@promptbook/website-crawler 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/website-crawler`
27
31
 
28
32
  - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -227,6 +231,7 @@ Or you can install them separately:
227
231
 
228
232
  - ⭐ **[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
229
233
  - **[promptbook](https://www.npmjs.com/package/promptbook)** - Same as `ptbk`
234
+ - ⭐🧙‍♂️ **[@promptbook/wizzard](https://www.npmjs.com/package/@promptbook/wizzard)** - Wizzard to just run the books in node without any struggle
230
235
  - **[@promptbook/core](https://www.npmjs.com/package/@promptbook/core)** - Core of the library, it contains the main logic for promptbooks
231
236
  - **[@promptbook/node](https://www.npmjs.com/package/@promptbook/node)** - Core of the library for Node.js environment
232
237
  - **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
@@ -247,8 +252,10 @@ Or you can install them separately:
247
252
  - **[@promptbook/documents](https://www.npmjs.com/package/@promptbook/documents)** - Read knowledge from documents like `.docx`, `.odt`,…
248
253
  - **[@promptbook/legacy-documents](https://www.npmjs.com/package/@promptbook/legacy-documents)** - Read knowledge from legacy documents like `.doc`, `.rtf`,…
249
254
  - **[@promptbook/website-crawler](https://www.npmjs.com/package/@promptbook/website-crawler)** - Crawl knowledge from the web
255
+ - **[@promptbook/editable](https://www.npmjs.com/package/@promptbook/editable)** - Editable book as native javascript object with imperative object API
256
+ - **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Usefull templates and examples of books which can be used as a starting point
250
257
  - **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
251
- - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
258
+ - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
252
259
 
253
260
 
254
261
 
package/esm/index.es.js CHANGED
@@ -16,15 +16,17 @@ import { Converter } from 'showdown';
16
16
  /**
17
17
  * The version of the Book language
18
18
  *
19
+ * @generated
19
20
  * @see https://github.com/webgptorg/book
20
21
  */
21
22
  var BOOK_LANGUAGE_VERSION = '1.0.0';
22
23
  /**
23
24
  * The version of the Promptbook engine
24
25
  *
26
+ * @generated
25
27
  * @see https://github.com/webgptorg/promptbook
26
28
  */
27
- var PROMPTBOOK_ENGINE_VERSION = '0.80.0-1';
29
+ var PROMPTBOOK_ENGINE_VERSION = '0.81.0-11';
28
30
  /**
29
31
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
30
32
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -234,6 +236,26 @@ var ADMIN_GITHUB_NAME = 'hejny';
234
236
  * @private within the repository - too low-level in comparison with other `MAX_...`
235
237
  */
236
238
  var LOOP_LIMIT = 1000;
239
+ /**
240
+ * Strings to represent various values in the context of parameter values
241
+ *
242
+ * @public exported from `@promptbook/utils`
243
+ */
244
+ var VALUE_STRINGS = {
245
+ empty: '(nothing; empty string)',
246
+ null: '(no value; null)',
247
+ undefined: '(unknown value; undefined)',
248
+ nan: '(not a number; NaN)',
249
+ infinity: '(infinity; ∞)',
250
+ negativeInfinity: '(negative infinity; -∞)',
251
+ unserializable: '(unserializable value)',
252
+ };
253
+ /**
254
+ * Small number limit
255
+ *
256
+ * @public exported from `@promptbook/utils`
257
+ */
258
+ var SMALL_NUMBER = 0.001;
237
259
  /**
238
260
  * Short time interval to prevent race conditions in milliseconds
239
261
  *
@@ -526,6 +548,7 @@ var websiteScraperMetadata = $deepFreeze({
526
548
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
527
549
  *
528
550
  * @public exported from `@promptbook/core`
551
+ * @public exported from `@promptbook/wizzard`
529
552
  * @public exported from `@promptbook/cli`
530
553
  */
531
554
  $scrapersMetadataRegister.register(websiteScraperMetadata);
@@ -923,21 +946,44 @@ function isValidFilePath(filename) {
923
946
  if (typeof filename !== 'string') {
924
947
  return false;
925
948
  }
949
+ if (filename.split('\n').length > 1) {
950
+ return false;
951
+ }
952
+ if (filename.split(' ').length >
953
+ 5 /* <- TODO: [🧠][🈷] Make some better non-arbitrary way how to distinct filenames from informational texts */) {
954
+ return false;
955
+ }
926
956
  var filenameSlashes = filename.split('\\').join('/');
927
957
  // Absolute Unix path: /hello.txt
928
958
  if (/^(\/)/i.test(filenameSlashes)) {
959
+ // console.log(filename, 'Absolute Unix path: /hello.txt');
929
960
  return true;
930
961
  }
931
962
  // Absolute Windows path: /hello.txt
932
963
  if (/^([A-Z]{1,2}:\/?)\//i.test(filenameSlashes)) {
964
+ // console.log(filename, 'Absolute Windows path: /hello.txt');
933
965
  return true;
934
966
  }
935
967
  // Relative path: ./hello.txt
936
968
  if (/^(\.\.?\/)+/i.test(filenameSlashes)) {
969
+ // console.log(filename, 'Relative path: ./hello.txt');
970
+ return true;
971
+ }
972
+ // Allow paths like foo/hello
973
+ if (/^[^/]+\/[^/]+/i.test(filenameSlashes)) {
974
+ // console.log(filename, 'Allow paths like foo/hello');
975
+ return true;
976
+ }
977
+ // Allow paths like hello.book
978
+ if (/^[^/]+\.[^/]+$/i.test(filenameSlashes)) {
979
+ // console.log(filename, 'Allow paths like hello.book');
937
980
  return true;
938
981
  }
939
982
  return false;
940
983
  }
984
+ /**
985
+ * TODO: [🍏] Implement for MacOs
986
+ */
941
987
 
942
988
  /**
943
989
  * Tests if given string is valid URL.
@@ -1063,7 +1109,7 @@ function getScraperIntermediateSource(source, options) {
1063
1109
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
1064
1110
  */
1065
1111
 
1066
- 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"}];
1112
+ 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"}];
1067
1113
 
1068
1114
  /**
1069
1115
  * Prettify the html code
@@ -1417,7 +1463,7 @@ function checkSerializableAsJson(options) {
1417
1463
  if (!(error instanceof Error)) {
1418
1464
  throw error;
1419
1465
  }
1420
- 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 "); }));
1466
+ 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 "); }));
1421
1467
  }
1422
1468
  /*
1423
1469
  TODO: [0] Is there some more elegant way to check circular references?
@@ -1515,6 +1561,7 @@ function exportJson(options) {
1515
1561
  * @public exported from `@promptbook/core`
1516
1562
  */
1517
1563
  var ORDER_OF_PIPELINE_JSON = [
1564
+ // Note: [🍙] In this order will be pipeline serialized
1518
1565
  'title',
1519
1566
  'pipelineUrl',
1520
1567
  'bookVersion',
@@ -1526,6 +1573,7 @@ var ORDER_OF_PIPELINE_JSON = [
1526
1573
  'preparations',
1527
1574
  'knowledgeSources',
1528
1575
  'knowledgePieces',
1576
+ 'sources', // <- TODO: [🧠] Where should the `sources` be
1529
1577
  ];
1530
1578
  /**
1531
1579
  * Nonce which is used for replacing things in strings
@@ -1713,9 +1761,6 @@ function isValidPipelineUrl(url) {
1713
1761
  if (!url.startsWith('https://')) {
1714
1762
  return false;
1715
1763
  }
1716
- if (!(url.endsWith('.book.md') || url.endsWith('.book') || url.endsWith('.book.md') || url.endsWith('.ptbk'))) {
1717
- return false;
1718
- }
1719
1764
  if (url.includes('#')) {
1720
1765
  // TODO: [🐠]
1721
1766
  return false;
@@ -2461,6 +2506,81 @@ function isPipelinePrepared(pipeline) {
2461
2506
  * - [♨] Are tasks prepared
2462
2507
  */
2463
2508
 
2509
+ /**
2510
+ * Format either small or big number
2511
+ *
2512
+ * @public exported from `@promptbook/utils`
2513
+ */
2514
+ function numberToString(value) {
2515
+ if (value === 0) {
2516
+ return '0';
2517
+ }
2518
+ else if (Number.isNaN(value)) {
2519
+ return VALUE_STRINGS.nan;
2520
+ }
2521
+ else if (value === Infinity) {
2522
+ return VALUE_STRINGS.infinity;
2523
+ }
2524
+ else if (value === -Infinity) {
2525
+ return VALUE_STRINGS.negativeInfinity;
2526
+ }
2527
+ for (var exponent = 0; exponent < 15; exponent++) {
2528
+ var factor = Math.pow(10, exponent);
2529
+ var valueRounded = Math.round(value * factor) / factor;
2530
+ if (Math.abs(value - valueRounded) / value < SMALL_NUMBER) {
2531
+ return valueRounded.toFixed(exponent);
2532
+ }
2533
+ }
2534
+ return value.toString();
2535
+ }
2536
+
2537
+ /**
2538
+ * Function `valueToString` will convert the given value to string
2539
+ * This is useful and used in the `templateParameters` function
2540
+ *
2541
+ * Note: This function is not just calling `toString` method
2542
+ * It's more complex and can handle this conversion specifically for LLM models
2543
+ * See `VALUE_STRINGS`
2544
+ *
2545
+ * Note: There are 2 similar functions
2546
+ * - `valueToString` converts value to string for LLM models as human-readable string
2547
+ * - `asSerializable` converts value to string to preserve full information to be able to convert it back
2548
+ *
2549
+ * @public exported from `@promptbook/utils`
2550
+ */
2551
+ function valueToString(value) {
2552
+ try {
2553
+ if (value === '') {
2554
+ return VALUE_STRINGS.empty;
2555
+ }
2556
+ else if (value === null) {
2557
+ return VALUE_STRINGS.null;
2558
+ }
2559
+ else if (value === undefined) {
2560
+ return VALUE_STRINGS.undefined;
2561
+ }
2562
+ else if (typeof value === 'string') {
2563
+ return value;
2564
+ }
2565
+ else if (typeof value === 'number') {
2566
+ return numberToString(value);
2567
+ }
2568
+ else if (value instanceof Date) {
2569
+ return value.toISOString();
2570
+ }
2571
+ else {
2572
+ return JSON.stringify(value);
2573
+ }
2574
+ }
2575
+ catch (error) {
2576
+ if (!(error instanceof Error)) {
2577
+ throw error;
2578
+ }
2579
+ console.error(error);
2580
+ return VALUE_STRINGS.unserializable;
2581
+ }
2582
+ }
2583
+
2464
2584
  /**
2465
2585
  * Serializes an error into a [🚉] JSON-serializable object
2466
2586
  *
@@ -3356,6 +3476,33 @@ function isFileExisting(filename, fs) {
3356
3476
  * TODO: [🖇] What about symlinks?
3357
3477
  */
3358
3478
 
3479
+ /**
3480
+ * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
3481
+ *
3482
+ * @private as default `fetch` function used in Promptbook scrapers
3483
+ */
3484
+ var scraperFetch = function (url, init) { return __awaiter(void 0, void 0, void 0, function () {
3485
+ var error_1;
3486
+ return __generator(this, function (_a) {
3487
+ switch (_a.label) {
3488
+ case 0:
3489
+ _a.trys.push([0, 2, , 3]);
3490
+ return [4 /*yield*/, fetch(url, init)];
3491
+ case 1: return [2 /*return*/, _a.sent()];
3492
+ case 2:
3493
+ error_1 = _a.sent();
3494
+ if (!(error_1 instanceof Error)) {
3495
+ throw error_1;
3496
+ }
3497
+ 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 "); }));
3498
+ case 3: return [2 /*return*/];
3499
+ }
3500
+ });
3501
+ }); };
3502
+ /**
3503
+ * TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
3504
+ */
3505
+
3359
3506
  /**
3360
3507
  * @@@
3361
3508
  *
@@ -3364,13 +3511,14 @@ function isFileExisting(filename, fs) {
3364
3511
  function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
3365
3512
  var _a;
3366
3513
  return __awaiter(this, void 0, void 0, function () {
3367
- var sourceContent, name, _b, _c, rootDirname, url, response_1, mimeType, filename_1, fileExtension, mimeType;
3368
- return __generator(this, function (_e) {
3369
- switch (_e.label) {
3514
+ var _b, fetch, sourceContent, name, _c, _d, rootDirname, url, response_1, mimeType, filename_1, fileExtension, mimeType;
3515
+ return __generator(this, function (_f) {
3516
+ switch (_f.label) {
3370
3517
  case 0:
3518
+ _b = tools.fetch, fetch = _b === void 0 ? scraperFetch : _b;
3371
3519
  sourceContent = knowledgeSource.sourceContent;
3372
3520
  name = knowledgeSource.name;
3373
- _b = options || {}, _c = _b.rootDirname, rootDirname = _c === void 0 ? null : _c, _b.isVerbose;
3521
+ _c = options || {}, _d = _c.rootDirname, rootDirname = _d === void 0 ? null : _d, _c.isVerbose;
3374
3522
  if (!name) {
3375
3523
  name = sourceContentToName(sourceContent);
3376
3524
  }
@@ -3378,7 +3526,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
3378
3526
  url = sourceContent;
3379
3527
  return [4 /*yield*/, fetch(url)];
3380
3528
  case 1:
3381
- response_1 = _e.sent();
3529
+ response_1 = _f.sent();
3382
3530
  mimeType = ((_a = response_1.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.split(';')[0]) || 'text/html';
3383
3531
  return [2 /*return*/, {
3384
3532
  source: name,
@@ -3421,7 +3569,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
3421
3569
  },
3422
3570
  }];
3423
3571
  case 2:
3424
- if (!(isValidFilePath(sourceContent) || /\.[a-z]{1,10}$/i.exec(sourceContent))) return [3 /*break*/, 4];
3572
+ if (!isValidFilePath(sourceContent)) return [3 /*break*/, 4];
3425
3573
  if (tools.fs === undefined) {
3426
3574
  throw new EnvironmentMismatchError('Can not import file knowledge without filesystem tools');
3427
3575
  // <- TODO: [🧠] What is the best error type here`
