@promptbook/node 0.69.0-1 → 0.69.0-4

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/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

@@ -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/CreatePipelineExecutorOptions';
+import type { CreatePipelineExecutorSettings } from '../execution/createPipelineExecutor/CreatePipelineExecutorSettings';
 import type { EmbeddingVector } from '../execution/EmbeddingVector';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
@@ -232,6 +235,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 };
@@ -240,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/commands/FOREACH/ForeachCommand.d.ts

@@ -1,5 +1,4 @@
-import type { string_parameter_name } from '../../types/typeAliases';
-import type { TODO_string } from '../../utils/organization/TODO_string';
+import type { ForeachJson } from './ForeachJson';
 /**
  * Parsed FOREACH command <- Write [🍭] !!!!!!
  *
@@ -8,7 +7,4 @@ import type { TODO_string } from '../../utils/organization/TODO_string';
  */
 export type ForeachCommand = {
     readonly type: 'FOREACH';
-    formatName: TODO_string;
-    cellName: TODO_string;
-    parameterName: string_parameter_name;
-};
+} & ForeachJson;

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

@@ -0,0 +1,26 @@
+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 cellName: TODO_string;
+    /**
+     * @@@
+     */
+    readonly parameterName: string_parameter_name;
+    /**
+     * @@@
+     */
+    readonly subparameterName: string_parameter_name;
+};
+/**
+ * TODO: [🧠] Betetr name for `parameterName` and `subparameterName`
+ */

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

@@ -156,28 +156,28 @@ export type CommandParserInput = {
      * @@@
      *
      * @example 'promptbook version 0.62.0'
-     * @example 'FOREACH List Line -> `{customer}`'
+     * @example 'FOREACH List Line `{customers}` -> `{customer}`'
      */
     readonly raw: string_markdown_text;
     /**
      * @@@
      *
      * @example '0.62.0'
-     * @example 'List Line -> `{customer}`'
+     * @example 'List Line `{customers}` -> `{customer}`'
      */
     readonly rawArgs: string_markdown_text;
     /**
      * @@@
      *
      * @example 'PROMPTBOOK_VERSION_0_62_0'
-     * @example 'FOREACH_LIST_LINE_CUSTOMER'
+     * @example 'FOREACH_LIST_LINE_CUSTOMERS_CUSTOMER'
      */
     readonly normalized: string_name & string_SCREAMING_CASE;
     /**
      * @@@
      *
      * @example [ '0.62.0' ]
-     * @example [ 'List', 'Line', '', '{customer}' ]
+     * @example [ 'List', 'Line', '{customers}', '', '{customer}' ]
      */
     readonly args: Array<string_name>;
 };

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

@@ -148,7 +148,13 @@ export declare const IS_VERBOSE = false;
  *
  * @private within the repository
  */
-export declare const DEBUG_ALLOW_PAYED_TESTING: boolean;
+export declare const IS_COST_PREVENTED: boolean;
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare const IS_PIPELINE_LOGIC_VALIDATED: 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

@@ -15,6 +15,10 @@ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
  * @public exported from `@promptbook/core`
  */
 export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
+/**
+ * @private internal function for `validatePipeline`
+ */
+export declare function validatePipelineCore(pipeline: PipelineJson): void;
 /**
  * TODO: [🧠] Work with promptbookVersion
  * TODO: Use here some json-schema, Zod or something similar and change it to:

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

@@ -0,0 +1,20 @@
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { ExecutionTools } from '../ExecutionTools';
+import type { CreatePipelineExecutorSettings } from './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/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/createPipelineExecutor.d.ts

@@ -0,0 +1,24 @@
+import type { PipelineExecutor } from '../PipelineExecutor';
+import type { CreatePipelineExecutorOptions } from './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;
+/**
+ * TODO: [🤹‍♂️] Make some smarter system for limiting concurrent executions MAX_PARALLEL_TOTAL, MAX_PARALLEL_PER_LLM
+ * 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: [🧠][🍸] 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
+ */

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

