@ai-sdk/openai-compatible 3.0.0-beta.3 → 3.0.0-beta.31

package/src/image/openai-compatible-image-model.ts

@@ -4,6 +4,10 @@ import {
   SharedV4ProviderOptions,
   SharedV4Warning,
 } from '@ai-sdk/provider';
+import {
+  toCamelCase,
+  warnIfDeprecatedProviderOptionsKey,
+} from '../utils/to-camel-case';
 import {
   combineHeaders,
   convertBase64ToUint8Array,
@@ -14,6 +18,9 @@ import {
   FetchFunction,
   postFormDataToApi,
   postJsonToApi,
+  serializeModelOptions,
+  WORKFLOW_SERIALIZE,
+  WORKFLOW_DESERIALIZE,
 } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 import {
@@ -24,7 +31,7 @@ import { OpenAICompatibleImageModelId } from './openai-compatible-image-settings
 
 export type OpenAICompatibleImageModelConfig = {
   provider: string;
-  headers: () => Record<string, string | undefined>;
+  headers?: () => Record<string, string | undefined>;
   url: (options: { modelId: string; path: string }) => string;
   fetch?: FetchFunction;
   errorStructure?: ProviderErrorStructure<any>;
@@ -48,15 +55,34 @@ export class OpenAICompatibleImageModel implements ImageModelV4 {
     return this.config.provider.split('.')[0].trim();
   }
 
+  static [WORKFLOW_SERIALIZE](model: OpenAICompatibleImageModel) {
+    return serializeModelOptions({
+      modelId: model.modelId,
+      config: model.config,
+    });
+  }
+
+  static [WORKFLOW_DESERIALIZE](options: {
+    modelId: string;
+    config: OpenAICompatibleImageModelConfig;
+  }) {
+    return new OpenAICompatibleImageModel(options.modelId, options.config);
+  }
+
   constructor(
     readonly modelId: OpenAICompatibleImageModelId,
     private readonly config: OpenAICompatibleImageModelConfig,
   ) {}
 
-  // TODO: deprecate non-camelCase keys and remove in future major version
   private getArgs(
     providerOptions: SharedV4ProviderOptions,
+    warnings: SharedV4Warning[],
   ): Record<string, unknown> {
+    warnIfDeprecatedProviderOptionsKey({
+      rawName: this.providerOptionsKey,
+      providerOptions,
+      warnings,
+    });
     return {
       ...providerOptions[this.providerOptionsKey],
       ...providerOptions[toCamelCase(this.providerOptionsKey)],
@@ -94,7 +120,7 @@ export class OpenAICompatibleImageModel implements ImageModelV4 {
 
     const currentDate = this.config._internal?.currentDate?.() ?? new Date();
 
-    const args = this.getArgs(providerOptions);
+    const args = this.getArgs(providerOptions, warnings);
 
     // Image editing mode - use form data and /images/edits endpoint
     if (files != null && files.length > 0) {
@@ -103,7 +129,7 @@ export class OpenAICompatibleImageModel implements ImageModelV4 {
           path: '/images/edits',
           modelId: this.modelId,
         }),
-        headers: combineHeaders(this.config.headers(), headers),
+        headers: combineHeaders(this.config.headers?.(), headers),
         formData: convertToFormData<OpenAICompatibleFormDataInput>({
           model: this.modelId,
           prompt,
@@ -140,7 +166,7 @@ export class OpenAICompatibleImageModel implements ImageModelV4 {
         path: '/images/generations',
         modelId: this.modelId,
       }),
-      headers: combineHeaders(this.config.headers(), headers),
+      headers: combineHeaders(this.config.headers?.(), headers),
       body: {
         model: this.modelId,
         prompt,
@@ -199,7 +225,3 @@ async function fileToBlob(file: ImageModelV4File): Promise<Blob> {
 
   return new Blob([data as BlobPart], { type: file.mediaType });
 }
-
-function toCamelCase(str: string): string {
-  return str.replace(/[_-]([a-z])/g, g => g[1].toUpperCase());
-}

package/src/utils/to-camel-case.ts

@@ -0,0 +1,43 @@
+import { SharedV4Warning } from '@ai-sdk/provider';
+
+export function toCamelCase(str: string): string {
+  return str.replace(/[_-]([a-z])/g, g => g[1].toUpperCase());
+}
+
+/**
+Resolves which key to use for providerMetadata based on what the caller
+passed in providerOptions. Returns the camelCase variant when the caller
+supplied it, otherwise falls back to the raw name.
+*/
+export function resolveProviderOptionsKey(
+  rawName: string,
+  providerOptions: Record<string, unknown> | undefined,
+): string {
+  const camelName = toCamelCase(rawName);
+  if (camelName !== rawName && providerOptions?.[camelName] != null) {
+    return camelName;
+  }
+  return rawName;
+}
+
+/**
+Pushes a deprecation warning when the user supplies providerOptions under a non-camelCase key
+*/
+export function warnIfDeprecatedProviderOptionsKey({
+  rawName,
+  providerOptions,
+  warnings,
+}: {
+  rawName: string;
+  providerOptions: Record<string, unknown> | undefined;
+  warnings: SharedV4Warning[];
+}): void {
+  const camelName = toCamelCase(rawName);
+  if (camelName !== rawName && providerOptions?.[rawName] != null) {
+    warnings.push({
+      type: 'deprecated',
+      setting: `providerOptions key '${rawName}'`,
+      message: `Use '${camelName}' instead.`,
+    });
+  }
+}

package/dist/index.d.mts

@@ -1,290 +0,0 @@
-import { SharedV4ProviderMetadata, LanguageModelV4, LanguageModelV4CallOptions, LanguageModelV4GenerateResult, LanguageModelV4StreamResult, EmbeddingModelV4, ImageModelV4, ProviderV4 } from '@ai-sdk/provider';
-import { FetchFunction } from '@ai-sdk/provider-utils';
-import { ZodType, z } from 'zod/v4';
-
-declare const openaiCompatibleErrorDataSchema: z.ZodObject<{
-    error: z.ZodObject<{
-        message: z.ZodString;
-        type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        param: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
-        code: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
-    }, z.core.$strip>;
-}, z.core.$strip>;
-type OpenAICompatibleErrorData = z.infer<typeof openaiCompatibleErrorDataSchema>;
-type ProviderErrorStructure<T> = {
-    errorSchema: ZodType<T>;
-    errorToMessage: (error: T) => string;
-    isRetryable?: (response: Response, error?: T) => boolean;
-};
-
-type OpenAICompatibleChatModelId = string;
-declare const openaiCompatibleLanguageModelChatOptions: z.ZodObject<{
-    user: z.ZodOptional<z.ZodString>;
-    reasoningEffort: z.ZodOptional<z.ZodString>;
-    textVerbosity: z.ZodOptional<z.ZodString>;
-    strictJsonSchema: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;
-type OpenAICompatibleLanguageModelChatOptions = z.infer<typeof openaiCompatibleLanguageModelChatOptions>;
-
-/**
- * Extracts provider-specific metadata from API responses.
- * Used to standardize metadata handling across different LLM providers while allowing
- * provider-specific metadata to be captured.
- */
-type MetadataExtractor = {
-    /**
-     * Extracts provider metadata from a complete, non-streaming response.
-     *
-     * @param parsedBody - The parsed response JSON body from the provider's API.
-     *
-     * @returns Provider-specific metadata or undefined if no metadata is available.
-     *          The metadata should be under a key indicating the provider id.
-     */
-    extractMetadata: ({ parsedBody, }: {
-        parsedBody: unknown;
-    }) => Promise<SharedV4ProviderMetadata | undefined>;
-    /**
-     * Creates an extractor for handling streaming responses. The returned object provides
-     * methods to process individual chunks and build the final metadata from the accumulated
-     * stream data.
-     *
-     * @returns An object with methods to process chunks and build metadata from a stream
-     */
-    createStreamExtractor: () => {
-        /**
-         * Process an individual chunk from the stream. Called for each chunk in the response stream
-         * to accumulate metadata throughout the streaming process.
-         *
-         * @param parsedChunk - The parsed JSON response chunk from the provider's API
-         */
-        processChunk(parsedChunk: unknown): void;
-        /**
-         * Builds the metadata object after all chunks have been processed.
-         * Called at the end of the stream to generate the complete provider metadata.
-         *
-         * @returns Provider-specific metadata or undefined if no metadata is available.
-         *          The metadata should be under a key indicating the provider id.
-         */
-        buildMetadata(): SharedV4ProviderMetadata | undefined;
-    };
-};
-
-type OpenAICompatibleChatConfig = {
-    provider: string;
-    headers: () => Record<string, string | undefined>;
-    url: (options: {
-        modelId: string;
-        path: string;
-    }) => string;
-    fetch?: FetchFunction;
-    includeUsage?: boolean;
-    errorStructure?: ProviderErrorStructure<any>;
-    metadataExtractor?: MetadataExtractor;
-    /**
-     * Whether the model supports structured outputs.
-     */
-    supportsStructuredOutputs?: boolean;
-    /**
-     * The supported URLs for the model.
-     */
-    supportedUrls?: () => LanguageModelV4['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>;
-};
-declare class OpenAICompatibleChatLanguageModel implements LanguageModelV4 {
-    readonly specificationVersion = "v4";
-    readonly supportsStructuredOutputs: boolean;
-    readonly modelId: OpenAICompatibleChatModelId;
-    private readonly config;
-    private readonly failedResponseHandler;
-    private readonly chunkSchema;
-    constructor(modelId: OpenAICompatibleChatModelId, config: OpenAICompatibleChatConfig);
-    get provider(): string;
-    private get providerOptionsName();
-    get supportedUrls(): Record<string, RegExp[]> | PromiseLike<Record<string, RegExp[]>>;
-    private transformRequestBody;
-    private getArgs;
-    doGenerate(options: LanguageModelV4CallOptions): Promise<LanguageModelV4GenerateResult>;
-    doStream(options: LanguageModelV4CallOptions): Promise<LanguageModelV4StreamResult>;
-}
-
-type OpenAICompatibleCompletionModelId = string;
-declare const openaiCompatibleLanguageModelCompletionOptions: z.ZodObject<{
-    echo: z.ZodOptional<z.ZodBoolean>;
-    logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
-    suffix: z.ZodOptional<z.ZodString>;
-    user: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-type OpenAICompatibleLanguageModelCompletionOptions = z.infer<typeof openaiCompatibleLanguageModelCompletionOptions>;
-
-type OpenAICompatibleCompletionConfig = {
-    provider: string;
-    includeUsage?: boolean;
-    headers: () => Record<string, string | undefined>;
-    url: (options: {
-        modelId: string;
-        path: string;
-    }) => string;
-    fetch?: FetchFunction;
-    errorStructure?: ProviderErrorStructure<any>;
-    /**
-     * The supported URLs for the model.
-     */
-    supportedUrls?: () => LanguageModelV4['supportedUrls'];
-};
-declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV4 {
-    readonly specificationVersion = "v4";
-    readonly modelId: OpenAICompatibleCompletionModelId;
-    private readonly config;
-    private readonly failedResponseHandler;
-    private readonly chunkSchema;
-    constructor(modelId: OpenAICompatibleCompletionModelId, config: OpenAICompatibleCompletionConfig);
-    get provider(): string;
-    private get providerOptionsName();
-    get supportedUrls(): Record<string, RegExp[]> | PromiseLike<Record<string, RegExp[]>>;
-    private getArgs;
-    doGenerate(options: LanguageModelV4CallOptions): Promise<LanguageModelV4GenerateResult>;
-    doStream(options: LanguageModelV4CallOptions): Promise<LanguageModelV4StreamResult>;
-}
-
-type OpenAICompatibleEmbeddingModelId = string;
-declare const openaiCompatibleEmbeddingModelOptions: z.ZodObject<{
-    dimensions: z.ZodOptional<z.ZodNumber>;
-    user: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-type OpenAICompatibleEmbeddingModelOptions = z.infer<typeof openaiCompatibleEmbeddingModelOptions>;
-
-type OpenAICompatibleEmbeddingConfig = {
-    /**
-     * Override the maximum number of embeddings per call.
-     */
-    maxEmbeddingsPerCall?: number;
-    /**
-     * Override the parallelism of embedding calls.
-     */
-    supportsParallelCalls?: boolean;
-    provider: string;
-    url: (options: {
-        modelId: string;
-        path: string;
-    }) => string;
-    headers: () => Record<string, string | undefined>;
-    fetch?: FetchFunction;
-    errorStructure?: ProviderErrorStructure<any>;
-};
-declare class OpenAICompatibleEmbeddingModel implements EmbeddingModelV4 {
-    readonly specificationVersion = "v4";
-    readonly modelId: OpenAICompatibleEmbeddingModelId;
-    private readonly config;
-    get provider(): string;
-    get maxEmbeddingsPerCall(): number;
-    get supportsParallelCalls(): boolean;
-    constructor(modelId: OpenAICompatibleEmbeddingModelId, config: OpenAICompatibleEmbeddingConfig);
-    private get providerOptionsName();
-    doEmbed({ values, headers, abortSignal, providerOptions, }: Parameters<EmbeddingModelV4['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV4['doEmbed']>>>;
-}
-
-type OpenAICompatibleImageModelId = string;
-
-type OpenAICompatibleImageModelConfig = {
-    provider: string;
-    headers: () => Record<string, string | undefined>;
-    url: (options: {
-        modelId: string;
-        path: string;
-    }) => string;
-    fetch?: FetchFunction;
-    errorStructure?: ProviderErrorStructure<any>;
-    _internal?: {
-        currentDate?: () => Date;
-    };
-};
-declare class OpenAICompatibleImageModel implements ImageModelV4 {
-    readonly modelId: OpenAICompatibleImageModelId;
-    private readonly config;
-    readonly specificationVersion = "v4";
-    readonly maxImagesPerCall = 10;
-    get provider(): string;
-    /**
-     * The provider options key used to extract provider-specific options.
-     */
-    private get providerOptionsKey();
-    constructor(modelId: OpenAICompatibleImageModelId, config: OpenAICompatibleImageModelConfig);
-    private getArgs;
-    doGenerate({ prompt, n, size, aspectRatio, seed, providerOptions, headers, abortSignal, files, mask, }: Parameters<ImageModelV4['doGenerate']>[0]): Promise<Awaited<ReturnType<ImageModelV4['doGenerate']>>>;
-}
-
-interface OpenAICompatibleProvider<CHAT_MODEL_IDS extends string = string, COMPLETION_MODEL_IDS extends string = string, EMBEDDING_MODEL_IDS extends string = string, IMAGE_MODEL_IDS extends string = string> extends Omit<ProviderV4, 'imageModel'> {
-    (modelId: CHAT_MODEL_IDS): LanguageModelV4;
-    languageModel(modelId: CHAT_MODEL_IDS, config?: Partial<OpenAICompatibleChatConfig>): LanguageModelV4;
-    chatModel(modelId: CHAT_MODEL_IDS): LanguageModelV4;
-    completionModel(modelId: COMPLETION_MODEL_IDS): LanguageModelV4;
-    embeddingModel(modelId: EMBEDDING_MODEL_IDS): EmbeddingModelV4;
-    /**
-     * @deprecated Use `embeddingModel` instead.
-     */
-    textEmbeddingModel(modelId: EMBEDDING_MODEL_IDS): EmbeddingModelV4;
-    imageModel(modelId: IMAGE_MODEL_IDS): ImageModelV4;
-}
-interface OpenAICompatibleProviderSettings {
-    /**
-     * Base URL for the API calls.
-     */
-    baseURL: string;
-    /**
-     * Provider name.
-     */
-    name: string;
-    /**
-     * API key for authenticating requests. If specified, adds an `Authorization`
-     * header to request headers with the value `Bearer <apiKey>`. This will be added
-     * before any headers potentially specified in the `headers` option.
-     */
-    apiKey?: string;
-    /**
-     * Optional custom headers to include in requests. These will be added to request headers
-     * after any headers potentially added by use of the `apiKey` option.
-     */
-    headers?: Record<string, string>;
-    /**
-     * Optional custom url query parameters to include in request urls.
-     */
-    queryParams?: Record<string, string>;
-    /**
-     * Custom fetch implementation. You can use it as a middleware to intercept requests,
-     * or to provide a custom fetch implementation for e.g. testing.
-     */
-    fetch?: FetchFunction;
-    /**
-     * Include usage information in streaming responses.
-     */
-    includeUsage?: boolean;
-    /**
-     * 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;
-}
-/**
- * Create an OpenAICompatible provider instance.
- */
-declare function createOpenAICompatible<CHAT_MODEL_IDS extends string, COMPLETION_MODEL_IDS extends string, EMBEDDING_MODEL_IDS extends string, IMAGE_MODEL_IDS extends string>(options: OpenAICompatibleProviderSettings): OpenAICompatibleProvider<CHAT_MODEL_IDS, COMPLETION_MODEL_IDS, EMBEDDING_MODEL_IDS, IMAGE_MODEL_IDS>;
-
-declare const VERSION: string;
-
-export { type MetadataExtractor, OpenAICompatibleChatLanguageModel, type OpenAICompatibleChatModelId, OpenAICompatibleCompletionLanguageModel, type OpenAICompatibleCompletionModelId, type OpenAICompatibleLanguageModelCompletionOptions as OpenAICompatibleCompletionProviderOptions, OpenAICompatibleEmbeddingModel, type OpenAICompatibleEmbeddingModelId, type OpenAICompatibleEmbeddingModelOptions, type OpenAICompatibleEmbeddingModelOptions as OpenAICompatibleEmbeddingProviderOptions, type OpenAICompatibleErrorData, OpenAICompatibleImageModel, type OpenAICompatibleLanguageModelChatOptions, type OpenAICompatibleLanguageModelCompletionOptions, type OpenAICompatibleProvider, type OpenAICompatibleLanguageModelChatOptions as OpenAICompatibleProviderOptions, type OpenAICompatibleProviderSettings, type ProviderErrorStructure, VERSION, createOpenAICompatible };