@promptbook/cli 0.62.1 → 0.62.2

package/esm/typings/src/conversion/validation/_importPipeline.d.ts

@@ -1,22 +1,22 @@
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { PipelineString } from '../../types/PipelineString';
-import type { string_json } from '../../types/typeAliases';
-/**
- * Import the pipeline.ptbk.md or pipeline.ptbk.json 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
- *
- * @param path - The path to the file relative to samples/templates directory
- * @private
- */
-export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.md`): PipelineString;
-export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.json`): PipelineJson;
-/**
- * Import the pipeline.ptbk.json file as parsed JSON
- */
-export declare function importPipelineJson(path: `${string}.ptbk.json`): PipelineJson;
-/**
- * Import the pipeline.ptbk.json file as string
- */
-export declare function importPipelineJsonAsString(path: `${string}.ptbk.json`): string_json<PipelineJson>;
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineString } from '../../types/PipelineString';
+import type { string_json } from '../../types/typeAliases';
+/**
+ * Import the pipeline.ptbk.md or pipeline.ptbk.json 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
+ *
+ * @param path - The path to the file relative to samples/templates directory
+ * @private
+ */
+export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.md`): PipelineString;
+export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.json`): PipelineJson;
+/**
+ * Import the pipeline.ptbk.json file as parsed JSON
+ */
+export declare function importPipelineJson(path: `${string}.ptbk.json`): PipelineJson;
+/**
+ * Import the pipeline.ptbk.json file as string
+ */
+export declare function importPipelineJsonAsString(path: `${string}.ptbk.json`): string_json<PipelineJson>;

package/esm/typings/src/conversion/validation/pipelineStringToJson-syntaxErrors.test.d.ts

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

package/esm/typings/src/conversion/validation/validatePipeline-logicErrors.test.d.ts

@@ -1,4 +1,4 @@
-export {};
-/**
- * TODO: Include automatically all samples from logic errors folder (same with syntax errors)
- */
+export {};
+/**
+ * TODO: Include automatically all samples from logic errors folder (same with syntax errors)
+ */

package/esm/typings/src/conversion/validation/validatePipeline.d.ts

@@ -1,36 +1,36 @@
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-/**
- * Validates PipelineJson 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 pipeline valid or invalid PipelineJson
- * @returns the same pipeline if it is logically valid
- * @throws {PipelineLogicError} on logical error in the pipeline
- */
-export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
-/**
- * TODO: [🧠] Work with promptbookVersion
- * TODO: Use here some json-schema, Zod or something similar and change it to:
- *     > /**
- *     >  * Validates PipelineJson if it is logically valid.
- *     >  *
- *     >  * It checks:
- *     >  * -   it has a valid structure
- *     >  * -   ...
- *     >  ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
- */
-/**
- * TODO: [🐣] !!!! Validate that all samples match expectations
- * TODO: [🐣][🐝] !!!! Validate that knowledge is valid (non-void)
- * TODO: [🐣] !!!! Validate that persona can be used only with CHAT variant
- * TODO: [🐣] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
- * TODO: [🐣] !!!! Validate that reserved parameter is not used as joker
- * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
- * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
- */
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+/**
+ * Validates PipelineJson 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 pipeline valid or invalid PipelineJson
+ * @returns the same pipeline if it is logically valid
+ * @throws {PipelineLogicError} on logical error in the pipeline
+ */
+export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
+/**
+ * TODO: [🧠] Work with promptbookVersion
+ * TODO: Use here some json-schema, Zod or something similar and change it to:
+ *     > /**
+ *     >  * Validates PipelineJson if it is logically valid.
+ *     >  *
+ *     >  * It checks:
+ *     >  * -   it has a valid structure
+ *     >  * -   ...
+ *     >  ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
+ */
+/**
+ * TODO: [🐣] !!!! Validate that all samples match expectations
+ * TODO: [🐣][🐝] !!!! Validate that knowledge is valid (non-void)
+ * TODO: [🐣] !!!! Validate that persona can be used only with CHAT variant
+ * TODO: [🐣] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
+ * TODO: [🐣] !!!! Validate that reserved parameter is not used as joker
+ * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ */

package/esm/typings/src/conversion/validation/validatePipeline.test.d.ts

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

package/esm/typings/src/errors/CollectionError.d.ts

@@ -1,7 +1,7 @@
-/**
- * This error indicates that the pipeline collection cannot be propperly loaded
- */
-export declare class CollectionError extends Error {
-    readonly name = "CollectionError";
-    constructor(message: string);
-}
+/**
+ * This error indicates that the pipeline collection cannot be propperly loaded
+ */
+export declare class CollectionError extends Error {
+    readonly name = "CollectionError";
+    constructor(message: string);
+}

package/esm/typings/src/errors/EnvironmentMismatchError.d.ts

@@ -1,7 +1,7 @@
-/**
- * This error type indicates that you try to use a feature that is not available in the current environment
- */
-export declare class EnvironmentMismatchError extends Error {
-    readonly name = "EnvironmentMismatchError";
-    constructor(message: string);
-}
+/**
+ * This error type indicates that you try to use a feature that is not available in the current environment
+ */
+export declare class EnvironmentMismatchError extends Error {
+    readonly name = "EnvironmentMismatchError";
+    constructor(message: string);
+}

package/esm/typings/src/errors/LimitReachedError.d.ts

@@ -1,7 +1,7 @@
-/**
- * This error type indicates that some limit was reached
- */
-export declare class LimitReachedError extends Error {
-    readonly name = "LimitReachedError";
-    constructor(message: string);
-}
+/**
+ * This error type indicates that some limit was reached
+ */
+export declare class LimitReachedError extends Error {
+    readonly name = "LimitReachedError";
+    constructor(message: string);
+}

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

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

package/esm/typings/src/errors/NotYetImplementedError.d.ts

@@ -1,7 +1,7 @@
-/**
- * This error type indicates that some part of the code is not implemented yet
- */
-export declare class NotYetImplementedError extends Error {
-    readonly name = "NotYetImplementedError";
-    constructor(message: string);
-}
+/**
+ * This error type indicates that some part of the code is not implemented yet
+ */
+export declare class NotYetImplementedError extends Error {
+    readonly name = "NotYetImplementedError";
+    constructor(message: string);
+}

package/esm/typings/src/errors/ParsingError.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 ParsingError extends Error {
-    readonly name = "ParsingError";
-    constructor(message: string);
-}
+/**
+ * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
+ */
+export declare class ParsingError extends Error {
+    readonly name = "ParsingError";
+    constructor(message: string);
+}

package/esm/typings/src/errors/PipelineExecutionError.d.ts

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

package/esm/typings/src/errors/PipelineLogicError.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 PipelineLogicError extends Error {
-    readonly name = "PipelineLogicError";
-    constructor(message: string);
-}
+/**
+ * This error indicates that the promptbook object has valid syntax but contains logical errors (like circular dependencies)
+ */
+export declare class PipelineLogicError extends Error {
+    readonly name = "PipelineLogicError";
+    constructor(message: string);
+}

package/esm/typings/src/errors/ReferenceError.d.ts

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

package/esm/typings/src/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/src/errors/VersionMismatchError.d.ts

@@ -1,8 +1,8 @@
-import type { string_semantic_version } from '../types/typeAliases';
-/**
- * This error type indicates that the version of the pipeline is not matching the expected version
- */
-export declare class VersionMismatchError extends Error {
-    readonly name = "UnexpectedError";
-    constructor(message: string, expectedVersion: string_semantic_version);
-}
+import type { string_semantic_version } from '../types/typeAliases';
+/**
+ * This error type indicates that the version of the pipeline is not matching the expected version
+ */
+export declare class VersionMismatchError extends Error {
+    readonly name = "UnexpectedError";
+    constructor(message: string, expectedVersion: string_semantic_version);
+}

package/esm/typings/src/errors/_ExpectError.d.ts

