@promptbook/documents 0.112.0-32 → 0.112.0-35

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.112.0-32';
+    const PROMPTBOOK_ENGINE_VERSION = '0.112.0-35';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -42,6 +42,7 @@
      *
      * @param value any values
      * @returns void
+     *
      * @private within the repository
      */
     function keepUnused(...valuesToKeep) {
@@ -51,16 +52,20 @@
      * Trims string from all 4 sides
      *
      * Note: This is a re-exported function from the `spacetrim` package which is
-     *       Developed by same author @hejny as this package
+     * Developed by same author @hejny as this package
      *
-     * @public exported from `@promptbook/utils`
      * @see https://github.com/hejny/spacetrim#usage
+     *
+     * @public exported from `@promptbook/utils`
      */
     const spaceTrim = spacetrim.spaceTrim;
 
     /**
-     * @private util of `@promptbook/color`
+     * Class implementing take chain.
+     *
      * @de
+     *
+     * @private util of `@promptbook/color`
      */
     class TakeChain {
         constructor(value) {
@@ -77,9 +82,9 @@
      *
      * @param {*} initialValue - The initial value.
      * @returns {Proxy<WithTake<TValue>>} - A proxy object with a `take` method.
+     * @deprecated [🤡] Use some better functional library instead of `TakeChain`
      *
      * @private util of `@promptbook/color`
-     * @deprecated [🤡] Use some better functional library instead of `TakeChain`
      */
     function take(initialValue) {
         if (initialValue instanceof TakeChain) {
@@ -257,9 +262,7 @@
         yellow: '#ffff00',
         yellowgreen: '#9acd32',
     };
-    /**
-     * Note: [💞] Ignore a discrepancy between file name and entity name
-     */
+    // Note: [💞] Ignore a discrepancy between file name and entity name
 
     /**
      * Validates that a channel value is a valid number within the range of 0 to 255.
@@ -289,7 +292,13 @@
         }
     }
 
+    /**
+     * Constant for short hex lengths.
+     */
     const SHORT_HEX_LENGTHS = new Set([3, 4]);
+    /**
+     * Constant for long hex lengths.
+     */
     const LONG_HEX_LENGTHS = new Set([6, 8]);
     /**
      * Parses a hex string into RGBA channel values.
@@ -322,6 +331,9 @@
         }
         return throwInvalidHex();
     }
+    /**
+     * Parses short hex channel.
+     */
     function parseShortHexChannel(char, onError) {
         if (!char) {
             return onError();
@@ -332,6 +344,9 @@
         }
         return parsed * 16;
     }
+    /**
+     * Parses long hex channel.
+     */
     function parseLongHexChannel(hex, start, onError) {
         const segment = hex.substr(start, 2);
         if (segment.length < 2) {
@@ -344,6 +359,9 @@
         return parsed;
     }
 
+    /**
+     * Pattern matching hsl.
+     */
     const HSL_REGEX = /^hsl\(\s*([0-9.]+)\s*,\s*([0-9.]+)%\s*,\s*([0-9.]+)%\s*\)$/;
     /**
      * Parses an HSL string into RGBA channel values.
@@ -369,6 +387,9 @@
             alpha: 255,
         };
     }
+    /**
+     * Handles convert hsl to Rgb.
+     */
     function convertHslToRgb(h, s, l) {
         const c = (1 - Math.abs(2 * l - 1)) * s;
         const x = c * (1 - Math.abs(((h / 60) % 2) - 1));
@@ -407,7 +428,13 @@
         };
     }
 
+    /**
+     * Pattern matching RGB.
+     */
     const RGB_REGEX = /^rgb\(\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*\)$/;
+    /**
+     * Pattern matching rgba.
+     */
     const RGBA_REGEX = /^rgba\(\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*\)$/;
     /**
      * Parses an RGB string into RGBA channel values.
@@ -449,6 +476,9 @@
             alpha: parseAlphaValue(match[4]),
         };
     }
+    /**
+     * Parses channel value.
+     */
     function parseChannelValue(value) {
         if (value.endsWith('%')) {
             const percent = parseFloat(value);
@@ -456,6 +486,9 @@
         }
         return Math.round(parseFloat(value));
     }
+    /**
+     * Parses alpha value.
+     */
     function parseAlphaValue(value) {
         if (value.endsWith('%')) {
             const percent = parseFloat(value);
@@ -468,8 +501,17 @@
         return Math.round(parsed);
     }
 
+    /**
+     * Pattern matching hsl regex.
+     */
     const HSL_REGEX_PATTERN = /^hsl\(\s*([0-9.]+)\s*,\s*([0-9.]+)%\s*,\s*([0-9.]+)%\s*\)$/;
+    /**
+     * Pattern matching RGB regex.
+     */
     const RGB_REGEX_PATTERN = /^rgb\(\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*\)$/;
+    /**
+     * Pattern matching rgba regex.
+     */
     const RGBA_REGEX_PATTERN = /^rgba\(\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*\)$/;
     /**
      * Color object represents an RGB color with alpha channel
@@ -835,9 +877,7 @@
         }
         return [Math.round(red * 255), Math.round(green * 255), Math.round(blue * 255)];
     }
-    /**
-     * TODO: Properly name all used internal variables
-     */
+    // TODO: Properly name all used internal variables
 
     /**
      * Converts RGB values to HSL values
@@ -883,9 +923,7 @@
         }
         return [hue, saturation, lightness];
     }
-    /**
-     * TODO: Properly name all used internal variables
-     */
+    // TODO: Properly name all used internal variables
 
     /**
      * Makes color transformer which lighten the given color
@@ -903,9 +941,7 @@
             return Color.fromValues(r, g, b, alpha);
         };
     }
-    /**
-     * TODO: Maybe implement by mix+hsl
-     */
+    // TODO: Maybe implement by mix+hsl
 
     /**
      * Makes color transformer which saturate the given color
@@ -923,9 +959,7 @@
             return Color.fromValues(r, g, b, alpha);
         };
     }
-    /**
-     * TODO: Maybe implement by mix+hsl
-     */
+    // TODO: Maybe implement by mix+hsl
 
     /**
      * Returns the same value that is passed as argument.
@@ -938,6 +972,7 @@
      *
      * @param value any values
      * @returns the same values
+     *
      * @private within the repository
      */
     function just(value) {
@@ -1296,9 +1331,7 @@
             return false;
         }
     }
-    /**
-     * TODO: [🎺]
-     */
+    // TODO: [🎺]
 
     /**
      * Normalize options for `execCommand` and `execCommands`
@@ -1366,7 +1399,6 @@
     /**
      * Run one command in a shell
      *
-     *
      * Note: There are 2 similar functions in the codebase:
      * - `$execCommand` which runs a single command
      * - `$execCommands` which runs multiple commands
@@ -1465,9 +1497,7 @@
             }
         });
     }
-    /**
-     * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
-     */
+    // Note: [🟢] Code for Node command-execution helper [$execCommand](src/utils/execCommand/$execCommand.ts) should never be published into packages that could be imported into browser environment
 
     /**
      * Get the file extension from a file name
@@ -1498,11 +1528,9 @@
             .catch(() => false);
         return isFile;
     }
-    /**
-     * Note: Not [~🟢~] because it is not directly dependent on `fs
-     * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
-     * TODO: [🖇] What about symlinks?
-     */
+    // Note: Not [~🟢~] because it is not directly dependent on `fs
+    // TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
+    // TODO: [🖇] What about symlinks?
 
     /**
      * Converts a name to a properly formatted subfolder path for cache storage.
@@ -1514,6 +1542,9 @@
         return [name.substr(0, 1).toLowerCase(), name.substr(1, 1).toLowerCase()];
     }
 
+    /**
+     * Collection of default diacritics removal map.
+     */
     const defaultDiacriticsRemovalMap = [
         {
             base: 'A',
@@ -1765,6 +1796,7 @@
      *
      * @param input The string containing diacritics to be normalized.
      * @returns The string with diacritics removed or normalized.
+     *
      * @public exported from `@promptbook/utils`
      */
     function removeDiacritics(input) {
@@ -1773,9 +1805,7 @@
             return DIACRITIC_VARIANTS_LETTERS[character] || character;
         });
     }
-    /**
-     * TODO: [Ж] Variant for cyrillic (and in general non-latin) letters
-     */
+    // TODO: [Ж] Variant for cyrillic (and in general non-latin) letters
 
     /**
      * Converts a given text to kebab-case format.
@@ -1786,6 +1816,7 @@
      * @returns The kebab-case formatted string.
      * @example 'hello-world'
      * @example 'i-love-promptbook'
+     *
      * @public exported from `@promptbook/utils`
      */
     function normalizeToKebabCase(text) {
@@ -1826,14 +1857,13 @@
         normalizedName = normalizedName.replace(/-$/, '');
         return normalizedName;
     }
-    /**
-     * Note: [💞] Ignore a discrepancy between file name and entity name
-     */
+    // Note: [💞] Ignore a discrepancy between file name and entity name
 
     /**
      * Tests if given string is valid file path.
      *
      * Note: This does not check if the file exists only if the path is valid
+     *
      * @public exported from `@promptbook/utils`
      */
     function isValidFilePath(filename) {
@@ -1882,9 +1912,7 @@
         }
         return false;
     }
-    /**
-     * TODO: [🍏] Implement for MacOs
-     */
+    // TODO: [🍏] Implement for MacOs
 
     /**
      * Tests if given string is valid URL.
@@ -1924,6 +1952,7 @@
      *
      * @param text with emojis
      * @returns text without emojis
+     *
      * @public exported from `@promptbook/utils`
      */
     function removeEmojis(text) {
@@ -1943,6 +1972,7 @@
      * @param value The title string to be converted to a name.
      * @returns A normalized name derived from the input title.
      * @example 'Hello World!' -> 'hello-world'
+     *
      * @public exported from `@promptbook/utils`
      */
     function titleToName(value) {
@@ -2023,13 +2053,11 @@
         };
         return fileHandler;
     }
-    /**
-     * Note: Not using `FileCacheStorage` for two reasons:
-     * 1) Need to store more than serialized JSONs
-     * 2) Need to switch between a `rootDirname` and `cacheDirname` <- TODO: [😡]
-     * TODO: [🐱‍🐉][🧠] Make some smart crop
-     * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
-     */
+    // Note: [🟢] Code for Node scraper helper [getScraperIntermediateSource](src/scrapers/_common/utils/getScraperIntermediateSource.ts) should never be published into packages that could be imported into browser environment
+    // Note: Not using `FileCacheStorage` for two reasons:
+    // 1. Need to store more than serialized JSONs.
+    // 2. Need to switch between a `rootDirname` and `cacheDirname` <- TODO: [😡]
+    // TODO: [🐱‍🐉][🧠] Make some smart crop
 
     var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book",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`\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"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.book",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`\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"},{title:"Prepare Knowledge-piece Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.book",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`\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"},{title:"Prepare Persona",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.book",formfactorName:"GENERIC",parameters:[{name:"availableModels",description:"List of available model names together with their descriptions as JSON",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelsRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-model-requirements",title:"Make modelRequirements",content:"You are an experienced AI engineer, you need to find the best models for virtual assistants:\n\n## Example\n\n```json\n[\n  {\n  \"modelName\": \"gpt-4o\",\n  \"systemMessage\": \"You are experienced AI engineer and helpful assistant.\",\n  \"temperature\": 0.7\n  },\n  {\n    \"modelName\": \"claude-3-5-sonnet\",\n    \"systemMessage\": \"You are a friendly and knowledgeable chatbot.\",\n    \"temperature\": 0.5\n  }\n]\n```\n\n## Instructions\n\n-   Your output format is JSON array\n-   Sort best-fitting models first\n-   Omit any models that are not suitable\n-   Write just the JSON, no other text should be present\n-   Array contain items with 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\nHere are the available models:\n\n```json\n{availableModels}\n```\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:"modelsRequirements",format:"JSON",dependentParameterNames:["availableModels","personaDescription"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Persona\n\n-   PIPELINE URL `https://promptbook.studio/promptbook/prepare-persona.book`\n-   INPUT PARAMETER `{availableModels}` List of available model names together with their descriptions as JSON\n-   INPUT PARAMETER `{personaDescription}` Description of the persona\n-   OUTPUT PARAMETER `{modelsRequirements}` Specific requirements for the model\n\n## Make modelRequirements\n\n-   FORMAT JSON\n\n```markdown\nYou are an experienced AI engineer, you need to find the best models for virtual assistants:\n\n## Example\n\n\\`\\`\\`json\n[\n  {\n  \"modelName\": \"gpt-4o\",\n  \"systemMessage\": \"You are experienced AI engineer and helpful assistant.\",\n  \"temperature\": 0.7\n  },\n  {\n    \"modelName\": \"claude-3-5-sonnet\",\n    \"systemMessage\": \"You are a friendly and knowledgeable chatbot.\",\n    \"temperature\": 0.5\n  }\n]\n\\`\\`\\`\n\n## Instructions\n\n-   Your output format is JSON array\n-   Sort best-fitting models first\n-   Omit any models that are not suitable\n-   Write just the JSON, no other text should be present\n-   Array contain items with 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\nHere are the available models:\n\n\\`\\`\\`json\n{availableModels}\n\\`\\`\\`\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`-> {modelsRequirements}`\n"}],sourceFile:"./books/prepare-persona.book"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-title.book",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`\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"}];
 
@@ -2060,9 +2088,7 @@
             Object.setPrototypeOf(this, ParseError.prototype);
         }
     }
