@tanstack/ai-svelte 0.16.3 → 0.18.1

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,23 +63,27 @@ 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,
         ...(options.initialMessages !== undefined && {
             initialMessages: options.initialMessages,
         }),
-        ...(options.persistence !== undefined && {
-            persistence: options.persistence,
-        }),
+        ...(typeof options.threadId === 'string' && options.persistence
+            ? {
+                persistence: options.persistence,
+                threadId: options.threadId,
+            }
+            : {
+                ...(options.threadId !== undefined && { threadId: options.threadId }),
+            }),
         ...(options.initialResumeSnapshot !== undefined && {
             initialResumeSnapshot: options.initialResumeSnapshot,
         }),
         ...(options.body !== undefined && { body: options.body }),
-        ...(options.threadId !== undefined && { threadId: options.threadId }),
         ...(options.forwardedProps !== undefined && {
             forwardedProps: options.forwardedProps,
         }),
@@ -101,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,
         }),
@@ -136,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/create-generate-audio.svelte.d.ts

@@ -11,10 +11,6 @@ export interface CreateGenerateAudioOptions<TOutput = AudioGenerationResult> ext
     connection?: ConnectConnectionAdapter;
     /** Direct async function for audio generation */
     fetcher?: GenerationFetcher<AudioGenerateInput, AudioGenerationResult>;
-    /**
-     * @deprecated Prefer `threadId`. Only allowed when `threadId` is omitted (see `GenerationPersistenceOptions`).
-     */
-    id?: string;
     /** Additional body parameters to send with connect-based adapter requests */
     body?: Record<string, any>;
     /** Display options for TanStack AI Devtools. */
@@ -77,6 +73,6 @@ export interface CreateGenerateAudioReturn<TOutput = AudioGenerationResult> exte
  * </div>
  * ```
  */
-export declare function createGenerateAudio<TTransformed = void>(options: Omit<CreateGenerateAudioOptions, 'onResult' | 'persistence' | 'threadId' | 'id'> & {
+export declare function createGenerateAudio<TTransformed = void>(options: Omit<CreateGenerateAudioOptions, 'onResult' | 'persistence' | 'threadId'> & {
     onResult?: (result: AudioGenerationResult) => TTransformed;
 } & GenerationPersistenceOptions): CreateGenerateAudioReturn<InferGenerationOutputFromReturn<AudioGenerationResult, TTransformed>>;

package/dist/create-generate-image.svelte.d.ts

@@ -11,10 +11,6 @@ export interface CreateGenerateImageOptions<TOutput = ImageGenerationResult> ext
     connection?: ConnectConnectionAdapter;
     /** Direct async function for image generation */
     fetcher?: GenerationFetcher<ImageGenerateInput, ImageGenerationResult>;
-    /**
-     * @deprecated Prefer `threadId`. Only allowed when `threadId` is omitted (see `GenerationPersistenceOptions`).
-     */
-    id?: string;
     /** Additional body parameters to send with connect-based adapter requests */
     body?: Record<string, any>;
     /** Display options for TanStack AI Devtools. */
@@ -86,6 +82,6 @@ export interface CreateGenerateImageReturn<TOutput = ImageGenerationResult> exte
  * </div>
  * ```
  */
