@promptbook/utils 0.41.0 → 0.41.2

package/esm/typings/execution/ExecutionTools.d.ts

@@ -1,25 +1,25 @@
-import { NaturalExecutionTools } from './NaturalExecutionTools';
-import { ScriptExecutionTools } from './ScriptExecutionTools';
-import { UserInterfaceTools } from './UserInterfaceTools';
-/**
- * All the tools needed to execute prompts (template pipelines).
- *
- * @see https://github.com/webgptorg/promptbook#execution-tools
- */
-export type ExecutionTools = {
-    /**
-     * Tools for executing prompts to large language models like GPT-4
-     */
-    natural: NaturalExecutionTools;
-    /**
-     * Tools for executing scripts
-     *
-     * Note: You can pass multiple ScriptExecutionTools, they will be tried one by one until one of them supports the script
-     *       If none of them supports the script, an error is thrown
-     */
-    script: Array<ScriptExecutionTools>;
-    /**
-     * Tools for interacting with the user
-     */
-    userInterface: UserInterfaceTools;
-};
+import { NaturalExecutionTools } from './NaturalExecutionTools';
+import { ScriptExecutionTools } from './ScriptExecutionTools';
+import { UserInterfaceTools } from './UserInterfaceTools';
+/**
+ * All the tools needed to execute prompts (template pipelines).
+ *
+ * @see https://github.com/webgptorg/promptbook#execution-tools
+ */
+export type ExecutionTools = {
+    /**
+     * Tools for executing prompts to large language models like GPT-4
+     */
+    natural: NaturalExecutionTools;
+    /**
+     * Tools for executing scripts
+     *
+     * Note: You can pass multiple ScriptExecutionTools, they will be tried one by one until one of them supports the script
+     *       If none of them supports the script, an error is thrown
+     */
+    script: Array<ScriptExecutionTools>;
+    /**
+     * Tools for interacting with the user
+     */
+    userInterface: UserInterfaceTools;
+};

package/esm/typings/execution/NaturalExecutionTools.d.ts

