@promptbook/core 0.61.0-11 → 0.61.0-13

package/umd/index.umd.js

@@ -392,11 +392,44 @@
         return parameterString;
     }
     /**
-     * TODO: !!!!! Implement new features and commands into `promptTemplateParameterJsonToString`
+     * TODO: !!!! Implement new features and commands into `promptTemplateParameterJsonToString`
      * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
      * TODO: Escape all
      */
 
+    /**
+     * @@@
+     *
+     * @returns The same object as the input, but deeply frozen
+     *
+     * Note: This function mutates the object
+     */
+    function deepFreeze(objectValue) {
+        var e_1, _a;
+        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: [🔼] Export from `@promptbook/utils`
+     * TODO: [🧠] Is there a way how to meaningfully test this utility
+     */
+
     /**
      * The maximum number of iterations for a loops
      */
@@ -408,11 +441,15 @@
     /**
      * The names of the parameters that are reserved for special purposes
      */
-    var RESERVED_PARAMETER_NAMES = [
+    var RESERVED_PARAMETER_NAMES = deepFreeze([
         'context',
         // <- TODO: Add more like 'date', 'modelName',...
         // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
-    ];
+    ]);
+    /*
+    TODO: !!! Just testing false-negative detection of [🟡][🟢][🔵][⚪] leak
+    */
+    // [🟡][🟢][🔵][⚪]
 
     /**
      * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
@@ -749,6 +786,7 @@
         var loopLimit = LOOP_LIMIT;
         var _loop_2 = function () {
             if (loopLimit-- < 0) {
+                // Note: Really UnexpectedError not LimitReachedError - this should not happen and be caught below
                 throw new UnexpectedError('Loop limit reached during detection of circular dependencies in `validatePipeline`');
             }
             var currentlyResovedTemplates = unresovedTemplates.filter(function (template) {
@@ -787,7 +825,9 @@
      *     >  ex port function validatePipeline(promptbook: unknown): asserts promptbook is PipelineJson {
      */
     /**
-     * TODO: [🧠] !!!!! Validate new things
+     * TODO: [🧠][🐣] !!!! Validate that all samples match expectations
+     * TODO: [🧠][🐣] !!!! Validate that knowledge is valid (non-void)
+     * TODO: [🧠] !!! Validationg not only logic itself but imports around - files and websites and rerefenced pipelines exists
      * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
      */
 
@@ -830,7 +870,7 @@
         /**
          * Constructs a pipeline collection from promptbooks
          *
-         * @param promptbooks !!!
+         * @param promptbooks @@@
          *
          * @private Use instead `createCollectionFromJson`
          * Note: During the construction logic of all promptbooks are validated
@@ -1134,37 +1174,64 @@
         // <- [🩻]
     ];
 
+    /**
+     * @@@
+     */
+    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: [🔼] Export from `@promptbook/utils`
+     * TODO: [🧠] Is there a way how to meaningfully test this utility
+     */
+
+    /**
+     * @@@
+     *
+     * TODO: [🔼] Export with addUsage
+     */
+    var ZERO_USAGE = deepFreeze({
+        price: { value: 0 },
+        input: {
+            tokensCount: { value: 0 },
+            charactersCount: { value: 0 },
+            wordsCount: { value: 0 },
+            sentencesCount: { value: 0 },
+            linesCount: { value: 0 },
+            paragraphsCount: { value: 0 },
+            pagesCount: { value: 0 },
+        },
+        output: {
+            tokensCount: { value: 0 },
+            charactersCount: { value: 0 },
+            wordsCount: { value: 0 },
+            sentencesCount: { value: 0 },
+            linesCount: { value: 0 },
+            paragraphsCount: { value: 0 },
+            pagesCount: { value: 0 },
+        },
+    });
     /**
      * Function `addUsage` will add multiple usages into one
      *
-     * Note: If you provide 0 values, it returns void usage
+     * Note: If you provide 0 values, it returns ZERO_USAGE
      */
     function addUsage() {
         var usageItems = [];
         for (var _i = 0; _i < arguments.length; _i++) {
             usageItems[_i] = arguments[_i];
         }
-        var initialStructure = {
-            price: { value: 0 },
-            input: {
-                tokensCount: { value: 0 },
-                charactersCount: { value: 0 },
-                wordsCount: { value: 0 },
-                sentencesCount: { value: 0 },
-                linesCount: { value: 0 },
-                paragraphsCount: { value: 0 },
-                pagesCount: { value: 0 },
-            },
-            output: {
-                tokensCount: { value: 0 },
-                charactersCount: { value: 0 },
-                wordsCount: { value: 0 },
-                sentencesCount: { value: 0 },
-                linesCount: { value: 0 },
-                paragraphsCount: { value: 0 },
-                pagesCount: { value: 0 },
-            },
-        };
         return usageItems.reduce(function (acc, item) {
             var e_1, _a, e_2, _b;
             var _c;
@@ -1222,7 +1289,7 @@
                 finally { if (e_2) throw e_2.error; }
             }
             return acc;
-        }, initialStructure);
+        }, deepClone(ZERO_USAGE));
     }
 
     /**
@@ -1299,7 +1366,7 @@
         });
     }
 
-    var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.61.0-10",parameters:[{name:"content",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledge",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{name:"knowledge",title:"Knowledge",dependentParameterNames:["content"],blockType:"PROMPT_TEMPLATE",personaName:null,modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},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> {content}",resultingParameterName:"knowledge"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[{id:1,promptbookVersion:"0.61.0-10",modelUsage:{price:{value:0},input:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}},output:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}}}}],sourceFile:"./promptbook-collection/prepare-knowledge-from-markdown.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.ptbk.md",promptbookVersion:"0.61.0-10",parameters:[{name:"content",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],promptTemplates:[{name:"knowledge",title:"Knowledge",dependentParameterNames:["content"],blockType:"PROMPT_TEMPLATE",personaName:null,modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},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> {content}",resultingParameterName:"keywords"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[{id:1,promptbookVersion:"0.61.0-10",modelUsage:{price:{value:0},input:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}},output:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}}}}],sourceFile:"./promptbook-collection/prepare-knowledge-keywords.ptbk.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.ptbk.md",promptbookVersion:"0.61.0-10",parameters:[{name:"content",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],promptTemplates:[{name:"knowledge",title:"Knowledge",dependentParameterNames:["content"],blockType:"PROMPT_TEMPLATE",expectations:{words:{min:1,max:8}},personaName:null,modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},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> {content}",resultingParameterName:"title"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[{id:1,promptbookVersion:"0.61.0-10",modelUsage:{price:{value:0},input:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}},output:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}}}}],sourceFile:"./promptbook-collection/prepare-knowledge-title.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.ptbk.md",promptbookVersion:"0.61.0-10",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}],promptTemplates:[{name:"make-model-requirements",title:"Make modelRequirements",dependentParameterNames:["availableModelNames","personaDescription"],blockType:"PROMPT_TEMPLATE",expectFormat:"JSON",personaName:null,modelRequirements:{modelVariant:"CHAT",modelName:"gpt-4-turbo"},content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Sample\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### Option `modelName`\n\nPick from the following models:\n\n-   {availableModelNames}\n\n### Option `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### Option `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"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[{id:1,promptbookVersion:"0.61.0-10",modelUsage:{price:{value:0},input:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}},output:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}}}}],sourceFile:"./promptbook-collection/prepare-persona.ptbk.md"}];
+    var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.61.0-12",parameters:[{name:"content",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledge",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{name:"knowledge",title:"Knowledge",dependentParameterNames:["content"],blockType:"PROMPT_TEMPLATE",personaName:null,modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},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> {content}",resultingParameterName:"knowledge"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[{id:1,promptbookVersion:"0.61.0-12",modelUsage:{price:{value:0},input:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}},output:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}}}}],sourceFile:"./promptbook-collection/prepare-knowledge-from-markdown.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.ptbk.md",promptbookVersion:"0.61.0-12",parameters:[{name:"content",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],promptTemplates:[{name:"knowledge",title:"Knowledge",dependentParameterNames:["content"],blockType:"PROMPT_TEMPLATE",personaName:null,modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},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> {content}",resultingParameterName:"keywords"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[{id:1,promptbookVersion:"0.61.0-12",modelUsage:{price:{value:0},input:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}},output:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}}}}],sourceFile:"./promptbook-collection/prepare-knowledge-keywords.ptbk.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.ptbk.md",promptbookVersion:"0.61.0-12",parameters:[{name:"content",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],promptTemplates:[{name:"knowledge",title:"Knowledge",dependentParameterNames:["content"],blockType:"PROMPT_TEMPLATE",expectations:{words:{min:1,max:8}},personaName:null,modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},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> {content}",resultingParameterName:"title"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[{id:1,promptbookVersion:"0.61.0-12",modelUsage:{price:{value:0},input:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}},output:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}}}}],sourceFile:"./promptbook-collection/prepare-knowledge-title.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.ptbk.md",promptbookVersion:"0.61.0-12",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}],promptTemplates:[{name:"make-model-requirements",title:"Make modelRequirements",dependentParameterNames:["availableModelNames","personaDescription"],blockType:"PROMPT_TEMPLATE",expectFormat:"JSON",personaName:null,modelRequirements:{modelVariant:"CHAT",modelName:"gpt-4-turbo"},content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Sample\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### Option `modelName`\n\nPick from the following models:\n\n-   {availableModelNames}\n\n### Option `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### Option `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"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[{id:1,promptbookVersion:"0.61.0-12",modelUsage:{price:{value:0},input:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}},output:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}}}}],sourceFile:"./promptbook-collection/prepare-persona.ptbk.md"}];
 
     var defaultDiacriticsRemovalMap = [
         {
@@ -1973,7 +2040,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.61.0-10';
+    var PROMPTBOOK_VERSION = '0.61.0-12';
     // TODO: !!!! List here all the versions and annotate + put into script
 
     /**
@@ -2107,6 +2174,20 @@
      * TODO: [💝] Unite object for expecting amount and format
      */
 
