@promptbook/markitdown 0.84.0-10

package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts

@@ -0,0 +1,46 @@
+import type { CsvSettings } from '../../formats/csv/CsvSettings';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import type { ExecutionTools } from '../ExecutionTools';
+/**
+ * Options for `createPipelineExecutor`
+ */
+export type CreatePipelineExecutorOptions = PrepareAndScrapeOptions & {
+    /**
+     * The pipeline to be executed
+     */
+    readonly pipeline: PipelineJson;
+    /**
+     * The execution tools to be used during the execution of the pipeline
+     */
+    readonly tools: ExecutionTools;
+    /**
+     * When executor does not satisfy expectations it will be retried this amount of times
+     *
+     * @default MAX_EXECUTION_ATTEMPTS
+     */
+    readonly maxExecutionAttempts?: number;
+    /**
+     * Settings for CSV format
+     *
+     * @default DEFAULT_CSV_SETTINGS
+     */
+    readonly csvSettings?: CsvSettings;
+    /**
+     * If you pass fully prepared pipeline, this does not matter
+     *
+     * Otherwise:
+     * If false or not set, warning is shown when pipeline is not prepared
+     * If true, warning is suppressed
+     *
+     * @default false
+     */
+    readonly isNotPreparedWarningSupressed?: boolean;
+};
+/**
+ * TODO: [🧎][🧠] Move `csvSettings` to some better place
+ *       1) either to some dependency in `ExecutionTools`
+ *       2) or make here container for multiple formats
+ *       3) or make the setting more universal and which just sets things like `delimiter` and `quote` without specifying the format
+ * TODO: [🤹‍♂️] More granular setting for limits of execution + better waiting for queue
+ */

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

@@ -0,0 +1,13 @@
+import type { PipelineExecutor } from '../PipelineExecutor';
+import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
+/**
+ * Creates executor function from pipeline and execution tools.
+ *
+ * @returns The executor function
+ * @throws {PipelineLogicError} on logical error in the pipeline
+ * @public exported from `@promptbook/core`
+ */
+export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
+/**
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
+ */

package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts

@@ -0,0 +1,49 @@
+import type { Promisable, ReadonlyDeep } from 'type-fest';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskProgress } from '../../types/TaskProgress';
+import type { InputParameters } from '../../types/typeAliases';
+import type { PipelineExecutorResult } from '../PipelineExecutorResult';
+import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
+/**
+ * @@@
+ *
+ * @private internal type of `executePipeline`
+ */
+type ExecutePipelineOptions = Required<CreatePipelineExecutorOptions> & {
+    /**
+     * @@@
+     */
+    readonly inputParameters: Readonly<InputParameters>;
+    /**
+     * @@@
+     */
+    onProgress?(taskProgress: TaskProgress): Promisable<void>;
+    /**
+     * @@@
+     */
+    readonly pipeline: PipelineJson;
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly setPreparedPipeline: (preparedPipeline: ReadonlyDeep<PipelineJson>) => void;
+    /**
+     * @@@
+     */
+    readonly pipelineIdentification: string;
+};
+/**
+ * @@@
+ *
+ * Note: This is not a `PipelineExecutor` (which is binded with one exact pipeline), but a utility function of `createPipelineExecutor` which creates `PipelineExecutor`
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function executePipeline(options: ExecutePipelineOptions): Promise<PipelineExecutorResult>;
+export {};
+/**
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
+ */

package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts

