@promptbook/vercel 0.76.0

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

@@ -0,0 +1,40 @@
+import { CsvFormatError } from '../formats/csv/CsvFormatError';
+import { AbstractFormatError } from './AbstractFormatError';
+import { CollectionError } from './CollectionError';
+import { EnvironmentMismatchError } from './EnvironmentMismatchError';
+import { ExpectError } from './ExpectError';
+import { KnowledgeScrapeError } from './KnowledgeScrapeError';
+import { LimitReachedError } from './LimitReachedError';
+import { MissingToolsError } from './MissingToolsError';
+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 AbstractFormatError: typeof AbstractFormatError;
+    readonly CsvFormatError: typeof CsvFormatError;
+    readonly CollectionError: typeof CollectionError;
+    readonly EnvironmentMismatchError: typeof EnvironmentMismatchError;
+    readonly ExpectError: typeof ExpectError;
+    readonly KnowledgeScrapeError: typeof KnowledgeScrapeError;
+    readonly LimitReachedError: typeof LimitReachedError;
+    readonly MissingToolsError: typeof MissingToolsError;
+    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;
+};
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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/utils/ErrorJson.d.ts

@@ -0,0 +1,20 @@
+import type { ERRORS } from '../0-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/executables/$provideExecutablesForNode.d.ts

@@ -0,0 +1,12 @@
+import type { Executables } from '../execution/Executables';
+import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $provideExecutablesForNode(options?: PrepareAndScrapeOptions): Promise<Executables>;
+/**
+ * TODO: [🧠] Allow to override the executables without need to call `locatePandoc` / `locateLibreoffice` in case of provided
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/executables/apps/locateLibreoffice.d.ts

@@ -0,0 +1,11 @@
+import type { string_executable_path } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locateLibreoffice(): Promise<string_executable_path | null>;
+/**
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/legacy-documents`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/executables/apps/locateLibreoffice.test.d.ts

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

package/esm/typings/src/executables/apps/locatePandoc.d.ts

@@ -0,0 +1,11 @@
+import type { string_executable_path } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locatePandoc(): Promise<string_executable_path | null>;
+/**
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/documents`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/executables/apps/locatePandoc.test.d.ts

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

package/esm/typings/src/executables/locateApp.d.ts

@@ -0,0 +1,33 @@
+import type { RequireAtLeastOne } from 'type-fest';
+import type { string_executable_path } from '../types/typeAliases';
+/**
+ * Options for locating any application
+ */
+export interface LocateAppOptions {
+    /**
+     * Name of the application
+     */
+    appName: string;
+    /**
+     * Name of the executable on Linux
+     */
+    linuxWhich?: string;
+    /**
+     * Path suffix on Windows
+     */
+    windowsSuffix?: string;
+    /**
+     * Name of the application on macOS
+     */
+    macOsName?: string;
+}
+/**
+ * Locates an application on the system
+ *
+ * @private within the repository
+ */
+export declare function locateApp(options: RequireAtLeastOne<LocateAppOptions, 'linuxWhich' | 'windowsSuffix' | 'macOsName'>): Promise<string_executable_path | null>;
+/**
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/executables/locateApp.test.d.ts

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

package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts

@@ -0,0 +1,12 @@
+import type { string_executable_path } from '../../types/typeAliases';
+import type { LocateAppOptions } from '../locateApp';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locateAppOnLinux({ appName, linuxWhich, }: Pick<Required<LocateAppOptions>, 'appName' | 'linuxWhich'>): Promise<string_executable_path | null>;
+/**
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts

@@ -0,0 +1,12 @@
+import type { string_executable_path } from '../../types/typeAliases';
+import type { LocateAppOptions } from '../locateApp';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locateAppOnMacOs({ appName, macOsName, }: Pick<Required<LocateAppOptions>, 'appName' | 'macOsName'>): Promise<string_executable_path | null>;
+/**
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts

@@ -0,0 +1,12 @@
+import type { string_executable_path } from '../../types/typeAliases';
+import type { LocateAppOptions } from '../locateApp';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locateAppOnWindows({ appName, windowsSuffix, }: Pick<Required<LocateAppOptions>, 'appName' | 'windowsSuffix'>): Promise<string_executable_path | null>;
+/**
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

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;
+};

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

@@ -0,0 +1,15 @@
+/**
+ * @@@
+ *
+ * Note: Keep it public to allow people to make their own execution tools
+ */
+export type CommonToolsOptions = {
+    /**
+     * 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

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

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

@@ -0,0 +1,18 @@
+import type { string_executable_path } from '../types/typeAliases';
+/**
+ * Paths to the external programs executables
+ */
+export type Executables = {
+    /**
+     * Path to the `pandoc` executable
+     *
+     * @example 'C:/Users/me/AppData/Local/Pandoc/pandoc.exe'
+     */
+    pandocPath?: string_executable_path;
+    /**
+     * Path to the LibreOffice executable
+     *
+     * @example 'C:/Program Files/LibreOffice/program/swriter.exe'
+     */
+    libreOfficePath?: string_executable_path;
+};

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

@@ -0,0 +1,62 @@
+import type { Scraper } from '../scrapers/_common/Scraper';
+import type { Arrayable } from '../types/Arrayable';
+import type { Executables } from './Executables';
+import type { FilesystemTools } from './FilesystemTools';
+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 in large language models
+     *
+     * Tip: Use `$provideLlmToolsFromEnv` to use all available LLM providers you configured
+     *
+     * @default [] - If not provided, no LLM execution will be possible - it does not make sense in most cases
+     */
+    readonly llm?: Arrayable<LlmExecutionTools>;
+    /**
+     * Tools for filesystem operations
+     *
+     * Tip: Use `$provideFilesystemForNode` to use filesystem in Node.js
+     *
+     * @default undefined - If not provided, no filesystem operations will be possible
+     */
+    readonly fs?: FilesystemTools;
+    /**
+     * Scrapers for extracting knowledge from external sources
+     *
+     * Tip: Use `$provideExecutablesForNode`
+     *
+     * @default [] - If not provided, no external knowledge extraction will be possible
+     */
+    readonly executables?: Executables;
+    /**
+     * Scrapers for extracting knowledge from external sources
+     *
+     * Tip: Use `$provideScrapersForNode` OR `$provideScrapersForBrowser` to use all available scrapers
+     *
+     * @default [] - If not provided, no external knowledge extraction will be possible
+     */
+    readonly scrapers?: Arrayable<Scraper>;
+    /**
+     * 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
+     * Tip: Use here `new JavascriptExecutionTools`
+     *
+     * @default [] - If not provided, no script execution will be possible
+     */
+    readonly 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
+     */
+    readonly userInterface?: UserInterfaceTools;
+};

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

