@openrouter/sdk 0.11.2 → 0.12.1

package/esm/lib/chat-compat.test.js

@@ -1,286 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { fromChatMessages, toChatMessage } from "./chat-compat.js";
-/**
- * Creates a properly typed mock OpenResponsesResult for testing.
- * This factory provides all required fields with sensible defaults.
- */
-function createMockResponse(overrides) {
-    return {
-        id: "resp_test",
-        object: "response",
-        createdAt: Date.now(),
-        completedAt: Date.now(),
-        model: "openai/gpt-4",
-        status: "completed",
-        error: null,
-        incompleteDetails: null,
-        temperature: null,
-        topP: null,
-        presencePenalty: null,
-        frequencyPenalty: null,
-        metadata: null,
-        tools: [],
-        toolChoice: "auto",
-        instructions: null,
-        parallelToolCalls: false,
-        ...overrides,
-    };
-}
-describe("fromChatMessages", () => {
-    describe("basic message conversion", () => {
-        it("converts user message with string content", () => {
-            const messages = [
-                { role: "user", content: "Hello, how are you?" },
-            ];
-            const result = fromChatMessages(messages);
-            expect(result).toEqual([
-                { role: "user", content: "Hello, how are you?" },
-            ]);
-        });
-        it("converts assistant message with string content", () => {
-            const messages = [
-                { role: "assistant", content: "I am doing well, thank you!" },
-            ];
-            const result = fromChatMessages(messages);
-            expect(result).toEqual([
-                { role: "assistant", content: "I am doing well, thank you!" },
-            ]);
-        });
-        it("converts system message with string content", () => {
-            const messages = [
-                { role: "system", content: "You are a helpful assistant." },
-            ];
-            const result = fromChatMessages(messages);
-            expect(result).toEqual([
-                { role: "system", content: "You are a helpful assistant." },
-            ]);
-        });
-        it("converts developer message with string content", () => {
-            const messages = [
-                { role: "developer", content: "Developer instructions here." },
-            ];
-            const result = fromChatMessages(messages);
-            expect(result).toEqual([
-                { role: "developer", content: "Developer instructions here." },
-            ]);
-        });
-        it("converts multiple messages in conversation", () => {
-            const messages = [
-                { role: "system", content: "You are helpful." },
-                { role: "user", content: "Hi" },
-                { role: "assistant", content: "Hello!" },
-                { role: "user", content: "How are you?" },
-            ];
-            const result = fromChatMessages(messages);
-            expect(result).toEqual([
-                { role: "system", content: "You are helpful." },
-                { role: "user", content: "Hi" },
-                { role: "assistant", content: "Hello!" },
-                { role: "user", content: "How are you?" },
-            ]);
-        });
-    });
-    describe("tool response message conversion", () => {
-        it("converts tool message to function_call_output", () => {
-            const messages = [
-                {
-                    role: "tool",
-                    content: "The weather is sunny and 72F",
-                    toolCallId: "call_abc123",
-                },
-            ];
-            const result = fromChatMessages(messages);
-            expect(result).toEqual([
-                {
-                    type: "function_call_output",
-                    callId: "call_abc123",
-                    output: "The weather is sunny and 72F",
-                },
-            ]);
-        });
-        it("converts tool message with object content by stringifying", () => {
-            const messages = [
-                {
-                    role: "tool",
-                    content: [{ type: "text", text: "Structured response" }],
-                    toolCallId: "call_def456",
-                },
-            ];
-            const result = fromChatMessages(messages);
-            expect(result).toEqual([
-                {
-                    type: "function_call_output",
-                    callId: "call_def456",
-                    output: JSON.stringify([{ type: "text", text: "Structured response" }]),
-                },
-            ]);
-        });
-    });
-    describe("content array handling", () => {
-        it("stringifies array content for user messages", () => {
-            const messages = [
-                {
-                    role: "user",
-                    content: [{ type: "text", text: "Hello from array" }],
-                },
-            ];
-            const result = fromChatMessages(messages);
-            expect(result).toEqual([
-                {
-                    role: "user",
-                    content: JSON.stringify([{ type: "text", text: "Hello from array" }]),
-                },
-            ]);
-        });
-        it("stringifies array content for assistant messages", () => {
-            const messages = [
-                {
-                    role: "assistant",
-                    content: [{ type: "text", text: "Response in array" }],
-                },
-            ];
-            const result = fromChatMessages(messages);
-            expect(result).toEqual([
-                {
-                    role: "assistant",
-                    content: JSON.stringify([{ type: "text", text: "Response in array" }]),
-                },
-            ]);
-        });
-    });
-    describe("null and empty content handling", () => {
-        it("handles null content in assistant message", () => {
-            const messages = [
-                { role: "assistant", content: null },
-            ];
-            const result = fromChatMessages(messages);
-            expect(result).toEqual([{ role: "assistant", content: "" }]);
-        });
-        it("handles empty string content", () => {
-            const messages = [{ role: "user", content: "" }];
-            const result = fromChatMessages(messages);
-            expect(result).toEqual([{ role: "user", content: "" }]);
-        });
-        it("handles empty messages array", () => {
-            const result = fromChatMessages([]);
-            expect(result).toEqual([]);
-        });
-    });
-});
-describe("toChatMessage", () => {
-    describe("basic message conversion", () => {
-        it("converts response with text output to ChatAssistantMessage", () => {
-            const response = createMockResponse({
-                id: "resp_123",
-                output: [
-                    {
-                        id: "msg_1",
-                        type: "message",
-                        role: "assistant",
-                        status: "completed",
-                        content: [
-                            {
-                                type: "output_text",
-                                text: "Hello! How can I help you?",
-                                annotations: [],
-                            },
-                        ],
-                    },
-                ],
-                usage: {
-                    inputTokens: 10,
-                    outputTokens: 20,
-                    totalTokens: 30,
-                    inputTokensDetails: { cachedTokens: 0 },
-                    outputTokensDetails: { reasoningTokens: 0 },
-                },
-            });
-            const result = toChatMessage(response);
-            expect(result).toEqual({
-                role: "assistant",
-                content: "Hello! How can I help you?",
-            });
-        });
-        it("combines multiple text parts into single content string", () => {
-            const response = createMockResponse({
-                id: "resp_456",
-                output: [
-                    {
-                        id: "msg_1",
-                        type: "message",
-                        role: "assistant",
-                        status: "completed",
-                        content: [
-                            { type: "output_text", text: "Part 1. ", annotations: [] },
-                            { type: "output_text", text: "Part 2.", annotations: [] },
-                        ],
-                    },
-                ],
-                usage: {
-                    inputTokens: 5,
-                    outputTokens: 10,
-                    totalTokens: 15,
-                    inputTokensDetails: { cachedTokens: 0 },
-                    outputTokensDetails: { reasoningTokens: 0 },
-                },
-            });
-            const result = toChatMessage(response);
-            expect(result).toEqual({
-                role: "assistant",
-                content: "Part 1. Part 2.",
-            });
-        });
-        it("returns null content when message has no text", () => {
-            const response = createMockResponse({
-                id: "resp_789",
-                output: [
-                    {
-                        id: "msg_1",
-                        type: "message",
-                        role: "assistant",
-                        status: "completed",
-                        content: [],
-                    },
-                ],
-                usage: {
-                    inputTokens: 5,
-                    outputTokens: 0,
-                    totalTokens: 5,
-                    inputTokensDetails: { cachedTokens: 0 },
-                    outputTokensDetails: { reasoningTokens: 0 },
-                },
-            });
-            const result = toChatMessage(response);
-            expect(result).toEqual({
-                role: "assistant",
-                content: null,
-            });
-        });
-    });
-    describe("error handling", () => {
-        it("throws error when no message found in output", () => {
-            const response = createMockResponse({
-                id: "resp_err",
-                output: [
-                    {
-                        type: "function_call",
-                        callId: "call_1",
-                        name: "test_tool",
-                        arguments: "{}",
-                        id: "fc_1",
-                        status: "completed",
-                    },
-                ],
-                usage: {
-                    inputTokens: 5,
-                    outputTokens: 10,
-                    totalTokens: 15,
-                    inputTokensDetails: { cachedTokens: 0 },
-                    outputTokensDetails: { reasoningTokens: 0 },
-                },
-            });
-            expect(() => toChatMessage(response)).toThrow("No message found in response output");
-        });
-    });
-});
-//# sourceMappingURL=chat-compat.test.js.map