+    /**
+     * This error type indicates that some limit was reached
+     */
+    var LimitReachedError = /** @class */ (function (_super) {
+        __extends(LimitReachedError, _super);
+        function LimitReachedError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'LimitReachedError';
+            Object.setPrototypeOf(_this, LimitReachedError.prototype);
+            return _this;
+        }
+        return LimitReachedError;
+    }(Error));
+
     /**
      * Replaces parameters in template with values from parameters object
      *
@@ -2123,7 +2204,7 @@
         var loopLimit = LOOP_LIMIT;
         var _loop_1 = function () {
             if (loopLimit-- < 0) {
-                throw new UnexpectedError('Loop limit reached during parameters replacement in `replaceParameters`');
+                throw new LimitReachedError('Loop limit reached during parameters replacement in `replaceParameters`');
             }
             var precol = match.groups.precol;
             var parameterName = match.groups.parameterName;
@@ -2611,6 +2692,7 @@
                                 switch (_e.label) {
                                     case 0:
                                         if (loopLimit-- < 0) {
+                                            // Note: Really UnexpectedError not LimitReachedError - this should be catched during validatePipeline
                                             throw new UnexpectedError('Loop limit reached during resolving parameters pipeline execution');
                                         }
                                         currentTemplate = unresovedTemplates.find(function (template) {
@@ -2657,7 +2739,7 @@
                         }
                         usage_1 = addUsage.apply(void 0, __spreadArray([], __read(executionReport.promptExecutions.map(function (_a) {
                             var result = _a.result;
-                            return (result === null || result === void 0 ? void 0 : result.usage) || addUsage();
+                            return (result === null || result === void 0 ? void 0 : result.usage) || ZERO_USAGE;
                         })), false));
                         return [2 /*return*/, {
                                 isSuccessful: false,
@@ -2686,7 +2768,7 @@
                         }
                         usage = addUsage.apply(void 0, __spreadArray([], __read(executionReport.promptExecutions.map(function (_a) {
                             var result = _a.result;
-                            return (result === null || result === void 0 ? void 0 : result.usage) || addUsage();
+                            return (result === null || result === void 0 ? void 0 : result.usage) || ZERO_USAGE;
                         })), false));
                         return [2 /*return*/, {
                                 isSuccessful: true,
@@ -2718,6 +2800,7 @@
      *
      * @param value any values
      * @returns void
+     * @private within the repository
      */
     function TODO_USE() {
         var value = [];
@@ -2853,6 +2936,7 @@
         });
     }
     /**
+     * TODO: [🔼] !!! Export via `@promptbook/markdown`
      * TODO: [🪂] Do it in parallel 11:11
      * Note: No need to aggregate usage here, it is done by intercepting the llmTools
      */