-    /**
-     * TODO: Maybe split `ParseError` and `ApplyError`
-     */
+    // TODO: Maybe split `ParseError` and `ApplyError`
 
     /**
      * This error type indicates that somewhere in the code non-Error object was thrown and it was wrapped into the `WrappedError`
@@ -2143,6 +2169,7 @@
      * @param {string} pipelineString the candidate for a pipeline string
      * @returns {PipelineString} the same string as input, but validated as valid
      * @throws {ParseError} if the string is not a valid pipeline string
+     *
      * @public exported from `@promptbook/core`
      */
     function validatePipelineString(pipelineString) {
@@ -2161,17 +2188,16 @@
         // <- TODO: Implement the validation + add tests when the pipeline logic considered as invalid
         return pipelineString;
     }
-    /**
-     * TODO: [🧠][🈴] Where is the best location for this file
-     */
+    // TODO: [🧠][🈴] Where is the best location for this file
 
     /**
      * Prettify the html code
      *
      * @param content raw html code
      * @returns formatted html code
-     * @private withing the package because of HUGE size of prettier dependency
      * @deprecated Prettier removed from Promptbook due to package size
+     *
+     * @private withing the package because of HUGE size of prettier dependency
      */
     function prettifyMarkdown(content) {
         return (content + `\n\n<!-- Note: Prettier removed from Promptbook -->`);
@@ -2194,6 +2220,7 @@
      * @deprecated TODO: [🥍][🧠] Backup original files in `PipelineJson` same as in Promptbook.studio
      * @param pipelineJson Promptbook in JSON format (.bookc)
      * @returns Promptbook in string format (.book.md)
+     *
      * @public exported from `@promptbook/core`
      */
     function pipelineJsonToString(pipelineJson) {
@@ -2310,6 +2337,8 @@
         return validatePipelineString(pipelineString);
     }
     /**
+     * Handles task parameter Json to string.
+     *
      * @private internal utility of `pipelineJsonToString`
      */
     function taskParameterJsonToString(taskParameterJson) {
@@ -2320,18 +2349,17 @@
         }
         return parameterString;
     }