package/esm/models/chatwebsearchservertool.d.ts

@@ -1,124 +0,0 @@
-import * as z from "zod/v4";
-import { ClosedEnum, OpenEnum } from "../types/enums.js";
-export declare const ChatWebSearchServerToolTypeOpenrouterWebSearch: {
-    readonly OpenrouterWebSearch: "openrouter:web_search";
-};
-export type ChatWebSearchServerToolTypeOpenrouterWebSearch = ClosedEnum<typeof ChatWebSearchServerToolTypeOpenrouterWebSearch>;
-/**
- * Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API.
- */
-export declare const ChatWebSearchServerToolEngine: {
-    readonly Auto: "auto";
-    readonly Native: "native";
-    readonly Exa: "exa";
-    readonly Firecrawl: "firecrawl";
-    readonly Parallel: "parallel";
-};
-/**
- * Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API.
- */
-export type ChatWebSearchServerToolEngine = OpenEnum<typeof ChatWebSearchServerToolEngine>;
-/**
- * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
- */
-export declare const ChatWebSearchServerToolSearchContextSize: {
-    readonly Low: "low";
-    readonly Medium: "medium";
-    readonly High: "high";
-};
-/**
- * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
- */
-export type ChatWebSearchServerToolSearchContextSize = OpenEnum<typeof ChatWebSearchServerToolSearchContextSize>;
-export declare const ChatWebSearchServerToolParametersType: {
-    readonly Approximate: "approximate";
-};
-export type ChatWebSearchServerToolParametersType = ClosedEnum<typeof ChatWebSearchServerToolParametersType>;
-/**
- * Approximate user location for location-biased results.
- */
-export type ChatWebSearchServerToolUserLocation = {
-    type?: ChatWebSearchServerToolParametersType | undefined;
-    city?: string | undefined;
-    region?: string | undefined;
-    country?: string | undefined;
-    timezone?: string | undefined;
-};
-export type ChatWebSearchServerToolParameters = {
-    /**
-     * Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API.
-     */
-    engine?: ChatWebSearchServerToolEngine | undefined;
-    /**
-     * Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search.
-     */
-    maxResults?: number | undefined;
-    /**
-     * Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops.
-     */
-    maxTotalResults?: number | undefined;
-    /**
-     * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
-     */
-    searchContextSize?: ChatWebSearchServerToolSearchContextSize | undefined;
-    /**
-     * Approximate user location for location-biased results.
-     */
-    userLocation?: ChatWebSearchServerToolUserLocation | undefined;
-    /**
-     * Limit search results to these domains. Applies to Exa and Parallel engines. Not supported with Firecrawl or native provider search.
-     */
-    allowedDomains?: Array<string> | undefined;
-    /**
-     * Exclude search results from these domains. Applies to Exa and Parallel engines. Not supported with Firecrawl or native provider search.
-     */
-    excludedDomains?: Array<string> | undefined;
-};
-/**
- * OpenRouter built-in server tool: searches the web for current information
- */
-export type ChatWebSearchServerTool = {
-    type: ChatWebSearchServerToolTypeOpenrouterWebSearch;
-    parameters?: ChatWebSearchServerToolParameters | undefined;
-};
-/** @internal */
-export declare const ChatWebSearchServerToolTypeOpenrouterWebSearch$outboundSchema: z.ZodEnum<typeof ChatWebSearchServerToolTypeOpenrouterWebSearch>;
-/** @internal */
-export declare const ChatWebSearchServerToolEngine$outboundSchema: z.ZodType<string, ChatWebSearchServerToolEngine>;
-/** @internal */
-export declare const ChatWebSearchServerToolSearchContextSize$outboundSchema: z.ZodType<string, ChatWebSearchServerToolSearchContextSize>;
-/** @internal */
-export declare const ChatWebSearchServerToolParametersType$outboundSchema: z.ZodEnum<typeof ChatWebSearchServerToolParametersType>;
-/** @internal */
-export type ChatWebSearchServerToolUserLocation$Outbound = {
-    type?: string | undefined;
-    city?: string | undefined;
-    region?: string | undefined;
-    country?: string | undefined;
-    timezone?: string | undefined;
-};
-/** @internal */
-export declare const ChatWebSearchServerToolUserLocation$outboundSchema: z.ZodType<ChatWebSearchServerToolUserLocation$Outbound, ChatWebSearchServerToolUserLocation>;
-export declare function chatWebSearchServerToolUserLocationToJSON(chatWebSearchServerToolUserLocation: ChatWebSearchServerToolUserLocation): string;
-/** @internal */
-export type ChatWebSearchServerToolParameters$Outbound = {
-    engine?: string | undefined;
-    max_results?: number | undefined;
-    max_total_results?: number | undefined;
-    search_context_size?: string | undefined;
-    user_location?: ChatWebSearchServerToolUserLocation$Outbound | undefined;
-    allowed_domains?: Array<string> | undefined;
-    excluded_domains?: Array<string> | undefined;
-};
-/** @internal */
-export declare const ChatWebSearchServerToolParameters$outboundSchema: z.ZodType<ChatWebSearchServerToolParameters$Outbound, ChatWebSearchServerToolParameters>;
-export declare function chatWebSearchServerToolParametersToJSON(chatWebSearchServerToolParameters: ChatWebSearchServerToolParameters): string;
-/** @internal */
-export type ChatWebSearchServerTool$Outbound = {
-    type: string;
-    parameters?: ChatWebSearchServerToolParameters$Outbound | undefined;
-};
-/** @internal */
-export declare const ChatWebSearchServerTool$outboundSchema: z.ZodType<ChatWebSearchServerTool$Outbound, ChatWebSearchServerTool>;
-export declare function chatWebSearchServerToolToJSON(chatWebSearchServerTool: ChatWebSearchServerTool): string;
-//# sourceMappingURL=chatwebsearchservertool.d.ts.map

