@promptbook/pdf 0.78.0-0 → 0.78.2

package/esm/typings/src/_packages/core.index.d.ts

@@ -5,6 +5,8 @@ import { createCollectionFromPromise } from '../collection/constructors/createCo
 import { createCollectionFromUrl } from '../collection/constructors/createCollectionFromUrl';
 import { createSubcollection } from '../collection/constructors/createSubcollection';
 import { NAME } from '../config';
+import { ADMIN_EMAIL } from '../config';
+import { ADMIN_GITHUB_NAME } from '../config';
 import { CLAIM } from '../config';
 import { LOGO_LIGHT_SRC } from '../config';
 import { LOGO_DARK_SRC } from '../config';
@@ -123,6 +125,8 @@ export { createCollectionFromPromise };
 export { createCollectionFromUrl };
 export { createSubcollection };
 export { NAME };
+export { ADMIN_EMAIL };
+export { ADMIN_GITHUB_NAME };
 export { CLAIM };
 export { LOGO_LIGHT_SRC };
 export { LOGO_DARK_SRC };

package/esm/typings/src/config.d.ts

@@ -1,5 +1,7 @@
 import type { CsvSettings } from './formats/csv/CsvSettings';
 import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
+import type { string_email } from './types/typeAliases';
+import type { string_name } from './types/typeAliases';
 import type { string_url_image } from './types/typeAliases';
 /**
  * Warning message for the generated sections and files files
@@ -15,6 +17,18 @@ export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has be
  * @public exported from `@promptbook/core`
  */
 export declare const NAME = "Promptbook";
+/**
+ * Email of the responsible person
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ADMIN_EMAIL: string_email;
+/**
+ * Name of the responsible person for the Promptbook on GitHub
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ADMIN_GITHUB_NAME: string_name;
 /**
  * Claim for the Promptbook
  *

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

@@ -0,0 +1,6 @@
+/**
+ * Make error report URL for the given error
+ *
+ * @private !!!!!!
+ */
+export declare function getErrorReportUrl(error: Error): URL;

package/esm/typings/src/execution/execution-report/ExecutionReportString.d.ts

@@ -12,5 +12,5 @@ export type ExecutionReportString = string & {
     readonly _type: 'ExecutionReportString';
 };
 /**
- * TODO: Better validation or remove branded type and make it just string
+ * TODO: [💩] Better validation or remove branded type and make it just string
  */

package/esm/typings/src/llm-providers/openai/openai-models.d.ts

@@ -24,7 +24,7 @@ export declare const OPENAI_MODELS: ReadonlyArray<AvailableModel & {
  * @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

package/esm/typings/src/pipeline/PipelineString.d.ts

@@ -8,5 +8,5 @@ export type PipelineString = string & {
     readonly _type: 'Promptbook';
 };
 /**
- * TODO: !! Better validation (validatePipelineString) or remove branded type and make it just string
+ * TODO: [💩] Better validation (validatePipelineString) or remove branded type and make it just string
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/pdf",
-    "version": "0.78.0-0",
+    "version": "0.78.2",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -54,7 +54,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/pdf.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.78.0-0"
+        "@promptbook/core": "0.78.2"
     },
     "dependencies": {
         "crypto-js": "4.2.0",

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
@@ -448,198 +448,25 @@
     }
 
     /**
-     * @@@
-     *
-     * 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
+     * Name for the Promptbook
      *
-     * @returns The same object as the input, but deeply frozen
-     * @public exported from `@promptbook/utils`
-     */
-    function $deepFreeze(objectValue) {
-        var e_1, _a;
-        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()) {
-                var propertyName = propertyNames_1_1.value;
-                var value = objectValue[propertyName];
-                if (value && typeof value === 'object') {
-                    $deepFreeze(value);
-                }
-            }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (propertyNames_1_1 && !propertyNames_1_1.done && (_a = propertyNames_1.return)) _a.call(propertyNames_1);
-            }
-            finally { if (e_1) throw e_1.error; }
-        }
-        return Object.freeze(objectValue);
-    }
-    /**
-     * TODO: [🧠] Is there a way how to meaningfully test this utility
-     */
-
-    /**
-     * This error type indicates that the error should not happen and its last check before crashing with some other error
+     * TODO: [🗽] Unite branding and make single place for it
      *
      * @public exported from `@promptbook/core`
      */
