@promptbook/browser 0.103.0-48 → 0.103.0-49

package/esm/index.es.js

@@ -19,7 +19,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.103.0-48';
+const PROMPTBOOK_ENGINE_VERSION = '0.103.0-49';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -481,6 +481,9 @@ class Color {
         if (hex.length === 3) {
             return Color.fromHex3(hex);
         }
+        if (hex.length === 4) {
+            return Color.fromHex4(hex);
+        }
         if (hex.length === 6) {
             return Color.fromHex6(hex);
         }
@@ -501,6 +504,19 @@ class Color {
         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)
      *
@@ -691,7 +707,8 @@ class Color {
      * @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
@@ -998,6 +1015,7 @@ const PROMPTBOOK_COLOR = Color.fromHex('#79EAFD');
 ({
     TITLE: Color.fromHex('#244EA8'),
     LINE: Color.fromHex('#eeeeee'),
+    SEPARATOR: Color.fromHex('#cccccc'),
     COMMITMENT: Color.fromHex('#DA0F78'),
     PARAMETER: Color.fromHex('#8e44ad'),
 });
@@ -1026,6 +1044,27 @@ Color.fromHex('#1D4ED8');
  * @private within the repository - too low-level in comparison with other `MAX_...`
  */
 const LOOP_LIMIT = 1000;
+/**
+ * Strings to represent various values in the context of parameter values
+ *
+ * @public exported from `@promptbook/utils`
+ */
+const VALUE_STRINGS = {
+    empty: '(nothing; empty string)',
+    null: '(no value; null)',
+    undefined: '(unknown value; undefined)',
+    nan: '(not a number; NaN)',
+    infinity: '(infinity; ∞)',
+    negativeInfinity: '(negative infinity; -∞)',
+    unserializable: '(unserializable value)',
+    circular: '(circular JSON)',
+};
+/**
+ * Small number limit
+ *
+ * @public exported from `@promptbook/utils`
+ */
+const SMALL_NUMBER = 0.001;
 // <- TODO: [🧜‍♂️]
 /**
  * Default settings for parsing and generating CSV files in Promptbook.
@@ -1672,7 +1711,7 @@ function deepClone(objectValue) {
     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);
     >     }
@@ -1991,13 +2030,106 @@ function generatePlaceholderAgentProfileImageUrl(agentName) {
  * TODO: [🤹] Figure out best placeholder image generator https://i.pravatar.cc/1000?u=568
  */
 
+/**
+ * Format either small or big number
+ *
+ * @public exported from `@promptbook/utils`
+ */
+function numberToString(value) {
+    if (value === 0) {
+        return '0';
+    }
+    else if (Number.isNaN(value)) {
+        return VALUE_STRINGS.nan;
+    }
+    else if (value === Infinity) {
+        return VALUE_STRINGS.infinity;
+    }
+    else if (value === -Infinity) {
+        return VALUE_STRINGS.negativeInfinity;
+    }
+    for (let exponent = 0; exponent < 15; exponent++) {
+        const factor = 10 ** exponent;
+        const valueRounded = Math.round(value * factor) / factor;
+        if (Math.abs(value - valueRounded) / value < SMALL_NUMBER) {
+            return valueRounded.toFixed(exponent);
+        }
+    }
+    return value.toString();
+}
+
+/**
+ * Function `valueToString` will convert the given value to string
+ * This is useful and used in the `templateParameters` function
+ *
+ * Note: This function is not just calling `toString` method
+ *       It's more complex and can handle this conversion specifically for LLM models
+ *       See `VALUE_STRINGS`
+ *
+ * Note: There are 2 similar functions
+ * - `valueToString` converts value to string for LLM models as human-readable string
+ * - `asSerializable` converts value to string to preserve full information to be able to convert it back
+ *
+ * @public exported from `@promptbook/utils`
+ */
+function valueToString(value) {
+    try {
+        if (value === '') {
+            return VALUE_STRINGS.empty;
+        }
+        else if (value === null) {
+            return VALUE_STRINGS.null;
+        }
+        else if (value === undefined) {
+            return VALUE_STRINGS.undefined;
+        }
+        else if (typeof value === 'string') {
+            return value;
+        }
+        else if (typeof value === 'number') {
+            return numberToString(value);
+        }
+        else if (value instanceof Date) {
+            return value.toISOString();
+        }
+        else {
+            try {
+                return JSON.stringify(value);
+            }
+            catch (error) {
+                if (error instanceof TypeError && error.message.includes('circular structure')) {
+                    return VALUE_STRINGS.circular;
+                }
+                throw error;
+            }
+        }
+    }
+    catch (error) {
+        assertsError(error);
+        console.error(error);
+        return VALUE_STRINGS.unserializable;
+    }
+}
+
+/**
+ * Computes SHA-256 hash of the given object
+ *
+ * @public exported from `@promptbook/utils`
+ */
+function computeHash(value) {
+    return SHA256(hexEncoder.parse(spaceTrim$1(valueToString(value)))).toString( /* hex */);
+}
+/**
+ * TODO: [🥬][🥬] Use this ACRY
+ */
+
 /**
  * Computes SHA-256 hash of the agent source
  *
  * @public exported from `@promptbook/core`
  */
 function computeAgentHash(agentSource) {
-    return SHA256(hexEncoder.parse(agentSource /* <- TODO: !!!!! spaceTrim */)).toString( /* hex */);
+    return computeHash(agentSource);
 }
 
 /**
@@ -3183,6 +3315,60 @@ class MemoryCommitmentDefinition extends BaseCommitmentDefinition {
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
+/**
+ * INITIAL MESSAGE commitment definition
+ *
+ * The INITIAL MESSAGE commitment defines the first message that the user sees when opening the chat.
+ * It is used to greet the user and set the tone of the conversation.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * INITIAL MESSAGE Hello! I am ready to help you with your tasks.
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+class InitialMessageCommitmentDefinition extends BaseCommitmentDefinition {
+    constructor() {
+        super('INITIAL MESSAGE');
+    }
+    /**
+     * Short one-line description of INITIAL MESSAGE.
+     */
+    get description() {
+        return 'Defines the **initial message** shown to the user when the chat starts.';
+    }
+    /**
+     * Markdown documentation for INITIAL MESSAGE commitment.
+     */
+    get documentation() {
+        return spaceTrim(`
+            # ${this.type}
+
+            Defines the first message that the user sees when opening the chat. This message is purely for display purposes in the UI and does not inherently become part of the LLM's system prompt context (unless also included via other means).
+
+            ## Key aspects
+
+            - Used to greet the user.
+            - Sets the tone of the conversation.
+            - Displayed immediately when the chat interface loads.
+
+            ## Examples
+
+            \`\`\`book
+            Support Agent
+
+            PERSONA You are a helpful support agent.
+            INITIAL MESSAGE Hi there! How can I assist you today?
+            \`\`\`
+        `);
+    }
+    applyToAgentModelRequirements(requirements, content) {
+        return requirements;
+    }
+}
+
 /**
  * MESSAGE commitment definition
  *
@@ -4344,6 +4530,7 @@ const COMMITMENT_REGISTRY = [
     new NoteCommitmentDefinition('NONCE'),
     new GoalCommitmentDefinition('GOAL'),
     new GoalCommitmentDefinition('GOALS'),
+    new InitialMessageCommitmentDefinition(),
     new MessageCommitmentDefinition('MESSAGE'),
     new MessageCommitmentDefinition('MESSAGES'),
     new ScenarioCommitmentDefinition('SCENARIO'),
@@ -4548,13 +4735,31 @@ function parseAgentSource(agentSource) {
         }
         personaDescription += commitment.content;
     }
+    let initialMessage = null;
+    for (const commitment of parseResult.commitments) {
+        if (commitment.type !== 'INITIAL MESSAGE') {
+            continue;
+        }
+        // Note: Initial message override logic - later overrides earlier
+        //       Or should it append? Usually initial message is just one block.
+        //       Let's stick to "later overrides earlier" for simplicity, or just take the last one.
+        initialMessage = commitment.content;
+    }
     const meta = {};
+    const links = [];
     for (const commitment of parseResult.commitments) {
+        if (commitment.type === 'META LINK') {
+            links.push(spaceTrim$1(commitment.content));
+            continue;
+        }
         if (commitment.type !== 'META') {
             continue;
         }
         // Parse META commitments - format is "META TYPE content"
         const metaTypeRaw = commitment.content.split(' ')[0] || 'NONE';
+        if (metaTypeRaw === 'LINK') {
+            links.push(spaceTrim$1(commitment.content.substring(metaTypeRaw.length)));
+        }
         const metaType = normalizeTo_camelCase(metaTypeRaw);
         meta[metaType] = spaceTrim$1(commitment.content.substring(metaTypeRaw.length));
     }
@@ -4570,7 +4775,9 @@ function parseAgentSource(agentSource) {
         agentName: normalizeAgentName(parseResult.agentName || createDefaultAgentName(agentSource)),
         agentHash,
         personaDescription,
+        initialMessage,
         meta,
+        links,
         parameters,
     };
 }