@langchain/openrouter 0.1.0

package/dist/utils/structured_output.cjs

@@ -0,0 +1,44 @@
+
+//#region src/utils/structured_output.ts
+/**
+* The three strategies OpenRouter can use to extract structured output:
+*
+* - `"jsonSchema"` — native JSON Schema response format (only models that
+*    advertise `structuredOutput` in their profile support this).
+* - `"functionCalling"` — wraps the schema as a tool/function call and
+*    parses the tool output. Works on any model that supports tools.
+* - `"jsonMode"` — asks the model to respond in JSON without a strict
+*    schema constraint (`response_format: { type: "json_object" }`).
+*/
+const SUPPORTED_STRUCTURED_OUTPUT_METHODS = [
+	"jsonSchema",
+	"functionCalling",
+	"jsonMode"
+];
+/**
+* Determines which structured-output strategy to use for a given model
+* and caller configuration.
+*
+* Resolution order:
+* 1. If the caller explicitly requested a method, validate and return it
+*    (throws if the method is unsupported or incompatible with the model).
+* 2. If OpenRouter routing is active (multi-model `models` list or
+*    `route: "fallback"`), fall back to `"functionCalling"` because the
+*    actual backend model — and its capabilities — are unknown at request
+*    time.
+* 3. Otherwise, pick the best method the model supports: `"jsonSchema"`
+*    when the profile advertises native structured output, else
+*    `"functionCalling"`.
+*/
+function resolveOpenRouterStructuredOutputMethod({ model, method, profile, models, route }) {
+	if (method !== void 0 && !SUPPORTED_STRUCTURED_OUTPUT_METHODS.includes(method)) throw new Error(`Invalid structured output method: ${String(method)}. Supported methods are: ${SUPPORTED_STRUCTURED_OUTPUT_METHODS.join(", ")}`);
+	const supportsStructuredOutput = profile.structuredOutput === true;
+	if (method === "jsonSchema" && !supportsStructuredOutput) throw new Error(`Structured output method "jsonSchema" is not supported for model "${model}". Use "functionCalling" or "jsonMode" instead.`);
+	if (method !== void 0) return method;
+	if (route === "fallback" || (models?.length ?? 0) > 0) return "functionCalling";
+	return supportsStructuredOutput ? "jsonSchema" : "functionCalling";
+}
+
+//#endregion
+exports.resolveOpenRouterStructuredOutputMethod = resolveOpenRouterStructuredOutputMethod;
+//# sourceMappingURL=structured_output.cjs.map

