@promptbook/vercel 0.78.4 → 0.80.0-0

package/umd/index.umd.js

@@ -21,7 +21,7 @@
      *
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.78.3';
+    var PROMPTBOOK_ENGINE_VERSION = '0.79.0';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -163,7 +163,7 @@
     }(Error));
 
     /**
-     * @@@
+     * Freezes the given object and all its nested objects recursively
      *
      * Note: `$` is used to indicate that this function is not a pure function - it mutates given object
      * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
@@ -173,6 +173,9 @@
      */
     function $deepFreeze(objectValue) {
         var e_1, _a;
+        if (Array.isArray(objectValue)) {
+            return Object.freeze(objectValue.map(function (item) { return $deepFreeze(item); }));
+        }
         var propertyNames = Object.getOwnPropertyNames(objectValue);
         try {
             for (var propertyNames_1 = __values(propertyNames), propertyNames_1_1 = propertyNames_1.next(); !propertyNames_1_1.done; propertyNames_1_1 = propertyNames_1.next()) {
@@ -190,7 +193,8 @@
             }
             finally { if (e_1) throw e_1.error; }
         }
-        return Object.freeze(objectValue);
+        Object.freeze(objectValue);
+        return objectValue;
     }
     /**
      * TODO: [🧠] Is there a way how to meaningfully test this utility
@@ -291,24 +295,6 @@
      * @private within the repository - too low-level in comparison with other `MAX_...`
      */
     var LOOP_LIMIT = 1000;
-    /**
-     * Nonce which is used for replacing things in strings
-     *
-     * @private within the repository
-     */
-    var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
-    /**
-     * @@@
-     *
-     * @private within the repository
-     */
-    var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
-    /**
-     * @@@
-     *
-     * @private within the repository
-     */
-    var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
     // <- TODO: [🧜‍♂️]
     /**
      * @@@
@@ -322,26 +308,21 @@
         skipEmptyLines: true,
     });
     /**
-     * TODO: Extract `constants.ts` from `config.ts`
      * Note: [💞] Ignore a discrepancy between file name and entity name
      * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
      */
 
     /**
-     * This error type indicates that some limit was reached
+     * Orders JSON object by keys
      *
-     * @public exported from `@promptbook/core`
+     * @returns The same type of object as the input re-ordered
+     * @public exported from `@promptbook/utils`
      */
