@promptbook/cli 0.62.0 → 0.62.2

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

@@ -1,64 +1,64 @@
-import type { Promisable } from 'type-fest';
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import { PipelineExecutionError } from '../errors/PipelineExecutionError';
-import type { TaskProgress } from '../types/TaskProgress';
-import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
-import type { Parameters } from '../types/typeAliases';
-import type { PromptResultUsage } from './PromptResultUsage';
-/**
- * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
- * Executor is made by combining execution tools and pipeline collection.
- *
- * It can be created with `createPipelineExecutor` function.
- *
- * @@@ almost-JSON (what about errors)
- *
- * @see https://github.com/webgptorg/promptbook#executor
- */
-export type PipelineExecutor = {
-    (inputParameters: Parameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
-};
-/**
- * @@@
- *
- * @@@ almost-JSON (what about errors)
- */
-export type PipelineExecutorResult = {
-    /**
-     * Result parameters of the execution
-     *
-     * Note: If the execution was not successful, there are only some of the result parameters
-     */
-    readonly outputParameters: Parameters;
-    /**
-     * Whether the execution was successful, details are aviable in `executionReport`
-     */
-    readonly isSuccessful: boolean;
-    /**
-     * Added usage of whole execution, detailed usage is aviable in `executionReport`
-     */
-    readonly usage: PromptResultUsage;
-    /**
-     * Errors that occured during the execution, details are aviable in `executionReport`
-     */
-    readonly errors: Array<PipelineExecutionError | Error>;
-    /**
-     * Warnings that occured during the execution, details are aviable in `executionReport`
-     */
-    readonly warnings: Array<PipelineExecutionError | Error>;
-    /**
-     * The report of the execution with all details
-     */
-    readonly executionReport: 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;
-};
-/**
- * TODO: [🧠] Should this file be in /execution or /types folder?
- * TODO: [💷] `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result - BUT maybe NOT?
- */
+import type { Promisable } from 'type-fest';
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import { PipelineExecutionError } from '../errors/PipelineExecutionError';
+import type { TaskProgress } from '../types/TaskProgress';
+import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
+import type { Parameters } from '../types/typeAliases';
+import type { PromptResultUsage } from './PromptResultUsage';
+/**
+ * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
+ * Executor is made by combining execution tools and pipeline collection.
+ *
+ * It can be created with `createPipelineExecutor` function.
+ *
+ * @@@ almost-JSON (what about errors)
+ *
+ * @see https://github.com/webgptorg/promptbook#executor
+ */
+export type PipelineExecutor = {
+    (inputParameters: Parameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
+};
+/**
+ * @@@
+ *
+ * @@@ almost-JSON (what about errors)
+ */
+export type PipelineExecutorResult = {
+    /**
+     * Result parameters of the execution
+     *
+     * Note: If the execution was not successful, there are only some of the result parameters
+     */
+    readonly outputParameters: Parameters;
+    /**
+     * Whether the execution was successful, details are aviable in `executionReport`
+     */
+    readonly isSuccessful: boolean;
+    /**
+     * Added usage of whole execution, detailed usage is aviable in `executionReport`
+     */
+    readonly usage: PromptResultUsage;
+    /**
+     * Errors that occured during the execution, details are aviable in `executionReport`
+     */
+    readonly errors: Array<PipelineExecutionError | Error>;
+    /**
+     * Warnings that occured during the execution, details are aviable in `executionReport`
+     */
+    readonly warnings: Array<PipelineExecutionError | Error>;
+    /**
+     * The report of the execution with all details
+     */
+    readonly executionReport: 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;
+};
+/**
+ * TODO: [🧠] Should this file be in /execution or /types folder?
+ * TODO: [💷] `assertsExecutionSuccessful` should be the method of `PipelineExecutor` result - BUT maybe NOT?
+ */

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

@@ -1,99 +1,99 @@
-import type { string_date_iso8601 } from '../types/typeAliases';
-import type { string_model_name } from '../types/typeAliases';
-import type { string_prompt } from '../types/typeAliases';
-import type { TODO_object } from '../utils/organization/TODO_object';
-import type { EmbeddingVector } from './EmbeddingVector';
-import type { PromptResultUsage } from './PromptResultUsage';
-/**
- * Prompt result is the simplest concept of execution.
- * It is the result of executing one prompt _(NOT a template)_.
- *
- * @see https://github.com/webgptorg/promptbook#prompt-result
- */
-export type PromptResult = CompletionPromptResult | ChatPromptResult | EmbeddingPromptResult;
-/**
- * Completion prompt result
- *
- * Note:It contains only the newly generated text NOT the whole completion
- * Note: This is fully serializable as JSON
- */
-export type CompletionPromptResult = CommonPromptResult;
-/**
- *Chat prompt result
- *
- * Note: This is fully serializable as JSON
- */
-export type ChatPromptResult = CommonPromptResult & {};
-/**
- * Embedding prompt  result
- *
- * Note: This is fully serializable as JSON
- */
-export type EmbeddingPromptResult = Omit<CommonPromptResult, 'content'> & {
-    /**
-     * The response from the model
-     */
-    content: EmbeddingVector;
-};
-/**
- * Common properties for all prompt results
- *
- * Note: This is fully serializable as JSON
- */
-export type CommonPromptResult = {
-    /**
-     * Exact text response from the model
-     */
-    readonly content: string;
-    /**
-     * Name of the model used to generate the response
-     */
-    readonly modelName: string_model_name;
-    /**
-     * Timing
-     */
-    readonly timing: {
-        /**
-         * Start of the execution
-         */
-        readonly start: string_date_iso8601;
-        /**
-         * First token generated
-         */
-        readonly firstToken?: string_date_iso8601;
-        /**
-         * End of the execution
-         */
-        readonly complete: string_date_iso8601;
-    };
-    /**
-     * Usage of the prompt execution
-     */
-    readonly usage: PromptResultUsage;
-    /**
-     * Exact text of the prompt (with all replacements)
-     *
-     * Note: This contains redundant information
-     */
-    readonly rawPromptContent: string_prompt;
-    /**
-     * Raw request to the model
-     *
-     * Note: This contains redundant information
-     */
-    readonly rawRequest: TODO_object | null;
-    /**
-     * Raw response from the model
-     *
-     * Note: This contains redundant information
-     */
-    readonly rawResponse: TODO_object;
-};
-/**
- * TODO: [🧠] Maybe timing more accurate then seconds?
- * TODO: [🧠] Should here be link to the prompt?
- * TODO: [🧠] Maybe type `rawResponse` properly - not onject but OpenAI.result.whatever
- * TODO: [🧠] Maybe remove redundant raw.choices.text
- * TODO: Log raw even if prompt failed - log the raw error
- * TODO: [🏳] Add `TranslationPromptResult`
- */
+import type { string_date_iso8601 } from '../types/typeAliases';
+import type { string_model_name } from '../types/typeAliases';
+import type { string_prompt } from '../types/typeAliases';
+import type { TODO_object } from '../utils/organization/TODO_object';
+import type { EmbeddingVector } from './EmbeddingVector';
+import type { PromptResultUsage } from './PromptResultUsage';
+/**
+ * Prompt result is the simplest concept of execution.
+ * It is the result of executing one prompt _(NOT a template)_.
+ *
+ * @see https://github.com/webgptorg/promptbook#prompt-result
+ */
+export type PromptResult = CompletionPromptResult | ChatPromptResult | EmbeddingPromptResult;
+/**
+ * Completion prompt result
+ *
+ * Note:It contains only the newly generated text NOT the whole completion
+ * Note: This is fully serializable as JSON
+ */
+export type CompletionPromptResult = CommonPromptResult;
+/**
+ *Chat prompt result
+ *
+ * Note: This is fully serializable as JSON
+ */
+export type ChatPromptResult = CommonPromptResult & {};
+/**
+ * Embedding prompt  result
+ *
+ * Note: This is fully serializable as JSON
+ */
+export type EmbeddingPromptResult = Omit<CommonPromptResult, 'content'> & {
+    /**
+     * The response from the model
+     */
+    content: EmbeddingVector;
+};
+/**
+ * Common properties for all prompt results
+ *
+ * Note: This is fully serializable as JSON
+ */
+export type CommonPromptResult = {
+    /**
+     * Exact text response from the model
+     */
+    readonly content: string;
+    /**
+     * Name of the model used to generate the response
+     */
+    readonly modelName: string_model_name;
+    /**
+     * Timing
+     */
+    readonly timing: {
+        /**
+         * Start of the execution
+         */
+        readonly start: string_date_iso8601;
+        /**
+         * First token generated
+         */
+        readonly firstToken?: string_date_iso8601;
+        /**
+         * End of the execution
+         */
+        readonly complete: string_date_iso8601;
+    };
+    /**
+     * Usage of the prompt execution
+     */
+    readonly usage: PromptResultUsage;
+    /**
+     * Exact text of the prompt (with all replacements)
+     *
+     * Note: This contains redundant information
+     */
+    readonly rawPromptContent: string_prompt;
+    /**
+     * Raw request to the model
+     *
+     * Note: This contains redundant information
+     */
+    readonly rawRequest: TODO_object | null;
+    /**
+     * Raw response from the model
+     *
+     * Note: This contains redundant information
+     */
+    readonly rawResponse: TODO_object;
+};
+/**
+ * TODO: [🧠] Maybe timing more accurate then seconds?
+ * TODO: [🧠] Should here be link to the prompt?
+ * TODO: [🧠] Maybe type `rawResponse` properly - not onject but OpenAI.result.whatever
+ * TODO: [🧠] Maybe remove redundant raw.choices.text
+ * TODO: Log raw even if prompt failed - log the raw error
+ * TODO: [🏳] Add `TranslationPromptResult`
+ */

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

@@ -1,29 +1,29 @@
-import type { KebabCase } from 'type-fest';
-import type { ExpectationUnit } from '../types/PipelineJson/Expectations';
-import type { UncertainNumber } from './UncertainNumber';
-/**
- * Usage statistics for one or many prompt results
- */
-export type PromptResultUsage = {
-    /**
-     * Cost of the execution in USD
-     *
-     * Note: If the cost is unknown, the value 0 and isUncertain is true
-     */
-    readonly price: UncertainNumber;
-    /**
-     * Number of whatever used in the input aka. `prompt_tokens`
-     */
-    readonly input: PromptResultUsageCounts;
-    /**
-     * Number of tokens used in the output aka. `completion_tokens`
-     */
-    readonly output: PromptResultUsageCounts;
-};
-/**
- * Record of all possible measurable units
- */
-export type PromptResultUsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
-/**
- * TODO: [🍙] Make some standart order of json properties
- */
+import type { KebabCase } from 'type-fest';
+import type { ExpectationUnit } from '../types/PipelineJson/Expectations';
+import type { UncertainNumber } from './UncertainNumber';
+/**
+ * Usage statistics for one or many prompt results
+ */
+export type PromptResultUsage = {
+    /**
+     * Cost of the execution in USD
+     *
+     * Note: If the cost is unknown, the value 0 and isUncertain is true
+     */
+    readonly price: UncertainNumber;
+    /**
+     * Number of whatever used in the input aka. `prompt_tokens`
+     */
+    readonly input: PromptResultUsageCounts;
+    /**
+     * Number of tokens used in the output aka. `completion_tokens`
+     */
+    readonly output: PromptResultUsageCounts;
+};
+/**
+ * Record of all possible measurable units
+ */
+export type PromptResultUsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ */

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

@@ -1,39 +1,39 @@
-import type { ScriptLanguage } from '../types/ScriptLanguage';
-import type { Parameters } from '../types/typeAliases';
-import type { string_script } from '../types/typeAliases';
-/**
- * Represents all the tools needed to EXECUTE SCRIPTs
- *
- * @see https://github.com/webgptorg/promptbook#script-execution-tools
- */
-export type ScriptExecutionTools = {
-    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
-};
-/**
- * Input for the script execution
- */
-export type ScriptExecutionToolsExecuteOptions = {
-    /**
-     * Language of the script
-     */
-    readonly scriptLanguage: ScriptLanguage;
-    /**
-     * Parameters for the script
-     * Theese parameters are passed to the script as variables
-     * For example: { "name": "John" } => const name = "John";
-     */
-    readonly parameters: Parameters;
-    /**
-     * The content of the script to execute
-     * - It can be a single statement
-     * - It can be multiple statements separated by semicolon and return
-     * - It can be a function (but you need to call it)
-     * - It can be IIFE (immediately invoked function expression)
-     * - It can use the parameters as variables and functions from global scope
-     */
-    readonly script: string_script;
-};
-/**
- * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
- * TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
- */
+import type { ScriptLanguage } from '../types/ScriptLanguage';
+import type { Parameters } from '../types/typeAliases';
+import type { string_script } from '../types/typeAliases';
+/**
+ * Represents all the tools needed to EXECUTE SCRIPTs
+ *
+ * @see https://github.com/webgptorg/promptbook#script-execution-tools
+ */
+export type ScriptExecutionTools = {
+    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
+};
+/**
+ * Input for the script execution
+ */
+export type ScriptExecutionToolsExecuteOptions = {
+    /**
+     * Language of the script
+     */
+    readonly scriptLanguage: ScriptLanguage;
+    /**
+     * Parameters for the script
+     * Theese parameters are passed to the script as variables
+     * For example: { "name": "John" } => const name = "John";
+     */
+    readonly parameters: Parameters;
+    /**
+     * The content of the script to execute
+     * - It can be a single statement
+     * - It can be multiple statements separated by semicolon and return
+     * - It can be a function (but you need to call it)
+     * - It can be IIFE (immediately invoked function expression)
+     * - It can use the parameters as variables and functions from global scope
+     */
+    readonly script: string_script;
+};
+/**
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ * TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
+ */

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

@@ -1,18 +1,18 @@
-import type { number_positive } from '../types/typeAliases';
-import type { number_usd } from '../types/typeAliases';
-/**
- * Number which can be uncertain
- *
- * Note: If the value is completelly unknown, the value 0 and isUncertain is true
- * Note: Not using NaN or null because it looses the value which is better to be uncertain then not to be at all
- */
-export type UncertainNumber = {
-    /**
-     * The numeric value
-     */
-    readonly value: number_usd & (number_positive | 0);
-    /**
-     * Is the value uncertain
-     */
-    readonly isUncertain?: true;
-};
+import type { number_positive } from '../types/typeAliases';
+import type { number_usd } from '../types/typeAliases';
+/**
+ * Number which can be uncertain
+ *
+ * Note: If the value is completelly unknown, the value 0 and isUncertain is true
+ * Note: Not using NaN or null because it looses the value which is better to be uncertain then not to be at all
+ */
+export type UncertainNumber = {
+    /**
+     * The numeric value
+     */
+    readonly value: number_usd & (number_positive | 0);
+    /**
+     * Is the value uncertain
+     */
+    readonly isUncertain?: true;
+};

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

@@ -1,46 +1,46 @@
-import type { number_integer } from '../types/typeAliases';
-import type { number_positive } from '../types/typeAliases';
-/**
- * Represents all the tools needed to interact with the user.
- *
- * @see https://github.com/webgptorg/promptbook#user-interface-tools
- */
-export type UserInterfaceTools = {
-    /**
-     * Asks the user to answer a free-text (multi-line) question
-     *
-     * @param options the question to ask
-     * @returns the answer from the user
-     */
-    promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
-};
-export type UserInterfaceToolsPromptDialogOptions = {
-    /**
-     * Prompt title
-     *
-     * Note: This is not a prompt to language model but a prompt to the user
-     * @example "Your name"
-     */
-    readonly promptTitle: string;
-    /**
-     * Prompt message
-     *
-     * Note: This is not a prompt to language model but a prompt to the user
-     * @example "Please enter your name, including your last name, title, etc."
-     */
-    readonly promptMessage: string;
-    /**
-     * Default value for the input/textarea
-     */
-    readonly defaultValue: string | null;
-    /**
-     * Placeholder for the input/textarea
-     */
-    readonly placeholder?: string;
-    /**
-     * Priority of the prompt
-     *
-     * Note: This would be reflected for example into the UI z-index of the prompt modal
-     */
-    readonly priority: number_integer & number_positive;
-};
+import type { number_integer } from '../types/typeAliases';
+import type { number_positive } from '../types/typeAliases';
+/**
+ * Represents all the tools needed to interact with the user.
+ *
+ * @see https://github.com/webgptorg/promptbook#user-interface-tools
+ */
+export type UserInterfaceTools = {
+    /**
+     * Asks the user to answer a free-text (multi-line) question
+     *
+     * @param options the question to ask
+     * @returns the answer from the user
+     */
+    promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
+};
+export type UserInterfaceToolsPromptDialogOptions = {
+    /**
+     * Prompt title
+     *
+     * Note: This is not a prompt to language model but a prompt to the user
+     * @example "Your name"
+     */
+    readonly promptTitle: string;
+    /**
+     * Prompt message
+     *
+     * Note: This is not a prompt to language model but a prompt to the user
+     * @example "Please enter your name, including your last name, title, etc."
+     */
+    readonly promptMessage: string;
+    /**
+     * Default value for the input/textarea
+     */
+    readonly defaultValue: string | null;
+    /**
+     * Placeholder for the input/textarea
+     */
+    readonly placeholder?: string;
+    /**
+     * Priority of the prompt
+     *
+     * Note: This would be reflected for example into the UI z-index of the prompt modal
+     */
+    readonly priority: number_integer & number_positive;
+};

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

@@ -1,11 +1,11 @@
-import type { PipelineExecutor } from './PipelineExecutor';
-/**
- * Asserts that the execution of a promptnook is successful
- *
- * @param executionResult - The partial result of the promptnook execution
- * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
- */
-export declare function assertsExecutionSuccessful(executionResult: Pick<Awaited<ReturnType<PipelineExecutor>>, 'isSuccessful' | 'errors'>): void;
-/**
- * TODO: [🧠] Can this return type be better typed than void
- */
+import type { PipelineExecutor } from './PipelineExecutor';
+/**
+ * Asserts that the execution of a promptnook is successful
+ *
+ * @param executionResult - The partial result of the promptnook execution
+ * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
+ */
+export declare function assertsExecutionSuccessful(executionResult: Pick<Awaited<ReturnType<PipelineExecutor>>, 'isSuccessful' | 'errors'>): void;
+/**
+ * TODO: [🧠] Can this return type be better typed than void
+ */