@promptbook/node 0.100.0-35 → 0.100.0-37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -46,6 +46,7 @@ import { DEFAULT_CSV_SETTINGS } from '../config';
46
46
  import { DEFAULT_IS_VERBOSE } from '../config';
47
47
  import { SET_IS_VERBOSE } from '../config';
48
48
  import { DEFAULT_IS_AUTO_INSTALLED } from '../config';
49
+ import { DEFAULT_TASK_SIMULATED_DURATION_MS } from '../config';
49
50
  import { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME } from '../config';
50
51
  import { DEFAULT_MAX_REQUESTS_PER_MINUTE } from '../config';
51
52
  import { MODEL_TRUST_LEVELS } from '../constants';
@@ -207,6 +208,7 @@ export { DEFAULT_CSV_SETTINGS };
207
208
  export { DEFAULT_IS_VERBOSE };
208
209
  export { SET_IS_VERBOSE };
209
210
  export { DEFAULT_IS_AUTO_INSTALLED };
211
+ export { DEFAULT_TASK_SIMULATED_DURATION_MS };
210
212
  export { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME };
211
213
  export { DEFAULT_MAX_REQUESTS_PER_MINUTE };
212
214
  export { MODEL_TRUST_LEVELS };
@@ -281,6 +281,12 @@ export declare function SET_IS_VERBOSE(isVerbose: boolean): void;
281
281
  * @public exported from `@promptbook/core`
282
282
  */
283
283
  export declare const DEFAULT_IS_AUTO_INSTALLED = false;
284
+ /**
285
+ * Default simulated duration for a task in milliseconds (used for progress reporting)
286
+ *
287
+ * @public exported from `@promptbook/core`
288
+ */
289
+ export declare const DEFAULT_TASK_SIMULATED_DURATION_MS: number;
284
290
  /**
285
291
  * Function name for generated function via `ptbk make` to get the pipeline collection
286
292
  *
@@ -29,6 +29,19 @@ type CreateTaskOptions<TTaskResult extends AbstractTaskResult> = {
29
29
  */
30
30
  readonly title?: AbstractTask<TTaskResult>['title'];
31
31
  }) => void): Promise<TTaskResult>;
32
+ /**
33
+ * Optional callback to provide custom tldr information
34
+ * @param createdAt When the task was created
35
+ * @param status Current task status
36
+ * @param currentValue Current partial result
37
+ * @param errors Current errors
38
+ * @param warnings Current warnings
39
+ * @returns Custom tldr information
40
+ */
41
+ tldrProvider?(createdAt: Date, status: task_status, currentValue: PartialDeep<TTaskResult>, errors: Array<Error>, warnings: Array<Error>): {
42
+ readonly percent: number_percent;
43
+ readonly message: string;
44
+ };
32
45
  };
33
46
  /**
34
47
  * Helper to create a new task
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.100.0-34`).
18
+ * It follows semantic versioning (e.g., `0.100.0-36`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/node",
3
- "version": "0.100.0-35",
3
+ "version": "0.100.0-37",
4
4
  "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -93,7 +93,7 @@
93
93
  "module": "./esm/index.es.js",
94
94
  "typings": "./esm/typings/src/_packages/node.index.d.ts",
95
95
  "peerDependencies": {
96
- "@promptbook/core": "0.100.0-35"
96
+ "@promptbook/core": "0.100.0-37"
97
97
  },
98
98
  "dependencies": {
99
99
  "colors": "1.4.0",
package/umd/index.umd.js CHANGED
@@ -46,7 +46,7 @@
46
46
  * @generated
47
47
  * @see https://github.com/webgptorg/promptbook
48
48
  */
49
- const PROMPTBOOK_ENGINE_VERSION = '0.100.0-35';
49
+ const PROMPTBOOK_ENGINE_VERSION = '0.100.0-37';
50
50
  /**
51
51
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
52
52
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -248,6 +248,12 @@
248
248
  * @public exported from `@promptbook/core`
249
249
  */
250
250
  const DEFAULT_IS_AUTO_INSTALLED = false;
