@promptbook/browser 0.104.0-1 → 0.104.0-10

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.104.0-1';
+    const PROMPTBOOK_ENGINE_VERSION = '0.104.0-10';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -122,13 +122,14 @@
      *
      * @public exported from `@promptbook/utils`
      */
-    const $isRunningInBrowser = new Function(`
-    try {
-        return this === window;
-    } catch (e) {
-        return false;
+    function $isRunningInBrowser() {
+        try {
+            return typeof window !== 'undefined' && typeof window.document !== 'undefined';
+        }
+        catch (e) {
+            return false;
+        }
     }
-`);
     /**
      * TODO: [🎺]
      */
@@ -140,17 +141,17 @@
      *
      * @public exported from `@promptbook/utils`
      */
-    const $isRunningInWebWorker = new Function(`
-    try {
-        if (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) {
-            return true;
-        } else {
+    function $isRunningInWebWorker() {
+        try {
+            // Note: Check for importScripts which is specific to workers
+            //       and not available in the main browser thread
+            return (typeof self !== 'undefined' &&
+                typeof self.importScripts === 'function');
+        }
+        catch (e) {
             return false;
         }
-    } catch (e) {
-        return false;
     }
-`);
     /**
      * TODO: [🎺]
      */
@@ -2048,44 +2049,6 @@
      * TODO: [🌺] Use some intermediate util splitWords
      */
 
-    /**
-     * Generates a gravatar URL based on agent name for fallback avatar
-     *
-     * @param agentName The agent name to generate avatar for
-     * @returns Gravatar URL
-     *
-     * @private - [🤹] The fact that profile image is Gravatar is just implementation detail which should be hidden for consumer
-     */
-    function generateGravatarUrl(agentName) {
-        // Use a default name if none provided
-        const safeName = agentName || 'Anonymous Agent';
-        // Create a simple hash from the name for consistent avatar
-        let hash = 0;
-        for (let i = 0; i < safeName.length; i++) {
-            const char = safeName.charCodeAt(i);
-            hash = (hash << 5) - hash + char;
-            hash = hash & hash; // Convert to 32bit integer
-        }
-        const avatarId = Math.abs(hash).toString();
-        return `https://www.gravatar.com/avatar/${avatarId}?default=robohash&size=200&rating=x`;
-    }
-
-    /**
-     * Generates an image for the agent to use as profile image
-     *
-     * @param agentName The agent name to generate avatar for
-     * @returns The placeholder profile image URL for the agent
-     *
-     * @public exported from `@promptbook/core`
-     */
-    function generatePlaceholderAgentProfileImageUrl(agentName) {
-        // Note: [🤹] The fact that profile image is Gravatar is just implementation detail which should be hidden for consumer
-        return generateGravatarUrl(agentName);
-    }
-    /**
-     * TODO: [🤹] Figure out best placeholder image generator https://i.pravatar.cc/1000?u=568
-     */
-
     /**
      * Format either small or big number
      *
@@ -2661,42 +2624,6 @@
      * Note: [💞] Ignore a discrepancy between file name and entity name
      */
 
-    /**
-     * Detects if the code is running in jest environment
-     *
-     * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
-     *
-     * @public exported from `@promptbook/utils`
-     */
-    new Function(`
-    try {
-        return process.env.JEST_WORKER_ID !== undefined;
-    } catch (e) {
-        return false;
-    }
-`);
-    /**
-     * TODO: [🎺]
-     */
-
-    /**
-     * Detects if the code is running in a Node.js environment
-     *
-     * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
-     *
-     * @public exported from `@promptbook/utils`
-     */
-    new Function(`
-    try {
-        return this === global;
-    } catch (e) {
-        return false;
-    }
-`);
-    /**
-     * TODO: [🎺]
-     */
-
     /**
      * Normalizes agent name from arbitrary string to valid agent name
      *
@@ -3175,6 +3102,114 @@
      * Note: [💞] Ignore a discrepancy between file name and entity name
      */
 
