Testing

@witqq/agent-sdk/testing

@witqq/agent-sdk/testing

Test utilities for consumers of the agent-sdk. Provides mock factories for IAgentService, IChatRuntime, and IChatClient.

Interfaces

MockAgentServiceOptions

Defined in: testing/mock-agent-service.ts:22

Options for createMockAgentService.

Properties

mockLLMBackend?

optional mockLLMBackend: MockLLMBackendOptions

Defined in: testing/mock-agent-service.ts:36

Opt-in: delegate to Mock LLM backend for richer simulation. When provided, createAgent() returns a full MockLLMAgent that participates in the BaseAgent lifecycle (retry, heartbeat, middleware, usage enrichment).

models?

optional models: ModelInfo[]

Defined in: testing/mock-agent-service.ts:26

Models to return from listModels().

name?

optional name: string

Defined in: testing/mock-agent-service.ts:24

Service name. Default: “mock”.

onRun()?

optional onRun: (prompt, options?) => Promise<AgentResult<void>>

Defined in: testing/mock-agent-service.ts:30

Custom run handler. Default: returns “Mock response”.

Parameters

prompt

MessageContent

options?

RunOptions

Returns

Promise<AgentResult<void>>

onStream()?

optional onStream: (prompt, options?) => AsyncIterable<AgentEvent>

Defined in: testing/mock-agent-service.ts:32

Custom stream handler. Default: yields text_delta + result events.

Parameters

prompt

MessageContent

options?

RunOptions

Returns

AsyncIterable<AgentEvent>

validationResult?

optional validationResult: ValidationResult

Defined in: testing/mock-agent-service.ts:28

Custom validation result. Default: { valid: true, errors: [] }.

---

MockChatClientOptions

Defined in: testing/mock-chat-client.ts:14

Options for createMockChatClient.

Properties

models?

optional models: ModelInfo[]

Defined in: testing/mock-chat-client.ts:18

Models to return from listModels().

onSend()?

optional onSend: (sessionId, message, options?) => AsyncIterable<ChatEvent>

Defined in: testing/mock-chat-client.ts:22

Custom send handler.

Parameters

sessionId

ChatIdLike

message

string

options?

SendMessageOptions

Returns

AsyncIterable<ChatEvent>

providers?

optional providers: ProviderConfig[]

Defined in: testing/mock-chat-client.ts:20

Providers to return from listProviders().

sessions?

optional sessions: ChatSession<Record<string, unknown>>[]

Defined in: testing/mock-chat-client.ts:16

Pre-seeded sessions.

---

MockMessageOptions

Defined in: testing/mock-data.ts:18

Options for createMockMessage.

Properties

id?

optional id: string

Defined in: testing/mock-data.ts:19

metadata?

optional metadata: Record<string, unknown>

Defined in: testing/mock-data.ts:24

parts?

optional parts: MessagePart[]

Defined in: testing/mock-data.ts:22

role?

optional role: "user" | "assistant" | "system"

Defined in: testing/mock-data.ts:20

status?

optional status: "error" | "streaming" | "pending" | "complete"

Defined in: testing/mock-data.ts:23

text?

optional text: string

Defined in: testing/mock-data.ts:21

---

MockRuntimeOptions

Defined in: testing/mock-runtime.ts:14

Options for createMockRuntime.

Properties

defaultBackend?

optional defaultBackend: string

Defined in: testing/mock-runtime.ts:16

Default backend name. Default: “mock”.

defaultModel?

optional defaultModel: string

Defined in: testing/mock-runtime.ts:18

Default model.

models?

optional models: ModelInfo[]

Defined in: testing/mock-runtime.ts:22

Models to return from listModels().

onSend()?

optional onSend: (sessionId, message, options?) => AsyncIterable<ChatEvent>

Defined in: testing/mock-runtime.ts:24

Custom send handler. When not provided, yields a single text_delta + done event.

Parameters

sessionId

ChatIdLike

message

string

options?

RuntimeSendOptions

Returns

AsyncIterable<ChatEvent>

sessions?

optional sessions: ChatSession<Record<string, unknown>>[]

Defined in: testing/mock-runtime.ts:20

Pre-seeded sessions.

---

MockSessionOptions

Defined in: testing/mock-data.ts:8

Options for createMockSession.

Properties

config?

optional config: Partial<ChatSessionConfig>

Defined in: testing/mock-data.ts:12

id?

optional id: string

Defined in: testing/mock-data.ts:9

messages?

optional messages: ChatMessage<unknown>[]

Defined in: testing/mock-data.ts:11

metadata?

optional metadata: Record<string, unknown>

Defined in: testing/mock-data.ts:13

status?

optional status: "active"

Defined in: testing/mock-data.ts:14

title?

optional title: string

Defined in: testing/mock-data.ts:10

Functions

createMockAgentService()

createMockAgentService(options?): IAgentService

Defined in: testing/mock-agent-service.ts:125

Create a mock IAgentService for testing agent-level code.

const service = createMockAgentService({ name: "test" });
const agent = service.createAgent({ model: "gpt-5-mini" });
const result = await agent.run("Hello");

For richer simulation with full BaseAgent lifecycle, pass mockLLMBackend:

const service = createMockAgentService({
  mockLLMBackend: { mode: { type: "echo" }, latency: { type: "fixed", ms: 50 } },
});

Parameters

options?

MockAgentServiceOptions = {}

Returns

IAgentService

---

createMockChatClient()

createMockChatClient(options?): IChatClient

Defined in: testing/mock-chat-client.ts:33

Create a mock IChatClient for testing React hooks that talk to RemoteChatClient.

const client = createMockChatClient({ providers: [{ id: "p1", backend: "copilot", model: "gpt-5-mini", label: "GPT Mini", createdAt: "" }] });
const providers = await client.listProviders();

Parameters

options?

MockChatClientOptions = {}

Returns

IChatClient

---

createMockMessage()

createMockMessage(options?): ChatMessage

Defined in: testing/mock-data.ts:64

Create a mock ChatMessage for testing.

const msg = createMockMessage({ role: "user", text: "Hello" });

Parameters

options?

MockMessageOptions = {}

Returns

ChatMessage

---

createMockRuntime()

createMockRuntime(options?): IChatRuntime

Defined in: testing/mock-runtime.ts:35

Create a mock IChatRuntime for testing chat UI hooks and components.

const runtime = createMockRuntime({ defaultModel: "gpt-5-mini" });
const session = await runtime.createSession({});

Parameters

options?

MockRuntimeOptions = {}

Returns

IChatRuntime

---

createMockSession()

createMockSession(options?): ChatSession

Defined in: testing/mock-data.ts:34

Create a mock ChatSession for testing.

const session = createMockSession({ title: "Test chat" });

Parameters

options?

MockSessionOptions = {}

Returns

ChatSession