@promptbook/cli 0.62.1 → 0.62.2

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

@@ -1,13 +1,13 @@
-import type { ___ } from '../../utils/organization/___';
-import type { LlmTemplateJson } from './LlmTemplateJson';
-import type { PromptDialogJson } from './PromptDialogJson';
-import type { ScriptJson } from './ScriptJson';
-import type { SimpleTemplateJson } from './SimpleTemplateJson';
-/**
- * Describes one prompt template in the promptbook
- */
-export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptJson | PromptDialogJson | ___ | ___ | ___ | ___;
-/**
- * TODO: [🧠][🥜] What is propper name for this - "Template", "Prompt template",...
- * TODO: [🧠][🥜] Reduce confusion of `PromptTemplateJson` vs (`LlmTemplateJson` which is 'PROMPT_TEMPLATE')
- */
+import type { ___ } from '../../utils/organization/___';
+import type { LlmTemplateJson } from './LlmTemplateJson';
+import type { PromptDialogJson } from './PromptDialogJson';
+import type { ScriptJson } from './ScriptJson';
+import type { SimpleTemplateJson } from './SimpleTemplateJson';
+/**
+ * Describes one prompt template in the promptbook
+ */
+export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptJson | PromptDialogJson | ___ | ___ | ___ | ___;
+/**
+ * TODO: [🧠][🥜] What is propper name for this - "Template", "Prompt template",...
+ * TODO: [🧠][🥜] Reduce confusion of `PromptTemplateJson` vs (`LlmTemplateJson` which is 'PROMPT_TEMPLATE')
+ */

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

@@ -1,96 +1,96 @@
-import type { BlockType } from '../../commands/BLOCK/BlockTypes';
-import type { ExpectFormatCommand } from '../../commands/EXPECT/ExpectFormatCommand';
-import type { string_javascript } from '../typeAliases';
-import type { string_javascript_name } from '../typeAliases';
-import type { string_markdown } from '../typeAliases';
-import type { string_markdown_text } from '../typeAliases';
-import type { string_name } from '../typeAliases';
-import type { string_parameter_name } from '../typeAliases';
-import type { string_prompt } from '../typeAliases';
-import type { string_template } from '../typeAliases';
-import type { Expectations } from './Expectations';
-/**
- * Common properties of all prompt templates
- */
-export interface PromptTemplateJsonCommon {
-    /**
-     * Name of the template
-     * - It must be unique across the pipeline
-     * - It should start uppercase and can contain letters and numbers
-     * - The pipelineUrl 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_markdown_text;
-    /**
-     * 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_parameter_name>;
-    /**
-     * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
-     *
-     * @see https://github.com/webgptorg/promptbook/discussions/66
-     */
-    readonly jokerParameterNames?: Array<string_parameter_name>;
-    /**
-     * Type of the execution
-     * This determines if the prompt template is send to LLM, user or some scripting evaluation
-     */
-    readonly blockType: BlockType;
-    /**
-     * Content of the template with {placeholders} for parameters
-     *
-     * @@@ content vs preparedContent
-     */
-    readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
-    /**
-     * @@@ Content of the template with {placeholders} for parameters
-     *
-     * @@@ content vs preparedContent
-     *
-     * @default "{content}"
-     */
-    readonly preparedContent?: (string_prompt | string_javascript | string_markdown) & string_template;
-    /**
-     * List of postprocessing steps that are executed after the prompt template
-     *
-     * @see https://github.com/webgptorg/promptbook/discussions/31
-     */
-    readonly postprocessingFunctionNames?: 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
-     * @see https://github.com/webgptorg/promptbook/discussions/30
-     */
-    readonly expectations?: Expectations;
-    /**
-     * Expect this format of the answer
-     *
-     * Note: Expectations are performed after all postprocessing steps
-     * @see https://github.com/webgptorg/promptbook/discussions/30
-     * @deprecated [💝]
-     */
-    readonly expectFormat?: ExpectFormatCommand['format'];
-    /**
-     * Name of the parameter that is the result of the prompt template
-     */
-    readonly resultingParameterName: string_name;
-}
-/**
- * TODO: [🧠][🥜]
- * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
- * TODO: [♈] Probbably move expectations from templates to parameters
- */
+import type { BlockType } from '../../commands/BLOCK/BlockTypes';
+import type { ExpectFormatCommand } from '../../commands/EXPECT/ExpectFormatCommand';
+import type { string_javascript } from '../typeAliases';
+import type { string_javascript_name } from '../typeAliases';
+import type { string_markdown } from '../typeAliases';
+import type { string_markdown_text } from '../typeAliases';
+import type { string_name } from '../typeAliases';
+import type { string_parameter_name } from '../typeAliases';
+import type { string_prompt } from '../typeAliases';
+import type { string_template } from '../typeAliases';
+import type { Expectations } from './Expectations';
+/**
+ * Common properties of all prompt templates
+ */
+export interface PromptTemplateJsonCommon {
+    /**
+     * Name of the template
+     * - It must be unique across the pipeline
+     * - It should start uppercase and can contain letters and numbers
+     * - The pipelineUrl 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_markdown_text;
+    /**
+     * 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_parameter_name>;
+    /**
+     * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/66
+     */
+    readonly jokerParameterNames?: Array<string_parameter_name>;
+    /**
+     * Type of the execution
+     * This determines if the prompt template is send to LLM, user or some scripting evaluation
+     */
+    readonly blockType: BlockType;
+    /**
+     * Content of the template with {placeholders} for parameters
+     *
+     * @@@ content vs preparedContent
+     */
+    readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
+    /**
+     * @@@ Content of the template with {placeholders} for parameters
+     *
+     * @@@ content vs preparedContent
+     *
+     * @default "{content}"
+     */
+    readonly preparedContent?: (string_prompt | string_javascript | string_markdown) & string_template;
+    /**
+     * List of postprocessing steps that are executed after the prompt template
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/31
+     */
+    readonly postprocessingFunctionNames?: 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
+     * @see https://github.com/webgptorg/promptbook/discussions/30
+     */
+    readonly expectations?: Expectations;
+    /**
+     * Expect this format of the answer
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     * @see https://github.com/webgptorg/promptbook/discussions/30
+     * @deprecated [💝]
+     */
+    readonly expectFormat?: ExpectFormatCommand['format'];
+    /**
+     * Name of the parameter that is the result of the prompt template
+     */
+    readonly resultingParameterName: string_name;
+}
+/**
+ * TODO: [🧠][🥜]
+ * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
+ * TODO: [♈] Probbably move expectations from templates to parameters
+ */

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

