@promptbook/cli 0.69.0-17 → 0.69.0-19

package/esm/index.es.js

@@ -21,7 +21,7 @@ import OpenAI from 'openai';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.69.0-16';
+var PROMPTBOOK_VERSION = '0.69.0-18';
 // TODO:[main] !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
@@ -3898,15 +3898,15 @@ function executeFormatCells(options) {
                             .join('\n')), "\n\n                    [\u26F7] This should never happen because format name should be validated during parsing\n\n                    ").concat(block(pipelineIdentification), "\n                "); }));
                     }
                     subvalueDefinition = formatDefinition.subvalueDefinitions.find(function (subvalueDefinition) {
-                        return __spreadArray([subvalueDefinition.subvalueName], __read((subvalueDefinition.aliases || [])), false).includes(template.foreach.cellName);
+                        return __spreadArray([subvalueDefinition.subvalueName], __read((subvalueDefinition.aliases || [])), false).includes(template.foreach.subformatName);
                     });
                     if (subvalueDefinition === undefined) {
                         throw new UnexpectedError(
                         // <- TODO: [🧠][🧐] Should be formats fixed per promptbook version or behave as plugins (=> change UnexpectedError)
-                        spaceTrim$1(function (block) { return "\n                    Unsupported cell name \"".concat(template.foreach.cellName, "\" for format \"").concat(template.foreach.formatName, "\"\n\n                    Available cell names for format \"").concat(formatDefinition.formatName, "\":\n                    ").concat(block(formatDefinition.subvalueDefinitions
+                        spaceTrim$1(function (block) { return "\n                    Unsupported subformat name \"".concat(template.foreach.subformatName, "\" for format \"").concat(template.foreach.formatName, "\"\n\n                    Available subformat names for format \"").concat(formatDefinition.formatName, "\":\n                    ").concat(block(formatDefinition.subvalueDefinitions
                             .map(function (subvalueDefinition) { return subvalueDefinition.subvalueName; })
                             .map(function (subvalueName) { return "- ".concat(subvalueName); })
-                            .join('\n')), "\n\n                    [\u26F7] This should never happen because cell name should be validated during parsing\n\n                    ").concat(block(pipelineIdentification), "\n                "); }));
+                            .join('\n')), "\n\n                    [\u26F7] This should never happen because subformat name should be validated during parsing\n\n                    ").concat(block(pipelineIdentification), "\n                "); }));
                     }
                     if (formatDefinition.formatName === 'CSV') {
                         formatSettings = settings.csvSettings;
@@ -3951,8 +3951,6 @@ function executeFormatCells(options) {
 /**
  * TODO: !!!!!! Make pipelineIdentification more precise
  * TODO: !!!!!! How FOREACH execution looks in the report
- * TODO: [🧠][🦥] Better (less confusing) name for "cell" / "subvalue" / "subparameter"
- * TODO: []
  */
 
 /**
@@ -5815,6 +5813,29 @@ function normalizeTo_camelCase(text, _isFirstLetterCapital) {
  * TODO: [🌺] Use some intermediate util splitWords
  */
 
+/**
+ * Removes quotes from a string
+ *
+ * Tip: This is very usefull for post-processing of the result of the LLM model
+ * Note: This function removes only the same quotes from the beginning and the end of the string
+ * Note: There are two simmilar functions:
+ * - `removeQuotes` which removes only bounding quotes
+ * - `unwrapResult` which removes whole introduce sentence
+ *
+ * @param text optionally quoted text
+ * @returns text without quotes
+ * @public exported from `@promptbook/utils`
+ */
+function removeQuotes(text) {
+    if (text.startsWith('"') && text.endsWith('"')) {
+        return text.slice(1, -1);
+    }
+    if (text.startsWith('\'') && text.endsWith('\'')) {
+        return text.slice(1, -1);
+    }
+    return text;
+}
+
 /**
  * Function `validateParameterName` will @@@
  *
@@ -5873,6 +5894,9 @@ function validateParameterName(parameterName) {
             parameterName.includes(']')) {
             throw new ParseError("Parameter name cannot contain braces");
         }
+        parameterName = removeDiacritics(parameterName);
+        parameterName = removeEmojis(parameterName);
+        parameterName = removeQuotes(parameterName);
         parameterName = normalizeTo_camelCase(parameterName);
         if (parameterName === '') {
             throw new ParseError("Parameter name cannot be empty");
@@ -5926,7 +5950,7 @@ var foreachCommandParser = {
     examples: [
         'FOREACH Text Line `{customers}` -> `{customer}`',
         'FOR Csv Row `{customers}` -> `{firstName}`, `{lastName}`',
-        'EACH Csv Cell `{customers}` -> `{cell}`',
+        'EACH Csv Cell `{customers}` -> `{subformat}`',
     ],
     /**
      * Parses the FOREACH command
@@ -5934,8 +5958,8 @@ var foreachCommandParser = {
     parse: function (input) {
         var args = input.args;
         var formatName = normalizeTo_SCREAMING_CASE(args[0] || '');
-        var cellName = normalizeTo_SCREAMING_CASE(args[1] || '');
-        var parameterNameWrapped = args[2];
+        var subformatName = normalizeTo_SCREAMING_CASE(args[1] || '');
+        var parameterNameArg = args[2] || '';
         var assignSign = args[3];
         var formatDefinition = FORMAT_DEFINITIONS.find(function (formatDefinition) {
             return __spreadArray([formatDefinition.formatName], __read((formatDefinition.aliases || [])), false).includes(formatName);
@@ -5947,24 +5971,19 @@ var foreachCommandParser = {
             // <- TODO: [🏢] List all supported format names
         }
         var subvalueDefinition = formatDefinition.subvalueDefinitions.find(function (subvalueDefinition) {
-            return __spreadArray([subvalueDefinition.subvalueName], __read((subvalueDefinition.aliases || [])), false).includes(cellName);
+            return __spreadArray([subvalueDefinition.subvalueName], __read((subvalueDefinition.aliases || [])), false).includes(subformatName);
         });
         if (subvalueDefinition === undefined) {
-            throw new ParseError(spaceTrim$1(function (block) { return "\n                        Unsupported cell name \"".concat(cellName, "\" for format \"").concat(formatName, "\"\n\n                        Available cell names for format \"").concat(formatDefinition.formatName, "\":\n                        ").concat(block(formatDefinition.subvalueDefinitions
+            throw new ParseError(spaceTrim$1(function (block) { return "\n                        Unsupported subformat name \"".concat(subformatName, "\" for format \"").concat(formatName, "\"\n\n                        Available subformat names for format \"").concat(formatDefinition.formatName, "\":\n                        ").concat(block(formatDefinition.subvalueDefinitions
                 .map(function (subvalueDefinition) { return subvalueDefinition.subvalueName; })
                 .map(function (subvalueName) { return "- ".concat(subvalueName); })
                 .join('\n')), "\n                    "); }));
-            // <- TODO: [🏢] List all supported cell names for the format
+            // <- TODO: [🏢] List all supported subformat names for the format
         }
         if (assignSign !== '->') {
             throw new ParseError("FOREACH command must have '->' to assign the value to the parameter");
         }
-        // TODO: !!! Replace with propper parameter name validation `validateParameterName`
-        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)) !== '}') {
-            throw new ParseError("Invalid parameter name \"".concat(parameterNameWrapped, "\" - must be wrapped in curly brackets: {parameterName}"));
-        }
-        var parameterName = parameterNameWrapped.substring(1, parameterNameWrapped.length - 1);
+        var parameterName = validateParameterName(parameterNameArg);
         var subparameterNames = args
             .slice(4)
             .map(function (parameterName) { return parameterName.split(',').join(' ').trim(); })
@@ -5976,7 +5995,7 @@ var foreachCommandParser = {
         return {
             type: 'FOREACH',
             formatName: formatName,
-            cellName: cellName,
+            subformatName: subformatName,
             parameterName: parameterName,
             subparameterNames: subparameterNames,
         };
@@ -5987,10 +6006,10 @@ var foreachCommandParser = {
      * Note: `$` is used to indicate that this function mutates given `templateJson`
      */
     $applyToTemplateJson: function (command, $templateJson, $pipelineJson) {
-        var formatName = command.formatName, cellName = command.cellName, parameterName = command.parameterName, subparameterNames = command.subparameterNames;
-        // TODO: !!!!!! Detect double use
-        // TODO: !!!!!! Detect usage with JOKER and don't allow it
-        $templateJson.foreach = { formatName: formatName, cellName: cellName, parameterName: parameterName, subparameterNames: subparameterNames };
+        var formatName = command.formatName, subformatName = command.subformatName, parameterName = command.parameterName, subparameterNames = command.subparameterNames;
+        // TODO: [🍭] Detect double use
+        // TODO: [🍭] Detect usage with JOKER and don't allow it
+        $templateJson.foreach = { formatName: formatName, subformatName: subformatName, parameterName: parameterName, subparameterNames: subparameterNames };
         keepUnused($pipelineJson); // <- TODO: [🧠] Maybe register subparameter from foreach into parameters of the pipeline
         // Note: [🍭] FOREACH apply has some sideeffects on different places in codebase
     },
@@ -6014,8 +6033,7 @@ var foreachCommandParser = {
     },
 };
 /**
- * TODO: [🧠][🦥] Better (less confusing) name for "cell" / "subvalue" / "subparameter"
- * TODO: [🍭] !!!!!! Make .ptbk.md file with examples of the FOREACH command and also with wrong parsing and logic
+ * TODO: [🍭] Make .ptbk.md file with examples of the FOREACH with wrong parsing and logic
  */
 
 /**
@@ -6125,12 +6143,11 @@ var jokerCommandParser = {
      */
     parse: function (input) {
         var args = input.args;
-        // TODO: !!!!!! Replace with propper parameter name validation `validateParameterName`
-        var parametersMatch = (args.pop() || '').match(/^\{(?<parameterName>[a-z0-9_]+)\}$/im);
-        if (!parametersMatch || !parametersMatch.groups || !parametersMatch.groups.parameterName) {
-            throw new ParseError("Invalid joker");
+        if (args.length !== 1) {
+            throw new ParseError("JOKE command expects exactly one parameter name");
         }
-        var parameterName = parametersMatch.groups.parameterName;
+        var parameterNameArg = args[0] || '';
+        var parameterName = validateParameterName(parameterNameArg);
         return {
             type: 'JOKER',
             parameterName: parameterName,
@@ -6354,14 +6371,13 @@ var parameterCommandParser = {
      * Parses the PARAMETER command
      */
     parse: function (input) {
-        var normalized = input.normalized, raw = input.raw;
-        var parametersMatch = raw.match(/\{(?<parameterName>[a-z0-9_]+)\}[^\S\r\n]*(?<parameterDescription>.*)$/im);
-        if (!parametersMatch || !parametersMatch.groups || !parametersMatch.groups.parameterName) {
-            throw new ParseError("Invalid parameter");
-        }
-        var _a = parametersMatch.groups, parameterName = _a.parameterName, parameterDescription = _a.parameterDescription;
-        if (parameterDescription && parameterDescription.match(/\{(?<parameterName>[a-z0-9_]+)\}/im)) {
-            throw new ParseError("Parameter {".concat(parameterName, "} can not contain another parameter in description"));
+        var normalized = input.normalized, args = input.args, raw = input.raw;
+        var parameterNameRaw = args.shift() || '';
+        var parameterDescriptionRaw = args.join(' ');
+        // <- TODO: When [🥶] fixed, change to:
+        //        >   const parameterDescriptionRaw = rawArgs.split(parameterNameRaw).join('').trim();
+        if (parameterDescriptionRaw && parameterDescriptionRaw.match(/\{(?<embeddedParameterName>[a-z0-9_]+)\}/im)) {
+            throw new ParseError(spaceTrim$1(function (block) { return "\n                        Parameter {".concat(parameterNameRaw, "} can not contain another parameter in description\n\n                        The description:\n                        ").concat(block(parameterDescriptionRaw), "\n                    "); }));
         }
         var isInput = normalized.startsWith('INPUT');
         var isOutput = normalized.startsWith('OUTPUT');
@@ -6369,11 +6385,12 @@ var parameterCommandParser = {
             isInput = false;
             isOutput = false;
         }
-        // TODO: !!!!!! Add parameter name validation
+        var parameterName = validateParameterName(parameterNameRaw);
+        var parameterDescription = parameterDescriptionRaw.trim() || null;
         return {
             type: 'PARAMETER',
             parameterName: parameterName,
-            parameterDescription: parameterDescription.trim() || null,
+            parameterDescription: parameterDescription,
             isInput: isInput,
             isOutput: isOutput,
         };
@@ -7181,7 +7198,9 @@ function parseCommand(raw, usagePlace) {
     for (var commandNameSegmentsCount = 0; commandNameSegmentsCount < Math.min(items.length, 3); commandNameSegmentsCount++) {
         var commandNameRaw = items.slice(0, commandNameSegmentsCount + 1).join('_');
         var args = items.slice(commandNameSegmentsCount + 1);
-        var rawArgs = raw.substring(commandNameRaw.length).trim();
+        var rawArgs = raw
+            .substring(commandNameRaw.length)
+            .trim();
         var command = parseCommandVariant({ usagePlace: usagePlace, raw: raw, rawArgs: rawArgs, normalized: normalized, args: args, commandNameRaw: commandNameRaw });
         if (command !== null) {
             return command;
@@ -7192,7 +7211,9 @@ function parseCommand(raw, usagePlace) {
     {
         var commandNameRaw = items.slice(-1).join('_');
         var args = items.slice(0, -1); // <- Note: This is probbably not correct
-        var rawArgs = raw.substring(0, raw.length - commandNameRaw.length).trim();
+        var rawArgs = raw
+            .substring(0, raw.length - commandNameRaw.length)
+            .trim();
         var command = parseCommandVariant({ usagePlace: usagePlace, raw: raw, rawArgs: rawArgs, normalized: normalized, args: args, commandNameRaw: commandNameRaw });
         if (command !== null) {
             return command;
@@ -9266,9 +9287,9 @@ function renderPromptbookMermaid(pipelineJson, options) {
     return promptbookMermaid;
 }
 /**
- * TODO: !!!!!! FOREACH in mermaid graph
- * TODO: !!!!!! Knowledge in mermaid graph
- * TODO: !!!!!! Personas in mermaid graph
+ * 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
  */