@promptbook/markdown-utils 0.79.0 → 0.80.0-1

package/umd/index.umd.js

@@ -22,7 +22,7 @@
      *
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.78.4';
+    var PROMPTBOOK_ENGINE_VERSION = '0.80.0-0';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -358,7 +358,7 @@
      * TODO: [🏢] Make this logic part of `JsonFormatDefinition` or `isValidJsonString`
      */
 
-    var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}",resultingParameterName:"knowledgePieces",dependentParameterNames:["knowledgeContent"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./books/prepare-knowledge-from-markdown.book.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n-   Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}",resultingParameterName:"keywords",dependentParameterNames:["knowledgePieceContent"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./books/prepare-knowledge-keywords.book.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced content creator, write best title for the document.\n\n# Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear\n-   Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}",resultingParameterName:"title",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./books/prepare-knowledge-title.book.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.book.md",formfactorName:"GENERIC",parameters:[{name:"availableModelNames",description:"List of available model names separated by comma (,)",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-model-requirements",title:"Make modelRequirements",content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Example\n\n```json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n```\n\n## Instructions\n\n-   Your output format is JSON object\n-   Write just the JSON object, no other text should be present\n-   It contains the following keys:\n    -   `modelName`: The name of the model to use\n    -   `systemMessage`: The system message to provide context to the model\n    -   `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nPick from the following models:\n\n-   {availableModelNames}\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n-   `0.1`: Low temperature, extremely conservative and deterministic\n-   `0.5`: Medium temperature, balanced between conservative and creative\n-   `1.0`: High temperature, creative and bit random\n-   `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n-   `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}",resultingParameterName:"modelRequirements",format:"JSON",dependentParameterNames:["availableModelNames","personaDescription"]}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./books/prepare-persona.book.md"}];
+    var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}",resultingParameterName:"knowledgePieces",dependentParameterNames:["knowledgeContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sourceFile:"./books/prepare-knowledge-from-markdown.book.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n-   Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}",resultingParameterName:"keywords",dependentParameterNames:["knowledgePieceContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sourceFile:"./books/prepare-knowledge-keywords.book.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.book.md",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced content creator, write best title for the document.\n\n# Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear\n-   Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}",resultingParameterName:"title",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sourceFile:"./books/prepare-knowledge-title.book.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.book.md",formfactorName:"GENERIC",parameters:[{name:"availableModelNames",description:"List of available model names separated by comma (,)",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-model-requirements",title:"Make modelRequirements",content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Example\n\n```json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n```\n\n## Instructions\n\n-   Your output format is JSON object\n-   Write just the JSON object, no other text should be present\n-   It contains the following keys:\n    -   `modelName`: The name of the model to use\n    -   `systemMessage`: The system message to provide context to the model\n    -   `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nPick from the following models:\n\n-   {availableModelNames}\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n-   `0.1`: Low temperature, extremely conservative and deterministic\n-   `0.5`: Medium temperature, balanced between conservative and creative\n-   `1.0`: High temperature, creative and bit random\n-   `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n-   `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}",resultingParameterName:"modelRequirements",format:"JSON",dependentParameterNames:["availableModelNames","personaDescription"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sourceFile:"./books/prepare-persona.book.md"}];
 
     /**
      * Prettify the html code
@@ -397,6 +397,7 @@
     /**
      * Converts promptbook in JSON format to string format
      *
+     * @deprecated TODO: [🥍][🧠] Backup original files in `PipelineJson` same as in Promptbook.studio
      * @param pipelineJson Promptbook in JSON format (.book.json)
      * @returns Promptbook in string format (.book.md)
      * @public exported from `@promptbook/core`
@@ -692,41 +693,6 @@
      * @public exported from `@promptbook/core`
      */
     var DEFAULT_SCRAPE_CACHE_DIRNAME = './.promptbook/scrape-cache';
-    /**
-     * Nonce which is used for replacing things in strings
-     *
-     * @private within the repository
-     */
-    var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
-    /**
-     * The names of the parameters that are reserved for special purposes
-     *
-     * @public exported from `@promptbook/core`
-     */
-    var RESERVED_PARAMETER_NAMES = 
-    /* !!!!!! $asDeeplyFrozenSerializableJson('RESERVED_PARAMETER_NAMES', _____ as const); */ [
-        'content',
-        'context',
-        'knowledge',
-        'examples',
-        'modelName',
-        'currentDate',
-        // <- TODO: list here all command names
-        // <- TODO: Add more like 'date', 'modelName',...
-        // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
-    ];
-    /**
-     * @@@
-     *
-     * @private within the repository
-     */
-    var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
-    /**
-     * @@@
-     *
-     * @private within the repository
-     */
-    var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
     // <- TODO: [🧜‍♂️]
     /**
      * @@@
@@ -761,26 +727,59 @@
     // Note: In normal situations, we check the pipeline logic:
     true);
     /**
-     * TODO: Extract `constants.ts` from `config.ts`
      * Note: [💞] Ignore a discrepancy between file name and entity name
      * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
      */
 
     /**
-     * This error indicates that the promptbook object has valid syntax (=can be parsed) but contains logical errors (like circular dependencies)
+     * Orders JSON object by keys
      *
-     * @public exported from `@promptbook/core`
+     * @returns The same type of object as the input re-ordered
+     * @public exported from `@promptbook/utils`
      */
-    var PipelineLogicError = /** @class */ (function (_super) {
-        __extends(PipelineLogicError, _super);
-        function PipelineLogicError(message) {
-            var _this = _super.call(this, message) || this;
-            _this.name = 'PipelineLogicError';
-            Object.setPrototypeOf(_this, PipelineLogicError.prototype);
-            return _this;
+    function orderJson(options) {
+        var value = options.value, order = options.order;
+        var orderedValue = __assign(__assign({}, (order === undefined ? {} : Object.fromEntries(order.map(function (key) { return [key, undefined]; })))), value);
+        return orderedValue;
+    }
+
+    /**
+     * Freezes the given object and all its nested objects recursively
+     *
+     * Note: `$` is used to indicate that this function is not a pure function - it mutates given object
+     * 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) {
+        var e_1, _a;
+        if (Array.isArray(objectValue)) {
+            return Object.freeze(objectValue.map(function (item) { return $deepFreeze(item); }));
         }
-        return PipelineLogicError;
-    }(Error));
+        var propertyNames = Object.getOwnPropertyNames(objectValue);
+        try {
+            for (var propertyNames_1 = __values(propertyNames), propertyNames_1_1 = propertyNames_1.next(); !propertyNames_1_1.done; propertyNames_1_1 = propertyNames_1.next()) {
+                var propertyName = propertyNames_1_1.value;
+                var value = objectValue[propertyName];
+                if (value && typeof value === 'object') {
+                    $deepFreeze(value);
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (propertyNames_1_1 && !propertyNames_1_1.done && (_a = propertyNames_1.return)) _a.call(propertyNames_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        Object.freeze(objectValue);
+        return objectValue;
+    }
+    /**
+     * TODO: [🧠] Is there a way how to meaningfully test this utility
+     */
 
     /**
      * Make error report URL for the given error
@@ -816,6 +815,264 @@
         return UnexpectedError;
     }(Error));
 
+    /**
+     * Checks if the value is [🚉] serializable as JSON
+     * If not, throws an UnexpectedError with a rich error message and tracking
+     *
+     * - Almost all primitives are serializable BUT:
+     * - `undefined` is not serializable
+     * - `NaN` is not serializable
+     * - Objects and arrays are serializable if all their properties are serializable
+     * - Functions are not serializable
+     * - Circular references are not serializable
+     * - `Date` objects are not serializable
+     * - `Map` and `Set` objects are not serializable
+     * - `RegExp` objects are not serializable
+     * - `Error` objects are not serializable
+     * - `Symbol` objects are not serializable
+     * - And much more...
+     *
+     * @throws UnexpectedError if the value is not serializable as JSON
+     * @public exported from `@promptbook/utils`
+     */
+    function checkSerializableAsJson(options) {
+        var e_1, _a;
+        var value = options.value, name = options.name, message = options.message;
+        if (value === undefined) {
+            throw new UnexpectedError("".concat(name, " is undefined"));
+        }
+        else if (value === null) {
+            return;
+        }
+        else if (typeof value === 'boolean') {
+            return;
+        }
+        else if (typeof value === 'number' && !isNaN(value)) {
+            return;
+        }
+        else if (typeof value === 'string') {
+            return;
+        }
+        else if (typeof value === 'symbol') {
+            throw new UnexpectedError("".concat(name, " is symbol"));
+        }
+        else if (typeof value === 'function') {
+            throw new UnexpectedError("".concat(name, " is function"));
+        }
+        else if (typeof value === 'object' && Array.isArray(value)) {
+            for (var i = 0; i < value.length; i++) {
+                checkSerializableAsJson({ name: "".concat(name, "[").concat(i, "]"), value: value[i], message: message });
+            }
+        }
+        else if (typeof value === 'object') {
+            if (value instanceof Date) {
+                throw new UnexpectedError(spaceTrim__default["default"](function (block) { return "\n                        `".concat(name, "` is Date\n\n                        Use `string_date_iso8601` instead\n\n                        Additional message for `").concat(name, "`:\n                        ").concat(block(message || '(nothing)'), "\n                    "); }));
+            }
+            else if (value instanceof Map) {
+                throw new UnexpectedError("".concat(name, " is Map"));
+            }
+            else if (value instanceof Set) {
+                throw new UnexpectedError("".concat(name, " is Set"));
+            }
+            else if (value instanceof RegExp) {
+                throw new UnexpectedError("".concat(name, " is RegExp"));
+            }
+            else if (value instanceof Error) {
+                throw new UnexpectedError(spaceTrim__default["default"](function (block) { return "\n                        `".concat(name, "` is unserialized Error\n\n                        Use function `serializeError`\n\n                        Additional message for `").concat(name, "`:\n                        ").concat(block(message || '(nothing)'), "\n\n                    "); }));
+            }
+            else {
+                try {
+                    for (var _b = __values(Object.entries(value)), _c = _b.next(); !_c.done; _c = _b.next()) {
+                        var _d = __read(_c.value, 2), subName = _d[0], subValue = _d[1];
+                        if (subValue === undefined) {
+                            // Note: undefined in object is serializable - it is just omited
+                            continue;
+                        }
+                        checkSerializableAsJson({ name: "".concat(name, ".").concat(subName), value: subValue, message: message });
+                    }
+                }
+                catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                finally {
+                    try {
+                        if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+                    }
+                    finally { if (e_1) throw e_1.error; }
+                }
+                try {
+                    JSON.stringify(value); // <- TODO: [0]
+                }
+                catch (error) {
+                    if (!(error instanceof Error)) {
+                        throw error;
+                    }
+                    throw new UnexpectedError(spaceTrim__default["default"](function (block) { return "\n                            `".concat(name, "` is not serializable\n\n                            ").concat(block(error.toString()), "\n\n                            Additional message for `").concat(name, "`:\n                            ").concat(block(message || '(nothing)'), "\n                        "); }));
+                }
+                /*
+                TODO: [0] Is there some more elegant way to check circular references?
+                const seen = new Set();
+                const stack = [{ value }];
+                while (stack.length > 0) {
+                    const { value } = stack.pop()!;
+                    if (typeof value === 'object' && value !== null) {
+                        if (seen.has(value)) {
+                            throw new UnexpectedError(`${name} has circular reference`);
+                        }
+                        seen.add(value);
+                        if (Array.isArray(value)) {
+                            stack.push(...value.map((value) => ({ value })));
+                        } else {
+                            stack.push(...Object.values(value).map((value) => ({ value })));
+                        }
+                    }
+                }
+                */
+                return;
+            }
+        }
+        else {
+            throw new UnexpectedError(spaceTrim__default["default"](function (block) { return "\n                    `".concat(name, "` is unknown type\n\n                    Additional message for `").concat(name, "`:\n                    ").concat(block(message || '(nothing)'), "\n                "); }));
+        }
+    }
+    /**
+     * TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
+     * TODO: [🧠][main] !!! 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
+     */
+
+    /**
+     * @@@
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function deepClone(objectValue) {
+        return JSON.parse(JSON.stringify(objectValue));
+        /*
+        !!!!!!!!
+        TODO: [🧠] Is there a better implementation?
+        > const propertyNames = Object.getOwnPropertyNames(objectValue);
+        > for (const propertyName of propertyNames) {
+        >     const value = (objectValue as really_any)[propertyName];
+        >     if (value && typeof value === 'object') {
+        >         deepClone(value);
+        >     }
+        > }
+        > return Object.assign({}, objectValue);
+        */
+    }
+    /**
+     * TODO: [🧠] Is there a way how to meaningfully test this utility
+     */
+
+    /**
+     * Utility to export a JSON object from a function
+     *
+     * 1) Checks if the value is serializable as JSON
+     * 2) Makes a deep clone of the object
+     * 2) Orders the object properties
+     * 2) Deeply freezes the cloned object
+     *
+     * 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) {
+        var name = options.name, value = options.value, order = options.order, message = options.message;
+        checkSerializableAsJson({ name: name, value: value, message: message });
+        var orderedValue = 
+        // TODO: Fix error "Type instantiation is excessively deep and possibly infinite."
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        order === undefined
+            ? deepClone(value)
+            : orderJson({
+                value: value,
+                // <- Note: checkSerializableAsJson asserts that the value is serializable as JSON
+                order: order,
+            });
+        $deepFreeze(orderedValue);
+        return orderedValue;
+    }
+    /**
+     * TODO: [🧠] Is there a way how to meaningfully test this utility
+     */
+
+    /**
+     * Order of keys in the pipeline JSON
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var ORDER_OF_PIPELINE_JSON = [
+        'title',
+        'pipelineUrl',
+        'bookVersion',
+        'description',
+        'formfactorName',
+        'parameters',
+        'tasks',
+        'personas',
+        'preparations',
+        'knowledgeSources',
+        'knowledgePieces',
+    ];
+    /**
+     * Nonce which is used for replacing things in strings
+     *
+     * @private within the repository
+     */
+    var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
+    /**
+     * @@@
+     *
+     * @private within the repository
+     */
+    var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
+    /**
+     * @@@
+     *
+     * @private within the repository
+     */
+    var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
+    /**
+     * The names of the parameters that are reserved for special purposes
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var RESERVED_PARAMETER_NAMES = exportJson({
+        name: 'RESERVED_PARAMETER_NAMES',
+        message: "The names of the parameters that are reserved for special purposes",
+        value: [
+            'content',
+            'context',
+            'knowledge',
+            'examples',
+            'modelName',
+            'currentDate',
+            // <- TODO: list here all command names
+            // <- TODO: Add more like 'date', 'modelName',...
+            // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
+        ],
+    });
+    /**
+     * 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)
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var PipelineLogicError = /** @class */ (function (_super) {
+        __extends(PipelineLogicError, _super);
+        function PipelineLogicError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'PipelineLogicError';
+            Object.setPrototypeOf(_this, PipelineLogicError.prototype);
+            return _this;
+        }
+        return PipelineLogicError;
+    }(Error));
+
     /**
      * Tests if given string is valid semantic version
      *
@@ -1053,6 +1310,21 @@
             }
         };
         try {
+            /*
+            TODO: [🧠][🅾] Should be empty pipeline valid or not
+            // Note: Check that pipeline has some tasks
+            if (pipeline.tasks.length === 0) {
+                throw new PipelineLogicError(
+                    spaceTrim(
+                        (block) => `
+                          Pipeline must have at least one task
+        
+                          ${block(pipelineIdentification)}
+                      `,
+                    ),
+                );
+            }
+            */
             // Note: Check each parameter individually
             for (var _d = __values(pipeline.parameters), _e = _d.next(); !_e.done; _e = _d.next()) {
                 var parameter = _e.value;
@@ -1213,6 +1485,9 @@
         while (unresovedTasks.length > 0) {
             _loop_3();
         }
+        // Note: Check that formfactor is corresponding to the pipeline interface
+        // TODO: !!!!!! Implement this
+        // pipeline.formfactorName
     }
     /**
      * TODO: !! [🧞‍♀️] Do not allow joker + foreach
@@ -1296,189 +1571,10 @@
         return parameterNames;
     }
 
-    /**
-     * @@@
-     *
-     * Note: `$` is used to indicate that this function is not a pure function - it mutates given object
-     * 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) {
-        var e_1, _a;
-        if (Array.isArray(objectValue)) {
-            return Object.freeze(objectValue.map(function (item) { return $deepFreeze(item); }));
-        }
-        var propertyNames = Object.getOwnPropertyNames(objectValue);
-        try {
-            for (var propertyNames_1 = __values(propertyNames), propertyNames_1_1 = propertyNames_1.next(); !propertyNames_1_1.done; propertyNames_1_1 = propertyNames_1.next()) {
-                var propertyName = propertyNames_1_1.value;
-                var value = objectValue[propertyName];
-                if (value && typeof value === 'object') {
-                    $deepFreeze(value);
-                }
-            }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (propertyNames_1_1 && !propertyNames_1_1.done && (_a = propertyNames_1.return)) _a.call(propertyNames_1);
-            }
-            finally { if (e_1) throw e_1.error; }
-        }
-        return Object.freeze(objectValue);
-    }
-    /**
-     * TODO: [🧠] Is there a way how to meaningfully test this utility
-     */
-
-    /**
-     * Checks if the value is [🚉] serializable as JSON
-     * If not, throws an UnexpectedError with a rich error message and tracking
-     *
-     * - Almost all primitives are serializable BUT:
-     * - `undefined` is not serializable
-     * - `NaN` is not serializable
-     * - Objects and arrays are serializable if all their properties are serializable
-     * - Functions are not serializable
-     * - Circular references are not serializable
-     * - `Date` objects are not serializable
-     * - `Map` and `Set` objects are not serializable
-     * - `RegExp` objects are not serializable
-     * - `Error` objects are not serializable
-     * - `Symbol` objects are not serializable
-     * - And much more...
-     *
-     * @throws UnexpectedError if the value is not serializable as JSON
-     * @public exported from `@promptbook/utils`
-     */
-    function checkSerializableAsJson(name, value) {
-        var e_1, _a;
-        if (value === undefined) {
-            throw new UnexpectedError("".concat(name, " is undefined"));
-        }
-        else if (value === null) {
-            return;
-        }
-        else if (typeof value === 'boolean') {
-            return;
-        }
-        else if (typeof value === 'number' && !isNaN(value)) {
-            return;
-        }
-        else if (typeof value === 'string') {
-            return;
-        }
-        else if (typeof value === 'symbol') {
-            throw new UnexpectedError("".concat(name, " is symbol"));
-        }
-        else if (typeof value === 'function') {
-            throw new UnexpectedError("".concat(name, " is function"));
-        }
-        else if (typeof value === 'object' && Array.isArray(value)) {
-            for (var i = 0; i < value.length; i++) {
-                checkSerializableAsJson("".concat(name, "[").concat(i, "]"), value[i]);
-            }
-        }
-        else if (typeof value === 'object') {
-            if (value instanceof Date) {
-                throw new UnexpectedError(spaceTrim__default["default"]("\n                    ".concat(name, " is Date\n\n                    Use `string_date_iso8601` instead\n                ")));
-            }
-            else if (value instanceof Map) {
-                throw new UnexpectedError("".concat(name, " is Map"));
-            }
-            else if (value instanceof Set) {
-                throw new UnexpectedError("".concat(name, " is Set"));
-            }
-            else if (value instanceof RegExp) {
-                throw new UnexpectedError("".concat(name, " is RegExp"));
-            }
-            else if (value instanceof Error) {
-                throw new UnexpectedError(spaceTrim__default["default"]("\n                    ".concat(name, " is unserialized Error\n\n                    Use function `serializeError`\n                ")));
-            }
-            else {
-                try {
-                    for (var _b = __values(Object.entries(value)), _c = _b.next(); !_c.done; _c = _b.next()) {
-                        var _d = __read(_c.value, 2), subName = _d[0], subValue = _d[1];
-                        if (subValue === undefined) {
-                            // Note: undefined in object is serializable - it is just omited
-                            continue;
-                        }
-                        checkSerializableAsJson("".concat(name, ".").concat(subName), subValue);
-                    }
-                }
-                catch (e_1_1) { e_1 = { error: e_1_1 }; }
-                finally {
-                    try {
-                        if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
-                    }
-                    finally { if (e_1) throw e_1.error; }
-                }
-                try {
-                    JSON.stringify(value); // <- TODO: [0]
-                }
-                catch (error) {
-                    if (!(error instanceof Error)) {
-                        throw error;
-                    }
-                    throw new UnexpectedError(spaceTrim__default["default"](function (block) { return "\n                            ".concat(name, " is not serializable\n\n                            ").concat(block(error.toString()), "\n                        "); }));
-                }
-                /*
-                TODO: [0] Is there some more elegant way to check circular references?
-                const seen = new Set();
-                const stack = [{ value }];
-                while (stack.length > 0) {
-                    const { value } = stack.pop()!;
-                    if (typeof value === 'object' && value !== null) {
-                        if (seen.has(value)) {
-                            throw new UnexpectedError(`${name} has circular reference`);
-                        }
-                        seen.add(value);
-                        if (Array.isArray(value)) {
-                            stack.push(...value.map((value) => ({ value })));
-                        } else {
-                            stack.push(...Object.values(value).map((value) => ({ value })));
-                        }
-                    }
-                }
-                */
-                return;
-            }
-        }
-        else {
-            throw new UnexpectedError("".concat(name, " is unknown"));
-        }
-    }
-    /**
-     * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
-     * TODO: [🧠][main] !!! 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
-     */
-
-    /**
-     * @@@
-     * @@@
-     *
-     * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
-     *
-     * @param name - Name of the object for debugging purposes
-     * @param objectValue - Object to be deeply frozen
-     * @returns The same object as the input, but deeply frozen
-     * @private this is in comparison to `deepFreeze` a more specific utility and maybe not very good practice to use without specific reason and considerations
-     */
-    function $asDeeplyFrozenSerializableJson(name, objectValue) {
-        checkSerializableAsJson(name, objectValue);
-        return $deepFreeze(objectValue);
-    }
-    /**
-     * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
-     * TODO: [🧠] Is there a way how to meaningfully test this utility
-     */
-
     /**
      * 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) {
@@ -1493,7 +1589,12 @@
             delete taskUnprepared.preparedContent;
             return taskUnprepared;
         });
-        return $asDeeplyFrozenSerializableJson('Unprepared PipelineJson', __assign(__assign({}, pipeline), { tasks: tasks, knowledgeSources: knowledgeSources, knowledgePieces: [], personas: personas, preparations: [] }));
+        return exportJson({
+            name: 'pipelineJson',
+            message: "Result of `unpreparePipeline`",
+            order: ORDER_OF_PIPELINE_JSON,
+            value: __assign(__assign({}, pipeline), { tasks: tasks, knowledgeSources: knowledgeSources, knowledgePieces: [], personas: personas, preparations: [] }),
+        });
     }
     /**
      * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
@@ -2055,29 +2156,6 @@
      * Note: [💞] Ignore a discrepancy between file name and entity name
      */
 
-    /**
-     * @@@
-     *
-     * @public exported from `@promptbook/utils`
-     */
-    function deepClone(objectValue) {
-        return JSON.parse(JSON.stringify(objectValue));
-        /*
-        TODO: [🧠] Is there a better implementation?
-        > const propertyNames = Object.getOwnPropertyNames(objectValue);
-        > for (const propertyName of propertyNames) {
-        >     const value = (objectValue as really_any)[propertyName];
-        >     if (value && typeof value === 'object') {
-        >         deepClone(value);
-        >     }
-        > }
-        > return Object.assign({}, objectValue);
-        */
-    }
-    /**
-     * TODO: [🧠] Is there a way how to meaningfully test this utility
-     */
-
     /**
      * Function `addUsage` will add multiple usages into one
      *
@@ -3603,36 +3681,6 @@
      *       [ ] One piece can have multiple sources
      */
 
-    /**
-     * @@@
-     *
-     * Note: It is usefull @@@
-     *
-     * @param pipeline
-     * @public exported from `@promptbook/utils`
-     */
-    function clonePipeline(pipeline) {
-        // Note: Not using spread operator (...) because @@@
-        var pipelineUrl = pipeline.pipelineUrl, sourceFile = pipeline.sourceFile, title = pipeline.title, bookVersion = pipeline.bookVersion, description = pipeline.description, formfactorName = pipeline.formfactorName, parameters = pipeline.parameters, tasks = pipeline.tasks, knowledgeSources = pipeline.knowledgeSources, knowledgePieces = pipeline.knowledgePieces, personas = pipeline.personas, preparations = pipeline.preparations;
-        return {
-            pipelineUrl: pipelineUrl,
-            sourceFile: sourceFile,
-            title: title,
-            bookVersion: bookVersion,
-            description: description,
-            formfactorName: formfactorName,
-            parameters: parameters,
-            tasks: tasks,
-            knowledgeSources: knowledgeSources,
-            knowledgePieces: knowledgePieces,
-            personas: personas,
-            preparations: preparations,
-        };
-    }
-    /**
-     * TODO: [🍙] Make some standard order of json properties
-     */
-
     /**
      * @@@
      *
@@ -3673,6 +3721,7 @@
         });
     }
     /**
+     * TODO: [😂] Adding knowledge should be convert to async high-level abstractions, simmilar 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] !!! Prepare index the examples and maybe tasks
@@ -3761,11 +3810,19 @@
                     case 3:
                         tasksPrepared = (_c.sent()).tasksPrepared;
                         // ----- /Tasks preparation -----
+                        // TODO: [😂] Use here all `AsyncHighLevelAbstraction`
                         // Note: Count total usage
                         currentPreparation.usage = llmToolsWithUsage.getTotalUsage();
-                        return [2 /*return*/, $asDeeplyFrozenSerializableJson('Prepared PipelineJson', __assign(__assign({}, clonePipeline(pipeline)), { tasks: __spreadArray([], __read(tasksPrepared), false), 
-                                // <- TODO: [🪓] Here should be no need for spreading new array, just ` tasks: tasksPrepared`
-                                knowledgeSources: knowledgeSourcesPrepared, knowledgePieces: knowledgePiecesPrepared, personas: preparedPersonas, preparations: __spreadArray([], __read(preparations), false) }))];
+                        return [2 /*return*/, exportJson({
+                                name: 'pipelineJson',
+                                message: "Result of `preparePipeline`",
+                                order: ORDER_OF_PIPELINE_JSON,
+                                value: __assign(__assign({}, pipeline), { 
+                                    // <- TODO: Probbably deeply clone the pipeline because `$exportJson` freezes the subobjects
+                                    knowledgeSources: knowledgeSourcesPrepared, knowledgePieces: knowledgePiecesPrepared, tasks: __spreadArray([], __read(tasksPrepared), false), 
+                                    // <- TODO: [🪓] Here should be no need for spreading new array, just ` tasks: tasksPrepared`
+                                    personas: preparedPersonas, preparations: __spreadArray([], __read(preparations), false) }),
+                            })];
                 }
             });
         });
