@promptbook/cli 0.72.0-0 → 0.72.0-1

package/esm/typings/src/_packages/cli.index.d.ts

@@ -5,7 +5,9 @@ import { _AnthropicClaudeRegistration } from '../llm-providers/anthropic-claude/
 import { _AzureOpenAiMetadataRegistration } from '../llm-providers/azure-openai/register-configuration';
 import { _AzureOpenAiRegistration } from '../llm-providers/azure-openai/register-constructor';
 import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
+import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
+import { _OpenAiAssistantRegistration } from '../llm-providers/openai/register-constructor';
 export { PROMPTBOOK_VERSION };
 export { _CLI };
 export { _AnthropicClaudeMetadataRegistration };
@@ -13,4 +15,6 @@ export { _AnthropicClaudeRegistration };
 export { _AzureOpenAiMetadataRegistration };
 export { _AzureOpenAiRegistration };
 export { _OpenAiMetadataRegistration };
+export { _OpenAiAssistantMetadataRegistration };
 export { _OpenAiRegistration };
+export { _OpenAiAssistantRegistration };

package/esm/typings/src/_packages/core.index.d.ts

@@ -17,6 +17,7 @@ import { PIPELINE_COLLECTION_BASE_FILENAME } from '../config';
 import { RESERVED_PARAMETER_NAMES } from '../config';
 import { DEFAULT_REMOTE_URL } from '../config';
 import { DEFAULT_REMOTE_URL_PATH } from '../config';
+import { DEFAULT_CSV_SETTINGS } from '../config';
 import { IS_VERBOSE } from '../config';
 import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
 import type { PipelineStringToJsonOptions } from '../conversion/pipelineStringToJson';
@@ -38,7 +39,7 @@ import { PipelineLogicError } from '../errors/PipelineLogicError';
 import { PipelineUrlError } from '../errors/PipelineUrlError';
 import { UnexpectedError } from '../errors/UnexpectedError';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
-import { createPipelineExecutor } from '../execution/createPipelineExecutor';
+import { createPipelineExecutor } from '../execution/createPipelineExecutor/00-createPipelineExecutor';
 import { embeddingVectorToString } from '../execution/embeddingVectorToString';
 import { addUsage } from '../execution/utils/addUsage';
 import { isPassingExpectations } from '../execution/utils/checkExpectations';
@@ -46,6 +47,9 @@ import { ZERO_USAGE } from '../execution/utils/usage-constants';
 import { UNCERTAIN_USAGE } from '../execution/utils/usage-constants';
 import { usageToHuman } from '../execution/utils/usageToHuman';
 import { usageToWorktime } from '../execution/utils/usageToWorktime';
+import { CsvFormatDefinition } from '../formats/csv/CsvFormatDefinition';
+import { MANDATORY_CSV_SETTINGS } from '../formats/csv/CsvSettings';
+import { TextFormatDefinition } from '../formats/text/TextFormatDefinition';
 import { CallbackInterfaceTools } from '../knowledge/dialogs/callback/CallbackInterfaceTools';
 import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
 import { prepareKnowledgePieces } from '../knowledge/prepare-knowledge/_common/prepareKnowledgePieces';
@@ -60,6 +64,7 @@ import { _AnthropicClaudeMetadataRegistration } from '../llm-providers/anthropic
 import { _AzureOpenAiMetadataRegistration } from '../llm-providers/azure-openai/register-configuration';
 import { joinLlmExecutionTools } from '../llm-providers/multiple/joinLlmExecutionTools';
 import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
+import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { preparePersona } from '../personas/preparePersona';
 import { isPipelinePrepared } from '../prepare/isPipelinePrepared';
 import { preparePipeline } from '../prepare/preparePipeline';
@@ -91,6 +96,7 @@ export { PIPELINE_COLLECTION_BASE_FILENAME };
 export { RESERVED_PARAMETER_NAMES };
 export { DEFAULT_REMOTE_URL };
 export { DEFAULT_REMOTE_URL_PATH };
