@promptbook/utils 0.41.4 → 0.41.101

package/esm/typings/conversion/prettify/prettifyPromptbookString.d.ts

@@ -1,10 +1,11 @@
-import { PromptbookString } from '../../types/PromptbookString';
-import type { PrettifyOptions } from './PrettifyOptions';
-/**
- * !!!
- */
-export declare function prettifyPromptbookString(promptbookString: PromptbookString, options: PrettifyOptions): PromptbookString;
-/**
- * TODO: [🧠] Should this be here OR in other folder
- * TODO: [🕌] When more than 2 functionalities, split into separate functions
- */
+import { PromptbookString } from '../../types/PromptbookString';
+import type { PrettifyOptions } from './PrettifyOptions';
+/**
+ * !!!
+ */
+export declare function prettifyPromptbookString(promptbookString: PromptbookString, options: PrettifyOptions): PromptbookString;
+/**
+ * TODO: Maybe use some Mermaid library instead of string templating
+ * TODO: [🧠] Should this be here OR in other folder
+ * TODO: [🕌] When more than 2 functionalities, split into separate functions
+ */

package/esm/typings/conversion/prettify/prettifyPromptbookStringCli.d.ts

@@ -1,9 +1,9 @@
-/**
- * !!! Initialize
- */
-export declare function prettifyPromptbookStringCli(): Promise<void>;
-/**
- * TODO: [🥠] Do not export to utils directly, its just for CLI script
- * TODO: [🌰] Use just prettifyPromptbookStringCli
- * Note: 11:11
- */
+/**
+ * !!! Initialize
+ */
+export declare function prettifyPromptbookStringCli(): Promise<void>;
+/**
+ * TODO: [🥠] Do not export to utils directly, its just for CLI script
+ * TODO: [🕌] When more functionalities, rename
+ * Note: 11:11
+ */

package/esm/typings/conversion/promptbookStringToJson.d.ts

