@promptbook/wizard 0.111.0-7 → 0.112.0-100

package/umd/src/execution/Executables.d.ts

@@ -1,4 +1,4 @@
-import type { string_executable_path } from '../types/typeAliases';
+import type { string_executable_path } from '../types/string_filename';
 /**
  * Paths to the external programs executables
  */

package/umd/src/execution/ExecutionTask.d.ts

@@ -1,7 +1,8 @@
 import type { Observable } from 'rxjs';
-import { PartialDeep } from 'type-fest';
+import type { PartialDeep } from 'type-fest';
 import type { LlmCall } from '../types/LlmCall';
-import type { number_percent, task_id } from '../types/typeAliases';
+import type { number_percent } from '../types/number_percent';
+import type { task_id } from '../types/string_token';
 import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { chococake } from '../utils/organization/really_any';
 import type { string_promptbook_version } from '../version';
@@ -50,6 +51,7 @@ export type ExecutionTask = AbstractTask<PipelineExecutorResult> & {
 };
 /**
  * Represents a task that prepares a pipeline
+ *
  * @deprecated TODO: [🐚] Currently unused - use
  */
 export type PreparationTask = AbstractTask<PipelineExecutorResult> & {
@@ -146,9 +148,8 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      */
     readonly ptbkNonce?: chococake;
 };
-export type Task = ExecutionTask | PreparationTask;
-export {};
 /**
- * TODO: Maybe allow to terminate the task and add getter `isFinished` or `status`
- * TODO: [🐚] Split into more files and make `PrepareTask` & `RemoteTask` + split the function
+ * Type describing task.
  */
+export type Task = ExecutionTask | PreparationTask;
+export {};

package/umd/src/execution/FilesystemTools.d.ts

@@ -4,6 +4,3 @@ 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' | 'mkdir' | 'watch'>;
-/**
- * TODO: Implement destroyable pattern to free resources
- */

package/umd/src/execution/LlmExecutionTools.d.ts

@@ -1,7 +1,8 @@
 import type { Promisable } from 'type-fest';
 import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
 import type { Prompt } from '../types/Prompt';
-import type { string_markdown, string_markdown_text, string_title } from '../types/typeAliases';
+import type { string_markdown, string_markdown_text } from '../types/string_markdown';
+import type { string_title } from '../types/string_title';
 import type { AvailableModel } from './AvailableModel';
 import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult, ImagePromptResult } from './PromptResult';
 /**
@@ -19,6 +20,20 @@ import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult, I
  *
  * @see https://github.com/webgptorg/promptbook#llm-execution-tools
  */
+/**
+ * Options that fine-tune streaming execution.
+ *
+ * @private internal helper for streaming helpers
+ */
+export type CallChatModelStreamOptions = {
+    /**
+     * Optional signal that can cancel the streaming request.
+     */
+    readonly signal?: AbortSignal;
+};
+/**
+ * Type describing Llm execution tools.
+ */
 export type LlmExecutionTools = {
     /**
      * Title of the model provider
@@ -59,7 +74,7 @@ export type LlmExecutionTools = {
      */
     callChatModelStream?(prompt: Prompt, onProgress: (chunk: ChatPromptResult & {
         isFinished?: boolean;
-    }) => void): Promise<ChatPromptResult>;
+    }) => void, options?: CallChatModelStreamOptions): Promise<ChatPromptResult>;
     /**
      * Calls a voice chat model
      */
@@ -82,12 +97,3 @@ export type LlmExecutionTools = {
      */
     callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
 };
-/**
- * TODO: [🕛] Extend this from sth class -  like `AgentBasicInformation` / `ModelBasicInformation``
- * 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/umd/src/execution/LlmExecutionToolsConstructor.d.ts

@@ -6,6 +6,3 @@ import type { LlmExecutionTools } from './LlmExecutionTools';
  * Combines registration metadata with a factory function for creating LLM tool instances.
  */
 export type LlmExecutionToolsConstructor = Registered & ((options: TODO_any) => LlmExecutionTools);
-/**
- * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
- */

package/umd/src/execution/PipelineExecutor.d.ts

@@ -1,4 +1,4 @@
-import type { InputParameters } from '../types/typeAliases';
+import type { InputParameters } from '../types/Parameters';
 import type { ExecutionTask } from './ExecutionTask';
 /**
  * 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)_.
@@ -11,6 +11,3 @@ import type { ExecutionTask } from './ExecutionTask';
 export type PipelineExecutor = {
     (inputParameters: InputParameters): ExecutionTask;
 };
-/**
- * TODO: [🧠] Should this file be in /execution or /types folder?
- */

