@ai-sdk/provider-utils 4.0.14 → 4.0.16

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @ai-sdk/provider-utils
 
+## 4.0.16
+
+### Patch Changes
+
+- 58bc42d: feat(provider/openai): support custom tools with alias mapping
+
+## 4.0.15
+
+### Patch Changes
+
+- 4024a3a: security: prevent unbounded memory growth in download functions
+
+  The `download()` and `downloadBlob()` functions now enforce a default 2 GiB size limit when downloading from user-provided URLs. Downloads that exceed this limit are aborted with a `DownloadError` instead of consuming unbounded memory and crashing the process. The `abortSignal` parameter is now passed through to `fetch()` in all download call sites.
+
+  Added `download` option to `transcribe()` and `experimental_generateVideo()` for providing a custom download function. Use the new `createDownload({ maxBytes })` factory to configure download size limits.
+
 ## 4.0.14
 
 ### Patch Changes

package/dist/index.d.mts

@@ -41,7 +41,7 @@ interface ToolNameMapping {
  * @param tools - Tools that were passed to the language model.
  * @param providerToolNames - Maps the provider tool ids to the provider tool names.
  */
-declare function createToolNameMapping({ tools, providerToolNames, }: {
+declare function createToolNameMapping({ tools, providerToolNames, resolveProviderToolName, }: {
     /**
      * Tools that were passed to the language model.
      */
@@ -50,6 +50,11 @@ declare function createToolNameMapping({ tools, providerToolNames, }: {
      * Maps the provider tool ids to the provider tool names.
      */
     providerToolNames: Record<`${string}.${string}`, string>;
+    /**
+     * Optional resolver for provider tool names that cannot be represented as
+     * static id -> name mappings (e.g. dynamic provider names).
+     */
+    resolveProviderToolName?: (tool: LanguageModelV3ProviderTool) => string | undefined;
 }): ToolNameMapping;
 
 /**
@@ -139,11 +144,17 @@ declare function convertToFormData<T extends Record<string, unknown>>(input: T,
  * Download a file from a URL and return it as a Blob.
  *
  * @param url - The URL to download from.
+ * @param options - Optional settings for the download.
+ * @param options.maxBytes - Maximum allowed download size in bytes. Defaults to 100 MiB.
+ * @param options.abortSignal - An optional abort signal to cancel the download.
  * @returns A Promise that resolves to the downloaded Blob.
  *
- * @throws DownloadError if the download fails.
+ * @throws DownloadError if the download fails or exceeds maxBytes.
  */
-declare function downloadBlob(url: string): Promise<Blob>;
+declare function downloadBlob(url: string, options?: {
+    maxBytes?: number;
+    abortSignal?: AbortSignal;
+}): Promise<Blob>;
 
 declare const symbol: unique symbol;
 declare class DownloadError extends AISDKError {
@@ -161,6 +172,37 @@ declare class DownloadError extends AISDKError {
     static isInstance(error: unknown): error is DownloadError;
 }
 
+/**
+ * Default maximum download size: 2 GiB.
+ *
+ * `fetch().arrayBuffer()` has ~2x peak memory overhead (undici buffers the
+ * body internally, then creates the JS ArrayBuffer), so very large downloads
+ * risk exceeding the default V8 heap limit on 64-bit systems and terminating
+ * the process with an out-of-memory error.
+ *
+ * Setting this limit converts an unrecoverable OOM crash into a catchable
+ * `DownloadError`.
+ */
+declare const DEFAULT_MAX_DOWNLOAD_SIZE: number;
+/**
+ * Reads a fetch Response body with a size limit to prevent memory exhaustion.
+ *
+ * Checks the Content-Length header for early rejection, then reads the body
+ * incrementally via ReadableStream and aborts with a DownloadError when the
+ * limit is exceeded.
+ *
+ * @param response - The fetch Response to read.
+ * @param url - The URL being downloaded (used in error messages).
+ * @param maxBytes - Maximum allowed bytes. Defaults to DEFAULT_MAX_DOWNLOAD_SIZE.
+ * @returns A Uint8Array containing the response body.
+ * @throws DownloadError if the response exceeds maxBytes.
+ */
+declare function readResponseWithSizeLimit({ response, url, maxBytes, }: {
+    response: Response;
+    url: string;
+    maxBytes?: number;
+}): Promise<Uint8Array>;
+
 /**
  * Fetch function type (standardizes the version of fetch used).
  */
@@ -1369,4 +1411,4 @@ interface ToolResult<NAME extends string, INPUT, OUTPUT> {
  */
 type ToolCallOptions = ToolExecutionOptions;
 
-export { type AssistantContent, type AssistantModelMessage, type DataContent, DelayedPromise, DownloadError, type FetchFunction, type FilePart, type FlexibleSchema, type IdGenerator, type ImagePart, type InferSchema, type InferToolInput, type InferToolOutput, type LazySchema, type MaybePromiseLike, type ModelMessage, type ParseResult, type ProviderOptions, type ProviderToolFactory, type ProviderToolFactoryWithOutputSchema, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallOptions, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolExecutionOptions, type ToolModelMessage, type ToolNameMapping, type ToolNeedsApprovalFunction, type ToolResult, type ToolResultOutput, type ToolResultPart, type UserContent, type UserModelMessage, VERSION, type ValidationResult, asSchema, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertImageModelFileToDataUri, convertToBase64, convertToFormData, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderToolFactory, createProviderToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, createToolNameMapping, delay, downloadBlob, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isNonNullable, isParsableJson, isUrlSupported, jsonSchema, lazySchema, loadApiKey, loadOptionalSetting, loadSetting, mediaTypeToExtension, normalizeHeaders, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, tool, validateTypes, withUserAgentSuffix, withoutTrailingSlash, zodSchema };
+export { type AssistantContent, type AssistantModelMessage, DEFAULT_MAX_DOWNLOAD_SIZE, type DataContent, DelayedPromise, DownloadError, type FetchFunction, type FilePart, type FlexibleSchema, type IdGenerator, type ImagePart, type InferSchema, type InferToolInput, type InferToolOutput, type LazySchema, type MaybePromiseLike, type ModelMessage, type ParseResult, type ProviderOptions, type ProviderToolFactory, type ProviderToolFactoryWithOutputSchema, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallOptions, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolExecutionOptions, type ToolModelMessage, type ToolNameMapping, type ToolNeedsApprovalFunction, type ToolResult, type ToolResultOutput, type ToolResultPart, type UserContent, type UserModelMessage, VERSION, type ValidationResult, asSchema, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertImageModelFileToDataUri, convertToBase64, convertToFormData, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderToolFactory, createProviderToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, createToolNameMapping, delay, downloadBlob, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isNonNullable, isParsableJson, isUrlSupported, jsonSchema, lazySchema, loadApiKey, loadOptionalSetting, loadSetting, mediaTypeToExtension, normalizeHeaders, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, readResponseWithSizeLimit, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, tool, validateTypes, withUserAgentSuffix, withoutTrailingSlash, zodSchema };

package/dist/index.d.ts

@@ -41,7 +41,7 @@ interface ToolNameMapping {
  * @param tools - Tools that were passed to the language model.
  * @param providerToolNames - Maps the provider tool ids to the provider tool names.
  */
-declare function createToolNameMapping({ tools, providerToolNames, }: {
+declare function createToolNameMapping({ tools, providerToolNames, resolveProviderToolName, }: {
     /**
      * Tools that were passed to the language model.
      */
@@ -50,6 +50,11 @@ declare function createToolNameMapping({ tools, providerToolNames, }: {
      * Maps the provider tool ids to the provider tool names.
      */
     providerToolNames: Record<`${string}.${string}`, string>;
+    /**
+     * Optional resolver for provider tool names that cannot be represented as
+     * static id -> name mappings (e.g. dynamic provider names).
+     */
+    resolveProviderToolName?: (tool: LanguageModelV3ProviderTool) => string | undefined;
 }): ToolNameMapping;
 
 /**
@@ -139,11 +144,17 @@ declare function convertToFormData<T extends Record<string, unknown>>(input: T,
  * Download a file from a URL and return it as a Blob.
  *
  * @param url - The URL to download from.
+ * @param options - Optional settings for the download.
+ * @param options.maxBytes - Maximum allowed download size in bytes. Defaults to 100 MiB.
+ * @param options.abortSignal - An optional abort signal to cancel the download.
  * @returns A Promise that resolves to the downloaded Blob.
  *
- * @throws DownloadError if the download fails.
+ * @throws DownloadError if the download fails or exceeds maxBytes.
  */
-declare function downloadBlob(url: string): Promise<Blob>;
+declare function downloadBlob(url: string, options?: {
+    maxBytes?: number;
+    abortSignal?: AbortSignal;
+}): Promise<Blob>;
 
 declare const symbol: unique symbol;
 declare class DownloadError extends AISDKError {
@@ -161,6 +172,37 @@ declare class DownloadError extends AISDKError {
     static isInstance(error: unknown): error is DownloadError;
 }
 
+/**
+ * Default maximum download size: 2 GiB.
+ *
+ * `fetch().arrayBuffer()` has ~2x peak memory overhead (undici buffers the
+ * body internally, then creates the JS ArrayBuffer), so very large downloads
+ * risk exceeding the default V8 heap limit on 64-bit systems and terminating
+ * the process with an out-of-memory error.
+ *
+ * Setting this limit converts an unrecoverable OOM crash into a catchable
+ * `DownloadError`.
+ */
+declare const DEFAULT_MAX_DOWNLOAD_SIZE: number;
+/**
+ * Reads a fetch Response body with a size limit to prevent memory exhaustion.
+ *
+ * Checks the Content-Length header for early rejection, then reads the body
+ * incrementally via ReadableStream and aborts with a DownloadError when the
+ * limit is exceeded.
+ *
+ * @param response - The fetch Response to read.
+ * @param url - The URL being downloaded (used in error messages).
+ * @param maxBytes - Maximum allowed bytes. Defaults to DEFAULT_MAX_DOWNLOAD_SIZE.
+ * @returns A Uint8Array containing the response body.
+ * @throws DownloadError if the response exceeds maxBytes.
+ */
+declare function readResponseWithSizeLimit({ response, url, maxBytes, }: {
+    response: Response;
+    url: string;
+    maxBytes?: number;
+}): Promise<Uint8Array>;
+
 /**
  * Fetch function type (standardizes the version of fetch used).
  */
@@ -1369,4 +1411,4 @@ interface ToolResult<NAME extends string, INPUT, OUTPUT> {
  */
 type ToolCallOptions = ToolExecutionOptions;
 
-export { type AssistantContent, type AssistantModelMessage, type DataContent, DelayedPromise, DownloadError, type FetchFunction, type FilePart, type FlexibleSchema, type IdGenerator, type ImagePart, type InferSchema, type InferToolInput, type InferToolOutput, type LazySchema, type MaybePromiseLike, type ModelMessage, type ParseResult, type ProviderOptions, type ProviderToolFactory, type ProviderToolFactoryWithOutputSchema, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallOptions, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolExecutionOptions, type ToolModelMessage, type ToolNameMapping, type ToolNeedsApprovalFunction, type ToolResult, type ToolResultOutput, type ToolResultPart, type UserContent, type UserModelMessage, VERSION, type ValidationResult, asSchema, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertImageModelFileToDataUri, convertToBase64, convertToFormData, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderToolFactory, createProviderToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, createToolNameMapping, delay, downloadBlob, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isNonNullable, isParsableJson, isUrlSupported, jsonSchema, lazySchema, loadApiKey, loadOptionalSetting, loadSetting, mediaTypeToExtension, normalizeHeaders, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, tool, validateTypes, withUserAgentSuffix, withoutTrailingSlash, zodSchema };
+export { type AssistantContent, type AssistantModelMessage, DEFAULT_MAX_DOWNLOAD_SIZE, type DataContent, DelayedPromise, DownloadError, type FetchFunction, type FilePart, type FlexibleSchema, type IdGenerator, type ImagePart, type InferSchema, type InferToolInput, type InferToolOutput, type LazySchema, type MaybePromiseLike, type ModelMessage, type ParseResult, type ProviderOptions, type ProviderToolFactory, type ProviderToolFactoryWithOutputSchema, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallOptions, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolExecutionOptions, type ToolModelMessage, type ToolNameMapping, type ToolNeedsApprovalFunction, type ToolResult, type ToolResultOutput, type ToolResultPart, type UserContent, type UserModelMessage, VERSION, type ValidationResult, asSchema, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertImageModelFileToDataUri, convertToBase64, convertToFormData, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderToolFactory, createProviderToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, createToolNameMapping, delay, downloadBlob, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isNonNullable, isParsableJson, isUrlSupported, jsonSchema, lazySchema, loadApiKey, loadOptionalSetting, loadSetting, mediaTypeToExtension, normalizeHeaders, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, readResponseWithSizeLimit, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, tool, validateTypes, withUserAgentSuffix, withoutTrailingSlash, zodSchema };

package/dist/index.js

@@ -30,6 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  DEFAULT_MAX_DOWNLOAD_SIZE: () => DEFAULT_MAX_DOWNLOAD_SIZE,
   DelayedPromise: () => DelayedPromise,
   DownloadError: () => DownloadError,
   EventSourceParserStream: () => import_stream2.EventSourceParserStream,
@@ -78,6 +79,7 @@ __export(src_exports, {
   postFormDataToApi: () => postFormDataToApi,
   postJsonToApi: () => postJsonToApi,
   postToApi: () => postToApi,
+  readResponseWithSizeLimit: () => readResponseWithSizeLimit,
   removeUndefinedEntries: () => removeUndefinedEntries,
   resolve: () => resolve,
   safeParseJSON: () => safeParseJSON,
@@ -142,25 +144,30 @@ function convertAsyncIteratorToReadableStream(iterator) {
 // src/create-tool-name-mapping.ts
 function createToolNameMapping({
   tools = [],
-  providerToolNames
+  providerToolNames,
+  resolveProviderToolName
 }) {
+  var _a2;
   const customToolNameToProviderToolName = {};
   const providerToolNameToCustomToolName = {};
   for (const tool2 of tools) {
-    if (tool2.type === "provider" && tool2.id in providerToolNames) {
-      const providerToolName = providerToolNames[tool2.id];
+    if (tool2.type === "provider") {
+      const providerToolName = (_a2 = resolveProviderToolName == null ? void 0 : resolveProviderToolName(tool2)) != null ? _a2 : tool2.id in providerToolNames ? providerToolNames[tool2.id] : void 0;
+      if (providerToolName == null) {
+        continue;
+      }
       customToolNameToProviderToolName[tool2.name] = providerToolName;
       providerToolNameToCustomToolName[providerToolName] = tool2.name;
     }
   }
   return {
     toProviderToolName: (customToolName) => {
-      var _a2;
-      return (_a2 = customToolNameToProviderToolName[customToolName]) != null ? _a2 : customToolName;
+      var _a3;
+      return (_a3 = customToolNameToProviderToolName[customToolName]) != null ? _a3 : customToolName;
     },
     toCustomToolName: (providerToolName) => {
-      var _a2;
-      return (_a2 = providerToolNameToCustomToolName[providerToolName]) != null ? _a2 : providerToolName;
+      var _a3;
+      return (_a3 = providerToolNameToCustomToolName[providerToolName]) != null ? _a3 : providerToolName;
     }
   };
 }
@@ -320,10 +327,68 @@ var DownloadError = class extends (_b = import_provider.AISDKError, _a = symbol,
   }
 };
 
+// src/read-response-with-size-limit.ts
+var DEFAULT_MAX_DOWNLOAD_SIZE = 2 * 1024 * 1024 * 1024;
+async function readResponseWithSizeLimit({
+  response,
+  url,
+  maxBytes = DEFAULT_MAX_DOWNLOAD_SIZE
+}) {
+  const contentLength = response.headers.get("content-length");
+  if (contentLength != null) {
+    const length = parseInt(contentLength, 10);
+    if (!isNaN(length) && length > maxBytes) {
+      throw new DownloadError({
+        url,
+        message: `Download of ${url} exceeded maximum size of ${maxBytes} bytes (Content-Length: ${length}).`
+      });
+    }
+  }
+  const body = response.body;
+  if (body == null) {
+    return new Uint8Array(0);
+  }
+  const reader = body.getReader();
+  const chunks = [];
+  let totalBytes = 0;
+  try {
+    while (true) {
+      const { done, value } = await reader.read();
+      if (done) {
+        break;
+      }
+      totalBytes += value.length;
+      if (totalBytes > maxBytes) {
+        throw new DownloadError({
+          url,
+          message: `Download of ${url} exceeded maximum size of ${maxBytes} bytes.`
+        });
+      }
+      chunks.push(value);
+    }
+  } finally {
+    try {
+      await reader.cancel();
+    } finally {
+      reader.releaseLock();
+    }
+  }
+  const result = new Uint8Array(totalBytes);
+  let offset = 0;
+  for (const chunk of chunks) {
+    result.set(chunk, offset);
+    offset += chunk.length;
+  }
+  return result;
+}
+
 // src/download-blob.ts
-async function downloadBlob(url) {
+async function downloadBlob(url, options) {
+  var _a2, _b2;
   try {
-    const response = await fetch(url);
+    const response = await fetch(url, {
+      signal: options == null ? void 0 : options.abortSignal
+    });
     if (!response.ok) {
       throw new DownloadError({
         url,
@@ -331,7 +396,13 @@ async function downloadBlob(url) {
         statusText: response.statusText
       });
     }
-    return await response.blob();
+    const data = await readResponseWithSizeLimit({
+      response,
+      url,
+      maxBytes: (_a2 = options == null ? void 0 : options.maxBytes) != null ? _a2 : DEFAULT_MAX_DOWNLOAD_SIZE
+    });
+    const contentType = (_b2 = response.headers.get("content-type")) != null ? _b2 : void 0;
+    return new Blob([data], contentType ? { type: contentType } : void 0);
   } catch (error) {
     if (DownloadError.isInstance(error)) {
       throw error;
@@ -502,7 +573,7 @@ function withUserAgentSuffix(headers, ...userAgentSuffixParts) {
 }
 
 // src/version.ts
-var VERSION = true ? "4.0.14" : "0.0.0-test";
+var VERSION = true ? "4.0.16" : "0.0.0-test";
 
 // src/get-from-api.ts
 var getOriginalFetch = () => globalThis.fetch;
@@ -2603,6 +2674,7 @@ async function* executeTool({
 var import_stream2 = require("eventsource-parser/stream");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  DEFAULT_MAX_DOWNLOAD_SIZE,
   DelayedPromise,
   DownloadError,
   EventSourceParserStream,
@@ -2651,6 +2723,7 @@ var import_stream2 = require("eventsource-parser/stream");
   postFormDataToApi,
   postJsonToApi,
   postToApi,
+  readResponseWithSizeLimit,
   removeUndefinedEntries,
   resolve,
   safeParseJSON,