@tanstack/ai-svelte 0.7.2 → 0.9.0

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

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

package/dist/create-chat.svelte.js

@@ -1,4 +1,5 @@
 import { ChatClient } from '@tanstack/ai-client';
+import { parsePartialJSON } from '@tanstack/ai';
 /**
  * Creates a reactive chat instance for Svelte 5.
  *
@@ -41,6 +42,10 @@ export function createChat(options) {
     let isSubscribed = $state(false);
     let connectionStatus = $state('disconnected');
     let sessionGenerating = $state(false);
+    let partial = $state({});
+    let final = $state(null);
+    // Raw JSON accumulator — not reactive, just a local buffer.
+    let rawJson = '';
     // Create ChatClient instance.
     // Note: Svelte's createChat runs once per instance and `options` is captured
     // by reference. Callbacks are therefore frozen to whatever the caller passed
@@ -51,8 +56,30 @@ export function createChat(options) {
         id: clientId,
         initialMessages: options.initialMessages,
         body: options.body,
+        forwardedProps: options.forwardedProps,
         onResponse: options.onResponse,
-        onChunk: options.onChunk,
+        onChunk: (chunk) => {
+            if (options.outputSchema !== undefined) {
+                if (chunk.type === 'RUN_STARTED') {
+                    rawJson = '';
+                    partial = {};
+                    final = null;
+                }
+                else if (chunk.type === 'TEXT_MESSAGE_CONTENT' && chunk.delta) {
+                    rawJson += chunk.delta;
+                    const progressive = parsePartialJSON(rawJson);
+                    if (progressive && typeof progressive === 'object') {
+                        partial = progressive;
+                    }
+                }
+                else if (chunk.type === 'CUSTOM' &&
+                    chunk.name === 'structured-output.complete') {
+                    const value = chunk.value;
+                    final = value.object;
+                }
+            }
+            options.onChunk?.(chunk);
+        },
         onFinish: (message) => {
             options.onFinish?.(message);
         },
@@ -116,9 +143,16 @@ export function createChat(options) {
     const addToolApprovalResponse = async (response) => {
         await client.addToolApprovalResponse(response);
     };
+    /**
+     * @deprecated Use `updateForwardedProps` instead.
+     * Both populate the same wire payload.
+     */
     const updateBody = (newBody) => {
         client.updateOptions({ body: newBody });
     };
+    const updateForwardedProps = (newForwardedProps) => {
+        client.updateOptions({ forwardedProps: newForwardedProps });
+    };
     // Return the chat interface with reactive getters
     // Using getters allows Svelte to track reactivity without needing $ prefix
     return {
@@ -143,6 +177,12 @@ export function createChat(options) {
         get sessionGenerating() {
             return sessionGenerating;
         },
+        get partial() {
+            return partial;
+        },
+        get final() {
+            return final;
+        },
         sendMessage,
         append,
         reload,
@@ -152,5 +192,6 @@ export function createChat(options) {
         addToolResult,
         addToolApprovalResponse,
         updateBody,
+        updateForwardedProps,
     };
 }

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { createChat } from './create-chat.svelte';
-export type { CreateChatOptions, CreateChatReturn, UIMessage, ChatRequestBody, } from './types';
+export type { CreateChatOptions, CreateChatReturn, DeepPartial, UIMessage, ChatRequestBody, } from './types';
 export { createGeneration } from './create-generation.svelte';
 export type { CreateGenerationOptions, CreateGenerationReturn, } from './create-generation.svelte';
 export { createGenerateImage } from './create-generate-image.svelte';

package/dist/types.d.ts

@@ -1,6 +1,14 @@
-import type { AnyClientTool, ModelMessage } from '@tanstack/ai';
+import type { AnyClientTool, InferSchemaType, ModelMessage, SchemaInput } from '@tanstack/ai';
 import type { ChatClientOptions, ChatClientState, ChatRequestBody, ConnectionStatus, MultimodalContent, UIMessage } from '@tanstack/ai-client';
 export type { ChatRequestBody, MultimodalContent, UIMessage };
+/**
+ * Recursive partial — every property and every nested array element is
+ * optional. Used to type the in-flight `partial` getter while a structured-
+ * output stream is still arriving.
+ */
+export type DeepPartial<T> = T extends ReadonlyArray<infer U> ? Array<DeepPartial<U>> : T extends object ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : T;
 /**
  * Options for the createChat function.
  *
@@ -14,13 +22,41 @@ export type { ChatRequestBody, MultimodalContent, UIMessage };
  * All other callbacks (onResponse, onChunk, onFinish, onError) are
  * passed through to the underlying ChatClient and can be used for side effects.
  *
+ * When `outputSchema` is supplied, the return adds typed `partial` and `final`
+ * reactive getters. The schema is used purely for type inference; server-side
+ * validation still runs against the schema passed to `chat({ outputSchema })`
+ * on the server route.
+ *
  * 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> = Omit<ChatClientOptions<TTools>, 'onMessagesChange' | 'onLoadingChange' | 'onErrorChange' | 'onStatusChange' | 'onSubscriptionChange' | 'onConnectionStatusChange' | 'onSessionGeneratingChange'> & {
+export type CreateChatOptions<TTools extends ReadonlyArray<AnyClientTool> = any, TSchema extends SchemaInput | undefined = undefined> = Omit<ChatClientOptions<TTools>, 'onMessagesChange' | 'onLoadingChange' | 'onErrorChange' | 'onStatusChange' | 'onSubscriptionChange' | 'onConnectionStatusChange' | 'onSessionGeneratingChange'> & {
     live?: boolean;
+    /**
+     * Standard-schema-compatible schema (Zod, Valibot, ArkType, or plain JSON
+     * Schema). Used to infer the shape of `partial` and `final`.
+     */
+    outputSchema?: TSchema;
 };
