@tanstack/ai-client 0.34.0 → 0.36.0

package/dist/esm/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../src/types.ts"],"sourcesContent":["import type {\n  AnyClientTool,\n  ApprovalCapabilityOf,\n  ApprovalSchemaOf,\n  AudioPart,\n  BatchInterruptError,\n  ChunkStrategy,\n  ContentPart,\n  DocumentPart,\n  ImagePart,\n  InferSchemaType,\n  InterruptDefinition,\n  InferToolInput,\n  InferToolOutput,\n  InputSchemaOf,\n  Interrupt,\n  InterruptBinding,\n  ItemInterruptError,\n  ModelMessage,\n  NoSchema,\n  RunAgentResumeItem,\n  SchemaInput,\n  StreamChunk,\n  StructuredOutputPart,\n  SubagentHandleData,\n  SubagentStatus,\n  UIResourcePart,\n  VideoPart,\n} from '@tanstack/ai/client'\nimport type { ByokClient } from './byok'\nimport type { ConnectionAdapter } from './connection-adapters'\nimport type { AIDevtoolsClientMetadata } from './devtools'\nimport type { ChatDevtoolsBridgeFactory } from './devtools-noop'\n\nexport type { StructuredOutputPart }\n\nexport interface ChatResumeState {\n  threadId: string\n  runId: string\n}\n\nexport type ChatPendingInterrupt = Interrupt\n\n/**\n * The durable pointer a chat keeps for the run it may need to rejoin, plus any\n * interrupt that run is waiting on.\n *\n * @internal\n */\nexport interface ChatResumeSnapshot {\n  resumeState: ChatResumeState\n  pendingInterrupts?: Array<ChatPendingInterrupt>\n}\n\nexport type InterruptItemStatus =\n  | 'pending'\n  | 'validating'\n  | 'staged'\n  | 'submitting'\n  | 'error'\n\nexport interface BoundInterruptBase {\n  readonly id: string\n  readonly interruptId: string\n  readonly reason: string\n  readonly message?: string\n  readonly responseSchema?: Readonly<Record<string, unknown>>\n  readonly expiresAt?: string\n  readonly metadata?: Readonly<Record<string, unknown>>\n  readonly threadId: string\n  readonly interruptedRunId: string\n  readonly generation: number\n  readonly status: InterruptItemStatus\n  readonly errors: ReadonlyArray<ItemInterruptError>\n  /** @deprecated Use `errors[0]`. */\n  readonly error?: ItemInterruptError\n  /**\n   * Whether the binding/schema allows resolution at hydrate time.\n   * Does not flip on submit/expiry — gate UI on `status`, `resuming`, and\n   * `errors` for those lifecycle states.\n   */\n  readonly canResolve: boolean\n  cancel: () => void\n  clearResolution: () => void\n}\n\nexport interface GenericAGUIInterrupt extends BoundInterruptBase {\n  readonly kind: 'generic'\n  readonly binding: Readonly<Extract<InterruptBinding, { kind: 'generic' }>>\n  resolveInterrupt: (payload: unknown) => void\n}\n\ntype InterruptResponseInput<TDefinition> =\n  TDefinition extends InterruptDefinition<any, any, infer TResponseSchema, any>\n    ? InferSchemaType<TResponseSchema>\n    : never\n\ntype RegisteredGenericInterruptFor<\n  TDefinition extends InterruptDefinition<any, any, any, any>,\n> =\n  TDefinition extends InterruptDefinition<\n    infer TDefinitionId,\n    any,\n    any,\n    infer TPayload\n  >\n    ? BoundInterruptBase & {\n        readonly kind: 'generic'\n        readonly definitionId: TDefinitionId\n        readonly key: string\n        readonly payload: TPayload | undefined\n        readonly binding: Readonly<\n          Extract<InterruptBinding, { kind: 'generic' }> & {\n            definitionId: TDefinitionId\n            key: string\n            batchIndex: number\n          }\n        >\n        resolveInterrupt: (\n          response: InterruptResponseInput<TDefinition>,\n        ) => void\n      }\n    : never\n\nexport type RegisteredGenericInterrupt<\n  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>>,\n> = TInterrupts[number] extends infer TDefinition\n  ? TDefinition extends InterruptDefinition<any, any, any, any>\n    ? RegisteredGenericInterruptFor<TDefinition>\n    : never\n  : never\n\n/** A bound generic interrupt for one `defineInterrupt()` definition. */\nexport type GenericInterrupt<\n  TDefinition extends InterruptDefinition<any, any, any, any>,\n> = RegisteredGenericInterruptFor<TDefinition>\n\n/**\n * An interrupt that arrived on the stream carrying no resume binding this\n * client understands — no `tanstack:interruptBinding`, or one written at a\n * protocol version we don't recognise.\n *\n * These are surfaced rather than hidden so a UI can show that the run is\n * paused, but they are never resolvable here: something else owns them. A\n * workflow engine's durable approval projected into the same AG-UI stream\n * lands in this bucket, and resolving it through the chat resume path would\n * send an answer no one is waiting for. Render it, or route it to whatever\n * actually owns the pause.\n */\nexport interface UnboundInterrupt extends Omit<\n  BoundInterruptBase,\n  'cancel' | 'clearResolution'\n> {\n  readonly kind: 'unbound'\n  readonly binding?: undefined\n  readonly canResolve: false\n}\n\ntype ApprovalBranchSchema<TTool, TBranch extends 'approve' | 'reject'> =\n  ApprovalSchemaOf<TTool> extends infer TApproval\n    ? TApproval extends { approve?: SchemaInput; reject?: SchemaInput }\n      ? Exclude<TApproval[TBranch], undefined>\n      : TApproval extends SchemaInput\n        ? TApproval\n        : never\n    : never\n\ntype ApprovalEdits<TTool> =\n  InputSchemaOf<TTool> extends NoSchema\n    ? { editedArgs?: never }\n    : { editedArgs?: InferToolInput<TTool> }\n\ntype ApprovalPayload<TSchema> = [TSchema] extends [never]\n  ? { payload?: never }\n  : TSchema extends SchemaInput\n    ? { payload: InferSchemaType<TSchema> }\n    : { payload?: never }\n\ntype ApproveArguments<TTool> = [\n  ApprovalBranchSchema<TTool, 'approve'>,\n] extends [never]\n  ? InputSchemaOf<TTool> extends NoSchema\n    ? [options?: never]\n    : [options?: ApprovalEdits<TTool> & { payload?: never }]\n  : [\n      options: ApprovalEdits<TTool> &\n        ApprovalPayload<ApprovalBranchSchema<TTool, 'approve'>>,\n    ]\n\ntype RejectArguments<TTool> = [ApprovalBranchSchema<TTool, 'reject'>] extends [\n  never,\n]\n  ? [options?: never]\n  : [\n      options: { editedArgs?: never } & ApprovalPayload<\n        ApprovalBranchSchema<TTool, 'reject'>\n      >,\n    ]\n\nexport type ToolApprovalInterrupt<TTool extends AnyClientTool = AnyClientTool> =\n  TTool extends AnyClientTool\n    ? BoundInterruptBase & {\n        readonly kind: 'tool-approval'\n        readonly binding: Readonly<\n          Extract<InterruptBinding, { kind: 'tool-approval' }>\n        >\n        readonly toolName: TTool['name']\n        readonly toolCallId: string\n        readonly originalArgs: InferToolInput<TTool>\n        // A single generic call signature — not two overloads. Overloads break\n        // editor autocomplete: a half-typed options literal (e.g.\n        // `resolveInterrupt(true, { payload: {` ) satisfies neither overload,\n        // so TS resolves no signature and offers no contextual completions.\n        // Making `approved` a generic discriminant lets TS infer it from the\n        // first argument and pick the matching branch for the rest params, so\n        // `payload` / `editedArgs` / the correct schema's fields complete\n        // per-branch (a plain union-of-tuples would offer both branches'\n        // fields) while still enforcing the right shape.\n        resolveInterrupt: <TApproved extends boolean>(\n          approved: TApproved,\n          ...args: TApproved extends true\n            ? ApproveArguments<TTool>\n            : RejectArguments<TTool>\n        ) => void\n      }\n    : never\n\ntype ApprovalInterrupts<TTools extends ReadonlyArray<AnyClientTool>> =\n  TTools[number] extends infer TTool\n    ? TTool extends AnyClientTool\n      ? ApprovalCapabilityOf<TTool> extends true\n        ? ToolApprovalInterrupt<TTool>\n        : never\n      : never\n    : never\n\n// Client tools resolve through their `.client()` implementation (auto-run) or\n// `addToolResult` — never as a bound interrupt. The `client-tool-execution`\n// pause is handled internally and is intentionally absent from this public\n// union.\nexport type ChatInterrupt<\n  TTools extends ReadonlyArray<AnyClientTool> = ReadonlyArray<AnyClientTool>,\n  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> =\n    readonly [],\n> =\n  | GenericAGUIInterrupt\n  | RegisteredGenericInterrupt<TInterrupts>\n  | UnboundInterrupt\n  | ApprovalInterrupts<TTools>\n\nexport type ResolvableChatInterrupt<\n  TTools extends ReadonlyArray<AnyClientTool> = ReadonlyArray<AnyClientTool>,\n  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> =\n    readonly [],\n> =\n  | GenericAGUIInterrupt\n  | RegisteredGenericInterrupt<TInterrupts>\n  | ApprovalInterrupts<TTools>\n\nexport type BoundInterrupts<\n  TTools extends ReadonlyArray<AnyClientTool> = ReadonlyArray<AnyClientTool>,\n  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> =\n    readonly [],\n> = ReadonlyArray<ChatInterrupt<TTools, TInterrupts>>\n\nexport interface ChatInterruptState<\n  TTools extends ReadonlyArray<AnyClientTool> = ReadonlyArray<AnyClientTool>,\n  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> =\n    readonly [],\n> {\n  readonly interrupts: BoundInterrupts<TTools, TInterrupts>\n  /** @deprecated Use `interrupts`. Same snapshot today. */\n  readonly pendingInterrupts: BoundInterrupts<TTools, TInterrupts>\n  readonly interruptErrors: ReadonlyArray<BatchInterruptError>\n  readonly resuming: boolean\n}\n\n/**\n * `messages` is the full UIMessage history (not a delta). `data` is the\n * merged body — `ChatClientOptions.body` plus any per-call data passed to\n * `sendMessage(...)`. `threadId` / `runId` are the AG-UI correlation ids\n * the chat client uses to track this turn — forward them to your server\n * if it needs to correlate requests.\n */\nexport interface ChatFetcherInput {\n  messages: Array<UIMessage>\n  data?: Record<string, unknown>\n  threadId: string\n  runId: string\n  parentRunId?: string\n  resume?: Array<RunAgentResumeItem>\n}\n\nexport interface ChatFetcherOptions {\n  /** Fires when `stop()` is called or the request is superseded. */\n  signal: AbortSignal\n  /** Extra request headers for this run (e.g. BYOK keys). */\n  headers?: Record<string, string>\n}\n\n/**\n * Direct function that performs a chat request. Mirrors\n * `GenerationFetcher`. Returns either a `Response` (SSE body parsed by the\n * chat client) or an `AsyncIterable<StreamChunk>` (yielded directly). May\n * return the value synchronously, as a `Promise`, or as an async generator\n * (`async function*`) — the chat client awaits whichever shape is returned.\n *\n * @example\n * ```ts\n * useChat({\n *   fetcher: ({ messages }, { signal }) =>\n *     chatFn({ data: { messages }, signal }),\n * })\n * ```\n */\nexport type ChatFetcher = (\n  input: ChatFetcherInput,\n  options: ChatFetcherOptions,\n) =>\n  | Response\n  | AsyncIterable<StreamChunk>\n  | Promise<Response | AsyncIterable<StreamChunk>>\n\n/**\n * Distributive `Omit` — applies `Omit<O, K>` per branch of a union so\n * discriminated unions survive omission. Plain `Omit` collapses unions\n * into a single object shape, which would erase the `ChatTransport` XOR\n * when framework hooks omit React-managed callbacks from\n * `ChatClientOptions`.\n */\nexport type DistributedOmit<\n  TObject,\n  TKeys extends keyof any,\n> = TObject extends unknown ? Omit<TObject, TKeys> : never\n\n/**\n * Discriminated union enforcing that exactly one of `connection` or\n * `fetcher` is provided. Mirrors `GenerationTransport`.\n */\nexport type ChatTransport =\n  | { connection: ConnectionAdapter; fetcher?: never }\n  | { fetcher: ChatFetcher; connection?: never }\n\n/**\n * Tool call states - track the lifecycle of a tool call\n */\nexport type ToolCallState =\n  | 'awaiting-input' // Received start but no arguments yet\n  | 'input-streaming' // Partial arguments received\n  | 'input-complete' // All arguments received\n  | 'approval-requested' // Waiting for user approval\n  | 'approval-responded' // User has approved/denied\n  | 'complete' // Result is complete\n  | 'error' // Tool execution failed (terminal)\n\n/**\n * Tool result states - track the lifecycle of a tool result\n */\nexport type ToolResultState =\n  | 'streaming' // Placeholder for future streamed output\n  | 'complete' // Result is complete\n  | 'error' // Error occurred\n\n/**\n * ChatClient state - track the lifecycle of a chat\n */\nexport type ChatClientState = 'ready' | 'submitted' | 'streaming' | 'error'\n\n/**\n * Connection lifecycle state for the subscription loop.\n */\nexport type ConnectionStatus =\n  | 'disconnected'\n  | 'connecting'\n  | 'connected'\n  | 'error'\n\n/**\n * Multimodal content input for sending messages with rich media.\n * Allows sending text, images, audio, video, and documents to the LLM.\n *\n * @example\n * ```ts\n * // Send an image with a question\n * client.sendMessage({\n *   content: [\n *     { type: 'text', content: 'What is in this image?' },\n *     { type: 'image', source: { type: 'url', value: 'https://example.com/photo.jpg' } }\n *   ],\n *   id: 'custom-message-id' // optional\n * })\n * ```\n */\nexport interface MultimodalContent {\n  /**\n   * The content of the message.\n   * Can be a simple string or an array of content parts for multimodal messages.\n   */\n  content: string | Array<ContentPart>\n  /**\n   * Optional custom ID for the message.\n   * If not provided, a unique ID will be generated.\n   */\n  id?: string\n  /**\n   * Optional AG-UI metadata bag copied onto the resulting UIMessage.\n   *\n   * @example\n   * ```ts\n   * await client.sendMessage({\n   *   content: 'Show me failed logins',\n   *   metadata: { author: { id: 'user-42', name: 'Dana' } },\n   * })\n   * ```\n   */\n  metadata?: Record<string, any>\n}\n\n/**\n * Action taken when `sendMessage` is called while the client is busy\n * (streaming, claiming a send, or draining the queue).\n * - `queue`: hold the message; it auto-sends when the current run settles\n *   **successfully**.\n * - `drop`: ignore the send (promise still resolves; does not throw).\n * - `interrupt`: abort the current stream and send immediately. Unlike\n *   `stop()`, does **not** flush already-queued messages — they still drain\n *   after the interrupting send settles successfully.\n */\nexport type WhenBusy = 'queue' | 'drop' | 'interrupt'\n\n/**\n * Why the client is busy when a {@link QueueStrategy} runs.\n * - `streaming` — an LLM stream is active (`isLoading`).\n * - `sendInFlight` — a send has claimed the client but is not yet loading.\n * - `draining` — the queue drain loop is delivering pending messages.\n */\nexport type QueueBusyReason = 'streaming' | 'sendInFlight' | 'draining'\n\n/**\n * A user message held in the send queue while a stream is active.\n * Rendered separately from `messages`; cancellable via `cancelQueued(id)`\n * until it drains.\n */\nexport interface QueuedMessage {\n  id: string\n  content: string | MultimodalContent\n  createdAt: number\n}\n\n/**\n * Declarative queue policy.\n */\nexport interface QueueConfig {\n  /**\n   * Action when the client is busy (streaming, claiming a send, or draining).\n   * Default `'queue'`.\n   */\n  whenBusy?: WhenBusy\n  /**\n   * How queued items leave the queue.\n   * - `'fifo'`: one at a time, in order (default).\n   * - `'batch'`: merge all queued items into one send when the run settles\n   *   successfully.\n   */\n  drain?: 'fifo' | 'batch'\n  /** Max queued items. Unlimited when omitted. `0` means never queue. */\n  maxSize?: number\n  /**\n   * Behavior when `maxSize` is reached. Default `'reject'`.\n   * `'reject'` silently discards the new send (does not throw);\n   * `'drop-oldest'` evicts the oldest queued item to make room.\n   * Only meaningful when `maxSize` is set.\n   */\n  onOverflow?: 'reject' | 'drop-oldest'\n}\n\n/**\n * Escape hatch: decide the action for a single send. Drain stays FIFO for the\n * function form (no `batch` via function). Per-call `sendOptions.whenBusy`\n * overrides the strategy for that send.\n *\n * Actions match {@link WhenBusy}. Concurrent streams are not supported.\n * `pending.id` is the id that will be stored if the action is `'queue'`\n * (safe to pass to `cancelQueued`).\n */\nexport type QueueStrategy = (ctx: {\n  pending: QueuedMessage\n  busyReason: QueueBusyReason\n  queued: ReadonlyArray<QueuedMessage>\n}) => { action: WhenBusy }\n\n/** A `WhenBusy` shorthand, a full config, or a strategy function. */\nexport type QueueOption = WhenBusy | QueueConfig | QueueStrategy\n\n/** Per-call overrides for `sendMessage`. */\nexport interface SendMessageOptions {\n  /** Overrides the configured `whenBusy` for this one send. */\n  whenBusy?: WhenBusy\n  /**\n   * Extra JSON merged into this request's wire `forwardedProps`.\n   * Shallow merge: `{ ...chatBody, ...positionalBody, ...body }`.\n   * This field wins on key collisions.\n   *\n   * Framework hooks (`useChat`, `injectChat`, `createChat`) expose\n   * `sendMessage(content, options)` with no positional body, so this field\n   * is the per-call body channel on those surfaces.\n   */\n  body?: Record<string, any>\n}\n\n/**\n * Message parts - building blocks of UIMessage\n */\nexport interface TextPart {\n  type: 'text'\n  content: string\n}\n\n/**\n * Tool-call part for a bare `{ name }` tool, such as a server tool\n * definition a subagent carries. No `approval` field.\n */\ntype ToolCallPartForNamedTool<T extends { name: string }> = {\n  type: 'tool-call'\n  id: string\n  name: T['name']\n  arguments: string\n  input?: InferToolInput<T>\n  state: ToolCallState\n  output?: InferToolOutput<T>\n}\n\n/**\n * Helper type that creates a tool-call part for a specific tool.\n * This is a conditional type to enable proper distribution over union types,\n * creating a discriminated union where `name` is the discriminant.\n */\ntype ToolCallPartForTool<T> = T extends AnyClientTool\n  ? {\n      type: 'tool-call'\n      id: string\n      name: T['name']\n      arguments: string // JSON string (may be incomplete)\n      /** Parsed tool input (typed from inputSchema) */\n      input?: InferToolInput<T>\n      state: ToolCallState\n      /** Tool execution output (for client tools or after approval) */\n      output?: InferToolOutput<T>\n    } & (NonNullable<T['needsApproval']> extends true\n      ? {\n          /**\n           * Approval metadata — present only on tools defined with\n           * `needsApproval: true`. Populated once the call reaches\n           * `state: 'approval-requested'`. `needsApproval` is an optional\n           * property on the tool, so we index into it (rather than\n           * `T extends { needsApproval: true }`, which an optional property\n           * never satisfies) and strip `undefined` before comparing to `true`.\n           */\n          approval?: {\n            id: string // Unique approval ID\n            needsApproval: boolean // Always true if present\n            approved?: boolean // User's decision (undefined until responded)\n          }\n        }\n      : // Tools without `needsApproval: true` never carry an approval field.\n        // `& unknown` is a no-op intersection (adds nothing).\n        unknown)\n  : T extends { name: string }\n    ? ToolCallPartForNamedTool<T>\n    : never\n\n/**\n * Fallback tool-call part type when tools are not typed\n */\ntype UntypedToolCallPart = {\n  type: 'tool-call'\n  id: string\n  name: string\n  arguments: string\n  input?: any\n  state: ToolCallState\n  approval?: {\n    id: string\n    needsApproval: boolean\n    approved?: boolean\n  }\n  output?: any\n}\n\n/**\n * Tool call part that creates a proper discriminated union.\n * When TTools is typed, checking `part.name === 'toolName'` will narrow\n * `part.output` to the correct type for that tool.\n *\n * The discriminant is `name`, so code like:\n * ```ts\n * if (part.name === 'recommendGuitar') {\n *   // part.output is now typed to the recommendGuitar tool's output\n * }\n * ```\n */\nexport type ToolCallPart<TTools extends ReadonlyArray<{ name: string }> = any> =\n  // Check if we have a concrete tools array (not 'any' or 'never')\n  [TTools] extends [never]\n    ? UntypedToolCallPart\n    : unknown extends TTools\n      ? UntypedToolCallPart\n      : TTools extends ReadonlyArray<infer Tool>\n        ? Tool extends { name: string }\n          ? ToolCallPartForTool<Tool>\n          : UntypedToolCallPart\n        : UntypedToolCallPart\n\nexport interface ToolResultPart {\n  type: 'tool-result'\n  id?: string\n  name?: string\n  toolCallId: string\n  content: string | Array<ContentPart>\n  state: ToolResultState\n  error?: string // Error message if state is \"error\"\n  metadata?: Record<string, unknown>\n  createdAt?: Date\n}\n\nexport interface ThinkingPart {\n  type: 'thinking'\n  content: string\n}\n\nexport type { SubagentStatus }\n\nexport interface SubagentHandle extends SubagentHandleData {\n  /**\n   * Set by ChatClient on every card it holds, streamed, restored, or initial,\n   * nested cards included. Calling it marks the card `error` (`Stopped`),\n   * ignores that child's later chunks until the same child starts again, and\n   * aborts the local request, parent stream included. A durable server run\n   * keeps going.\n   */\n  stop?: () => void\n}\n\nexport interface SubagentPart {\n  type: 'subagent'\n  subagent: SubagentHandle\n}\n\n/**\n * The slice of a server `defineAgent` result that the client reads for types.\n * The client does not call `run`. Put tool definitions (from\n * `toolDefinition`) in `tools` to type the child's tool calls and approvals.\n */\nexport type SubagentClientAgent = {\n  name: string\n  description?: string\n  tools?: ReadonlyArray<{ name: string }>\n  interrupts?: ReadonlyArray<InterruptDefinition<any, any, any, any>>\n  outputSchema?: SchemaInput\n}\n\ntype AgentToolList<TAgent> = TAgent extends { tools?: infer TTools }\n  ? [undefined] extends [TTools]\n    ? [TTools] extends [undefined]\n      ? any\n      : Exclude<TTools, undefined> extends ReadonlyArray<infer TTool>\n        ? [TTool] extends [never]\n          ? any\n          : Exclude<TTools, undefined>\n        : any\n    : TTools extends ReadonlyArray<infer TTool>\n      ? [TTool] extends [never]\n        ? any\n        : TTools\n      : any\n  : any\n\ntype AgentOutputData<TAgent> = TAgent extends { outputSchema?: infer TSchema }\n  ? Exclude<TSchema, undefined> extends SchemaInput\n    ? [Exclude<TSchema, undefined>] extends [never]\n      ? unknown\n      : InferSchemaType<Exclude<TSchema, undefined>>\n    : unknown\n  : unknown\n\n/** One child handle. `name` is the discriminant. */\nexport type SubagentHandleOf<TAgent extends SubagentClientAgent> = Omit<\n  SubagentHandle,\n  'name' | 'messages'\n> & {\n  name: TAgent['name']\n  messages: Array<UIMessage<AgentToolList<TAgent>, AgentOutputData<TAgent>>>\n}\n\nexport type SubagentHandles<\n  TAgents extends ReadonlyArray<SubagentClientAgent> | undefined,\n> = [TAgents] extends [undefined]\n  ? SubagentHandle\n  : unknown extends TAgents\n    ? SubagentHandle\n    : TAgents extends ReadonlyArray<infer TAgent>\n      ? TAgent extends SubagentClientAgent\n        ? SubagentHandleOf<TAgent>\n        : SubagentHandle\n      : SubagentHandle\n\nexport type SubagentPartOf<\n  TAgents extends ReadonlyArray<SubagentClientAgent> | undefined,\n> = [TAgents] extends [undefined]\n  ? SubagentPart\n  : unknown extends TAgents\n    ? SubagentPart\n    : {\n        type: 'subagent'\n        subagent: SubagentHandles<TAgents>\n      }\n\nexport type MessagePart<\n  TTools extends ReadonlyArray<{ name: string }> = any,\n  TData = unknown,\n  TSubagents extends ReadonlyArray<SubagentClientAgent> | undefined = undefined,\n> =\n  | TextPart\n  | ImagePart\n  | AudioPart\n  | VideoPart\n  | DocumentPart\n  | ToolCallPart<TTools>\n  | ToolResultPart\n  | ThinkingPart\n  | StructuredOutputPart<TData>\n  | UIResourcePart\n  | SubagentPartOf<TSubagents>\n\n/**\n * UIMessage - Domain-specific message format optimized for building chat UIs\n * Contains parts that can be text, tool calls, or tool results.\n *\n * `TTools` narrows the tool-call/result part types based on the registered\n * tools. `TData` is the schema-inferred type for any `structured-output` part\n * on the message — defaulted to `unknown` so untyped consumers (the core\n * stream processor, the wire converter) don't need to thread a schema generic\n * everywhere; the hook layer (`useChat({ outputSchema })`) substitutes it on\n * the public return so `m.parts.find(p => p.type === 'structured-output').data`\n * is typed without manual casts.\n */\nexport interface UIMessage<\n  TTools extends ReadonlyArray<{ name: string }> = any,\n  TData = unknown,\n  TSubagents extends ReadonlyArray<SubagentClientAgent> | undefined = undefined,\n> {\n  id: string\n  role: 'system' | 'user' | 'assistant'\n  name?: string\n  parts: Array<MessagePart<TTools, TData, TSubagents>>\n  createdAt?: Date\n  /**\n   * Optional AG-UI metadata bag. TanStack writes the `tanstack` key.\n   * User keys stay at the top.\n   */\n  metadata?: Record<string, any>\n}\n\n/**\n * A generic key/value storage adapter. `getItem` may be sync or async; the\n * chat persistence layer treats every call as best-effort. The provided\n * `localStoragePersistence` / `sessionStoragePersistence` / `indexedDBPersistence`\n * factories return one of these, and `ChatStorageAdapter<ChatPersistedState>`\n * is assignable to {@link ChatClientPersistence}.\n */\nexport interface ChatStorageAdapter<TValue> {\n  getItem: (\n    id: string,\n  ) => TValue | null | undefined | Promise<TValue | null | undefined>\n  setItem: (id: string, value: TValue) => void | Promise<void>\n  removeItem: (id: string) => void | Promise<void>\n}\n\n/**\n * The single record a `ChatClientPersistence` adapter stores per chat. It folds\n * the two things that must survive a full page reload into one blob under one\n * key: the message transcript and the optional resume snapshot (which run to\n * rejoin / which interrupts to rehydrate). One adapter, one key — see\n * {@link ChatClientPersistence}.\n */\nexport interface ChatPersistedState<\n  TTools extends ReadonlyArray<AnyClientTool> = any,\n> {\n  messages: Array<UIMessage<TTools>>\n  /** Present while a run is in flight or paused on an interrupt; absent otherwise. */\n  resume?: ChatResumeSnapshot\n}\n\n/**\n * Storage adapter for durable chat state. A single adapter persists both the\n * message transcript and the resume snapshot as one {@link ChatPersistedState}\n * record, so a full page reload restores the conversation AND can rejoin an\n * in-flight run / rehydrate pending interrupts.\n *\n * For backward compatibility `getItem` may also return a bare `UIMessage[]`\n * (the legacy messages-only format); the client normalizes it to\n * `{ messages }`. `setItem` always writes the combined record.\n */\nexport interface ChatClientPersistence<\n  TTools extends ReadonlyArray<AnyClientTool> = any,\n> {\n  getItem: (\n    id: string,\n  ) =>\n    | ChatPersistedState<TTools>\n    | Array<UIMessage<TTools>>\n    | null\n    | undefined\n    | Promise<\n        ChatPersistedState<TTools> | Array<UIMessage<TTools>> | null | undefined\n      >\n  setItem: (\n    id: string,\n    state: ChatPersistedState<TTools>,\n  ) => void | Promise<void>\n  removeItem: (id: string) => void | Promise<void>\n}\n\n/**\n * The `persistence` option for a chat.\n *\n * - `false` (default): ephemeral. Messages live in memory only; a reload starts\n *   from empty.\n * - `true`: server-authoritative. Nothing is cached in the browser. On mount the\n *   client hydrates the thread from the server by its `threadId` (paints the\n *   stored transcript and tails any run still generating), so a reload or the\n *   same thread opened on another device both just resume. Requires a connection\n *   with a `hydrate` handler.\n * - a {@link ChatClientPersistence} adapter: client-authoritative. The combined\n *   {@link ChatPersistedState} record (transcript plus resume pointer) is cached\n *   in the browser and restored on reload with no network.\n */\nexport type ChatPersistenceOption<\n  TTools extends ReadonlyArray<AnyClientTool> = any,\n> = boolean | ChatClientPersistence<TTools>\n\n/**\n * The `persistence` / `threadId` pairing for `ChatClient` and the chat hooks.\n *\n * Persistence that is on (`true` or a storage adapter) requires a `threadId`.\n * A minted id changes every reload, so nothing would restore. The compiler\n * asks for the conversation id instead.\n *\n * Omit `persistence`, or set it to `false`, and `threadId` stays optional.\n * The client then mints one after mount for the wire and DevTools.\n *\n * Intersect this onto `ChatClientOptions`. Do not apply a later plain `Omit`\n * to that type: it collapses the union and the requirement disappears. Use\n * {@link DistributedOmit}.\n */\nexport type ChatPersistenceOptions<\n  TTools extends ReadonlyArray<AnyClientTool> = any,\n> =\n  | {\n      persistence: true\n      threadId: string\n      /**\n       * Newest-window size for server hydrate. Only with `persistence: true`.\n       * Without this, hydrate still loads the full thread.\n       */\n      history?: {\n        pageSize: number\n      }\n    }\n  | {\n      persistence: ChatClientPersistence<TTools>\n      threadId: string\n      history?: never\n    }\n  | {\n      persistence?: false | undefined\n      threadId?: string\n      history?: never\n    }\n\ntype IsUnknown<T> = unknown extends T\n  ? [T] extends [unknown]\n    ? true\n    : false\n  : false\n\ntype KnownContext<T> = IsUnknown<T> extends true ? never : T\n\ntype MergeContext<TLeft, TRight> = [TLeft] extends [never]\n  ? TRight\n  : [TRight] extends [never]\n    ? TLeft\n    : TLeft & TRight\n\ntype UnionToIntersection<T> = [T] extends [never]\n  ? never\n  : (T extends unknown ? (value: T) => void : never) extends (\n        value: infer TIntersection,\n      ) => void\n    ? TIntersection\n    : never\n\ntype DefinedContext<T> = Exclude<T, undefined>\n\ntype ContextFromExecute<T> = T extends (...args: any) => any\n  ? NonNullable<Parameters<T>[1]> extends { context: infer TContext }\n    ? KnownContext<TContext>\n    : never\n  : never\n\ntype ContextFromClientTool<T> = T extends AnyClientTool\n  ? T extends { execute?: infer TExecute }\n    ? ContextFromExecute<TExecute>\n    : never\n  : never\n\ntype RequiredContextFromClientToolUnion<T> = T extends unknown\n  ? undefined extends ContextFromClientTool<T>\n    ? never\n    : ContextFromClientTool<T>\n  : never\n\ntype ContextFromClientToolUnion<T> = [\n  UnionToIntersection<DefinedContext<ContextFromClientTool<T>>>,\n] extends [never]\n  ? never\n  : [RequiredContextFromClientToolUnion<T>] extends [never]\n    ? UnionToIntersection<DefinedContext<ContextFromClientTool<T>>> | undefined\n    : UnionToIntersection<DefinedContext<ContextFromClientTool<T>>>\n\ntype ContextFromClientTools<TTools> =\n  IsUnknown<TTools> extends true\n    ? never\n    : TTools extends readonly [infer THead, ...infer TTail]\n      ? MergeContext<\n          ContextFromClientTool<THead>,\n          ContextFromClientTools<TTail>\n        >\n      : TTools extends ReadonlyArray<infer TItem>\n        ? ContextFromClientToolUnion<TItem>\n        : never\n\nexport type InferredClientContext<TTools> = [\n  ContextFromClientTools<TTools>,\n] extends [never]\n  ? unknown\n  : ContextFromClientTools<TTools>\n\nexport type ClientContextOptionFromTools<TTools, TContext> = [\n  ContextFromClientTools<TTools>,\n] extends [never]\n  ? { context?: TContext }\n  : undefined extends ContextFromClientTools<TTools>\n    ? { context?: TContext & ContextFromClientTools<TTools> }\n    : { context: TContext & ContextFromClientTools<TTools> }\n\n/**\n * Base options for `ChatClient`, excluding the transport (`connection` or\n * `fetcher`) which is supplied separately via `ChatTransport` so the XOR\n * is preserved when composing the final `ChatClientOptions` type.\n */\nexport interface ChatClientBaseOptions<\n  TTools extends ReadonlyArray<AnyClientTool> = any,\n  TContext = unknown,\n  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> =\n    readonly [],\n> {\n  /**\n   * Initial messages to populate the chat\n   */\n  initialMessages?: Array<UIMessage<TTools>>\n\n  /**\n   * Initial resumable run state, useful when rehydrating a persisted client\n   * after a full page reload. This restores the client-side interrupt\n   * descriptors needed to send AG-UI resume entries.\n   */\n  initialResumeSnapshot?: ChatResumeSnapshot\n\n  /**\n   * Arbitrary client-controlled JSON forwarded to the server in the\n   * AG-UI `RunAgentInput.forwardedProps` field. Use this for per-session\n   * options like provider/model selection or feature flags that the\n   * server endpoint should read.\n   *\n   * Replaces the legacy `body` option. If both are provided,\n   * `forwardedProps` wins on key collision.\n   */\n  forwardedProps?: Record<string, any>\n\n  /**\n   * @deprecated Use `forwardedProps` instead. `body` continues to work\n   * unchanged — its values are merged into the AG-UI\n   * `RunAgentInput.forwardedProps` field on the wire and are also\n   * mirrored under the legacy `data` field for servers that have not\n   * migrated yet. Will be removed in a future major release.\n   */\n  body?: Record<string, any>\n\n  /**\n   * Optional BYOK keyring. On each send the client prepares the resolved\n   * provider and stamps `x-byok-*` request headers. Keys never go in the body.\n   */\n  byok?: ByokClient\n\n  /**\n   * The agents you pass to `chat({ subagents: { agents } })`, for types only.\n   * The client does not call `run`. `createChatHook` from\n   * `@tanstack/ai-react/ui` requires a `subagentsComponents` entry for every\n   * agent name.\n   */\n  subagents?: ReadonlyArray<SubagentClientAgent>\n\n  /**\n   * Optional provider id for this chat. If it returns a provider slug,\n   * only that key is prepared and sent. Otherwise the merged `provider`\n   * from `forwardedProps`, `body`, and per-call `sendMessage` `body` is\n   * used. Later sources win. If no slug resolves, the send throws\n   * instead of attaching every stored key.\n   */\n  byokProvider?: () => string | undefined\n\n  /**\n   * Client-local runtime context passed to client tool implementations.\n   *\n   * This value is not serialized to the server. Use `forwardedProps` for\n   * explicit client-to-server handoff of serializable values.\n   */\n  context?: TContext\n\n  /**\n   * Callback when a response is received\n   */\n  onResponse?: (response?: Response) => void | Promise<void>\n\n  /**\n   * Callback when a stream chunk is received\n   */\n  onChunk?: (chunk: StreamChunk) => void\n\n  /**\n   * Callback when the response is finished\n   */\n  onFinish?: (message: UIMessage<TTools>) => void\n\n  /**\n   * Callback when an error occurs\n   */\n  onError?: (error: Error) => void\n\n  /**\n   * Callback when messages change\n   */\n  onMessagesChange?: (messages: Array<UIMessage<TTools>>) => void\n\n  /**\n   * Callback when loading state changes\n   */\n  onLoadingChange?: (isLoading: boolean) => void\n\n  /**\n   * Callback when error state changes\n   */\n  onErrorChange?: (error: Error | undefined) => void\n\n  /**\n   * Callback when chat status changes\n   */\n  onStatusChange?: (status: ChatClientState) => void\n\n  /**\n   * Callback when subscription lifecycle changes.\n   * This is independent from request lifecycle (`isLoading`, `status`).\n   */\n  onSubscriptionChange?: (isSubscribed: boolean) => void\n\n  /**\n   * Callback when connection lifecycle changes.\n   */\n  onConnectionStatusChange?: (status: ConnectionStatus) => void\n\n  /**\n   * Callback when session generation activity changes.\n   * Derived from stream run events (RUN_STARTED / RUN_FINISHED / RUN_ERROR).\n   * Unlike `onLoadingChange` (request-local), this reflects shared generation\n   * activity visible to all subscribers (e.g. across tabs/devices).\n   */\n  onSessionGeneratingChange?: (isGenerating: boolean) => void\n\n  /**\n   * Policy for messages sent while the client is busy (streaming, claiming\n   * a send, or draining the queue). Accepts a `WhenBusy` string, a\n   * `QueueConfig`, or a `QueueStrategy` function.\n   * Default: `{ whenBusy: 'queue', drain: 'fifo' }`.\n   * Queued items auto-send only after a **successful** settle; they are\n   * discarded on error/abort, `stop()`, `clear()`, `unsubscribe()`, and\n   * `reload()`.\n   */\n  queue?: QueueOption\n\n  /**\n   * Callback when the pending send queue changes (enqueue, cancel, drain,\n   * or flush).\n   */\n  onQueueChange?: (queue: Array<QueuedMessage>) => void\n\n  /**\n   * Callback when resumable run state or pending interrupts change.\n   */\n  onResumeStateChange?: (\n    resumeState: ChatResumeState | null,\n    pendingInterrupts: BoundInterrupts<TTools, TInterrupts>,\n  ) => void\n\n  /**\n   * Callback when the id of the run this client has in flight changes: the new\n   * id when a run starts (a send, or a `joinRun` rejoin), `null` when it settles.\n   */\n  onRunIdChange?: (runId: string | null) => void\n\n  /**\n   * Callback when the immutable interrupt state snapshot changes.\n   * Snapshot restoration passes `{ source: 'hydrate' }`; streamed and\n   * client-initiated updates pass `{ source: 'live' }`.\n   */\n  onInterruptStateChange?: (\n    state: ChatInterruptState<TTools, TInterrupts>,\n    context: { source: 'hydrate' | 'live' },\n  ) => void\n\n  /**\n   * Callback when a custom event is received from a server-side tool.\n   * Custom events are emitted by tools using `context.emitCustomEvent()` during execution.\n   *\n   * @param eventType - The name of the custom event\n   * @param data - The event payload data\n   * @param context - Additional context including the toolCallId that emitted the event\n   */\n  onCustomEvent?: (\n    eventType: string,\n    data: unknown,\n    context: { toolCallId?: string },\n  ) => void\n\n  /**\n   * Client-side tools with execution logic\n   * When provided, tools with execute functions will be called automatically\n   */\n  tools?: TTools\n\n  /** First-party generic interrupts this client can type and resolve. */\n  interrupts?: TInterrupts\n\n  /**\n   * Devtools hook metadata for this client instance.\n   */\n  devtools?: Partial<AIDevtoolsClientMetadata>\n\n  /**\n   * Factory that constructs the devtools bridge. Default is a no-op\n   * factory, which keeps `@tanstack/ai-client/devtools` (the heavy\n   * bridge implementation) out of the main entry's bundle. Frameworks\n   * that need live devtools should pass the real factory from\n   * `@tanstack/ai-client/devtools`.\n   */\n  devtoolsBridgeFactory?: ChatDevtoolsBridgeFactory\n\n  /**\n   * Stream processing options (optional)\n   * Configure chunking strategy\n   */\n  streamProcessor?: {\n    /**\n     * Strategy for when to emit text updates\n     * Defaults to ImmediateStrategy (every chunk)\n     */\n    chunkStrategy?: ChunkStrategy\n  }\n}\n\n/**\n * Options for `ChatClient`. Exactly one of `connection` or `fetcher` must be\n * provided — the type-level XOR is enforced via `ChatTransport`. Persistence\n * that is on requires a `threadId` via {@link ChatPersistenceOptions}.\n */\nexport type ChatClientOptions<\n  TTools extends ReadonlyArray<AnyClientTool> = any,\n  TContext = InferredClientContext<TTools>,\n  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> =\n    readonly [],\n> = DistributedOmit<\n  ChatClientBaseOptions<TTools, TContext, TInterrupts>,\n  'context'\n> &\n  ClientContextOptionFromTools<TTools, TContext> &\n  ChatTransport &\n  ChatPersistenceOptions<TTools>\n\nexport interface ChatRequestBody {\n  messages: Array<ModelMessage>\n  data?: Record<string, any>\n}\n\n/**\n * Create a typed array of client tools with proper type inference.\n * This eliminates the need for `as const` when defining tool arrays.\n *\n * @example\n * ```ts\n * const tools = clientTools(\n *   myTool1.client(() => result1),\n *   myTool2.client(() => result2),\n * )\n *\n * // tools is now properly typed as a tuple with literal tool names\n * // This enables type narrowing when checking part.name === 'toolName'\n * ```\n */\nexport function clientTools<const T extends Array<AnyClientTool>>(\n  ...tools: T\n): T {\n  return tools\n}\n\n/**\n * Helper to create typed chat client options\n * Use this to get proper type inference for messages\n *\n * @example\n * ```ts\n * const tools = clientTools(myTool1, myTool2)\n *\n * const chatOptions = createChatClientOptions({\n *   connection: fetchServerSentEvents('/api/chat'),\n *   tools,\n * })\n *\n * type MyMessages = InferChatMessages<typeof chatOptions>\n * ```\n */\nexport function createChatClientOptions<\n  const TTools extends ReadonlyArray<AnyClientTool>,\n  TContext = InferredClientContext<TTools>,\n  const TInterrupts extends ReadonlyArray<\n    InterruptDefinition<any, any, any, any>\n  > = readonly [],\n>(\n  options: ChatClientOptions<TTools, TContext, TInterrupts>,\n): ChatClientOptions<TTools, TContext, TInterrupts> {\n  return options\n}\n\n/**\n * Extract the message type from chat options\n *\n * @example\n * ```ts\n * const chatOptions = createChatClientOptions({\n *   connection: fetchServerSentEvents('/api/chat'),\n *   tools: [myTool1, myTool2],\n * })\n *\n * type MyMessages = InferChatMessages<typeof chatOptions>\n * // MyMessages is now Array<UIMessage<[typeof myTool1, typeof myTool2]>>\n * ```\n */\nexport type InferChatMessages<T> =\n  T extends ChatClientOptions<infer TTools, any>\n    ? Array<UIMessage<TTools>>\n    : never\n"],"mappings":";;;;;;;;;;;;;;;;AAksCA,SAAgB,YACd,GAAG,OACA;CACH,OAAO;AACT;;;;;;;;;;;;;;;;;AAkBA,SAAgB,wBAOd,SACkD;CAClD,OAAO;AACT"}
+{"version":3,"file":"types.js","names":[],"sources":["../../src/types.ts"],"sourcesContent":["import type {\n  AnyClientTool,\n  ApprovalCapabilityOf,\n  ApprovalSchemaOf,\n  AudioPart,\n  BatchInterruptError,\n  ChunkStrategy,\n  ContentPart,\n  DocumentPart,\n  ImagePart,\n  InferSchemaType,\n  InterruptDefinition,\n  InferToolInput,\n  InferToolOutput,\n  InputSchemaOf,\n  Interrupt,\n  InterruptBinding,\n  ItemInterruptError,\n  ModelMessage,\n  NoSchema,\n  RunAgentResumeItem,\n  SchemaInput,\n  StreamChunk,\n  StructuredOutputPart,\n  SubagentHandleData,\n  SubagentStatus,\n  ToolResultOutcome,\n  UIResourcePart,\n  VideoPart,\n} from '@tanstack/ai/client'\nimport type { ByokClient } from './byok'\nimport type { ConnectionAdapter } from './connection-adapters'\nimport type { AIDevtoolsClientMetadata } from './devtools'\nimport type { ChatDevtoolsBridgeFactory } from './devtools-noop'\n\nexport type { StructuredOutputPart }\n\nexport interface ChatResumeState {\n  threadId: string\n  runId: string\n}\n\nexport type ChatPendingInterrupt = Interrupt\n\n/**\n * The durable pointer a chat keeps for the run it may need to rejoin, plus any\n * interrupt that run is waiting on.\n *\n * @internal\n */\nexport interface ChatResumeSnapshot {\n  resumeState: ChatResumeState\n  pendingInterrupts?: Array<ChatPendingInterrupt>\n}\n\nexport type InterruptItemStatus =\n  | 'pending'\n  | 'validating'\n  | 'staged'\n  | 'submitting'\n  | 'error'\n\nexport interface BoundInterruptBase {\n  readonly id: string\n  readonly interruptId: string\n  readonly reason: string\n  readonly message?: string\n  readonly responseSchema?: Readonly<Record<string, unknown>>\n  readonly expiresAt?: string\n  readonly metadata?: Readonly<Record<string, unknown>>\n  readonly threadId: string\n  readonly interruptedRunId: string\n  readonly generation: number\n  readonly status: InterruptItemStatus\n  readonly errors: ReadonlyArray<ItemInterruptError>\n  /** @deprecated Use `errors[0]`. */\n  readonly error?: ItemInterruptError\n  /**\n   * Whether the binding/schema allows resolution at hydrate time.\n   * Does not flip on submit/expiry — gate UI on `status`, `resuming`, and\n   * `errors` for those lifecycle states.\n   */\n  readonly canResolve: boolean\n  cancel: () => void\n  clearResolution: () => void\n}\n\nexport interface GenericAGUIInterrupt extends BoundInterruptBase {\n  readonly kind: 'generic'\n  readonly binding: Readonly<Extract<InterruptBinding, { kind: 'generic' }>>\n  resolveInterrupt: (payload: unknown) => void\n}\n\ntype InterruptResponseInput<TDefinition> =\n  TDefinition extends InterruptDefinition<any, any, infer TResponseSchema, any>\n    ? InferSchemaType<TResponseSchema>\n    : never\n\ntype RegisteredGenericInterruptFor<\n  TDefinition extends InterruptDefinition<any, any, any, any>,\n> =\n  TDefinition extends InterruptDefinition<\n    infer TDefinitionId,\n    any,\n    any,\n    infer TPayload\n  >\n    ? BoundInterruptBase & {\n        readonly kind: 'generic'\n        readonly definitionId: TDefinitionId\n        readonly key: string\n        readonly payload: TPayload | undefined\n        readonly binding: Readonly<\n          Extract<InterruptBinding, { kind: 'generic' }> & {\n            definitionId: TDefinitionId\n            key: string\n            batchIndex: number\n          }\n        >\n        resolveInterrupt: (\n          response: InterruptResponseInput<TDefinition>,\n        ) => void\n      }\n    : never\n\nexport type RegisteredGenericInterrupt<\n  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>>,\n> = TInterrupts[number] extends infer TDefinition\n  ? TDefinition extends InterruptDefinition<any, any, any, any>\n    ? RegisteredGenericInterruptFor<TDefinition>\n    : never\n  : never\n\n/** A bound generic interrupt for one `defineInterrupt()` definition. */\nexport type GenericInterrupt<\n  TDefinition extends InterruptDefinition<any, any, any, any>,\n> = RegisteredGenericInterruptFor<TDefinition>\n\n/**\n * An interrupt that arrived on the stream carrying no resume binding this\n * client understands — no `tanstack:interruptBinding`, or one written at a\n * protocol version we don't recognise.\n *\n * These are surfaced rather than hidden so a UI can show that the run is\n * paused, but they are never resolvable here: something else owns them. A\n * workflow engine's durable approval projected into the same AG-UI stream\n * lands in this bucket, and resolving it through the chat resume path would\n * send an answer no one is waiting for. Render it, or route it to whatever\n * actually owns the pause.\n */\nexport interface UnboundInterrupt extends Omit<\n  BoundInterruptBase,\n  'cancel' | 'clearResolution'\n> {\n  readonly kind: 'unbound'\n  readonly binding?: undefined\n  readonly canResolve: false\n}\n\ntype ApprovalBranchSchema<TTool, TBranch extends 'approve' | 'reject'> =\n  ApprovalSchemaOf<TTool> extends infer TApproval\n    ? TApproval extends { approve?: SchemaInput; reject?: SchemaInput }\n      ? Exclude<TApproval[TBranch], undefined>\n      : TApproval extends SchemaInput\n        ? TApproval\n        : never\n    : never\n\ntype ApprovalEdits<TTool> =\n  InputSchemaOf<TTool> extends NoSchema\n    ? { editedArgs?: never }\n    : { editedArgs?: InferToolInput<TTool> }\n\ntype ApprovalPayload<TSchema> = [TSchema] extends [never]\n  ? { payload?: never }\n  : TSchema extends SchemaInput\n    ? { payload: InferSchemaType<TSchema> }\n    : { payload?: never }\n\ntype ApproveArguments<TTool> = [\n  ApprovalBranchSchema<TTool, 'approve'>,\n] extends [never]\n  ? InputSchemaOf<TTool> extends NoSchema\n    ? [options?: never]\n    : [options?: ApprovalEdits<TTool> & { payload?: never }]\n  : [\n      options: ApprovalEdits<TTool> &\n        ApprovalPayload<ApprovalBranchSchema<TTool, 'approve'>>,\n    ]\n\ntype RejectArguments<TTool> = [ApprovalBranchSchema<TTool, 'reject'>] extends [\n  never,\n]\n  ? [options?: never]\n  : [\n      options: { editedArgs?: never } & ApprovalPayload<\n        ApprovalBranchSchema<TTool, 'reject'>\n      >,\n    ]\n\nexport type ToolApprovalInterrupt<TTool extends AnyClientTool = AnyClientTool> =\n  TTool extends AnyClientTool\n    ? BoundInterruptBase & {\n        readonly kind: 'tool-approval'\n        readonly binding: Readonly<\n          Extract<InterruptBinding, { kind: 'tool-approval' }>\n        >\n        readonly toolName: TTool['name']\n        readonly toolCallId: string\n        readonly originalArgs: InferToolInput<TTool>\n        // A single generic call signature — not two overloads. Overloads break\n        // editor autocomplete: a half-typed options literal (e.g.\n        // `resolveInterrupt(true, { payload: {` ) satisfies neither overload,\n        // so TS resolves no signature and offers no contextual completions.\n        // Making `approved` a generic discriminant lets TS infer it from the\n        // first argument and pick the matching branch for the rest params, so\n        // `payload` / `editedArgs` / the correct schema's fields complete\n        // per-branch (a plain union-of-tuples would offer both branches'\n        // fields) while still enforcing the right shape.\n        resolveInterrupt: <TApproved extends boolean>(\n          approved: TApproved,\n          ...args: TApproved extends true\n            ? ApproveArguments<TTool>\n            : RejectArguments<TTool>\n        ) => void\n      }\n    : never\n\ntype ApprovalInterrupts<TTools extends ReadonlyArray<AnyClientTool>> =\n  TTools[number] extends infer TTool\n    ? TTool extends AnyClientTool\n      ? ApprovalCapabilityOf<TTool> extends true\n        ? ToolApprovalInterrupt<TTool>\n        : never\n      : never\n    : never\n\n// Client tools resolve through their `.client()` implementation (auto-run) or\n// `addToolResult` — never as a bound interrupt. The `client-tool-execution`\n// pause is handled internally and is intentionally absent from this public\n// union.\nexport type ChatInterrupt<\n  TTools extends ReadonlyArray<AnyClientTool> = ReadonlyArray<AnyClientTool>,\n  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> =\n    readonly [],\n> =\n  | GenericAGUIInterrupt\n  | RegisteredGenericInterrupt<TInterrupts>\n  | UnboundInterrupt\n  | ApprovalInterrupts<TTools>\n\nexport type ResolvableChatInterrupt<\n  TTools extends ReadonlyArray<AnyClientTool> = ReadonlyArray<AnyClientTool>,\n  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> =\n    readonly [],\n> =\n  | GenericAGUIInterrupt\n  | RegisteredGenericInterrupt<TInterrupts>\n  | ApprovalInterrupts<TTools>\n\nexport type BoundInterrupts<\n  TTools extends ReadonlyArray<AnyClientTool> = ReadonlyArray<AnyClientTool>,\n  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> =\n    readonly [],\n> = ReadonlyArray<ChatInterrupt<TTools, TInterrupts>>\n\nexport interface ChatInterruptState<\n  TTools extends ReadonlyArray<AnyClientTool> = ReadonlyArray<AnyClientTool>,\n  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> =\n    readonly [],\n> {\n  readonly interrupts: BoundInterrupts<TTools, TInterrupts>\n  /** @deprecated Use `interrupts`. Same snapshot today. */\n  readonly pendingInterrupts: BoundInterrupts<TTools, TInterrupts>\n  readonly interruptErrors: ReadonlyArray<BatchInterruptError>\n  readonly resuming: boolean\n}\n\n/**\n * `messages` is the full UIMessage history (not a delta). `data` is the\n * merged body — `ChatClientOptions.body` plus any per-call data passed to\n * `sendMessage(...)`. `threadId` / `runId` are the AG-UI correlation ids\n * the chat client uses to track this turn — forward them to your server\n * if it needs to correlate requests.\n */\nexport interface ChatFetcherInput {\n  messages: Array<UIMessage>\n  data?: Record<string, unknown>\n  threadId: string\n  runId: string\n  parentRunId?: string\n  resume?: Array<RunAgentResumeItem>\n}\n\nexport interface ChatFetcherOptions {\n  /** Fires when `stop()` is called or the request is superseded. */\n  signal: AbortSignal\n  /** Extra request headers for this run (e.g. BYOK keys). */\n  headers?: Record<string, string>\n}\n\n/**\n * Direct function that performs a chat request. Mirrors\n * `GenerationFetcher`. Returns either a `Response` (SSE body parsed by the\n * chat client) or an `AsyncIterable<StreamChunk>` (yielded directly). May\n * return the value synchronously, as a `Promise`, or as an async generator\n * (`async function*`) — the chat client awaits whichever shape is returned.\n *\n * @example\n * ```ts\n * useChat({\n *   fetcher: ({ messages }, { signal }) =>\n *     chatFn({ data: { messages }, signal }),\n * })\n * ```\n */\nexport type ChatFetcher = (\n  input: ChatFetcherInput,\n  options: ChatFetcherOptions,\n) =>\n  | Response\n  | AsyncIterable<StreamChunk>\n  | Promise<Response | AsyncIterable<StreamChunk>>\n\n/**\n * Distributive `Omit` — applies `Omit<O, K>` per branch of a union so\n * discriminated unions survive omission. Plain `Omit` collapses unions\n * into a single object shape, which would erase the `ChatTransport` XOR\n * when framework hooks omit React-managed callbacks from\n * `ChatClientOptions`.\n */\nexport type DistributedOmit<\n  TObject,\n  TKeys extends keyof any,\n> = TObject extends unknown ? Omit<TObject, TKeys> : never\n\n/**\n * Discriminated union enforcing that exactly one of `connection` or\n * `fetcher` is provided. Mirrors `GenerationTransport`.\n */\nexport type ChatTransport =\n  | { connection: ConnectionAdapter; fetcher?: never }\n  | { fetcher: ChatFetcher; connection?: never }\n\n/**\n * Tool call states - track the lifecycle of a tool call\n */\nexport type ToolCallState =\n  | 'awaiting-input' // Received start but no arguments yet\n  | 'input-streaming' // Partial arguments received\n  | 'input-complete' // All arguments received\n  | 'approval-requested' // Waiting for user approval\n  | 'approval-responded' // User has approved/denied\n  | 'complete' // Result is complete\n  | 'error' // Tool execution failed (terminal)\n\n/**\n * Tool result states - track the lifecycle of a tool result\n */\nexport type ToolResultState =\n  | 'streaming' // Placeholder for future streamed output\n  | 'complete' // Result is complete\n  | 'error' // Error occurred\n\n/**\n * ChatClient state - track the lifecycle of a chat\n */\nexport type ChatClientState = 'ready' | 'submitted' | 'streaming' | 'error'\n\n/**\n * Connection lifecycle state for the subscription loop.\n */\nexport type ConnectionStatus =\n  | 'disconnected'\n  | 'connecting'\n  | 'connected'\n  | 'error'\n\n/**\n * Multimodal content input for sending messages with rich media.\n * Allows sending text, images, audio, video, and documents to the LLM.\n *\n * @example\n * ```ts\n * // Send an image with a question\n * client.sendMessage({\n *   content: [\n *     { type: 'text', content: 'What is in this image?' },\n *     { type: 'image', source: { type: 'url', value: 'https://example.com/photo.jpg' } }\n *   ],\n *   id: 'custom-message-id' // optional\n * })\n * ```\n */\nexport interface MultimodalContent {\n  /**\n   * The content of the message.\n   * Can be a simple string or an array of content parts for multimodal messages.\n   */\n  content: string | Array<ContentPart>\n  /**\n   * Optional custom ID for the message.\n   * If not provided, a unique ID will be generated.\n   */\n  id?: string\n  /**\n   * Optional AG-UI metadata bag copied onto the resulting UIMessage.\n   *\n   * @example\n   * ```ts\n   * await client.sendMessage({\n   *   content: 'Show me failed logins',\n   *   metadata: { author: { id: 'user-42', name: 'Dana' } },\n   * })\n   * ```\n   */\n  metadata?: Record<string, any>\n}\n\n/**\n * Action taken when `sendMessage` is called while the client is busy\n * (streaming, claiming a send, or draining the queue).\n * - `queue`: hold the message; it auto-sends when the current run settles\n *   **successfully**.\n * - `drop`: ignore the send (promise still resolves; does not throw).\n * - `interrupt`: abort the current stream and send immediately. Unlike\n *   `stop()`, does **not** flush already-queued messages — they still drain\n *   after the interrupting send settles successfully.\n */\nexport type WhenBusy = 'queue' | 'drop' | 'interrupt'\n\n/**\n * Why the client is busy when a {@link QueueStrategy} runs.\n * - `streaming` — an LLM stream is active (`isLoading`).\n * - `sendInFlight` — a send has claimed the client but is not yet loading.\n * - `draining` — the queue drain loop is delivering pending messages.\n */\nexport type QueueBusyReason = 'streaming' | 'sendInFlight' | 'draining'\n\n/**\n * A user message held in the send queue while a stream is active.\n * Rendered separately from `messages`; cancellable via `cancelQueued(id)`\n * until it drains.\n */\nexport interface QueuedMessage {\n  id: string\n  content: string | MultimodalContent\n  createdAt: number\n}\n\n/**\n * Declarative queue policy.\n */\nexport interface QueueConfig {\n  /**\n   * Action when the client is busy (streaming, claiming a send, or draining).\n   * Default `'queue'`.\n   */\n  whenBusy?: WhenBusy\n  /**\n   * How queued items leave the queue.\n   * - `'fifo'`: one at a time, in order (default).\n   * - `'batch'`: merge all queued items into one send when the run settles\n   *   successfully.\n   */\n  drain?: 'fifo' | 'batch'\n  /** Max queued items. Unlimited when omitted. `0` means never queue. */\n  maxSize?: number\n  /**\n   * Behavior when `maxSize` is reached. Default `'reject'`.\n   * `'reject'` silently discards the new send (does not throw);\n   * `'drop-oldest'` evicts the oldest queued item to make room.\n   * Only meaningful when `maxSize` is set.\n   */\n  onOverflow?: 'reject' | 'drop-oldest'\n}\n\n/**\n * Escape hatch: decide the action for a single send. Drain stays FIFO for the\n * function form (no `batch` via function). Per-call `sendOptions.whenBusy`\n * overrides the strategy for that send.\n *\n * Actions match {@link WhenBusy}. Concurrent streams are not supported.\n * `pending.id` is the id that will be stored if the action is `'queue'`\n * (safe to pass to `cancelQueued`).\n */\nexport type QueueStrategy = (ctx: {\n  pending: QueuedMessage\n  busyReason: QueueBusyReason\n  queued: ReadonlyArray<QueuedMessage>\n}) => { action: WhenBusy }\n\n/** A `WhenBusy` shorthand, a full config, or a strategy function. */\nexport type QueueOption = WhenBusy | QueueConfig | QueueStrategy\n\n/** Per-call overrides for `sendMessage`. */\nexport interface SendMessageOptions {\n  /** Overrides the configured `whenBusy` for this one send. */\n  whenBusy?: WhenBusy\n  /**\n   * Extra JSON merged into this request's wire `forwardedProps`.\n   * Shallow merge: `{ ...chatBody, ...positionalBody, ...body }`.\n   * This field wins on key collisions.\n   *\n   * Framework hooks (`useChat`, `injectChat`, `createChat`) expose\n   * `sendMessage(content, options)` with no positional body, so this field\n   * is the per-call body channel on those surfaces.\n   */\n  body?: Record<string, any>\n}\n\n/**\n * Message parts - building blocks of UIMessage\n */\nexport interface TextPart {\n  type: 'text'\n  content: string\n}\n\n/**\n * Tool-call part for a bare `{ name }` tool, such as a server tool\n * definition a subagent carries. No `approval` field.\n */\ntype ToolCallPartForNamedTool<T extends { name: string }> = {\n  type: 'tool-call'\n  id: string\n  name: T['name']\n  arguments: string\n  input?: InferToolInput<T>\n  state: ToolCallState\n  output?: InferToolOutput<T>\n}\n\n/**\n * Helper type that creates a tool-call part for a specific tool.\n * This is a conditional type to enable proper distribution over union types,\n * creating a discriminated union where `name` is the discriminant.\n */\ntype ToolCallPartForTool<T> = T extends AnyClientTool\n  ? {\n      type: 'tool-call'\n      id: string\n      name: T['name']\n      arguments: string // JSON string (may be incomplete)\n      /** Parsed tool input (typed from inputSchema) */\n      input?: InferToolInput<T>\n      state: ToolCallState\n      /** Tool execution output (for client tools or after approval) */\n      output?: InferToolOutput<T>\n    } & (NonNullable<T['needsApproval']> extends true\n      ? {\n          /**\n           * Approval metadata — present only on tools defined with\n           * `needsApproval: true`. Populated once the call reaches\n           * `state: 'approval-requested'`. `needsApproval` is an optional\n           * property on the tool, so we index into it (rather than\n           * `T extends { needsApproval: true }`, which an optional property\n           * never satisfies) and strip `undefined` before comparing to `true`.\n           */\n          approval?: {\n            id: string // Unique approval ID\n            needsApproval: boolean // Always true if present\n            approved?: boolean // User's decision (undefined until responded)\n          }\n        }\n      : // Tools without `needsApproval: true` never carry an approval field.\n        // `& unknown` is a no-op intersection (adds nothing).\n        unknown)\n  : T extends { name: string }\n    ? ToolCallPartForNamedTool<T>\n    : never\n\n/**\n * Fallback tool-call part type when tools are not typed\n */\ntype UntypedToolCallPart = {\n  type: 'tool-call'\n  id: string\n  name: string\n  arguments: string\n  input?: any\n  state: ToolCallState\n  approval?: {\n    id: string\n    needsApproval: boolean\n    approved?: boolean\n  }\n  output?: any\n}\n\n/**\n * Tool call part that creates a proper discriminated union.\n * When TTools is typed, checking `part.name === 'toolName'` will narrow\n * `part.output` to the correct type for that tool.\n *\n * The discriminant is `name`, so code like:\n * ```ts\n * if (part.name === 'recommendGuitar') {\n *   // part.output is now typed to the recommendGuitar tool's output\n * }\n * ```\n */\nexport type ToolCallPart<TTools extends ReadonlyArray<{ name: string }> = any> =\n  // Check if we have a concrete tools array (not 'any' or 'never')\n  [TTools] extends [never]\n    ? UntypedToolCallPart\n    : unknown extends TTools\n      ? UntypedToolCallPart\n      : TTools extends ReadonlyArray<infer Tool>\n        ? Tool extends { name: string }\n          ? ToolCallPartForTool<Tool>\n          : UntypedToolCallPart\n        : UntypedToolCallPart\n\nexport interface ToolResultPart {\n  type: 'tool-result'\n  id?: string\n  name?: string\n  toolCallId: string\n  content: string | Array<ContentPart>\n  state: ToolResultState\n  /** Set when the user or middleware cancelled or denied the tool call; state remains `error`. */\n  outcome?: ToolResultOutcome\n  error?: string // Error message if state is \"error\"\n  metadata?: Record<string, unknown>\n  createdAt?: Date\n}\n\nexport interface ThinkingPart {\n  type: 'thinking'\n  content: string\n}\n\nexport type { SubagentStatus }\n\nexport interface SubagentHandle extends SubagentHandleData {\n  /**\n   * Set by ChatClient on every card it holds, streamed, restored, or initial,\n   * nested cards included. Calling it marks the card `error` (`Stopped`),\n   * ignores that child's later chunks until the same child starts again, and\n   * aborts the local request, parent stream included. A durable server run\n   * keeps going.\n   */\n  stop?: () => void\n}\n\nexport interface SubagentPart {\n  type: 'subagent'\n  subagent: SubagentHandle\n}\n\n/**\n * The slice of a server `defineAgent` result that the client reads for types.\n * The client does not call `run`. Put tool definitions (from\n * `toolDefinition`) in `tools` to type the child's tool calls and approvals.\n */\nexport type SubagentClientAgent = {\n  name: string\n  description?: string\n  tools?: ReadonlyArray<{ name: string }>\n  interrupts?: ReadonlyArray<InterruptDefinition<any, any, any, any>>\n  outputSchema?: SchemaInput\n}\n\ntype AgentToolList<TAgent> = TAgent extends { tools?: infer TTools }\n  ? [undefined] extends [TTools]\n    ? [TTools] extends [undefined]\n      ? any\n      : Exclude<TTools, undefined> extends ReadonlyArray<infer TTool>\n        ? [TTool] extends [never]\n          ? any\n          : Exclude<TTools, undefined>\n        : any\n    : TTools extends ReadonlyArray<infer TTool>\n      ? [TTool] extends [never]\n        ? any\n        : TTools\n      : any\n  : any\n\ntype AgentOutputData<TAgent> = TAgent extends { outputSchema?: infer TSchema }\n  ? Exclude<TSchema, undefined> extends SchemaInput\n    ? [Exclude<TSchema, undefined>] extends [never]\n      ? unknown\n      : InferSchemaType<Exclude<TSchema, undefined>>\n    : unknown\n  : unknown\n\n/** One child handle. `name` is the discriminant. */\nexport type SubagentHandleOf<TAgent extends SubagentClientAgent> = Omit<\n  SubagentHandle,\n  'name' | 'messages'\n> & {\n  name: TAgent['name']\n  messages: Array<UIMessage<AgentToolList<TAgent>, AgentOutputData<TAgent>>>\n}\n\nexport type SubagentHandles<\n  TAgents extends ReadonlyArray<SubagentClientAgent> | undefined,\n> = [TAgents] extends [undefined]\n  ? SubagentHandle\n  : unknown extends TAgents\n    ? SubagentHandle\n    : TAgents extends ReadonlyArray<infer TAgent>\n      ? TAgent extends SubagentClientAgent\n        ? SubagentHandleOf<TAgent>\n        : SubagentHandle\n      : SubagentHandle\n\nexport type SubagentPartOf<\n  TAgents extends ReadonlyArray<SubagentClientAgent> | undefined,\n> = [TAgents] extends [undefined]\n  ? SubagentPart\n  : unknown extends TAgents\n    ? SubagentPart\n    : {\n        type: 'subagent'\n        subagent: SubagentHandles<TAgents>\n      }\n\nexport type MessagePart<\n  TTools extends ReadonlyArray<{ name: string }> = any,\n  TData = unknown,\n  TSubagents extends ReadonlyArray<SubagentClientAgent> | undefined = undefined,\n> =\n  | TextPart\n  | ImagePart\n  | AudioPart\n  | VideoPart\n  | DocumentPart\n  | ToolCallPart<TTools>\n  | ToolResultPart\n  | ThinkingPart\n  | StructuredOutputPart<TData>\n  | UIResourcePart\n  | SubagentPartOf<TSubagents>\n\n/**\n * UIMessage - Domain-specific message format optimized for building chat UIs\n * Contains parts that can be text, tool calls, or tool results.\n *\n * `TTools` narrows the tool-call/result part types based on the registered\n * tools. `TData` is the schema-inferred type for any `structured-output` part\n * on the message — defaulted to `unknown` so untyped consumers (the core\n * stream processor, the wire converter) don't need to thread a schema generic\n * everywhere; the hook layer (`useChat({ outputSchema })`) substitutes it on\n * the public return so `m.parts.find(p => p.type === 'structured-output').data`\n * is typed without manual casts.\n */\nexport interface UIMessage<\n  TTools extends ReadonlyArray<{ name: string }> = any,\n  TData = unknown,\n  TSubagents extends ReadonlyArray<SubagentClientAgent> | undefined = undefined,\n> {\n  id: string\n  role: 'system' | 'user' | 'assistant'\n  name?: string\n  parts: Array<MessagePart<TTools, TData, TSubagents>>\n  createdAt?: Date\n  /**\n   * Optional AG-UI metadata bag. TanStack writes the `tanstack` key.\n   * User keys stay at the top.\n   */\n  metadata?: Record<string, any>\n}\n\n/**\n * A generic key/value storage adapter. `getItem` may be sync or async; the\n * chat persistence layer treats every call as best-effort. The provided\n * `localStoragePersistence` / `sessionStoragePersistence` / `indexedDBPersistence`\n * factories return one of these, and `ChatStorageAdapter<ChatPersistedState>`\n * is assignable to {@link ChatClientPersistence}.\n */\nexport interface ChatStorageAdapter<TValue> {\n  getItem: (\n    id: string,\n  ) => TValue | null | undefined | Promise<TValue | null | undefined>\n  setItem: (id: string, value: TValue) => void | Promise<void>\n  removeItem: (id: string) => void | Promise<void>\n}\n\n/**\n * The single record a `ChatClientPersistence` adapter stores per chat. It folds\n * the two things that must survive a full page reload into one blob under one\n * key: the message transcript and the optional resume snapshot (which run to\n * rejoin / which interrupts to rehydrate). One adapter, one key — see\n * {@link ChatClientPersistence}.\n */\nexport interface ChatPersistedState<\n  TTools extends ReadonlyArray<AnyClientTool> = any,\n> {\n  messages: Array<UIMessage<TTools>>\n  /** Present while a run is in flight or paused on an interrupt; absent otherwise. */\n  resume?: ChatResumeSnapshot\n}\n\n/**\n * Storage adapter for durable chat state. A single adapter persists both the\n * message transcript and the resume snapshot as one {@link ChatPersistedState}\n * record, so a full page reload restores the conversation AND can rejoin an\n * in-flight run / rehydrate pending interrupts.\n *\n * For backward compatibility `getItem` may also return a bare `UIMessage[]`\n * (the legacy messages-only format); the client normalizes it to\n * `{ messages }`. `setItem` always writes the combined record.\n */\nexport interface ChatClientPersistence<\n  TTools extends ReadonlyArray<AnyClientTool> = any,\n> {\n  getItem: (\n    id: string,\n  ) =>\n    | ChatPersistedState<TTools>\n    | Array<UIMessage<TTools>>\n    | null\n    | undefined\n    | Promise<\n        ChatPersistedState<TTools> | Array<UIMessage<TTools>> | null | undefined\n      >\n  setItem: (\n    id: string,\n    state: ChatPersistedState<TTools>,\n  ) => void | Promise<void>\n  removeItem: (id: string) => void | Promise<void>\n}\n\n/**\n * The `persistence` option for a chat.\n *\n * - `false` (default): ephemeral. Messages live in memory only; a reload starts\n *   from empty.\n * - `true`: server-authoritative. Nothing is cached in the browser. On mount the\n *   client hydrates the thread from the server by its `threadId` (paints the\n *   stored transcript and tails any run still generating), so a reload or the\n *   same thread opened on another device both just resume. Requires a connection\n *   with a `hydrate` handler.\n * - a {@link ChatClientPersistence} adapter: client-authoritative. The combined\n *   {@link ChatPersistedState} record (transcript plus resume pointer) is cached\n *   in the browser and restored on reload with no network.\n */\nexport type ChatPersistenceOption<\n  TTools extends ReadonlyArray<AnyClientTool> = any,\n> = boolean | ChatClientPersistence<TTools>\n\n/**\n * The `persistence` / `threadId` pairing for `ChatClient` and the chat hooks.\n *\n * Persistence that is on (`true` or a storage adapter) requires a `threadId`.\n * A minted id changes every reload, so nothing would restore. The compiler\n * asks for the conversation id instead.\n *\n * Omit `persistence`, or set it to `false`, and `threadId` stays optional.\n * The client then mints one after mount for the wire and DevTools.\n *\n * Intersect this onto `ChatClientOptions`. Do not apply a later plain `Omit`\n * to that type: it collapses the union and the requirement disappears. Use\n * {@link DistributedOmit}.\n */\nexport type ChatPersistenceOptions<\n  TTools extends ReadonlyArray<AnyClientTool> = any,\n> =\n  | {\n      persistence: true\n      threadId: string\n      /**\n       * Newest-window size for server hydrate. Only with `persistence: true`.\n       * Without this, hydrate still loads the full thread.\n       */\n      history?: {\n        pageSize: number\n      }\n    }\n  | {\n      persistence: ChatClientPersistence<TTools>\n      threadId: string\n      history?: never\n    }\n  | {\n      persistence?: false | undefined\n      threadId?: string\n      history?: never\n    }\n\ntype IsUnknown<T> = unknown extends T\n  ? [T] extends [unknown]\n    ? true\n    : false\n  : false\n\ntype KnownContext<T> = IsUnknown<T> extends true ? never : T\n\ntype MergeContext<TLeft, TRight> = [TLeft] extends [never]\n  ? TRight\n  : [TRight] extends [never]\n    ? TLeft\n    : TLeft & TRight\n\ntype UnionToIntersection<T> = [T] extends [never]\n  ? never\n  : (T extends unknown ? (value: T) => void : never) extends (\n        value: infer TIntersection,\n      ) => void\n    ? TIntersection\n    : never\n\ntype DefinedContext<T> = Exclude<T, undefined>\n\ntype ContextFromExecute<T> = T extends (...args: any) => any\n  ? NonNullable<Parameters<T>[1]> extends { context: infer TContext }\n    ? KnownContext<TContext>\n    : never\n  : never\n\ntype ContextFromClientTool<T> = T extends AnyClientTool\n  ? T extends { execute?: infer TExecute }\n    ? ContextFromExecute<TExecute>\n    : never\n  : never\n\ntype RequiredContextFromClientToolUnion<T> = T extends unknown\n  ? undefined extends ContextFromClientTool<T>\n    ? never\n    : ContextFromClientTool<T>\n  : never\n\ntype ContextFromClientToolUnion<T> = [\n  UnionToIntersection<DefinedContext<ContextFromClientTool<T>>>,\n] extends [never]\n  ? never\n  : [RequiredContextFromClientToolUnion<T>] extends [never]\n    ? UnionToIntersection<DefinedContext<ContextFromClientTool<T>>> | undefined\n    : UnionToIntersection<DefinedContext<ContextFromClientTool<T>>>\n\ntype ContextFromClientTools<TTools> =\n  IsUnknown<TTools> extends true\n    ? never\n    : TTools extends readonly [infer THead, ...infer TTail]\n      ? MergeContext<\n          ContextFromClientTool<THead>,\n          ContextFromClientTools<TTail>\n        >\n      : TTools extends ReadonlyArray<infer TItem>\n        ? ContextFromClientToolUnion<TItem>\n        : never\n\nexport type InferredClientContext<TTools> = [\n  ContextFromClientTools<TTools>,\n] extends [never]\n  ? unknown\n  : ContextFromClientTools<TTools>\n\nexport type ClientContextOptionFromTools<TTools, TContext> = [\n  ContextFromClientTools<TTools>,\n] extends [never]\n  ? { context?: TContext }\n  : undefined extends ContextFromClientTools<TTools>\n    ? { context?: TContext & ContextFromClientTools<TTools> }\n    : { context: TContext & ContextFromClientTools<TTools> }\n\n/**\n * Base options for `ChatClient`, excluding the transport (`connection` or\n * `fetcher`) which is supplied separately via `ChatTransport` so the XOR\n * is preserved when composing the final `ChatClientOptions` type.\n */\nexport interface ChatClientBaseOptions<\n  TTools extends ReadonlyArray<AnyClientTool> = any,\n  TContext = unknown,\n  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> =\n    readonly [],\n> {\n  /**\n   * Initial messages to populate the chat\n   */\n  initialMessages?: Array<UIMessage<TTools>>\n\n  /**\n   * Initial resumable run state, useful when rehydrating a persisted client\n   * after a full page reload. This restores the client-side interrupt\n   * descriptors needed to send AG-UI resume entries.\n   */\n  initialResumeSnapshot?: ChatResumeSnapshot\n\n  /**\n   * Arbitrary client-controlled JSON forwarded to the server in the\n   * AG-UI `RunAgentInput.forwardedProps` field. Use this for per-session\n   * options like provider/model selection or feature flags that the\n   * server endpoint should read.\n   *\n   * Replaces the legacy `body` option. If both are provided,\n   * `forwardedProps` wins on key collision.\n   */\n  forwardedProps?: Record<string, any>\n\n  /**\n   * @deprecated Use `forwardedProps` instead. `body` continues to work\n   * unchanged — its values are merged into the AG-UI\n   * `RunAgentInput.forwardedProps` field on the wire and are also\n   * mirrored under the legacy `data` field for servers that have not\n   * migrated yet. Will be removed in a future major release.\n   */\n  body?: Record<string, any>\n\n  /**\n   * Optional BYOK keyring. On each send the client prepares the resolved\n   * provider and stamps `x-byok-*` request headers. Keys never go in the body.\n   */\n  byok?: ByokClient\n\n  /**\n   * The agents you pass to `chat({ subagents: { agents } })`, for types only.\n   * The client does not call `run`. `createChatHook` from\n   * `@tanstack/ai-react/ui` requires a `subagentsComponents` entry for every\n   * agent name.\n   */\n  subagents?: ReadonlyArray<SubagentClientAgent>\n\n  /**\n   * Optional provider id for this chat. If it returns a provider slug,\n   * only that key is prepared and sent. Otherwise the merged `provider`\n   * from `forwardedProps`, `body`, and per-call `sendMessage` `body` is\n   * used. Later sources win. If no slug resolves, the send throws\n   * instead of attaching every stored key.\n   */\n  byokProvider?: () => string | undefined\n\n  /**\n   * Client-local runtime context passed to client tool implementations.\n   *\n   * This value is not serialized to the server. Use `forwardedProps` for\n   * explicit client-to-server handoff of serializable values.\n   */\n  context?: TContext\n\n  /**\n   * Callback when a response is received\n   */\n  onResponse?: (response?: Response) => void | Promise<void>\n\n  /**\n   * Callback when a stream chunk is received\n   */\n  onChunk?: (chunk: StreamChunk) => void\n\n  /**\n   * Callback when the response is finished\n   */\n  onFinish?: (message: UIMessage<TTools>) => void\n\n  /**\n   * Callback when an error occurs\n   */\n  onError?: (error: Error) => void\n\n  /**\n   * Callback when messages change\n   */\n  onMessagesChange?: (messages: Array<UIMessage<TTools>>) => void\n\n  /**\n   * Callback when loading state changes\n   */\n  onLoadingChange?: (isLoading: boolean) => void\n\n  /**\n   * Callback when error state changes\n   */\n  onErrorChange?: (error: Error | undefined) => void\n\n  /**\n   * Callback when chat status changes\n   */\n  onStatusChange?: (status: ChatClientState) => void\n\n  /**\n   * Callback when subscription lifecycle changes.\n   * This is independent from request lifecycle (`isLoading`, `status`).\n   */\n  onSubscriptionChange?: (isSubscribed: boolean) => void\n\n  /**\n   * Callback when connection lifecycle changes.\n   */\n  onConnectionStatusChange?: (status: ConnectionStatus) => void\n\n  /**\n   * Callback when session generation activity changes.\n   * Derived from stream run events (RUN_STARTED / RUN_FINISHED / RUN_ERROR).\n   * Unlike `onLoadingChange` (request-local), this reflects shared generation\n   * activity visible to all subscribers (e.g. across tabs/devices).\n   */\n  onSessionGeneratingChange?: (isGenerating: boolean) => void\n\n  /**\n   * Policy for messages sent while the client is busy (streaming, claiming\n   * a send, or draining the queue). Accepts a `WhenBusy` string, a\n   * `QueueConfig`, or a `QueueStrategy` function.\n   * Default: `{ whenBusy: 'queue', drain: 'fifo' }`.\n   * Queued items auto-send only after a **successful** settle; they are\n   * discarded on error/abort, `stop()`, `clear()`, `unsubscribe()`, and\n   * `reload()`.\n   */\n  queue?: QueueOption\n\n  /**\n   * Callback when the pending send queue changes (enqueue, cancel, drain,\n   * or flush).\n   */\n  onQueueChange?: (queue: Array<QueuedMessage>) => void\n\n  /**\n   * Callback when resumable run state or pending interrupts change.\n   */\n  onResumeStateChange?: (\n    resumeState: ChatResumeState | null,\n    pendingInterrupts: BoundInterrupts<TTools, TInterrupts>,\n  ) => void\n\n  /**\n   * Callback when the id of the run this client has in flight changes: the new\n   * id when a run starts (a send, or a `joinRun` rejoin), `null` when it settles.\n   */\n  onRunIdChange?: (runId: string | null) => void\n\n  /**\n   * Callback when the immutable interrupt state snapshot changes.\n   * Snapshot restoration passes `{ source: 'hydrate' }`; streamed and\n   * client-initiated updates pass `{ source: 'live' }`.\n   */\n  onInterruptStateChange?: (\n    state: ChatInterruptState<TTools, TInterrupts>,\n    context: { source: 'hydrate' | 'live' },\n  ) => void\n\n  /**\n   * Callback when a custom event is received from a server-side tool.\n   * Custom events are emitted by tools using `context.emitCustomEvent()` during execution.\n   *\n   * @param eventType - The name of the custom event\n   * @param data - The event payload data\n   * @param context - Additional context including the toolCallId that emitted the event\n   */\n  onCustomEvent?: (\n    eventType: string,\n    data: unknown,\n    context: { toolCallId?: string },\n  ) => void\n\n  /**\n   * Client-side tools with execution logic\n   * When provided, tools with execute functions will be called automatically\n   */\n  tools?: TTools\n\n  /** First-party generic interrupts this client can type and resolve. */\n  interrupts?: TInterrupts\n\n  /**\n   * Devtools hook metadata for this client instance.\n   */\n  devtools?: Partial<AIDevtoolsClientMetadata>\n\n  /**\n   * Factory that constructs the devtools bridge. Default is a no-op\n   * factory, which keeps `@tanstack/ai-client/devtools` (the heavy\n   * bridge implementation) out of the main entry's bundle. Frameworks\n   * that need live devtools should pass the real factory from\n   * `@tanstack/ai-client/devtools`.\n   */\n  devtoolsBridgeFactory?: ChatDevtoolsBridgeFactory\n\n  /**\n   * Stream processing options (optional)\n   * Configure chunking strategy\n   */\n  streamProcessor?: {\n    /**\n     * Strategy for when to emit text updates\n     * Defaults to ImmediateStrategy (every chunk)\n     */\n    chunkStrategy?: ChunkStrategy\n  }\n}\n\n/**\n * Options for `ChatClient`. Exactly one of `connection` or `fetcher` must be\n * provided — the type-level XOR is enforced via `ChatTransport`. Persistence\n * that is on requires a `threadId` via {@link ChatPersistenceOptions}.\n */\nexport type ChatClientOptions<\n  TTools extends ReadonlyArray<AnyClientTool> = any,\n  TContext = InferredClientContext<TTools>,\n  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> =\n    readonly [],\n> = DistributedOmit<\n  ChatClientBaseOptions<TTools, TContext, TInterrupts>,\n  'context'\n> &\n  ClientContextOptionFromTools<TTools, TContext> &\n  ChatTransport &\n  ChatPersistenceOptions<TTools>\n\nexport interface ChatRequestBody {\n  messages: Array<ModelMessage>\n  data?: Record<string, any>\n}\n\n/**\n * Create a typed array of client tools with proper type inference.\n * This eliminates the need for `as const` when defining tool arrays.\n *\n * @example\n * ```ts\n * const tools = clientTools(\n *   myTool1.client(() => result1),\n *   myTool2.client(() => result2),\n * )\n *\n * // tools is now properly typed as a tuple with literal tool names\n * // This enables type narrowing when checking part.name === 'toolName'\n * ```\n */\nexport function clientTools<const T extends Array<AnyClientTool>>(\n  ...tools: T\n): T {\n  return tools\n}\n\n/**\n * Helper to create typed chat client options\n * Use this to get proper type inference for messages\n *\n * @example\n * ```ts\n * const tools = clientTools(myTool1, myTool2)\n *\n * const chatOptions = createChatClientOptions({\n *   connection: fetchServerSentEvents('/api/chat'),\n *   tools,\n * })\n *\n * type MyMessages = InferChatMessages<typeof chatOptions>\n * ```\n */\nexport function createChatClientOptions<\n  const TTools extends ReadonlyArray<AnyClientTool>,\n  TContext = InferredClientContext<TTools>,\n  const TInterrupts extends ReadonlyArray<\n    InterruptDefinition<any, any, any, any>\n  > = readonly [],\n>(\n  options: ChatClientOptions<TTools, TContext, TInterrupts>,\n): ChatClientOptions<TTools, TContext, TInterrupts> {\n  return options\n}\n\n/**\n * Extract the message type from chat options\n *\n * @example\n * ```ts\n * const chatOptions = createChatClientOptions({\n *   connection: fetchServerSentEvents('/api/chat'),\n *   tools: [myTool1, myTool2],\n * })\n *\n * type MyMessages = InferChatMessages<typeof chatOptions>\n * // MyMessages is now Array<UIMessage<[typeof myTool1, typeof myTool2]>>\n * ```\n */\nexport type InferChatMessages<T> =\n  T extends ChatClientOptions<infer TTools, any>\n    ? Array<UIMessage<TTools>>\n    : never\n"],"mappings":";;;;;;;;;;;;;;;;AAqsCA,SAAgB,YACd,GAAG,OACA;CACH,OAAO;AACT;;;;;;;;;;;;;;;;;AAkBA,SAAgB,wBAOd,SACkD;CAClD,OAAO;AACT"}

package/dist/esm/web-mcp-tools.d.ts

@@ -47,3 +47,63 @@ export type RegisterWebMCPToolsOptions<TTools extends ReadonlyArray<AnyClientToo
  * ```
  */
 export declare function registerWebMCPTools<const TTools extends ReadonlyArray<AnyClientTool>, TContext = InferredClientContext<TTools>>(tools: TTools, options: RegisterWebMCPToolsOptions<TTools, TContext>): Promise<void>;
+/** A tool that a page registered with WebMCP, as `getTools()` returns it. */
+export interface WebMCPPageTool {
+    name: string;
+    title?: string;
+    description: string;
+    /** A JSON Schema object for the tool input. */
+    inputSchema?: object;
+    /** The origin of the document that registered the tool. */
+    origin: string;
+    annotations?: WebMCPToolAnnotations;
+}
+/** Options for {@link getWebMCPTools}. */
+export interface GetWebMCPToolsOptions {
+    /** Return `false` to skip a tool. */
+    filter?: (tool: WebMCPPageTool) => boolean;
+}
+/** Options for {@link subscribeWebMCPTools}. */
+export interface SubscribeWebMCPToolsOptions extends GetWebMCPToolsOptions {
+    /** Stops the subscription when it aborts. */
+    signal: AbortSignal;
+    /** Receives a failure from the WebMCP `getTools()` call. */
+    onError?: (error: unknown) => void;
+}
+/**
+ * Reads the WebMCP tools on the page and returns them as client tools.
+ *
+ * Pass the result to a chat as `tools`. Each tool runs through the WebMCP
+ * `executeTool()` call. Unsupported browsers and server environments return
+ * an empty array.
+ *
+ * @param options - A filter that skips tools.
+ *
+ * @example
+ * ```ts
+ * const tools = await getWebMCPTools({
+ *   filter: (tool) => tool.origin === location.origin,
+ * })
+ * ```
+ */
+export declare function getWebMCPTools(options?: GetWebMCPToolsOptions): Promise<Array<AnyClientTool>>;
+/**
+ * Calls `listener` with the page WebMCP tools now and after each
+ * `toolchange` event, until `options.signal` aborts.
+ *
+ * Unsupported browsers and server environments call `listener` once with an
+ * empty array. When a read fails, `options.onError` gets the error and the
+ * listener keeps the last list.
+ *
+ * @param listener - Receives the current client tools.
+ * @param options - The subscription signal, a filter, and an error callback.
+ *
+ * @example
+ * ```ts
+ * const controller = new AbortController()
+ * subscribeWebMCPTools((tools) => client.updateOptions({ tools }), {
+ *   signal: controller.signal,
+ * })
+ * ```
+ */
+export declare function subscribeWebMCPTools(listener: (tools: Array<AnyClientTool>) => void, options: SubscribeWebMCPToolsOptions): void;

package/dist/esm/web-mcp-tools.js

@@ -74,7 +74,98 @@ async function registerWebMCPTools(tools, options) {
 		throw error;
 	}
 }
+function isWebMCPToolReader(value) {
+	return value !== null && typeof value === "object" && "getTools" in value && typeof value.getTools === "function" && "executeTool" in value && typeof value.executeTool === "function" && "addEventListener" in value && typeof value.addEventListener === "function" && "removeEventListener" in value && typeof value.removeEventListener === "function";
+}
+function getWebMCPToolReader() {
+	if (typeof document === "undefined" || typeof isSecureContext !== "undefined" && !isSecureContext || !("modelContext" in document) || !isWebMCPToolReader(document.modelContext)) return;
+	return document.modelContext;
+}
+function parseToolResult(result) {
+	try {
+		return JSON.parse(result);
+	} catch {
+		return result;
+	}
+}
+async function readWebMCPTools(reader, options) {
+	const pageTools = await reader.getTools();
+	const names = /* @__PURE__ */ new Set();
+	return pageTools.filter((tool) => options?.filter?.(tool) ?? true).map((tool) => {
+		if (names.has(tool.name)) throw new Error(`Duplicate WebMCP tool name "${tool.name}". Use a filter or register tools with unique names.`);
+		names.add(tool.name);
+		return {
+			__toolSide: "client",
+			name: tool.name,
+			description: tool.description,
+			inputSchema: tool.inputSchema ?? { type: "object" },
+			async execute(input, context) {
+				return parseToolResult(await reader.executeTool(tool, input, context?.abortSignal ? { signal: context.abortSignal } : {}));
+			}
+		};
+	});
+}
+/**
+* Reads the WebMCP tools on the page and returns them as client tools.
+*
+* Pass the result to a chat as `tools`. Each tool runs through the WebMCP
+* `executeTool()` call. Unsupported browsers and server environments return
+* an empty array.
+*
+* @param options - A filter that skips tools.
+*
+* @example
+* ```ts
+* const tools = await getWebMCPTools({
+*   filter: (tool) => tool.origin === location.origin,
+* })
+* ```
+*/
+async function getWebMCPTools(options) {
+	const reader = getWebMCPToolReader();
+	return reader ? readWebMCPTools(reader, options) : [];
+}
+/**
+* Calls `listener` with the page WebMCP tools now and after each
+* `toolchange` event, until `options.signal` aborts.
+*
+* Unsupported browsers and server environments call `listener` once with an
+* empty array. When a read fails, `options.onError` gets the error and the
+* listener keeps the last list.
+*
+* @param listener - Receives the current client tools.
+* @param options - The subscription signal, a filter, and an error callback.
+*
+* @example
+* ```ts
+* const controller = new AbortController()
+* subscribeWebMCPTools((tools) => client.updateOptions({ tools }), {
+*   signal: controller.signal,
+* })
+* ```
+*/
+function subscribeWebMCPTools(listener, options) {
+	if (options.signal.aborted) return;
+	const reader = getWebMCPToolReader();
+	if (!reader) {
+		listener([]);
+		return;
+	}
+	let latestRead = 0;
+	const refresh = () => {
+		const read = ++latestRead;
+		const isCurrent = () => read === latestRead && !options.signal.aborted;
+		readWebMCPTools(reader, options).then((tools) => {
+			if (isCurrent()) listener(tools);
+		}, (error) => {
+			if (isCurrent()) options.onError?.(error);
+		});
+	};
+	reader.addEventListener("toolchange", refresh);
+	options.signal.addEventListener("abort", () => reader.removeEventListener("toolchange", refresh), { once: true });
+	refresh();
+}
 //#endregion
-export { registerWebMCPTools };
+export { getWebMCPTools, registerWebMCPTools, subscribeWebMCPTools };
 
 //# sourceMappingURL=web-mcp-tools.js.map

package/dist/esm/web-mcp-tools.js.map

@@ -1 +1 @@
-{"version":3,"file":"web-mcp-tools.js","names":[],"sources":["../../src/web-mcp-tools.ts"],"sourcesContent":["import {\n  convertSchemaToJsonSchema,\n  validateWithStandardSchema,\n} from '@tanstack/ai/client'\nimport type { AnyClientTool } from '@tanstack/ai/client'\nimport type {\n  ClientContextOptionFromTools,\n  InferredClientContext,\n} from './types'\n\ninterface WebMCPTool {\n  name: string\n  title?: string\n  description: string\n  inputSchema?: object\n  annotations?: WebMCPToolAnnotations\n  execute: (input: object, options: { signal: AbortSignal }) => Promise<unknown>\n}\n\ninterface WebMCPModelContext {\n  registerTool: (\n    tool: WebMCPTool,\n    options: { signal: AbortSignal },\n  ) => Promise<void>\n}\n\n/** WebMCP behavior hints for one registered tool. */\nexport interface WebMCPToolAnnotations {\n  /** Indicates that the tool does not modify state. */\n  readOnlyHint?: boolean\n  /** Indicates that the tool can return content that the application does not trust. */\n  untrustedContentHint?: boolean\n}\n\n/** Display and behavior options for one WebMCP tool. */\nexport interface WebMCPToolOptions {\n  /** A human-readable title for browser user interfaces. */\n  title?: string\n  /** Optional behavior hints for browser agents. */\n  annotations?: WebMCPToolAnnotations\n}\n\n/** WebMCP options keyed by the inferred names in a client tool list. */\nexport type WebMCPToolOptionsByName<\n  TTools extends ReadonlyArray<AnyClientTool>,\n> = Partial<{\n  [TName in TTools[number]['name']]: WebMCPToolOptions\n}>\n\n/**\n * Options for {@link registerWebMCPTools}.\n *\n * The signal controls the registration lifetime. Context is required when a\n * client tool declares a required runtime context.\n */\nexport type RegisterWebMCPToolsOptions<\n  TTools extends ReadonlyArray<AnyClientTool>,\n  TContext = InferredClientContext<TTools>,\n> = {\n  /** Removes all tools from this call when the signal aborts. */\n  signal: AbortSignal\n  /** Per-tool display and behavior options. */\n  toolOptions?: WebMCPToolOptionsByName<TTools>\n} & ClientContextOptionFromTools<TTools, TContext>\n\nfunction isWebMCPModelContext(value: unknown): value is WebMCPModelContext {\n  return (\n    value !== null &&\n    typeof value === 'object' &&\n    'registerTool' in value &&\n    typeof value.registerTool === 'function'\n  )\n}\n\nfunction getToolOptions<TName extends string>(\n  toolOptions: Partial<Record<TName, WebMCPToolOptions>> | undefined,\n  name: TName,\n) {\n  return toolOptions?.[name]\n}\n\nasync function validateSchemaValue(schema: unknown, value: unknown) {\n  const result = await validateWithStandardSchema(schema, value)\n  if (result.success) {\n    return result.data\n  }\n\n  throw new Error(\n    `Validation failed: ${result.issues.map((issue) => issue.message).join(', ')}`,\n  )\n}\n\n/**\n * Registers executable TanStack client tools with the browser WebMCP API.\n *\n * Unsupported browsers and server environments resolve without registration.\n * Abort `options.signal` to remove every tool registered by this call.\n *\n * @param tools - The executable client tools to expose through WebMCP.\n * @param options - The registration signal, runtime context, and per-tool options.\n *\n * @example\n * ```ts\n * const controller = new AbortController()\n * await registerWebMCPTools(tools, { signal: controller.signal })\n * controller.abort()\n * ```\n */\nexport async function registerWebMCPTools<\n  const TTools extends ReadonlyArray<AnyClientTool>,\n  TContext = InferredClientContext<TTools>,\n>(tools: TTools, options: RegisterWebMCPToolsOptions<TTools, TContext>) {\n  if (\n    typeof document === 'undefined' ||\n    (typeof isSecureContext !== 'undefined' && !isSecureContext) ||\n    !('modelContext' in document) ||\n    !isWebMCPModelContext(document.modelContext)\n  ) {\n    return\n  }\n  if (tools.length === 0) {\n    return\n  }\n\n  const names = new Set<string>()\n  const webMCPTools = tools.map((tool) => {\n    if (!/^[A-Za-z0-9_.-]{1,128}$/.test(tool.name)) {\n      throw new Error(\n        `WebMCP tool name \"${tool.name}\" must contain 1 to 128 ASCII letters, numbers, underscores, hyphens, or periods.`,\n      )\n    }\n    if (names.has(tool.name)) {\n      throw new Error(`Duplicate WebMCP tool name \"${tool.name}\".`)\n    }\n    if (tool.description.trim() === '') {\n      throw new Error(`WebMCP tool \"${tool.name}\" must have a description.`)\n    }\n    if (typeof tool.execute !== 'function') {\n      throw new Error(\n        `WebMCP tool \"${tool.name}\" must have an execute handler.`,\n      )\n    }\n    if (tool.needsApproval === true) {\n      throw new Error(\n        `WebMCP tool \"${tool.name}\" cannot use needsApproval: true.`,\n      )\n    }\n\n    names.add(tool.name)\n    const toolOptions = getToolOptions(options.toolOptions, tool.name)\n    const inputSchema = tool.inputSchema\n    const outputSchema = tool.outputSchema\n    const convertedInputSchema = convertSchemaToJsonSchema(inputSchema)\n    const inputSchemaType = convertedInputSchema?.type\n    const requiresNonObjectInput =\n      (typeof inputSchemaType === 'string' && inputSchemaType !== 'object') ||\n      (Array.isArray(inputSchemaType) && !inputSchemaType.includes('object'))\n    if (requiresNonObjectInput) {\n      throw new Error(\n        `WebMCP tool \"${tool.name}\" input schema must accept an object.`,\n      )\n    }\n    const execute = tool.execute\n\n    return {\n      name: tool.name,\n      description: tool.description,\n      ...(toolOptions?.title !== undefined ? { title: toolOptions.title } : {}),\n      ...(convertedInputSchema !== undefined\n        ? { inputSchema: convertedInputSchema }\n        : {}),\n      ...(toolOptions?.annotations !== undefined\n        ? { annotations: toolOptions.annotations }\n        : {}),\n      async execute(\n        input: object,\n        executionOptions?: { signal?: AbortSignal },\n      ) {\n        const validatedInput = await validateSchemaValue(inputSchema, input)\n        const output = await execute(validatedInput, {\n          abortSignal: executionOptions?.signal,\n          context: options.context,\n          emitCustomEvent() {},\n        })\n        return validateSchemaValue(outputSchema, output)\n      },\n    }\n  })\n\n  const registrationController = new AbortController()\n  const abortRegistration = () =>\n    registrationController.abort(options.signal.reason)\n\n  if (options.signal.aborted) {\n    abortRegistration()\n  } else {\n    options.signal.addEventListener('abort', abortRegistration, { once: true })\n  }\n\n  try {\n    for (const tool of webMCPTools) {\n      await document.modelContext.registerTool(tool, {\n        signal: registrationController.signal,\n      })\n    }\n  } catch (error) {\n    registrationController.abort(error)\n    options.signal.removeEventListener('abort', abortRegistration)\n    throw error\n  }\n}\n"],"mappings":";;AAiEA,SAAS,qBAAqB,OAA6C;CACzE,OACE,UAAU,QACV,OAAO,UAAU,YACjB,kBAAkB,SAClB,OAAO,MAAM,iBAAiB;AAElC;AAEA,SAAS,eACP,aACA,MACA;CACA,OAAO,cAAc;AACvB;AAEA,eAAe,oBAAoB,QAAiB,OAAgB;CAClE,MAAM,SAAS,MAAM,2BAA2B,QAAQ,KAAK;CAC7D,IAAI,OAAO,SACT,OAAO,OAAO;CAGhB,MAAM,IAAI,MACR,sBAAsB,OAAO,OAAO,KAAK,UAAU,MAAM,OAAO,CAAC,CAAC,KAAK,IAAI,GAC7E;AACF;;;;;;;;;;;;;;;;;AAkBA,eAAsB,oBAGpB,OAAe,SAAuD;CACtE,IACE,OAAO,aAAa,eACnB,OAAO,oBAAoB,eAAe,CAAC,mBAC5C,EAAE,kBAAkB,aACpB,CAAC,qBAAqB,SAAS,YAAY,GAE3C;CAEF,IAAI,MAAM,WAAW,GACnB;CAGF,MAAM,wBAAQ,IAAI,IAAY;CAC9B,MAAM,cAAc,MAAM,KAAK,SAAS;EACtC,IAAI,CAAC,0BAA0B,KAAK,KAAK,IAAI,GAC3C,MAAM,IAAI,MACR,qBAAqB,KAAK,KAAK,kFACjC;EAEF,IAAI,MAAM,IAAI,KAAK,IAAI,GACrB,MAAM,IAAI,MAAM,+BAA+B,KAAK,KAAK,GAAG;EAE9D,IAAI,KAAK,YAAY,KAAK,MAAM,IAC9B,MAAM,IAAI,MAAM,gBAAgB,KAAK,KAAK,2BAA2B;EAEvE,IAAI,OAAO,KAAK,YAAY,YAC1B,MAAM,IAAI,MACR,gBAAgB,KAAK,KAAK,gCAC5B;EAEF,IAAI,KAAK,kBAAkB,MACzB,MAAM,IAAI,MACR,gBAAgB,KAAK,KAAK,kCAC5B;EAGF,MAAM,IAAI,KAAK,IAAI;EACnB,MAAM,cAAc,eAAe,QAAQ,aAAa,KAAK,IAAI;EACjE,MAAM,cAAc,KAAK;EACzB,MAAM,eAAe,KAAK;EAC1B,MAAM,uBAAuB,0BAA0B,WAAW;EAClE,MAAM,kBAAkB,sBAAsB;EAI9C,IAFG,OAAO,oBAAoB,YAAY,oBAAoB,YAC3D,MAAM,QAAQ,eAAe,KAAK,CAAC,gBAAgB,SAAS,QAAQ,GAErE,MAAM,IAAI,MACR,gBAAgB,KAAK,KAAK,sCAC5B;EAEF,MAAM,UAAU,KAAK;EAErB,OAAO;GACL,MAAM,KAAK;GACX,aAAa,KAAK;GAClB,GAAI,aAAa,UAAU,KAAA,IAAY,EAAE,OAAO,YAAY,MAAM,IAAI,CAAC;GACvE,GAAI,yBAAyB,KAAA,IACzB,EAAE,aAAa,qBAAqB,IACpC,CAAC;GACL,GAAI,aAAa,gBAAgB,KAAA,IAC7B,EAAE,aAAa,YAAY,YAAY,IACvC,CAAC;GACL,MAAM,QACJ,OACA,kBACA;IACA,MAAM,iBAAiB,MAAM,oBAAoB,aAAa,KAAK;IACnE,MAAM,SAAS,MAAM,QAAQ,gBAAgB;KAC3C,aAAa,kBAAkB;KAC/B,SAAS,QAAQ;KACjB,kBAAkB,CAAC;IACrB,CAAC;IACD,OAAO,oBAAoB,cAAc,MAAM;GACjD;EACF;CACF,CAAC;CAED,MAAM,yBAAyB,IAAI,gBAAgB;CACnD,MAAM,0BACJ,uBAAuB,MAAM,QAAQ,OAAO,MAAM;CAEpD,IAAI,QAAQ,OAAO,SACjB,kBAAkB;MAElB,QAAQ,OAAO,iBAAiB,SAAS,mBAAmB,EAAE,MAAM,KAAK,CAAC;CAG5E,IAAI;EACF,KAAK,MAAM,QAAQ,aACjB,MAAM,SAAS,aAAa,aAAa,MAAM,EAC7C,QAAQ,uBAAuB,OACjC,CAAC;CAEL,SAAS,OAAO;EACd,uBAAuB,MAAM,KAAK;EAClC,QAAQ,OAAO,oBAAoB,SAAS,iBAAiB;EAC7D,MAAM;CACR;AACF"}
+{"version":3,"file":"web-mcp-tools.js","names":[],"sources":["../../src/web-mcp-tools.ts"],"sourcesContent":["import {\n  convertSchemaToJsonSchema,\n  validateWithStandardSchema,\n} from '@tanstack/ai/client'\nimport type { AnyClientTool } from '@tanstack/ai/client'\nimport type {\n  ClientContextOptionFromTools,\n  InferredClientContext,\n} from './types'\n\ninterface WebMCPTool {\n  name: string\n  title?: string\n  description: string\n  inputSchema?: object\n  annotations?: WebMCPToolAnnotations\n  execute: (input: object, options: { signal: AbortSignal }) => Promise<unknown>\n}\n\ninterface WebMCPModelContext {\n  registerTool: (\n    tool: WebMCPTool,\n    options: { signal: AbortSignal },\n  ) => Promise<void>\n}\n\n/** WebMCP behavior hints for one registered tool. */\nexport interface WebMCPToolAnnotations {\n  /** Indicates that the tool does not modify state. */\n  readOnlyHint?: boolean\n  /** Indicates that the tool can return content that the application does not trust. */\n  untrustedContentHint?: boolean\n}\n\n/** Display and behavior options for one WebMCP tool. */\nexport interface WebMCPToolOptions {\n  /** A human-readable title for browser user interfaces. */\n  title?: string\n  /** Optional behavior hints for browser agents. */\n  annotations?: WebMCPToolAnnotations\n}\n\n/** WebMCP options keyed by the inferred names in a client tool list. */\nexport type WebMCPToolOptionsByName<\n  TTools extends ReadonlyArray<AnyClientTool>,\n> = Partial<{\n  [TName in TTools[number]['name']]: WebMCPToolOptions\n}>\n\n/**\n * Options for {@link registerWebMCPTools}.\n *\n * The signal controls the registration lifetime. Context is required when a\n * client tool declares a required runtime context.\n */\nexport type RegisterWebMCPToolsOptions<\n  TTools extends ReadonlyArray<AnyClientTool>,\n  TContext = InferredClientContext<TTools>,\n> = {\n  /** Removes all tools from this call when the signal aborts. */\n  signal: AbortSignal\n  /** Per-tool display and behavior options. */\n  toolOptions?: WebMCPToolOptionsByName<TTools>\n} & ClientContextOptionFromTools<TTools, TContext>\n\nfunction isWebMCPModelContext(value: unknown): value is WebMCPModelContext {\n  return (\n    value !== null &&\n    typeof value === 'object' &&\n    'registerTool' in value &&\n    typeof value.registerTool === 'function'\n  )\n}\n\nfunction getToolOptions<TName extends string>(\n  toolOptions: Partial<Record<TName, WebMCPToolOptions>> | undefined,\n  name: TName,\n) {\n  return toolOptions?.[name]\n}\n\nasync function validateSchemaValue(schema: unknown, value: unknown) {\n  const result = await validateWithStandardSchema(schema, value)\n  if (result.success) {\n    return result.data\n  }\n\n  throw new Error(\n    `Validation failed: ${result.issues.map((issue) => issue.message).join(', ')}`,\n  )\n}\n\n/**\n * Registers executable TanStack client tools with the browser WebMCP API.\n *\n * Unsupported browsers and server environments resolve without registration.\n * Abort `options.signal` to remove every tool registered by this call.\n *\n * @param tools - The executable client tools to expose through WebMCP.\n * @param options - The registration signal, runtime context, and per-tool options.\n *\n * @example\n * ```ts\n * const controller = new AbortController()\n * await registerWebMCPTools(tools, { signal: controller.signal })\n * controller.abort()\n * ```\n */\nexport async function registerWebMCPTools<\n  const TTools extends ReadonlyArray<AnyClientTool>,\n  TContext = InferredClientContext<TTools>,\n>(tools: TTools, options: RegisterWebMCPToolsOptions<TTools, TContext>) {\n  if (\n    typeof document === 'undefined' ||\n    (typeof isSecureContext !== 'undefined' && !isSecureContext) ||\n    !('modelContext' in document) ||\n    !isWebMCPModelContext(document.modelContext)\n  ) {\n    return\n  }\n  if (tools.length === 0) {\n    return\n  }\n\n  const names = new Set<string>()\n  const webMCPTools = tools.map((tool) => {\n    if (!/^[A-Za-z0-9_.-]{1,128}$/.test(tool.name)) {\n      throw new Error(\n        `WebMCP tool name \"${tool.name}\" must contain 1 to 128 ASCII letters, numbers, underscores, hyphens, or periods.`,\n      )\n    }\n    if (names.has(tool.name)) {\n      throw new Error(`Duplicate WebMCP tool name \"${tool.name}\".`)\n    }\n    if (tool.description.trim() === '') {\n      throw new Error(`WebMCP tool \"${tool.name}\" must have a description.`)\n    }\n    if (typeof tool.execute !== 'function') {\n      throw new Error(\n        `WebMCP tool \"${tool.name}\" must have an execute handler.`,\n      )\n    }\n    if (tool.needsApproval === true) {\n      throw new Error(\n        `WebMCP tool \"${tool.name}\" cannot use needsApproval: true.`,\n      )\n    }\n\n    names.add(tool.name)\n    const toolOptions = getToolOptions(options.toolOptions, tool.name)\n    const inputSchema = tool.inputSchema\n    const outputSchema = tool.outputSchema\n    const convertedInputSchema = convertSchemaToJsonSchema(inputSchema)\n    const inputSchemaType = convertedInputSchema?.type\n    const requiresNonObjectInput =\n      (typeof inputSchemaType === 'string' && inputSchemaType !== 'object') ||\n      (Array.isArray(inputSchemaType) && !inputSchemaType.includes('object'))\n    if (requiresNonObjectInput) {\n      throw new Error(\n        `WebMCP tool \"${tool.name}\" input schema must accept an object.`,\n      )\n    }\n    const execute = tool.execute\n\n    return {\n      name: tool.name,\n      description: tool.description,\n      ...(toolOptions?.title !== undefined ? { title: toolOptions.title } : {}),\n      ...(convertedInputSchema !== undefined\n        ? { inputSchema: convertedInputSchema }\n        : {}),\n      ...(toolOptions?.annotations !== undefined\n        ? { annotations: toolOptions.annotations }\n        : {}),\n      async execute(\n        input: object,\n        executionOptions?: { signal?: AbortSignal },\n      ) {\n        const validatedInput = await validateSchemaValue(inputSchema, input)\n        const output = await execute(validatedInput, {\n          abortSignal: executionOptions?.signal,\n          context: options.context,\n          emitCustomEvent() {},\n        })\n        return validateSchemaValue(outputSchema, output)\n      },\n    }\n  })\n\n  const registrationController = new AbortController()\n  const abortRegistration = () =>\n    registrationController.abort(options.signal.reason)\n\n  if (options.signal.aborted) {\n    abortRegistration()\n  } else {\n    options.signal.addEventListener('abort', abortRegistration, { once: true })\n  }\n\n  try {\n    for (const tool of webMCPTools) {\n      await document.modelContext.registerTool(tool, {\n        signal: registrationController.signal,\n      })\n    }\n  } catch (error) {\n    registrationController.abort(error)\n    options.signal.removeEventListener('abort', abortRegistration)\n    throw error\n  }\n}\n\n/** A tool that a page registered with WebMCP, as `getTools()` returns it. */\nexport interface WebMCPPageTool {\n  name: string\n  title?: string\n  description: string\n  /** A JSON Schema object for the tool input. */\n  inputSchema?: object\n  /** The origin of the document that registered the tool. */\n  origin: string\n  annotations?: WebMCPToolAnnotations\n}\n\ninterface WebMCPToolReader {\n  getTools: () => Promise<Array<WebMCPPageTool>>\n  executeTool: (\n    tool: WebMCPPageTool,\n    input: unknown,\n    options: { signal?: AbortSignal },\n  ) => Promise<string>\n  addEventListener: EventTarget['addEventListener']\n  removeEventListener: EventTarget['removeEventListener']\n}\n\n/** Options for {@link getWebMCPTools}. */\nexport interface GetWebMCPToolsOptions {\n  /** Return `false` to skip a tool. */\n  filter?: (tool: WebMCPPageTool) => boolean\n}\n\n/** Options for {@link subscribeWebMCPTools}. */\nexport interface SubscribeWebMCPToolsOptions extends GetWebMCPToolsOptions {\n  /** Stops the subscription when it aborts. */\n  signal: AbortSignal\n  /** Receives a failure from the WebMCP `getTools()` call. */\n  onError?: (error: unknown) => void\n}\n\nfunction isWebMCPToolReader(value: unknown): value is WebMCPToolReader {\n  return (\n    value !== null &&\n    typeof value === 'object' &&\n    'getTools' in value &&\n    typeof value.getTools === 'function' &&\n    'executeTool' in value &&\n    typeof value.executeTool === 'function' &&\n    'addEventListener' in value &&\n    typeof value.addEventListener === 'function' &&\n    'removeEventListener' in value &&\n    typeof value.removeEventListener === 'function'\n  )\n}\n\nfunction getWebMCPToolReader() {\n  if (\n    typeof document === 'undefined' ||\n    (typeof isSecureContext !== 'undefined' && !isSecureContext) ||\n    !('modelContext' in document) ||\n    !isWebMCPToolReader(document.modelContext)\n  ) {\n    return undefined\n  }\n  return document.modelContext\n}\n\nfunction parseToolResult(result: string): unknown {\n  try {\n    return JSON.parse(result)\n  } catch {\n    return result\n  }\n}\n\nasync function readWebMCPTools(\n  reader: WebMCPToolReader,\n  options: GetWebMCPToolsOptions | undefined,\n): Promise<Array<AnyClientTool>> {\n  const pageTools = await reader.getTools()\n  const names = new Set<string>()\n  return pageTools\n    .filter((tool) => options?.filter?.(tool) ?? true)\n    .map((tool) => {\n      if (names.has(tool.name)) {\n        throw new Error(\n          `Duplicate WebMCP tool name \"${tool.name}\". Use a filter or register tools with unique names.`,\n        )\n      }\n      names.add(tool.name)\n      return {\n        __toolSide: 'client' as const,\n        name: tool.name,\n        description: tool.description,\n        inputSchema: tool.inputSchema ?? { type: 'object' },\n        async execute(input: unknown, context?: { abortSignal?: AbortSignal }) {\n          const result = await reader.executeTool(\n            tool,\n            input,\n            context?.abortSignal ? { signal: context.abortSignal } : {},\n          )\n          return parseToolResult(result)\n        },\n      }\n    })\n}\n\n/**\n * Reads the WebMCP tools on the page and returns them as client tools.\n *\n * Pass the result to a chat as `tools`. Each tool runs through the WebMCP\n * `executeTool()` call. Unsupported browsers and server environments return\n * an empty array.\n *\n * @param options - A filter that skips tools.\n *\n * @example\n * ```ts\n * const tools = await getWebMCPTools({\n *   filter: (tool) => tool.origin === location.origin,\n * })\n * ```\n */\nexport async function getWebMCPTools(\n  options?: GetWebMCPToolsOptions,\n): Promise<Array<AnyClientTool>> {\n  const reader = getWebMCPToolReader()\n  return reader ? readWebMCPTools(reader, options) : []\n}\n\n/**\n * Calls `listener` with the page WebMCP tools now and after each\n * `toolchange` event, until `options.signal` aborts.\n *\n * Unsupported browsers and server environments call `listener` once with an\n * empty array. When a read fails, `options.onError` gets the error and the\n * listener keeps the last list.\n *\n * @param listener - Receives the current client tools.\n * @param options - The subscription signal, a filter, and an error callback.\n *\n * @example\n * ```ts\n * const controller = new AbortController()\n * subscribeWebMCPTools((tools) => client.updateOptions({ tools }), {\n *   signal: controller.signal,\n * })\n * ```\n */\nexport function subscribeWebMCPTools(\n  listener: (tools: Array<AnyClientTool>) => void,\n  options: SubscribeWebMCPToolsOptions,\n): void {\n  if (options.signal.aborted) return\n  const reader = getWebMCPToolReader()\n  if (!reader) {\n    listener([])\n    return\n  }\n\n  let latestRead = 0\n  const refresh = () => {\n    const read = ++latestRead\n    const isCurrent = () => read === latestRead && !options.signal.aborted\n    readWebMCPTools(reader, options).then(\n      (tools) => {\n        if (isCurrent()) listener(tools)\n      },\n      (error: unknown) => {\n        if (isCurrent()) options.onError?.(error)\n      },\n    )\n  }\n\n  // Remove the listener by hand: Zone.js breaks the `signal` listener option.\n  reader.addEventListener('toolchange', refresh)\n  options.signal.addEventListener(\n    'abort',\n    () => reader.removeEventListener('toolchange', refresh),\n    { once: true },\n  )\n  refresh()\n}\n"],"mappings":";;AAiEA,SAAS,qBAAqB,OAA6C;CACzE,OACE,UAAU,QACV,OAAO,UAAU,YACjB,kBAAkB,SAClB,OAAO,MAAM,iBAAiB;AAElC;AAEA,SAAS,eACP,aACA,MACA;CACA,OAAO,cAAc;AACvB;AAEA,eAAe,oBAAoB,QAAiB,OAAgB;CAClE,MAAM,SAAS,MAAM,2BAA2B,QAAQ,KAAK;CAC7D,IAAI,OAAO,SACT,OAAO,OAAO;CAGhB,MAAM,IAAI,MACR,sBAAsB,OAAO,OAAO,KAAK,UAAU,MAAM,OAAO,CAAC,CAAC,KAAK,IAAI,GAC7E;AACF;;;;;;;;;;;;;;;;;AAkBA,eAAsB,oBAGpB,OAAe,SAAuD;CACtE,IACE,OAAO,aAAa,eACnB,OAAO,oBAAoB,eAAe,CAAC,mBAC5C,EAAE,kBAAkB,aACpB,CAAC,qBAAqB,SAAS,YAAY,GAE3C;CAEF,IAAI,MAAM,WAAW,GACnB;CAGF,MAAM,wBAAQ,IAAI,IAAY;CAC9B,MAAM,cAAc,MAAM,KAAK,SAAS;EACtC,IAAI,CAAC,0BAA0B,KAAK,KAAK,IAAI,GAC3C,MAAM,IAAI,MACR,qBAAqB,KAAK,KAAK,kFACjC;EAEF,IAAI,MAAM,IAAI,KAAK,IAAI,GACrB,MAAM,IAAI,MAAM,+BAA+B,KAAK,KAAK,GAAG;EAE9D,IAAI,KAAK,YAAY,KAAK,MAAM,IAC9B,MAAM,IAAI,MAAM,gBAAgB,KAAK,KAAK,2BAA2B;EAEvE,IAAI,OAAO,KAAK,YAAY,YAC1B,MAAM,IAAI,MACR,gBAAgB,KAAK,KAAK,gCAC5B;EAEF,IAAI,KAAK,kBAAkB,MACzB,MAAM,IAAI,MACR,gBAAgB,KAAK,KAAK,kCAC5B;EAGF,MAAM,IAAI,KAAK,IAAI;EACnB,MAAM,cAAc,eAAe,QAAQ,aAAa,KAAK,IAAI;EACjE,MAAM,cAAc,KAAK;EACzB,MAAM,eAAe,KAAK;EAC1B,MAAM,uBAAuB,0BAA0B,WAAW;EAClE,MAAM,kBAAkB,sBAAsB;EAI9C,IAFG,OAAO,oBAAoB,YAAY,oBAAoB,YAC3D,MAAM,QAAQ,eAAe,KAAK,CAAC,gBAAgB,SAAS,QAAQ,GAErE,MAAM,IAAI,MACR,gBAAgB,KAAK,KAAK,sCAC5B;EAEF,MAAM,UAAU,KAAK;EAErB,OAAO;GACL,MAAM,KAAK;GACX,aAAa,KAAK;GAClB,GAAI,aAAa,UAAU,KAAA,IAAY,EAAE,OAAO,YAAY,MAAM,IAAI,CAAC;GACvE,GAAI,yBAAyB,KAAA,IACzB,EAAE,aAAa,qBAAqB,IACpC,CAAC;GACL,GAAI,aAAa,gBAAgB,KAAA,IAC7B,EAAE,aAAa,YAAY,YAAY,IACvC,CAAC;GACL,MAAM,QACJ,OACA,kBACA;IACA,MAAM,iBAAiB,MAAM,oBAAoB,aAAa,KAAK;IACnE,MAAM,SAAS,MAAM,QAAQ,gBAAgB;KAC3C,aAAa,kBAAkB;KAC/B,SAAS,QAAQ;KACjB,kBAAkB,CAAC;IACrB,CAAC;IACD,OAAO,oBAAoB,cAAc,MAAM;GACjD;EACF;CACF,CAAC;CAED,MAAM,yBAAyB,IAAI,gBAAgB;CACnD,MAAM,0BACJ,uBAAuB,MAAM,QAAQ,OAAO,MAAM;CAEpD,IAAI,QAAQ,OAAO,SACjB,kBAAkB;MAElB,QAAQ,OAAO,iBAAiB,SAAS,mBAAmB,EAAE,MAAM,KAAK,CAAC;CAG5E,IAAI;EACF,KAAK,MAAM,QAAQ,aACjB,MAAM,SAAS,aAAa,aAAa,MAAM,EAC7C,QAAQ,uBAAuB,OACjC,CAAC;CAEL,SAAS,OAAO;EACd,uBAAuB,MAAM,KAAK;EAClC,QAAQ,OAAO,oBAAoB,SAAS,iBAAiB;EAC7D,MAAM;CACR;AACF;AAuCA,SAAS,mBAAmB,OAA2C;CACrE,OACE,UAAU,QACV,OAAO,UAAU,YACjB,cAAc,SACd,OAAO,MAAM,aAAa,cAC1B,iBAAiB,SACjB,OAAO,MAAM,gBAAgB,cAC7B,sBAAsB,SACtB,OAAO,MAAM,qBAAqB,cAClC,yBAAyB,SACzB,OAAO,MAAM,wBAAwB;AAEzC;AAEA,SAAS,sBAAsB;CAC7B,IACE,OAAO,aAAa,eACnB,OAAO,oBAAoB,eAAe,CAAC,mBAC5C,EAAE,kBAAkB,aACpB,CAAC,mBAAmB,SAAS,YAAY,GAEzC;CAEF,OAAO,SAAS;AAClB;AAEA,SAAS,gBAAgB,QAAyB;CAChD,IAAI;EACF,OAAO,KAAK,MAAM,MAAM;CAC1B,QAAQ;EACN,OAAO;CACT;AACF;AAEA,eAAe,gBACb,QACA,SAC+B;CAC/B,MAAM,YAAY,MAAM,OAAO,SAAS;CACxC,MAAM,wBAAQ,IAAI,IAAY;CAC9B,OAAO,UACJ,QAAQ,SAAS,SAAS,SAAS,IAAI,KAAK,IAAI,CAAC,CACjD,KAAK,SAAS;EACb,IAAI,MAAM,IAAI,KAAK,IAAI,GACrB,MAAM,IAAI,MACR,+BAA+B,KAAK,KAAK,qDAC3C;EAEF,MAAM,IAAI,KAAK,IAAI;EACnB,OAAO;GACL,YAAY;GACZ,MAAM,KAAK;GACX,aAAa,KAAK;GAClB,aAAa,KAAK,eAAe,EAAE,MAAM,SAAS;GAClD,MAAM,QAAQ,OAAgB,SAAyC;IAMrE,OAAO,gBAAgB,MALF,OAAO,YAC1B,MACA,OACA,SAAS,cAAc,EAAE,QAAQ,QAAQ,YAAY,IAAI,CAAC,CAC5D,CAC6B;GAC/B;EACF;CACF,CAAC;AACL;;;;;;;;;;;;;;;;;AAkBA,eAAsB,eACpB,SAC+B;CAC/B,MAAM,SAAS,oBAAoB;CACnC,OAAO,SAAS,gBAAgB,QAAQ,OAAO,IAAI,CAAC;AACtD;;;;;;;;;;;;;;;;;;;;AAqBA,SAAgB,qBACd,UACA,SACM;CACN,IAAI,QAAQ,OAAO,SAAS;CAC5B,MAAM,SAAS,oBAAoB;CACnC,IAAI,CAAC,QAAQ;EACX,SAAS,CAAC,CAAC;EACX;CACF;CAEA,IAAI,aAAa;CACjB,MAAM,gBAAgB;EACpB,MAAM,OAAO,EAAE;EACf,MAAM,kBAAkB,SAAS,cAAc,CAAC,QAAQ,OAAO;EAC/D,gBAAgB,QAAQ,OAAO,CAAC,CAAC,MAC9B,UAAU;GACT,IAAI,UAAU,GAAG,SAAS,KAAK;EACjC,IACC,UAAmB;GAClB,IAAI,UAAU,GAAG,QAAQ,UAAU,KAAK;EAC1C,CACF;CACF;CAGA,OAAO,iBAAiB,cAAc,OAAO;CAC7C,QAAQ,OAAO,iBACb,eACM,OAAO,oBAAoB,cAAc,OAAO,GACtD,EAAE,MAAM,KAAK,CACf;CACA,QAAQ;AACV"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/ai-client",
-  "version": "0.34.0",
+  "version": "0.36.0",
   "description": "Framework-agnostic headless client for TanStack AI chat, realtime sessions, streaming transports, and media generations.",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -57,8 +57,8 @@
     "src"
   ],
   "dependencies": {
-    "@tanstack/ai": "^0.59.0",
-    "@tanstack/ai-event-client": "^0.12.1",
+    "@tanstack/ai": "^0.63.0",
+    "@tanstack/ai-event-client": "^0.13.0",
     "@tanstack/ai-utils": "^0.4.1"
   },
   "devDependencies": {
@@ -72,9 +72,9 @@
     "clean": "premove ./build ./dist",
     "lint:fix": "oxlint src --type-aware --fix",
     "test:build": "publint --strict",
-    "test:coverage": "vitest run --coverage",
-    "test:coverage:watch": "vitest --coverage --watch",
     "test:oxlint": "oxlint src --type-aware",
+    "test:coverage": "vitest run --coverage --coverage.include='src/**' --coverage.reporter=text-summary --coverage.reporter=json-summary",
+    "test:coverage:watch": "vitest --coverage --watch",
     "test:lib": "vitest",
     "test:lib:dev": "pnpm test:lib --watch",
     "test:types": "tsc"