-    /**
-     * TODO: [🛋] Implement new features and commands into `pipelineJsonToString` + `taskParameterJsonToString` , use `stringifyCommand`
-     * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
-     * TODO: [🏛] Maybe make some markdown builder
-     * TODO: [🏛] Escape all
-     * TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
-     */
+    // TODO: [🛋] Implement new features and commands into `pipelineJsonToString` + `taskParameterJsonToString` , use `stringifyCommand`
+    // TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
+    // TODO: [🏛] Maybe make some markdown builder
+    // TODO: [🏛] Escape all
+    // TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
 
     /**
      * Orders JSON object by keys
      *
      * @returns The same type of object as the input re-ordered
+     *
      * @public exported from `@promptbook/utils`
      */
     function orderJson(options) {
@@ -2350,6 +2378,7 @@
      * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
      *
      * @returns The same object as the input, but deeply frozen
+     *
      * @public exported from `@promptbook/utils`
      */
     function $deepFreeze(objectValue) {
@@ -2366,9 +2395,7 @@
         Object.freeze(objectValue);
         return objectValue;
     }
-    /**
-     * TODO: [🧠] Is there a way how to meaningfully test this utility
-     */
+    // TODO: [🧠] Is there a way how to meaningfully test this utility
 
     /**
      * Checks if the value is [🚉] serializable as JSON
@@ -2388,6 +2415,7 @@
      * - And much more...
      *
      * @throws UnexpectedError if the value is not serializable as JSON
+     *
      * @public exported from `@promptbook/utils`
      */
     function checkSerializableAsJson(options) {
@@ -2502,11 +2530,9 @@
                 `));
         }
     }
-    /**
-     * TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
-     * TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
-     * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
-     */
+    // TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
+    // TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
+    // Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
 
     /**
      * Creates a deep clone of the given object
@@ -2516,6 +2542,7 @@
      *
      * @param objectValue The object to clone.
      * @returns A deep, writable clone of the input object.
+     *
      * @public exported from `@promptbook/utils`
      */
     function deepClone(objectValue) {
@@ -2532,9 +2559,7 @@
         > return Object.assign({}, objectValue);
         */
     }
-    /**
-     * TODO: [🧠] Is there a way how to meaningfully test this utility
-     */
+    // TODO: [🧠] Is there a way how to meaningfully test this utility
 
     /**
      * Utility to export a JSON object from a function
@@ -2547,6 +2572,7 @@
      * Note: This function does not mutates the given object
      *
      * @returns The same type of object as the input but read-only and re-ordered
+     *
      * @public exported from `@promptbook/utils`
      */
     function exportJson(options) {
@@ -2566,9 +2592,7 @@
         $deepFreeze(orderedValue);
         return orderedValue;
     }
-    /**
-     * TODO: [🧠] Is there a way how to meaningfully test this utility
-     */
+    // TODO: [🧠] Is there a way how to meaningfully test this utility
 
     /**
      * Order of keys in the pipeline JSON
@@ -2628,9 +2652,7 @@
             // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
         ],
     });
-    /**
-     * Note: [💞] Ignore a discrepancy between file name and entity name
-     */
+    // Note: [💞] Ignore a discrepancy between file name and entity name
 
     /**
      * This error indicates that the promptbook object has valid syntax (=can be parsed) but contains logical errors (like circular dependencies)
@@ -2668,12 +2690,13 @@
      * Tests if given string is valid promptbook version
      * It looks into list of known promptbook versions.
      *
-     * @see https://www.npmjs.com/package/promptbook?activeTab=versions
      * Note: When you are using for example promptbook 2.0.0 and there already is promptbook 3.0.0 it don`t know about it.
      * Note: There are two similar functions:
      * - `isValidSemanticVersion` which tests any semantic version
      * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
      *
+     * @see https://www.npmjs.com/package/promptbook?activeTab=versions
+     *
      * @public exported from `@promptbook/utils`
      */
     function isValidPromptbookVersion(version) {
@@ -2716,9 +2739,7 @@
         */
         return true;
     }
-    /**
-     * TODO: [🐠] Maybe more info why the URL is invalid
-     */
+    // TODO: [🐠] Maybe more info why the URL is invalid
 
     /**
      * Validates PipelineJson if it is logically valid
@@ -2735,6 +2756,7 @@
      * @param pipeline valid or invalid PipelineJson
      * @returns the same pipeline if it is logically valid
      * @throws {PipelineLogicError} on logical error in the pipeline
+     *
      * @public exported from `@promptbook/core`
      */
     function validatePipeline(pipeline) {
@@ -2759,6 +2781,8 @@
         return pipeline;
     }
     /**
+     * Validates pipeline inner function.
+     *
      * @private internal function for `validatePipeline`
      */
     function validatePipeline_InnerFunction(pipeline) {
@@ -3003,15 +3027,13 @@
      *     >  * -   ...
      *     >  ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
      */
-    /**
-     * TODO: [🧳][main] !!4 Validate that all examples match expectations
-     * TODO: [🧳][🐝][main] !!4 Validate that knowledge is valid (non-void)
-     * TODO: [🧳][main] !!4 Validate that persona can be used only with CHAT variant
-     * TODO: [🧳][main] !!4 Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
-     * TODO: [🧳][main] !!4 Validate that reserved parameter is not used as joker
-     * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
-     * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
-     */
+    // TODO: [🧳][main] !!4 Validate that all examples match expectations
+    // TODO: [🧳][🐝][main] !!4 Validate that knowledge is valid (non-void)
+    // TODO: [🧳][main] !!4 Validate that persona can be used only with CHAT variant
+    // TODO: [🧳][main] !!4 Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
+    // TODO: [🧳][main] !!4 Validate that reserved parameter is not used as joker
+    // TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
+    // TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
 
     /**
      * This error indicates that promptbook not found in the collection
@@ -3044,6 +3066,7 @@
      *
      * @param template the string template with parameters in {curly} braces
      * @returns the list of parameter names
+     *
      * @public exported from `@promptbook/utils`
      */
     function extractParameterNames(template) {
@@ -3060,6 +3083,7 @@
      * Unprepare just strips the preparation data of the pipeline
      *
      * @deprecated In future version this function will be removed or deprecated
+     *
      * @public exported from `@promptbook/core`
      */
     function unpreparePipeline(pipeline) {
@@ -3088,18 +3112,17 @@
             },
         });
     }
-    /**
-     * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
-     * TODO: Write tests for `preparePipeline`
-     * TODO: [🍙] Make some standard order of json properties
-     */
+    // TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
+    // TODO: Write tests for `preparePipeline`
+    // TODO: [🍙] Make some standard order of json properties
 
     /**
      * Library of pipelines that groups together pipelines for an application.
      * This implementation is a very thin wrapper around the Array / Map of pipelines.
      *
-     * @private internal function of `createPipelineCollectionFromJson`, use `createPipelineCollectionFromJson` instead
      * @see https://github.com/webgptorg/pipeline#pipeline-collection
+     *
+     * @private internal function of `createPipelineCollectionFromJson`, use `createPipelineCollectionFromJson` instead
      */
     class SimplePipelineCollection {
         /**
@@ -3203,6 +3226,7 @@
      *
      * @param promptbookSources
      * @returns PipelineCollection
+     *
      * @public exported from `@promptbook/core`
      */
     function createPipelineCollectionFromJson(...promptbooks) {
@@ -3215,16 +3239,15 @@
      * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
      * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
      *
-     * @private internal helper function
      * @returns secure random token
+     *
+     * @private internal helper function
      */
     function $randomToken(randomness) {
         return crypto.randomBytes(randomness).toString('hex');
     }
-    /**
-     * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
-     * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
-     */
+    // TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
+    // TODO: Maybe use nanoid instead https://github.com/ai/nanoid
 
     /**
      * This error indicates errors during the execution of the pipeline
@@ -3241,9 +3264,7 @@
             Object.setPrototypeOf(this, PipelineExecutionError.prototype);
         }
     }
-    /**
-     * TODO: [🧠][🌂] Add id to all errors
-     */
+    // TODO: [🧠][🌂] Add id to all errors
 
     /**
      * Determine if the pipeline is fully prepared
@@ -3366,17 +3387,16 @@
             Object.setPrototypeOf(this, DatabaseError.prototype);
         }
     }
-    /**
-     * TODO: [🐱‍🚀] Explain that NotFoundError ([🐱‍🚀] and other specific errors) has priority over DatabaseError in some contexts
-     */
+    // TODO: [🐱‍🚀] Explain that NotFoundError ([🐱‍🚀] and other specific errors) has priority over DatabaseError in some contexts
 
     /**
      * This error occurs when some expectation is not met in the execution of the pipeline
      *
-     * @public exported from `@promptbook/core`
      * Note: Do not throw this error, its reserved for `checkExpectations` and `createPipelineExecutor` and public ONLY to be serializable through remote server
      * Note: Always thrown in `checkExpectations` and catched in `createPipelineExecutor` and rethrown as `PipelineExecutionError`
      * Note: This is a kindof subtype of PipelineExecutionError
+     *
+     * @public exported from `@promptbook/core`
      */
     class ExpectError extends Error {
         constructor(message) {
@@ -3509,9 +3529,7 @@
         ...PROMPTBOOK_ERRORS,
         ...COMMON_JAVASCRIPT_ERRORS,
     };
-    /**
-     * Note: [💞] Ignore a discrepancy between file name and entity name
-     */
+    // Note: [💞] Ignore a discrepancy between file name and entity name
 
     /**
      * Serializes an error into a [🚉] JSON-serializable object
@@ -3580,7 +3598,7 @@
 
     /**
      * Recursively converts JSON strings to JSON objects
-
+     *
      * @public exported from `@promptbook/utils`
      */
     function jsonStringsToJsons(object) {
@@ -3604,9 +3622,7 @@
         }
         return newObject;
     }
-    /**
-     * TODO: Type the return type correctly
-     */
+    // TODO: Type the return type correctly
 
     /**
      * Deserializes the error object
@@ -3641,6 +3657,7 @@
      *
      * @param executionResult - The partial result of the Promptbook execution
      * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
+     *
      * @private internal helper function of `asPromise` method of `ExecutionTask`
      */
     function assertsTaskSuccessful(executionResult) {
@@ -3671,9 +3688,7 @@
                 `));
         }
     }
-    /**
-     * TODO: [🧠] Can this return type be better typed than void
-     */
+    // TODO: [🧠] Can this return type be better typed than void
 
     /**
      * Helper to create a new task
@@ -3864,10 +3879,8 @@
             },
         };
     }
-    /**
-     * TODO: Maybe allow to terminate the task and add getter `isFinished` or `status`
-     * TODO: [🐚] Split into more files and make `PrepareTask` & `RemoteTask` + split the function
-     */
+    // TODO: Maybe allow to terminate the task and add getter `isFinished` or `status`
+    // TODO: [🐚] Split into more files and make `PrepareTask` & `RemoteTask` + split the function
 
     /**
      * Represents the uncertain value
@@ -3935,9 +3948,7 @@
             pagesCount: UNCERTAIN_ZERO_VALUE,
         },
     });
-    /**
-     * Note: [💞] Ignore a discrepancy between file name and entity name
-     */
+    // Note: [💞] Ignore a discrepancy between file name and entity name
 
     /**
      * Async version of Array.forEach
@@ -3945,8 +3956,9 @@
      * @param array - Array to iterate over
      * @param options - Options for the function
      * @param callbackfunction - Function to call for each item
-     * @public exported from `@promptbook/utils`
      * @deprecated [🪂] Use queues instead
+     *
+     * @public exported from `@promptbook/utils`
      */
     async function forEachAsync(array, options, callbackfunction) {
         const { maxParallelCount = Infinity } = options;
@@ -4031,6 +4043,7 @@
      *
      * @param llmTools - The LLM tools to be intercepted and tracked
      * @returns Full proxy of the tools with added usage tracking capabilities
+     *
      * @public exported from `@promptbook/core`
      */
     function countUsage(llmTools) {
@@ -4155,6 +4168,7 @@
      * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
      *
      * Note: Internal utility of `joinLlmExecutionTools` but exposed type
+     *
      * @public exported from `@promptbook/core`
      */
     class MultipleLlmExecutionTools {
@@ -4317,16 +4331,16 @@
      * `MultipleLlmExecutionTools` object. It provides failover and aggregation logic:
      *
      * 1.  **Failover**: When a model call is made, it tries providers in the order they were provided.
-     *     If the first provider doesn't support the requested model or fails, it tries the next one.
+     * If the first provider doesn't support the requested model or fails, it tries the next one.
      * 2.  **Aggregation**: `listModels` returns a combined list of all models available from all providers.
      * 3.  **Empty case**: If no tools are provided, it logs a warning (as Promptbook requires LLMs to function).
      *
+     * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`.
+     *
      * @param title - A descriptive title for this collection of joined tools
      * @param llmExecutionTools - An array of execution tools to be joined
      * @returns A single unified execution tool wrapper
      *
-     * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`.
-     *
      * @public exported from `@promptbook/core`
      */
     function joinLlmExecutionTools(title, ...llmExecutionTools) {
@@ -4363,10 +4377,8 @@
         }
         return new MultipleLlmExecutionTools(title || 'Multiple LLM Providers joined by `joinLlmExecutionTools`', ...llmExecutionTools);
     }
-    /**
-     * TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
-     * TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
-     */
+    // TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
+    // TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
 
     /**
      * Just returns the given `LlmExecutionTools` or joins multiple into one
@@ -4380,15 +4392,14 @@
             : joinLlmExecutionTools('Multiple LLM Providers joined by `getSingleLlmExecutionTools`', ..._llms);
         return llmTools;
     }
-    /**
-     * TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
-     * TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
-     */
+    // TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
+    // TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
 
     /**
      * Prepares the persona for the pipeline
      *
      * @see https://github.com/webgptorg/promptbook/discussions/22
+     *
      * @public exported from `@promptbook/core`
      */
     async function preparePersona(personaDescription, tools, options) {
@@ -4445,13 +4456,11 @@
             modelsRequirements,
         };
     }
-    /**
-     * TODO: [😩] DRY `preparePersona` and `selectBestModelFromAvailable`
-     * TODO: [🔃][main] If the persona was prepared with different version or different set of models, prepare it once again
-     * TODO: [🏢] Check validity of `modelName` in pipeline
-     * TODO: [🏢] Check validity of `systemMessage` in pipeline
-     * TODO: [🏢] Check validity of `temperature` in pipeline
-     */
+    // TODO: [😩] DRY `preparePersona` and `selectBestModelFromAvailable`
+    // TODO: [🔃][main] If the persona was prepared with different version or different set of models, prepare it once again
+    // TODO: [🏢] Check validity of `modelName` in pipeline
+    // TODO: [🏢] Check validity of `systemMessage` in pipeline
+    // TODO: [🏢] Check validity of `temperature` in pipeline
 
     /**
      * Safely retrieves the global scope object (window in browser, global in Node.js)
@@ -4459,7 +4468,7 @@
      *
      * Note: `$` is used to indicate that this function is not a pure function - it access global scope
      *
-     *  @private internal function of `$Register`
+     * @private internal function of `$Register`
      */
     function $getGlobalScope() {
         return Function('return this')();
@@ -4474,6 +4483,7 @@
      * @returns The normalized text in SCREAMING_CASE format.
      * @example 'HELLO_WORLD'
      * @example 'I_LOVE_PROMPTBOOK'
+     *
      * @public exported from `@promptbook/utils`
      */
     function normalizeTo_SCREAMING_CASE(text) {
@@ -4531,6 +4541,7 @@
      * @returns The normalized text in snake_case format.
      * @example 'hello_world'
      * @example 'i_love_promptbook'
+     *
      * @public exported from `@promptbook/utils`
      */
     function normalizeTo_snake_case(text) {
@@ -4589,26 +4600,26 @@
      * Global registry for storing metadata about all available scrapers and converters.
      *
      * Note: `$` is used to indicate that this interacts with the global scope.
+     *
      * @singleton Only one instance of each register is created per build, but there can be more in different contexts (e.g., tests).
+     *
      * @public exported from `@promptbook/core`
      */
     const $scrapersMetadataRegister = new $Register('scrapers_metadata');
-    /**
-     * TODO: [®] DRY Register logic
-     */
+    // TODO: [®] DRY Register logic
 
     /**
      * Registry for all available scrapers in the system.
      * Central point for registering and accessing different types of content scrapers.
      *
      * Note: `$` is used to indicate that this interacts with the global scope
+     *
      * @singleton Only one instance of each register is created per build, but there can be more than one in different build modules
+     *
      * @public exported from `@promptbook/core`
      */
     const $scrapersRegister = new $Register('scraper_constructors');
-    /**
-     * TODO: [®] DRY Register logic
-     */
+    // TODO: [®] DRY Register logic
 
     /**
      * Creates a message with all registered scrapers
@@ -4693,9 +4704,7 @@
 
         `);
     }
-    /**
-     * TODO: [®] DRY Register logic
-     */
+    // TODO: [®] DRY Register logic
 
     /**
      * Creates unique name for the source
@@ -4714,9 +4723,7 @@
         // <- TODO: Use MAX_FILENAME_LENGTH
         return name;
     }
-    /**
-     * TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
-     */
+    // TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
 
     /**
      * Convert file extension to mime type
@@ -4765,9 +4772,7 @@
                 `));
         }
     };
-    /**
-     * TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
-     */
+    // TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
 
     /**
      * Factory function that creates a handler for processing knowledge sources.
@@ -4987,6 +4992,7 @@
      * Prepares the knowledge pieces
      *
      * @see https://github.com/webgptorg/promptbook/discussions/41
+     *
      * @public exported from `@promptbook/core`
      */
     async function prepareKnowledgePieces(knowledgeSources, tools, options) {
@@ -5128,25 +5134,24 @@
         });
         return { tasksPrepared };
     }
