@promptbook/markitdown 0.100.0-4 → 0.100.0-41

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 (70) 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 +14 -0
  5. package/esm/typings/src/_packages/core.index.d.ts +26 -0
  6. package/esm/typings/src/_packages/types.index.d.ts +34 -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/AvatarProfile/AvatarChip/AvatarChip.d.ts +35 -0
  45. package/esm/typings/src/book-components/AvatarProfile/AvatarChip/AvatarChipFromSource.d.ts +21 -0
  46. package/esm/typings/src/book-components/AvatarProfile/AvatarChip/index.d.ts +2 -0
  47. package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +35 -0
  48. package/esm/typings/src/book-components/BookEditor/config.d.ts +10 -0
  49. package/esm/typings/src/book-components/BookEditor/injectCssModuleIntoShadowRoot.d.ts +11 -0
  50. package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts +7 -0
  51. package/esm/typings/src/book-components/_common/react-utils/collectCssTextsForClass.d.ts +7 -0
  52. package/esm/typings/src/book-components/_common/react-utils/escapeHtml.d.ts +6 -0
  53. package/esm/typings/src/book-components/_common/react-utils/escapeRegex.d.ts +6 -0
  54. package/esm/typings/src/config.d.ts +6 -0
  55. package/esm/typings/src/execution/AvailableModel.d.ts +4 -0
  56. package/esm/typings/src/execution/ExecutionTask.d.ts +27 -0
  57. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +6 -1
  58. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +0 -5
  59. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  60. package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts +1 -1
  61. package/esm/typings/src/llm-providers/google/google-models.d.ts +1 -1
  62. package/esm/typings/src/llm-providers/ollama/ollama-models.d.ts +1 -1
  63. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
  64. package/esm/typings/src/pipeline/book-notation.d.ts +2 -1
  65. package/esm/typings/src/types/ModelRequirements.d.ts +0 -2
  66. package/esm/typings/src/types/typeAliases.d.ts +6 -0
  67. package/esm/typings/src/version.d.ts +1 -1
  68. package/package.json +2 -2
  69. package/umd/index.umd.js +150 -3
  70. 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
@@ -26,7 +26,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
26
26
  * @generated
27
27
  * @see https://github.com/webgptorg/promptbook
28
28
  */
29
- const PROMPTBOOK_ENGINE_VERSION = '0.100.0-4';
29
+ const PROMPTBOOK_ENGINE_VERSION = '0.100.0-41';
30
30
  /**
31
31
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
32
32
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -218,6 +218,12 @@ let DEFAULT_IS_VERBOSE = false;
218
218
  * @public exported from `@promptbook/core`
219
219
  */
220
220
  const DEFAULT_IS_AUTO_INSTALLED = false;
221
+ /**
222
+ * Default simulated duration for a task in milliseconds (used for progress reporting)
223
+ *
224
+ * @public exported from `@promptbook/core`
225
+ */
226
+ const DEFAULT_TASK_SIMULATED_DURATION_MS = 5 * 60 * 1000; // 5 minutes
221
227
  /**
222
228
  * Indicates whether pipeline logic validation is enabled. When true, the pipeline logic is checked for consistency.
223
229
  *
@@ -2513,7 +2519,7 @@ function assertsTaskSuccessful(executionResult) {
2513
2519
  * @private internal helper function
2514
2520
  */
