@promptbook/legacy-documents 0.100.0-4 → 0.100.0-40

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.
Files changed (62) hide show
  1. package/README.md +1 -0
  2. package/esm/index.es.js +150 -3
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/src/_packages/components.index.d.ts +4 -0
  5. package/esm/typings/src/_packages/core.index.d.ts +26 -0
  6. package/esm/typings/src/_packages/types.index.d.ts +30 -0
  7. package/esm/typings/src/book-2.0/agent-source/parseAgentSource.d.ts +30 -0
  8. package/esm/typings/src/book-2.0/agent-source/parseAgentSource.test.d.ts +1 -0
  9. package/esm/typings/src/book-2.0/agent-source/string_book.d.ts +26 -0
  10. package/esm/typings/src/book-2.0/commitments/ACTION/ACTION.d.ts +38 -0
  11. package/esm/typings/src/book-2.0/commitments/FORMAT/FORMAT.d.ts +39 -0
  12. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/FrontendRAGService.d.ts +48 -0
  13. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/KNOWLEDGE.d.ts +51 -0
  14. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/RAGService.d.ts +54 -0
  15. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/BaseKnowledgeProcessor.d.ts +45 -0
  16. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/PdfProcessor.d.ts +31 -0
  17. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/ProcessorFactory.d.ts +23 -0
  18. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/TextProcessor.d.ts +18 -0
  19. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/types.d.ts +56 -0
  20. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/utils/ragHelper.d.ts +34 -0
  21. package/esm/typings/src/book-2.0/commitments/META_IMAGE/META_IMAGE.d.ts +44 -0
  22. package/esm/typings/src/book-2.0/commitments/META_LINK/META_LINK.d.ts +56 -0
  23. package/esm/typings/src/book-2.0/commitments/MODEL/MODEL.d.ts +39 -0
  24. package/esm/typings/src/book-2.0/commitments/NOTE/NOTE.d.ts +49 -0
  25. package/esm/typings/src/book-2.0/commitments/PERSONA/PERSONA.d.ts +46 -0
  26. package/esm/typings/src/book-2.0/commitments/RULE/RULE.d.ts +44 -0
  27. package/esm/typings/src/book-2.0/commitments/SAMPLE/SAMPLE.d.ts +44 -0
  28. package/esm/typings/src/book-2.0/commitments/STYLE/STYLE.d.ts +38 -0
  29. package/esm/typings/src/book-2.0/commitments/_base/BaseCommitmentDefinition.d.ts +52 -0
  30. package/esm/typings/src/book-2.0/commitments/_base/BookCommitment.d.ts +5 -0
  31. package/esm/typings/src/book-2.0/commitments/_base/CommitmentDefinition.d.ts +48 -0
  32. package/esm/typings/src/book-2.0/commitments/_base/NotYetImplementedCommitmentDefinition.d.ts +22 -0
  33. package/esm/typings/src/book-2.0/commitments/_base/createEmptyAgentModelRequirements.d.ts +19 -0
  34. package/esm/typings/src/book-2.0/commitments/_misc/AgentModelRequirements.d.ts +37 -0
  35. package/esm/typings/src/book-2.0/commitments/_misc/AgentSourceParseResult.d.ts +18 -0
  36. package/esm/typings/src/book-2.0/commitments/_misc/ParsedCommitment.d.ts +22 -0
  37. package/esm/typings/src/book-2.0/commitments/_misc/createAgentModelRequirements.d.ts +61 -0
  38. package/esm/typings/src/book-2.0/commitments/_misc/createAgentModelRequirementsWithCommitments.d.ts +35 -0
  39. package/esm/typings/src/book-2.0/commitments/_misc/createCommitmentRegex.d.ts +20 -0
  40. package/esm/typings/src/book-2.0/commitments/_misc/parseAgentSourceWithCommitments.d.ts +24 -0
  41. package/esm/typings/src/book-2.0/commitments/_misc/removeCommentsFromSystemMessage.d.ts +11 -0
  42. package/esm/typings/src/book-2.0/commitments/index.d.ts +56 -0
  43. package/esm/typings/src/book-2.0/utils/profileImageUtils.d.ts +39 -0
  44. package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +30 -0
  45. package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts +7 -0
  46. package/esm/typings/src/config.d.ts +6 -0
  47. package/esm/typings/src/execution/AvailableModel.d.ts +4 -0
  48. package/esm/typings/src/execution/ExecutionTask.d.ts +27 -0
  49. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +6 -1
  50. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +0 -5
  51. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  52. package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts +1 -1
  53. package/esm/typings/src/llm-providers/google/google-models.d.ts +1 -1
  54. package/esm/typings/src/llm-providers/ollama/ollama-models.d.ts +1 -1
  55. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
  56. package/esm/typings/src/pipeline/book-notation.d.ts +2 -1
  57. package/esm/typings/src/types/ModelRequirements.d.ts +0 -2
  58. package/esm/typings/src/types/typeAliases.d.ts +6 -0
  59. package/esm/typings/src/version.d.ts +1 -1
  60. package/package.json +2 -2
  61. package/umd/index.umd.js +150 -3
  62. package/umd/index.umd.js.map +1 -1