+    /**
+     * DICTIONARY commitment definition
+     *
+     * The DICTIONARY commitment defines specific terms and their meanings that the agent should use correctly
+     * in its reasoning and responses. This ensures consistent terminology usage.
+     *
+     * Key features:
+     * - Multiple DICTIONARY commitments are automatically merged into one
+     * - Content is placed in a dedicated section of the system message
+     * - Terms and definitions are stored in metadata.DICTIONARY for debugging
+     * - Agent should use the defined terms correctly in responses
+     *
+     * Example usage in agent source:
+     *
+     * ```book
+     * Legal Assistant
+     *
+     * PERSONA You are a knowledgeable legal assistant
+     * DICTIONARY Misdemeanor is a minor wrongdoing or criminal offense
+     * DICTIONARY Felony is a serious crime usually punishable by imprisonment for more than one year
+     * DICTIONARY Tort is a civil wrong that causes harm or loss to another person, leading to legal liability
+     * ```
+     *
+     * @private [🪔] Maybe export the commitments through some package
+     */
+    class DictionaryCommitmentDefinition extends BaseCommitmentDefinition {
+        constructor() {
+            super('DICTIONARY');
+        }
+        /**
+         * Short one-line description of DICTIONARY.
+         */
+        get description() {
+            return 'Define terms and their meanings for consistent terminology usage.';
+        }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '📚';
+        }
+        /**
+         * Markdown documentation for DICTIONARY commitment.
+         */
+        get documentation() {
+            return spaceTrim$1.spaceTrim(`
+            # DICTIONARY
+
+            Defines specific terms and their meanings that the agent should use correctly in reasoning and responses.
+
+            ## Key aspects
+
+            - Multiple \`DICTIONARY\` commitments are merged together.
+            - Terms are defined in the format: "Term is definition"
+            - The agent should use these terms consistently in responses.
+            - Definitions help ensure accurate and consistent terminology.
+
+            ## Examples
+
+            \`\`\`book
+            Legal Assistant
+
+            PERSONA You are a knowledgeable legal assistant specializing in criminal law
+            DICTIONARY Misdemeanor is a minor wrongdoing or criminal offense
+            DICTIONARY Felony is a serious crime usually punishable by imprisonment for more than one year
+            DICTIONARY Tort is a civil wrong that causes harm or loss to another person, leading to legal liability
+            \`\`\`
+
+            \`\`\`book
+            Medical Assistant
+
+            PERSONA You are a helpful medical assistant
+            DICTIONARY Hypertension is persistently high blood pressure
+            DICTIONARY Diabetes is a chronic condition that affects how the body processes blood sugar
+            DICTIONARY Vaccine is a biological preparation that provides active immunity to a particular disease
+            \`\`\`
+        `);
+        }
+        applyToAgentModelRequirements(requirements, content) {
+            var _a;
+            const trimmedContent = content.trim();
+            if (!trimmedContent) {
+                return requirements;
+            }
+            // Get existing dictionary entries from metadata
+            const existingDictionary = ((_a = requirements.metadata) === null || _a === void 0 ? void 0 : _a.DICTIONARY) || '';
+            // Merge the new dictionary entry with existing entries
+            const mergedDictionary = existingDictionary
+                ? `${existingDictionary}\n${trimmedContent}`
+                : trimmedContent;
+            // Store the merged dictionary in metadata for debugging and inspection
+            const updatedMetadata = {
+                ...requirements.metadata,
+                DICTIONARY: mergedDictionary,
+            };
+            // Create the dictionary section for the system message
+            // Format: "# DICTIONARY\nTerm: definition\nTerm: definition..."
+            const dictionarySection = `# DICTIONARY\n${mergedDictionary}`;
+            return {
+                ...this.appendToSystemMessage(requirements, dictionarySection),
+                metadata: updatedMetadata,
+            };
+        }
+    }
+    /**
+     * Note: [💞] Ignore a discrepancy between file name and entity name
+     */
+
     /**
      * FORMAT commitment definition
      *
@@ -5995,6 +6030,7 @@
         new DeleteCommitmentDefinition('CANCEL'),
         new DeleteCommitmentDefinition('DISCARD'),
         new DeleteCommitmentDefinition('REMOVE'),
+        new DictionaryCommitmentDefinition(),
         new OpenCommitmentDefinition(),
         new ClosedCommitmentDefinition(),
         new UseBrowserCommitmentDefinition(),
@@ -6035,17 +6071,64 @@
             };
         }
         const lines = agentSource.split('\n');
-        const agentName = (((_a = lines[0]) === null || _a === void 0 ? void 0 : _a.trim()) || null);
+        let agentName = null;
+        let agentNameLineIndex = -1;
+        // Find the agent name: first non-empty line that is not a commitment and not a horizontal line
+        for (let i = 0; i < lines.length; i++) {
+            const line = lines[i];
+            if (line === undefined) {
+                continue;
+            }
+            const trimmed = line.trim();
+            if (!trimmed) {
+                continue;
+            }
+            const isHorizontal = HORIZONTAL_LINE_PATTERN.test(line);
+            if (isHorizontal) {
+                continue;
+            }
+            let isCommitment = false;
+            for (const definition of COMMITMENT_REGISTRY) {
+                const typeRegex = definition.createTypeRegex();
+                const match = typeRegex.exec(trimmed);
+                if (match && ((_a = match.groups) === null || _a === void 0 ? void 0 : _a.type)) {
+                    isCommitment = true;
+                    break;
+                }
+            }
+            if (!isCommitment) {
+                agentName = trimmed;
+                agentNameLineIndex = i;
+                break;
+            }
+        }
         const commitments = [];
         const nonCommitmentLines = [];
-        // Always add the first line (agent name) to non-commitment lines
-        if (lines[0] !== undefined) {
-            nonCommitmentLines.push(lines[0]);
+        // Add lines before agentName that are horizontal lines (they are non-commitment)
+        for (let i = 0; i < agentNameLineIndex; i++) {
+            const line = lines[i];
+            if (line === undefined) {
+                continue;
+            }
+            const trimmed = line.trim();
+            if (!trimmed) {
+                continue;
+            }
+            const isHorizontal = HORIZONTAL_LINE_PATTERN.test(line);
+            if (isHorizontal) {
+                nonCommitmentLines.push(line);
+            }
+            // Note: Commitments before agentName are not added to nonCommitmentLines
+        }
+        // Add the agent name line to non-commitment lines
+        if (agentNameLineIndex >= 0) {
+            nonCommitmentLines.push(lines[agentNameLineIndex]);
         }
         // Parse commitments with multiline support
         let currentCommitment = null;
-        // Process lines starting from the second line (skip agent name)
-        for (let i = 1; i < lines.length; i++) {
+        // Process lines starting from after the agent name line
+        const startIndex = agentNameLineIndex >= 0 ? agentNameLineIndex + 1 : 0;
+        for (let i = startIndex; i < lines.length; i++) {
             const line = lines[i];
             if (line === undefined) {
                 continue;
@@ -6252,10 +6335,6 @@
             const metaType = normalizeTo_camelCase(metaTypeRaw);
             meta[metaType] = spaceTrim__default["default"](commitment.content.substring(metaTypeRaw.length));
         }
-        // Generate gravatar fallback if no meta image specified
-        if (!meta.image) {
-            meta.image = generatePlaceholderAgentProfileImageUrl(parseResult.agentName || '!!');
-        }
         // Generate fullname fallback if no meta fullname specified
         if (!meta.fullname) {
             meta.fullname = parseResult.agentName || createDefaultAgentName(agentSource);
@@ -6267,6 +6346,7 @@
         return {
             agentName: normalizeAgentName(parseResult.agentName || createDefaultAgentName(agentSource)),
             agentHash,
+            permanentId: meta.id,
             personaDescription,
             initialMessage,
             meta,