@promptbook/markdown-utils 0.112.0-34 → 0.112.0-36

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.112.0-34';
+    const PROMPTBOOK_ENGINE_VERSION = '0.112.0-36';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -41,9 +41,7 @@
             Object.setPrototypeOf(this, ParseError.prototype);
         }
     }
-    /**
-     * TODO: Maybe split `ParseError` and `ApplyError`
-     */
+    // TODO: Maybe split `ParseError` and `ApplyError`
 
     /**
      * Makes first letter of a string uppercase
@@ -68,6 +66,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) {
@@ -118,9 +117,7 @@
         }
         return codeBlocks;
     }
-    /**
-     * TODO: Maybe name for `blockNotation` instead of  '```' and '>'
-     */
+    // TODO: Maybe name for `blockNotation` instead of  '```' and '>'
 
     /**
      * Extracts exactly ONE code block from markdown.
@@ -135,8 +132,9 @@
      *
      * @param markdown any valid markdown
      * @returns code block with language and content
-     * @public exported from `@promptbook/markdown-utils`
      * @throws {ParseError} if there is not exactly one code block in the markdown
+     *
+     * @public exported from `@promptbook/markdown-utils`
      */
     function extractOneBlockFromMarkdown(markdown) {
         const codeBlocks = extractAllBlocksFromMarkdown(markdown);
@@ -149,9 +147,7 @@
         }
         return codeBlocks[0];
     }
-    /***
-     * TODO: [🍓][🌻] Decide of this is internal utility, external util OR validator/postprocessor
-     */
+    // TODO: [🍓][🌻] Decide of this is internal utility, external util OR validator/postprocessor
 
     /**
      * Extracts code block from markdown.
@@ -164,8 +160,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 not exactly one code block in the markdown
+     *
+     * @public exported from `@promptbook/markdown-utils`
      */
     function extractBlock(markdown) {
         const { content } = extractOneBlockFromMarkdown(markdown);
@@ -176,16 +173,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) {
@@ -202,9 +203,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) {
@@ -382,9 +383,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.
@@ -414,7 +413,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.
@@ -447,6 +452,9 @@
         }
         return throwInvalidHex();
     }
+    /**
+     * Parses short hex channel.
+     */
     function parseShortHexChannel(char, onError) {
         if (!char) {
             return onError();
@@ -457,6 +465,9 @@
         }
         return parsed * 16;
     }
+    /**
+     * Parses long hex channel.
+     */
     function parseLongHexChannel(hex, start, onError) {
         const segment = hex.substr(start, 2);
         if (segment.length < 2) {
@@ -469,6 +480,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.
@@ -494,6 +508,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));
@@ -532,7 +549,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.
@@ -574,6 +597,9 @@
             alpha: parseAlphaValue(match[4]),
         };
     }
+    /**
+     * Parses channel value.
+     */
     function parseChannelValue(value) {
         if (value.endsWith('%')) {
             const percent = parseFloat(value);
@@ -581,6 +607,9 @@
         }
         return Math.round(parseFloat(value));
     }
