agent-swarm-kit 1.0.111 → 1.0.113

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agent-swarm-kit",
-  "version": "1.0.111",
+  "version": "1.0.113",
   "description": "A TypeScript library for building orchestrated framework-agnostic multi-agent AI systems",
   "author": {
     "name": "Petr Tripolsky",

package/types.d.ts

@@ -408,6 +408,11 @@ interface IState<T extends IStateData = IStateData> {
      * @returns {Promise<T>} - The updated state.
      */
     setState: (dispatchFn: (prevState: T) => Promise<T>) => Promise<T>;
+    /**
+     * Set the state to initial value
+     * @returns {Promise<T>} - The initial state.
+     */
+    clearState: () => Promise<T>;
 }
 /**
  * The name of the state.
@@ -712,6 +717,11 @@ interface ISession {
      * @returns {Promise<void>}
      */
     commitFlush: () => Promise<void>;
+    /**
+     * Prevent the next tool from being executed
+     * @returns {Promise<void>}
+     */
+    commitStopTools: () => Promise<void>;
     /**
      * Commit a system message.
      * @param {string} message - The message to commit.
@@ -1487,11 +1497,21 @@ interface IAgent {
      * @returns A promise that resolves when the flush is committed.
      */
     commitFlush(): Promise<void>;
+    /**
+     * Prevent the next tool from being executed
+     * @returns A promise that resolves when the tool stop is committed.
+     */
+    commitStopTools(): Promise<void>;
     /**
      * Unlock the queue on agent change. Stop the next tool execution
      * @returns A promise that resolves when the agent change is committed.
      */
     commitAgentChange(): Promise<void>;
+    /**
+     * Prevent the next tool from execution
+     * @returns A promise that resolves when the tool stop is committed.
+     */
+    commitStopTools(): Promise<void>;
 }
 /** Type representing the name of an agent. */
 type AgentName = string;
