@funkai/models 0.2.1 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/.turbo/turbo-build.log +35 -36
  2. package/CHANGELOG.md +18 -0
  3. package/dist/alibaba-B6q4Ng1R.mjs.map +1 -1
  4. package/dist/amazon-bedrock-Cv9AHQBH.mjs.map +1 -1
  5. package/dist/anthropic-yB7ST97_.mjs.map +1 -1
  6. package/dist/cerebras-COfl7XM-.mjs.map +1 -1
  7. package/dist/cohere-B7TgO0hT.mjs.map +1 -1
  8. package/dist/deepinfra-B0GxUwCG.mjs.map +1 -1
  9. package/dist/deepseek-D64ZEsvS.mjs.map +1 -1
  10. package/dist/fireworks-ai-DJYvdAi_.mjs.map +1 -1
  11. package/dist/google-BypRl349.mjs.map +1 -1
  12. package/dist/google-vertex-DbS-zTGD.mjs.map +1 -1
  13. package/dist/groq-ei_PerYi.mjs.map +1 -1
  14. package/dist/huggingface-DaM1EeLP.mjs.map +1 -1
  15. package/dist/inception-CspEzqNV.mjs.map +1 -1
  16. package/dist/index.d.mts +41 -87
  17. package/dist/index.d.mts.map +1 -1
  18. package/dist/index.mjs +20 -115
  19. package/dist/index.mjs.map +1 -1
  20. package/dist/llama-Cf3-koap.mjs.map +1 -1
  21. package/dist/mistral-BI9MdAO4.mjs.map +1 -1
  22. package/dist/nvidia-COHacuoa.mjs.map +1 -1
  23. package/dist/openai-C0nCfZUq.mjs.map +1 -1
  24. package/dist/openrouter-DSFzxKQb.mjs.map +1 -1
  25. package/dist/perplexity-zeZ2WlBU.mjs.map +1 -1
  26. package/dist/providers/alibaba.d.mts +1 -1
  27. package/dist/providers/amazon-bedrock.d.mts +1 -1
  28. package/dist/providers/anthropic.d.mts +1 -1
  29. package/dist/providers/cerebras.d.mts +1 -1
  30. package/dist/providers/cohere.d.mts +1 -1
  31. package/dist/providers/deepinfra.d.mts +1 -1
  32. package/dist/providers/deepseek.d.mts +1 -1
  33. package/dist/providers/fireworks-ai.d.mts +1 -1
  34. package/dist/providers/google-vertex.d.mts +1 -1
  35. package/dist/providers/google.d.mts +1 -1
  36. package/dist/providers/groq.d.mts +1 -1
  37. package/dist/providers/huggingface.d.mts +1 -1
  38. package/dist/providers/inception.d.mts +1 -1
  39. package/dist/providers/llama.d.mts +1 -1
  40. package/dist/providers/mistral.d.mts +1 -1
  41. package/dist/providers/nvidia.d.mts +1 -1
  42. package/dist/providers/openai.d.mts +1 -1
  43. package/dist/providers/openrouter.d.mts +1 -1
  44. package/dist/providers/perplexity.d.mts +1 -1
  45. package/dist/providers/togetherai.d.mts +1 -1
  46. package/dist/providers/xai.d.mts +1 -1
  47. package/dist/togetherai-BvcxUfPE.mjs.map +1 -1
  48. package/dist/{types-DjdaZckF.d.mts → types-DIzolT_s.d.mts} +61 -21
  49. package/dist/types-DIzolT_s.d.mts.map +1 -0
  50. package/dist/xai-fSuAkQJo.mjs.map +1 -1
  51. package/package.json +7 -6
  52. package/scripts/generate-models.ts +152 -83
  53. package/src/catalog/index.test.ts +8 -20
  54. package/src/catalog/index.ts +4 -1
  55. package/src/catalog/providers/alibaba.ts +91 -91
  56. package/src/catalog/providers/amazon-bedrock.ts +205 -185
  57. package/src/catalog/providers/anthropic.ts +87 -62
  58. package/src/catalog/providers/cerebras.ts +9 -9
  59. package/src/catalog/providers/cohere.ts +16 -16
  60. package/src/catalog/providers/deepinfra.ts +71 -71
  61. package/src/catalog/providers/deepseek.ts +3 -3
  62. package/src/catalog/providers/fireworks-ai.ts +36 -36
  63. package/src/catalog/providers/google-vertex.ts +62 -62
  64. package/src/catalog/providers/google.ts +69 -69
  65. package/src/catalog/providers/groq.ts +24 -24
  66. package/src/catalog/providers/huggingface.ts +52 -52
  67. package/src/catalog/providers/inception.ts +9 -9
  68. package/src/catalog/providers/index.ts +1 -0
  69. package/src/catalog/providers/llama.ts +7 -7
  70. package/src/catalog/providers/mistral.ts +60 -60
  71. package/src/catalog/providers/nvidia.ts +84 -84
  72. package/src/catalog/providers/openai.ts +115 -115
  73. package/src/catalog/providers/openrouter.ts +448 -433
  74. package/src/catalog/providers/perplexity.ts +9 -9
  75. package/src/catalog/providers/togetherai.ts +47 -47
  76. package/src/catalog/providers/xai.ts +49 -49
  77. package/src/catalog/types.ts +60 -20
  78. package/src/cost/calculate.test.ts +11 -19
  79. package/src/index.ts +2 -8
  80. package/src/provider/index.ts +2 -8
  81. package/src/provider/registry.test.ts +87 -0
  82. package/src/provider/registry.ts +93 -0
  83. package/src/provider/types.ts +1 -1
  84. package/tsconfig.json +2 -1
  85. package/tsdown.config.ts +7 -4
  86. package/dist/types-DjdaZckF.d.mts.map +0 -1
  87. package/src/provider/openrouter.test.ts +0 -125
  88. package/src/provider/openrouter.ts +0 -110
  89. package/src/provider/resolver.test.ts +0 -138
  90. package/src/provider/resolver.ts +0 -125