-    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;
-            _this.name = 'UnexpectedError';
-            Object.setPrototypeOf(_this, UnexpectedError.prototype);
-            return _this;
-        }
-        return UnexpectedError;
-    }(Error));
-
+    var NAME = "Promptbook";
     /**
-     * Checks if the value is [🚉] serializable as JSON
-     * If not, throws an UnexpectedError with a rich error message and tracking
-     *
-     * - Almost all primitives are serializable BUT:
-     * - `undefined` is not serializable
-     * - `NaN` is not serializable
-     * - Objects and arrays are serializable if all their properties are serializable
-     * - Functions are not serializable
-     * - Circular references are not serializable
-     * - `Date` objects are not serializable
-     * - `Map` and `Set` objects are not serializable
-     * - `RegExp` objects are not serializable
-     * - `Error` objects are not serializable
-     * - `Symbol` objects are not serializable
-     * - And much more...
+     * Email of the responsible person
      *
-     * @throws UnexpectedError if the value is not serializable as JSON
-     * @public exported from `@promptbook/utils`
-     */
-    function checkSerializableAsJson(name, value) {
-        var e_1, _a;
-        if (value === undefined) {
-            throw new UnexpectedError("".concat(name, " is undefined"));
-        }
-        else if (value === null) {
-            return;
-        }
-        else if (typeof value === 'boolean') {
-            return;
-        }
-        else if (typeof value === 'number' && !isNaN(value)) {
-            return;
-        }
-        else if (typeof value === 'string') {
-            return;
-        }
-        else if (typeof value === 'symbol') {
-            throw new UnexpectedError("".concat(name, " is symbol"));
-        }
-        else if (typeof value === 'function') {
-            throw new UnexpectedError("".concat(name, " is function"));
-        }
-        else if (typeof value === 'object' && Array.isArray(value)) {
-            for (var i = 0; i < value.length; i++) {
-                checkSerializableAsJson("".concat(name, "[").concat(i, "]"), value[i]);
-            }
-        }
-        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                ")));
-            }
-            else if (value instanceof Map) {
-                throw new UnexpectedError("".concat(name, " is Map"));
-            }
-            else if (value instanceof Set) {
-                throw new UnexpectedError("".concat(name, " is Set"));
-            }
-            else if (value instanceof RegExp) {
-                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                ")));
-            }
-            else {
-                try {
-                    for (var _b = __values(Object.entries(value)), _c = _b.next(); !_c.done; _c = _b.next()) {
-                        var _d = __read(_c.value, 2), subName = _d[0], subValue = _d[1];
-                        if (subValue === undefined) {
-                            // Note: undefined in object is serializable - it is just omited
-                            continue;
-                        }
-                        checkSerializableAsJson("".concat(name, ".").concat(subName), subValue);
-                    }
-                }
-                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; }
-                }
-                try {
-                    JSON.stringify(value); // <- TODO: [0]
-                }
-                catch (error) {
-                    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                        "); }));
-                }
-                /*
-                TODO: [0] Is there some more elegant way to check circular references?
-                const seen = new Set();
-                const stack = [{ value }];
-                while (stack.length > 0) {
-                    const { value } = stack.pop()!;
-                    if (typeof value === 'object' && value !== null) {
-                        if (seen.has(value)) {
-                            throw new UnexpectedError(`${name} has circular reference`);
-                        }
-                        seen.add(value);
-                        if (Array.isArray(value)) {
-                            stack.push(...value.map((value) => ({ value })));
-                        } else {
-                            stack.push(...Object.values(value).map((value) => ({ value })));
-                        }
-                    }
-                }
-                */
-                return;
-            }
-        }
-        else {
-            throw new UnexpectedError("".concat(name, " is unknown"));
-        }
-    }
-    /**
-     * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
-     * 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
+     * @public exported from `@promptbook/core`
      */