@@ -5325,16 +5382,21 @@
                         // Note: Wait a short time to prevent race conditions
                         _g.sent();
                         _g.label = 6;
-                    case 6: return [2 /*return*/, $asDeeplyFrozenSerializableJson("Unuccessful PipelineExecutorResult (with missing parameter {".concat(parameter.name, "}) PipelineExecutorResult"), {
-                            isSuccessful: false,
-                            errors: __spreadArray([
-                                new PipelineExecutionError("Parameter `{".concat(parameter.name, "}` is required as an input parameter"))
-                            ], __read(errors), false).map(serializeError),
-                            warnings: [],
-                            executionReport: executionReport,
-                            outputParameters: {},
-                            usage: ZERO_USAGE,
-                            preparedPipeline: preparedPipeline,
+                    case 6: return [2 /*return*/, exportJson({
+                            name: "executionReport",
+                            message: "Unuccessful PipelineExecutorResult (with missing parameter {".concat(parameter.name, "}) PipelineExecutorResult"),
+                            order: [],
+                            value: {
+                                isSuccessful: false,
+                                errors: __spreadArray([
+                                    new PipelineExecutionError("Parameter `{".concat(parameter.name, "}` is required as an input parameter"))
+                                ], __read(errors), false).map(serializeError),
+                                warnings: [],
+                                executionReport: executionReport,
+                                outputParameters: {},
+                                usage: ZERO_USAGE,
+                                preparedPipeline: preparedPipeline,
+                            },
                         })];
                     case 7:
                         _b = _a.next();
@@ -5373,16 +5435,21 @@
                                         // Note: Wait a short time to prevent race conditions
                                         _h.sent();
                                         _h.label = 3;
-                                    case 3: return [2 /*return*/, { value: $asDeeplyFrozenSerializableJson(spaceTrim.spaceTrim(function (block) { return "\n                        Unuccessful PipelineExecutorResult (with extra parameter {".concat(parameter.name, "}) PipelineExecutorResult\n\n                        ").concat(block(pipelineIdentification), "\n                    "); }), {
-                                                isSuccessful: false,
-                                                errors: __spreadArray([
-                                                    new PipelineExecutionError(spaceTrim.spaceTrim(function (block) { return "\n                                    Parameter `{".concat(parameter.name, "}` is passed as input parameter but it is not input\n\n                                    ").concat(block(pipelineIdentification), "\n                                "); }))
-                                                ], __read(errors), false).map(serializeError),
-                                                warnings: warnings.map(serializeError),
-                                                executionReport: executionReport,
-                                                outputParameters: {},
-                                                usage: ZERO_USAGE,
-                                                preparedPipeline: preparedPipeline,
+                                    case 3: return [2 /*return*/, { value: exportJson({
+                                                name: 'pipelineExecutorResult',
+                                                message: spaceTrim.spaceTrim(function (block) { return "\n                        Unuccessful PipelineExecutorResult (with extra parameter {".concat(parameter.name, "}) PipelineExecutorResult\n\n                        ").concat(block(pipelineIdentification), "\n                    "); }),
+                                                order: [],
+                                                value: {
+                                                    isSuccessful: false,
+                                                    errors: __spreadArray([
+                                                        new PipelineExecutionError(spaceTrim.spaceTrim(function (block) { return "\n                                    Parameter `{".concat(parameter.name, "}` is passed as input parameter but it is not input\n\n                                    ").concat(block(pipelineIdentification), "\n                                "); }))
+                                                    ], __read(errors), false).map(serializeError),
+                                                    warnings: warnings.map(serializeError),
+                                                    executionReport: executionReport,
+                                                    outputParameters: {},
+                                                    usage: ZERO_USAGE,
+                                                    preparedPipeline: preparedPipeline,
+                                                },
                                             }) }];
                                     case 4: return [2 /*return*/];
                                 }
@@ -5536,14 +5603,19 @@
                         // Note: Wait a short time to prevent race conditions
                         _g.sent();
                         _g.label = 27;
-                    case 27: return [2 /*return*/, $asDeeplyFrozenSerializableJson('Unuccessful PipelineExecutorResult (with misc errors) PipelineExecutorResult', {
-                            isSuccessful: false,
-                            errors: __spreadArray([error_1], __read(errors), false).map(serializeError),
-                            warnings: warnings.map(serializeError),
-                            usage: usage_1,
-                            executionReport: executionReport,
-                            outputParameters: outputParameters_1,
-                            preparedPipeline: preparedPipeline,
+                    case 27: return [2 /*return*/, exportJson({
+                            name: 'pipelineExecutorResult',
+                            message: "Unuccessful PipelineExecutorResult (with misc errors) PipelineExecutorResult",
+                            order: [],
+                            value: {
+                                isSuccessful: false,
+                                errors: __spreadArray([error_1], __read(errors), false).map(serializeError),
+                                warnings: warnings.map(serializeError),
+                                usage: usage_1,
+                                executionReport: executionReport,
+                                outputParameters: outputParameters_1,
+                                preparedPipeline: preparedPipeline,
+                            },
                         })];
                     case 28:
                         usage = addUsage.apply(void 0, __spreadArray([], __read(executionReport.promptExecutions.map(function (_a) {
@@ -5564,14 +5636,19 @@
                         // Note: Wait a short time to prevent race conditions
                         _g.sent();
                         _g.label = 30;
-                    case 30: return [2 /*return*/, $asDeeplyFrozenSerializableJson('Successful PipelineExecutorResult', {
-                            isSuccessful: true,
-                            errors: errors.map(serializeError),
-                            warnings: warnings.map(serializeError),
-                            usage: usage,
-                            executionReport: executionReport,
-                            outputParameters: outputParameters,
-                            preparedPipeline: preparedPipeline,
+                    case 30: return [2 /*return*/, exportJson({
+                            name: 'pipelineExecutorResult',
+                            message: "Successful PipelineExecutorResult",
+                            order: [],
+                            value: {
+                                isSuccessful: true,
+                                errors: errors.map(serializeError),
+                                warnings: warnings.map(serializeError),
+                                usage: usage,
+                                executionReport: executionReport,
+                                outputParameters: outputParameters,
+                                preparedPipeline: preparedPipeline,
+                            },
                         })];
                 }
             });
@@ -5695,7 +5772,7 @@
         documentationUrl: 'https://github.com/webgptorg/promptbook/discussions/@@',
         isAvilableInBrowser: true,
         requiredExecutables: [],
-    }); /* <- TODO: [🤛] */
+    }); /* <- Note: [🤛] */
     /**
      * Registration of known scraper metadata
      *
@@ -5886,7 +5963,7 @@
      */
     var createMarkdownScraper = Object.assign(function (tools, options) {
         return new MarkdownScraper(tools, options);
-    }, markdownScraperMetadata); /* <- TODO: [🤛] */
+    }, markdownScraperMetadata); /* <- Note: [🤛] */
     /**
      * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
      */