-export declare function createGenerateImage<TTransformed = void>(options: Omit<CreateGenerateImageOptions, 'onResult' | 'persistence' | 'threadId' | 'id'> & {
+export declare function createGenerateImage<TTransformed = void>(options: Omit<CreateGenerateImageOptions, 'onResult' | 'persistence' | 'threadId'> & {
     onResult?: (result: ImageGenerationResult) => TTransformed;
 } & GenerationPersistenceOptions): CreateGenerateImageReturn<InferGenerationOutputFromReturn<ImageGenerationResult, TTransformed>>;

package/dist/create-generate-speech.svelte.d.ts

@@ -11,10 +11,6 @@ export interface CreateGenerateSpeechOptions<TOutput = TTSResult> extends Pick<C
     connection?: ConnectConnectionAdapter;
     /** Direct async function for speech generation */
     fetcher?: GenerationFetcher<SpeechGenerateInput, TTSResult>;
-    /**
-     * @deprecated Prefer `threadId`. Only allowed when `threadId` is omitted (see `GenerationPersistenceOptions`).
-     */
-    id?: string;
     /** Additional body parameters to send with connect-based adapter requests */
     body?: Record<string, any>;
     /** Display options for TanStack AI Devtools. */
@@ -77,6 +73,6 @@ export interface CreateGenerateSpeechReturn<TOutput = TTSResult> extends Omit<Cr
  * </div>
  * ```
  */
-export declare function createGenerateSpeech<TTransformed = void>(options: Omit<CreateGenerateSpeechOptions, 'onResult' | 'persistence' | 'threadId' | 'id'> & {
+export declare function createGenerateSpeech<TTransformed = void>(options: Omit<CreateGenerateSpeechOptions, 'onResult' | 'persistence' | 'threadId'> & {
     onResult?: (result: TTSResult) => TTransformed;
 } & GenerationPersistenceOptions): CreateGenerateSpeechReturn<InferGenerationOutputFromReturn<TTSResult, TTransformed>>;

package/dist/create-generate-video.svelte.d.ts

@@ -10,10 +10,6 @@ export interface CreateGenerateVideoOptions<TOutput = VideoGenerateResult> {
     connection?: ConnectConnectionAdapter;
     /** Direct async function that returns a completed video result */
     fetcher?: GenerationFetcher<VideoGenerateInput, VideoGenerateResult>;
-    /**
-     * @deprecated Prefer `threadId`. Only allowed when `threadId` is omitted (see `GenerationPersistenceOptions`).
-     */
-    id?: string;
     /** Additional body parameters to send with connect-based adapter requests */
     body?: Record<string, any>;
     /** Display options for TanStack AI Devtools. */
@@ -37,8 +33,8 @@ export interface CreateGenerateVideoOptions<TOutput = VideoGenerateResult> {
      * id on the wire, which the protocol requires.
      *
      * **Required whenever `persistence` is set** — an app that cannot name the
-     * scope has nothing to restore to. Optional for ephemeral generations, where
-     * it falls back to `id` purely to satisfy the wire.
+     * scope has nothing to restore to. Optional for ephemeral generations. If
+     * omitted, the client mints a wire id after mount.
      */
     threadId?: string;
     /**
@@ -140,6 +136,6 @@ export interface CreateGenerateVideoReturn<TOutput = VideoGenerateResult> {
  * </div>
  * ```
  */
-export declare function createGenerateVideo<TTransformed = void>(options: Omit<CreateGenerateVideoOptions, 'onResult' | 'persistence' | 'threadId' | 'id'> & {
+export declare function createGenerateVideo<TTransformed = void>(options: Omit<CreateGenerateVideoOptions, 'onResult' | 'persistence' | 'threadId'> & {
     onResult?: (result: VideoGenerateResult) => TTransformed;
 } & GenerationPersistenceOptions): CreateGenerateVideoReturn<InferGenerationOutputFromReturn<VideoGenerateResult, TTransformed>>;

package/dist/create-generate-video.svelte.js

@@ -34,7 +34,6 @@ import { createVideoDevtoolsBridge } from '@tanstack/ai-client/devtools';
 // parameter is typed as `VideoGenerateResult` and `result` narrows to the
 // transform's return. See issue #848.
 export function createGenerateVideo(options) {
-    const fallbackId = `video-${Date.now()}-${Math.random().toString(36).substring(7)}`;
     // Create reactive state using Svelte 5 runes
     let result = $state(null);
     let jobId = $state(null);
@@ -48,15 +47,18 @@ export function createGenerateVideo(options) {
     // is declared `body?: Record<string, any>` (absent vs. present) under
     // `exactOptionalPropertyTypes`. The optional caller `options.body` may be
     // undefined, in which case we want the key to be absent on the target.
-    // Identity: pass `threadId` alone when set (never also pass deprecated `id`).
     const baseOptions = {
         body: options.body,
-        ...(options.threadId !== undefined
-            ? { threadId: options.threadId }
-            : { id: options.id ?? fallbackId }),
-        ...(options.persistence !== undefined && {
-            persistence: options.persistence,
-        }),
+        ...(typeof options.threadId === 'string' && options.persistence
+            ? {
+                persistence: options.persistence,
+                threadId: options.threadId,
+            }
+            : {
+                ...(options.threadId !== undefined && {
+                    threadId: options.threadId,
+                }),
+            }),
         ...(options.hydrateGeneration !== undefined && {
             hydrateGeneration: options.hydrateGeneration,
         }),

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

@@ -14,10 +14,6 @@ export interface CreateGenerationOptions<TInput, TResult, TOutput = TResult> {
     connection?: ConnectConnectionAdapter;
     /** Direct async function for one-shot generation (no streaming protocol needed) */
     fetcher?: GenerationFetcher<TInput, TResult>;
-    /**
-     * @deprecated Prefer `threadId`. Only allowed when `threadId` is omitted (see `GenerationPersistenceOptions`).
-     */
-    id?: string;
     /** Additional body parameters to send with connect-based adapter requests */
     body?: Record<string, any>;
     /** Display options for TanStack AI Devtools. */
@@ -41,8 +37,8 @@ export interface CreateGenerationOptions<TInput, TResult, TOutput = TResult> {
      * id on the wire, which the protocol requires.
      *
      * **Required whenever `persistence` is set** — an app that cannot name the
-     * scope has nothing to restore to. Optional for ephemeral generations, where
-     * it falls back to `id` purely to satisfy the wire.
+     * scope has nothing to restore to. Optional for ephemeral generations. If
+     * omitted, the client mints a wire id after mount.
      */
     threadId?: string;
     /**
@@ -144,6 +140,6 @@ export interface CreateGenerationReturn<TOutput, TInput extends Record<string, a
  * </div>
  * ```
  */
-export declare function createGeneration<TInput extends Record<string, any>, TResult, TTransformed = void>(options: Omit<CreateGenerationOptions<TInput, TResult>, 'onResult' | 'persistence' | 'threadId' | 'id'> & {
+export declare function createGeneration<TInput extends Record<string, any>, TResult, TTransformed = void>(options: Omit<CreateGenerationOptions<TInput, TResult>, 'onResult' | 'persistence' | 'threadId'> & {
     onResult?: (result: TResult) => TTransformed;
 } & GenerationPersistenceOptions): CreateGenerationReturn<InferGenerationOutputFromReturn<TResult, TTransformed>, TInput>;

package/dist/create-generation.svelte.js

@@ -38,7 +38,6 @@ import { createGenerationDevtoolsBridge } from '@tanstack/ai-client/devtools';
 // default, leaving the parameter `any` — a hard error under `strict`. See
 // issue #848.
 export function createGeneration(options) {
-    const fallbackId = `gen-${Date.now()}-${Math.random().toString(36).substring(7)}`;
     // Create reactive state using Svelte 5 runes
     let result = $state(null);
     let isLoading = $state(false);
@@ -51,15 +50,8 @@ export function createGeneration(options) {
     // `exactOptionalPropertyTypes`. Assigning `undefined` directly would be
     // rejected — the optional caller `options.body` may be undefined, in which
     // case we want the key to be absent.
-    // Identity: pass `threadId` alone when set (never also pass deprecated `id`).
     const clientOptions = {
         body: options.body,
-        ...(options.threadId !== undefined
-            ? { threadId: options.threadId }
-            : { id: options.id ?? fallbackId }),
-        ...(options.persistence !== undefined && {
-            persistence: options.persistence,
-        }),
         ...(options.hydrateGeneration !== undefined && {
             hydrateGeneration: options.hydrateGeneration,
         }),
@@ -115,16 +107,28 @@ export function createGeneration(options) {
             runId = rs?.runId ?? null;
         },
     };
+    const persistenceProps = typeof options.threadId === 'string' && options.persistence
+        ? {
+            persistence: options.persistence,
+            threadId: options.threadId,
+        }
+        : {
+            ...(options.threadId !== undefined && {
+                threadId: options.threadId,
+            }),
+        };
     let client;
     if (options.connection) {
         client = new GenerationClient({
             ...clientOptions,
+            ...persistenceProps,
             connection: options.connection,
         });
     }
     else if (options.fetcher) {
         client = new GenerationClient({
             ...clientOptions,
+            ...persistenceProps,
             fetcher: options.fetcher,
         });
     }

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

@@ -11,10 +11,6 @@ export interface CreateSummarizeOptions<TOutput = SummarizationResult> extends P
     connection?: ConnectConnectionAdapter;
     /** Direct async function for summarization */
     fetcher?: GenerationFetcher<SummarizeGenerateInput, SummarizationResult>;
-    /**
-     * @deprecated Prefer `threadId`. Only allowed when `threadId` is omitted (see `GenerationPersistenceOptions`).
-     */
-    id?: string;
     /** Additional body parameters to send with connect-based adapter requests */
     body?: Record<string, any>;
     /** Display options for TanStack AI Devtools. */
@@ -81,6 +77,6 @@ export interface CreateSummarizeReturn<TOutput = SummarizationResult> extends Om
  * </div>
  * ```
  */
-export declare function createSummarize<TTransformed = void>(options: Omit<CreateSummarizeOptions, 'onResult' | 'persistence' | 'threadId' | 'id'> & {
+export declare function createSummarize<TTransformed = void>(options: Omit<CreateSummarizeOptions, 'onResult' | 'persistence' | 'threadId'> & {
     onResult?: (result: SummarizationResult) => TTransformed;
 } & GenerationPersistenceOptions): CreateSummarizeReturn<InferGenerationOutputFromReturn<SummarizationResult, TTransformed>>;

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

@@ -11,10 +11,6 @@ export interface CreateTranscriptionOptions<TOutput = TranscriptionResult> exten
     connection?: ConnectConnectionAdapter;
     /** Direct async function for transcription */
     fetcher?: GenerationFetcher<TranscriptionGenerateInput, TranscriptionResult>;
-    /**
-     * @deprecated Prefer `threadId`. Only allowed when `threadId` is omitted (see `GenerationPersistenceOptions`).
-     */
-    id?: string;
     /** Additional body parameters to send with connect-based adapter requests */
     body?: Record<string, any>;
     /** Display options for TanStack AI Devtools. */
@@ -86,6 +82,6 @@ export interface CreateTranscriptionReturn<TOutput = TranscriptionResult> extend
  * </div>
  * ```
  */
-export declare function createTranscription<TTransformed = void>(options: Omit<CreateTranscriptionOptions, 'onResult' | 'persistence' | 'threadId' | 'id'> & {
+export declare function createTranscription<TTransformed = void>(options: Omit<CreateTranscriptionOptions, 'onResult' | 'persistence' | 'threadId'> & {
     onResult?: (result: TranscriptionResult) => TTransformed;
 } & GenerationPersistenceOptions): CreateTranscriptionReturn<InferGenerationOutputFromReturn<TranscriptionResult, TTransformed>>;

package/dist/index.d.ts

@@ -16,4 +16,4 @@ export { createGenerateVideo } from './create-generate-video.svelte';
 export type { CreateGenerateVideoOptions, CreateGenerateVideoReturn, } from './create-generate-video.svelte';
 export { createAudioRecorder } from './create-audio-recorder.svelte';
 export type { CreateAudioRecorderOptions, CreateAudioRecorderReturn, } from './create-audio-recorder.svelte';
-export { fetchServerSentEvents, localStoragePersistence, sessionStoragePersistence, indexedDBPersistence, StorageUnavailableError, type ChatClientPersistence, type ChatPersistedState, type ChatPersistenceOption, type ChatStorageAdapter, type WebStoragePersistenceOptions, type IndexedDBPersistenceOptions, fetchHttpStream, xhrServerSentEvents, xhrHttpStream, stream, rpcStream, createChatClientOptions, clientTools, type ConnectionAdapter, type ConnectConnectionAdapter, type SubscribeConnectionAdapter, type RunAgentInputContext, type FetchConnectionOptions, type XhrConnectionOptions, type InferChatMessages, type GenerationClientState, type ImageGenerateInput, type AudioGenerateInput, type SpeechGenerateInput, type TranscriptionGenerateInput, type SummarizeGenerateInput, type VideoGenerateInput, type VideoGenerateResult, type VideoStatusInfo, } from '@tanstack/ai-client';
+export { fetchServerSentEvents, localStoragePersistence, sessionStoragePersistence, indexedDBPersistence, StorageUnavailableError, type ChatClientPersistence, type ChatPersistedState, type ChatPersistenceOption, type ChatStorageAdapter, type WebStoragePersistenceOptions, type IndexedDBPersistenceOptions, fetchHttpStream, xhrServerSentEvents, xhrHttpStream, stream, rpcStream, webSocket, createChatClientOptions, clientTools, type ConnectionAdapter, type ConnectConnectionAdapter, type SubscribeConnectionAdapter, type RunAgentInputContext, type FetchConnectionOptions, type XhrConnectionOptions, type WebSocketConnectionOptions, type InferChatMessages, type GenerationClientState, type ImageGenerateInput, type AudioGenerateInput, type SpeechGenerateInput, type TranscriptionGenerateInput, type SummarizeGenerateInput, type VideoGenerateInput, type VideoGenerateResult, type VideoStatusInfo, } from '@tanstack/ai-client';

package/dist/index.js

@@ -9,4 +9,4 @@ export { createSummarize } from './create-summarize.svelte';
 export { createGenerateVideo } from './create-generate-video.svelte';
 export { createAudioRecorder } from './create-audio-recorder.svelte';
 // Re-export from ai-client for convenience
-export { fetchServerSentEvents, localStoragePersistence, sessionStoragePersistence, indexedDBPersistence, StorageUnavailableError, fetchHttpStream, xhrServerSentEvents, xhrHttpStream, stream, rpcStream, createChatClientOptions, clientTools, } from '@tanstack/ai-client';
+export { fetchServerSentEvents, localStoragePersistence, sessionStoragePersistence, indexedDBPersistence, StorageUnavailableError, fetchHttpStream, xhrServerSentEvents, xhrHttpStream, stream, rpcStream, webSocket, createChatClientOptions, clientTools, } from '@tanstack/ai-client';

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' | 'id'> & {
+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.16.3",
+  "version": "0.18.1",
   "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.23.3"
+    "@tanstack/ai-client": "^0.25.1"
   },
   "peerDependencies": {
     "svelte": "^5.0.0",
-    "@tanstack/ai": "^0.45.0"
+    "@tanstack/ai": "^0.47.1"
   },
   "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.45.0"
+    "@tanstack/ai": "0.47.1"
   },
   "scripts": {
     "clean": "rm -rf ./dist",

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,23 +110,27 @@ 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 && {
       initialMessages: options.initialMessages,
     }),
-    ...(options.persistence !== undefined && {
-      persistence: options.persistence,
-    }),
+    ...(typeof options.threadId === 'string' && options.persistence
+      ? {
+          persistence: options.persistence,
+          threadId: options.threadId,
+        }
+      : {
+          ...(options.threadId !== undefined && { threadId: options.threadId }),
+        }),
     ...(options.initialResumeSnapshot !== undefined && {
       initialResumeSnapshot: options.initialResumeSnapshot,
     }),
     ...(options.body !== undefined && { body: options.body }),
-    ...(options.threadId !== undefined && { threadId: options.threadId }),
     ...(options.forwardedProps !== undefined && {
       forwardedProps: options.forwardedProps,
     }),
@@ -144,6 +152,9 @@ export function createChat<
       options.onError?.(err)
     },
     tools: options.tools,
+    ...(options.interrupts !== undefined && {
+      interrupts: options.interrupts,
+    }),
     ...(options.onCustomEvent !== undefined && {
       onCustomEvent: options.onCustomEvent,
     }),
@@ -179,9 +190,9 @@ export function createChat<
     onRunIdChange: (nextRunId) => {
       runId = nextRunId
     },
-    onInterruptStateChange: (nextInterruptState) => {
+    onInterruptStateChange: (nextInterruptState, context) => {
       interruptState = nextInterruptState
-      options.onInterruptStateChange?.(nextInterruptState)
+      options.onInterruptStateChange?.(nextInterruptState, context)
     },
   })
 
@@ -304,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)
@@ -447,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/create-generate-audio.svelte.ts

@@ -30,10 +30,6 @@ export interface CreateGenerateAudioOptions<
   connection?: ConnectConnectionAdapter
   /** Direct async function for audio generation */
   fetcher?: GenerationFetcher<AudioGenerateInput, AudioGenerationResult>
-  /**
-   * @deprecated Prefer `threadId`. Only allowed when `threadId` is omitted (see `GenerationPersistenceOptions`).
-   */
-  id?: string
   /** Additional body parameters to send with connect-based adapter requests */
   body?: Record<string, any>
   /** Display options for TanStack AI Devtools. */
@@ -103,7 +99,7 @@ export interface CreateGenerateAudioReturn<
 export function createGenerateAudio<TTransformed = void>(
   options: Omit<
     CreateGenerateAudioOptions,
-    'onResult' | 'persistence' | 'threadId' | 'id'
+    'onResult' | 'persistence' | 'threadId'
   > & {
     onResult?: (result: AudioGenerationResult) => TTransformed
   } & GenerationPersistenceOptions,

package/src/create-generate-image.svelte.ts

@@ -30,10 +30,6 @@ export interface CreateGenerateImageOptions<
   connection?: ConnectConnectionAdapter
   /** Direct async function for image generation */
   fetcher?: GenerationFetcher<ImageGenerateInput, ImageGenerationResult>
-  /**
-   * @deprecated Prefer `threadId`. Only allowed when `threadId` is omitted (see `GenerationPersistenceOptions`).
-   */
-  id?: string
   /** Additional body parameters to send with connect-based adapter requests */
   body?: Record<string, any>
   /** Display options for TanStack AI Devtools. */
@@ -112,7 +108,7 @@ export interface CreateGenerateImageReturn<
 export function createGenerateImage<TTransformed = void>(
   options: Omit<
     CreateGenerateImageOptions,
-    'onResult' | 'persistence' | 'threadId' | 'id'
+    'onResult' | 'persistence' | 'threadId'
   > & {
     onResult?: (result: ImageGenerationResult) => TTransformed
   } & GenerationPersistenceOptions,

package/src/create-generate-speech.svelte.ts

@@ -28,10 +28,6 @@ export interface CreateGenerateSpeechOptions<TOutput = TTSResult> extends Pick<
   connection?: ConnectConnectionAdapter
   /** Direct async function for speech generation */
   fetcher?: GenerationFetcher<SpeechGenerateInput, TTSResult>
-  /**
-   * @deprecated Prefer `threadId`. Only allowed when `threadId` is omitted (see `GenerationPersistenceOptions`).
-   */
-  id?: string
   /** Additional body parameters to send with connect-based adapter requests */
   body?: Record<string, any>
   /** Display options for TanStack AI Devtools. */
@@ -102,7 +98,7 @@ export interface CreateGenerateSpeechReturn<TOutput = TTSResult> extends Omit<
 export function createGenerateSpeech<TTransformed = void>(
   options: Omit<
     CreateGenerateSpeechOptions,
-    'onResult' | 'persistence' | 'threadId' | 'id'
+    'onResult' | 'persistence' | 'threadId'
   > & {
     onResult?: (result: TTSResult) => TTransformed
   } & GenerationPersistenceOptions,

package/src/create-generate-video.svelte.ts

@@ -23,10 +23,6 @@ export interface CreateGenerateVideoOptions<TOutput = VideoGenerateResult> {
   connection?: ConnectConnectionAdapter
   /** Direct async function that returns a completed video result */
   fetcher?: GenerationFetcher<VideoGenerateInput, VideoGenerateResult>
-  /**
-   * @deprecated Prefer `threadId`. Only allowed when `threadId` is omitted (see `GenerationPersistenceOptions`).
-   */
-  id?: string
   /** Additional body parameters to send with connect-based adapter requests */
   body?: Record<string, any>
   /** Display options for TanStack AI Devtools. */
@@ -50,8 +46,8 @@ export interface CreateGenerateVideoOptions<TOutput = VideoGenerateResult> {
    * id on the wire, which the protocol requires.
    *
    * **Required whenever `persistence` is set** — an app that cannot name the
-   * scope has nothing to restore to. Optional for ephemeral generations, where
-   * it falls back to `id` purely to satisfy the wire.
+   * scope has nothing to restore to. Optional for ephemeral generations. If
+   * omitted, the client mints a wire id after mount.
    */
   threadId?: string
   /**
@@ -161,7 +157,7 @@ export interface CreateGenerateVideoReturn<TOutput = VideoGenerateResult> {
 export function createGenerateVideo<TTransformed = void>(
   options: Omit<
     CreateGenerateVideoOptions,
-    'onResult' | 'persistence' | 'threadId' | 'id'
+    'onResult' | 'persistence' | 'threadId'
   > & {
     onResult?: (result: VideoGenerateResult) => TTransformed
   } & GenerationPersistenceOptions,
@@ -172,7 +168,6 @@ export function createGenerateVideo<TTransformed = void>(
     VideoGenerateResult,
     TTransformed
   >
-  const fallbackId = `video-${Date.now()}-${Math.random().toString(36).substring(7)}`
 
   // Create reactive state using Svelte 5 runes
   let result = $state<TOutput | null>(null)
@@ -188,15 +183,18 @@ export function createGenerateVideo<TTransformed = void>(
   // is declared `body?: Record<string, any>` (absent vs. present) under
   // `exactOptionalPropertyTypes`. The optional caller `options.body` may be
   // undefined, in which case we want the key to be absent on the target.
-  // Identity: pass `threadId` alone when set (never also pass deprecated `id`).
   const baseOptions = {
     body: options.body,
-    ...(options.threadId !== undefined
-      ? { threadId: options.threadId }
-      : { id: options.id ?? fallbackId }),
-    ...(options.persistence !== undefined && {
-      persistence: options.persistence,
-    }),
+    ...(typeof options.threadId === 'string' && options.persistence
+      ? {
+          persistence: options.persistence,
+          threadId: options.threadId,
+        }
+      : {
+          ...(options.threadId !== undefined && {
+            threadId: options.threadId,
+          }),
+        }),
     ...(options.hydrateGeneration !== undefined && {
       hydrateGeneration: options.hydrateGeneration,
     }),

package/src/create-generation.svelte.ts

@@ -26,10 +26,6 @@ export interface CreateGenerationOptions<TInput, TResult, TOutput = TResult> {
   connection?: ConnectConnectionAdapter
   /** Direct async function for one-shot generation (no streaming protocol needed) */
   fetcher?: GenerationFetcher<TInput, TResult>
-  /**
-   * @deprecated Prefer `threadId`. Only allowed when `threadId` is omitted (see `GenerationPersistenceOptions`).
-   */
-  id?: string
   /** Additional body parameters to send with connect-based adapter requests */
   body?: Record<string, any>
   /** Display options for TanStack AI Devtools. */
@@ -53,8 +49,8 @@ export interface CreateGenerationOptions<TInput, TResult, TOutput = TResult> {
    * id on the wire, which the protocol requires.
    *
    * **Required whenever `persistence` is set** — an app that cannot name the
-   * scope has nothing to restore to. Optional for ephemeral generations, where
-   * it falls back to `id` purely to satisfy the wire.
+   * scope has nothing to restore to. Optional for ephemeral generations. If
+   * omitted, the client mints a wire id after mount.
    */
   threadId?: string
   /**
@@ -174,7 +170,7 @@ export function createGeneration<
 >(
   options: Omit<
     CreateGenerationOptions<TInput, TResult>,
-    'onResult' | 'persistence' | 'threadId' | 'id'
+    'onResult' | 'persistence' | 'threadId'
   > & {
     onResult?: (result: TResult) => TTransformed
   } & GenerationPersistenceOptions,
@@ -183,8 +179,6 @@ export function createGeneration<
   TInput
 > {
   type TOutput = InferGenerationOutputFromReturn<TResult, TTransformed>
-  const fallbackId = `gen-${Date.now()}-${Math.random().toString(36).substring(7)}`
-
   // Create reactive state using Svelte 5 runes
   let result = $state<TOutput | null>(null)
   let isLoading = $state(false)
@@ -198,15 +192,11 @@ export function createGeneration<
   // `exactOptionalPropertyTypes`. Assigning `undefined` directly would be
   // rejected — the optional caller `options.body` may be undefined, in which
   // case we want the key to be absent.
-  // Identity: pass `threadId` alone when set (never also pass deprecated `id`).
-  const clientOptions: GenerationClientOptions<TInput, TResult, TOutput> = {
+  const clientOptions: Omit<
+    GenerationClientOptions<TInput, TResult, TOutput>,
+    'persistence' | 'threadId'
+  > = {
     body: options.body,
-    ...(options.threadId !== undefined
-      ? { threadId: options.threadId }
-      : { id: options.id ?? fallbackId }),
-    ...(options.persistence !== undefined && {
-      persistence: options.persistence,
-    }),
     ...(options.hydrateGeneration !== undefined && {
       hydrateGeneration: options.hydrateGeneration,
     }),
@@ -257,16 +247,30 @@ export function createGeneration<
     },
   }
 
+  const persistenceProps =
+    typeof options.threadId === 'string' && options.persistence
+      ? {
+          persistence: options.persistence,
+          threadId: options.threadId,
+        }
+      : {
+          ...(options.threadId !== undefined && {
+            threadId: options.threadId,
+          }),
+        }
+
   let client: GenerationClient<TInput, TResult, TOutput>
 
   if (options.connection) {
     client = new GenerationClient<TInput, TResult, TOutput>({
       ...clientOptions,
+      ...persistenceProps,
       connection: options.connection,
     })
   } else if (options.fetcher) {
     client = new GenerationClient<TInput, TResult, TOutput>({
       ...clientOptions,
+      ...persistenceProps,
       fetcher: options.fetcher,
     })
   } else {

package/src/create-summarize.svelte.ts

@@ -30,10 +30,6 @@ export interface CreateSummarizeOptions<
   connection?: ConnectConnectionAdapter
   /** Direct async function for summarization */
   fetcher?: GenerationFetcher<SummarizeGenerateInput, SummarizationResult>
-  /**
-   * @deprecated Prefer `threadId`. Only allowed when `threadId` is omitted (see `GenerationPersistenceOptions`).
-   */
-  id?: string
   /** Additional body parameters to send with connect-based adapter requests */
   body?: Record<string, any>
   /** Display options for TanStack AI Devtools. */
@@ -107,7 +103,7 @@ export interface CreateSummarizeReturn<
 export function createSummarize<TTransformed = void>(
   options: Omit<
     CreateSummarizeOptions,
-    'onResult' | 'persistence' | 'threadId' | 'id'
+    'onResult' | 'persistence' | 'threadId'
   > & {
     onResult?: (result: SummarizationResult) => TTransformed
   } & GenerationPersistenceOptions,

package/src/create-transcription.svelte.ts

@@ -34,10 +34,6 @@ export interface CreateTranscriptionOptions<
   connection?: ConnectConnectionAdapter
   /** Direct async function for transcription */
   fetcher?: GenerationFetcher<TranscriptionGenerateInput, TranscriptionResult>
-  /**
-   * @deprecated Prefer `threadId`. Only allowed when `threadId` is omitted (see `GenerationPersistenceOptions`).
-   */
-  id?: string
   /** Additional body parameters to send with connect-based adapter requests */
   body?: Record<string, any>
   /** Display options for TanStack AI Devtools. */
@@ -116,7 +112,7 @@ export interface CreateTranscriptionReturn<
 export function createTranscription<TTransformed = void>(
   options: Omit<
     CreateTranscriptionOptions,
-    'onResult' | 'persistence' | 'threadId' | 'id'
+    'onResult' | 'persistence' | 'threadId'
   > & {
     onResult?: (result: TranscriptionResult) => TTransformed
   } & GenerationPersistenceOptions,

package/src/index.ts

@@ -80,6 +80,7 @@ export {
   xhrHttpStream,
   stream,
   rpcStream,
+  webSocket,
   createChatClientOptions,
   clientTools,
   type ConnectionAdapter,
@@ -88,6 +89,7 @@ export {
   type RunAgentInputContext,
   type FetchConnectionOptions,
   type XhrConnectionOptions,
+  type WebSocketConnectionOptions,
   type InferChatMessages,
   type GenerationClientState,
   type ImageGenerateInput,

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'
@@ -92,10 +95,6 @@ export type CreateChatOptions<
   | 'onRunIdChange'
   | 'context'
   | 'devtools'
-  // `id` is not a hook option: the hook's identity is its `threadId`, which is
-  // also the persistence key. Persist across reloads by passing a stable
-  // `threadId`; there is no separate id to set.
-  | 'id'
 > & {
   live?: boolean
   /** Display options for TanStack AI Devtools. */
@@ -116,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
     ? {
@@ -141,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
@@ -205,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