package/umd/src/execution/PipelineExecutorResult.d.ts

@@ -1,6 +1,6 @@
-import { ReadonlyDeep } from 'type-fest';
+import type { ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
-import type { Parameters } from '../types/typeAliases';
+import type { Parameters } from '../types/Parameters';
 import type { AbstractTaskResult } from './AbstractTaskResult';
 import type { ExecutionReportJson } from './execution-report/ExecutionReportJson';
 import type { Usage } from './Usage';
@@ -34,6 +34,3 @@ export type PipelineExecutorResult = AbstractTaskResult & {
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
 };
-/**
- * TODO: [🧠] Should this file be in /execution or /types folder?
- */

package/umd/src/execution/PromptResult.d.ts

@@ -1,5 +1,7 @@
+import type { string_model_name } from '../types/string_model_name';
+import type { string_prompt } from '../types/string_prompt';
+import type { string_date_iso8601 } from '../types/string_token';
 import type { ToolCall } from '../types/ToolCall';
-import type { string_date_iso8601, string_model_name, string_prompt } from '../types/typeAliases';
 import type { TODO_object } from '../utils/organization/TODO_object';
 import type { EmbeddingVector } from './EmbeddingVector';
 import type { Usage } from './Usage';
@@ -18,7 +20,7 @@ export type PromptResult = CompletionPromptResult | ChatPromptResult | ImageProm
  */
 export type CompletionPromptResult = CommonPromptResult;
 /**
- *Chat prompt result
+ * Chat prompt result
  *
  * Note: [🚉] This is fully serializable as JSON
  */
@@ -101,11 +103,3 @@ export type CommonPromptResult = {
      */
     readonly rawResponse: TODO_object;
 };
-/**
- * TODO: [🧠] Maybe timing more accurate then seconds?
- * TODO: [🧠] Should here be link to the prompt?
- * TODO: [🧠] Maybe type `rawResponse` 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
- * TODO: [🏳] Add `TranslationPromptResult`
- */

package/umd/src/execution/PromptbookFetch.d.ts

@@ -1,4 +1,4 @@
-import type { string_url } from '../types/typeAliases';
+import type { string_url } from '../types/string_url';
 /**
  * Fetch function used in Promptbook engine
  *

package/umd/src/execution/PromptbookFetch.test-type.d.ts

@@ -1,5 +1 @@
 export {};
-/**
- * Note: [⚪] This should never be in any released package
- * TODO: Is this a good pattern to do type testing?
- */

package/umd/src/execution/ScriptExecutionTools.d.ts

@@ -1,6 +1,6 @@
+import type { Parameters } from '../types/Parameters';
 import type { ScriptLanguage } from '../types/ScriptLanguage';
-import type { Parameters } from '../types/typeAliases';
-import type { string_script } from '../types/typeAliases';
+import type { string_script } from '../types/string_markdown';
 /**
  * Represents all the tools needed to execute `SCRIPT` tasks
  *
@@ -33,7 +33,3 @@ export type ScriptExecutionToolsExecuteOptions = {
      */
     readonly script: string_script;
 };
-/**
- * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
- * TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
- */

package/umd/src/execution/UncertainNumber.d.ts

@@ -1,5 +1,5 @@
-import type { number_positive } from '../types/typeAliases';
-import type { number_usd } from '../types/typeAliases';
+import type { number_positive } from '../types/number_positive';
+import type { number_usd } from '../types/number_usd';
 /**
  * Number which can be uncertain
  *

package/umd/src/execution/Usage.d.ts

@@ -13,6 +13,10 @@ export type Usage = {
      * Note: If the cost is unknown, the value 0 and isUncertain is true
      */
     readonly price: UncertainNumber;
+    /**
+     * Time how long the agent was running in seconds
+     */
+    readonly duration: UncertainNumber;
     /**
      * Number of whatever used in the input aka. `prompt_tokens`
      */
@@ -28,6 +32,3 @@ export type Usage = {
  * Note: [🚉] This is fully serializable as JSON
  */
 export type UsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
-/**
- * TODO: [🍙] Make some standard order of json properties
- */

package/umd/src/execution/UserInterfaceTools.d.ts

@@ -1,5 +1,4 @@
-import type { number_integer } from '../types/typeAliases';
-import type { number_positive } from '../types/typeAliases';
+import type { number_integer, number_positive } from '../types/number_positive';
 /**
  * Represents all the tools needed to interact with the user.
  *
@@ -14,6 +13,9 @@ export type UserInterfaceTools = {
      */
     promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
 };
