@promptbook/openai 0.60.0 → 0.61.0-0

package/umd/typings/src/utils/validators/uuid/isValidUuid.d.ts

@@ -0,0 +1,5 @@
+import type { string_uuid } from '../../../types/typeAliases';
+/**
+ * Checks if value is valid uuid
+ */
+export declare function isValidUuid(value: unknown): value is string_uuid;

package/umd/typings/src/utils/validators/uuid/isValidUuid.test.d.ts

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

package/umd/typings/src/version.d.ts

@@ -1,5 +1,6 @@
-import type { string_version } from './types/typeAliases';
+import type { string_semantic_version } from './types/typeAliases';
 /**
  * The version of the Promptbook library
  */
-export declare const PROMPTBOOK_VERSION: string_version;
+export declare const PROMPTBOOK_VERSION: string_promptbook_version;
+export type string_promptbook_version = string_semantic_version;

package/esm/typings/src/cli/actions/hello.d.ts

@@ -1,7 +0,0 @@
-import type { Command } from 'commander';
-/**
- * Initializes testing `hello` command for Promptbook CLI utilities
- *
- * @private part of `promptbookCli`
- */
-export declare function initializeHello(program: Command): void;

package/esm/typings/src/cli/actions/make.d.ts

@@ -1,7 +0,0 @@
-import type { Command } from 'commander';
-/**
- * Initializes `make` command for Promptbook CLI utilities
- *
- * @private part of `promptbookCli`
- */
-export declare function initializeMake(program: Command): void;

package/esm/typings/src/cli/actions/prettify.d.ts

@@ -1,7 +0,0 @@
-import type { Command } from 'commander';
-/**
- * Initializes `prettify` command for Promptbook CLI utilities
- *
- * @private part of `promptbookCli`
- */
-export declare function initializePrettify(program: Command): void;

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

@@ -1,11 +0,0 @@
-import type { Command } from '../../types/Command';
-import type { string_markdown_text } from '../../types/typeAliases';
-/**
- * Parses one line of ul/ol to command
- *
- * @returns parsed command object
- * @throws {SyntaxError} if the command is invalid
- *
- * @private within the pipelineStringToJson
- */
-export declare function parseCommand(listItem: string_markdown_text): Command;

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

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

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

@@ -1,9 +0,0 @@
-/**
- * This error occurs during the parameter replacement in the template
- *
- * Note: This is a kindof subtype of ExecutionError because it occurs during the execution of the pipeline
- */
-export declare class TemplateError extends Error {
-    readonly name = "TemplateError";
-    constructor(message: string);
-}

package/esm/typings/src/llm-providers/mocked/mocked-chat.test.d.ts

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

package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionToolsOptions.d.ts

@@ -1,24 +0,0 @@
-import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
-import type { client_id } from '../../types/typeAliases';
-import type { string_uri } from '../../types/typeAliases';
-/**
- * Options for MultipleLlmExecutionTools
- */
-export type MultipleLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
-    /**
-     * URL of the multiple PROMPTBOOK server
-     * On this server will be connected to the socket.io server
-     */
-    readonly multipleUrl: URL;
-    /**
-     * Path for the Socket.io server to listen
-     *
-     * @default '/socket.io'
-     * @example '/promptbook/socket.io'
-     */
-    readonly path: string_uri;
-    /**
-     * Your client ID
-     */
-    readonly clientId: client_id;
-};

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