@@ -4,10 +4,6 @@ import { calculateCost } from "./calculate.js";
4
4
  import type { ModelPricing } from "@/catalog/types.js";
5
5
  import type { TokenUsage } from "@/provider/types.js";
6
6
 
7
- // ---------------------------------------------------------------------------
8
- // Helpers
9
- // ---------------------------------------------------------------------------
10
-
11
7
  const ZERO_USAGE: TokenUsage = {
12
8
  inputTokens: 0,
13
9
  outputTokens: 0,
@@ -18,29 +14,25 @@ const ZERO_USAGE: TokenUsage = {
18
14
  };
19
15
 
20
16
  const BASIC_PRICING: ModelPricing = {
21
- input: 0.000002,
22
- output: 0.000008,
17
+ input: 0.000_002,
18
+ output: 0.000_008,
23
19
  };
24
20
 
25
21
  const FULL_PRICING: ModelPricing = {
26
- input: 0.000002,
27
- output: 0.000008,
28
- cacheRead: 0.0000005,
29
- cacheWrite: 0.000001,
22
+ input: 0.000_002,
23
+ output: 0.000_008,
24
+ cacheRead: 0.000_000_5,
25
+ cacheWrite: 0.000_001,
30
26
  };
31
27
 
32
28
  const REASONING_PRICING: ModelPricing = {
33
- input: 0.000002,
34
- output: 0.000008,
35
- cacheRead: 0.0000005,
36
- cacheWrite: 0.000001,
37
- reasoning: 0.000012,
29
+ input: 0.000_002,
30
+ output: 0.000_008,
31
+ cacheRead: 0.000_000_5,
32
+ cacheWrite: 0.000_001,
33
+ reasoning: 0.000_012,
38
34
  };
39
35
 
40
- // ---------------------------------------------------------------------------
41
- // calculateCost()
42
- // ---------------------------------------------------------------------------
43
-
44
36
  describe("calculateCost()", () => {
45
37
  it("returns all zeros for zero usage", () => {
46
38
  const result = calculateCost(ZERO_USAGE, FULL_PRICING);
package/src/index.ts CHANGED
@@ -10,14 +10,8 @@ export type {
10
10
  } from "@/catalog/index.js";
11
11
 
12
12
  // Provider
13
- export { createOpenRouter, openrouter } from "@/provider/openrouter.js";
14
- export { createModelResolver } from "@/provider/resolver.js";
15
- export type {
16
- ProviderFactory,
17
- ProviderMap,
18
- ModelResolverConfig,
19
- ModelResolver,
20
- } from "@/provider/resolver.js";
13
+ export { createProviderRegistry } from "@/provider/registry.js";
14
+ export type { ProviderRegistryConfig, ProviderRegistry } from "@/provider/registry.js";
21
15
  export type { LanguageModel, TokenUsage } from "@/provider/types.js";
22
16
 
23
17
  // Cost
@@ -1,9 +1,3 @@
1
- export { createOpenRouter, openrouter } from "./openrouter.js";
2
- export { createModelResolver } from "./resolver.js";
3
- export type {
4
- ProviderFactory,
5
- ProviderMap,
6
- ModelResolverConfig,
7
- ModelResolver,
8
- } from "./resolver.js";
1
+ export { createProviderRegistry } from "./registry.js";
2
+ export type { ProviderRegistryConfig, ProviderRegistry } from "./registry.js";
9
3
  export type { LanguageModel, TokenUsage } from "./types.js";
@@ -0,0 +1,87 @@
1
+ import { describe, expect, it, vi } from "vitest";
2
+
3
+ import { createProviderRegistry } from "@/provider/registry.js";
4
+ import type { LanguageModel } from "@/provider/types.js";
5
+
6
+ function fakeModel(id: string): LanguageModel {
7
+ return { modelId: id } as unknown as LanguageModel;
8
+ }
9
+
10
+ function fakeProvider(prefix: string) {
11
+ return {
12
+ specificationVersion: "v3" as const,
13
+ languageModel: (modelName: string) => fakeModel(`${prefix}/${modelName}`),
14
+ textEmbeddingModel: () => {
15
+ throw new Error("not implemented");
16
+ },
17
+ embeddingModel: () => {
18
+ throw new Error("not implemented");
19
+ },
20
+ imageModel: () => {
21
+ throw new Error("not implemented");
22
+ },
23
+ };
24
+ }
25
+
26
+ describe("createProviderRegistry()", () => {
27
+ it("resolves a model ID via the mapped provider", () => {
28
+ const registry = createProviderRegistry({
29
+ providers: { openai: fakeProvider("openai") },
30
+ });
31
+
32
+ const result = registry("openai/gpt-4.1");
33
+
34
+ expect(result).toEqual(fakeModel("openai/gpt-4.1"));
35
+ });
36
+
37
+ it("supports multiple mapped providers", () => {
38
+ const openai = fakeProvider("openai");
39
+ const anthropic = fakeProvider("anthropic");
40
+ const openaiSpy = vi.spyOn(openai, "languageModel");
41
+ const anthropicSpy = vi.spyOn(anthropic, "languageModel");
42
+
43
+ const registry = createProviderRegistry({
44
+ providers: { openai, anthropic },
45
+ });
46
+
47
+ registry("openai/gpt-4.1");
48
+ registry("anthropic/claude-sonnet-4-20250514");
49
+
50
+ expect(openaiSpy).toHaveBeenCalledWith("gpt-4.1");
51
+ expect(anthropicSpy).toHaveBeenCalledWith("claude-sonnet-4-20250514");
52
+ });
53
+
54
+ it("handles model IDs with multiple slashes correctly", () => {
55
+ const registry = createProviderRegistry({
56
+ providers: { "meta-llama": fakeProvider("meta-llama") },
57
+ });
58
+
59
+ const result = registry("meta-llama/llama-4-scout/extended");
60
+
61
+ expect(result).toEqual(fakeModel("meta-llama/llama-4-scout/extended"));
62
+ });
63
+
64
+ it("throws for empty model ID", () => {
65
+ const registry = createProviderRegistry({
66
+ providers: { openai: fakeProvider("openai") },
67
+ });
68
+
69
+ expect(() => registry("")).toThrow("Cannot resolve model: model ID is empty");
70
+ });
71
+
72
+ it("throws for whitespace-only model ID", () => {
73
+ const registry = createProviderRegistry({
74
+ providers: { openai: fakeProvider("openai") },
75
+ });
76
+
77
+ expect(() => registry(" ")).toThrow("Cannot resolve model: model ID is empty");
78
+ });
79
+
80
+ it("throws for unmapped provider prefix", () => {
81
+ const registry = createProviderRegistry({
82
+ providers: { openai: fakeProvider("openai") },
83
+ });
84
+
85
+ expect(() => registry("anthropic/claude-sonnet-4-20250514")).toThrow();
86
+ });
87
+ });
@@ -0,0 +1,93 @@
1
+ import { createProviderRegistry as baseCreateProviderRegistry } from "ai";
2
+
3
+ import type { ModelId } from "@/catalog/index.js";
4
+ import type { LanguageModel } from "@/provider/types.js";
5
+
6
+ /**
7
+ * Extract the provider type accepted by the AI SDK's `createProviderRegistry`.
8
+ *
9
+ * @private
10
+ */
11
+ type AIProviders = Parameters<typeof baseCreateProviderRegistry>[0];
12
+
13
+ /**
14
+ * Configuration for {@link createProviderRegistry}.
15
+ */
16
+ export interface ProviderRegistryConfig {
17
+ /**
18
+ * AI SDK provider instances keyed by prefix.
19
+ *
20
+ * When a model ID like `"openai/gpt-4.1"` is resolved, the prefix
21
+ * `"openai"` is extracted and looked up in this map.
22
+ *
23
+ * @example
24
+ * ```typescript
25
+ * import { createOpenAI } from '@ai-sdk/openai'
26
+ * import { anthropic } from '@ai-sdk/anthropic'
27
+ *
28
+ * const registry = createProviderRegistry({
29
+ * providers: {
30
+ * openai: createOpenAI({ apiKey: '...' }),
31
+ * anthropic,
32
+ * },
33
+ * })
34
+ * ```
35
+ */
36
+ readonly providers: AIProviders;
37
+ }
38
+
39
+ /**
40
+ * A function that resolves a model ID to a {@link LanguageModel} instance.
41
+ *
42
+ * @param modelId - Catalog model identifier in `provider/model` format.
43
+ * @returns The resolved AI SDK {@link LanguageModel}.
44
+ *
45
+ * @example
46
+ * ```typescript
47
+ * const model = registry("openai/gpt-4.1");
48
+ * ```
49
+ */
50
+ export type ProviderRegistry = (modelId: ModelId) => LanguageModel;
51
+
52
+ /**
53
+ * Create a provider registry that resolves `provider/model` string IDs
54
+ * to AI SDK {@link LanguageModel} instances.
55
+ *
56
+ * Thin wrapper around the AI SDK's `createProviderRegistry` that uses
57
+ * `/` as the separator instead of `:`, matching the model ID format used
58
+ * throughout the funkai catalog (e.g. `"openai/gpt-4.1"`).
59
+ *
60
+ * @param config - Provider mappings.
61
+ * @returns A resolver function that maps model IDs to {@link LanguageModel} instances.
62
+ *
63
+ * @example
64
+ * ```typescript
65
+ * import { createOpenAI } from '@ai-sdk/openai'
66
+ * import { anthropic } from '@ai-sdk/anthropic'
67
+ * import { createProviderRegistry } from '@funkai/models'
68
+ *
69
+ * const registry = createProviderRegistry({
70
+ * providers: {
71
+ * openai: createOpenAI({ apiKey: '...' }),
72
+ * anthropic,
73
+ * },
74
+ * })
75
+ *
76
+ * const m1 = registry('openai/gpt-4.1')
77
+ * const m2 = registry('anthropic/claude-sonnet-4')
78
+ * ```
79
+ */
80
+ export function createProviderRegistry(config: ProviderRegistryConfig): ProviderRegistry {
81
+ const inner = baseCreateProviderRegistry(config.providers, {
82
+ separator: "/",
83
+ });
84
+
85
+ return (modelId: ModelId): LanguageModel => {
86
+ if (!modelId.trim()) {
87
+ throw new Error("Cannot resolve model: model ID is empty");
88
+ }
89
+ // Cast needed: AI SDK overloads expect `provider/model` template literal,
90
+ // But our ModelId is a branded string union. The runtime validates the format.
91
+ return inner.languageModel(modelId as `${string}/${string}`) as LanguageModel;
92
+ };
93
+ }
@@ -1,4 +1,4 @@
1
- import { type LanguageModel as BaseLanguageModel } from "ai";
1
+ import type { LanguageModel as BaseLanguageModel } from "ai";
2
2
 
3
3
  /**
4
4
  * AI SDK language model instance (v3 specification).
package/tsconfig.json CHANGED
@@ -18,7 +18,8 @@
18
18
  "rootDir": ".",
19
19
  "paths": {
20
20
  "@/*": ["./src/*"]
21
- }
21
+ },
22
+ "types": ["node"]
22
23
  },
23
24
  "include": ["src"],
24
25
  "exclude": ["node_modules", "dist"]
package/tsdown.config.ts CHANGED
@@ -3,11 +3,14 @@ import { join } from "node:path";
3
3
 
4
4
  import { defineConfig } from "tsdown";
5
5
 
6
- // Read generated entry points (created by generate-models script)
7
6
  const entriesPath = join(import.meta.dirname, ".generated", "entries.json");
8
- const generatedEntries: string[] = existsSync(entriesPath)
9
- ? JSON.parse(readFileSync(entriesPath, "utf-8"))
10
- : [];
7
+ // oxlint-disable-next-line eslint-plugin-jest/require-hook
8
+ const generatedEntries: string[] = (() => {
9
+ if (existsSync(entriesPath)) {
10
+ return JSON.parse(readFileSync(entriesPath, "utf8")) as string[];
11
+ }
12
+ return [];
13
+ })();
11
14
 
12
15
  export default defineConfig([
13
16
  {
@@ -1 +0,0 @@
1
- {"version":3,"file":"types-DjdaZckF.d.mts","names":[],"sources":["../src/catalog/types.ts"],"mappings":";;AAOA;;;;;;UAAiB,YAAA;EAWN;EAAA,SATA,KAAA;EAYS;EAAA,SATT,MAAA;EAkBM;EAAA,SAfN,SAAA;;WAGA,UAAA;EAiBM;EAAA,SAdN,SAAA;AAAA;;;;;;;UASM,eAAA;EAsBU;EAAA,SApBhB,KAAA;EA0BqB;EAAA,SAvBrB,MAAA;AAAA;;;;UAMM,iBAAA;EAmBN;EAAA,SAjBA,SAAA;EAuBA;EAAA,SApBA,QAAA;EA0BA;EAAA,SAvBA,UAAA;EA0BA;EAAA,SAvBA,gBAAA;AAAA;;;;UAMM,eAAA;EA0ByB;EAAA,SAxB/B,EAAA;;WAGA,IAAA;;WAGA,QAAA;;WAGA,MAAA;;WAGA,OAAA,EAAS,YAAA;;WAGT,aAAA;;WAGA,SAAA;;WAGA,UAAA,EAAY,eAAA;;WAGZ,YAAA,EAAc,iBAAA;AAAA"}
@@ -1,125 +0,0 @@
1
- import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
2
-
3
- // Mock the external provider before importing the module under test
4
- const mockBaseCreateOpenRouter = vi.fn();
5
- const mockProviderInstance = vi.fn();
6
-
7
- vi.mock("@openrouter/ai-sdk-provider", () => ({
8
- createOpenRouter: mockBaseCreateOpenRouter,
9
- }));
10
-
11
- // Must import after mocking
12
- const { createOpenRouter, openrouter } = await import("@/provider/openrouter.js");
13
-
14
- // ---------------------------------------------------------------------------
15
- // createOpenRouter()
16
- // ---------------------------------------------------------------------------
17
-
18
- describe("createOpenRouter()", () => {
19
- beforeEach(() => {
20
- vi.clearAllMocks();
21
- mockBaseCreateOpenRouter.mockReturnValue(mockProviderInstance);
22
- vi.stubEnv("OPENROUTER_API_KEY", "env-key-123");
23
- });
24
-
25
- afterEach(() => {
26
- vi.unstubAllEnvs();
27
- });
28
-
29
- it("uses explicit apiKey when provided in options", () => {
30
- createOpenRouter({ apiKey: "explicit-key" });
31
-
32
- expect(mockBaseCreateOpenRouter).toHaveBeenCalledWith(
33
- expect.objectContaining({ apiKey: "explicit-key" }),
34
- );
35
- });
36
-
37
- it("falls back to OPENROUTER_API_KEY env var when no apiKey in options", () => {
38
- createOpenRouter();
39
-
40
- expect(mockBaseCreateOpenRouter).toHaveBeenCalledWith(
41
- expect.objectContaining({ apiKey: "env-key-123" }),
42
- );
43
- });
44
-
45
- it("falls back to env var when options are provided without apiKey", () => {
46
- createOpenRouter({});
47
-
48
- expect(mockBaseCreateOpenRouter).toHaveBeenCalledWith(
49
- expect.objectContaining({ apiKey: "env-key-123" }),
50
- );
51
- });
52
-
53
- it("throws when no apiKey provided and env var is not set", () => {
54
- vi.stubEnv("OPENROUTER_API_KEY", undefined as unknown as string);
55
-
56
- expect(() => createOpenRouter()).toThrow("OPENROUTER_API_KEY environment variable is required");
57
- });
58
-
59
- it("forwards additional options to the base provider", () => {
60
- createOpenRouter({ apiKey: "key", baseURL: "https://custom.api" } as Record<string, unknown>);
61
-
62
- expect(mockBaseCreateOpenRouter).toHaveBeenCalledWith(
63
- expect.objectContaining({
64
- apiKey: "key",
65
- baseURL: "https://custom.api",
66
- }),
67
- );
68
- });
69
- });
70
-
71
- // ---------------------------------------------------------------------------
72
- // openrouter() — cached model factory
73
- // ---------------------------------------------------------------------------
74
-
75
- describe("openrouter()", () => {
76
- beforeEach(() => {
77
- vi.clearAllMocks();
78
- mockProviderInstance.mockReturnValue({ modelId: "mock-model" });
79
- mockBaseCreateOpenRouter.mockReturnValue(mockProviderInstance);
80
- });
81
-
82
- afterEach(() => {
83
- vi.unstubAllEnvs();
84
- });
85
-
86
- it("creates a provider and returns a language model", () => {
87
- vi.stubEnv("OPENROUTER_API_KEY", "key-test-create");
88
-
89
- const result = openrouter("openai/gpt-5.2-codex");
90
-
91
- expect(mockBaseCreateOpenRouter).toHaveBeenCalledWith({ apiKey: "key-test-create" });
92
- expect(mockProviderInstance).toHaveBeenCalledWith("openai/gpt-5.2-codex");
93
- expect(result).toEqual({ modelId: "mock-model" });
94
- });
95
-
96
- it("reuses cached provider on subsequent calls with same api key", () => {
97
- vi.stubEnv("OPENROUTER_API_KEY", "key-test-reuse");
98
-
99
- openrouter("openai/gpt-5.2-codex");
100
- openrouter("openai/gpt-5.2");
101
-
102
- // Provider should only be created once since key is the same
103
- expect(mockBaseCreateOpenRouter).toHaveBeenCalledTimes(1);
104
- expect(mockProviderInstance).toHaveBeenCalledTimes(2);
105
- });
106
-
107
- it("creates new provider when api key changes", () => {
108
- vi.stubEnv("OPENROUTER_API_KEY", "key-test-change-1");
109
- openrouter("openai/gpt-5.2-codex");
110
-
111
- vi.stubEnv("OPENROUTER_API_KEY", "key-test-change-2");
112
- openrouter("openai/gpt-5.2");
113
-
114
- expect(mockBaseCreateOpenRouter).toHaveBeenCalledTimes(2);
115
- expect(mockBaseCreateOpenRouter).toHaveBeenLastCalledWith({ apiKey: "key-test-change-2" });
116
- });
117
-
118
- it("throws when OPENROUTER_API_KEY is not set", () => {
119
- vi.stubEnv("OPENROUTER_API_KEY", undefined as unknown as string);
120
-
121
- expect(() => openrouter("openai/gpt-5.2-codex")).toThrow(
122
- "OPENROUTER_API_KEY environment variable is required",
123
- );
124
- });
125
- });
@@ -1,110 +0,0 @@
1
- import {
2
- createOpenRouter as baseCreateOpenRouter,
3
- type OpenRouterProvider,
4
- type OpenRouterProviderSettings,
5
- } from "@openrouter/ai-sdk-provider";
6
-
7
- import type { ModelId } from "@/catalog/index.js";
8
- import type { LanguageModel } from "@/provider/types.js";
9
-
10
- /**
11
- * Create an OpenRouter provider instance with automatic API key resolution.
12
- *
13
- * Falls back to the `OPENROUTER_API_KEY` environment variable when
14
- * no explicit `apiKey` is provided in the options.
15
- *
16
- * @param options - Provider settings forwarded to `@openrouter/ai-sdk-provider`.
17
- * @returns A configured {@link OpenRouterProvider} instance.
18
- *
19
- * @example
20
- * ```typescript
21
- * const openrouter = createOpenRouter({ apiKey: 'sk-...' })
22
- * const m = openrouter('openai/gpt-5.2-codex')
23
- * ```
24
- */
25
- export function createOpenRouter(options?: OpenRouterProviderSettings): OpenRouterProvider {
26
- const apiKey = resolveApiKey(options);
27
- return baseCreateOpenRouter({
28
- ...options,
29
- apiKey,
30
- });
31
- }
32
-
33
- // ---------------------------------------------------------------------------
34
- // Private helpers
35
- // ---------------------------------------------------------------------------
36
-
37
- /**
38
- * @private
39
- */
40
- function resolveApiKey(options: OpenRouterProviderSettings | undefined): string {
41
- if (options != null && options.apiKey != null) {
42
- return options.apiKey;
43
- }
44
- return getOpenRouterApiKey();
45
- }
46
-
47
- /**
48
- * Create a cached OpenRouter model resolver.
49
- *
50
- * The returned function caches the underlying provider and invalidates
51
- * when the API key changes at runtime.
52
- *
53
- * @returns A function that resolves a model ID to a {@link LanguageModel}.
54
- *
55
- * @private
56
- */
57
- // Cache mutation is safe: JS is single-threaded and baseCreateOpenRouter is synchronous.
58
- // If this were refactored to async initialization, a lock or re-architecture would be needed.
59
- function createCachedOpenRouter(): (modelId: ModelId) => LanguageModel {
60
- const cache: { provider: OpenRouterProvider | undefined; apiKey: string | undefined } = {
61
- provider: undefined,
62
- apiKey: undefined,
63
- };
64
- return (modelId: ModelId): LanguageModel => {
65
- const apiKey = getOpenRouterApiKey();
66
- if (!cache.provider || cache.apiKey !== apiKey) {
67
- cache.provider = baseCreateOpenRouter({ apiKey });
68
- cache.apiKey = apiKey;
69
- }
70
- return cache.provider(modelId);
71
- };
72
- }
73
-
74
- /**
75
- * Shorthand for creating a single OpenRouter language model.
76
- *
77
- * Resolves the API key from the environment and returns a ready-to-use
78
- * {@link LanguageModel} that can be passed directly to AI SDK functions.
79
- *
80
- * The provider instance is cached at module scope and reused across
81
- * calls. If `OPENROUTER_API_KEY` changes at runtime, the cache is
82
- * invalidated and a new provider is created.
83
- *
84
- * @param modelId - A model identifier (e.g. `"openai/gpt-5.2-codex"`).
85
- * @returns A configured {@link LanguageModel} instance.
86
- *
87
- * @example
88
- * ```typescript
89
- * const m = openrouter('openai/gpt-5.2-codex')
90
- * ```
91
- */
92
- export const openrouter: (modelId: ModelId) => LanguageModel = createCachedOpenRouter();
93
-
94
- /**
95
- * Read the OpenRouter API key from the environment.
96
- *
97
- * @throws {Error} If `OPENROUTER_API_KEY` is not set.
98
- *
99
- * @private
100
- */
101
- function getOpenRouterApiKey(): string {
102
- const apiKey = process.env.OPENROUTER_API_KEY;
103
- if (!apiKey) {
104
- throw new Error(
105
- "OPENROUTER_API_KEY environment variable is required. " +
106
- "Set it in your .env file or environment.",
107
- );
108
- }
109
- return apiKey;
110
- }
@@ -1,138 +0,0 @@
1
- import { describe, expect, it, vi } from "vitest";
2
-
3
- import { createModelResolver } from "@/provider/resolver.js";
4
- import type { LanguageModel } from "@/provider/types.js";
5
-
6
- // ---------------------------------------------------------------------------
7
- // Helpers
8
- // ---------------------------------------------------------------------------
9
-
10
- function fakeModel(id: string): LanguageModel {
11
- return { modelId: id } as unknown as LanguageModel;
12
- }
13
-
14
- function fakeFactory(prefix: string): (modelName: string) => LanguageModel {
15
- return (modelName: string) => fakeModel(`${prefix}/${modelName}`);
16
- }
17
-
18
- // ---------------------------------------------------------------------------
19
- // createModelResolver()
20
- // ---------------------------------------------------------------------------
21
-
22
- describe("createModelResolver()", () => {
23
- it("throws when no providers or fallback are configured for prefixed ID", () => {
24
- const resolve = createModelResolver();
25
-
26
- expect(() => resolve("openai/gpt-4.1")).toThrow(
27
- 'Cannot resolve model "openai/gpt-4.1": no provider mapped for "openai" and no fallback configured',
28
- );
29
- });
30
-
31
- it("throws when no providers or fallback are configured for unprefixed ID", () => {
32
- const resolve = createModelResolver();
33
-
34
- expect(() => resolve("gpt-4.1")).toThrow(
35
- 'Cannot resolve model "gpt-4.1": no provider prefix and no fallback configured',
36
- );
37
- });
38
-
39
- it("uses a mapped provider when prefix matches", () => {
40
- const openaiFactory = vi.fn(fakeFactory("openai"));
41
- const resolve = createModelResolver({
42
- providers: { openai: openaiFactory },
43
- });
44
-
45
- const result = resolve("openai/gpt-4.1");
46
-
47
- expect(openaiFactory).toHaveBeenCalledWith("gpt-4.1");
48
- expect(result).toEqual(fakeModel("openai/gpt-4.1"));
49
- });
50
-
51
- it("falls back to fallback for unmapped prefixes", () => {
52
- const fallback = vi.fn((id: string) => fakeModel(id));
53
- const resolve = createModelResolver({
54
- providers: { openai: fakeFactory("openai") },
55
- fallback,
56
- });
57
-
58
- resolve("anthropic/claude-sonnet-4-20250514");
59
-
60
- expect(fallback).toHaveBeenCalledWith("anthropic/claude-sonnet-4-20250514");
61
- });
62
-
63
- it("handles model IDs without a slash via fallback", () => {
64
- const fallback = vi.fn((id: string) => fakeModel(id));
65
- const resolve = createModelResolver({ fallback });
66
-
67
- resolve("gpt-4.1");
68
-
69
- expect(fallback).toHaveBeenCalledWith("gpt-4.1");
70
- });
71
-
72
- it("throws for unmapped prefixes when no fallback is configured", () => {
73
- const resolve = createModelResolver({
74
- providers: { openai: fakeFactory("openai") },
75
- });
76
-
77
- expect(() => resolve("anthropic/claude-sonnet-4-20250514")).toThrow(
78
- 'Cannot resolve model "anthropic/claude-sonnet-4-20250514": no provider mapped for "anthropic" and no fallback configured',
79
- );
80
- });
81
-
82
- it("supports multiple mapped providers", () => {
83
- const openaiFactory = vi.fn(fakeFactory("openai"));
84
- const anthropicFactory = vi.fn(fakeFactory("anthropic"));
85
-
86
- const resolve = createModelResolver({
87
- providers: {
88
- openai: openaiFactory,
89
- anthropic: anthropicFactory,
90
- },
91
- });
92
-
93
- resolve("openai/gpt-4.1");
94
- resolve("anthropic/claude-sonnet-4-20250514");
95
-
96
- expect(openaiFactory).toHaveBeenCalledWith("gpt-4.1");
97
- expect(anthropicFactory).toHaveBeenCalledWith("claude-sonnet-4-20250514");
98
- });
99
-
100
- it("handles model IDs with multiple slashes correctly", () => {
101
- const resolve = createModelResolver({
102
- providers: { "meta-llama": fakeFactory("meta-llama") },
103
- });
104
-
105
- resolve("meta-llama/llama-4-scout/extended");
106
-
107
- expect(resolve("meta-llama/llama-4-scout/extended")).toEqual(
108
- fakeModel("meta-llama/llama-4-scout/extended"),
109
- );
110
- });
111
-
112
- it("throws for empty model ID", () => {
113
- const resolve = createModelResolver();
114
-
115
- expect(() => resolve("")).toThrow("Cannot resolve model: model ID is empty");
116
- });
117
-
118
- it("throws for whitespace-only model ID", () => {
119
- const resolve = createModelResolver();
120
-
121
- expect(() => resolve(" ")).toThrow("Cannot resolve model: model ID is empty");
122
- });
123
-
124
- it("prefers mapped provider over fallback", () => {
125
- const openaiFactory = vi.fn(fakeFactory("openai"));
126
- const fallback = vi.fn((id: string) => fakeModel(id));
127
-
128
- const resolve = createModelResolver({
129
- providers: { openai: openaiFactory },
130
- fallback,
131
- });
132
-
133
- resolve("openai/gpt-4.1");
134
-
135
- expect(openaiFactory).toHaveBeenCalledWith("gpt-4.1");
136
- expect(fallback).not.toHaveBeenCalled();
137
- });
138
- });