@@ -2861,7 +2945,6 @@
      * Prepares the knowle
      *
      * @see https://github.com/webgptorg/promptbook/discussions/41
-     * @private within the package
      */
     function prepareKnowledgePieces(knowledgeSources, options) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2876,7 +2959,7 @@
                                 var partialPieces, pieces;
                                 return __generator(this, function (_a) {
                                     switch (_a.label) {
-                                        case 0: return [4 /*yield*/, prepareKnowledgeFromMarkdown(knowledgeSource.source, // <- TODO: !!!!! Unhardcode markdown, detect which type it is
+                                        case 0: return [4 /*yield*/, prepareKnowledgeFromMarkdown(knowledgeSource.source, // <- TODO: [🐝] !!!!! Unhardcode markdown, detect which type it is
                                             options)];
                                         case 1:
                                             partialPieces = _a.sent();
@@ -2914,6 +2997,7 @@
     > ):
     */
     /**
+     * TODO: [🔼] !!! Export via `@promptbook/core`
      * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
      *       Put `knowledgePieces` into `PrepareKnowledgeOptions`
      * TODO: [🪂] More than max things can run in parallel by acident [1,[2a,2b,_],[3a,3b,_]]
@@ -2926,7 +3010,6 @@
      * Prepares the persona for the pipeline
      *
      * @see https://github.com/webgptorg/promptbook/discussions/22
-     * @private within the package
      */
     function preparePersona(personaDescription, options) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2970,9 +3053,6 @@
                             console.info("PERSONA ".concat(personaDescription), modelRequirements);
                         }
                         modelName = modelRequirements.modelName, systemMessage = modelRequirements.systemMessage, temperature = modelRequirements.temperature;
-                        // TODO: !!! Check validity of `modelName`
-                        // TODO: !!! Check validity of `systemMessage`
-                        // TODO: !!! Check validity of `temperature`
                         return [2 /*return*/, {
                                 modelVariant: 'CHAT',
                                 modelName: modelName,
@@ -2983,6 +3063,12 @@
             });
         });
     }
