@promptbook/core 0.69.0-18 → 0.69.0-19

package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts

@@ -11,7 +11,7 @@ export type ForeachJson = {
     /**
      * @@@
      */
-    readonly cellName: TODO_string;
+    readonly subformatName: TODO_string;
     /**
      * @@@
      */
@@ -21,6 +21,3 @@ export type ForeachJson = {
      */
     readonly subparameterNames: Array<string_parameter_name>;
 };
-/**
- * TODO: [🧠][🦥] Better (less confusing) name for "cell" / "subvalue" / "subparameter"
- */

package/esm/typings/src/commands/FOREACH/foreachCommand.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [🧠][🦥] Better (less confusing) name for "cell" / "subvalue" / "subparameter"
- */

package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts

@@ -10,6 +10,5 @@ import type { ForeachCommand } from './ForeachCommand';
  */
 export declare const foreachCommandParser: PipelineTemplateCommandParser<ForeachCommand>;
 /**
- * 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
  */

package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts

@@ -22,9 +22,9 @@ export type renderPipelineMermaidOptions = {
  */
 export declare function renderPromptbookMermaid(pipelineJson: PipelineJson, options?: renderPipelineMermaidOptions): string;
 /**
- * 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
  */

package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatCells.d.ts

@@ -16,6 +16,4 @@ export {};
 /**
  * TODO: !!!!!! Make pipelineIdentification more precise
  * TODO: !!!!!! How FOREACH execution looks in the report
- * TODO: [🧠][🦥] Better (less confusing) name for "cell" / "subvalue" / "subparameter"
- * TODO: []
  */

package/esm/typings/src/formats/_common/FormatDefinition.d.ts

@@ -61,7 +61,6 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
     readonly subvalueDefinitions: Array<FormatSubvalueDefinition<TValue, TSettings>>;
 };
 /**
- * TODO: [🧠][🦥] Better (less confusing) name for "cell" / "subvalue" / "subparameter"
  * TODO: [♏] Add some prepare hook to modify prompt according to the format
  * TODO: [🍓]`name` and `aliases` should be UPPERCASE only and interpreted as case-insensitive (via normalization)
  * TODO: [🍓][👨‍⚖️] Compute TPartialValue dynamically - PartialString<TValue>

package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts

@@ -26,6 +26,5 @@ export type FormatSubvalueDefinition<TValue extends string, TSettings extends em
     mapValues(value: TValue, settings: TSettings, mapCallback: (subvalues: Parameters, index: number) => Promisable<string>): Promise<string>;
 };
 /**
- * TODO: [🧠][🦥] Better (less confusing) name for "cell" / "subvalue" / "subparameter"
  * Note: [👩🏾‍🤝‍🧑🏽]
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.69.0-18",
+    "version": "0.69.0-19",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -16,7 +16,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.69.0-17';
+    var PROMPTBOOK_VERSION = '0.69.0-18';
     // TODO:[main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
@@ -4073,15 +4073,15 @@
                                 .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__default["default"](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__default["default"](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;
@@ -4126,8 +4126,6 @@
     /**
      * TODO: !!!!!! Make pipelineIdentification more precise
      * TODO: !!!!!! How FOREACH execution looks in the report
-     * TODO: [🧠][🦥] Better (less confusing) name for "cell" / "subvalue" / "subparameter"
-     * TODO: []
      */
 
     /**
@@ -5972,6 +5970,29 @@
      * 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 @@@
      *
@@ -6030,6 +6051,9 @@
                 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");
@@ -6083,7 +6107,7 @@
         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
@@ -6091,8 +6115,8 @@
         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);
@@ -6104,24 +6128,19 @@
                 // <- 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__default["default"](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__default["default"](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(); })
@@ -6133,7 +6152,7 @@
             return {
                 type: 'FOREACH',
                 formatName: formatName,
-                cellName: cellName,
+                subformatName: subformatName,
                 parameterName: parameterName,
                 subparameterNames: subparameterNames,
             };
@@ -6144,10 +6163,10 @@
          * 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
         },
@@ -6171,8 +6190,7 @@
         },
     };
     /**
-     * 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
      */
 
     /**
@@ -6282,12 +6300,11 @@
          */
         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,
@@ -6511,14 +6528,13 @@
          * 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__default["default"](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');
@@ -6526,11 +6542,12 @@
                 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,
             };
@@ -7338,7 +7355,9 @@
         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;
@@ -7349,7 +7368,9 @@
         {
             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;
@@ -8104,9 +8125,9 @@
         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
      */
@@ -8931,8 +8952,8 @@
      */
     function createMarkdownTable(table) {
         var columnWidths = table.reduce(function (widths, row) {
-            row.forEach(function (cell, columnIndex) {
-                var cellLength = cell.length;
+            row.forEach(function (subformat, columnIndex) {
+                var cellLength = subformat.length;
                 if (!widths[columnIndex] || cellLength > widths[columnIndex]) {
                     widths[columnIndex] = cellLength;
                 }
@@ -8940,12 +8961,12 @@
             return widths;
         }, []);
         var header = "| ".concat(table[0]
-            .map(function (cell, columnIndex) { return cell.padEnd(columnWidths[columnIndex]); })
+            .map(function (subformat, columnIndex) { return subformat.padEnd(columnWidths[columnIndex]); })
             .join(' | '), " |");
         var separator = "|".concat(columnWidths.map(function (width) { return '-'.repeat(width + 2); }).join('|'), "|");
         var rows = table.slice(1).map(function (row) {
-            var paddedRow = row.map(function (cell, columnIndex) {
-                return cell.padEnd(columnWidths[columnIndex]);
+            var paddedRow = row.map(function (subformat, columnIndex) {
+                return subformat.padEnd(columnWidths[columnIndex]);
             });
             return "| ".concat(paddedRow.join(' | '), " |");
         });