251
+ /**
252
+ * Default simulated duration for a task in milliseconds (used for progress reporting)
253
+ *
254
+ * @public exported from `@promptbook/core`
255
+ */
256
+ const DEFAULT_TASK_SIMULATED_DURATION_MS = 5 * 60 * 1000; // 5 minutes
251
257
  /**
252
258
  * Indicates whether pipeline logic validation is enabled. When true, the pipeline logic is checked for consistency.
253
259
  *
@@ -2098,7 +2104,7 @@
2098
2104
  * @private internal helper function
2099
2105
  */
2100
2106
  function createTask(options) {
2101
- const { taskType, taskProcessCallback } = options;
2107
+ const { taskType, taskProcessCallback, tldrProvider } = options;
2102
2108
  let { title } = options;
2103
2109
  // TODO: [🐙] DRY
2104
2110
  const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid similar char conflicts */)}`;
@@ -2173,21 +2179,35 @@
2173
2179
  },
2174
2180
  get tldr() {
2175
2181
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
2176
- // Derive a short progress summary from currentValue, status and any errors/warnings.
2182
+ // Use custom tldr provider if available
2183
+ if (tldrProvider) {
2184
+ return tldrProvider(createdAt, status, currentValue, errors, warnings);
2185
+ }
2186
+ // Fallback to default implementation
2177
2187
  const cv = currentValue;
2178
- // Try several common places where a percent might be stored on the partial result
2188
+ // If explicit percent is provided, use it
2179
2189
  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;
2180
- // If we didn't find a numeric percent, infer from status
2190
+ // Simulate progress if not provided
2181
2191
  if (typeof percentRaw !== 'number') {
2182
- if (status === 'FINISHED') {
2192
+ // Simulate progress: evenly split across subtasks, based on elapsed time
2193
+ const now = new Date();
2194
+ const elapsedMs = now.getTime() - createdAt.getTime();
2195
+ const totalMs = DEFAULT_TASK_SIMULATED_DURATION_MS;
2196
+ // If subtasks are defined, split progress evenly
2197
+ const subtaskCount = Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks) ? cv.subtasks.length : 1;
2198
+ const completedSubtasks = Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks)
2199
+ ? cv.subtasks.filter((s) => s.done || s.completed).length
2200
+ : 0;
2201
+ // Progress from completed subtasks
2202
+ const subtaskProgress = subtaskCount > 0 ? completedSubtasks / subtaskCount : 0;
2203
+ // Progress from elapsed time for current subtask
2204
+ const timeProgress = Math.min(elapsedMs / totalMs, 1);
2205
+ // Combine: completed subtasks + time progress for current subtask
2206
+ percentRaw = Math.min(subtaskProgress + (1 / subtaskCount) * timeProgress, 1);
2207
+ if (status === 'FINISHED')
2183
2208
  percentRaw = 1;
2184
- }
2185
- else if (status === 'ERROR') {
2209
+ if (status === 'ERROR')
2186
2210
  percentRaw = 0;
2187
- }
2188
- else {
2189
- percentRaw = 0;
2190
- }
2191
2211
  }
2192
2212
  // Clamp to [0,1]
2193
2213
  let percent = Number(percentRaw) || 0;
@@ -2199,20 +2219,29 @@
2199
2219
  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;
2200
2220
  let message = messageFromResult;
2201
2221
  if (!message) {
2202
- if (errors.length) {
2203
- message = errors[errors.length - 1].message || 'Error';
2204
- }
2205
- else if (warnings.length) {
2206
- message = warnings[warnings.length - 1].message || 'Warning';
2207
- }
2208
- else if (status === 'FINISHED') {
2209
- message = 'Finished';
2210
- }
2211
- else if (status === 'ERROR') {
2212
- message = 'Error';
2222
+ // If subtasks, show current subtask
2223
+ if (Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks) && cv.subtasks.length > 0) {
2224
+ const current = cv.subtasks.find((s) => !s.done && !s.completed);
2225
+ if (current && current.title) {
2226
+ message = `Working on ${current.title}`;
2227
+ }
2213
2228
  }
2214
- else {
2215
- message = 'Running';
2229
+ if (!message) {
2230
+ if (errors.length) {
2231
+ message = errors[errors.length - 1].message || 'Error';
2232
+ }
2233
+ else if (warnings.length) {
2234
+ message = warnings[warnings.length - 1].message || 'Warning';
2235
+ }
2236
+ else if (status === 'FINISHED') {
2237
+ message = 'Finished';
2238
+ }
2239
+ else if (status === 'ERROR') {
2240
+ message = 'Error';
2241
+ }
2242
+ else {
2243
+ message = 'Running';
2244
+ }
2216
2245
  }
2217
2246
  }
2218
2247
  return {
@@ -5002,6 +5031,71 @@
5002
5031
  updateOngoingResult(newOngoingResult);
5003
5032
  });
5004
5033
  },
5034
+ tldrProvider(createdAt, status, currentValue, errors) {
5035
+ var _a;
5036
+ // Better progress estimation based on pipeline structure
5037
+ const cv = currentValue;
5038
+ // Handle finished/error states
5039
+ if (status === 'FINISHED') {
5040
+ return {
5041
+ percent: 1,
5042
+ message: 'Finished',
5043
+ };
5044
+ }
5045
+ if (status === 'ERROR') {
5046
+ const errorMessage = errors.length > 0 ? errors[errors.length - 1].message : 'Error';
5047
+ return {
5048
+ percent: 0,
5049
+ message: errorMessage,
5050
+ };
5051
+ }
5052
+ // Calculate progress based on pipeline tasks
5053
+ const totalTasks = pipeline.tasks.length;
5054
+ let completedTasks = 0;
5055
+ let currentTaskName = '';
5056
+ // Check execution report for completed tasks
5057
+ if ((_a = cv === null || cv === void 0 ? void 0 : cv.executionReport) === null || _a === void 0 ? void 0 : _a.promptExecutions) {
5058
+ const executedTaskTitles = new Set(cv.executionReport.promptExecutions.map((execution) => execution.prompt.title));
5059
+ // Count completed tasks by matching titles
5060
+ const completedTasksByTitle = pipeline.tasks.filter(task => executedTaskTitles.has(task.title));
5061
+ completedTasks = completedTasksByTitle.length;
5062
+ // Find current task being executed (first task not yet completed)
5063
+ const remainingTasks = pipeline.tasks.filter(task => !executedTaskTitles.has(task.title));
5064
+ if (remainingTasks.length > 0) {
5065
+ currentTaskName = remainingTasks[0].name;
5066
+ }
5067
+ }
5068
+ // Calculate progress percentage
5069
+ let percent = totalTasks > 0 ? completedTasks / totalTasks : 0;
5070
+ // Add time-based progress for current task (assuming 5 minutes total)
5071
+ if (completedTasks < totalTasks) {
5072
+ const elapsedMs = new Date().getTime() - createdAt.getTime();
5073
+ const totalMs = 5 * 60 * 1000; // 5 minutes
5074
+ const timeProgress = Math.min(elapsedMs / totalMs, 1);
5075
+ // Add partial progress for current task
5076
+ percent += (1 / totalTasks) * timeProgress;
5077
+ }
5078
+ // Clamp to [0,1]
5079
+ percent = Math.min(Math.max(percent, 0), 1);
5080
+ // Generate message
5081
+ let message = '';
5082
+ if (currentTaskName) {
5083
+ // Find the task to get its title
5084
+ const currentTask = pipeline.tasks.find(task => task.name === currentTaskName);
5085
+ const taskTitle = (currentTask === null || currentTask === void 0 ? void 0 : currentTask.title) || currentTaskName;
5086
+ message = `Working on task ${taskTitle}`;
5087
+ }
5088
+ else if (completedTasks === 0) {
5089
+ message = 'Starting pipeline execution';
5090
+ }
5091
+ else {
5092
+ message = `Processing pipeline (${completedTasks}/${totalTasks} tasks completed)`;
5093
+ }
5094
+ return {
5095
+ percent,
5096
+ message,
5097
+ };
5098
+ },
5005
5099
  });
5006
5100
  // <- TODO: Make types such as there is no need to do `as` for `createTask`
5007
5101
  return pipelineExecutor;