@tanstack/openai-base 0.10.0 → 0.10.2

package/README.md

@@ -71,7 +71,7 @@ Per-provider quirks are handled via protected hooks:
   differences (extra fields, omitted fields, alternative encodings).
 - `extractReasoning` — surface a provider's reasoning channel into the
   shared `REASONING_*` AG-UI lifecycle.
-- `transformStructuredOutput`, `makeStructuredOutputCompatible` —
+- `transformStructuredOutput`, `makeStructuredOutputCompatibleWithMap` —
   adjust structured-output handling for provider quirks (e.g. Groq's
   schema-shape requirements).
 - `processStreamChunks` — wrap the shared chunk processor for last-mile
@@ -117,5 +117,5 @@ self-hosted gateway, …), import the abstract adapters from this package
 and subclass them. The existing providers are worked examples —
 `@tanstack/ai-grok` is the simplest (xAI's API is a near-direct OpenAI
 Chat Completions clone), `@tanstack/ai-groq` shows the
-`processStreamChunks` and `makeStructuredOutputCompatible` override
+`processStreamChunks` and `makeStructuredOutputCompatibleWithMap` override
 pattern.

package/dist/esm/adapters/chat-completions-text.d.ts

@@ -1,7 +1,14 @@
 import { BaseTextAdapter, StructuredOutputOptions, StructuredOutputResult } from '@tanstack/ai/adapters';
+import { StructuredOutputCompatibility } from '../utils/schema-converter.js';
 import { default as OpenAI } from 'openai';
 import { ChatCompletionChunk, ChatCompletionContentPart, ChatCompletionCreateParamsStreaming, ChatCompletionMessageParam } from 'openai/resources/chat/completions/completions';
 import { ContentPart, DefaultMessageMetadataByModality, Modality, ModelMessage, StreamChunk, TextOptions } from '@tanstack/ai';
+type ChatStreamState = {
+    runId: string;
+    threadId: string;
+    messageId: string;
+    hasEmittedRunStarted: boolean;
+};
 /**
  * Shared implementation of the OpenAI Chat Completions API. Holds the
  * stream-accumulator + AG-UI lifecycle logic and calls the OpenAI SDK
@@ -14,6 +21,7 @@ export declare abstract class OpenAIBaseChatCompletionsTextAdapter<TModel extend
     protected client: OpenAI;
     constructor(model: TModel, name: string, client: OpenAI);
     chatStream(options: TextOptions<TProviderOptions>): AsyncIterable<StreamChunk>;
+    private handleChatStreamError;
     /**
      * Extracts a rejected tool call from a provider error. Returned calls are
      * emitted as non-executable `output-error` results so the model can repair them.
@@ -54,9 +62,16 @@ export declare abstract class OpenAIBaseChatCompletionsTextAdapter<TModel extend
      * `@openrouter/sdk`'s `RequestAbortedError`) override to extend the check.
      */
     protected isAbortError(error: unknown): boolean;
+    /**
+     * Strict conversion plus the inverse null-widening map for this request.
+     * Override this when schema conversion changes, so tool-input undo matches
+     * the wire schema.
+     */
+    protected makeStructuredOutputCompatibleWithMap(schema: Record<string, any>, originalRequired?: Array<string>): StructuredOutputCompatibility;
     /**
      * Applies provider-specific transformations for structured output compatibility.
-     * Override this in subclasses to handle provider-specific quirks.
+     * Override `makeStructuredOutputCompatibleWithMap` when you need the inverse map
+     * to match the wire schema.
      */
     protected makeStructuredOutputCompatible(schema: Record<string, any>, originalRequired?: Array<string>): Record<string, any>;
     /**
@@ -85,12 +100,7 @@ export declare abstract class OpenAIBaseChatCompletionsTextAdapter<TModel extend
      * Processes streamed chunks from the Chat Completions API and yields AG-UI events.
      * Override this in subclasses to handle provider-specific stream behavior.
      */
-    protected processStreamChunks(stream: AsyncIterable<ChatCompletionChunk>, options: TextOptions, aguiState: {
-        runId: string;
-        threadId: string;
-        messageId: string;
-        hasEmittedRunStarted: boolean;
-    }): AsyncIterable<StreamChunk>;
+    protected processStreamChunks(stream: AsyncIterable<ChatCompletionChunk>, options: TextOptions, aguiState: ChatStreamState): AsyncIterable<StreamChunk>;
     /**
      * Maps common TextOptions to Chat Completions API request format.
      * Override this in subclasses to add provider-specific options.
@@ -124,3 +134,4 @@ export declare abstract class OpenAIBaseChatCompletionsTextAdapter<TModel extend
      */
     protected extractTextContent(content: string | null | Array<ContentPart>): string;
 }
+export {};

package/dist/esm/adapters/chat-completions-text.js

@@ -1,6 +1,7 @@
-import { makeStructuredOutputCompatible } from "../utils/schema-converter.js";
+import { makeStructuredOutputCompatibleWithMap } from "../utils/schema-converter.js";
 import { buildChatCompletionsUsage } from "../usage.js";
 import { extractRequestOptions } from "../utils/request-options.js";
