@promptbook/types 0.69.0-2 → 0.69.0-5

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

@@ -38,7 +38,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 { ZERO_USAGE } from '../execution/utils/addUsage';
 import { addUsage } from '../execution/utils/addUsage';

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

@@ -16,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';
@@ -242,6 +244,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 };

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' | 'foreach'>): 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/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';
 /**
  * @@@
@@ -41,9 +42,10 @@ export type PipelineExecutorResult = {
      * 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: !!!!!! Maybe add ReadonlyDeep< to all
  * TODO: [🧠] Should this file be in /execution or /types folder?
  * TODO: [🧠] Maybe constrain `ErrorJson` -> `ErrorJson & { name: 'PipelineExecutionError' | '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,30 @@
+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;
+    /**
+     * 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;
+};

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 { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
+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';
+/**
+ * @@@
+ *
+ * @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

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

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

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

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

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

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

@@ -0,0 +1,34 @@
+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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,27 @@
+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

@@ -0,0 +1,30 @@
+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

@@ -0,0 +1,10 @@
+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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.69.0-2",
+    "version": "0.69.0-5",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -45,6 +45,6 @@
     ],
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.69.0-2"
+        "@promptbook/core": "0.69.0-5"
     }
 }

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

@@ -1,72 +0,0 @@
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import type { ExecutionTools } from './ExecutionTools';
-import type { PipelineExecutor } from './PipelineExecutor';
-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;
-    /**
-     * 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;
-};
-/**
- * Options for `createPipelineExecutor`
- */
-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>;
-}
-/**
- * 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;
-export {};
-/**
- * TODO: !!! Identify not only pipeline BUT exact template ${block(pipelineIdentification)}
- * TODO: Use isVerbose here (not only pass to `preparePipeline`)
- * TODO: [🧠][🌳] Use here `countTotalUsage` and put preparation and prepared pipiline to report
- * TODO: [🪂] Use maxParallelCount here (not only pass to `preparePipeline`)
- * TODO: [♈] Probbably move expectations from templates to parameters
- * TODO: [🧠] When not meet expectations in DIALOG_TEMPLATE, make some way to tell the user
- * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
- * Note: CreatePipelineExecutorOptions are just connected to PipelineExecutor so do not extract to types folder
- * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
- * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
- * TODO: [🧠][💷] `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result BUT maybe NOT to preserve pure JSON object
- */