@tanstack/ai-svelte 0.17.0 → 0.18.2

package/dist/create-audio-recorder.svelte.d.ts

@@ -33,5 +33,7 @@ export interface CreateAudioRecorderReturn<TOutput> {
  * failure (and `stop()` rejects with `Recording cancelled` if `cancel()` runs
  * while a stop is in flight) — handle one channel, not both.
  */
-export declare function createAudioRecorder<TOnComplete extends (recording: AudioRecording) => unknown>(options: CreateAudioRecorderOptions<TOnComplete>): CreateAudioRecorderReturn<InferAudioRecordingOutput<TOnComplete>>;
+export declare function createAudioRecorder<TOnComplete extends (recording: AudioRecording) => unknown>(options: CreateAudioRecorderOptions<TOnComplete> & {
+    onComplete: TOnComplete;
+}): CreateAudioRecorderReturn<InferAudioRecordingOutput<TOnComplete>>;
 export declare function createAudioRecorder(options?: CreateAudioRecorderOptions<undefined>): CreateAudioRecorderReturn<AudioRecording>;

package/dist/create-chat.svelte.d.ts

@@ -1,5 +1,5 @@
 import type { InferredClientContext } from '@tanstack/ai-client';
-import type { AnyClientTool, SchemaInput } from '@tanstack/ai';
+import type { AnyClientTool, InterruptDefinition, SchemaInput } from '@tanstack/ai';
 import type { CreateChatOptions, CreateChatReturn } from './types';
 /**
  * Creates a reactive chat instance for Svelte 5.
@@ -31,4 +31,4 @@ import type { CreateChatOptions, CreateChatReturn } from './types';
  * </div>
  * ```
  */
-export declare function createChat<const TTools extends ReadonlyArray<AnyClientTool> = any, TSchema extends SchemaInput | undefined = undefined, TContext = InferredClientContext<TTools>>(options: CreateChatOptions<TTools, TSchema, TContext>): CreateChatReturn<TTools, TSchema, TContext>;
+export declare function createChat<const TTools extends ReadonlyArray<AnyClientTool> = any, TSchema extends SchemaInput | undefined = undefined, TContext = InferredClientContext<TTools>, const TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> = readonly []>(options: CreateChatOptions<TTools, TSchema, TContext, TInterrupts>): CreateChatReturn<TTools, TSchema, TContext, TInterrupts>;

package/dist/create-chat.svelte.js

@@ -63,9 +63,9 @@ export function createChat(options) {
     const transport = options.connection
         ? { connection: options.connection }
         : { fetcher: options.fetcher };
-    // The hook's identity is its `threadId`, which ChatClient also uses as the
-    // persistence key — no separate `id`. When no `threadId` is given the client
-    // generates one, so an ephemeral chat still works but is not restored on reload.
+    // The hook's identity is its `threadId`. When no `threadId` is given the
+    // client mints one after mount, so an ephemeral chat still works but is not
+    // restored on reload.
     const client = new ChatClient({
         devtoolsBridgeFactory: createChatDevtoolsBridge,
         ...transport,
@@ -105,6 +105,9 @@ export function createChat(options) {
             options.onError?.(err);
         },
         tools: options.tools,
+        ...(options.interrupts !== undefined && {
+            interrupts: options.interrupts,
+        }),
         ...(options.onCustomEvent !== undefined && {
             onCustomEvent: options.onCustomEvent,
         }),
@@ -140,9 +143,9 @@ export function createChat(options) {
         onRunIdChange: (nextRunId) => {
             runId = nextRunId;
         },
-        onInterruptStateChange: (nextInterruptState) => {
+        onInterruptStateChange: (nextInterruptState, context) => {
             interruptState = nextInterruptState;
-            options.onInterruptStateChange?.(nextInterruptState);
+            options.onInterruptStateChange?.(nextInterruptState, context);
         },
     });
     function syncResumeState() {

package/dist/types.d.ts

@@ -1,5 +1,5 @@
-import type { AnyClientTool, InferSchemaType, ModelMessage, RunAgentResumeItem, SchemaInput } from '@tanstack/ai';
-import type { AIDevtoolsDisplayOptions, BoundInterrupts, ChatClientOptions, ChatClientState, ChatInterrupt, ChatInterruptState, ChatRequestBody, ChatResumeState, ClientContextOptionFromTools, ConnectionStatus, DistributedOmit, InferredClientContext, MultimodalContent, QueueConfig, QueueOption, QueueStrategy, QueuedMessage, SendMessageOptions, UIMessage, WhenBusy } from '@tanstack/ai-client';
+import type { AnyClientTool, InterruptDefinition, InferSchemaType, ModelMessage, RunAgentResumeItem, SchemaInput } from '@tanstack/ai';
+import type { AIDevtoolsDisplayOptions, BoundInterrupts, ChatClientOptions, ChatClientState, ResolvableChatInterrupt, ChatInterruptState, ChatRequestBody, ChatResumeState, ClientContextOptionFromTools, ConnectionStatus, DistributedOmit, InferredClientContext, MultimodalContent, QueueConfig, QueueOption, QueueStrategy, QueuedMessage, SendMessageOptions, UIMessage, WhenBusy } from '@tanstack/ai-client';
 export type { ChatRequestBody, MultimodalContent, QueueConfig, QueuedMessage, QueueOption, QueueStrategy, SendMessageOptions, UIMessage, WhenBusy, };
 /**
  * Recursive partial — every property and every nested array element is
@@ -30,7 +30,7 @@ export type DeepPartial<T> = T extends ReadonlyArray<infer U> ? Array<DeepPartia
  * Note: Connection and body changes will recreate the ChatClient instance.
  * To update these options, remount the component or use a key prop.
  */
-export type CreateChatOptions<TTools extends ReadonlyArray<AnyClientTool> = any, TSchema extends SchemaInput | undefined = undefined, TContext = InferredClientContext<TTools>> = DistributedOmit<ChatClientOptions<TTools, TContext>, 'onMessagesChange' | 'onLoadingChange' | 'onErrorChange' | 'onStatusChange' | 'onSubscriptionChange' | 'onConnectionStatusChange' | 'onSessionGeneratingChange' | 'onQueueChange' | 'onResumeStateChange' | 'onRunIdChange' | 'context' | 'devtools'> & {
+export type CreateChatOptions<TTools extends ReadonlyArray<AnyClientTool> = any, TSchema extends SchemaInput | undefined = undefined, TContext = InferredClientContext<TTools>, TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> = readonly []> = DistributedOmit<ChatClientOptions<TTools, TContext, TInterrupts>, 'onMessagesChange' | 'onLoadingChange' | 'onErrorChange' | 'onStatusChange' | 'onSubscriptionChange' | 'onConnectionStatusChange' | 'onSessionGeneratingChange' | 'onQueueChange' | 'onResumeStateChange' | 'onRunIdChange' | 'context' | 'devtools'> & {
     live?: boolean;
     /** Display options for TanStack AI Devtools. */
     devtools?: AIDevtoolsDisplayOptions;
@@ -45,7 +45,7 @@ export type CreateChatOptions<TTools extends ReadonlyArray<AnyClientTool> = any,
  * typed `partial` / `final` reactive getters; otherwise the return is
  * unchanged.
  */
-export type CreateChatReturn<TTools extends ReadonlyArray<AnyClientTool> = any, TSchema extends SchemaInput | undefined = undefined, TContext = unknown> = BaseCreateChatReturn<TTools, TSchema extends SchemaInput ? InferSchemaType<TSchema> : unknown, TContext> & (TSchema extends SchemaInput ? {
+export type CreateChatReturn<TTools extends ReadonlyArray<AnyClientTool> = any, TSchema extends SchemaInput | undefined = undefined, TContext = unknown, TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> = readonly []> = BaseCreateChatReturn<TTools, TSchema extends SchemaInput ? InferSchemaType<TSchema> : unknown, TContext, TInterrupts> & (TSchema extends SchemaInput ? {
     /**
      * Live progressively-parsed structured output (reactive getter).
      * Derived from the latest assistant message's structured-output part.
@@ -58,7 +58,7 @@ export type CreateChatReturn<TTools extends ReadonlyArray<AnyClientTool> = any,
      */
     readonly final: InferSchemaType<TSchema> | null;
 } : Record<never, never>);
-interface BaseCreateChatReturn<TTools extends ReadonlyArray<AnyClientTool> = any, TData = unknown, TContext = unknown> {
+interface BaseCreateChatReturn<TTools extends ReadonlyArray<AnyClientTool> = any, TData = unknown, TContext = unknown, TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> = readonly []> {
     /**
      * Current messages in the conversation (reactive getter). When
      * `outputSchema` is supplied, `messages[i].parts.find(p => p.type ===
@@ -112,14 +112,14 @@ interface BaseCreateChatReturn<TTools extends ReadonlyArray<AnyClientTool> = any
      * it, correlate a log line).
      */
     readonly runId: string | null;
-    readonly interrupts: BoundInterrupts<TTools>;
+    readonly interrupts: BoundInterrupts<TTools, TInterrupts>;
     /** @deprecated Use `interrupts`. */
-    readonly pendingInterrupts: BoundInterrupts<TTools>;
-    readonly interruptErrors: ChatInterruptState<TTools>['interruptErrors'];
+    readonly pendingInterrupts: BoundInterrupts<TTools, TInterrupts>;
+    readonly interruptErrors: ChatInterruptState<TTools, TInterrupts>['interruptErrors'];
     readonly resuming: boolean;
     resolveInterrupts: {
         (approved: boolean): void;
-        (resolver: (interrupt: ChatInterrupt<TTools>) => undefined): void;
+        (resolver: (interrupt: ResolvableChatInterrupt<TTools, TInterrupts>) => undefined): void;
     };
     cancelInterrupts: () => void;
     retryInterrupts: () => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/ai-svelte",
-  "version": "0.17.0",
+  "version": "0.18.2",
   "description": "Svelte 5 bindings for TanStack AI streaming chat, structured outputs, and media generation.",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -46,24 +46,24 @@
     "media-generation"
   ],
   "dependencies": {
-    "@tanstack/ai-client": "^0.24.0"
+    "@tanstack/ai-client": "^0.25.2"
   },
   "peerDependencies": {
     "svelte": "^5.0.0",
-    "@tanstack/ai": "^0.46.0"
+    "@tanstack/ai": "^0.47.3"
   },
   "devDependencies": {
     "@standard-schema/spec": "^1.1.0",
     "@sveltejs/package": "^2.3.10",
-    "@sveltejs/vite-plugin-svelte": "^5.1.1",
+    "@sveltejs/vite-plugin-svelte": "^7.3.0",
     "@types/node": "^24.10.1",
     "@vitest/coverage-v8": "4.1.10",
     "jsdom": "^27.4.0",
-    "svelte": "^5.20.0",
+    "svelte": "^5.56.9",
     "svelte-check": "^4.2.0",
     "typescript": "5.9.3",
     "vite": "^8.2.1",
-    "@tanstack/ai": "0.46.0"
+    "@tanstack/ai": "0.47.3"
   },
   "scripts": {
     "clean": "rm -rf ./dist",

package/src/create-audio-recorder.svelte.ts

@@ -41,10 +41,18 @@ export interface CreateAudioRecorderReturn<TOutput> {
  * failure (and `stop()` rejects with `Recording cancelled` if `cancel()` runs
  * while a stop is in flight) — handle one channel, not both.
  */
+// The transforming overload requires `onComplete`. Without that constraint an
+// options object carrying only unrelated keys (`createAudioRecorder({ onError })`)
+// still matches it, `TOnComplete` infers as `unknown`, and `recording`/`stop()`
+// collapse to `unknown` — so passing any option would silently cost you the
+// `AudioRecording` type. Requiring it here sends those calls to the second
+// overload instead (issue #1001).
 export function createAudioRecorder<
   TOnComplete extends (recording: AudioRecording) => unknown,
 >(
-  options: CreateAudioRecorderOptions<TOnComplete>,
+  options: CreateAudioRecorderOptions<TOnComplete> & {
+    onComplete: TOnComplete
+  },
 ): CreateAudioRecorderReturn<InferAudioRecordingOutput<TOnComplete>>
 export function createAudioRecorder(
   options?: CreateAudioRecorderOptions<undefined>,

package/src/create-chat.svelte.ts

@@ -3,7 +3,7 @@ import { createChatDevtoolsBridge } from '@tanstack/ai-client/devtools'
 import { onMount } from 'svelte'
 import type {
   ChatClientState,
-  ChatInterrupt,
+  ResolvableChatInterrupt,
   ChatInterruptState,
   ChatResumeState,
   ConnectionStatus,
@@ -14,6 +14,7 @@ import type {
 } from '@tanstack/ai-client'
 import type {
   AnyClientTool,
+  InterruptDefinition,
   InferSchemaType,
   ModelMessage,
   RunAgentResumeItem,
@@ -65,9 +66,12 @@ export function createChat<
   const TTools extends ReadonlyArray<AnyClientTool> = any,
   TSchema extends SchemaInput | undefined = undefined,
   TContext = InferredClientContext<TTools>,
+  const TInterrupts extends ReadonlyArray<
+    InterruptDefinition<any, any, any, any>
+  > = readonly [],
 >(
-  options: CreateChatOptions<TTools, TSchema, TContext>,
-): CreateChatReturn<TTools, TSchema, TContext> {
+  options: CreateChatOptions<TTools, TSchema, TContext, TInterrupts>,
+): CreateChatReturn<TTools, TSchema, TContext, TInterrupts> {
   // Create reactive state using Svelte 5 runes
   let messages = $state<Array<UIMessage<TTools>>>(options.initialMessages || [])
   let isLoading = $state(false)
@@ -78,7 +82,7 @@ export function createChat<
   let sessionGenerating = $state(false)
   let queue = $state<Array<QueuedMessage>>([])
   let runId = $state<string | null>(null)
-  let interruptState = $state.raw<ChatInterruptState<TTools>>({
+  let interruptState = $state.raw<ChatInterruptState<TTools, TInterrupts>>({
     interrupts: EMPTY_INTERRUPTS,
     pendingInterrupts: EMPTY_INTERRUPTS,
     interruptErrors: EMPTY_INTERRUPT_ERRORS,
@@ -106,10 +110,10 @@ export function createChat<
     ? { connection: options.connection }
     : { fetcher: options.fetcher }
 
-  // The hook's identity is its `threadId`, which ChatClient also uses as the
-  // persistence key — no separate `id`. When no `threadId` is given the client
-  // generates one, so an ephemeral chat still works but is not restored on reload.
-  const client = new ChatClient<TTools, TContext>({
+  // The hook's identity is its `threadId`. When no `threadId` is given the
+  // client mints one after mount, so an ephemeral chat still works but is not
+  // restored on reload.
+  const client = new ChatClient<TTools, TContext, TInterrupts>({
     devtoolsBridgeFactory: createChatDevtoolsBridge,
     ...transport,
     ...(options.initialMessages !== undefined && {
@@ -148,6 +152,9 @@ export function createChat<
       options.onError?.(err)
     },
     tools: options.tools,
+    ...(options.interrupts !== undefined && {
+      interrupts: options.interrupts,
+    }),
     ...(options.onCustomEvent !== undefined && {
       onCustomEvent: options.onCustomEvent,
     }),
@@ -183,9 +190,9 @@ export function createChat<
     onRunIdChange: (nextRunId) => {
       runId = nextRunId
     },
-    onInterruptStateChange: (nextInterruptState) => {
+    onInterruptStateChange: (nextInterruptState, context) => {
       interruptState = nextInterruptState
-      options.onInterruptStateChange?.(nextInterruptState)
+      options.onInterruptStateChange?.(nextInterruptState, context)
     },
   })
 
@@ -308,7 +315,11 @@ export function createChat<
   }
 
   const resolveInterrupts = (
-    resolution: boolean | ((interrupt: ChatInterrupt<TTools>) => undefined),
+    resolution:
+      | boolean
+      | ((
+          interrupt: ResolvableChatInterrupt<TTools, TInterrupts>,
+        ) => undefined),
   ) => {
     if (typeof resolution === 'boolean') {
       client.resolveInterrupts(resolution)
@@ -451,5 +462,5 @@ export function createChat<
     updateBody,
     updateForwardedProps,
     updateContext,
-  } as unknown as CreateChatReturn<TTools, TSchema, TContext>
+  } as unknown as CreateChatReturn<TTools, TSchema, TContext, TInterrupts>
 }

package/src/types.ts

@@ -1,5 +1,6 @@
 import type {
   AnyClientTool,
+  InterruptDefinition,
   InferSchemaType,
   ModelMessage,
   RunAgentResumeItem,
@@ -10,7 +11,7 @@ import type {
   BoundInterrupts,
   ChatClientOptions,
   ChatClientState,
-  ChatInterrupt,
+  ResolvableChatInterrupt,
   ChatInterruptState,
   ChatRequestBody,
   ChatResumeState,
@@ -78,8 +79,10 @@ export type CreateChatOptions<
   TTools extends ReadonlyArray<AnyClientTool> = any,
   TSchema extends SchemaInput | undefined = undefined,
   TContext = InferredClientContext<TTools>,
+  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> =
+    readonly [],
 > = DistributedOmit<
-  ChatClientOptions<TTools, TContext>,
+  ChatClientOptions<TTools, TContext, TInterrupts>,
   | 'onMessagesChange'
   | 'onLoadingChange'
   | 'onErrorChange'
@@ -112,10 +115,13 @@ export type CreateChatReturn<
   TTools extends ReadonlyArray<AnyClientTool> = any,
   TSchema extends SchemaInput | undefined = undefined,
   TContext = unknown,
+  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> =
+    readonly [],
 > = BaseCreateChatReturn<
   TTools,
   TSchema extends SchemaInput ? InferSchemaType<TSchema> : unknown,
-  TContext
+  TContext,
+  TInterrupts
 > &
   (TSchema extends SchemaInput
     ? {
@@ -137,6 +143,8 @@ interface BaseCreateChatReturn<
   TTools extends ReadonlyArray<AnyClientTool> = any,
   TData = unknown,
   TContext = unknown,
+  TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> =
+    readonly [],
 > {
   /**
    * Current messages in the conversation (reactive getter). When
@@ -201,14 +209,21 @@ interface BaseCreateChatReturn<
    * it, correlate a log line).
    */
   readonly runId: string | null
-  readonly interrupts: BoundInterrupts<TTools>
+  readonly interrupts: BoundInterrupts<TTools, TInterrupts>
   /** @deprecated Use `interrupts`. */
-  readonly pendingInterrupts: BoundInterrupts<TTools>
-  readonly interruptErrors: ChatInterruptState<TTools>['interruptErrors']
+  readonly pendingInterrupts: BoundInterrupts<TTools, TInterrupts>
+  readonly interruptErrors: ChatInterruptState<
+    TTools,
+    TInterrupts
+  >['interruptErrors']
   readonly resuming: boolean
   resolveInterrupts: {
     (approved: boolean): void
-    (resolver: (interrupt: ChatInterrupt<TTools>) => undefined): void
+    (
+      resolver: (
+        interrupt: ResolvableChatInterrupt<TTools, TInterrupts>,
+      ) => undefined,
+    ): void
   }
   cancelInterrupts: () => void
   retryInterrupts: () => void