@openrouter/ai-sdk-provider 1.5.3 → 2.0.0

package/README.md

@@ -2,7 +2,7 @@
 
 The [OpenRouter](https://openrouter.ai/) provider for the [Vercel AI SDK](https://sdk.vercel.ai/docs) gives access to over 300 large language models on the OpenRouter chat and completion APIs.
 
-## Setup for AI SDK v5
+## Setup for AI SDK v6
 
 ```bash
 # For pnpm
@@ -15,18 +15,17 @@ npm install @openrouter/ai-sdk-provider
 yarn add @openrouter/ai-sdk-provider
 ```
 
-## (LEGACY) Setup for AI SDK v4
+## (LEGACY) Setup for AI SDK v5
 
 ```bash
 # For pnpm
-pnpm add @openrouter/ai-sdk-provider@ai-sdk-v4
+pnpm add @openrouter/ai-sdk-provider@ai-sdk-v5
 
 # For npm
-npm install @openrouter/ai-sdk-provider@ai-sdk-v4
+npm install @openrouter/ai-sdk-provider@ai-sdk-v5
 
 # For yarn
-yarn add @openrouter/ai-sdk-provider@ai-sdk-v4
-
+yarn add @openrouter/ai-sdk-provider@ai-sdk-v5
 ```
 
 ## Provider Instance
@@ -57,9 +56,9 @@ You can find the latest list of tool-supported models supported by OpenRouter [h
 
 ## Embeddings
 
-OpenRouter supports embedding models for semantic search, RAG pipelines, and vector-native features. The provider exposes embeddings compatible with both AI SDK v5 and v4.
+OpenRouter supports embedding models for semantic search, RAG pipelines, and vector-native features.
 
-### AI SDK v5 (Recommended)
+### Basic Usage
 
 ```ts
 import { embed } from 'ai';
@@ -91,20 +90,6 @@ const { embeddings } = await embedMany({
 console.log(embeddings); // Array of embedding arrays
 ```
 
-### AI SDK v4 (Deprecated)
-
-For backwards compatibility, the `embedding` method is also available:
-
-```ts
-import { embed } from 'ai';
-import { openrouter } from '@openrouter/ai-sdk-provider';
-
-const { embedding } = await embed({
-  model: openrouter.embedding('openai/text-embedding-3-small'),
-  value: 'sunny day at the beach',
-});
-```
-
 ### Supported Embedding Models
 
 OpenRouter supports various embedding models including:
@@ -225,6 +210,7 @@ await streamText({
   ],
 });
 ```
+
 ## Anthropic Beta Features
 
 You can enable Anthropic beta features by passing custom headers through the OpenRouter SDK.
@@ -319,8 +305,6 @@ for await (const partialComponent of result.partialObjectStream) {
 }
 ```
 
-
-
 ## Use Cases
 
 ### Debugging API Requests

package/dist/index.d.mts

@@ -1,9 +1,8 @@
-import { LanguageModelV2, LanguageModelV2CallOptions, LanguageModelV2Content, LanguageModelV2FinishReason, LanguageModelV2Usage, LanguageModelV2CallWarning, LanguageModelV2ResponseMetadata, SharedV2Headers, LanguageModelV2StreamPart, EmbeddingModelV2, SharedV2ProviderMetadata, ProviderV2 } from '@ai-sdk/provider';
-export { LanguageModelV2, LanguageModelV2Prompt } from '@ai-sdk/provider';
+import * as _ai_sdk_provider from '@ai-sdk/provider';
+import { LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3Content, LanguageModelV3FinishReason, LanguageModelV3Usage, SharedV3Warning, LanguageModelV3ResponseMetadata, SharedV3Headers, LanguageModelV3StreamPart, EmbeddingModelV3, SharedV3ProviderMetadata, ProviderV3 } from '@ai-sdk/provider';
+export { LanguageModelV3, LanguageModelV3Prompt } from '@ai-sdk/provider';
 import * as models from '@openrouter/sdk/models';
 import { z } from 'zod/v4';
-import { EncodeOptions, DecodeOptions, JsonValue } from '@toon-format/toon';
-export { DecodeOptions, EncodeOptions, JsonValue } from '@toon-format/toon';
 
 type OpenRouterChatModelId = string;
 type OpenRouterChatSettings = {
@@ -339,8 +338,8 @@ type OpenRouterChatConfig = {
     fetch?: typeof fetch;
     extraBody?: Record<string, unknown>;
 };
-declare class OpenRouterChatLanguageModel implements LanguageModelV2 {
-    readonly specificationVersion: "v2";
+declare class OpenRouterChatLanguageModel implements LanguageModelV3 {
+    readonly specificationVersion: "v3";
     readonly provider = "openrouter";
     readonly defaultObjectGenerationMode: "tool";
     readonly modelId: OpenRouterChatModelId;
@@ -350,11 +349,11 @@ declare class OpenRouterChatLanguageModel implements LanguageModelV2 {
     private readonly config;
     constructor(modelId: OpenRouterChatModelId, settings: OpenRouterChatSettings, config: OpenRouterChatConfig);
     private getArgs;
-    doGenerate(options: LanguageModelV2CallOptions): Promise<{
-        content: Array<LanguageModelV2Content>;
-        finishReason: LanguageModelV2FinishReason;
-        usage: LanguageModelV2Usage;
-        warnings: Array<LanguageModelV2CallWarning>;
+    doGenerate(options: LanguageModelV3CallOptions): Promise<{
+        content: Array<LanguageModelV3Content>;
+        finishReason: LanguageModelV3FinishReason;
+        usage: LanguageModelV3Usage;
+        warnings: Array<SharedV3Warning>;
         providerMetadata?: {
             openrouter: {
                 provider: string;
@@ -365,19 +364,19 @@ declare class OpenRouterChatLanguageModel implements LanguageModelV2 {
         request?: {
             body?: unknown;
         };
-        response?: LanguageModelV2ResponseMetadata & {
-            headers?: SharedV2Headers;
+        response?: LanguageModelV3ResponseMetadata & {
+            headers?: SharedV3Headers;
             body?: unknown;
         };
     }>;
-    doStream(options: LanguageModelV2CallOptions): Promise<{
-        stream: ReadableStream<LanguageModelV2StreamPart>;
-        warnings: Array<LanguageModelV2CallWarning>;
+    doStream(options: LanguageModelV3CallOptions): Promise<{
+        stream: ReadableStream<LanguageModelV3StreamPart>;
+        warnings: Array<SharedV3Warning>;
         request?: {
             body?: unknown;
         };
-        response?: LanguageModelV2ResponseMetadata & {
-            headers?: SharedV2Headers;
+        response?: LanguageModelV3ResponseMetadata & {
+            headers?: SharedV3Headers;
             body?: unknown;
         };
     }>;
@@ -394,8 +393,8 @@ type OpenRouterCompletionConfig = {
     fetch?: typeof fetch;
     extraBody?: Record<string, unknown>;
 };
-declare class OpenRouterCompletionLanguageModel implements LanguageModelV2 {
-    readonly specificationVersion: "v2";
+declare class OpenRouterCompletionLanguageModel implements LanguageModelV3 {
+    readonly specificationVersion: "v3";
     readonly provider = "openrouter";
     readonly modelId: OpenRouterCompletionModelId;
     readonly supportsImageUrls = true;
@@ -405,8 +404,8 @@ declare class OpenRouterCompletionLanguageModel implements LanguageModelV2 {
     private readonly config;
     constructor(modelId: OpenRouterCompletionModelId, settings: OpenRouterCompletionSettings, config: OpenRouterCompletionConfig);
     private getArgs;
-    doGenerate(options: LanguageModelV2CallOptions): Promise<Awaited<ReturnType<LanguageModelV2['doGenerate']>>>;
-    doStream(options: LanguageModelV2CallOptions): Promise<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
+    doGenerate(options: LanguageModelV3CallOptions): Promise<Awaited<ReturnType<LanguageModelV3['doGenerate']>>>;
+    doStream(options: LanguageModelV3CallOptions): Promise<Awaited<ReturnType<LanguageModelV3['doStream']>>>;
 }
 
 type OpenRouterEmbeddingConfig = {
@@ -419,8 +418,8 @@ type OpenRouterEmbeddingConfig = {
     fetch?: typeof fetch;
     extraBody?: Record<string, unknown>;
 };
-declare class OpenRouterEmbeddingModel implements EmbeddingModelV2<string> {
-    readonly specificationVersion: "v2";
+declare class OpenRouterEmbeddingModel implements EmbeddingModelV3 {
+    readonly specificationVersion: "v3";
     readonly provider = "openrouter";
     readonly modelId: OpenRouterEmbeddingModelId;
     readonly settings: OpenRouterEmbeddingSettings;
@@ -437,15 +436,16 @@ declare class OpenRouterEmbeddingModel implements EmbeddingModelV2<string> {
         usage?: {
             tokens: number;
         };
-        providerMetadata?: SharedV2ProviderMetadata;
+        providerMetadata?: SharedV3ProviderMetadata;
         response?: {
-            headers?: SharedV2Headers;
+            headers?: SharedV3Headers;
             body?: unknown;
         };
+        warnings: Array<_ai_sdk_provider.SharedV3Warning>;
     }>;
 }
 
-interface OpenRouterProvider extends ProviderV2 {
+interface OpenRouterProvider extends ProviderV3 {
     (modelId: OpenRouterChatModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
     (modelId: OpenRouterChatModelId, settings?: OpenRouterChatSettings): OpenRouterChatLanguageModel;
     languageModel(modelId: OpenRouterChatModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
@@ -551,84 +551,4 @@ declare class OpenRouter {
     embedding(modelId: OpenRouterEmbeddingModelId, settings?: OpenRouterEmbeddingSettings): OpenRouterEmbeddingModel;
 }
 
-/**
- * TOON (Token-Oriented Object Notation) helper utilities for token-efficient
- * data encoding in LLM prompts.
- *
- * TOON achieves ~40% token reduction vs JSON for tabular data while maintaining
- * high LLM comprehension accuracy.
- *
- * @see https://toonformat.dev
- * @see https://github.com/toon-format/toon
- *
- * @example
- * ```ts
- * import { encodeToon, decodeToon } from '@openrouter/ai-sdk-provider';
- *
- * // Encode data to TOON format
- * const toon = await encodeToon([
- *   { id: 1, name: 'Alice', score: 95 },
- *   { id: 2, name: 'Bob', score: 87 },
- * ]);
- * // Result: [2]{id,name,score}: 1,Alice,95 2,Bob,87
- *
- * // Decode TOON back to JSON
- * const data = await decodeToon(toon);
- * ```
- */
-
-type ToonEncodeOptions = EncodeOptions;
-type ToonDecodeOptions = DecodeOptions;
-/**
- * Encodes a JavaScript value into TOON format string.
- *
- * TOON is particularly efficient for uniform arrays of objects (tabular data),
- * achieving CSV-like compactness while preserving explicit structure.
- *
- * @param value - Any JavaScript value (objects, arrays, primitives)
- * @param options - Optional encoding configuration
- * @returns Promise resolving to TOON formatted string
- *
- * @example
- * ```ts
- * // Simple object
- * await encodeToon({ name: 'Alice', age: 30 });
- * // name: Alice
- * // age: 30
- *
- * // Tabular array (most efficient)
- * await encodeToon([
- *   { id: 1, name: 'Alice' },
- *   { id: 2, name: 'Bob' },
- * ]);
- * // [2]{id,name}: 1,Alice 2,Bob
- *
- * // With options
- * await encodeToon(data, { indent: 4, keyFolding: 'safe' });
- * ```
- */
-declare function encodeToon(value: unknown, options?: ToonEncodeOptions): Promise<string>;
-/**
- * Decodes a TOON format string into a JavaScript value.
- *
- * @param input - TOON formatted string
- * @param options - Optional decoding configuration
- * @returns Promise resolving to parsed JavaScript value
- *
- * @example
- * ```ts
- * // Decode simple object
- * await decodeToon('name: Alice\nage: 30');
- * // { name: 'Alice', age: 30 }
- *
- * // Decode tabular array
- * await decodeToon('[2]{id,name}: 1,Alice 2,Bob');
- * // [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }]
- *
- * // With options
- * await decodeToon(toonString, { strict: false, expandPaths: 'safe' });
- * ```
- */
-declare function decodeToon(input: string, options?: ToonDecodeOptions): Promise<JsonValue>;
-
-export { OpenRouter, type OpenRouterChatSettings, type OpenRouterCompletionSettings, type OpenRouterEmbeddingModelId, type OpenRouterEmbeddingSettings, type OpenRouterProvider, type OpenRouterProviderOptions, type OpenRouterProviderSettings, type OpenRouterSharedSettings, type OpenRouterUsageAccounting, type ToonDecodeOptions, type ToonEncodeOptions, createOpenRouter, decodeToon, encodeToon, openrouter };
+export { OpenRouter, type OpenRouterChatSettings, type OpenRouterCompletionSettings, type OpenRouterEmbeddingModelId, type OpenRouterEmbeddingSettings, type OpenRouterProvider, type OpenRouterProviderOptions, type OpenRouterProviderSettings, type OpenRouterSharedSettings, type OpenRouterUsageAccounting, createOpenRouter, openrouter };

package/dist/index.d.ts

@@ -1,9 +1,8 @@
-import { LanguageModelV2, LanguageModelV2CallOptions, LanguageModelV2Content, LanguageModelV2FinishReason, LanguageModelV2Usage, LanguageModelV2CallWarning, LanguageModelV2ResponseMetadata, SharedV2Headers, LanguageModelV2StreamPart, EmbeddingModelV2, SharedV2ProviderMetadata, ProviderV2 } from '@ai-sdk/provider';
-export { LanguageModelV2, LanguageModelV2Prompt } from '@ai-sdk/provider';
+import * as _ai_sdk_provider from '@ai-sdk/provider';
+import { LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3Content, LanguageModelV3FinishReason, LanguageModelV3Usage, SharedV3Warning, LanguageModelV3ResponseMetadata, SharedV3Headers, LanguageModelV3StreamPart, EmbeddingModelV3, SharedV3ProviderMetadata, ProviderV3 } from '@ai-sdk/provider';
+export { LanguageModelV3, LanguageModelV3Prompt } from '@ai-sdk/provider';
 import * as models from '@openrouter/sdk/models';
 import { z } from 'zod/v4';
-import { EncodeOptions, DecodeOptions, JsonValue } from '@toon-format/toon';
-export { DecodeOptions, EncodeOptions, JsonValue } from '@toon-format/toon';
 
 type OpenRouterChatModelId = string;
 type OpenRouterChatSettings = {
@@ -339,8 +338,8 @@ type OpenRouterChatConfig = {
     fetch?: typeof fetch;
     extraBody?: Record<string, unknown>;
 };
-declare class OpenRouterChatLanguageModel implements LanguageModelV2 {
-    readonly specificationVersion: "v2";
+declare class OpenRouterChatLanguageModel implements LanguageModelV3 {
+    readonly specificationVersion: "v3";
     readonly provider = "openrouter";
     readonly defaultObjectGenerationMode: "tool";
     readonly modelId: OpenRouterChatModelId;
@@ -350,11 +349,11 @@ declare class OpenRouterChatLanguageModel implements LanguageModelV2 {
     private readonly config;
     constructor(modelId: OpenRouterChatModelId, settings: OpenRouterChatSettings, config: OpenRouterChatConfig);
     private getArgs;
-    doGenerate(options: LanguageModelV2CallOptions): Promise<{
-        content: Array<LanguageModelV2Content>;
-        finishReason: LanguageModelV2FinishReason;
-        usage: LanguageModelV2Usage;
-        warnings: Array<LanguageModelV2CallWarning>;
+    doGenerate(options: LanguageModelV3CallOptions): Promise<{
+        content: Array<LanguageModelV3Content>;
+        finishReason: LanguageModelV3FinishReason;
+        usage: LanguageModelV3Usage;
+        warnings: Array<SharedV3Warning>;
         providerMetadata?: {
             openrouter: {
                 provider: string;
@@ -365,19 +364,19 @@ declare class OpenRouterChatLanguageModel implements LanguageModelV2 {
         request?: {
             body?: unknown;
         };
-        response?: LanguageModelV2ResponseMetadata & {
-            headers?: SharedV2Headers;
+        response?: LanguageModelV3ResponseMetadata & {
+            headers?: SharedV3Headers;
             body?: unknown;
         };
     }>;
-    doStream(options: LanguageModelV2CallOptions): Promise<{
-        stream: ReadableStream<LanguageModelV2StreamPart>;
-        warnings: Array<LanguageModelV2CallWarning>;
+    doStream(options: LanguageModelV3CallOptions): Promise<{
+        stream: ReadableStream<LanguageModelV3StreamPart>;
+        warnings: Array<SharedV3Warning>;
         request?: {
             body?: unknown;
         };
-        response?: LanguageModelV2ResponseMetadata & {
-            headers?: SharedV2Headers;
+        response?: LanguageModelV3ResponseMetadata & {
+            headers?: SharedV3Headers;
             body?: unknown;
         };
     }>;
@@ -394,8 +393,8 @@ type OpenRouterCompletionConfig = {
     fetch?: typeof fetch;
     extraBody?: Record<string, unknown>;
 };
-declare class OpenRouterCompletionLanguageModel implements LanguageModelV2 {
-    readonly specificationVersion: "v2";
+declare class OpenRouterCompletionLanguageModel implements LanguageModelV3 {
+    readonly specificationVersion: "v3";
     readonly provider = "openrouter";
     readonly modelId: OpenRouterCompletionModelId;
     readonly supportsImageUrls = true;
@@ -405,8 +404,8 @@ declare class OpenRouterCompletionLanguageModel implements LanguageModelV2 {
     private readonly config;
     constructor(modelId: OpenRouterCompletionModelId, settings: OpenRouterCompletionSettings, config: OpenRouterCompletionConfig);
     private getArgs;
-    doGenerate(options: LanguageModelV2CallOptions): Promise<Awaited<ReturnType<LanguageModelV2['doGenerate']>>>;
-    doStream(options: LanguageModelV2CallOptions): Promise<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
+    doGenerate(options: LanguageModelV3CallOptions): Promise<Awaited<ReturnType<LanguageModelV3['doGenerate']>>>;
+    doStream(options: LanguageModelV3CallOptions): Promise<Awaited<ReturnType<LanguageModelV3['doStream']>>>;
 }
 
 type OpenRouterEmbeddingConfig = {
@@ -419,8 +418,8 @@ type OpenRouterEmbeddingConfig = {
     fetch?: typeof fetch;
     extraBody?: Record<string, unknown>;
 };
-declare class OpenRouterEmbeddingModel implements EmbeddingModelV2<string> {
-    readonly specificationVersion: "v2";
+declare class OpenRouterEmbeddingModel implements EmbeddingModelV3 {
+    readonly specificationVersion: "v3";
     readonly provider = "openrouter";
     readonly modelId: OpenRouterEmbeddingModelId;
     readonly settings: OpenRouterEmbeddingSettings;
@@ -437,15 +436,16 @@ declare class OpenRouterEmbeddingModel implements EmbeddingModelV2<string> {
         usage?: {
             tokens: number;
         };
-        providerMetadata?: SharedV2ProviderMetadata;
+        providerMetadata?: SharedV3ProviderMetadata;
         response?: {
-            headers?: SharedV2Headers;
+            headers?: SharedV3Headers;
             body?: unknown;
         };
+        warnings: Array<_ai_sdk_provider.SharedV3Warning>;
     }>;
 }
 
-interface OpenRouterProvider extends ProviderV2 {
+interface OpenRouterProvider extends ProviderV3 {
     (modelId: OpenRouterChatModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
     (modelId: OpenRouterChatModelId, settings?: OpenRouterChatSettings): OpenRouterChatLanguageModel;
     languageModel(modelId: OpenRouterChatModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
@@ -551,84 +551,4 @@ declare class OpenRouter {
     embedding(modelId: OpenRouterEmbeddingModelId, settings?: OpenRouterEmbeddingSettings): OpenRouterEmbeddingModel;
 }
 
-/**
- * TOON (Token-Oriented Object Notation) helper utilities for token-efficient
- * data encoding in LLM prompts.
- *
- * TOON achieves ~40% token reduction vs JSON for tabular data while maintaining
- * high LLM comprehension accuracy.
- *
- * @see https://toonformat.dev
- * @see https://github.com/toon-format/toon
- *
- * @example
- * ```ts
- * import { encodeToon, decodeToon } from '@openrouter/ai-sdk-provider';
- *
- * // Encode data to TOON format
- * const toon = await encodeToon([
- *   { id: 1, name: 'Alice', score: 95 },
- *   { id: 2, name: 'Bob', score: 87 },
- * ]);
- * // Result: [2]{id,name,score}: 1,Alice,95 2,Bob,87
- *
- * // Decode TOON back to JSON
- * const data = await decodeToon(toon);
- * ```
- */
-
-type ToonEncodeOptions = EncodeOptions;
-type ToonDecodeOptions = DecodeOptions;
-/**
- * Encodes a JavaScript value into TOON format string.
- *
- * TOON is particularly efficient for uniform arrays of objects (tabular data),
- * achieving CSV-like compactness while preserving explicit structure.
- *
- * @param value - Any JavaScript value (objects, arrays, primitives)
- * @param options - Optional encoding configuration
- * @returns Promise resolving to TOON formatted string
- *
- * @example
- * ```ts
- * // Simple object
- * await encodeToon({ name: 'Alice', age: 30 });
- * // name: Alice
- * // age: 30
- *
- * // Tabular array (most efficient)
- * await encodeToon([
- *   { id: 1, name: 'Alice' },
- *   { id: 2, name: 'Bob' },
- * ]);
- * // [2]{id,name}: 1,Alice 2,Bob
- *
- * // With options
- * await encodeToon(data, { indent: 4, keyFolding: 'safe' });
- * ```
- */
-declare function encodeToon(value: unknown, options?: ToonEncodeOptions): Promise<string>;
-/**
- * Decodes a TOON format string into a JavaScript value.
- *
- * @param input - TOON formatted string
- * @param options - Optional decoding configuration
- * @returns Promise resolving to parsed JavaScript value
- *
- * @example
- * ```ts
- * // Decode simple object
- * await decodeToon('name: Alice\nage: 30');
- * // { name: 'Alice', age: 30 }
- *
- * // Decode tabular array
- * await decodeToon('[2]{id,name}: 1,Alice 2,Bob');
- * // [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }]
- *
- * // With options
- * await decodeToon(toonString, { strict: false, expandPaths: 'safe' });
- * ```
- */
-declare function decodeToon(input: string, options?: ToonDecodeOptions): Promise<JsonValue>;
-
-export { OpenRouter, type OpenRouterChatSettings, type OpenRouterCompletionSettings, type OpenRouterEmbeddingModelId, type OpenRouterEmbeddingSettings, type OpenRouterProvider, type OpenRouterProviderOptions, type OpenRouterProviderSettings, type OpenRouterSharedSettings, type OpenRouterUsageAccounting, type ToonDecodeOptions, type ToonEncodeOptions, createOpenRouter, decodeToon, encodeToon, openrouter };
+export { OpenRouter, type OpenRouterChatSettings, type OpenRouterCompletionSettings, type OpenRouterEmbeddingModelId, type OpenRouterEmbeddingSettings, type OpenRouterProvider, type OpenRouterProviderOptions, type OpenRouterProviderSettings, type OpenRouterSharedSettings, type OpenRouterUsageAccounting, createOpenRouter, openrouter };