@ai-sdk/provider-utils 5.0.0-beta.23 → 5.0.0-beta.24

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/provider-utils
 
+## 5.0.0-beta.24
+
+### Patch Changes
+
+- f807e45: Extract shared `StreamingToolCallTracker` class into `@ai-sdk/provider-utils` to deduplicate streaming tool call handling across OpenAI-compatible providers. Also adds missing `generateId()` fallback for `toolCallId` in Alibaba's `doGenerate` path and ensures all providers finalize unfinished tool calls during stream flush.
+
 ## 5.0.0-beta.23
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ImageModelV4File, LanguageModelV4FunctionTool, LanguageModelV4ProviderTool, AISDKError, JSONSchema7, JSONParseError, TypeValidationError, JSONValue, APICallError, LanguageModelV4Prompt, LanguageModelV4FilePart, SharedV4ProviderReference, LanguageModelV4CallOptions, SharedV4Warning, SharedV4ProviderOptions, JSONObject, TypeValidationContext } from '@ai-sdk/provider';
+import { ImageModelV4File, LanguageModelV4FunctionTool, LanguageModelV4ProviderTool, AISDKError, JSONSchema7, JSONParseError, TypeValidationError, JSONValue, APICallError, LanguageModelV4Prompt, LanguageModelV4FilePart, SharedV4ProviderReference, LanguageModelV4CallOptions, SharedV4Warning, SharedV4ProviderOptions, JSONObject, SharedV4ProviderMetadata, LanguageModelV4StreamPart, TypeValidationContext } from '@ai-sdk/provider';
 export { getErrorMessage } from '@ai-sdk/provider';
 import { StandardSchemaV1, StandardJSONSchemaV1 } from '@standard-schema/spec';
 export * from '@standard-schema/spec';
@@ -1479,6 +1479,76 @@ declare function serializeModelOptions<CONFIG extends {
     config: JSONObject;
 };
 
