@promptbook/utils 0.41.0 → 0.41.2

package/umd/typings/types/PromptbookJson/PromptTemplateJson.d.ts

@@ -1,126 +1,126 @@
-import { ExpectFormatCommand } from '../Command';
-import { ExecutionType } from '../ExecutionTypes';
-import { ModelRequirements } from '../ModelRequirements';
-import { ScriptLanguage } from '../ScriptLanguage';
-import { number_integer, number_positive_or_zero, string_javascript, string_javascript_name, string_markdown, string_name, string_prompt, string_template } from '../typeAliases';
-/**
- * Describes one prompt template in the promptbook
- */
-export type PromptTemplateJson = NaturalTemplateJson | SimpleTemplateJson | ScriptTemplateJson | PromptDialogJson;
-/**
- * Template for prompt to LLM
- */
-export type NaturalTemplateJson = PromptTemplateJsonCommon & {
-    readonly executionType: 'PROMPT_TEMPLATE';
-    /**
-     * Requirements for the model
-     * - This is required only for executionType PROMPT_TEMPLATE
-     */
-    readonly modelRequirements: ModelRequirements;
-};
-/**
- * Units of text measurement
- */
-export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "PARAGRAPHS", "LINES", "PAGES"];
-/**
- * Unit of text measurement
- */
-export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
-/**
- * Amount of text measurement
- */
-export type ExpectationAmount = number_integer & number_positive_or_zero;
-/**
- * Template for simple concatenation of strings
- */
-interface SimpleTemplateJson extends PromptTemplateJsonCommon {
-    readonly executionType: 'SIMPLE_TEMPLATE';
-}
-/**
- * Template for script execution
- */
-interface ScriptTemplateJson extends PromptTemplateJsonCommon {
-    readonly executionType: 'SCRIPT';
-    /**
-     * Language of the script
-     * - This is required only for executionType SCRIPT
-     *
-     */
-    readonly contentLanguage?: ScriptLanguage;
-}
-/**
- * Template for prompt to user
- */
-interface PromptDialogJson extends PromptTemplateJsonCommon {
-    readonly executionType: 'PROMPT_DIALOG';
-}
-/**
- * Common properties of all prompt templates
- */
-interface PromptTemplateJsonCommon {
-    /**
-     * Name of the template
-     * - It must be unique across the pipeline
-     * - It should start uppercase and contain letters and numbers
-     * - The promptbookUrl together with hash and name are used to identify the prompt template in the pipeline
-     */
-    readonly name: string_name;
-    /**
-     * Title of the prompt template
-     * It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
-     */
-    readonly title: string;
-    /**
-     * Description of the prompt template
-     * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
-     */
-    readonly description?: string;
-    /**
-     * List of parameter names that are used in the prompt template and must be defined before the prompt template is executed
-     *
-     * Note: Joker is one of the dependent parameters
-     */
-    readonly dependentParameterNames: Array<string_name>;
-    /**
-     * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
-     */
-    readonly jokers?: Array<string>;
-    /**
-     * Type of the execution
-     * This determines if the prompt template is send to LLM, user or some scripting evaluation
-     */
-    readonly executionType: ExecutionType;
-    /**
-     * Content of the template with {placeholders} for parameters
-     */
-    readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
-    /**
-     * List of postprocessing steps that are executed after the prompt template
-     */
-    readonly postprocessing?: Array<string_javascript_name>;
-    /**
-     * Expect this amount of each unit in the answer
-     *
-     * For example 5 words, 3 sentences, 2 paragraphs, ...
-     *
-     * Note: Expectations are performed after all postprocessing steps
-     */
-    readonly expectAmount?: Partial<Record<Lowercase<ExpectationUnit>, {
-        min?: ExpectationAmount;
-        max?: ExpectationAmount;
-    }>>;
-    /**
-     * Expect this format of the answer
-     *
-     * Note: Expectations are performed after all postprocessing steps
-     */
-    readonly expectFormat?: ExpectFormatCommand['format'];
-    /**
-     * Name of the parameter that is the result of the prompt template
-     */
-    readonly resultingParameterName: string_name;
-}
-export {};
-/**
- * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
- */
+import { ExpectFormatCommand } from '../Command';
+import { ExecutionType } from '../ExecutionTypes';
+import { ModelRequirements } from '../ModelRequirements';
+import { ScriptLanguage } from '../ScriptLanguage';
+import { number_integer, number_positive_or_zero, string_javascript, string_javascript_name, string_markdown, string_name, string_prompt, string_template } from '../typeAliases';
+/**
+ * Describes one prompt template in the promptbook
+ */
+export type PromptTemplateJson = NaturalTemplateJson | SimpleTemplateJson | ScriptTemplateJson | PromptDialogJson;
+/**
+ * Template for prompt to LLM
+ */
+export type NaturalTemplateJson = PromptTemplateJsonCommon & {
+    readonly executionType: 'PROMPT_TEMPLATE';
+    /**
+     * Requirements for the model
+     * - This is required only for executionType PROMPT_TEMPLATE
+     */
+    readonly modelRequirements: ModelRequirements;
+};
+/**
+ * Units of text measurement
+ */
+export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "PARAGRAPHS", "LINES", "PAGES"];
+/**
+ * Unit of text measurement
+ */
+export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
+/**
+ * Amount of text measurement
+ */
+export type ExpectationAmount = number_integer & number_positive_or_zero;
+/**
+ * Template for simple concatenation of strings
+ */
+interface SimpleTemplateJson extends PromptTemplateJsonCommon {
+    readonly executionType: 'SIMPLE_TEMPLATE';
+}
+/**
+ * Template for script execution
+ */
+interface ScriptTemplateJson extends PromptTemplateJsonCommon {
+    readonly executionType: 'SCRIPT';
+    /**
+     * Language of the script
+     * - This is required only for executionType SCRIPT
+     *
+     */
+    readonly contentLanguage?: ScriptLanguage;
+}
+/**
+ * Template for prompt to user
+ */
+interface PromptDialogJson extends PromptTemplateJsonCommon {
+    readonly executionType: 'PROMPT_DIALOG';
+}
+/**
+ * Common properties of all prompt templates
+ */
+interface PromptTemplateJsonCommon {
+    /**
+     * Name of the template
+     * - It must be unique across the pipeline
+     * - It should start uppercase and contain letters and numbers
+     * - The promptbookUrl together with hash and name are used to identify the prompt template in the pipeline
+     */
+    readonly name: string_name;
+    /**
+     * Title of the prompt template
+     * It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
+     */
+    readonly title: string;
+    /**
+     * Description of the prompt template
+     * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
+     */
+    readonly description?: string;
+    /**
+     * List of parameter names that are used in the prompt template and must be defined before the prompt template is executed
+     *
+     * Note: Joker is one of the dependent parameters
+     */
+    readonly dependentParameterNames: Array<string_name>;
+    /**
+     * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
+     */
+    readonly jokers?: Array<string>;
+    /**
+     * Type of the execution
+     * This determines if the prompt template is send to LLM, user or some scripting evaluation
+     */
+    readonly executionType: ExecutionType;
+    /**
+     * Content of the template with {placeholders} for parameters
+     */
+    readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
+    /**
+     * List of postprocessing steps that are executed after the prompt template
+     */
+    readonly postprocessing?: Array<string_javascript_name>;
+    /**
+     * Expect this amount of each unit in the answer
+     *
+     * For example 5 words, 3 sentences, 2 paragraphs, ...
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     */
+    readonly expectAmount?: Partial<Record<Lowercase<ExpectationUnit>, {
+        min?: ExpectationAmount;
+        max?: ExpectationAmount;
+    }>>;
+    /**
+     * Expect this format of the answer
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     */
+    readonly expectFormat?: ExpectFormatCommand['format'];
+    /**
+     * Name of the parameter that is the result of the prompt template
+     */
+    readonly resultingParameterName: string_name;
+}
+export {};
+/**
+ * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
+ */

