offrouter-core 0.2.1 → 0.2.2

package/src/providers/catalog-data.ts

@@ -1,498 +0,0 @@
-/**
- * Static built-in provider + model family metadata for offline routing.
- *
- * Metadata only: no network calls, no credential reads, no secrets. API-key
- * presence is checked elsewhere by the adapter (checkAuth). Pricing hints are
- * approximate public values in USD per 1M tokens; re-verify against vendor
- * pricing before any billing-sensitive use. Unknown fields are left undefined;
- * nothing here is invented.
- *
- * Subscription-first invariant: this catalog never auto-promotes an api-key
- * candidate over a subscription candidate for the same logical family. The
- * supportsSubscriptionRouting flag only documents which families expose an
- * official subscription surface (official login, token helper, OAuth, or MCP
- * login); subscription routing itself is handled by the harness adapters, not
- * by these OpenAI-compatible provider entries.
- */
-
-import { z } from "zod";
-import type { AuthScope, AuthTier } from "../types.js";
-import type { LogicalModelFamily } from "./catalog.js";
-import type { OpenAiCompatibleFlavor } from "./openai-compatible.js";
-
-/** Public pricing hint in USD per 1M tokens. Undefined when undocumented. */
-export interface PricingHint {
-  /** USD per 1M input tokens, when publicly documented. */
-  inputPer1M?: number;
-  /** USD per 1M output tokens, when publicly documented. */
-  outputPer1M?: number;
-}
-
-/**
- * Known model family metadata. Optional fields are unknown, never invented.
- * Local runtime models omit token/capability fields because they are
- * discovered from the running server.
- */
-export interface BuiltinModelFamily {
-  modelId: string;
-  displayName?: string;
-  /** Logical family used to group candidates across auth tiers. */
-  family: LogicalModelFamily;
-  contextWindowTokens?: number;
-  maxOutputTokens?: number;
-  supportsTools?: boolean;
-  supportsStreaming?: boolean;
-  supportsJson?: boolean;
-  supportsImages?: boolean;
-  /** Public pricing hint; undefined when undocumented. */
-  pricing?: PricingHint;
-}
-
-/**
- * Static provider entry describing how to build its OpenAI-compatible adapter
- * and which model families it exposes. No secrets.
- */
-export interface BuiltinProviderEntry {
-  providerId: string;
-  displayName: string;
-  /** Default base URL for the OpenAI-compatible adapter. */
-  defaultBaseUrl: string;
-  /** Adapter flavor used to construct the OpenAI-compatible client. */
-  flavor: OpenAiCompatibleFlavor;
-  /** Default auth tier for candidates built from this provider. */
-  defaultAuthTier: AuthTier;
-  /** Default auth scope for candidates built from this provider. */
-  defaultAuthScope: AuthScope;
-  /**
-   * True only when an official subscription surface exists (official login,
-   * token helper, OAuth, or MCP login). Informational only; never promotes a
-   * tier. False for pure api-key and local providers.
-   */
-  supportsSubscriptionRouting: boolean;
-  /** ASCII-only note on the official subscription surface, if any. */
-  subscriptionSurfaceNote?: string;
-  knownModels: readonly BuiltinModelFamily[];
-}
-
-/**
- * Per-provider catalog config mirroring the existing config providers map.
- * Users enable/disable providers and override base URLs in TOML; this is not a
- * new config file format.
- */
-export interface ProviderCatalogConfig {
-  /** Whether the provider is enabled. Defaults to true. */
-  enabled?: boolean;
-  /** Override the built-in default base URL. */
-  baseUrl?: string;
-}
-
-/** Map of providerId to provider catalog config (mirrors config providers map). */
-export type BuiltinCatalogConfig = Record<string, ProviderCatalogConfig>;
-
-// ---------------------------------------------------------------------------
-// Runtime validation (Zod). Mirrors the config.ts pattern: a shape object plus
-// a strict object schema so unknown keys are rejected. The TS interfaces above
-// remain the source of truth for the catalog-data public types.
-// ---------------------------------------------------------------------------
-
-const ProviderCatalogConfigShape = {
-  enabled: z.boolean().optional(),
-  baseUrl: z.string().optional(),
-} satisfies z.ZodRawShape;
-
-export const ProviderCatalogConfigSchema = z
-  .object(ProviderCatalogConfigShape)
-  .strict();
-
-/** Record of providerId -> ProviderCatalogConfig. */
-export const BuiltinCatalogConfigSchema = z.record(
-  z.string().min(1),
-  ProviderCatalogConfigSchema,
-);
-
-/**
- * Parse and validate a BuiltinCatalogConfig, throwing on invalid input.
- * Lets callers validate provider catalog overrides at runtime.
- */
-export function parseBuiltinCatalogConfig(
-  input: unknown,
-): BuiltinCatalogConfig {
-  return BuiltinCatalogConfigSchema.parse(input);
-}
-
-// TODO(catalog-config): wire base_url + enable/disable overrides declared in
-// config.toml `[providers]` through BuiltinCatalogConfigSchema. config.ts only
-// validates `enabled` today; integrating `baseUrl` there would change the
-// config contract, so it is tracked as a follow-up (code-review finding 4).
-
-/**
- * Shared note for local runtime providers: model list and capabilities are
- * discovered from the running server, not from this static metadata.
- */
-const LOCAL_RUNTIME_SUBSCRIPTION_NOTE =
-  "Local runtime; model list and capabilities are discovered from the running server.";
-
-/**
- * Built-in providers. Subscription-backed first-party login happens through the
- * harness adapters (claude/codex/gemini/grok), not these api endpoints, so each
- * api/local entry reports supportsSubscriptionRouting=false with a note.
- */
-export const BUILTIN_PROVIDERS: readonly BuiltinProviderEntry[] = [
-  {
-    providerId: "openai",
-    displayName: "OpenAI API",
-    defaultBaseUrl: "https://api.openai.com/v1",
-    flavor: "openai",
-    defaultAuthTier: "api-key",
-    defaultAuthScope: "first-party",
-    supportsSubscriptionRouting: false,
-    subscriptionSurfaceNote:
-      "Subscription routing for first-party OpenAI models is handled by the codex harness adapter, not this api endpoint.",
-    knownModels: [
-      {
-        modelId: "gpt-4.1",
-        displayName: "GPT-4.1",
-        family: "frontier-coder",
-        contextWindowTokens: 1_047_576,
-        maxOutputTokens: 32_768,
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: true,
-        pricing: { inputPer1M: 2.0, outputPer1M: 8.0 },
-      },
-      {
-        modelId: "gpt-4.1-mini",
-        displayName: "GPT-4.1 mini",
-        family: "fast-coder",
-        contextWindowTokens: 1_047_576,
-        maxOutputTokens: 32_768,
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: true,
-        pricing: { inputPer1M: 0.4, outputPer1M: 1.6 },
-      },
-      {
-        modelId: "o3",
-        displayName: "o3",
-        family: "frontier-coder",
-        contextWindowTokens: 200_000,
-        maxOutputTokens: 100_000,
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: true,
-        pricing: { inputPer1M: 2.0, outputPer1M: 8.0 },
-      },
-    ],
-  },
-  {
-    providerId: "anthropic",
-    displayName: "Anthropic API (OpenAI-compatible)",
-    defaultBaseUrl: "https://api.anthropic.com/v1/openai",
-    flavor: "openai",
-    defaultAuthTier: "api-key",
-    defaultAuthScope: "first-party",
-    supportsSubscriptionRouting: false,
-    subscriptionSurfaceNote:
-      "Subscription routing for first-party Anthropic models is handled by the claude harness adapter, not this api endpoint.",
-    knownModels: [
-      {
-        modelId: "claude-sonnet-4",
-        displayName: "Claude Sonnet 4",
-        family: "frontier-coder",
-        contextWindowTokens: 200_000,
-        maxOutputTokens: 32_000,
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: true,
-        pricing: { inputPer1M: 3.0, outputPer1M: 15.0 },
-      },
-      {
-        modelId: "claude-opus-4",
-        displayName: "Claude Opus 4",
-        family: "frontier-coder",
-        contextWindowTokens: 200_000,
-        maxOutputTokens: 32_000,
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: true,
-        pricing: { inputPer1M: 15.0, outputPer1M: 75.0 },
-      },
-      {
-        modelId: "claude-haiku-4",
-        displayName: "Claude Haiku 4",
-        family: "fast-coder",
-        contextWindowTokens: 200_000,
-        maxOutputTokens: 16_000,
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: true,
-      },
-    ],
-  },
-  {
-    providerId: "google",
-    displayName: "Google Gemini API (OpenAI-compatible)",
-    defaultBaseUrl: "https://generativelanguage.googleapis.com/v1beta/openai",
-    flavor: "openai",
-    defaultAuthTier: "api-key",
-    defaultAuthScope: "first-party",
-    supportsSubscriptionRouting: false,
-    subscriptionSurfaceNote:
-      "Subscription routing for first-party Google models is handled by the gemini harness adapter, not this api endpoint.",
-    knownModels: [
-      {
-        modelId: "gemini-2.5-pro",
-        displayName: "Gemini 2.5 Pro",
-        family: "frontier-coder",
-        contextWindowTokens: 1_048_576,
-        maxOutputTokens: 65_536,
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: true,
-        pricing: { inputPer1M: 1.25, outputPer1M: 10.0 },
-      },
-      {
-        modelId: "gemini-2.5-flash",
-        displayName: "Gemini 2.5 Flash",
-        family: "fast-coder",
-        contextWindowTokens: 1_048_576,
-        maxOutputTokens: 65_536,
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: true,
-        pricing: { inputPer1M: 0.3, outputPer1M: 2.5 },
-      },
-    ],
-  },
-  {
-    providerId: "xai",
-    displayName: "xAI Grok API",
-    defaultBaseUrl: "https://api.x.ai/v1",
-    flavor: "xai",
-    defaultAuthTier: "api-key",
-    defaultAuthScope: "first-party",
-    supportsSubscriptionRouting: false,
-    subscriptionSurfaceNote:
-      "Subscription routing for first-party xAI models is handled by the grok harness adapter, not this api endpoint.",
-    knownModels: [
-      {
-        modelId: "grok-4",
-        displayName: "Grok 4",
-        family: "frontier-coder",
-        contextWindowTokens: 256_000,
-        maxOutputTokens: 32_768,
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: true,
-        pricing: { inputPer1M: 3.0, outputPer1M: 15.0 },
-      },
-      {
-        modelId: "grok-code-fast-1",
-        displayName: "Grok Code Fast",
-        family: "fast-coder",
-        contextWindowTokens: 256_000,
-        maxOutputTokens: 16_384,
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: false,
-      },
-    ],
-  },
-  {
-    providerId: "openrouter",
-    displayName: "OpenRouter",
-    defaultBaseUrl: "https://openrouter.ai/api/v1",
-    flavor: "openrouter",
-    defaultAuthTier: "api-key",
-    defaultAuthScope: "third-party",
-    supportsSubscriptionRouting: false,
-    knownModels: [
-      {
-        modelId: "anthropic/claude-sonnet-4",
-        family: "frontier-coder",
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: true,
-      },
-      {
-        modelId: "google/gemini-2.5-flash",
-        family: "fast-coder",
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: true,
-      },
-    ],
-  },
-  {
-    providerId: "zai",
-    displayName: "Z.ai GLM API",
-    defaultBaseUrl: "https://open.bigmodel.cn/api/paas/v4",
-    flavor: "openai",
-    defaultAuthTier: "api-key",
-    defaultAuthScope: "first-party",
-    supportsSubscriptionRouting: false,
-    knownModels: [
-      {
-        modelId: "glm-4.6",
-        displayName: "GLM-4.6",
-        family: "fast-coder",
-        contextWindowTokens: 200_000,
-        maxOutputTokens: 16_000,
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: false,
-      },
-      {
-        modelId: "glm-4.5",
-        displayName: "GLM-4.5",
-        family: "fast-coder",
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: false,
-      },
-    ],
-  },
-  {
-    providerId: "moonshot",
-    displayName: "Moonshot Kimi API",
-    defaultBaseUrl: "https://api.moonshot.cn/v1",
-    flavor: "openai",
-    defaultAuthTier: "api-key",
-    defaultAuthScope: "first-party",
-    supportsSubscriptionRouting: false,
-    knownModels: [
-      {
-        modelId: "kimi-k2",
-        displayName: "Kimi K2",
-        family: "fast-coder",
-        contextWindowTokens: 200_000,
-        maxOutputTokens: 8_192,
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: false,
-      },
-    ],
-  },
-  {
-    providerId: "ollama",
-    displayName: "Ollama (local)",
-    defaultBaseUrl: "http://localhost:11434/v1",
-    flavor: "ollama",
-    defaultAuthTier: "local",
-    defaultAuthScope: "first-party",
-    supportsSubscriptionRouting: false,
-    subscriptionSurfaceNote: LOCAL_RUNTIME_SUBSCRIPTION_NOTE,
-    knownModels: [
-      {
-        modelId: "qwen2.5-coder:32b",
-        family: "local-coder",
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: false,
-      },
-      {
-        modelId: "llava:latest",
-        family: "vision-helper",
-        supportsTools: false,
-        supportsStreaming: true,
-        supportsJson: false,
-        supportsImages: true,
-      },
-    ],
-  },
-  {
-    providerId: "lm-studio",
-    displayName: "LM Studio (local)",
-    defaultBaseUrl: "http://localhost:1234/v1",
-    flavor: "openai",
-    defaultAuthTier: "local",
-    defaultAuthScope: "first-party",
-    supportsSubscriptionRouting: false,
-    subscriptionSurfaceNote: LOCAL_RUNTIME_SUBSCRIPTION_NOTE,
-    knownModels: [
-      {
-        modelId: "local-coder",
-        family: "local-coder",
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: false,
-      },
-    ],
-  },
-  {
-    providerId: "custom",
-    displayName: "Custom OpenAI-compatible endpoint",
-    defaultBaseUrl: "",
-    flavor: "openai",
-    defaultAuthTier: "local",
-    defaultAuthScope: "unknown",
-    supportsSubscriptionRouting: false,
-    subscriptionSurfaceNote:
-      "User-defined OpenAI-compatible gateway. base URL and model ids must be supplied via provider config.",
-    knownModels: [
-      {
-        modelId: "custom-model",
-        family: "local-coder",
-        supportsTools: true,
-        supportsStreaming: true,
-        supportsJson: true,
-        supportsImages: false,
-      },
-    ],
-  },
-];
-
-/** Provider ids covered by the built-in catalog. */
-export const BUILTIN_PROVIDER_IDS: readonly string[] = BUILTIN_PROVIDERS.map(
-  (provider) => provider.providerId,
-);
-
-/** Look up a built-in provider by id. */
-export function getBuiltinProvider(
-  providerId: string,
-): BuiltinProviderEntry | undefined {
-  return BUILTIN_PROVIDERS.find((p) => p.providerId === providerId);
-}
-
-/**
- * Resolve built-in providers applying enable/disable and base URL overrides.
- * Returns copies so callers cannot mutate the static source. Disabled providers
- * are excluded. This never adds or removes a subscription tier; it only filters
- * api-key/local provider metadata, preserving the subscription-first invariant.
- */
-export function selectBuiltinProviders(
-  config: BuiltinCatalogConfig = {},
-): BuiltinProviderEntry[] {
-  return BUILTIN_PROVIDERS.filter((provider) => {
-    const override = config[provider.providerId];
-    return override?.enabled ?? true;
-  }).map((provider) => {
-    const override = config[provider.providerId];
-    const overrideUrl = override?.baseUrl?.trim();
-    return {
-      ...provider,
-      defaultBaseUrl:
-        overrideUrl && overrideUrl.length > 0
-          ? overrideUrl
-          : provider.defaultBaseUrl,
-      knownModels: provider.knownModels.map((model) => ({ ...model })),
-    };
-  });
-}

