@promptbook/markdown-utils 0.61.0-10

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

@@ -0,0 +1,114 @@
+import type { KebabCase } from 'type-fest';
+import type { ExpectationUnit } from '../types/PipelineJson/Expectations';
+import type { number_positive } from '../types/typeAliases';
+import type { number_usd } from '../types/typeAliases';
+import type { string_date_iso8601 } from '../types/typeAliases';
+import type { string_model_name } from '../types/typeAliases';
+import type { EmbeddingVector } from './EmbeddingVector';
+/**
+ * Prompt result is the simplest concept of execution.
+ * It is the result of executing one prompt _(NOT a template)_.
+ *
+ * @see https://github.com/webgptorg/promptbook#prompt-result
+ */
+export type PromptResult = PromptCompletionResult | PromptChatResult | PromptEmbeddingResult;
+/**
+ * Prompt completion result
+ * It contains only the following text NOT the whole completion
+ */
+export type PromptCompletionResult = PromptCommonResult;
+/**
+ * Prompt chat result
+ */
+export type PromptChatResult = PromptCommonResult & {};
+/**
+ * Prompt embedding result
+ * It contains only the following text NOT the whole completion
+ */
+export type PromptEmbeddingResult = Omit<PromptCommonResult, 'content'> & {
+    /**
+     * The response from the model
+     */
+    content: EmbeddingVector;
+};
+export type PromptCommonResult = {
+    /**
+     * Exact text response from the model
+     */
+    readonly content: string;
+    /**
+     * Name of the model used to generate the response
+     */
+    readonly modelName: string_model_name;
+    /**
+     * Timing
+     */
+    readonly timing: {
+        /**
+         * Start of the execution
+         */
+        readonly start: string_date_iso8601;
+        /**
+         * First token generated
+         */
+        readonly firstToken?: string_date_iso8601;
+        /**
+         * End of the execution
+         */
+        readonly complete: string_date_iso8601;
+    };
+    /**
+     * Usage of the prompt execution
+     */
+    readonly usage: PromptResultUsage;
+    /**
+     * Raw response from the model
+     */
+    readonly rawResponse: object;
+};
+/**
+ * Usage statistics for one or many prompt results
+ */
+export type PromptResultUsage = {
+    /**
+     * Cost of the execution in USD
+     *
+     * Note: If the cost is unknown, the value 0 and isUncertain is true
+     */
+    price: UncertainNumber;
+    /**
+     * Number of whatever used in the input aka. `prompt_tokens`
+     */
+    input: PromptResultUsageCounts;
+    /**
+     * Number of tokens used in the output aka. `completion_tokens`
+     */
+    output: PromptResultUsageCounts;
+};
+/**
+ * Record of all possible measurable units
+ */
+export type PromptResultUsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
+/**
+ * Number which can be uncertain
+ *
+ * Note: If the value is completelly unknown, the value 0 and isUncertain is true
+ * Note: Not using NaN or null because it looses the value which is better to be uncertain then not to be at all
+ */
+export type UncertainNumber = {
+    /**
+     * The numeric value
+     */
+    readonly value: number_usd & (number_positive | 0);
+    /**
+     * Is the value uncertain
+     */
+    readonly isUncertain?: true;
+};
+/**
+ * TODO: [🧠] Maybe timing more accurate then seconds?
+ * TODO: [🧠] Should here be link to the prompt?
+ * TODO: [🧠] Maybe type raw properly - not onject but OpenAI.result.whatever
+ * TODO: [🧠] Maybe remove redundant raw.choices.text
+ * TODO: Log raw even if prompt failed - log the raw error
+ */

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

@@ -0,0 +1,38 @@
+import type { ScriptLanguage } from '../types/ScriptLanguage';
+import type { string_name } from '../types/typeAliases';
+import type { string_script } from '../types/typeAliases';
+/**
+ * Represents all the tools needed to EXECUTE SCRIPTs
+ *
+ * @see https://github.com/webgptorg/promptbook#script-execution-tools
+ */
+export type ScriptExecutionTools = {
+    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
+};
+/**
+ * Input for the script execution
+ */
+export type ScriptExecutionToolsExecuteOptions = {
+    /**
+     * Language of the script
+     */
+    readonly scriptLanguage: ScriptLanguage;
+    /**
+     * Parameters for the script
+     * Theese parameters are passed to the script as variables
+     * For example: { "name": "John" } => const name = "John";
+     */
+    readonly parameters: Record<string_name, string>;
+    /**
+     * The content of the script to execute
+     * - It can be a single statement
+     * - It can be multiple statements separated by semicolon and return
+     * - It can be a function (but you need to call it)
+     * - It can be IIFE (immediately invoked function expression)
+     * - It can use the parameters as variables and functions from global scope
+     */
+    readonly script: string_script;
+};
+/**
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ */

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

