@promptbook/editable 0.101.0-2 → 0.101.0-20

package/esm/typings/src/book-2.0/agent-source/AgentBasicInformation.d.ts

@@ -1,4 +1,28 @@
 import type { string_agent_name, string_url_image } from '../../types/typeAliases';
+/**
+ * Unified parameter representation that supports two different notations:
+ * 1. @Parameter - single word parameter starting with @
+ * 2. {parameterName} or {parameter with multiple words} or {parameterName: description text}
+ * Both notations represent the same syntax feature - parameters
+ */
+export type BookParameter = {
+    /**
+     * The raw text of the parameter as it appears in the source
+     */
+    text: string;
+    /**
+     * The notation used for this parameter
+     */
+    notation: 'at' | 'brace';
+    /**
+     * The parameter name (without @ or {})
+     */
+    name: string;
+    /**
+     * Optional description for {parameterName: description} notation
+     */
+    description?: string;
+};
 export type AgentBasicInformation = {
     /**
      * Name of the agent
@@ -11,10 +35,24 @@ export type AgentBasicInformation = {
      */
     personaDescription: string | null;
     /**
-     * Optional profile image URL
-     * This is the line starting with "META IMAGE"
+     * Metadata commitments parsed from META lines
+     * Each META commitment has the format "META TYPE content"
+     * When there are multiple meta commitments of the same type, later overrides earlier
+     */
+    meta: {
+        image?: string_url_image;
+        link?: string;
+        title?: string;
+        description?: string;
+        [key: string]: string | undefined;
+    };
+    /**
+     * Parameters found in the agent source
+     * Supports two different notations for the same syntax feature:
+     * - @Parameter (single word parameter starting with @)
+     * - {parameterName} or {parameter with multiple words} or {parameterName: description text}
      */
-    profileImageUrl: string_url_image;
+    parameters: BookParameter[];
 };
 /**
  * TODO: [🕛] Unite `AgentBasicInformation`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`

package/esm/typings/src/book-2.0/agent-source/AgentModelRequirements.d.ts

@@ -35,3 +35,6 @@ export type AgentModelRequirements = {
      */
     readonly metadata?: Record<string, TODO_any>;
 };
+/**
+ * TODO: [🐤] DRY `AgentModelRequirements` and `ModelRequirements`
+ */

package/esm/typings/src/book-2.0/agent-source/createAgentModelRequirements.d.ts

@@ -1,36 +1,18 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { string_model_name } from '../../types/typeAliases';
 import type { AgentModelRequirements } from './AgentModelRequirements';
 import type { string_book } from './string_book';
 /**
  * Creates model requirements for an agent based on its source
- * Results are cached to improve performance for repeated calls with the same agentSource and modelName
  *
  * There are 2 similar functions:
  * - `parseAgentSource` which is a lightweight parser for agent source, it parses basic information and its purpose is to be quick and synchronous. The commitments there are hardcoded.
- * - `createAgentModelRequirements` which is an asynchronous function that creates model requirements it applies each commitment one by one and works asynchronously.
+ * - `createAgentModelRequirements` which is an asynchronous function that creates model requirements it applies each commitment one by one and works asynchronous.
  *
  * @public exported from `@promptbook/core`
  */
-export declare function createAgentModelRequirements(agentSource: string_book, modelName?: string_model_name): Promise<AgentModelRequirements>;
-/**
- * Clears the cache for createAgentModelRequirements
- * Useful when agent sources are updated and cached results should be invalidated
- *
- * @private
- */
-export declare function clearAgentModelRequirementsCache(): void;
-/**
- * Removes cache entries for a specific agent source (all model variants)
- * @param agentSource The agent source to remove from cache
- * @private
- */
-export declare function invalidateAgentModelRequirementsCache(agentSource: string_book): void;
-/**
- * Gets the current cache size (for debugging/monitoring)
- *
- * @private
- */
-export declare function getAgentModelRequirementsCacheSize(): number;
+export declare function createAgentModelRequirements(agentSource: string_book, modelName?: string_model_name, availableModels?: readonly AvailableModel[], llmTools?: LlmExecutionTools): Promise<AgentModelRequirements>;
 /**
  * Extracts MCP servers from agent source
  *

package/esm/typings/src/book-2.0/agent-source/createAgentModelRequirementsWithCommitments.d.ts

@@ -6,31 +6,6 @@ import type { string_book } from './string_book';
  * This function uses a reduce-like pattern where each commitment applies its changes
  * to build the final requirements starting from a basic empty model
  *
- * @private - TODO: [🧠] Maybe should be public?
+ * @public exported from `@promptbook/core`
  */
 export declare function createAgentModelRequirementsWithCommitments(agentSource: string_book, modelName?: string_model_name): Promise<AgentModelRequirements>;
