@promptbook/markdown-utils 0.74.0-8 → 0.74.0

package/umd/index.umd.js

@@ -22,7 +22,7 @@
      *
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.74.0-7';
+    var PROMPTBOOK_ENGINE_VERSION = '0.74.0-13';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      */
@@ -357,7 +357,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.ptbk.md",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],templates:[{templateType:"PROMPT_TEMPLATE",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:"./promptbook-collection/prepare-knowledge-from-markdown.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.ptbk.md",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],templates:[{templateType:"PROMPT_TEMPLATE",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:"./promptbook-collection/prepare-knowledge-keywords.ptbk.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.ptbk.md",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],templates:[{templateType:"PROMPT_TEMPLATE",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:"./promptbook-collection/prepare-knowledge-title.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.ptbk.md",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}],templates:[{templateType:"PROMPT_TEMPLATE",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:"./promptbook-collection/prepare-persona.ptbk.md"}];
+    var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book.md",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],templates:[{templateType:"PROMPT_TEMPLATE",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:"./promptbook-collection/prepare-knowledge-from-markdown.book.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.book.md",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],templates:[{templateType:"PROMPT_TEMPLATE",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:"./promptbook-collection/prepare-knowledge-keywords.book.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.book.md",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],templates:[{templateType:"PROMPT_TEMPLATE",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:"./promptbook-collection/prepare-knowledge-title.book.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.book.md",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}],templates:[{templateType:"PROMPT_TEMPLATE",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:"./promptbook-collection/prepare-persona.book.md"}];
 
     /**
      * Prettify the html code
@@ -396,13 +396,13 @@
     /**
      * Converts promptbook in JSON format to string format
      *
-     * @param pipelineJson Promptbook in JSON format (.ptbk.json)
-     * @returns Promptbook in string format (.ptbk.md)
+     * @param pipelineJson Promptbook in JSON format (.book.json)
+     * @returns Promptbook in string format (.book.md)
      * @public exported from `@promptbook/core`
      */
     function pipelineJsonToString(pipelineJson) {
         var e_1, _a, e_2, _b, e_3, _c, e_4, _d, e_5, _e, e_6, _f;
-        var title = pipelineJson.title, pipelineUrl = pipelineJson.pipelineUrl, promptbookVersion = pipelineJson.promptbookVersion, description = pipelineJson.description, parameters = pipelineJson.parameters, templates = pipelineJson.templates;
+        var title = pipelineJson.title, pipelineUrl = pipelineJson.pipelineUrl, bookVersion = pipelineJson.bookVersion, description = pipelineJson.description, parameters = pipelineJson.parameters, templates = pipelineJson.templates;
         var pipelineString = "# ".concat(title);
         if (description) {
             pipelineString += '\n\n';
@@ -412,8 +412,10 @@
         if (pipelineUrl) {
             commands.push("PIPELINE URL ".concat(pipelineUrl));
         }
-        commands.push("PROMPTBOOK VERSION ".concat(promptbookVersion));
-        // TODO: [main] !!! This increase size of the bundle and is probbably not necessary
+        if (bookVersion !== "undefined") {
+            commands.push("BOOK VERSION ".concat(bookVersion));
+        }
+        // TODO: [main] !!!!! This increases size of the bundle and is probbably not necessary
         pipelineString = prettifyMarkdown(pipelineString);
         try {
             for (var _g = __values(parameters.filter(function (_a) {
@@ -593,7 +595,7 @@
      * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
      * TODO: [🏛] Maybe make some markdown builder
      * TODO: [🏛] Escape all
-     * TODO: [🧠] Should be in generated .ptbk.md file GENERATOR_WARNING
+     * TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
      */
 
     /**
@@ -815,6 +817,13 @@
      * @private within the repository
      */
     var GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has been generated so that any manual changes will be overwritten";
+    //            <- TODO: [🐊] Pick the best claim
+    /**
+     * When the title is not provided, the default title is used
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var DEFAULT_TITLE = "Untitled";
     // <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
     /**
      * The maximum number of iterations for a loops
@@ -1060,7 +1069,7 @@
         if (!url.startsWith('https://')) {
             return false;
         }
-        if (!(url.endsWith('.book.md') || url.endsWith('.book') || url.endsWith('.ptbk.md') || url.endsWith('.ptbk'))) {
+        if (!(url.endsWith('.book.md') || url.endsWith('.book') || url.endsWith('.book.md') || url.endsWith('.ptbk'))) {
             return false;
         }
         if (url.includes('#')) {
@@ -1129,9 +1138,9 @@
             // <- Note: [🚲]
             throw new PipelineLogicError(spaceTrim.spaceTrim(function (block) { return "\n                    Invalid promptbook URL \"".concat(pipeline.pipelineUrl, "\"\n\n                    ").concat(block(pipelineIdentification), "\n                "); }));
         }
-        if (pipeline.promptbookVersion !== undefined && !isValidPromptbookVersion(pipeline.promptbookVersion)) {
+        if (pipeline.bookVersion !== undefined && !isValidPromptbookVersion(pipeline.bookVersion)) {
             // <- Note: [🚲]
-            throw new PipelineLogicError(spaceTrim.spaceTrim(function (block) { return "\n                    Invalid Promptbook Version \"".concat(pipeline.promptbookVersion, "\"\n\n                    ").concat(block(pipelineIdentification), "\n                "); }));
+            throw new PipelineLogicError(spaceTrim.spaceTrim(function (block) { return "\n                    Invalid Promptbook Version \"".concat(pipeline.bookVersion, "\"\n\n                    ").concat(block(pipelineIdentification), "\n                "); }));
         }
         // TODO: [🧠] Maybe do here some propper JSON-schema / ZOD checking
         if (!Array.isArray(pipeline.parameters)) {
@@ -2780,7 +2789,7 @@
                         collection = createCollectionFromJson.apply(void 0, __spreadArray([], __read(PipelineCollection), false));
                         _b = createPipelineExecutor;
                         _c = {};
-                        return [4 /*yield*/, collection.getPipelineByUrl('https://promptbook.studio/promptbook/prepare-persona.ptbk.md')];
+                        return [4 /*yield*/, collection.getPipelineByUrl('https://promptbook.studio/promptbook/prepare-persona.book.md')];
                     case 1:
                         preparePersonaExecutor = _b.apply(void 0, [(_c.pipeline = _d.sent(),
                                 _c.tools = tools,
@@ -3452,12 +3461,12 @@
      */
     function clonePipeline(pipeline) {
         // Note: Not using spread operator (...) because @@@
-        var pipelineUrl = pipeline.pipelineUrl, sourceFile = pipeline.sourceFile, title = pipeline.title, promptbookVersion = pipeline.promptbookVersion, description = pipeline.description, parameters = pipeline.parameters, templates = pipeline.templates, knowledgeSources = pipeline.knowledgeSources, knowledgePieces = pipeline.knowledgePieces, personas = pipeline.personas, preparations = pipeline.preparations;
+        var pipelineUrl = pipeline.pipelineUrl, sourceFile = pipeline.sourceFile, title = pipeline.title, bookVersion = pipeline.bookVersion, description = pipeline.description, parameters = pipeline.parameters, templates = pipeline.templates, knowledgeSources = pipeline.knowledgeSources, knowledgePieces = pipeline.knowledgePieces, personas = pipeline.personas, preparations = pipeline.preparations;
         return {
             pipelineUrl: pipelineUrl,
             sourceFile: sourceFile,
             title: title,
-            promptbookVersion: promptbookVersion,
+            bookVersion: bookVersion,
             description: description,
             parameters: parameters,
             templates: templates,
@@ -4265,30 +4274,42 @@
         return text.length;
     }
 
+    /**
+     * Number of characters per standard line with 11pt Arial font size.
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    var CHARACTERS_PER_STANDARD_LINE = 63;
+    /**
+     * Number of lines per standard A4 page with 11pt Arial font size and standard margins and spacing.
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    var LINES_PER_STANDARD_PAGE = 44;
+
     /**
      * Counts number of lines in the text
      *
+     * Note: This does not check only for the presence of newlines, but also for the length of the standard line.
+     *
      * @public exported from `@promptbook/utils`
      */
     function countLines(text) {
-        if (text === '') {
-            return 0;
-        }
-        return text.split('\n').length;
+        text = text.replace('\r\n', '\n');
+        text = text.replace('\r', '\n');
+        var lines = text.split('\n');
+        return lines.reduce(function (count, line) { return count + Math.ceil(line.length / CHARACTERS_PER_STANDARD_LINE); }, 0);
     }
 
     /**
      * Counts number of pages in the text
      *
+     * Note: This does not check only for the count of newlines, but also for the length of the standard line and length of the standard page.
+     *
      * @public exported from `@promptbook/utils`
      */
     function countPages(text) {
-        if (text === '') {
-            return 0;
-        }
-        var pagesByLinesCount = Math.ceil(countLines(text) / 44);
-        var pagesByCharactersCount = Math.ceil(countCharacters(text) / 2772);
-        return Math.max(pagesByLinesCount, pagesByCharactersCount);
+        return Math.ceil(countLines(text) / LINES_PER_STANDARD_PAGE);
     }
 
     /**
@@ -4568,7 +4589,7 @@
                                                 promptTitle: template.title,
                                                 promptMessage: replaceParameters(template.description || '', parameters),
                                                 defaultValue: replaceParameters(preparedContent, parameters),
-                                                // TODO: [🧠] !! Figure out how to define placeholder in .ptbk.md file
+                                                // TODO: [🧠] !! Figure out how to define placeholder in .book.md file
                                                 placeholder: undefined,
                                                 priority: priority,
                                             }))];
@@ -5134,7 +5155,7 @@
                             pipelineUrl: preparedPipeline.pipelineUrl,
                             title: preparedPipeline.title,
                             promptbookUsedVersion: PROMPTBOOK_ENGINE_VERSION,
-                            promptbookRequestedVersion: preparedPipeline.promptbookVersion,
+                            promptbookRequestedVersion: preparedPipeline.bookVersion,
                             description: preparedPipeline.description,
                             promptExecutions: [],
                         };
@@ -5530,7 +5551,7 @@
                             collection = createCollectionFromJson.apply(void 0, __spreadArray([], __read(PipelineCollection), false));
                             _d = createPipelineExecutor;
                             _g = {};
-                            return [4 /*yield*/, collection.getPipelineByUrl('https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md')];
+                            return [4 /*yield*/, collection.getPipelineByUrl('https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book.md')];
                         case 1:
                             prepareKnowledgeFromMarkdownExecutor = _d.apply(void 0, [(_g.pipeline = _k.sent(),
                                     _g.tools = {
@@ -5539,7 +5560,7 @@
                                     _g)]);
                             _e = createPipelineExecutor;
                             _h = {};
-                            return [4 /*yield*/, collection.getPipelineByUrl('https://promptbook.studio/promptbook/prepare-knowledge-title.ptbk.md')];
+                            return [4 /*yield*/, collection.getPipelineByUrl('https://promptbook.studio/promptbook/prepare-knowledge-title.book.md')];
                         case 2:
                             prepareTitleExecutor = _e.apply(void 0, [(_h.pipeline = _k.sent(),
                                     _h.tools = {
@@ -5548,7 +5569,7 @@
                                     _h)]);
                             _f = createPipelineExecutor;
                             _j = {};
-                            return [4 /*yield*/, collection.getPipelineByUrl('https://promptbook.studio/promptbook/prepare-knowledge-keywords.ptbk.md')];
+                            return [4 /*yield*/, collection.getPipelineByUrl('https://promptbook.studio/promptbook/prepare-knowledge-keywords.book.md')];
                         case 3:
                             prepareKeywordsExecutor = _f.apply(void 0, [(_j.pipeline = _k.sent(),
                                     _j.tools = {
@@ -5906,7 +5927,7 @@
                 return;
             }
             if (!section.startsWith('#')) {
-                section = "# Untitled\n\n".concat(section);
+                section = "# ".concat(DEFAULT_TITLE, "\n\n").concat(section);
             }
             sections.push(section);
             buffer = [];
@@ -5970,7 +5991,7 @@
         var e_1, _a;
         var sections = splitMarkdownIntoSections(markdown);
         if (sections.length === 0) {
-            return '# Untitled';
+            return "# ".concat(DEFAULT_TITLE);
         }
         var flattenedMarkdown = '';
         var parsedSections = sections.map(parseMarkdownSection);
@@ -5981,7 +6002,7 @@
         }
         else {
             parsedSections.unshift(firstSection);
-            flattenedMarkdown += "# Untitled" + "\n\n"; // <- [🧠] Maybe 3 new lines?
+            flattenedMarkdown += "# ".concat(DEFAULT_TITLE) + "\n\n"; // <- [🧠] Maybe 3 new lines?
         }
         try {
             for (var parsedSections_1 = __values(parsedSections), parsedSections_1_1 = parsedSections_1.next(); !parsedSections_1_1.done; parsedSections_1_1 = parsedSections_1.next()) {