@promptbook/components 0.104.0-0 → 0.104.0-10

package/esm/typings/servers.d.ts

@@ -22,6 +22,14 @@ type ServerConfiguration = {
      */
     urls: Array<string_promptbook_server_url>;
 };
+/**
+ * Core Promptbook server configuration.
+ *
+ * This server is also used for auto-federation in the Agents Server.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const CORE_SERVER: ServerConfiguration;
 /**
  * Available remote servers for the Promptbook
  *

package/esm/typings/src/_packages/core.index.d.ts

@@ -191,6 +191,7 @@ import { SectionTypes } from '../types/SectionType';
 import { TaskTypes } from '../types/TaskType';
 import { aboutPromptbookInformation } from '../utils/misc/aboutPromptbookInformation';
 import { $generateBookBoilerplate } from '../utils/random/$generateBookBoilerplate';
+import { CORE_SERVER } from '../../servers';
 import { REMOTE_SERVER_URLS } from '../../servers';
 import { AUTO_FEDERATED_AGENT_SERVER_URLS } from '../../servers';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
@@ -386,5 +387,6 @@ export { SectionTypes };
 export { TaskTypes };
 export { aboutPromptbookInformation };
 export { $generateBookBoilerplate };
+export { CORE_SERVER };
 export { REMOTE_SERVER_URLS };
 export { AUTO_FEDERATED_AGENT_SERVER_URLS };

package/esm/typings/src/_packages/types.index.d.ts

@@ -185,6 +185,7 @@ import type { BookTranspiler } from '../transpilers/_common/BookTranspiler';
 import type { BookTranspilerOptions } from '../transpilers/_common/BookTranspilerOptions';
 import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
 import type { LlmCall } from '../types/LlmCall';
+import type { Message } from '../types/Message';
 import type { ModelRequirements } from '../types/ModelRequirements';
 import type { CompletionModelRequirements } from '../types/ModelRequirements';
 import type { ChatModelRequirements } from '../types/ModelRequirements';
@@ -205,6 +206,7 @@ import type { string_char_emoji } from '../types/typeAliasEmoji';
 import type { string_business_category_name } from '../types/typeAliases';
 import type { string_model_name } from '../types/typeAliases';
 import type { string_prompt } from '../types/typeAliases';
+import type { string_prompt_image } from '../types/typeAliases';
 import type { string_template } from '../types/typeAliases';
 import type { string_text_prompt } from '../types/typeAliases';
 import type { string_chat_prompt } from '../types/typeAliases';
@@ -225,6 +227,7 @@ import type { string_title } from '../types/typeAliases';
 import type { string_agent_name } from '../types/typeAliases';
 import type { string_agent_name_in_book } from '../types/typeAliases';
 import type { string_agent_hash } from '../types/typeAliases';
+import type { string_agent_permanent_id } from '../types/typeAliases';
 import type { string_persona_description } from '../types/typeAliases';
 import type { string_model_description } from '../types/typeAliases';
 import type { string_knowledge_source_content } from '../types/typeAliases';
@@ -275,6 +278,7 @@ import type { string_uuid } from '../types/typeAliases';
 import type { string_app_id } from '../types/typeAliases';
 import type { string_user_id } from '../types/typeAliases';
 import type { string_sha256 } from '../types/typeAliases';
+import type { string_base_58 } from '../types/typeAliases';
 import type { string_semantic_version } from '../types/typeAliases';
 import type { string_version_dependency } from '../types/typeAliases';
 import type { string_file_extension } from '../types/typeAliases';
@@ -337,7 +341,7 @@ import type { ColorTransformer } from '../utils/color/operators/ColorTransformer
 import type { PipelineEditableSerialized } from '../utils/editable/types/PipelineEditableSerialized';
 import type { ExecCommandOptions } from '../utils/execCommand/ExecCommandOptions';
 import type { ExecCommandOptionsAdvanced } from '../utils/execCommand/ExecCommandOptions';
-import type { CodeBlock } from '../utils/markdown/extractAllBlocksFromMarkdown';
+import type { MarkdownCodeBlock } from '../utils/markdown/extractAllBlocksFromMarkdown';
 import type { MarkdownSection } from '../utils/markdown/parseMarkdownSection';
 import type { Registered } from '../utils/misc/$Register';
 import type { Registration } from '../utils/misc/$Register';
@@ -549,6 +553,7 @@ export type { BookTranspiler };
 export type { BookTranspilerOptions };
 export type { IntermediateFilesStrategy };
 export type { LlmCall };
+export type { Message };
 export type { ModelRequirements };
 export type { CompletionModelRequirements };
 export type { ChatModelRequirements };
@@ -569,6 +574,7 @@ export type { string_char_emoji };
 export type { string_business_category_name };
 export type { string_model_name };
 export type { string_prompt };
+export type { string_prompt_image };
 export type { string_template };
 export type { string_text_prompt };
 export type { string_chat_prompt };
@@ -589,6 +595,7 @@ export type { string_title };
 export type { string_agent_name };
 export type { string_agent_name_in_book };
 export type { string_agent_hash };
+export type { string_agent_permanent_id };
 export type { string_persona_description };
 export type { string_model_description };
 export type { string_knowledge_source_content };
@@ -639,6 +646,7 @@ export type { string_uuid };
 export type { string_app_id };
 export type { string_user_id };
 export type { string_sha256 };
+export type { string_base_58 };
 export type { string_semantic_version };
 export type { string_version_dependency };
 export type { string_file_extension };
@@ -701,7 +709,7 @@ export type { ColorTransformer };
 export type { PipelineEditableSerialized };
 export type { ExecCommandOptions };
 export type { ExecCommandOptionsAdvanced };
-export type { CodeBlock };
+export type { MarkdownCodeBlock };
 export type { MarkdownSection };
 export type { Registered };
 export type { Registration };

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

@@ -1,4 +1,4 @@
-import type { string_agent_hash, string_agent_name, string_agent_url, string_color, string_fonts, string_url_image } from '../../types/typeAliases';
+import type { string_agent_hash, string_agent_name, string_agent_permanent_id, string_agent_url, string_color, string_fonts, string_url_image } from '../../types/typeAliases';
 /**
  * Unified parameter representation that supports two different notations:
  * 1. @Parameter - single word parameter starting with @
@@ -33,6 +33,11 @@ export type AgentBasicInformation = {
      * Hash of the agent source for integrity verification
      */
     agentHash: string_agent_hash;