package/README.md CHANGED
@@ -18,6 +18,7 @@ Write AI applications using plain human language across multiple models and plat
18
18
 
19
19
  ## 🌟 New Features
20
20
 
21
+ - 🚀 **GPT-5 Support** - Now includes OpenAI's most advanced language model with unprecedented reasoning capabilities and 200K context window
21
22
  - 💡 VS Code support for `.book` files with syntax highlighting and IntelliSense
22
23
  - 🐳 Official Docker image (`hejny/promptbook`) for seamless containerized usage
23
24
  - 🔥 Native support for OpenAI `o3-mini`, GPT-4 and other leading LLMs
package/esm/index.es.js CHANGED
@@ -28,7 +28,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
28
28
  * @generated
29
29
  * @see https://github.com/webgptorg/promptbook
30
30
  */
31
- const PROMPTBOOK_ENGINE_VERSION = '0.100.0-4';
31
+ const PROMPTBOOK_ENGINE_VERSION = '0.100.0-40';
32
32
  /**
33
33
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
34
34
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -220,6 +220,12 @@ let DEFAULT_IS_VERBOSE = false;
220
220
  * @public exported from `@promptbook/core`
221
221
  */
222
222
  const DEFAULT_IS_AUTO_INSTALLED = false;
223
+ /**
224
+ * Default simulated duration for a task in milliseconds (used for progress reporting)
225
+ *
226
+ * @public exported from `@promptbook/core`
227
+ */
228
+ const DEFAULT_TASK_SIMULATED_DURATION_MS = 5 * 60 * 1000; // 5 minutes
223
229
  /**
224
230
  * Indicates whether pipeline logic validation is enabled. When true, the pipeline logic is checked for consistency.
225
231
  *
@@ -2687,7 +2693,7 @@ function assertsTaskSuccessful(executionResult) {
2687
2693
  * @private internal helper function
2688
2694
  */