@@ -1,23 +1,23 @@
-import { Prompt } from '../types/Prompt';
-import { PromptChatResult, PromptCompletionResult } from './PromptResult';
-/**
- * Vontainer for all the tools needed to execute prompts to large language models like GPT-4
- * On its interface it exposes common methods for prompt execution.
- * Inside (in constructor) it calls OpenAI, Azure, GPU, proxy, cache, logging,...
- *
- * @see https://github.com/webgptorg/promptbook#natural-execution-tools
- */
-export type NaturalExecutionTools = {
-    /**
-     * Use a chat model
-     */
-    gptChat(prompt: Prompt): Promise<PromptChatResult>;
-    /**
-     * Use a completion model
-     */
-    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
-};
-/**
- * TODO: [🏳] gptChat -> chat, gptComplete -> complete, translate
- * TODO: [🧠] Should or should not there be a word "GPT" in both gptComplete and gptChat
- */
+import { Prompt } from '../types/Prompt';
+import { PromptChatResult, PromptCompletionResult } from './PromptResult';
+/**
+ * Vontainer for all the tools needed to execute prompts to large language models like GPT-4
+ * On its interface it exposes common methods for prompt execution.
+ * Inside (in constructor) it calls OpenAI, Azure, GPU, proxy, cache, logging,...
+ *
+ * @see https://github.com/webgptorg/promptbook#natural-execution-tools
+ */
+export type NaturalExecutionTools = {
+    /**
+     * Use a chat model
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    /**
+     * Use a completion model
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+};
+/**
+ * TODO: [🏳] gptChat -> chat, gptComplete -> complete, translate
+ * TODO: [🧠] Should or should not there be a word "GPT" in both gptComplete and gptChat
+ */

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

@@ -1,74 +1,74 @@
-import type { number_positive_or_zero, number_tokens, number_usd, string_date_iso8601, string_model_name } from '.././types/typeAliases';
-/**
- * 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 = PromptCompletionResult | PromptChatResult;
-/**
- * Prompt completion result
- * It contains only the following text NOT the whole completion
- */
-export type PromptCompletionResult = PromptCommonResult;
-/**
- * Prompt chat result
- */
-export type PromptChatResult = PromptCommonResult & {};
-export type PromptCommonResult = {
-    /**
-     * Exact text response from the model
-     */
-    readonly content: string;
-    /**
-     * Name of the model used to generate the response
-     */
-    readonly model: string_model_name;
-    /**
-     * Timing
-     */
-    readonly timing: {
-        /**
-         * Start of the execution
-         */
-        start: string_date_iso8601;
-        /**
-         * First token generated
-         */
-        firstToken?: string_date_iso8601;
-        /**
-         * End of the execution
-         */
-        complete: string_date_iso8601;
-    };
-    /**
-     * Usage of the prompt execution
-     */
-    readonly usage: {
-        /**
-         * Cost of the execution in USD
-         *
-         * If the cost is unknown, the value is `'UNKNOWN'`
-         */
-        price: (number_positive_or_zero & number_usd) | 'UNKNOWN';
-        /**
-         * Number of tokens used in the input aka. `prompt_tokens`
-         */
-        inputTokens: number_tokens;
-        /**
-         * Number of tokens used in the output aka. `completion_tokens`
-         */
-        outputTokens: number_tokens;
-    };
-    /**
-     * Raw response from the model
-     */
-    readonly rawResponse: object;
-};
-/**
- * TODO: [🧠] Maybe timing more accurate then seconds?
- * TODO: [🧠] Should here be link to the prompt?
- * TODO: [🧠] Maybe type raw 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
- */
+import type { number_positive_or_zero, number_tokens, number_usd, string_date_iso8601, string_model_name } from '.././types/typeAliases';
+/**
+ * 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 = PromptCompletionResult | PromptChatResult;
+/**
+ * Prompt completion result
+ * It contains only the following text NOT the whole completion
+ */
+export type PromptCompletionResult = PromptCommonResult;
+/**
+ * Prompt chat result
+ */
+export type PromptChatResult = PromptCommonResult & {};
+export type PromptCommonResult = {
+    /**
+     * Exact text response from the model
+     */
+    readonly content: string;
+    /**
+     * Name of the model used to generate the response
+     */
+    readonly model: string_model_name;
+    /**
+     * Timing
+     */
+    readonly timing: {
+        /**
+         * Start of the execution
+         */
+        start: string_date_iso8601;
+        /**
+         * First token generated
+         */
+        firstToken?: string_date_iso8601;
+        /**
+         * End of the execution
+         */
+        complete: string_date_iso8601;
+    };
+    /**
+     * Usage of the prompt execution
+     */
+    readonly usage: {
+        /**
+         * Cost of the execution in USD
+         *
+         * If the cost is unknown, the value is `'UNKNOWN'`
+         */
+        price: (number_positive_or_zero & number_usd) | 'UNKNOWN';
+        /**
+         * Number of tokens used in the input aka. `prompt_tokens`
+         */
+        inputTokens: number_tokens;
+        /**
+         * Number of tokens used in the output aka. `completion_tokens`
+         */
+        outputTokens: number_tokens;
+    };
+    /**
+     * Raw response from the model
+     */
+    readonly rawResponse: object;
+};
+/**
+ * TODO: [🧠] Maybe timing more accurate then seconds?
+ * TODO: [🧠] Should here be link to the prompt?
+ * TODO: [🧠] Maybe type raw 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
+ */

package/esm/typings/execution/PromptbookExecutor.d.ts

@@ -1,39 +1,39 @@
-import type { Promisable } from 'type-fest';
-import type { TaskProgress } from '../types/TaskProgress';
-import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
-import type { string_name } from '../types/typeAliases';
-/**
- * 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 promptbook library.
- *
- * It can be done in two ways:
- * -   From `PromptbookLibrary.getExecutor` method
- * -   `createPromptbookExecutor` utility function
- *
- * @see https://github.com/webgptorg/promptbook#executor
- */
-export type PromptbookExecutor = {
-    (inputParameters: Record<string_name, string>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
-        /**
-         * Whether the execution was successful
-         */
-        isSuccessful: boolean;
-        /**
-         * Errors that occured during the execution
-         */
-        errors: Array<Error>;
-        /**
-         * The report of the execution
-         */
-        executionReport: ExecutionReportJson;
-        /**
-         * Result parameters of the execution
-         *
-         * Note: If the execution was not successful, there are only some of the result parameters
-         */
-        outputParameters: Record<string_name, string>;
-    }>;
-};
-/**
- * TODO: [🧠] Should this file be in /execution or /types folder?
- */
+import type { Promisable } from 'type-fest';
+import type { TaskProgress } from '../types/TaskProgress';
+import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
+import type { string_name } from '../types/typeAliases';
+/**
+ * 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 promptbook library.
+ *
+ * It can be done in two ways:
+ * -   From `PromptbookLibrary.getExecutor` method
+ * -   `createPromptbookExecutor` utility function
+ *
+ * @see https://github.com/webgptorg/promptbook#executor
+ */
+export type PromptbookExecutor = {
+    (inputParameters: Record<string_name, string>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
+        /**
+         * Whether the execution was successful
+         */
+        isSuccessful: boolean;
+        /**
+         * Errors that occured during the execution
+         */
+        errors: Array<Error>;
+        /**
+         * The report of the execution
+         */
+        executionReport: ExecutionReportJson;
+        /**
+         * Result parameters of the execution
+         *
+         * Note: If the execution was not successful, there are only some of the result parameters
+         */
+        outputParameters: Record<string_name, string>;
+    }>;
+};
+/**
+ * TODO: [🧠] Should this file be in /execution or /types folder?
+ */

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

@@ -1,37 +1,37 @@
-import { string_name, string_script } from '.././types/typeAliases';
-import { ScriptLanguage } from '../types/ScriptLanguage';
-/**
- * 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
-     */
-    scriptLanguage: ScriptLanguage;
-    /**
-     * Parameters for the script
-     * Theese parameters are passed to the script as variables
-     * For example: { "name": "John" } => const name = "John";
-     */
-    parameters: Record<string_name, string>;
-    /**
-     * 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
-     */
-    script: string_script;
-};
-/**
- * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
- */
+import { string_name, string_script } from '.././types/typeAliases';
+import { ScriptLanguage } from '../types/ScriptLanguage';
+/**
+ * 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
+     */
+    scriptLanguage: ScriptLanguage;
+    /**
+     * Parameters for the script
+     * Theese parameters are passed to the script as variables
+     * For example: { "name": "John" } => const name = "John";
+     */
+    parameters: Record<string_name, string>;
+    /**
+     * 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
+     */
+    script: string_script;
+};
+/**
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ */

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

