@promptbook/openai 0.78.0-0 → 0.78.2

package/umd/index.umd.js

@@ -22,7 +22,7 @@
      *
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.77.1';
+    var PROMPTBOOK_ENGINE_VERSION = '0.78.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
@@ -299,6 +299,103 @@
         return new Date().toISOString();
     }
 
+    /**
+     * Name for the Promptbook
+     *
+     * TODO: [🗽] Unite branding and make single place for it
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var NAME = "Promptbook";
+    /**
+     * Email of the responsible person
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var ADMIN_EMAIL = 'me@pavolhejny.com';
+    /**
+     * Name of the responsible person for the Promptbook on GitHub
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var ADMIN_GITHUB_NAME = 'hejny';
+    // <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
+    /**
+     * The maximum number of iterations for a loops
+     *
+     * @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: [🧜‍♂️]
+    /**
+     * @@@
+     *
+     * @public exported from `@promptbook/core`
+     */
+    Object.freeze({
+        delimiter: ',',
+        quoteChar: '"',
+        newline: '\n',
+        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
+     *
+     * @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));
+
+    /**
+     * Make error report URL for the given error
+     *
+     * @private !!!!!!
+     */
+    function getErrorReportUrl(error) {
+        var report = {
+            title: "\uD83D\uDC1C Error report from ".concat(NAME),
+            body: spaceTrim__default["default"](function (block) { return "\n\n\n            `".concat(error.name || 'Error', "` has occurred in the [").concat(NAME, "], please look into it @").concat(ADMIN_GITHUB_NAME, ".\n\n            ```\n            ").concat(block(error.message || '(no error message)'), "\n            ```\n\n\n            ## More info:\n\n            - **Promptbook engine version:** ").concat(PROMPTBOOK_ENGINE_VERSION, "\n            - **Book language version:** ").concat(BOOK_LANGUAGE_VERSION, "\n            - **Time:** ").concat(new Date().toISOString(), "\n\n            <details>\n            <summary>Stack trace:</summary>\n\n            ## Stack trace:\n\n            ```stacktrace\n            ").concat(block(error.stack || '(empty)'), "\n            ```\n            </details>\n\n        "); }),
+        };
+        var reportUrl = new URL("https://github.com/webgptorg/promptbook/issues/new");
+        reportUrl.searchParams.set('labels', 'bug');
+        reportUrl.searchParams.set('assignees', ADMIN_GITHUB_NAME);
+        reportUrl.searchParams.set('title', report.title);
+        reportUrl.searchParams.set('body', report.body);
+        return reportUrl;
+    }
+
     /**
      * This error type indicates that the error should not happen and its last check before crashing with some other error
      *
@@ -307,7 +404,7 @@
     var UnexpectedError = /** @class */ (function (_super) {
         __extends(UnexpectedError, _super);
         function UnexpectedError(message) {
-            var _this = _super.call(this, spaceTrim.spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This error should not happen.\n                    It's probbably a bug in the pipeline collection\n\n                    Please report issue:\n                    https://github.com/webgptorg/promptbook/issues\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
+            var _this = _super.call(this, spaceTrim.spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This error should not happen.\n                    It's probbably a bug in the pipeline collection\n\n                    Please report issue:\n                    ").concat(block(getErrorReportUrl(new Error(message)).href), "\n\n                    Or contact us on ").concat(ADMIN_EMAIL, "\n\n                "); })) || this;
             _this.name = 'UnexpectedError';
             Object.setPrototypeOf(_this, UnexpectedError.prototype);
             return _this;
@@ -315,6 +412,85 @@
         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
@@ -458,160 +634,6 @@
      * TODO: [🧠] Is there a way how to meaningfully test this utility
      */
 
-    // <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
-    /**
-     * The maximum number of iterations for a loops
-     *
-     * @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';
-    /**
-     * The names of the parameters that are reserved for special purposes
-     *
-     * @public exported from `@promptbook/core`
-     */
-    $asDeeplyFrozenSerializableJson('RESERVED_PARAMETER_NAMES', [
-        '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
-    ]);
-    /**
-     * @@@
-     *
-     * @private within the repository
-     */
-    var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
-    /**
-     * @@@
-     *
-     * @private within the repository
-     */
-    var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
-    // <- TODO: [🧜‍♂️]
-    /**
-     * @@@
-     *
-     * @public exported from `@promptbook/core`
-     */
-    Object.freeze({
-        delimiter: ',',
-        quoteChar: '"',
-        newline: '\n',
-        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
-     *
-     * @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;
-    }
-
     /**
      * Counts number of characters in the text
      *
@@ -1353,7 +1375,7 @@
             modelVariant: 'CHAT',
             modelTitle: 'o1-preview-2024-09-12',
             modelName: 'o1-preview-2024-09-12',
-            //             <- TODO: [main] !!! Some better system to organize theese date suffixes and versions
+            //             <- TODO: [💩] Some better system to organize theese date suffixes and versions
             pricing: {
                 prompt: computeUsage("$15.00 / 1M tokens"),
                 output: computeUsage("$60.00 / 1M tokens"),
@@ -1403,7 +1425,7 @@
      * @see https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4
      * @see https://openai.com/api/pricing/
      * @see /other/playground/playground.ts
-     * TODO: [🍓] Make better
+     * TODO: [🍓][💩] Make better
      * TODO: Change model titles to human eg: "gpt-4-turbo-2024-04-09" -> "GPT-4 Turbo (2024-04-09)"
      * TODO: [🚸] Not all models are compatible with JSON mode, add this information here and use it
      * Note: [💞] Ignore a discrepancy between file name and entity name