Merge pull request #57 from tripolskypetr/message-contract

Message contract

Author: tripolskypetr

docs/classes/ClientAgent.md

@@ -169,7 +169,7 @@ Useful for external consumers (e.g., SwarmConnectionService) awaiting agent resp
 ### getCompletion
 
 ```ts
-getCompletion(mode: ExecutionMode, tools: IAgentTool[]): Promise<IModelMessage>;
+getCompletion(mode: ExecutionMode, tools: IAgentTool[]): Promise<ISwarmMessage>;
 ```
 
 Retrieves a completion message from the model using the current history and tools.

docs/classes/ClientCompute.md

@@ -23,18 +23,18 @@ constructor(params: IComputeParams<Compute>);
 params: IComputeParams<Compute>
 ```
 
-### __@DISPOSE_SLOT_FN_SYMBOL@3154
+### __@DISPOSE_SLOT_FN_SYMBOL@3157
 
 ```ts
-__@DISPOSE_SLOT_FN_SYMBOL@3154: any
+__@DISPOSE_SLOT_FN_SYMBOL@3157: any
 ```
 
 Stores the composed dispose function.
 
-### __@GET_COMPUTE_DATA_FN_SYMBOL@3155
+### __@GET_COMPUTE_DATA_FN_SYMBOL@3158
 
 ```ts
-__@GET_COMPUTE_DATA_FN_SYMBOL@3155: any
+__@GET_COMPUTE_DATA_FN_SYMBOL@3158: any
 ```
 
 Memoized function for retrieving compute data.

docs/classes/ClientHistory.md

@@ -30,7 +30,7 @@ params: IHistoryParams
 ### _filterCondition
 
 ```ts
-_filterCondition: (message: IModelMessage<object>) => boolean
+_filterCondition: (message: ISwarmMessage<object>) => boolean
 ```
 
 Filter condition function for toArrayForAgent, used to filter messages based on agent-specific criteria.
@@ -41,7 +41,7 @@ Initialized from GLOBAL_CONFIG.CC_AGENT_HISTORY_FILTER, applied to common messag
 ### push
 
 ```ts
-push<Payload extends object = object>(message: IModelMessage<Payload>): Promise<void>;
+push<Payload extends object = object>(message: ISwarmMessage<Payload>): Promise<void>;
 ```
 
 Pushes a message into the history and emits a corresponding event via BusService.
@@ -50,7 +50,7 @@ Adds the message to the underlying storage (params.items) and notifies the syste
 ### pop
 
 ```ts
-pop(): Promise<IModelMessage | null>;
+pop(): Promise<ISwarmMessage | null>;
 ```
 
 Removes and returns the most recent message from the history, emitting an event via BusService.
@@ -60,7 +60,7 @@ Useful for ClientAgent to undo recent actions or inspect the latest entry.
 ### toArrayForRaw
 
 ```ts
-toArrayForRaw(): Promise<IModelMessage[]>;
+toArrayForRaw(): Promise<ISwarmMessage[]>;
 ```
 
 Converts the history into an array of raw messages without filtering or transformation.
@@ -69,7 +69,7 @@ Iterates over params.items to collect all messages as-is, useful for debugging o
 ### toArrayForAgent
 
 ```ts
-toArrayForAgent(prompt: string, system?: string[]): Promise<IModelMessage[]>;
+toArrayForAgent(prompt: string, system?: string[]): Promise<ISwarmMessage[]>;
 ```
 
 Converts the history into an array of messages tailored for the agent, used by ClientAgent for completions.

docs/classes/ClientState.md

@@ -5,7 +5,7 @@ group: docs
 
 # ClientState
 
-Implements `IState<State>`, `IStateChangeContract`
+Implements `IState<State>`, `IStateChangeEvent`
 
 Class representing the client state in the swarm system, implementing the IState interface.
 Manages a single state object with queued read/write operations, middleware support, and event-driven updates via BusService.

docs/classes/CompletionSchemaService.md

@@ -61,7 +61,7 @@ Supports ClientAgent execution by ensuring completion schema validity before reg
 ### register
 
 ```ts
-register: (key: string, value: ICompletionSchema) => void
+register: (key: string, value: ICompletionSchema<IBaseMessage<any>>) => void
 ```
 
 Registers a new completion schema in the registry after validation.
@@ -72,7 +72,7 @@ Supports ClientAgent execution by providing validated completion schemas to Agen
 ### override
 
 ```ts
-override: (key: string, value: Partial<ICompletionSchema>) => ICompletionSchema
+override: (key: string, value: Partial<ICompletionSchema<IBaseMessage<any>>>) => ICompletionSchema<IBaseMessage<any>>
 ```
 
 Overrides an existing completion schema in the registry with a new one.
@@ -83,7 +83,7 @@ Supports dynamic updates to completion schemas used by AgentSchemaService, Clien
 ### get
 
 ```ts
-get: (key: string) => ICompletionSchema
+get: (key: string) => ICompletionSchema<IBaseMessage<any>>
 ```
 
 Retrieves a completion schema from the registry by its name.

docs/classes/HistoryConnectionService.md

@@ -80,7 +80,7 @@ Supports ClientAgent (history in EXECUTE_FN), AgentConnectionService (history pr
 ### push
 
 ```ts