+/**
+ * Options for user interface tools prompt dialog.
+ */
 export type UserInterfaceToolsPromptDialogOptions = {
     /**
      * Prompt title

package/umd/src/execution/assertsTaskSuccessful.d.ts

@@ -6,9 +6,7 @@ import type { PipelineExecutorResult } from './PipelineExecutorResult';
  *
  * @param executionResult - The partial result of the Promptbook execution
  * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
+ *
  * @private internal helper function of `asPromise` method of `ExecutionTask`
  */
 export declare function assertsTaskSuccessful(executionResult: Pick<PipelineExecutorResult, 'isSuccessful' | 'errors' | 'warnings'>): void;
-/**
- * TODO: [🧠] Can this return type be better typed than void
- */

package/umd/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts

@@ -5,6 +5,7 @@ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorO
  *
  * @returns The executor function
  * @throws {PipelineLogicError} on logical error in the pipeline
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;

package/umd/src/execution/createPipelineExecutor/10-executePipeline.d.ts

@@ -1,7 +1,7 @@
 import type { PartialDeep, Promisable, ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { LlmCall } from '../../types/LlmCall';
-import type { InputParameters } from '../../types/typeAliases';
+import type { InputParameters } from '../../types/Parameters';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**

package/umd/src/execution/createPipelineExecutor/20-executeTask.d.ts

@@ -1,8 +1,8 @@
 import type { PartialDeep, Promisable, 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 { LlmCall } from '../../types/LlmCall';
+import type { Parameters } from '../../types/Parameters';
 import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
@@ -51,6 +51,3 @@ type executeSingleTaskOptions = Required<CreatePipelineExecutorOptions> & {
  */
 export declare function executeTask(options: executeSingleTaskOptions): Promise<Readonly<Parameters>>;
 export {};
-/**
- * TODO: [🤹‍♂️]
- */

package/umd/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts

@@ -1,6 +1,6 @@
 import type { PartialDeep, Promisable } from 'type-fest';
-import type { TODO_any } from '../../utils/organization/TODO_any';
 import type { LlmCall } from '../../types/LlmCall';
+import type { TODO_any } from '../../utils/organization/TODO_any';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { ExecuteAttemptsOptions } from './40-executeAttempts';
 /**

package/umd/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -2,7 +2,8 @@ import type { PartialDeep, Promisable, ReadonlyDeep, WritableDeep } from 'type-f
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { LlmCall } from '../../types/LlmCall';
-import type { Parameters, string_parameter_name } from '../../types/typeAliases';
+import type { Parameters } from '../../types/Parameters';
+import type { string_parameter_name } from '../../types/string_name';
 import type { TODO_string } from '../../utils/organization/TODO_string';
 import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
@@ -71,9 +72,7 @@ export type ExecuteAttemptsOptions = Required<Omit<CreatePipelineExecutorOptions
  *
  * @param options - The options for execution, including task, parameters, pipeline, and configuration.
  * @returns The result string of the executed task.
+ *
  * @private internal utility of `createPipelineExecutor`
  */
 export declare function executeAttempts(options: ExecuteAttemptsOptions): Promise<TODO_string>;
-/**
- * TODO: Break into smaller functions
- */

package/umd/src/execution/createPipelineExecutor/executeSingleAttempt.d.ts

@@ -0,0 +1,31 @@
+import type { string_parameter_name } from '../../types/string_name';
+import type { LlmExecutionTools } from '../LlmExecutionTools';
+import type { $OngoingTaskResult } from './$OngoingTaskResult';
+import type { ExecuteAttemptsOptions } from './40-executeAttempts';
+/**
+ * Executes one loop iteration, from joker resolution or task execution through validation.
+ *
+ * @private function of `executeAttempts`
+ */
+export declare function executeSingleAttempt(options: {
+    /**
+     * Metadata describing the current loop iteration.
+     */
+    readonly attempt: {
+        readonly attemptIndex: number;
+        readonly isJokerAttempt: boolean;
+        readonly jokerParameterName?: string_parameter_name;
+    };
+    /**
+     * Immutable executor options shared across all attempts.
+     */
+    readonly options: ExecuteAttemptsOptions;
+    /**
+     * Narrowed LLM execution tools for prompt tasks.
+     */
+    readonly llmTools: LlmExecutionTools;
+    /**
+     * Mutable per-task state accumulated across attempts.
+     */
+    readonly $ongoingTaskResult: $OngoingTaskResult;
+}): Promise<void>;

package/umd/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts

@@ -1,7 +1,7 @@
 import type { ReadonlyDeep } from 'type-fest';
 import { PipelineExecutionError } from '../../errors/PipelineExecutionError';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
-import type { Parameters } from '../../types/typeAliases';
+import type { Parameters } from '../../types/Parameters';
 /**
  * Options for filtering and extracting only output parameters from a pipeline execution.
  *

package/umd/src/execution/createPipelineExecutor/getContextForTask.d.ts

@@ -1,7 +1,7 @@
 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';
+import type { string_markdown } from '../../types/string_markdown';
+import type { string_parameter_value } from '../../types/string_name';
 /**
  * Returns the context for a given task, typically used to provide additional information or variables
  * required for the execution of the task within a pipeline. The context is returned as a string value
@@ -9,6 +9,7 @@ import type { string_parameter_value } from '../../types/typeAliases';
  *
  * @param task - The task for which the context is being generated. This should be a deeply immutable TaskJson object.
  * @returns The context as a string, formatted as markdown and parameter value.
+ *
  * @private internal utility of `createPipelineExecutor`
  */
 export declare function getContextForTask(task: ReadonlyDeep<TaskJson>): Promise<string_parameter_value & string_markdown>;

package/umd/src/execution/createPipelineExecutor/getExamplesForTask.d.ts

@@ -1,7 +1,7 @@
 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';
+import type { string_markdown } from '../../types/string_markdown';
+import type { string_parameter_value } from '../../types/string_name';
 /**
  * Retrieves example values or templates for a given task, used to guide or validate pipeline execution.
  *

package/umd/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts

@@ -1,7 +1,9 @@
 import type { ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
-import type { Parameters, string_markdown, string_parameter_value } from '../../types/typeAliases';
+import type { Parameters } from '../../types/Parameters';
+import type { string_markdown } from '../../types/string_markdown';
+import type { string_parameter_value } from '../../types/string_name';
 import type { ExecutionTools } from '../ExecutionTools';
 /**
  * Options for retrieving relevant knowledge for a specific task during pipeline execution.
@@ -34,7 +36,3 @@ type GetKnowledgeForTaskOptions = {
  */
 export declare function getKnowledgeForTask(options: GetKnowledgeForTaskOptions): Promise<string_parameter_value & string_markdown>;
 export {};
-/**
- * TODO: [♨] Implement Better - use keyword search
- * TODO: [♨] Examples of values
- */

package/umd/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts

@@ -1,8 +1,7 @@
 import type { ReadonlyDeep } 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 { ReservedParameters } from '../../types/typeAliases';
+import type { Parameters, ReservedParameters } from '../../types/Parameters';
 import type { ExecutionTools } from '../ExecutionTools';
 /**
  * Options for retrieving reserved parameters for a pipeline task, including context, pipeline, and identification.

package/umd/src/execution/createPipelineExecutor/handleAttemptFailure.d.ts

@@ -0,0 +1,40 @@
+import type { PartialDeep, Promisable } from 'type-fest';
+import { ExpectError } from '../../errors/ExpectError';
+import type { PipelineExecutorResult } from '../PipelineExecutorResult';
+import type { $OngoingTaskResult } from './$OngoingTaskResult';
+/**
+ * Stores one failed attempt, reports the expectation error, and throws the aggregated retry error after the final
+ * regular attempt.
+ *
+ * @private function of `executeAttempts`
+ */
+export declare function handleAttemptFailure(options: {
+    /**
+     * Expectation error raised by the current attempt.
+     */
+    readonly error: ExpectError;
+    /**
+     * Zero-based attempt index for the current execution loop.
+     */
+    readonly attemptIndex: number;
+    /**
+     * Maximum number of attempts for the current task type.
+     */
+    readonly maxAttempts: number;
+    /**
+     * Maximum number of model execution attempts for prompt tasks.
+     */
+    readonly maxExecutionAttempts: number;
+    /**
+     * Callback invoked with partial progress updates.
+     */
+    onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
+    /**
+     * String identifier for the pipeline, used for error reporting.
+     */
+    readonly pipelineIdentification: string;
+    /**
+     * Mutable per-task execution state.
+     */
+    readonly $ongoingTaskResult: $OngoingTaskResult;
+}): void;

package/umd/src/execution/createPipelineExecutor/knowledgePiecesToString.d.ts

@@ -1,6 +1,5 @@
 import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
 /**
- *
  * @param knowledgePieces
  * @returns
  *

package/umd/src/execution/createPipelineExecutor/reportPromptExecution.d.ts

@@ -0,0 +1,34 @@
+import type { Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
+import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { LlmCall } from '../../types/LlmCall';
+import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
+import type { $OngoingTaskResult } from './$OngoingTaskResult';
+/**
+ * Appends the prompt execution report for prompt-task attempts.
+ *
+ * @private function of `executeAttempts`
+ */
+export declare function reportPromptExecution(options: {
+    /**
+     * Metadata describing the current loop iteration.
+     */
+    readonly attempt: {
+        readonly isJokerAttempt: boolean;
+    };
+    /**
+     * Task currently being executed.
+     */
+    readonly task: ReadonlyDeep<TaskJson>;
+    /**
+     * Mutable execution report object to append prompt execution data to.
+     */
+    readonly $executionReport: WritableDeep<ExecutionReportJson>;
+    /**
+     * Optional callback invoked with each LLM call.
+     */
+    logLlmCall?(llmCall: LlmCall): Promisable<void>;
+    /**
+     * Mutable per-task execution state.
+     */
+    readonly $ongoingTaskResult: $OngoingTaskResult;
+}): void;

package/umd/src/execution/execution-report/ExecutionReportJson.d.ts

@@ -1,6 +1,6 @@
-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 { string_markdown_text } from '../../types/string_markdown';
+import type { string_pipeline_url } from '../../types/string_pipeline_url';
+import type { string_semantic_version } from '../../types/string_sha256';
 import type { ExecutionPromptReportJson } from './ExecutionPromptReportJson';
 /**
  * ExecutionReport is result of executing one promptbook
@@ -11,6 +11,7 @@ import type { ExecutionPromptReportJson } from './ExecutionPromptReportJson';
  * -   _(this)_ **JSON** format
  *
  * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook#execution-report
  */
 export type ExecutionReportJson = {

package/umd/src/execution/execution-report/ExecutionReportString.d.ts

@@ -11,6 +11,3 @@
 export type ExecutionReportString = string & {
     readonly _type: 'ExecutionReportString';
 };
-/**
- * TODO: [💩] Better validation or remove branded type and make it just string
- */

package/umd/src/execution/execution-report/ExecutionReportStringOptions.d.ts

@@ -1,4 +1,4 @@
-import type { number_percent } from '../../types/typeAliases';
+import type { number_percent } from '../../types/number_percent';
 /**
  * Options for `executionReportJsonToString`
  *

package/umd/src/execution/execution-report/executionReportJsonToString.d.ts

@@ -8,8 +8,3 @@ import type { ExecutionReportStringOptions } from './ExecutionReportStringOption
  * @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/umd/src/execution/resolveTaskTldr.d.ts

@@ -0,0 +1,32 @@
+import type { number_percent } from '../types/number_percent';
+import type { chococake } from '../utils/organization/really_any';
+import type { task_status } from './ExecutionTask';
+/**
+ * Shared type for task TLDR information.
+ *
+ * @private internal type of `ExecutionTask`
+ */
+type TaskTldrInfo = {
+    readonly percent: number_percent;
+    readonly message: string;
+};
+/**
+ * Snapshot of the mutable task state needed to resolve the fallback TLDR.
+ *
+ * @private internal type of `ExecutionTask`
+ */
+type ResolveTaskTldrOptions = {
+    readonly customTldr: TaskTldrInfo | null;
+    readonly currentValue: chococake;
+    readonly status: task_status;
+    readonly createdAt: Date;
+    readonly errors: ReadonlyArray<Error>;
+    readonly warnings: ReadonlyArray<Error>;
+};
+/**
+ * Resolves the short task summary shown in the UI.
+ *
+ * @private internal helper function of `ExecutionTask`
+ */
+export declare function resolveTaskTldr(options: ResolveTaskTldrOptions): TaskTldrInfo;
+export {};

package/umd/src/execution/resolveTaskTldr.test.d.ts

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

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

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

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

@@ -1,6 +1,8 @@
 import type { AutomaticTranslator } from './AutomaticTranslator';
 /**
- * @private still in development [🏳]
+ * Still in development [🏳].
+ *
+ * @private
  */
 export declare class FakeAutomaticTranslator implements AutomaticTranslator {
     constructor();

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

@@ -1,5 +1,7 @@
 /**
- * @private still in development [🏳]
+ * Still in development [🏳].
+ *
+ * @private
  */
 export type TranslatorOptions = {
     readonly from?: string;

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

@@ -1,8 +1,10 @@
 /**
+ * Extracts multiplicated occurrence.
  *
  * @param message
  * @returns
  * @throws {PipelineExecutionError}
+ *
  * @private still in development [🏳]
  */
 export declare function extractMultiplicatedOccurrence(message: string): string;