2689
2695
  function createTask(options) {
2690
- const { taskType, taskProcessCallback } = options;
2696
+ const { taskType, taskProcessCallback, tldrProvider } = options;
2691
2697
  let { title } = options;
2692
2698
  // TODO: [🐙] DRY
2693
2699
  const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid similar char conflicts */)}`;
@@ -2760,6 +2766,78 @@ function createTask(options) {
2760
2766
  return status;
2761
2767
  // <- Note: [1] --||--
2762
2768
  },
2769
+ get tldr() {
2770
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
2771
+ // Use custom tldr provider if available
2772
+ if (tldrProvider) {
2773
+ return tldrProvider(createdAt, status, currentValue, errors, warnings);
2774
+ }
2775
+ // Fallback to default implementation
2776
+ const cv = currentValue;
2777
+ // If explicit percent is provided, use it
2778
+ 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;
2779
+ // Simulate progress if not provided
2780
+ if (typeof percentRaw !== 'number') {
2781
+ // Simulate progress: evenly split across subtasks, based on elapsed time
2782
+ const now = new Date();
2783
+ const elapsedMs = now.getTime() - createdAt.getTime();
2784
+ const totalMs = DEFAULT_TASK_SIMULATED_DURATION_MS;
2785
+ // If subtasks are defined, split progress evenly
2786
+ const subtaskCount = Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks) ? cv.subtasks.length : 1;
2787
+ const completedSubtasks = Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks)
2788
+ ? cv.subtasks.filter((s) => s.done || s.completed).length
2789
+ : 0;
2790
+ // Progress from completed subtasks
2791
+ const subtaskProgress = subtaskCount > 0 ? completedSubtasks / subtaskCount : 0;
2792
+ // Progress from elapsed time for current subtask
2793
+ const timeProgress = Math.min(elapsedMs / totalMs, 1);
2794
+ // Combine: completed subtasks + time progress for current subtask
2795
+ percentRaw = Math.min(subtaskProgress + (1 / subtaskCount) * timeProgress, 1);
2796
+ if (status === 'FINISHED')
2797
+ percentRaw = 1;
2798
+ if (status === 'ERROR')
2799
+ percentRaw = 0;
2800
+ }
2801
+ // Clamp to [0,1]
2802
+ let percent = Number(percentRaw) || 0;
2803
+ if (percent < 0)
2804
+ percent = 0;
2805
+ if (percent > 1)
2806
+ percent = 1;
2807
+ // Build a short message: prefer explicit tldr.message, then common summary/message fields, then errors/warnings, then status
2808
+ 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;
2809
+ let message = messageFromResult;
2810
+ if (!message) {
2811
+ // If subtasks, show current subtask
2812
+ if (Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks) && cv.subtasks.length > 0) {
2813
+ const current = cv.subtasks.find((s) => !s.done && !s.completed);
2814
+ if (current && current.title) {
2815
+ message = `Working on ${current.title}`;
2816
+ }
2817
+ }
2818
+ if (!message) {
2819
+ if (errors.length) {
2820
+ message = errors[errors.length - 1].message || 'Error';
2821
+ }
2822
+ else if (warnings.length) {
2823
+ message = warnings[warnings.length - 1].message || 'Warning';
2824
+ }
2825
+ else if (status === 'FINISHED') {
2826
+ message = 'Finished';
2827
+ }
2828
+ else if (status === 'ERROR') {
2829
+ message = 'Error';
2830
+ }
2831
+ else {
2832
+ message = 'Running';
2833
+ }
2834
+ }
2835
+ }
2836
+ return {
2837
+ percent: percent,
2838
+ message,
2839
+ };
2840
+ },
2763
2841
  get createdAt() {
2764
2842
  return createdAt;
2765
2843
  // <- Note: [1] --||--
@@ -5107,7 +5185,7 @@ function validatePromptResult(options) {
5107
5185
  */
5108
5186
  async function executeAttempts(options) {
5109
5187
  const { jokerParameterNames, priority, maxAttempts, // <- Note: [💂]
5110
- preparedContent, parameters, task, preparedPipeline, tools, $executionReport, pipelineIdentification, maxExecutionAttempts, } = options;
5188
+ preparedContent, parameters, task, preparedPipeline, tools, $executionReport, pipelineIdentification, maxExecutionAttempts, onProgress, } = options;
5111
5189
  const $ongoingTaskResult = {
5112
5190
  $result: null,
5113
5191
  $resultString: null,
@@ -5351,6 +5429,10 @@ async function executeAttempts(options) {
5351
5429
  result: $ongoingTaskResult.$resultString,
5352
5430
  error: error,
5353
5431
  });
5432
+ // Report failed attempt
5433
+ onProgress({
5434
+ errors: [error],
5435
+ });
5354
5436
  }
5355
5437
  finally {
5356
5438
  if (!isJokerAttempt &&
@@ -6232,6 +6314,71 @@ function createPipelineExecutor(options) {
6232
6314
  updateOngoingResult(newOngoingResult);
6233
6315
  });
6234
6316
  },
6317
+ tldrProvider(createdAt, status, currentValue, errors) {
6318
+ var _a;
6319
+ // Better progress estimation based on pipeline structure
6320
+ const cv = currentValue;
6321
+ // Handle finished/error states
6322
+ if (status === 'FINISHED') {
6323
+ return {
6324
+ percent: 1,
6325
+ message: 'Finished',
6326
+ };
6327
+ }
6328
+ if (status === 'ERROR') {
6329
+ const errorMessage = errors.length > 0 ? errors[errors.length - 1].message : 'Error';
6330
+ return {
6331
+ percent: 0,
6332
+ message: errorMessage,
6333
+ };
6334
+ }
6335
+ // Calculate progress based on pipeline tasks
6336
+ const totalTasks = pipeline.tasks.length;
6337
+ let completedTasks = 0;
6338
+ let currentTaskName = '';
6339
+ // Check execution report for completed tasks
6340
+ if ((_a = cv === null || cv === void 0 ? void 0 : cv.executionReport) === null || _a === void 0 ? void 0 : _a.promptExecutions) {
6341
+ const executedTaskTitles = new Set(cv.executionReport.promptExecutions.map((execution) => execution.prompt.title));
6342
+ // Count completed tasks by matching titles
6343
+ const completedTasksByTitle = pipeline.tasks.filter(task => executedTaskTitles.has(task.title));
6344
+ completedTasks = completedTasksByTitle.length;
6345
+ // Find current task being executed (first task not yet completed)
6346
+ const remainingTasks = pipeline.tasks.filter(task => !executedTaskTitles.has(task.title));
6347
+ if (remainingTasks.length > 0) {
6348
+ currentTaskName = remainingTasks[0].name;
6349
+ }
6350
+ }
6351
+ // Calculate progress percentage
6352
+ let percent = totalTasks > 0 ? completedTasks / totalTasks : 0;
6353
+ // Add time-based progress for current task (assuming 5 minutes total)
6354
+ if (completedTasks < totalTasks) {
6355
+ const elapsedMs = new Date().getTime() - createdAt.getTime();
6356
+ const totalMs = 5 * 60 * 1000; // 5 minutes
6357
+ const timeProgress = Math.min(elapsedMs / totalMs, 1);
6358
+ // Add partial progress for current task
6359
+ percent += (1 / totalTasks) * timeProgress;
6360
+ }
6361
+ // Clamp to [0,1]
6362
+ percent = Math.min(Math.max(percent, 0), 1);
6363
+ // Generate message
6364
+ let message = '';
6365
+ if (currentTaskName) {
6366
+ // Find the task to get its title
6367
+ const currentTask = pipeline.tasks.find(task => task.name === currentTaskName);
6368
+ const taskTitle = (currentTask === null || currentTask === void 0 ? void 0 : currentTask.title) || currentTaskName;
6369
+ message = `Working on task ${taskTitle}`;
6370
+ }
6371
+ else if (completedTasks === 0) {
6372
+ message = 'Starting pipeline execution';
6373
+ }
6374
+ else {
6375
+ message = `Processing pipeline (${completedTasks}/${totalTasks} tasks completed)`;
6376
+ }
6377
+ return {
6378
+ percent,
6379
+ message,
6380
+ };
6381
+ },
6235
6382
  });
6236
6383
  // <- TODO: Make types such as there is no need to do `as` for `createTask`
6237
6384
  return pipelineExecutor;