@@ -0,0 +1,46 @@
+import type { number_integer } from '../types/typeAliases';
+import type { number_positive } from '../types/typeAliases';
+/**
+ * Represents all the tools needed to interact with the user.
+ *
+ * @see https://github.com/webgptorg/promptbook#user-interface-tools
+ */
+export type UserInterfaceTools = {
+    /**
+     * Asks the user to answer a free-text (multi-line) question
+     *
+     * @param options the question to ask
+     * @returns the answer from the user
+     */
+    promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
+};
+export type UserInterfaceToolsPromptDialogOptions = {
+    /**
+     * Prompt title
+     *
+     * Note: This is not a prompt to language model but a prompt to the user
+     * @example "Your name"
+     */
+    readonly promptTitle: string;
+    /**
+     * Prompt message
+     *
+     * Note: This is not a prompt to language model but a prompt to the user
+     * @example "Please enter your name, including your last name, title, etc."
+     */
+    readonly promptMessage: string;
+    /**
+     * Default value for the input/textarea
+     */
+    readonly defaultValue: string | null;
+    /**
+     * Placeholder for the input/textarea
+     */
+    readonly placeholder?: string;
+    /**
+     * Priority of the prompt
+     *
+     * Note: This would be reflected for example into the UI z-index of the prompt modal
+     */
+    readonly priority: number_integer & number_positive;
+};

package/esm/typings/src/execution/addPromptResultUsage.test.d.ts

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

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

@@ -0,0 +1,11 @@
+import type { PipelineExecutor } from './PipelineExecutor';
+/**
+ * Asserts that the execution of a promptnook is successful
+ *
+ * @param executionResult - The partial result of the promptnook execution
+ * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
+ */
+export declare function assertsExecutionSuccessful(executionResult: Pick<Awaited<ReturnType<PipelineExecutor>>, 'isSuccessful' | 'errors'>): void;
+/**
+ * TODO: [🧠] Can this return type be better typed than void
+ */

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

@@ -0,0 +1,43 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { ExecutionTools } from './ExecutionTools';
+import type { PipelineExecutor } from './PipelineExecutor';
+type CreatePipelineExecutorSettings = {
+    /**
+     * When executor does not satisfy expectations it will be retried this amount of times
+     *
+     * @default 3
+     */
+    readonly maxExecutionAttempts: number;
+};
+/**
+ * Options for `createPipelineExecutor`
+ */
+interface CreatePipelineExecutorOptions {
+    /**
+     * The pipeline to be executed
+     */
+    readonly pipeline: PipelineJson;
+    /**
+     * The execution tools to be used during the execution of the pipeline
+     */
+    readonly tools: ExecutionTools;
+    /**
+     * Optional settings for the pipeline executor
+     */
+    readonly settings?: Partial<CreatePipelineExecutorSettings>;
+}
+/**
+ * Creates executor function from pipeline and execution tools.
+ *
+ * @returns The executor function
+ * @throws {PipelineLogicError} on logical error in the pipeline
+ */
+export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
+export {};
+/**
+ * TODO: [🪂] Pass maxParallelCount here
+ * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
+ * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
+ * Note: CreatePipelineExecutorOptions are just connected to PipelineExecutor so do not extract to types folder
+ * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
+ */

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

@@ -0,0 +1,5 @@
+import type { EmbeddingVector } from './EmbeddingVector';
+/**
+ * Pretty print an embedding vector for logging
+ */
+export declare function embeddingVectorToString(embeddingVector: EmbeddingVector): string;

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts

@@ -0,0 +1,4 @@
+import type { Promisable } from 'type-fest';
+export type AutomaticTranslator = {
+    translate(message: string): Promisable<string>;
+};

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts

@@ -0,0 +1,9 @@
+import type { AutomaticTranslator } from './AutomaticTranslator';
+/**
+ * This will wrap an automatic translator and log each translation into the console
+ */
+export declare class DebugAutomaticTranslator implements AutomaticTranslator {
+    private readonly automaticTranslator;
+    constructor(automaticTranslator: AutomaticTranslator);
+    translate(message: string): Promise<string>;
+}

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts

@@ -0,0 +1,5 @@
+import type { AutomaticTranslator } from './AutomaticTranslator';
+export declare class FakeAutomaticTranslator implements AutomaticTranslator {
+    constructor();
+    translate(message: string): string;
+}

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts

@@ -0,0 +1,11 @@
+import type { AutomaticTranslator } from './AutomaticTranslator';
+import type { TranslatorOptions } from './TranslatorOptions';
+interface LindatAutomaticTranslatorOptions extends TranslatorOptions {
+    apiUrl?: URL;
+}
+export declare class LindatAutomaticTranslator implements AutomaticTranslator {
+    private readonly options;
+    constructor(options: LindatAutomaticTranslatorOptions);
+    translate(message: string): Promise<string>;
+}
+export {};

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts

@@ -0,0 +1,4 @@
+export type TranslatorOptions = {
+    readonly from?: string;
+    readonly to: string;
+};

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts

@@ -0,0 +1,7 @@
+/**
+ *
+ * @param message
+ * @returns
+ * @throws {PipelineExecutionError}
+ */
+export declare function extractMultiplicatedOccurrence(message: string): string;

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts

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

package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts

@@ -0,0 +1,5 @@
+import type { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
+import type { TranslatorOptions } from './automatic-translators/TranslatorOptions';
+export declare function translateMessages({ automaticTranslator, from, to, }: {
+    automaticTranslator: AutomaticTranslator;
+} & TranslatorOptions): Promise<void>;

package/esm/typings/src/execution/utils/addUsage.d.ts

@@ -0,0 +1,7 @@
+import type { PromptResultUsage } from '../PromptResult';
+/**
+ * Function `addUsage` will add multiple usages into one
+ *
+ * Note: If you provide 0 values, it returns void usage
+ */
+export declare function addUsage(...usageItems: Array<PromptResultUsage>): PromptResultUsage;

package/esm/typings/src/execution/utils/addUsage.test.d.ts

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

package/esm/typings/src/execution/utils/checkExpectations.d.ts

@@ -0,0 +1,25 @@
+import type { Expectations } from '../../types/PipelineJson/Expectations';
+/**
+ * Function checkExpectations will check if the expectations on given value are met
+ *
+ * Note: There are two simmilar functions:
+ * - `checkExpectations` which throws an error if the expectations are not met
+ * - `isPassingExpectations` which returns a boolean
+ *
+ * @throws {ExpectError} if the expectations are not met
+ * @returns {void} Nothing
+ */
+export declare function checkExpectations(expectations: Expectations, value: string): void;
+/**
+ * Function checkExpectations will check if the expectations on given value are met
+ *
+ * Note: There are two simmilar functions:
+ * - `checkExpectations` which throws an error if the expectations are not met
+ * - `isPassingExpectations` which returns a boolean
+ *
+ * @returns {boolean} True if the expectations are met
+ */
+export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
+/**
+ * TODO: [💝] Unite object for expecting amount and format
+ */

package/esm/typings/src/execution/utils/checkExpectations.test.d.ts

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

package/esm/typings/src/execution/utils/computeUsageCounts.d.ts

@@ -0,0 +1,10 @@
+import type { PromptResultUsageCounts } from '../PromptResult';
+/**
+ * Helper of usage compute
+ *
+ * @param content the content of prompt or response
+ * @returns part of PromptResultUsageCounts
+ *
+ * @private internal util of LlmExecutionTools
+ */
+export declare function computeUsageCounts(content: string): Omit<PromptResultUsageCounts, 'tokensCount'>;

package/esm/typings/src/execution/utils/forEachAsync.d.ts

@@ -0,0 +1,18 @@
+import type { Promisable } from 'type-fest';
+type ForEachAsyncOptions = {
+    /**
+     * Maximum number of tasks running in parallel
+     *
+     * @default Infinity
+     */
+    readonly maxParallelCount?: number;
+};
+/**
+ * Async version of Array.forEach
+ *
+ * @param array - Array to iterate over
+ * @param options - Options for the function
+ * @param callbackfunction - Function to call for each item
+ */
+export declare function forEachAsync<TItem>(array: Array<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: Array<TItem>) => Promisable<void>): Promise<void>;
+export {};