package/esm/models/chatwebsearchservertool.js

@@ -1,84 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: ae822f875178
- */
-import * as z from "zod/v4";
-import { remap as remap$ } from "../lib/primitives.js";
-import * as openEnums from "../types/enums.js";
-export const ChatWebSearchServerToolTypeOpenrouterWebSearch = {
-    OpenrouterWebSearch: "openrouter:web_search",
-};
-/**
- * Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API.
- */
-export const ChatWebSearchServerToolEngine = {
-    Auto: "auto",
-    Native: "native",
-    Exa: "exa",
-    Firecrawl: "firecrawl",
-    Parallel: "parallel",
-};
-/**
- * How much context to retrieve per result. Defaults to medium (15000 chars). Only applies when using the Exa engine; ignored with native provider search.
- */
-export const ChatWebSearchServerToolSearchContextSize = {
-    Low: "low",
-    Medium: "medium",
-    High: "high",
-};
-export const ChatWebSearchServerToolParametersType = {
-    Approximate: "approximate",
-};
-/** @internal */
-export const ChatWebSearchServerToolTypeOpenrouterWebSearch$outboundSchema = z.enum(ChatWebSearchServerToolTypeOpenrouterWebSearch);
-/** @internal */
-export const ChatWebSearchServerToolEngine$outboundSchema = openEnums.outboundSchema(ChatWebSearchServerToolEngine);
-/** @internal */
-export const ChatWebSearchServerToolSearchContextSize$outboundSchema = openEnums.outboundSchema(ChatWebSearchServerToolSearchContextSize);
-/** @internal */
-export const ChatWebSearchServerToolParametersType$outboundSchema = z.enum(ChatWebSearchServerToolParametersType);
-/** @internal */
-export const ChatWebSearchServerToolUserLocation$outboundSchema = z.object({
-    type: ChatWebSearchServerToolParametersType$outboundSchema.optional(),
-    city: z.string().optional(),
-    region: z.string().optional(),
-    country: z.string().optional(),
-    timezone: z.string().optional(),
-});
-export function chatWebSearchServerToolUserLocationToJSON(chatWebSearchServerToolUserLocation) {
-    return JSON.stringify(ChatWebSearchServerToolUserLocation$outboundSchema.parse(chatWebSearchServerToolUserLocation));
-}
-/** @internal */
-export const ChatWebSearchServerToolParameters$outboundSchema = z.object({
-    engine: ChatWebSearchServerToolEngine$outboundSchema.optional(),
-    maxResults: z.number().optional(),
-    maxTotalResults: z.number().optional(),
-    searchContextSize: ChatWebSearchServerToolSearchContextSize$outboundSchema
-        .optional(),
-    userLocation: z.lazy(() => ChatWebSearchServerToolUserLocation$outboundSchema)
-        .optional(),
-    allowedDomains: z.array(z.string()).optional(),
-    excludedDomains: z.array(z.string()).optional(),
-}).transform((v) => {
-    return remap$(v, {
-        maxResults: "max_results",
-        maxTotalResults: "max_total_results",
-        searchContextSize: "search_context_size",
-        userLocation: "user_location",
-        allowedDomains: "allowed_domains",
-        excludedDomains: "excluded_domains",
-    });
-});
-export function chatWebSearchServerToolParametersToJSON(chatWebSearchServerToolParameters) {
-    return JSON.stringify(ChatWebSearchServerToolParameters$outboundSchema.parse(chatWebSearchServerToolParameters));
-}
-/** @internal */
-export const ChatWebSearchServerTool$outboundSchema = z.object({
-    type: ChatWebSearchServerToolTypeOpenrouterWebSearch$outboundSchema,
-    parameters: z.lazy(() => ChatWebSearchServerToolParameters$outboundSchema)
-        .optional(),
-});
-export function chatWebSearchServerToolToJSON(chatWebSearchServerTool) {
-    return JSON.stringify(ChatWebSearchServerTool$outboundSchema.parse(chatWebSearchServerTool));
-}
-//# sourceMappingURL=chatwebsearchservertool.js.map