-
+    var ADMIN_EMAIL = 'me@pavolhejny.com';
     /**
-     * @@@
-     * @@@
+     * Name of the responsible person for the Promptbook on GitHub
      *
-     * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
-     *
-     * @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
-     */
-    function $asDeeplyFrozenSerializableJson(name, objectValue) {
-        checkSerializableAsJson(name, objectValue);
-        return $deepFreeze(objectValue);
-    }
-    /**
-     * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
-     * TODO: [🧠] Is there a way how to meaningfully test this utility
+     * @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
@@ -691,7 +518,8 @@
      *
      * @public exported from `@promptbook/core`
      */
-    var RESERVED_PARAMETER_NAMES = $asDeeplyFrozenSerializableJson('RESERVED_PARAMETER_NAMES', [
+    var RESERVED_PARAMETER_NAMES = 
+    /* !!!!!! $asDeeplyFrozenSerializableJson('RESERVED_PARAMETER_NAMES', _____ as const); */ [
         'content',
         'context',
         'knowledge',
@@ -701,7 +529,7 @@
         // <- TODO: list here all command names
         // <- TODO: Add more like 'date', 'modelName',...
         // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
-    ]);
+    ];
     /**
      * @@@
      *
@@ -788,6 +616,40 @@
         return PipelineLogicError;
     }(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
+     *
+     * @public exported from `@promptbook/core`
+     */
+    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                    ").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;
+        }
+        return UnexpectedError;
+    }(Error));
+
     /**
      * Tests if given string is valid semantic version
      *
@@ -1268,6 +1130,183 @@
         return parameterNames;
     }
 
+    /**
+     * @@@
+     *
+     * 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
+     *
+     * @returns The same object as the input, but deeply frozen
+     * @public exported from `@promptbook/utils`
+     */
+    function $deepFreeze(objectValue) {
+        var e_1, _a;
+        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()) {
+                var propertyName = propertyNames_1_1.value;
+                var value = objectValue[propertyName];
+                if (value && typeof value === 'object') {
+                    $deepFreeze(value);
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (propertyNames_1_1 && !propertyNames_1_1.done && (_a = propertyNames_1.return)) _a.call(propertyNames_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return Object.freeze(objectValue);
+    }
+    /**
+     * TODO: [🧠] Is there a way how to meaningfully test this utility
+     */
+
+    /**
+     * Checks if the value is [🚉] serializable as JSON
+     * If not, throws an UnexpectedError with a rich error message and tracking
+     *
+     * - Almost all primitives are serializable BUT:
+     * - `undefined` is not serializable
+     * - `NaN` is not serializable
+     * - Objects and arrays are serializable if all their properties are serializable
+     * - Functions are not serializable
+     * - Circular references are not serializable
+     * - `Date` objects are not serializable
+     * - `Map` and `Set` objects are not serializable
+     * - `RegExp` objects are not serializable
+     * - `Error` objects are not serializable
+     * - `Symbol` objects are not serializable
+     * - And much more...
+     *
+     * @throws UnexpectedError if the value is not serializable as JSON
+     * @public exported from `@promptbook/utils`
+     */
+    function checkSerializableAsJson(name, value) {
+        var e_1, _a;
+        if (value === undefined) {
+            throw new UnexpectedError("".concat(name, " is undefined"));
+        }
+        else if (value === null) {
+            return;
+        }
+        else if (typeof value === 'boolean') {
+            return;
+        }
+        else if (typeof value === 'number' && !isNaN(value)) {
+            return;
+        }
+        else if (typeof value === 'string') {
+            return;
+        }
+        else if (typeof value === 'symbol') {
+            throw new UnexpectedError("".concat(name, " is symbol"));
+        }
+        else if (typeof value === 'function') {
+            throw new UnexpectedError("".concat(name, " is function"));
+        }
+        else if (typeof value === 'object' && Array.isArray(value)) {
+            for (var i = 0; i < value.length; i++) {
+                checkSerializableAsJson("".concat(name, "[").concat(i, "]"), value[i]);
+            }
+        }
+        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                ")));
+            }
+            else if (value instanceof Map) {
+                throw new UnexpectedError("".concat(name, " is Map"));
+            }
+            else if (value instanceof Set) {
+                throw new UnexpectedError("".concat(name, " is Set"));
+            }
+            else if (value instanceof RegExp) {
+                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                ")));
+            }
+            else {
+                try {
+                    for (var _b = __values(Object.entries(value)), _c = _b.next(); !_c.done; _c = _b.next()) {
+                        var _d = __read(_c.value, 2), subName = _d[0], subValue = _d[1];
+                        if (subValue === undefined) {
+                            // Note: undefined in object is serializable - it is just omited
+                            continue;
+                        }
+                        checkSerializableAsJson("".concat(name, ".").concat(subName), subValue);
+                    }
+                }
+                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; }
+                }
+                try {
+                    JSON.stringify(value); // <- TODO: [0]
+                }
+                catch (error) {
+                    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                        "); }));
+                }
+                /*
+                TODO: [0] Is there some more elegant way to check circular references?
+                const seen = new Set();
+                const stack = [{ value }];
+                while (stack.length > 0) {
+                    const { value } = stack.pop()!;
+                    if (typeof value === 'object' && value !== null) {
+                        if (seen.has(value)) {
+                            throw new UnexpectedError(`${name} has circular reference`);
+                        }
+                        seen.add(value);
+                        if (Array.isArray(value)) {
+                            stack.push(...value.map((value) => ({ value })));
+                        } else {
+                            stack.push(...Object.values(value).map((value) => ({ value })));
+                        }
+                    }
+                }
+                */
+                return;
+            }
+        }
+        else {
+            throw new UnexpectedError("".concat(name, " is unknown"));
+        }
+    }
+    /**
+     * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
+     * 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
+     *
+     * @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
+     */
+    function $asDeeplyFrozenSerializableJson(name, objectValue) {
+        checkSerializableAsJson(name, objectValue);
+        return $deepFreeze(objectValue);
+    }
+    /**
+     * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
+     * TODO: [🧠] Is there a way how to meaningfully test this utility
+     */
+
     /**
      * Unprepare just strips the preparation data of the pipeline
      *
@@ -3565,6 +3604,7 @@
      */
     function extractVariablesFromScript(script) {
         var variables = new Set();
+        var originalScript = script;
         script = "(()=>{".concat(script, "})()");
         try {
             for (var i = 0; i < 100 /* <- TODO: This limit to configuration */; i++)
@@ -3596,7 +3636,9 @@
             if (!(error instanceof Error)) {
                 throw error;
             }
-            throw new ParseError(spaceTrim.spaceTrim(function (block) { return "\n                    Can not extract variables from the script\n\n                    ".concat(block(error.toString()), "}\n                "); }));
+            throw new ParseError(spaceTrim.spaceTrim(function (block) { return "\n                    Can not extract variables from the script\n\n                    ".concat(block(error.toString()), "}\n\n\n                    Found variables:\n\n                    ").concat(Array.from(variables)
+                .map(function (variableName, i) { return "".concat(i + 1, ") ").concat(variableName); })
+                .join('\n'), "\n\n\n                    The script:\n\n                    ```javascript\n                    ").concat(block(originalScript), "\n                    ```\n                "); }));
         }
         return variables;
     }