@promptbook/utils 0.77.0 → 0.78.0-0

package/esm/typings/src/errors/utils/ErrorJson.d.ts

@@ -1,4 +1,4 @@
-import type { ERRORS } from '../0-index';
+import type { ALL_ERRORS } from '../0-index';
 /**
  * Represents a serialized error or custom Promptbook error
  *
@@ -8,7 +8,7 @@ export type ErrorJson = {
     /**
      * The type of the error
      */
-    readonly name: keyof typeof ERRORS | 'Error';
+    readonly name: keyof typeof ALL_ERRORS;
     /**
      * The message of the error
      */

package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/normalization/titleToName.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/utils",
-    "version": "0.77.0",
+    "version": "0.78.0-0",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,

package/umd/index.umd.js

@@ -20,7 +20,7 @@
      *
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.77.0-6';
+    var PROMPTBOOK_ENGINE_VERSION = '0.77.1';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -225,6 +225,48 @@
      * TODO: [🌺] Use some intermediate util splitWords
      */
 
+    /**
+     * Removes emojis from a string and fix whitespaces
+     *
+     * @param text with emojis
+     * @returns text without emojis
+     * @public exported from `@promptbook/utils`
+     */
+    function removeEmojis(text) {
+        // Replace emojis (and also ZWJ sequence) with hyphens
+        text = text.replace(/(\p{Extended_Pictographic})\p{Modifier_Symbol}/gu, '$1');
+        text = text.replace(/(\p{Extended_Pictographic})[\u{FE00}-\u{FE0F}]/gu, '$1');
+        text = text.replace(/(\p{Extended_Pictographic})(\u{200D}\p{Extended_Pictographic})*/gu, '$1');
+        text = text.replace(/\p{Extended_Pictographic}/gu, '');
+        return text;
+    }
+
+    /**
+     * Tests if given string is valid URL.
+     *
+     * Note: This does not check if the file exists only if the path is valid
+     * @public exported from `@promptbook/utils`
+     */
+    function isValidFilePath(filename) {
+        if (typeof filename !== 'string') {
+            return false;
+        }
+        var filenameSlashes = filename.split('\\').join('/');
+        // Absolute Unix path: /hello.txt
+        if (/^(\/)/i.test(filenameSlashes)) {
+            return true;
+        }
+        // Absolute Windows path: /hello.txt
+        if (/^([A-Z]{1,2}:\/?)\//i.test(filenameSlashes)) {
+            return true;
+        }
+        // Relative path: ./hello.txt
+        if (/^(\.\.?\/)+/i.test(filenameSlashes)) {
+            return true;
+        }
+        return false;
+    }
+
     /**
      * Tests if given string is valid URL.
      *
@@ -577,48 +619,6 @@
      * Note: [💞] Ignore a discrepancy between file name and entity name
      */
 
-    /**
-     * Removes emojis from a string and fix whitespaces
-     *
-     * @param text with emojis
-     * @returns text without emojis
-     * @public exported from `@promptbook/utils`
-     */
-    function removeEmojis(text) {
-        // Replace emojis (and also ZWJ sequence) with hyphens
-        text = text.replace(/(\p{Extended_Pictographic})\p{Modifier_Symbol}/gu, '$1');
-        text = text.replace(/(\p{Extended_Pictographic})[\u{FE00}-\u{FE0F}]/gu, '$1');
-        text = text.replace(/(\p{Extended_Pictographic})(\u{200D}\p{Extended_Pictographic})*/gu, '$1');
-        text = text.replace(/\p{Extended_Pictographic}/gu, '');
-        return text;
-    }
-
-    /**
-     * Tests if given string is valid URL.
-     *
-     * Note: This does not check if the file exists only if the path is valid
-     * @public exported from `@promptbook/utils`
-     */
-    function isValidFilePath(filename) {
-        if (typeof filename !== 'string') {
-            return false;
-        }
-        var filenameSlashes = filename.split('\\').join('/');
-        // Absolute Unix path: /hello.txt
-        if (/^(\/)/i.test(filenameSlashes)) {
-            return true;
-        }
-        // Absolute Windows path: /hello.txt
-        if (/^([A-Z]{1,2}:\/?)\//i.test(filenameSlashes)) {
-            return true;
-        }
-        // Relative path: ./hello.txt
-        if (/^(\.\.?\/)+/i.test(filenameSlashes)) {
-            return true;
-        }
-        return false;
-    }
-
     /**
      * @@@
      *
@@ -665,7 +665,7 @@
             if (!task) {
                 throw new Error("Could not find task for {".concat(parameterName, "}"));
             }
-            return normalizeTo_camelCase('task-' + titleToName(task.title));
+            return task.name || normalizeTo_camelCase('task-' + titleToName(task.title));
         };
         var promptbookMermaid = spaceTrim$1.spaceTrim(function (block) { return "\n\n            %% \uD83D\uDD2E Tip: Open this on GitHub or in the VSCode website to see the Mermaid graph visually\n\n            flowchart LR\n              subgraph \"".concat(pipelineJson.title, "\"\n\n                  direction TB\n\n                  input((Input)):::input\n                  ").concat(block(pipelineJson.tasks
             .flatMap(function (_a) {
@@ -707,34 +707,6 @@
      * TODO: [🕌] When more than 2 functionalities, split into separate functions
      */
 