+    /**
+     * Unique identifier of the agent
+     * This is a random base58 string assigned by the server
+     */
+    permanentId?: string_agent_permanent_id;
     /**
      * Optional description of the agent
      * This is the line starting with "PERSONA"

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

@@ -1,6 +1,6 @@
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { string_model_name } from '../../types/typeAliases';
+import type { string_agent_name, string_model_name, string_system_message, string_url_image } from '../../types/typeAliases';
 import type { AgentModelRequirements } from './AgentModelRequirements';
 import type { string_book } from './string_book';
 /**
@@ -27,18 +27,18 @@ export declare function extractMcpServers(agentSource: string_book): string[];
  * @deprecated Use createAgentModelRequirements instead
  * @private
  */
-export declare function createAgentSystemMessage(agentSource: string_book): Promise<string>;
+export declare function createAgentSystemMessage(agentSource: string_book): Promise<string_system_message>;
 /**
  * Extracts the agent name from the first line of the agent source
  * @deprecated Use parseAgentSource instead
  * @private
  */
-export declare function extractAgentName(agentSource: string_book): string;
+export declare function extractAgentName(agentSource: string_book): string_agent_name;
 /**
- * Extracts the profile image URL from agent source or returns gravatar fallback
+ * Extracts the profile image URL from agent source or returns default avatar fallback
  * @param agentSource The agent source string that may contain META IMAGE line
- * @returns Profile image URL (from source or gravatar fallback)
+ * @returns Profile image URL (from source or default avatar fallback)
  * @deprecated Use parseAgentSource instead
  * @private
  */
-export declare function extractAgentProfileImage(agentSource: string_book): string;
+export declare function extractAgentProfileImage(agentSource: string_book): string_url_image | null;

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

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

package/esm/typings/src/book-2.0/utils/generatePlaceholderAgentProfileImageUrl.d.ts

@@ -1,13 +1,13 @@
-import type { string_agent_name, string_url_image } from '../../types/typeAliases';
+import type { string_agent_name, string_agent_permanent_id, string_url, string_url_image } from '../../types/typeAliases';
 /**
  * Generates an image for the agent to use as profile image
  *
- * @param agentName The agent name to generate avatar for
+ * @param agentId - The permanent ID of the agent
  * @returns The placeholder profile image URL for the agent
  *
  * @public exported from `@promptbook/core`
  */
