@promptbook/types 0.101.0-0 → 0.101.0-10

package/README.md

@@ -47,7 +47,35 @@ npm i ptbk
 npm i -D @promptbook/types
 ```
 
-This package is useful when you want to explicitly define types in your code.
+Comprehensive TypeScript type definitions for all Promptbook entities, enabling type-safe development and excellent IDE support throughout the Promptbook ecosystem.
+
+## 🎯 Purpose and Motivation
+
+This package centralizes all TypeScript type definitions used throughout the Promptbook ecosystem. It enables developers to write type-safe code when working with promptbooks, pipelines, LLM providers, and other Promptbook components, providing excellent IntelliSense and compile-time error checking.
+
+## 🔧 High-Level Functionality
+
+The package provides type definitions for:
+
+-   **Pipeline Structures**: Complete type definitions for promptbook JSON structures
+-   **Execution Types**: Types for pipeline execution, results, and error handling
+-   **LLM Provider Types**: Configuration and option types for all supported providers
+-   **Command Types**: Type definitions for all promptbook commands
+-   **Utility Types**: Helper types for common patterns and data structures
+-   **Component Types**: React component prop types for UI components
+
+## ✨ Key Features
+
+-   📝 **Complete Type Coverage** - Types for all Promptbook entities and APIs
+-   🔒 **Type Safety** - Compile-time validation and error prevention
+-   💡 **Excellent IntelliSense** - Rich IDE support with autocomplete and documentation
+-   🏗️ **Structural Types** - Detailed types for promptbook JSON structures
+-   🔧 **Provider-Agnostic** - Generic types that work across all LLM providers
+-   📊 **Execution Types** - Comprehensive types for pipeline execution and results
+-   🎨 **Component Types** - React component prop types for UI development
+-   🔄 **Version Compatibility** - Types that evolve with the Promptbook ecosystem
+
+## Usage Example
 
 ```typescript
 import type { PipelineJson } from '@promptbook/types';