-/**
- * Cached version of createAgentModelRequirementsWithCommitments
- * This maintains the same caching behavior as the original function
- *
- * @private
- */
-export declare function createAgentModelRequirementsWithCommitmentsCached(agentSource: string_book, modelName?: string_model_name): Promise<AgentModelRequirements>;
-/**
- * Clears the cache for createAgentModelRequirementsWithCommitments
- *
- * @private
- */
-export declare function clearAgentModelRequirementsWithCommitmentsCache(): void;
-/**
- * Removes cache entries for a specific agent source
- *
- * @private
- */
-export declare function invalidateAgentModelRequirementsWithCommitmentsCache(agentSource: string_book): void;
-/**
- * Gets the current cache size
- *
- * @private
- */
-export declare function getAgentModelRequirementsWithCommitmentsCacheSize(): number;

package/esm/typings/src/book-2.0/agent-source/parseParameters.d.ts

@@ -0,0 +1,13 @@
+import type { BookParameter } from './AgentBasicInformation';
+/**
+ * Parses parameters from text using both supported notations:
+ * 1. @Parameter - single word parameter starting with @
+ * 2. {parameterName} or {parameter with multiple words} or {parameterName: description text}
+ *
+ * Both notations represent the same syntax feature - parameters
+ *
+ * @param text - Text to extract parameters from
+ * @returns Array of parsed parameters with unified representation
+ * @public exported from `@promptbook/core`
+ */
+export declare function parseParameters(text: string): BookParameter[];

package/esm/typings/src/book-2.0/commitments/ACTION/ACTION.d.ts

