@tanstack/ai-svelte 0.13.14 → 0.13.15

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

@@ -0,0 +1,94 @@
+import type { StreamChunk, TranscriptionResult } from '@tanstack/ai';
+import type { AIDevtoolsDisplayOptions, ConnectConnectionAdapter, GenerationClientState, GenerationFetcher, InferGenerationOutput, TranscriptionGenerateInput } from '@tanstack/ai-client';
+/**
+ * Options for the createTranscription function.
+ *
+ * @template TOutput - The output type after optional transform (defaults to TranscriptionResult)
+ */
+export interface CreateTranscriptionOptions<TOutput = TranscriptionResult> {
+    /** Connect-based adapter for streaming transport (SSE, HTTP stream, custom) */
+    connection?: ConnectConnectionAdapter;
+    /** Direct async function for transcription */
+    fetcher?: GenerationFetcher<TranscriptionGenerateInput, TranscriptionResult>;
+    /** Unique identifier for this generation instance */
+    id?: string;
+    /** Additional body parameters to send with connect-based adapter requests */
+    body?: Record<string, any>;
+    /** Display options for TanStack AI Devtools. */
+    devtools?: AIDevtoolsDisplayOptions;
+    /**
+     * Callback when transcription is complete. Can optionally return a transformed value.
+     *
+     * - Return a non-null value to transform and store it as the result
+     * - Return `null` to keep the previous result unchanged
+     * - Return nothing (`void`) to store the raw result as-is
+     */
+    onResult?: (result: TranscriptionResult) => TOutput | null | void;
+    /** Callback when an error occurs */
+    onError?: (error: Error) => void;
+    /** Callback when progress is reported (0-100) */
+    onProgress?: (progress: number, message?: string) => void;
+    /** Callback for each stream chunk (connect-based adapter mode only) */
+    onChunk?: (chunk: StreamChunk) => void;
+}
+/**
+ * Return type for the createTranscription function.
+ *
+ * @template TOutput - The output type (after optional transform)
+ */
+export interface CreateTranscriptionReturn<TOutput = TranscriptionResult> {
+    /** The transcription result, or null */
+    readonly result: TOutput | null;
+    /** Whether transcription is in progress */
+    readonly isLoading: boolean;
+    /** Current error, if any */
+    readonly error: Error | undefined;
+    /** Current state of the generation */
+    readonly status: GenerationClientState;
+    /** Trigger transcription */
+    generate: (input: TranscriptionGenerateInput) => Promise<void>;
+    /** Abort the current transcription */
+    stop: () => void;
+    /** Clear result, error, and return to idle */
+    reset: () => void;
+    /** Update additional body parameters */
+    updateBody: (body: Record<string, any>) => void;
+}
+/**
+ * Creates a reactive audio transcription instance for Svelte 5.
+ *
+ * @example
+ * ```svelte
+ * <script>
+ *   import { createTranscription, fetchServerSentEvents } from '@tanstack/ai-svelte'
+ *
+ *   const transcription = createTranscription({
+ *     connection: fetchServerSentEvents('/api/transcribe'),
+ *   })
+ *
+ *   function handleFile(e) {
+ *     const file = e.target.files?.[0]
+ *     if (file) {
+ *       const reader = new FileReader()
+ *       reader.onload = () => {
+ *         transcription.generate({ audio: reader.result, language: 'en' })
+ *       }
+ *       reader.readAsDataURL(file)
+ *     }
+ *   }
+ * </script>
+ *
+ * <div>
+ *   <input type="file" accept="audio/*" onchange={handleFile} />
+ *   {#if transcription.isLoading}
+ *     <p>Transcribing...</p>
+ *   {/if}
+ *   {#if transcription.result}
+ *     <p>{transcription.result.text}</p>
+ *   {/if}
+ * </div>
+ * ```
+ */
+export declare function createTranscription<TOnResult extends ((result: TranscriptionResult) => any) | undefined = undefined>(options: Omit<CreateTranscriptionOptions, 'onResult'> & {
+    onResult?: TOnResult;
+}): CreateTranscriptionReturn<InferGenerationOutput<TranscriptionResult, TOnResult>>;

package/dist/create-transcription.svelte.js

