@tanstack/ai-client 0.6.0 → 0.7.2

package/src/connection-adapters.ts

@@ -62,15 +62,9 @@ async function* readStreamLines(
   }
 }
 
-/**
- * Connection adapter interface - converts a connection into a stream of chunks
- */
-export interface ConnectionAdapter {
+export interface ConnectConnectionAdapter {
   /**
-   * Connect and return an async iterable of StreamChunks
-   * @param messages - The messages to send (UIMessages or ModelMessages)
-   * @param data - Additional data to send
-   * @param abortSignal - Optional abort signal for request cancellation
+   * Connect and return an async iterable of StreamChunks.
    */
   connect: (
     messages: Array<UIMessage> | Array<ModelMessage>,
@@ -79,6 +73,147 @@ export interface ConnectionAdapter {
   ) => AsyncIterable<StreamChunk>
 }
 
+export interface SubscribeConnectionAdapter {
+  /**
+   * Subscribe to stream chunks.
+   */
+  subscribe: (abortSignal?: AbortSignal) => AsyncIterable<StreamChunk>
+  /**
+   * Send a request; chunks arrive through subscribe().
+   */
+  send: (
+    messages: Array<UIMessage> | Array<ModelMessage>,
+    data?: Record<string, any>,
+    abortSignal?: AbortSignal,
+  ) => Promise<void>
+}
+
+/**
+ * Connection adapter union.
+ * Provide either `connect`, or `subscribe` + `send`.
+ */
+export type ConnectionAdapter =
+  | ConnectConnectionAdapter
+  | SubscribeConnectionAdapter
+
+/**
+ * Normalize a ConnectionAdapter to subscribe/send operations.
+ *
+ * If a connection provides native subscribe/send, that mode is used.
+ * Otherwise, connect() is wrapped using an async queue.
+ */
+export function normalizeConnectionAdapter(
+  connection: ConnectionAdapter | undefined,
+): SubscribeConnectionAdapter {
+  if (!connection) {
+    throw new Error('Connection adapter is required')
+  }
+
+  const hasConnect = 'connect' in connection
+  const hasSubscribe = 'subscribe' in connection
+  const hasSend = 'send' in connection
+
+  if (hasConnect && (hasSubscribe || hasSend)) {
+    throw new Error(
+      'Connection adapter must provide either connect or both subscribe and send, not both modes',
+    )
+  }
+
+  if (hasSubscribe && hasSend) {
+    return {
+      subscribe: connection.subscribe.bind(connection),
+      send: connection.send.bind(connection),
+    }
+  }
+
+  if (!hasConnect) {
+    throw new Error(
+      'Connection adapter must provide either connect or both subscribe and send',
+    )
+  }
+
+  // Legacy connect() wrapper
+  let activeBuffer: Array<StreamChunk> = []
+  let activeWaiters: Array<(chunk: StreamChunk | null) => void> = []
+
+  function push(chunk: StreamChunk): void {
+    const waiter = activeWaiters.shift()
+    if (waiter) {
+      waiter(chunk)
+    } else {
+      activeBuffer.push(chunk)
+    }
+  }
+
+  return {
+    subscribe(abortSignal?: AbortSignal): AsyncIterable<StreamChunk> {
+      // Transfer ownership to the latest subscriber so only one active
+      // subscribe() call receives chunks from the shared connect-wrapper queue.
+      const myBuffer: Array<StreamChunk> = activeBuffer.splice(0)
+      const myWaiters: Array<(chunk: StreamChunk | null) => void> = []
+      activeBuffer = myBuffer
+      activeWaiters = myWaiters
+
+      return (async function* () {
+        while (!abortSignal?.aborted) {
+          let chunk: StreamChunk | null
+          if (myBuffer.length > 0) {
+            chunk = myBuffer.shift()!
+          } else {
+            chunk = await new Promise<StreamChunk | null>((resolve) => {
+              const onAbort = () => resolve(null)
+              myWaiters.push((c) => {
+                abortSignal?.removeEventListener('abort', onAbort)
+                resolve(c)
+              })
+              abortSignal?.addEventListener('abort', onAbort, { once: true })
+            })
+          }
+          if (chunk !== null) yield chunk
+        }
+      })()
+    },
+    async send(messages, data, abortSignal) {
+      let hasTerminalEvent = false
+      try {
+        const stream = connection.connect(messages, data, abortSignal)
+        for await (const chunk of stream) {
+          if (chunk.type === 'RUN_FINISHED' || chunk.type === 'RUN_ERROR') {
+            hasTerminalEvent = true
+          }
+          push(chunk)
+        }
+
+        // If the connect stream ended cleanly without a terminal event,
+        // synthesize RUN_FINISHED so request-scoped consumers can complete.
+        if (!abortSignal?.aborted && !hasTerminalEvent) {
+          push({
+            type: 'RUN_FINISHED',
+            runId: `run-${Date.now()}`,
+            model: 'connect-wrapper',
+            timestamp: Date.now(),
+            finishReason: 'stop',
+          })
+        }
+      } catch (err) {
+        if (!abortSignal?.aborted && !hasTerminalEvent) {
+          push({
+            type: 'RUN_ERROR',
+            timestamp: Date.now(),
+            error: {
+              message:
+                err instanceof Error
+                  ? err.message
+                  : 'Unknown error in connect()',
+            },
+          })
+        }
+        throw err
+      }
+    },
+  }
+}
+
 /**
  * Options for fetch-based connection adapters
  */
@@ -129,7 +264,7 @@ export function fetchServerSentEvents(
   options:
     | FetchConnectionOptions
     | (() => FetchConnectionOptions | Promise<FetchConnectionOptions>) = {},
-): ConnectionAdapter {
+): ConnectConnectionAdapter {
   return {
     async *connect(messages, data, abortSignal) {
       // Resolve URL and options if they are functions
@@ -228,7 +363,7 @@ export function fetchHttpStream(
   options:
     | FetchConnectionOptions
     | (() => FetchConnectionOptions | Promise<FetchConnectionOptions>) = {},
-): ConnectionAdapter {
+): ConnectConnectionAdapter {
   return {
     async *connect(messages, data, abortSignal) {
       // Resolve URL and options if they are functions
@@ -301,7 +436,7 @@ export function stream(
     messages: Array<UIMessage> | Array<ModelMessage>,
     data?: Record<string, any>,
   ) => AsyncIterable<StreamChunk>,
-): ConnectionAdapter {
+): ConnectConnectionAdapter {
   return {
     async *connect(messages, data) {
       // Pass messages as-is (UIMessages with parts preserved)
@@ -332,7 +467,7 @@ export function rpcStream(
     messages: Array<UIMessage> | Array<ModelMessage>,
     data?: Record<string, any>,
   ) => AsyncIterable<StreamChunk>,
-): ConnectionAdapter {
+): ConnectConnectionAdapter {
   return {
     async *connect(messages, data) {
       // Pass messages as-is (UIMessages with parts preserved)

package/src/events.ts

@@ -1,4 +1,4 @@
-import { aiEventClient } from '@tanstack/ai/event-client'
+import { aiEventClient } from '@tanstack/ai-event-client'
 import type { ContentPart } from '@tanstack/ai'
 import type { UIMessage } from './types'
 

package/src/generation-client.ts

@@ -1,7 +1,7 @@
 import { GENERATION_EVENTS } from './generation-types'
 import { parseSSEResponse } from './sse-parser'
 import type { StreamChunk } from '@tanstack/ai'
-import type { ConnectionAdapter } from './connection-adapters'
+import type { ConnectConnectionAdapter } from './connection-adapters'
 import type {
   GenerationClientOptions,
   GenerationClientState,
@@ -27,7 +27,7 @@ interface GenerationCallbacks<TResult, TOutput> {
  * (image, speech, transcription, summarize).
  *
  * Supports two transport modes:
- * - **ConnectionAdapter** — Streaming transport (SSE, HTTP stream, custom).
+ * - **ConnectConnectionAdapter** — Streaming transport (SSE, HTTP stream, custom).
  *   Server wraps results in StreamChunk events with CUSTOM event names.
  * - **Fetcher** — Direct async function call. No streaming protocol needed.
  *
@@ -36,7 +36,7 @@ interface GenerationCallbacks<TResult, TOutput> {
  *
  * @example
  * ```typescript
- * // With ConnectionAdapter (streaming)
+ * // With streaming connection adapter
  * const client = new GenerationClient<ImageGenerateInput, ImageGenerationResult>({
  *   connection: fetchServerSentEvents('/api/generate/image'),
  *   onResultChange: setResult,
@@ -62,7 +62,7 @@ export class GenerationClient<
   TResult,
   TOutput = TResult,
 > {
-  private connection: ConnectionAdapter | undefined
+  private connection: ConnectConnectionAdapter | undefined
   private fetcher: GenerationFetcher<TInput, TResult> | undefined
   private body: Record<string, any>
   private result: TOutput | null = null
@@ -75,7 +75,7 @@ export class GenerationClient<
   constructor(
     options: GenerationClientOptions<TInput, TResult, TOutput> &
       (
-        | { connection: ConnectionAdapter; fetcher?: never }
+        | { connection: ConnectConnectionAdapter; fetcher?: never }
         | {
             fetcher: GenerationFetcher<TInput, TResult>
             connection?: never
@@ -127,7 +127,7 @@ export class GenerationClient<
           this.setStatus('success')
         }
       } else if (this.connection) {
-        // ConnectionAdapter streaming path
+        // Streaming adapter path
         const mergedData = { ...this.body, ...input }
         const stream = this.connection.connect([], mergedData, signal)
         await this.processStream(stream)
@@ -149,7 +149,7 @@ export class GenerationClient<
   }
 
   /**
-   * Process a stream of AG-UI events from the ConnectionAdapter.
+   * Process a stream of AG-UI events from the streaming connection adapter.
    */
   private async processStream(
     source: AsyncIterable<StreamChunk>,

package/src/generation-types.ts

@@ -1,5 +1,5 @@
 import type { StreamChunk } from '@tanstack/ai'
-import type { ConnectionAdapter } from './connection-adapters'
+import type { ConnectConnectionAdapter } from './connection-adapters'
 
 // ===========================
 // Inference Utilities
@@ -81,10 +81,10 @@ export type GenerationFetcher<TInput, TResult> = (
 
 /**
  * Transport configuration for generation clients.
- * Supports either a ConnectionAdapter (streaming) or a direct fetcher function.
+ * Supports either a connect-based streaming adapter or a direct fetcher function.
  */
 export type GenerationTransport<TInput, TResult> =
-  | { connection: ConnectionAdapter; fetcher?: never }
+  | { connection: ConnectConnectionAdapter; fetcher?: never }
   | { fetcher: GenerationFetcher<TInput, TResult>; connection?: never }
 
 // ===========================
@@ -103,7 +103,7 @@ export interface GenerationClientOptions<_TInput, TResult, TOutput = TResult> {
   /** Unique identifier for this generation client instance */
   id?: string
 
-  /** Additional body parameters to send with ConnectionAdapter requests */
+  /** Additional body parameters to send with connect-based adapter requests */
   body?: Record<string, any>
 
   /**
@@ -119,7 +119,7 @@ export interface GenerationClientOptions<_TInput, TResult, TOutput = TResult> {
   onError?: (error: Error) => void
   /** Callback when progress is reported (0-100) */
   onProgress?: (progress: number, message?: string) => void
-  /** Callback for each stream chunk (ConnectionAdapter mode only) */
+  /** Callback for each stream chunk (connect-based adapter mode only) */
   onChunk?: (chunk: StreamChunk) => void
 
   // Framework state callbacks (set by hooks, not users)

package/src/index.ts

@@ -1,4 +1,5 @@
 export { ChatClient } from './chat-client'
+export { RealtimeClient } from './realtime-client'
 export { GenerationClient } from './generation-client'
 export { VideoGenerationClient } from './video-generation-client'
 export type {
@@ -14,6 +15,7 @@ export type {
   ChatRequestBody,
   InferChatMessages,
   ChatClientState,
+  ConnectionStatus,
   // Multimodal content input type
   MultimodalContent,
 } from './types'
@@ -42,13 +44,22 @@ export type {
   ExtractToolOutput,
 } from './tool-types'
 export type { AnyClientTool } from '@tanstack/ai'
+export type {
+  RealtimeAdapter,
+  RealtimeConnection,
+  RealtimeClientOptions,
+  RealtimeClientState,
+  RealtimeStateChangeCallback,
+} from './realtime-types'
 export {
   fetchServerSentEvents,
   fetchHttpStream,
   stream,
   rpcStream,
+  type ConnectConnectionAdapter,
   type ConnectionAdapter,
   type FetchConnectionOptions,
+  type SubscribeConnectionAdapter,
 } from './connection-adapters'
 
 // Re-export message converters from @tanstack/ai