@promptbook/legacy-documents 0.71.0-12

package/esm/typings/src/conversion/pipelineStringToJson.d.ts

@@ -0,0 +1,28 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PipelineString } from '../types/PipelineString';
+/**
+ * Compile pipeline from string (markdown) format to JSON format
+ *
+ * Note: There are 3 similar functions:
+ * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `preparePipeline` - just one step in the compilation process
+ *
+ * Note: This function does not validate logic of the pipeline only the parsing
+ * Note: This function acts as compilation process
+ *
+ * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
+ * @param tools - Tools for the preparation and scraping - if not provided together with `llm`, the preparation will be skipped
+ * @param options - Options and tools for the compilation
+ * @returns {Promptbook} compiled in JSON format (.ptbk.json)
+ * @throws {ParseError} if the promptbook string is not valid
+ * @public exported from `@promptbook/core`
+ */
+export declare function pipelineStringToJson(pipelineString: PipelineString, tools?: Pick<ExecutionTools, 'llm' | 'scrapers'>, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
+/**
+ * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ * TODO: [🧠] Should be in generated JSON file GENERATOR_WARNING
+ */

package/esm/typings/src/conversion/pipelineStringToJson.test.d.ts

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

package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts

@@ -0,0 +1,29 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PipelineString } from '../types/PipelineString';
+/**
+ * Compile pipeline from string (markdown) format to JSON format synchronously
+ *
+ * Note: There are 3 similar functions:
+ * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `preparePipeline` - just one step in the compilation process
+ *
+ * Note: This function does not validate logic of the pipeline only the parsing
+ * Note: This function acts as compilation process
+ *
+ * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
+ * @returns {Promptbook} compiled in JSON format (.ptbk.json)
+ * @throws {ParseError} if the promptbook string is not valid
+ * @public exported from `@promptbook/core`
+ */
+export declare function pipelineStringToJsonSync(pipelineString: PipelineString): PipelineJson;
+/**
+ * TODO: [main] !!!! Warn if used only sync version
+ * TODO: [🚞] Report here line/column of error
+ * TODO: Use spaceTrim more effectively
+ * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
+ * TODO: [🥞] Not optimal parsing because `splitMarkdownIntoSections` is executed twice with same string, once through `flattenMarkdown` and second directly here
+ * TODO: [♈] Probbably move expectations from templates to parameters
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ * TODO: [🍙] Make some standard order of json properties
+ */

package/esm/typings/src/conversion/pipelineStringToJsonSync.test.d.ts

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

package/esm/typings/src/conversion/prettify/PrettifyOptions.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Options for `prettifyPipelineString` function
+ */
+export type PrettifyOptions = {
+    /***
+     * If true, adds Mermaid graph to the Promptbook string
+     */
+    readonly isGraphAdded?: boolean;
+    /**
+     * If true, the string is prettifyed as markdown
+     */
+    readonly isPrettifyed?: boolean;
+};

package/esm/typings/src/conversion/prettify/prettifyPipelineString.d.ts

@@ -0,0 +1,12 @@
+import type { PipelineString } from '../../types/PipelineString';
+import type { PrettifyOptions } from './PrettifyOptions';
+/**
+ * Prettyfies Promptbook string and adds Mermaid graph
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function prettifyPipelineString(pipelineString: PipelineString, options: PrettifyOptions): Promise<PipelineString>;
+/**
+ * TODO: Maybe use some Mermaid package instead of string templating
+ * TODO: [🕌] When more than 2 functionalities, split into separate functions
+ */

package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts

@@ -0,0 +1,30 @@
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { string_href } from '../../types/typeAliases';
+/**
+ * Addtional options for rendering Mermaid graph
+ */
+export type renderPipelineMermaidOptions = {
+    /**
+     * Callback for creating from template graph node
+     */
+    linkTemplate?(template: TemplateJson): {
+        href: string_href;
+        title: string;
+    } | null;
+};
+/**
+ * Creates a Mermaid graph based on the promptbook
+ *
+ * Note: The result is not wrapped in a Markdown code block
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function renderPromptbookMermaid(pipelineJson: PipelineJson, options?: renderPipelineMermaidOptions): string;
+/**
+ * TODO: !!!!! FOREACH in mermaid graph
+ * TODO: !!!!! Knowledge in mermaid graph
+ * TODO: !!!!! Personas in mermaid graph
+ * TODO: Maybe use some Mermaid package instead of string templating
+ * TODO: [🕌] When more than 2 functionalities, split into separate functions
+ */

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

@@ -0,0 +1,15 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { string_parameter_name } from '../../types/typeAliases';
+/**
+ * Parses the template and returns the set of all used parameters
+ *
+ * @param template the template with used parameters
+ * @returns the set of parameter names
+ * @throws {ParseError} if the script is invalid
+ * @public exported from `@promptbook/utils`
+ */
+export declare function extractParameterNamesFromTemplate(template: ReadonlyDeep<Pick<TemplateJson, 'title' | 'description' | 'templateType' | 'content' | 'preparedContent' | 'jokerParameterNames' | 'foreach'>>): Set<string_parameter_name>;
+/**
+ * TODO: [🔣] If script require contentLanguage
+ */

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

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

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