+    /**
+     * Parses alpha value.
+     */
     function parseAlphaValue(value) {
         if (value.endsWith('%')) {
             const percent = parseFloat(value);
@@ -593,8 +622,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
@@ -960,9 +998,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
@@ -1008,9 +1044,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
@@ -1028,9 +1062,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
@@ -1048,9 +1080,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.
@@ -1063,6 +1093,7 @@
      *
      * @param value any values
      * @returns the same values
+     *
      * @private within the repository
      */
     function just(value) {
@@ -1452,8 +1483,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)) {
@@ -1469,10 +1501,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`
 
     /**
      * Just says that the variable is not used but should be kept
@@ -1486,6 +1516,7 @@
      *
      * @param value any values
      * @returns void
+     *
      * @private within the repository
      */
     function keepUnused(...valuesToKeep) {
@@ -1512,6 +1543,7 @@
      * 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) {
@@ -1560,9 +1592,7 @@
         }
         return false;
     }
-    /**
-     * TODO: [🍏] Implement for MacOs
-     */
+    // TODO: [🍏] Implement for MacOs
 
     /**
      * Tests if given string is valid URL.
@@ -1604,6 +1634,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) {
@@ -1622,17 +1653,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 -->`);
@@ -1644,6 +1674,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) {
@@ -1760,6 +1791,8 @@
         return validatePipelineString(pipelineString);
     }
     /**
+     * Handles task parameter Json to string.
+     *
      * @private internal utility of `pipelineJsonToString`
      */
     function taskParameterJsonToString(taskParameterJson) {
@@ -1770,18 +1803,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) {
@@ -1800,6 +1832,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) {
@@ -1816,9 +1849,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
@@ -1838,6 +1869,7 @@
      * - And much more...
      *
      * @throws UnexpectedError if the value is not serializable as JSON
+     *
      * @public exported from `@promptbook/utils`
      */
     function checkSerializableAsJson(options) {
@@ -1952,11 +1984,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
@@ -1966,6 +1996,7 @@
      *
      * @param objectValue The object to clone.
      * @returns A deep, writable clone of the input object.
+     *
      * @public exported from `@promptbook/utils`
      */
     function deepClone(objectValue) {
@@ -1982,9 +2013,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
@@ -1997,6 +2026,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) {
@@ -2016,9 +2046,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
@@ -2078,9 +2106,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)
@@ -2118,12 +2144,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) {
@@ -2166,9 +2193,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
@@ -2185,6 +2210,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) {
@@ -2209,6 +2235,8 @@
         return pipeline;
     }
     /**
+     * Validates pipeline inner function.
+     *
      * @private internal function for `validatePipeline`
      */
     function validatePipeline_InnerFunction(pipeline) {
@@ -2453,15 +2481,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
@@ -2494,6 +2520,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) {
@@ -2510,6 +2537,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) {
@@ -2538,18 +2566,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 {
         /**
@@ -2653,6 +2680,7 @@
      *
      * @param promptbookSources
      * @returns PipelineCollection
+     *
      * @public exported from `@promptbook/core`
      */
     function createPipelineCollectionFromJson(...promptbooks) {
@@ -2683,16 +2711,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
@@ -2709,9 +2736,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
@@ -2834,9 +2859,7 @@
             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 type indicates that you try to use a feature that is not available in the current environment
@@ -2854,10 +2877,11 @@
     /**
      * 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) {
@@ -3003,9 +3027,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
@@ -3074,7 +3096,7 @@
 
     /**
      * Recursively converts JSON strings to JSON objects
-
+     *
      * @public exported from `@promptbook/utils`
      */
     function jsonStringsToJsons(object) {
@@ -3098,9 +3120,7 @@
         }
         return newObject;
     }
-    /**
-     * TODO: Type the return type correctly
-     */
+    // TODO: Type the return type correctly
 
     /**
      * Deserializes the error object
@@ -3135,6 +3155,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) {
@@ -3165,9 +3186,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
@@ -3358,10 +3377,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
@@ -3429,9 +3446,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
@@ -3439,8 +3454,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;
@@ -3525,6 +3541,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) {
@@ -3649,6 +3666,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 {
@@ -3811,16 +3829,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) {
@@ -3857,10 +3875,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
@@ -3874,15 +3890,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) {
@@ -3939,13 +3954,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)
@@ -3953,7 +3966,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')();
@@ -3968,6 +3981,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) {
@@ -4025,6 +4039,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) {
@@ -4083,26 +4098,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
@@ -4187,10 +4202,11 @@
 
         `);
     }
+    // TODO: [®] DRY Register logic
+
     /**
-     * TODO: [®] DRY Register logic
+     * Collection of default diacritics removal map.
      */
-
     const defaultDiacriticsRemovalMap = [
         {
             base: 'A',
@@ -4442,6 +4458,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) {
@@ -4450,9 +4467,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.
@@ -4463,6 +4478,7 @@
      * @returns The kebab-case formatted string.
      * @example 'hello-world'
      * @example 'i-love-promptbook'
+     *
      * @public exported from `@promptbook/utils`
      */
     function normalizeToKebabCase(text) {
@@ -4503,9 +4519,7 @@
         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
 
     /**
      * Creates unique name for the source
@@ -4524,9 +4538,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-...
 
     /**
      * Converts a name to a properly formatted subfolder path for cache storage.
@@ -4576,11 +4588,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?
 
     /**
      * Convert mime type to file extension
@@ -4600,6 +4610,7 @@
      *
      * @param text with emojis
      * @returns text without emojis
+     *
      * @public exported from `@promptbook/utils`
      */
     function removeEmojis(text) {
@@ -4619,6 +4630,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) {
@@ -4664,9 +4676,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.
@@ -4886,6 +4896,7 @@
      * Prepares the knowledge pieces
      *
      * @see https://github.com/webgptorg/promptbook/discussions/41
+     *
      * @public exported from `@promptbook/core`
      */
     async function prepareKnowledgePieces(knowledgeSources, tools, options) {
@@ -5027,25 +5038,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) {
@@ -5216,8 +5226,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
@@ -5270,6 +5280,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) {
@@ -5335,9 +5346,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
@@ -5345,6 +5354,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) {
@@ -5385,14 +5395,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) {
@@ -5404,14 +5413,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) {
@@ -5477,8 +5485,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',
@@ -5568,13 +5577,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
@@ -5595,17 +5602,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
@@ -5643,15 +5648,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
@@ -5696,17 +5699,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
@@ -5714,9 +5715,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.
@@ -5726,6 +5725,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) {
@@ -5788,12 +5788,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) {
@@ -5869,10 +5870,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.
@@ -5886,10 +5885,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
@@ -5907,10 +5904,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
@@ -5922,10 +5917,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
@@ -5935,10 +5928,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
@@ -5956,10 +5947,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
@@ -5973,11 +5962,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
@@ -5992,10 +5979,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
@@ -6006,6 +5991,7 @@
      *
      * @throws {ExpectError} if the expectations are not met
      * @returns {void} Nothing
+     *
      * @private internal function of `createPipelineExecutor`
      */
     function checkExpectations(expectations, value) {
@@ -6019,11 +6005,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.
@@ -6034,6 +6018,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) {
@@ -6096,6 +6081,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) {
@@ -6419,9 +6405,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).
@@ -6564,6 +6548,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) {
@@ -6601,7 +6586,6 @@
     }
 
     /**
-     *
      * @param knowledgePieces
      * @returns
      *
@@ -6682,10 +6666,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.
@@ -6838,9 +6820,7 @@
             resultString,
         });
     }
-    /**
-     * TODO: [🤹‍♂️]
-     */
+    // TODO: [🤹‍♂️]
 
     /**
      * Filters and returns only the output parameters from the provided pipeline execution options.
@@ -7170,6 +7150,7 @@
      *
      * @returns The executor function
      * @throws {PipelineLogicError} on logical error in the pipeline
+     *
      * @public exported from `@promptbook/core`
      */
     function createPipelineExecutor(options) {
@@ -7344,14 +7325,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 {
@@ -7484,10 +7464,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
 
     /**
      * Creates a scraper for markdown content.
@@ -7497,9 +7475,7 @@
     const createMarkdownScraper = Object.assign((tools, options) => {
         return new MarkdownScraper(tools, options);
     }, markdownScraperMetadata); /* <- Note: [🤛] */
-    /**
-     * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
-     */
+    // TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
 
     /**
      * Registration of known scraper
@@ -7511,16 +7487,15 @@
      * @public exported from `@promptbook/cli`
      */
     const _MarkdownScraperRegistration = $scrapersRegister.register(createMarkdownScraper);
-    /**
-     * 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
 
     /**
      * Removes Markdown (or HTML) comments
      *
      * @param {string} content - The string to remove comments from.
      * @returns {string} The input string with all comments removed.
+     *
      * @public exported from `@promptbook/markdown-utils`
      */
     function removeMarkdownComments(content) {
@@ -7565,9 +7540,7 @@
             ${block(contentToInsert)}
         `);
     }
-    /**
-     * TODO: [🏛] This can be part of markdown builder
-     */
+    // TODO: [🏛] This can be part of markdown builder
 
     /**
      * Create a markdown table from a 2D array of strings
@@ -7594,9 +7567,7 @@
         });
         return [header, separator, ...rows].join('\n');
     }
-    /**
-     * TODO: [🏛] This can be part of markdown builder
-     */
+    // TODO: [🏛] This can be part of markdown builder
 
     /**
      * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
@@ -7634,9 +7605,7 @@
     function escapeMarkdownBlock(value) {
         return value.replace(/```/g, '\\`\\`\\`');
     }
-    /**
-     * TODO: [🏛] This can be part of markdown builder
-     */
+    // TODO: [🏛] This can be part of markdown builder
 
     /**
      * Utility function to extract all list items from markdown
@@ -7648,6 +7617,7 @@
      *
      * @param markdown any valid markdown
      * @returns An array of strings, each representing an individual list item found in the markdown
+     *
      * @public exported from `@promptbook/markdown-utils`
      */
     function extractAllListItemsFromMarkdown(markdown) {
@@ -7804,9 +7774,7 @@
     function humanizeAiTextEllipsis(aiText) {
         return aiText.replace(/[…⋯]/g, '...').replace(/\.\s+\.\s+\./g, '...');
     }
-    /**
-     * Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
-     */
+    // Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
 
     /**
      * Change dash-like characters to regular dashes `—` -> `-` and remove soft hyphens
@@ -7819,9 +7787,7 @@
     function humanizeAiTextEmdashed(aiText) {
         return aiText.replace(/\u00AD/g, '').replace(/[‐‑‒–—―−⁃﹣－]/g, '-');
     }
-    /**
-     * Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
-     */
+    // Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
 
     /**
      * Change smart quotes to regular quotes
@@ -7834,9 +7800,7 @@
     function humanizeAiTextQuotes(aiText) {
         return aiText.replace(/[“”„‟«»❝❞〝〞〟＂]/g, '"').replace(/[‚‘’‛‹›❛❜＇ʼ]/g, "'");
     }
-    /**
-     * Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
-     */
+    // Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
 
     /**
      * Remove bracketed source citation artifacts like `\u30105:1\u2020source\u3011`.
@@ -7849,9 +7813,7 @@
     function humanizeAiTextSources(aiText) {
         return aiText.replace(/[ \t]*\u3010\s*\d+(?:\s*:\s*\d+)?\s*\u2020source\s*\u3011/g, '');
     }
-    /**
-     * Note: [??] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
-     */
+    // Note: [??] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
 
     /**
      * Change unprintable hard spaces to regular spaces and drop zero-width spaces
@@ -7864,9 +7826,7 @@
     function humanizeAiTextWhitespace(aiText) {
         return aiText.replace(/[\u00A0\u1680\u2000-\u200A\u202F\u205F\u3000]/g, ' ').replace(/[\u200B\uFEFF\u2060]/g, '');
     }
-    /**
-     * Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
-     */
+    // Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
 
     /**
      * Function `humanizeAiText` will remove traces of AI text generation artifacts
@@ -7885,11 +7845,11 @@
         cleanedText = humanizeAiTextWhitespace(cleanedText);
         return cleanedText;
     }
-    /**
-     * TODO: [🧠] Maybe this should be exported from `@promptbook/utils` not `@promptbook/markdown-utils`
-     */
+    // TODO: [🧠] Maybe this should be exported from `@promptbook/utils` not `@promptbook/markdown-utils`
 
     /**
+     * Map of promptbook pseudotoken substitution.
+     *
      * @private
      */
     const PROMPTBOOK_PSEUDOTOKEN_SUBSTITUTION = {
@@ -7937,15 +7897,14 @@
         }
         return promptbookifiedTextTokens.join('');
     }
-    /**
-     * TODO: [🧠][✌️] Make some Promptbook-native token system
-     */
+    // TODO: [🧠][✌️] Make some Promptbook-native token system
 
     /**
      * Removes Markdown formatting tags from a string.
      *
      * @param {string} str - The string to remove Markdown tags from.
      * @returns {string} The input string with all Markdown tags removed.
+     *
      * @public exported from `@promptbook/markdown-utils`
      */
     function removeMarkdownFormatting(str) {
@@ -7963,6 +7922,7 @@
      *
      * @param {string} str - The string to remove Markdown tags from.
      * @returns {string} The input string with all Markdown tags removed.
+     *
      * @public exported from `@promptbook/markdown-utils`
      */
     function removeMarkdownLinks(str) {
@@ -7978,7 +7938,7 @@
      *
      * Note: [🔂] This function is idempotent.
      * Note: This is useful for post-processing of the result of the chat LLM model
-     *       when the model wraps the result in the (markdown) code block.
+     * when the model wraps the result in the (markdown) code block.
      *
      * @public exported from `@promptbook/markdown-utils`
      */
@@ -7997,7 +7957,7 @@
      * Function trimEndOfCodeBlock will remove ending code block from the string if it is present.
      *
      * Note: This is useful for post-processing of the result of the completion LLM model
-     *       if you want to start code block in the prompt but you don't want to end it in the result.
+     * if you want to start code block in the prompt but you don't want to end it in the result.
      *
      * @public exported from `@promptbook/markdown-utils`
      */