package/dist/utils/structured_output.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"structured_output.cjs","names":[],"sources":["../../src/utils/structured_output.ts"],"sourcesContent":["import type { ModelProfile } from \"@langchain/core/language_models/profile\";\n\n/**\n * The three strategies OpenRouter can use to extract structured output:\n *\n * - `\"jsonSchema\"` — native JSON Schema response format (only models that\n *    advertise `structuredOutput` in their profile support this).\n * - `\"functionCalling\"` — wraps the schema as a tool/function call and\n *    parses the tool output. Works on any model that supports tools.\n * - `\"jsonMode\"` — asks the model to respond in JSON without a strict\n *    schema constraint (`response_format: { type: \"json_object\" }`).\n */\nconst SUPPORTED_STRUCTURED_OUTPUT_METHODS = [\n  \"jsonSchema\",\n  \"functionCalling\",\n  \"jsonMode\",\n] as const;\n\nexport type OpenRouterStructuredOutputMethod =\n  (typeof SUPPORTED_STRUCTURED_OUTPUT_METHODS)[number];\n\ninterface ResolveStructuredOutputMethodParams {\n  /** The model identifier, e.g. `\"anthropic/claude-4-sonnet\"`. */\n  model: string;\n  /** Caller-requested method, or `undefined` to auto-detect. */\n  method: unknown;\n  /** Static capability profile for the model. */\n  profile: ModelProfile;\n  /** Optional list of candidate models used with OpenRouter routing. */\n  models?: string[];\n  /** Optional routing strategy (currently only `\"fallback\"`). */\n  route?: \"fallback\";\n}\n\n/**\n * Determines which structured-output strategy to use for a given model\n * and caller configuration.\n *\n * Resolution order:\n * 1. If the caller explicitly requested a method, validate and return it\n *    (throws if the method is unsupported or incompatible with the model).\n * 2. If OpenRouter routing is active (multi-model `models` list or\n *    `route: \"fallback\"`), fall back to `\"functionCalling\"` because the\n *    actual backend model — and its capabilities — are unknown at request\n *    time.\n * 3. Otherwise, pick the best method the model supports: `\"jsonSchema\"`\n *    when the profile advertises native structured output, else\n *    `\"functionCalling\"`.\n */\nexport function resolveOpenRouterStructuredOutputMethod({\n  model,\n  method,\n  profile,\n  models,\n  route,\n}: ResolveStructuredOutputMethodParams): OpenRouterStructuredOutputMethod {\n  if (\n    method !== undefined &&\n    !SUPPORTED_STRUCTURED_OUTPUT_METHODS.includes(\n      method as OpenRouterStructuredOutputMethod\n    )\n  ) {\n    throw new Error(\n      `Invalid structured output method: ${String(\n        method\n      )}. Supported methods are: ${SUPPORTED_STRUCTURED_OUTPUT_METHODS.join(\n        \", \"\n      )}`\n    );\n  }\n\n  const supportsStructuredOutput = profile.structuredOutput === true;\n\n  if (method === \"jsonSchema\" && !supportsStructuredOutput) {\n    throw new Error(\n      `Structured output method \"jsonSchema\" is not supported for model \"${model}\". Use \"functionCalling\" or \"jsonMode\" instead.`\n    );\n  }\n\n  if (method !== undefined) {\n    return method as OpenRouterStructuredOutputMethod;\n  }\n\n  const hasRoutedModelSelection =\n    route === \"fallback\" || (models?.length ?? 0) > 0;\n\n  if (hasRoutedModelSelection) {\n    return \"functionCalling\";\n  }\n\n  return supportsStructuredOutput ? \"jsonSchema\" : \"functionCalling\";\n}\n"],"mappings":";;;;;;;;;;;;AAYA,MAAM,sCAAsC;CAC1C;CACA;CACA;CACD;;;;;;;;;;;;;;;;AAiCD,SAAgB,wCAAwC,EACtD,OACA,QACA,SACA,QACA,SACwE;AACxE,KACE,WAAW,UACX,CAAC,oCAAoC,SACnC,OACD,CAED,OAAM,IAAI,MACR,qCAAqC,OACnC,OACD,CAAC,2BAA2B,oCAAoC,KAC/D,KACD,GACF;CAGH,MAAM,2BAA2B,QAAQ,qBAAqB;AAE9D,KAAI,WAAW,gBAAgB,CAAC,yBAC9B,OAAM,IAAI,MACR,qEAAqE,MAAM,iDAC5E;AAGH,KAAI,WAAW,OACb,QAAO;AAMT,KAFE,UAAU,eAAe,QAAQ,UAAU,KAAK,EAGhD,QAAO;AAGT,QAAO,2BAA2B,eAAe"}

package/dist/utils/structured_output.js

@@ -0,0 +1,43 @@
+//#region src/utils/structured_output.ts
+/**
+* The three strategies OpenRouter can use to extract structured output:
+*
+* - `"jsonSchema"` — native JSON Schema response format (only models that
+*    advertise `structuredOutput` in their profile support this).
+* - `"functionCalling"` — wraps the schema as a tool/function call and
+*    parses the tool output. Works on any model that supports tools.
+* - `"jsonMode"` — asks the model to respond in JSON without a strict
+*    schema constraint (`response_format: { type: "json_object" }`).
+*/
+const SUPPORTED_STRUCTURED_OUTPUT_METHODS = [
+	"jsonSchema",
+	"functionCalling",
+	"jsonMode"
+];
+/**
+* Determines which structured-output strategy to use for a given model
+* and caller configuration.
+*
+* Resolution order:
+* 1. If the caller explicitly requested a method, validate and return it
+*    (throws if the method is unsupported or incompatible with the model).
+* 2. If OpenRouter routing is active (multi-model `models` list or
+*    `route: "fallback"`), fall back to `"functionCalling"` because the
+*    actual backend model — and its capabilities — are unknown at request
+*    time.
+* 3. Otherwise, pick the best method the model supports: `"jsonSchema"`
+*    when the profile advertises native structured output, else
+*    `"functionCalling"`.
+*/
+function resolveOpenRouterStructuredOutputMethod({ model, method, profile, models, route }) {
+	if (method !== void 0 && !SUPPORTED_STRUCTURED_OUTPUT_METHODS.includes(method)) throw new Error(`Invalid structured output method: ${String(method)}. Supported methods are: ${SUPPORTED_STRUCTURED_OUTPUT_METHODS.join(", ")}`);
+	const supportsStructuredOutput = profile.structuredOutput === true;
+	if (method === "jsonSchema" && !supportsStructuredOutput) throw new Error(`Structured output method "jsonSchema" is not supported for model "${model}". Use "functionCalling" or "jsonMode" instead.`);
+	if (method !== void 0) return method;
+	if (route === "fallback" || (models?.length ?? 0) > 0) return "functionCalling";
+	return supportsStructuredOutput ? "jsonSchema" : "functionCalling";
+}
+
+//#endregion
+export { resolveOpenRouterStructuredOutputMethod };
+//# sourceMappingURL=structured_output.js.map

