@promptbook/cli 0.69.0-0 → 0.69.0-2

package/README.md

@@ -28,10 +28,10 @@ To install this package, run:
 npm i ptbk
 
 # Install as dev dependency
-npm i -D @promptbook/cli
+npm install --save-dev @promptbook/cli
 
 # Or install globally
-npm i -g @promptbook/cli
+npm install --global @promptbook/cli
 ```
 
 CLI utils for Promptbook. After install you can use `promptbook` command in terminal:

package/esm/index.es.js

@@ -20,7 +20,7 @@ import OpenAI from 'openai';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.68.0';
+var PROMPTBOOK_VERSION = '0.69.0-1';
 // TODO: !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
@@ -507,6 +507,15 @@ var DEFAULT_REMOTE_URL_PATH = '/promptbook/socket.io';
  * @public exported from `@promptbook/core`
  */
 var IS_VERBOSE = false;
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+var IS_PIPELINE_LOGIC_VALIDATED = just(
+/**/
+// Note: In normal situations, we check the pipeline logic:
+true);
 /**
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
  */
@@ -1040,7 +1049,7 @@ function forEachAsync(array, options, callbackfunction) {
     });
 }
 
-var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.68.0",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",promptbookVersion:"0.68.0",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",promptbookVersion:"0.68.0",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",promptbookVersion:"0.68.0",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## 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-   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.ptbk.md",promptbookVersion:"0.69.0-1",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",promptbookVersion:"0.69.0-1",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",promptbookVersion:"0.69.0-1",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",promptbookVersion:"0.69.0-1",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## 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-   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"}];
 
 /**
  * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
@@ -1247,6 +1256,26 @@ function isValidPipelineUrl(url) {
  * @public exported from `@promptbook/core`
  */
 function validatePipeline(pipeline) {
+    if (IS_PIPELINE_LOGIC_VALIDATED) {
+        validatePipelineCore(pipeline);
+    }
+    else {
+        try {
+            validatePipelineCore(pipeline);
+        }
+        catch (error) {
+            if (!(error instanceof PipelineLogicError)) {
+                throw error;
+            }
+            console.error(spaceTrim(function (block) { return "\n                        Pipeline is not valid but logic errors are temporarily disabled via `IS_PIPELINE_LOGIC_VALIDATED`\n\n                        ".concat(block(error.message), "\n                    "); }));
+        }
+    }
+    return pipeline;
+}
+/**
+ * @private internal function for `validatePipeline`
+ */
+function validatePipelineCore(pipeline) {
     // TODO: [🧠] Maybe test if promptbook is a promise and make specific error case for that
     var e_1, _a, e_2, _b, e_3, _c;
     var pipelineIdentification = (function () {
@@ -1445,7 +1474,6 @@ function validatePipeline(pipeline) {
     while (unresovedTemplates.length > 0) {
         _loop_3();
     }
-    return pipeline;
 }
 /**
  * TODO: [🧠] Work with promptbookVersion
@@ -2227,7 +2255,7 @@ function extractVariables(script) {
  */
 function extractParameterNamesFromTemplate(template) {
     var e_1, _a, e_2, _b, e_3, _c;
-    var title = template.title, description = template.description, templateType = template.templateType, content = template.content, preparedContent = template.preparedContent, jokerParameterNames = template.jokerParameterNames;
+    var title = template.title, description = template.description, templateType = template.templateType, content = template.content, preparedContent = template.preparedContent, jokerParameterNames = template.jokerParameterNames, foreach = template.foreach;
     var parameterNames = new Set();
     try {
         for (var _d = __values(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read(extractParameterNames(title)), false), __read(extractParameterNames(description || '')), false), __read(extractParameterNames(content)), false), __read(extractParameterNames(preparedContent || '')), false)), _e = _d.next(); !_e.done; _e = _d.next()) {
@@ -2272,6 +2300,14 @@ function extractParameterNamesFromTemplate(template) {
     }
     parameterNames.delete('content');
     //                      <- Note {websiteContent} is used in `preparedContent`
+    // Note: [🍭] Fixing dependent subparameterName from FOREACH command
+    if (foreach !== undefined) {
+        if (parameterNames.has(foreach.subparameterName)) {
+            parameterNames.delete(foreach.subparameterName);
+            parameterNames.add(foreach.parameterName);
+            // <- TODO: [🚎] Warn/logic error when `subparameterName` not used
+        }
+    }
     return parameterNames;
 }
 /**
@@ -3300,6 +3336,7 @@ function createPipelineExecutor(options) {
                                         case 0:
                                             isJokerAttempt = attempt < 0;
                                             jokerParameterName = jokerParameterNames[jokerParameterNames.length + attempt];
+                                            // TODO: [🧠] !!!!!! JOKERS, EXPECTATIONS, POSTPROCESSING and FOREACH
                                             if (isJokerAttempt && !jokerParameterName) {
                                                 throw new UnexpectedError(spaceTrim(function (block) { return "\n                                Joker not found in attempt ".concat(attempt, "\n\n                                ").concat(block(pipelineIdentification), "\n                            "); }));
                                             }
@@ -3618,6 +3655,19 @@ function createPipelineExecutor(options) {
                             attempt++;
                             return [3 /*break*/, 4];
                         case 7:
+                            //------------------------------------
+                            /*
+                
+                
+                
+                
+                
+                
+                
+                
+                
+                            */
+                            //------------------------------------
                             if (resultString === null) {
                                 throw new UnexpectedError(spaceTrim(function (block) { return "\n                            Something went wrong and prompt result is null\n\n                            ".concat(block(pipelineIdentification), "\n                        "); }));
                             }
@@ -5145,20 +5195,21 @@ var foreachCommandParser = {
      * Example usages of the FOREACH command
      */
     examples: [
-        'FOREACH List Line -> `{customer}`',
-        'FOR List Line -> `{customer}`',
-        'EACH List Line -> `{customer}`',
+        'FOREACH List Line `{customers}` -> `{customer}`',
+        'FOR List Line `{customers}` -> `{customer}`',
+        'EACH List Line `{customers}` -> `{customer}`',
         // <- TODO: [🍭] !!!!!! More
     ],
     /**
      * Parses the FOREACH command
      */
     parse: function (input) {
-        var args = input.args, rawArgs = input.rawArgs;
+        var args = input.args;
         var formatName = normalizeTo_SCREAMING_CASE(args[0] || '');
         var cellName = normalizeTo_SCREAMING_CASE(args[1] || '');
-        var assignSign = args[2];
-        var parameter = args[3];
+        var parameterNameWrapped = args[2];
+        var assignSign = args[3];
+        var subparameterNameWrapped = args[4];
         if (![
             'LIST',
             'CSV',
@@ -5173,7 +5224,7 @@ var foreachCommandParser = {
             'ROW',
             'COLUMN',
             'CELL',
-            // <- TODO: [🏢] Unhardcode format cekks
+            // <- TODO: [🏢] Unhardcode format cells
         ].includes(cellName)) {
             console.info({ args: args, cellName: cellName });
             throw new Error("Format ".concat(formatName, " does not support cell \"").concat(cellName, "\""));
@@ -5183,24 +5234,27 @@ var foreachCommandParser = {
             console.info({ args: args, assignSign: assignSign });
             throw new Error("FOREACH command must have '->' to assign the value to the parameter");
         }
-        var parameterNames = extractParameterNames(parameter || rawArgs);
-        if (parameterNames.size !== 1) {
-            console.info({ args: args, parameter: parameter, rawArgs: rawArgs });
-            throw new Error("FOREACH command contain exactly one parameter, but found ".concat(parameterNames.size));
-        }
-        var parameterName = parameterNames.values().next().value;
-        if (typeof parameterName !== 'string'
-        // <- TODO: !!!!!! Replace with propper parameter name validation
-        ) {
-            console.info({ args: args, parameterName: parameterName });
-            throw new Error("Invalid parameter name");
-            // <- TODO: !!!!!! Better error (with rules and precise error) from validateParameterName
-        }
+        // TODO: !!!!!! Replace with propper parameter name validation
+        if ((parameterNameWrapped === null || parameterNameWrapped === void 0 ? void 0 : parameterNameWrapped.substring(0, 1)) !== '{' ||
+            (parameterNameWrapped === null || parameterNameWrapped === void 0 ? void 0 : parameterNameWrapped.substring(parameterNameWrapped.length - 1, parameterNameWrapped.length)) !== '}') {
+            console.info({ args: args, parameterNameWrapped: parameterNameWrapped }, parameterNameWrapped === null || parameterNameWrapped === void 0 ? void 0 : parameterNameWrapped.substring(0, 1), parameterNameWrapped === null || parameterNameWrapped === void 0 ? void 0 : parameterNameWrapped.substring(parameterNameWrapped.length - 1, parameterNameWrapped.length));
+            throw new Error("!!!!!! 1 Here will be error (with rules and precise error) from validateParameterName");
+        }
+        var parameterName = parameterNameWrapped.substring(1, parameterNameWrapped.length - 1);
+        // TODO: !!!!!! Replace with propper parameter name validation
+        if ((subparameterNameWrapped === null || subparameterNameWrapped === void 0 ? void 0 : subparameterNameWrapped.substring(0, 1)) !== '{' ||
+            (subparameterNameWrapped === null || subparameterNameWrapped === void 0 ? void 0 : subparameterNameWrapped.substring(subparameterNameWrapped.length - 1, subparameterNameWrapped.length)) !==
+                '}') {
+            console.info({ args: args, subparameterNameWrapped: subparameterNameWrapped });
+            throw new Error("!!!!!! 2 Here will be error (with rules and precise error) from validateParameterName");
+        }
+        var subparameterName = subparameterNameWrapped.substring(1, subparameterNameWrapped.length - 1);
         return {
             type: 'FOREACH',
             formatName: formatName,
             cellName: cellName,
             parameterName: parameterName,
+            subparameterName: subparameterName,
         };
     },
     /**
@@ -5209,8 +5263,10 @@ var foreachCommandParser = {
      * Note: `$` is used to indicate that this function mutates given `templateJson`
      */
     $applyToTemplateJson: function (command, $templateJson, $pipelineJson) {
-        keepUnused(command, $templateJson, $pipelineJson);
-        // <- TODO: [🍭] !!!!!! Implement
+        var formatName = command.formatName, cellName = command.cellName, parameterName = command.parameterName, subparameterName = command.subparameterName;
+        $templateJson.foreach = { formatName: formatName, cellName: cellName, parameterName: parameterName, subparameterName: subparameterName };
+        keepUnused($pipelineJson); // <- TODO: !!!!!! BUT Maybe register subparameter from foreach into parameters of the pipeline
+        // Note: [🍭] FOREACH apply has some sideeffects on different places in codebase
     },
     /**
      * Converts the FOREACH command back to string
@@ -5219,8 +5275,7 @@ var foreachCommandParser = {
      */
     stringify: function (command) {
         keepUnused(command);
-        return "";
-        // <- TODO: [🍭] !!!!!! Implement
+        return "---"; // <- TODO: [🛋] Implement
     },
     /**
      * Reads the FOREACH command from the `TemplateJson`
@@ -5229,8 +5284,7 @@ var foreachCommandParser = {
      */
     takeFromTemplateJson: function ($templateJson) {
         keepUnused($templateJson);
-        return [];
-        // <- TODO: [🍭] !!!!!! Implement
+        throw new NotYetImplementedError("[\uD83D\uDECB] Not implemented yet"); // <- TODO: [🛋] Implement
     },
 };
 /**
@@ -5345,6 +5399,7 @@ var jokerCommandParser = {
      */
     parse: function (input) {
         var args = input.args;
+        // TODO: !!!!!! Replace with propper parameter name validation
         var parametersMatch = (args.pop() || '').match(/^\{(?<parameterName>[a-z0-9_]+)\}$/im);
         if (!parametersMatch || !parametersMatch.groups || !parametersMatch.groups.parameterName) {
             throw new ParseError("Invalid joker");
@@ -5474,6 +5529,7 @@ var modelCommandParser = {
         if ($pipelineJson.defaultModelRequirements[command.key] !== undefined) {
             if ($pipelineJson.defaultModelRequirements[command.key] === command.value) {
                 console.warn("Multiple commands `MODEL ".concat(command.key, " ").concat(command.value, "` in the pipeline head"));
+                // <- TODO: [🚎] Some better way how to get warnings from pipeline parsing / logic
             }
             else {
                 throw new ParseError(spaceTrim$1("\n                        Redefinition of MODEL `".concat(command.key, "` in the pipeline head\n\n                        You have used:\n                        - MODEL ").concat(command.key, " ").concat($pipelineJson.defaultModelRequirements[command.key], "\n                        - MODEL ").concat(command.key, " ").concat(command.value, "\n                    ")));
@@ -8528,6 +8584,9 @@ function renderPromptbookMermaid(pipelineJson, options) {
     return promptbookMermaid;
 }
 /**
+ * TODO: !!!!!! FOREACH in mermaid graph
+ * TODO: !!!!!! Knowledge in mermaid graph
+ * TODO: !!!!!! Personas in mermaid graph
  * TODO: Maybe use some Mermaid package instead of string templating
  * TODO: [🕌] When more than 2 functionalities, split into separate functions
  */