package/src/providers/catalog.test.ts

@@ -1,84 +0,0 @@
-import { describe, expect, it } from "vitest";
-import type { AuthTier } from "../types.js";
-import {
-  MULTI_TIER_FAMILIES,
-  STATIC_CATALOG,
-  catalogToCandidates,
-  familyAuthTiers,
-  loadStaticCatalog,
-  type LogicalModelFamily,
-} from "./catalog.js";
-
-describe("static provider catalog", () => {
-  it("loads a non-empty static catalog offline", () => {
-    const entries = loadStaticCatalog();
-    expect(entries.length).toBeGreaterThan(0);
-    expect(entries).toEqual(
-      expect.arrayContaining(STATIC_CATALOG.map((e) => ({ ...e }))),
-    );
-  });
-
-  it("returns copies so callers cannot mutate the static source", () => {
-    const [first] = loadStaticCatalog();
-    first.modelId = "mutated";
-    expect(STATIC_CATALOG[0]?.modelId).not.toBe("mutated");
-  });
-
-  it("exposes subscription, local, and api-key candidates for key families", () => {
-    const required: AuthTier[] = ["subscription", "local", "api-key"];
-    for (const family of MULTI_TIER_FAMILIES) {
-      const tiers = familyAuthTiers(family);
-      for (const tier of required) {
-        expect(tiers.has(tier), `${family} missing tier ${tier}`).toBe(true);
-      }
-    }
-  });
-
-  it("catalog candidates carry auth scope and subscription status for sub tiers", () => {
-    const candidates = catalogToCandidates();
-    expect(candidates.every((c) => c.authScope)).toBe(true);
-
-    const subs = candidates.filter((c) => c.authTier === "subscription");
-    expect(subs.length).toBeGreaterThan(0);
-    for (const s of subs) {
-      expect(s.subscriptionStatus).toBeDefined();
-      expect(["first-party", "third-party", "unknown"]).toContain(s.authScope);
-    }
-  });
-
-  it("filters by family and auth tier", () => {
-    const family: LogicalModelFamily = "frontier-coder";
-    const onlySub = loadStaticCatalog({
-      families: [family],
-      authTiers: ["subscription"],
-    });
-    expect(onlySub.length).toBeGreaterThan(0);
-    expect(
-      onlySub.every(
-        (e) => e.family === family && e.authTier === "subscription",
-      ),
-    ).toBe(true);
-  });
-
-  it("can exclude unhealthy entries", () => {
-    const healthy = loadStaticCatalog({ includeUnhealthy: false });
-    expect(healthy.every((e) => e.health === "healthy")).toBe(true);
-    expect(STATIC_CATALOG.some((e) => e.health !== "healthy")).toBe(true);
-  });
-
-  it("maps catalog entries into ProviderCandidate rows usable by routing", () => {
-    const candidates = catalogToCandidates(
-      loadStaticCatalog({ families: ["fast-coder"], includeUnhealthy: false }),
-    );
-    expect(candidates.length).toBeGreaterThanOrEqual(3);
-    const tiers = new Set(candidates.map((c) => c.authTier));
-    expect(tiers.has("subscription")).toBe(true);
-    expect(tiers.has("local")).toBe(true);
-    expect(tiers.has("api-key")).toBe(true);
-    for (const c of candidates) {
-      expect(c.providerId).toBeTruthy();
-      expect(c.modelId).toBeTruthy();
-      expect(typeof c.supportsTools).toBe("boolean");
-    }
-  });
-});