@promptbook/pdf 0.80.0 → 0.81.0-12

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 +8 -1
  2. package/esm/index.es.js +179 -23
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/books/index.d.ts +15 -0
  5. package/esm/typings/src/_packages/core.index.d.ts +2 -6
  6. package/esm/typings/src/_packages/editable.index.d.ts +10 -0
  7. package/esm/typings/src/_packages/templates.index.d.ts +4 -0
  8. package/esm/typings/src/_packages/types.index.d.ts +6 -0
  9. package/esm/typings/src/_packages/utils.index.d.ts +12 -2
  10. package/esm/typings/src/_packages/wizzard.index.d.ts +44 -0
  11. package/esm/typings/src/config.d.ts +26 -0
  12. package/esm/typings/src/execution/ExecutionTools.d.ts +7 -0
  13. package/esm/typings/src/execution/PipelineExecutor.d.ts +2 -2
  14. package/esm/typings/src/execution/PromptbookFetch.d.ts +5 -0
  15. package/esm/typings/src/execution/PromptbookFetch.test-type.d.ts +5 -0
  16. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +2 -2
  17. package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts +2 -1
  18. package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts +2 -1
  19. package/esm/typings/src/high-level-abstractions/index.d.ts +10 -0
  20. package/esm/typings/src/llm-providers/_common/register/{$provideLlmToolsForCli.d.ts → $provideLlmToolsForWizzardOrCli.d.ts} +2 -2
  21. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +1 -0
  22. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +2 -0
  23. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +1 -0
  24. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +1 -0
  25. package/esm/typings/src/llm-providers/google/register-configuration.d.ts +1 -0
  26. package/esm/typings/src/llm-providers/google/register-constructor.d.ts +1 -0
  27. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +2 -0
  28. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +2 -0
  29. package/esm/typings/src/other/templates/getBookTemplate.d.ts +19 -0
  30. package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts +10 -0
  31. package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts +10 -0
  32. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +1 -1
  33. package/esm/typings/src/scrapers/_common/utils/scraperFetch.d.ts +10 -0
  34. package/esm/typings/src/scrapers/document/register-constructor.d.ts +1 -0
  35. package/esm/typings/src/scrapers/document/register-metadata.d.ts +1 -0
  36. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +1 -0
  37. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +1 -0
  38. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +1 -0
  39. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +1 -0
  40. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +1 -0
  41. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +1 -0
  42. package/esm/typings/src/scrapers/website/register-constructor.d.ts +1 -0
  43. package/esm/typings/src/scrapers/website/register-metadata.d.ts +1 -0
  44. package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +1 -0
  45. package/esm/typings/src/types/typeAliases.d.ts +8 -0
  46. package/esm/typings/src/utils/editable/types/PipelineEditableSerialized.d.ts +27 -0
  47. package/esm/typings/src/{conversion → utils/editable}/utils/removePipelineCommand.d.ts +3 -3
  48. package/esm/typings/src/{conversion → utils/editable}/utils/renamePipelineParameter.d.ts +3 -3
  49. package/esm/typings/src/{conversion → utils/editable}/utils/stringifyPipelineJson.d.ts +2 -2
  50. package/esm/typings/src/utils/parameters/numberToString.d.ts +7 -0
  51. package/esm/typings/src/utils/parameters/{replaceParameters.d.ts → templateParameters.d.ts} +6 -2
  52. package/esm/typings/src/utils/parameters/valueToString.d.ts +17 -0
  53. package/esm/typings/src/utils/parameters/valueToString.test.d.ts +1 -0
  54. package/esm/typings/src/utils/serialization/asSerializable.d.ts +4 -0
  55. package/esm/typings/src/utils/validators/filePath/isPathRoot.d.ts +12 -0
  56. package/esm/typings/src/utils/validators/filePath/isPathRoot.test.d.ts +4 -0
  57. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +3 -0
  58. package/esm/typings/src/version.d.ts +7 -0
  59. package/esm/typings/src/wizzard/$getCompiledBook.d.ts +16 -0
  60. package/esm/typings/src/wizzard/wizzard.d.ts +51 -0
  61. package/package.json +2 -2
  62. package/umd/index.umd.js +179 -23
  63. package/umd/index.umd.js.map +1 -1
  64. package/esm/typings/src/scripting/javascript/utils/unknownToString.d.ts +0 -8
  65. package/esm/typings/src/utils/formatNumber.d.ts +0 -6
  66. /package/esm/typings/src/{conversion → utils/editable}/utils/removePipelineCommand.test.d.ts +0 -0
  67. /package/esm/typings/src/{conversion → utils/editable}/utils/renamePipelineParameter.test.d.ts +0 -0
  68. /package/esm/typings/src/{conversion → utils/editable}/utils/stringifyPipelineJson.test.d.ts +0 -0
  69. /package/esm/typings/src/utils/{formatNumber.test.d.ts → parameters/numberToString.test.d.ts} +0 -0
  70. /package/esm/typings/src/utils/parameters/{replaceParameters.test.d.ts → templateParameters.test.d.ts} +0 -0