package/dist/utils/structured_output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"structured_output.js","names":[],"sources":["../../src/utils/structured_output.ts"],"sourcesContent":["import type { ModelProfile } from \"@langchain/core/language_models/profile\";\n\n/**\n * The three strategies OpenRouter can use to extract structured output:\n *\n * - `\"jsonSchema\"` — native JSON Schema response format (only models that\n *    advertise `structuredOutput` in their profile support this).\n * - `\"functionCalling\"` — wraps the schema as a tool/function call and\n *    parses the tool output. Works on any model that supports tools.\n * - `\"jsonMode\"` — asks the model to respond in JSON without a strict\n *    schema constraint (`response_format: { type: \"json_object\" }`).\n */\nconst SUPPORTED_STRUCTURED_OUTPUT_METHODS = [\n  \"jsonSchema\",\n  \"functionCalling\",\n  \"jsonMode\",\n] as const;\n\nexport type OpenRouterStructuredOutputMethod =\n  (typeof SUPPORTED_STRUCTURED_OUTPUT_METHODS)[number];\n\ninterface ResolveStructuredOutputMethodParams {\n  /** The model identifier, e.g. `\"anthropic/claude-4-sonnet\"`. */\n  model: string;\n  /** Caller-requested method, or `undefined` to auto-detect. */\n  method: unknown;\n  /** Static capability profile for the model. */\n  profile: ModelProfile;\n  /** Optional list of candidate models used with OpenRouter routing. */\n  models?: string[];\n  /** Optional routing strategy (currently only `\"fallback\"`). */\n  route?: \"fallback\";\n}\n\n/**\n * Determines which structured-output strategy to use for a given model\n * and caller configuration.\n *\n * Resolution order:\n * 1. If the caller explicitly requested a method, validate and return it\n *    (throws if the method is unsupported or incompatible with the model).\n * 2. If OpenRouter routing is active (multi-model `models` list or\n *    `route: \"fallback\"`), fall back to `\"functionCalling\"` because the\n *    actual backend model — and its capabilities — are unknown at request\n *    time.\n * 3. Otherwise, pick the best method the model supports: `\"jsonSchema\"`\n *    when the profile advertises native structured output, else\n *    `\"functionCalling\"`.\n */\nexport function resolveOpenRouterStructuredOutputMethod({\n  model,\n  method,\n  profile,\n  models,\n  route,\n}: ResolveStructuredOutputMethodParams): OpenRouterStructuredOutputMethod {\n  if (\n    method !== undefined &&\n    !SUPPORTED_STRUCTURED_OUTPUT_METHODS.includes(\n      method as OpenRouterStructuredOutputMethod\n    )\n  ) {\n    throw new Error(\n      `Invalid structured output method: ${String(\n        method\n      )}. Supported methods are: ${SUPPORTED_STRUCTURED_OUTPUT_METHODS.join(\n        \", \"\n      )}`\n    );\n  }\n\n  const supportsStructuredOutput = profile.structuredOutput === true;\n\n  if (method === \"jsonSchema\" && !supportsStructuredOutput) {\n    throw new Error(\n      `Structured output method \"jsonSchema\" is not supported for model \"${model}\". Use \"functionCalling\" or \"jsonMode\" instead.`\n    );\n  }\n\n  if (method !== undefined) {\n    return method as OpenRouterStructuredOutputMethod;\n  }\n\n  const hasRoutedModelSelection =\n    route === \"fallback\" || (models?.length ?? 0) > 0;\n\n  if (hasRoutedModelSelection) {\n    return \"functionCalling\";\n  }\n\n  return supportsStructuredOutput ? \"jsonSchema\" : \"functionCalling\";\n}\n"],"mappings":";;;;;;;;;;;AAYA,MAAM,sCAAsC;CAC1C;CACA;CACA;CACD;;;;;;;;;;;;;;;;AAiCD,SAAgB,wCAAwC,EACtD,OACA,QACA,SACA,QACA,SACwE;AACxE,KACE,WAAW,UACX,CAAC,oCAAoC,SACnC,OACD,CAED,OAAM,IAAI,MACR,qCAAqC,OACnC,OACD,CAAC,2BAA2B,oCAAoC,KAC/D,KACD,GACF;CAGH,MAAM,2BAA2B,QAAQ,qBAAqB;AAE9D,KAAI,WAAW,gBAAgB,CAAC,yBAC9B,OAAM,IAAI,MACR,qEAAqE,MAAM,iDAC5E;AAGH,KAAI,WAAW,OACb,QAAO;AAMT,KAFE,UAAU,eAAe,QAAQ,UAAU,KAAK,EAGhD,QAAO;AAGT,QAAO,2BAA2B,eAAe"}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@langchain/openrouter",
+  "version": "0.1.0",
+  "description": "OpenRouter integration for LangChain.js",
+  "author": "LangChain",
+  "license": "MIT",
+  "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:langchain-ai/langchainjs.git",
+    "directory": "libs/providers/langchain-openrouter"
+  },
+  "dependencies": {
+    "eventsource-parser": "^3.0.6",
+    "openai": "^6.22.0",
+    "@langchain/openai": "1.2.8"
+  },
+  "peerDependencies": {
+    "@langchain/core": "^1.0.0"
+  },
+  "devDependencies": {
+    "@tsconfig/recommended": "^1.0.10",
+    "dpdm": "^3.14.0",
+    "eslint": "^9.34.0",
+    "prettier": "^2.8.3",
+    "sparktype": "^0.1.3",
+    "typescript": "~5.8.3",
+    "vitest": "^3.2.4",
+    "zod": "^3.25.76 || ^4",
+    "zod-to-json-schema": "^3.24.6",
+    "@langchain/openai": "^1.2.8",
+    "@langchain/eslint": "0.1.1",
+    "@langchain/standard-tests": "0.0.23",
+    "@langchain/core": "^1.1.26"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "input": "./src/index.ts",
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      },
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/",
+    "CHANGELOG.md",
+    "README.md",
+    "LICENSE"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.cts",
+  "scripts": {
+    "build": "turbo build:compile --filter @langchain/openrouter --output-logs new-only",
+    "build:compile": "tsdown",
+    "lint:eslint": "eslint --cache src/",
+    "lint:dpdm": "dpdm --skip-dynamic-imports circular --exit-code circular:1 --no-warning --no-tree src/**/*.ts",
+    "lint": "pnpm lint:eslint && pnpm lint:dpdm",
+    "lint:fix": "pnpm lint:eslint --fix && pnpm lint:dpdm",
+    "clean": "rm -rf .turbo dist/",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:int": "vitest run --mode int",
+    "test:standard:unit": "vitest run --mode standard-unit",
+    "test:standard:int": "vitest run --mode standard-int",
+    "test:standard": "pnpm test:standard:unit && pnpm test:standard:int",
+    "format": "prettier --write \"src\"",
+    "format:check": "prettier --check \"src\"",
+    "typegen": "pnpm run typegen:sparktype && pnpm run typegen:profiles",
+    "typegen:sparktype": "sparktype generate",
+    "typegen:profiles": "pnpm --filter @langchain/model-profiles make --config profiles.toml",
+    "typegen:check": "sparktype check"
+  }
+}