@@ -0,0 +1,51 @@
+import type { Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { TaskProgress } from '../../types/TaskProgress';
+import type { Parameters } from '../../types/typeAliases';
+import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
+import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
+/**
+ * @@@
+ *
+ * @private internal type of `executeTask`
+ */
+type executeSingleTaskOptions = Required<CreatePipelineExecutorOptions> & {
+    /**
+     * @@@
+     */
+    readonly currentTask: ReadonlyDeep<TaskJson>;
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly parametersToPass: Readonly<Parameters>;
+    /**
+     * @@@
+     */
+    readonly onProgress: (taskProgress: TaskProgress) => Promisable<void>;
+    /**
+     * @@@
+     */
+    readonly $executionReport: WritableDeep<ExecutionReportJson>;
+    /**
+     * @@@
+     */
+    readonly pipelineIdentification: string;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function executeTask(options: executeSingleTaskOptions): Promise<Readonly<Parameters>>;
+export {};
+/**
+ * TODO: [🤹‍♂️]
+ */
+/**
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
+ */

package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts

@@ -0,0 +1,15 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
+import type { ExecuteAttemptsOptions } from './40-executeAttempts';
+/**
+ * @@@
+ *
+ * @private internal type of `executeFormatSubvalues`
+ */
+type ExecuteFormatCellsOptions = ExecuteAttemptsOptions;
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function executeFormatSubvalues(options: ExecuteFormatCellsOptions): Promise<TODO_any>;
+export {};

package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -0,0 +1,64 @@
+import type { ReadonlyDeep, WritableDeep } from 'type-fest';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { Parameters } from '../../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { TODO_string } from '../../utils/organization/TODO_string';
+import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
+import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
+/**
+ * @@@
+ *
+ * @private internal type of `executeAttempts`
+ */
+export type ExecuteAttemptsOptions = Required<Omit<CreatePipelineExecutorOptions, 'pipeline'>> & {
+    /**
+     * @@@
+     */
+    readonly jokerParameterNames: Readonly<ReadonlyArray<string_parameter_name>>;
+    /**
+     * @@@
+     */
+    readonly priority: number;
+    /**
+     * @@@
+     *
+     * Note: [💂] There are two distinct variabiles
+     * 1) `maxExecutionAttempts` - the amount of attempts LLM model
+     * 2) `maxAttempts` - the amount of attempts for any task - LLM, SCRIPT, DIALOG, etc.
+     */
+    readonly maxAttempts: number;
+    /**
+     * @@@
+     */
+    readonly preparedContent: TODO_string;
+    /**
+     * @@@
+     */
+    readonly parameters: Readonly<Parameters>;
+    /**
+     * @@@
+     */
+    readonly task: ReadonlyDeep<TaskJson>;
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly $executionReport: WritableDeep<ExecutionReportJson>;
+    /**
+     * @@@
+     */
+    readonly pipelineIdentification: string;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function executeAttempts(options: ExecuteAttemptsOptions): Promise<TODO_string>;
+/**
+ * TODO: Break into smaller functions
+ */

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

@@ -0,0 +1,34 @@
+import type { ReadonlyDeep } from 'type-fest';
+import { PipelineExecutionError } from '../../errors/PipelineExecutionError';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { Parameters } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal type of `createPipelineExecutor`
+ */
+type FilterJustOutputParametersOptions = {
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly parametersToPass: Readonly<Parameters>;
+    /**
+     * @@@
+     */
+    readonly $warnings: PipelineExecutionError[];
+    /**
+     * @@@
+     */
+    readonly pipelineIdentification: string;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function filterJustOutputParameters(options: FilterJustOutputParametersOptions): Parameters;
+export {};

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

@@ -0,0 +1,10 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getContextForTask(task: ReadonlyDeep<TaskJson>): Promise<string_parameter_value & string_markdown>;

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

@@ -0,0 +1,10 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getExamplesForTask(task: ReadonlyDeep<TaskJson>): Promise<string_parameter_value & string_markdown>;

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

@@ -0,0 +1,27 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal type of `getKnowledgeFoTask`
+ */
+type GetKnowledgeForTaskOptions = {
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly task: ReadonlyDeep<TaskJson>;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getKnowledgeForTask(options: GetKnowledgeForTaskOptions): Promise<string_parameter_value & string_markdown>;
+export {};

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

@@ -0,0 +1,30 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { ReservedParameters } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal type of `getReservedParametersForTask`
+ */
+type GetReservedParametersForTaskOptions = {
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly task: ReadonlyDeep<TaskJson>;
+    /**
+     * @@@
+     */
+    readonly pipelineIdentification: string;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getReservedParametersForTask(options: GetReservedParametersForTaskOptions): Promise<Readonly<ReservedParameters>>;
+export {};

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

@@ -0,0 +1,7 @@
+import type { EmbeddingVector } from './EmbeddingVector';
+/**
+ * Pretty print an embedding vector for logging
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function embeddingVectorToString(embeddingVector: Readonly<EmbeddingVector>): string;

package/esm/typings/src/execution/execution-report/ExecutionPromptReportJson.d.ts

@@ -0,0 +1,24 @@
+import type { ErrorJson } from '../../errors/utils/ErrorJson';
+import type { Prompt } from '../../types/Prompt';
+import type { PromptResult } from '../PromptResult';
+/**
+ * Report of single prompt execution
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ExecutionPromptReportJson = {
+    /**
+     * The prompt wich was executed
+     */
+    readonly prompt: Omit<Prompt, 'pipelineUrl'>;
+    /**
+     * Result of the prompt execution (if not failed during LLM execution)
+     */
+    readonly result?: PromptResult;
+    /**
+     * The error which occured during LLM execution or during postprocessing or expectation checking
+     *
+     * Note: It makes sense to have both error and result defined, for example when the result not pass expectations
+     */
+    readonly error?: ErrorJson;
+};

package/esm/typings/src/execution/execution-report/ExecutionReportJson.d.ts

@@ -0,0 +1,41 @@
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_pipeline_url } from '../../types/typeAliases';
+import type { string_semantic_version } from '../../types/typeAliases';
+import type { ExecutionPromptReportJson } from './ExecutionPromptReportJson';
+/**
+ * ExecutionReport is result of executing one promptbook
+ * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
+ *
+ * It can have 2 formats:
+ * -   **.md file** created from the **JSON** format
+ * -   _(this)_ **JSON** format
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook#execution-report
+ */
+export type ExecutionReportJson = {
+    /**
+     * Unique identifier of the pipeline from promptbook which was executed
+     */
+    readonly pipelineUrl?: string_pipeline_url;
+    /**
+     * Title of from promptbook which was executed
+     */
+    readonly title?: string;
+    /**
+     * Version from promptbook which was executed
+     */
+    readonly promptbookUsedVersion: string_semantic_version;
+    /**
+     * Version from promptbook which was requested by promptbook
+     */
+    readonly promptbookRequestedVersion?: string_semantic_version;
+    /**
+     * Description of the promptbook which was executed
+     */
+    readonly description?: string_markdown_text;
+    /**
+     * Sequence of tasks in order which were executed
+     */
+    readonly promptExecutions: ReadonlyArray<ExecutionPromptReportJson>;
+};

package/esm/typings/src/execution/execution-report/ExecutionReportString.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ExecutionReport is result of executing one promptbook
+ * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
+ *
+ * It can have 2 formats:
+ * -   _(this)_ **.md file** created from the **JSON** format
+ * -   **JSON** format
+ *
+ * @see https://github.com/webgptorg/promptbook#execution-report
+ */
+export type ExecutionReportString = string & {
+    readonly _type: 'ExecutionReportString';
+};
+/**
+ * TODO: [💩] Better validation or remove branded type and make it just string
+ */

package/esm/typings/src/execution/execution-report/ExecutionReportStringOptions.d.ts

@@ -0,0 +1,25 @@
+import type { number_percent } from '../../types/typeAliases';
+/**
+ * Options for `executionReportJsonToString`
+ *
+ * @public exported from `@promptbook/core`
+ */
+export type ExecutionReportStringOptions = {
+    /**
+     * The tax rate to be applied, expressed as a percentage from 0 to 1 (=100%) or even more
+     */
+    readonly taxRate: number_percent;
+    /**
+     * The width of the charts in the report
+     */
+    readonly chartsWidth: number;
+};
+/**
+ * Default options for generating an execution report string
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ExecutionReportStringOptionsDefaults: {
+    taxRate: number;
+    chartsWidth: number;
+};

package/esm/typings/src/execution/execution-report/countWorkingDuration.d.ts

@@ -0,0 +1,7 @@
+import type { FromtoItems } from '../../utils/FromtoItems';
+/**
+ * Count the duration of working time
+ *
+ * @private within the repository
+ */
+export declare function countWorkingDuration(items: FromtoItems): number;

package/esm/typings/src/execution/execution-report/countWorkingDuration.test.d.ts

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

package/esm/typings/src/execution/execution-report/executionReportJsonToString.d.ts

@@ -0,0 +1,15 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { ExecutionReportJson } from './ExecutionReportJson';
+import type { ExecutionReportString } from './ExecutionReportString';
+import type { ExecutionReportStringOptions } from './ExecutionReportStringOptions';
+/**
+ * Converts execution report from JSON to string format
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function executionReportJsonToString(executionReportJson: ReadonlyDeep<ExecutionReportJson>, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
+/**
+ * TODO: Add mermaid chart for every report
+ * TODO: [🧠] Allow to filter out some parts of the report by options
+ * TODO: [🧠] Should be in generated file GENERATOR_WARNING
+ */

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

@@ -0,0 +1,7 @@
+import type { Promisable } from 'type-fest';
+/**
+ * @private still in development [🏳]
+ */
+export type AutomaticTranslator = {
+    translate(message: string): Promisable<string>;
+};

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

@@ -0,0 +1,11 @@
+import type { AutomaticTranslator } from './AutomaticTranslator';
+/**
+ * This will wrap an automatic translator and log each translation into the console
+ *
+ * @private still in development [🏳]
+ */
+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,8 @@
+import type { AutomaticTranslator } from './AutomaticTranslator';
+/**
+ * @private still in development [🏳]
+ */
+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,22 @@
+import type { AutomaticTranslator } from './AutomaticTranslator';
+import type { TranslatorOptions } from './TranslatorOptions';
+/**
+ * @@@
+ */
+type LindatAutomaticTranslatorOptions = TranslatorOptions & {
+    /**
+     * @@@
+     */
+    readonly apiUrl?: URL;
+};
+/**
+ * @@@
+ *
+ * @private still in development [🏳]
+ */
+export declare class LindatAutomaticTranslator implements AutomaticTranslator {
+    protected readonly options: LindatAutomaticTranslatorOptions;
+    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,7 @@
+/**
+ * @private still in development [🏳]
+ */
+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,8 @@
+/**
+ *
+ * @param message
+ * @returns
+ * @throws {PipelineExecutionError}
+ * @private still in development [🏳]
+ */
+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,12 @@
+import type { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
+import type { TranslatorOptions } from './automatic-translators/TranslatorOptions';
+/**
+ * @private still in development [🏳]
+ */
+export declare function translateMessages({ automaticTranslator, from, to, }: {
+    automaticTranslator: AutomaticTranslator;
+} & TranslatorOptions): Promise<void>;
+/**
+ * TODO: [😶] Unite floder listing
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts

@@ -0,0 +1,13 @@
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import type { ExecutionTools } from '../ExecutionTools';
+/**
+ * Note: There is unfortunately no equivalent for this function in the browser environment
+ *       because it is not possible automatically detect configured LLM providers
+ *       you need to provide them manually BUT you can help by utilities like `$provideScrapersForBrowser`
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $provideExecutionToolsForNode(options?: PrepareAndScrapeOptions): Promise<ExecutionTools>;
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

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

@@ -0,0 +1,9 @@
+import type { PromptResultUsage } from '../PromptResultUsage';
+/**
+ * Function `addUsage` will add multiple usages into one
+ *
+ * Note: If you provide 0 values, it returns ZERO_USAGE
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function addUsage(...usageItems: ReadonlyArray<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,29 @@
+import type { Expectations } from '../../pipeline/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
+ * @private internal function of `createPipelineExecutor`
+ */
+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
+ * @public exported from `@promptbook/core`
+ */
+export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
+/**
+ * TODO: [💝] Unite object for expecting amount and format
+ * TODO: [🧠][🤠] This should be part of `TextFormatDefinition`
+ * Note: [💝] and [🤠] are interconnected together
+ */

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

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