@openrouter/ai-sdk-provider 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -1,8 +1,37 @@
 import { LanguageModelV1 } from '@ai-sdk/provider';
 export { LanguageModelV1 } from '@ai-sdk/provider';
 
+type OpenRouterLanguageModel = LanguageModelV1;
+type OpenRouterProviderOptions = {
+    models?: string[];
+    /**
+     * https://openrouter.ai/docs/use-cases/reasoning-tokens
+     * One of `max_tokens` or `effort` is required.
+     * If `exclude` is true, reasoning will be removed from the response. Default is false.
+     */
+    reasoning?: {
+        exclude?: boolean;
+    } & ({
+        max_tokens: number;
+    } | {
+        effort: 'high' | 'medium' | 'low';
+    });
+    /**
+     * A unique identifier representing your end-user, which can
+     * help OpenRouter to monitor and detect abuse.
+     */
+    user?: string;
+};
+type OpenRouterSharedSettings = OpenRouterProviderOptions & {
+    /**
+     * @deprecated use `reasoning` instead
+     */
+    includeReasoning?: boolean;
+    extraBody?: Record<string, any>;
+};
+
 type OpenRouterChatModelId = string;
-interface OpenRouterChatSettings {
+type OpenRouterChatSettings = {
     /**
   Modify the likelihood of specified tokens appearing in the completion.
   
@@ -39,52 +68,10 @@ interface OpenRouterChatSettings {
   monitor and detect abuse. Learn more.
   */
     user?: string;
-    /**
-     * List of model IDs to try in order if the primary model fails, e.g. ["anthropic/claude-2","gryphe/mythomax-l2-13b"]
-     */
-    models?: string[];
-    /**
-     * @deprecated use `reasoning` instead
-     */
-    includeReasoning?: boolean;
-    reasoning?: {
-        exclude?: boolean;
-        max_tokens?: number;
-        effort?: 'high' | 'medium' | 'low';
-    };
-    extraBody?: Record<string, any>;
-}
-
-type OpenRouterChatConfig = {
-    provider: string;
-    compatibility: "strict" | "compatible";
-    headers: () => Record<string, string | undefined>;
-    url: (options: {
-        modelId: string;
-        path: string;
-    }) => string;
-    fetch?: typeof fetch;
-    extraBody?: Record<string, unknown>;
-};
-declare class OpenRouterChatLanguageModel implements LanguageModelV1 {
-    readonly specificationVersion = "v1";
-    readonly defaultObjectGenerationMode = "tool";
-    readonly modelId: OpenRouterChatModelId;
-    readonly settings: OpenRouterChatSettings;
-    private readonly config;
-    constructor(modelId: OpenRouterChatModelId, settings: OpenRouterChatSettings, config: OpenRouterChatConfig);
-    get provider(): string;
-    private getArgs;
-    doGenerate(options: Parameters<LanguageModelV1["doGenerate"]>[0]): Promise<Awaited<ReturnType<LanguageModelV1["doGenerate"]>>>;
-    doStream(options: Parameters<LanguageModelV1["doStream"]>[0]): Promise<Awaited<ReturnType<LanguageModelV1["doStream"]>>>;
-}
+} & OpenRouterSharedSettings;
 