@@ -1,101 +0,0 @@
-import type { ExecutionType } from './ExecutionTypes';
-import type { ModelRequirements } from './ModelRequirements';
-import type { ExpectationAmount } from './PipelineJson/PromptTemplateJson';
-import type { ExpectationUnit } from './PipelineJson/PromptTemplateJson';
-import type { string_markdown_text } from './typeAliases';
-import type { string_name } from './typeAliases';
-import type { string_version } from './typeAliases';
-/**
- * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
- * It is parsed from the markdown from ul/ol items - one command per one item.
- */
-export type Command = PromptbookUrlCommand | PromptbookVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
-/**
- * PromptbookVersion command tells which version is .promptbook file using
- *
- * - It is used for backward compatibility
- * - It is defined per whole .promptbook file in the header
- */
-export type PromptbookUrlCommand = {
-    readonly type: 'PIPELINE_URL';
-    readonly pipelineUrl: URL;
-};
-/**
- * PromptbookVersion command tells which version is .promptbook file using
- *
- * - It is used for backward compatibility
- * - It is defined per whole .promptbook file in the header
- */
-export type PromptbookVersionCommand = {
-    readonly type: 'PROMPTBOOK_VERSION';
-    readonly promptbookVersion: string_version;
-};
-/**
- * Execute command tells how to execute the section
- * It can be either prompt template, script or SIMPLE TEMPLATE etc.
- */
-export type ExecuteCommand = {
-    readonly type: 'EXECUTE';
-    readonly executionType: ExecutionType;
-};
-/**
- * Model command tells which model and modelRequirements to use for the prompt template. execution
- */
-export type ModelCommand = {
-    readonly type: 'MODEL';
-    readonly key: keyof ModelRequirements;
-    readonly value: any;
-};
-/**
- * Joker parameter is used instead of executing the prompt template if it meet the expectations requirements
- */
-export type JokerCommand = {
-    readonly type: 'JOKER';
-    readonly parameterName: string_name;
-};
-/**
- * Parameter command describes one parameter of the prompt template
- *
- * - It can tell if it is input or OUTPUT PARAMETER
- * - It can have description
- * - In description it can have simple formatting BUT not markdown structure or reference to other parameters
- */
-export type ParameterCommand = {
-    readonly type: 'PARAMETER';
-    readonly isInput: boolean;
-    readonly isOutput: boolean;
-    readonly parameterName: string_name;
-    readonly parameterDescription: string_markdown_text | null;
-};
-/**
- * Postprocess command describes which function to use for postprocessing
- * This will be created as separate EXECUTE SCRIPT block bellow
- */
-export type PostprocessCommand = {
-    readonly type: 'POSTPROCESS';
-    readonly functionName: string_name;
-};
-/**
- * Expect command describes the desired output of the prompt template (after post-processing)
- * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs or some other shape of the output.
- */
-export type ExpectCommand = ExpectAmountCommand | ExpectFormatCommand;
-/**
- * Expect amount command describes the desired output of the prompt template (after post-processing)
- * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
- *
- * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
- */
-export type ExpectAmountCommand = {
-    readonly type: 'EXPECT_AMOUNT';
-    readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
-    readonly unit: ExpectationUnit;
-    readonly amount: ExpectationAmount;
-};
-/**
- * Represents a command that expects a specific format.
- */
-export type ExpectFormatCommand = {
-    readonly type: 'EXPECT_FORMAT';
-    readonly format: 'JSON';
-};

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

@@ -1,13 +0,0 @@
-import type { TupleToUnion } from 'type-fest';
-/**
- * Execution type describes the way how the block is executed
- *
- * @see https://github.com/webgptorg/promptbook#execution-type
- */
-export type ExecutionType = TupleToUnion<typeof ExecutionTypes>;
-/**
- * Execution type describes the way how the block is executed
- *
- * @see https://github.com/webgptorg/promptbook#execution-type
- */
-export declare const ExecutionTypes: readonly ["PROMPT_TEMPLATE", "SIMPLE_TEMPLATE", "SCRIPT", "PROMPT_DIALOG"];

package/esm/typings/src/utils/markdown-json/MarkdownStructure.d.ts

@@ -1,25 +0,0 @@
-/**
- * Represents the structure of a markdown file.
- *
- * @private within the package
- */
-export type MarkdownStructure = {
-    /**
-     * The section level of the markdown file.
-     * h1 is level 1, h2 is level 2, etc.
-     */
-    level: number;
-    /**
-     * The title of the markdown file.
-     */
-    title: string;
-    /**
-     * Content of the section.
-     * It contains text, images, formatting, ul, ol, hr, blockquotes, etc. BUT not headings and sub-sections
-     */
-    content: string;
-    /**
-     * The sub-sections of current section which are recursively structured.
-     */
-    sections: MarkdownStructure[];
-};

package/esm/typings/src/utils/markdown-json/countMarkdownStructureDeepness.d.ts

@@ -1,7 +0,0 @@
-import type { MarkdownStructure } from './MarkdownStructure';
-/**
- * Computes the deepness of the markdown structure.
- *
- * @private within the package
- */
-export declare function countMarkdownStructureDeepness(markdownStructure: MarkdownStructure): number;

package/esm/typings/src/utils/markdown-json/markdownToMarkdownStructure.d.ts

