@promptbook/browser 0.103.0-52 → 0.103.0-54

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-52';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-54';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2787,6 +2787,12 @@
         get description() {
             return 'Define agent capabilities and actions it can perform.';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '⚡';
+        }
         /**
          * Markdown documentation for ACTION commitment.
          */
@@ -2866,6 +2872,12 @@
         get description() {
             return 'Remove or **disregard** certain information, context, or previous commitments.';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '🗑️';
+        }
         /**
          * Markdown documentation for DELETE commitment.
          */
@@ -2982,6 +2994,12 @@
         get description() {
             return 'Specify output structure or formatting requirements.';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '📜';
+        }
         /**
          * Markdown documentation for FORMAT commitment.
          */
@@ -3057,6 +3075,12 @@
         get description() {
             return 'Define main **goals** the AI assistant should achieve, with later goals having higher priority.';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '🎯';
+        }
         /**
          * Markdown documentation for GOAL commitment.
          */
@@ -3153,6 +3177,12 @@
         get description() {
             return 'Add domain **knowledge** via direct text or external sources (RAG).';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '🧠';
+        }
         /**
          * Markdown documentation for KNOWLEDGE commitment.
          */
@@ -3254,6 +3284,12 @@
         get description() {
             return 'Remember past interactions and user **preferences** for personalized responses.';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '🧠';
+        }
         /**
          * Markdown documentation for MEMORY commitment.
          */
@@ -3328,6 +3364,83 @@
      * Note: [💞] Ignore a discrepancy between file name and entity name
      */
 
+    /**
+     * AGENT MESSAGE commitment definition
+     *
+     * The AGENT MESSAGE commitment defines a message from the agent in the conversation history.
+     * It is used to pre-fill the chat with a conversation history or to provide few-shot examples.
+     *
+     * Example usage in agent source:
+     *
+     * ```book
+     * AGENT MESSAGE What seems to be the issue?
+     * ```
+     *
+     * @private [🪔] Maybe export the commitments through some package
+     */
+    class AgentMessageCommitmentDefinition extends BaseCommitmentDefinition {
+        constructor() {
+            super('AGENT MESSAGE');
+        }
+        /**
+         * Short one-line description of AGENT MESSAGE.
+         */
+        get description() {
+            return 'Defines a **message from the agent** in the conversation history.';
+        }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '🤖';
+        }
+        /**
+         * Markdown documentation for AGENT MESSAGE commitment.
+         */
+        get documentation() {
+            return spaceTrim.spaceTrim(`
+            # ${this.type}
+
+            Defines a message from the agent in the conversation history. This is used to pre-fill the chat with a conversation history or to provide few-shot examples.
+
+            ## Key aspects
+
+            - Represents a message sent by the agent.
+            - Used for setting up conversation context.
+            - Can be used in conjunction with USER MESSAGE.
+
+            ## Examples
+
+            \`\`\`book
+            Conversation History
+
+            USER MESSAGE Hello, I have a problem.
+            AGENT MESSAGE What seems to be the issue?
+            USER MESSAGE My computer is not starting.
+            \`\`\`
+        `);
+        }
+        applyToAgentModelRequirements(requirements, content) {
+            // AGENT MESSAGE is for UI display purposes / conversation history construction
+            // and typically doesn't need to be added to the system prompt or model requirements directly.
+            // It is extracted separately for the chat interface.
+            var _a;
+            const pendingUserMessage = (_a = requirements.metadata) === null || _a === void 0 ? void 0 : _a.pendingUserMessage;
+            if (pendingUserMessage) {
+                const newSample = { question: pendingUserMessage, answer: content };
+                const newSamples = [...(requirements.samples || []), newSample];
+                const newMetadata = { ...requirements.metadata };
+                delete newMetadata.pendingUserMessage;
+                return {
+                    ...requirements,
+                    samples: newSamples,
+                    metadata: newMetadata,
+                };
+            }
+            return requirements;
+        }
+    }
+
     /**
      * INITIAL MESSAGE commitment definition
      *
@@ -3352,6 +3465,12 @@
         get description() {
             return 'Defines the **initial message** shown to the user when the chat starts.';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '👋';
+        }
         /**
          * Markdown documentation for INITIAL MESSAGE commitment.
          */
@@ -3410,6 +3529,12 @@
         get description() {
             return 'Include actual **messages** the AI assistant has sent during conversation history.';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '💬';
+        }
         /**
          * Markdown documentation for MESSAGE commitment.
          */
@@ -3492,6 +3617,73 @@
      * Note: [💞] Ignore a discrepancy between file name and entity name
      */
 
