@promptbook/vercel 0.103.0-10 → 0.103.0-100

package/esm/typings/src/utils/random/$randomItem.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Pick random item from the received array
+ *
+ * @private internal helper function
+ */
+export declare function $randomItem<TItem>(...items: Array<TItem>): TItem;
+/**
+ * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
+ */ 

package/esm/typings/src/utils/random/$randomSeed.d.ts

@@ -8,3 +8,6 @@ import type { number_seed } from '../../types/typeAliases';
  * @private internal helper function
  */
 export declare function $randomSeed(): number_seed;
+/**
+ * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
+ */ 

package/esm/typings/src/utils/random/$randomToken.d.ts

@@ -2,6 +2,7 @@ import type { string_token } from '../../types/typeAliases';
 /**
  * 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
@@ -9,5 +10,6 @@ import type { string_token } from '../../types/typeAliases';
  */
 export declare function $randomToken(randomness: number): string_token;
 /**
+ * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
  * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
  */

package/esm/typings/src/utils/serialization/$deepFreeze.d.ts

@@ -1,4 +1,5 @@
 import type { ReadonlyDeep } from 'type-fest';
+import type { $side_effect } from '../organization/$side_effect';
 /**
  * Freezes the given object and all its nested objects recursively
  *
@@ -8,7 +9,7 @@ import type { ReadonlyDeep } from 'type-fest';
  * @returns The same object as the input, but deeply frozen
  * @public exported from `@promptbook/utils`
  */
-export declare function $deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<TObject>;
+export declare function $deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<$side_effect & TObject>;
 /**
  * TODO: [🧠] Is there a way how to meaningfully test this utility
  */

package/esm/typings/src/utils/serialization/asSerializable.d.ts

@@ -1,4 +1,4 @@
-import type { really_any } from '../organization/really_any';
+import type { chococake } from '../organization/really_any';
 /**
  * Function `asSerializable` will convert values which are not serializable to serializable values
  * It walks deeply through the object and converts all values
@@ -12,4 +12,4 @@ import type { really_any } from '../organization/really_any';
  *
  * @private Internal helper function
  */
-export declare function asSerializable(value: really_any): really_any;
+export declare function asSerializable(value: chococake): chococake;

package/esm/typings/src/utils/serialization/serializeToPromptbookJavascript.d.ts

@@ -1,5 +1,5 @@
-import { string_javascript } from '../../types/typeAliases';
-import { TODO_any } from '../organization/TODO_any';
+import type { string_javascript } from '../../types/typeAliases';
+import type { TODO_any } from '../organization/TODO_any';
 type SerializeToPromptbookJavascriptReturn = {
     /**
      * Array of import statements required for the `value` to work

package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts

@@ -3,6 +3,8 @@ import type { string_parameter_name } from '../../../types/typeAliases';
  * Function `validateParameterName` will normalize and validate a parameter name for use in pipelines.
  * It removes diacritics, emojis, and quotes, normalizes to camelCase, and checks for reserved names and invalid characters.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param parameterName The parameter name to validate and normalize.
  * @returns The validated and normalized parameter name.
  * @throws {ParseError} If the parameter name is empty, reserved, or contains invalid characters.

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

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.103.0-9`).
+ * It follows semantic versioning (e.g., `0.103.0-55`).
  *
  * @generated
  */

package/esm/typings/src/wizard/$getCompiledBook.d.ts

@@ -2,8 +2,7 @@ import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 import type { PipelineString } from '../pipeline/PipelineString';
 import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
-import type { string_filename } from '../types/typeAliases';
-import type { string_pipeline_url } from '../types/typeAliases';
+import type { string_filename, string_pipeline_url } from '../types/typeAliases';
 /**
  * @see ./wizard.ts `getPipeline` method
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/vercel",
-    "version": "0.103.0-10",
+    "version": "0.103.0-100",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -87,18 +87,18 @@
     },
     "homepage": "https://ptbk.io/",
     "engines": {
-        "node": ">=16.0.0",
+        "node": ">=18.18.0",
         "npm": ">=8.0.0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/vercel.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-10"
+        "@promptbook/core": "0.103.0-100"
     },
     "dependencies": {
         "colors": "1.4.0",
         "crypto": "1.0.1",
-        "spacetrim": "0.11.59"
+        "spacetrim": "0.11.60"
     }
 }

package/umd/index.umd.js

@@ -1,13 +1,13 @@
 (function (global, factory) {
     typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('spacetrim'), require('crypto')) :
     typeof define === 'function' && define.amd ? define(['exports', 'colors', 'spacetrim', 'crypto'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-vercel"] = {}, global.colors, global.spaceTrim, global.crypto));
-})(this, (function (exports, colors, spaceTrim, crypto) { 'use strict';
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-vercel"] = {}, global.colors, global.spaceTrim$1, global.crypto));
+})(this, (function (exports, colors, spaceTrim$1, crypto) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
     var colors__default = /*#__PURE__*/_interopDefaultLegacy(colors);
-    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
     /**
@@ -16,14 +16,14 @@
      * @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-10';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-100';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -32,6 +32,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
@@ -41,6 +42,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
      */
 
@@ -107,10 +109,13 @@
      * @public exported from `@promptbook/utils`
      */
     function countLines(text) {
+        if (text === '') {
+            return 0;
+        }
         text = text.replace('\r\n', '\n');
         text = text.replace('\r', '\n');
         const lines = text.split('\n');
-        return lines.reduce((count, line) => count + Math.ceil(line.length / CHARACTERS_PER_STANDARD_LINE), 0);
+        return lines.reduce((count, line) => count + Math.max(Math.ceil(line.length / CHARACTERS_PER_STANDARD_LINE), 1), 0);
     }
     /**
      * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
@@ -591,6 +596,17 @@
         return new Date().toISOString();
     }
 
+    /**
+     * 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
@@ -639,6 +655,7 @@
      * @public exported from `@promptbook/color`
      */
     const CSS_COLORS = {
+        promptbook: '#79EAFD',
         transparent: 'rgba(0,0,0,0)',
         aliceblue: '#f0f8ff',
         antiquewhite: '#faebd7',
@@ -820,9 +837,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
@@ -857,6 +871,28 @@
                 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
          *
@@ -924,6 +960,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);
             }
@@ -944,6 +983,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)
          *
@@ -1134,7 +1186,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
@@ -1249,6 +1302,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
      *
@@ -1364,102 +1434,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
      *
@@ -1508,16 +1482,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)
      *
@@ -1644,7 +1634,7 @@
      */
     class UnexpectedError extends Error {
         constructor(message) {
-            super(spaceTrim.spaceTrim((block) => `
+            super(spaceTrim$1.spaceTrim((block) => `
                     ${block(message)}
 
                     Note: This error should not happen.
@@ -1670,7 +1660,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
@@ -1863,7 +1853,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);
         >     }
@@ -2215,7 +2205,7 @@
                 let promptMessages;
                 if ('thread' in prompt && Array.isArray(prompt.thread)) {
                     promptMessages = prompt.thread.map((msg) => ({
-                        role: msg.role === 'assistant' ? 'assistant' : (msg.role === 'system' ? 'system' : 'user'),
+                        role: msg.role === 'assistant' ? 'assistant' : msg.role === 'system' ? 'system' : 'user',
                         content: [
                             {
                                 type: 'text',