@tanstack/ai 0.32.0 → 0.34.0

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

@@ -1,11 +1,12 @@
 import { devtoolsMiddleware } from "@tanstack/ai-event-client";
+import { undoNullWidening } from "@tanstack/ai-utils";
 import { stripToSpecMiddleware } from "../../strip-to-spec-middleware.js";
 import { streamToText } from "../../stream-to-response.js";
 import { resolveDebugOption } from "../../logger/resolve.js";
 import { normalizeToolResult } from "../../utilities/tool-result.js";
 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 { convertSchemaForStructuredOutput, isStandardSchema, parseWithStandardSchema, convertSchemaToJsonSchema } from "./tools/schema-converter.js";
 import { maxIterations } from "./agent-loop-strategies.js";
 import { convertMessagesToModelMessages, generateMessageId } from "./messages.js";
 import { MiddlewareRunner } from "./middleware/compose.js";
@@ -90,8 +91,8 @@ class TextEngine {
   // to carry, so the client matches it to the streaming text deltas.
   combinedStructuredMessageId = null;
   // Holds the validated value when `finalStructuredOutput.validate` is provided
-  // and succeeds. Distinct from `structuredOutputResult.data` (the raw,
-  // unvalidated payload from the structured-output.complete chunk).
+  // and succeeds. Distinct from `structuredOutputResult.data` (the normalized
+  // but unvalidated payload from the structured-output.complete chunk).
   validatedStructuredOutput = void 0;
   hasValidatedStructuredOutput = false;
   finalizationError = null;
@@ -155,6 +156,7 @@ class TextEngine {
         this.deferredPromises.push(promise);
       },
       // Provider / adapter info
+      activity: "chat",
       provider: config.adapter.name,
       model: config.params.model,
       source: "server",
@@ -525,6 +527,20 @@ class TextEngine {
       this.currentThinkingSignature = chunk.signature;
     }
   }