+export { DEFAULT_CSV_SETTINGS };
 export { IS_VERBOSE };
 export { pipelineJsonToString };
 export type { PipelineStringToJsonOptions };
@@ -120,6 +126,9 @@ export { ZERO_USAGE };
 export { UNCERTAIN_USAGE };
 export { usageToHuman };
 export { usageToWorktime };
+export { CsvFormatDefinition };
+export { MANDATORY_CSV_SETTINGS };
+export { TextFormatDefinition };
 export { CallbackInterfaceTools };
 export type { CallbackInterfaceToolsOptions };
 export { prepareKnowledgePieces };
@@ -134,6 +143,7 @@ export { _AnthropicClaudeMetadataRegistration };
 export { _AzureOpenAiMetadataRegistration };
 export { joinLlmExecutionTools };
 export { _OpenAiMetadataRegistration };
+export { _OpenAiAssistantMetadataRegistration };
 export { preparePersona };
 export { isPipelinePrepared };
 export { preparePipeline };

package/esm/typings/src/_packages/openai.index.d.ts

@@ -1,4 +1,5 @@
 import { PROMPTBOOK_VERSION } from '../version';
+import { createOpenAiAssistantExecutionTools } from '../llm-providers/openai/createOpenAiAssistantExecutionTools';
 import { createOpenAiExecutionTools } from '../llm-providers/openai/createOpenAiExecutionTools';
 import { OPENAI_MODELS } from '../llm-providers/openai/openai-models';
 import { OpenAiAssistantExecutionTools } from '../llm-providers/openai/OpenAiAssistantExecutionTools';
@@ -6,7 +7,9 @@ import type { OpenAiAssistantExecutionToolsOptions } from '../llm-providers/open
 import { OpenAiExecutionTools } from '../llm-providers/openai/OpenAiExecutionTools';
 import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
 import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
+import { _OpenAiAssistantRegistration } from '../llm-providers/openai/register-constructor';
 export { PROMPTBOOK_VERSION };
+export { createOpenAiAssistantExecutionTools };
 export { createOpenAiExecutionTools };
 export { OPENAI_MODELS };
 export { OpenAiAssistantExecutionTools };
@@ -14,3 +17,4 @@ export type { OpenAiAssistantExecutionToolsOptions };
 export { OpenAiExecutionTools };
 export type { OpenAiExecutionToolsOptions };
 export { _OpenAiRegistration };
+export { _OpenAiAssistantRegistration };

package/esm/typings/src/_packages/types.index.d.ts

@@ -7,6 +7,7 @@ import type { PipelineTemplateCommandParser } from '../commands/_common/types/Co
 import type { CommandParserInput } from '../commands/_common/types/CommandParser';
 import type { CommandUsagePlace } from '../commands/_common/types/CommandUsagePlaces';
 import type { ExpectCommand } from '../commands/EXPECT/ExpectCommand';
+import type { ForeachJson } from '../commands/FOREACH/ForeachJson';
 import type { FormatCommand } from '../commands/FORMAT/FormatCommand';
 import type { TemplateType } from '../commands/TEMPLATE/TemplateTypes';
 import type { PipelineStringToJsonOptions } from '../conversion/pipelineStringToJson';
@@ -15,6 +16,8 @@ import type { renderPipelineMermaidOptions } from '../conversion/prettify/render
 import type { ErrorJson } from '../errors/utils/ErrorJson';
 import type { AvailableModel } from '../execution/AvailableModel';
 import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
+import type { CreatePipelineExecutorOptions } from '../execution/createPipelineExecutor/00-CreatePipelineExecutorOptions';
+import type { CreatePipelineExecutorSettings } from '../execution/createPipelineExecutor/00-CreatePipelineExecutorSettings';
 import type { EmbeddingVector } from '../execution/EmbeddingVector';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