@@ -3435,8 +3583,8 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
3435
3583
  mimeType = extensionToMimeType(fileExtension || '');
3436
3584
  return [4 /*yield*/, isFileExisting(filename_1, tools.fs)];
3437
3585
  case 3:
3438
- if (!(_e.sent())) {
3439
- 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 "); }));
3586
+ if (!(_f.sent())) {
3587
+ 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 "); }));
3440
3588
  }
3441
3589
  // TODO: [🧠][😿] Test security file - file is scoped to the project (BUT maybe do this in `filesystemTools`)
3442
3590
  return [2 /*return*/, {
@@ -3844,7 +3992,7 @@ function extractVariablesFromScript(script) {
3844
3992
  if (!(error instanceof Error)) {
3845
3993
  throw error;
3846
3994
  }
3847
- 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)
3995
+ 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)
3848
3996
  .map(function (variableName, i) { return "".concat(i + 1, ") ").concat(variableName); })
3849
3997
  .join('\n'), "\n\n\n The script:\n\n ```javascript\n ").concat(block(originalScript), "\n ```\n "); }));
3850
3998
  }
@@ -4466,13 +4614,16 @@ function extractJsonBlock(markdown) {
4466
4614
  /**
4467
4615
  * Replaces parameters in template with values from parameters object
4468
4616
  *
4617
+ * Note: This function is not places strings into string,
4618
+ * It's more complex and can handle this operation specifically for LLM models
4619
+ *
4469
4620
  * @param template the template with parameters in {curly} braces
4470
4621
  * @param parameters the object with parameters
4471
4622
  * @returns the template with replaced parameters
4472
4623
  * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
4473
4624
  * @public exported from `@promptbook/utils`
4474
4625
  */
4475
- function replaceParameters(template, parameters) {
4626
+ function templateParameters(template, parameters) {
4476
4627
  var e_1, _a;
4477
4628
  try {
4478
4629
  for (var _b = __values(Object.entries(parameters)), _c = _b.next(); !_c.done; _c = _b.next()) {
@@ -4498,7 +4649,7 @@ function replaceParameters(template, parameters) {
4498
4649
  var loopLimit = LOOP_LIMIT;
4499
4650
  var _loop_1 = function () {
4500
4651
  if (loopLimit-- < 0) {
4501
- throw new LimitReachedError('Loop limit reached during parameters replacement in `replaceParameters`');
4652
+ throw new LimitReachedError('Loop limit reached during parameters replacement in `templateParameters`');
4502
4653
  }
4503
4654
  var precol = match.groups.precol;
4504
4655
  var parameterName = match.groups.parameterName;
@@ -4515,7 +4666,7 @@ function replaceParameters(template, parameters) {
4515
4666
  if (parameterValue === undefined) {
4516
4667
  throw new PipelineExecutionError("Parameter `{".concat(parameterName, "}` is not defined"));
4517
4668
  }
4518
- parameterValue = parameterValue.toString();
4669
+ parameterValue = valueToString(parameterValue);
4519
4670
  if (parameterValue.includes('\n') && /^\s*\W{0,3}\s*$/.test(precol)) {
4520
4671
  parameterValue = parameterValue
4521
4672
  .split('\n')
@@ -4750,7 +4901,7 @@ function executeAttempts(options) {
4750
4901
  }
4751
4902
  return [3 /*break*/, 24];
4752
4903
  case 2:
4753
- $ongoingTaskResult.$resultString = replaceParameters(preparedContent, parameters);
4904
+ $ongoingTaskResult.$resultString = templateParameters(preparedContent, parameters);
4754
4905
  return [3 /*break*/, 25];
4755
4906
  case 3:
4756
4907
  modelRequirements = __assign(__assign({ modelVariant: 'CHAT' }, (preparedPipeline.defaultModelRequirements || {})), (task.modelRequirements || {}));
@@ -4873,8 +5024,8 @@ function executeAttempts(options) {
4873
5024
  _j = $ongoingTaskResult;
4874
5025
  return [4 /*yield*/, tools.userInterface.promptDialog($deepFreeze({
4875
5026
  promptTitle: task.title,
4876
- promptMessage: replaceParameters(task.description || '', parameters),
4877
- defaultValue: replaceParameters(preparedContent, parameters),
5027
+ promptMessage: templateParameters(task.description || '', parameters),
5028
+ defaultValue: templateParameters(preparedContent, parameters),
4878
5029
  // TODO: [🧠] !! Figure out how to define placeholder in .book.md file
4879
5030
  placeholder: undefined,
4880
5031
  priority: priority,
@@ -4998,7 +5149,7 @@ function executeAttempts(options) {
4998
5149
  if (!isJokerAttempt &&
4999
5150
  task.taskType === 'PROMPT_TASK' &&
5000
5151
  $ongoingTaskResult.$prompt
5001
- // <- Note: [2] When some expected parameter is not defined, error will occur in replaceParameters
5152
+ // <- Note: [2] When some expected parameter is not defined, error will occur in templateParameters
5002
5153
  // In that case we don’t want to make a report about it because it’s not a llm execution error
5003
5154
  ) {
5004
5155
  // TODO: [🧠] Maybe put other taskTypes into report
@@ -5575,7 +5726,10 @@ function executePipeline(options) {
5575
5726
  finally { if (e_2) throw e_2.error; }
5576
5727
  return [7 /*endfinally*/];
5577
5728
  case 19:
5578
- parametersToPass = inputParameters;
5729
+ parametersToPass = Object.fromEntries(Object.entries(inputParameters).map(function (_a) {
5730
+ var _b = __read(_a, 2), key = _b[0], value = _b[1];
5731
+ return [key, valueToString(value)];
5732
+ }));
5579
5733
  _g.label = 20;
5580
5734
  case 20:
5581
5735
  _g.trys.push([20, 25, , 28]);
@@ -5830,6 +5984,7 @@ var markdownScraperMetadata = $deepFreeze({
5830
5984
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
5831
5985
  *
5832
5986
  * @public exported from `@promptbook/core`
5987
+ * @public exported from `@promptbook/wizzard`
5833
5988
  * @public exported from `@promptbook/cli`
5834
5989
  */
5835
5990
  $scrapersMetadataRegister.register(markdownScraperMetadata);
@@ -6173,6 +6328,7 @@ var createWebsiteScraper = Object.assign(function (tools, options) {
6173
6328
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
6174
6329
  *
6175
6330
  * @public exported from `@promptbook/website-crawler`
6331
+ * @public exported from `@promptbook/wizzard`
6176
6332
  * @public exported from `@promptbook/cli`
6177
6333
  */
6178
6334
  var _WebsiteScraperRegistration = $scrapersRegister.register(createWebsiteScraper);