@ai-sdk/openai-compatible 3.0.0-beta.2 → 3.0.0-beta.21

package/src/openai-compatible-provider.ts

@@ -1,8 +1,8 @@
 import {
-  EmbeddingModelV3,
-  ImageModelV3,
-  LanguageModelV3,
-  ProviderV3,
+  EmbeddingModelV4,
+  ImageModelV4,
+  LanguageModelV4,
+  ProviderV4,
 } from '@ai-sdk/provider';
 import {
   FetchFunction,
@@ -24,26 +24,26 @@ export interface OpenAICompatibleProvider<
   COMPLETION_MODEL_IDS extends string = string,
   EMBEDDING_MODEL_IDS extends string = string,
   IMAGE_MODEL_IDS extends string = string,
-> extends Omit<ProviderV3, 'imageModel'> {
-  (modelId: CHAT_MODEL_IDS): LanguageModelV3;
+> extends Omit<ProviderV4, 'imageModel'> {
+  (modelId: CHAT_MODEL_IDS): LanguageModelV4;
 
   languageModel(
     modelId: CHAT_MODEL_IDS,
     config?: Partial<OpenAICompatibleChatConfig>,
-  ): LanguageModelV3;
+  ): LanguageModelV4;
 
-  chatModel(modelId: CHAT_MODEL_IDS): LanguageModelV3;
+  chatModel(modelId: CHAT_MODEL_IDS): LanguageModelV4;
 
-  completionModel(modelId: COMPLETION_MODEL_IDS): LanguageModelV3;
+  completionModel(modelId: COMPLETION_MODEL_IDS): LanguageModelV4;
 
-  embeddingModel(modelId: EMBEDDING_MODEL_IDS): EmbeddingModelV3;
+  embeddingModel(modelId: EMBEDDING_MODEL_IDS): EmbeddingModelV4;
 
   /**
    * @deprecated Use `embeddingModel` instead.
    */
-  textEmbeddingModel(modelId: EMBEDDING_MODEL_IDS): EmbeddingModelV3;
+  textEmbeddingModel(modelId: EMBEDDING_MODEL_IDS): EmbeddingModelV4;
 
-  imageModel(modelId: IMAGE_MODEL_IDS): ImageModelV3;
+  imageModel(modelId: IMAGE_MODEL_IDS): ImageModelV4;
 }
 
 export interface OpenAICompatibleProviderSettings {
@@ -181,7 +181,7 @@ export function createOpenAICompatible<
 
   const provider = (modelId: CHAT_MODEL_IDS) => createLanguageModel(modelId);
 
-  provider.specificationVersion = 'v3' as const;
+  provider.specificationVersion = 'v4' as const;
   provider.languageModel = createLanguageModel;
   provider.chatModel = createChatModel;
   provider.completionModel = createCompletionModel;

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.`,
+    });
+  }
+}