package/esm/typings/src/execution/utils/replaceParameters.d.ts

@@ -0,0 +1,13 @@
+import type { Parameters } from '../../types/Parameters';
+import type { string_template } from '../../types/typeAliases';
+/**
+ * Replaces parameters in template with values from parameters object
+ *
+ * @param template the template with parameters in {curly} braces
+ * @param parameters the object with parameters
+ * @returns the template with replaced parameters
+ * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
+ *
+ * @private within the createPipelineExecutor
+ */
+export declare function replaceParameters(template: string_template, parameters: Parameters): string;

package/esm/typings/src/execution/utils/replaceParameters.test.d.ts

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

package/esm/typings/src/execution/utils/uncertainNumber.d.ts

@@ -0,0 +1,9 @@
+import type { UncertainNumber } from '../PromptResult';
+/**
+ * Make UncertainNumber
+ *
+ * @param value
+ *
+ * @private utility for initializating UncertainNumber
+ */
+export declare function uncertainNumber(value?: number | typeof NaN | undefined | null): UncertainNumber;

package/esm/typings/src/execution/utils/usageToWorktime.d.ts

@@ -0,0 +1,10 @@
+import type { PromptResultUsage } from '../PromptResult';
+import type { UncertainNumber } from '../PromptResult';
+/**
+ * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
+ *
+ * Note: This is an estimate based of theese sources:
+ * - https://jecas.cz/doba-cteni
+ * - https://www.originalnitonery.cz/blog/psani-vsemi-deseti-se-muzete-naucit-i-sami-doma
+ */
+export declare function usageToWorktime(usage: PromptResultUsage): UncertainNumber;

package/esm/typings/src/execution/utils/usageToWorktime.test.d.ts

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

package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts

@@ -0,0 +1,6 @@
+import type { string_name } from '../../types/typeAliases';
+export declare function isDomainNameFree(name: string_name): Promise<boolean>;
+/**
+ * TODO: [🍓][🧠] Test and implement `isDomainNameFree`
+ * TODO: Export via some (and probably new) NPM package
+ */

package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts

@@ -0,0 +1,6 @@
+import type { string_name } from '../../types/typeAliases';
+export declare function isGithubNameFree(name: string_name): Promise<boolean>;
+/**
+ * TODO: [🍓][🧠] Test and implement `isGithubNameFree`
+ * TODO: Export via some (and probably new) NPM package
+ */

package/esm/typings/src/formats/_common/FormatDefinition.d.ts

@@ -0,0 +1,69 @@
+import type { string_mime_type } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+/**
+ * A format definition is a set of functions that define how to validate, heal and convert response from LLM
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/36
+ */
+export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSchema extends object> = {
+    /**
+     * The name of the format used in .ptbk.md files
+     *
+     * @sample "JSON"
+     */
+    readonly name: string_name;
+    /**
+     * Aliases for the name
+     */
+    readonly aliases?: Array<string_name>;
+    /**
+     * The mime type of the format (if any)
+     *
+     * @sample "application/json"
+     */
+    readonly mimeType?: string_mime_type;
+    /**
+     * Check if a value is fully valid
+     *
+     * @param value The value to check, for example "{\"foo\": true}"
+     * @param schema Optional schema to do extra validation
+     */
+    isValid(value: string, schema?: TSchema): value is TValue;
+    /**
+     * Check if a first part of a value is valid
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/37
+     *
+     * @param partialValue Partial value to check, for example "{\"foo\": t"
+     * @param schema Optional schema to do extra validation
+     */
+    canBeValid(partialValue: string, schema?: TSchema): partialValue is TPartialValue;
+    /**
+     * Heal a value to make it valid if possible
+     *
+     * Note: This make sense in context of LLMs that often returns slightly invalid values
+     * @see https://github.com/webgptorg/promptbook/discussions/31
+     *
+     * @param value The value to heal, for example "{foo: true}"
+     * @param scheme
+     * @throws {Error} If the value cannot be healed
+     */
+    heal(value: string, scheme?: TSchema): TValue;
+    /**
+     * Parses just the values and removes structural information
+     *
+     * Note: This is useful when you want to combine format expectations with counting words, characters,...
+     *
+     * @param value The value to check, for example "{\"name\": "John Smith"}"
+     * @param schema Optional schema
+     * @example "{\"name\": "John Smith"}" -> ["John Smith"]
+     */
+    extractValues(value: string, schema?: TSchema): Array<string>;
+};
+/**
+ * TODO: [🍓]`name` and `aliases` should be UPPERCASE only and interpreted as case-insensitive (via normalization)
+ * TODO: [🍓][👨‍⚖️] Compute TPartialValue dynamically - PartialString<TValue>
+ * TODO: [🍓][🧠] Should execution tools be aviable to heal, canBeValid and isValid?
+ * TODO: [🍓][🧠] llm Provider Bindings
+ * TODO: [🍓]Export via some package
+ */ 

