@promptbook/pdf 0.84.0-9 → 0.84.0

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 (43) hide show
  1. package/README.md +21 -9
  2. package/esm/index.es.js +173 -71
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/src/_packages/cli.index.d.ts +4 -0
  5. package/esm/typings/src/_packages/core.index.d.ts +12 -2
  6. package/esm/typings/src/_packages/deepseek.index.d.ts +8 -0
  7. package/esm/typings/src/_packages/types.index.d.ts +2 -0
  8. package/esm/typings/src/_packages/utils.index.d.ts +2 -0
  9. package/esm/typings/src/_packages/wizzard.index.d.ts +4 -0
  10. package/esm/typings/src/cli/cli-commands/about.d.ts +4 -1
  11. package/esm/typings/src/cli/cli-commands/hello.d.ts +3 -1
  12. package/esm/typings/src/cli/cli-commands/list-models.d.ts +3 -1
  13. package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +13 -0
  14. package/esm/typings/src/cli/cli-commands/make.d.ts +3 -1
  15. package/esm/typings/src/cli/cli-commands/prettify.d.ts +3 -1
  16. package/esm/typings/src/cli/cli-commands/run.d.ts +3 -1
  17. package/esm/typings/src/cli/cli-commands/runInteractiveChatbot.d.ts +1 -1
  18. package/esm/typings/src/cli/cli-commands/test-command.d.ts +3 -1
  19. package/esm/typings/src/config.d.ts +27 -1
  20. package/esm/typings/src/conversion/compilePipelineOnRemoteServer.d.ts +1 -1
  21. package/esm/typings/src/execution/FilesystemTools.d.ts +1 -1
  22. package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +3 -1
  23. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +9 -0
  24. package/esm/typings/src/llm-providers/deepseek/DeepseekExecutionToolsOptions.d.ts +9 -0
  25. package/esm/typings/src/llm-providers/deepseek/createDeepseekExecutionTools.d.ts +14 -0
  26. package/esm/typings/src/llm-providers/deepseek/register-configuration.d.ts +14 -0
  27. package/esm/typings/src/llm-providers/deepseek/register-constructor.d.ts +15 -0
  28. package/esm/typings/src/pipeline/book-notation.d.ts +3 -2
  29. package/esm/typings/src/pipeline/prompt-notation.d.ts +18 -5
  30. package/esm/typings/src/prepare/preparePipelineOnRemoteServer.d.ts +1 -1
  31. package/esm/typings/src/remote-server/socket-types/_subtypes/PromptbookServer_Identification.d.ts +5 -2
  32. package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.test.d.ts +1 -0
  33. package/esm/typings/src/utils/editable/utils/isFlatPipeline.test.d.ts +1 -0
  34. package/esm/typings/src/utils/environment/$isRunningInBrowser.d.ts +3 -0
  35. package/esm/typings/src/utils/environment/$isRunningInJest.d.ts +3 -0
  36. package/esm/typings/src/utils/environment/$isRunningInNode.d.ts +3 -0
  37. package/esm/typings/src/utils/environment/$isRunningInWebWorker.d.ts +3 -0
  38. package/esm/typings/src/utils/files/mimeTypeToExtension.d.ts +10 -0
  39. package/esm/typings/src/utils/files/mimeTypeToExtension.test.d.ts +1 -0
  40. package/esm/typings/src/wizzard/wizzard.d.ts +7 -1
  41. package/package.json +9 -16
  42. package/umd/index.umd.js +176 -74
  43. package/umd/index.umd.js.map +1 -1