package/umd/typings/types/PromptbookJson/PromptTemplateParameterJson.d.ts

@@ -1,25 +1,25 @@
-import { string_name } from '../typeAliases';
-/**
- * Describes one parameter of the promptbook
- */
-export type PromptTemplateParameterJson = {
-    /**
-     * Name of the parameter
-     * - It must be unique across the pipeline
-     * - It should start lowercase and contain letters and numbers
-     */
-    readonly name: string_name;
-    /**
-     * The parameter is input of the pipeline
-     */
-    readonly isInput: boolean;
-    /**
-     * The parameter is output of the pipeline
-     */
-    readonly isOutput: boolean;
-    /**
-     * Description of the parameter
-     * - It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
-     */
-    readonly description?: string;
-};
+import { string_name } from '../typeAliases';
+/**
+ * Describes one parameter of the promptbook
+ */
+export type PromptTemplateParameterJson = {
+    /**
+     * Name of the parameter
+     * - It must be unique across the pipeline
+     * - It should start lowercase and contain letters and numbers
+     */
+    readonly name: string_name;
+    /**
+     * The parameter is input of the pipeline
+     */
+    readonly isInput: boolean;
+    /**
+     * The parameter is output of the pipeline
+     */
+    readonly isOutput: boolean;
+    /**
+     * Description of the parameter
+     * - It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
+     */
+    readonly description?: string;
+};

