@promptbook/utils 0.103.0-9 → 0.104.0-0

package/esm/typings/src/commitments/MESSAGE/AgentMessageCommitmentDefinition.d.ts

@@ -0,0 +1,32 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * 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
+ */
+export declare class AgentMessageCommitmentDefinition extends BaseCommitmentDefinition<'AGENT MESSAGE'> {
+    constructor();
+    /**
+     * Short one-line description of AGENT MESSAGE.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for AGENT MESSAGE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}

package/esm/typings/src/commitments/MESSAGE/InitialMessageCommitmentDefinition.d.ts

@@ -0,0 +1,32 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * 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
+ */
+export declare class InitialMessageCommitmentDefinition extends BaseCommitmentDefinition<'INITIAL MESSAGE'> {
+    constructor();
+    /**
+     * Short one-line description of INITIAL MESSAGE.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for INITIAL MESSAGE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}

package/esm/typings/src/{book-2.0/commitments → commitments}/MESSAGE/MESSAGE.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * MESSAGE commitment definition
@@ -24,6 +24,10 @@ export declare class MessageCommitmentDefinition extends BaseCommitmentDefinitio
      * Short one-line description of MESSAGE.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for MESSAGE commitment.
      */

package/esm/typings/src/commitments/MESSAGE/UserMessageCommitmentDefinition.d.ts

@@ -0,0 +1,32 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * 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
+ */
+export declare class UserMessageCommitmentDefinition extends BaseCommitmentDefinition<'USER MESSAGE'> {
+    constructor();
+    /**
+     * Short one-line description of USER MESSAGE.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USER MESSAGE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}

package/esm/typings/src/{book-2.0/commitments → commitments}/META/META.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * META commitment definition
@@ -32,6 +32,10 @@ export declare class MetaCommitmentDefinition extends BaseCommitmentDefinition<`
      * Short one-line description of META commitments.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for META commitment.
      */

package/esm/typings/src/commitments/META_COLOR/META_COLOR.d.ts

@@ -0,0 +1,48 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * META COLOR commitment definition
+ *
+ * The META COLOR commitment sets the agent's accent color.
+ * This commitment is special because it doesn't affect the system message,
+ * but is handled separately in the parsing logic.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * META COLOR #ff0000
+ * META COLOR #00ff00
+ * ```
+ *
+ * You can also specify multiple colors separated by comma:
+ *
+ * ```book
+ * META COLOR #ff0000, #00ff00, #0000ff
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class MetaColorCommitmentDefinition extends BaseCommitmentDefinition<'META COLOR'> {
+    constructor();
+    /**
+     * Short one-line description of META COLOR.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for META COLOR commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Extracts the profile color from the content
+     * This is used by the parsing logic
+     */
+    extractProfileColor(content: string): string | null;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/META_FONT/META_FONT.d.ts

@@ -0,0 +1,42 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * META FONT commitment definition
+ *
+ * The META FONT commitment sets the agent's font.
+ * This commitment is special because it doesn't affect the system message,
+ * but is handled separately in the parsing logic.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * META FONT Poppins, Arial, sans-serif
+ * META FONT Roboto
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class MetaFontCommitmentDefinition extends BaseCommitmentDefinition<'META FONT'> {
+    constructor();
+    /**
+     * Short one-line description of META FONT.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for META FONT commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Extracts the font from the content
+     * This is used by the parsing logic
+     */
+    extractProfileFont(content: string): string | null;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/{book-2.0/commitments → commitments}/META_IMAGE/META_IMAGE.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * META IMAGE commitment definition
@@ -22,6 +22,10 @@ export declare class MetaImageCommitmentDefinition extends BaseCommitmentDefinit
      * Short one-line description of META IMAGE.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for META IMAGE commitment.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/META_LINK/META_LINK.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * META LINK commitment definition
@@ -30,6 +30,10 @@ export declare class MetaLinkCommitmentDefinition extends BaseCommitmentDefiniti
      * Short one-line description of META LINK.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for META LINK commitment.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/MODEL/MODEL.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * MODEL commitment definition
@@ -31,6 +31,10 @@ export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<
      * Short one-line description of MODEL.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for MODEL commitment.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/NOTE/NOTE.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * NOTE commitment definition
@@ -32,6 +32,10 @@ export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition<'
      * Short one-line description of NOTE.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for NOTE commitment.
      */

package/esm/typings/src/commitments/OPEN/OPEN.d.ts

@@ -0,0 +1,35 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * OPEN commitment definition
+ *
+ * The OPEN commitment specifies that the agent can be modified by conversation.
+ * This is the default behavior.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * OPEN
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class OpenCommitmentDefinition extends BaseCommitmentDefinition<'OPEN'> {
+    constructor();
+    /**
+     * Short one-line description of OPEN.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for OPEN commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, _content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/{book-2.0/commitments → commitments}/PERSONA/PERSONA.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * PERSONA commitment definition
@@ -29,6 +29,10 @@ export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinitio
      * Short one-line description of PERSONA.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for PERSONA commitment.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/RULE/RULE.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * RULE commitment definition
@@ -21,6 +21,10 @@ export declare class RuleCommitmentDefinition extends BaseCommitmentDefinition<'
      * Short one-line description of RULE/RULES.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for RULE/RULES commitment.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/SAMPLE/SAMPLE.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * SAMPLE commitment definition
@@ -21,6 +21,10 @@ export declare class SampleCommitmentDefinition extends BaseCommitmentDefinition
      * Short one-line description of SAMPLE/EXAMPLE.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for SAMPLE/EXAMPLE commitment.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/SCENARIO/SCENARIO.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * SCENARIO commitment definition
@@ -23,6 +23,10 @@ export declare class ScenarioCommitmentDefinition extends BaseCommitmentDefiniti
      * Short one-line description of SCENARIO.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for SCENARIO commitment.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/STYLE/STYLE.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * STYLE commitment definition
@@ -21,6 +21,10 @@ export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition<
      * Short one-line description of STYLE.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for STYLE commitment.
      */

package/esm/typings/src/commitments/USE/USE.d.ts

@@ -0,0 +1,53 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * USE commitment definition
+ *
+ * The USE commitment indicates that the agent should utilize specific tools or capabilities
+ * to access and interact with external systems when necessary.
+ *
+ * Supported USE types:
+ * - USE BROWSER: Enables the agent to use a web browser tool
+ * - USE SEARCH ENGINE (future): Enables search engine access
+ * - USE FILE SYSTEM (future): Enables file system operations
+ * - USE MCP (future): Enables MCP server connections
+ *
+ * The content following the USE commitment is ignored (similar to NOTE).
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE BROWSER
+ * USE SEARCH ENGINE
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class UseCommitmentDefinition extends BaseCommitmentDefinition<`USE${string}`> {
+    constructor();
+    /**
+     * Short one-line description of USE commitments.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Extracts the tool type from the USE commitment
+     * This is used by the parsing logic
+     */
+    extractToolType(content: string): string | null;
+    /**
+     * Checks if this is a known USE type
+     */
+    isKnownUseType(useType: string): boolean;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/USE_BROWSER/USE_BROWSER.d.ts

@@ -0,0 +1,42 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * USE BROWSER commitment definition
+ *
+ * The `USE BROWSER` commitment indicates that the agent should utilize a web browser tool
+ * to access and retrieve up-to-date information from the internet when necessary.
+ *
+ * The content following `USE BROWSER` is ignored (similar to NOTE).
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE BROWSER
+ * USE BROWSER This will be ignored
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class UseBrowserCommitmentDefinition extends BaseCommitmentDefinition<'USE BROWSER'> {
+    constructor();
+    /**
+     * The `USE BROWSER` commitment is standalone.
+     */
+    get requiresContent(): boolean;
+    /**
+     * Short one-line description of USE BROWSER.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USE BROWSER commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/USE_BROWSER/USE_BROWSER.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/commitments/USE_MCP/USE_MCP.d.ts

@@ -0,0 +1,37 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * USE MCP commitment definition
+ *
+ * The `USE MCP` commitment allows to specify an MCP server URL which the agent will connect to
+ * for retrieving additional instructions and actions.
+ *
+ * The content following `USE MCP` is the URL of the MCP server.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE MCP http://mcp-server-url.com
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class UseMcpCommitmentDefinition extends BaseCommitmentDefinition<'USE MCP'> {
+    constructor();
+    /**
+     * Short one-line description of USE MCP.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USE MCP commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts

@@ -0,0 +1,38 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * USE SEARCH ENGINE commitment definition
+ *
+ * The `USE SEARCH ENGINE` commitment indicates that the agent should utilize a search engine tool
+ * to access and retrieve up-to-date information from the internet when necessary.
+ *
+ * The content following `USE SEARCH ENGINE` is ignored (similar to NOTE).
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE SEARCH ENGINE
+ * USE SEARCH ENGINE This will be ignored
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition<'USE SEARCH ENGINE'> {
+    constructor();
+    /**
+     * Short one-line description of USE SEARCH ENGINE.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USE SEARCH ENGINE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/{book-2.0/commitments → commitments}/_base/BaseCommitmentDefinition.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import type { CommitmentDefinition } from './CommitmentDefinition';
 /**
  * Base implementation of CommitmentDefinition that provides common functionality
@@ -8,12 +8,24 @@ import type { CommitmentDefinition } from './CommitmentDefinition';
  */
 export declare abstract class BaseCommitmentDefinition<TBookCommitment extends string> implements CommitmentDefinition {
     readonly type: TBookCommitment;
-    constructor(type: TBookCommitment);
+    readonly aliases: string[];
+    constructor(type: TBookCommitment, aliases?: string[]);
     /**
      * Short one-line markdown description; concise, may use inline **markdown**.
      * Must be implemented by each concrete commitment.
      */
     abstract get description(): string;
+    /**
+     * Whether this commitment requires content.
+     * If true, regex will match only if there is content after the commitment keyword.
+     * If false, regex will match even if there is no content.
+     */
+    get requiresContent(): boolean;
+    /**
+     * Icon for this commitment.
+     * It should be a single emoji.
+     */
+    abstract get icon(): string;
     /**
      * Human-readable markdown documentation for this commitment, available at runtime.
      * Must be implemented by each concrete commitment.

package/esm/typings/src/{book-2.0/commitments → commitments}/_base/CommitmentDefinition.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 /**
  * Definition of a commitment that can be applied to agent model requirements
  *
@@ -16,6 +16,11 @@ export type CommitmentDefinition = {
      * Keep it concise; may use inline markdown like **bold** or *italic*.
      */
     readonly description: string;
+    /**
+     * Icon for this commitment.
+     * It should be a single emoji.
+     */
+    readonly icon: string;
     /**
      * Human-readable markdown documentation for this commitment.
      * Should explain what the commitment does and include example usage.

package/esm/typings/src/{book-2.0/commitments → commitments}/_base/NotYetImplementedCommitmentDefinition.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from './BaseCommitmentDefinition';
 /**
  * Placeholder commitment definition for commitments that are not yet implemented
@@ -14,6 +14,10 @@ export declare class NotYetImplementedCommitmentDefinition<TBookCommitment exten
      * Short one-line description of a placeholder commitment.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation available at runtime.
      */