-export declare function generatePlaceholderAgentProfileImageUrl(agentName?: string_agent_name): string_url_image;
+export declare function generatePlaceholderAgentProfileImageUrl(agentIdOrName: string_agent_permanent_id | string_agent_name, agentsServerUrl?: URL | string_url): string_url_image;
 /**
  * TODO: [🤹] Figure out best placeholder image generator https://i.pravatar.cc/1000?u=568
  */

package/esm/typings/src/book-components/Chat/Chat/ChatMessageItem.d.ts

@@ -29,11 +29,15 @@ type ChatMessageItemProps = Pick<ChatProps, 'onMessage' | 'participants'> & {
      * Called when the copy button is pressed.
      */
     onCopy?: () => void;
+    /**
+     * Called when the create agent button is pressed for book code blocks.
+     */
+    onCreateAgent?: (bookContent: string) => void;
 };
 /**
  * Renders a single chat message item with avatar, content, buttons, and rating.
  *
  * @private internal subcomponent of `<Chat>` component
  */
-export declare const ChatMessageItem: import("react").MemoExoticComponent<({ message, participant, participants, isLastMessage, onMessage, setExpandedMessageId, isExpanded, currentRating, handleRating, mode, isCopyButtonEnabled, isFeedbackEnabled, onCopy, }: ChatMessageItemProps) => import("react/jsx-runtime").JSX.Element>;
+export declare const ChatMessageItem: import("react").MemoExoticComponent<({ message, participant, participants, isLastMessage, onMessage, setExpandedMessageId, isExpanded, currentRating, handleRating, mode, isCopyButtonEnabled, isFeedbackEnabled, onCopy, onCreateAgent, }: ChatMessageItemProps) => import("react/jsx-runtime").JSX.Element>;
 export {};

package/esm/typings/src/book-components/Chat/Chat/ChatProps.d.ts