+    /**
+     * USER MESSAGE commitment definition
+     *
+     * The USER MESSAGE commitment defines a message from the user in the conversation history.
+     * It is used to pre-fill the chat with a conversation history or to provide few-shot examples.
+     *
+     * Example usage in agent source:
+     *
+     * ```book
+     * USER MESSAGE Hello, I have a problem.
+     * ```
+     *
+     * @private [🪔] Maybe export the commitments through some package
+     */
+    class UserMessageCommitmentDefinition extends BaseCommitmentDefinition {
+        constructor() {
+            super('USER MESSAGE');
+        }
+        /**
+         * Short one-line description of USER MESSAGE.
+         */
+        get description() {
+            return 'Defines a **message from the user** in the conversation history.';
+        }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '🧑';
+        }
+        /**
+         * Markdown documentation for USER MESSAGE commitment.
+         */
+        get documentation() {
+            return spaceTrim.spaceTrim(`
+            # ${this.type}
+
+            Defines a message from the user in the conversation history. This is used to pre-fill the chat with a conversation history or to provide few-shot examples.
+
+            ## Key aspects
+
+            - Represents a message sent by the user.
+            - Used for setting up conversation context.
+            - Can be used in conjunction with AGENT MESSAGE.
+
+            ## Examples
+
+            \`\`\`book
+            Conversation History
+
+            USER MESSAGE Hello, I have a problem.
+            AGENT MESSAGE What seems to be the issue?
+            USER MESSAGE My computer is not starting.
+            \`\`\`
+        `);
+        }
+        applyToAgentModelRequirements(requirements, content) {
+            return {
+                ...requirements,
+                metadata: {
+                    ...requirements.metadata,
+                    pendingUserMessage: content,
+                },
+            };
+        }
+    }
+
     /**
      * META commitment definition
      *
@@ -3528,6 +3720,12 @@
         get description() {
             return 'Set meta-information about the agent (IMAGE, LINK, TITLE, DESCRIPTION, etc.).';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return 'ℹ️';
+        }
         /**
          * Markdown documentation for META commitment.
          */
@@ -3655,6 +3853,12 @@
         get description() {
             return "Set the agent's accent color.";
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '🎨';
+        }
         /**
          * Markdown documentation for META COLOR commitment.
          */
@@ -3733,6 +3937,12 @@
         get description() {
             return "Set the agent's profile image URL.";
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '🖼️';
+        }
         /**
          * Markdown documentation for META IMAGE commitment.
          */
@@ -3823,6 +4033,12 @@
         get description() {
             return 'Enforce AI model requirements including name and technical parameters.';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '⚙️';
+        }
         /**
          * Markdown documentation for MODEL commitment.
          */
@@ -4058,6 +4274,12 @@
         get description() {
             return 'Add developer-facing notes without changing behavior or output.';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '📝';
+        }
         /**
          * Markdown documentation for NOTE commitment.
          */
@@ -4160,6 +4382,12 @@
         get description() {
             return 'Define who the agent is: background, expertise, and personality.';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '👤';
+        }
         /**
          * Markdown documentation for PERSONA commitment.
          */
@@ -4287,6 +4515,12 @@
         get description() {
             return 'Add behavioral rules the agent must follow.';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '⚖️';
+        }
         /**
          * Markdown documentation for RULE/RULES commitment.
          */
@@ -4363,6 +4597,12 @@
         get description() {
             return 'Provide example responses to guide behavior.';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '🔍';
+        }
         /**
          * Markdown documentation for SAMPLE/EXAMPLE commitment.
          */
@@ -4440,6 +4680,12 @@
         get description() {
             return 'Define specific **situations** or contexts for AI responses, with later scenarios having higher priority.';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '🎭';
+        }
         /**
          * Markdown documentation for SCENARIO commitment.
          */
@@ -4556,6 +4802,12 @@
         get description() {
             return 'Control the tone and writing style of responses.';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '🖋️';
+        }
         /**
          * Markdown documentation for STYLE commitment.
          */
@@ -4625,6 +4877,12 @@
         get description() {
             return 'Placeholder commitment that appends content verbatim to the system message.';
         }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '🚧';
+        }
         /**
          * Markdown documentation available at runtime.
          */
@@ -4705,6 +4963,8 @@
         new GoalCommitmentDefinition('GOAL'),
         new GoalCommitmentDefinition('GOALS'),
         new InitialMessageCommitmentDefinition(),
+        new UserMessageCommitmentDefinition(),
+        new AgentMessageCommitmentDefinition(),
         new MessageCommitmentDefinition('MESSAGE'),
         new MessageCommitmentDefinition('MESSAGES'),
         new ScenarioCommitmentDefinition('SCENARIO'),