@promptbook/core 0.103.0-9 → 0.103.0

package/esm/typings/src/commands/_common/types/CommandParser.d.ts

@@ -1,10 +1,9 @@
 import type { SetOptional, WritableDeep } from 'type-fest';
 import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../../pipeline/PipelineJson/TaskJson';
-import type { string_markdown_text } from '../../../types/typeAliases';
-import type { string_name } from '../../../types/typeAliases';
-import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
+import type { string_markdown_text, string_name, string_promptbook_documentation_url } from '../../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
+import type { $side_effect } from '../../../utils/organization/$side_effect';
 import type { ___and___ } from '../../../utils/organization/___and___';
 import type { CommandUsagePlace } from './CommandUsagePlaces';
 /**
@@ -98,7 +97,7 @@ export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonComm
      *
      * Note: `$` is used to indicate that this function mutates given `pipelineJson`
      */
-    $applyToPipelineJson(command: TCommand, $pipelineJson: $PipelineJson): void;
+    $applyToPipelineJson(command: TCommand, $pipelineJson: $PipelineJson): $side_effect;
     /**
      * Reads the command from the `PipelineJson`
      *
@@ -126,7 +125,7 @@ export type PipelineTaskCommandParser<TCommand extends CommandBase> = CommonComm
      *
      * Note: `$` is used to indicate that this function mutates given `taskJson` and/or `pipelineJson`
      */
-    $applyToTaskJson(command: TCommand, $taskJson: $TaskJson, $pipelineJson: $PipelineJson): void;
+    $applyToTaskJson(command: TCommand, $taskJson: $TaskJson, $pipelineJson: $PipelineJson): $side_effect;
     /**
      * Reads the command from the `TaskJson`
      *

package/esm/typings/src/{book-2.0/commitments → commitments}/ACTION/ACTION.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';
 /**
  * ACTION commitment definition
@@ -21,6 +21,10 @@ export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition
      * Short one-line description of ACTION.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for ACTION commitment.
      */

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

@@ -0,0 +1,39 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * CLOSED commitment definition
+ *
+ * The CLOSED commitment specifies that the agent CANNOT be modified by conversation.
+ * It prevents the agent from learning from interactions and updating its source code.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * CLOSED
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class ClosedCommitmentDefinition extends BaseCommitmentDefinition<'CLOSED'> {
+    constructor();
+    /**
+     * The `CLOSED` commitment is standalone.
+     */
+    get requiresContent(): boolean;
+    /**
+     * Short one-line description of CLOSED.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for CLOSED 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/CLOSED/CLOSED.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: !!!! Must be last commitment to take effect
+ */

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

@@ -0,0 +1,28 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * COMPONENT commitment definition
+ *
+ * The COMPONENT commitment defines a UI component that the agent can render in the chat.
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class ComponentCommitmentDefinition extends BaseCommitmentDefinition<'COMPONENT'> {
+    constructor();
+    /**
+     * Short one-line description of COMPONENT.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for COMPONENT 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}/DELETE/DELETE.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';
 /**
  * DELETE commitment definition
@@ -24,6 +24,10 @@ export declare class DeleteCommitmentDefinition extends BaseCommitmentDefinition
      * Short one-line description of DELETE/CANCEL/DISCARD/REMOVE.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for DELETE commitment.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/FORMAT/FORMAT.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';
 /**
  * FORMAT commitment definition
@@ -22,6 +22,10 @@ export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition
      * Short one-line description of FORMAT.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for FORMAT commitment.
      */

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

@@ -0,0 +1,34 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * FROM commitment definition
+ *
+ * The FROM commitment tells the agent that its `agentSource` is inherited from another agent.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * FROM https://s6.ptbk.io/benjamin-white
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class FromCommitmentDefinition extends BaseCommitmentDefinition<'FROM'> {
+    constructor(type?: 'FROM');
+    /**
+     * Short one-line description of FROM.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for FROM 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}/GOAL/GOAL.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';
 /**
  * GOAL commitment definition
@@ -22,6 +22,10 @@ export declare class GoalCommitmentDefinition extends BaseCommitmentDefinition<'
      * Short one-line description of GOAL.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for GOAL commitment.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/KNOWLEDGE/KNOWLEDGE.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';
 /**
  * KNOWLEDGE commitment definition
@@ -24,15 +24,15 @@ export declare class KnowledgeCommitmentDefinition extends BaseCommitmentDefinit
      * Short one-line description of KNOWLEDGE.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for KNOWLEDGE commitment.
      */
     get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
-    /**
-     * Check if content is a URL
-     */
-    private isUrl;
 }
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name

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

@@ -0,0 +1,35 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * LANGUAGE commitment definition
+ *
+ * The LANGUAGE/LANGUAGES commitment specifies the language(s) the agent should use in its responses.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * LANGUAGE English
+ * LANGUAGE French, English and Czech
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class LanguageCommitmentDefinition extends BaseCommitmentDefinition<'LANGUAGE' | 'LANGUAGES'> {
+    constructor(type?: 'LANGUAGE' | 'LANGUAGES');
+    /**
+     * Short one-line description of LANGUAGE/LANGUAGES.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for LANGUAGE/LANGUAGES 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}/MEMORY/MEMORY.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';
 /**
  * MEMORY commitment definition
@@ -23,6 +23,10 @@ export declare class MemoryCommitmentDefinition extends BaseCommitmentDefinition
      * Short one-line description of MEMORY.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for MEMORY commitment.
      */

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.
      */