@promptbook/browser 0.103.0-52 → 0.103.0-54

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-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
@@ -2783,6 +2783,12 @@ class ActionCommitmentDefinition extends BaseCommitmentDefinition {
     get description() {
         return 'Define agent capabilities and actions it can perform.';
     }
+    /**
+     * Icon for this commitment.
+     */
+    get icon() {
+        return '⚡';
+    }
     /**
      * Markdown documentation for ACTION commitment.
      */
@@ -2862,6 +2868,12 @@ class DeleteCommitmentDefinition extends BaseCommitmentDefinition {
     get description() {
         return 'Remove or **disregard** certain information, context, or previous commitments.';
     }
+    /**
+     * Icon for this commitment.
+     */
+    get icon() {
+        return '🗑️';
+    }
     /**
      * Markdown documentation for DELETE commitment.
      */
@@ -2978,6 +2990,12 @@ class FormatCommitmentDefinition extends BaseCommitmentDefinition {
     get description() {
         return 'Specify output structure or formatting requirements.';
     }
+    /**
+     * Icon for this commitment.
+     */
+    get icon() {
+        return '📜';
+    }
     /**
      * Markdown documentation for FORMAT commitment.
      */
@@ -3053,6 +3071,12 @@ class GoalCommitmentDefinition extends BaseCommitmentDefinition {
     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.
      */
@@ -3149,6 +3173,12 @@ class KnowledgeCommitmentDefinition extends BaseCommitmentDefinition {
     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.
      */
@@ -3250,6 +3280,12 @@ class MemoryCommitmentDefinition extends BaseCommitmentDefinition {
     get description() {
         return 'Remember past interactions and user **preferences** for personalized responses.';
     }
+    /**
+     * Icon for this commitment.
+     */
+    get icon() {
+        return '🧠';
+    }
     /**
      * Markdown documentation for MEMORY commitment.
      */
@@ -3324,6 +3360,83 @@ class MemoryCommitmentDefinition extends BaseCommitmentDefinition {
  * 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(`
+            # ${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
  *
@@ -3348,6 +3461,12 @@ class InitialMessageCommitmentDefinition extends BaseCommitmentDefinition {
     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.
      */
@@ -3406,6 +3525,12 @@ class MessageCommitmentDefinition extends BaseCommitmentDefinition {
     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.
      */
@@ -3488,6 +3613,73 @@ class MessageCommitmentDefinition extends BaseCommitmentDefinition {
  * 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(`
+            # ${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
  *
@@ -3524,6 +3716,12 @@ class MetaCommitmentDefinition extends BaseCommitmentDefinition {
     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.
      */
@@ -3651,6 +3849,12 @@ class MetaColorCommitmentDefinition extends BaseCommitmentDefinition {
     get description() {
         return "Set the agent's accent color.";
     }
+    /**
+     * Icon for this commitment.
+     */
+    get icon() {
+        return '🎨';
+    }
     /**
      * Markdown documentation for META COLOR commitment.
      */
@@ -3729,6 +3933,12 @@ class MetaImageCommitmentDefinition extends BaseCommitmentDefinition {
     get description() {
         return "Set the agent's profile image URL.";
     }
+    /**
+     * Icon for this commitment.
+     */
+    get icon() {
+        return '🖼️';
+    }
     /**
      * Markdown documentation for META IMAGE commitment.
      */
@@ -3819,6 +4029,12 @@ class ModelCommitmentDefinition extends BaseCommitmentDefinition {
     get description() {
         return 'Enforce AI model requirements including name and technical parameters.';
     }
+    /**
+     * Icon for this commitment.
+     */
+    get icon() {
+        return '⚙️';
+    }
     /**
      * Markdown documentation for MODEL commitment.
      */
@@ -4054,6 +4270,12 @@ class NoteCommitmentDefinition extends BaseCommitmentDefinition {
     get description() {
         return 'Add developer-facing notes without changing behavior or output.';
     }
+    /**
+     * Icon for this commitment.
+     */
+    get icon() {
+        return '📝';
+    }
     /**
      * Markdown documentation for NOTE commitment.
      */
@@ -4156,6 +4378,12 @@ class PersonaCommitmentDefinition extends BaseCommitmentDefinition {
     get description() {
         return 'Define who the agent is: background, expertise, and personality.';
     }
+    /**
+     * Icon for this commitment.
+     */
+    get icon() {
+        return '👤';
+    }
     /**
      * Markdown documentation for PERSONA commitment.
      */
@@ -4283,6 +4511,12 @@ class RuleCommitmentDefinition extends BaseCommitmentDefinition {
     get description() {
         return 'Add behavioral rules the agent must follow.';
     }
+    /**
+     * Icon for this commitment.
+     */
+    get icon() {
+        return '⚖️';
+    }
     /**
      * Markdown documentation for RULE/RULES commitment.
      */
@@ -4359,6 +4593,12 @@ class SampleCommitmentDefinition extends BaseCommitmentDefinition {
     get description() {
         return 'Provide example responses to guide behavior.';
     }
+    /**
+     * Icon for this commitment.
+     */
+    get icon() {
+        return '🔍';
+    }
     /**
      * Markdown documentation for SAMPLE/EXAMPLE commitment.
      */
@@ -4436,6 +4676,12 @@ class ScenarioCommitmentDefinition extends BaseCommitmentDefinition {
     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.
      */
@@ -4552,6 +4798,12 @@ class StyleCommitmentDefinition extends BaseCommitmentDefinition {
     get description() {
         return 'Control the tone and writing style of responses.';
     }
+    /**
+     * Icon for this commitment.
+     */
+    get icon() {
+        return '🖋️';
+    }
     /**
      * Markdown documentation for STYLE commitment.
      */
@@ -4621,6 +4873,12 @@ class NotYetImplementedCommitmentDefinition extends BaseCommitmentDefinition {
     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.
      */
@@ -4701,6 +4959,8 @@ const COMMITMENT_REGISTRY = [
     new GoalCommitmentDefinition('GOAL'),
     new GoalCommitmentDefinition('GOALS'),
     new InitialMessageCommitmentDefinition(),
+    new UserMessageCommitmentDefinition(),
+    new AgentMessageCommitmentDefinition(),
     new MessageCommitmentDefinition('MESSAGE'),
     new MessageCommitmentDefinition('MESSAGES'),
     new ScenarioCommitmentDefinition('SCENARIO'),