-export interface CreateChatReturn<TTools extends ReadonlyArray<AnyClientTool> = any> {
+/**
+ * Discriminated return shape: when `outputSchema` is supplied, the return adds
+ * typed `partial` / `final` reactive getters; otherwise the return is
+ * unchanged.
+ */
+export type CreateChatReturn<TTools extends ReadonlyArray<AnyClientTool> = any, TSchema extends SchemaInput | undefined = undefined> = BaseCreateChatReturn<TTools> & (TSchema extends SchemaInput ? {
+    /**
+     * Live progressively-parsed structured output (reactive getter).
+     * Resets on every new run.
+     */
+    readonly partial: DeepPartial<InferSchemaType<TSchema>>;
+    /**
+     * Final, schema-validated structured output (reactive getter). `null`
+     * until the terminal `structured-output.complete` event arrives.
+     * Resets on every new run.
+     */
+    readonly final: InferSchemaType<TSchema> | null;
+} : Record<never, never>);
+interface BaseCreateChatReturn<TTools extends ReadonlyArray<AnyClientTool> = any> {
     /**
      * Current messages in the conversation (reactive getter)
      */
@@ -95,7 +131,13 @@ export interface CreateChatReturn<TTools extends ReadonlyArray<AnyClientTool> =
      */
     readonly sessionGenerating: boolean;
     /**
-     * Update the body sent with requests (e.g., for changing model selection)
+     * @deprecated Use `updateForwardedProps` instead. Both populate the
+     * same wire payload; `updateBody` is retained for backward compatibility.
      */
     updateBody: (body: Record<string, any>) => void;
+    /**
+     * Update the AG-UI `forwardedProps` sent with requests (e.g., for
+     * changing model selection or other client-driven options).
+     */
+    updateForwardedProps: (forwardedProps: Record<string, any>) => void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/ai-svelte",
-  "version": "0.7.2",
+  "version": "0.9.0",
   "description": "Svelte bindings for TanStack AI",
   "author": "",
   "license": "MIT",
@@ -33,13 +33,14 @@
     "streaming"
   ],
   "dependencies": {
-    "@tanstack/ai-client": "0.9.1"
+    "@tanstack/ai-client": "0.10.0"
   },
   "peerDependencies": {
     "svelte": "^5.0.0",
-    "@tanstack/ai": "^0.16.0"
+    "@tanstack/ai": "^0.18.0"
   },
   "devDependencies": {
+    "@standard-schema/spec": "^1.1.0",
     "@sveltejs/package": "^2.3.10",
     "@sveltejs/vite-plugin-svelte": "^5.1.1",
     "@types/node": "^24.10.1",
@@ -49,7 +50,7 @@
     "svelte-check": "^4.2.0",
     "typescript": "5.9.3",
     "vite": "^7.2.7",
-    "@tanstack/ai": "0.16.0"
+    "@tanstack/ai": "0.18.0"
   },
   "scripts": {
     "clean": "rm -rf ./dist",

package/src/create-chat.svelte.ts

@@ -1,9 +1,17 @@
 import { ChatClient } from '@tanstack/ai-client'
+import { parsePartialJSON } from '@tanstack/ai'
 import type { ChatClientState, ConnectionStatus } from '@tanstack/ai-client'
-import type { AnyClientTool, ModelMessage } from '@tanstack/ai'
+import type {
+  AnyClientTool,
+  InferSchemaType,
+  ModelMessage,
+  SchemaInput,
+  StreamChunk,
+} from '@tanstack/ai'
 import type {
   CreateChatOptions,
   CreateChatReturn,
+  DeepPartial,
   MultimodalContent,
   UIMessage,
 } from './types'
@@ -38,9 +46,12 @@ import type {
  * </div>
  * ```
  */
-export function createChat<TTools extends ReadonlyArray<AnyClientTool> = any>(
-  options: CreateChatOptions<TTools>,
-): CreateChatReturn<TTools> {
+export function createChat<
+  TTools extends ReadonlyArray<AnyClientTool> = any,
+  TSchema extends SchemaInput | undefined = undefined,
+>(
+  options: CreateChatOptions<TTools, TSchema>,
+): CreateChatReturn<TTools, TSchema> {
   // Generate a unique ID for this chat instance
   const clientId =
     options.id ||
@@ -55,6 +66,15 @@ export function createChat<TTools extends ReadonlyArray<AnyClientTool> = any>(
   let connectionStatus = $state<ConnectionStatus>('disconnected')
   let sessionGenerating = $state(false)
 
+  // Structured-output state. Runtime always tracks them — the conditional
+  // return type hides them when no `outputSchema` is supplied.
+  type Partial = DeepPartial<InferSchemaType<NonNullable<TSchema>>>
+  type Final = InferSchemaType<NonNullable<TSchema>>
+  let partial = $state<Partial>({} as Partial)
+  let final = $state<Final | null>(null)
+  // Raw JSON accumulator — not reactive, just a local buffer.
+  let rawJson = ''
+
   // Create ChatClient instance.
   // Note: Svelte's createChat runs once per instance and `options` is captured
   // by reference. Callbacks are therefore frozen to whatever the caller passed
@@ -65,8 +85,30 @@ export function createChat<TTools extends ReadonlyArray<AnyClientTool> = any>(
     id: clientId,
     initialMessages: options.initialMessages,
     body: options.body,
+    forwardedProps: options.forwardedProps,
     onResponse: options.onResponse,
-    onChunk: options.onChunk,
+    onChunk: (chunk: StreamChunk) => {
+      if (options.outputSchema !== undefined) {
+        if (chunk.type === 'RUN_STARTED') {
+          rawJson = ''
+          partial = {} as Partial
+          final = null
+        } else if (chunk.type === 'TEXT_MESSAGE_CONTENT' && chunk.delta) {
+          rawJson += chunk.delta
+          const progressive = parsePartialJSON(rawJson)
+          if (progressive && typeof progressive === 'object') {
+            partial = progressive as Partial
+          }
+        } else if (
+          chunk.type === 'CUSTOM' &&
+          chunk.name === 'structured-output.complete'
+        ) {
+          const value = chunk.value as { object: unknown }
+          final = value.object as Final
+        }
+      }
+      options.onChunk?.(chunk)
+    },
     onFinish: (message) => {
       options.onFinish?.(message)
     },
@@ -150,10 +192,18 @@ export function createChat<TTools extends ReadonlyArray<AnyClientTool> = any>(
     await client.addToolApprovalResponse(response)
   }
 
+  /**
+   * @deprecated Use `updateForwardedProps` instead.
+   * Both populate the same wire payload.
+   */
   const updateBody = (newBody: Record<string, any>) => {
     client.updateOptions({ body: newBody })
   }
 
+  const updateForwardedProps = (newForwardedProps: Record<string, any>) => {
+    client.updateOptions({ forwardedProps: newForwardedProps })
+  }
+
   // Return the chat interface with reactive getters
   // Using getters allows Svelte to track reactivity without needing $ prefix
   return {
@@ -178,6 +228,12 @@ export function createChat<TTools extends ReadonlyArray<AnyClientTool> = any>(
     get sessionGenerating() {
       return sessionGenerating
     },
+    get partial() {
+      return partial
+    },
+    get final() {
+      return final
+    },
     sendMessage,
     append,
     reload,
@@ -187,5 +243,6 @@ export function createChat<TTools extends ReadonlyArray<AnyClientTool> = any>(
     addToolResult,
     addToolApprovalResponse,
     updateBody,
-  }
+    updateForwardedProps,
+  } as unknown as CreateChatReturn<TTools, TSchema>
 }

package/src/index.ts

@@ -2,6 +2,7 @@ export { createChat } from './create-chat.svelte'
 export type {
   CreateChatOptions,
   CreateChatReturn,
+  DeepPartial,
   UIMessage,
   ChatRequestBody,
 } from './types'

package/src/types.ts

@@ -1,4 +1,9 @@
-import type { AnyClientTool, ModelMessage } from '@tanstack/ai'
+import type {
+  AnyClientTool,
+  InferSchemaType,
+  ModelMessage,
+  SchemaInput,
+} from '@tanstack/ai'
 import type {
   ChatClientOptions,
   ChatClientState,
@@ -11,6 +16,18 @@ import type {
 // Re-export types from ai-client
 export type { ChatRequestBody, MultimodalContent, UIMessage }
 
+/**
+ * Recursive partial — every property and every nested array element is
+ * optional. Used to type the in-flight `partial` getter while a structured-
+ * output stream is still arriving.
+ */
+export type DeepPartial<T> =
+  T extends ReadonlyArray<infer U>
+    ? Array<DeepPartial<U>>
+    : T extends object
+      ? { [K in keyof T]?: DeepPartial<T[K]> }
+      : T
+
 /**
  * Options for the createChat function.
  *
@@ -24,11 +41,17 @@ export type { ChatRequestBody, MultimodalContent, UIMessage }
  * All other callbacks (onResponse, onChunk, onFinish, onError) are
  * passed through to the underlying ChatClient and can be used for side effects.
  *
+ * When `outputSchema` is supplied, the return adds typed `partial` and `final`
+ * reactive getters. The schema is used purely for type inference; server-side
+ * validation still runs against the schema passed to `chat({ outputSchema })`
+ * on the server route.
+ *
  * 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,
 > = Omit<
   ChatClientOptions<TTools>,
   | 'onMessagesChange'
@@ -40,9 +63,39 @@ export type CreateChatOptions<
   | 'onSessionGeneratingChange'
 > & {
   live?: boolean
+  /**
+   * Standard-schema-compatible schema (Zod, Valibot, ArkType, or plain JSON
+   * Schema). Used to infer the shape of `partial` and `final`.
+   */
+  outputSchema?: TSchema
 }
 
-export interface CreateChatReturn<
+/**
+ * Discriminated return shape: when `outputSchema` is supplied, the return adds
+ * typed `partial` / `final` reactive getters; otherwise the return is
+ * unchanged.
+ */
+export type CreateChatReturn<
+  TTools extends ReadonlyArray<AnyClientTool> = any,
+  TSchema extends SchemaInput | undefined = undefined,
+> = BaseCreateChatReturn<TTools> &
+  (TSchema extends SchemaInput
+    ? {
+        /**
+         * Live progressively-parsed structured output (reactive getter).
+         * Resets on every new run.
+         */
+        readonly partial: DeepPartial<InferSchemaType<TSchema>>
+        /**
+         * Final, schema-validated structured output (reactive getter). `null`
+         * until the terminal `structured-output.complete` event arrives.
+         * Resets on every new run.
+         */
+        readonly final: InferSchemaType<TSchema> | null
+      }
+    : Record<never, never>)
+
+interface BaseCreateChatReturn<
   TTools extends ReadonlyArray<AnyClientTool> = any,
 > {
   /**
@@ -130,9 +183,15 @@ export interface CreateChatReturn<
    */
   readonly sessionGenerating: boolean
   /**
-   * Update the body sent with requests (e.g., for changing model selection)
+   * @deprecated Use `updateForwardedProps` instead. Both populate the
+   * same wire payload; `updateBody` is retained for backward compatibility.
    */
   updateBody: (body: Record<string, any>) => void
+  /**
+   * Update the AG-UI `forwardedProps` sent with requests (e.g., for
+   * changing model selection or other client-driven options).
+   */
+  updateForwardedProps: (forwardedProps: Record<string, any>) => void
 }
 
 // Note: createChatClientOptions and InferChatMessages are now in @tanstack/ai-client