@promptbook/vercel 0.76.0

package/esm/typings/src/config.d.ts

@@ -0,0 +1,238 @@
+import type { CsvSettings } from './formats/csv/CsvSettings';
+import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
+import type { string_url_image } from './types/typeAliases';
+/**
+ * Warning message for the generated sections and files files
+ *
+ * @private within the repository
+ */
+export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has been generated so that any manual changes will be overwritten";
+/**
+ * Name for the Promptbook
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const NAME = "Promptbook";
+/**
+ * Claim for the Promptbook
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const CLAIM = "It's time for a paradigm shift. The future of software in plain English, French or Latin";
+/**
+ * Logo for the light theme
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const LOGO_LIGHT_SRC: string_url_image;
+/**
+ * Logo for the dark theme
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const LOGO_DARK_SRC: string_url_image;
+/**
+ * When the title is not provided, the default title is used
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_TITLE = "Untitled";
+/**
+ * Warning message for the generated sections and files files
+ *
+ * @private within the repository
+ */
+export declare const GENERATOR_WARNING_BY_PROMPTBOOK_CLI = "\u26A0\uFE0F WARNING: This code has been generated by `@promptbook/cli` so that any manual changes will be overwritten";
+/**
+ * The maximum number of iterations for a loops
+ *
+ * @private within the repository - too low-level in comparison with other `MAX_...`
+ */
+export declare const LOOP_LIMIT = 1000;
+/**
+ * The maximum number of iterations for a loops which adds characters one by one
+ *
+ * @private within the repository - too low-level in comparison with other `MAX_...`
+ */
+export declare const CHARACTER_LOOP_LIMIT = 100000;
+/**
+ * Timeout for the connections in milliseconds
+ *
+ * @private within the repository - too low-level in comparison with other `MAX_...`
+ */
+export declare const CONNECTION_TIMEOUT_MS: number;
+/**
+ * How many times to retry the connections
+ *
+ * @private within the repository - too low-level in comparison with other `MAX_...`
+ */
+export declare const CONNECTION_RETRIES_LIMIT = 5;
+/**
+ * Short time interval to prevent race conditions in milliseconds
+ *
+ * @private within the repository - too low-level in comparison with other `MAX_...`
+ */
+export declare const IMMEDIATE_TIME = 10;
+/**
+ * The maximum length of the (generated) filename
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MAX_FILENAME_LENGTH = 30;
+/**
+ * Strategy for caching the intermediate results for knowledge sources
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_INTERMEDIATE_FILES_STRATEGY: IntermediateFilesStrategy;
+/**
+ * The maximum number of (LLM) tasks running in parallel
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_MAX_PARALLEL_COUNT = 5;
+/**
+ * The maximum number of attempts to execute LLM task before giving up
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_MAX_EXECUTION_ATTEMPTS = 3;
+/**
+ * @@@
+ * TODO: [🐝][main] !!! Use
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
+/**
+ * @@@
+ * TODO: [🐝][main] !!! Use
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
+/**
+ * Where to store your books
+ * This is kind of a "src" for your books
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_BOOKS_DIRNAME = "./books";
+/**
+ * Where to store the cache of executions for promptbook CLI
+ *
+ * Note: When the folder does not exist, it is created recursively
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_EXECUTIONS_CACHE_DIRNAME = "./.promptbook/executions-cache";
+/**
+ * Where to store the scrape cache
+ *
+ * Note: When the folder does not exist, it is created recursively
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_SCRAPE_CACHE_DIRNAME = "./.promptbook/scrape-cache";
+/**
+ * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME = "index";
+/**
+ * Nonce which is used for replacing things in strings
+ *
+ * @private within the repository
+ */
+export declare const REPLACING_NONCE = "u$k42k%!V2zo34w7Fu#@QUHYPW";
+/**
+ * The names of the parameters that are reserved for special purposes
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const RESERVED_PARAMETER_NAMES: readonly ["content", "context", "knowledge", "examples", "modelName", "currentDate"];
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare const RESERVED_PARAMETER_MISSING_VALUE: string;
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare const RESERVED_PARAMETER_RESTRICTED: string;
+/**
+ * The thresholds for the relative time in the `moment` NPM package.
+ *
+ * @see https://momentjscom.readthedocs.io/en/latest/moment/07-customization/13-relative-time-threshold/
+ * @private within the repository - too low-level in comparison with other constants
+ */
+export declare const MOMENT_ARG_THRESHOLDS: {
+    readonly ss: 3;
+};
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_REMOTE_URL = "https://api.pavolhejny.com/";
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_REMOTE_URL_PATH = "/promptbook/socket.io";
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_CSV_SETTINGS: CsvSettings;
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare let DEFAULT_IS_VERBOSE: boolean;
+/**
+ * @@@
+ *
+ * Note: This is experimental feature
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function SET_IS_VERBOSE(isVerbose: boolean): void;
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_IS_AUTO_INSTALLED = false;
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare const IS_COST_PREVENTED: boolean;
+/**
+ * TODO: Extract `constants.ts` from `config.ts`
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ */

package/esm/typings/src/config.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] Maybe more elegant how to prevent accidental costs
+ */

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

@@ -0,0 +1,17 @@
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
+/**
+ * Converts promptbook in JSON format to string format
+ *
+ * @param pipelineJson Promptbook in JSON format (.book.json)
+ * @returns Promptbook in string format (.book.md)
+ * @public exported from `@promptbook/core`
+ */
+export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
+/**
+ * TODO: [🛋] Implement new features and commands into `pipelineJsonToString` + `taskParameterJsonToString` , use `stringifyCommand`
+ * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
+ * TODO: [🏛] Maybe make some markdown builder
+ * TODO: [🏛] Escape all
+ * TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
+ */

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

@@ -0,0 +1,28 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
+import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
+/**
+ * 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 (.book.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 (.book.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' | 'fs' | '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 '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/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 (.book.md)
+ * @returns {Promptbook} compiled in JSON format (.book.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 tasks 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 '../../pipeline/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 '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { string_href } from '../../types/typeAliases';
+/**
+ * Addtional options for rendering Mermaid graph
+ */
+export type renderPipelineMermaidOptions = {
+    /**
+     * Callback for creating from task graph node
+     */
+    linkTask?(task: TaskJson): {
+        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/extractParameterNamesFromTask.d.ts

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

package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.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 '../../pipeline/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 task
+ * In other words, it will find all parameters that are not used in the task 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/examples/mixed-knowledge.book.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,30 @@
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../../pipeline/PipelineString';
+import type { string_json } from '../../types/typeAliases';
+/**
+ * Import the pipeline.book.md or pipeline.book.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 examples/pipelines directory
+ * @private internal function of tests
+ */
+export declare function importPipelineWithoutPreparation(path: `${string}.book.md`): PipelineString;
+export declare function importPipelineWithoutPreparation(path: `${string}.book.json`): PipelineJson;
+/**
+ * Import the pipeline.book.json file as parsed JSON
+ *
+ * @private internal function of tests
+ */
+export declare function importPipelineJson(path: `${string}.book.json`): PipelineJson;
+/**
+ * Import the pipeline.book.json file as string
+ *
+ * @private internal function of tests
+ */
+export declare function importPipelineJsonAsString(path: `${string}.book.json`): string_json<PipelineJson>;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * 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 '../../pipeline/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 examples 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 {
+    protected readonly options: CallbackInterfaceToolsOptions;
+    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 {
+    protected readonly options: CommonToolsOptions;
+    constructor(options?: CommonToolsOptions);
+    /**
+     * Trigger window.prompt dialog
+     */
+    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/0-BoilerplateError.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This error indicates @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class BoilerplateError extends Error {
+    readonly name = "BoilerplateError";
+    constructor(message: string);
+}
+/**
+ * TODO: @@@ Do not forget to add the error into `0-index.ts` ERRORS
+ */