+  /**
+   * Tools available for execution this turn. The discovery tool is dropped
+   * from the advertised set (`this.tools`) once every lazy tool is discovered,
+   * but a model may still re-request discovery; this widens execution lookup
+   * to include it so such calls don't fail with "Unknown tool". Centralised so
+   * both execution sites (`processToolCalls` and `checkForPendingToolCalls`)
+   * stay in sync.
+   */
+  resolveExecutableTools(toolCalls) {
+    return this.lazyToolManager.getExecutableTools(
+      this.tools,
+      toolCalls.map((tc) => tc.function.name)
+    );
+  }
   async *checkForPendingToolCalls() {
     const pendingToolCalls = this.getPendingToolCallsFromMessages();
     if (pendingToolCalls.length === 0) {
@@ -562,7 +578,7 @@ class TextEngine {
     const { approvals, clientToolResults } = this.collectClientState();
     const generator = executeToolCalls(
       executablePendingCalls,
-      this.tools,
+      this.resolveExecutableTools(executablePendingCalls),
       approvals,
       clientToolResults,
       (eventName, data) => this.createCustomEventChunk(eventName, data),
@@ -694,7 +710,7 @@ class TextEngine {
     const { approvals, clientToolResults } = this.collectClientState();
     const generator = executeToolCalls(
       executableToolCalls,
-      this.tools,
+      this.resolveExecutableTools(executableToolCalls),
       approvals,
       clientToolResults,
       (eventName, data) => this.createCustomEventChunk(eventName, data),
@@ -1125,13 +1141,16 @@ class TextEngine {
           }
         }
       }
+      let outboundChunk = chunk;
       if (chunk.type === EventType.CUSTOM && chunk.name === "structured-output.complete") {
         const parsed = readStructuredOutputCompleteValue(chunk.value);
         if (parsed) {
-          this.structuredOutputResult = {
-            data: parsed.object,
-            rawText: parsed.raw
-          };
+          const object = this.finalStructuredOutput.normalize ? this.finalStructuredOutput.normalize(parsed.object) : parsed.object;
+          this.structuredOutputResult = { data: object, rawText: parsed.raw };
+          const value = chunk.value;
+          if (object !== parsed.object && value && typeof value === "object") {
+            outboundChunk = { ...chunk, value: { ...value, object } };
+          }
         }
       }
       if (chunk.type === EventType.RUN_FINISHED && chunk.usage) {
@@ -1146,7 +1165,7 @@ class TextEngine {
       }
       const outputChunks = await this.middlewareRunner.runOnChunk(
         this.middlewareCtx,
-        chunk
+        outboundChunk
       );
       if (this.finalStructuredOutput.yieldChunks) {
         for (const outputChunk of outputChunks) {
@@ -1252,7 +1271,8 @@ class TextEngine {
     } else {
       try {
         const parsed = JSON.parse(rawText);
-        this.structuredOutputResult = { data: parsed, rawText };
+        const data = this.finalStructuredOutput.normalize ? this.finalStructuredOutput.normalize(parsed) : parsed;
+        this.structuredOutputResult = { data, rawText };
       } catch (err) {
         const detail = rawText.slice(0, 200) + (rawText.length > 200 ? "..." : "");
         this.finalizationError = {
@@ -1493,12 +1513,11 @@ async function runAgenticStructuredOutput(options) {
   if (!outputSchema) {
     throw new Error("outputSchema is required for structured output");
   }
-  const jsonSchema = convertSchemaToJsonSchema(outputSchema, {
-    forStructuredOutput: true
-  });
+  const { jsonSchema, nullWideningMap } = convertSchemaForStructuredOutput(outputSchema);
   if (!jsonSchema) {
     throw new Error("Failed to convert output schema to JSON Schema");
   }
+  const normalize = (data) => undoNullWidening(data, nullWideningMap);
   const validate = isStandardSchema(outputSchema) ? (data) => parseWithStandardSchema(outputSchema, data) : void 0;
   const nativeCombined = adapter.supportsCombinedToolsAndSchema?.(options.modelOptions) === true;
   const mcpManager = MCPManager.from(mcp);
@@ -1515,6 +1534,7 @@ async function runAgenticStructuredOutput(options) {
       finalStructuredOutput: {
         jsonSchema,
         yieldChunks: false,
+        normalize,
         ...validate ? { validate } : {},
         ...nativeCombined ? { nativeCombined: true } : {}
       }
@@ -1629,7 +1649,13 @@ async function* fallbackStructuredOutputStream(adapter, options, onAdapterError)
     threadId,
     model,
     timestamp,
-    finishReason: "stop"
+    finishReason: "stop",
+    // Forward adapter-reported token usage so consumers reading
+    // `RUN_FINISHED.usage` (and the engine's `runOnUsage` middleware hook) see
+    // it on the fallback path, mirroring the native streaming path. The
+    // conditional spread avoids emitting `usage: undefined` for adapters that
+    // don't report it. See #758.
+    ...result.usage ? { usage: result.usage } : {}
   };
 }
 function runStreamingStructuredOutput(options) {
@@ -1637,18 +1663,18 @@ function runStreamingStructuredOutput(options) {
   if (!outputSchema) {
     throw new Error("outputSchema is required for streaming structured output");
   }
-  const jsonSchema = convertSchemaToJsonSchema(outputSchema, {
-    forStructuredOutput: true
-  });
+  const { jsonSchema, nullWideningMap } = convertSchemaForStructuredOutput(outputSchema);
   if (!jsonSchema) {
     throw new Error("Failed to convert output schema to JSON Schema");
   }
+  const normalize = (data) => undoNullWidening(data, nullWideningMap);
   return runStreamingStructuredOutputImpl(
     options,
-    jsonSchema
+    jsonSchema,
+    normalize
   );
 }
-async function* runStreamingStructuredOutputImpl(options, jsonSchema) {
+async function* runStreamingStructuredOutputImpl(options, jsonSchema, normalize) {
   const {
     adapter,
     outputSchema,
@@ -1675,6 +1701,7 @@ async function* runStreamingStructuredOutputImpl(options, jsonSchema) {
       finalStructuredOutput: {
         jsonSchema,
         yieldChunks: true,
+        normalize,
         ...nativeCombined ? { nativeCombined: true } : {}
       }
     },