-type OpenRouterCompletionModelId = string & {};
-interface OpenRouterCompletionSettings {
-    /**
-  Echo back the prompt in addition to the completion.
-     */
-    echo?: boolean;
+type OpenRouterCompletionModelId = string;
+type OpenRouterCompletionSettings = {
     /**
   Modify the likelihood of specified tokens appearing in the completion.
   
@@ -116,30 +103,35 @@ interface OpenRouterCompletionSettings {
   The suffix that comes after a completion of inserted text.
      */
     suffix?: string;
-    /**
-  A unique identifier representing your end-user, which can help OpenRouter to
-  monitor and detect abuse. Learn more.
-     */
-    user?: string;
-    /**
-     * List of model IDs to try in order if the primary model fails, e.g. ["openai/gpt-4","anthropic/claude-2"]
-     */
-    models?: string[];
-    /**
-     * @deprecated use `reasoning` instead
-     */
-    includeReasoning?: boolean;
-    reasoning?: {
-        exclude?: boolean;
-        max_tokens?: number;
-        effort?: 'high' | 'medium' | 'low';
-    };
-    extraBody?: Record<string, any>;
+} & OpenRouterSharedSettings;
+
+type OpenRouterChatConfig = {
+    provider: string;
+    compatibility: 'strict' | 'compatible';
+    headers: () => Record<string, string | undefined>;
+    url: (options: {
+        modelId: string;
+        path: string;
+    }) => string;
+    fetch?: typeof fetch;
+    extraBody?: Record<string, unknown>;
+};
+declare class OpenRouterChatLanguageModel implements LanguageModelV1 {
+    readonly specificationVersion = "v1";
+    readonly defaultObjectGenerationMode = "tool";
+    readonly modelId: OpenRouterChatModelId;
+    readonly settings: OpenRouterChatSettings;
+    private readonly config;
+    constructor(modelId: OpenRouterChatModelId, settings: OpenRouterChatSettings, config: OpenRouterChatConfig);
+    get provider(): string;
+    private getArgs;
+    doGenerate(options: Parameters<LanguageModelV1['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doGenerate']>>>;
+    doStream(options: Parameters<LanguageModelV1['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doStream']>>>;
 }
 
 type OpenRouterCompletionConfig = {
     provider: string;
-    compatibility: "strict" | "compatible";
+    compatibility: 'strict' | 'compatible';
     headers: () => Record<string, string | undefined>;
     url: (options: {
         modelId: string;
@@ -157,8 +149,8 @@ declare class OpenRouterCompletionLanguageModel implements LanguageModelV1 {
     constructor(modelId: OpenRouterCompletionModelId, settings: OpenRouterCompletionSettings, config: OpenRouterCompletionConfig);
     get provider(): string;
     private getArgs;
-    doGenerate(options: Parameters<LanguageModelV1["doGenerate"]>[0]): Promise<Awaited<ReturnType<LanguageModelV1["doGenerate"]>>>;
-    doStream(options: Parameters<LanguageModelV1["doStream"]>[0]): Promise<Awaited<ReturnType<LanguageModelV1["doStream"]>>>;
+    doGenerate(options: Parameters<LanguageModelV1['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doGenerate']>>>;
+    doStream(options: Parameters<LanguageModelV1['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doStream']>>>;
 }
 
 interface OpenRouterProvider {
@@ -197,7 +189,7 @@ interface OpenRouterProviderSettings {
   and `compatible` when using 3rd party providers. In `compatible` mode, newer
   information such as streamOptions are not being sent. Defaults to 'compatible'.
      */
-    compatibility?: "strict" | "compatible";
+    compatibility?: 'strict' | 'compatible';
     /**
   Custom fetch implementation. You can use it as a middleware to intercept requests,
   or to provide a custom fetch implementation for e.g. testing.
@@ -244,6 +236,4 @@ declare class OpenRouter {
     completion(modelId: OpenRouterCompletionModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
 }
 
-type OpenRouterLanguageModel = LanguageModelV1;
-
-export { OpenRouter, type OpenRouterCompletionSettings, type OpenRouterLanguageModel, type OpenRouterProvider, type OpenRouterProviderSettings, createOpenRouter, openrouter };
+export { OpenRouter, type OpenRouterCompletionSettings, type OpenRouterLanguageModel, type OpenRouterProvider, type OpenRouterProviderOptions, type OpenRouterProviderSettings, type OpenRouterSharedSettings, createOpenRouter, openrouter };

package/dist/index.js

@@ -135,6 +135,10 @@ function convertToOpenRouterChatMessages(prompt) {
               });
               break;
             }
+            // TODO: Handle reasoning and redacted-reasoning
+            case "reasoning":
+            case "redacted-reasoning":
+              break;
             default: {
               const _exhaustiveCheck = part;
               throw new Error(`Unsupported part: ${_exhaustiveCheck}`);
@@ -198,8 +202,8 @@ function mapOpenRouterFinishReason(finishReason) {
 }
 
 // src/openrouter-error.ts
-var import_zod = require("zod");
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
+var import_zod = require("zod");
 var openAIErrorDataSchema = import_zod.z.object({
   error: import_zod.z.object({
     message: import_zod.z.string(),
@@ -239,10 +243,13 @@ var OpenRouterChatLanguageModel = class {
     seed,
     stopSequences,
     responseFormat,
-    topK
+    topK,
+    providerMetadata
   }) {
+    var _a;
     const type = mode.type;
-    const baseArgs = __spreadValues(__spreadValues({
+    const extraCallingBody = (_a = providerMetadata == null ? void 0 : providerMetadata["openrouter"]) != null ? _a : {};
+    const baseArgs = __spreadValues(__spreadValues(__spreadValues({
       // model id:
       model: this.modelId,
       models: this.settings.models,
@@ -267,7 +274,7 @@ var OpenRouterChatLanguageModel = class {
       // OpenRouter specific settings:
       include_reasoning: this.settings.includeReasoning,
       reasoning: this.settings.reasoning
-    }, this.config.extraBody), this.settings.extraBody);
+    }, this.config.extraBody), this.settings.extraBody), extraCallingBody);
     switch (type) {
       case "regular": {
         return __spreadValues(__spreadValues({}, baseArgs), prepareToolsAndToolChoice(mode));
@@ -572,7 +579,7 @@ var openrouterChatChunkSchema = import_zod2.z.union([
         delta: import_zod2.z.object({
           role: import_zod2.z.enum(["assistant"]).optional(),
           content: import_zod2.z.string().nullish(),
-          reasoning: import_zod2.z.string().nullish(),
+          reasoning: import_zod2.z.string().nullish().optional(),
           tool_calls: import_zod2.z.array(
             import_zod2.z.object({
               index: import_zod2.z.number(),
@@ -711,7 +718,9 @@ function convertToOpenRouterCompletionPrompt({
             }
             default: {
               const _exhaustiveCheck = part;
-              throw new Error(`Unsupported content type: ${_exhaustiveCheck}`);
+              throw new Error(
+                `Unsupported content type: ${_exhaustiveCheck}`
+              );
             }
           }
         }).join("");
@@ -732,9 +741,21 @@ ${userMessage}
                 functionality: "tool-call messages"
               });
             }
+            case "reasoning": {
+              throw new import_provider2.UnsupportedFunctionalityError({
+                functionality: "reasoning messages"
+              });
+            }
+            case "redacted-reasoning": {
+              throw new import_provider2.UnsupportedFunctionalityError({
+                functionality: "redacted reasoning messages"
+              });
+            }
             default: {
               const _exhaustiveCheck = part;
-              throw new Error(`Unsupported content type: ${_exhaustiveCheck}`);
+              throw new Error(
+                `Unsupported content type: ${_exhaustiveCheck}`
+              );
             }
           }
         }).join("");
@@ -803,17 +824,21 @@ var OpenRouterCompletionLanguageModel = class {
     seed,
     responseFormat,
     topK,
-    stopSequences
+    stopSequences,
+    providerMetadata
   }) {
-    var _a;
+    var _a, _b;
     const type = mode.type;
-    const { prompt: completionPrompt } = convertToOpenRouterCompletionPrompt({ prompt, inputFormat });
-    const baseArgs = __spreadValues(__spreadValues({
+    const extraCallingBody = (_a = providerMetadata == null ? void 0 : providerMetadata["openrouter"]) != null ? _a : {};
+    const { prompt: completionPrompt } = convertToOpenRouterCompletionPrompt({
+      prompt,
+      inputFormat
+    });
+    const baseArgs = __spreadValues(__spreadValues(__spreadValues({
       // model id:
       model: this.modelId,
       models: this.settings.models,
       // model specific settings:
-      echo: this.settings.echo,
       logit_bias: this.settings.logitBias,
       logprobs: typeof this.settings.logprobs === "number" ? this.settings.logprobs : typeof this.settings.logprobs === "boolean" ? this.settings.logprobs ? 0 : void 0 : void 0,
       suffix: this.settings.suffix,
@@ -833,10 +858,10 @@ var OpenRouterCompletionLanguageModel = class {
       // OpenRouter specific settings:
       include_reasoning: this.settings.includeReasoning,
       reasoning: this.settings.reasoning
-    }, this.config.extraBody), this.settings.extraBody);
+    }, this.config.extraBody), this.settings.extraBody), extraCallingBody);
     switch (type) {
       case "regular": {
-        if ((_a = mode.tools) == null ? void 0 : _a.length) {
+        if ((_b = mode.tools) == null ? void 0 : _b.length) {
           throw new import_provider3.UnsupportedFunctionalityError({
             functionality: "tools"
           });
@@ -988,7 +1013,7 @@ var openAICompletionResponseSchema = import_zod3.z.object({
   choices: import_zod3.z.array(
     import_zod3.z.object({
       text: import_zod3.z.string(),
-      reasoning: import_zod3.z.string().nullable(),
+      reasoning: import_zod3.z.string().nullish().optional(),
       finish_reason: import_zod3.z.string(),
       logprobs: import_zod3.z.object({
         tokens: import_zod3.z.array(import_zod3.z.string()),