@@ -1,36 +1,36 @@
-import type { string_markdown_text } from '../typeAliases';
-import type { string_parameter_name } from '../typeAliases';
-import type { string_parameter_value } 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_parameter_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_markdown_text;
-    /**
-     * Sample values of the parameter
-     * Note: This values won't be actually used as some default values, but they are just for better understanding of the parameter
-     */
-    readonly sampleValues?: Array<string_parameter_value>;
-};
-/**
- * TODO: [♈] Probbably move expectations from templates to parameters
- * TODO: [🍙] Make some standart order of json properties
- */
+import type { string_markdown_text } from '../typeAliases';
+import type { string_parameter_name } from '../typeAliases';
+import type { string_parameter_value } 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_parameter_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_markdown_text;
+    /**
+     * Sample values of the parameter
+     * Note: This values won't be actually used as some default values, but they are just for better understanding of the parameter
+     */
+    readonly sampleValues?: Array<string_parameter_value>;
+};
+/**
+ * TODO: [♈] Probbably move expectations from templates to parameters
+ * TODO: [🍙] Make some standart order of json properties
+ */

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

@@ -1,19 +1,19 @@
-import type { ScriptLanguage } from '../ScriptLanguage';
-import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
-/**
- * Template for script execution
- *
- * @see https://github.com/webgptorg/promptbook/discussions/77
- */
-export type ScriptJson = PromptTemplateJsonCommon & {
-    readonly blockType: 'SCRIPT';
-    /**
-     * Language of the script
-     * - This is required only for blockType SCRIPT
-     *
-     */
-    readonly contentLanguage?: ScriptLanguage;
-};
-/**
- * TODO: [🍙] Make some standart order of json properties
- */
+import type { ScriptLanguage } from '../ScriptLanguage';
+import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
+/**
+ * Template for script execution
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/77
+ */
+export type ScriptJson = PromptTemplateJsonCommon & {
+    readonly blockType: 'SCRIPT';
+    /**
+     * Language of the script
+     * - This is required only for blockType SCRIPT
+     *
+     */
+    readonly contentLanguage?: ScriptLanguage;
+};
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ */

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

