@promptbook/remote-server 0.71.0-0 → 0.72.0-0

package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts

@@ -1,55 +0,0 @@
-import type { Promisable, ReadonlyDeep } from 'type-fest';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { TaskProgress } from '../../types/TaskProgress';
-import type { Parameters } from '../../types/typeAliases';
-import type { ExecutionTools } from '../ExecutionTools';
-import type { PipelineExecutorResult } from '../PipelineExecutorResult';
-import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
-/**
- * @@@
- *
- * @private internal type of `executePipelinex`
- */
-type ExecutePipelineOptions = {
-    /**
-     * @@@
-     */
-    readonly inputParameters: Readonly<Parameters>;
-    /**
-     * @@@
-     */
-    readonly tools: ExecutionTools;
-    /**
-     * @@@
-     */
-    readonly onProgress?: (taskProgress: TaskProgress) => Promisable<void>;
-    /**
-     * @@@
-     */
-    readonly pipeline: PipelineJson;
-    /**
-     * @@@
-     */
-    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
-    /**
-     * @@@
-     */
-    readonly setPreparedPipeline: (preparedPipeline: ReadonlyDeep<PipelineJson>) => void;
-    /**
-     * @@@
-     */
-    readonly pipelineIdentification: string;
-    /**
-     * Settings for the pipeline executor
-     */
-    readonly settings: CreatePipelineExecutorSettings;
-};
-/**
- * @@@
- *
- * Note: This is not a `PipelineExecutor` (which is binded with one exact pipeline), but a utility function of `createPipelineExecutor` which creates `PipelineExecutor`
- *
- * @private internal utility of `createPipelineExecutor`
- */
-export declare function executePipeline(options: ExecutePipelineOptions): Promise<PipelineExecutorResult>;
-export {};

package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts

@@ -1,62 +0,0 @@
-import { Promisable, ReadonlyDeep } from 'type-fest';
-import { MultipleLlmExecutionTools } from '../../llm-providers/multiple/MultipleLlmExecutionTools';
-import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
-import type { TaskProgress } from '../../types/TaskProgress';
-import type { Parameters } from '../../types/typeAliases';
-import type { ExecutionTools } from '../ExecutionTools';
-import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
-/**
- * @@@
- *
- * @private internal type of `executeTemplate`
- */
-type executeSingleTemplateOptions = {
-    /**
-     * @@@
-     */
-    readonly currentTemplate: ReadonlyDeep<TemplateJson>;
-    /**
-     * @@@
-     */
-    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
-    /**
-     * @@@
-     */
-    readonly parametersToPass: Readonly<Parameters>;
-    /**
-     * @@@
-     */
-    readonly tools: Omit<ExecutionTools, 'llm'>;
-    /**
-     * @@@
-     */
-    readonly llmTools: MultipleLlmExecutionTools;
-    /**
-     * @@@
-     */
-    readonly onProgress: (taskProgress: TaskProgress) => Promisable<void>;
-    /**
-     * Settings for the pipeline executor
-     */
-    readonly settings: CreatePipelineExecutorSettings;
-    /**
-     * @@@
-     */
-    readonly $executionReport: ExecutionReportJson;
-    /**
-     * @@@
-     */
-    readonly pipelineIdentification: string;
-};
-/**
- * @@@
- *
- * @private internal utility of `createPipelineExecutor`
- */
-export declare function executeTemplate(options: executeSingleTemplateOptions): Promise<Readonly<Parameters>>;
-export {};
-/**
- * TODO: [🤹‍♂️]
- */

package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatCells.d.ts

@@ -1,19 +0,0 @@
-import type { TODO_any } from '../../utils/organization/TODO_any';
-import type { ExecuteAttemptsOptions } from './40-executeAttempts';
-/**
- * @@@
- *
- * @private internal type of `executeFormatCells`
- */
-type ExecuteFormatCellsOptions = ExecuteAttemptsOptions;
-/**
- * @@@
- *
- * @private internal utility of `createPipelineExecutor`
- */
-export declare function executeFormatCells(options: ExecuteFormatCellsOptions): Promise<TODO_any>;
-export {};
-/**
- * TODO: !!!!!! Make pipelineIdentification more precise
- * TODO: !!!!!! How FOREACH execution looks in the report
- */

