@promptbook/node 0.100.0-33 → 0.100.0-34

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

@@ -1,5 +1,6 @@
 import type { Observable } from 'rxjs';
 import { PartialDeep } from 'type-fest';
+import type { number_percent } from '../types/typeAliases';
 import type { task_id } from '../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { string_promptbook_version } from '../version';
@@ -80,6 +81,19 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      * Status of the task
      */
     readonly status: task_status;
+    /**
+     * Short summary of the task status for quick overview in the UI
+     */
+    readonly tldr: {
+        /**
+         * Progress in percentage from 0 to 1 (100%) that can be used to display a progress bar
+         */
+        readonly percent: number_percent;
+        /**
+         * Short summary message of the task status that can be displayed in the UI
+         */
+        readonly message: string;
+    };
     /**
      * Date when the task was created
      */

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-32`).
+ * It follows semantic versioning (e.g., `0.100.0-33`).
  *
  * @generated
  */

package/package.json

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

package/umd/index.umd.js

@@ -46,7 +46,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.100.0-33';
+    const PROMPTBOOK_ENGINE_VERSION = '0.100.0-34';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2171,6 +2171,55 @@
                 return status;
                 // <- Note: [1] --||--
             },
+            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.
+                const cv = currentValue;
+                // Try several common places where a percent might be stored on the partial result
+                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
+                if (typeof percentRaw !== 'number') {
+                    if (status === 'FINISHED') {
+                        percentRaw = 1;
+                    }
+                    else if (status === 'ERROR') {
+                        percentRaw = 0;
+                    }
+                    else {
+                        percentRaw = 0;
+                    }
+                }
+                // Clamp to [0,1]
+                let percent = Number(percentRaw) || 0;
+                if (percent < 0)
+                    percent = 0;
+                if (percent > 1)
+                    percent = 1;
+                // Build a short message: prefer explicit tldr.message, then common summary/message fields, then errors/warnings, then status
+                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';
+                    }
+                    else {
+                        message = 'Running';
+                    }
+                }
+                return {
+                    percent: percent,
+                    message,
+                };
+            },
             get createdAt() {
                 return createdAt;
                 // <- Note: [1] --||--