@@ -0,0 +1,66 @@
+import { createGeneration } from './create-generation.svelte';
+/**
+ * Creates a reactive audio transcription instance for Svelte 5.
+ *
+ * @example
+ * ```svelte
+ * <script>
+ *   import { createTranscription, fetchServerSentEvents } from '@tanstack/ai-svelte'
+ *
+ *   const transcription = createTranscription({
+ *     connection: fetchServerSentEvents('/api/transcribe'),
+ *   })
+ *
+ *   function handleFile(e) {
+ *     const file = e.target.files?.[0]
+ *     if (file) {
+ *       const reader = new FileReader()
+ *       reader.onload = () => {
+ *         transcription.generate({ audio: reader.result, language: 'en' })
+ *       }
+ *       reader.readAsDataURL(file)
+ *     }
+ *   }
+ * </script>
+ *
+ * <div>
+ *   <input type="file" accept="audio/*" onchange={handleFile} />
+ *   {#if transcription.isLoading}
+ *     <p>Transcribing...</p>
+ *   {/if}
+ *   {#if transcription.result}
+ *     <p>{transcription.result.text}</p>
+ *   {/if}
+ * </div>
+ * ```
+ */
+export function createTranscription(options) {
+    const devtools = {
+        ...options.devtools,
+        framework: 'svelte',
+        hookName: 'createTranscription',
+        outputKind: 'text',
+    };
+    const gen = createGeneration({
+        ...options,
+        devtools,
+    });
+    return {
+        get result() {
+            return gen.result;
+        },
+        get isLoading() {
+            return gen.isLoading;
+        },
+        get error() {
+            return gen.error;
+        },
+        get status() {
+            return gen.status;
+        },
+        generate: gen.generate,
+        stop: gen.stop,
+        reset: gen.reset,
+        updateBody: gen.updateBody,
+    };
+}

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+export { createChat } from './create-chat.svelte';
+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';
+export type { CreateGenerateImageOptions, CreateGenerateImageReturn, } from './create-generate-image.svelte';
+export { createGenerateAudio } from './create-generate-audio.svelte';
+export type { CreateGenerateAudioOptions, CreateGenerateAudioReturn, } from './create-generate-audio.svelte';
+export { createGenerateSpeech } from './create-generate-speech.svelte';
+export type { CreateGenerateSpeechOptions, CreateGenerateSpeechReturn, } from './create-generate-speech.svelte';
+export { createTranscription } from './create-transcription.svelte';
+export type { CreateTranscriptionOptions, CreateTranscriptionReturn, } from './create-transcription.svelte';
+export { createSummarize } from './create-summarize.svelte';
+export type { CreateSummarizeOptions, CreateSummarizeReturn, } from './create-summarize.svelte';
+export { createGenerateVideo } from './create-generate-video.svelte';
+export type { CreateGenerateVideoOptions, CreateGenerateVideoReturn, } from './create-generate-video.svelte';
+export { fetchServerSentEvents, 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';

package/dist/index.js

@@ -0,0 +1,11 @@
+export { createChat } from './create-chat.svelte';
+// Generation hooks
+export { createGeneration } from './create-generation.svelte';
+export { createGenerateImage } from './create-generate-image.svelte';
+export { createGenerateAudio } from './create-generate-audio.svelte';
+export { createGenerateSpeech } from './create-generate-speech.svelte';
+export { createTranscription } from './create-transcription.svelte';
+export { createSummarize } from './create-summarize.svelte';
+export { createGenerateVideo } from './create-generate-video.svelte';
+// Re-export from ai-client for convenience
+export { fetchServerSentEvents, fetchHttpStream, xhrServerSentEvents, xhrHttpStream, stream, rpcStream, createChatClientOptions, clientTools, } from '@tanstack/ai-client';

package/dist/types.d.ts

@@ -0,0 +1,157 @@
+import type { AnyClientTool, InferSchemaType, ModelMessage, SchemaInput } from '@tanstack/ai';
+import type { AIDevtoolsDisplayOptions, ChatClientOptions, ChatClientState, ChatRequestBody, ClientContextOptionFromTools, ConnectionStatus, DistributedOmit, InferredClientContext, 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.
+ *
+ * This extends ChatClientOptions but omits the state change callbacks that are
+ * managed internally by Svelte state:
+ * - `onMessagesChange` - Managed by Svelte state (exposed as `messages`)
+ * - `onLoadingChange` - Managed by Svelte state (exposed as `isLoading`)
+ * - `onErrorChange` - Managed by Svelte state (exposed as `error`)
+ * - `onStatusChange` - Managed by Svelte state (exposed as `status`)
+ *
+ * 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, TContext = InferredClientContext<TTools>> = DistributedOmit<ChatClientOptions<TTools, TContext>, 'onMessagesChange' | 'onLoadingChange' | 'onErrorChange' | 'onStatusChange' | 'onSubscriptionChange' | 'onConnectionStatusChange' | 'onSessionGeneratingChange' | 'context' | 'devtools'> & {
+    live?: boolean;
+    /** Display options for TanStack AI Devtools. */
+    devtools?: AIDevtoolsDisplayOptions;
+    /**
+     * Standard-schema-compatible schema (Zod, Valibot, ArkType, or plain JSON
+     * Schema). Used to infer the shape of `partial` and `final`.
+     */
+    outputSchema?: TSchema;
+} & ClientContextOptionFromTools<TTools, TContext>;
+/**
+ * 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, TContext = unknown> = BaseCreateChatReturn<TTools, TSchema extends SchemaInput ? InferSchemaType<TSchema> : unknown, TContext> & (TSchema extends SchemaInput ? {
+    /**
+     * Live progressively-parsed structured output (reactive getter).
+     * Derived from the latest assistant message's structured-output part.
+     */
+    readonly partial: DeepPartial<InferSchemaType<TSchema>>;
+    /**
+     * Final, schema-validated structured output (reactive getter). `null`
+     * until the latest assistant turn's structured-output part transitions
+     * to `complete`.
+     */
+    readonly final: InferSchemaType<TSchema> | null;
+} : Record<never, never>);
+interface BaseCreateChatReturn<TTools extends ReadonlyArray<AnyClientTool> = any, TData = unknown, TContext = unknown> {
+    /**
+     * Current messages in the conversation (reactive getter). When
+     * `outputSchema` is supplied, `messages[i].parts.find(p => p.type ===
+     * 'structured-output')` is typed by the schema — `data: T`,
+     * `partial: DeepPartial<T>`.
+     */
+    readonly messages: Array<UIMessage<TTools, TData>>;
+    /**
+     * Send a message and get a response.
+     * Can be a simple string or multimodal content with images, audio, etc.
+     */
+    sendMessage: (content: string | MultimodalContent) => Promise<void>;
+    /**
+     * Append a message to the conversation
+     */
+    append: (message: ModelMessage | UIMessage<TTools, TData>) => Promise<void>;
+    /**
+     * Add the result of a client-side tool execution
+     */
+    addToolResult: (result: {
+        toolCallId: string;
+        tool: string;
+        output: any;
+        state?: 'output-available' | 'output-error';
+        errorText?: string;
+    }) => Promise<void>;
+    /**
+     * Respond to a tool approval request
+     */
+    addToolApprovalResponse: (response: {
+        id: string;
+        approved: boolean;
+    }) => Promise<void>;
+    /**
+     * Reload the last assistant message
+     */
+    reload: () => Promise<void>;
+    /**
+     * Stop the current response generation
+     */
+    stop: () => void;
+    /**
+     * Dispose the chat client and unregister it from devtools.
+     */
+    dispose: () => void;
+    /**
+     * Whether a response is currently being generated (reactive getter)
+     */
+    readonly isLoading: boolean;
+    /**
+     * Current error, if any (reactive getter)
+     */
+    readonly error: Error | undefined;
+    /**
+     * Set messages manually
+     */
+    setMessages: (messages: Array<UIMessage<TTools, TData>>) => void;
+    /**
+     * Clear all messages
+     */
+    clear: () => void;
+    /**
+     * Current generation status (reactive getter)
+     */
+    readonly status: ChatClientState;
+    /**
+     * Whether the subscription loop is currently active (reactive getter)
+     */
+    readonly isSubscribed: boolean;
+    /**
+     * Current connection lifecycle status (reactive getter)
+     */
+    readonly connectionStatus: ConnectionStatus;
+    /**
+     * Whether the shared session is actively generating (reactive getter).
+     * Derived from stream run events (RUN_STARTED / RUN_FINISHED / RUN_ERROR).
+     * Unlike `isLoading` (request-local), this reflects shared generation
+     * activity visible to all subscribers (e.g. across tabs/devices).
+     */
+    readonly sessionGenerating: boolean;
+    /**
+     * @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;
+    /**
+     * Update the client-local runtime context passed to client tool
+     * implementations. This value is not serialized to the server.
+     */
+    updateContext: (context: TContext) => void;
+}

package/dist/types.js

@@ -0,0 +1,3 @@
+export {};
+// Note: createChatClientOptions and InferChatMessages are now in @tanstack/ai-client
+// and re-exported from there for convenience

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/ai-svelte",
-  "version": "0.13.14",
+  "version": "0.13.15",
   "description": "Svelte 5 bindings for TanStack AI streaming chat, structured outputs, and media generation.",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -46,11 +46,11 @@
     "media-generation"
   ],
   "dependencies": {
-    "@tanstack/ai-client": "0.18.5"
+    "@tanstack/ai-client": "0.18.6"
   },
   "peerDependencies": {
     "svelte": "^5.0.0",
-    "@tanstack/ai": "^0.36.0"
+    "@tanstack/ai": "^0.37.0"
   },
   "devDependencies": {
     "@standard-schema/spec": "^1.1.0",
@@ -63,7 +63,7 @@
     "svelte-check": "^4.2.0",
     "typescript": "5.9.3",
     "vite": "^7.3.3",
-    "@tanstack/ai": "0.36.0"
+    "@tanstack/ai": "0.37.0"
   },
   "scripts": {
     "clean": "rm -rf ./dist",