@@ -1556,6 +1576,7 @@ declare class LoggerService implements ILogger {
 
 declare const AGENT_CHANGE_SYMBOL: unique symbol;
 declare const TOOL_ERROR_SYMBOL: unique symbol;
+declare const TOOL_STOP_SYMBOL: unique symbol;
 /**
  * Represents a client agent that interacts with the system.
  * @implements {IAgent}
@@ -1564,6 +1585,7 @@ declare class ClientAgent implements IAgent {
     readonly params: IAgentParams;
     readonly _agentChangeSubject: Subject<typeof AGENT_CHANGE_SYMBOL>;
     readonly _toolErrorSubject: Subject<typeof TOOL_ERROR_SYMBOL>;
+    readonly _toolStopSubject: Subject<typeof TOOL_STOP_SYMBOL>;
     readonly _toolCommitSubject: Subject<void>;
     readonly _outputSubject: Subject<string>;
     /**
@@ -1611,6 +1633,11 @@ declare class ClientAgent implements IAgent {
      * @returns {Promise<void>}
      */
     commitAgentChange: () => Promise<void>;
+    /**
+     * Commits change of agent to prevent the next tool execution from being called.
+     * @returns {Promise<void>}
+     */
+    commitStopTools: () => Promise<void>;
     /**
      * Commits a system message to the history.
      * @param {string} message - The system message to commit.
@@ -1704,6 +1731,11 @@ declare class AgentConnectionService implements IAgent {
      * @returns {Promise<any>} The commit result.
      */
     commitAgentChange: () => Promise<void>;
+    /**
+     * Prevent the next tool from being executed
+     * @returns {Promise<any>} The commit result.
+     */
+    commitStopTools: () => Promise<void>;
     /**
      * Commits flush of agent history
      * @returns {Promise<any>} The commit result.
@@ -2050,6 +2082,11 @@ declare class ClientSession implements ISession {
      * @returns {Promise<void>}
      */
     commitFlush: () => Promise<void>;
+    /**
+     * Commits stop of the nexttool execution
+     * @returns {Promise<void>}
+     */
+    commitStopTools: () => Promise<void>;
     /**
      * Commits a system message.
      * @param {string} message - The system message to commit.
@@ -2141,6 +2178,12 @@ declare class SessionConnectionService implements ISession {
      * @returns {Promise<void>} A promise that resolves when the message is committed.
      */
     commitFlush: () => Promise<void>;
+    /**
+     * Commits user message to the agent without answer.
+     * @param {string} message - The message to commit.
+     * @returns {Promise<void>} A promise that resolves when the message is committed.
+     */
+    commitStopTools: () => Promise<void>;
     /**
      * Disposes of the session connection service.
      * @returns {Promise<void>} A promise that resolves when the service is disposed.
@@ -2231,6 +2274,13 @@ declare class AgentPublicService implements TAgentConnectionService {
      * @returns {Promise<unknown>} The commit result.
      */
     commitAgentChange: (methodName: string, clientId: string, agentName: AgentName) => Promise<void>;
+    /**
+     * Prevent the next tool from being executed
+     * @param {string} clientId - The client ID.
+     * @param {AgentName} agentName - The name of the agent.
+     * @returns {Promise<unknown>} The commit result.
+     */
+    commitStopTools: (methodName: string, clientId: string, agentName: AgentName) => Promise<void>;
     /**
      * Disposes of the agent.
      * @param {string} clientId - The client ID.
@@ -2365,6 +2415,13 @@ declare class SessionPublicService implements TSessionConnectionService {
      * @returns {Promise<void>}
      */
     commitFlush: (methodName: string, clientId: string, swarmName: SwarmName) => Promise<void>;
+    /**
+     * Prevent the next tool from being executed
+     * @param {string} clientId - The client ID.
+     * @param {SwarmName} swarmName - The swarm name.
+     * @returns {Promise<void>}
+     */
+    commitStopTools: (methodName: string, clientId: string, swarmName: SwarmName) => Promise<void>;
     /**
      * Disposes of the session.
      * @param {string} clientId - The client ID.
@@ -3013,6 +3070,11 @@ declare class ClientState<State extends IStateData = IStateData> implements ISta
      * @returns {Promise<State>}
      */
     setState: (dispatchFn: DispatchFn<State>) => Promise<State>;
+    /**
+     * Sets the to initial value
+     * @returns {Promise<State>}
+     */
+    clearState: () => Promise<State>;
     /**
      * Gets the current state.
      * @returns {Promise<State>}
@@ -3051,6 +3113,11 @@ declare class StateConnectionService<T extends IStateData = IStateData> implemen
      * @returns {Promise<T>} The new state.
      */
     setState: (dispatchFn: (prevState: T) => Promise<T>) => Promise<T>;
+    /**
+     * Set the state to initial value
+     * @returns {Promise<T>} The initial state.
+     */
+    clearState: () => Promise<T>;
     /**
      * Gets the state.
      * @returns {Promise<T>} The current state.
@@ -3083,6 +3150,13 @@ declare class StatePublicService<T extends IStateData = IStateData> implements T
      * @returns {Promise<T>} - The updated state.
      */
     setState: (dispatchFn: (prevState: T) => Promise<T>, methodName: string, clientId: string, stateName: StateName) => Promise<T>;
+    /**
+     * Set the state to initial value
+     * @param {string} clientId - The client ID.
+     * @param {StateName} stateName - The name of the state.
+     * @returns {Promise<T>} - The initial state.
+     */
+    clearState: (methodName: string, clientId: string, stateName: StateName) => Promise<T>;
     /**
      * Gets the current state.
      * @param {string} clientId - The client ID.
@@ -3330,6 +3404,11 @@ declare class SharedStateConnectionService<T extends IStateData = IStateData> im
      * @returns {Promise<T>} The new state.
      */
     setState: (dispatchFn: (prevState: T) => Promise<T>) => Promise<T>;
+    /**
+     * Set the state to initial value
+     * @returns {Promise<T>} The new state.
+     */
+    clearState: () => Promise<T>;
     /**
      * Gets the state.
      * @returns {Promise<T>} The current state.
@@ -3356,6 +3435,12 @@ declare class SharedStatePublicService<T extends IStateData = IStateData> implem
      * @returns {Promise<T>} - The updated state.
      */
     setState: (dispatchFn: (prevState: T) => Promise<T>, methodName: string, stateName: StateName) => Promise<T>;
+    /**
+     * Set the state to initial value
+     * @param {StateName} stateName - The name of the state.
+     * @returns {Promise<T>} - The initial state.
+     */
+    clearState: (methodName: string, stateName: StateName) => Promise<T>;
     /**
      * Gets the current state.
      * @param {StateName} stateName - The name of the state.
@@ -3661,6 +3746,23 @@ declare const cancelOutput: (clientId: string, agentName: string) => Promise<voi
  */
 declare const cancelOutputForce: (clientId: string) => Promise<void>;
 
+/**
+ * Prevent the next tool from being executed
+ *
+ * @param {string} clientId - The ID of the client.
+ * @param {string} agentName - The name of the agent.
+ * @returns {Promise<void>} - A promise that resolves when the message is committed.
+ */
+declare const commitStopTools: (clientId: string, agentName: string) => Promise<void>;
+
+/**
+ * Prevent the next tool from being executed without active agent check
+ *
+ * @param {string} clientId - The ID of the client.
+ * @returns {Promise<void>} - A promise that resolves when the message is committed.
+ */
+declare const commitStopToolsForce: (clientId: string) => Promise<void>;
+
 /**
  * Emits a string constant as the model output without executing incoming message and checking active agent
  * Works only for `makeConnection`
@@ -4334,6 +4436,21 @@ declare class StateUtils implements TState {
         agentName: AgentName;
         stateName: StateName;
     }) => Promise<void>;
+    /**
+     * Set the state to initial value
+     * @template T
+     * @param {Object} payload - The payload containing client and state information.
+     * @param {string} payload.clientId - The client ID.
+     * @param {AgentName} payload.agentName - The agent name.
+     * @param {StateName} payload.stateName - The state name.
+     * @returns {Promise<void>}
+     * @throws Will throw an error if the state is not registered in the agent.
+     */
+    clearState: <T extends unknown = any>(payload: {
+        clientId: string;
+        agentName: AgentName;
+        stateName: StateName;
+    }) => Promise<T>;
 }
 /**
  * Instance of StateUtils for managing state.
@@ -4376,6 +4493,19 @@ declare class SharedStateUtils implements TSharedState {
         agentName: AgentName;
         stateName: StateName;
     }) => Promise<void>;
+    /**
+     * Set the state to initial value
+     * @template T
+     * @param {Object} payload - The payload containing client and state information.
+     * @param {AgentName} payload.agentName - The agent name.
+     * @param {StateName} payload.stateName - The state name.
+     * @returns {Promise<void>}
+     * @throws Will throw an error if the state is not registered in the agent.
+     */
+    clearState: <T extends unknown = any>(payload: {
+        agentName: AgentName;
+        stateName: StateName;
+    }) => Promise<T>;
 }
 /**
  * Instance of SharedStateUtils for managing state.
@@ -4581,4 +4711,4 @@ declare class SchemaUtils {
  */
 declare const Schema: SchemaUtils;
 
