@tanstack/ai-svelte 0.18.3 → 0.19.1

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

@@ -0,0 +1,4 @@
+import type { ByokClient, ByokSnapshot } from '@tanstack/ai-client/byok';
+export declare function createByok(client: ByokClient): {
+    readonly snapshot: ByokSnapshot;
+};

package/dist/create-byok.svelte.js

@@ -0,0 +1,18 @@
+import { onDestroy } from 'svelte';
+export function createByok(client) {
+    let snapshot = $state(client.getSnapshot());
+    const unsubscribe = client.subscribe(() => {
+        snapshot = client.getSnapshot();
+    });
+    try {
+        onDestroy(unsubscribe);
+    }
+    catch {
+        // Svelte lifecycle hooks are only valid during component initialization.
+    }
+    return {
+        get snapshot() {
+            return snapshot;
+        },
+    };
+}

package/dist/create-chat.svelte.js

@@ -87,6 +87,8 @@ export function createChat(options) {
         ...(options.forwardedProps !== undefined && {
             forwardedProps: options.forwardedProps,
         }),
+        ...(options.byok !== undefined && { byok: options.byok }),
+        byokProvider: () => options.byokProvider?.(),
         ...(options.context !== undefined && { context: options.context }),
         devtools: {
             ...options.devtools,

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

@@ -6,7 +6,7 @@ import type { AIDevtoolsDisplayOptions, AudioGenerateInput, ConnectConnectionAda
  *
  * @template TOutput - The output type after optional transform (defaults to AudioGenerationResult)
  */
-export interface CreateGenerateAudioOptions<TOutput = AudioGenerationResult> extends Pick<CreateGenerationOptions<AudioGenerateInput, AudioGenerationResult, TOutput>, 'persistence' | 'threadId' | 'hydrateGeneration' | 'joinRun'> {
+export interface CreateGenerateAudioOptions<TOutput = AudioGenerationResult> extends Pick<CreateGenerationOptions<AudioGenerateInput, AudioGenerationResult, TOutput>, 'persistence' | 'threadId' | 'hydrateGeneration' | 'joinRun' | 'byok' | 'byokProvider'> {
     /** Connect-based adapter for streaming transport (SSE, HTTP stream, custom) */
     connection?: ConnectConnectionAdapter;
     /** Direct async function for audio generation */

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

@@ -6,7 +6,7 @@ import type { AIDevtoolsDisplayOptions, ConnectConnectionAdapter, GenerationClie
  *
  * @template TOutput - The output type after optional transform (defaults to ImageGenerationResult)
  */
-export interface CreateGenerateImageOptions<TOutput = ImageGenerationResult> extends Pick<CreateGenerationOptions<ImageGenerateInput, ImageGenerationResult, TOutput>, 'persistence' | 'threadId' | 'hydrateGeneration' | 'joinRun'> {
+export interface CreateGenerateImageOptions<TOutput = ImageGenerationResult> extends Pick<CreateGenerationOptions<ImageGenerateInput, ImageGenerationResult, TOutput>, 'persistence' | 'threadId' | 'hydrateGeneration' | 'joinRun' | 'byok' | 'byokProvider'> {
     /** Connect-based adapter for streaming transport (SSE, HTTP stream, custom) */
     connection?: ConnectConnectionAdapter;
     /** Direct async function for image generation */

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

@@ -6,7 +6,7 @@ import type { AIDevtoolsDisplayOptions, ConnectConnectionAdapter, GenerationClie
  *
  * @template TOutput - The output type after optional transform (defaults to TTSResult)
  */
-export interface CreateGenerateSpeechOptions<TOutput = TTSResult> extends Pick<CreateGenerationOptions<SpeechGenerateInput, TTSResult, TOutput>, 'persistence' | 'threadId' | 'hydrateGeneration' | 'joinRun'> {
+export interface CreateGenerateSpeechOptions<TOutput = TTSResult> extends Pick<CreateGenerationOptions<SpeechGenerateInput, TTSResult, TOutput>, 'persistence' | 'threadId' | 'hydrateGeneration' | 'joinRun' | 'byok' | 'byokProvider'> {
     /** Connect-based adapter for streaming transport (SSE, HTTP stream, custom) */
     connection?: ConnectConnectionAdapter;
     /** Direct async function for speech generation */

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

@@ -1,5 +1,7 @@
 import type { StreamChunk } from '@tanstack/ai';
 import type { AIDevtoolsDisplayOptions, ConnectConnectionAdapter, GenerationClientState, GenerationFetcher, GenerationPersistenceOptions, InferGenerationOutputFromReturn, VideoGenerateInput, VideoGenerateResult, VideoStatusInfo } from '@tanstack/ai-client';
+import type { ByokClient } from '@tanstack/ai-client/byok';
+import type { ProviderId } from '@tanstack/ai/byok';
 /**
  * Options for the createGenerateVideo function.
  *
@@ -12,6 +14,10 @@ export interface CreateGenerateVideoOptions<TOutput = VideoGenerateResult> {
     fetcher?: GenerationFetcher<VideoGenerateInput, VideoGenerateResult>;
     /** Additional body parameters to send with connect-based adapter requests */
     body?: Record<string, any>;
+    /** Optional BYOK keyring. Keys go in `x-byok-*` headers, never the body. */
+    byok?: ByokClient;
+    /** Optional provider id. If it returns a slug, only that key is sent. If no slug resolves (`byokProvider`, then `body.provider`), generate throws. */
+    byokProvider?: () => ProviderId | undefined;
     /** Display options for TanStack AI Devtools. */
     devtools?: AIDevtoolsDisplayOptions;
     /**

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

@@ -63,6 +63,8 @@ export function createGenerateVideo(options) {
             hydrateGeneration: options.hydrateGeneration,
         }),
         ...(options.joinRun !== undefined && { joinRun: options.joinRun }),
+        ...(options.byok !== undefined && { byok: options.byok }),
+        byokProvider: () => options.byokProvider?.(),
         devtoolsBridgeFactory: createVideoDevtoolsBridge,
         devtools: {
             ...options.devtools,

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

@@ -1,5 +1,7 @@
 import type { StreamChunk } from '@tanstack/ai';
 import type { AIDevtoolsDisplayOptions, ConnectConnectionAdapter, GenerationClientState, GenerationFetcher, GenerationPersistenceOptions, GenerationRestoredResult, InferGenerationOutputFromReturn } from '@tanstack/ai-client';
+import type { ByokClient } from '@tanstack/ai-client/byok';
+import type { ProviderId } from '@tanstack/ai/byok';
 /**
  * Options for the createGeneration function.
  *
@@ -16,6 +18,10 @@ export interface CreateGenerationOptions<TInput, TResult, TOutput = TResult> {
     fetcher?: GenerationFetcher<TInput, TResult>;
     /** Additional body parameters to send with connect-based adapter requests */
     body?: Record<string, any>;
+    /** Optional BYOK keyring. Keys go in `x-byok-*` headers, never the body. */
+    byok?: ByokClient;
+    /** Optional provider id. If it returns a slug, only that key is sent. If no slug resolves (`byokProvider`, then `body.provider`), generate throws. */
+    byokProvider?: () => ProviderId | undefined;
     /** Display options for TanStack AI Devtools. */
     devtools?: AIDevtoolsDisplayOptions;
     /**

package/dist/create-generation.svelte.js

@@ -56,6 +56,8 @@ export function createGeneration(options) {
             hydrateGeneration: options.hydrateGeneration,
         }),
         ...(options.joinRun !== undefined && { joinRun: options.joinRun }),
+        ...(options.byok !== undefined && { byok: options.byok }),
+        byokProvider: () => options.byokProvider?.(),
         ...(options.reconstructResult
             ? { reconstructResult: options.reconstructResult }
             : {}),

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

@@ -6,7 +6,7 @@ import type { AIDevtoolsDisplayOptions, ConnectConnectionAdapter, GenerationClie
  *
  * @template TOutput - The output type after optional transform (defaults to SummarizationResult)
  */
-export interface CreateSummarizeOptions<TOutput = SummarizationResult> extends Pick<CreateGenerationOptions<SummarizeGenerateInput, SummarizationResult, TOutput>, 'persistence' | 'threadId' | 'hydrateGeneration' | 'joinRun'> {
+export interface CreateSummarizeOptions<TOutput = SummarizationResult> extends Pick<CreateGenerationOptions<SummarizeGenerateInput, SummarizationResult, TOutput>, 'persistence' | 'threadId' | 'hydrateGeneration' | 'joinRun' | 'byok' | 'byokProvider'> {
     /** Connect-based adapter for streaming transport (SSE, HTTP stream, custom) */
     connection?: ConnectConnectionAdapter;
     /** Direct async function for summarization */

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

@@ -6,7 +6,7 @@ import type { AIDevtoolsDisplayOptions, ConnectConnectionAdapter, GenerationClie
  *
  * @template TOutput - The output type after optional transform (defaults to TranscriptionResult)
  */
-export interface CreateTranscriptionOptions<TOutput = TranscriptionResult> extends Pick<CreateGenerationOptions<TranscriptionGenerateInput, TranscriptionResult, TOutput>, 'persistence' | 'threadId' | 'hydrateGeneration' | 'joinRun'> {
+export interface CreateTranscriptionOptions<TOutput = TranscriptionResult> extends Pick<CreateGenerationOptions<TranscriptionGenerateInput, TranscriptionResult, TOutput>, 'persistence' | 'threadId' | 'hydrateGeneration' | 'joinRun' | 'byok' | 'byokProvider'> {
     /** Connect-based adapter for streaming transport (SSE, HTTP stream, custom) */
     connection?: ConnectConnectionAdapter;
     /** Direct async function for transcription */

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { createChat } from './create-chat.svelte';
+export { createByok } from './create-byok.svelte';
 export type { CreateChatOptions, CreateChatReturn, DeepPartial, UIMessage, ChatRequestBody, QueuedMessage, SendMessageOptions, WhenBusy, QueueConfig, QueueStrategy, QueueOption, } from './types';
 export { createGeneration } from './create-generation.svelte';
 export type { CreateGenerationOptions, CreateGenerationReturn, } from './create-generation.svelte';

package/dist/index.js

@@ -1,4 +1,5 @@
 export { createChat } from './create-chat.svelte';
+export { createByok } from './create-byok.svelte';
 // Generation hooks
 export { createGeneration } from './create-generation.svelte';
 export { createGenerateImage } from './create-generate-image.svelte';

package/dist/types.d.ts

@@ -69,6 +69,8 @@ interface BaseCreateChatReturn<TTools extends ReadonlyArray<AnyClientTool> = any
     /**
      * Send a message and get a response.
      * Can be a simple string or multimodal content with images, audio, etc.
+     * Pass `{ whenBusy }` to override the queue policy for a single send, or
+     * `{ body }` to merge per-call JSON into this request's `forwardedProps`.
      */
     sendMessage: (content: string | MultimodalContent, options?: SendMessageOptions) => Promise<void>;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/ai-svelte",
-  "version": "0.18.3",
+  "version": "0.19.1",
   "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.26.0"
+    "@tanstack/ai-client": "^0.28.0"
   },
   "peerDependencies": {
     "svelte": "^5.0.0",
-    "@tanstack/ai": "^0.48.0"
+    "@tanstack/ai": "^0.49.1"
   },
   "devDependencies": {
     "@standard-schema/spec": "^1.1.0",
@@ -63,7 +63,7 @@
     "svelte-check": "^4.2.0",
     "typescript": "5.9.3",
     "vite": "^8.2.1",
-    "@tanstack/ai": "0.48.0"
+    "@tanstack/ai": "0.49.1"
   },
   "scripts": {
     "clean": "rm -rf ./dist",

package/src/create-byok.svelte.ts

@@ -0,0 +1,22 @@
+import { onDestroy } from 'svelte'
+import type { ByokClient, ByokSnapshot } from '@tanstack/ai-client/byok'
+
+export function createByok(client: ByokClient): {
+  readonly snapshot: ByokSnapshot
+} {
+  let snapshot = $state(client.getSnapshot())
+  const unsubscribe = client.subscribe(() => {
+    snapshot = client.getSnapshot()
+  })
+  try {
+    onDestroy(unsubscribe)
+  } catch {
+    // Svelte lifecycle hooks are only valid during component initialization.
+  }
+
+  return {
+    get snapshot() {
+      return snapshot
+    },
+  }
+}

package/src/create-chat.svelte.ts

@@ -134,6 +134,8 @@ export function createChat<
     ...(options.forwardedProps !== undefined && {
       forwardedProps: options.forwardedProps,
     }),
+    ...(options.byok !== undefined && { byok: options.byok }),
+    byokProvider: () => options.byokProvider?.(),
     ...(options.context !== undefined && { context: options.context }),
     devtools: {
       ...options.devtools,

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

@@ -24,7 +24,12 @@ export interface CreateGenerateAudioOptions<
   TOutput = AudioGenerationResult,
 > extends Pick<
   CreateGenerationOptions<AudioGenerateInput, AudioGenerationResult, TOutput>,
-  'persistence' | 'threadId' | 'hydrateGeneration' | 'joinRun'
+  | 'persistence'
+  | 'threadId'
+  | 'hydrateGeneration'
+  | 'joinRun'
+  | 'byok'
+  | 'byokProvider'
 > {
   /** Connect-based adapter for streaming transport (SSE, HTTP stream, custom) */
   connection?: ConnectConnectionAdapter

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

@@ -24,7 +24,12 @@ export interface CreateGenerateImageOptions<
   TOutput = ImageGenerationResult,
 > extends Pick<
   CreateGenerationOptions<ImageGenerateInput, ImageGenerationResult, TOutput>,
-  'persistence' | 'threadId' | 'hydrateGeneration' | 'joinRun'
+  | 'persistence'
+  | 'threadId'
+  | 'hydrateGeneration'
+  | 'joinRun'
+  | 'byok'
+  | 'byokProvider'
 > {
   /** Connect-based adapter for streaming transport (SSE, HTTP stream, custom) */
   connection?: ConnectConnectionAdapter

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

@@ -22,7 +22,12 @@ import type {
  */
 export interface CreateGenerateSpeechOptions<TOutput = TTSResult> extends Pick<
   CreateGenerationOptions<SpeechGenerateInput, TTSResult, TOutput>,
-  'persistence' | 'threadId' | 'hydrateGeneration' | 'joinRun'
+  | 'persistence'
+  | 'threadId'
+  | 'hydrateGeneration'
+  | 'joinRun'
+  | 'byok'
+  | 'byokProvider'
 > {
   /** Connect-based adapter for streaming transport (SSE, HTTP stream, custom) */
   connection?: ConnectConnectionAdapter

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

@@ -12,6 +12,8 @@ import type {
   VideoGenerateResult,
   VideoStatusInfo,
 } from '@tanstack/ai-client'
+import type { ByokClient } from '@tanstack/ai-client/byok'
+import type { ProviderId } from '@tanstack/ai/byok'
 
 /**
  * Options for the createGenerateVideo function.
@@ -25,6 +27,10 @@ export interface CreateGenerateVideoOptions<TOutput = VideoGenerateResult> {
   fetcher?: GenerationFetcher<VideoGenerateInput, VideoGenerateResult>
   /** Additional body parameters to send with connect-based adapter requests */
   body?: Record<string, any>
+  /** Optional BYOK keyring. Keys go in `x-byok-*` headers, never the body. */
+  byok?: ByokClient
+  /** Optional provider id. If it returns a slug, only that key is sent. If no slug resolves (`byokProvider`, then `body.provider`), generate throws. */
+  byokProvider?: () => ProviderId | undefined
   /** Display options for TanStack AI Devtools. */
   devtools?: AIDevtoolsDisplayOptions
   /**
@@ -199,6 +205,8 @@ export function createGenerateVideo<TTransformed = void>(
       hydrateGeneration: options.hydrateGeneration,
     }),
     ...(options.joinRun !== undefined && { joinRun: options.joinRun }),
+    ...(options.byok !== undefined && { byok: options.byok }),
+    byokProvider: () => options.byokProvider?.(),
     devtoolsBridgeFactory: createVideoDevtoolsBridge,
     devtools: {
       ...options.devtools,

package/src/create-generation.svelte.ts

@@ -11,6 +11,8 @@ import type {
   GenerationRestoredResult,
   InferGenerationOutputFromReturn,
 } from '@tanstack/ai-client'
+import type { ByokClient } from '@tanstack/ai-client/byok'
+import type { ProviderId } from '@tanstack/ai/byok'
 
 /**
  * Options for the createGeneration function.
@@ -28,6 +30,10 @@ export interface CreateGenerationOptions<TInput, TResult, TOutput = TResult> {
   fetcher?: GenerationFetcher<TInput, TResult>
   /** Additional body parameters to send with connect-based adapter requests */
   body?: Record<string, any>
+  /** Optional BYOK keyring. Keys go in `x-byok-*` headers, never the body. */
+  byok?: ByokClient
+  /** Optional provider id. If it returns a slug, only that key is sent. If no slug resolves (`byokProvider`, then `body.provider`), generate throws. */
+  byokProvider?: () => ProviderId | undefined
   /** Display options for TanStack AI Devtools. */
   devtools?: AIDevtoolsDisplayOptions
   /**
@@ -201,6 +207,8 @@ export function createGeneration<
       hydrateGeneration: options.hydrateGeneration,
     }),
     ...(options.joinRun !== undefined && { joinRun: options.joinRun }),
+    ...(options.byok !== undefined && { byok: options.byok }),
+    byokProvider: () => options.byokProvider?.(),
     ...(options.reconstructResult
       ? { reconstructResult: options.reconstructResult }
       : {}),

package/src/create-summarize.svelte.ts

@@ -24,7 +24,12 @@ export interface CreateSummarizeOptions<
   TOutput = SummarizationResult,
 > extends Pick<
   CreateGenerationOptions<SummarizeGenerateInput, SummarizationResult, TOutput>,
-  'persistence' | 'threadId' | 'hydrateGeneration' | 'joinRun'
+  | 'persistence'
+  | 'threadId'
+  | 'hydrateGeneration'
+  | 'joinRun'
+  | 'byok'
+  | 'byokProvider'
 > {
   /** Connect-based adapter for streaming transport (SSE, HTTP stream, custom) */
   connection?: ConnectConnectionAdapter

package/src/create-transcription.svelte.ts

@@ -28,7 +28,12 @@ export interface CreateTranscriptionOptions<
     TranscriptionResult,
     TOutput
   >,
-  'persistence' | 'threadId' | 'hydrateGeneration' | 'joinRun'
+  | 'persistence'
+  | 'threadId'
+  | 'hydrateGeneration'
+  | 'joinRun'
+  | 'byok'
+  | 'byokProvider'
 > {
   /** Connect-based adapter for streaming transport (SSE, HTTP stream, custom) */
   connection?: ConnectConnectionAdapter

package/src/index.ts

@@ -1,4 +1,5 @@
 export { createChat } from './create-chat.svelte'
+export { createByok } from './create-byok.svelte'
 export type {
   CreateChatOptions,
   CreateChatReturn,

package/src/types.ts

@@ -157,6 +157,8 @@ interface BaseCreateChatReturn<
   /**
    * Send a message and get a response.
    * Can be a simple string or multimodal content with images, audio, etc.
+   * Pass `{ whenBusy }` to override the queue policy for a single send, or
+   * `{ body }` to merge per-call JSON into this request's `forwardedProps`.
    */
   sendMessage: (
     content: string | MultimodalContent,