@openrouter/ai-sdk-provider 2.0.2 → 2.1.0

package/dist/internal/index.d.mts

@@ -1,7 +1,7 @@
-import { LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3Content, LanguageModelV3FinishReason, LanguageModelV3Usage, SharedV3Warning, LanguageModelV3ResponseMetadata, SharedV3Headers, LanguageModelV3StreamPart } from '@ai-sdk/provider';
+import * as _ai_sdk_provider from '@ai-sdk/provider';
+import { LanguageModelV3, LanguageModelV3CallOptions, EmbeddingModelV3, SharedV3ProviderMetadata, SharedV3Headers, ImageModelV3, ImageModelV3CallOptions, SharedV3Warning, ImageModelV3ProviderMetadata, ImageModelV3Usage, LanguageModelV3Content, LanguageModelV3FinishReason, LanguageModelV3Usage, LanguageModelV3ResponseMetadata, LanguageModelV3StreamPart } from '@ai-sdk/provider';
 export { LanguageModelV3, LanguageModelV3Prompt } from '@ai-sdk/provider';
 import { z } from 'zod/v4';
-import * as models from '@openrouter/sdk/models';
 
 declare enum ReasoningFormat {
     Unknown = "unknown",
@@ -38,6 +38,50 @@ declare const ReasoningDetailUnionSchema: z.ZodUnion<readonly [z.ZodObject<{
 }, z.core.$strip>]>;
 type ReasoningDetailUnion = z.infer<typeof ReasoningDetailUnionSchema>;
 
+/**
+ * Plugin identifier for web search functionality.
+ */
+type IdWeb = 'web';
+/**
+ * Plugin identifier for file parsing functionality.
+ */
+type IdFileParser = 'file-parser';
+/**
+ * Plugin identifier for content moderation.
+ */
+type IdModeration = 'moderation';
+/**
+ * Plugin identifier for response healing.
+ * Automatically validates and repairs malformed JSON responses.
+ * @see https://openrouter.ai/docs/guides/features/plugins/response-healing
+ */
+type IdResponseHealing = 'response-healing';
+/**
+ * Search engine options for web search.
+ * Open enum - accepts known values or any string for forward compatibility.
+ */
+type Engine = 'native' | 'exa' | (string & {});
+/**
+ * PDF processing engine options.
+ * Open enum - accepts known values or any string for forward compatibility.
+ */
+type PdfEngine = 'mistral-ocr' | 'pdf-text' | 'native' | (string & {});
+/**
+ * Data collection preference for provider routing.
+ * Open enum - accepts known values or any string for forward compatibility.
+ */
+type DataCollection = 'deny' | 'allow' | (string & {});
+/**
+ * Model quantization levels for provider filtering.
+ * Open enum - accepts known values or any string for forward compatibility.
+ */
+type Quantization = 'int4' | 'int8' | 'fp4' | 'fp6' | 'fp8' | 'fp16' | 'bf16' | 'fp32' | 'unknown' | (string & {});
+/**
+ * Provider sorting strategy options.
+ * Open enum - accepts known values or any string for forward compatibility.
+ */
+type ProviderSort = 'price' | 'throughput' | 'latency' | (string & {});
+
 type OpenRouterChatModelId = string;
 type OpenRouterChatSettings = {
     /**
@@ -80,18 +124,29 @@ type OpenRouterChatSettings = {
      * Plugin configurations for enabling various capabilities
      */
     plugins?: Array<{
-        id: models.IdWeb;
+        id: IdWeb;
         max_results?: number;
         search_prompt?: string;
-        engine?: models.Engine;
+        engine?: Engine;
     } | {
-        id: models.IdFileParser;
+        id: IdFileParser;
         max_files?: number;
         pdf?: {
-            engine?: models.PdfEngine;
+            engine?: PdfEngine;
         };
     } | {
-        id: models.IdModeration;
+        id: IdModeration;
+    } | {
+        /**
+         * Response healing plugin - automatically validates and repairs malformed JSON responses.
+         *
+         * **Important:** This plugin only works with non-streaming requests (e.g., `generateObject`).
+         * It has no effect when used with streaming methods like `streamObject` or `streamText`.
+         * The plugin activates when using `response_format` with `json_schema` or `json_object`.
+         *
+         * @see https://openrouter.ai/docs/guides/features/plugins/response-healing
+         */
+        id: IdResponseHealing;
     }>;
     /**
      * Built-in web search options for models that support native web search
@@ -112,7 +167,7 @@ type OpenRouterChatSettings = {
          * - undefined: Native if supported, otherwise Exa
          * @see https://openrouter.ai/docs/features/web-search
          */
-        engine?: models.Engine;
+        engine?: Engine;
     };
     /**
      * Debug options for troubleshooting API requests.
@@ -146,7 +201,7 @@ type OpenRouterChatSettings = {
         /**
          * Control whether to use providers that may store data
          */
-        data_collection?: models.DataCollection;
+        data_collection?: DataCollection;
         /**
          * List of provider slugs to allow for this request
          */
@@ -158,11 +213,11 @@ type OpenRouterChatSettings = {
         /**
          * List of quantization levels to filter by (e.g. ["int4", "int8"])
          */
-        quantizations?: Array<models.Quantization>;
+        quantizations?: Array<Quantization>;
         /**
          * Sort providers by price, throughput, or latency
          */
-        sort?: models.ProviderSort;
+        sort?: ProviderSort;
         /**
          * Maximum pricing you want to pay for this request
          */
@@ -216,6 +271,52 @@ type OpenRouterCompletionSettings = {
     suffix?: string;
 } & OpenRouterSharedSettings;
 
+type OpenRouterImageModelId = string;
+type OpenRouterImageSettings = {
+    /**
+     * Provider routing preferences to control request routing behavior
+     */
+    provider?: {
+        /**
+         * List of provider slugs to try in order (e.g. ["google", "black-forest-labs"])
+         */
+        order?: string[];
+        /**
+         * Whether to allow backup providers when primary is unavailable (default: true)
+         */
+        allow_fallbacks?: boolean;
+        /**
+         * Only use providers that support all parameters in your request (default: false)
+         */
+        require_parameters?: boolean;
+        /**
+         * Control whether to use providers that may store data
+         */
+        data_collection?: 'allow' | 'deny';
+        /**
+         * List of provider slugs to allow for this request
+         */
+        only?: string[];
+        /**
+         * List of provider slugs to skip for this request
+         */
+        ignore?: string[];
+        /**
+         * Sort providers by price, throughput, or latency
+         */
+        sort?: 'price' | 'throughput' | 'latency';
+        /**
+         * Maximum pricing you want to pay for this request
+         */
+        max_price?: {
+            prompt?: number | string;
+            completion?: number | string;
+            image?: number | string;
+            request?: number | string;
+        };
+    };
+} & OpenRouterSharedSettings;
+
 type OpenRouterCompletionConfig = {
     provider: string;
     compatibility: 'strict' | 'compatible';
@@ -242,6 +343,74 @@ declare class OpenRouterCompletionLanguageModel implements LanguageModelV3 {
     doStream(options: LanguageModelV3CallOptions): Promise<Awaited<ReturnType<LanguageModelV3['doStream']>>>;
 }
 
+type OpenRouterEmbeddingConfig = {
+    provider: string;
+    headers: () => Record<string, string | undefined>;
+    url: (options: {
+        modelId: string;
+        path: string;
+    }) => string;
+    fetch?: typeof fetch;
+    extraBody?: Record<string, unknown>;
+};
+declare class OpenRouterEmbeddingModel implements EmbeddingModelV3 {
+    readonly specificationVersion: "v3";
+    readonly provider = "openrouter";
+    readonly modelId: OpenRouterEmbeddingModelId;
+    readonly settings: OpenRouterEmbeddingSettings;
+    readonly maxEmbeddingsPerCall: undefined;
+    readonly supportsParallelCalls = true;
+    private readonly config;
+    constructor(modelId: OpenRouterEmbeddingModelId, settings: OpenRouterEmbeddingSettings, config: OpenRouterEmbeddingConfig);
+    doEmbed(options: {
+        values: Array<string>;
+        abortSignal?: AbortSignal;
+        headers?: Record<string, string | undefined>;
+    }): Promise<{
+        embeddings: Array<Array<number>>;
+        usage?: {
+            tokens: number;
+        };
+        providerMetadata?: SharedV3ProviderMetadata;
+        response?: {
+            headers?: SharedV3Headers;
+            body?: unknown;
+        };
+        warnings: Array<_ai_sdk_provider.SharedV3Warning>;
+    }>;
+}
+
+type OpenRouterImageConfig = {
+    provider: string;
+    headers: () => Record<string, string | undefined>;
+    url: (options: {
+        modelId: string;
+        path: string;
+    }) => string;
+    fetch?: typeof fetch;
+    extraBody?: Record<string, unknown>;
+};
+declare class OpenRouterImageModel implements ImageModelV3 {
+    readonly specificationVersion: "v3";
+    readonly provider = "openrouter";
+    readonly modelId: OpenRouterImageModelId;
+    readonly settings: OpenRouterImageSettings;
+    readonly maxImagesPerCall = 1;
+    private readonly config;
+    constructor(modelId: OpenRouterImageModelId, settings: OpenRouterImageSettings, config: OpenRouterImageConfig);
+    doGenerate(options: ImageModelV3CallOptions): Promise<{
+        images: Array<string>;
+        warnings: Array<SharedV3Warning>;
+        providerMetadata?: ImageModelV3ProviderMetadata;
+        response: {
+            timestamp: Date;
+            modelId: string;
+            headers: Record<string, string> | undefined;
+        };
+        usage?: ImageModelV3Usage;
+    }>;
+}
+
 type OpenRouterEmbeddingModelId = string;
 type OpenRouterEmbeddingSettings = {
     /**
@@ -407,4 +576,4 @@ declare class OpenRouterChatLanguageModel implements LanguageModelV3 {
     }>;
 }
 
-export { OpenRouterChatLanguageModel, type OpenRouterChatModelId, type OpenRouterChatSettings, OpenRouterCompletionLanguageModel, type OpenRouterCompletionModelId, type OpenRouterCompletionSettings, type OpenRouterEmbeddingModelId, type OpenRouterEmbeddingSettings, type OpenRouterProviderOptions, type OpenRouterSharedSettings, type OpenRouterUsageAccounting };
+export { OpenRouterChatLanguageModel, type OpenRouterChatModelId, type OpenRouterChatSettings, OpenRouterCompletionLanguageModel, type OpenRouterCompletionModelId, type OpenRouterCompletionSettings, OpenRouterEmbeddingModel, type OpenRouterEmbeddingModelId, type OpenRouterEmbeddingSettings, OpenRouterImageModel, type OpenRouterImageModelId, type OpenRouterImageSettings, type OpenRouterProviderOptions, type OpenRouterSharedSettings, type OpenRouterUsageAccounting };

package/dist/internal/index.d.ts

@@ -1,7 +1,7 @@
-import { LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3Content, LanguageModelV3FinishReason, LanguageModelV3Usage, SharedV3Warning, LanguageModelV3ResponseMetadata, SharedV3Headers, LanguageModelV3StreamPart } from '@ai-sdk/provider';
+import * as _ai_sdk_provider from '@ai-sdk/provider';
+import { LanguageModelV3, LanguageModelV3CallOptions, EmbeddingModelV3, SharedV3ProviderMetadata, SharedV3Headers, ImageModelV3, ImageModelV3CallOptions, SharedV3Warning, ImageModelV3ProviderMetadata, ImageModelV3Usage, LanguageModelV3Content, LanguageModelV3FinishReason, LanguageModelV3Usage, LanguageModelV3ResponseMetadata, LanguageModelV3StreamPart } from '@ai-sdk/provider';
 export { LanguageModelV3, LanguageModelV3Prompt } from '@ai-sdk/provider';
 import { z } from 'zod/v4';
-import * as models from '@openrouter/sdk/models';
 
 declare enum ReasoningFormat {
     Unknown = "unknown",
@@ -38,6 +38,50 @@ declare const ReasoningDetailUnionSchema: z.ZodUnion<readonly [z.ZodObject<{
 }, z.core.$strip>]>;
 type ReasoningDetailUnion = z.infer<typeof ReasoningDetailUnionSchema>;
 
+/**
+ * Plugin identifier for web search functionality.
+ */
+type IdWeb = 'web';
+/**
+ * Plugin identifier for file parsing functionality.
+ */
+type IdFileParser = 'file-parser';
+/**
+ * Plugin identifier for content moderation.
+ */
+type IdModeration = 'moderation';
+/**
+ * Plugin identifier for response healing.
+ * Automatically validates and repairs malformed JSON responses.
+ * @see https://openrouter.ai/docs/guides/features/plugins/response-healing
+ */
+type IdResponseHealing = 'response-healing';
+/**
+ * Search engine options for web search.
+ * Open enum - accepts known values or any string for forward compatibility.
+ */
+type Engine = 'native' | 'exa' | (string & {});
+/**
+ * PDF processing engine options.
+ * Open enum - accepts known values or any string for forward compatibility.
+ */
+type PdfEngine = 'mistral-ocr' | 'pdf-text' | 'native' | (string & {});
+/**
+ * Data collection preference for provider routing.
+ * Open enum - accepts known values or any string for forward compatibility.
+ */
+type DataCollection = 'deny' | 'allow' | (string & {});
+/**
+ * Model quantization levels for provider filtering.
+ * Open enum - accepts known values or any string for forward compatibility.
+ */
+type Quantization = 'int4' | 'int8' | 'fp4' | 'fp6' | 'fp8' | 'fp16' | 'bf16' | 'fp32' | 'unknown' | (string & {});
+/**
+ * Provider sorting strategy options.
+ * Open enum - accepts known values or any string for forward compatibility.
+ */
+type ProviderSort = 'price' | 'throughput' | 'latency' | (string & {});
+
 type OpenRouterChatModelId = string;
 type OpenRouterChatSettings = {
     /**
@@ -80,18 +124,29 @@ type OpenRouterChatSettings = {
      * Plugin configurations for enabling various capabilities
      */
     plugins?: Array<{
-        id: models.IdWeb;
+        id: IdWeb;
         max_results?: number;
         search_prompt?: string;
-        engine?: models.Engine;
+        engine?: Engine;
     } | {
-        id: models.IdFileParser;
+        id: IdFileParser;
         max_files?: number;
         pdf?: {
-            engine?: models.PdfEngine;
+            engine?: PdfEngine;
         };
     } | {
-        id: models.IdModeration;
+        id: IdModeration;
+    } | {
+        /**
+         * Response healing plugin - automatically validates and repairs malformed JSON responses.
+         *
+         * **Important:** This plugin only works with non-streaming requests (e.g., `generateObject`).
+         * It has no effect when used with streaming methods like `streamObject` or `streamText`.
+         * The plugin activates when using `response_format` with `json_schema` or `json_object`.
+         *
+         * @see https://openrouter.ai/docs/guides/features/plugins/response-healing
+         */
+        id: IdResponseHealing;
     }>;
     /**
      * Built-in web search options for models that support native web search
@@ -112,7 +167,7 @@ type OpenRouterChatSettings = {
          * - undefined: Native if supported, otherwise Exa
          * @see https://openrouter.ai/docs/features/web-search
          */
-        engine?: models.Engine;
+        engine?: Engine;
     };
     /**
      * Debug options for troubleshooting API requests.
@@ -146,7 +201,7 @@ type OpenRouterChatSettings = {
         /**
          * Control whether to use providers that may store data
          */
-        data_collection?: models.DataCollection;
+        data_collection?: DataCollection;
         /**
          * List of provider slugs to allow for this request
          */
@@ -158,11 +213,11 @@ type OpenRouterChatSettings = {
         /**
          * List of quantization levels to filter by (e.g. ["int4", "int8"])
          */
-        quantizations?: Array<models.Quantization>;
+        quantizations?: Array<Quantization>;
         /**
          * Sort providers by price, throughput, or latency
          */
-        sort?: models.ProviderSort;
+        sort?: ProviderSort;
         /**
          * Maximum pricing you want to pay for this request
          */
@@ -216,6 +271,52 @@ type OpenRouterCompletionSettings = {
     suffix?: string;
 } & OpenRouterSharedSettings;
 
+type OpenRouterImageModelId = string;
+type OpenRouterImageSettings = {
+    /**
+     * Provider routing preferences to control request routing behavior
+     */
+    provider?: {
+        /**
+         * List of provider slugs to try in order (e.g. ["google", "black-forest-labs"])
+         */
+        order?: string[];
+        /**
+         * Whether to allow backup providers when primary is unavailable (default: true)
+         */
+        allow_fallbacks?: boolean;
+        /**
+         * Only use providers that support all parameters in your request (default: false)
+         */
+        require_parameters?: boolean;
+        /**
+         * Control whether to use providers that may store data
+         */
+        data_collection?: 'allow' | 'deny';
+        /**
+         * List of provider slugs to allow for this request
+         */
+        only?: string[];
+        /**
+         * List of provider slugs to skip for this request
+         */
+        ignore?: string[];
+        /**
+         * Sort providers by price, throughput, or latency
+         */
+        sort?: 'price' | 'throughput' | 'latency';
+        /**
+         * Maximum pricing you want to pay for this request
+         */
+        max_price?: {
+            prompt?: number | string;
+            completion?: number | string;
+            image?: number | string;
+            request?: number | string;
+        };
+    };
+} & OpenRouterSharedSettings;
+
 type OpenRouterCompletionConfig = {
     provider: string;
     compatibility: 'strict' | 'compatible';
@@ -242,6 +343,74 @@ declare class OpenRouterCompletionLanguageModel implements LanguageModelV3 {
     doStream(options: LanguageModelV3CallOptions): Promise<Awaited<ReturnType<LanguageModelV3['doStream']>>>;
 }
 
+type OpenRouterEmbeddingConfig = {
+    provider: string;
+    headers: () => Record<string, string | undefined>;
+    url: (options: {
+        modelId: string;
+        path: string;
+    }) => string;
+    fetch?: typeof fetch;
+    extraBody?: Record<string, unknown>;
+};
+declare class OpenRouterEmbeddingModel implements EmbeddingModelV3 {
+    readonly specificationVersion: "v3";
+    readonly provider = "openrouter";
+    readonly modelId: OpenRouterEmbeddingModelId;
+    readonly settings: OpenRouterEmbeddingSettings;
+    readonly maxEmbeddingsPerCall: undefined;
+    readonly supportsParallelCalls = true;
+    private readonly config;
+    constructor(modelId: OpenRouterEmbeddingModelId, settings: OpenRouterEmbeddingSettings, config: OpenRouterEmbeddingConfig);
+    doEmbed(options: {
+        values: Array<string>;
+        abortSignal?: AbortSignal;
+        headers?: Record<string, string | undefined>;
+    }): Promise<{
+        embeddings: Array<Array<number>>;
+        usage?: {
+            tokens: number;
+        };
+        providerMetadata?: SharedV3ProviderMetadata;
+        response?: {
+            headers?: SharedV3Headers;
+            body?: unknown;
+        };
+        warnings: Array<_ai_sdk_provider.SharedV3Warning>;
+    }>;
+}
+
+type OpenRouterImageConfig = {
+    provider: string;
+    headers: () => Record<string, string | undefined>;
+    url: (options: {
+        modelId: string;
+        path: string;
+    }) => string;
+    fetch?: typeof fetch;
+    extraBody?: Record<string, unknown>;
+};
+declare class OpenRouterImageModel implements ImageModelV3 {
+    readonly specificationVersion: "v3";
+    readonly provider = "openrouter";
+    readonly modelId: OpenRouterImageModelId;
+    readonly settings: OpenRouterImageSettings;
+    readonly maxImagesPerCall = 1;
+    private readonly config;
+    constructor(modelId: OpenRouterImageModelId, settings: OpenRouterImageSettings, config: OpenRouterImageConfig);
+    doGenerate(options: ImageModelV3CallOptions): Promise<{
+        images: Array<string>;
+        warnings: Array<SharedV3Warning>;
+        providerMetadata?: ImageModelV3ProviderMetadata;
+        response: {
+            timestamp: Date;
+            modelId: string;
+            headers: Record<string, string> | undefined;
+        };
+        usage?: ImageModelV3Usage;
+    }>;
+}
+
 type OpenRouterEmbeddingModelId = string;
 type OpenRouterEmbeddingSettings = {
     /**
@@ -407,4 +576,4 @@ declare class OpenRouterChatLanguageModel implements LanguageModelV3 {
     }>;
 }
 
-export { OpenRouterChatLanguageModel, type OpenRouterChatModelId, type OpenRouterChatSettings, OpenRouterCompletionLanguageModel, type OpenRouterCompletionModelId, type OpenRouterCompletionSettings, type OpenRouterEmbeddingModelId, type OpenRouterEmbeddingSettings, type OpenRouterProviderOptions, type OpenRouterSharedSettings, type OpenRouterUsageAccounting };
+export { OpenRouterChatLanguageModel, type OpenRouterChatModelId, type OpenRouterChatSettings, OpenRouterCompletionLanguageModel, type OpenRouterCompletionModelId, type OpenRouterCompletionSettings, OpenRouterEmbeddingModel, type OpenRouterEmbeddingModelId, type OpenRouterEmbeddingSettings, OpenRouterImageModel, type OpenRouterImageModelId, type OpenRouterImageSettings, type OpenRouterProviderOptions, type OpenRouterSharedSettings, type OpenRouterUsageAccounting };