@promptbook/markdown-utils 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.
- package/esm/index.es.js +119 -25
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/core.index.d.ts +2 -0
- package/esm/typings/src/config.d.ts +6 -0
- package/esm/typings/src/execution/ExecutionTask.d.ts +13 -0
- package/esm/typings/src/version.d.ts +1 -1
- package/package.json +1 -1
- package/umd/index.umd.js +119 -25
- package/umd/index.umd.js.map +1 -1
|
@@ -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-
|
|
18
|
+
* It follows semantic versioning (e.g., `0.100.0-36`).
|
|
19
19
|
*
|
|
20
20
|
* @generated
|
|
21
21
|
*/
|
package/package.json
CHANGED
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-
|
|
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
|
|
@@ -347,6 +347,12 @@
|
|
|
347
347
|
* @public exported from `@promptbook/core`
|
|
348
348
|
*/
|
|
349
349
|
const DEFAULT_IS_AUTO_INSTALLED = false;
|
|
350
|
+
/**
|
|
351
|
+
* Default simulated duration for a task in milliseconds (used for progress reporting)
|
|
352
|
+
*
|
|
353
|
+
* @public exported from `@promptbook/core`
|
|
354
|
+
*/
|
|
355
|
+
const DEFAULT_TASK_SIMULATED_DURATION_MS = 5 * 60 * 1000; // 5 minutes
|
|
350
356
|
/**
|
|
351
357
|
* Indicates whether pipeline logic validation is enabled. When true, the pipeline logic is checked for consistency.
|
|
352
358
|
*
|
|
@@ -2196,7 +2202,7 @@
|
|
|
2196
2202
|
* @private internal helper function
|
|
2197
2203
|
*/
|
|
2198
2204
|
function createTask(options) {
|
|
2199
|
-
const { taskType, taskProcessCallback } = options;
|
|
2205
|
+
const { taskType, taskProcessCallback, tldrProvider } = options;
|
|
2200
2206
|
let { title } = options;
|
|
2201
2207
|
// TODO: [🐙] DRY
|
|
2202
2208
|
const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid similar char conflicts */)}`;
|
|
@@ -2271,21 +2277,35 @@
|
|
|
2271
2277
|
},
|
|
2272
2278
|
get tldr() {
|
|
2273
2279
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
2274
|
-
//
|
|
2280
|
+
// Use custom tldr provider if available
|
|
2281
|
+
if (tldrProvider) {
|
|
2282
|
+
return tldrProvider(createdAt, status, currentValue, errors, warnings);
|
|
2283
|
+
}
|
|
2284
|
+
// Fallback to default implementation
|
|
2275
2285
|
const cv = currentValue;
|
|
2276
|
-
//
|
|
2286
|
+
// If explicit percent is provided, use it
|
|
2277
2287
|
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;
|
|
2278
|
-
//
|
|
2288
|
+
// Simulate progress if not provided
|
|
2279
2289
|
if (typeof percentRaw !== 'number') {
|
|
2280
|
-
|
|
2290
|
+
// Simulate progress: evenly split across subtasks, based on elapsed time
|
|
2291
|
+
const now = new Date();
|
|
2292
|
+
const elapsedMs = now.getTime() - createdAt.getTime();
|
|
2293
|
+
const totalMs = DEFAULT_TASK_SIMULATED_DURATION_MS;
|
|
2294
|
+
// If subtasks are defined, split progress evenly
|
|
2295
|
+
const subtaskCount = Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks) ? cv.subtasks.length : 1;
|
|
2296
|
+
const completedSubtasks = Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks)
|
|
2297
|
+
? cv.subtasks.filter((s) => s.done || s.completed).length
|
|
2298
|
+
: 0;
|
|
2299
|
+
// Progress from completed subtasks
|
|
2300
|
+
const subtaskProgress = subtaskCount > 0 ? completedSubtasks / subtaskCount : 0;
|
|
2301
|
+
// Progress from elapsed time for current subtask
|
|
2302
|
+
const timeProgress = Math.min(elapsedMs / totalMs, 1);
|
|
2303
|
+
// Combine: completed subtasks + time progress for current subtask
|
|
2304
|
+
percentRaw = Math.min(subtaskProgress + (1 / subtaskCount) * timeProgress, 1);
|
|
2305
|
+
if (status === 'FINISHED')
|
|
2281
2306
|
percentRaw = 1;
|
|
2282
|
-
|
|
2283
|
-
else if (status === 'ERROR') {
|
|
2307
|
+
if (status === 'ERROR')
|
|
2284
2308
|
percentRaw = 0;
|
|
2285
|
-
}
|
|
2286
|
-
else {
|
|
2287
|
-
percentRaw = 0;
|
|
2288
|
-
}
|
|
2289
2309
|
}
|
|
2290
2310
|
// Clamp to [0,1]
|
|
2291
2311
|
let percent = Number(percentRaw) || 0;
|
|
@@ -2297,20 +2317,29 @@
|
|
|
2297
2317
|
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;
|
|
2298
2318
|
let message = messageFromResult;
|
|
2299
2319
|
if (!message) {
|
|
2300
|
-
|
|
2301
|
-
|
|
2302
|
-
|
|
2303
|
-
|
|
2304
|
-
|
|
2305
|
-
|
|
2306
|
-
else if (status === 'FINISHED') {
|
|
2307
|
-
message = 'Finished';
|
|
2308
|
-
}
|
|
2309
|
-
else if (status === 'ERROR') {
|
|
2310
|
-
message = 'Error';
|
|
2320
|
+
// If subtasks, show current subtask
|
|
2321
|
+
if (Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks) && cv.subtasks.length > 0) {
|
|
2322
|
+
const current = cv.subtasks.find((s) => !s.done && !s.completed);
|
|
2323
|
+
if (current && current.title) {
|
|
2324
|
+
message = `Working on ${current.title}`;
|
|
2325
|
+
}
|
|
2311
2326
|
}
|
|
2312
|
-
|
|
2313
|
-
|
|
2327
|
+
if (!message) {
|
|
2328
|
+
if (errors.length) {
|
|
2329
|
+
message = errors[errors.length - 1].message || 'Error';
|
|
2330
|
+
}
|
|
2331
|
+
else if (warnings.length) {
|
|
2332
|
+
message = warnings[warnings.length - 1].message || 'Warning';
|
|
2333
|
+
}
|
|
2334
|
+
else if (status === 'FINISHED') {
|
|
2335
|
+
message = 'Finished';
|
|
2336
|
+
}
|
|
2337
|
+
else if (status === 'ERROR') {
|
|
2338
|
+
message = 'Error';
|
|
2339
|
+
}
|
|
2340
|
+
else {
|
|
2341
|
+
message = 'Running';
|
|
2342
|
+
}
|
|
2314
2343
|
}
|
|
2315
2344
|
}
|
|
2316
2345
|
return {
|
|
@@ -6089,6 +6118,71 @@
|
|
|
6089
6118
|
updateOngoingResult(newOngoingResult);
|
|
6090
6119
|
});
|
|
6091
6120
|
},
|
|
6121
|
+
tldrProvider(createdAt, status, currentValue, errors) {
|
|
6122
|
+
var _a;
|
|
6123
|
+
// Better progress estimation based on pipeline structure
|
|
6124
|
+
const cv = currentValue;
|
|
6125
|
+
// Handle finished/error states
|
|
6126
|
+
if (status === 'FINISHED') {
|
|
6127
|
+
return {
|
|
6128
|
+
percent: 1,
|
|
6129
|
+
message: 'Finished',
|
|
6130
|
+
};
|
|
6131
|
+
}
|
|
6132
|
+
if (status === 'ERROR') {
|
|
6133
|
+
const errorMessage = errors.length > 0 ? errors[errors.length - 1].message : 'Error';
|
|
6134
|
+
return {
|
|
6135
|
+
percent: 0,
|
|
6136
|
+
message: errorMessage,
|
|
6137
|
+
};
|
|
6138
|
+
}
|
|
6139
|
+
// Calculate progress based on pipeline tasks
|
|
6140
|
+
const totalTasks = pipeline.tasks.length;
|
|
6141
|
+
let completedTasks = 0;
|
|
6142
|
+
let currentTaskName = '';
|
|
6143
|
+
// Check execution report for completed tasks
|
|
6144
|
+
if ((_a = cv === null || cv === void 0 ? void 0 : cv.executionReport) === null || _a === void 0 ? void 0 : _a.promptExecutions) {
|
|
6145
|
+
const executedTaskTitles = new Set(cv.executionReport.promptExecutions.map((execution) => execution.prompt.title));
|
|
6146
|
+
// Count completed tasks by matching titles
|
|
6147
|
+
const completedTasksByTitle = pipeline.tasks.filter(task => executedTaskTitles.has(task.title));
|
|
6148
|
+
completedTasks = completedTasksByTitle.length;
|
|
6149
|
+
// Find current task being executed (first task not yet completed)
|
|
6150
|
+
const remainingTasks = pipeline.tasks.filter(task => !executedTaskTitles.has(task.title));
|
|
6151
|
+
if (remainingTasks.length > 0) {
|
|
6152
|
+
currentTaskName = remainingTasks[0].name;
|
|
6153
|
+
}
|
|
6154
|
+
}
|
|
6155
|
+
// Calculate progress percentage
|
|
6156
|
+
let percent = totalTasks > 0 ? completedTasks / totalTasks : 0;
|
|
6157
|
+
// Add time-based progress for current task (assuming 5 minutes total)
|
|
6158
|
+
if (completedTasks < totalTasks) {
|
|
6159
|
+
const elapsedMs = new Date().getTime() - createdAt.getTime();
|
|
6160
|
+
const totalMs = 5 * 60 * 1000; // 5 minutes
|
|
6161
|
+
const timeProgress = Math.min(elapsedMs / totalMs, 1);
|
|
6162
|
+
// Add partial progress for current task
|
|
6163
|
+
percent += (1 / totalTasks) * timeProgress;
|
|
6164
|
+
}
|
|
6165
|
+
// Clamp to [0,1]
|
|
6166
|
+
percent = Math.min(Math.max(percent, 0), 1);
|
|
6167
|
+
// Generate message
|
|
6168
|
+
let message = '';
|
|
6169
|
+
if (currentTaskName) {
|
|
6170
|
+
// Find the task to get its title
|
|
6171
|
+
const currentTask = pipeline.tasks.find(task => task.name === currentTaskName);
|
|
6172
|
+
const taskTitle = (currentTask === null || currentTask === void 0 ? void 0 : currentTask.title) || currentTaskName;
|
|
6173
|
+
message = `Working on task ${taskTitle}`;
|
|
6174
|
+
}
|
|
6175
|
+
else if (completedTasks === 0) {
|
|
6176
|
+
message = 'Starting pipeline execution';
|
|
6177
|
+
}
|
|
6178
|
+
else {
|
|
6179
|
+
message = `Processing pipeline (${completedTasks}/${totalTasks} tasks completed)`;
|
|
6180
|
+
}
|
|
6181
|
+
return {
|
|
6182
|
+
percent,
|
|
6183
|
+
message,
|
|
6184
|
+
};
|
|
6185
|
+
},
|
|
6092
6186
|
});
|
|
6093
6187
|
// <- TODO: Make types such as there is no need to do `as` for `createTask`
|
|
6094
6188
|
return pipelineExecutor;
|