@@ -32,6 +35,8 @@ import type { ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExec
 import type { UncertainNumber } from '../execution/UncertainNumber';
 import type { UserInterfaceTools } from '../execution/UserInterfaceTools';
 import type { UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
+import type { FormatSubvalueDefinition } from '../formats/_common/FormatSubvalueDefinition';
+import type { CsvSettings } from '../formats/csv/CsvSettings';
 import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
 import type { LlmToolsConfiguration } from '../llm-providers/_common/LlmToolsConfiguration';
 import type { LlmToolsMetadata } from '../llm-providers/_common/LlmToolsMetadata';
@@ -221,6 +226,7 @@ import type { string_camelCase } from '../utils/normalization/normalizeTo_camelC
 import type { string_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
 import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { string_snake_case } from '../utils/normalization/normalizeTo_snake_case';
+import type { empty_object } from '../utils/organization/empty_object';
 import type { really_any } from '../utils/organization/really_any';
 import type { TODO_any } from '../utils/organization/TODO_any';
 import type { string_promptbook_version } from '../version';
@@ -233,6 +239,7 @@ export type { PipelineTemplateCommandParser };
 export type { CommandParserInput };
 export type { CommandUsagePlace };
 export type { ExpectCommand };
+export type { ForeachJson };
 export type { FormatCommand };
 export type { TemplateType };
 export type { PipelineStringToJsonOptions };
@@ -241,6 +248,8 @@ export type { renderPipelineMermaidOptions };
 export type { ErrorJson };
 export type { AvailableModel };
 export type { CommonExecutionToolsOptions };
+export type { CreatePipelineExecutorOptions };
+export type { CreatePipelineExecutorSettings };
 export type { EmbeddingVector };
 export type { ExecutionTools };
 export type { LlmExecutionTools };
@@ -258,6 +267,8 @@ export type { ScriptExecutionToolsExecuteOptions };
 export type { UncertainNumber };
 export type { UserInterfaceTools };
 export type { UserInterfaceToolsPromptDialogOptions };
+export type { FormatSubvalueDefinition };
+export type { CsvSettings };
 export type { CallbackInterfaceToolsOptions };
 export type { LlmToolsConfiguration };
 export type { LlmToolsMetadata };
@@ -447,6 +458,7 @@ export type { string_camelCase };
 export type { string_PascalCase };
 export type { string_SCREAMING_CASE };
 export type { string_snake_case };
+export type { empty_object };
 export type { really_any };
 export type { TODO_any };
 export type { string_promptbook_version };

package/esm/typings/src/_packages/utils.index.d.ts

@@ -20,7 +20,6 @@ import { splitIntoSentences } from '../utils/expectation-counters/countSentences
 import { countSentences } from '../utils/expectation-counters/countSentences';
 import { countWords } from '../utils/expectation-counters/countWords';
 import { CountUtils } from '../utils/expectation-counters/index';
-import { extractParameterNames } from '../utils/extractParameterNames';
 import { capitalize } from '../utils/normalization/capitalize';
 import { decapitalize } from '../utils/normalization/decapitalize';
 import { DIACRITIC_VARIANTS_LETTERS } from '../utils/normalization/DIACRITIC_VARIANTS_LETTERS';
@@ -43,11 +42,12 @@ import { parseKeywords } from '../utils/normalization/parseKeywords';
 import { parseKeywordsFromString } from '../utils/normalization/parseKeywordsFromString';
 import { removeDiacritics } from '../utils/normalization/removeDiacritics';
 import { searchKeywords } from '../utils/normalization/searchKeywords';
+import { extractParameterNames } from '../utils/parameters/extractParameterNames';
+import { replaceParameters } from '../utils/parameters/replaceParameters';
 import { parseNumber } from '../utils/parseNumber';
 import { $randomSeed } from '../utils/random/$randomSeed';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';
-import { replaceParameters } from '../utils/replaceParameters';
 import { $deepFreeze } from '../utils/serialization/$deepFreeze';
 import { checkSerializableAsJson } from '../utils/serialization/checkSerializableAsJson';
 import { clonePipeline } from '../utils/serialization/clonePipeline';
@@ -91,7 +91,6 @@ export { splitIntoSentences };
 export { countSentences };
 export { countWords };
 export { CountUtils };
-export { extractParameterNames };
 export { capitalize };
 export { decapitalize };
 export { DIACRITIC_VARIANTS_LETTERS };
@@ -114,11 +113,12 @@ export { parseKeywords };
 export { parseKeywordsFromString };
 export { removeDiacritics };
 export { searchKeywords };
+export { extractParameterNames };
+export { replaceParameters };
 export { parseNumber };
 export { $randomSeed };
 export { removeEmojis };
 export { removeQuotes };
-export { replaceParameters };
 export { $deepFreeze };
 export { checkSerializableAsJson };
 export { clonePipeline };

package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts

@@ -1,9 +1,10 @@
+import type { ForeachJson } from './ForeachJson';
 /**
- * Parsed FOREACH command <- Write [🍭]
+ * Parsed FOREACH command which is used to iterate over a table of values
  *
  * @see ./foreachCommandParser.ts for more details
  * @private within the commands folder
  */
 export type ForeachCommand = {
     readonly type: 'FOREACH';
-};
+} & ForeachJson;

package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts

@@ -0,0 +1,23 @@
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { TODO_string } from '../../utils/organization/TODO_string';
+/**
+ * @@@
+ */
+export type ForeachJson = {
+    /**
+     * @@@
+     */
+    readonly formatName: TODO_string;
+    /**
+     * @@@
+     */
+    readonly subformatName: TODO_string;
+    /**
+     * @@@
+     */
+    readonly parameterName: string_parameter_name;
+    /**
+     * @@@
+     */
+    readonly subparameterNames: Array<string_parameter_name>;
+};

package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts

@@ -10,5 +10,5 @@ import type { ForeachCommand } from './ForeachCommand';
  */
 export declare const foreachCommandParser: PipelineTemplateCommandParser<ForeachCommand>;
 /**
- * TODO: [🍭] Make .ptbk.md file with examples of the FOREACH command and also with wrong parsing and logic
+ * TODO: [🍭] Make .ptbk.md file with examples of the FOREACH with wrong parsing and logic
  */

package/esm/typings/src/commands/_common/types/CommandParser.d.ts

@@ -147,24 +147,39 @@ export type $PipelineJson = WritableDeep<PipelineJson>;
 export type CommandParserInput = {
     /**
      * @@@
+     *
+     * @example 'PIPELINE_HEAD'
+     * @example 'PIPELINE_TEMPLATE'
      */
     readonly usagePlace: CommandUsagePlace;
     /**
      * @@@
+     *
+     * @example 'promptbook version 0.62.0'
+     * @example 'FOREACH Text Line `{customers}` -> `{customer}`'
      */
     readonly raw: string_markdown_text;
     /**
      * @@@
+     *
+     * @example '0.62.0'
+     * @example 'List Line `{customers}` -> `{customer}`'
      */
     readonly rawArgs: string_markdown_text;
     /**
      * @@@
+     *
+     * @example 'PROMPTBOOK_VERSION_0_62_0'
+     * @example 'FOREACH_LIST_LINE_CUSTOMERS_CUSTOMER'
      */
     readonly normalized: string_name & string_SCREAMING_CASE;
     /**
      * @@@
+     *
+     * @example [ '0.62.0' ]
+     * @example [ 'List', 'Line', '{customers}', '', '{customer}' ]
      */
-    readonly args: Array<string_name & string_SCREAMING_CASE>;
+    readonly args: Array<string_name>;
 };
 /**
  * TODO: [♓️] Add order here

package/esm/typings/src/config.d.ts

@@ -1,3 +1,4 @@
+import type { CsvSettings } from './formats/csv/CsvSettings';
 /**
  * Warning message for the generated sections and files files
  *
@@ -137,6 +138,12 @@ export declare const DEFAULT_REMOTE_URL = "https://api.pavolhejny.com/";
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_REMOTE_URL_PATH = "/promptbook/socket.io";
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_CSV_SETTINGS: CsvSettings;
 /**
  * @@@
  *
@@ -148,7 +155,13 @@ export declare const IS_VERBOSE = false;
  *
  * @private within the repository
  */
-export declare const DEBUG_ALLOW_PAYED_TESTING: boolean;
+export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare const IS_COST_PREVENTED: boolean;
 /**
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
  */

package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts

@@ -22,6 +22,9 @@ export type renderPipelineMermaidOptions = {
  */
 export declare function renderPromptbookMermaid(pipelineJson: PipelineJson, options?: renderPipelineMermaidOptions): string;
 /**
+ * TODO: !!!!! FOREACH in mermaid graph
+ * TODO: !!!!! Knowledge in mermaid graph
+ * TODO: !!!!! Personas in mermaid graph
  * TODO: Maybe use some Mermaid package instead of string templating
  * TODO: [🕌] When more than 2 functionalities, split into separate functions
  */

package/esm/typings/src/conversion/utils/extractParameterNamesFromTemplate.d.ts

@@ -1,3 +1,4 @@
+import type { ReadonlyDeep } from 'type-fest';
 import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
 import type { string_parameter_name } from '../../types/typeAliases';
 /**
@@ -8,7 +9,7 @@ import type { string_parameter_name } from '../../types/typeAliases';
  * @throws {ParseError} if the script is invalid
  * @public exported from `@promptbook/utils`
  */
-export declare function extractParameterNamesFromTemplate(template: Pick<TemplateJson, 'title' | 'description' | 'templateType' | 'content' | 'preparedContent' | 'jokerParameterNames'>): Set<string_parameter_name>;
+export declare function extractParameterNamesFromTemplate(template: ReadonlyDeep<Pick<TemplateJson, 'title' | 'description' | 'templateType' | 'content' | 'preparedContent' | 'jokerParameterNames' | 'foreach'>>): Set<string_parameter_name>;
 /**
  * TODO: [🔣] If script require contentLanguage
  */

package/esm/typings/src/conversion/validation/validatePipeline.d.ts

@@ -16,6 +16,11 @@ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
  */
 export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
 /**
+ * @private internal function for `validatePipeline`
+ */
+export declare function validatePipelineCore(pipeline: PipelineJson): void;
+/**
+ * TODO: !!!!! [🧞‍♀️] Do not allow joker + foreach
  * TODO: [🧠] Work with promptbookVersion
  * TODO: Use here some json-schema, Zod or something similar and change it to:
  *     > /**

package/esm/typings/src/execution/PipelineExecutorResult.d.ts

@@ -1,7 +1,8 @@
+import { ReadonlyDeep } from 'type-fest';
+import type { ErrorJson } from '../errors/utils/ErrorJson';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
-import type { Parameters } from '../types/typeAliases';
 import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import type { ErrorJson } from '../errors/utils/ErrorJson';
+import type { Parameters } from '../types/typeAliases';
 import type { PromptResultUsage } from './PromptResultUsage';
 /**
  * @@@
@@ -14,7 +15,7 @@ export type PipelineExecutorResult = {
      *
      * Note: If the execution was not successful, there are only some of the result parameters
      */
-    readonly outputParameters: Parameters;
+    readonly outputParameters: Readonly<Parameters>;
     /**
      * Whether the execution was successful, details are aviable in `executionReport`
      */
@@ -22,26 +23,26 @@ export type PipelineExecutorResult = {
     /**
      * Added usage of whole execution, detailed usage is aviable in `executionReport`
      */
-    readonly usage: PromptResultUsage;
+    readonly usage: ReadonlyDeep<PromptResultUsage>;
     /**
      * Errors that occured during the execution, details are aviable in `executionReport`
      */
-    readonly errors: Array<ErrorJson>;
+    readonly errors: ReadonlyDeep<Array<ErrorJson>>;
     /**
      * Warnings that occured during the execution, details are aviable in `executionReport`
      */
-    readonly warnings: Array<ErrorJson>;
+    readonly warnings: ReadonlyDeep<Array<ErrorJson>>;
     /**
      * The report of the execution with all details
      */
-    readonly executionReport: ExecutionReportJson;
+    readonly executionReport: ReadonlyDeep<ExecutionReportJson>;
     /**
      * The prepared pipeline that was used for the execution
      *
      * Note: If you called `createPipelineExecutor` with fully prepared pipeline, this is the same object as this pipeline
      *       If you passed not fully prepared pipeline, this is same pipeline but fully prepared
      */
-    readonly preparedPipeline: PipelineJson;
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
 };
 /**
  * TODO: [🧠] Should this file be in /execution or /types folder?

package/esm/typings/src/execution/createPipelineExecutor/$OngoingTemplateResult.d.ts

@@ -0,0 +1,45 @@
+import { ExpectError } from '../../errors/ExpectError';
+import type { Prompt } from '../../types/Prompt';
+import type { ChatPromptResult } from '../PromptResult';
+import type { CompletionPromptResult } from '../PromptResult';
+import type { EmbeddingPromptResult } from '../PromptResult';
+import type { PromptResult } from '../PromptResult';
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export type $OngoingTemplateResult = {
+    /**
+     * @@@
+     */
+    $prompt?: Prompt;
+    /**
+     * @@@
+     */
+    $chatResult?: ChatPromptResult;
+    /**
+     * @@@
+     */
+    $completionResult?: CompletionPromptResult;
+    /**
+     * @@@
+     */
+    $embeddingResult?: EmbeddingPromptResult;
+    /**
+     * @@@
+     */
+    $result: PromptResult | null;
+    /**
+     * @@@
+     */
+    $resultString: string | null;
+    /**
+     * @@@
+     */
+    $expectError: ExpectError | null;
+    /**
+     * @@@
+     */
+    $scriptPipelineExecutionErrors: Array<Error>;
+};

package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts

@@ -0,0 +1,20 @@
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { ExecutionTools } from '../ExecutionTools';
+import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
+/**
+ * Options for `createPipelineExecutor`
+ */
+export interface CreatePipelineExecutorOptions {
+    /**
+     * The pipeline to be executed
+     */
+    readonly pipeline: PipelineJson;
+    /**
+     * The execution tools to be used during the execution of the pipeline
+     */
+    readonly tools: ExecutionTools;
+    /**
+     * Optional settings for the pipeline executor
+     */
+    readonly settings?: Partial<CreatePipelineExecutorSettings>;
+}

package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts

@@ -0,0 +1,40 @@
+import type { CsvSettings } from '../../formats/csv/CsvSettings';
+export type CreatePipelineExecutorSettings = {
+    /**
+     * When executor does not satisfy expectations it will be retried this amount of times
+     *
+     * @default MAX_EXECUTION_ATTEMPTS
+     */
+    readonly maxExecutionAttempts: number;
+    /**
+     * Maximum number of tasks running in parallel
+     *
+     * @default MAX_PARALLEL_COUNT
+     */
+    readonly maxParallelCount: number;
+    /**
+     * If true, the preparation logs additional information
+     *
+     * @default false
+     */
+    readonly isVerbose: boolean;
+    /**
+     * Settings for CSV format
+     *
+     * @default DEFAULT_CSV_SETTINGS
+     */
+    readonly csvSettings: CsvSettings;
+    /**
+     * If you pass fully prepared pipeline, this does not matter
+     *
+     * Otherwise:
+     * If false or not set, warning is shown when pipeline is not prepared
+     * If true, warning is suppressed
+     *
+     * @default false
+     */
+    readonly isNotPreparedWarningSupressed: boolean;
+};
+/**
+ * TODO: [🤹‍♂️] More granular setting for limits of execution + better waiting for queue
+ */

package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts

@@ -0,0 +1,10 @@
+import type { PipelineExecutor } from '../PipelineExecutor';
+import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
+/**
+ * Creates executor function from pipeline and execution tools.
+ *
+ * @returns The executor function
+ * @throws {PipelineLogicError} on logical error in the pipeline
+ * @public exported from `@promptbook/core`
+ */
+export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;

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

@@ -0,0 +1,55 @@
+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;
+    /**
+     * @@@
+     */
+    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

@@ -0,0 +1,62 @@
+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: [🤹‍♂️]
+ */