-    var LimitReachedError = /** @class */ (function (_super) {
-        __extends(LimitReachedError, _super);
-        function LimitReachedError(message) {
-            var _this = _super.call(this, message) || this;
-            _this.name = 'LimitReachedError';
-            Object.setPrototypeOf(_this, LimitReachedError.prototype);
-            return _this;
-        }
-        return LimitReachedError;
-    }(Error));
+    function orderJson(options) {
+        var value = options.value, order = options.order;
+        var orderedValue = __assign(__assign({}, (order === undefined ? {} : Object.fromEntries(order.map(function (key) { return [key, undefined]; })))), value);
+        return orderedValue;
+    }
 
     /**
      * Make error report URL for the given error
@@ -377,85 +358,6 @@
         return UnexpectedError;
     }(Error));
 
-    /**
-     * Replaces parameters in template with values from parameters object
-     *
-     * @param template the template with parameters in {curly} braces
-     * @param parameters the object with parameters
-     * @returns the template with replaced parameters
-     * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
-     * @public exported from `@promptbook/utils`
-     */
-    function replaceParameters(template, parameters) {
-        var e_1, _a;
-        try {
-            for (var _b = __values(Object.entries(parameters)), _c = _b.next(); !_c.done; _c = _b.next()) {
-                var _d = __read(_c.value, 2), parameterName = _d[0], parameterValue = _d[1];
-                if (parameterValue === RESERVED_PARAMETER_MISSING_VALUE) {
-                    throw new UnexpectedError("Parameter `{".concat(parameterName, "}` has missing value"));
-                }
-                else if (parameterValue === RESERVED_PARAMETER_RESTRICTED) {
-                    // TODO: [🍵]
-                    throw new UnexpectedError("Parameter `{".concat(parameterName, "}` is restricted to use"));
-                }
-            }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
-            }
-            finally { if (e_1) throw e_1.error; }
-        }
-        var replacedTemplates = template;
-        var match;
-        var loopLimit = LOOP_LIMIT;
-        var _loop_1 = function () {
-            if (loopLimit-- < 0) {
-                throw new LimitReachedError('Loop limit reached during parameters replacement in `replaceParameters`');
-            }
-            var precol = match.groups.precol;
-            var parameterName = match.groups.parameterName;
-            if (parameterName === '') {
-                return "continue";
-            }
-            if (parameterName.indexOf('{') !== -1 || parameterName.indexOf('}') !== -1) {
-                throw new PipelineExecutionError('Parameter is already opened or not closed');
-            }
-            if (parameters[parameterName] === undefined) {
-                throw new PipelineExecutionError("Parameter `{".concat(parameterName, "}` is not defined"));
-            }
-            var parameterValue = parameters[parameterName];
-            if (parameterValue === undefined) {
-                throw new PipelineExecutionError("Parameter `{".concat(parameterName, "}` is not defined"));
-            }
-            parameterValue = parameterValue.toString();
-            if (parameterValue.includes('\n') && /^\s*\W{0,3}\s*$/.test(precol)) {
-                parameterValue = parameterValue
-                    .split('\n')
-                    .map(function (line, index) { return (index === 0 ? line : "".concat(precol).concat(line)); })
-                    .join('\n');
-            }
-            replacedTemplates =
-                replacedTemplates.substring(0, match.index + precol.length) +
-                    parameterValue +
-                    replacedTemplates.substring(match.index + precol.length + parameterName.length + 2);
-        };
-        while ((match = /^(?<precol>.*){(?<parameterName>\w+)}(.*)/m /* <- Not global */
-            .exec(replacedTemplates))) {
-            _loop_1();
-        }
-        // [💫] Check if there are parameters that are not closed properly
-        if (/{\w+$/.test(replacedTemplates)) {
-            throw new PipelineExecutionError('Parameter is not closed');
-        }
-        // [💫] Check if there are parameters that are not opened properly
-        if (/^\w+}/.test(replacedTemplates)) {
-            throw new PipelineExecutionError('Parameter is not opened');
-        }
-        return replacedTemplates;
-    }
-
     /**
      * Checks if the value is [🚉] serializable as JSON
      * If not, throws an UnexpectedError with a rich error message and tracking
@@ -476,8 +378,9 @@
      * @throws UnexpectedError if the value is not serializable as JSON
      * @public exported from `@promptbook/utils`
      */
