@promptbook/javascript 0.103.0-9 → 0.103.0

package/umd/index.umd.js

@@ -1,12 +1,12 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('spacetrim'), require('path'), require('crypto')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'spacetrim', 'path', 'crypto'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-javascript"] = {}, global.spaceTrim, null, global.crypto));
-})(this, (function (exports, spaceTrim, path, crypto) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('spacetrim'), require('path'), require('crypto'), require('crypto-js'), require('crypto-js/enc-hex')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'spacetrim', 'path', 'crypto', 'crypto-js', 'crypto-js/enc-hex'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-javascript"] = {}, global.spaceTrim$1, null, global.crypto));
+})(this, (function (exports, spaceTrim$1, path, crypto) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
-    var spaceTrim__default = /*#__PURE__*/_interopDefaultLegacy(spaceTrim);
+    var spaceTrim__default = /*#__PURE__*/_interopDefaultLegacy(spaceTrim$1);
 
     // ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
     /**
@@ -15,19 +15,30 @@
      * @generated
      * @see https://github.com/webgptorg/book
      */
-    const BOOK_LANGUAGE_VERSION = '1.0.0';
+    const BOOK_LANGUAGE_VERSION = '2.0.0';
     /**
      * The version of the Promptbook engine
      *
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-9';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.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
      */
 
+    /**
+     * Trims string from all 4 sides
+     *
+     * Note: This is a re-exported function from the `spacetrim` package which is
+     *       Developed by same author @hejny as this package
+     *
+     * @public exported from `@promptbook/utils`
+     * @see https://github.com/hejny/spacetrim#usage
+     */
+    const spaceTrim = spaceTrim$1.spaceTrim;
+
     /**
      * @private util of `@promptbook/color`
      * @de
@@ -76,6 +87,7 @@
      * @public exported from `@promptbook/color`
      */
     const CSS_COLORS = {
+        promptbook: '#79EAFD',
         transparent: 'rgba(0,0,0,0)',
         aliceblue: '#f0f8ff',
         antiquewhite: '#faebd7',
@@ -257,9 +269,6 @@
             throw new Error(`${channelName} channel is greater than 255, it is ${value}`);
         }
     }
-    /**
-     * TODO: [🧠][🚓] Is/which combination it better to use asserts/check, validate or is utility function?
-     */
 
     /**
      * Color object represents an RGB color with alpha channel
@@ -279,21 +288,61 @@
          * @param color
          * @returns Color object
          */
-        static from(color) {
-            if (color instanceof Color) {
+        static from(color, _isSingleValue = false) {
+            if (color === '') {
+                throw new Error(`Can not create color from empty string`);
+            }
+            else if (color instanceof Color) {
                 return take(color);
             }
             else if (Color.isColor(color)) {
                 return take(color);
             }
             else if (typeof color === 'string') {
-                return Color.fromString(color);
+                try {
+                    return Color.fromString(color);
+                }
+                catch (error) {
+                    // <- Note: Can not use `assertsError(error)` here because it causes circular dependency
+                    if (_isSingleValue) {
+                        throw error;
+                    }
+                    const parts = color.split(/[\s+,;|]/);
+                    if (parts.length > 0) {
+                        return Color.from(parts[0].trim(), true);
+                    }
+                    else {
+                        throw new Error(`Can not create color from given string "${color}"`);
+                    }
+                }
             }
             else {
                 console.error({ color });
                 throw new Error(`Can not create color from given object`);
             }
         }
+        /**
+         * Creates a new Color instance from miscellaneous formats
+         * It just does not throw error when it fails, it returns PROMPTBOOK_COLOR instead
+         *
+         * @param color
+         * @returns Color object
+         */
+        static fromSafe(color) {
+            try {
+                return Color.from(color);
+            }
+            catch (error) {
+                // <- Note: Can not use `assertsError(error)` here because it causes circular dependency
+                console.warn(spaceTrim((block) => `
+                        Color.fromSafe error:
+                        ${block(error.message)}
+
+                        Returning default PROMPTBOOK_COLOR.
+                    `));
+                return Color.fromString('promptbook');
+            }
+        }
         /**
          * Creates a new Color instance from miscellaneous string formats
          *
@@ -361,6 +410,9 @@
             if (hex.length === 3) {
                 return Color.fromHex3(hex);
             }
+            if (hex.length === 4) {
+                return Color.fromHex4(hex);
+            }
             if (hex.length === 6) {
                 return Color.fromHex6(hex);
             }
@@ -381,6 +433,19 @@
             const b = parseInt(hex.substr(2, 1), 16) * 16;
             return take(new Color(r, g, b));
         }
+        /**
+         * Creates a new Color instance from color in hex format with 4 digits (with alpha channel)
+         *
+         * @param color in hex for example `09df`
+         * @returns Color object
+         */
+        static fromHex4(hex) {
+            const r = parseInt(hex.substr(0, 1), 16) * 16;
+            const g = parseInt(hex.substr(1, 1), 16) * 16;
+            const b = parseInt(hex.substr(2, 1), 16) * 16;
+            const a = parseInt(hex.substr(3, 1), 16) * 16;
+            return take(new Color(r, g, b, a));
+        }
         /**
          * Creates a new Color instance from color in hex format with 6 color digits (without alpha channel)
          *
@@ -571,7 +636,8 @@
          * @returns true if the value is a valid hex color string (e.g., `#009edd`, `#fff`, etc.)
          */
         static isHexColorString(value) {
-            return typeof value === 'string' && /^#(?:[0-9a-fA-F]{3}){1,2}$/.test(value);
+            return (typeof value === 'string' &&
+                /^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$/.test(value));
         }
         /**
          * Creates new Color object
@@ -686,6 +752,23 @@
      * TODO: Maybe connect with textures
      */
 
+    /**
+     * Makes color transformer which returns a grayscale version of the color
+     *
+     * @param amount from 0 to 1
+     *
+     * @public exported from `@promptbook/color`
+     */
+    function grayscale(amount) {
+        return ({ red, green, blue, alpha }) => {
+            const average = (red + green + blue) / 3;
+            red = Math.round(average * amount + red * (1 - amount));
+            green = Math.round(average * amount + green * (1 - amount));
+            blue = Math.round(average * amount + blue * (1 - amount));
+            return Color.fromValues(red, green, blue, alpha);
+        };
+    }
+
     /**
      * Converts HSL values to RGB values
      *
@@ -801,102 +884,6 @@
      * TODO: Maybe implement by mix+hsl
      */
 
-    /**
-     * Calculates distance between two colors
-     *
-     * @param color1 first color
-     * @param color2 second color
-     *
-     * Note: This function is inefficient. Use colorDistanceSquared instead if possible.
-     *
-     * @public exported from `@promptbook/color`
-     */
-    /**
-     * Calculates distance between two colors without square root
-     *
-     * @param color1 first color
-     * @param color2 second color
-     *
-     * @public exported from `@promptbook/color`
-     */
-    function colorDistanceSquared(color1, color2) {
-        const rmean = (color1.red + color2.red) / 2;
-        const r = color1.red - color2.red;
-        const g = color1.green - color2.green;
-        const b = color1.blue - color2.blue;
-        const weightR = 2 + rmean / 256;
-        const weightG = 4.0;
-        const weightB = 2 + (255 - rmean) / 256;
-        const distance = weightR * r * r + weightG * g * g + weightB * b * b;
-        return distance;
-    }
-
-    /**
-     * Makes color transformer which finds the nearest color from the given list
-     *
-     * @param colors array of colors to choose from
-     *
-     * @public exported from `@promptbook/color`
-     */
-    function nearest(...colors) {
-        return (color) => {
-            const distances = colors.map((c) => colorDistanceSquared(c, color));
-            const minDistance = Math.min(...distances);
-            const minIndex = distances.indexOf(minDistance);
-            const nearestColor = colors[minIndex];
-            return nearestColor;
-        };
-    }
-
-    /**
-     * Color transformer which returns the negative color
-     *
-     * @public exported from `@promptbook/color`
-     */
-    function negative(color) {
-        const r = 255 - color.red;
-        const g = 255 - color.green;
-        const b = 255 - color.blue;
-        return Color.fromValues(r, g, b, color.alpha);
-    }
-
-    /**
-     * Makes color transformer which finds the furthest color from the given list
-     *
-     * @param colors array of colors to choose from
-     *
-     * @public exported from `@promptbook/color`
-     */
-    function furthest(...colors) {
-        return (color) => {
-            const furthestColor = negative(nearest(...colors.map(negative))(color));
-            return furthestColor;
-        };
-    }
-    /**
-     * Makes color transformer which finds the best text color (black or white) for the given background color
-     *
-     * @public exported from `@promptbook/color`
-     */
-    furthest(Color.get('white'), Color.from('black'));
-
-    /**
-     * Makes color transformer which returns a grayscale version of the color
-     *
-     * @param amount from 0 to 1
-     *
-     * @public exported from `@promptbook/color`
-     */
-    function grayscale(amount) {
-        return ({ red, green, blue, alpha }) => {
-            const average = (red + green + blue) / 3;
-            red = Math.round(average * amount + red * (1 - amount));
-            green = Math.round(average * amount + green * (1 - amount));
-            blue = Math.round(average * amount + blue * (1 - amount));
-            return Color.fromValues(red, green, blue, alpha);
-        };
-    }
-
     /**
      * Makes color transformer which saturate the given color
      *
@@ -945,16 +932,32 @@
      *
      * @public exported from `@promptbook/core`
      */
-    const PROMPTBOOK_COLOR = Color.fromHex('#79EAFD');
-    // <- TODO: [🧠] Using `Color` here increases the package size approx 3kb, maybe remove it
+    const PROMPTBOOK_COLOR = Color.fromString('promptbook');
+    // <- TODO: [🧠][🈵] Using `Color` here increases the package size approx 3kb, maybe remove it
+    /**
+     * Colors for syntax highlighting in the `<BookEditor/>`
+     *
+     * TODO: [🗽] Unite branding and make single place for it
+     *
+     * @public exported from `@promptbook/core`
+     */
+    ({
+        TITLE: Color.fromHex('#244EA8'),
+        LINE: Color.fromHex('#eeeeee'),
+        SEPARATOR: Color.fromHex('#cccccc'),
+        COMMITMENT: Color.fromHex('#DA0F78'),
+        PARAMETER: Color.fromHex('#8e44ad'),
+    });
+    // <- TODO: [🧠][🈵] Using `Color` here increases the package size approx 3kb, maybe remove it
     /**
-     * Dark color of the Promptbook
+     * Chat color of the Promptbook (in chat)
      *
      * TODO: [🗽] Unite branding and make single place for it
      *
      * @public exported from `@promptbook/core`
      */
     PROMPTBOOK_COLOR.then(lighten(0.1)).then(saturate(0.9)).then(grayscale(0.9));
+    // <- TODO: [🧠][🈵] Using `Color` and `lighten`, `saturate`,... here increases the package size approx 3kb, maybe remove it
     /**
      * Color of the user (in chat)
      *
@@ -1108,7 +1111,7 @@
      */
     class UnexpectedError extends Error {
         constructor(message) {
-            super(spaceTrim.spaceTrim((block) => `
+            super(spaceTrim$1.spaceTrim((block) => `
                     ${block(message)}
 
                     Note: This error should not happen.
@@ -1134,7 +1137,7 @@
         constructor(whatWasThrown) {
             const tag = `[🤮]`;
             console.error(tag, whatWasThrown);
-            super(spaceTrim.spaceTrim(`
+            super(spaceTrim$1.spaceTrim(`
                 Non-Error object was thrown
 
                 Note: Look for ${tag} in the console for more details
@@ -1327,7 +1330,7 @@
         TODO: [🧠] Is there a better implementation?
         > const propertyNames = Object.getOwnPropertyNames(objectValue);
         > for (const propertyName of propertyNames) {
-        >     const value = (objectValue as really_any)[propertyName];
+        >     const value = (objectValue as chococake)[propertyName];
         >     if (value && typeof value === 'object') {
         >         deepClone(value);
         >     }
@@ -1400,6 +1403,8 @@
     /**
      * Normalizes a given text to camelCase format.
      *
+     * Note: [🔂] This function is idempotent.
+     *
      * @param text The text to be normalized.
      * @param _isFirstLetterCapital Whether the first letter should be capitalized.
      * @returns The camelCase formatted string.
@@ -1715,6 +1720,8 @@
     /**
      * Converts a given text to kebab-case format.
      *
+     * Note: [🔂] This function is idempotent.
+     *
      * @param text The text to be converted.
      * @returns The kebab-case formatted string.
      * @example 'hello-world'
@@ -1800,6 +1807,7 @@
     /**
      * Generates random token
      *
+     * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
      * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
      *
      * @private internal helper function
@@ -1809,6 +1817,7 @@
         return crypto.randomBytes(randomness).toString('hex');
     }
     /**
+     * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
      * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
      */
 
@@ -2142,6 +2151,9 @@
     }
 
     /**
+     * Normalizes a given text to PascalCase format.
+     *
+     * Note: [🔂] This function is idempotent.
      *
      * @param text @public exported from `@promptbook/utils`
      * @returns
@@ -2221,7 +2233,7 @@
         let trimmedText = text;
         // Remove leading and trailing spaces and newlines
         if (isTrimmed) {
-            trimmedText = spaceTrim.spaceTrim(trimmedText);
+            trimmedText = spaceTrim$1.spaceTrim(trimmedText);
         }
         let processedText = trimmedText;
         if (isIntroduceSentenceRemoved) {
@@ -2230,7 +2242,7 @@
                 // Remove the introduce sentence and quotes by replacing it with an empty string
                 processedText = processedText.replace(introduceSentenceRegex, '');
             }
-            processedText = spaceTrim.spaceTrim(processedText);
+            processedText = spaceTrim$1.spaceTrim(processedText);
         }
         if (processedText.length < 3) {
             return trimmedText;
@@ -2412,13 +2424,13 @@
      * @public exported from `@promptbook/markdown-utils`
      */
     function trimCodeBlock(value) {
-        value = spaceTrim.spaceTrim(value);
+        value = spaceTrim$1.spaceTrim(value);
         if (!/^```[a-z]*(.*)```$/is.test(value)) {
             return value;
         }
         value = value.replace(/^```[a-z]*/i, '');
         value = value.replace(/```$/i, '');
-        value = spaceTrim.spaceTrim(value);
+        value = spaceTrim$1.spaceTrim(value);
         return value;
     }
 
@@ -2431,9 +2443,9 @@
      * @public exported from `@promptbook/markdown-utils`
      */
     function trimEndOfCodeBlock(value) {
-        value = spaceTrim.spaceTrim(value);
+        value = spaceTrim$1.spaceTrim(value);
         value = value.replace(/```$/g, '');
-        value = spaceTrim.spaceTrim(value);
+        value = spaceTrim$1.spaceTrim(value);
         return value;
     }
 
@@ -2760,7 +2772,7 @@
         }
         catch (error) {
             assertsError(error);
-            throw new ParseError(spaceTrim.spaceTrim((block) => `
+            throw new ParseError(spaceTrim$1.spaceTrim((block) => `
                     Can not extract variables from the script
                     ${block(error.stack || error.message)}