+    /**
+     * TODO: [🔼] !!! Export via `@promptbook/core`
+     * TODO: [🏢] !! Check validity of `modelName` in pipeline
+     * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
+     * TODO: [🏢] !! Check validity of `temperature` in pipeline
+     */
 
     /**
      * Prepare pipeline from string (markdown) format to JSON format
@@ -3008,7 +3094,7 @@
                             id: 1,
                             // TODO: [🍥]> date: $currentDate(),
                             promptbookVersion: PROMPTBOOK_VERSION,
-                            modelUsage: addUsage(),
+                            modelUsage: ZERO_USAGE,
                         };
                         preparations = [
                             // ...preparations
@@ -3043,10 +3129,11 @@
         });
     }
     /**
+     * TODO: [🔼] !!! Export via `@promptbook/core`
      * 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: !!!!! Use here countTotalUsage
+     * TODO: [🎐] !!!! Use here countTotalUsage
      * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
      */
 
@@ -3361,7 +3448,7 @@
             'Knowledge BLOCK',
             // 'Knowledge', // <- Note: [⛱] For execution blocks which are also separate commands shortcut does not work
             //---
-            /* TODO: !!!! Not implemented block types will be in examples in future -> */
+            /* Note: Not implemented block types will be in examples in future -> */
             'Instrument BLOCK',
             // 'Instrument', // <- Note: [⛱]
             'Action BLOCK',
@@ -3379,10 +3466,10 @@
             if (blockTypes.length !== 1) {
                 throw new ParsingError(spaceTrim__default["default"](function (block) { return "\n                        Unknown block type in BLOCK command\n\n                        Supported block types are:\n                        ".concat(block(BlockTypes.join(', ')), "\n                    "); }));
             }
-            // TODO: !!!! Not supported yet
+            var blockType = blockTypes[0];
             return {
                 type: 'BLOCK',
-                blockType: blockTypes[0],
+                blockType: blockType,
             };
         },
     };