@@ -0,0 +1,9 @@
+/// <reference types="node" />
+import type fs from 'fs/promises';
+/**
+ * Container for all the tools needed to manipulate with filesystem
+ */
+export type FilesystemTools = Pick<typeof fs, 'access' | 'constants' | 'readFile' | 'writeFile' | 'stat' | 'readdir'>;
+/**
+ * TODO: Implement destroyable pattern to free resources
+ */

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

@@ -0,0 +1,61 @@
+import type { Promisable } from 'type-fest';
+import type { Prompt } from '../types/Prompt';
+import type { string_markdown } from '../types/typeAliases';
+import type { string_markdown_text } from '../types/typeAliases';
+import type { string_title } from '../types/typeAliases';
+import type { AvailableModel } from './AvailableModel';
+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;
+    /**
+     * Check comfiguration
+     *
+     * @returns nothing if configuration is correct
+     * @throws {Error} if configuration is incorrect
+     */
+    checkConfiguration(): Promisable<void>;
+    /**
+     * List all available models that can be used
+     */
+    listModels(): Promisable<ReadonlyArray<AvailableModel>>;
+    /**
+     * 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>;
+};
+/**
+ * TODO: [🍚] Implement destroyable pattern to free resources
+ * TODO: [🏳] Add `callTranslationModel`
+ * 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?
+ */

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

@@ -0,0 +1,10 @@
+import type { Registered } from '../utils/$Register';
+import type { TODO_any } from '../utils/organization/TODO_any';
+import type { LlmExecutionTools } from './LlmExecutionTools';
+/**
+ * @@@
+ */
+export type LlmExecutionToolsConstructor = Registered & ((options: TODO_any) => LlmExecutionTools);
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

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

@@ -0,0 +1,19 @@
+import type { Promisable } from 'type-fest';
+import type { TaskProgress } from '../types/TaskProgress';
+import type { Parameters } from '../types/typeAliases';
+import type { PipelineExecutorResult } from './PipelineExecutorResult';
+/**
+ * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
+ * Executor is made by combining execution tools and pipeline collection.
+ *
+ * It can be created with `createPipelineExecutor` function.
+ *
+ * @see https://github.com/webgptorg/promptbook#executor
+ */
+export type PipelineExecutor = {
+    (inputParameters: Parameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
+};
+/**
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
+ * TODO: [🧠] Should this file be in /execution or /types folder?
+ */