@@ -1,13 +1,13 @@
-import { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import { PromptbookString } from '../types/PromptbookString';
-/**
- * Parse promptbook from string format to JSON format
- *
- * Note: This function does not validate logic of the pipeline only the syntax
- */
-export declare function promptbookStringToJson(promptbookString: PromptbookString): PromptbookJson;
-/**
- * TODO: Report here line/column of error
- * TODO: Use spaceTrim more effectively
- * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
- */
+import { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import { PromptbookString } from '../types/PromptbookString';
+/**
+ * Parse promptbook from string format to JSON format
+ *
+ * Note: This function does not validate logic of the pipeline only the syntax
+ */
+export declare function promptbookStringToJson(promptbookString: PromptbookString): PromptbookJson;
+/**
+ * TODO: Report here line/column of error
+ * TODO: Use spaceTrim more effectively
+ * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
+ */

package/esm/typings/conversion/test/_importPromptbook.d.ts

@@ -1,12 +1,12 @@
-import { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import { PromptbookString } from '../../types/PromptbookString';
-/**
- * Import the text file
- *
- * Note: Using here custom import to work in jest tests
- * Note: Using sync version is 💩 in the production code, but it's ok here in tests
- *
- * @private
- */
-export declare function importPromptbook(path: `${string}.ptbk.md`): PromptbookString;
-export declare function importPromptbook(path: `${string}.ptbk.json`): PromptbookJson;
+import { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import { PromptbookString } from '../../types/PromptbookString';
+/**
+ * Import the text file
+ *
+ * Note: Using here custom import to work in jest tests
+ * Note: Using sync version is 💩 in the production code, but it's ok here in tests
+ *
+ * @private
+ */
+export declare function importPromptbook(path: `${string}.ptbk.md`): PromptbookString;
+export declare function importPromptbook(path: `${string}.ptbk.json`): PromptbookJson;

package/esm/typings/conversion/test/promptbookStringToJson-syntaxErrors.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/esm/typings/conversion/test/promptbookStringToJson.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/esm/typings/conversion/test/validatePromptbookJson-logicErrors.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/esm/typings/conversion/test/validatePromptbookJson.d.ts

@@ -1,26 +1,26 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-/**
- * Validates PromptbookJson if it is logically valid.
- *
- * It checks:
- * -   if it has correct parameters dependency
- *
- * It does NOT check:
- * -   if it is valid json
- * -   if it is meaningful
- *
- * @param promptbook valid or invalid PromptbookJson
- * @throws {Error} if invalid
- */
-export declare function validatePromptbookJson(promptbook: PromptbookJson): void;
-/**
- * TODO: [🧠] Work with promptbookVersion
- * TODO: Use here some json-schema, Zod or something similar and change it to:
- *     > /**
- *     >  * Validates PromptbookJson if it is logically valid.
- *     >  *
- *     >  * It checks:
- *     >  * -   it has a valid structure
- *     >  * -   ...
- *     >  ex port function validatePromptbookJson(promptbook: unknown): asserts promptbook is PromptbookJson {
- */
+import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+/**
+ * Validates PromptbookJson if it is logically valid.
+ *
+ * It checks:
+ * -   if it has correct parameters dependency
+ *
+ * It does NOT check:
+ * -   if it is valid json
+ * -   if it is meaningful
+ *
+ * @param promptbook valid or invalid PromptbookJson
+ * @throws {Error} if invalid
+ */
+export declare function validatePromptbookJson(promptbook: PromptbookJson): void;
+/**
+ * TODO: [🧠] Work with promptbookVersion
+ * TODO: Use here some json-schema, Zod or something similar and change it to:
+ *     > /**
+ *     >  * Validates PromptbookJson if it is logically valid.
+ *     >  *
+ *     >  * It checks:
+ *     >  * -   it has a valid structure
+ *     >  * -   ...
+ *     >  ex port function validatePromptbookJson(promptbook: unknown): asserts promptbook is PromptbookJson {
+ */

package/esm/typings/conversion/test/validatePromptbookJson.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/esm/typings/conversion/utils/extractVariables.d.ts

@@ -1,10 +1,10 @@
-import { string_javascript, string_javascript_name } from '../../types/typeAliases';
-/**
- * Parses the given script and returns the list of all used variables that are not defined in the script
- *
- * @param script from which to extract the variables
- * @returns the list of variable names
- *
- * @private within the promptbookStringToJson
- */
-export declare function extractVariables(script: string_javascript): Array<string_javascript_name>;
+import { string_javascript, string_javascript_name } from '../../types/typeAliases';
+/**
+ * Parses the given script and returns the list of all used variables that are not defined in the script
+ *
+ * @param script from which to extract the variables
+ * @returns the list of variable names
+ *
+ * @private within the promptbookStringToJson
+ */
+export declare function extractVariables(script: string_javascript): Array<string_javascript_name>;

package/esm/typings/conversion/utils/extractVariables.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/esm/typings/conversion/utils/parseCommand.d.ts

@@ -1,8 +1,8 @@
-import type { Command } from '../../types/Command';
-import type { string_markdown_text } from '../../types/typeAliases';
-/**
- * Parses one line of ul/ol to command
- *
- * @private within the promptbookStringToJson
- */
-export declare function parseCommand(listItem: string_markdown_text): Command;
+import type { Command } from '../../types/Command';
+import type { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Parses one line of ul/ol to command
+ *
+ * @private within the promptbookStringToJson
+ */
+export declare function parseCommand(listItem: string_markdown_text): Command;

package/esm/typings/conversion/utils/parseCommand.test.d.ts

@@ -1,4 +1,4 @@
-export {};
-/**
- * TODO: [🧠] Probbably change syntax MODEL VARIANT -> MODEL
- */
+export {};
+/**
+ * TODO: [🧠] Probbably change syntax MODEL VARIANT -> MODEL
+ */

package/esm/typings/conversion/utils/parseNumber.d.ts

@@ -1,12 +1,12 @@
-/**
- * Function parseNumber will parse number from string
- *
- * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
- * Note: it also works only with decimal numbers
- *
- * @private within the parseCommand
- */
-export declare function parseNumber(value: string | number): number;
-/**
- * TODO: Maybe use sth. like safe-eval in fraction/calculation case @see https://www.npmjs.com/package/safe-eval
- */
+/**
+ * Function parseNumber will parse number from string
+ *
+ * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
+ * Note: it also works only with decimal numbers
+ *
+ * @private within the parseCommand
+ */
+export declare function parseNumber(value: string | number): number;
+/**
+ * TODO: Maybe use sth. like safe-eval in fraction/calculation case @see https://www.npmjs.com/package/safe-eval
+ */

package/esm/typings/conversion/utils/parseNumber.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/esm/typings/errors/ExpectError.d.ts

@@ -1,9 +1,9 @@
-/**
- * This error occurs when some expectation is not met in the execution of the pipeline
- *
- * Note: This is a kindof subtype of PromptbookExecutionError
- */
-export declare class ExpectError extends Error {
-    readonly name = "ExpectError";
-    constructor(message: string);
-}
+/**
+ * This error occurs when some expectation is not met in the execution of the pipeline
+ *
+ * Note: This is a kindof subtype of PromptbookExecutionError
+ */
+export declare class ExpectError extends Error {
+    readonly name = "ExpectError";
+    constructor(message: string);
+}

package/esm/typings/errors/NotFoundError.d.ts

@@ -1,7 +1,7 @@
-/**
- * This error indicates that the requested resource (for example promptbook in the library ) was not found
- */
-export declare class NotFoundError extends Error {
-    readonly name = "NotFoundError";
-    constructor(message: string);
-}
+/**
+ * This error indicates that the requested resource (for example promptbook in the library ) was not found
+ */
+export declare class NotFoundError extends Error {
+    readonly name = "NotFoundError";
+    constructor(message: string);
+}

package/esm/typings/errors/PromptbookExecutionError.d.ts

@@ -1,7 +1,7 @@
-/**
- * This error indicates errors during the execution of the promptbook
- */
-export declare class PromptbookExecutionError extends Error {
-    readonly name = "PromptbookExecutionError";
-    constructor(message: string);
-}
+/**
+ * This error indicates errors during the execution of the promptbook
+ */
+export declare class PromptbookExecutionError extends Error {
+    readonly name = "PromptbookExecutionError";
+    constructor(message: string);
+}

package/esm/typings/errors/PromptbookLogicError.d.ts

@@ -1,7 +1,7 @@
-/**
- * This error indicates that the promptbook object has valid syntax but contains logical errors (like circular dependencies)
- */
-export declare class PromptbookLogicError extends Error {
-    readonly name = "PromptbookLogicError";
-    constructor(message: string);
-}
+/**
+ * This error indicates that the promptbook object has valid syntax but contains logical errors (like circular dependencies)
+ */
+export declare class PromptbookLogicError extends Error {
+    readonly name = "PromptbookLogicError";
+    constructor(message: string);
+}

package/esm/typings/errors/PromptbookReferenceError.d.ts

@@ -1,7 +1,7 @@
-/**
- * This error indicates errors in referencing promptbooks between each other
- */
-export declare class PromptbookReferenceError extends Error {
-    readonly name = "PromptbookReferenceError";
-    constructor(message: string);
-}
+/**
+ * This error indicates errors in referencing promptbooks between each other
+ */
+export declare class PromptbookReferenceError extends Error {
+    readonly name = "PromptbookReferenceError";
+    constructor(message: string);
+}

package/esm/typings/errors/PromptbookSyntaxError.d.ts

@@ -1,7 +1,7 @@
-/**
- * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
- */
-export declare class PromptbookSyntaxError extends Error {
-    readonly name = "PromptbookSyntaxError";
-    constructor(message: string);
-}
+/**
+ * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
+ */
+export declare class PromptbookSyntaxError extends Error {
+    readonly name = "PromptbookSyntaxError";
+    constructor(message: string);
+}

package/esm/typings/errors/UnexpectedError.d.ts

@@ -1,7 +1,7 @@
-/**
- * This error type indicates that the error should not happen and its last check before crashing with some other error
- */
-export declare class UnexpectedError extends Error {
-    readonly name = "UnexpectedError";
-    constructor(message: string);
-}
+/**
+ * This error type indicates that the error should not happen and its last check before crashing with some other error
+ */
+export declare class UnexpectedError extends Error {
+    readonly name = "UnexpectedError";
+    constructor(message: string);
+}

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

@@ -1,9 +1,9 @@
-export type CommonExecutionToolsOptions = {
-    /**
-     * If true, the internal executions will be logged
-     */
-    readonly isVerbose?: boolean;
-};
-/**
- * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
- */
+export type CommonExecutionToolsOptions = {
+    /**
+     * If true, the internal executions will be logged
+     */
+    readonly isVerbose?: boolean;
+};
+/**
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ */

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