@@ -1,12 +1,12 @@
-import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
-/**
- * Template for simple concatenation of strings
- *
- * @see https://github.com/webgptorg/promptbook/discussions/17
- */
-export type SimpleTemplateJson = PromptTemplateJsonCommon & {
-    readonly blockType: 'SIMPLE_TEMPLATE';
-};
-/**
- * TODO: [🍙] Make some standart order of json properties
- */
+import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
+/**
+ * Template for simple concatenation of strings
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/17
+ */
+export type SimpleTemplateJson = PromptTemplateJsonCommon & {
+    readonly blockType: 'SIMPLE_TEMPLATE';
+};
+/**
+ * TODO: [🍙] Make some standart order of json properties
+ */

package/esm/typings/src/types/PipelineString.d.ts

@@ -1,12 +1,12 @@
-/**
- * Promptbook is the **core concept of this package**.
- * 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 PipelineString = string & {
-    readonly _type: 'Promptbook';
-};
-/**
- * TODO: !! Better validation (validatePipelineString) or remove branded type and make it just string
- */
+/**
+ * Promptbook is the **core concept of this package**.
+ * 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 PipelineString = string & {
+    readonly _type: 'Promptbook';
+};
+/**
+ * TODO: !! Better validation (validatePipelineString) or remove branded type and make it just string
+ */

package/esm/typings/src/types/Prompt.d.ts