-    /**
-     * TODO: [😂] Adding knowledge should be convert to async high-level abstractions, similar thing with expectations to sync high-level abstractions
-     * TODO: [🧠] Add context to each task (if missing)
-     * TODO: [🧠] What is better name `prepareTask` or `prepareTaskAndParameters`
-     * TODO: [♨][main] !!3 Prepare index the examples and maybe tasks
-     * TODO: Write tests for `preparePipeline`
-     * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
-     * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
-     * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
-     */
+    // TODO: [😂] Adding knowledge should be convert to async high-level abstractions, similar thing with expectations to sync high-level abstractions
+    // TODO: [🧠] Add context to each task (if missing)
+    // TODO: [🧠] What is better name `prepareTask` or `prepareTaskAndParameters`
+    // TODO: [♨][main] !!3 Prepare index the examples and maybe tasks
+    // TODO: Write tests for `preparePipeline`
+    // TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
+    // TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
+    // TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
 
     /**
      * Prepare pipeline locally
      *
-     * @see https://github.com/webgptorg/promptbook/discussions/196
-     *
      * Note: This function does not validate logic of the pipeline
      * Note: This function acts as part of compilation process
      * Note: When the pipeline is already prepared, it returns the same pipeline
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/196
+     *
      * @public exported from `@promptbook/core`
      */
     async function preparePipeline(pipeline, tools, options) {
@@ -5317,8 +5322,8 @@
      * This is useful and used in the `templateParameters` function
      *
      * Note: This function is not just calling `toString` method
-     *       It's more complex and can handle this conversion specifically for LLM models
-     *       See `VALUE_STRINGS`
+     * It's more complex and can handle this conversion specifically for LLM models
+     * See `VALUE_STRINGS`
      *
      * Note: There are 2 similar functions
      * - `valueToString` converts value to string for LLM models as human-readable string
@@ -5371,6 +5376,7 @@
      * @param script from which to extract the variables
      * @returns the list of variable names
      * @throws {ParseError} if the script is invalid
+     *
      * @public exported from `@promptbook/javascript`
      */
     function extractVariablesFromJavascript(script) {
@@ -5436,9 +5442,7 @@
         }
         return variables;
     }
