@promptbook/legacy-documents 0.100.0-35 → 0.100.0-37

package/esm/typings/src/_packages/core.index.d.ts

@@ -46,6 +46,7 @@ import { DEFAULT_CSV_SETTINGS } from '../config';
 import { DEFAULT_IS_VERBOSE } from '../config';
 import { SET_IS_VERBOSE } from '../config';
 import { DEFAULT_IS_AUTO_INSTALLED } from '../config';
+import { DEFAULT_TASK_SIMULATED_DURATION_MS } from '../config';
 import { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME } from '../config';
 import { DEFAULT_MAX_REQUESTS_PER_MINUTE } from '../config';
 import { MODEL_TRUST_LEVELS } from '../constants';
@@ -207,6 +208,7 @@ export { DEFAULT_CSV_SETTINGS };
 export { DEFAULT_IS_VERBOSE };
 export { SET_IS_VERBOSE };
 export { DEFAULT_IS_AUTO_INSTALLED };
+export { DEFAULT_TASK_SIMULATED_DURATION_MS };
 export { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME };
 export { DEFAULT_MAX_REQUESTS_PER_MINUTE };
 export { MODEL_TRUST_LEVELS };

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

@@ -281,6 +281,12 @@ export declare function SET_IS_VERBOSE(isVerbose: boolean): void;
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_IS_AUTO_INSTALLED = false;
+/**
+ * Default simulated duration for a task in milliseconds (used for progress reporting)
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_TASK_SIMULATED_DURATION_MS: number;
 /**
  * Function name for generated function via `ptbk make` to get the pipeline collection
  *

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

@@ -29,6 +29,19 @@ type CreateTaskOptions<TTaskResult extends AbstractTaskResult> = {
          */
         readonly title?: AbstractTask<TTaskResult>['title'];
     }) => void): Promise<TTaskResult>;
+    /**
+     * Optional callback to provide custom tldr information
+     * @param createdAt When the task was created
+     * @param status Current task status
+     * @param currentValue Current partial result
+     * @param errors Current errors
+     * @param warnings Current warnings
+     * @returns Custom tldr information
+     */
+    tldrProvider?(createdAt: Date, status: task_status, currentValue: PartialDeep<TTaskResult>, errors: Array<Error>, warnings: Array<Error>): {
+        readonly percent: number_percent;
+        readonly message: string;
+    };
 };
 /**
  * Helper to create a new task

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

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.100.0-34`).
+ * It follows semantic versioning (e.g., `0.100.0-36`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/legacy-documents",
-    "version": "0.100.0-35",
+    "version": "0.100.0-37",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -95,7 +95,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/legacy-documents.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.100.0-35"
+        "@promptbook/core": "0.100.0-37"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -26,7 +26,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.100.0-35';
+    const PROMPTBOOK_ENGINE_VERSION = '0.100.0-37';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -218,6 +218,12 @@
      * @public exported from `@promptbook/core`
      */
     const DEFAULT_IS_AUTO_INSTALLED = false;