@@ -15,8 +15,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition<'ACTION'> {
-    constructor();
+export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition<'ACTION' | 'ACTIONS'> {
+    constructor(type?: 'ACTION' | 'ACTIONS');
     /**
      * Short one-line description of ACTION.
      */
@@ -33,6 +33,12 @@ export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition
  * @private [🪔] Maybe export the commitments through some package
  */
 export declare const ActionCommitment: ActionCommitmentDefinition;
+/**
+ * Singleton instance of the ACTIONS commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const ActionsCommitment: ActionCommitmentDefinition;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/book-2.0/commitments/DELETE/DELETE.d.ts

@@ -0,0 +1,59 @@
+import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * DELETE commitment definition
+ *
+ * The DELETE commitment (and its aliases CANCEL, DISCARD, REMOVE) is used to
+ * remove or disregard certain information or context. This can be useful for
+ * overriding previous commitments or removing unwanted behaviors.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * DELETE Previous formatting requirements
+ * CANCEL All emotional responses
+ * DISCARD Technical jargon explanations
+ * REMOVE Casual conversational style
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class DeleteCommitmentDefinition extends BaseCommitmentDefinition<'DELETE' | 'CANCEL' | 'DISCARD' | 'REMOVE'> {
+    constructor(type: 'DELETE' | 'CANCEL' | 'DISCARD' | 'REMOVE');
+    /**
+     * Short one-line description of DELETE/CANCEL/DISCARD/REMOVE.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for DELETE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instances of the DELETE commitment definitions with aliases
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const DeleteCommitment: DeleteCommitmentDefinition;
+/**
+ * Singleton instances of the DELETE commitment definitions with aliases
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const CancelCommitment: DeleteCommitmentDefinition;
+/**
+ * Singleton instances of the DELETE commitment definitions with aliases
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const DiscardCommitment: DeleteCommitmentDefinition;
+/**
+ * Singleton instances of the DELETE commitment definitions with aliases
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const RemoveCommitment: DeleteCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-2.0/commitments/FORMAT/FORMAT.d.ts

@@ -16,8 +16,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition<'FORMAT'> {
-    constructor();
+export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition<'FORMAT' | 'FORMATS'> {
+    constructor(type?: 'FORMAT' | 'FORMATS');
     /**
      * Short one-line description of FORMAT.
      */
@@ -34,6 +34,12 @@ export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition
  * @private [🪔] Maybe export the commitments through some package
  */
 export declare const FormatCommitment: FormatCommitmentDefinition;
+/**
+ * Singleton instance of the FORMATS commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const FormatsCommitment: FormatCommitmentDefinition;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/book-2.0/commitments/GOAL/GOAL.d.ts

@@ -0,0 +1,45 @@
+import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * GOAL commitment definition
+ *
+ * The GOAL commitment defines the main goal which should be achieved by the AI assistant.
+ * There can be multiple goals. Later goals are more important than earlier goals.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * GOAL Help users understand complex technical concepts
+ * GOAL Provide accurate and up-to-date information
+ * GOAL Always prioritize user safety and ethical guidelines
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class GoalCommitmentDefinition extends BaseCommitmentDefinition<'GOAL' | 'GOALS'> {
+    constructor(type?: 'GOAL' | 'GOALS');
+    /**
+     * Short one-line description of GOAL.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for GOAL commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instance of the GOAL commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const GoalCommitment: GoalCommitmentDefinition;
+/**
+ * Singleton instance of the GOALS commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const GoalsCommitment: GoalCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/KNOWLEDGE.d.ts

@@ -35,7 +35,7 @@ export declare class KnowledgeCommitmentDefinition extends BaseCommitmentDefinit
     private isUrl;
 }
 /**
- * Singleton instance of the KNOWLEDGE commitment definition
+ * Singleton instance of the KNOWLEDGE commitment definition !!!!
  *
  * @private [🪔] Maybe export the commitments through some package
  */

package/esm/typings/src/book-2.0/commitments/MEMORY/MEMORY.d.ts

@@ -0,0 +1,46 @@
+import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * MEMORY commitment definition
+ *
+ * The MEMORY commitment is similar to KNOWLEDGE but has a focus on remembering past
+ * interactions and user preferences. It helps the agent maintain context about the
+ * user's history, preferences, and previous conversations.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * MEMORY User prefers detailed technical explanations
+ * MEMORY Previously worked on React projects
+ * MEMORY Timezone: UTC-5 (Eastern Time)
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class MemoryCommitmentDefinition extends BaseCommitmentDefinition<'MEMORY' | 'MEMORIES'> {
+    constructor(type?: 'MEMORY' | 'MEMORIES');
+    /**
+     * Short one-line description of MEMORY.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for MEMORY commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instance of the MEMORY commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const MemoryCommitment: MemoryCommitmentDefinition;
+/**
+ * Singleton instance of the MEMORIES commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const MemoriesCommitment: MemoryCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,47 @@
+import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * MESSAGE commitment definition
+ *
+ * The MESSAGE commitment contains 1:1 text of the message which AI assistant already
+ * sent during the conversation. Later messages are later in the conversation.
+ * It is similar to EXAMPLE but it is not example, it is the real message which
+ * AI assistant already sent.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * MESSAGE Hello! How can I help you today?
+ * MESSAGE I understand you're looking for information about our services.
+ * MESSAGE Based on your requirements, I'd recommend our premium package.
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class MessageCommitmentDefinition extends BaseCommitmentDefinition<'MESSAGE' | 'MESSAGES'> {
+    constructor(type?: 'MESSAGE' | 'MESSAGES');
+    /**
+     * Short one-line description of MESSAGE.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for MESSAGE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instance of the MESSAGE commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const MessageCommitment: MessageCommitmentDefinition;
+/**
+ * Singleton instance of the MESSAGES commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const MessagesCommitment: MessageCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,62 @@
+import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * META commitment definition
+ *
+ * The META commitment handles all meta-information about the agent such as:
+ * - META IMAGE: Sets the agent's avatar/profile image URL
+ * - META LINK: Provides profile/source links for the person the agent models
+ * - META TITLE: Sets the agent's display title
+ * - META DESCRIPTION: Sets the agent's description
+ * - META [ANYTHING]: Any other meta information in uppercase format
+ *
+ * These commitments are special because they don't affect the system message,
+ * but are handled separately in the parsing logic for profile display.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * META IMAGE https://example.com/avatar.jpg
+ * META LINK https://twitter.com/username
+ * META TITLE Professional Assistant
+ * META DESCRIPTION An AI assistant specialized in business tasks
+ * META AUTHOR John Doe
+ * META VERSION 1.0
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class MetaCommitmentDefinition extends BaseCommitmentDefinition<`META${string}`> {
+    constructor();
+    /**
+     * Short one-line description of META commitments.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for META commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Extracts meta information from the content based on the meta type
+     * This is used by the parsing logic
+     */
+    extractMetaValue(metaType: string, content: string): string | null;
+    /**
+     * Validates if the provided content is a valid URL (for IMAGE and LINK types)
+     */
+    isValidUrl(content: string): boolean;
+    /**
+     * Checks if this is a known meta type
+     */
+    isKnownMetaType(metaType: string): boolean;
+}
+/**
+ * Singleton instance of the META commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const MetaCommitment: MetaCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -4,20 +4,29 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
  * MODEL commitment definition
  *
  * The MODEL commitment specifies which AI model to use and can also set
- * model-specific parameters like temperature, topP, and topK.
+ * model-specific parameters like temperature, topP, topK, and maxTokens.
  *
- * Example usage in agent source:
+ * Supports multiple syntax variations:
  *
+ * Single-line format:
  * ```book
  * MODEL gpt-4
  * MODEL claude-3-opus temperature=0.3
  * MODEL gpt-3.5-turbo temperature=0.8 topP=0.9
  * ```
  *
+ * Multi-line named parameter format:
+ * ```book
+ * MODEL NAME gpt-4
+ * MODEL TEMPERATURE 0.7
+ * MODEL TOP_P 0.9
+ * MODEL MAX_TOKENS 2048
+ * ```
+ *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<'MODEL'> {
-    constructor();
+export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<'MODEL' | 'MODELS'> {
+    constructor(type?: 'MODEL' | 'MODELS');
     /**
      * Short one-line description of MODEL.
      */
@@ -27,6 +36,18 @@ export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<
      */
     get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Check if the first part is a known named parameter
+     */
+    private isNamedParameter;
+    /**
+     * Parse the new named parameter format: "MODEL TEMPERATURE 0.7"
+     */
+    private parseNamedParameter;
+    /**
+     * Parse the legacy format: "MODEL gpt-4 temperature=0.3 topP=0.9"
+     */
+    private parseLegacyFormat;
 }
 /**
  * Singleton instance of the MODEL commitment definition
@@ -34,6 +55,12 @@ export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<
  * @private [🪔] Maybe export the commitments through some package
  */
 export declare const ModelCommitment: ModelCommitmentDefinition;
+/**
+ * Singleton instance of the MODELS commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const ModelsCommitment: ModelCommitmentDefinition;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -26,8 +26,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition<'NOTE'> {
-    constructor();
+export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition<'NOTE' | 'NOTES' | 'COMMENT' | 'NONCE'> {
+    constructor(type?: 'NOTE' | 'NOTES' | 'COMMENT' | 'NONCE');
     /**
      * Short one-line description of NOTE.
      */
@@ -44,6 +44,24 @@ export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition<'
  * @private [🪔] Maybe export the commitments through some package
  */
 export declare const NoteCommitment: NoteCommitmentDefinition;
+/**
+ * Singleton instance of the NOTES commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const NotesCommitment: NoteCommitmentDefinition;
+/**
+ * Singleton instance of the COMMENT commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const CommentCommitment: NoteCommitmentDefinition;
+/**
+ * Singleton instance of the NONCE commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const NonceCommitment: NoteCommitmentDefinition;
 /**
  * [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -23,8 +23,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinition<'PERSONA'> {
-    constructor();
+export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinition<'PERSONA' | 'PERSONAE'> {
+    constructor(type?: 'PERSONA' | 'PERSONAE');
     /**
      * Short one-line description of PERSONA.
      */
@@ -41,6 +41,12 @@ export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinitio
  * @private [🪔] Maybe export the commitments through some package
  */
 export declare const PersonaCommitment: PersonaCommitmentDefinition;
+/**
+ * Singleton instance of the PERSONAE commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const PersonaeCommitment: PersonaCommitmentDefinition;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -0,0 +1,46 @@
+import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * SCENARIO commitment definition
+ *
+ * The SCENARIO commitment defines a specific situation or context in which the AI
+ * assistant should operate. It helps to set the scene for the AI's responses.
+ * Later scenarios are more important than earlier scenarios.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * SCENARIO You are in a customer service call center during peak hours
+ * SCENARIO The customer is frustrated and has been on hold for 20 minutes
+ * SCENARIO This is the customer's third call about the same issue
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class ScenarioCommitmentDefinition extends BaseCommitmentDefinition<'SCENARIO' | 'SCENARIOS'> {
+    constructor(type?: 'SCENARIO' | 'SCENARIOS');
+    /**
+     * Short one-line description of SCENARIO.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for SCENARIO commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instance of the SCENARIO commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const ScenarioCommitment: ScenarioCommitmentDefinition;
+/**
+ * Singleton instance of the SCENARIOS commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const ScenariosCommitment: ScenarioCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */