@tanstack/ai 0.23.0 → 0.24.0

package/README.md

@@ -186,7 +186,7 @@ Official adapters include:
 
 | Package                                                                              | Use it for                                                                     |
 | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
-| [`@tanstack/ai-openrouter`](https://tanstack.com/ai/latest/docs/adapters/openrouter) | 300+ models through one OpenRouter API                                         |
+| [`@tanstack/ai-openrouter`](https://tanstack.com/ai/latest/docs/adapters/openrouter) | 300+ models through one OpenRouter API, with per-request cost tracking         |
 | [`@tanstack/ai-openai`](https://tanstack.com/ai/latest/docs/adapters/openai)         | OpenAI chat, image, video, speech, transcription, realtime, and provider tools |
 | [`@tanstack/ai-anthropic`](https://tanstack.com/ai/latest/docs/adapters/anthropic)   | Anthropic Claude chat, thinking, tools, and structured outputs                 |
 | [`@tanstack/ai-gemini`](https://tanstack.com/ai/latest/docs/adapters/gemini)         | Google Gemini chat, image, speech, and audio generation                        |

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

@@ -1,11 +1,36 @@
 import { AnyTextAdapter } from './adapter.js';
-import { ConstrainedModelMessage, InferSchemaType, ModelMessage, SchemaInput, StreamChunk, StructuredOutputStream, TextOptions, Tool, UIMessage } from '../../types.js';
+import { AnyTool, ConstrainedModelMessage, InferSchemaType, ModelMessage, SchemaInput, StreamChunk, StructuredOutputStream, TextOptions, UIMessage } from '../../types.js';
 import { ChatMiddleware } from './middleware/types.js';
 import { SystemPrompt } from '../../system-prompts.js';
 import { DebugOption } from '../../logger/types.js';
 import { ProviderTool } from '../../tools/provider-tool.js';
+import { ContextFromMiddleware, ContextFromTool, DefinedContext, MergeContext, UnionToIntersection } from './runtime-context-types.js';
 /** The adapter kind this activity handles */
 export declare const kind: "text";
+type AnyRuntimeTool = AnyTool;
+type ContextFromConsumer<T> = ContextFromTool<T> | ContextFromMiddleware<T>;
+type RequiredContextFromConsumerUnion<T> = T extends unknown ? undefined extends ContextFromConsumer<T> ? never : ContextFromConsumer<T> : never;
+type ContextFromConsumerUnion<T> = [
+    UnionToIntersection<DefinedContext<ContextFromConsumer<T>>>
+] extends [never] ? never : [RequiredContextFromConsumerUnion<T>] extends [never] ? UnionToIntersection<DefinedContext<ContextFromConsumer<T>>> | undefined : UnionToIntersection<DefinedContext<ContextFromConsumer<T>>>;
+type ContextFromArray<T> = T extends readonly [infer THead, ...infer TTail] ? MergeContext<ContextFromConsumer<THead>, ContextFromArray<TTail>> : T extends ReadonlyArray<infer TItem> ? ContextFromConsumerUnion<TItem> : never;
+type ContextFromInputs<TTools, TMiddleware> = MergeContext<ContextFromArray<NonNullable<TTools>>, ContextFromArray<NonNullable<TMiddleware>>>;
+type InferredContext<TTools, TMiddleware> = [
+    ContextFromInputs<TTools, TMiddleware>
+] extends [never] ? unknown : ContextFromInputs<TTools, TMiddleware>;
+type RequiredContextFromInputs<TTools, TMiddleware> = [
+    ContextFromInputs<TTools, TMiddleware>
+] extends [never] ? {
+    context?: unknown;
+} : undefined extends ContextFromInputs<TTools, TMiddleware> ? {
+    context?: ContextFromInputs<TTools, TMiddleware>;
+} : {
+    context: ContextFromInputs<TTools, TMiddleware>;
+};
+type TextActivityOptionsWithContext<TAdapter extends AnyTextAdapter, TSchema extends SchemaInput | undefined, TStream extends boolean, TTools extends TextActivityOptions<TAdapter, TSchema, TStream, any>['tools'], TMiddleware extends TextActivityOptions<TAdapter, TSchema, TStream, any>['middleware']> = Omit<TextActivityOptions<TAdapter, TSchema, TStream, any>, 'tools' | 'middleware' | 'context'> & {
+    tools?: TTools;
+    middleware?: TMiddleware;
+} & RequiredContextFromInputs<TTools, TMiddleware>;
 /**
  * Options for the text activity.
  * Types are extracted directly from the adapter (which has pre-resolved generics).
@@ -14,7 +39,7 @@ export declare const kind: "text";
  * @template TSchema - Optional Standard Schema for structured output
  * @template TStream - Whether to stream the output (default: true)
  */
-export interface TextActivityOptions<TAdapter extends AnyTextAdapter, TSchema extends SchemaInput | undefined, TStream extends boolean> {
+export interface TextActivityOptions<TAdapter extends AnyTextAdapter, TSchema extends SchemaInput | undefined, TStream extends boolean, TContext = unknown> {
     /** The text adapter to use (created by a provider function like openaiText('gpt-4o')) */
     adapter: TAdapter;
     /**
@@ -49,7 +74,7 @@ export interface TextActivityOptions<TAdapter extends AnyTextAdapter, TSchema ex
      *    `supports.tools` list. Passing an unsupported tool produces a
      *    compile-time error on the array element.
      */
-    tools?: Array<(Tool & {
+    tools?: Array<(AnyRuntimeTool & {
         readonly '~toolKind'?: never;
     }) | ProviderTool<string, TAdapter['~types']['toolCapabilities'][number]>> | undefined;
     /** Controls the randomness of the output. Higher values make output more random. Range: [0.0, 2.0] */
@@ -127,12 +152,11 @@ export interface TextActivityOptions<TAdapter extends AnyTextAdapter, TSchema ex
      * })
      * ```
      */
-    middleware?: Array<ChatMiddleware>;
+    middleware?: Array<ChatMiddleware<TContext>>;
     /**
-     * Opaque user-provided context value passed to middleware hooks.
-     * Can be used to pass request-scoped data (e.g., user ID, request context).
+     * Runtime context value passed to middleware hooks and server tools.
      */
-    context?: unknown;
+    context?: TContext;
     /**
      * Enable debug logging. Pass `true` to enable all categories with the default
      * console logger, `false` to silence everything, or a `DebugConfig` object for
@@ -154,7 +178,7 @@ export interface TextActivityOptions<TAdapter extends AnyTextAdapter, TSchema ex
  * const stream = chat({ ...chatOptions, messages })
  * ```
  */
-export declare function createChatOptions<TAdapter extends AnyTextAdapter, TSchema extends SchemaInput | undefined = undefined, TStream extends boolean = true>(options: TextActivityOptions<TAdapter, TSchema, TStream>): TextActivityOptions<TAdapter, TSchema, TStream>;
+export declare function createChatOptions<TAdapter extends AnyTextAdapter, TSchema extends SchemaInput | undefined = undefined, TStream extends boolean = true, const TTools extends TextActivityOptions<TAdapter, TSchema, TStream, any>['tools'] = TextActivityOptions<TAdapter, TSchema, TStream, any>['tools'], const TMiddleware extends TextActivityOptions<TAdapter, TSchema, TStream, any>['middleware'] = TextActivityOptions<TAdapter, TSchema, TStream, any>['middleware']>(options: TextActivityOptionsWithContext<TAdapter, TSchema, TStream, TTools, TMiddleware>): TextActivityOptions<TAdapter, TSchema, TStream, InferredContext<TTools, TMiddleware>>;
 /**
  * Result type for the text activity.
  * - If outputSchema is provided AND stream is explicitly true:
@@ -233,6 +257,6 @@ export type TextActivityResult<TSchema extends SchemaInput | undefined, TStream
  * // result is { summary: string, keyPoints: string[] }
  * ```
  */
-export declare function chat<TAdapter extends AnyTextAdapter, TSchema extends SchemaInput | undefined = undefined, TStream extends boolean = boolean>(options: TextActivityOptions<TAdapter, TSchema, TStream>): TextActivityResult<TSchema, TStream>;
+export declare function chat<TAdapter extends AnyTextAdapter, TSchema extends SchemaInput | undefined = undefined, TStream extends boolean = boolean, const TTools extends TextActivityOptions<TAdapter, TSchema, TStream, any>['tools'] = TextActivityOptions<TAdapter, TSchema, TStream, any>['tools'], const TMiddleware extends TextActivityOptions<TAdapter, TSchema, TStream, any>['middleware'] = TextActivityOptions<TAdapter, TSchema, TStream, any>['middleware']>(options: TextActivityOptionsWithContext<TAdapter, TSchema, TStream, TTools, TMiddleware>): TextActivityResult<TSchema, TStream>;
 export type { TextAdapter, TextAdapterConfig, StructuredOutputOptions, StructuredOutputResult, } from './adapter.js';
 export { BaseTextAdapter } from './adapter.js';

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

@@ -2,6 +2,7 @@ import { devtoolsMiddleware } from "@tanstack/ai-event-client";
 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";
@@ -567,7 +568,8 @@ class TextEngine {
             info
           );
         }
-      }
+      },
+      this.middlewareCtx.context
     );
     const executionResult = yield* this.drainToolCallGenerator(generator);
     if (this.isMiddlewareAborted()) {
@@ -697,7 +699,8 @@ class TextEngine {
             info
           );
         }
-      }
+      },
+      this.middlewareCtx.context
     );
     const executionResult = yield* this.drainToolCallGenerator(generator);
     this.middlewareCtx.phase = "afterTools";