@@ -3627,7 +3714,7 @@
 
     var MODEL_VARIANTS = ['COMPLETION', 'CHAT', 'EMBEDDING' /* <- TODO [🏳] */ /* <- [🤖] */];
     /**
-     * TODO: [🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (simmilar that `user` identification is not here)
+     * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (simmilar that `user` identification is not here)
      * TODO: [🧠][💱] Add more model options: `stop_token`, `logit_bias`, `logprobs` (`top_logprobs`), `top_k`, `top_p`, `presence_penalty`, `frequency_penalty`, `bestOf`, `logitBias`, `logitBiasType`,...
      *       [💱] Probbably keep using just `temperature` in Promptbook (not `top_k` and `top_p`)
      * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
@@ -4087,6 +4174,7 @@
     };
     /**
      * TODO: [💐] Implement BOILERPLATE command into `pipelineStringToJsonSync` function
+     * Note: [⚪] This should never be in any released package
      */
 
     /**
@@ -4105,7 +4193,7 @@
         actionCommandParser,
         instrumentCommandParser,
         personaCommandParser,
-        boilerplateCommandParser, // <- TODO: !!!! Only in development, remove in production
+        boilerplateCommandParser, // <- TODO: !! Only in development, remove in production
     ];
 
     /**
@@ -4191,7 +4279,7 @@
         }));
     }
     /**
-     * !!!
+     * @@@
      */
     function getSupportedCommandsMessage() {
         return COMMANDS.flatMap(function (_a) {
@@ -4202,7 +4290,7 @@
         }).join('\n');
     }
     /**
-     * !!!
+     * @@@
      */
     function parseCommandVariant(input) {
         var e_1, _a;
@@ -4933,7 +5021,7 @@
                             if (command.blockType === 'KNOWLEDGE') {
                                 knowledgeCommandParser.applyToPipelineJson(pipelineJson, {
                                     type: 'KNOWLEDGE',
-                                    source: content, // <- TODO: !!!! Working KNOWLEDGE which not referring to the source file/wweb, but its content itseld
+                                    source: content, // <- TODO: [🐝] !!!! Work with KNOWLEDGE which not referring to the source file/wweb, but its content itself
                                 });
                                 return "continue-templates";
                             }
@@ -5071,7 +5159,7 @@
                 delete template.modelRequirements;
             }
             // TODO: [🍧] What actually about preparation and pushing the block into `promptTemplates`
-            pipelineJson.promptTemplates.push(template /* <- !!! */);
+            pipelineJson.promptTemplates.push(template);
         };
         try {
             // =============================================================
@@ -5185,7 +5273,7 @@
     /**
      * Add or modify an auto-generated section in a markdown file
      *
-     * @private within the package
+     * @private within the repository
      */
     function addAutoGeneratedSection(content, options) {
         var sectionName = options.sectionName, sectionContent = options.sectionContent;
@@ -5472,6 +5560,9 @@
         };
         return SimplePromptInterfaceTools;
     }());
+    /**
+     * Note: [🔵] This code should never be published outside of `@promptbook/browser`
+     */
 
     /**
      * Unprepare just strips the preparation data of the pipeline
@@ -5483,6 +5574,7 @@
         return __assign(__assign({}, pipeline), { knowledgeSources: knowledgeSources, knowledgePieces: [], personas: personas, preparations: [] });
     }
     /**
+     * TODO: [🔼] !!! Export via `@promptbook/core`
      * TODO: Write tests for `preparePipeline`
      */
 
@@ -5497,7 +5589,7 @@
     /**
      * Format either small or big number
      *
-     * @private within the package
+     * @private within the repository
      */
     function formatNumber(value) {
         if (value === 0) {
@@ -5517,7 +5609,7 @@
     /**
      * Create a markdown table from a 2D array of strings
      *
-     * @private within the package
+     * @private within the repository
      */
     function createMarkdownTable(table) {
         var columnWidths = table.reduce(function (widths, row) {
@@ -5545,7 +5637,7 @@
     /**
      * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
      *
-     * @private within the package
+     * @private within the repository
      */
     function createMarkdownChart(options) {
         var e_1, _a;
@@ -5590,10 +5682,14 @@
      * Returns the same value that is passed as argument.
      * No side effects.
      *
-     * Note: It can be usefull for leveling indentation
+     * Note: It can be usefull for:
+     *
+     * 1) Leveling indentation
+     * 2) Putting always-true or always-false conditions without getting eslint errors
      *
      * @param value any values
      * @returns the same values
+     * @private within the repository
      */
     function just(value) {
         if (value === undefined) {
@@ -5614,7 +5710,7 @@
     /**
      * Count the duration of working time
      *
-     * @private within the package
+     * @private within the repository
      */
     function countWorkingDuration(items) {
         var e_1, _a;