@@ -187,6 +187,11 @@ export type ChatProps = {
      * @default true
      */
     isCopyButtonEnabled?: boolean;
+    /**
+     * Optional callback for creating an agent from a book code block.
+     * When provided, "Create Agent" buttons will be shown for book code blocks.
+     */
+    onCreateAgent?: (bookContent: string) => void;
 };
 /**
  * TODO: [☁️] Export component prop types only to `@promptbook/components` (not `@promptbook/types`)

package/esm/typings/src/book-components/Chat/CodeBlock/CodeBlock.d.ts

@@ -0,0 +1,13 @@
+type CodeBlockProps = {
+    code: string;
+    language?: string;
+    className?: string;
+    onCreateAgent?: (bookContent: string) => void;
+};
+/**
+ * Component to render a code block with syntax highlighting, copy, download, and create agent options.
+ *
+ * @private Internal utility of `<ChatMessage />` component
+ */
+export declare function CodeBlock({ code, language, className, onCreateAgent }: CodeBlockProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/esm/typings/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts

@@ -2,6 +2,7 @@ import type { string_markdown } from '../../../types/typeAliases';
 type MarkdownContentProps = {
     content: string_markdown;
     className?: string;
+    onCreateAgent?: (bookContent: string) => void;
 };
 /**
  * Renders markdown content with support for code highlighting, math, and tables.

package/esm/typings/src/book-components/Chat/types/ChatMessage.d.ts

@@ -1,22 +1,17 @@
+import { Message } from '../../../types/Message';
 import type { id, string_markdown } from '../../../types/typeAliases';
 /**
  * A message in the chat
  *
  * @public exported from `@promptbook/components`
  */
-export type ChatMessage = {
+export type ChatMessage = Omit<Message<id>, 'direction' | 'recipients' | 'threadId' | 'metadata'> & {
     /**
-     * Unique identifier of the message
-     */
-    id?: id;
-    /**
-     * Date when the message was created
-     */
-    date?: Date;
-    /**
-     * The name of the participant who sent the message
+     * Force the channel to be 'PROMPTBOOK_CHAT'
+     *
+     * @default 'PROMPTBOOK_CHAT'
      */
-    from: id;
+    channel?: 'PROMPTBOOK_CHAT';
     /**
      * The content of the message with optional markdown formatting
      */
@@ -37,6 +32,7 @@ export type ChatMessage = {
     isVoiceCall?: boolean;
 };
 /**
+ * TODO: Make all fields readonly
  * TODO: Delete `expectedAnswer` from ChatMessage
  * TODO: Rename `date` into `created`+`modified`
  */

package/esm/typings/src/book-components/_common/Dropdown/Dropdown.d.ts

@@ -1,7 +1,7 @@
-import { JSX } from 'react';
+import { ReactNode } from 'react';
 type DropdownProps = {
     actions: Array<{
-        icon: JSX.Element;
+        icon: ReactNode;
         name: string;
         onClick: () => void;
     }>;

package/esm/typings/src/book-components/_common/MenuHoisting/MenuHoistingContext.d.ts

@@ -0,0 +1,56 @@
+import { ReactNode } from 'react';
+/**
+ * Item that can be hoisted to the top menu
+ *
+ * @private mechanism inside Promptbook
+ */
+export type HoistedMenuItem = {
+    /**
+     * Unique key for the menu item
+     */
+    key?: string;
+    /**
+     * Icon to display
+     */
+    icon: ReactNode;
+    /**
+     * Name/Tooltip of the item
+     */
+    name: string;
+    /**
+     * Action to perform when clicked
+     */
+    onClick: () => void;
+    /**
+     * If true, the item is active/toggled
+     */
+    isActive?: boolean;
+};
+type MenuHoistingContextType = {
+    /**
+     * The currently hoisted menu items
+     */
+    menu: HoistedMenuItem[];
+    /**
+     * Set the hoisted menu items
+     */
+    setMenu: (items: HoistedMenuItem[]) => void;
+};
+/**
+ * Provider for menu hoisting
+ *
+ * @private mechanism inside Promptbook
+ */
+export declare function MenuHoistingProvider({ children }: {
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+/**
+ * Hook to use the menu hoisting system
+ *
+ * @private mechanism inside Promptbook
+ */
+export declare function useMenuHoisting(): MenuHoistingContextType | null;
+export {};
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts

@@ -1,7 +1,7 @@
 import type { SupabaseClient } from '@supabase/supabase-js';
 import type { AgentBasicInformation } from '../../../../book-2.0/agent-source/AgentBasicInformation';
 import type { string_book } from '../../../../book-2.0/agent-source/string_book';
-import type { string_agent_name } from '../../../../types/typeAliases';
+import type { string_agent_name, string_agent_permanent_id } from '../../../../types/typeAliases';
 import { AgentCollectionInSupabaseOptions } from './AgentCollectionInSupabaseOptions';
 import type { AgentsDatabaseSchema } from './AgentsDatabaseSchema';
 /**
@@ -28,38 +28,48 @@ export declare class AgentCollectionInSupabase {
     /**
      * [🐱‍🚀]@@@
      */
-    getAgentSource(agentName: string_agent_name): Promise<string_book>;
+    getAgentPermanentId(agentNameOrPermanentId: string_agent_name | string_agent_permanent_id): Promise<string_agent_permanent_id>;
+    /**
+     * [🐱‍🚀]@@@
+     */
+    getAgentSource(agentNameOrPermanentId: string_agent_name | string_agent_permanent_id): Promise<string_book>;
     /**
      * Creates a new agent in the collection
      *
      * Note: You can set 'PARENT' in the agent source to inherit from another agent in the collection.
      */
-    createAgent(agentSource: string_book): Promise<AgentBasicInformation>;
+    createAgent(agentSource: string_book): Promise<AgentBasicInformation & Required<Pick<AgentBasicInformation, 'permanentId'>>>;
     /**
      * Updates an existing agent in the collection
      */
-    updateAgentSource(agentName: string_agent_name, agentSource: string_book): Promise<void>;
+    updateAgentSource(permanentId: string_agent_permanent_id, agentSource: string_book): Promise<void>;
     /**
-     * Deletes an agent from the collection
+     * List agents that are soft deleted (deletedAt IS NOT NULL)
      */
-    deleteAgent(agentName: string_agent_name): Promise<void>;
+    listDeletedAgents(): Promise<ReadonlyArray<AgentBasicInformation>>;
     /**
      * List history of an agent
      */
-    listAgentHistory(agentName: string_agent_name): Promise<ReadonlyArray<{
+    listAgentHistory(permanentId: string_agent_permanent_id): Promise<ReadonlyArray<{
         id: number;
         createdAt: string;
         agentHash: string;
         promptbookEngineVersion: string;
     }>>;
     /**
-     * List agents that are in history but not in the active agents list
+     * Restore a soft-deleted agent by setting deletedAt to NULL
+     */
+    restoreAgent(permanentId: string_agent_permanent_id): Promise<void>;
+    /**
+     * Restore an agent from a specific history entry
+     *
+     * This will update the current agent with the source from the history entry
      */
-    listDeletedAgents(): Promise<ReadonlyArray<string_agent_name>>;
+    restoreAgentFromHistory(historyId: number): Promise<void>;
     /**
-     * Restore an agent from history
+     * Soft delete an agent by setting deletedAt to current timestamp
      */
-    restoreAgent(historyId: number): Promise<void>;
+    deleteAgent(permanentId: string_agent_permanent_id): Promise<void>;
     /**
      * Get the Supabase table name with prefix
      *

package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentsDatabaseSchema.d.ts

@@ -3,11 +3,12 @@
  * Source of truth: `/apps/agents-server/src/database/schema.sql` *(do not edit table structure here manually)*
  *
  * [💽] Prompt:
- * Re-generate this sub-schema
+ * Re-generate this sub-schema from `/apps/agents-server/src/database/schema.ts` *(which was generated from `/apps/agents-server/src/database/migrations/*.sql`)*
+ * `AgentsDatabaseSchema` is strict subset of `AgentsServerDatabase`
  * Generate Supabase TypeScript schema which is a subset of `AgentsServerDatabase`
  * containing only tables `Agent` and `AgentHistory`
  *
- * NOTE: This file intentionally omits all other tables (EnvironmentVariable, ChatHistory, ChatFeedback)
+ * NOTE: This file intentionally omits all other tables (`Metadata`, `ChatHistory`, `ChatFeedback`, `User`, `LlmCache`, etc.)
  *       and any extra schemas (e.g. `graphql_public`) to remain a strict subset.
  */
 export type Json = string | number | boolean | null | {
@@ -22,6 +23,7 @@ export type AgentsDatabaseSchema = {
                     agentName: string;
                     createdAt: string;
                     updatedAt: string | null;
+                    permanentId: string | null;
                     agentHash: string;
                     agentSource: string;
                     agentProfile: Json;
@@ -29,12 +31,15 @@ export type AgentsDatabaseSchema = {
                     usage: Json | null;
                     preparedModelRequirements: Json | null;
                     preparedExternals: Json | null;
+                    deletedAt: string | null;
+                    visibility: 'PUBLIC' | 'PRIVATE';
                 };
                 Insert: {
                     id?: number;
                     agentName: string;
                     createdAt: string;
                     updatedAt?: string | null;
+                    permanentId?: string | null;
                     agentHash: string;
                     agentSource: string;
                     agentProfile: Json;
@@ -42,12 +47,15 @@ export type AgentsDatabaseSchema = {
                     usage?: Json | null;
                     preparedModelRequirements?: Json | null;
                     preparedExternals?: Json | null;
+                    deletedAt?: string | null;
+                    visibility?: 'PUBLIC' | 'PRIVATE';
                 };
                 Update: {
                     id?: number;
                     agentName?: string;
                     createdAt?: string;
                     updatedAt?: string | null;
+                    permanentId?: string | null;
                     agentHash?: string;
                     agentSource?: string;
                     agentProfile?: Json;
@@ -55,6 +63,8 @@ export type AgentsDatabaseSchema = {
                     usage?: Json | null;
                     preparedModelRequirements?: Json | null;
                     preparedExternals?: Json | null;
+                    deletedAt?: string | null;
+                    visibility?: 'PUBLIC' | 'PRIVATE';
                 };
                 Relationships: [];
             };
@@ -63,6 +73,7 @@ export type AgentsDatabaseSchema = {
                     id: number;
                     createdAt: string;
                     agentName: string;
+                    permanentId: string;
                     agentHash: string;
                     previousAgentHash: string | null;
                     agentSource: string;
@@ -72,6 +83,7 @@ export type AgentsDatabaseSchema = {
                     id?: number;
                     createdAt: string;
                     agentName: string;
+                    permanentId: string;
                     agentHash: string;
                     previousAgentHash?: string | null;
                     agentSource: string;
@@ -81,26 +93,80 @@ export type AgentsDatabaseSchema = {
                     id?: number;
                     createdAt?: string;
                     agentName?: string;
+                    permanentId?: string;
                     agentHash?: string;
                     previousAgentHash?: string | null;
                     agentSource?: string;
                     promptbookEngineVersion?: string;
                 };
+                Relationships: [
+                    {
+                        foreignKeyName: 'AgentHistory_permanentId_fkey';
+                        columns: ['permanentId'];
+                        referencedRelation: 'Agent';
+                        referencedColumns: ['permanentId'];
+                    }
+                ];
+            };
+            GenerationLock: {
+                Row: {
+                    id: number;
+                    createdAt: string;
+                    updatedAt: string;
+                    lockKey: string;
+                    expiresAt: string;
+                };
+                Insert: {
+                    id?: number;
+                    createdAt?: string;
+                    updatedAt?: string;
+                    lockKey: string;
+                    expiresAt: string;
+                };
+                Update: {
+                    id?: number;
+                    createdAt?: string;
+                    updatedAt?: string;
+                    lockKey?: string;
+                    expiresAt?: string;
+                };
+                Relationships: [];
+            };
+            Image: {
+                Row: {
+                    id: number;
+                    createdAt: string;
+                    updatedAt: string;
+                    filename: string;
+                    prompt: string;
+                    cdnUrl: string;
+                    cdnKey: string;
+                };
+                Insert: {
+                    id?: number;
+                    createdAt?: string;
+                    updatedAt?: string;
+                    filename: string;
+                    prompt: string;
+                    cdnUrl: string;
+                    cdnKey: string;
+                };
+                Update: {
+                    id?: number;
+                    createdAt?: string;
+                    updatedAt?: string;
+                    filename?: string;
+                    prompt?: string;
+                    cdnUrl?: string;
+                    cdnKey?: string;
+                };
                 Relationships: [];
             };
         };
-        Views: {
-            [_ in never]: never;
-        };
-        Functions: {
-            [_ in never]: never;
-        };
-        Enums: {
-            [_ in never]: never;
-        };
-        CompositeTypes: {
-            [_ in never]: never;
-        };
+        Views: Record<string, never>;
+        Functions: Record<string, never>;
+        Enums: Record<string, never>;
+        CompositeTypes: Record<string, never>;
     };
 };
 type PublicSchema = AgentsDatabaseSchema[Extract<keyof AgentsDatabaseSchema, 'public'>];

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

@@ -0,0 +1,46 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * DICTIONARY commitment definition
+ *
+ * The DICTIONARY commitment defines specific terms and their meanings that the agent should use correctly
+ * in its reasoning and responses. This ensures consistent terminology usage.
+ *
+ * Key features:
+ * - Multiple DICTIONARY commitments are automatically merged into one
+ * - Content is placed in a dedicated section of the system message
+ * - Terms and definitions are stored in metadata.DICTIONARY for debugging
+ * - Agent should use the defined terms correctly in responses
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * Legal Assistant
+ *
+ * PERSONA You are a knowledgeable legal assistant
+ * DICTIONARY Misdemeanor is a minor wrongdoing or criminal offense
+ * DICTIONARY Felony is a serious crime usually punishable by imprisonment for more than one year
+ * DICTIONARY Tort is a civil wrong that causes harm or loss to another person, leading to legal liability
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class DictionaryCommitmentDefinition extends BaseCommitmentDefinition<'DICTIONARY'> {
+    constructor();
+    /**
+     * Short one-line description of DICTIONARY.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for DICTIONARY 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/index.d.ts

@@ -4,6 +4,7 @@ import { ActionCommitmentDefinition } from './ACTION/ACTION';
 import { ClosedCommitmentDefinition } from './CLOSED/CLOSED';
 import { ComponentCommitmentDefinition } from './COMPONENT/COMPONENT';
 import { DeleteCommitmentDefinition } from './DELETE/DELETE';
+import { DictionaryCommitmentDefinition } from './DICTIONARY/DICTIONARY';
 import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
 import { FromCommitmentDefinition } from './FROM/FROM';
 import { GoalCommitmentDefinition } from './GOAL/GOAL';
@@ -39,7 +40,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
  *
  * @private Use functions to access commitments instead of this array directly
  */
-export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, FromCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
+export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, FromCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
 /**
  * Gets a commitment definition by its type
  * @param type The commitment type to look up