@@ -73,7 +101,200 @@ const promptbook: PipelineJson = compilePipeline(
 );
 ```
 
-_Note: `@promptbook/types` does not export brand-specific types like `OpenAiExecutionToolsOptions`, `ClaudeExecutionToolsOptions`, `LangchainExecutionToolsOptions`,... etc._
+## 📦 Exported Type Categories
+
+### Agent and Book Types
+
+-   `AgentBasicInformation` - Basic agent information structure (type)
+-   `AgentModelRequirements` - Model requirements for agents (type)
+-   `string_book` - Book content string type (type)
+-   `BookCommitment` - Book commitment structure (type)
+-   `CommitmentDefinition` - Commitment definition interface (type)
+-   `ParsedCommitment` - Parsed commitment structure (type)
+
+### Component Types
+
+-   `AvatarChipProps` - Avatar chip component props (type)
+-   `AvatarChipFromSourceProps` - Avatar chip from source props (type)
+-   `AvatarProfileProps` - Avatar profile component props (type)
+-   `AvatarProfileFromSourceProps` - Avatar profile from source props (type)
+-   `BookEditorProps` - Book editor component props (type)
+-   `ChatProps` - Chat component props (type)
+-   `LlmChatProps` - LLM chat component props (type)
+-   `ChatMessage` - Chat message structure (type)
+-   `ChatParticipant` - Chat participant information (type)
+
+### Collection and Pipeline Types
+
+-   `PipelineCollection` - Pipeline collection interface (type)
+-   `PipelineJson` - Complete pipeline JSON structure (type)
+-   `PipelineString` - Pipeline string format (type)
+-   `PipelineInterface` - Pipeline interface definition (type)
+-   `TaskJson` - Task JSON structure (type)
+-   `PromptTaskJson` - Prompt task structure (type)
+-   `ScriptTaskJson` - Script task structure (type)
+-   `SimpleTaskJson` - Simple task structure (type)
+-   `DialogTaskJson` - Dialog task structure (type)
+-   `CommonTaskJson` - Common task properties (type)
+
+### Command Types
+
+-   `Command` - Base command interface (type)
+-   `CommandParser` - Command parser interface (type)
+-   `PipelineBothCommandParser` - Pipeline both command parser (type)
+-   `PipelineHeadCommandParser` - Pipeline head command parser (type)
+-   `PipelineTaskCommandParser` - Pipeline task command parser (type)
+-   `CommandParserInput` - Command parser input (type)
+-   `CommandType` - Command type enumeration (type)
+-   `CommandUsagePlace` - Command usage context (type)
+-   `BookVersionCommand` - Book version command (type)
+-   `ExpectCommand` - Expect command structure (type)
+-   `ForeachCommand` - Foreach command structure (type)
+-   `ForeachJson` - Foreach JSON structure (type)
+-   `FormatCommand` - Format command structure (type)
+-   `FormfactorCommand` - Formfactor command structure (type)
+-   `JokerCommand` - Joker command structure (type)
+-   `KnowledgeCommand` - Knowledge command structure (type)
+-   `ModelCommand` - Model command structure (type)
+-   `ParameterCommand` - Parameter command structure (type)
+-   `PersonaCommand` - Persona command structure (type)
+-   `PostprocessCommand` - Postprocess command structure (type)
+-   `SectionCommand` - Section command structure (type)
+-   `UrlCommand` - URL command structure (type)
+-   `ActionCommand` - Action command structure (type)
+-   `InstrumentCommand` - Instrument command structure (type)
+
+### Execution Types
+
+-   `ExecutionTools` - Execution tools interface (type)
+-   `LlmExecutionTools` - LLM execution tools interface (type)
+-   `LlmExecutionToolsConstructor` - LLM execution tools constructor (type)
+-   `PipelineExecutor` - Pipeline executor interface (type)
+-   `PipelineExecutorResult` - Execution result structure (type)
+-   `ExecutionTask` - Execution task structure (type)
+-   `PreparationTask` - Preparation task structure (type)
+-   `task_status` - Task status type (type)
+-   `AbstractTask` - Abstract task interface (type)
+-   `Task` - Task interface (type)
+-   `ExecutionReportJson` - Execution report structure (type)
+-   `ExecutionPromptReportJson` - Execution prompt report structure (type)
+-   `ExecutionReportString` - Execution report string (type)
+-   `ExecutionReportStringOptions` - Report formatting options (type)
+-   `PromptResult` - Prompt execution result (type)
+-   `CompletionPromptResult` - Completion prompt result (type)
+-   `ChatPromptResult` - Chat prompt result (type)
+-   `EmbeddingPromptResult` - Embedding prompt result (type)
+-   `Usage` - Usage tracking structure (type)
+-   `UsageCounts` - Usage counts structure (type)
+-   `UncertainNumber` - Uncertain number type (type)
+-   `AvailableModel` - Available model information (type)
+-   `AbstractTaskResult` - Abstract task result (type)
+-   `EmbeddingVector` - Embedding vector type (type)
+
+### LLM Provider Configuration Types
+
+-   `AnthropicClaudeExecutionToolsOptions` - Anthropic Claude configuration (type)
+-   `AnthropicClaudeExecutionToolsNonProxiedOptions` - Anthropic Claude non-proxied options (type)
+-   `AnthropicClaudeExecutionToolsProxiedOptions` - Anthropic Claude proxied options (type)
+-   `OpenAiExecutionToolsOptions` - OpenAI configuration (type)
+-   `OpenAiAssistantExecutionToolsOptions` - OpenAI Assistant configuration (type)
+-   `OpenAiCompatibleExecutionToolsOptions` - OpenAI Compatible configuration (type)
+-   `OpenAiCompatibleExecutionToolsNonProxiedOptions` - OpenAI Compatible non-proxied options (type)
+-   `OpenAiCompatibleExecutionToolsProxiedOptions` - OpenAI Compatible proxied options (type)
+-   `AzureOpenAiExecutionToolsOptions` - Azure OpenAI configuration (type)
+-   `GoogleExecutionToolsOptions` - Google configuration (type)
+-   `DeepseekExecutionToolsOptions` - Deepseek configuration (type)
+-   `OllamaExecutionToolsOptions` - Ollama configuration (type)
+-   `VercelExecutionToolsOptions` - Vercel configuration (type)
+-   `VercelProvider` - Vercel provider type (type)
+
+### Parameter and Data Types
+
+-   `ParameterJson` - Parameter definition structure (type)
+-   `InputParameterJson` - Input parameter structure (type)
+-   `IntermediateParameterJson` - Intermediate parameter structure (type)
+-   `OutputParameterJson` - Output parameter structure (type)
+-   `CommonParameterJson` - Common parameter properties (type)
+-   `Parameters` - Parameter collection type (type)
+-   `InputParameters` - Input parameters type (type)
+-   `Expectations` - Expectation validation structure (type)
+-   `ExpectationUnit` - Expectation unit type (type)
+-   `ExpectationAmount` - Expectation amount type (type)
+-   `PersonaJson` - Persona definition structure (type)
+-   `PersonaPreparedJson` - Prepared persona structure (type)
+-   `KnowledgeSourceJson` - Knowledge source structure (type)
+-   `KnowledgeSourcePreparedJson` - Prepared knowledge source structure (type)
+-   `KnowledgePiecePreparedJson` - Prepared knowledge piece structure (type)
+
+### Utility and Helper Types
+
+-   `string_prompt` - Prompt string type (type)
+-   `string_template` - Template string type (type)
+-   `string_text_prompt` - Text prompt string type (type)
+-   `string_chat_prompt` - Chat prompt string type (type)
+-   `string_system_message` - System message string type (type)
+-   `string_completion_prompt` - Completion prompt string type (type)
+-   `string_parameter_name` - Parameter name type (type)
+-   `string_parameter_value` - Parameter value type (type)
+-   `string_reserved_parameter_name` - Reserved parameter name type (type)
+-   `ReservedParameters` - Reserved parameters type (type)
+-   `string_model_name` - Model name type (type)
+-   `string_url` - URL string type (type)
+-   `string_filename` - Filename string type (type)
+-   `string_absolute_filename` - Absolute filename type (type)
+-   `string_relative_filename` - Relative filename type (type)
+-   `string_dirname` - Directory name type (type)
+-   `string_absolute_dirname` - Absolute directory name type (type)
+-   `string_relative_dirname` - Relative directory name type (type)
+-   `number_tokens` - Token count type (type)
+-   `number_usd` - USD amount type (type)
+-   `ModelVariant` - Model variant enumeration (type)
+-   `ScriptLanguage` - Script language enumeration (type)
+-   `TaskType` - Task type enumeration (type)
+-   `SectionType` - Section type enumeration (type)
+-   `ModelRequirements` - Model requirements type (type)
+-   `CompletionModelRequirements` - Completion model requirements (type)
+-   `ChatModelRequirements` - Chat model requirements (type)
+-   `EmbeddingModelRequirements` - Embedding model requirements (type)
+
+### Remote Server Types
+
+-   `RemoteServerOptions` - Remote server configuration (type)
+-   `AnonymousRemoteServerOptions` - Anonymous remote server options (type)
+-   `ApplicationRemoteServerOptions` - Application remote server options (type)
+-   `ApplicationRemoteServerClientOptions` - Application remote server client options (type)
+-   `RemoteClientOptions` - Remote client configuration (type)
+-   `Identification` - User identification structure (type)
+-   `ApplicationModeIdentification` - Application mode identification (type)
+-   `AnonymousModeIdentification` - Anonymous mode identification (type)
+-   `LoginRequest` - Login request structure (type)
+-   `LoginResponse` - Login response structure (type)
+-   `RemoteServer` - Remote server interface (type)
+
+### Storage and Scraper Types
+
+-   `PromptbookStorage` - Storage interface (type)
+-   `FileCacheStorageOptions` - File cache storage options (type)
+-   `IndexedDbStorageOptions` - IndexedDB storage options (type)
+-   `Scraper` - Scraper interface (type)
+-   `ScraperConstructor` - Scraper constructor type (type)
+-   `ScraperSourceHandler` - Scraper source handler (type)
+-   `ScraperIntermediateSource` - Scraper intermediate source (type)
+-   `ScraperAndConverterMetadata` - Scraper and converter metadata (type)
+-   `Converter` - Content converter interface (type)
+
+### Additional Types
+
+-   `Prompt` - Prompt interface (type)
+-   `CompletionPrompt` - Completion prompt interface (type)
+-   `ChatPrompt` - Chat prompt interface (type)
+-   `EmbeddingPrompt` - Embedding prompt interface (type)
+-   `NonEmptyArray` - Non-empty array type (type)
+-   `NonEmptyReadonlyArray` - Non-empty readonly array type (type)
+-   `IntermediateFilesStrategy` - Intermediate files strategy (type)
+-   `string_promptbook_version` - Promptbook version string type (type)
+
+> 💡 This package provides TypeScript types for promptbook applications. For runtime functionality, see [@promptbook/core](#-packages) or install all packages with `npm i ptbk`
 
 
 ---

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

@@ -7,6 +7,9 @@ import type { AvatarProfileProps } from '../book-components/AvatarProfile/Avatar
 import { AvatarProfile } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
 import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
 import { AvatarProfileFromSource } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
+import type { MockedChatDelayConfig } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
+import type { MockedChatProps } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
+import { MockedChat } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
 import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
 import { BookEditor } from '../book-components/BookEditor/BookEditor';
 import { DEFAULT_BOOK_FONT_CLASS } from '../book-components/BookEditor/config';
@@ -16,6 +19,12 @@ import { LlmChat } from '../book-components/Chat/LlmChat/LlmChat';
 import type { LlmChatProps } from '../book-components/Chat/LlmChat/LlmChatProps';
 import type { ChatMessage } from '../book-components/Chat/types/ChatMessage';
 import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
+import { renderMarkdown } from '../book-components/Chat/utils/renderMarkdown';
+import { isMarkdownContent } from '../book-components/Chat/utils/renderMarkdown';
+import { ArrowIcon } from '../book-components/icons/ArrowIcon';
+import { ResetIcon } from '../book-components/icons/ResetIcon';
+import { SendIcon } from '../book-components/icons/SendIcon';
+import { TemplateIcon } from '../book-components/icons/TemplateIcon';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export type { AvatarChipProps };
 export { AvatarChip };
@@ -25,6 +34,9 @@ export type { AvatarProfileProps };
 export { AvatarProfile };
 export type { AvatarProfileFromSourceProps };
 export { AvatarProfileFromSource };
+export type { MockedChatDelayConfig };
+export type { MockedChatProps };
+export { MockedChat };
 export type { BookEditorProps };
 export { BookEditor };
 export { DEFAULT_BOOK_FONT_CLASS };
@@ -34,3 +46,9 @@ export { LlmChat };
 export type { LlmChatProps };
 export type { ChatMessage };
 export type { ChatParticipant };
+export { renderMarkdown };
+export { isMarkdownContent };
+export { ArrowIcon };
+export { ResetIcon };
+export { SendIcon };
+export { TemplateIcon };

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

@@ -1,6 +1,7 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { createAgentModelRequirements } from '../book-2.0/agent-source/createAgentModelRequirements';
 import { parseAgentSource } from '../book-2.0/agent-source/parseAgentSource';
+import { parseParameters } from '../book-2.0/agent-source/parseParameters';
 import { isValidBook } from '../book-2.0/agent-source/string_book';
 import { validateBook } from '../book-2.0/agent-source/string_book';
 import { DEFAULT_BOOK } from '../book-2.0/agent-source/string_book';
@@ -166,6 +167,7 @@ import { REMOTE_SERVER_URLS } from '../../servers';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { createAgentModelRequirements };
 export { parseAgentSource };
+export { parseParameters };
 export { isValidBook };
 export { validateBook };
 export { DEFAULT_BOOK };

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

@@ -1,3 +1,4 @@
+import type { BookParameter } from '../book-2.0/agent-source/AgentBasicInformation';
 import type { AgentBasicInformation } from '../book-2.0/agent-source/AgentBasicInformation';
 import type { AgentModelRequirements } from '../book-2.0/agent-source/AgentModelRequirements';
 import type { string_book } from '../book-2.0/agent-source/string_book';
@@ -8,6 +9,8 @@ import type { AvatarChipProps } from '../book-components/AvatarProfile/AvatarChi
 import type { AvatarChipFromSourceProps } from '../book-components/AvatarProfile/AvatarChip/AvatarChipFromSource';
 import type { AvatarProfileProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
 import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
+import type { MockedChatDelayConfig } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
+import type { MockedChatProps } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
 import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
 import type { ChatProps } from '../book-components/Chat/Chat/ChatProps';
 import type { LlmChatProps } from '../book-components/Chat/LlmChat/LlmChatProps';
@@ -320,6 +323,7 @@ import type { CheckSerializableAsJsonOptions } from '../utils/serialization/chec
 import type { ExportJsonOptions } from '../utils/serialization/exportJson';
 import type { ITakeChain } from '../utils/take/interfaces/ITakeChain';
 import type { string_promptbook_version } from '../version';
+export type { BookParameter };
 export type { AgentBasicInformation };
 export type { AgentModelRequirements };
 export type { string_book };
@@ -330,6 +334,8 @@ export type { AvatarChipProps };
 export type { AvatarChipFromSourceProps };
 export type { AvatarProfileProps };
 export type { AvatarProfileFromSourceProps };
+export type { MockedChatDelayConfig };
+export type { MockedChatProps };
 export type { BookEditorProps };
 export type { ChatProps };
 export type { LlmChatProps };

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