2515
2521
  function createTask(options) {
2516
- const { taskType, taskProcessCallback } = options;
2522
+ const { taskType, taskProcessCallback, tldrProvider } = options;
2517
2523
  let { title } = options;
2518
2524
  // TODO: [🐙] DRY
2519
2525
  const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid similar char conflicts */)}`;
@@ -2586,6 +2592,78 @@ function createTask(options) {
2586
2592
  return status;
2587
2593
  // <- Note: [1] --||--
2588
2594
  },
2595
+ get tldr() {
2596
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
2597
+ // Use custom tldr provider if available
2598
+ if (tldrProvider) {
2599
+ return tldrProvider(createdAt, status, currentValue, errors, warnings);
2600
+ }
2601
+ // Fallback to default implementation
2602
+ const cv = currentValue;
2603
+ // If explicit percent is provided, use it
2604
+ 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;
2605
+ // Simulate progress if not provided
2606
+ if (typeof percentRaw !== 'number') {
2607
+ // Simulate progress: evenly split across subtasks, based on elapsed time
2608
+ const now = new Date();
2609
+ const elapsedMs = now.getTime() - createdAt.getTime();
2610
+ const totalMs = DEFAULT_TASK_SIMULATED_DURATION_MS;
2611
+ // If subtasks are defined, split progress evenly
2612
+ const subtaskCount = Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks) ? cv.subtasks.length : 1;
2613
+ const completedSubtasks = Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks)
2614
+ ? cv.subtasks.filter((s) => s.done || s.completed).length
2615
+ : 0;
2616
+ // Progress from completed subtasks
2617
+ const subtaskProgress = subtaskCount > 0 ? completedSubtasks / subtaskCount : 0;
2618
+ // Progress from elapsed time for current subtask
2619
+ const timeProgress = Math.min(elapsedMs / totalMs, 1);
2620
+ // Combine: completed subtasks + time progress for current subtask
2621
+ percentRaw = Math.min(subtaskProgress + (1 / subtaskCount) * timeProgress, 1);
2622
+ if (status === 'FINISHED')
2623
+ percentRaw = 1;
2624
+ if (status === 'ERROR')
2625
+ percentRaw = 0;
2626
+ }
2627
+ // Clamp to [0,1]
2628
+ let percent = Number(percentRaw) || 0;
2629
+ if (percent < 0)
2630
+ percent = 0;
2631
+ if (percent > 1)
2632
+ percent = 1;
2633
+ // Build a short message: prefer explicit tldr.message, then common summary/message fields, then errors/warnings, then status
2634
+ 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;
2635
+ let message = messageFromResult;
2636
+ if (!message) {
2637
+ // If subtasks, show current subtask
2638
+ if (Array.isArray(cv === null || cv === void 0 ? void 0 : cv.subtasks) && cv.subtasks.length > 0) {
2639
+ const current = cv.subtasks.find((s) => !s.done && !s.completed);
2640
+ if (current && current.title) {
2641
+ message = `Working on ${current.title}`;
2642
+ }
2643
+ }
2644
+ if (!message) {
2645
+ if (errors.length) {
2646
+ message = errors[errors.length - 1].message || 'Error';
2647
+ }
2648
+ else if (warnings.length) {
2649
+ message = warnings[warnings.length - 1].message || 'Warning';
2650
+ }
2651
+ else if (status === 'FINISHED') {
2652
+ message = 'Finished';
2653
+ }
2654
+ else if (status === 'ERROR') {
2655
+ message = 'Error';
2656
+ }
2657
+ else {
2658
+ message = 'Running';
2659
+ }
2660
+ }
2661
+ }
2662
+ return {
2663
+ percent: percent,
2664
+ message,
2665
+ };
2666
+ },
2589
2667
  get createdAt() {
2590
2668
  return createdAt;
2591
2669
  // <- Note: [1] --||--
@@ -4943,7 +5021,7 @@ function validatePromptResult(options) {
4943
5021
  */
4944
5022
  async function executeAttempts(options) {
4945
5023
  const { jokerParameterNames, priority, maxAttempts, // <- Note: [💂]
4946
- preparedContent, parameters, task, preparedPipeline, tools, $executionReport, pipelineIdentification, maxExecutionAttempts, } = options;
5024
+ preparedContent, parameters, task, preparedPipeline, tools, $executionReport, pipelineIdentification, maxExecutionAttempts, onProgress, } = options;
4947
5025
  const $ongoingTaskResult = {
4948
5026
  $result: null,
4949
5027
  $resultString: null,
@@ -5187,6 +5265,10 @@ async function executeAttempts(options) {
5187
5265
  result: $ongoingTaskResult.$resultString,
5188
5266
  error: error,
5189
5267
  });
5268
+ // Report failed attempt
5269
+ onProgress({
5270
+ errors: [error],
5271
+ });
5190
5272
  }
5191
5273
  finally {
5192
5274
  if (!isJokerAttempt &&
@@ -6068,6 +6150,71 @@ function createPipelineExecutor(options) {
6068
6150
  updateOngoingResult(newOngoingResult);
6069
6151
  });
6070
6152
  },
6153
+ tldrProvider(createdAt, status, currentValue, errors) {
6154
+ var _a;
6155
+ // Better progress estimation based on pipeline structure
6156
+ const cv = currentValue;
6157
+ // Handle finished/error states
6158
+ if (status === 'FINISHED') {
6159
+ return {
6160
+ percent: 1,
6161
+ message: 'Finished',
6162
+ };
6163
+ }
6164
+ if (status === 'ERROR') {
6165
+ const errorMessage = errors.length > 0 ? errors[errors.length - 1].message : 'Error';
6166
+ return {
6167
+ percent: 0,
6168
+ message: errorMessage,
6169
+ };
6170
+ }
6171
+ // Calculate progress based on pipeline tasks
6172
+ const totalTasks = pipeline.tasks.length;
6173
+ let completedTasks = 0;
6174
+ let currentTaskName = '';
6175
+ // Check execution report for completed tasks
6176
+ if ((_a = cv === null || cv === void 0 ? void 0 : cv.executionReport) === null || _a === void 0 ? void 0 : _a.promptExecutions) {
6177
+ const executedTaskTitles = new Set(cv.executionReport.promptExecutions.map((execution) => execution.prompt.title));
6178
+ // Count completed tasks by matching titles
6179
+ const completedTasksByTitle = pipeline.tasks.filter(task => executedTaskTitles.has(task.title));
6180
+ completedTasks = completedTasksByTitle.length;
6181
+ // Find current task being executed (first task not yet completed)
6182
+ const remainingTasks = pipeline.tasks.filter(task => !executedTaskTitles.has(task.title));
6183
+ if (remainingTasks.length > 0) {
6184
+ currentTaskName = remainingTasks[0].name;
6185
+ }
6186
+ }
6187
+ // Calculate progress percentage
6188
+ let percent = totalTasks > 0 ? completedTasks / totalTasks : 0;
6189
+ // Add time-based progress for current task (assuming 5 minutes total)
6190
+ if (completedTasks < totalTasks) {
6191
+ const elapsedMs = new Date().getTime() - createdAt.getTime();
6192
+ const totalMs = 5 * 60 * 1000; // 5 minutes
6193
+ const timeProgress = Math.min(elapsedMs / totalMs, 1);
6194
+ // Add partial progress for current task
6195
+ percent += (1 / totalTasks) * timeProgress;
6196
+ }
6197
+ // Clamp to [0,1]
6198
+ percent = Math.min(Math.max(percent, 0), 1);
6199
+ // Generate message
6200
+ let message = '';
6201
+ if (currentTaskName) {
6202
+ // Find the task to get its title
6203
+ const currentTask = pipeline.tasks.find(task => task.name === currentTaskName);
6204
+ const taskTitle = (currentTask === null || currentTask === void 0 ? void 0 : currentTask.title) || currentTaskName;
6205
+ message = `Working on task ${taskTitle}`;
6206
+ }
6207
+ else if (completedTasks === 0) {
6208
+ message = 'Starting pipeline execution';
6209
+ }
6210
+ else {
6211
+ message = `Processing pipeline (${completedTasks}/${totalTasks} tasks completed)`;
6212
+ }
6213
+ return {
6214
+ percent,
6215
+ message,
6216
+ };
6217
+ },
6071
6218
  });
6072
6219
  // <- TODO: Make types such as there is no need to do `as` for `createTask`
6073
6220
  return pipelineExecutor;