-    /**
-     * TODO: [🔣] Support for multiple languages - python, java,...
-     */
+    // TODO: [🔣] Support for multiple languages - python, java,...
 
     /**
      * Parses the task and returns the set of all used parameters
@@ -5446,6 +5450,7 @@
      * @param task the task with used parameters
      * @returns the set of parameter names
      * @throws {ParseError} if the script is invalid
+     *
      * @public exported from `@promptbook/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
      */
     function extractParameterNamesFromTask(task) {
@@ -5486,14 +5491,13 @@
         }
         return parameterNames;
     }
-    /**
-     * TODO: [🔣] If script require contentLanguage
-     */
+    // TODO: [🔣] If script require contentLanguage
 
     /**
      * Create difference set of two sets.
      *
      * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
+     *
      * @public exported from `@promptbook/utils`
      */
     function difference(a, b, isEqual = (a, b) => a === b) {
@@ -5505,14 +5509,13 @@
         }
         return diff;
     }
-    /**
-     * TODO: [🧠][💯] Maybe also implement symmetricDifference
-     */
+    // TODO: [🧠][💯] Maybe also implement symmetricDifference
 
     /**
      * Creates a new set with all elements that are present in either set
      *
      * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
+     *
      * @public exported from `@promptbook/utils`
      */
     function union(...sets) {
@@ -5578,8 +5581,9 @@
     /**
      * Definition for CSV spreadsheet
      *
+     * TODO: [🏢] Export from package `@promptbook/csv`
+     *
      * @public exported from `@promptbook/core`
-     *                          <- TODO: [🏢] Export from package `@promptbook/csv`
      */
     const CsvFormatParser = {
         formatName: 'CSV',
@@ -5669,13 +5673,11 @@
             },
         ],
     };