package/umd/typings/types/PromptbookJson/PromptbookJson.d.ts

@@ -1,51 +1,51 @@
-import { string_promptbook_url, string_version } from '../typeAliases';
-import { PromptTemplateJson } from './PromptTemplateJson';
-import { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
-/**
- * Promptbook is the **core concept of this library**.
- * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
- *
- * @see https://github.com/webgptorg/promptbook#promptbook
- */
-export type PromptbookJson = {
-    /**
-     * Unique identifier of the promptbook
-     *
-     * Note: It must be unique across all promptbooks libraries
-     * Note: It must use HTTPs URL
-     * Tip: You can do versioning in the URL
-     *      For example: https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@1.0.0
-     * Warning: Do not hash part of the URL, hash part is used for identification of the prompt template in the pipeline
-     */
-    readonly promptbookUrl?: string_promptbook_url;
-    /**
-     * Title of the promptbook
-     * -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
-     */
-    readonly title: string;
-    /**
-     * Version of the .ptbk.json file
-     */
-    readonly promptbookVersion: string_version;
-    /**
-     * Description of the promptbook
-     * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
-     */
-    readonly description?: string;
-    /**
-     * Set of variables that are used across the pipeline
-     */
-    readonly parameters: Array<PromptTemplateParameterJson>;
-    /**
-     * Sequence of prompt templates that are chained together to form a pipeline
-     */
-    readonly promptTemplates: Array<PromptTemplateJson>;
-};
-/**
- * TODO: [🧠] Best format of this code?
- *             There must be possible to make
- *             - Branching
- *             - Loops
- *             - Paralelization
- *             - ...and more
- */
+import { string_promptbook_url, string_version } from '../typeAliases';
+import { PromptTemplateJson } from './PromptTemplateJson';
+import { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
+/**
+ * Promptbook is the **core concept of this library**.
+ * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
+ *
+ * @see https://github.com/webgptorg/promptbook#promptbook
+ */
+export type PromptbookJson = {
+    /**
+     * Unique identifier of the promptbook
+     *
+     * Note: It must be unique across all promptbooks libraries
+     * Note: It must use HTTPs URL
+     * Tip: You can do versioning in the URL
+     *      For example: https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@1.0.0
+     * Warning: Do not hash part of the URL, hash part is used for identification of the prompt template in the pipeline
+     */
+    readonly promptbookUrl?: string_promptbook_url;
+    /**
+     * Title of the promptbook
+     * -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
+     */
+    readonly title: string;
+    /**
+     * Version of the .ptbk.json file
+     */
+    readonly promptbookVersion: string_version;
+    /**
+     * Description of the promptbook
+     * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
+     */
+    readonly description?: string;
+    /**
+     * Set of variables that are used across the pipeline
+     */
+    readonly parameters: Array<PromptTemplateParameterJson>;
+    /**
+     * Sequence of prompt templates that are chained together to form a pipeline
+     */
+    readonly promptTemplates: Array<PromptTemplateJson>;
+};
+/**
+ * TODO: [🧠] Best format of this code?
+ *             There must be possible to make
+ *             - Branching
+ *             - Loops
+ *             - Paralelization
+ *             - ...and more
+ */

package/umd/typings/types/PromptbookString.d.ts

@@ -1,12 +1,12 @@
-/**
- * Promptbook is the **core concept of this library**.
- * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
- *
- * @see https://github.com/webgptorg/promptbook#promptbook
- */
-export type PromptbookString = string & {
-    readonly _type: 'Promptbook';
-};
-/**
- * TODO: !! Better validation (validatePromptbookString) or remove branded type and make it just string
- */
+/**
+ * Promptbook is the **core concept of this library**.
+ * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
+ *
+ * @see https://github.com/webgptorg/promptbook#promptbook
+ */
+export type PromptbookString = string & {
+    readonly _type: 'Promptbook';
+};
+/**
+ * TODO: !! Better validation (validatePromptbookString) or remove branded type and make it just string
+ */

package/umd/typings/types/ScriptLanguage.d.ts

@@ -1,9 +1,9 @@
-import { TupleToUnion } from 'type-fest';
-/**
- * Supported script languages
- */
-export declare const SUPPORTED_SCRIPT_LANGUAGES: readonly ["javascript", "typescript", "python"];
-/**
- * Script language
- */
-export type ScriptLanguage = TupleToUnion<typeof SUPPORTED_SCRIPT_LANGUAGES>;
+import { TupleToUnion } from 'type-fest';
+/**
+ * Supported script languages
+ */
+export declare const SUPPORTED_SCRIPT_LANGUAGES: readonly ["javascript", "typescript", "python"];
+/**
+ * Script language
+ */
+export type ScriptLanguage = TupleToUnion<typeof SUPPORTED_SCRIPT_LANGUAGES>;

package/umd/typings/types/TaskProgress.d.ts

@@ -1,42 +1,42 @@
-import { ExecutionType } from './ExecutionTypes';
-import { string_markdown_text, string_name } from './typeAliases';
-/**
- * TaskProgress represents the progress of a Promptbook execution.
- */
-export type TaskProgress = {
-    /**
-     * The unique name of the task.
-     *
-     * Note: This is not supposed to be displayed to the user.
-     *       It is used to identify the task in the code, for example as react key
-     */
-    readonly name: string_name;
-    /**
-     * Title of the task.
-     *
-     * Note: This is supposed to be displayed to the user.
-     * Note: This is trimmed and stripped of HTML tags and emojis
-     */
-    readonly title: string_markdown_text;
-    /**
-     * Does the task started?
-     */
-    readonly isStarted: boolean;
-    /**
-     * Is task done?
-     */
-    readonly isDone: boolean;
-    /**
-     * The type of the execution.
-     * Note: The Promptbook library reports everything, in the app level you can filter out the execution types that you don't want to show to the user.
-     */
-    readonly executionType: ExecutionType;
-    /**
-     * The parameter name that is being processed.
-     */
-    readonly parameterName: string_name;
-    /**
-     * The parameter value or null if the parameter is not yet processed.
-     */
-    readonly parameterValue: string | null;
-};
+import { ExecutionType } from './ExecutionTypes';
+import { string_markdown_text, string_name } from './typeAliases';
+/**
+ * TaskProgress represents the progress of a Promptbook execution.
+ */
+export type TaskProgress = {
+    /**
+     * The unique name of the task.
+     *
+     * Note: This is not supposed to be displayed to the user.
+     *       It is used to identify the task in the code, for example as react key
+     */
+    readonly name: string_name;
+    /**
+     * Title of the task.
+     *
+     * Note: This is supposed to be displayed to the user.
+     * Note: This is trimmed and stripped of HTML tags and emojis
+     */
+    readonly title: string_markdown_text;
+    /**
+     * Does the task started?
+     */
+    readonly isStarted: boolean;
+    /**
+     * Is task done?
+     */
+    readonly isDone: boolean;
+    /**
+     * The type of the execution.
+     * Note: The Promptbook library reports everything, in the app level you can filter out the execution types that you don't want to show to the user.
+     */
+    readonly executionType: ExecutionType;
+    /**
+     * The parameter name that is being processed.
+     */
+    readonly parameterName: string_name;
+    /**
+     * The parameter value or null if the parameter is not yet processed.
+     */
+    readonly parameterValue: string | null;
+};

package/umd/typings/types/execution-report/ExecutionReportJson.d.ts

@@ -1,56 +1,56 @@
-import type { PromptResult } from '../../execution/PromptResult';
-import type { Prompt } from '../Prompt';
-import type { string_promptbook_url, string_version } from '../typeAliases';
-/**
- * ExecutionReport is result of executing one promptbook
- * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
- *
- * It can have 2 formats:
- * -   **.md file** created from the **JSON** format
- * -   _(this)_ **JSON** format
- *
- * @see https://github.com/webgptorg/promptbook#execution-report
- */
-export type ExecutionReportJson = {
-    /**
-     * Unique identifier of the promptbook from promptbook which was executed
-     */
-    readonly promptbookUrl?: string_promptbook_url;
-    /**
-     * Title of from promptbook which was executed
-     */
-    readonly title?: string;
-    /**
-     * Version from promptbook which was executed
-     */
-    readonly promptbookUsedVersion: string_version;
-    /**
-     * Version from promptbook which was requested by promptbook
-     */
-    readonly promptbookRequestedVersion?: string_version;
-    /**
-     * Description of the promptbook which was executed
-     */
-    readonly description?: string;
-    /**
-     * Sequence of prompt templates in order which were executed
-     */
-    readonly promptExecutions: Array<{
-        /**
-         * The prompt wich was executed
-         */
-        prompt: Omit<Prompt, 'promptbookUrl' | 'parameters'>;
-        /**
-         * Result of the prompt execution (if not failed during LLM execution)
-         */
-        result?: PromptResult;
-        /**
-         * The error which occured during LLM execution or during postprocessing or expectation checking
-         *
-         * Note: It makes sense to have both error and result defined, for example when the result not pass expectations
-         */
-        error?: {
-            message: string;
-        };
-    }>;
-};
+import type { PromptResult } from '../../execution/PromptResult';
+import type { Prompt } from '../Prompt';
+import type { string_promptbook_url, string_version } from '../typeAliases';
+/**
+ * ExecutionReport is result of executing one promptbook
+ * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
+ *
+ * It can have 2 formats:
+ * -   **.md file** created from the **JSON** format
+ * -   _(this)_ **JSON** format
+ *
+ * @see https://github.com/webgptorg/promptbook#execution-report
+ */
+export type ExecutionReportJson = {
+    /**
+     * Unique identifier of the promptbook from promptbook which was executed
+     */
+    readonly promptbookUrl?: string_promptbook_url;
+    /**
+     * Title of from promptbook which was executed
+     */
+    readonly title?: string;
+    /**
+     * Version from promptbook which was executed
+     */
+    readonly promptbookUsedVersion: string_version;
+    /**
+     * Version from promptbook which was requested by promptbook
+     */
+    readonly promptbookRequestedVersion?: string_version;
+    /**
+     * Description of the promptbook which was executed
+     */
+    readonly description?: string;
+    /**
+     * Sequence of prompt templates in order which were executed
+     */
+    readonly promptExecutions: Array<{
+        /**
+         * The prompt wich was executed
+         */
+        prompt: Omit<Prompt, 'promptbookUrl' | 'parameters'>;
+        /**
+         * Result of the prompt execution (if not failed during LLM execution)
+         */
+        result?: PromptResult;
+        /**
+         * The error which occured during LLM execution or during postprocessing or expectation checking
+         *
+         * Note: It makes sense to have both error and result defined, for example when the result not pass expectations
+         */
+        error?: {
+            message: string;
+        };
+    }>;
+};