@tanstack/ai 0.17.0 → 0.19.0

package/README.md

@@ -49,10 +49,6 @@ A powerful, type-safe AI SDK for building AI-powered applications.
 
 ### <a href="https://tanstack.com/ai">Read the docs →</a>
 
-## Requirements
-
-- **Node.js v24+** is required to avoid compatibility issues with `isolated-vm`.
-
 ## Tree-Shakeable Adapters
 
 Import only the functionality you need for smaller bundle sizes:

package/dist/esm/activities/chat/index.d.ts

@@ -1,5 +1,5 @@
 import { AnyTextAdapter } from './adapter.js';
-import { ConstrainedModelMessage, InferSchemaType, SchemaInput, StreamChunk, StructuredOutputStream, TextOptions, Tool } from '../../types.js';
+import { ConstrainedModelMessage, InferSchemaType, ModelMessage, SchemaInput, StreamChunk, StructuredOutputStream, TextOptions, Tool, UIMessage } from '../../types.js';
 import { ChatMiddleware } from './middleware/types.js';
 import { DebugOption } from '../../logger/types.js';
 import { ProviderTool } from '../../tools/provider-tool.js';
@@ -16,8 +16,15 @@ export declare const kind: "text";
 export interface TextActivityOptions<TAdapter extends AnyTextAdapter, TSchema extends SchemaInput | undefined, TStream extends boolean> {
     /** The text adapter to use (created by a provider function like openaiText('gpt-4o')) */
     adapter: TAdapter;
-    /** Conversation messages - content types are constrained by the adapter's input modalities and metadata */
-    messages?: Array<ConstrainedModelMessage<{
+    /**
+     * Conversation messages. Accepts:
+     * - `ConstrainedModelMessage` — content types constrained by the adapter's input modalities.
+     * - `ModelMessage` — unconstrained model message (e.g., forwarded from an AG-UI wire payload).
+     * - `UIMessage` — parts-based UI representation; converted internally via `convertMessagesToModelMessages`.
+     *
+     * The three shapes can be mixed in a single array (e.g., when forwarding a wire payload that includes both anchor UIMessages and AG-UI fan-out ModelMessages).
+     */
+    messages?: Array<UIMessage | ModelMessage | ConstrainedModelMessage<{
         inputModalities: TAdapter['~types']['inputModalities'];
         messageMetadataByModality: TAdapter['~types']['messageMetadataByModality'];
     }>>;
@@ -56,6 +63,8 @@ export interface TextActivityOptions<TAdapter extends AnyTextAdapter, TSchema ex
     threadId?: TextOptions['threadId'];
     /** Run ID override for AG-UI protocol. Auto-generated by adapter if not provided. */
     runId?: TextOptions['runId'];
+    /** Parent run ID for AG-UI protocol nested run correlation. */
+    parentRunId?: TextOptions['parentRunId'];
     /**
      * Optional Standard Schema for structured output.
      * When provided, the activity will:

package/dist/esm/activities/chat/index.js

@@ -6,7 +6,7 @@ import { LazyToolManager } from "./tools/lazy-tool-manager.js";
 import { ToolCallManager, MiddlewareAbortError, executeToolCalls } from "./tools/tool-calls.js";
 import { convertSchemaToJsonSchema, isStandardSchema, parseWithStandardSchema } from "./tools/schema-converter.js";
 import { maxIterations } from "./agent-loop-strategies.js";
-import { convertMessagesToModelMessages } from "./messages.js";
+import { convertMessagesToModelMessages, generateMessageId } from "./messages.js";
 import { MiddlewareRunner } from "./middleware/compose.js";
 import { EventType } from "@ag-ui/core";
 const kind = "text";
@@ -54,8 +54,9 @@ class TextEngine {
     this.streamId = this.createId("stream");
     this.effectiveRequest = config.params.abortController ? { signal: config.params.abortController.signal } : void 0;
     this.effectiveSignal = config.params.abortController?.signal;
-    this.threadId = config.params.threadId || this.createId("thread");
+    this.threadId = config.params.threadId || config.params.conversationId || this.createId("thread");
     this.runIdOverride = config.params.runId;
+    this.parentRunIdOverride = config.params.parentRunId;
     const allMiddleware = [
       devtoolsMiddleware(),
       ...config.middleware || [],
@@ -66,7 +67,10 @@ class TextEngine {
     this.middlewareCtx = {
       requestId: this.requestId,
       streamId: this.streamId,
-      conversationId: config.params.conversationId,
+      threadId: this.threadId,
+      // Legacy alias kept on the ctx so middleware that reads
+      // `ctx.conversationId` keeps working. Always equals `threadId`.
+      conversationId: this.threadId,
       phase: "init",
       iteration: 0,
       chunkIndex: 0,
@@ -111,7 +115,7 @@ class TextEngine {
   async *run() {
     this.beforeRun();
     this.logger.agentLoop("run started", {
-      conversationId: this.middlewareCtx.conversationId
+      threadId: this.middlewareCtx.threadId
     });
     try {
       this.middlewareCtx.phase = "init";
@@ -173,7 +177,7 @@ class TextEngine {
         } else {
           this.logger.errors("chat run failed", {
             error,
-            conversationId: this.middlewareCtx.conversationId
+            threadId: this.middlewareCtx.threadId
           });
           await this.middlewareRunner.runOnError(this.middlewareCtx, {
             error,
@@ -269,7 +273,8 @@ class TextEngine {
       systemPrompts: this.systemPrompts,
       logger: this.logger,
       threadId: this.threadId,
-      runId: this.runIdOverride
+      runId: this.runIdOverride,
+      parentRunId: this.parentRunIdOverride
     })) {
       if (this.isCancelled()) {
         break;
@@ -1189,7 +1194,57 @@ async function* runStreamingStructuredOutputImpl(options, jsonSchema) {
     chatOptions: structuredChatOptions,
     outputSchema: jsonSchema
   });
+  let structuredMessageId = null;
+  let startEmitted = false;
+  const extractMessageId = (c) => {
+    const id = c.messageId;
+    return typeof id === "string" && id !== "" ? id : null;
+  };
+  const emitStartIfNeeded = function* (referenceChunk) {
+    if (startEmitted) return;
+    const idForStart = structuredMessageId ?? generateMessageId();
+    structuredMessageId = idForStart;
+    startEmitted = true;
+    yield {
+      type: EventType.CUSTOM,
+      name: "structured-output.start",
+      value: { messageId: idForStart },
+      model: "model" in referenceChunk ? referenceChunk.model ?? model : model,
+      timestamp: "timestamp" in referenceChunk ? referenceChunk.timestamp ?? Date.now() : Date.now(),
+      runId
+    };
+  };
   for await (const chunk of stream) {
+    if (!structuredMessageId) {
+      if (chunk.type === EventType.TEXT_MESSAGE_START || chunk.type === EventType.TEXT_MESSAGE_CONTENT) {
+        structuredMessageId = extractMessageId(chunk);
+      }
+    }
+    if (chunk.type === EventType.RUN_ERROR && !startEmitted) {
+      yield* emitStartIfNeeded(chunk);
+    }
+    if (!structuredMessageId && chunk.type === EventType.TEXT_MESSAGE_CONTENT) {
+      yield {
+        type: EventType.RUN_ERROR,
+        runId,
+        model,
+        timestamp: Date.now(),
+        message: "Structured-output stream produced text content without a messageId; adapter is not honoring the AG-UI contract.",
+        code: "structured-output-missing-message-id"
+      };
+      return;
+    }
+    if (!startEmitted && structuredMessageId && (chunk.type === EventType.TEXT_MESSAGE_START || chunk.type === EventType.TEXT_MESSAGE_CONTENT)) {
+      startEmitted = true;
+      yield {
+        type: EventType.CUSTOM,
+        name: "structured-output.start",
+        value: { messageId: structuredMessageId },
+        model: "model" in chunk ? chunk.model ?? model : model,
+        timestamp: "timestamp" in chunk ? chunk.timestamp ?? Date.now() : Date.now(),
+        runId
+      };
+    }
     if (chunk.type === EventType.CUSTOM && chunk.name === "structured-output.complete") {
       const value = chunk.value;
       if (isStandardSchema(outputSchema)) {
@@ -1202,10 +1257,13 @@ async function* runStreamingStructuredOutputImpl(options, jsonSchema) {
             ...chunk,
             // Forward `reasoning` through schema validation so consumers that
             // only listen for the terminal event don't lose chain-of-thought.
+            // Tag with messageId so the client processor can snap the right
+            // assistant message's structured-output part.
             value: {
               object: validated,
               raw: value.raw,
-              ...value.reasoning ? { reasoning: value.reasoning } : {}
+              ...value.reasoning ? { reasoning: value.reasoning } : {},
+              ...structuredMessageId ? { messageId: structuredMessageId } : {}
             }
           };
           continue;
@@ -1237,6 +1295,16 @@ async function* runStreamingStructuredOutputImpl(options, jsonSchema) {
           return;
         }
       }
+      if (structuredMessageId) {
+        yield {
+          ...chunk,
+          value: {
+            ...chunk.value,
+            messageId: structuredMessageId
+          }
+        };
+        continue;
+      }
       yield chunk;
       continue;
     }