+/**
+ * Minimal interface for a streaming tool call delta from an OpenAI-compatible API.
+ */
+interface StreamingToolCallDelta {
+    index?: number | null;
+    id?: string | null;
+    type?: string | null;
+    function?: {
+        name?: string | null;
+        arguments?: string | null;
+    } | null;
+}
+interface StreamingToolCallTrackerOptions {
+    /**
+     * ID generator function for tool call IDs.
+     * Defaults to the standard generateId.
+     */
+    generateId?: () => string;
+    /**
+     * How to validate the `type` field on new tool call deltas.
+     * - `'none'`: no validation (default)
+     * - `'if-present'`: throw if type is present and not `'function'`
+     * - `'required'`: throw if type is not exactly `'function'`
+     */
+    typeValidation?: 'none' | 'if-present' | 'required';
+    /**
+     * Extract provider-specific metadata from a tool call delta.
+     * Called once when a new tool call is detected.
+     * The returned metadata is stored on the tool call and passed to
+     * `buildToolCallProviderMetadata` when the tool call is finalized.
+     */
+    extractMetadata?: (delta: StreamingToolCallDelta) => SharedV4ProviderMetadata | undefined;
+    /**
+     * Build the `providerMetadata` object for a `tool-call` event.
+     * Receives the metadata previously extracted via `extractMetadata`.
+     * If `undefined` is returned, no `providerMetadata` is included in the event.
+     */
+    buildToolCallProviderMetadata?: (metadata: SharedV4ProviderMetadata | undefined) => SharedV4ProviderMetadata | undefined;
+}
+/**
+ * Tracks streaming tool call state across multiple deltas from an
+ * OpenAI-compatible chat completion stream. Handles argument accumulation,
+ * emits tool-input-start/delta/end and tool-call events, and finalizes
+ * unfinished tool calls on flush.
+ *
+ * Used by openai, openai-compatible, groq, deepseek, and alibaba providers.
+ */
+declare class StreamingToolCallTracker {
+    private toolCalls;
+    private readonly _generateId;
+    private readonly typeValidation;
+    private readonly extractMetadata?;
+    private readonly buildToolCallProviderMetadata?;
+    constructor(options?: StreamingToolCallTrackerOptions);
+    /**
+     * Process a tool call delta from a streaming response chunk.
+     * Emits tool-input-start, tool-input-delta, tool-input-end, and tool-call
+     * events as appropriate.
+     */
+    processDelta(toolCallDelta: StreamingToolCallDelta, enqueue: (part: LanguageModelV4StreamPart) => void): void;
+    /**
+     * Finalize any unfinished tool calls. Should be called during the stream's
+     * flush handler to ensure all tool calls are properly completed.
+     */
+    flush(enqueue: (part: LanguageModelV4StreamPart) => void): void;
+    private processNewToolCall;
+    private processExistingToolCall;
+    private finishToolCall;
+}
+
 /**
  * Strips file extension segments from a filename.
  *
@@ -1684,4 +1754,4 @@ interface ToolResult<NAME extends string, INPUT, OUTPUT> {
     dynamic?: boolean;
 }
 
-export { type Arrayable, type AssistantContent, type AssistantModelMessage, type Context, type CustomPart, DEFAULT_MAX_DOWNLOAD_SIZE, type DataContent, DelayedPromise, DownloadError, type ExecutableTool, type FetchFunction, type FilePart, type FlexibleSchema, type HasRequiredKey, type IdGenerator, type ImagePart, type InferSchema, type InferToolContext, type InferToolInput, type InferToolOutput, type InferToolSetContext, type LazySchema, type MaybePromiseLike, type ModelMessage, type ParseResult, type ProviderOptions, type ProviderReference, type ProviderToolFactory, type ProviderToolFactoryWithOutputSchema, type ReasoningFilePart, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolExecutionOptions, type ToolModelMessage, type ToolNameMapping, type ToolNeedsApprovalFunction, type ToolResult, type ToolResultOutput, type ToolResultPart, type ToolSet, type UserContent, type UserModelMessage, VERSION, type ValidationResult, asArray, asSchema, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertImageModelFileToDataUri, convertToBase64, convertToFormData, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderToolFactory, createProviderToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, createToolNameMapping, delay, downloadBlob, dynamicTool, executeTool, extractResponseHeaders, generateId, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isCustomReasoning, isExecutableTool, isNonNullable, isParsableJson, isProviderReference, isUrlSupported, jsonSchema, lazySchema, loadApiKey, loadOptionalSetting, loadSetting, mapReasoningToProviderBudget, mapReasoningToProviderEffort, mediaTypeToExtension, normalizeHeaders, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, readResponseWithSizeLimit, removeUndefinedEntries, resolve, resolveProviderReference, safeParseJSON, safeValidateTypes, serializeModelOptions, stripFileExtension, tool, validateDownloadUrl, validateTypes, withUserAgentSuffix, withoutTrailingSlash, zodSchema };
+export { type Arrayable, type AssistantContent, type AssistantModelMessage, type Context, type CustomPart, DEFAULT_MAX_DOWNLOAD_SIZE, type DataContent, DelayedPromise, DownloadError, type ExecutableTool, type FetchFunction, type FilePart, type FlexibleSchema, type HasRequiredKey, type IdGenerator, type ImagePart, type InferSchema, type InferToolContext, type InferToolInput, type InferToolOutput, type InferToolSetContext, type LazySchema, type MaybePromiseLike, type ModelMessage, type ParseResult, type ProviderOptions, type ProviderReference, type ProviderToolFactory, type ProviderToolFactoryWithOutputSchema, type ReasoningFilePart, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type StreamingToolCallDelta, StreamingToolCallTracker, type StreamingToolCallTrackerOptions, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolExecutionOptions, type ToolModelMessage, type ToolNameMapping, type ToolNeedsApprovalFunction, type ToolResult, type ToolResultOutput, type ToolResultPart, type ToolSet, type UserContent, type UserModelMessage, VERSION, type ValidationResult, asArray, asSchema, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertImageModelFileToDataUri, convertToBase64, convertToFormData, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderToolFactory, createProviderToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, createToolNameMapping, delay, downloadBlob, dynamicTool, executeTool, extractResponseHeaders, generateId, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isCustomReasoning, isExecutableTool, isNonNullable, isParsableJson, isProviderReference, isUrlSupported, jsonSchema, lazySchema, loadApiKey, loadOptionalSetting, loadSetting, mapReasoningToProviderBudget, mapReasoningToProviderEffort, mediaTypeToExtension, normalizeHeaders, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, readResponseWithSizeLimit, removeUndefinedEntries, resolve, resolveProviderReference, safeParseJSON, safeValidateTypes, serializeModelOptions, stripFileExtension, tool, validateDownloadUrl, validateTypes, withUserAgentSuffix, withoutTrailingSlash, zodSchema };

package/dist/index.js

@@ -571,7 +571,7 @@ function withUserAgentSuffix(headers, ...userAgentSuffixParts) {
 }
 
 // src/version.ts
-var VERSION = true ? "5.0.0-beta.23" : "0.0.0-test";
+var VERSION = true ? "5.0.0-beta.24" : "0.0.0-test";
 
 // src/get-from-api.ts
 var getOriginalFetch = () => globalThis.fetch;
@@ -2770,6 +2770,140 @@ function resolveSync(value) {
   return next;
 }
 
+// src/streaming-tool-call-tracker.ts
+import {
+  InvalidResponseDataError
+} from "@ai-sdk/provider";
+var StreamingToolCallTracker = class {
+  constructor(options = {}) {
+    this.toolCalls = [];
+    var _a2, _b2;
+    this._generateId = (_a2 = options.generateId) != null ? _a2 : generateId;
+    this.typeValidation = (_b2 = options.typeValidation) != null ? _b2 : "none";
+    this.extractMetadata = options.extractMetadata;
+    this.buildToolCallProviderMetadata = options.buildToolCallProviderMetadata;
+  }
+  /**
+   * Process a tool call delta from a streaming response chunk.
+   * Emits tool-input-start, tool-input-delta, tool-input-end, and tool-call
+   * events as appropriate.
+   */
+  processDelta(toolCallDelta, enqueue) {
+    var _a2;
+    const index = (_a2 = toolCallDelta.index) != null ? _a2 : this.toolCalls.length;
+    if (this.toolCalls[index] == null) {
+      this.processNewToolCall(index, toolCallDelta, enqueue);
+    } else {
+      this.processExistingToolCall(index, toolCallDelta, enqueue);
+    }
+  }
+  /**
+   * Finalize any unfinished tool calls. Should be called during the stream's
+   * flush handler to ensure all tool calls are properly completed.
+   */
+  flush(enqueue) {
+    for (const toolCall of this.toolCalls) {
+      if (!toolCall.hasFinished) {
+        this.finishToolCall(toolCall, enqueue);
+      }
+    }
+  }
+  processNewToolCall(index, toolCallDelta, enqueue) {
+    var _a2, _b2, _c;
+    if (this.typeValidation === "required") {
+      if (toolCallDelta.type !== "function") {
+        throw new InvalidResponseDataError({
+          data: toolCallDelta,
+          message: `Expected 'function' type.`
+        });
+      }
+    } else if (this.typeValidation === "if-present") {
+      if (toolCallDelta.type != null && toolCallDelta.type !== "function") {
+        throw new InvalidResponseDataError({
+          data: toolCallDelta,
+          message: `Expected 'function' type.`
+        });
+      }
+    }
+    if (toolCallDelta.id == null) {
+      throw new InvalidResponseDataError({
+        data: toolCallDelta,
+        message: `Expected 'id' to be a string.`
+      });
+    }
+    if (((_a2 = toolCallDelta.function) == null ? void 0 : _a2.name) == null) {
+      throw new InvalidResponseDataError({
+        data: toolCallDelta,
+        message: `Expected 'function.name' to be a string.`
+      });
+    }
+    enqueue({
+      type: "tool-input-start",
+      id: toolCallDelta.id,
+      toolName: toolCallDelta.function.name
+    });
+    const metadata = (_b2 = this.extractMetadata) == null ? void 0 : _b2.call(this, toolCallDelta);
+    this.toolCalls[index] = {
+      id: toolCallDelta.id,
+      type: "function",
+      function: {
+        name: toolCallDelta.function.name,
+        arguments: (_c = toolCallDelta.function.arguments) != null ? _c : ""
+      },
+      hasFinished: false,
+      metadata
+    };
+    const toolCall = this.toolCalls[index];
+    if (toolCall.function.arguments.length > 0) {
+      enqueue({
+        type: "tool-input-delta",
+        id: toolCall.id,
+        delta: toolCall.function.arguments
+      });
+    }
+    if (isParsableJson(toolCall.function.arguments)) {
+      this.finishToolCall(toolCall, enqueue);
+    }
+  }
+  processExistingToolCall(index, toolCallDelta, enqueue) {
+    var _a2;
+    const toolCall = this.toolCalls[index];
+    if (toolCall.hasFinished) {
+      return;
+    }
+    if (((_a2 = toolCallDelta.function) == null ? void 0 : _a2.arguments) != null) {
+      toolCall.function.arguments += toolCallDelta.function.arguments;
+      enqueue({
+        type: "tool-input-delta",
+        id: toolCall.id,
+        delta: toolCallDelta.function.arguments
+      });
+    }
+    if (isParsableJson(toolCall.function.arguments)) {
+      this.finishToolCall(toolCall, enqueue);
+    }
+  }
+  finishToolCall(toolCall, enqueue) {
+    var _a2, _b2;
+    enqueue({
+      type: "tool-input-end",
+      id: toolCall.id
+    });
+    const providerMetadata = (_a2 = this.buildToolCallProviderMetadata) == null ? void 0 : _a2.call(
+      this,
+      toolCall.metadata
+    );
+    enqueue({
+      type: "tool-call",
+      toolCallId: (_b2 = toolCall.id) != null ? _b2 : this._generateId(),
+      toolName: toolCall.function.name,
+      input: toolCall.function.arguments,
+      ...providerMetadata ? { providerMetadata } : {}
+    });
+    toolCall.hasFinished = true;
+  }
+};
+
 // src/strip-file-extension.ts
 function stripFileExtension(filename) {
   const firstDotIndex = filename.indexOf(".");
@@ -2820,6 +2954,7 @@ export {
   DelayedPromise,
   DownloadError,
   EventSourceParserStream2 as EventSourceParserStream,
+  StreamingToolCallTracker,
   VERSION,
   WORKFLOW_DESERIALIZE,
   WORKFLOW_SERIALIZE,