package/umd/index.umd.js CHANGED
@@ -1,14 +1,15 @@
1
1
  (function (global, factory) {
2
- typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('fs/promises'), require('spacetrim'), require('crypto-js'), require('crypto-js/enc-hex'), require('path'), require('prettier'), require('prettier/parser-html'), require('waitasecond'), require('mime-types'), require('papaparse')) :
3
- typeof define === 'function' && define.amd ? define(['exports', 'fs/promises', 'spacetrim', 'crypto-js', 'crypto-js/enc-hex', 'path', 'prettier', 'prettier/parser-html', 'waitasecond', 'mime-types', 'papaparse'], factory) :
4
- (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-pdf"] = {}, global.promises, global.spaceTrim, global.cryptoJs, global.hexEncoder, global.path, global.prettier, global.parserHtml, global.waitasecond, global.mimeTypes, global.papaparse));
5
- })(this, (function (exports, promises, spaceTrim, cryptoJs, hexEncoder, path, prettier, parserHtml, waitasecond, mimeTypes, papaparse) { 'use strict';
2
+ typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('fs/promises'), require('spacetrim'), require('crypto-js'), require('crypto-js/enc-hex'), require('path'), require('prettier'), require('prettier/parser-html'), require('waitasecond'), require('crypto-js/sha256'), require('mime-types'), require('papaparse')) :
3
+ typeof define === 'function' && define.amd ? define(['exports', 'fs/promises', 'spacetrim', 'crypto-js', 'crypto-js/enc-hex', 'path', 'prettier', 'prettier/parser-html', 'waitasecond', 'crypto-js/sha256', 'mime-types', 'papaparse'], factory) :
4
+ (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-pdf"] = {}, global.promises, global.spaceTrim, global.cryptoJs, global.hexEncoder, global.path, global.prettier, global.parserHtml, global.waitasecond, global.sha256, global.mimeTypes, global.papaparse));
5
+ })(this, (function (exports, promises, spaceTrim, cryptoJs, hexEncoder, path, prettier, parserHtml, waitasecond, sha256, mimeTypes, papaparse) { 'use strict';
6
6
 
7
7
  function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
8
8
 
9
9
  var spaceTrim__default = /*#__PURE__*/_interopDefaultLegacy(spaceTrim);
10
10
  var hexEncoder__default = /*#__PURE__*/_interopDefaultLegacy(hexEncoder);
11
11
  var parserHtml__default = /*#__PURE__*/_interopDefaultLegacy(parserHtml);
12
+ var sha256__default = /*#__PURE__*/_interopDefaultLegacy(sha256);
12
13
 
13
14
  // ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
14
15
  /**
@@ -24,7 +25,7 @@
24
25
  * @generated
25
26
  * @see https://github.com/webgptorg/promptbook
26
27
  */
27
- var PROMPTBOOK_ENGINE_VERSION = '0.84.0-8';
28
+ var PROMPTBOOK_ENGINE_VERSION = '0.84.0-21';
28
29
  /**
29
30
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
30
31
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -195,6 +196,12 @@
195
196
  * @public exported from `@promptbook/core`
196
197
  */
197
198
  var DEFAULT_BOOK_TITLE = "\u2728 Untitled Book";
199
+ /**
200
+ * Maximum file size limit
201
+ *
202
+ * @public exported from `@promptbook/core`
203
+ */
204
+ var DEFAULT_MAX_FILE_SIZE = 100 * 1024 * 1024; // 100MB
198
205
  // <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
199
206
  /**
200
207
  * The maximum number of iterations for a loops
@@ -228,6 +235,12 @@
228
235
  * @private within the repository - too low-level in comparison with other `MAX_...`
229
236
  */
230
237
  var IMMEDIATE_TIME = 10;
238
+ /**
239
+ * The maximum length of the (generated) filename
240
+ *
241
+ * @public exported from `@promptbook/core`
242
+ */
243
+ var MAX_FILENAME_LENGTH = 30;
231
244
  /**
232
245
  * Strategy for caching the intermediate results for knowledge sources
233
246
  *
@@ -247,6 +260,15 @@
247
260
  * @public exported from `@promptbook/core`
248
261
  */
249
262
  var DEFAULT_MAX_EXECUTION_ATTEMPTS = 3; // <- TODO: [🤹‍♂️]
263
+ // <- TODO: [🕝] Make also `BOOKS_DIRNAME_ALTERNATIVES`
264
+ /**
265
+ * Where to store the temporary downloads
266
+ *
267
+ * Note: When the folder does not exist, it is created recursively
268
+ *
269
+ * @public exported from `@promptbook/core`
270
+ */
271
+ var DEFAULT_DOWNLOAD_CACHE_DIRNAME = './.promptbook/download-cache';
250
272
  /**
251
273
  * Where to store the scrape cache
252
274
  *
@@ -367,6 +389,9 @@
367
389
  * @public exported from `@promptbook/utils`
368
390
  */
369
391
  var $isRunningInNode = new Function("\n try {\n return this === global;\n } catch (e) {\n return false;\n }\n");
392
+ /**
393
+ * TODO: [☑]
394
+ */
370
395
 
371
396
  /**
372
397
  * Checks if the file exists
@@ -941,24 +966,18 @@
941
966
  var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n- Make pieces of information concise, clear, and easy to understand\n- One piece of information should be approximately 1 paragraph\n- Divide the paragraphs by markdown horizontal lines ---\n- Omit irrelevant information\n- Group redundant information\n- Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}",resultingParameterName:"knowledgePieces",dependentParameterNames:["knowledgeContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Knowledge from Markdown\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book.md`\n- INPUT PARAMETER `{knowledgeContent}` Markdown document content\n- OUTPUT PARAMETER `{knowledgePieces}` The knowledge JSON object\n\n## Knowledge\n\n<!-- TODO: [🍆] -FORMAT JSON -->\n\n```markdown\nYou are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n- Make pieces of information concise, clear, and easy to understand\n- One piece of information should be approximately 1 paragraph\n- Divide the paragraphs by markdown horizontal lines ---\n- Omit irrelevant information\n- Group redundant information\n- Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}\n```\n\n`-> {knowledgePieces}`\n"}],sourceFile:"./books/prepare-knowledge-from-markdown.book.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n- Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}",resultingParameterName:"keywords",dependentParameterNames:["knowledgePieceContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Keywords\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-keywords.book.md`\n- INPUT PARAMETER `{knowledgePieceContent}` The content\n- OUTPUT PARAMETER `{keywords}` Keywords separated by comma\n\n## Knowledge\n\n<!-- TODO: [🍆] -FORMAT JSON -->\n\n```markdown\nYou are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n- Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}\n```\n\n`-> {keywords}`\n"}],sourceFile:"./books/prepare-knowledge-keywords.book.md"},{title:"Prepare Knowledge-piece Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced content creator, write best title for the document.\n\n# Rules\n\n- Write just title, nothing else\n- Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}",resultingParameterName:"title",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Knowledge-piece Title\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-title.book.md`\n- INPUT PARAMETER `{knowledgePieceContent}` The content\n- OUTPUT PARAMETER `{title}` The title of the document\n\n## Knowledge\n\n- EXPECT MIN 1 WORD\n- EXPECT MAX 8 WORDS\n\n```markdown\nYou are experienced content creator, write best title for the document.\n\n# Rules\n\n- Write just title, nothing else\n- Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}\n```\n\n`-> {title}`\n"}],sourceFile:"./books/prepare-knowledge-title.book.md"},{title:"Prepare Persona",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.book.md",formfactorName:"GENERIC",parameters:[{name:"availableModelNames",description:"List of available model names separated by comma (,)",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-model-requirements",title:"Make modelRequirements",content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Example\n\n```json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n```\n\n## Instructions\n\n- Your output format is JSON object\n- Write just the JSON object, no other text should be present\n- It contains the following keys:\n - `modelName`: The name of the model to use\n - `systemMessage`: The system message to provide context to the model\n - `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nPick from the following models:\n\n- {availableModelNames}\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n- `0.1`: Low temperature, extremely conservative and deterministic\n- `0.5`: Medium temperature, balanced between conservative and creative\n- `1.0`: High temperature, creative and bit random\n- `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n- `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}",resultingParameterName:"modelRequirements",format:"JSON",dependentParameterNames:["availableModelNames","personaDescription"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Persona\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-persona.book.md`\n- INPUT PARAMETER `{availableModelNames}` List of available model names separated by comma (,)\n- INPUT PARAMETER `{personaDescription}` Description of the persona\n- OUTPUT PARAMETER `{modelRequirements}` Specific requirements for the model\n\n## Make modelRequirements\n\n- FORMAT JSON\n\n```markdown\nYou are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Example\n\n\\`\\`\\`json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n\\`\\`\\`\n\n## Instructions\n\n- Your output format is JSON object\n- Write just the JSON object, no other text should be present\n- It contains the following keys:\n - `modelName`: The name of the model to use\n - `systemMessage`: The system message to provide context to the model\n - `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nPick from the following models:\n\n- {availableModelNames}\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n- `0.1`: Low temperature, extremely conservative and deterministic\n- `0.5`: Medium temperature, balanced between conservative and creative\n- `1.0`: High temperature, creative and bit random\n- `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n- `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}\n```\n\n`-> {modelRequirements}`\n"}],sourceFile:"./books/prepare-persona.book.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-title.book.md",formfactorName:"GENERIC",parameters:[{name:"book",description:"The book to prepare the title for",isInput:true,isOutput:false},{name:"title",description:"Best title for the book",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-title",title:"Make title",content:"Make best title for given text which describes the workflow:\n\n## Rules\n\n- Write just title, nothing else\n- Title should be concise and clear - Write maximum ideally 2 words, maximum 5 words\n- Title starts with emoticon\n- Title should not mention the input and output of the workflow but the main purpose of the workflow\n _For example, not \"✍ Convert Knowledge-piece to title\" but \"✍ Title\"_\n\n## The workflow\n\n> {book}",resultingParameterName:"title",expectations:{words:{min:1,max:8},lines:{min:1,max:1}},dependentParameterNames:["book"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Title\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-title.book.md`\n- INPUT PARAMETER `{book}` The book to prepare the title for\n- OUTPUT PARAMETER `{title}` Best title for the book\n\n## Make title\n\n- EXPECT MIN 1 Word\n- EXPECT MAX 8 Words\n- EXPECT EXACTLY 1 Line\n\n```markdown\nMake best title for given text which describes the workflow:\n\n## Rules\n\n- Write just title, nothing else\n- Title should be concise and clear - Write maximum ideally 2 words, maximum 5 words\n- Title starts with emoticon\n- Title should not mention the input and output of the workflow but the main purpose of the workflow\n _For example, not \"✍ Convert Knowledge-piece to title\" but \"✍ Title\"_\n\n## The workflow\n\n> {book}\n```\n\n`-> {title}`\n"}],sourceFile:"./books/prepare-title.book.md"}];
942
967
 
943
968
  /**
944
- * Function isValidJsonString will tell you if the string is valid JSON or not
969
+ * Checks if value is valid email
945
970
  *
946
971
  * @public exported from `@promptbook/utils`
947
972
  */
948
- function isValidJsonString(value /* <- [👨‍⚖️] */) {
949
- try {
950
- JSON.parse(value);
951
- return true;
973
+ function isValidEmail(email) {
974
+ if (typeof email !== 'string') {
975
+ return false;
952
976
  }
953
- catch (error) {
954
- if (!(error instanceof Error)) {
955
- throw error;
956
- }
957
- if (error.message.includes('Unexpected token')) {
958
- return false;
959
- }
977
+ if (email.split('\n').length > 1) {
960
978
  return false;
961
979
  }
980
+ return /^.+@.+\..+$/.test(email);
962
981
  }
963
982
 
964
983
  /**
@@ -980,6 +999,27 @@
980
999
  * TODO: Maybe split `ParseError` and `ApplyError`
981
1000
  */
982
1001
 
1002
+ /**
1003
+ * Function isValidJsonString will tell you if the string is valid JSON or not
1004
+ *
1005
+ * @public exported from `@promptbook/utils`
1006
+ */
1007
+ function isValidJsonString(value /* <- [👨‍⚖️] */) {
1008
+ try {
1009
+ JSON.parse(value);
1010
+ return true;
1011
+ }
1012
+ catch (error) {
1013
+ if (!(error instanceof Error)) {
1014
+ throw error;
1015
+ }
1016
+ if (error.message.includes('Unexpected token')) {
1017
+ return false;
1018
+ }
1019
+ return false;
1020
+ }
1021
+ }
1022
+
983
1023
  /**
984
1024
  * Function `validatePipelineString` will validate the if the string is a valid pipeline string
985
1025
  * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
@@ -993,6 +1033,15 @@
993
1033
  if (isValidJsonString(pipelineString)) {
994
1034
  throw new ParseError('Expected a book, but got a JSON string');
995
1035
  }
1036
+ else if (isValidUrl(pipelineString)) {
1037
+ throw new ParseError("Expected a book, but got just the URL \"".concat(pipelineString, "\""));
1038
+ }
1039
+ else if (isValidFilePath(pipelineString)) {
1040
+ throw new ParseError("Expected a book, but got just the file path \"".concat(pipelineString, "\""));
1041
+ }
1042
+ else if (isValidEmail(pipelineString)) {
1043
+ throw new ParseError("Expected a book, but got just the email \"".concat(pipelineString, "\""));
1044
+ }
996
1045
  // <- TODO: Implement the validation + add tests when the pipeline logic considered as invalid
997
1046
  return pipelineString;
998
1047
  }
@@ -2374,12 +2423,28 @@
2374
2423
  /**
2375
2424
  * Asserts that the execution of a Promptbook is successful
2376
2425
  *
2426
+ * Note: If there are only warnings, the execution is still successful but the warnings are logged in the console
2427
+ *
2377
2428
  * @param executionResult - The partial result of the Promptbook execution
2378
2429
  * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
2379
2430
  * @public exported from `@promptbook/core`
2380
2431
  */
2381
2432
  function assertsExecutionSuccessful(executionResult) {
2382
- var isSuccessful = executionResult.isSuccessful, errors = executionResult.errors;
2433
+ var e_1, _a;
2434
+ var isSuccessful = executionResult.isSuccessful, errors = executionResult.errors, warnings = executionResult.warnings;
2435
+ try {
2436
+ for (var warnings_1 = __values(warnings), warnings_1_1 = warnings_1.next(); !warnings_1_1.done; warnings_1_1 = warnings_1.next()) {
2437
+ var warning = warnings_1_1.value;
2438
+ console.warn(warning.message);
2439
+ }
2440
+ }
2441
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
2442
+ finally {
2443
+ try {
2444
+ if (warnings_1_1 && !warnings_1_1.done && (_a = warnings_1.return)) _a.call(warnings_1);
2445
+ }
2446
+ finally { if (e_1) throw e_1.error; }
2447
+ }
2383
2448
  if (isSuccessful === true) {
2384
2449
  return;
2385
2450
  }
@@ -3016,7 +3081,7 @@
3016
3081
  if (!(error_1 instanceof Error) || error_1 instanceof UnexpectedError) {
3017
3082
  throw error_1;
3018
3083
  }
3019
- errors.push(error_1);
3084
+ errors.push({ llmExecutionTools: llmExecutionTools, error: error_1 });
3020
3085
  return [3 /*break*/, 13];
3021
3086
  case 13:
3022
3087
  _b = _a.next();
@@ -3043,7 +3108,10 @@
3043
3108
  // 2) AnthropicClaude throw PipelineExecutionError: Parameter `{knowledge}` is not defined
3044
3109
  // 3) ...
3045
3110
  spaceTrim__default["default"](function (block) { return "\n All execution tools failed:\n\n ".concat(block(errors
3046
- .map(function (error, i) { return "".concat(i + 1, ") **").concat(error.name || 'Error', ":** ").concat(error.message); })
3111
+ .map(function (_a, i) {
3112
+ var error = _a.error, llmExecutionTools = _a.llmExecutionTools;
3113
+ return "".concat(i + 1, ") **").concat(llmExecutionTools.title, "** thrown **").concat(error.name || 'Error', ":** ").concat(error.message);
3114
+ })
3047
3115
  .join('\n')), "\n\n "); }));
3048
3116
  }
3049
3117
  else if (this.llmExecutionTools.length === 0) {
@@ -3525,6 +3593,17 @@
3525
3593
  return match ? match[1].toLowerCase() : null;
3526
3594
  }
3527
3595
 
3596
+ /**
3597
+ * Convert mime type to file extension
3598
+ *
3599
+ * Note: If the mime type is invalid, `null` is returned
3600
+ *
3601
+ * @private within the repository
3602
+ */
3603
+ function mimeTypeToExtension(value) {
3604
+ return mimeTypes.extension(value) || null;
3605
+ }
3606
+
3528
3607
  /**
3529
3608
  * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
3530
3609
  *
@@ -3560,9 +3639,9 @@
3560
3639
  function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
3561
3640
  var _a;
3562
3641
  return __awaiter(this, void 0, void 0, function () {
3563
- var _b, fetch, knowledgeSourceContent, name, _c, _d, rootDirname, url, response_1, mimeType, filename_1, fileExtension, mimeType;
3564
- return __generator(this, function (_f) {
3565
- switch (_f.label) {
3642
+ var _b, fetch, knowledgeSourceContent, name, _c, _d, rootDirname, url, response_1, mimeType, basename, hash, rootDirname_1, filepath, fileContent, _f, _g, filename_1, fileExtension, mimeType;
3643
+ return __generator(this, function (_h) {
3644
+ switch (_h.label) {
3566
3645
  case 0:
3567
3646
  _b = tools.fetch, fetch = _b === void 0 ? scraperFetch : _b;
3568
3647
  knowledgeSourceContent = knowledgeSource.knowledgeSourceContent;
@@ -3571,54 +3650,76 @@
3571
3650
  if (!name) {
3572
3651
  name = knowledgeSourceContentToName(knowledgeSourceContent);
3573
3652
  }
3574
- if (!isValidUrl(knowledgeSourceContent)) return [3 /*break*/, 2];
3653
+ if (!isValidUrl(knowledgeSourceContent)) return [3 /*break*/, 5];
3575
3654
  url = knowledgeSourceContent;
3576
3655
  return [4 /*yield*/, fetch(url)];
3577
3656
  case 1:
3578
- response_1 = _f.sent();
3657
+ response_1 = _h.sent();
3579
3658
  mimeType = ((_a = response_1.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.split(';')[0]) || 'text/html';
3580
- return [2 /*return*/, {
3581
- source: name,
3582
- filename: null,
3583
- url: url,
3584
- mimeType: mimeType,
3585
- /*
3586
- TODO: [🥽]
3587
- > async asBlob() {
3588
- > // TODO: [👨🏻‍🤝‍👨🏻] This can be called multiple times BUT when called second time, response in already consumed
3589
- > const content = await response.blob();
3590
- > return content;
3591
- > },
3592
- */
3593
- asJson: function () {
3594
- return __awaiter(this, void 0, void 0, function () {
3595
- var content;
3596
- return __generator(this, function (_a) {
3597
- switch (_a.label) {
3598
- case 0: return [4 /*yield*/, response_1.json()];
3599
- case 1:
3600
- content = _a.sent();
3601
- return [2 /*return*/, content];
3602
- }
3659
+ if (tools.fs === undefined || !url.endsWith('.pdf' /* <- TODO: [💵] */)) {
3660
+ return [2 /*return*/, {
3661
+ source: name,
3662
+ filename: null,
3663
+ url: url,
3664
+ mimeType: mimeType,
3665
+ /*
3666
+ TODO: [🥽]
3667
+ > async asBlob() {
3668
+ > // TODO: [👨🏻‍🤝‍👨🏻] This can be called multiple times BUT when called second time, response in already consumed
3669
+ > const content = await response.blob();
3670
+ > return content;
3671
+ > },
3672
+ */
3673
+ asJson: function () {
3674
+ return __awaiter(this, void 0, void 0, function () {
3675
+ var content;
3676
+ return __generator(this, function (_a) {
3677
+ switch (_a.label) {
3678
+ case 0: return [4 /*yield*/, response_1.json()];
3679
+ case 1:
3680
+ content = _a.sent();
3681
+ return [2 /*return*/, content];
3682
+ }
3683
+ });
3603
3684
  });
3604
- });
3605
- },
3606
- asText: function () {
3607
- return __awaiter(this, void 0, void 0, function () {
3608
- var content;
3609
- return __generator(this, function (_a) {
3610
- switch (_a.label) {
3611
- case 0: return [4 /*yield*/, response_1.text()];
3612
- case 1:
3613
- content = _a.sent();
3614
- return [2 /*return*/, content];
3615
- }
3685
+ },
3686
+ asText: function () {
3687
+ return __awaiter(this, void 0, void 0, function () {
3688
+ var content;
3689
+ return __generator(this, function (_a) {
3690
+ switch (_a.label) {
3691
+ case 0: return [4 /*yield*/, response_1.text()];
3692
+ case 1:
3693
+ content = _a.sent();
3694
+ return [2 /*return*/, content];
3695
+ }
3696
+ });
3616
3697
  });
3617
- });
3618
- },
3619
- }];
3698
+ },
3699
+ }];
3700
+ }
3701
+ basename = url.split('/').pop() || titleToName(url);
3702
+ hash = sha256__default["default"](hexEncoder__default["default"].parse(url)).toString( /* hex */);
3703
+ rootDirname_1 = path.join(process.cwd(), DEFAULT_DOWNLOAD_CACHE_DIRNAME);
3704
+ filepath = path.join.apply(void 0, __spreadArray(__spreadArray([], __read(nameToSubfolderPath(hash /* <- TODO: [🎎] Maybe add some SHA256 prefix */)), false), ["".concat(basename.substring(0, MAX_FILENAME_LENGTH), ".").concat(mimeTypeToExtension(mimeType))], false));
3705
+ return [4 /*yield*/, tools.fs.mkdir(path.dirname(path.join(rootDirname_1, filepath)), { recursive: true })];
3620
3706
  case 2:
3621
- if (!isValidFilePath(knowledgeSourceContent)) return [3 /*break*/, 4];
3707
+ _h.sent();
3708
+ _g = (_f = Buffer).from;
3709
+ return [4 /*yield*/, response_1.arrayBuffer()];
3710
+ case 3:
3711
+ fileContent = _g.apply(_f, [_h.sent()]);
3712
+ if (fileContent.length > DEFAULT_MAX_FILE_SIZE /* <- TODO: Allow to pass different value to remote server */) {
3713
+ throw new LimitReachedError("File is too large (".concat(Math.round(fileContent.length / 1024 / 1024), "MB). Maximum allowed size is ").concat(Math.round(DEFAULT_MAX_FILE_SIZE / 1024 / 1024), "MB."));
3714
+ }
3715
+ return [4 /*yield*/, tools.fs.writeFile(path.join(rootDirname_1, filepath), fileContent)];
3716
+ case 4:
3717
+ _h.sent();
3718
+ // TODO: [💵] Check the file security
3719
+ // TODO: [🧹][🧠] Delete the file after the scraping is done
3720
+ return [2 /*return*/, makeKnowledgeSourceHandler({ name: name, knowledgeSourceContent: filepath }, tools, __assign(__assign({}, options), { rootDirname: rootDirname_1 }))];
3721
+ case 5:
3722
+ if (!isValidFilePath(knowledgeSourceContent)) return [3 /*break*/, 7];
3622
3723
  if (tools.fs === undefined) {
3623
3724
  throw new EnvironmentMismatchError('Can not import file knowledge without filesystem tools');
3624
3725
  // <- TODO: [🧠] What is the best error type here`
@@ -3631,8 +3732,8 @@
3631
3732
  fileExtension = getFileExtension(filename_1);
3632
3733
  mimeType = extensionToMimeType(fileExtension || '');
3633
3734
  return [4 /*yield*/, isFileExisting(filename_1, tools.fs)];
3634
- case 3:
3635
- if (!(_f.sent())) {
3735
+ case 6:
3736
+ if (!(_h.sent())) {
3636
3737
  throw new NotFoundError(spaceTrim__default["default"](function (block) { return "\n Can not make source handler for file which does not exist:\n\n File:\n ".concat(block(knowledgeSourceContent), "\n\n Full file path:\n ").concat(block(filename_1), "\n "); }));
3637
3738
  }
3638
3739
  // TODO: [🧠][😿] Test security file - file is scoped to the project (BUT maybe do this in `filesystemTools`)
@@ -3678,7 +3779,7 @@
3678
3779
  });
3679
3780
  },
3680
3781
  }];
3681
- case 4: return [2 /*return*/, {
3782
+ case 7: return [2 /*return*/, {
3682
3783
  source: name,
3683
3784
  filename: null,
3684
3785
  url: null,
@@ -6234,7 +6335,7 @@
6234
6335
  className: 'MarkitdownScraper',
6235
6336
  mimeTypes: [
6236
6337
  'application/pdf',
6237
- // TODO: Make priority for scrapers and than allow all mime types here:
6338
+ // TODO: [💵] Make priority for scrapers and than analyze which mime-types can Markitdown scrape and allow all mime types here:
6238
6339
  // 'text/html',
6239
6340
  // 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
6240
6341
  ],
@@ -6270,10 +6371,10 @@
6270
6371
  this.tools = tools;
6271
6372
  this.options = options;
6272
6373
  this.markdownScraper = new MarkdownScraper(tools, options);
6374
+ // Note: Module `markitdown-ts` has no types available, so it is imported using `require`
6273
6375
  // eslint-disable-next-line @typescript-eslint/no-var-requires
6274
6376
  var MarkItDown = require('markitdown-ts').MarkItDown;
6275
- // <- TODO: !!! Use Markitdown directly not through this package
6276
- // <- Note: !!!!!!!
6377
+ // <- TODO: [🍀] Use Markitdown directly not through this package
6277
6378
  this.markitdown = new MarkItDown();
6278
6379
  }
6279
6380
  Object.defineProperty(MarkitdownScraper.prototype, "metadata", {
@@ -6318,12 +6419,12 @@
6318
6419
  case 2:
6319
6420
  if (!!(_f.sent())) return [3 /*break*/, 5];
6320
6421
  src = source.filename || source.url || null;
6321
- console.log('!!!', { src: src, source: source, cacheFilehandler: cacheFilehandler });
6422
+ // console.log('!!', { src, source, cacheFilehandler });
6322
6423
  if (src === null) {
6323
6424
  throw new UnexpectedError('Source has no filename or url');
6324
6425
  }
6325
6426
  return [4 /*yield*/, this.markitdown.convert(src, {
6326
- // TODO: !!!!!! Pass when sacraping Youtube
6427
+ // TODO: Pass when sacraping Youtube
6327
6428
  // enableYoutubeTranscript: true,
6328
6429
  // youtubeTranscriptLanguage: 'en',
6329
6430
  })];
@@ -6331,11 +6432,12 @@
6331
6432
  result = _f.sent();
6332
6433
  if (result === null || result === undefined) {
6333
6434
  throw new Error("Markitdown could not convert the \"".concat(source.source, "\""));
6334
- // <- TODO: !!! Make MarkitdownError
6435
+ // <- TODO: [🍀] Make MarkitdownError
6335
6436
  }
6336
- console.log('!!!', { result: result, cacheFilehandler: cacheFilehandler });
6437
+ // console.log('!!', { result, cacheFilehandler });
6337
6438
  return [4 /*yield*/, this.tools.fs.writeFile(cacheFilehandler.filename, result.text_content)];
6338
6439
  case 4:
6440
+ // console.log('!!', { result, cacheFilehandler });
6339
6441
  _f.sent();
6340
6442
  _f.label = 5;
6341
6443
  case 5: return [2 /*return*/, cacheFilehandler];