-    function checkSerializableAsJson(name, value) {
+    function checkSerializableAsJson(options) {
         var e_1, _a;
+        var value = options.value, name = options.name, message = options.message;
         if (value === undefined) {
             throw new UnexpectedError("".concat(name, " is undefined"));
         }
@@ -501,12 +404,12 @@
         }
         else if (typeof value === 'object' && Array.isArray(value)) {
             for (var i = 0; i < value.length; i++) {
-                checkSerializableAsJson("".concat(name, "[").concat(i, "]"), value[i]);
+                checkSerializableAsJson({ name: "".concat(name, "[").concat(i, "]"), value: value[i], message: message });
             }
         }
         else if (typeof value === 'object') {
             if (value instanceof Date) {
-                throw new UnexpectedError(spaceTrim__default["default"]("\n                    ".concat(name, " is Date\n\n                    Use `string_date_iso8601` instead\n                ")));
+                throw new UnexpectedError(spaceTrim__default["default"](function (block) { return "\n                        `".concat(name, "` is Date\n\n                        Use `string_date_iso8601` instead\n\n                        Additional message for `").concat(name, "`:\n                        ").concat(block(message || '(nothing)'), "\n                    "); }));
             }
             else if (value instanceof Map) {
                 throw new UnexpectedError("".concat(name, " is Map"));
@@ -518,7 +421,7 @@
                 throw new UnexpectedError("".concat(name, " is RegExp"));
             }
             else if (value instanceof Error) {
-                throw new UnexpectedError(spaceTrim__default["default"]("\n                    ".concat(name, " is unserialized Error\n\n                    Use function `serializeError`\n                ")));
+                throw new UnexpectedError(spaceTrim__default["default"](function (block) { return "\n                        `".concat(name, "` is unserialized Error\n\n                        Use function `serializeError`\n\n                        Additional message for `").concat(name, "`:\n                        ").concat(block(message || '(nothing)'), "\n\n                    "); }));
             }
             else {
                 try {
@@ -528,7 +431,7 @@
                             // Note: undefined in object is serializable - it is just omited
                             continue;
                         }
-                        checkSerializableAsJson("".concat(name, ".").concat(subName), subValue);
+                        checkSerializableAsJson({ name: "".concat(name, ".").concat(subName), value: subValue, message: message });
                     }
                 }
                 catch (e_1_1) { e_1 = { error: e_1_1 }; }
@@ -545,7 +448,7 @@
                     if (!(error instanceof Error)) {
                         throw error;
                     }
-                    throw new UnexpectedError(spaceTrim__default["default"](function (block) { return "\n                            ".concat(name, " is not serializable\n\n                            ").concat(block(error.toString()), "\n                        "); }));
+                    throw new UnexpectedError(spaceTrim__default["default"](function (block) { return "\n                            `".concat(name, "` is not serializable\n\n                            ").concat(block(error.toString()), "\n\n                            Additional message for `").concat(name, "`:\n                            ").concat(block(message || '(nothing)'), "\n                        "); }));
                 }
                 /*
                 TODO: [0] Is there some more elegant way to check circular references?
@@ -570,35 +473,210 @@
             }
         }
         else {
-            throw new UnexpectedError("".concat(name, " is unknown"));
+            throw new UnexpectedError(spaceTrim__default["default"](function (block) { return "\n                    `".concat(name, "` is unknown type\n\n                    Additional message for `").concat(name, "`:\n                    ").concat(block(message || '(nothing)'), "\n                "); }));
         }
     }
     /**
-     * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
+     * TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
      * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
      * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
      */
 
     /**
-     * @@@
      * @@@
      *
-     * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+     * @public exported from `@promptbook/utils`
+     */
+    function deepClone(objectValue) {
+        return JSON.parse(JSON.stringify(objectValue));
+        /*
+        !!!!!!!!
+        TODO: [🧠] Is there a better implementation?
+        > const propertyNames = Object.getOwnPropertyNames(objectValue);
+        > for (const propertyName of propertyNames) {
+        >     const value = (objectValue as really_any)[propertyName];
+        >     if (value && typeof value === 'object') {
+        >         deepClone(value);
+        >     }
+        > }
+        > return Object.assign({}, objectValue);
+        */
+    }
+    /**
+     * TODO: [🧠] Is there a way how to meaningfully test this utility
+     */
+
+    /**
+     * Utility to export a JSON object from a function
      *
-     * @param name - Name of the object for debugging purposes
-     * @param objectValue - Object to be deeply frozen
-     * @returns The same object as the input, but deeply frozen
-     * @private this is in comparison to `deepFreeze` a more specific utility and maybe not very good practice to use without specific reason and considerations
+     * 1) Checks if the value is serializable as JSON
+     * 2) Makes a deep clone of the object
+     * 2) Orders the object properties
+     * 2) Deeply freezes the cloned object
+     *
+     * Note: This function does not mutates the given object
+     *
+     * @returns The same type of object as the input but read-only and re-ordered
+     * @public exported from `@promptbook/utils`
      */