-export { type EventSource, ExecutionContextService, History, HistoryAdapter, HistoryInstance, type IAgentSchema, type IAgentTool, type IBaseEvent, type IBusEvent, type IBusEventContext, type ICompletionArgs, type ICompletionSchema, type ICustomEvent, type IEmbeddingSchema, type IHistoryAdapter, type IHistoryInstance, type IHistoryInstanceCallbacks, type IIncomingMessage, type ILoggerAdapter, type ILoggerInstance, type ILoggerInstanceCallbacks, type IMakeConnectionConfig, type IMakeDisposeParams, type IModelMessage, type IOutgoingMessage, type ISessionConfig, type IStateSchema, type IStorageSchema, type ISwarmSchema, type ITool, type IToolCall, Logger, LoggerAdapter, LoggerInstance, MethodContextService, type ReceiveMessageFn, Schema, type SendMessageFn$1 as SendMessageFn, SharedState, SharedStorage, State, Storage, addAgent, addCompletion, addEmbedding, addState, addStorage, addSwarm, addTool, cancelOutput, cancelOutputForce, changeToAgent, changeToDefaultAgent, changeToPrevAgent, commitAssistantMessage, commitAssistantMessageForce, commitFlush, commitFlushForce, commitSystemMessage, commitSystemMessageForce, commitToolOutput, commitToolOutputForce, commitUserMessage, commitUserMessageForce, complete, disposeConnection, dumpAgent, dumpDocs, dumpSwarm, emit, emitForce, event, execute, executeForce, getAgentHistory, getAgentName, getAssistantHistory, getLastAssistantMessage, getLastSystemMessage, getLastUserMessage, getRawHistory, getSessionMode, getUserHistory, listenAgentEvent, listenAgentEventOnce, listenEvent, listenEventOnce, listenHistoryEvent, listenHistoryEventOnce, listenSessionEvent, listenSessionEventOnce, listenStateEvent, listenStateEventOnce, listenStorageEvent, listenStorageEventOnce, listenSwarmEvent, listenSwarmEventOnce, makeAutoDispose, makeConnection, session, setConfig, swarm };
+export { type EventSource, ExecutionContextService, History, HistoryAdapter, HistoryInstance, type IAgentSchema, type IAgentTool, type IBaseEvent, type IBusEvent, type IBusEventContext, type ICompletionArgs, type ICompletionSchema, type ICustomEvent, type IEmbeddingSchema, type IHistoryAdapter, type IHistoryInstance, type IHistoryInstanceCallbacks, type IIncomingMessage, type ILoggerAdapter, type ILoggerInstance, type ILoggerInstanceCallbacks, type IMakeConnectionConfig, type IMakeDisposeParams, type IModelMessage, type IOutgoingMessage, type ISessionConfig, type IStateSchema, type IStorageSchema, type ISwarmSchema, type ITool, type IToolCall, Logger, LoggerAdapter, LoggerInstance, MethodContextService, type ReceiveMessageFn, Schema, type SendMessageFn$1 as SendMessageFn, SharedState, SharedStorage, State, Storage, addAgent, addCompletion, addEmbedding, addState, addStorage, addSwarm, addTool, cancelOutput, cancelOutputForce, changeToAgent, changeToDefaultAgent, changeToPrevAgent, commitAssistantMessage, commitAssistantMessageForce, commitFlush, commitFlushForce, commitStopTools, commitStopToolsForce, commitSystemMessage, commitSystemMessageForce, commitToolOutput, commitToolOutputForce, commitUserMessage, commitUserMessageForce, complete, disposeConnection, dumpAgent, dumpDocs, dumpSwarm, emit, emitForce, event, execute, executeForce, getAgentHistory, getAgentName, getAssistantHistory, getLastAssistantMessage, getLastSystemMessage, getLastUserMessage, getRawHistory, getSessionMode, getUserHistory, listenAgentEvent, listenAgentEventOnce, listenEvent, listenEventOnce, listenHistoryEvent, listenHistoryEventOnce, listenSessionEvent, listenSessionEventOnce, listenStateEvent, listenStateEventOnce, listenStorageEvent, listenStorageEventOnce, listenSwarmEvent, listenSwarmEventOnce, makeAutoDispose, makeConnection, session, setConfig, swarm };