eliashaeussler/typo3-solver

View on GitHub
Resources/Private/Frontend/src/scripts/@types/events.ts

Summary

Maintainability
A
0 mins
Test Coverage
'use strict';

/*
 * This file is part of the TYPO3 CMS extension "solver".
 *
 * Copyright (C) 2023 Elias Häußler <elias@haeussler.dev>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

/**
 * Data of event stream with event "solutionDelta".
 */
type SolutionDeltaResponse = {
  data: SolutionDeltaResponseData;
  content: string;
}

/**
 * Metadata of solutions streamed with event "solutionDelta".
 */
type SolutionDeltaResponseData = {
  model: string;
  numberOfChoices: number;
  numberOfPendingChoices: number;
  prompt: string;
}

/**
 * Data of event stream with event "solutionError"
 */
type SolutionErrorResponse = {
  data: SolutionErrorResponseData;
  content: string;
}

/**
 * Metadata of errors streamed with event "solutionError".
 */
type SolutionErrorResponseData = {
  message: string;
  code: string;
};