Class ScenarioExecutionState

constructor

• new ScenarioExecutionState(config: ScenarioConfig): ScenarioExecutionState

  Parameters

  • config: ScenarioConfig

  Returns ScenarioExecutionState

_executor

config

description

Readonlyevents$

currentTurn

• get currentTurn(): number

  The current turn number in the scenario.

  Returns number

• set currentTurn(turn: number): void

  The current turn number in the scenario.

  Parameters

  • turn: number

  Returns void

messages

• get messages(): ModelMessage[]

  The sequence of messages exchanged during the scenario.

  Returns ModelMessage[]

threadId

• get threadId(): string

  The unique identifier for the execution thread.

  Returns string

• set threadId(value: string): void

  The unique identifier for the execution thread.

  Parameters

  • value: string

  Returns void

addMessage

• addMessage(message: ModelMessage & { traceId?: string }): void

  Adds a message to the conversation history.

  Parameters

  • message: ModelMessage & { traceId?: string }

    The message to add.

  Returns void

hasToolCall

• hasToolCall(toolName: string): boolean

  Checks if a tool call for a specific tool exists in the execution state.

  Parameters

  • toolName: string

    The name of the tool.

  Returns boolean

  True if the tool call exists, false otherwise.

lastAgentMessage

• lastAgentMessage(): AssistantModelMessage & { traceId?: string }

  Retrieves the last agent message from the execution state.

  Returns AssistantModelMessage & { traceId?: string }

  The last agent message.

lastMessage

• lastMessage(): ModelMessage & { id: string; traceId?: string }

  Retrieves the last message from the execution state.

  Returns ModelMessage & { id: string; traceId?: string }

  The last message.

lastToolCall

• lastToolCall(toolName: string): ToolModelMessage & { traceId?: string }

  Retrieves the last tool call message for a specific tool.

  Parameters

  • toolName: string

    The name of the tool.

  Returns ToolModelMessage & { traceId?: string }

  The last tool call message.

lastUserMessage

• lastUserMessage(): UserModelMessage & { id: string; traceId?: string }

  Retrieves the last user message from the execution state.

  Returns UserModelMessage & { id: string; traceId?: string }

  The last user message.

rollbackMessagesTo

• rollbackMessagesTo(index: number): ModelMessage[]

  Remove all messages from position index onward.

  Truncates the internal message list and notifies the executor (via the registered rollback handler) to clean pending queues.

  Note: This method is safe to call only during an agent's call() invocation. The executor runs agents sequentially, so no other agent can observe stale newMessages references. Calling this from outside that flow may leave already-delivered newMessages out of sync.

  Parameters

  • index: number

    Truncate point (clamped to [0, messages.length]). Messages at positions >= index are removed.

  Returns ModelMessage[]

  The removed messages (empty array if nothing to remove).

  Throws

  If index is negative.

setExecutor

• setExecutor(executor: object): void

  Set the back-reference; called once by the executor's constructor.

  Parameters

  • executor: object

  Returns void

setOnRollback

• setOnRollback(handler: (removedSet: Set<object>) => void): void

  Register a callback that fires when messages are rolled back. The executor uses this to clean up its pending message queues.

  Parameters

  • handler: (removedSet: Set<object>) => void

  Returns void