@@ -1,109 +1,109 @@
-import type { ExpectFormatCommand } from '../commands/EXPECT/ExpectFormatCommand';
-import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
-import type { ChatModelRequirements } from './ModelRequirements';
-import type { CompletionModelRequirements } from './ModelRequirements';
-import type { EmbeddingModelRequirements } from './ModelRequirements';
-import type { ModelRequirements } from './ModelRequirements';
-import type { Expectations } from './PipelineJson/Expectations';
-import type { Parameters } from './typeAliases';
-import type { string_pipeline_url_with_hashtemplate } from './typeAliases';
-import type { string_prompt } from './typeAliases';
-import type { string_template } from './typeAliases';
-import type { string_title } from './typeAliases';
-/**
- * Prompt in a text along with model requirements, but without any execution or templating logic.
- *
- * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
- * @see https://github.com/webgptorg/promptbook#prompt
- */
-export type Prompt = CompletionPrompt | ChatPrompt | EmbeddingPrompt;
-/**
- * Completion prompt
- *
- * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
- */
-export type CompletionPrompt = CommonPrompt & {
-    /**
-     * Requirements for completion model
-     */
-    modelRequirements: CompletionModelRequirements;
-};
-/**
- * Chat prompt
- *
- * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
- */
-export type ChatPrompt = CommonPrompt & {
-    /**
-     * Requirements for chat model
-     */
-    modelRequirements: ChatModelRequirements;
-};
-/**
- * Embedding prompt
- *
- * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
- */
-export type EmbeddingPrompt = CommonPrompt & {
-    /**
-     * Requirements for chat model
-     */
-    modelRequirements: EmbeddingModelRequirements;
-};
-/**
- * Common properties for all prompt results
- *
- * Note: This is fully serializable as JSON
- */
-export type CommonPrompt = {
-    /**
-     * The title of the prompt
-     *
-     * Note: This has no effect on the model, it is just for the reporting
-     */
-    readonly title: string_title;
-    /**
-     * The text of the prompt with placeholders for parameters
-     *
-     * @example "What is the capital of {country}?"
-     */
-    readonly content: string_prompt & string_template;
-    /**
-     * Requirements for the model
-     */
-    readonly modelRequirements: ModelRequirements;
-    /**
-     * List of postprocessing steps that are executed after the prompt
-     */
-    readonly postprocessing?: Array<PostprocessingFunction>;
-    /**
-     * Expectations for the answer
-     *
-     * For example 5 words, 3 sentences, 2 paragraphs, ...
-     * If not set, nothing is expected from the answer
-     */
-    readonly expectations?: Expectations;
-    /**
-     * Expect this format of the answer
-     *
-     * Note: Expectations are performed after all postprocessing steps
-     * @deprecated [💝]
-     */
-    readonly expectFormat?: ExpectFormatCommand['format'];
-    /**
-     * Unique identifier of the pipeline with specific template name as hash
-     *
-     * @example https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md#keywords
-     */
-    readonly pipelineUrl?: string_pipeline_url_with_hashtemplate;
-    /**
-     * Parameters used in the `content`
-     */
-    readonly parameters: Parameters;
-};
-/**
- * TODO: [🔼] !!!! Export all from `@promptbook/types`
- * TODO: [🧄] Replace all "github.com/webgptorg/promptbook#xxx" with "ptbk.io/xxx"
- * TODO: [✔] Check ModelRequirements in runtime
- * TODO: [🏳] Add options for translation - maybe create `TranslationPrompt`
- */
+import type { ExpectFormatCommand } from '../commands/EXPECT/ExpectFormatCommand';
+import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
+import type { ChatModelRequirements } from './ModelRequirements';
+import type { CompletionModelRequirements } from './ModelRequirements';
+import type { EmbeddingModelRequirements } from './ModelRequirements';
+import type { ModelRequirements } from './ModelRequirements';
+import type { Expectations } from './PipelineJson/Expectations';
+import type { Parameters } from './typeAliases';
+import type { string_pipeline_url_with_hashtemplate } from './typeAliases';
+import type { string_prompt } from './typeAliases';
+import type { string_template } from './typeAliases';
+import type { string_title } from './typeAliases';
+/**
+ * Prompt in a text along with model requirements, but without any execution or templating logic.
+ *
+ * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ * @see https://github.com/webgptorg/promptbook#prompt
+ */
+export type Prompt = CompletionPrompt | ChatPrompt | EmbeddingPrompt;
+/**
+ * Completion prompt
+ *
+ * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ */
+export type CompletionPrompt = CommonPrompt & {
+    /**
+     * Requirements for completion model
+     */
+    modelRequirements: CompletionModelRequirements;
+};
+/**
+ * Chat prompt
+ *
+ * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ */
+export type ChatPrompt = CommonPrompt & {
+    /**
+     * Requirements for chat model
+     */
+    modelRequirements: ChatModelRequirements;
+};
+/**
+ * Embedding prompt
+ *
+ * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ */
+export type EmbeddingPrompt = CommonPrompt & {
+    /**
+     * Requirements for chat model
+     */
+    modelRequirements: EmbeddingModelRequirements;
+};
+/**
+ * Common properties for all prompt results
+ *
+ * Note: This is fully serializable as JSON
+ */
+export type CommonPrompt = {
+    /**
+     * The title of the prompt
+     *
+     * Note: This has no effect on the model, it is just for the reporting
+     */
+    readonly title: string_title;
+    /**
+     * The text of the prompt with placeholders for parameters
+     *
+     * @example "What is the capital of {country}?"
+     */
+    readonly content: string_prompt & string_template;
+    /**
+     * Requirements for the model
+     */
+    readonly modelRequirements: ModelRequirements;
+    /**
+     * List of postprocessing steps that are executed after the prompt
+     */
+    readonly postprocessing?: Array<PostprocessingFunction>;
+    /**
+     * Expectations for the answer
+     *
+     * For example 5 words, 3 sentences, 2 paragraphs, ...
+     * If not set, nothing is expected from the answer
+     */
+    readonly expectations?: Expectations;
+    /**
+     * Expect this format of the answer
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     * @deprecated [💝]
+     */
+    readonly expectFormat?: ExpectFormatCommand['format'];
+    /**
+     * Unique identifier of the pipeline with specific template name as hash
+     *
+     * @example https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md#keywords
+     */
+    readonly pipelineUrl?: string_pipeline_url_with_hashtemplate;
+    /**
+     * Parameters used in the `content`
+     */
+    readonly parameters: Parameters;
+};
+/**
+ * TODO: [🔼] !!!! Export all from `@promptbook/types`
+ * TODO: [🧄] Replace all "github.com/webgptorg/promptbook#xxx" with "ptbk.io/xxx"
+ * TODO: [✔] Check ModelRequirements in runtime
+ * TODO: [🏳] Add options for translation - maybe create `TranslationPrompt`
+ */

package/esm/typings/src/types/ScriptLanguage.d.ts

@@ -1,9 +1,9 @@
-import type { 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 type { 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>;