+import { createToolInputNormalizer } from "../utils/tool-input-normalizer.js";
 import { convertToolsToChatCompletionsFormat } from "./chat-completions-tool-converter.js";
 import { EventType, normalizeSystemPrompts } from "@tanstack/ai";
 import { toRunErrorPayload, toRunErrorRawEvent } from "@tanstack/ai/adapter-internals";
@@ -42,77 +43,80 @@ var OpenAIBaseChatCompletionsTextAdapter = class extends BaseTextAdapter {
 			}, extractRequestOptions(options.request));
 			yield* this.processStreamChunks(stream, options, aguiState);
 		} catch (error) {
-			const errorPayload = toRunErrorPayload(error, `${this.name}.chatStream failed`);
-			const rawEvent = toRunErrorRawEvent(error);
-			if (!aguiState.hasEmittedRunStarted) {
-				aguiState.hasEmittedRunStarted = true;
-				yield {
-					type: EventType.RUN_STARTED,
-					runId: aguiState.runId,
-					threadId: aguiState.threadId,
-					model: options.model,
-					timestamp: Date.now(),
-					parentRunId: options.parentRunId
-				};
-			}
-			const rejectedToolCall = this.extractRejectedToolCall(rawEvent, errorPayload.message);
-			if (rejectedToolCall) {
-				const toolCallId = generateId(this.name);
-				yield {
-					type: EventType.TOOL_CALL_START,
-					toolCallId,
-					toolCallName: rejectedToolCall.toolName,
-					toolName: rejectedToolCall.toolName,
-					parentMessageId: aguiState.messageId,
-					model: options.model,
-					timestamp: Date.now()
-				};
-				yield {
-					type: EventType.TOOL_CALL_ARGS,
-					toolCallId,
-					delta: rejectedToolCall.arguments,
-					args: rejectedToolCall.arguments,
-					model: options.model,
-					timestamp: Date.now()
-				};
-				yield {
-					type: EventType.TOOL_CALL_END,
-					toolCallId,
-					toolCallName: rejectedToolCall.toolName,
-					toolName: rejectedToolCall.toolName,
-					...rejectedToolCall.input !== void 0 && { input: rejectedToolCall.input },
-					result: JSON.stringify({ error: rejectedToolCall.error }),
-					state: "output-error",
-					model: options.model,
-					timestamp: Date.now()
-				};
-				yield {
-					type: EventType.RUN_FINISHED,
-					runId: aguiState.runId,
-					threadId: aguiState.threadId,
-					model: options.model,
-					timestamp: Date.now(),
-					finishReason: "tool_calls"
-				};
-				return;
-			}
+			yield* this.handleChatStreamError(error, options, aguiState, "chatStream");
+		}
+	}
+	async *handleChatStreamError(error, options, aguiState, source) {
+		const errorPayload = toRunErrorPayload(error, `${this.name}.${source} failed`);
+		const rawEvent = toRunErrorRawEvent(error);
+		if (!aguiState.hasEmittedRunStarted) {
+			aguiState.hasEmittedRunStarted = true;
 			yield {
-				type: EventType.RUN_ERROR,
+				type: EventType.RUN_STARTED,
+				runId: aguiState.runId,
+				threadId: aguiState.threadId,
 				model: options.model,
 				timestamp: Date.now(),
-				message: errorPayload.message,
-				code: errorPayload.code,
-				...rawEvent !== void 0 && { rawEvent },
-				error: {
-					message: errorPayload.message,
-					code: errorPayload.code
-				}
+				parentRunId: options.parentRunId
 			};
-			options.logger.errors(`${this.name}.chatStream fatal`, {
-				error: errorPayload,
-				source: `${this.name}.chatStream`
-			});
 		}
+		const rejectedToolCall = this.extractRejectedToolCall(rawEvent, errorPayload.message);
+		if (rejectedToolCall) {
+			const toolCallId = generateId(this.name);
+			yield {
+				type: EventType.TOOL_CALL_START,
+				toolCallId,
+				toolCallName: rejectedToolCall.toolName,
+				toolName: rejectedToolCall.toolName,
+				parentMessageId: aguiState.messageId,
+				model: options.model,
+				timestamp: Date.now()
+			};
+			yield {
+				type: EventType.TOOL_CALL_ARGS,
+				toolCallId,
+				delta: rejectedToolCall.arguments,
+				args: rejectedToolCall.arguments,
+				model: options.model,
+				timestamp: Date.now()
+			};
+			yield {
+				type: EventType.TOOL_CALL_END,
+				toolCallId,
+				toolCallName: rejectedToolCall.toolName,
+				toolName: rejectedToolCall.toolName,
+				...rejectedToolCall.input !== void 0 && { input: rejectedToolCall.input },
+				result: JSON.stringify({ error: rejectedToolCall.error }),
+				state: "output-error",
+				model: options.model,
+				timestamp: Date.now()
+			};
+			yield {
+				type: EventType.RUN_FINISHED,
+				runId: aguiState.runId,
+				threadId: aguiState.threadId,
+				model: options.model,
+				timestamp: Date.now(),
+				finishReason: "tool_calls"
+			};
+			return;
+		}
+		options.logger.errors(`${this.name}.${source} fatal`, {
+			error: errorPayload,
+			source: `${this.name}.${source}`
+		});
+		yield {
+			type: EventType.RUN_ERROR,
+			model: options.model,
+			timestamp: Date.now(),
+			message: errorPayload.message,
+			...errorPayload.code !== void 0 && { code: errorPayload.code },
+			...rawEvent !== void 0 && { rawEvent },
+			error: {
+				message: errorPayload.message,
+				...errorPayload.code !== void 0 && { code: errorPayload.code }
+			}
+		};
 	}
 	/**
 	* Extracts a rejected tool call from a provider error. Returned calls are
@@ -437,11 +441,20 @@ var OpenAIBaseChatCompletionsTextAdapter = class extends BaseTextAdapter {
 		return e.name === "APIUserAbortError" || e.name === "AbortError" || e.code === "ERR_CANCELED";
 	}
 	/**
+	* Strict conversion plus the inverse null-widening map for this request.
+	* Override this when schema conversion changes, so tool-input undo matches
+	* the wire schema.
+	*/
+	makeStructuredOutputCompatibleWithMap(schema, originalRequired) {
+		return makeStructuredOutputCompatibleWithMap(schema, originalRequired);
+	}
+	/**
 	* Applies provider-specific transformations for structured output compatibility.
-	* Override this in subclasses to handle provider-specific quirks.
+	* Override `makeStructuredOutputCompatibleWithMap` when you need the inverse map
+	* to match the wire schema.
 	*/
 	makeStructuredOutputCompatible(schema, originalRequired) {
-		return makeStructuredOutputCompatible(schema, originalRequired);
+		return this.makeStructuredOutputCompatibleWithMap(schema, originalRequired).schema;
 	}
 	/**
 	* Extract reasoning content from a stream chunk. Default returns
@@ -470,6 +483,7 @@ var OpenAIBaseChatCompletionsTextAdapter = class extends BaseTextAdapter {
 	* Override this in subclasses to handle provider-specific stream behavior.
 	*/
 	async *processStreamChunks(stream, options, aguiState) {
+		const normalizeToolInput = createToolInputNormalizer(options.tools, (schema, required) => this.makeStructuredOutputCompatibleWithMap(schema, required));
 		let accumulatedContent = "";
 		let hasEmittedTextMessageStart = false;
 		let lastModel;
@@ -629,7 +643,7 @@ var OpenAIBaseChatCompletionsTextAdapter = class extends BaseTextAdapter {
 							let parsedInput = {};
 							if (toolCall.arguments) try {
 								const parsed = JSON.parse(toolCall.arguments);
-								parsedInput = parsed && typeof parsed === "object" ? parsed : {};
+								parsedInput = normalizeToolInput(toolCall.name, parsed && typeof parsed === "object" ? parsed : {});
 							} catch (parseError) {
 								options.logger.errors(`${this.name}.processStreamChunks tool-args JSON parse failed`, {
 									error: toRunErrorPayload(parseError, `tool ${toolCall.name} (${toolCall.id}) returned malformed JSON arguments`),
@@ -672,7 +686,7 @@ var OpenAIBaseChatCompletionsTextAdapter = class extends BaseTextAdapter {
 					let parsedInput = {};
 					if (toolCall.arguments) try {
 						const parsed = JSON.parse(toolCall.arguments);
-						parsedInput = parsed && typeof parsed === "object" ? parsed : {};
+						parsedInput = normalizeToolInput(toolCall.name, parsed && typeof parsed === "object" ? parsed : {});
 					} catch (parseError) {
 						options.logger.errors(`${this.name}.processStreamChunks tool-args JSON parse failed (drain)`, {
 							error: toRunErrorPayload(parseError, `tool ${toolCall.name} (${toolCall.id}) returned malformed JSON arguments`),
@@ -737,24 +751,7 @@ var OpenAIBaseChatCompletionsTextAdapter = class extends BaseTextAdapter {
 				};
 			}
 		} catch (error) {
-			const errorPayload = toRunErrorPayload(error, `${this.name}.processStreamChunks failed`);
-			const rawEvent = toRunErrorRawEvent(error);
-			options.logger.errors(`${this.name}.processStreamChunks fatal`, {
-				error: errorPayload,
-				source: `${this.name}.processStreamChunks`
-			});
-			yield {
-				type: EventType.RUN_ERROR,
-				model: options.model,
-				timestamp: Date.now(),
-				message: errorPayload.message,
-				...errorPayload.code !== void 0 && { code: errorPayload.code },
-				...rawEvent !== void 0 && { rawEvent },
-				error: {
-					message: errorPayload.message,
-					...errorPayload.code !== void 0 && { code: errorPayload.code }
-				}
-			};
+			yield* this.handleChatStreamError(error, options, aguiState, "processStreamChunks");
 		}
 	}
 	/**