@@ -0,0 +1,14 @@
+import type { string_javascript } from '../../types/typeAliases';
+import type { 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
+ * @throws {ParseError} if the script is invalid
+ * @public exported from `@promptbook/utils`
+ */
+export declare function extractVariables(script: string_javascript): Set<string_javascript_name>;
+/**
+ * TODO: [🔣] Support for multiple languages - python, java,...
+ */

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

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

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

@@ -0,0 +1,26 @@
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { string_name } from '../../types/typeAliases';
+type RenameParameterOptions = {
+    /**
+     * Pipeline to search and replace for parameters
+     * This pipeline is returned as copy with replaced parameters
+     */
+    readonly pipeline: PipelineJson;
+    /**
+     * Original parameter name that should be replaced
+     */
+    readonly oldParameterName: string_name;
+    /**
+     * New parameter name that should replace the original parameter name
+     */
+    readonly newParameterName: string_name;
+};
+/**
+ * Function `renameParameter` will find all usable parameters for given template
+ * In other words, it will find all parameters that are not used in the template itseld and all its dependencies
+ *
+ * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
+ * @public exported from `@promptbook/utils`
+ */
+export declare function renameParameter(options: RenameParameterOptions): PipelineJson;
+export {};

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

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

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

@@ -0,0 +1,16 @@
+import type { string_json } from '../../types/typeAliases';
+/**
+ * Stringify the PipelineJson with proper formatting
+ *
+ * Note: [0] It can be used for more JSON types like whole collection of pipelines, single knowledge piece, etc.
+ * Note: In contrast to JSON.stringify, this function ensures that **embedding index** is on single line
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
+/**
+ * TODO: [🐝] Not Working propperly @see https://promptbook.studio/samples/mixed-knowledge.ptbk.md
+ * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
+ * TODO: [🧠] Maybe more elegant solution than replacing via regex
+ * TODO: [🍙] Make some standard order of json properties
+ */

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * @@@
+ *
+ * @param value @@@
+ * @returns @@@
+ * @example @@@
+ * @public exported from `@promptbook/utils`
+ */
+export declare function titleToName(value: string): string;

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

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

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

@@ -0,0 +1,29 @@
+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/pipelines directory
+ * @private internal function of tests
+ */
+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
+ *
+ * @private internal function of tests
+ */
+export declare function importPipelineJson(path: `${string}.ptbk.json`): PipelineJson;
+/**
+ * Import the pipeline.ptbk.json file as string
+ *
+ * @private internal function of tests
+ */
+export declare function importPipelineJsonAsString(path: `${string}.ptbk.json`): string_json<PipelineJson>;
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

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

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🚏] DRY
+ */

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

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🚏] DRY
+ */

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

@@ -0,0 +1,42 @@
+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
+ * @public exported from `@promptbook/core`
+ */
+export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
+/**
+ * @private internal function for `validatePipeline`
+ */
+export declare function validatePipelineCore(pipeline: PipelineJson): void;
+/**
+ * TODO: !!!!! [🧞‍♀️] Do not allow joker + foreach
+ * 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: [🧳][main] !!!! Validate that all samples match expectations
+ * TODO: [🧳][🐝][main] !!!! Validate that knowledge is valid (non-void)
+ * TODO: [🧳][main] !!!! Validate that persona can be used only with CHAT variant
+ * TODO: [🧳][main] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
+ * TODO: [🧳][main] !!!! 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

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🚏] DRY
+ */

package/esm/typings/src/dialogs/callback/CallbackInterfaceTools.d.ts

@@ -0,0 +1,17 @@
+import type { UserInterfaceTools } from '../../execution/UserInterfaceTools';
+import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
+import type { CallbackInterfaceToolsOptions } from './CallbackInterfaceToolsOptions';
+/**
+ * Delagates the user interaction to a async callback function
+ * You need to provide your own implementation of this callback function and its bind to UI.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class CallbackInterfaceTools implements UserInterfaceTools {
+    private readonly options;
+    constructor(options: CallbackInterfaceToolsOptions);
+    /**
+     * Trigger the custom callback function
+     */
+    promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
+}

package/esm/typings/src/dialogs/callback/CallbackInterfaceToolsOptions.d.ts

@@ -0,0 +1,14 @@
+import type { Promisable } from 'type-fest';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
+/**
+ * Options for `CallbackInterfaceTools`
+ *
+ * @public exported from `@promptbook/core`
+ */
+export type CallbackInterfaceToolsOptions = CommonToolsOptions & {
+    /**
+     * The callback function to be called when promptDialog is called
+     */
+    callback(prompt: UserInterfaceToolsPromptDialogOptions): Promisable<string>;
+};

package/esm/typings/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts

@@ -0,0 +1,22 @@
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { UserInterfaceTools } from '../../execution/UserInterfaceTools';
+import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
+/**
+ * Wrapper around `window.prompt` synchronous function that interacts with the user via browser prompt
+ *
+ * Warning: It is used for testing and mocking
+ *          **NOT intended to use in the production** due to its synchronous nature.
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
+    private readonly options;
+    constructor(options?: CommonToolsOptions);
+    /**
+     * Trigger window.DIALOG TEMPLATE
+     */
+    promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
+}
+/**
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

package/esm/typings/src/dialogs/user-interface-execution-tools.test.d.ts

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

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

@@ -0,0 +1,11 @@
+/**
+ * This error indicates problems parsing the format value
+ *
+ * For example, when the format value is not a valid JSON or CSV
+ * This is not thrown directly but in extended classes
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class AbstractFormatError extends Error {
+    constructor(message: string);
+}

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

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

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * This error occurs when some expectation is not met in the execution of the pipeline
+ *
+ * @public exported from `@promptbook/core`
+ * Note: Do not throw this error, its reserved for `checkExpectations` and `createPipelineExecutor` and public ONLY to be serializable through remote server
+ * Note: Always thrown in `checkExpectations` and catched in `createPipelineExecutor` 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/errors/KnowledgeScrapeError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This error indicates that the promptbook can not retrieve knowledge from external sources
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class KnowledgeScrapeError extends Error {
+    readonly name = "KnowledgeScrapeError";
+    constructor(message: string);
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This error type indicates that some limit was reached
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class LimitReachedError extends Error {
+    readonly name = "LimitReachedError";
+    constructor(message: string);
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This error type indicates that some tools are missing for pipeline execution or preparation
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class MissingToolsError extends Error {
+    readonly name = "MissingToolsError";
+    constructor(message: string);
+}

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

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

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class ParseError extends Error {
+    readonly name = "ParseError";
+    constructor(message: string);
+}
+/**
+ * TODO: Maybe split `ParseError` and `ApplyError`
+ */

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

@@ -0,0 +1,9 @@
+/**
+ * This error indicates errors during the execution of the pipeline
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class PipelineExecutionError extends Error {
+    readonly name = "PipelineExecutionError";
+    constructor(message: string);
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This error indicates that the promptbook object has valid syntax (=can be parsed) but contains logical errors (like circular dependencies)
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class PipelineLogicError extends Error {
+    readonly name = "PipelineLogicError";
+    constructor(message: string);
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This error indicates errors in referencing promptbooks between each other
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class PipelineUrlError extends Error {
+    readonly name = "PipelineUrlError";
+    constructor(message: string);
+}

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

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

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

@@ -0,0 +1,29 @@
+import { CollectionError } from './CollectionError';
+import { EnvironmentMismatchError } from './EnvironmentMismatchError';
+import { ExpectError } from './ExpectError';
+import { LimitReachedError } from './LimitReachedError';
+import { NotFoundError } from './NotFoundError';
+import { NotYetImplementedError } from './NotYetImplementedError';
+import { ParseError } from './ParseError';
+import { PipelineExecutionError } from './PipelineExecutionError';
+import { PipelineLogicError } from './PipelineLogicError';
+import { PipelineUrlError } from './PipelineUrlError';
+import { UnexpectedError } from './UnexpectedError';
+/**
+ * Index of all custom errors
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ERRORS: {
+    readonly ExpectError: typeof ExpectError;
+    readonly CollectionError: typeof CollectionError;
+    readonly EnvironmentMismatchError: typeof EnvironmentMismatchError;
+    readonly LimitReachedError: typeof LimitReachedError;
+    readonly NotFoundError: typeof NotFoundError;
+    readonly NotYetImplementedError: typeof NotYetImplementedError;
+    readonly ParseError: typeof ParseError;
+    readonly PipelineExecutionError: typeof PipelineExecutionError;
+    readonly PipelineLogicError: typeof PipelineLogicError;
+    readonly PipelineUrlError: typeof PipelineUrlError;
+    readonly UnexpectedError: typeof UnexpectedError;
+};

package/esm/typings/src/errors/utils/ErrorJson.d.ts

@@ -0,0 +1,20 @@
+import type { ERRORS } from '../index';
+/**
+ * Represents a serialized error or custom Promptbook error
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ErrorJson = {
+    /**
+     * The type of the error
+     */
+    readonly name: keyof typeof ERRORS | 'Error';
+    /**
+     * The message of the error
+     */
+    readonly message: string;
+    /**
+     * The stack trace of the error
+     */
+    readonly stack?: string;
+};

package/esm/typings/src/errors/utils/deserializeError.d.ts

@@ -0,0 +1,7 @@
+import type { ErrorJson } from './ErrorJson';
+/**
+ * Deserializes the error object
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function deserializeError(error: ErrorJson): Error;

package/esm/typings/src/errors/utils/deserializeError.test.d.ts

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

package/esm/typings/src/errors/utils/serializeError.d.ts

@@ -0,0 +1,7 @@
+import type { ErrorJson } from './ErrorJson';
+/**
+ * Serializes an error into a [🚉] JSON-serializable object
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function serializeError(error: Error): ErrorJson;

package/esm/typings/src/errors/utils/serializeError.test.d.ts

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

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

@@ -0,0 +1,20 @@
+import type { ModelVariant } from '../types/ModelVariant';
+import type { string_model_name } from '../types/typeAliases';
+import type { string_title } from '../types/typeAliases';
+/**
+ * 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;
+};