-    /**
-     * Parses the task and returns the list of all parameter names
-     *
-     * @param template the string template with parameters in {curly} braces
-     * @returns the list of parameter names
-     * @public exported from `@promptbook/utils`
-     */
-    function extractParameterNames(template) {
-        var e_1, _a;
-        var matches = template.matchAll(/{\w+}/g);
-        var parameterNames = new Set();
-        try {
-            for (var matches_1 = __values(matches), matches_1_1 = matches_1.next(); !matches_1_1.done; matches_1_1 = matches_1.next()) {
-                var match = matches_1_1.value;
-                var parameterName = match[0].slice(1, -1);
-                parameterNames.add(parameterName);
-            }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (matches_1_1 && !matches_1_1.done && (_a = matches_1.return)) _a.call(matches_1);
-            }
-            finally { if (e_1) throw e_1.error; }
-        }
-        return parameterNames;
-    }
-
     /**
      * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
      *
@@ -760,9 +732,9 @@
      * @param script from which to extract the variables
      * @returns the list of variable names
      * @throws {ParseError} if the script is invalid
-     * @public exported from `@promptbook/utils`
+     * @public exported from `@promptbook/utils` <- Note: [👖] This is usable elsewhere than in Promptbook, so keeping in utils
      */
-    function extractVariables(script) {
+    function extractVariablesFromScript(script) {
         var variables = new Set();
         script = "(()=>{".concat(script, "})()");
         try {
@@ -803,162 +775,6 @@
      * TODO: [🔣] Support for multiple languages - python, java,...
      */
 
-    /**
-     * Parses the task and returns the set of all used parameters
-     *
-     * @param task the task with used parameters
-     * @returns the set of parameter names
-     * @throws {ParseError} if the script is invalid
-     * @public exported from `@promptbook/utils`
-     */
-    function extractParameterNamesFromTask(task) {
-        var e_1, _a, e_2, _b, e_3, _c, e_4, _d;
-        var title = task.title, description = task.description, taskType = task.taskType, content = task.content, preparedContent = task.preparedContent, jokerParameterNames = task.jokerParameterNames, foreach = task.foreach;
-        var parameterNames = new Set();
-        try {
-            for (var _e = __values(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read(extractParameterNames(title)), false), __read(extractParameterNames(description || '')), false), __read(extractParameterNames(content)), false), __read(extractParameterNames(preparedContent || '')), false)), _f = _e.next(); !_f.done; _f = _e.next()) {
-                var parameterName = _f.value;
-                parameterNames.add(parameterName);
-            }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (_f && !_f.done && (_a = _e.return)) _a.call(_e);
-            }
-            finally { if (e_1) throw e_1.error; }
-        }
-        if (taskType === 'SCRIPT_TASK') {
-            try {
-                for (var _g = __values(extractVariables(content)), _h = _g.next(); !_h.done; _h = _g.next()) {
-                    var parameterName = _h.value;
-                    parameterNames.add(parameterName);
-                }
-            }
-            catch (e_2_1) { e_2 = { error: e_2_1 }; }
-            finally {
-                try {
-                    if (_h && !_h.done && (_b = _g.return)) _b.call(_g);
-                }
-                finally { if (e_2) throw e_2.error; }
-            }
-        }
-        try {
-            for (var _j = __values(jokerParameterNames || []), _k = _j.next(); !_k.done; _k = _j.next()) {
-                var jokerName = _k.value;
-                parameterNames.add(jokerName);
-            }
-        }
-        catch (e_3_1) { e_3 = { error: e_3_1 }; }
-        finally {
-            try {
-                if (_k && !_k.done && (_c = _j.return)) _c.call(_j);
-            }
-            finally { if (e_3) throw e_3.error; }
-        }
-        parameterNames.delete('content');
-        //                      <- Note {websiteContent} is used in `preparedContent`
-        // Note: [🍭] Fixing dependent subparameterName from FOREACH command
-        if (foreach !== undefined) {
-            try {
-                for (var _l = __values(foreach.inputSubparameterNames), _m = _l.next(); !_m.done; _m = _l.next()) {
-                    var subparameterName = _m.value;
-                    if (parameterNames.has(subparameterName)) {
-                        parameterNames.delete(subparameterName);
-                        parameterNames.add(foreach.parameterName);
-                        // <- TODO: [🚎] Warn/logic error when `subparameterName` not used
-                    }
-                }
-            }
-            catch (e_4_1) { e_4 = { error: e_4_1 }; }
-            finally {
-                try {
-                    if (_m && !_m.done && (_d = _l.return)) _d.call(_l);
-                }
-                finally { if (e_4) throw e_4.error; }
-            }
-        }
-        return parameterNames;
-    }
-    /**
-     * TODO: [🔣] If script require contentLanguage
-     */
-
-    /**
-     * This error indicates that the promptbook object has valid syntax (=can be parsed) but contains logical errors (like circular dependencies)
-     *
-     * @public exported from `@promptbook/core`
-     */
-    var PipelineLogicError = /** @class */ (function (_super) {
-        __extends(PipelineLogicError, _super);
-        function PipelineLogicError(message) {
-            var _this = _super.call(this, message) || this;
-            _this.name = 'PipelineLogicError';
-            Object.setPrototypeOf(_this, PipelineLogicError.prototype);
-            return _this;
-        }
-        return PipelineLogicError;
-    }(Error));
-
-    /**
-     * Function `renameParameter` will find all usable parameters for given task
-     * In other words, it will find all parameters that are not used in the task itseld and all its dependencies
-     *
-     * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
-     * @public exported from `@promptbook/utils`
-     */
-    function renameParameter(options) {
-        var e_1, _a, e_2, _b;
-        var pipeline = options.pipeline, oldParameterName = options.oldParameterName, newParameterName = options.newParameterName;
-        if (pipeline.parameters.some(function (parameter) { return parameter.name === newParameterName; })) {
-            throw new PipelineLogicError("Can not replace {".concat(oldParameterName, "} to {").concat(newParameterName, "} because {").concat(newParameterName, "} is already used in the pipeline"));
-        }
-        var renamedPipeline = __assign(__assign({}, pipeline), { 
-            // <- TODO: [🪓] This should be without `as $PipelineJson`
-            parameters: __spreadArray([], __read(pipeline.parameters), false), tasks: __spreadArray([], __read(pipeline.tasks), false) });
-        try {
-            for (var _c = __values(renamedPipeline.parameters), _d = _c.next(); !_d.done; _d = _c.next()) {
-                var parameter = _d.value;
-                if (parameter.name !== oldParameterName) {
-                    continue;
-                }
-                parameter.name = newParameterName;
-            }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
-            }
-            finally { if (e_1) throw e_1.error; }
-        }
-        try {
-            for (var _e = __values(renamedPipeline.tasks), _f = _e.next(); !_f.done; _f = _e.next()) {
-                var task = _f.value;
-                if (task.resultingParameterName === oldParameterName) {
-                    task.resultingParameterName = newParameterName;
-                }
-                task.dependentParameterNames = task.dependentParameterNames.map(function (dependentParameterName) {
-                    return dependentParameterName === oldParameterName ? newParameterName : dependentParameterName;
-                });
-                task.content = task.content.replace(new RegExp("{".concat(oldParameterName, "}"), 'g'), "{".concat(newParameterName, "}"));
-                task.title = task.title.replace(new RegExp("{".concat(oldParameterName, "}"), 'g'), "{".concat(newParameterName, "}"));
-                task.description =
-                    task.description === undefined
-                        ? undefined
-                        : task.description.replace(new RegExp("{".concat(oldParameterName, "}"), 'g'), "{".concat(newParameterName, "}"));
-            }
-        }
-        catch (e_2_1) { e_2 = { error: e_2_1 }; }
-        finally {
-            try {
-                if (_f && !_f.done && (_b = _e.return)) _b.call(_e);
-            }
-            finally { if (e_2) throw e_2.error; }
-        }
-        return renamedPipeline;
-    }
-
     /**
      * This error indicates problems parsing the format value
      *
@@ -1142,6 +958,22 @@
         return PipelineExecutionError;
     }(Error));
 
+    /**
+     * This error indicates that the promptbook object has valid syntax (=can be parsed) but contains logical errors (like circular dependencies)
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var PipelineLogicError = /** @class */ (function (_super) {
+        __extends(PipelineLogicError, _super);
+        function PipelineLogicError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'PipelineLogicError';
+            Object.setPrototypeOf(_this, PipelineLogicError.prototype);
+            return _this;
+        }
+        return PipelineLogicError;
+    }(Error));
+
     /**
      * This error indicates errors in referencing promptbooks between each other
      *
@@ -1163,7 +995,7 @@
      *
      * @public exported from `@promptbook/core`
      */
