@promptbook/editable 0.112.0-32 → 0.112.0-35

package/esm/index.es.js

@@ -17,7 +17,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @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
@@ -27,16 +27,20 @@ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-32';
  * 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$1;
 
 /**
- * @private util of `@promptbook/color`
+ * Class implementing take chain.
+ *
  * @de
+ *
+ * @private util of `@promptbook/color`
  */
 class TakeChain {
     constructor(value) {
@@ -53,9 +57,9 @@ class TakeChain {
  *
  * @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) {
@@ -233,9 +237,7 @@ const CSS_COLORS = {
     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.
@@ -265,7 +267,13 @@ function checkChannelValue(channelName, value) {
     }
 }
 
+/**
+ * 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.
@@ -298,6 +306,9 @@ function parseHexColor(hex) {
     }
     return throwInvalidHex();
 }
+/**
+ * Parses short hex channel.
+ */
 function parseShortHexChannel(char, onError) {
     if (!char) {
         return onError();
@@ -308,6 +319,9 @@ function parseShortHexChannel(char, onError) {
     }
     return parsed * 16;
 }
+/**
+ * Parses long hex channel.
+ */
 function parseLongHexChannel(hex, start, onError) {
     const segment = hex.substr(start, 2);
     if (segment.length < 2) {
@@ -320,6 +334,9 @@ function parseLongHexChannel(hex, start, onError) {
     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.
@@ -345,6 +362,9 @@ function parseHslColor(hsl) {
         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));
@@ -383,7 +403,13 @@ function convertHslToRgb(h, s, l) {
     };
 }
 
+/**
+ * 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.
@@ -425,6 +451,9 @@ function parseRgbaColor(rgba) {
         alpha: parseAlphaValue(match[4]),
     };
 }
+/**
+ * Parses channel value.
+ */
 function parseChannelValue(value) {
     if (value.endsWith('%')) {
         const percent = parseFloat(value);
@@ -432,6 +461,9 @@ function parseChannelValue(value) {
     }
     return Math.round(parseFloat(value));
 }
+/**
+ * Parses alpha value.
+ */
 function parseAlphaValue(value) {
     if (value.endsWith('%')) {
         const percent = parseFloat(value);
@@ -444,8 +476,17 @@ function parseAlphaValue(value) {
     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
@@ -811,9 +852,7 @@ function hslToRgb(hue, saturation, lightness) {
     }
     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
@@ -859,9 +898,7 @@ function rgbToHsl(red, green, blue) {
     }
     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
@@ -879,9 +916,7 @@ function lighten(amount) {
         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
@@ -899,9 +934,7 @@ function saturate(amount) {
         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.
@@ -914,6 +947,7 @@ function saturate(amount) {
  *
  * @param value any values
  * @returns the same values
+ *
  * @private within the repository
  */
 function just(value) {
@@ -1113,9 +1147,7 @@ class ParseError extends Error {
         Object.setPrototypeOf(this, ParseError.prototype);
     }
 }
-/**
- * TODO: Maybe split `ParseError` and `ApplyError`
- */
+// TODO: Maybe split `ParseError` and `ApplyError`
 
 /**
  * Parses the boilerplate command
@@ -1123,6 +1155,7 @@ class ParseError extends Error {
  * Note: @@ This command is used as boilerplate for new commands - it should NOT be used in any `.book` file
  *
  * @see `documentationUrl` for more details
+ *
  * @private within the commands folder
  */
 const boilerplateCommandParser = {
@@ -1256,12 +1289,13 @@ function isValidSemanticVersion(version) {
  * 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) {
@@ -1279,6 +1313,7 @@ function isValidPromptbookVersion(version) {
  * Parses the BOOK_VERSION command
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/editable`
  */
 const bookVersionCommandParser = {
@@ -1403,12 +1438,11 @@ function assertsError(whatWasThrown) {
  * Units of text measurement
  *
  * @see https://github.com/webgptorg/promptbook/discussions/30
+ *
  * @public exported from `@promptbook/core`
  */
 const EXPECTATION_UNITS = ['CHARACTERS', 'WORDS', 'SENTENCES', 'LINES', 'PARAGRAPHS', 'PAGES'];
-/**
- * TODO: [💝] Unite object for expecting amount and format - remove format
- */
+// TODO: [💝] Unite object for expecting amount and format - remove format
 
 /**
  * Function parseNumber will parse number from string
@@ -1477,17 +1511,16 @@ function parseNumber(value) {
     }
     return num;
 }
-/**
- * TODO: Maybe use sth. like safe-eval in fraction/calculation case @see https://www.npmjs.com/package/safe-eval
- * TODO: [🧠][🌻] Maybe export through `@promptbook/markdown-utils` not `@promptbook/utils`
- */
+// TODO: Maybe use sth. like safe-eval in fraction/calculation case @see https://www.npmjs.com/package/safe-eval
+// TODO: [🧠][🌻] Maybe export through `@promptbook/markdown-utils` not `@promptbook/utils`
 
 /**
-import { WrappedError } from '../../errors/WrappedError';
-import { assertsError } from '../../errors/assertsError';
+ * import { WrappedError } from '../../errors/WrappedError';
+ * import { assertsError } from '../../errors/assertsError';
  * Parses the expect command
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/editable`
  */
 const expectCommandParser = {
@@ -1707,8 +1740,9 @@ function isValidCsvString(value) {
 /**
  * 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',
@@ -1798,13 +1832,11 @@ const CsvFormatParser = {
         },
     ],
 };
-/**
- * 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
 
 /**
  * Function isValidJsonString will tell you if the string is valid JSON or not
@@ -1847,17 +1879,15 @@ const JsonFormatParser = {
     },
     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
@@ -1895,15 +1925,13 @@ const TextFormatParser = {
         // <- 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
@@ -1948,17 +1976,15 @@ const XmlFormatParser = {
     },
     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
@@ -1966,9 +1992,7 @@ const XmlFormatParser = {
  * @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
 
 /**
  * Normalizes a text string to SCREAMING_CASE (all uppercase with underscores).
@@ -1979,6 +2003,7 @@ const FORMAT_DEFINITIONS = [JsonFormatParser, XmlFormatParser, TextFormatParser,
  * @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) {
@@ -2031,6 +2056,7 @@ function normalizeTo_SCREAMING_CASE(text) {
  * Orders JSON object by keys
  *
  * @returns The same type of object as the input re-ordered
+ *
  * @public exported from `@promptbook/utils`
  */
 function orderJson(options) {
@@ -2049,6 +2075,7 @@ function orderJson(options) {
  * 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) {
@@ -2065,9 +2092,7 @@ function $deepFreeze(objectValue) {
     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
@@ -2087,6 +2112,7 @@ function $deepFreeze(objectValue) {
  * - And much more...
  *
  * @throws UnexpectedError if the value is not serializable as JSON
+ *
  * @public exported from `@promptbook/utils`
  */
 function checkSerializableAsJson(options) {
@@ -2201,11 +2227,9 @@ function checkSerializableAsJson(options) {
                 `));
     }
 }
-/**
- * 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
@@ -2215,6 +2239,7 @@ function checkSerializableAsJson(options) {
  *
  * @param objectValue The object to clone.
  * @returns A deep, writable clone of the input object.
+ *
  * @public exported from `@promptbook/utils`
  */
 function deepClone(objectValue) {
@@ -2231,9 +2256,7 @@ function deepClone(objectValue) {
     > 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
@@ -2246,6 +2269,7 @@ function deepClone(objectValue) {
  * 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) {
@@ -2265,9 +2289,7 @@ function exportJson(options) {
     $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
 
 /**
  * Nonce which is used for replacing things in strings
@@ -2295,9 +2317,7 @@ const RESERVED_PARAMETER_NAMES = exportJson({
         // <- 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
 
 /**
  * Normalizes a given text to camelCase format.
@@ -2309,6 +2329,7 @@ const RESERVED_PARAMETER_NAMES = exportJson({
  * @returns The camelCase formatted string.
  * @example 'helloWorld'
  * @example 'iLovePromptbook'
+ *
  * @public exported from `@promptbook/utils`
  */
 function normalizeTo_camelCase(text, _isFirstLetterCapital = false) {
@@ -2349,10 +2370,11 @@ function normalizeTo_camelCase(text, _isFirstLetterCapital = false) {
     }
     return normalizedName;
 }
+// TODO: [🌺] Use some intermediate util splitWords
+
 /**
- * TODO: [🌺] Use some intermediate util splitWords
+ * Collection of default diacritics removal map.
  */
-
 const defaultDiacriticsRemovalMap = [
     {
         base: 'A',
@@ -2604,6 +2626,7 @@ for (let i = 0; i < defaultDiacriticsRemovalMap.length; i++) {
  *
  * @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) {
@@ -2612,9 +2635,7 @@ function removeDiacritics(input) {
         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
 
 /**
  * Removes emojis from a string and fix whitespaces
@@ -2623,6 +2644,7 @@ function removeDiacritics(input) {
  *
  * @param text with emojis
  * @returns text without emojis
+ *
  * @public exported from `@promptbook/utils`
  */
 function removeEmojis(text) {
@@ -2646,6 +2668,7 @@ function removeEmojis(text) {
  *
  * @param text optionally quoted text
  * @returns text without quotes
+ *
  * @public exported from `@promptbook/utils`
  */
 function removeQuotes(text) {
@@ -2667,6 +2690,7 @@ function removeQuotes(text) {
  * @param parameterName The parameter name to validate and normalize.
  * @returns The validated and normalized parameter name.
  * @throws {ParseError} If the parameter name is empty, reserved, or contains invalid characters.
+ *
  * @private within the repository
  */
 function validateParameterName(parameterName) {
@@ -2737,6 +2761,7 @@ function validateParameterName(parameterName) {
  * Parses the foreach command
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/editable`
  */
 const foreachCommandParser = {
@@ -2895,14 +2920,13 @@ const foreachCommandParser = {
         throw new NotYetImplementedError(`[🛋] Not implemented yet`); // <- TODO: [🛋] Implement
     },
 };
-/**
- * TODO: [🍭] Make .book.md file with examples of the FOREACH with wrong parsing and logic
- */
+// TODO: [🍭] Make .book.md file with examples of the FOREACH with wrong parsing and logic
 
 /**
  * Parses the format command
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/editable`
  */
 const formatCommandParser = {
@@ -3087,9 +3111,7 @@ const GENERIC_PIPELINE_INTERFACE = {
     inputParameters: [],
     outputParameters: [],
 };
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */
+// Note: [💞] Ignore a discrepancy between file name and entity name
 
 /**
  * A generic pipeline
@@ -3241,9 +3263,7 @@ const FORMFACTOR_DEFINITIONS = [
     CompletionFormfactorDefinition,
     // <- [🛬] When making new formfactor, copy the _boilerplate and link it here
 ];
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */
+// Note: [💞] Ignore a discrepancy between file name and entity name
 
 /**
  * Parses the formfactor command
@@ -3251,6 +3271,7 @@ const FORMFACTOR_DEFINITIONS = [
  * Note: This command is used as a formfactor for new commands and defines the app type format - it should NOT be used in any `.book` file
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/editable`
  */
 const formfactorCommandParser = {
@@ -3346,6 +3367,7 @@ const formfactorCommandParser = {
  * Parses the joker command
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/editable`
  */
 const jokerCommandParser = {
@@ -3416,6 +3438,7 @@ const jokerCommandParser = {
  * 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) {
@@ -3464,9 +3487,7 @@ function isValidFilePath(filename) {
     }
     return false;
 }
-/**
- * TODO: [🍏] Implement for MacOs
- */
+// TODO: [🍏] Implement for MacOs
 
 /**
  * Tests if given string is valid URL.
@@ -3508,6 +3529,7 @@ function isValidUrl(url) {
  * @returns The kebab-case formatted string.
  * @example 'hello-world'
  * @example 'i-love-promptbook'
+ *
  * @public exported from `@promptbook/utils`
  */
 function normalizeToKebabCase(text) {
@@ -3548,9 +3570,7 @@ function normalizeToKebabCase(text) {
     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
@@ -3569,14 +3589,13 @@ function knowledgeSourceContentToName(knowledgeSourceContent) {
     // <- 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-...
 
 /**
  * Parses the knowledge command
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/editable`
  */
 const knowledgeCommandParser = {
@@ -3663,12 +3682,13 @@ const knowledgeCommandParser = {
         throw new NotYetImplementedError(`[🛋] Not implemented yet`); // <- TODO: [🛋] Implement
     },
 };
-/**
- * Note: [⛱] There are two types of KNOWLEDGE commands *...(read more in [⛱])*
- */
+// Note: [⛱] There are two types of KNOWLEDGE commands *...(read more in [⛱])*
 
 /**
+ * Constant for model variants.
+ *
  * @see {@link ModelVariant}
+ *
  * @public exported from `@promptbook/core`
  */
 const MODEL_VARIANTS = [
@@ -3683,6 +3703,7 @@ const MODEL_VARIANTS = [
  *
  * @see `documentationUrl` for more details
  * @deprecated Option to manually set the model requirements is not recommended to use, use `PERSONA` instead
+ *
  * @public exported from `@promptbook/editable`
  */
 const modelCommandParser = {
@@ -3863,6 +3884,7 @@ const modelCommandParser = {
  * Parses the parameter command
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/editable`
  */
 const parameterCommandParser = {
@@ -3973,6 +3995,7 @@ const parameterCommandParser = {
  * Parses the persona command
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/editable`
  */
 const personaCommandParser = {
@@ -4105,6 +4128,7 @@ function $applyToTaskJson(command, $taskJson, $pipelineJson) {
  *
  * @param javascriptName The value to check for JavaScript identifier validity.
  * @returns `true` if the value is a valid JavaScript name, false otherwise.
+ *
  * @public exported from `@promptbook/utils`
  */
 function isValidJavascriptName(javascriptName) {
@@ -4118,6 +4142,7 @@ function isValidJavascriptName(javascriptName) {
  * Parses the postprocess command
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/editable`
  */
 const postprocessCommandParser = {
@@ -4233,6 +4258,7 @@ const SectionTypes = [
  * Parses the section command
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/editable`
  */
 const sectionCommandParser = {
@@ -4447,14 +4473,13 @@ function isValidPipelineUrl(url) {
     */
     return true;
 }
-/**
- * TODO: [🐠] Maybe more info why the URL is invalid
- */
+// TODO: [🐠] Maybe more info why the URL is invalid
 
 /**
  * Parses the url command
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/editable`
  */
 const urlCommandParser = {
@@ -4556,6 +4581,7 @@ const urlCommandParser = {
  * Parses the action command
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/editable`
  */
 const actionCommandParser = {
@@ -4613,14 +4639,13 @@ const actionCommandParser = {
         throw new NotYetImplementedError('[🛠] Actions are not implemented yet');
     },
 };
-/**
- * Note: [⛱] There are two types of ACTION commands *...(read more in [⛱])*
- */
+// Note: [⛱] There are two types of ACTION commands *...(read more in [⛱])*
 
 /**
  * Parses the instrument command
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/editable`
  */
 const instrumentCommandParser = {
@@ -4678,9 +4703,7 @@ const instrumentCommandParser = {
         throw new NotYetImplementedError('[🛠] Instruments are not implemented yet');
     },
 };
-/**
- * Note: [⛱] There are two types of INSTRUMENT commands *...(read more in [⛱])*
- */
+// Note: [⛱] There are two types of INSTRUMENT commands *...(read more in [⛱])*
 
 /**
  * All available command parsers
@@ -4706,9 +4729,7 @@ const COMMANDS = [
     boilerplateCommandParser, // <- TODO: Only in development, remove in production
     // <- Note: [♓️][💩] This is the order of the commands in the pipeline, BUT its not used in parsing and before usage maybe it should be done better
 ];
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */
+// Note: [💞] Ignore a discrepancy between file name and entity name
 
 /**
  * Gets the parser for the command
@@ -4738,6 +4759,7 @@ function getParserForCommand(command) {
  *
  * @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) {
@@ -4907,7 +4929,7 @@ function parseCommandVariant(input) {
 }
 
 /**
- *  Number of padding lines to add at the end of the book content
+ * Number of padding lines to add at the end of the book content
  *
  * @public exported from `@promptbook/core`
  */
@@ -4944,9 +4966,7 @@ function padBook(content) {
     const linesToAdd = PADDING_LINES - trailingEmptyLines;
     return (content + '\n'.repeat(linesToAdd));
 }
-/**
- * TODO: [🧠] Maybe export
- */
+// TODO: [🧠] Maybe export
 
 /**
  * Checks if value is valid email
@@ -4972,6 +4992,7 @@ function isValidEmail(email) {
  * @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) {
@@ -4990,15 +5011,14 @@ function validatePipelineString(pipelineString) {
     // <- 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
 
 /**
  * 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) {
@@ -5076,9 +5096,7 @@ function deflatePipeline(pipelineString) {
     // <- TODO: Maybe use book` notation
     return padBook(pipelineString);
 }
-/**
- * TODO: Unit test
- */
+// TODO: Unit test
 
 /**
  * Adds a new command to a pipeline string in the correct format.
@@ -5134,10 +5152,8 @@ function addPipelineCommand(options) {
     }
     return spaceTrim$1(newLines.join('\n'));
 }
-/**
- * TODO: [🧠] What is the better solution - `- xxx`, - `-   xxx` or preserve (see also next TODO)
- * TODO: When existing commands 1) as 2) number 3) list, add 4) new command as next number
- */
+// TODO: [🧠] What is the better solution - `- xxx`, - `-   xxx` or preserve (see also next TODO)
+// TODO: When existing commands 1) as 2) number 3) list, add 4) new command as next number
 
 /**
  * Function `removePipelineCommand` will remove one command from pipeline string
@@ -5196,6 +5212,7 @@ class PipelineLogicError extends Error {
  * In other words, it will find all parameters that are not used in the task itseld and all its dependencies
  *
  * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
+ *
  * @public exported from `@promptbook/editable`
  */
 function renamePipelineParameter(options) {
@@ -5229,9 +5246,7 @@ function renamePipelineParameter(options) {
     }
     return renamedPipeline;
 }
-/**
- * TODO: Also variant for `edit-pipeline-string`
- */
+// TODO: Also variant for `edit-pipeline-string`
 
 // <- TODO: Auto convert to type `import { ... } from 'type-fest';`
 /**
@@ -5250,7 +5265,6 @@ function renamePipelineParameter(options) {
  * - `Symbol` objects are not serializable
  * - And much more...
  *
- *
  * @public exported from `@promptbook/utils`
  */
 function isSerializableAsJson(value) {
@@ -5262,10 +5276,8 @@ function isSerializableAsJson(value) {
         return false;
     }
 }
-/**
- * TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
- * TODO: [🧠][💺] Can be done this on type-level?
- */
+// TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
+// TODO: [🧠][💺] Can be done this on type-level?
 
 /**
  * Stringify the PipelineJson with proper formatting
@@ -5293,12 +5305,10 @@ function stringifyPipelineJson(pipeline) {
     pipelineJsonStringified += '\n';
     return pipelineJsonStringified;
 }
-/**
- * TODO: [🐝] Not Working properly @see https://promptbook.studio/examples/mixed-knowledge.book
- * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
- * TODO: [🧠] Maybe more elegant solution than replacing via regex
- * TODO: [🍙] Make some standard order of json properties
- */
+// TODO: [🐝] Not Working properly @see https://promptbook.studio/examples/mixed-knowledge.book
+// TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
+// TODO: [🧠] Maybe more elegant solution than replacing via regex
+// TODO: [🍙] Make some standard order of json properties
 
 export { BOOK_LANGUAGE_VERSION, COMMANDS, PROMPTBOOK_ENGINE_VERSION, actionCommandParser, addPipelineCommand, bookVersionCommandParser, deflatePipeline, expectCommandParser, foreachCommandParser, formatCommandParser, formfactorCommandParser, getParserForCommand, instrumentCommandParser, isFlatPipeline, jokerCommandParser, knowledgeCommandParser, knowledgeSourceContentToName, modelCommandParser, parameterCommandParser, parseCommand, personaCommandParser, postprocessCommandParser, removePipelineCommand, renamePipelineParameter, sectionCommandParser, stringifyPipelineJson, urlCommandParser };
 //# sourceMappingURL=index.es.js.map