package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -1,74 +0,0 @@
-import type { ReadonlyDeep } from 'type-fest';
-import { MultipleLlmExecutionTools } from '../../llm-providers/multiple/MultipleLlmExecutionTools';
-import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
-import type { Parameters } from '../../types/typeAliases';
-import type { string_parameter_name } from '../../types/typeAliases';
-import type { TODO_string } from '../../utils/organization/TODO_string';
-import type { ExecutionTools } from '../ExecutionTools';
-import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
-/**
- * @@@
- *
- * @private internal type of `executeAttempts`
- */
-export type ExecuteAttemptsOptions = {
-    /**
-     * @@@
-     */
-    readonly jokerParameterNames: Readonly<Array<string_parameter_name>>;
-    /**
-     * @@@
-     */
-    readonly priority: number;
-    /**
-     * @@@
-     */
-    readonly maxAttempts: number;
-    /**
-     * @@@
-     */
-    readonly preparedContent: TODO_string;
-    /**
-     * @@@
-     */
-    readonly parameters: Readonly<Parameters>;
-    /**
-     * @@@
-     */
-    readonly template: ReadonlyDeep<TemplateJson>;
-    /**
-     * @@@
-     */
-    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
-    /**
-     * @@@
-     */
-    readonly tools: Omit<ExecutionTools, 'llm'>;
-    /**
-     * @@@
-     */
-    readonly llmTools: MultipleLlmExecutionTools;
-    /**
-     * Settings for the pipeline executor
-     */
-    readonly settings: CreatePipelineExecutorSettings;
-    /**
-     * @@@
-     */
-    readonly $executionReport: ExecutionReportJson;
-    /**
-     * @@@
-     */
-    readonly pipelineIdentification: string;
-};
-/**
- * @@@
- *
- * @private internal utility of `createPipelineExecutor`
- */
-export declare function executeAttempts(options: ExecuteAttemptsOptions): Promise<TODO_string>;
-/**
- * TODO: Break into smaller functions
- */

package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts

@@ -1,34 +0,0 @@
-import type { ReadonlyDeep } from 'type-fest';
-import { PipelineExecutionError } from '../../errors/PipelineExecutionError';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { Parameters } from '../../types/typeAliases';
-/**
- * @@@
- *
- * @private internal type of `createPipelineExecutor`
- */
-type FilterJustOutputParametersOptions = {
-    /**
-     * @@@
-     */
-    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
-    /**
-     * @@@
-     */
-    readonly parametersToPass: Readonly<Parameters>;
-    /**
-     * @@@
-     */
-    readonly $warnings: PipelineExecutionError[];
-    /**
-     * @@@
-     */
-    readonly pipelineIdentification: string;
-};
-/**
- * @@@
- *
- * @private internal utility of `createPipelineExecutor`
- */
-export declare function filterJustOutputParameters(options: FilterJustOutputParametersOptions): Parameters;
-export {};

package/esm/typings/src/execution/createPipelineExecutor/getContextForTemplate.d.ts

@@ -1,10 +0,0 @@
-import type { ReadonlyDeep } from 'type-fest';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
-import type { string_markdown } from '../../types/typeAliases';
-import type { string_parameter_value } from '../../types/typeAliases';
-/**
- * @@@
- *
- * @private internal utility of `createPipelineExecutor`
- */
-export declare function getContextForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;

package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTemplate.d.ts

@@ -1,27 +0,0 @@
-import type { ReadonlyDeep } from 'type-fest';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
-import type { string_markdown } from '../../types/typeAliases';
-import type { string_parameter_value } from '../../types/typeAliases';
-/**
- * @@@
- *
- * @private internal type of `getKnowledgeForTemplate`
- */
-type GetKnowledgeForTemplateOptions = {
-    /**
-     * @@@
-     */
-    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
-    /**
-     * @@@
-     */
-    readonly template: ReadonlyDeep<TemplateJson>;
-};
-/**
- * @@@
- *
- * @private internal utility of `createPipelineExecutor`
- */
-export declare function getKnowledgeForTemplate(options: GetKnowledgeForTemplateOptions): Promise<string_parameter_value & string_markdown>;
-export {};

package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTemplate.d.ts

@@ -1,30 +0,0 @@
-import type { ReadonlyDeep } from 'type-fest';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
-import type { ReservedParameters } from '../../types/typeAliases';
-/**
- * @@@
- *
- * @private internal type of `getReservedParametersForTemplate`
- */
-type GetReservedParametersForTemplateOptions = {
-    /**
-     * @@@
-     */
-    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
-    /**
-     * @@@
-     */
-    readonly template: ReadonlyDeep<TemplateJson>;
-    /**
-     * @@@
-     */
-    readonly pipelineIdentification: string;
-};
-/**
- * @@@
- *
- * @private internal utility of `createPipelineExecutor`
- */
-export declare function getReservedParametersForTemplate(options: GetReservedParametersForTemplateOptions): Promise<Readonly<ReservedParameters>>;
-export {};

package/esm/typings/src/execution/createPipelineExecutor/getSamplesForTemplate.d.ts

@@ -1,10 +0,0 @@
-import type { ReadonlyDeep } from 'type-fest';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
-import type { string_markdown } from '../../types/typeAliases';
-import type { string_parameter_value } from '../../types/typeAliases';
-/**
- * @@@
- *
- * @private internal utility of `createPipelineExecutor`
- */
-export declare function getSamplesForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;