@@ -1,10 +1,10 @@
-/**
- * This error occurs when some expectation is not met in the execution of the pipeline
- *
- * @private Always catched and rethrown as `PipelineExecutionError`
- * Note: This is a kindof subtype of PipelineExecutionError
- */
-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
+ *
+ * @private Always catched and rethrown as `PipelineExecutionError`
+ * Note: This is a kindof subtype of PipelineExecutionError
+ */
+export declare class ExpectError extends Error {
+    readonly name = "ExpectError";
+    constructor(message: string);
+}

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

@@ -1,10 +1,10 @@
-export type CommonExecutionToolsOptions = {
-    /**
-     * If true, the internal executions will be logged
-     */
-    readonly isVerbose?: boolean;
-};
-/**
- * TODO: [🈁] Maybe add here `isDeterministic`
- * 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: [🈁] Maybe add here `isDeterministic`
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ */

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

@@ -1,8 +1,8 @@
-/**
- * Represents a vector in an latent space of the embedding model
- */
-export type EmbeddingVector = Array<number>;
-/**
- * TODO: Figure out how to use NPM package xyzt
- *       Not using IVectorData due to HUGE dimensionality
- */
+/**
+ * Represents a vector in an latent space of the embedding model
+ */
+export type EmbeddingVector = Array<number>;
+/**
+ * TODO: Figure out how to use NPM package xyzt
+ *       Not using IVectorData due to HUGE dimensionality
+ */

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

@@ -1,33 +1,33 @@
-import type { Arrayable } from '../types/Arrayable';
-import type { LlmExecutionTools } from './LlmExecutionTools';
-import type { ScriptExecutionTools } from './ScriptExecutionTools';
-import type { UserInterfaceTools } from './UserInterfaceTools';
-/**
- * All the tools needed to execute pipelines.
- *
- * @see https://github.com/webgptorg/promptbook#execution-tools
- */
-export type ExecutionTools = {
-    /**
-     * Tools for executing prompts to large language models like GPT-4
-     *
-     * Tip: Combine multiple LLM execution tools - use array of LlmExecutionTools instead of single LlmExecutionTools
-     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#llm-execution-tools
-     */
-    llm?: Arrayable<LlmExecutionTools>;
-    /**
-     * 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
-     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#script-execution-tools
-     */
-    script?: Arrayable<ScriptExecutionTools>;
-    /**
-     * Tools for interacting with the user
-     *
-     * Note: When undefined, the user interface is disabled and promptbook which requires user interaction will fail
-     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#user-interface-tools
-     */
-    userInterface?: UserInterfaceTools;
-};
+import type { Arrayable } from '../types/Arrayable';
+import type { LlmExecutionTools } from './LlmExecutionTools';
+import type { ScriptExecutionTools } from './ScriptExecutionTools';
+import type { UserInterfaceTools } from './UserInterfaceTools';
+/**
+ * All the tools needed to execute pipelines.
+ *
+ * @see https://github.com/webgptorg/promptbook#execution-tools
+ */
+export type ExecutionTools = {
+    /**
+     * Tools for executing prompts to large language models like GPT-4
+     *
+     * Tip: Combine multiple LLM execution tools - use array of LlmExecutionTools instead of single LlmExecutionTools
+     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#llm-execution-tools
+     */
+    llm?: Arrayable<LlmExecutionTools>;
+    /**
+     * 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
+     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#script-execution-tools
+     */
+    script?: Arrayable<ScriptExecutionTools>;
+    /**
+     * Tools for interacting with the user
+     *
+     * Note: When undefined, the user interface is disabled and promptbook which requires user interaction will fail
+     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#user-interface-tools
+     */
+    userInterface?: UserInterfaceTools;
+};

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