@@ -1,45 +1,45 @@
-import { number_integer, 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"
-     */
-    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."
-     */
-    promptMessage: string;
-    /**
-     * Default value for the input/textarea
-     */
-    defaultValue: string | null;
-    /**
-     * Placeholder for the input/textarea
-     */
-    placeholder?: string;
-    /**
-     * Priority of the prompt
-     *
-     * Note: This would be reflected for example into the UI z-index of the prompt modal
-     */
-    priority: number_integer & number_positive;
-};
+import { number_integer, 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"
+     */
+    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."
+     */
+    promptMessage: string;
+    /**
+     * Default value for the input/textarea
+     */
+    defaultValue: string | null;
+    /**
+     * Placeholder for the input/textarea
+     */
+    placeholder?: string;
+    /**
+     * Priority of the prompt
+     *
+     * Note: This would be reflected for example into the UI z-index of the prompt modal
+     */
+    priority: number_integer & number_positive;
+};

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

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

package/esm/typings/execution/createPromptbookExecutor.d.ts

@@ -1,41 +1,41 @@
-import { PromptbookJson } from '../_packages/types.index';
-import { ExecutionTools } from './ExecutionTools';
-import { PromptbookExecutor } from './PromptbookExecutor';
-type CreatePromptbookExecutorSettings = {
-    /**
-     * When executor does not satisfy expectations it will be retried this amount of times
-     *
-     * @default 3
-     */
-    readonly maxExecutionAttempts: number;
-};
-/**
- * Options for creating a promptbook executor
- */
-interface CreatePromptbookExecutorOptions {
-    /**
-     * The promptbook to be executed
-     */
-    readonly promptbook: PromptbookJson;
-    /**
-     * The execution tools to be used during the execution of the PROMPTBOOK
-     */
-    readonly tools: ExecutionTools;
-    /**
-     * Optional settings for the PROMPTBOOK executor
-     */
-    readonly settings?: Partial<CreatePromptbookExecutorSettings>;
-}
-/**
- * Creates executor function from promptbook and execution tools.
- *
- * Note: Consider using getExecutor method of the library instead of using this function
- */
-export declare function createPromptbookExecutor(options: CreatePromptbookExecutorOptions): PromptbookExecutor;
-export {};
-/**
- * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
- * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
- * Note: CreatePromptbookExecutorOptions are just connected to PromptbookExecutor so do not extract to types folder
- * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
- */
+import { PromptbookJson } from '../_packages/types.index';
+import { ExecutionTools } from './ExecutionTools';
+import { PromptbookExecutor } from './PromptbookExecutor';
+type CreatePromptbookExecutorSettings = {
+    /**
+     * When executor does not satisfy expectations it will be retried this amount of times
+     *
+     * @default 3
+     */
+    readonly maxExecutionAttempts: number;
+};
+/**
+ * Options for creating a promptbook executor
+ */
+interface CreatePromptbookExecutorOptions {
+    /**
+     * The promptbook to be executed
+     */
+    readonly promptbook: PromptbookJson;
+    /**
+     * The execution tools to be used during the execution of the PROMPTBOOK
+     */
+    readonly tools: ExecutionTools;
+    /**
+     * Optional settings for the PROMPTBOOK executor
+     */
+    readonly settings?: Partial<CreatePromptbookExecutorSettings>;
+}
+/**
+ * Creates executor function from promptbook and execution tools.
+ *
+ * Note: Consider using getExecutor method of the library instead of using this function
+ */
+export declare function createPromptbookExecutor(options: CreatePromptbookExecutorOptions): PromptbookExecutor;
+export {};
+/**
+ * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
+ * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
+ * Note: CreatePromptbookExecutorOptions are just connected to PromptbookExecutor so do not extract to types folder
+ * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
+ */