package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts

@@ -1,30 +0,0 @@
-import type { Promisable } from 'type-fest';
-import type { Parameters } from '../../types/typeAliases';
-import type { string_name } from '../../types/typeAliases';
-import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
-import type { empty_object } from '../../utils/organization/empty_object';
-/**
- * @@@
- */
-export type FormatSubvalueDefinition<TValue extends string, TSettings extends empty_object> = {
-    /**
-     * The name of the format used in .ptbk.md files
-     *
-     * @sample "CELL"
-     */
-    readonly subvalueName: string_name & string_SCREAMING_CASE;
-    /**
-     * Aliases for the `subvalueName`
-     */
-    readonly aliases?: Array<string_name & string_SCREAMING_CASE>;
-    /**
-     * Maps values
-     *
-     * For example, if you have a JSON object and you want to map all values to uppercase
-     * Or iterate over all CSV cells @@@
-     */
-    mapValues(value: TValue, settings: TSettings, mapCallback: (subvalues: Parameters, index: number) => Promisable<string>): Promise<string>;
-};
-/**
- * Note: [👩🏾‍🤝‍🧑🏽]
- */

package/esm/typings/src/formats/csv/CsvSettings.d.ts

@@ -1,13 +0,0 @@
-import type { ParseConfig, UnparseConfig } from 'papaparse';
-/**
- * @@@
- */
-export type CsvSettings = Pick<ParseConfig & UnparseConfig, 'delimiter' | 'quoteChar' | 'newline' | 'skipEmptyLines'>;
-/**
- * @@@
- *
- * @public exported from `@promptbook/core`
- */
-export declare const MANDATORY_CSV_SETTINGS: Readonly<{
-    readonly header: true;
-}>;

package/esm/typings/src/formats/text/TextFormatDefinition.d.ts

@@ -1,19 +0,0 @@
-import type { TODO_any } from '../../utils/organization/TODO_any';
-import type { FormatDefinition } from '../_common/FormatDefinition';
-/**
- * Definition for any text - this will be always valid
- *
- * Note: This is not useful for validation, but for splitting and mapping with `subvalueDefinitions`
- *
- * @public exported from `@promptbook/core`
- */
-export declare const TextFormatDefinition: FormatDefinition<string, string, TODO_any, TODO_any>;
-/**
- * TODO: [1] Make type for XML Text and Schema
- * TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages aviable as subvalues
- * TODO: [🍓] In `TextFormatDefinition` implement simple `isValid`
- * TODO: [🍓] In `TextFormatDefinition` implement partial `canBeValid`
- * TODO: [🍓] In `TextFormatDefinition` implement `heal
- * TODO: [🍓] In `TextFormatDefinition` implement `subvalueDefinitions`
- * TODO: [🏢] Allow to expect something inside each item of list and other formats
- */

package/esm/typings/src/utils/organization/just_empty_object.d.ts

@@ -1,12 +0,0 @@
-/**
- * Organizational helper to better @@@@
- *
- * Note: There are 2 similar types>
- * - `empty_object` @@@
- * - `just_empty_object` @@@
- *
- * Note: In most cases, you should use `empty_object`
- *
- * @private within the repository
- */
-export type just_empty_object = Record<string, never>;

package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts

@@ -1,27 +0,0 @@
-import type { string_parameter_name } from '../../types/typeAliases';
-import type { string_parameter_value } from '../../types/typeAliases';
-/**
- * @@@
- */
-type MakeapAvailableToExpectedParametersOptions = {
-    /**
-     * @@@
-     */
-    readonly expectedParameters: Readonly<Record<string_parameter_name, null>>;
-    /**
-     * @@@
-     */
-    readonly availableParameters: Readonly<Record<string_parameter_name, string_parameter_value>>;
-};
-/**
- * Maps available parameters to expected parameters
- *
- * The strategy is:
- * 1) @@@
- * 2) @@@
- *
- * @throws {PipelineExecutionError} @@@
- * @private within the repository used in `createPipelineExecutor`
- */
-export declare function mapAvailableToExpectedParameters(options: MakeapAvailableToExpectedParametersOptions): Readonly<Record<string_parameter_name, string_parameter_value>>;
-export {};

package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts

@@ -1,10 +0,0 @@
-import type { string_parameter_name } from '../../../types/typeAliases';
-/**
- * Function `validateParameterName` will @@@
- *
- * @param parameterName @@@
- * @returns @@@
- * @throws {ParseError} @@@
- * @private within the repository
- */
-export declare function validateParameterName(parameterName: string): string_parameter_name;

package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts

@@ -1 +0,0 @@
-export {};