-    /**
-     * TODO: [🍓] In `CsvFormatParser` implement simple `isValid`
-     * TODO: [🍓] In `CsvFormatParser` implement partial `canBeValid`
-     * TODO: [🍓] In `CsvFormatParser` implement `heal
-     * TODO: [🍓] In `CsvFormatParser` implement `subvalueParsers`
-     * TODO: [🏢] Allow to expect something inside CSV objects and other formats
-     */
+    // TODO: [🍓] In `CsvFormatParser` implement simple `isValid`
+    // TODO: [🍓] In `CsvFormatParser` implement partial `canBeValid`
+    // TODO: [🍓] In `CsvFormatParser` implement `heal
+    // TODO: [🍓] In `CsvFormatParser` implement `subvalueParsers`
+    // TODO: [🏢] Allow to expect something inside CSV objects and other formats
 
     /**
      * Definition for JSON format
@@ -5696,17 +5698,15 @@
         },
         subvalueParsers: [],
     };
-    /**
-     * TODO: [🧠] Maybe proper instance of object
-     * TODO: [0] Make string_serialized_json
-     * TODO: [1] Make type for JSON Settings and Schema
-     * TODO: [🧠] What to use for validating JSONs - JSON Schema, ZoD, typescript types/interfaces,...?
-     * TODO: [🍓] In `JsonFormatParser` implement simple `isValid`
-     * TODO: [🍓] In `JsonFormatParser` implement partial `canBeValid`
-     * TODO: [🍓] In `JsonFormatParser` implement `heal
-     * TODO: [🍓] In `JsonFormatParser` implement `subvalueParsers`
-     * TODO: [🏢] Allow to expect something inside JSON objects and other formats
-     */
+    // TODO: [🧠] Maybe proper instance of object
+    // TODO: [0] Make string_serialized_json
+    // TODO: [1] Make type for JSON Settings and Schema
+    // TODO: [🧠] What to use for validating JSONs - JSON Schema, ZoD, typescript types/interfaces,...?
+    // TODO: [🍓] In `JsonFormatParser` implement simple `isValid`
+    // TODO: [🍓] In `JsonFormatParser` implement partial `canBeValid`
+    // TODO: [🍓] In `JsonFormatParser` implement `heal
+    // TODO: [🍓] In `JsonFormatParser` implement `subvalueParsers`
+    // TODO: [🏢] Allow to expect something inside JSON objects and other formats
 
     /**
      * Definition for any text - this will be always valid
@@ -5744,15 +5744,13 @@
             // <- TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages available as subvalues
         ],
     };
-    /**
-     * TODO: [1] Make type for XML Text and Schema
-     * TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages available as subvalues
-     * TODO: [🍓] In `TextFormatParser` implement simple `isValid`
-     * TODO: [🍓] In `TextFormatParser` implement partial `canBeValid`
-     * TODO: [🍓] In `TextFormatParser` implement `heal
-     * TODO: [🍓] In `TextFormatParser` implement `subvalueParsers`
-     * TODO: [🏢] Allow to expect something inside each item of list and other formats
-     */
+    // TODO: [1] Make type for XML Text and Schema
+    // TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages available as subvalues
+    // TODO: [🍓] In `TextFormatParser` implement simple `isValid`
+    // TODO: [🍓] In `TextFormatParser` implement partial `canBeValid`
+    // TODO: [🍓] In `TextFormatParser` implement `heal
+    // TODO: [🍓] In `TextFormatParser` implement `subvalueParsers`
+    // TODO: [🏢] Allow to expect something inside each item of list and other formats
 
     /**
      * Function to check if a string is valid XML
@@ -5797,17 +5795,15 @@
         },
         subvalueParsers: [],
     };
-    /**
-     * TODO: [🧠] Maybe proper instance of object
-     * TODO: [0] Make string_serialized_xml
-     * TODO: [1] Make type for XML Settings and Schema
-     * TODO: [🧠] What to use for validating XMLs - XSD,...
-     * TODO: [🍓] In `XmlFormatParser` implement simple `isValid`
-     * TODO: [🍓] In `XmlFormatParser` implement partial `canBeValid`
-     * TODO: [🍓] In `XmlFormatParser` implement `heal
-     * TODO: [🍓] In `XmlFormatParser` implement `subvalueParsers`
-     * TODO: [🏢] Allow to expect something inside XML and other formats
-     */
+    // TODO: [🧠] Maybe proper instance of object
+    // TODO: [0] Make string_serialized_xml
+    // TODO: [1] Make type for XML Settings and Schema
+    // TODO: [🧠] What to use for validating XMLs - XSD,...
+    // TODO: [🍓] In `XmlFormatParser` implement simple `isValid`
+    // TODO: [🍓] In `XmlFormatParser` implement partial `canBeValid`
+    // TODO: [🍓] In `XmlFormatParser` implement `heal
+    // TODO: [🍓] In `XmlFormatParser` implement `subvalueParsers`
+    // TODO: [🏢] Allow to expect something inside XML and other formats
 
     /**
      * Definitions for all formats supported by Promptbook
@@ -5815,9 +5811,7 @@
      * @private internal index of `...` <- TODO [🏢]
      */
     const FORMAT_DEFINITIONS = [JsonFormatParser, XmlFormatParser, TextFormatParser, CsvFormatParser];