+    /**
+     * Default simulated duration for a task in milliseconds (used for progress reporting)
+     *
+     * @public exported from `@promptbook/core`
+     */
+    const DEFAULT_TASK_SIMULATED_DURATION_MS = 5 * 60 * 1000; // 5 minutes
     /**
      * Indicates whether pipeline logic validation is enabled. When true, the pipeline logic is checked for consistency.
      *
@@ -2685,7 +2691,7 @@
      * @private internal helper function
      */
     function createTask(options) {
-        const { taskType, taskProcessCallback } = options;
+        const { taskType, taskProcessCallback, tldrProvider } = options;
         let { title } = options;
         // TODO: [🐙] DRY
         const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid similar char conflicts   */)}`;
@@ -2760,21 +2766,35 @@
             },
             get tldr() {
                 var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-                // Derive a short progress summary from currentValue, status and any errors/warnings.
+                // Use custom tldr provider if available
+                if (tldrProvider) {
+                    return tldrProvider(createdAt, status, currentValue, errors, warnings);
+                }
+                // Fallback to default implementation
                 const cv = currentValue;
-                // Try several common places where a percent might be stored on the partial result
+                // If explicit percent is provided, use it
                 let percentRaw = (_f = (_d = (_b = (_a = cv === null || cv === void 0 ? void 0 : cv.tldr) === null || _a === void 0 ? void 0 : _a.percent) !== null && _b !== void 0 ? _b : (_c = cv === null || cv === void 0 ? void 0 : cv.usage) === null || _c === void 0 ? void 0 : _c.percent) !== null && _d !== void 0 ? _d : (_e = cv === null || cv === void 0 ? void 0 : cv.progress) === null || _e === void 0 ? void 0 : _e.percent) !== null && _f !== void 0 ? _f : cv === null || cv === void 0 ? void 0 : cv.percent;
-                // If we didn't find a numeric percent, infer from status
+                // Simulate progress if not provided
                 if (typeof percentRaw !== 'number') {
-                    if (status === 'FINISHED') {
+                    // Simulate progress: evenly split across subtasks, based on elapsed time
+                    const now = new Date();
+                    const elapsedMs = now.getTime() - createdAt.getTime();
+                    const totalMs = DEFAULT_TASK_SIMULATED_DURATION_MS;
+                    // If subtasks are defined, split progress evenly
+                    const subtaskCount = Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks) ? cv.subtasks.length : 1;
+                    const completedSubtasks = Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks)
+                        ? cv.subtasks.filter((s) => s.done || s.completed).length
+                        : 0;
+                    // Progress from completed subtasks
+                    const subtaskProgress = subtaskCount > 0 ? completedSubtasks / subtaskCount : 0;
+                    // Progress from elapsed time for current subtask
+                    const timeProgress = Math.min(elapsedMs / totalMs, 1);
+                    // Combine: completed subtasks + time progress for current subtask
+                    percentRaw = Math.min(subtaskProgress + (1 / subtaskCount) * timeProgress, 1);
+                    if (status === 'FINISHED')
                         percentRaw = 1;
-                    }
-                    else if (status === 'ERROR') {
+                    if (status === 'ERROR')
                         percentRaw = 0;
-                    }
-                    else {
-                        percentRaw = 0;
-                    }
                 }
                 // Clamp to [0,1]
                 let percent = Number(percentRaw) || 0;
@@ -2786,20 +2806,29 @@
                 const messageFromResult = (_k = (_j = (_h = (_g = cv === null || cv === void 0 ? void 0 : cv.tldr) === null || _g === void 0 ? void 0 : _g.message) !== null && _h !== void 0 ? _h : cv === null || cv === void 0 ? void 0 : cv.message) !== null && _j !== void 0 ? _j : cv === null || cv === void 0 ? void 0 : cv.summary) !== null && _k !== void 0 ? _k : cv === null || cv === void 0 ? void 0 : cv.statusMessage;
                 let message = messageFromResult;
                 if (!message) {
-                    if (errors.length) {
-                        message = errors[errors.length - 1].message || 'Error';
-                    }
-                    else if (warnings.length) {
-                        message = warnings[warnings.length - 1].message || 'Warning';
-                    }
-                    else if (status === 'FINISHED') {
-                        message = 'Finished';
-                    }
-                    else if (status === 'ERROR') {
-                        message = 'Error';
+                    // If subtasks, show current subtask
+                    if (Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks) && cv.subtasks.length > 0) {
+                        const current = cv.subtasks.find((s) => !s.done && !s.completed);
+                        if (current && current.title) {
+                            message = `Working on ${current.title}`;
+                        }
                     }
-                    else {
-                        message = 'Running';
+                    if (!message) {
+                        if (errors.length) {
+                            message = errors[errors.length - 1].message || 'Error';
+                        }
+                        else if (warnings.length) {
+                            message = warnings[warnings.length - 1].message || 'Warning';
+                        }
+                        else if (status === 'FINISHED') {
+                            message = 'Finished';
+                        }
+                        else if (status === 'ERROR') {
+                            message = 'Error';
+                        }
+                        else {
+                            message = 'Running';
+                        }
                     }
                 }
                 return {
@@ -6283,6 +6312,71 @@
                     updateOngoingResult(newOngoingResult);
                 });
             },
+            tldrProvider(createdAt, status, currentValue, errors) {
+                var _a;
+                // Better progress estimation based on pipeline structure
+                const cv = currentValue;
+                // Handle finished/error states
+                if (status === 'FINISHED') {
+                    return {
+                        percent: 1,
+                        message: 'Finished',
+                    };
+                }
+                if (status === 'ERROR') {
+                    const errorMessage = errors.length > 0 ? errors[errors.length - 1].message : 'Error';
+                    return {
+                        percent: 0,
+                        message: errorMessage,
+                    };
+                }
+                // Calculate progress based on pipeline tasks
+                const totalTasks = pipeline.tasks.length;
+                let completedTasks = 0;
+                let currentTaskName = '';
+                // Check execution report for completed tasks
+                if ((_a = cv === null || cv === void 0 ? void 0 : cv.executionReport) === null || _a === void 0 ? void 0 : _a.promptExecutions) {
+                    const executedTaskTitles = new Set(cv.executionReport.promptExecutions.map((execution) => execution.prompt.title));
+                    // Count completed tasks by matching titles
+                    const completedTasksByTitle = pipeline.tasks.filter(task => executedTaskTitles.has(task.title));
+                    completedTasks = completedTasksByTitle.length;
+                    // Find current task being executed (first task not yet completed)
+                    const remainingTasks = pipeline.tasks.filter(task => !executedTaskTitles.has(task.title));
+                    if (remainingTasks.length > 0) {
+                        currentTaskName = remainingTasks[0].name;
+                    }
+                }
+                // Calculate progress percentage
+                let percent = totalTasks > 0 ? completedTasks / totalTasks : 0;
+                // Add time-based progress for current task (assuming 5 minutes total)
+                if (completedTasks < totalTasks) {
+                    const elapsedMs = new Date().getTime() - createdAt.getTime();
+                    const totalMs = 5 * 60 * 1000; // 5 minutes
+                    const timeProgress = Math.min(elapsedMs / totalMs, 1);
+                    // Add partial progress for current task
+                    percent += (1 / totalTasks) * timeProgress;
+                }
+                // Clamp to [0,1]
+                percent = Math.min(Math.max(percent, 0), 1);
+                // Generate message
+                let message = '';
+                if (currentTaskName) {
+                    // Find the task to get its title
+                    const currentTask = pipeline.tasks.find(task => task.name === currentTaskName);
+                    const taskTitle = (currentTask === null || currentTask === void 0 ? void 0 : currentTask.title) || currentTaskName;
+                    message = `Working on task ${taskTitle}`;
+                }
+                else if (completedTasks === 0) {
+                    message = 'Starting pipeline execution';
+                }
+                else {
+                    message = `Processing pipeline (${completedTasks}/${totalTasks} tasks completed)`;
+                }
+                return {
+                    percent,
+                    message,
+                };
+            },
         });
         //        <- TODO: Make types such as there is no need to do `as` for `createTask`
         return pipelineExecutor;