package/esm/typings/execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools.d.ts

@@ -1,22 +1,22 @@
-import { Prompt } from '../../../../types/Prompt';
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { NaturalExecutionTools } from '../../../NaturalExecutionTools';
-import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
-/**
- * Mocked execution Tools for just echoing the requests for testing purposes.
- */
-export declare class MockedEchoNaturalExecutionTools implements NaturalExecutionTools {
-    private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
-    /**
-     * Mocks chat model
-     */
-    gptChat(prompt: Prompt): Promise<PromptChatResult>;
-    /**
-     * Mocks completion model
-     */
-    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
-}
-/**
- * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}
- */
+import { Prompt } from '../../../../types/Prompt';
+import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+/**
+ * Mocked execution Tools for just echoing the requests for testing purposes.
+ */
+export declare class MockedEchoNaturalExecutionTools implements NaturalExecutionTools {
+    private readonly options;
+    constructor(options: CommonExecutionToolsOptions);
+    /**
+     * Mocks chat model
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    /**
+     * Mocks completion model
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+}
+/**
+ * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}
+ */

package/esm/typings/execution/plugins/natural-execution-tools/mocked/joker.test.d.ts

@@ -1,4 +1,4 @@
-export {};
-/**
- * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPromptbookExecutor.test.ts"
- */
+export {};
+/**
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPromptbookExecutor.test.ts"
+ */