-    /**
-     * Note: [💞] Ignore a discrepancy between file name and entity name
-     */
+    // Note: [💞] Ignore a discrepancy between file name and entity name
 
     /**
      * Maps available parameters to expected parameters for a pipeline task.
@@ -5827,6 +5821,7 @@
      * 2) Then, if there are unmatched expected and available parameters, map them by order.
      *
      * @throws {PipelineExecutionError} If the number of unmatched expected and available parameters does not match, or mapping is ambiguous.
+     *
      * @private within the repository used in `createPipelineExecutor`
      */
     function mapAvailableToExpectedParameters(options) {
@@ -5889,12 +5884,13 @@
      * Replaces parameters in template with values from parameters object
      *
      * Note: This function is not places strings into string,
-     *       It's more complex and can handle this operation specifically for LLM models
+     * It's more complex and can handle this operation specifically for LLM models
      *
      * @param template the template with parameters in {curly} braces
      * @param parameters the object with parameters
      * @returns the template with replaced parameters
      * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
+     *
      * @public exported from `@promptbook/utils`
      */
     function templateParameters(template, parameters) {
@@ -5968,6 +5964,7 @@
      * @param markdown any valid markdown
      * @returns code blocks with language and content
      * @throws {ParseError} if block is not closed properly
+     *
      * @public exported from `@promptbook/markdown-utils`
      */
     function extractAllBlocksFromMarkdown(markdown) {
@@ -6018,9 +6015,7 @@
         }
         return codeBlocks;
     }
-    /**
-     * TODO: Maybe name for `blockNotation` instead of  '```' and '>'
-     */
+    // TODO: Maybe name for `blockNotation` instead of  '```' and '>'
 
     /**
      * Extracts  extracts exactly one valid JSON code block
@@ -6036,8 +6031,9 @@
      * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
      * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
      *
-     * @public exported from `@promptbook/markdown-utils`
      * @throws {ParseError} if there is no valid JSON block in the markdown
+     *
+     * @public exported from `@promptbook/markdown-utils`
      */
     function extractJsonBlock(markdown) {
         if (isValidJsonString(markdown)) {
@@ -6053,10 +6049,8 @@
         }
         return jsonBlocks[0].content;
     }
-    /**
-     * TODO: Add some auto-healing logic + extract YAML, JSON5, TOML, etc.
-     * TODO: [🏢] Make this logic part of `JsonFormatParser` or `isValidJsonString`
-     */
+    // TODO: Add some auto-healing logic + extract YAML, JSON5, TOML, etc.
+    // TODO: [🏢] Make this logic part of `JsonFormatParser` or `isValidJsonString`
 
     /**
      * Counts number of characters in the text
@@ -6072,10 +6066,8 @@
         text = text.replace(/\p{Extended_Pictographic}(\u{200D}\p{Extended_Pictographic})*/gu, '-');
         return text.length;
     }
-    /**
-     * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
-     * TODO: [🧠][✌️] Make some Promptbook-native token system
-     */
+    // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+    // TODO: [🧠][✌️] Make some Promptbook-native token system
 
     /**
      * Number of characters per standard line with 11pt Arial font size.
@@ -6089,10 +6081,8 @@
      * @public exported from `@promptbook/utils`
      */
     const LINES_PER_STANDARD_PAGE = 44;
-    /**
-     * TODO: [🧠] Should be this `constants.ts` or `config.ts`?
-     * Note: [💞] Ignore a discrepancy between file name and entity name
-     */
+    // TODO: [🧠] Should be this `constants.ts` or `config.ts`?
+    // Note: [💞] Ignore a discrepancy between file name and entity name
 
     /**
      * Counts number of lines in the text
@@ -6110,10 +6100,8 @@
         const lines = text.split(/\r?\n/);
         return lines.reduce((count, line) => count + Math.max(Math.ceil(line.length / CHARACTERS_PER_STANDARD_LINE), 1), 0);
     }
-    /**
-     * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
-     * TODO: [🧠][✌️] Make some Promptbook-native token system
-     */
+    // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+    // TODO: [🧠][✌️] Make some Promptbook-native token system
 
     /**
      * Counts number of pages in the text
@@ -6125,10 +6113,8 @@
     function countPages(text) {
         return Math.ceil(countLines(text) / LINES_PER_STANDARD_PAGE);
     }
-    /**
-     * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
-     * TODO: [🧠][✌️] Make some Promptbook-native token system
-     */
+    // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+    // TODO: [🧠][✌️] Make some Promptbook-native token system
 
     /**
      * Counts number of paragraphs in the text
@@ -6138,10 +6124,8 @@
     function countParagraphs(text) {
         return text.split(/\n\s*\n/).filter((paragraph) => paragraph.trim() !== '').length;
     }
-    /**
-     * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
-     * TODO: [🧠][✌️] Make some Promptbook-native token system
-     */
+    // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+    // TODO: [🧠][✌️] Make some Promptbook-native token system
 
     /**
      * Split text into sentences
@@ -6159,10 +6143,8 @@
     function countSentences(text) {
         return splitIntoSentences(text).length;
     }
-    /**
-     * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
-     * TODO: [🧠][✌️] Make some Promptbook-native token system
-     */
+    // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+    // TODO: [🧠][✌️] Make some Promptbook-native token system
 
     /**
      * Counts number of words in the text
@@ -6176,11 +6158,9 @@
         text = text.replace(/([a-z])([A-Z])/g, '$1 $2');
         return text.split(/[^a-zа-я0-9]+/i).filter((word) => word.length > 0).length;
     }
-    /**
-     * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
-     * TODO: [🧠][✌️] Make some Promptbook-native token system
-     * TODO: [✌️] `countWords` should be just `splitWords(...).length`, and all other counters should use this pattern as well
-     */
+    // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+    // TODO: [🧠][✌️] Make some Promptbook-native token system
+    // TODO: [✌️] `countWords` should be just `splitWords(...).length`, and all other counters should use this pattern as well
 
     /**
      * Index of all counter functions
@@ -6195,10 +6175,8 @@
         LINES: countLines,
         PAGES: countPages,
     };
-    /**
-     * TODO: [🧠][🤠] This should be probably as part of `TextFormatParser`
-     * Note: [💞] Ignore a discrepancy between file name and entity name
-     */
+    // TODO: [🧠][🤠] This should be probably as part of `TextFormatParser`
+    // Note: [💞] Ignore a discrepancy between file name and entity name
 
     /**
      * Function checkExpectations will check if the expectations on given value are met
@@ -6209,6 +6187,7 @@
      *
      * @throws {ExpectError} if the expectations are not met
      * @returns {void} Nothing
+     *
      * @private internal function of `createPipelineExecutor`
      */
     function checkExpectations(expectations, value) {
@@ -6222,11 +6201,9 @@
             }
         }
     }