@@ -1,13 +0,0 @@
-import type { MarkdownStructure } from './MarkdownStructure';
-/**
- * Parse a markdown string into a MarkdownStructure object.
- *
- * Note: This function does work with code blocks
- * Note: This function does not work with markdown comments
- *
- * @param markdown The markdown string to parse.
- * @returns The MarkdownStructure object.
- *
- * @private within the package
- */
-export declare function markdownToMarkdownStructure(markdown: string): MarkdownStructure;

package/umd/typings/src/cli/actions/hello.d.ts

@@ -1,7 +0,0 @@
-import type { Command } from 'commander';
-/**
- * Initializes testing `hello` command for Promptbook CLI utilities
- *
- * @private part of `promptbookCli`
- */
-export declare function initializeHello(program: Command): void;

package/umd/typings/src/cli/actions/make.d.ts

@@ -1,7 +0,0 @@
-import type { Command } from 'commander';
-/**
- * Initializes `make` command for Promptbook CLI utilities
- *
- * @private part of `promptbookCli`
- */
-export declare function initializeMake(program: Command): void;

package/umd/typings/src/cli/actions/prettify.d.ts

@@ -1,7 +0,0 @@
-import type { Command } from 'commander';
-/**
- * Initializes `prettify` command for Promptbook CLI utilities
- *
- * @private part of `promptbookCli`
- */
-export declare function initializePrettify(program: Command): void;

package/umd/typings/src/conversion/utils/parseCommand.d.ts

@@ -1,11 +0,0 @@
-import type { Command } from '../../types/Command';
-import type { string_markdown_text } from '../../types/typeAliases';
-/**
- * Parses one line of ul/ol to command
- *
- * @returns parsed command object
- * @throws {SyntaxError} if the command is invalid
- *
- * @private within the pipelineStringToJson
- */
-export declare function parseCommand(listItem: string_markdown_text): Command;

package/umd/typings/src/conversion/utils/parseCommand.test.d.ts

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

package/umd/typings/src/errors/TemplateError.d.ts

@@ -1,9 +0,0 @@
-/**
- * This error occurs during the parameter replacement in the template
- *
- * Note: This is a kindof subtype of ExecutionError because it occurs during the execution of the pipeline
- */
-export declare class TemplateError extends Error {
-    readonly name = "TemplateError";
-    constructor(message: string);
-}

package/umd/typings/src/llm-providers/mocked/mocked-chat.test.d.ts

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

package/umd/typings/src/llm-providers/multiple/MultipleLlmExecutionToolsOptions.d.ts

@@ -1,24 +0,0 @@
-import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
-import type { client_id } from '../../types/typeAliases';
-import type { string_uri } from '../../types/typeAliases';
-/**
- * Options for MultipleLlmExecutionTools
- */
-export type MultipleLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
-    /**
-     * URL of the multiple PROMPTBOOK server
-     * On this server will be connected to the socket.io server
-     */
-    readonly multipleUrl: URL;
-    /**
-     * Path for the Socket.io server to listen
-     *
-     * @default '/socket.io'
-     * @example '/promptbook/socket.io'
-     */
-    readonly path: string_uri;
-    /**
-     * Your client ID
-     */
-    readonly clientId: client_id;
-};

package/umd/typings/src/types/Command.d.ts

