@promptbook/website-crawler 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 +162 -64
  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 +165 -67
  43. package/umd/index.umd.js.map +1 -1
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  <!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->
2
2
 
3
- # Promptbook
3
+ # Promptbook
4
4
 
5
5
 
6
6
 
@@ -14,19 +14,16 @@
14
14
 
15
15
 
16
16
 
17
- ## New Features
17
+ ## 🌟 New Features
18
18
 
19
+ - 💫 Support of [`o3-mini` model by OpenAI](https://openai.com/index/openai-o3-mini/)
20
+ - 🐋 **Support of [DeepSeek models](https://www.npmjs.com/package/@promptbook/deepseek)**
19
21
  - 💙 Working [the **Book** language v1.0.0](https://github.com/webgptorg/book)
20
22
  - 🖤 Run books from CLI - `npx ptbk run path/to/your/book`
21
- - 📚 Support of `.docx`, `.doc` and `.pdf` documents
22
- - ✨ **Support of [OpenAI o1 model](https://openai.com/o1/)**
23
+ - 📚 Support of `.docx`, `.doc` and `.pdf` documents as knowledge
23
24
 
24
25
 
25
26
 
26
- <blockquote style="color: #ff8811">
27
- <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
28
- </blockquote>
29
-
30
27
  ## 📦 Package `@promptbook/website-crawler`
31
28
 
32
29
  - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -263,8 +260,9 @@ Or you can install them separately:
263
260
  - **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
264
261
  - **[@promptbook/vercel](https://www.npmjs.com/package/@promptbook/vercel)** - Adapter for Vercel functionalities
265
262
  - **[@promptbook/google](https://www.npmjs.com/package/@promptbook/google)** - Integration with Google's Gemini API
263
+ - **[@promptbook/deepseek](https://www.npmjs.com/package/@promptbook/deepseek)** - Integration with [DeepSeek API](https://www.deepseek.com/)
266
264
  - **[@promptbook/azure-openai](https://www.npmjs.com/package/@promptbook/azure-openai)** - Execution tools for Azure OpenAI API
267
- - **[@promptbook/langtail](https://www.npmjs.com/package/@promptbook/langtail)** - Execution tools for Langtail API, wrapper around Langtail SDK
265
+
268
266
  - **[@promptbook/fake-llm](https://www.npmjs.com/package/@promptbook/fake-llm)** - Mocked execution tools for testing the library and saving the tokens
269
267
  - **[@promptbook/remote-client](https://www.npmjs.com/package/@promptbook/remote-client)** - Remote client for remote execution of promptbooks
270
268
  - **[@promptbook/remote-server](https://www.npmjs.com/package/@promptbook/remote-server)** - Remote server for remote execution of promptbooks
@@ -434,6 +432,20 @@ See [TODO.md](./TODO.md)
434
432
 
435
433
 
436
434
 
435
+ ## 🤝 Partners
436
+
437
+ <div style="display: flex; align-items: center; gap: 20px;">
438
+
439
+ <a href="https://promptbook.studio/">
440
+ <img src="./other/design/promptbook-studio-logo.png" alt="Partner 3" height="100">
441
+ </a>
442
+
443
+ <a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
444
+ <img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="100">
445
+ </a>
446
+
447
+ </div>
448
+
437
449
  ## 🖋️ Contributing
438
450
 
439
451
  I am open to pull requests, feedback, and suggestions. Or if you like this utility, you can [☕ buy me a coffee](https://www.buymeacoffee.com/hejny) or [donate via cryptocurrencies](https://github.com/hejny/hejny/blob/main/documents/crypto.md).
package/esm/index.es.js CHANGED
@@ -8,7 +8,8 @@ import { basename, join, dirname } from 'path';
8
8
  import { format } from 'prettier';
9
9
  import parserHtml from 'prettier/parser-html';
10
10
  import { forTime } from 'waitasecond';
11
- import { lookup } from 'mime-types';
11
+ import sha256 from 'crypto-js/sha256';
12
+ import { lookup, extension } from 'mime-types';
12
13
  import { unparse, parse } from 'papaparse';
13
14
  import { Converter } from 'showdown';
14
15
 
@@ -26,7 +27,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
26
27
  * @generated
27
28
  * @see https://github.com/webgptorg/promptbook
28
29
  */
29
- var PROMPTBOOK_ENGINE_VERSION = '0.84.0-8';
30
+ var PROMPTBOOK_ENGINE_VERSION = '0.84.0-21';
30
31
  /**
31
32
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
32
33
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -235,6 +236,12 @@ var ADMIN_GITHUB_NAME = 'hejny';
235
236
  * @public exported from `@promptbook/core`
236
237
  */
237
238
  var DEFAULT_BOOK_TITLE = "\u2728 Untitled Book";
239
+ /**
240
+ * Maximum file size limit
241
+ *
242
+ * @public exported from `@promptbook/core`
243
+ */
244
+ var DEFAULT_MAX_FILE_SIZE = 100 * 1024 * 1024; // 100MB
238
245
  // <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
239
246
  /**
240
247
  * The maximum number of iterations for a loops
@@ -268,6 +275,12 @@ var SMALL_NUMBER = 0.001;
268
275
  * @private within the repository - too low-level in comparison with other `MAX_...`
269
276
  */
270
277
  var IMMEDIATE_TIME = 10;
278
+ /**
279
+ * The maximum length of the (generated) filename
280
+ *
281
+ * @public exported from `@promptbook/core`
282
+ */
283
+ var MAX_FILENAME_LENGTH = 30;
271
284
  /**
272
285
  * Strategy for caching the intermediate results for knowledge sources
273
286
  *
@@ -287,6 +300,15 @@ var DEFAULT_MAX_PARALLEL_COUNT = 5; // <- TODO: [🤹‍♂️]
287
300
  * @public exported from `@promptbook/core`
288
301
  */
289
302
  var DEFAULT_MAX_EXECUTION_ATTEMPTS = 3; // <- TODO: [🤹‍♂️]
303
+ // <- TODO: [🕝] Make also `BOOKS_DIRNAME_ALTERNATIVES`
304
+ /**
305
+ * Where to store the temporary downloads
306
+ *
307
+ * Note: When the folder does not exist, it is created recursively
308
+ *
309
+ * @public exported from `@promptbook/core`
310
+ */
311
+ var DEFAULT_DOWNLOAD_CACHE_DIRNAME = './.promptbook/download-cache';
290
312
  /**
291
313
  * Where to store the scrape cache
292
314
  *
@@ -1119,24 +1141,18 @@ function getScraperIntermediateSource(source, options) {
1119
1141
  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"}];
1120
1142
 
1121
1143
  /**
1122
- * Function isValidJsonString will tell you if the string is valid JSON or not
1144
+ * Checks if value is valid email
1123
1145
  *
1124
1146
  * @public exported from `@promptbook/utils`
1125
1147
  */
1126
- function isValidJsonString(value /* <- [👨‍⚖️] */) {
1127
- try {
1128
- JSON.parse(value);
1129
- return true;
1148
+ function isValidEmail(email) {
1149
+ if (typeof email !== 'string') {
1150
+ return false;
1130
1151
  }
1131
- catch (error) {
1132
- if (!(error instanceof Error)) {
1133
- throw error;
1134
- }
1135
- if (error.message.includes('Unexpected token')) {
1136
- return false;
1137
- }
1152
+ if (email.split('\n').length > 1) {
1138
1153
  return false;
1139
1154
  }
1155
+ return /^.+@.+\..+$/.test(email);
1140
1156
  }
1141
1157
 
1142
1158
  /**
@@ -1158,6 +1174,27 @@ var ParseError = /** @class */ (function (_super) {
1158
1174
  * TODO: Maybe split `ParseError` and `ApplyError`
1159
1175
  */
1160
1176
 
1177
+ /**
1178
+ * Function isValidJsonString will tell you if the string is valid JSON or not
1179
+ *
1180
+ * @public exported from `@promptbook/utils`
1181
+ */
1182
+ function isValidJsonString(value /* <- [👨‍⚖️] */) {
1183
+ try {
1184
+ JSON.parse(value);
1185
+ return true;
1186
+ }
1187
+ catch (error) {
1188
+ if (!(error instanceof Error)) {
1189
+ throw error;
1190
+ }
1191
+ if (error.message.includes('Unexpected token')) {
1192
+ return false;
1193
+ }
1194
+ return false;
1195
+ }
1196
+ }
1197
+
1161
1198
  /**
1162
1199
  * Function `validatePipelineString` will validate the if the string is a valid pipeline string
1163
1200
  * 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.
@@ -1171,6 +1208,15 @@ function validatePipelineString(pipelineString) {
1171
1208
  if (isValidJsonString(pipelineString)) {
1172
1209
  throw new ParseError('Expected a book, but got a JSON string');
1173
1210
  }
1211
+ else if (isValidUrl(pipelineString)) {
1212
+ throw new ParseError("Expected a book, but got just the URL \"".concat(pipelineString, "\""));
1213
+ }
1214
+ else if (isValidFilePath(pipelineString)) {
1215
+ throw new ParseError("Expected a book, but got just the file path \"".concat(pipelineString, "\""));
1216
+ }
1217
+ else if (isValidEmail(pipelineString)) {
1218
+ throw new ParseError("Expected a book, but got just the email \"".concat(pipelineString, "\""));
1219
+ }
1174
1220
  // <- TODO: Implement the validation + add tests when the pipeline logic considered as invalid
1175
1221
  return pipelineString;
1176
1222
  }
@@ -2498,12 +2544,28 @@ function deserializeError(error) {
2498
2544
  /**
2499
2545
  * Asserts that the execution of a Promptbook is successful
2500
2546
  *
2547
+ * Note: If there are only warnings, the execution is still successful but the warnings are logged in the console
2548
+ *
2501
2549
  * @param executionResult - The partial result of the Promptbook execution
2502
2550
  * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
2503
2551
  * @public exported from `@promptbook/core`
2504
2552
  */
2505
2553
  function assertsExecutionSuccessful(executionResult) {
2506
- var isSuccessful = executionResult.isSuccessful, errors = executionResult.errors;
2554
+ var e_1, _a;
2555
+ var isSuccessful = executionResult.isSuccessful, errors = executionResult.errors, warnings = executionResult.warnings;
2556
+ try {
2557
+ for (var warnings_1 = __values(warnings), warnings_1_1 = warnings_1.next(); !warnings_1_1.done; warnings_1_1 = warnings_1.next()) {
2558
+ var warning = warnings_1_1.value;
2559
+ console.warn(warning.message);
2560
+ }
2561
+ }
2562
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
2563
+ finally {
2564
+ try {
2565
+ if (warnings_1_1 && !warnings_1_1.done && (_a = warnings_1.return)) _a.call(warnings_1);
2566
+ }
2567
+ finally { if (e_1) throw e_1.error; }
2568
+ }
2507
2569
  if (isSuccessful === true) {
2508
2570
  return;
2509
2571
  }
@@ -3140,7 +3202,7 @@ var MultipleLlmExecutionTools = /** @class */ (function () {
3140
3202
  if (!(error_1 instanceof Error) || error_1 instanceof UnexpectedError) {
3141
3203
  throw error_1;
3142
3204
  }
3143
- errors.push(error_1);
3205
+ errors.push({ llmExecutionTools: llmExecutionTools, error: error_1 });
3144
3206
  return [3 /*break*/, 13];
3145
3207
  case 13:
3146
3208
  _b = _a.next();
@@ -3167,7 +3229,10 @@ var MultipleLlmExecutionTools = /** @class */ (function () {
3167
3229
  // 2) AnthropicClaude throw PipelineExecutionError: Parameter `{knowledge}` is not defined
3168
3230
  // 3) ...
3169
3231
  spaceTrim$1(function (block) { return "\n All execution tools failed:\n\n ".concat(block(errors
3170
- .map(function (error, i) { return "".concat(i + 1, ") **").concat(error.name || 'Error', ":** ").concat(error.message); })
3232
+ .map(function (_a, i) {
3233
+ var error = _a.error, llmExecutionTools = _a.llmExecutionTools;
3234
+ return "".concat(i + 1, ") **").concat(llmExecutionTools.title, "** thrown **").concat(error.name || 'Error', ":** ").concat(error.message);
3235
+ })
3171
3236
  .join('\n')), "\n\n "); }));
3172
3237
  }
3173
3238
  else if (this.llmExecutionTools.length === 0) {
@@ -3534,6 +3599,17 @@ function isFileExisting(filename, fs) {
3534
3599
  * TODO: [🖇] What about symlinks?
3535
3600
  */
3536
3601
 
3602
+ /**
3603
+ * Convert mime type to file extension
3604
+ *
3605
+ * Note: If the mime type is invalid, `null` is returned
3606
+ *
3607
+ * @private within the repository
3608
+ */
3609
+ function mimeTypeToExtension(value) {
3610
+ return extension(value) || null;
3611
+ }
3612
+
3537
3613
  /**
3538
3614
  * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
3539
3615
  *
@@ -3569,9 +3645,9 @@ var scraperFetch = function (url, init) { return __awaiter(void 0, void 0, void
3569
3645
  function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
3570
3646
  var _a;
3571
3647
  return __awaiter(this, void 0, void 0, function () {
3572
- var _b, fetch, knowledgeSourceContent, name, _c, _d, rootDirname, url, response_1, mimeType, filename_1, fileExtension, mimeType;
3573
- return __generator(this, function (_f) {
3574
- switch (_f.label) {
3648
+ var _b, fetch, knowledgeSourceContent, name, _c, _d, rootDirname, url, response_1, mimeType, basename, hash, rootDirname_1, filepath, fileContent, _f, _g, filename_1, fileExtension, mimeType;
3649
+ return __generator(this, function (_h) {
3650
+ switch (_h.label) {
3575
3651
  case 0:
3576
3652
  _b = tools.fetch, fetch = _b === void 0 ? scraperFetch : _b;
3577
3653
  knowledgeSourceContent = knowledgeSource.knowledgeSourceContent;
@@ -3580,54 +3656,76 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
3580
3656
  if (!name) {
3581
3657
  name = knowledgeSourceContentToName(knowledgeSourceContent);
3582
3658
  }
3583
- if (!isValidUrl(knowledgeSourceContent)) return [3 /*break*/, 2];
3659
+ if (!isValidUrl(knowledgeSourceContent)) return [3 /*break*/, 5];
3584
3660
  url = knowledgeSourceContent;
3585
3661
  return [4 /*yield*/, fetch(url)];
3586
3662
  case 1:
3587
- response_1 = _f.sent();
3663
+ response_1 = _h.sent();
3588
3664
  mimeType = ((_a = response_1.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.split(';')[0]) || 'text/html';
3589
- return [2 /*return*/, {
3590
- source: name,
3591
- filename: null,
3592
- url: url,
3593
- mimeType: mimeType,
3594
- /*
3595
- TODO: [🥽]
3596
- > async asBlob() {
3597
- > // TODO: [👨🏻‍🤝‍👨🏻] This can be called multiple times BUT when called second time, response in already consumed
3598
- > const content = await response.blob();
3599
- > return content;
3600
- > },
3601
- */
3602
- asJson: function () {
3603
- return __awaiter(this, void 0, void 0, function () {
3604
- var content;
3605
- return __generator(this, function (_a) {
3606
- switch (_a.label) {
3607
- case 0: return [4 /*yield*/, response_1.json()];
3608
- case 1:
3609
- content = _a.sent();
3610
- return [2 /*return*/, content];
3611
- }
3665
+ if (tools.fs === undefined || !url.endsWith('.pdf' /* <- TODO: [💵] */)) {
3666
+ return [2 /*return*/, {
3667
+ source: name,
3668
+ filename: null,
3669
+ url: url,
3670
+ mimeType: mimeType,
3671
+ /*
3672
+ TODO: [🥽]
3673
+ > async asBlob() {
3674
+ > // TODO: [👨🏻‍🤝‍👨🏻] This can be called multiple times BUT when called second time, response in already consumed
3675
+ > const content = await response.blob();
3676
+ > return content;
3677
+ > },
3678
+ */
3679
+ asJson: function () {
3680
+ return __awaiter(this, void 0, void 0, function () {
3681
+ var content;
3682
+ return __generator(this, function (_a) {
3683
+ switch (_a.label) {
3684
+ case 0: return [4 /*yield*/, response_1.json()];
3685
+ case 1:
3686
+ content = _a.sent();
3687
+ return [2 /*return*/, content];
3688
+ }
3689
+ });
3612
3690
  });
3613
- });
3614
- },
3615
- asText: function () {
3616
- return __awaiter(this, void 0, void 0, function () {
3617
- var content;
3618
- return __generator(this, function (_a) {
3619
- switch (_a.label) {
3620
- case 0: return [4 /*yield*/, response_1.text()];
3621
- case 1:
3622
- content = _a.sent();
3623
- return [2 /*return*/, content];
3624
- }
3691
+ },
3692
+ asText: function () {
3693
+ return __awaiter(this, void 0, void 0, function () {
3694
+ var content;
3695
+ return __generator(this, function (_a) {
3696
+ switch (_a.label) {
3697
+ case 0: return [4 /*yield*/, response_1.text()];
3698
+ case 1:
3699
+ content = _a.sent();
3700
+ return [2 /*return*/, content];
3701
+ }
3702
+ });
3625
3703
  });
3626
- });
3627
- },
3628
- }];
3704
+ },
3705
+ }];
3706
+ }
3707
+ basename = url.split('/').pop() || titleToName(url);
3708
+ hash = sha256(hexEncoder.parse(url)).toString( /* hex */);
3709
+ rootDirname_1 = join(process.cwd(), DEFAULT_DOWNLOAD_CACHE_DIRNAME);
3710
+ filepath = 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));
3711
+ return [4 /*yield*/, tools.fs.mkdir(dirname(join(rootDirname_1, filepath)), { recursive: true })];
3629
3712
  case 2:
3630
- if (!isValidFilePath(knowledgeSourceContent)) return [3 /*break*/, 4];
3713
+ _h.sent();
3714
+ _g = (_f = Buffer).from;
3715
+ return [4 /*yield*/, response_1.arrayBuffer()];
3716
+ case 3:
3717
+ fileContent = _g.apply(_f, [_h.sent()]);
3718
+ if (fileContent.length > DEFAULT_MAX_FILE_SIZE /* <- TODO: Allow to pass different value to remote server */) {
3719
+ 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."));
3720
+ }
3721
+ return [4 /*yield*/, tools.fs.writeFile(join(rootDirname_1, filepath), fileContent)];
3722
+ case 4:
3723
+ _h.sent();
3724
+ // TODO: [💵] Check the file security
3725
+ // TODO: [🧹][🧠] Delete the file after the scraping is done
3726
+ return [2 /*return*/, makeKnowledgeSourceHandler({ name: name, knowledgeSourceContent: filepath }, tools, __assign(__assign({}, options), { rootDirname: rootDirname_1 }))];
3727
+ case 5:
3728
+ if (!isValidFilePath(knowledgeSourceContent)) return [3 /*break*/, 7];
3631
3729
  if (tools.fs === undefined) {
3632
3730
  throw new EnvironmentMismatchError('Can not import file knowledge without filesystem tools');
3633
3731
  // <- TODO: [🧠] What is the best error type here`
@@ -3640,8 +3738,8 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
3640
3738
  fileExtension = getFileExtension(filename_1);
3641
3739
  mimeType = extensionToMimeType(fileExtension || '');
3642
3740
  return [4 /*yield*/, isFileExisting(filename_1, tools.fs)];
3643
- case 3:
3644
- if (!(_f.sent())) {
3741
+ case 6:
3742
+ if (!(_h.sent())) {
3645
3743
  throw new NotFoundError(spaceTrim$1(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 "); }));
3646
3744
  }
3647
3745
  // TODO: [🧠][😿] Test security file - file is scoped to the project (BUT maybe do this in `filesystemTools`)
@@ -3687,7 +3785,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
3687
3785
  });
3688
3786
  },
3689
3787
  }];
3690
- case 4: return [2 /*return*/, {
3788
+ case 7: return [2 /*return*/, {
3691
3789
  source: name,
3692
3790
  filename: null,
3693
3791
  url: null,