@promptbook/pdf 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/pdf",
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,
@@ -94,7 +94,7 @@
94
94
  "module": "./esm/index.es.js",
95
95
  "typings": "./esm/typings/src/_packages/pdf.index.d.ts",
96
96
  "peerDependencies": {
97
- "@promptbook/core": "0.100.0-35"
97
+ "@promptbook/core": "0.100.0-37"
98
98
  },
99
99
  "dependencies": {
100
100
  "crypto": "1.0.1",
package/umd/index.umd.js CHANGED
@@ -25,7 +25,7 @@
25
25
  * @generated
26
26
  * @see https://github.com/webgptorg/promptbook
27
27
  */
28
- const PROMPTBOOK_ENGINE_VERSION = '0.100.0-35';
28
+ const PROMPTBOOK_ENGINE_VERSION = '0.100.0-37';
29
29
  /**
30
30
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
31
31
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -217,6 +217,12 @@
217
217
  * @public exported from `@promptbook/core`
218
218
  */
219
219
  const DEFAULT_IS_AUTO_INSTALLED = false;
220
+ /**
221
+ * Default simulated duration for a task in milliseconds (used for progress reporting)
222
+ *
223
+ * @public exported from `@promptbook/core`
224
+ */
225
+ const DEFAULT_TASK_SIMULATED_DURATION_MS = 5 * 60 * 1000; // 5 minutes
220
226
  /**
221
227
  * Indicates whether pipeline logic validation is enabled. When true, the pipeline logic is checked for consistency.
222
228
  *
@@ -2525,7 +2531,7 @@
2525
2531
  * @private internal helper function
2526
2532
  */
2527
2533
  function createTask(options) {
2528
- const { taskType, taskProcessCallback } = options;
2534
+ const { taskType, taskProcessCallback, tldrProvider } = options;
2529
2535
  let { title } = options;
2530
2536
  // TODO: [🐙] DRY
2531
2537
  const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid similar char conflicts */)}`;
@@ -2600,21 +2606,35 @@
2600
2606
  },
2601
2607
  get tldr() {
2602
2608
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
2603
- // Derive a short progress summary from currentValue, status and any errors/warnings.
2609
+ // Use custom tldr provider if available
2610
+ if (tldrProvider) {
2611
+ return tldrProvider(createdAt, status, currentValue, errors, warnings);
2612
+ }
2613
+ // Fallback to default implementation
2604
2614
  const cv = currentValue;
2605
- // Try several common places where a percent might be stored on the partial result
2615
+ // If explicit percent is provided, use it
2606
2616
  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;
2607
- // If we didn't find a numeric percent, infer from status
2617
+ // Simulate progress if not provided
2608
2618
  if (typeof percentRaw !== 'number') {
2609
- if (status === 'FINISHED') {
2619
+ // Simulate progress: evenly split across subtasks, based on elapsed time
2620
+ const now = new Date();
2621
+ const elapsedMs = now.getTime() - createdAt.getTime();
2622
+ const totalMs = DEFAULT_TASK_SIMULATED_DURATION_MS;
2623
+ // If subtasks are defined, split progress evenly
2624
+ const subtaskCount = Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks) ? cv.subtasks.length : 1;
2625
+ const completedSubtasks = Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks)
2626
+ ? cv.subtasks.filter((s) => s.done || s.completed).length
2627
+ : 0;
2628
+ // Progress from completed subtasks
2629
+ const subtaskProgress = subtaskCount > 0 ? completedSubtasks / subtaskCount : 0;
2630
+ // Progress from elapsed time for current subtask
2631
+ const timeProgress = Math.min(elapsedMs / totalMs, 1);
2632
+ // Combine: completed subtasks + time progress for current subtask
2633
+ percentRaw = Math.min(subtaskProgress + (1 / subtaskCount) * timeProgress, 1);
2634
+ if (status === 'FINISHED')
2610
2635
  percentRaw = 1;
2611
- }
2612
- else if (status === 'ERROR') {
2636
+ if (status === 'ERROR')
2613
2637
  percentRaw = 0;
2614
- }
2615
- else {
2616
- percentRaw = 0;
2617
- }
2618
2638
  }
2619
2639
  // Clamp to [0,1]
2620
2640
  let percent = Number(percentRaw) || 0;
@@ -2626,20 +2646,29 @@
2626
2646
  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;
2627
2647
  let message = messageFromResult;
2628
2648
  if (!message) {
2629
- if (errors.length) {
2630
- message = errors[errors.length - 1].message || 'Error';
2631
- }
2632
- else if (warnings.length) {
2633
- message = warnings[warnings.length - 1].message || 'Warning';
2634
- }
2635
- else if (status === 'FINISHED') {
2636
- message = 'Finished';
2637
- }
2638
- else if (status === 'ERROR') {
2639
- message = 'Error';
2649
+ // If subtasks, show current subtask
2650
+ if (Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks) && cv.subtasks.length > 0) {
2651
+ const current = cv.subtasks.find((s) => !s.done && !s.completed);
2652
+ if (current && current.title) {
2653
+ message = `Working on ${current.title}`;
2654
+ }
2640
2655
  }
2641
- else {
2642
- message = 'Running';
2656
+ if (!message) {
2657
+ if (errors.length) {
2658
+ message = errors[errors.length - 1].message || 'Error';
2659
+ }
2660
+ else if (warnings.length) {
2661
+ message = warnings[warnings.length - 1].message || 'Warning';
2662
+ }
2663
+ else if (status === 'FINISHED') {
2664
+ message = 'Finished';
2665
+ }
2666
+ else if (status === 'ERROR') {
2667
+ message = 'Error';
2668
+ }
2669
+ else {
2670
+ message = 'Running';
2671
+ }
2643
2672
  }
2644
2673
  }
2645
2674
  return {
@@ -6133,6 +6162,71 @@
6133
6162
  updateOngoingResult(newOngoingResult);
6134
6163
  });
6135
6164
  },
6165
+ tldrProvider(createdAt, status, currentValue, errors) {
6166
+ var _a;
6167
+ // Better progress estimation based on pipeline structure
6168
+ const cv = currentValue;
6169
+ // Handle finished/error states
6170
+ if (status === 'FINISHED') {
6171
+ return {
6172
+ percent: 1,
6173
+ message: 'Finished',
6174
+ };
6175
+ }
6176
+ if (status === 'ERROR') {
6177
+ const errorMessage = errors.length > 0 ? errors[errors.length - 1].message : 'Error';
6178
+ return {
6179
+ percent: 0,
6180
+ message: errorMessage,
6181
+ };
6182
+ }
6183
+ // Calculate progress based on pipeline tasks
6184
+ const totalTasks = pipeline.tasks.length;
6185
+ let completedTasks = 0;
6186
+ let currentTaskName = '';
6187
+ // Check execution report for completed tasks
6188
+ if ((_a = cv === null || cv === void 0 ? void 0 : cv.executionReport) === null || _a === void 0 ? void 0 : _a.promptExecutions) {
6189
+ const executedTaskTitles = new Set(cv.executionReport.promptExecutions.map((execution) => execution.prompt.title));
6190
+ // Count completed tasks by matching titles
6191
+ const completedTasksByTitle = pipeline.tasks.filter(task => executedTaskTitles.has(task.title));
6192
+ completedTasks = completedTasksByTitle.length;
6193
+ // Find current task being executed (first task not yet completed)
6194
+ const remainingTasks = pipeline.tasks.filter(task => !executedTaskTitles.has(task.title));
6195
+ if (remainingTasks.length > 0) {
6196
+ currentTaskName = remainingTasks[0].name;
6197
+ }
6198
+ }
6199
+ // Calculate progress percentage
6200
+ let percent = totalTasks > 0 ? completedTasks / totalTasks : 0;
6201
+ // Add time-based progress for current task (assuming 5 minutes total)
6202
+ if (completedTasks < totalTasks) {
6203
+ const elapsedMs = new Date().getTime() - createdAt.getTime();
6204
+ const totalMs = 5 * 60 * 1000; // 5 minutes
6205
+ const timeProgress = Math.min(elapsedMs / totalMs, 1);
6206
+ // Add partial progress for current task
6207
+ percent += (1 / totalTasks) * timeProgress;
6208
+ }
6209
+ // Clamp to [0,1]
6210
+ percent = Math.min(Math.max(percent, 0), 1);
6211
+ // Generate message
6212
+ let message = '';
6213
+ if (currentTaskName) {
6214
+ // Find the task to get its title
6215
+ const currentTask = pipeline.tasks.find(task => task.name === currentTaskName);
6216
+ const taskTitle = (currentTask === null || currentTask === void 0 ? void 0 : currentTask.title) || currentTaskName;
6217
+ message = `Working on task ${taskTitle}`;
6218
+ }
6219
+ else if (completedTasks === 0) {
6220
+ message = 'Starting pipeline execution';
6221
+ }
6222
+ else {
6223
+ message = `Processing pipeline (${completedTasks}/${totalTasks} tasks completed)`;
6224
+ }
6225
+ return {
6226
+ percent,
6227
+ message,
6228
+ };
6229
+ },
6136
6230
  });
6137
6231
  // <- TODO: Make types such as there is no need to do `as` for `createTask`
6138
6232
  return pipelineExecutor;