-    function $asDeeplyFrozenSerializableJson(name, objectValue) {
-        checkSerializableAsJson(name, objectValue);
-        return $deepFreeze(objectValue);
+    function exportJson(options) {
+        var name = options.name, value = options.value, order = options.order, message = options.message;
+        checkSerializableAsJson({ name: name, value: value, message: message });
+        var orderedValue = 
+        // TODO: Fix error "Type instantiation is excessively deep and possibly infinite."
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        order === undefined
+            ? deepClone(value)
+            : orderJson({
+                value: value,
+                // <- Note: checkSerializableAsJson asserts that the value is serializable as JSON
+                order: order,
+            });
+        $deepFreeze(orderedValue);
+        return orderedValue;
     }
     /**
-     * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
      * TODO: [🧠] Is there a way how to meaningfully test this utility
      */
 
+    /**
+     * Nonce which is used for replacing things in strings
+     *
+     * @private within the repository
+     */
+    var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
+    /**
+     * @@@
+     *
+     * @private within the repository
+     */
+    var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
+    /**
+     * @@@
+     *
+     * @private within the repository
+     */
+    var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
+    /**
+     * The names of the parameters that are reserved for special purposes
+     *
+     * @public exported from `@promptbook/core`
+     */
+    exportJson({
+        name: 'RESERVED_PARAMETER_NAMES',
+        message: "The names of the parameters that are reserved for special purposes",
+        value: [
+            'content',
+            'context',
+            'knowledge',
+            'examples',
+            'modelName',
+            'currentDate',
+            // <- TODO: list here all command names
+            // <- TODO: Add more like 'date', 'modelName',...
+            // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
+        ],
+    });
+    /**
+     * Note: [💞] Ignore a discrepancy between file name and entity name
+     */
+
+    /**
+     * This error type indicates that some limit was reached
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var LimitReachedError = /** @class */ (function (_super) {
+        __extends(LimitReachedError, _super);
+        function LimitReachedError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'LimitReachedError';
+            Object.setPrototypeOf(_this, LimitReachedError.prototype);
+            return _this;
+        }
+        return LimitReachedError;
+    }(Error));
+
+    /**
+     * Replaces parameters in template with values from parameters object
+     *
+     * @param template the template with parameters in {curly} braces
+     * @param parameters the object with parameters
+     * @returns the template with replaced parameters
+     * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
+     * @public exported from `@promptbook/utils`
+     */
+    function replaceParameters(template, parameters) {
+        var e_1, _a;
+        try {
+            for (var _b = __values(Object.entries(parameters)), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var _d = __read(_c.value, 2), parameterName = _d[0], parameterValue = _d[1];
+                if (parameterValue === RESERVED_PARAMETER_MISSING_VALUE) {
+                    throw new UnexpectedError("Parameter `{".concat(parameterName, "}` has missing value"));
+                }
+                else if (parameterValue === RESERVED_PARAMETER_RESTRICTED) {
+                    // TODO: [🍵]
+                    throw new UnexpectedError("Parameter `{".concat(parameterName, "}` is restricted to use"));
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        var replacedTemplates = template;
+        var match;
+        var loopLimit = LOOP_LIMIT;
+        var _loop_1 = function () {
+            if (loopLimit-- < 0) {
+                throw new LimitReachedError('Loop limit reached during parameters replacement in `replaceParameters`');
+            }
+            var precol = match.groups.precol;
+            var parameterName = match.groups.parameterName;
+            if (parameterName === '') {
+                return "continue";
+            }
+            if (parameterName.indexOf('{') !== -1 || parameterName.indexOf('}') !== -1) {
+                throw new PipelineExecutionError('Parameter is already opened or not closed');
+            }
+            if (parameters[parameterName] === undefined) {
+                throw new PipelineExecutionError("Parameter `{".concat(parameterName, "}` is not defined"));
+            }
+            var parameterValue = parameters[parameterName];
+            if (parameterValue === undefined) {
+                throw new PipelineExecutionError("Parameter `{".concat(parameterName, "}` is not defined"));
+            }
+            parameterValue = parameterValue.toString();
+            if (parameterValue.includes('\n') && /^\s*\W{0,3}\s*$/.test(precol)) {
+                parameterValue = parameterValue
+                    .split('\n')
+                    .map(function (line, index) { return (index === 0 ? line : "".concat(precol).concat(line)); })
+                    .join('\n');
+            }
+            replacedTemplates =
+                replacedTemplates.substring(0, match.index + precol.length) +
+                    parameterValue +
+                    replacedTemplates.substring(match.index + precol.length + parameterName.length + 2);
+        };
+        while ((match = /^(?<precol>.*){(?<parameterName>\w+)}(.*)/m /* <- Not global */
+            .exec(replacedTemplates))) {
+            _loop_1();
+        }
+        // [💫] Check if there are parameters that are not closed properly
+        if (/{\w+$/.test(replacedTemplates)) {
+            throw new PipelineExecutionError('Parameter is not closed');
+        }
+        // [💫] Check if there are parameters that are not opened properly
+        if (/^\w+}/.test(replacedTemplates)) {
+            throw new PipelineExecutionError('Parameter is not opened');
+        }
+        return replacedTemplates;
+    }
+
     /**
      * Function `asSerializable` will convert values which are not serializable to serializable values
      * It walks deeply through the object and converts all values
@@ -678,7 +756,7 @@
                                         return modelVariant === 'CHAT';
                                     })) === null || _a === void 0 ? void 0 : _a.modelName);
                                 if (!modelName) {
-                                    throw new PipelineExecutionError(spaceTrim__default["default"]("\n                        Can not determine which model to use.\n\n                        You need to provide at least one of:\n                        1) In `createExecutionToolsFromVercelProvider` options, provide `availableModels` with at least one model\n                        2) In `prompt.modelRequirements`, provide `modelName` with the name of the model to use\n                  \n                    "));
+                                    throw new PipelineExecutionError(spaceTrim__default["default"]("\n                        Can not determine which model to use.\n\n                        You need to provide at least one of:\n                        1) In `createExecutionToolsFromVercelProvider` options, provide `availableModels` with at least one model\n                        2) In `prompt.modelRequirements`, provide `modelName` with the name of the model to use\n\n                    "));
                                 }
                                 return [4 /*yield*/, vercelProvider.chat(modelName, __assign({ user: (userId === null || userId === void 0 ? void 0 : userId.toString()) || undefined }, additionalChatSettings))];
                             case 1:
@@ -741,18 +819,22 @@
                                 }
                                 complete = $getCurrentDate();
                                 usage = UNCERTAIN_USAGE;
-                                return [2 /*return*/, $asDeeplyFrozenSerializableJson('createExecutionToolsFromVercelProvider ChatPromptResult', {
-                                        content: rawResponse.text,
-                                        modelName: modelName,
-                                        timing: {
-                                            start: start,
-                                            complete: complete,
+                                return [2 /*return*/, exportJson({
+                                        name: 'promptResult',
+                                        message: "Result of `createExecutionToolsFromVercelProvider.callChatModel`",
+                                        value: {
+                                            content: rawResponse.text,
+                                            modelName: modelName,
+                                            timing: {
+                                                start: start,
+                                                complete: complete,
+                                            },
+                                            usage: usage,
+                                            rawPromptContent: rawPromptContent,
+                                            rawRequest: rawRequest,
+                                            rawResponse: asSerializable(rawResponse),
+                                            // <- [🗯]
                                         },
-                                        usage: usage,
-                                        rawPromptContent: rawPromptContent,
-                                        rawRequest: rawRequest,
-                                        rawResponse: asSerializable(rawResponse),
-                                        // <- [🗯]
                                     })];
                         }
                     });