@@ -798,10 +801,14 @@ class TextEngine {
     for (const message of this.messages) {
       if (message.role === "tool" && message.toolCallId) {
         let output;
-        try {
-          output = JSON.parse(message.content);
-        } catch {
+        if (Array.isArray(message.content)) {
           output = message.content;
+        } else {
+          try {
+            output = JSON.parse(message.content);
+          } catch {
+            output = message.content;
+          }
         }
         if (output && typeof output === "object" && output.pendingExecution === true) {
           continue;
@@ -852,7 +859,8 @@ class TextEngine {
   buildToolResultChunks(results, finishEvent, argsMap) {
     const chunks = [];
     for (const result of results) {
-      const content = JSON.stringify(result.result);
+      const content = normalizeToolResult(result.result);
+      const wireContent = typeof content === "string" ? content : JSON.stringify(content);
       if (argsMap) {
         chunks.push({
           type: "TOOL_CALL_START",
@@ -879,7 +887,8 @@ class TextEngine {
         toolCallId: result.toolCallId,
         toolCallName: result.toolName,
         toolName: result.toolName,
-        result: content
+        result: wireContent,
+        ...result.state !== void 0 && { state: result.state }
       });
       chunks.push({
         type: "TOOL_CALL_RESULT",
@@ -887,8 +896,9 @@ class TextEngine {
         model: finishEvent.model,
         messageId: this.createId("tool-result"),
         toolCallId: result.toolCallId,
-        content,
-        role: "tool"
+        content: wireContent,
+        role: "tool",
+        ...result.state !== void 0 && { state: result.state }
       });
       const placeholderIdx = this.messages.findIndex((m) => {
         if (m.role !== "tool" || m.toolCallId !== result.toolCallId) {