@openrouter/ai-sdk-provider 2.3.2 → 2.4.0

package/dist/index.d.mts

@@ -431,6 +431,7 @@ type OpenRouterCompletionSettings = {
 declare enum ReasoningFormat {
     Unknown = "unknown",
     OpenAIResponsesV1 = "openai-responses-v1",
+    AzureOpenAIResponsesV1 = "azure-openai-responses-v1",
     XAIResponsesV1 = "xai-responses-v1",
     AnthropicClaudeV1 = "anthropic-claude-v1",
     GoogleGeminiV1 = "google-gemini-v1"
@@ -676,6 +677,16 @@ interface OpenRouterProviderSettings {
      * Maps provider slugs (e.g. "anthropic", "openai") to their respective API keys.
      */
     api_keys?: Record<string, string>;
+    /**
+     * Your app's display name. Sets the `X-OpenRouter-Title` header on
+     * every request for app attribution on the openrouter.ai dashboard.
+     */
+    appName?: string;
+    /**
+     * Your app's URL or identifier. Sets the `HTTP-Referer` header on every request,
+     * used to identify your app on the openrouter.ai dashboard.
+     */
+    appUrl?: string;
 }
 /**
 Create an OpenRouter provider instance.
@@ -708,6 +719,14 @@ declare class OpenRouter {
      * Record of provider slugs to API keys for injecting into provider routing.
      */
     readonly api_keys?: Record<string, string>;
+    /**
+     * App display name for the `X-OpenRouter-Title` header.
+     */
+    readonly appName?: string;
+    /**
+     * App URL for the `HTTP-Referer` header.
+     */
+    readonly appUrl?: string;
     /**
      * Creates a new OpenRouter provider instance.
      */

package/dist/index.d.ts

@@ -431,6 +431,7 @@ type OpenRouterCompletionSettings = {
 declare enum ReasoningFormat {
     Unknown = "unknown",
     OpenAIResponsesV1 = "openai-responses-v1",
+    AzureOpenAIResponsesV1 = "azure-openai-responses-v1",
     XAIResponsesV1 = "xai-responses-v1",
     AnthropicClaudeV1 = "anthropic-claude-v1",
     GoogleGeminiV1 = "google-gemini-v1"
@@ -676,6 +677,16 @@ interface OpenRouterProviderSettings {
      * Maps provider slugs (e.g. "anthropic", "openai") to their respective API keys.
      */
     api_keys?: Record<string, string>;
+    /**
+     * Your app's display name. Sets the `X-OpenRouter-Title` header on
+     * every request for app attribution on the openrouter.ai dashboard.
+     */
+    appName?: string;
+    /**
+     * Your app's URL or identifier. Sets the `HTTP-Referer` header on every request,
+     * used to identify your app on the openrouter.ai dashboard.
+     */
+    appUrl?: string;
 }
 /**
 Create an OpenRouter provider instance.
@@ -708,6 +719,14 @@ declare class OpenRouter {
      * Record of provider slugs to API keys for injecting into provider routing.
      */
     readonly api_keys?: Record<string, string>;
+    /**
+     * App display name for the `X-OpenRouter-Title` header.
+     */
+    readonly appName?: string;
+    /**
+     * App URL for the `HTTP-Referer` header.
+     */
+    readonly appUrl?: string;
     /**
      * Creates a new OpenRouter provider instance.
      */

package/dist/index.js

@@ -2216,11 +2216,13 @@ function isDefinedOrNotNull(value) {
 var ReasoningFormat = /* @__PURE__ */ ((ReasoningFormat2) => {
   ReasoningFormat2["Unknown"] = "unknown";
   ReasoningFormat2["OpenAIResponsesV1"] = "openai-responses-v1";
+  ReasoningFormat2["AzureOpenAIResponsesV1"] = "azure-openai-responses-v1";
   ReasoningFormat2["XAIResponsesV1"] = "xai-responses-v1";
   ReasoningFormat2["AnthropicClaudeV1"] = "anthropic-claude-v1";
   ReasoningFormat2["GoogleGeminiV1"] = "google-gemini-v1";
   return ReasoningFormat2;
 })(ReasoningFormat || {});
+var DEFAULT_REASONING_FORMAT = "anthropic-claude-v1" /* AnthropicClaudeV1 */;
 
 // src/schemas/reasoning-details.ts
 var CommonReasoningDetailSchema = import_v4.z.object({
@@ -2373,7 +2375,11 @@ var OpenRouterProviderMetadataSchema = import_v43.z.object({
 }).catchall(import_v43.z.any());
 var OpenRouterProviderOptionsSchema = import_v43.z.object({
   openrouter: import_v43.z.object({
-    reasoning_details: import_v43.z.array(ReasoningDetailUnionSchema).optional(),
+    // Use ReasoningDetailArraySchema (with unknown fallback) instead of
+    // z.array(ReasoningDetailUnionSchema) so that a single malformed entry
+    // (e.g., a future format not yet in the enum) is individually dropped
+    // rather than causing the entire array to fail parsing.
+    reasoning_details: ReasoningDetailArraySchema.optional(),
     annotations: import_v43.z.array(FileAnnotationSchema).optional()
   }).optional()
 }).optional();
@@ -2444,6 +2450,31 @@ function createFinishReason(unified, raw) {
   return { unified, raw };
 }
 
+// src/utils/with-stream-error-handling.ts
+function withStreamErrorHandling(source, onError) {
+  const reader = source.getReader();
+  return new ReadableStream({
+    async pull(controller) {
+      try {
+        const { done, value } = await reader.read();
+        if (done) {
+          controller.close();
+        } else {
+          controller.enqueue(value);
+        }
+      } catch (err) {
+        onError(err);
+        reader.cancel().catch(() => {
+        });
+        controller.close();
+      }
+    },
+    cancel(reason) {
+      reader.cancel(reason);
+    }
+  });
+}
+
 // src/utils/reasoning-details-duplicate-tracker.ts
 var _seenKeys;
 var ReasoningDetailsDuplicateTracker = class {
@@ -2785,8 +2816,24 @@ function convertToOpenRouterChatMessages(prompt) {
         const candidateReasoningDetails = messageReasoningDetails && Array.isArray(messageReasoningDetails) && messageReasoningDetails.length > 0 ? messageReasoningDetails : findFirstReasoningDetails(content);
         let finalReasoningDetails;
         if (candidateReasoningDetails && candidateReasoningDetails.length > 0) {
+          const validDetails = candidateReasoningDetails.filter((detail) => {
+            var _a17;
+            if (detail.type !== "reasoning.text" /* Text */) {
+              return true;
+            }
+            const format = (_a17 = detail.format) != null ? _a17 : DEFAULT_REASONING_FORMAT;
+            if (format !== "anthropic-claude-v1" /* AnthropicClaudeV1 */) {
+              return true;
+            }
+            return !!detail.signature;
+          });
+          if (validDetails.length < candidateReasoningDetails.length) {
+            console.warn(
+              "[openrouter] Some reasoning_details entries were removed because they were missing signatures. See https://github.com/OpenRouterTeam/ai-sdk-provider/issues/423 for more details."
+            );
+          }
           const uniqueDetails = [];
-          for (const detail of candidateReasoningDetails) {
+          for (const detail of validDetails) {
             if (reasoningDetailsTracker.upsert(detail)) {
               uniqueDetails.push(detail);
             }
@@ -2815,6 +2862,7 @@ function convertToOpenRouterChatMessages(prompt) {
             role: "tool",
             tool_call_id: toolResponse.toolCallId,
             content: content2,
+            name: toolResponse.toolName,
             cache_control: (_h = getCacheControl(providerOptions)) != null ? _h : getCacheControl(toolResponse.providerOptions)
           });
         }
@@ -2956,13 +3004,14 @@ function filenameFromUrl(url) {
   }
 }
 function findFirstReasoningDetails(content) {
-  var _a16, _b16, _c;
+  var _a16, _b16, _c, _d;
   for (const part of content) {
     if (part.type === "tool-call") {
-      const openrouter2 = (_a16 = part.providerOptions) == null ? void 0 : _a16.openrouter;
-      const details = openrouter2 == null ? void 0 : openrouter2.reasoning_details;
-      if (Array.isArray(details) && details.length > 0) {
-        return details;
+      const parsed = OpenRouterProviderOptionsSchema.safeParse(
+        part.providerOptions
+      );
+      if (parsed.success && ((_b16 = (_a16 = parsed.data) == null ? void 0 : _a16.openrouter) == null ? void 0 : _b16.reasoning_details) && parsed.data.openrouter.reasoning_details.length > 0) {
+        return parsed.data.openrouter.reasoning_details;
       }
     }
   }
@@ -2971,7 +3020,7 @@ function findFirstReasoningDetails(content) {
       const parsed = OpenRouterProviderOptionsSchema.safeParse(
         part.providerOptions
       );
-      if (parsed.success && ((_c = (_b16 = parsed.data) == null ? void 0 : _b16.openrouter) == null ? void 0 : _c.reasoning_details) && parsed.data.openrouter.reasoning_details.length > 0) {
+      if (parsed.success && ((_d = (_c = parsed.data) == null ? void 0 : _c.openrouter) == null ? void 0 : _d.reasoning_details) && parsed.data.openrouter.reasoning_details.length > 0) {
         return parsed.data.openrouter.reasoning_details;
       }
     }
@@ -3476,7 +3525,8 @@ var OpenRouterChatLanguageModel = class {
       (d) => d.type === "reasoning.encrypted" /* Encrypted */ && d.data
     );
     const shouldOverrideFinishReason = hasToolCalls && hasEncryptedReasoning && choice.finish_reason === "stop";
-    const effectiveFinishReason = shouldOverrideFinishReason ? createFinishReason("tool-calls", (_j = choice.finish_reason) != null ? _j : void 0) : mapOpenRouterFinishReason(choice.finish_reason);
+    const mappedFinishReason = shouldOverrideFinishReason ? createFinishReason("tool-calls", (_j = choice.finish_reason) != null ? _j : void 0) : mapOpenRouterFinishReason(choice.finish_reason);
+    const effectiveFinishReason = hasToolCalls && mappedFinishReason.unified === "other" ? createFinishReason("tool-calls", mappedFinishReason.raw) : mappedFinishReason;
     return {
       content,
       finishReason: effectiveFinishReason,
@@ -3540,6 +3590,10 @@ var OpenRouterChatLanguageModel = class {
       abortSignal: options.abortSignal,
       fetch: this.config.fetch
     });
+    let streamError;
+    const safeResponse = withStreamErrorHandling(response, (err) => {
+      streamError = err;
+    });
     const toolCalls = [];
     let finishReason = createFinishReason("other");
     const usage = {
@@ -3568,7 +3622,7 @@ var OpenRouterChatLanguageModel = class {
     let openrouterResponseId;
     let provider;
     return {
-      stream: response.pipeThrough(
+      stream: safeResponse.pipeThrough(
         new TransformStream({
           transform(chunk, controller) {
             var _a17, _b17, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u;
@@ -3890,12 +3944,19 @@ var OpenRouterChatLanguageModel = class {
           flush(controller) {
             var _a17;
             const hasToolCalls = toolCalls.length > 0;
+            if (streamError != null) {
+              finishReason = createFinishReason("error");
+              controller.enqueue({ type: "error", error: streamError });
+            }
             const hasEncryptedReasoning = accumulatedReasoningDetails.some(
               (d) => d.type === "reasoning.encrypted" /* Encrypted */ && d.data
             );
             if (hasToolCalls && hasEncryptedReasoning && finishReason.unified === "stop") {
               finishReason = createFinishReason("tool-calls", finishReason.raw);
             }
+            if (hasToolCalls && finishReason.unified === "other") {
+              finishReason = createFinishReason("tool-calls", finishReason.raw);
+            }
             if (finishReason.unified === "tool-calls") {
               for (const toolCall of toolCalls) {
                 if (toolCall && !toolCall.sent) {
@@ -4281,6 +4342,10 @@ var OpenRouterCompletionLanguageModel = class {
       abortSignal: options.abortSignal,
       fetch: this.config.fetch
     });
+    let streamError;
+    const safeResponse = withStreamErrorHandling(response, (err) => {
+      streamError = err;
+    });
     let finishReason = createFinishReason("other");
     const usage = {
       inputTokens: {
@@ -4300,7 +4365,7 @@ var OpenRouterCompletionLanguageModel = class {
     let provider;
     let rawUsage;
     return {
-      stream: response.pipeThrough(
+      stream: safeResponse.pipeThrough(
         new TransformStream({
           transform(chunk, controller) {
             var _a16, _b16, _c, _d, _e;
@@ -4364,6 +4429,10 @@ var OpenRouterCompletionLanguageModel = class {
             }
           },
           flush(controller) {
+            if (streamError != null) {
+              finishReason = createFinishReason("error");
+              controller.enqueue({ type: "error", error: streamError });
+            }
             usage.raw = rawUsage;
             const openrouterMetadata = {
               usage: openrouterUsage
@@ -4477,17 +4546,19 @@ var OpenRouter = class {
     this.apiKey = options.apiKey;
     this.headers = options.headers;
     this.api_keys = options.api_keys;
+    this.appName = options.appName;
+    this.appUrl = options.appUrl;
   }
   get baseConfig() {
     return {
       baseURL: this.baseURL,
-      headers: () => __spreadValues(__spreadValues({
+      headers: () => __spreadValues(__spreadValues(__spreadValues(__spreadValues({
         Authorization: `Bearer ${loadApiKey({
           apiKey: this.apiKey,
           environmentVariableName: "OPENROUTER_API_KEY",
           description: "OpenRouter"
         })}`
-      }, this.headers), this.api_keys && Object.keys(this.api_keys).length > 0 && {
+      }, this.appName && { "X-OpenRouter-Title": this.appName }), this.appUrl && { "HTTP-Referer": this.appUrl }), this.headers), this.api_keys && Object.keys(this.api_keys).length > 0 && {
         "X-Provider-API-Keys": JSON.stringify(this.api_keys)
       })
     };
@@ -4724,7 +4795,7 @@ function withUserAgentSuffix2(headers, ...userAgentSuffixParts) {
 }
 
 // src/version.ts
-var VERSION2 = false ? "0.0.0-test" : "2.3.2";
+var VERSION2 = false ? "0.0.0-test" : "2.4.0";
 
 // src/provider.ts
 function createOpenRouter(options = {}) {
@@ -4732,13 +4803,13 @@ function createOpenRouter(options = {}) {
   const baseURL = (_b16 = withoutTrailingSlash((_a16 = options.baseURL) != null ? _a16 : options.baseUrl)) != null ? _b16 : "https://openrouter.ai/api/v1";
   const compatibility = (_c = options.compatibility) != null ? _c : "compatible";
   const getHeaders = () => withUserAgentSuffix2(
-    __spreadValues(__spreadValues({
+    __spreadValues(__spreadValues(__spreadValues(__spreadValues({
       Authorization: `Bearer ${loadApiKey({
         apiKey: options.apiKey,
         environmentVariableName: "OPENROUTER_API_KEY",
         description: "OpenRouter"
       })}`
-    }, options.headers), options.api_keys && Object.keys(options.api_keys).length > 0 && {
+    }, options.appName && { "X-OpenRouter-Title": options.appName }), options.appUrl && { "HTTP-Referer": options.appUrl }), options.headers), options.api_keys && Object.keys(options.api_keys).length > 0 && {
       "X-Provider-API-Keys": JSON.stringify(options.api_keys)
     }),
     `ai-sdk/openrouter/${VERSION2}`