@ai-sdk/openai-compatible 1.0.37 → 1.0.39

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @ai-sdk/openai-compatible
 
+## 1.0.39
+
+### Patch Changes
+
+- cb61408: feat(vertex): add grok models to vertex provider
+
+## 1.0.38
+
+### Patch Changes
+
+- 783fa6c: chore: ensure consistent import handling and avoid import duplicates or cycles
+- Updated dependencies [783fa6c]
+  - @ai-sdk/provider-utils@3.0.25
+  - @ai-sdk/provider@2.0.3
+
 ## 1.0.37
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { SharedV2ProviderMetadata, LanguageModelV2, EmbeddingModelV2, ImageModelV2, ProviderV2 } from '@ai-sdk/provider';
+import { SharedV2ProviderMetadata, LanguageModelV2, LanguageModelV2Usage, EmbeddingModelV2, ImageModelV2, ProviderV2 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { z, ZodType } from 'zod/v4';
 
@@ -87,6 +87,17 @@ type OpenAICompatibleChatConfig = {
      * The supported URLs for the model.
      */
     supportedUrls?: () => LanguageModelV2['supportedUrls'];
+    /**
+     * Optional function to transform the request body before sending it to the API.
+     * This is useful for proxy providers that may require a different request format
+     * than the official OpenAI API.
+     */
+    transformRequestBody?: (args: Record<string, any>) => Record<string, any>;
+    /**
+     * Optional usage converter for OpenAI-compatible providers with different
+     * token accounting semantics.
+     */
+    convertUsage?: (usage: z.infer<typeof openaiCompatibleTokenUsageSchema>) => LanguageModelV2Usage;
 };
 declare class OpenAICompatibleChatLanguageModel implements LanguageModelV2 {
     readonly specificationVersion = "v2";
@@ -99,10 +110,25 @@ declare class OpenAICompatibleChatLanguageModel implements LanguageModelV2 {
     get provider(): string;
     private get providerOptionsName();
     get supportedUrls(): Record<string, RegExp[]> | PromiseLike<Record<string, RegExp[]>>;
+    private transformRequestBody;
+    private convertUsage;
     private getArgs;
     doGenerate(options: Parameters<LanguageModelV2['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV2['doGenerate']>>>;
     doStream(options: Parameters<LanguageModelV2['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
 }
+declare const openaiCompatibleTokenUsageSchema: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    prompt_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    completion_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    total_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    prompt_tokens_details: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        cached_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>>;
+    completion_tokens_details: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        reasoning_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        accepted_prediction_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        rejected_prediction_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>>>;
 
 type OpenAICompatibleCompletionModelId = string;
 declare const openaiCompatibleCompletionProviderOptions: z.ZodObject<{
@@ -254,6 +280,27 @@ interface OpenAICompatibleProviderSettings {
      * Whether the provider supports structured outputs in chat models.
      */
     supportsStructuredOutputs?: boolean;
+    /**
+     * Optional function to transform the request body before sending it to the API.
+     * This is useful for proxy providers that may require a different request format
+     * than the official OpenAI API.
+     */
+    transformRequestBody?: (args: Record<string, any>) => Record<string, any>;
+    /**
+     * Optional metadata extractor to capture provider-specific metadata from API responses.
+     * This is useful for extracting non-standard fields, experimental features,
+     * or provider-specific metrics from both streaming and non-streaming responses.
+     */
+    metadataExtractor?: MetadataExtractor;
+    /**
+     * The supported URLs for chat models.
+     */
+    supportedUrls?: OpenAICompatibleChatConfig['supportedUrls'];
+    /**
+     * Optional usage converter for providers with token accounting semantics that
+     * differ from the default OpenAI-compatible shape.
+     */
+    convertUsage?: OpenAICompatibleChatConfig['convertUsage'];
 }
 /**
 Create an OpenAICompatible provider instance.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { SharedV2ProviderMetadata, LanguageModelV2, EmbeddingModelV2, ImageModelV2, ProviderV2 } from '@ai-sdk/provider';
+import { SharedV2ProviderMetadata, LanguageModelV2, LanguageModelV2Usage, EmbeddingModelV2, ImageModelV2, ProviderV2 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { z, ZodType } from 'zod/v4';
 
@@ -87,6 +87,17 @@ type OpenAICompatibleChatConfig = {
      * The supported URLs for the model.
      */
     supportedUrls?: () => LanguageModelV2['supportedUrls'];
+    /**
+     * Optional function to transform the request body before sending it to the API.
+     * This is useful for proxy providers that may require a different request format
+     * than the official OpenAI API.
+     */
+    transformRequestBody?: (args: Record<string, any>) => Record<string, any>;
+    /**
+     * Optional usage converter for OpenAI-compatible providers with different
+     * token accounting semantics.
+     */
+    convertUsage?: (usage: z.infer<typeof openaiCompatibleTokenUsageSchema>) => LanguageModelV2Usage;
 };
 declare class OpenAICompatibleChatLanguageModel implements LanguageModelV2 {
     readonly specificationVersion = "v2";
@@ -99,10 +110,25 @@ declare class OpenAICompatibleChatLanguageModel implements LanguageModelV2 {
     get provider(): string;
     private get providerOptionsName();
     get supportedUrls(): Record<string, RegExp[]> | PromiseLike<Record<string, RegExp[]>>;
+    private transformRequestBody;
+    private convertUsage;
     private getArgs;
     doGenerate(options: Parameters<LanguageModelV2['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV2['doGenerate']>>>;
     doStream(options: Parameters<LanguageModelV2['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
 }
+declare const openaiCompatibleTokenUsageSchema: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    prompt_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    completion_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    total_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    prompt_tokens_details: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        cached_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>>;
+    completion_tokens_details: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        reasoning_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        accepted_prediction_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        rejected_prediction_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>>>;
 
 type OpenAICompatibleCompletionModelId = string;
 declare const openaiCompatibleCompletionProviderOptions: z.ZodObject<{
@@ -254,6 +280,27 @@ interface OpenAICompatibleProviderSettings {
      * Whether the provider supports structured outputs in chat models.
      */
     supportsStructuredOutputs?: boolean;
+    /**
+     * Optional function to transform the request body before sending it to the API.
+     * This is useful for proxy providers that may require a different request format
+     * than the official OpenAI API.
+     */
+    transformRequestBody?: (args: Record<string, any>) => Record<string, any>;
+    /**
+     * Optional metadata extractor to capture provider-specific metadata from API responses.
+     * This is useful for extracting non-standard fields, experimental features,
+     * or provider-specific metrics from both streaming and non-streaming responses.
+     */
+    metadataExtractor?: MetadataExtractor;
+    /**
+     * The supported URLs for chat models.
+     */
+    supportedUrls?: OpenAICompatibleChatConfig['supportedUrls'];
+    /**
+     * Optional usage converter for providers with token accounting semantics that
+     * differ from the default OpenAI-compatible shape.
+     */
+    convertUsage?: OpenAICompatibleChatConfig['convertUsage'];
 }
 /**
 Create an OpenAICompatible provider instance.

package/dist/index.js

@@ -305,6 +305,14 @@ var OpenAICompatibleChatLanguageModel = class {
     var _a, _b, _c;
     return (_c = (_b = (_a = this.config).supportedUrls) == null ? void 0 : _b.call(_a)) != null ? _c : {};
   }
+  transformRequestBody(args) {
+    var _a, _b, _c;
+    return (_c = (_b = (_a = this.config).transformRequestBody) == null ? void 0 : _b.call(_a, args)) != null ? _c : args;
+  }
+  convertUsage(usage) {
+    var _a, _b, _c;
+    return (_c = (_b = (_a = this.config).convertUsage) == null ? void 0 : _b.call(_a, usage)) != null ? _c : convertOpenAICompatibleChatUsage(usage);
+  }
   async getArgs({
     prompt,
     maxOutputTokens,
@@ -393,9 +401,10 @@ var OpenAICompatibleChatLanguageModel = class {
     };
   }
   async doGenerate(options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q;
+    var _a, _b, _c, _d, _e;
     const { args, warnings } = await this.getArgs({ ...options });
-    const body = JSON.stringify(args);
+    const transformedArgs = this.transformRequestBody(args);
+    const body = JSON.stringify(transformedArgs);
     const {
       responseHeaders,
       value: responseBody,
@@ -406,7 +415,7 @@ var OpenAICompatibleChatLanguageModel = class {
         modelId: this.modelId
       }),
       headers: (0, import_provider_utils2.combineHeaders)(this.config.headers(), options.headers),
-      body: args,
+      body: transformedArgs,
       failedResponseHandler: this.failedResponseHandler,
       successfulResponseHandler: (0, import_provider_utils2.createJsonResponseHandler)(
         OpenAICompatibleChatResponseSchema
@@ -453,13 +462,7 @@ var OpenAICompatibleChatLanguageModel = class {
     return {
       content,
       finishReason: mapOpenAICompatibleFinishReason(choice.finish_reason),
-      usage: {
-        inputTokens: (_g = (_f = responseBody.usage) == null ? void 0 : _f.prompt_tokens) != null ? _g : void 0,
-        outputTokens: (_i = (_h = responseBody.usage) == null ? void 0 : _h.completion_tokens) != null ? _i : void 0,
-        totalTokens: (_k = (_j = responseBody.usage) == null ? void 0 : _j.total_tokens) != null ? _k : void 0,
-        reasoningTokens: (_n = (_m = (_l = responseBody.usage) == null ? void 0 : _l.completion_tokens_details) == null ? void 0 : _m.reasoning_tokens) != null ? _n : void 0,
-        cachedInputTokens: (_q = (_p = (_o = responseBody.usage) == null ? void 0 : _o.prompt_tokens_details) == null ? void 0 : _p.cached_tokens) != null ? _q : void 0
-      },
+      usage: this.convertUsage(responseBody.usage),
       providerMetadata,
       request: { body },
       response: {
@@ -473,12 +476,12 @@ var OpenAICompatibleChatLanguageModel = class {
   async doStream(options) {
     var _a;
     const { args, warnings } = await this.getArgs({ ...options });
-    const body = {
+    const body = this.transformRequestBody({
       ...args,
       stream: true,
       // only include stream_options when in strict compatibility mode:
       stream_options: this.config.includeUsage ? { include_usage: true } : void 0
-    };
+    });
     const metadataExtractor = (_a = this.config.metadataExtractor) == null ? void 0 : _a.createStreamExtractor();
     const { responseHeaders, value: response } = await (0, import_provider_utils2.postJsonToApi)({
       url: this.config.url({
@@ -509,10 +512,12 @@ var OpenAICompatibleChatLanguageModel = class {
       },
       totalTokens: void 0
     };
+    let lastUsage = void 0;
     let isFirstChunk = true;
     const providerOptionsName = this.providerOptionsName;
     let isActiveReasoning = false;
     let isActiveText = false;
+    const convertUsage = (usage2) => this.convertUsage(usage2);
     return {
       stream: response.pipeThrough(
         new TransformStream({
@@ -545,6 +550,7 @@ var OpenAICompatibleChatLanguageModel = class {
               });
             }
             if (value.usage != null) {
+              lastUsage = value.usage;
               const {
                 prompt_tokens,
                 completion_tokens,
@@ -688,7 +694,7 @@ var OpenAICompatibleChatLanguageModel = class {
             }
           },
           flush(controller) {
-            var _a2, _b, _c, _d, _e, _f;
+            var _a2;
             if (isActiveReasoning) {
               controller.enqueue({ type: "reasoning-end", id: "reasoning-0" });
             }
@@ -722,13 +728,7 @@ var OpenAICompatibleChatLanguageModel = class {
             controller.enqueue({
               type: "finish",
               finishReason,
-              usage: {
-                inputTokens: (_b = usage.promptTokens) != null ? _b : void 0,
-                outputTokens: (_c = usage.completionTokens) != null ? _c : void 0,
-                totalTokens: (_d = usage.totalTokens) != null ? _d : void 0,
-                reasoningTokens: (_e = usage.completionTokensDetails.reasoningTokens) != null ? _e : void 0,
-                cachedInputTokens: (_f = usage.promptTokensDetails.cachedTokens) != null ? _f : void 0
-              },
+              usage: convertUsage(lastUsage),
               providerMetadata
             });
           }
@@ -752,6 +752,16 @@ var openaiCompatibleTokenUsageSchema = import_v43.z.object({
     rejected_prediction_tokens: import_v43.z.number().nullish()
   }).nullish()
 }).nullish();
+function convertOpenAICompatibleChatUsage(usage) {
+  var _a, _b, _c, _d, _e, _f, _g;
+  return {
+    inputTokens: (_a = usage == null ? void 0 : usage.prompt_tokens) != null ? _a : void 0,
+    outputTokens: (_b = usage == null ? void 0 : usage.completion_tokens) != null ? _b : void 0,
+    totalTokens: (_c = usage == null ? void 0 : usage.total_tokens) != null ? _c : void 0,
+    reasoningTokens: (_e = (_d = usage == null ? void 0 : usage.completion_tokens_details) == null ? void 0 : _d.reasoning_tokens) != null ? _e : void 0,
+    cachedInputTokens: (_g = (_f = usage == null ? void 0 : usage.prompt_tokens_details) == null ? void 0 : _f.cached_tokens) != null ? _g : void 0
+  };
+}
 var OpenAICompatibleChatResponseSchema = import_v43.z.object({
   id: import_v43.z.string().nullish(),
   created: import_v43.z.number().nullish(),
@@ -1401,7 +1411,7 @@ var openaiCompatibleImageResponseSchema = import_v48.z.object({
 var import_provider_utils6 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "1.0.37" : "0.0.0-test";
+var VERSION = true ? "1.0.39" : "0.0.0-test";
 
 // src/openai-compatible-provider.ts
 function createOpenAICompatible(options) {
@@ -1428,7 +1438,11 @@ function createOpenAICompatible(options) {
   const createChatModel = (modelId) => new OpenAICompatibleChatLanguageModel(modelId, {
     ...getCommonModelConfig("chat"),
     includeUsage: options.includeUsage,
-    supportsStructuredOutputs: options.supportsStructuredOutputs
+    supportsStructuredOutputs: options.supportsStructuredOutputs,
+    supportedUrls: options.supportedUrls,
+    transformRequestBody: options.transformRequestBody,
+    metadataExtractor: options.metadataExtractor,
+    convertUsage: options.convertUsage
   });
   const createCompletionModel = (modelId) => new OpenAICompatibleCompletionLanguageModel(modelId, {
     ...getCommonModelConfig("completion"),