-push: (message: IModelMessage<object>) => Promise<void>
+push: (message: ISwarmMessage<object>) => Promise<void>
 ```
 
 Pushes a message to the agent’s history.
@@ -90,7 +90,7 @@ Mirrors HistoryPublicService’s push, supporting ClientAgent’s history update
 ### pop
 
 ```ts
-pop: () => Promise<IModelMessage<object>>
+pop: () => Promise<ISwarmMessage<object>>
 ```
 
 Pops the most recent message from the agent’s history.
@@ -100,17 +100,17 @@ Mirrors HistoryPublicService’s pop, supporting ClientAgent’s history manipul
 ### toArrayForAgent
 
 ```ts
-toArrayForAgent: (prompt: string) => Promise<IModelMessage<object>[]>
+toArrayForAgent: (prompt: string) => Promise<ISwarmMessage<object>[]>
 ```
 
-Converts the agent’s history to an array formatted for agent use, incorporating a prompt.
+Converts the agent's history to an array formatted for agent use, incorporating a prompt.
 Delegates to ClientHistory.toArrayForAgent, using context from MethodContextService, logging via LoggerService if GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO is true.
-Mirrors HistoryPublicService’s toArrayForAgent, supporting ClientAgent’s execution context (e.g., EXECUTE_FN with prompt).
+Mirrors HistoryPublicService's toArrayForAgent, supporting ClientAgent's execution context (e.g., EXECUTE_FN with prompt).
 
 ### toArrayForRaw
 
 ```ts
-toArrayForRaw: () => Promise<IModelMessage<object>[]>
+toArrayForRaw: () => Promise<ISwarmMessage<object>[]>
 ```
 
 Converts the agent’s history to a raw array of messages.

docs/classes/HistoryPublicService.md

@@ -41,7 +41,7 @@ Provides core functionality (e.g., push, pop) called by public methods, aligning
 ### push
 
 ```ts
-push: (message: IModelMessage<object>, methodName: string, clientId: string, agentName: string) => Promise<void>
+push: (message: ISwarmMessage<object>, methodName: string, clientId: string, agentName: string) => Promise<void>
 ```
 
 Pushes a message to the agent’s history for a specific client and method context.
@@ -51,7 +51,7 @@ Used in AgentPublicService (e.g., commitSystemMessage, commitUserMessage) and Cl
 ### pop
 
 ```ts
-pop: (methodName: string, clientId: string, agentName: string) => Promise<IModelMessage<object>>
+pop: (methodName: string, clientId: string, agentName: string) => Promise<ISwarmMessage<object>>
 ```
 
 Pops the most recent message from the agent’s history.
@@ -61,17 +61,17 @@ Supports ClientAgent (e.g., retrieving last message in EXECUTE_FN) and AgentPubl
 ### toArrayForAgent
 
 ```ts
-toArrayForAgent: (prompt: string, methodName: string, clientId: string, agentName: string) => Promise<IModelMessage<object>[]>
+toArrayForAgent: (prompt: string, methodName: string, clientId: string, agentName: string) => Promise<ISwarmMessage<object>[]>
 ```
 
-Converts the agent’s history to an array tailored for agent processing, incorporating a prompt.
+Converts the agent's history to an array tailored for agent processing, incorporating a prompt.
 Wraps HistoryConnectionService.toArrayForAgent with MethodContextService, logging via LoggerService if GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO is true.
 Used in ClientAgent (e.g., EXECUTE_FN context preparation) and DocService (e.g., history documentation with prompts).
 
 ### toArrayForRaw
 
 ```ts
-toArrayForRaw: (methodName: string, clientId: string, agentName: string) => Promise<IModelMessage<object>[]>
+toArrayForRaw: (methodName: string, clientId: string, agentName: string) => Promise<ISwarmMessage<object>[]>
 ```
 
 Converts the agent’s history to a raw array of items.

docs/classes/SchemaUtils.md

@@ -16,10 +16,10 @@ constructor();
 
 ## Properties
 
-### __@PERSIST_WRITE_SYMBOL@4419
+### __@PERSIST_WRITE_SYMBOL@4438
 
 ```ts
-__@PERSIST_WRITE_SYMBOL@4419: any
+__@PERSIST_WRITE_SYMBOL@4438: any
 ```
 
 ### writeSessionMemory

docs/functions/chat.md

@@ -0,0 +1,20 @@
+---
+title: docs/api-reference/function/chat
+group: docs
+---
+
+# chat
+
+```ts
+declare function chat(completionName: CompletionName, messages: IBaseMessage[]): Promise<string>;
+```
+
+Processes a chat completion request by sending messages to a specified completion service.
+Delegates to an internal context-isolated function to ensure clean execution.
+
+## Parameters
+
+| Parameter | Description |
+|-----------|-------------|
+| `completionName` | The name of the completion service to use. |
+| `messages` | Array of messages representing the conversation history. |

docs/functions/getAgentHistory.md

@@ -6,7 +6,7 @@ group: docs
 # getAgentHistory
 
 ```ts
-declare function getAgentHistory(clientId: string, agentName: AgentName): Promise<IModelMessage<object>[]>;
+declare function getAgentHistory(clientId: string, agentName: AgentName): Promise<ISwarmMessage<object>[]>;
 ```
 
 Retrieves the history prepared for a specific agent, incorporating rescue algorithm tweaks.