@@ -1,101 +0,0 @@
-import type { ExecutionType } from './ExecutionTypes';
-import type { ModelRequirements } from './ModelRequirements';
-import type { ExpectationAmount } from './PipelineJson/PromptTemplateJson';
-import type { ExpectationUnit } from './PipelineJson/PromptTemplateJson';
-import type { string_markdown_text } from './typeAliases';
-import type { string_name } from './typeAliases';
-import type { string_version } from './typeAliases';
-/**
- * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
- * It is parsed from the markdown from ul/ol items - one command per one item.
- */
-export type Command = PromptbookUrlCommand | PromptbookVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
-/**
- * PromptbookVersion command tells which version is .promptbook file using
- *
- * - It is used for backward compatibility
- * - It is defined per whole .promptbook file in the header
- */
-export type PromptbookUrlCommand = {
-    readonly type: 'PIPELINE_URL';
-    readonly pipelineUrl: URL;
-};
-/**
- * PromptbookVersion command tells which version is .promptbook file using
- *
- * - It is used for backward compatibility
- * - It is defined per whole .promptbook file in the header
- */
-export type PromptbookVersionCommand = {
-    readonly type: 'PROMPTBOOK_VERSION';
-    readonly promptbookVersion: string_version;
-};
-/**
- * Execute command tells how to execute the section
- * It can be either prompt template, script or SIMPLE TEMPLATE etc.
- */
-export type ExecuteCommand = {
-    readonly type: 'EXECUTE';
-    readonly executionType: ExecutionType;
-};
-/**
- * Model command tells which model and modelRequirements to use for the prompt template. execution
- */
-export type ModelCommand = {
-    readonly type: 'MODEL';
-    readonly key: keyof ModelRequirements;
-    readonly value: any;
-};
-/**
- * Joker parameter is used instead of executing the prompt template if it meet the expectations requirements
- */
-export type JokerCommand = {
-    readonly type: 'JOKER';
-    readonly parameterName: string_name;
-};
-/**
- * Parameter command describes one parameter of the prompt template
- *
- * - It can tell if it is input or OUTPUT PARAMETER
- * - It can have description
- * - In description it can have simple formatting BUT not markdown structure or reference to other parameters
- */
-export type ParameterCommand = {
-    readonly type: 'PARAMETER';
-    readonly isInput: boolean;
-    readonly isOutput: boolean;
-    readonly parameterName: string_name;
-    readonly parameterDescription: string_markdown_text | null;
-};
-/**
- * Postprocess command describes which function to use for postprocessing
- * This will be created as separate EXECUTE SCRIPT block bellow
- */
-export type PostprocessCommand = {
-    readonly type: 'POSTPROCESS';
-    readonly functionName: string_name;
-};
-/**
- * Expect command describes the desired output of the prompt template (after post-processing)
- * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs or some other shape of the output.
- */
-export type ExpectCommand = ExpectAmountCommand | ExpectFormatCommand;
-/**
- * Expect amount command describes the desired output of the prompt template (after post-processing)
- * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
- *
- * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
- */
-export type ExpectAmountCommand = {
-    readonly type: 'EXPECT_AMOUNT';
-    readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
-    readonly unit: ExpectationUnit;
-    readonly amount: ExpectationAmount;
-};
-/**
- * Represents a command that expects a specific format.
- */
-export type ExpectFormatCommand = {
-    readonly type: 'EXPECT_FORMAT';
-    readonly format: 'JSON';
-};

package/umd/typings/src/types/ExecutionTypes.d.ts

@@ -1,13 +0,0 @@
-import type { TupleToUnion } from 'type-fest';
-/**
- * Execution type describes the way how the block is executed
- *
- * @see https://github.com/webgptorg/promptbook#execution-type
- */
-export type ExecutionType = TupleToUnion<typeof ExecutionTypes>;
-/**
- * Execution type describes the way how the block is executed
- *
- * @see https://github.com/webgptorg/promptbook#execution-type
- */
-export declare const ExecutionTypes: readonly ["PROMPT_TEMPLATE", "SIMPLE_TEMPLATE", "SCRIPT", "PROMPT_DIALOG"];

package/umd/typings/src/utils/markdown-json/MarkdownStructure.d.ts

@@ -1,25 +0,0 @@
-/**
- * Represents the structure of a markdown file.
- *
- * @private within the package
- */
-export type MarkdownStructure = {
-    /**
-     * The section level of the markdown file.
-     * h1 is level 1, h2 is level 2, etc.
-     */
-    level: number;
-    /**
-     * The title of the markdown file.
-     */
-    title: string;
-    /**
-     * Content of the section.
-     * It contains text, images, formatting, ul, ol, hr, blockquotes, etc. BUT not headings and sub-sections
-     */
-    content: string;
-    /**
-     * The sub-sections of current section which are recursively structured.
-     */
-    sections: MarkdownStructure[];
-};

package/umd/typings/src/utils/markdown-json/countMarkdownStructureDeepness.d.ts

@@ -1,7 +0,0 @@
-import type { MarkdownStructure } from './MarkdownStructure';
-/**
- * Computes the deepness of the markdown structure.
- *
- * @private within the package
- */
-export declare function countMarkdownStructureDeepness(markdownStructure: MarkdownStructure): number;

package/umd/typings/src/utils/markdown-json/markdownToMarkdownStructure.d.ts

@@ -1,13 +0,0 @@
-import type { MarkdownStructure } from './MarkdownStructure';
-/**
- * Parse a markdown string into a MarkdownStructure object.
- *
- * Note: This function does work with code blocks
- * Note: This function does not work with markdown comments
- *
- * @param markdown The markdown string to parse.
- * @returns The MarkdownStructure object.
- *
- * @private within the package
- */
-export declare function markdownToMarkdownStructure(markdown: string): MarkdownStructure;