@@ -0,0 +1,27 @@
+import { Promisable, ReadonlyDeep } from 'type-fest';
+import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
+import type { ExecutionTools } from '../ExecutionTools';
+import { MultipleLlmExecutionTools } from '../../llm-providers/multiple/MultipleLlmExecutionTools';
+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';
+type executeSingleTemplateOptions = {
+    currentTemplate: ReadonlyDeep<TemplateJson>;
+    preparedPipeline: ReadonlyDeep<PipelineJson>;
+    parametersToPass: Readonly<Parameters>;
+    tools: Omit<ExecutionTools, 'llm'>;
+    llmTools: MultipleLlmExecutionTools;
+    onProgress: (taskProgress: TaskProgress) => Promisable<void>;
+    maxExecutionAttempts: number;
+    $executionReport: ExecutionReportJson;
+    pipelineIdentification: string;
+};
+/**
+ * @private @@@
+ */
+export declare function executeSingleTemplate(options: executeSingleTemplateOptions): Promise<Readonly<Parameters>>;
+export {};
+/**
+ * TODO: [🤹‍♂️]
+ */

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

@@ -0,0 +1,8 @@
+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 @@@
+ */
+export declare function filterJustOutputParameters(preparedPipeline: ReadonlyDeep<PipelineJson>, parametersToPass: Readonly<Parameters>, $warnings: PipelineExecutionError[], pipelineIdentification: string): Parameters;

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

@@ -0,0 +1,8 @@
+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 @@@
+ */
+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,9 @@
+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 @@@
+ */
+export declare function getKnowledgeForTemplate(preparedPipeline: ReadonlyDeep<PipelineJson>, template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;

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

@@ -0,0 +1,8 @@
+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 @@@
+ */
+export declare function getReservedParametersForTemplate(preparedPipeline: ReadonlyDeep<PipelineJson>, template: ReadonlyDeep<TemplateJson>, pipelineIdentification: string): Promise<Readonly<ReservedParameters>>;

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

@@ -0,0 +1,8 @@
+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 @@@
+ */
+export declare function getSamplesForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;

package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts

@@ -33,6 +33,7 @@ export type ParameterJson = {
     readonly sampleValues?: Array<string_parameter_value>;
 };
 /**
+ * TODO: [🧠] !!!!!! Should be here registered subparameter from foreach or not?
  * TODO: [♈] Probbably move expectations from templates to parameters
  * TODO: [🍙] Make some standard order of json properties
  */

package/esm/typings/src/types/PipelineJson/TemplateJsonCommon.d.ts

@@ -1,3 +1,4 @@
+import type { ForeachJson } from '../../commands/FOREACH/ForeachJson';
 import type { FormatCommand } from '../../commands/FORMAT/FormatCommand';
 import type { TemplateType } from '../../commands/TEMPLATE/TemplateTypes';
 import type { string_javascript } from '../typeAliases';
@@ -42,6 +43,10 @@ export interface TemplateJsonCommon {
      * @see https://github.com/webgptorg/promptbook/discussions/66
      */
     readonly jokerParameterNames?: Array<string_parameter_name>;
+    /**
+     * @@@
+     */
+    readonly foreach?: ForeachJson;
     /**
      * Type of the execution
      * This determines if the template is send to LLM, user or some scripting evaluation

package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts

@@ -39,3 +39,6 @@ export type ExecutionReportJson = {
      */
     readonly promptExecutions: Array<ExecutionPromptReportJson>;
 };
+/**
+ * TODO: !!!!!! FOREACH in report
+ */ 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/node",
-    "version": "0.69.0-1",
+    "version": "0.69.0-4",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -47,7 +47,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/node.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.69.0-1"
+        "@promptbook/core": "0.69.0-4"
     },
     "dependencies": {
         "colors": "1.4.0",