-    /**
-     * TODO: [💝] Unite object for expecting amount and format
-     * TODO: [🧠][🤠] This should be part of `TextFormatParser`
-     * Note: [💝] and [🤠] are interconnected together
-     */
+    // TODO: [💝] Unite object for expecting amount and format
+    // TODO: [🧠][🤠] This should be part of `TextFormatParser`
+    // Note: [💝] and [🤠] are interconnected together
 
     /**
      * Validates a prompt result against expectations and format requirements.
@@ -6237,6 +6214,7 @@
      *
      * @param options - The validation options including result string, expectations, and format
      * @returns Validation result with processed string and validity status
+     *
      * @private internal function of `createPipelineExecutor` and `cacheLlmTools`
      */
     function validatePromptResult(options) {
@@ -6299,6 +6277,7 @@
      *
      * @param options - The options for execution, including task, parameters, pipeline, and configuration.
      * @returns The result string of the executed task.
+     *
      * @private internal utility of `createPipelineExecutor`
      */
     async function executeAttempts(options) {
@@ -6622,9 +6601,7 @@
         }
         return $ongoingTaskResult.$resultString;
     }
-    /**
-     * TODO: Break into smaller functions
-     */
+    // TODO: Break into smaller functions
 
     /**
      * Executes a pipeline task that requires mapping or iterating over subvalues of a parameter (such as rows in a CSV).
@@ -6767,6 +6744,7 @@
      *
      * @param task - The task for which the context is being generated. This should be a deeply immutable TaskJson object.
      * @returns The context as a string, formatted as markdown and parameter value.
+     *
      * @private internal utility of `createPipelineExecutor`
      */
     async function getContextForTask(task) {
@@ -6804,7 +6782,6 @@
     }
 
     /**
-     *
      * @param knowledgePieces
      * @returns
      *
@@ -6885,10 +6862,8 @@
             return knowledgePiecesToString(preparedPipeline.knowledgePieces);
         }
     }
-    /**
-     * TODO: [♨] Implement Better - use keyword search
-     * TODO: [♨] Examples of values
-     */
+    // TODO: [♨] Implement Better - use keyword search
+    // TODO: [♨] Examples of values
 
     /**
      * Retrieves all reserved parameters for a given pipeline task, including context, knowledge, examples, and metadata.
@@ -7041,9 +7016,7 @@
             resultString,
         });
     }
-    /**
-     * TODO: [🤹‍♂️]
-     */
+    // TODO: [🤹‍♂️]
 
     /**
      * Filters and returns only the output parameters from the provided pipeline execution options.
@@ -7373,6 +7346,7 @@
      *
      * @returns The executor function
      * @throws {PipelineLogicError} on logical error in the pipeline
+     *
      * @public exported from `@promptbook/core`
      */
     function createPipelineExecutor(options) {
@@ -7547,14 +7521,13 @@
      * @public exported from `@promptbook/cli`
      */
     $scrapersMetadataRegister.register(markdownScraperMetadata);
-    /**
-     * Note: [💞] Ignore a discrepancy between file name and entity name
-     */
+    // Note: [💞] Ignore a discrepancy between file name and entity name
 
     /**
      * Scraper for markdown files
      *
      * @see `documentationUrl` for more details
+     *
      * @public exported from `@promptbook/markdown-utils`
      */
     class MarkdownScraper {
@@ -7687,10 +7660,8 @@
             return knowledge;
         }
     }
-    /**
-     * TODO: [🪂] Do it in parallel 11:11
-     * Note: No need to aggregate usage here, it is done by intercepting the llmTools
-     */
+    // TODO: [🪂] Do it in parallel 11:11
+    // Note: No need to aggregate usage here, it is done by intercepting the llmTools
 
     /**
      * Metadata of the scraper
@@ -7717,15 +7688,14 @@
      * @public exported from `@promptbook/cli`
      */
     $scrapersMetadataRegister.register(documentScraperMetadata);
-    /**
-     * Note: [💞] Ignore a discrepancy between file name and entity name
-     */
+    // Note: [💞] Ignore a discrepancy between file name and entity name
 
     // TODO: [🏳‍🌈] Finally take pick of .json vs .ts
     /**
      * Scraper of .docx and .odt files
      *
      * @see `documentationUrl` for more details
+     *
      * @public exported from `@promptbook/documents`
      */
     class DocumentScraper {
@@ -7821,12 +7791,10 @@
             return knowledge;
         }
     }
-    /**
-     * TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
-     * TODO: [🪂] Do it in parallel 11:11
-     * Note: No need to aggregate usage here, it is done by intercepting the llmTools
-     * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
-     */
+    // Note: [🟢] Code for Node scraper implementation [DocumentScraper](src/scrapers/document/DocumentScraper.ts) should never be published into packages that could be imported into browser environment
+    // TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
+    // TODO: [🪂] Do it in parallel 11:11
+    // Note: No need to aggregate usage here, it is done by intercepting the llmTools
 
     /**
      * Creates a scraper for document content.
@@ -7836,9 +7804,7 @@
     const createDocumentScraper = Object.assign((tools, options) => {
         return new DocumentScraper(tools, options);
     }, documentScraperMetadata); /* <- Note: [🤛] */
-    /**
-     * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
-     */
+    // TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
 
     /**
      * Registration of known scraper
@@ -7850,10 +7816,8 @@
      * @public exported from `@promptbook/cli`
      */
     const _DocumentScraperRegistration = $scrapersRegister.register(createDocumentScraper);
-    /**
-     * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
-     * Note: [💞] Ignore a discrepancy between file name and entity name
-     */
+    // TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+    // Note: [💞] Ignore a discrepancy between file name and entity name
 
     exports.BOOK_LANGUAGE_VERSION = BOOK_LANGUAGE_VERSION;
     exports.DocumentScraper = DocumentScraper;