package/esm/models/createchargerequest.d.ts

@@ -1,28 +0,0 @@
-import * as z from "zod/v4";
-import { OpenEnum } from "../types/enums.js";
-export declare const ChainId: {
-    readonly One: 1;
-    readonly OneHundredAndThirtySeven: 137;
-    readonly EightThousandFourHundredAndFiftyThree: 8453;
-};
-export type ChainId = OpenEnum<typeof ChainId>;
-/**
- * Create a Coinbase charge for crypto payment
- */
-export type CreateChargeRequest = {
-    amount: number;
-    sender: string;
-    chainId: ChainId;
-};
-/** @internal */
-export declare const ChainId$outboundSchema: z.ZodType<number, ChainId>;
-/** @internal */
-export type CreateChargeRequest$Outbound = {
-    amount: number;
-    sender: string;
-    chain_id: number;
-};
-/** @internal */
-export declare const CreateChargeRequest$outboundSchema: z.ZodType<CreateChargeRequest$Outbound, CreateChargeRequest>;
-export declare function createChargeRequestToJSON(createChargeRequest: CreateChargeRequest): string;
-//# sourceMappingURL=createchargerequest.d.ts.map

package/esm/models/createchargerequest.js

@@ -1,29 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: c342dc72d1f4
- */
-import * as z from "zod/v4";
-import { remap as remap$ } from "../lib/primitives.js";
-import * as openEnums from "../types/enums.js";
-export const ChainId = {
-    One: 1,
-    OneHundredAndThirtySeven: 137,
-    EightThousandFourHundredAndFiftyThree: 8453,
-};
-/** @internal */
-export const ChainId$outboundSchema = openEnums
-    .outboundSchemaInt(ChainId);
-/** @internal */
-export const CreateChargeRequest$outboundSchema = z.object({
-    amount: z.number(),
-    sender: z.string(),
-    chainId: ChainId$outboundSchema,
-}).transform((v) => {
-    return remap$(v, {
-        chainId: "chain_id",
-    });
-});
-export function createChargeRequestToJSON(createChargeRequest) {
-    return JSON.stringify(CreateChargeRequest$outboundSchema.parse(createChargeRequest));
-}
-//# sourceMappingURL=createchargerequest.js.map