@@ -1,72 +1,72 @@
-import type { Promisable } from 'type-fest';
-import type { ModelVariant } from '../types/ModelVariant';
-import type { Prompt } from '../types/Prompt';
-import type { string_markdown } from '../types/typeAliases';
-import type { string_markdown_text } from '../types/typeAliases';
-import type { string_model_name } from '../types/typeAliases';
-import type { string_title } from '../types/typeAliases';
-import type { ChatPromptResult } from './PromptResult';
-import type { CompletionPromptResult } from './PromptResult';
-import type { EmbeddingPromptResult } from './PromptResult';
-/**
- * Container 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#llm-execution-tools
- */
-export type LlmExecutionTools = {
-    /**
-     * Title of the model provider
-     *
-     * @example "OpenAI"
-     */
-    readonly title: string_title & string_markdown_text;
-    /**
-     * Description of the provider
-     *
-     * @example "Use all models from OpenAI"
-     */
-    readonly description: string_markdown;
-    /**
-     * Calls a chat model
-     */
-    callChatModel?(prompt: Prompt): Promise<ChatPromptResult>;
-    /**
-     * Calls a completion model
-     */
-    callCompletionModel?(prompt: Prompt): Promise<CompletionPromptResult>;
-    /**
-     * Calls an embedding model
-     */
-    callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
-    /**
-     * List all available models that can be used
-     */
-    listModels(): Promisable<Array<AvailableModel>>;
-};
-/**
- * Represents a model that can be used for prompt execution
- */
-export type AvailableModel = {
-    /**
-     * The model title
-     */
-    readonly modelTitle: string_title;
-    /**
-     * The model name aviailable
-     */
-    readonly modelName: string_model_name;
-    /**
-     * Variant of the model
-     */
-    readonly modelVariant: ModelVariant;
-};
-/**
- * TODO: [🏳] Add `callTranslationModel`
- * TODO: Maybe reorder `listModels` and put it befor `callChatModel`, `callCompletionModel`, `callEmbeddingModel`
- * TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat
- * TODO: [🍓][♐] Some heuristic to pick the best model in listed models
- * TODO: [🧠] Should or should not there be a word "GPT" in both callCompletionModel and callChatModel
- * TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
- */
+import type { Promisable } from 'type-fest';
+import type { ModelVariant } from '../types/ModelVariant';
+import type { Prompt } from '../types/Prompt';
+import type { string_markdown } from '../types/typeAliases';
+import type { string_markdown_text } from '../types/typeAliases';
+import type { string_model_name } from '../types/typeAliases';
+import type { string_title } from '../types/typeAliases';
+import type { ChatPromptResult } from './PromptResult';
+import type { CompletionPromptResult } from './PromptResult';
+import type { EmbeddingPromptResult } from './PromptResult';
+/**
+ * Container 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#llm-execution-tools
+ */
+export type LlmExecutionTools = {
+    /**
+     * Title of the model provider
+     *
+     * @example "OpenAI"
+     */
+    readonly title: string_title & string_markdown_text;
+    /**
+     * Description of the provider
+     *
+     * @example "Use all models from OpenAI"
+     */
+    readonly description: string_markdown;
+    /**
+     * Calls a chat model
+     */
+    callChatModel?(prompt: Prompt): Promise<ChatPromptResult>;
+    /**
+     * Calls a completion model
+     */
+    callCompletionModel?(prompt: Prompt): Promise<CompletionPromptResult>;
+    /**
+     * Calls an embedding model
+     */
+    callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
+    /**
+     * List all available models that can be used
+     */
+    listModels(): Promisable<Array<AvailableModel>>;
+};
+/**
+ * Represents a model that can be used for prompt execution
+ */
+export type AvailableModel = {
+    /**
+     * The model title
+     */
+    readonly modelTitle: string_title;
+    /**
+     * The model name aviailable
+     */
+    readonly modelName: string_model_name;
+    /**
+     * Variant of the model
+     */
+    readonly modelVariant: ModelVariant;
+};
+/**
+ * TODO: [🏳] Add `callTranslationModel`
+ * TODO: Maybe reorder `listModels` and put it befor `callChatModel`, `callCompletionModel`, `callEmbeddingModel`
+ * TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat
+ * TODO: [🍓][♐] Some heuristic to pick the best model in listed models
+ * TODO: [🧠] Should or should not there be a word "GPT" in both callCompletionModel and callChatModel
+ * TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
+ */