package/esm/typings/src/formats/csv/ListFormatDefinition.d.ts

@@ -0,0 +1,11 @@
+import type { FormatDefinition } from '../_common/FormatDefinition';
+/**
+ * Definition for CSV spreadsheet
+ */
+export declare const CsvFormatDefinition: FormatDefinition<string, string, object>;
+/**
+ * TODO: [🍓] In `CsvFormatDefinition` implement simple `isValid`
+ * TODO: [🍓] In `CsvFormatDefinition` implement partial `canBeValid`
+ * TODO: [🍓] In `CsvFormatDefinition` implement `heal
+ * TODO: [🍓] In `CsvFormatDefinition` implement `extractValues`
+ */

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

@@ -0,0 +1,4 @@
+/**
+ * Definitions for all formats supported by Promptbook
+ */
+export declare const FORMAT_DEFINITIONS: import("./_common/FormatDefinition").FormatDefinition<string, string, object>[];

package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts

@@ -0,0 +1,15 @@
+import type { FormatDefinition } from '../_common/FormatDefinition';
+/**
+ * Definition for JSON format
+ */
+export declare const JsonFormatDefinition: FormatDefinition<string, string, object>;
+/**
+ * TODO: [🧠] Maybe propper instance of object
+ * TODO: [0] Make string_serialized_json
+ * TODO: [1] Make type for JSON Schema
+ * TODO: [🧠] What to use for validating JSONs - JSON Schema, ZoD, typescript types/interfaces,...?
+ * TODO: [🍓] In `JsonFormatDefinition` implement simple `isValid`
+ * TODO: [🍓] In `JsonFormatDefinition` implement partial `canBeValid`
+ * TODO: [🍓] In `JsonFormatDefinition` implement `heal
+ * TODO: [🍓] In `JsonFormatDefinition` implement `extractValues`
+ */

package/esm/typings/src/formats/json/utils/isValidJsonString.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Function isValidJsonString will tell you if the string is valid JSON or not
+ */
+export declare function isValidJsonString(value: string): boolean;

package/esm/typings/src/formats/json/utils/isValidJsonString.test.d.ts

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

package/esm/typings/src/formats/list/ListFormatDefinition.d.ts

@@ -0,0 +1,13 @@
+import type { FormatDefinition } from '../_common/FormatDefinition';
+/**
+ * Definition for list of multiple items
+ *
+ * Note: list is just a string with multiple lines or multiple items separated by comma
+ */
+export declare const ListFormatDefinition: FormatDefinition<string, string, object>;
+/**
+ * TODO: [🍓] In `ListFormatDefinition` implement simple `isValid`
+ * TODO: [🍓] In `ListFormatDefinition` implement partial `canBeValid`
+ * TODO: [🍓] In `ListFormatDefinition` implement `heal
+ * TODO: [🍓] In `ListFormatDefinition` implement `extractValues`
+ */

package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts

@@ -0,0 +1,15 @@
+import type { FormatDefinition } from '../_common/FormatDefinition';
+/**
+ * Definition for XML format
+ */
+export declare const XmlFormatDefinition: FormatDefinition<string, string, object>;
+/**
+ * TODO: [🧠] Maybe propper instance of object
+ * TODO: [0] Make string_serialized_xml
+ * TODO: [1] Make type for XML Schema
+ * TODO: [🧠] What to use for validating XMLs - XSD,...
+ * TODO: [🍓] In `XmlFormatDefinition` implement simple `isValid`
+ * TODO: [🍓] In `XmlFormatDefinition` implement partial `canBeValid`
+ * TODO: [🍓] In `XmlFormatDefinition` implement `heal
+ * TODO: [🍓] In `XmlFormatDefinition` implement `extractValues`
+ */

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

@@ -0,0 +1,15 @@
+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.
+ */
+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/knowledge/dialogs/callback/CallbackInterfaceToolsOptions.d.ts

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