package/README.md CHANGED
@@ -23,6 +23,10 @@
23
23
 
24
24
 
25
25
 
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
+
26
30
  ## 📦 Package `@promptbook/pdf`
27
31
 
28
32
  - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -229,6 +233,7 @@ Or you can install them separately:
229
233
 
230
234
  - ⭐ **[ptbk](https://www.npmjs.com/package/ptbk)** - Bundle of all packages, when you want to install everything and you don't care about the size
231
235
  - **[promptbook](https://www.npmjs.com/package/promptbook)** - Same as `ptbk`
236
+ - ⭐🧙‍♂️ **[@promptbook/wizzard](https://www.npmjs.com/package/@promptbook/wizzard)** - Wizzard to just run the books in node without any struggle
232
237
  - **[@promptbook/core](https://www.npmjs.com/package/@promptbook/core)** - Core of the library, it contains the main logic for promptbooks
233
238
  - **[@promptbook/node](https://www.npmjs.com/package/@promptbook/node)** - Core of the library for Node.js environment
234
239
  - **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
@@ -249,8 +254,10 @@ Or you can install them separately:
249
254
  - **[@promptbook/documents](https://www.npmjs.com/package/@promptbook/documents)** - Read knowledge from documents like `.docx`, `.odt`,…
250
255
  - **[@promptbook/legacy-documents](https://www.npmjs.com/package/@promptbook/legacy-documents)** - Read knowledge from legacy documents like `.doc`, `.rtf`,…
251
256
  - **[@promptbook/website-crawler](https://www.npmjs.com/package/@promptbook/website-crawler)** - Crawl knowledge from the web
257
+ - **[@promptbook/editable](https://www.npmjs.com/package/@promptbook/editable)** - Editable book as native javascript object with imperative object API
258
+ - **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Usefull templates and examples of books which can be used as a starting point
252
259
  - **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
253
- - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
260
+ - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
254
261
 
255
262
 
256
263
 
package/esm/index.es.js CHANGED
@@ -12,15 +12,17 @@ import { unparse, parse } from 'papaparse';
12
12
  /**
13
13
  * The version of the Book language
14
14
  *
15
+ * @generated
15
16
  * @see https://github.com/webgptorg/book
16
17
  */
17
18
  var BOOK_LANGUAGE_VERSION = '1.0.0';
18
19
  /**
19
20
  * The version of the Promptbook engine
20
21
  *
22
+ * @generated
21
23
  * @see https://github.com/webgptorg/promptbook
22
24
  */
23
- var PROMPTBOOK_ENGINE_VERSION = '0.80.0-1';
25
+ var PROMPTBOOK_ENGINE_VERSION = '0.81.0-11';
24
26
  /**
25
27
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
26
28
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -174,7 +176,7 @@ var NotYetImplementedError = /** @class */ (function (_super) {
174
176
  function TODO_USE() {
175
177
  }
176
178
 
177
- 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:[],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:[],sourceFile:"./books/prepare-knowledge-keywords.book.md"},{title:"Prepare 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- Title should be concise and clear\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:[],sourceFile:"./books/prepare-knowledge-title.book.md"},{title:"Prepare Keywords",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:[],sourceFile:"./books/prepare-persona.book.md"}];
179
+ 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 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- Title should be concise and clear\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 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- Title should be concise and clear\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 Keywords",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 Keywords\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"}];
178
180
 
179
181
  /**
180
182
  * Prettify the html code
@@ -473,6 +475,26 @@ var ADMIN_GITHUB_NAME = 'hejny';
473
475
  * @private within the repository - too low-level in comparison with other `MAX_...`
474
476
  */
475
477
  var LOOP_LIMIT = 1000;
478
+ /**
479
+ * Strings to represent various values in the context of parameter values
480
+ *
481
+ * @public exported from `@promptbook/utils`
482
+ */
483
+ var VALUE_STRINGS = {
484
+ empty: '(nothing; empty string)',
485
+ null: '(no value; null)',
486
+ undefined: '(unknown value; undefined)',
487
+ nan: '(not a number; NaN)',
488
+ infinity: '(infinity; ∞)',
489
+ negativeInfinity: '(negative infinity; -∞)',
490
+ unserializable: '(unserializable value)',
491
+ };
492
+ /**
493
+ * Small number limit
494
+ *
495
+ * @public exported from `@promptbook/utils`
496
+ */
497
+ var SMALL_NUMBER = 0.001;
476
498
  /**
477
499
  * Short time interval to prevent race conditions in milliseconds
478
500
  *
@@ -718,7 +740,7 @@ function checkSerializableAsJson(options) {
718
740
  if (!(error instanceof Error)) {
719
741
  throw error;
720
742
  }
721
- throw new UnexpectedError(spaceTrim$1(function (block) { return "\n `".concat(name, "` is not serializable\n\n ").concat(block(error.toString()), "\n\n Additional message for `").concat(name, "`:\n ").concat(block(message || '(nothing)'), "\n "); }));
743
+ throw new UnexpectedError(spaceTrim$1(function (block) { return "\n `".concat(name, "` is not serializable\n\n ").concat(block(error.stack || error.message), "\n\n Additional message for `").concat(name, "`:\n ").concat(block(message || '(nothing)'), "\n "); }));
722
744
  }
723
745
  /*
724
746
  TODO: [0] Is there some more elegant way to check circular references?
@@ -816,6 +838,7 @@ function exportJson(options) {
816
838
  * @public exported from `@promptbook/core`
817
839
  */
818
840
  var ORDER_OF_PIPELINE_JSON = [
841
+ // Note: [🍙] In this order will be pipeline serialized
819
842
  'title',
820
843
  'pipelineUrl',
821
844
  'bookVersion',
@@ -827,6 +850,7 @@ var ORDER_OF_PIPELINE_JSON = [
827
850
  'preparations',
828
851
  'knowledgeSources',
829
852
  'knowledgePieces',
853
+ 'sources', // <- TODO: [🧠] Where should the `sources` be
830
854
  ];
831
855
  /**
832
856
  * Nonce which is used for replacing things in strings
@@ -1043,9 +1067,6 @@ function isValidPipelineUrl(url) {
1043
1067
  if (!url.startsWith('https://')) {
1044
1068
  return false;
1045
1069
  }
1046
- if (!(url.endsWith('.book.md') || url.endsWith('.book') || url.endsWith('.book.md') || url.endsWith('.ptbk'))) {
1047
- return false;
1048
- }
1049
1070
  if (url.includes('#')) {
1050
1071
  // TODO: [🐠]
1051
1072
  return false;
@@ -1823,6 +1844,81 @@ function isPipelinePrepared(pipeline) {
1823
1844
  * - [♨] Are tasks prepared
1824
1845
  */
1825
1846
 
1847
+ /**
1848
+ * Format either small or big number
1849
+ *
1850
+ * @public exported from `@promptbook/utils`
1851
+ */
1852
+ function numberToString(value) {
1853
+ if (value === 0) {
1854
+ return '0';
1855
+ }
1856
+ else if (Number.isNaN(value)) {
1857
+ return VALUE_STRINGS.nan;
1858
+ }
1859
+ else if (value === Infinity) {
1860
+ return VALUE_STRINGS.infinity;
1861
+ }
1862
+ else if (value === -Infinity) {
1863
+ return VALUE_STRINGS.negativeInfinity;
1864
+ }
1865
+ for (var exponent = 0; exponent < 15; exponent++) {
1866
+ var factor = Math.pow(10, exponent);
1867
+ var valueRounded = Math.round(value * factor) / factor;
1868
+ if (Math.abs(value - valueRounded) / value < SMALL_NUMBER) {
1869
+ return valueRounded.toFixed(exponent);
1870
+ }
1871
+ }
1872
+ return value.toString();
1873
+ }
1874
+
1875
+ /**
1876
+ * Function `valueToString` will convert the given value to string
1877
+ * This is useful and used in the `templateParameters` function
1878
+ *
1879
+ * Note: This function is not just calling `toString` method
1880
+ * It's more complex and can handle this conversion specifically for LLM models
1881
+ * See `VALUE_STRINGS`
1882
+ *
1883
+ * Note: There are 2 similar functions
1884
+ * - `valueToString` converts value to string for LLM models as human-readable string
1885
+ * - `asSerializable` converts value to string to preserve full information to be able to convert it back
1886
+ *
1887
+ * @public exported from `@promptbook/utils`
1888
+ */
1889
+ function valueToString(value) {
1890
+ try {
1891
+ if (value === '') {
1892
+ return VALUE_STRINGS.empty;
1893
+ }
1894
+ else if (value === null) {
1895
+ return VALUE_STRINGS.null;
1896
+ }
1897
+ else if (value === undefined) {
1898
+ return VALUE_STRINGS.undefined;
1899
+ }
1900
+ else if (typeof value === 'string') {
1901
+ return value;
1902
+ }
1903
+ else if (typeof value === 'number') {
1904
+ return numberToString(value);
1905
+ }
1906
+ else if (value instanceof Date) {
1907
+ return value.toISOString();
1908
+ }
1909
+ else {
1910
+ return JSON.stringify(value);
1911
+ }
1912
+ }
1913
+ catch (error) {
1914
+ if (!(error instanceof Error)) {
1915
+ throw error;
1916
+ }
1917
+ console.error(error);
1918
+ return VALUE_STRINGS.unserializable;
1919
+ }
1920
+ }
1921
+
1826
1922
  /**
1827
1923
  * Serializes an error into a [🚉] JSON-serializable object
1828
1924
  *
@@ -3202,21 +3298,71 @@ function isValidFilePath(filename) {
3202
3298
  if (typeof filename !== 'string') {
3203
3299
  return false;
3204
3300
  }
3301
+ if (filename.split('\n').length > 1) {
3302
+ return false;
3303
+ }
3304
+ if (filename.split(' ').length >
3305
+ 5 /* <- TODO: [🧠][🈷] Make some better non-arbitrary way how to distinct filenames from informational texts */) {
3306
+ return false;
3307
+ }
3205
3308
  var filenameSlashes = filename.split('\\').join('/');
3206
3309
  // Absolute Unix path: /hello.txt
3207
3310
  if (/^(\/)/i.test(filenameSlashes)) {
3311
+ // console.log(filename, 'Absolute Unix path: /hello.txt');
3208
3312
  return true;
3209
3313
  }
3210
3314
  // Absolute Windows path: /hello.txt
3211
3315
  if (/^([A-Z]{1,2}:\/?)\//i.test(filenameSlashes)) {
3316
+ // console.log(filename, 'Absolute Windows path: /hello.txt');
3212
3317
  return true;
3213
3318
  }
3214
3319
  // Relative path: ./hello.txt
3215
3320
  if (/^(\.\.?\/)+/i.test(filenameSlashes)) {
3321
+ // console.log(filename, 'Relative path: ./hello.txt');
3322
+ return true;
3323
+ }
3324
+ // Allow paths like foo/hello
3325
+ if (/^[^/]+\/[^/]+/i.test(filenameSlashes)) {
3326
+ // console.log(filename, 'Allow paths like foo/hello');
3327
+ return true;
3328
+ }
3329
+ // Allow paths like hello.book
3330
+ if (/^[^/]+\.[^/]+$/i.test(filenameSlashes)) {
3331
+ // console.log(filename, 'Allow paths like hello.book');
3216
3332
  return true;
3217
3333
  }
3218
3334
  return false;
3219
3335
  }
3336
+ /**
3337
+ * TODO: [🍏] Implement for MacOs
3338
+ */
3339
+
3340
+ /**
3341
+ * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
3342
+ *
3343
+ * @private as default `fetch` function used in Promptbook scrapers
3344
+ */
3345
+ var scraperFetch = function (url, init) { return __awaiter(void 0, void 0, void 0, function () {
3346
+ var error_1;
3347
+ return __generator(this, function (_a) {
3348
+ switch (_a.label) {
3349
+ case 0:
3350
+ _a.trys.push([0, 2, , 3]);
3351
+ return [4 /*yield*/, fetch(url, init)];
3352
+ case 1: return [2 /*return*/, _a.sent()];
3353
+ case 2:
3354
+ error_1 = _a.sent();
3355
+ if (!(error_1 instanceof Error)) {
3356
+ throw error_1;
3357
+ }
3358
+ throw new KnowledgeScrapeError(spaceTrim$1(function (block) { return "\n Can not fetch \"".concat(url, "\"\n\n Fetch error:\n ").concat(block(error_1.message), "\n\n "); }));
3359
+ case 3: return [2 /*return*/];
3360
+ }
3361
+ });
3362
+ }); };
3363
+ /**
3364
+ * TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
3365
+ */
3220
3366
 
3221
3367
  /**
3222
3368
  * @@@
@@ -3226,13 +3372,14 @@ function isValidFilePath(filename) {
3226
3372
  function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
3227
3373
  var _a;
3228
3374
  return __awaiter(this, void 0, void 0, function () {
3229
- var sourceContent, name, _b, _c, rootDirname, url, response_1, mimeType, filename_1, fileExtension, mimeType;
3230
- return __generator(this, function (_e) {
3231
- switch (_e.label) {
3375
+ var _b, fetch, sourceContent, name, _c, _d, rootDirname, url, response_1, mimeType, filename_1, fileExtension, mimeType;
3376
+ return __generator(this, function (_f) {
3377
+ switch (_f.label) {
3232
3378
  case 0:
3379
+ _b = tools.fetch, fetch = _b === void 0 ? scraperFetch : _b;
3233
3380
  sourceContent = knowledgeSource.sourceContent;
3234
3381
  name = knowledgeSource.name;
3235
- _b = options || {}, _c = _b.rootDirname, rootDirname = _c === void 0 ? null : _c, _b.isVerbose;
3382
+ _c = options || {}, _d = _c.rootDirname, rootDirname = _d === void 0 ? null : _d, _c.isVerbose;
3236
3383
  if (!name) {
3237
3384
  name = sourceContentToName(sourceContent);
3238
3385
  }
@@ -3240,7 +3387,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
3240
3387
  url = sourceContent;
3241
3388
  return [4 /*yield*/, fetch(url)];
3242
3389
  case 1:
3243
- response_1 = _e.sent();
3390
+ response_1 = _f.sent();
3244
3391
  mimeType = ((_a = response_1.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.split(';')[0]) || 'text/html';
3245
3392
  return [2 /*return*/, {
3246
3393
  source: name,
@@ -3283,7 +3430,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
3283
3430
  },
3284
3431
  }];
3285
3432
  case 2:
3286
- if (!(isValidFilePath(sourceContent) || /\.[a-z]{1,10}$/i.exec(sourceContent))) return [3 /*break*/, 4];
3433
+ if (!isValidFilePath(sourceContent)) return [3 /*break*/, 4];
3287
3434
  if (tools.fs === undefined) {
3288
3435
  throw new EnvironmentMismatchError('Can not import file knowledge without filesystem tools');
3289
3436
  // <- TODO: [🧠] What is the best error type here`
@@ -3297,8 +3444,8 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
3297
3444
  mimeType = extensionToMimeType(fileExtension || '');
3298
3445
  return [4 /*yield*/, isFileExisting(filename_1, tools.fs)];
3299
3446
  case 3:
3300
- if (!(_e.sent())) {
3301
- 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(filename_1), "\n "); }));
3447
+ if (!(_f.sent())) {
3448
+ 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(sourceContent), "\n\n Full file path:\n ").concat(block(filename_1), "\n "); }));
3302
3449
  }
3303
3450
  // TODO: [🧠][😿] Test security file - file is scoped to the project (BUT maybe do this in `filesystemTools`)
3304
3451
  return [2 /*return*/, {
@@ -3706,7 +3853,7 @@ function extractVariablesFromScript(script) {
3706
3853
  if (!(error instanceof Error)) {
3707
3854
  throw error;
3708
3855
  }
3709
- throw new ParseError(spaceTrim(function (block) { return "\n Can not extract variables from the script\n\n ".concat(block(error.toString()), "}\n\n\n Found variables:\n\n ").concat(Array.from(variables)
3856
+ throw new ParseError(spaceTrim(function (block) { return "\n Can not extract variables from the script\n ".concat(block(error.stack || error.message), "\n\n Found variables:\n ").concat(Array.from(variables)
3710
3857
  .map(function (variableName, i) { return "".concat(i + 1, ") ").concat(variableName); })
3711
3858
  .join('\n'), "\n\n\n The script:\n\n ```javascript\n ").concat(block(originalScript), "\n ```\n "); }));
3712
3859
  }
@@ -4328,13 +4475,16 @@ function extractJsonBlock(markdown) {
4328
4475
  /**
4329
4476
  * Replaces parameters in template with values from parameters object
4330
4477
  *
4478
+ * Note: This function is not places strings into string,
4479
+ * It's more complex and can handle this operation specifically for LLM models
4480
+ *
4331
4481
  * @param template the template with parameters in {curly} braces
4332
4482
  * @param parameters the object with parameters
4333
4483
  * @returns the template with replaced parameters
4334
4484
  * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
4335
4485
  * @public exported from `@promptbook/utils`
4336
4486
  */
4337
- function replaceParameters(template, parameters) {
4487
+ function templateParameters(template, parameters) {
4338
4488
  var e_1, _a;
4339
4489
  try {
4340
4490
  for (var _b = __values(Object.entries(parameters)), _c = _b.next(); !_c.done; _c = _b.next()) {
@@ -4360,7 +4510,7 @@ function replaceParameters(template, parameters) {
4360
4510
  var loopLimit = LOOP_LIMIT;
4361
4511
  var _loop_1 = function () {
4362
4512
  if (loopLimit-- < 0) {
4363
- throw new LimitReachedError('Loop limit reached during parameters replacement in `replaceParameters`');
4513
+ throw new LimitReachedError('Loop limit reached during parameters replacement in `templateParameters`');
4364
4514
  }
4365
4515
  var precol = match.groups.precol;
4366
4516
  var parameterName = match.groups.parameterName;
@@ -4377,7 +4527,7 @@ function replaceParameters(template, parameters) {
4377
4527
  if (parameterValue === undefined) {
4378
4528
  throw new PipelineExecutionError("Parameter `{".concat(parameterName, "}` is not defined"));
4379
4529
  }
4380
- parameterValue = parameterValue.toString();
4530
+ parameterValue = valueToString(parameterValue);
4381
4531
  if (parameterValue.includes('\n') && /^\s*\W{0,3}\s*$/.test(precol)) {
4382
4532
  parameterValue = parameterValue
4383
4533
  .split('\n')
@@ -4612,7 +4762,7 @@ function executeAttempts(options) {
4612
4762
  }
4613
4763
  return [3 /*break*/, 24];
4614
4764
  case 2:
4615
- $ongoingTaskResult.$resultString = replaceParameters(preparedContent, parameters);
4765
+ $ongoingTaskResult.$resultString = templateParameters(preparedContent, parameters);
4616
4766
  return [3 /*break*/, 25];
4617
4767
  case 3:
4618
4768
  modelRequirements = __assign(__assign({ modelVariant: 'CHAT' }, (preparedPipeline.defaultModelRequirements || {})), (task.modelRequirements || {}));
@@ -4735,8 +4885,8 @@ function executeAttempts(options) {
4735
4885
  _j = $ongoingTaskResult;
4736
4886
  return [4 /*yield*/, tools.userInterface.promptDialog($deepFreeze({
4737
4887
  promptTitle: task.title,
4738
- promptMessage: replaceParameters(task.description || '', parameters),
4739
- defaultValue: replaceParameters(preparedContent, parameters),
4888
+ promptMessage: templateParameters(task.description || '', parameters),
4889
+ defaultValue: templateParameters(preparedContent, parameters),
4740
4890
  // TODO: [🧠] !! Figure out how to define placeholder in .book.md file
4741
4891
  placeholder: undefined,
4742
4892
  priority: priority,
@@ -4860,7 +5010,7 @@ function executeAttempts(options) {
4860
5010
  if (!isJokerAttempt &&
4861
5011
  task.taskType === 'PROMPT_TASK' &&
4862
5012
  $ongoingTaskResult.$prompt
4863
- // <- Note: [2] When some expected parameter is not defined, error will occur in replaceParameters
5013
+ // <- Note: [2] When some expected parameter is not defined, error will occur in templateParameters
4864
5014
  // In that case we don’t want to make a report about it because it’s not a llm execution error
4865
5015
  ) {
4866
5016
  // TODO: [🧠] Maybe put other taskTypes into report
@@ -5437,7 +5587,10 @@ function executePipeline(options) {
5437
5587
  finally { if (e_2) throw e_2.error; }
5438
5588
  return [7 /*endfinally*/];
5439
5589
  case 19:
5440
- parametersToPass = inputParameters;
5590
+ parametersToPass = Object.fromEntries(Object.entries(inputParameters).map(function (_a) {
5591
+ var _b = __read(_a, 2), key = _b[0], value = _b[1];
5592
+ return [key, valueToString(value)];
5593
+ }));
5441
5594
  _g.label = 20;
5442
5595
  case 20:
5443
5596
  _g.trys.push([20, 25, , 28]);
@@ -5732,6 +5885,7 @@ var markdownScraperMetadata = $deepFreeze({
5732
5885
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
5733
5886
  *
5734
5887
  * @public exported from `@promptbook/core`
5888
+ * @public exported from `@promptbook/wizzard`
5735
5889
  * @public exported from `@promptbook/cli`
5736
5890
  */
5737
5891
  $scrapersMetadataRegister.register(markdownScraperMetadata);
@@ -5929,6 +6083,7 @@ var pdfScraperMetadata = $deepFreeze({
5929
6083
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
5930
6084
  *
5931
6085
  * @public exported from `@promptbook/core`
6086
+ * @public exported from `@promptbook/wizzard`
5932
6087
  * @public exported from `@promptbook/cli`
5933
6088
  */
5934
6089
  $scrapersMetadataRegister.register(pdfScraperMetadata);
@@ -6013,6 +6168,7 @@ var createPdfScraper = Object.assign(function (tools, options) {
6013
6168
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
6014
6169
  *
6015
6170
  * @public exported from `@promptbook/pdf`
6171
+ * @public exported from `@promptbook/wizzard`
6016
6172
  * @public exported from `@promptbook/cli`
6017
6173
  */
6018
6174
  var _PdfScraperRegistration = $scrapersRegister.register(createPdfScraper);