@ai-sdk/openai-compatible 3.0.0-beta.23 → 3.0.0-beta.25

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @ai-sdk/openai-compatible
 
+## 3.0.0-beta.25
+
+### Patch Changes
+
+- b3976a2: Add workflow serialization support to all provider models.
+
+  **`@ai-sdk/provider-utils`:** New `serializeModel()` helper that extracts only serializable properties from a model instance, filtering out functions and objects containing functions. Third-party provider authors can use this to add workflow support to their own models.
+
+  **All providers:** `headers` is now optional in provider config types. This is non-breaking — existing code that passes `headers` continues to work. Custom provider implementations that construct model configs manually can now omit `headers`, which is useful when models are deserialized from a workflow step boundary where auth is provided separately.
+
+  All provider model classes now include `WORKFLOW_SERIALIZE` and `WORKFLOW_DESERIALIZE` static methods, enabling them to cross workflow step boundaries without serialization errors.
+
+- Updated dependencies [b3976a2]
+- Updated dependencies [ff5eba1]
+  - @ai-sdk/provider-utils@5.0.0-beta.20
+  - @ai-sdk/provider@4.0.0-beta.12
+
+## 3.0.0-beta.24
+
+### Major Changes
+
+- ef992f8: Remove CommonJS exports from all packages. All packages are now ESM-only (`"type": "module"`). Consumers using `require()` must switch to ESM `import` syntax.
+
+### Patch Changes
+
+- Updated dependencies [ef992f8]
+  - @ai-sdk/provider@4.0.0-beta.11
+  - @ai-sdk/provider-utils@5.0.0-beta.19
+
 ## 3.0.0-beta.23
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,5 +1,6 @@
+import * as _ai_sdk_provider from '@ai-sdk/provider';
 import { SharedV4ProviderMetadata, LanguageModelV4, LanguageModelV4CallOptions, LanguageModelV4GenerateResult, LanguageModelV4StreamResult, EmbeddingModelV4, ImageModelV4, ProviderV4 } from '@ai-sdk/provider';
-import { FetchFunction } from '@ai-sdk/provider-utils';
+import { FetchFunction, WORKFLOW_SERIALIZE, WORKFLOW_DESERIALIZE } from '@ai-sdk/provider-utils';
 import { ZodType, z } from 'zod/v4';
 
 declare const openaiCompatibleErrorDataSchema: z.ZodObject<{
@@ -71,7 +72,7 @@ type MetadataExtractor = {
 
 type OpenAICompatibleChatConfig = {
     provider: string;
-    headers: () => Record<string, string | undefined>;
+    headers?: () => Record<string, string | undefined>;
     url: (options: {
         modelId: string;
         path: string;
@@ -99,9 +100,17 @@ declare class OpenAICompatibleChatLanguageModel implements LanguageModelV4 {
     readonly specificationVersion = "v4";
     readonly supportsStructuredOutputs: boolean;
     readonly modelId: OpenAICompatibleChatModelId;
-    private readonly config;
+    protected readonly config: OpenAICompatibleChatConfig;
     private readonly failedResponseHandler;
     private readonly chunkSchema;
+    static [WORKFLOW_SERIALIZE](model: OpenAICompatibleChatLanguageModel): {
+        modelId: string;
+        config: _ai_sdk_provider.JSONObject;
+    };
+    static [WORKFLOW_DESERIALIZE](options: {
+        modelId: string;
+        config: OpenAICompatibleChatConfig;
+    }): OpenAICompatibleChatLanguageModel;
     constructor(modelId: OpenAICompatibleChatModelId, config: OpenAICompatibleChatConfig);
     get provider(): string;
     private get providerOptionsName();
@@ -124,7 +133,7 @@ type OpenAICompatibleLanguageModelCompletionOptions = z.infer<typeof openaiCompa
 type OpenAICompatibleCompletionConfig = {
     provider: string;
     includeUsage?: boolean;
-    headers: () => Record<string, string | undefined>;
+    headers?: () => Record<string, string | undefined>;
     url: (options: {
         modelId: string;
         path: string;
@@ -142,6 +151,14 @@ declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV4
     private readonly config;
     private readonly failedResponseHandler;
     private readonly chunkSchema;
+    static [WORKFLOW_SERIALIZE](model: OpenAICompatibleCompletionLanguageModel): {
+        modelId: string;
+        config: _ai_sdk_provider.JSONObject;
+    };
+    static [WORKFLOW_DESERIALIZE](options: {
+        modelId: string;
+        config: OpenAICompatibleCompletionConfig;
+    }): OpenAICompatibleCompletionLanguageModel;
     constructor(modelId: OpenAICompatibleCompletionModelId, config: OpenAICompatibleCompletionConfig);
     get provider(): string;
     private get providerOptionsName();
@@ -172,7 +189,7 @@ type OpenAICompatibleEmbeddingConfig = {
         modelId: string;
         path: string;
     }) => string;
-    headers: () => Record<string, string | undefined>;
+    headers?: () => Record<string, string | undefined>;
     fetch?: FetchFunction;
     errorStructure?: ProviderErrorStructure<any>;
 };
@@ -183,6 +200,14 @@ declare class OpenAICompatibleEmbeddingModel implements EmbeddingModelV4 {
     get provider(): string;
     get maxEmbeddingsPerCall(): number;
     get supportsParallelCalls(): boolean;
+    static [WORKFLOW_SERIALIZE](model: OpenAICompatibleEmbeddingModel): {
+        modelId: string;
+        config: _ai_sdk_provider.JSONObject;
+    };
+    static [WORKFLOW_DESERIALIZE](options: {
+        modelId: string;
+        config: OpenAICompatibleEmbeddingConfig;
+    }): OpenAICompatibleEmbeddingModel;
     constructor(modelId: OpenAICompatibleEmbeddingModelId, config: OpenAICompatibleEmbeddingConfig);
     private get providerOptionsName();
     doEmbed({ values, headers, abortSignal, providerOptions, }: Parameters<EmbeddingModelV4['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV4['doEmbed']>>>;
@@ -192,7 +217,7 @@ type OpenAICompatibleImageModelId = string;
 
 type OpenAICompatibleImageModelConfig = {
     provider: string;
-    headers: () => Record<string, string | undefined>;
+    headers?: () => Record<string, string | undefined>;
     url: (options: {
         modelId: string;
         path: string;
@@ -213,6 +238,14 @@ declare class OpenAICompatibleImageModel implements ImageModelV4 {
      * The provider options key used to extract provider-specific options.
      */
     private get providerOptionsKey();
+    static [WORKFLOW_SERIALIZE](model: OpenAICompatibleImageModel): {
+        modelId: string;
+        config: _ai_sdk_provider.JSONObject;
+    };
+    static [WORKFLOW_DESERIALIZE](options: {
+        modelId: string;
+        config: OpenAICompatibleImageModelConfig;
+    }): OpenAICompatibleImageModel;
     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']>>>;