package/esm/models/datacollection.d.ts

@@ -1,26 +0,0 @@
-import * as z from "zod/v4";
-import { OpenEnum } from "../types/enums.js";
-/**
- * Data collection setting. If no available model provider meets the requirement, your request will return an error.
- *
- * @remarks
- * - allow: (default) allow providers which store user data non-transiently and may train on it
- *
- * - deny: use only providers which do not collect user data.
- */
-export declare const DataCollection: {
-    readonly Deny: "deny";
-    readonly Allow: "allow";
-};
-/**
- * Data collection setting. If no available model provider meets the requirement, your request will return an error.
- *
- * @remarks
- * - allow: (default) allow providers which store user data non-transiently and may train on it
- *
- * - deny: use only providers which do not collect user data.
- */
-export type DataCollection = OpenEnum<typeof DataCollection>;
-/** @internal */
-export declare const DataCollection$outboundSchema: z.ZodType<string, DataCollection>;
-//# sourceMappingURL=datacollection.d.ts.map

package/esm/models/datacollection.js

@@ -1,20 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: fa417e9ad79a
- */
-import * as openEnums from "../types/enums.js";
-/**
- * Data collection setting. If no available model provider meets the requirement, your request will return an error.
- *
- * @remarks
- * - allow: (default) allow providers which store user data non-transiently and may train on it
- *
- * - deny: use only providers which do not collect user data.
- */
-export const DataCollection = {
-    Deny: "deny",
-    Allow: "allow",
-};
-/** @internal */
-export const DataCollection$outboundSchema = openEnums.outboundSchema(DataCollection);
-//# sourceMappingURL=datacollection.js.map