@ai-sdk/gateway 3.0.39 → 3.0.41

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/gateway
 
+## 3.0.41
+
+### Patch Changes
+
+- 99fbed8: feat: normalize provider specific model options type names and ensure they are exported
+
+## 3.0.40
+
+### Patch Changes
+
+- a2208a2: fix (provider/gateway): added custom error class and message for client side timeouts
+
 ## 3.0.39
 
 ### Patch Changes

package/dist/index.d.mts

@@ -432,7 +432,7 @@ interface GatewayProviderSettings {
 declare function createGatewayProvider(options?: GatewayProviderSettings): GatewayProvider;
 declare const gateway: GatewayProvider;
 
-declare const gatewayProviderOptions: _ai_sdk_provider_utils.LazySchema<{
+declare const gatewayLanguageModelOptions: _ai_sdk_provider_utils.LazySchema<{
     only?: string[] | undefined;
     order?: string[] | undefined;
     user?: string | undefined;
@@ -441,7 +441,7 @@ declare const gatewayProviderOptions: _ai_sdk_provider_utils.LazySchema<{
     byok?: Record<string, Record<string, unknown>[]> | undefined;
     zeroDataRetention?: boolean | undefined;
 }>;
-type GatewayProviderOptions = InferSchema<typeof gatewayProviderOptions>;
+type GatewayLanguageModelOptions = InferSchema<typeof gatewayLanguageModelOptions>;
 
 declare const symbol$6: unique symbol;
 declare abstract class GatewayError extends Error {
@@ -596,4 +596,4 @@ declare class GatewayResponseError extends GatewayError {
     static isInstance(error: unknown): error is GatewayResponseError;
 }
 
-export { GatewayAuthenticationError, type GatewayCreditsResponse, GatewayError, type GatewayErrorResponse, GatewayInternalServerError, GatewayInvalidRequestError, type GatewayLanguageModelEntry, type GatewayLanguageModelSpecification, type GatewayLanguageModelEntry as GatewayModelEntry, type GatewayModelId, GatewayModelNotFoundError, type GatewayProvider, type GatewayProviderOptions, type GatewayProviderSettings, GatewayRateLimitError, GatewayResponseError, type GatewayVideoModelId, createGatewayProvider as createGateway, createGatewayProvider, gateway };
+export { GatewayAuthenticationError, type GatewayCreditsResponse, GatewayError, type GatewayErrorResponse, GatewayInternalServerError, GatewayInvalidRequestError, type GatewayLanguageModelEntry, type GatewayLanguageModelOptions, type GatewayLanguageModelSpecification, type GatewayLanguageModelEntry as GatewayModelEntry, type GatewayModelId, GatewayModelNotFoundError, type GatewayProvider, type GatewayLanguageModelOptions as GatewayProviderOptions, type GatewayProviderSettings, GatewayRateLimitError, GatewayResponseError, type GatewayVideoModelId, createGatewayProvider as createGateway, createGatewayProvider, gateway };

package/dist/index.d.ts

@@ -432,7 +432,7 @@ interface GatewayProviderSettings {
 declare function createGatewayProvider(options?: GatewayProviderSettings): GatewayProvider;
 declare const gateway: GatewayProvider;
 
-declare const gatewayProviderOptions: _ai_sdk_provider_utils.LazySchema<{
+declare const gatewayLanguageModelOptions: _ai_sdk_provider_utils.LazySchema<{
     only?: string[] | undefined;
     order?: string[] | undefined;
     user?: string | undefined;
@@ -441,7 +441,7 @@ declare const gatewayProviderOptions: _ai_sdk_provider_utils.LazySchema<{
     byok?: Record<string, Record<string, unknown>[]> | undefined;
     zeroDataRetention?: boolean | undefined;
 }>;
-type GatewayProviderOptions = InferSchema<typeof gatewayProviderOptions>;
+type GatewayLanguageModelOptions = InferSchema<typeof gatewayLanguageModelOptions>;
 
 declare const symbol$6: unique symbol;
 declare abstract class GatewayError extends Error {
@@ -596,4 +596,4 @@ declare class GatewayResponseError extends GatewayError {
     static isInstance(error: unknown): error is GatewayResponseError;
 }
 
-export { GatewayAuthenticationError, type GatewayCreditsResponse, GatewayError, type GatewayErrorResponse, GatewayInternalServerError, GatewayInvalidRequestError, type GatewayLanguageModelEntry, type GatewayLanguageModelSpecification, type GatewayLanguageModelEntry as GatewayModelEntry, type GatewayModelId, GatewayModelNotFoundError, type GatewayProvider, type GatewayProviderOptions, type GatewayProviderSettings, GatewayRateLimitError, GatewayResponseError, type GatewayVideoModelId, createGatewayProvider as createGateway, createGatewayProvider, gateway };
+export { GatewayAuthenticationError, type GatewayCreditsResponse, GatewayError, type GatewayErrorResponse, GatewayInternalServerError, GatewayInvalidRequestError, type GatewayLanguageModelEntry, type GatewayLanguageModelOptions, type GatewayLanguageModelSpecification, type GatewayLanguageModelEntry as GatewayModelEntry, type GatewayModelId, GatewayModelNotFoundError, type GatewayProvider, type GatewayLanguageModelOptions as GatewayProviderOptions, type GatewayProviderSettings, GatewayRateLimitError, GatewayResponseError, type GatewayVideoModelId, createGatewayProvider as createGateway, createGatewayProvider, gateway };

package/dist/index.js

@@ -4,8 +4,8 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
-  for (var name7 in all)
-    __defProp(target, name7, { get: all[name7], enumerable: true });
+  for (var name8 in all)
+    __defProp(target, name8, { get: all[name8], enumerable: true });
 };
 var __copyProps = (to, from, except, desc) => {
   if (from && typeof from === "object" || typeof from === "function") {
@@ -275,7 +275,7 @@ async function createGatewayErrorFromResponse({
   cause,
   authMethod
 }) {
-  var _a8;
+  var _a9;
   const parseResult = await (0, import_provider_utils2.safeValidateTypes)({
     value: response,
     schema: gatewayErrorResponseSchema
@@ -294,7 +294,7 @@ async function createGatewayErrorFromResponse({
   const validatedResponse = parseResult.value;
   const errorType = validatedResponse.error.type;
   const message = validatedResponse.error.message;
-  const generationId = (_a8 = validatedResponse.generationId) != null ? _a8 : void 0;
+  const generationId = (_a9 = validatedResponse.generationId) != null ? _a9 : void 0;
   switch (errorType) {
     case "authentication_error":
       return GatewayAuthenticationError.createContextualError({
@@ -361,22 +361,91 @@ var gatewayErrorResponseSchema = (0, import_provider_utils2.lazySchema)(
   )
 );
 
+// src/errors/gateway-timeout-error.ts
+var name7 = "GatewayTimeoutError";
+var marker8 = `vercel.ai.gateway.error.${name7}`;
+var symbol8 = Symbol.for(marker8);
+var _a8, _b8;
+var GatewayTimeoutError = class _GatewayTimeoutError extends (_b8 = GatewayError, _a8 = symbol8, _b8) {
+  constructor({
+    message = "Request timed out",
+    statusCode = 408,
+    cause,
+    generationId
+  } = {}) {
+    super({ message, statusCode, cause, generationId });
+    this[_a8] = true;
+    // used in isInstance
+    this.name = name7;
+    this.type = "timeout_error";
+  }
+  static isInstance(error) {
+    return GatewayError.hasMarker(error) && symbol8 in error;
+  }
+  /**
+   * Creates a helpful timeout error message with troubleshooting guidance
+   */
+  static createTimeoutError({
+    originalMessage,
+    statusCode = 408,
+    cause,
+    generationId
+  }) {
+    const message = `Gateway request timed out: ${originalMessage}
+
+    This is a client-side timeout. To resolve this, increase your timeout configuration: https://vercel.com/docs/ai-gateway/capabilities/video-generation#extending-timeouts-for-node.js`;
+    return new _GatewayTimeoutError({
+      message,
+      statusCode,
+      cause,
+      generationId
+    });
+  }
+};
+
 // src/errors/as-gateway-error.ts
-function asGatewayError(error, authMethod) {
-  var _a8;
+function isTimeoutError(error) {
+  if (!(error instanceof Error)) {
+    return false;
+  }
+  const errorCode = error.code;
+  if (typeof errorCode === "string") {
+    const undiciTimeoutCodes = [
+      "UND_ERR_HEADERS_TIMEOUT",
+      "UND_ERR_BODY_TIMEOUT",
+      "UND_ERR_CONNECT_TIMEOUT"
+    ];
+    return undiciTimeoutCodes.includes(errorCode);
+  }
+  return false;
+}
+async function asGatewayError(error, authMethod) {
+  var _a9;
   if (GatewayError.isInstance(error)) {
     return error;
   }
+  if (isTimeoutError(error)) {
+    return GatewayTimeoutError.createTimeoutError({
+      originalMessage: error instanceof Error ? error.message : "Unknown error",
+      cause: error
+    });
+  }
   if (import_provider.APICallError.isInstance(error)) {
-    return createGatewayErrorFromResponse({
+    if (error.cause && isTimeoutError(error.cause)) {
+      return GatewayTimeoutError.createTimeoutError({
+        originalMessage: error.message,
+        cause: error
+      });
+    }
+    return await createGatewayErrorFromResponse({
       response: extractApiCallResponse(error),
-      statusCode: (_a8 = error.statusCode) != null ? _a8 : 500,
+      statusCode: (_a9 = error.statusCode) != null ? _a9 : 500,
       defaultMessage: "Gateway request failed",
       cause: error,
       authMethod
     });
   }
-  return createGatewayErrorFromResponse({
+  return await createGatewayErrorFromResponse({
     response: {},
     statusCode: 500,
     defaultMessage: error instanceof Error ? `Gateway request failed: ${error.message}` : "Unknown Gateway error",
@@ -675,7 +744,7 @@ var GatewayEmbeddingModel = class {
     abortSignal,
     providerOptions
   }) {
-    var _a8;
+    var _a9;
     const resolvedHeaders = await (0, import_provider_utils6.resolve)(this.config.headers());
     try {
       const {
@@ -706,7 +775,7 @@ var GatewayEmbeddingModel = class {
       });
       return {
         embeddings: responseBody.embeddings,
-        usage: (_a8 = responseBody.usage) != null ? _a8 : void 0,
+        usage: (_a9 = responseBody.usage) != null ? _a9 : void 0,
         providerMetadata: responseBody.providerMetadata,
         response: { headers: responseHeaders, body: rawValue },
         warnings: []
@@ -761,7 +830,7 @@ var GatewayImageModel = class {
     headers,
     abortSignal
   }) {
-    var _a8, _b8, _c, _d;
+    var _a9, _b9, _c, _d;
     const resolvedHeaders = await (0, import_provider_utils7.resolve)(this.config.headers());
     try {
       const {
@@ -801,7 +870,7 @@ var GatewayImageModel = class {
       return {
         images: responseBody.images,
         // Always base64 strings from server
-        warnings: (_a8 = responseBody.warnings) != null ? _a8 : [],
+        warnings: (_a9 = responseBody.warnings) != null ? _a9 : [],
         providerMetadata: responseBody.providerMetadata,
         response: {
           timestamp: /* @__PURE__ */ new Date(),
@@ -810,7 +879,7 @@ var GatewayImageModel = class {
         },
         ...responseBody.usage != null && {
           usage: {
-            inputTokens: (_b8 = responseBody.usage.inputTokens) != null ? _b8 : void 0,
+            inputTokens: (_b9 = responseBody.usage.inputTokens) != null ? _b9 : void 0,
             outputTokens: (_c = responseBody.usage.outputTokens) != null ? _c : void 0,
             totalTokens: (_d = responseBody.usage.totalTokens) != null ? _d : void 0
           }
@@ -898,7 +967,7 @@ var GatewayVideoModel = class {
     headers,
     abortSignal
   }) {
-    var _a8;
+    var _a9;
     const resolvedHeaders = await (0, import_provider_utils8.resolve)(this.config.headers());
     try {
       const {
@@ -936,7 +1005,7 @@ var GatewayVideoModel = class {
       });
       return {
         videos: responseBody.videos,
-        warnings: (_a8 = responseBody.warnings) != null ? _a8 : [],
+        warnings: (_a9 = responseBody.warnings) != null ? _a9 : [],
         providerMetadata: responseBody.providerMetadata,
         response: {
           timestamp: /* @__PURE__ */ new Date(),
@@ -1179,25 +1248,25 @@ var gatewayTools = {
 var import_oidc = require("@vercel/oidc");
 var import_oidc2 = require("@vercel/oidc");
 async function getVercelRequestId() {
-  var _a8;
-  return (_a8 = (0, import_oidc.getContext)().headers) == null ? void 0 : _a8["x-vercel-id"];
+  var _a9;
+  return (_a9 = (0, import_oidc.getContext)().headers) == null ? void 0 : _a9["x-vercel-id"];
 }
 
 // src/gateway-provider.ts
 var import_provider_utils12 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "3.0.39" : "0.0.0-test";
+var VERSION = true ? "3.0.41" : "0.0.0-test";
 
 // src/gateway-provider.ts
 var AI_GATEWAY_PROTOCOL_VERSION = "0.0.1";
 function createGatewayProvider(options = {}) {
-  var _a8, _b8;
+  var _a9, _b9;
   let pendingMetadata = null;
   let metadataCache = null;
-  const cacheRefreshMillis = (_a8 = options.metadataCacheRefreshMillis) != null ? _a8 : 1e3 * 60 * 5;
+  const cacheRefreshMillis = (_a9 = options.metadataCacheRefreshMillis) != null ? _a9 : 1e3 * 60 * 5;
   let lastFetchTime = 0;
-  const baseURL = (_b8 = (0, import_provider_utils11.withoutTrailingSlash)(options.baseURL)) != null ? _b8 : "https://ai-gateway.vercel.sh/v3/ai";
+  const baseURL = (_b9 = (0, import_provider_utils11.withoutTrailingSlash)(options.baseURL)) != null ? _b9 : "https://ai-gateway.vercel.sh/v3/ai";
   const getHeaders = async () => {
     try {
       const auth = await getGatewayAuthToken(options);
@@ -1252,8 +1321,8 @@ function createGatewayProvider(options = {}) {
     });
   };
   const getAvailableModels = async () => {
-    var _a9, _b9, _c;
-    const now = (_c = (_b9 = (_a9 = options._internal) == null ? void 0 : _a9.currentDate) == null ? void 0 : _b9.call(_a9).getTime()) != null ? _c : Date.now();
+    var _a10, _b10, _c;
+    const now = (_c = (_b10 = (_a10 = options._internal) == null ? void 0 : _a10.currentDate) == null ? void 0 : _b10.call(_a10).getTime()) != null ? _c : Date.now();
     if (!pendingMetadata || now - lastFetchTime > cacheRefreshMillis) {
       lastFetchTime = now;
       pendingMetadata = new GatewayFetchMetadata({