-    var ERRORS = {
+    var PROMPTBOOK_ERRORS = {
         AbstractFormatError: AbstractFormatError,
         CsvFormatError: CsvFormatError,
         CollectionError: CollectionError,
@@ -1181,6 +1013,35 @@
         UnexpectedError: UnexpectedError,
         // TODO: [🪑]> VersionMismatchError,
     };
+    /**
+     * Index of all javascript errors
+     *
+     * @private for internal usage
+     */
+    var COMMON_JAVASCRIPT_ERRORS = {
+        Error: Error,
+        EvalError: EvalError,
+        RangeError: RangeError,
+        ReferenceError: ReferenceError,
+        SyntaxError: SyntaxError,
+        TypeError: TypeError,
+        URIError: URIError,
+        AggregateError: AggregateError,
+        /*
+      Note: Not widely supported
+      > InternalError,
+      > ModuleError,
+      > HeapError,
+      > WebAssemblyCompileError,
+      > WebAssemblyRuntimeError,
+      */
+    };
+    /**
+     * Index of all errors
+     *
+     * @private for internal usage
+     */
+    var ALL_ERRORS = __assign(__assign({}, PROMPTBOOK_ERRORS), COMMON_JAVASCRIPT_ERRORS);
     /**
      * Note: [💞] Ignore a discrepancy between file name and entity name
      */
@@ -1191,11 +1052,11 @@
      * @public exported from `@promptbook/utils`
      */
     function deserializeError(error) {
-        if (error.name === 'Error') {
-            return new Error(error.message);
+        var ErrorClass = ALL_ERRORS[error.name];
+        if (ErrorClass === undefined) {
+            return new Error("".concat(error.name, ": ").concat(error.message));
         }
-        var CustomError = ERRORS[error.name];
-        return new CustomError(error.message);
+        return new ErrorClass(error.message);
     }
 
     /**
@@ -1205,8 +1066,8 @@
      */
     function serializeError(error) {
         var name = error.name, message = error.message, stack = error.stack;
-        if (!__spreadArray(['Error'], __read(Object.keys(ERRORS)), false).includes(name)) {
-            throw new UnexpectedError(spaceTrim__default["default"](function (block) { return "\n          \n                    Cannot serialize error with name \"".concat(name, "\"\n\n                    ").concat(block(stack || message), "\n                \n                "); }));
+        if (!Object.keys(ALL_ERRORS).includes(name)) {
+            console.error(spaceTrim__default["default"](function (block) { return "\n          \n                    Cannot serialize error with name \"".concat(name, "\"\n\n                    ").concat(block(stack || message), "\n                \n                "); }));
         }
         return {
             name: name,
@@ -1732,6 +1593,34 @@
      */
     var spaceTrim = spaceTrim$1.spaceTrim;
 
+    /**
+     * Parses the task and returns the list of all parameter names
+     *
+     * @param template the string template with parameters in {curly} braces
+     * @returns the list of parameter names
+     * @public exported from `@promptbook/utils`
+     */
+    function extractParameterNames(template) {
+        var e_1, _a;
+        var matches = template.matchAll(/{\w+}/g);
+        var parameterNames = new Set();
+        try {
+            for (var matches_1 = __values(matches), matches_1_1 = matches_1.next(); !matches_1_1.done; matches_1_1 = matches_1.next()) {
+                var match = matches_1_1.value;
+                var parameterName = match[0].slice(1, -1);
+                parameterNames.add(parameterName);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (matches_1_1 && !matches_1_1.done && (_a = matches_1.return)) _a.call(matches_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return parameterNames;
+    }
+
     /**
      * @@@
      *
@@ -2646,8 +2535,7 @@
     exports.deserializeError = deserializeError;
     exports.difference = difference;
     exports.extractParameterNames = extractParameterNames;
-    exports.extractParameterNamesFromTask = extractParameterNamesFromTask;
-    exports.extractVariables = extractVariables;
+    exports.extractVariablesFromScript = extractVariablesFromScript;
     exports.forEachAsync = forEachAsync;
     exports.intersection = intersection;
     exports.isHostnameOnPrivateNetwork = isHostnameOnPrivateNetwork;
@@ -2677,7 +2565,6 @@
     exports.removeDiacritics = removeDiacritics;
     exports.removeEmojis = removeEmojis;
     exports.removeQuotes = removeQuotes;
-    exports.renameParameter = renameParameter;
     exports.renderPromptbookMermaid = renderPromptbookMermaid;
     exports.replaceParameters = replaceParameters;
     exports.searchKeywords = searchKeywords;