@funkai/models 0.1.0

package/package.json

@@ -0,0 +1,142 @@
+{
+  "name": "@funkai/models",
+  "version": "0.1.0",
+  "private": false,
+  "description": "Model catalog, provider resolution, and cost calculations for the funkai AI SDK",
+  "keywords": [
+    "ai",
+    "ai-sdk",
+    "models",
+    "openrouter",
+    "pricing",
+    "providers",
+    "typescript"
+  ],
+  "homepage": "https://github.com/joggrdocs/funkai/tree/main/packages/models#readme",
+  "bugs": {
+    "url": "https://github.com/joggrdocs/funkai/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/joggrdocs/funkai.git",
+    "directory": "packages/models"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    },
+    "./openai": {
+      "types": "./dist/providers/openai.d.mts",
+      "import": "./dist/providers/openai.mjs"
+    },
+    "./anthropic": {
+      "types": "./dist/providers/anthropic.d.mts",
+      "import": "./dist/providers/anthropic.mjs"
+    },
+    "./google": {
+      "types": "./dist/providers/google.d.mts",
+      "import": "./dist/providers/google.mjs"
+    },
+    "./google-vertex": {
+      "types": "./dist/providers/google-vertex.d.mts",
+      "import": "./dist/providers/google-vertex.mjs"
+    },
+    "./mistral": {
+      "types": "./dist/providers/mistral.d.mts",
+      "import": "./dist/providers/mistral.mjs"
+    },
+    "./amazon-bedrock": {
+      "types": "./dist/providers/amazon-bedrock.d.mts",
+      "import": "./dist/providers/amazon-bedrock.mjs"
+    },
+    "./groq": {
+      "types": "./dist/providers/groq.d.mts",
+      "import": "./dist/providers/groq.mjs"
+    },
+    "./deepseek": {
+      "types": "./dist/providers/deepseek.d.mts",
+      "import": "./dist/providers/deepseek.mjs"
+    },
+    "./xai": {
+      "types": "./dist/providers/xai.d.mts",
+      "import": "./dist/providers/xai.mjs"
+    },
+    "./cohere": {
+      "types": "./dist/providers/cohere.d.mts",
+      "import": "./dist/providers/cohere.mjs"
+    },
+    "./fireworks-ai": {
+      "types": "./dist/providers/fireworks-ai.d.mts",
+      "import": "./dist/providers/fireworks-ai.mjs"
+    },
+    "./togetherai": {
+      "types": "./dist/providers/togetherai.d.mts",
+      "import": "./dist/providers/togetherai.mjs"
+    },
+    "./deepinfra": {
+      "types": "./dist/providers/deepinfra.d.mts",
+      "import": "./dist/providers/deepinfra.mjs"
+    },
+    "./cerebras": {
+      "types": "./dist/providers/cerebras.d.mts",
+      "import": "./dist/providers/cerebras.mjs"
+    },
+    "./perplexity": {
+      "types": "./dist/providers/perplexity.d.mts",
+      "import": "./dist/providers/perplexity.mjs"
+    },
+    "./openrouter": {
+      "types": "./dist/providers/openrouter.d.mts",
+      "import": "./dist/providers/openrouter.mjs"
+    },
+    "./llama": {
+      "types": "./dist/providers/llama.d.mts",
+      "import": "./dist/providers/llama.mjs"
+    },
+    "./alibaba": {
+      "types": "./dist/providers/alibaba.d.mts",
+      "import": "./dist/providers/alibaba.mjs"
+    },
+    "./nvidia": {
+      "types": "./dist/providers/nvidia.d.mts",
+      "import": "./dist/providers/nvidia.mjs"
+    },
+    "./huggingface": {
+      "types": "./dist/providers/huggingface.d.mts",
+      "import": "./dist/providers/huggingface.mjs"
+    },
+    "./inception": {
+      "types": "./dist/providers/inception.d.mts",
+      "import": "./dist/providers/inception.mjs"
+    }
+  },
+  "scripts": {
+    "generate:models": "lauf run @funkai/models/generate-models",
+    "build": "tsdown",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run --typecheck",
+    "test:coverage": "vitest run --coverage"
+  },
+  "dependencies": {
+    "@openrouter/ai-sdk-provider": "^2.3.1",
+    "ai": "^6.0.116",
+    "type-fest": "^5.4.4"
+  },
+  "devDependencies": {
+    "@types/node": "catalog:",
+    "@vitest/coverage-v8": "catalog:",
+    "tsdown": "catalog:",
+    "tsx": "catalog:",
+    "typescript": "catalog:",
+    "vitest": "catalog:"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=24.0.0"
+  }
+}

package/providers.json

@@ -0,0 +1,39 @@
+{
+  "openai": { "name": "OpenAI", "prefix": "OpenAI", "sdk": "@ai-sdk/openai" },
+  "anthropic": { "name": "Anthropic", "prefix": "Anthropic", "sdk": "@ai-sdk/anthropic" },
+  "google": { "name": "Google", "prefix": "Google", "sdk": "@ai-sdk/google" },
+  "google-vertex": {
+    "name": "Google Vertex AI",
+    "prefix": "GoogleVertex",
+    "sdk": "@ai-sdk/google-vertex"
+  },
+  "mistral": { "name": "Mistral", "prefix": "Mistral", "sdk": "@ai-sdk/mistral" },
+  "amazon-bedrock": {
+    "name": "Amazon Bedrock",
+    "prefix": "AmazonBedrock",
+    "sdk": "@ai-sdk/amazon-bedrock"
+  },
+  "groq": { "name": "Groq", "prefix": "Groq", "sdk": "@ai-sdk/groq" },
+  "deepseek": { "name": "DeepSeek", "prefix": "DeepSeek", "sdk": "@ai-sdk/deepseek" },
+  "xai": { "name": "xAI", "prefix": "XAI", "sdk": "@ai-sdk/xai" },
+  "cohere": { "name": "Cohere", "prefix": "Cohere", "sdk": "@ai-sdk/cohere" },
+  "fireworks-ai": { "name": "Fireworks AI", "prefix": "Fireworks", "sdk": "@ai-sdk/fireworks" },
+  "togetherai": { "name": "Together AI", "prefix": "Together", "sdk": "@ai-sdk/togetherai" },
+  "deepinfra": { "name": "DeepInfra", "prefix": "DeepInfra", "sdk": "@ai-sdk/deepinfra" },
+  "cerebras": { "name": "Cerebras", "prefix": "Cerebras", "sdk": "@ai-sdk/cerebras" },
+  "perplexity": { "name": "Perplexity", "prefix": "Perplexity", "sdk": "@ai-sdk/perplexity" },
+  "openrouter": {
+    "name": "OpenRouter",
+    "prefix": "OpenRouter",
+    "sdk": "@openrouter/ai-sdk-provider"
+  },
+  "llama": { "name": "Meta Llama", "prefix": "Llama", "sdk": "@ai-sdk/openai-compatible" },
+  "alibaba": { "name": "Alibaba (Qwen)", "prefix": "Alibaba", "sdk": "@ai-sdk/alibaba" },
+  "nvidia": { "name": "NVIDIA NIM", "prefix": "Nvidia", "sdk": "@ai-sdk/openai-compatible" },
+  "huggingface": { "name": "Hugging Face", "prefix": "HuggingFace", "sdk": "@ai-sdk/huggingface" },
+  "inception": {
+    "name": "Inception (Mercury)",
+    "prefix": "Inception",
+    "sdk": "@ai-sdk/openai-compatible"
+  }
+}

package/scripts/generate-models.ts

@@ -0,0 +1,392 @@
+import { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+
+import { lauf, z } from "laufen";
+
+const API_URL = "https://models.dev/api.json";
+const STALE_MS = 24 * 60 * 60 * 1000;
+
+// ---------------------------------------------------------------------------
+// Banner
+// ---------------------------------------------------------------------------
+
+const BANNER = `// ──────────────────────────────────────────────────────────────
+// ███████╗██╗   ██╗███╗   ██╗██╗  ██╗ █████╗ ██╗
+// ██╔════╝██║   ██║████╗  ██║██║ ██╔╝██╔══██╗██║
+// █████╗  ██║   ██║██╔██╗ ██║█████╔╝ ███████║██║
+// ██╔══╝  ██║   ██║██║╚██╗██║██╔═██╗ ██╔══██║██║
+// ██║     ╚██████╔╝██║ ╚████║██║  ██╗██║  ██║██║
+// ╚═╝      ╚═════╝ ╚═╝  ╚═══╝╚═╝  ╚═╝╚═╝  ╚═╝╚═╝
+//
+// AUTO-GENERATED — DO NOT EDIT
+// Source: https://models.dev
+// Update: pnpm --filter=@funkai/models generate:models
+// ──────────────────────────────────────────────────────────────`;
+
+// ---------------------------------------------------------------------------
+// Types
+// ---------------------------------------------------------------------------
+
+interface ProviderEntry {
+  name: string;
+  prefix: string;
+  sdk: string;
+}
+
+interface ApiModel {
+  id: string;
+  name?: string;
+  family?: string;
+  reasoning?: boolean;
+  tool_call?: boolean;
+  attachment?: boolean;
+  structured_output?: boolean;
+  modalities?: { input?: string[]; output?: string[] };
+  cost?: {
+    input?: number;
+    output?: number;
+    cache_read?: number;
+    cache_write?: number;
+    reasoning?: number;
+  };
+  limit?: { context?: number; output?: number };
+}
+
+interface ApiProvider {
+  id: string;
+  name: string;
+  models: Record<string, ApiModel>;
+}
+
+// ---------------------------------------------------------------------------
+// Helpers
+// ---------------------------------------------------------------------------
+
+/**
+ * Convert a provider key to a TypeScript constant name.
+ * e.g. "openai" → "OPENAI_MODELS", "meta-llama" → "META_LLAMA_MODELS"
+ */
+function toConstName(provider: string): string {
+  return `${provider.toUpperCase().replace(/[^A-Z0-9]/g, "_")}_MODELS`;
+}
+
+/**
+ * Lowercase the first character of a string, preserving the rest as-is.
+ * e.g. "OpenAI" → "openAI", "GoogleVertex" → "googleVertex", "XAI" → "xAI"
+ */
+function lowerFirst(s: string): string {
+  return s.length === 0 ? s : s[0]!.toLowerCase() + s.slice(1);
+}
+
+/**
+ * Return the correct indefinite article ("a" or "an") for a word.
+ */
+function article(word: string): string {
+  return /^[aeiou]/i.test(word) ? "an" : "a";
+}
+
+/**
+ * Convert per-million-token rate to per-token rate, rounding to
+ * eliminate floating-point noise (e.g. `8.000000000000001e-7`).
+ */
+function toPerToken(perMillion: number): number {
+  return parseFloat((perMillion / 1_000_000).toPrecision(6));
+}
+
+/**
+ * Format a number for codegen output, using scientific notation for
+ * very small values.
+ */
+function fmtNum(n: number): string {
+  if (n === 0) return "0";
+  if (n < 0.0000001) return n.toExponential();
+  return String(n);
+}
+
+/**
+ * Build the pricing object literal string for a model.
+ */
+function buildPricing(cost: ApiModel["cost"]): string {
+  const input = toPerToken(cost?.input ?? 0);
+  const output = toPerToken(cost?.output ?? 0);
+  const parts: string[] = [`input: ${fmtNum(input)}`, `output: ${fmtNum(output)}`];
+
+  if (cost?.cache_read != null && cost.cache_read > 0) {
+    parts.push(`cacheRead: ${fmtNum(toPerToken(cost.cache_read))}`);
+  }
+  if (cost?.cache_write != null && cost.cache_write > 0) {
+    parts.push(`cacheWrite: ${fmtNum(toPerToken(cost.cache_write))}`);
+  }
+  if (cost?.reasoning != null && cost.reasoning > 0) {
+    parts.push(`reasoning: ${fmtNum(toPerToken(cost.reasoning))}`);
+  }
+
+  return `{ ${parts.join(", ")} }`;
+}
+
+/**
+ * Build the modalities object literal string.
+ */
+function buildModalities(modalities: ApiModel["modalities"]): string {
+  const input = JSON.stringify(modalities?.input ?? ["text"]);
+  const output = JSON.stringify(modalities?.output ?? ["text"]);
+  return `{ input: ${input}, output: ${output} }`;
+}
+
+/**
+ * Build the capabilities object literal string.
+ */
+function buildCapabilities(m: ApiModel): string {
+  return [
+    `reasoning: ${Boolean(m.reasoning)}`,
+    `toolCall: ${Boolean(m.tool_call)}`,
+    `attachment: ${Boolean(m.attachment)}`,
+    `structuredOutput: ${Boolean(m.structured_output)}`,
+  ].join(", ");
+}
+
+/**
+ * Escape a string for use in a TypeScript single-quoted string literal.
+ */
+function escapeStr(s: string): string {
+  return s.replace(/\\/g, "\\\\").replace(/'/g, "\\'").replace(/\n/g, "\\n").replace(/\r/g, "\\r");
+}
+
+// ---------------------------------------------------------------------------
+// Staleness check
+// ---------------------------------------------------------------------------
+
+function isFresh(reqPath: string): boolean {
+  if (!existsSync(reqPath)) {
+    return false;
+  }
+  try {
+    const timestamp = readFileSync(reqPath, "utf-8").trim();
+    const lastRun = new Date(timestamp).getTime();
+    return Date.now() - lastRun < STALE_MS;
+  } catch {
+    return false;
+  }
+}
+
+// ---------------------------------------------------------------------------
+// Script
+// ---------------------------------------------------------------------------
+
+export default lauf({
+  description: "Fetch model data from models.dev and generate TypeScript catalog files",
+  args: {
+    force: z.boolean().default(false).describe("Force-fetch ignoring staleness cache"),
+  },
+  async run(ctx) {
+    const PACKAGE_ROOT = ctx.dir.package;
+    const PROVIDERS_PATH = join(PACKAGE_ROOT, "providers.json");
+    const CATALOG_DIR = join(PACKAGE_ROOT, "src", "catalog", "providers");
+    const ENTRY_DIR = join(PACKAGE_ROOT, "src", "providers");
+    const GENERATED_DIR = join(PACKAGE_ROOT, ".generated");
+    const REQ_PATH = join(GENERATED_DIR, "req.txt");
+    const ENTRIES_PATH = join(GENERATED_DIR, "entries.json");
+    const PACKAGE_JSON_PATH = join(PACKAGE_ROOT, "package.json");
+
+    if (!ctx.args.force && isFresh(REQ_PATH)) {
+      ctx.logger.info("skipping — last fetch was less than 24h ago");
+      return;
+    }
+
+    // Read provider config
+    const providers: Record<string, ProviderEntry> = JSON.parse(
+      readFileSync(PROVIDERS_PATH, "utf-8"),
+    );
+    const providerKeys = Object.keys(providers);
+
+    if (providerKeys.length === 0) {
+      throw new Error("providers.json has no providers");
+    }
+
+    // Fetch models.dev API
+    ctx.spinner.start("Fetching models from models.dev");
+    const response = await fetch(API_URL, { signal: AbortSignal.timeout(30_000) });
+    if (!response.ok) {
+      throw new Error(`Failed to fetch ${API_URL}: ${response.status} ${response.statusText}`);
+    }
+    const apiData: Record<string, ApiProvider> = await response.json();
+    ctx.spinner.stop(`${Object.keys(apiData).length} providers from API`);
+
+    // Fail fast if any configured provider is missing from the API
+    const missingProviders = providerKeys.filter((key) => !apiData[key]);
+    if (missingProviders.length > 0) {
+      throw new Error(
+        `models.dev API is missing configured providers: ${missingProviders.join(", ")}`,
+      );
+    }
+
+    mkdirSync(GENERATED_DIR, { recursive: true });
+
+    // Clean and recreate catalog providers dir
+    rmSync(CATALOG_DIR, { recursive: true, force: true });
+    mkdirSync(CATALOG_DIR, { recursive: true });
+
+    // Clean and recreate entry points dir
+    rmSync(ENTRY_DIR, { recursive: true, force: true });
+    mkdirSync(ENTRY_DIR, { recursive: true });
+
+    const providerFiles: { provider: string; constName: string; count: number }[] = [];
+
+    for (const providerKey of providerKeys) {
+      const apiProvider = apiData[providerKey]!;
+      const apiModels = apiProvider.models ?? {};
+      const constName = toConstName(providerKey);
+      const lines: string[] = [];
+
+      for (const [, m] of Object.entries(apiModels)) {
+        const id = escapeStr(m.id);
+        const name = escapeStr(m.name ?? m.id);
+        const family = escapeStr(m.family ?? "");
+        const pricing = buildPricing(m.cost);
+        const contextWindow = m.limit?.context ?? 0;
+        const maxOutput = m.limit?.output ?? 0;
+        const modalities = buildModalities(m.modalities);
+        const capabilities = buildCapabilities(m);
+
+        lines.push(
+          `  { id: '${id}', name: '${name}', provider: '${providerKey}', family: '${family}', ` +
+            `pricing: ${pricing}, contextWindow: ${contextWindow}, maxOutput: ${maxOutput}, ` +
+            `modalities: ${modalities}, capabilities: { ${capabilities} } },`,
+        );
+      }
+
+      // Write catalog provider file
+      const catalogContent = `${BANNER}
+
+import type { ModelDefinition } from '../types.js'
+
+export const ${constName} = [
+${lines.join("\n")}
+] as const satisfies readonly ModelDefinition[]
+`;
+
+      const catalogPath = join(CATALOG_DIR, `${providerKey}.ts`);
+      writeFileSync(catalogPath, catalogContent, "utf-8");
+
+      // Write per-provider entry point
+      const prefix = providers[providerKey]!.prefix;
+      const camel = lowerFirst(prefix);
+      const exampleId = escapeStr(Object.values(apiModels)[0]?.id ?? "example-id");
+      const providerName = escapeStr(providers[providerKey]!.name);
+      const art = article(providers[providerKey]!.name);
+      const entryContent = `${BANNER}
+
+import type { LiteralUnion } from 'type-fest'
+import type { ModelDefinition } from '../catalog/types.js'
+import { ${constName} } from '../catalog/providers/${providerKey}.js'
+
+/**
+ * Known model identifiers for ${providerName}.
+ *
+ * @example
+ * \`\`\`typescript
+ * import type { ${prefix}ModelId } from '@funkai/models/${providerKey}'
+ *
+ * const id: ${prefix}ModelId = '${exampleId}'
+ * \`\`\`
+ */
+export type ${prefix}ModelId = (typeof ${constName})[number]['id']
+
+/**
+ * All ${providerName} models in the catalog.
+ *
+ * @example
+ * \`\`\`typescript
+ * import { ${camel}Models } from '@funkai/models/${providerKey}'
+ *
+ * for (const m of ${camel}Models) {
+ *   console.log(m.id, m.pricing.input)
+ * }
+ * \`\`\`
+ */
+export const ${camel}Models = ${constName}
+
+const MODEL_INDEX = new Map<string, ModelDefinition>(${constName}.map((m) => [m.id, m]))
+
+/**
+ * Look up ${art} ${providerName} model by ID.
+ *
+ * @param id - The provider-native model identifier.
+ * @returns The matching model definition, or \`null\`.
+ *
+ * @example
+ * \`\`\`typescript
+ * import { ${camel}Model } from '@funkai/models/${providerKey}'
+ *
+ * const m = ${camel}Model('${exampleId}')
+ * if (m) {
+ *   console.log(m.pricing.input)
+ * }
+ * \`\`\`
+ */
+export function ${camel}Model(id: LiteralUnion<${prefix}ModelId, string>): ModelDefinition | null {
+  return MODEL_INDEX.get(id) ?? null
+}
+`;
+
+      const entryPath = join(ENTRY_DIR, `${providerKey}.ts`);
+      writeFileSync(entryPath, entryContent, "utf-8");
+
+      ctx.logger.success(`${providerKey} (${lines.length} models)`);
+      providerFiles.push({ provider: providerKey, constName, count: lines.length });
+    }
+
+    // Catalog barrel
+    const imports = providerFiles
+      .map((p) => `import { ${p.constName} } from './${p.provider}.js'`)
+      .join("\n");
+
+    const spreads = providerFiles.map((p) => `  ...${p.constName},`).join("\n");
+
+    const catalogBarrel = `${BANNER}
+
+import type { ModelDefinition } from '../types.js'
+${imports}
+
+export const MODELS = [
+${spreads}
+] as const satisfies readonly ModelDefinition[]
+`;
+
+    writeFileSync(join(CATALOG_DIR, "index.ts"), catalogBarrel, "utf-8");
+    ctx.logger.success("catalog/providers/index.ts (barrel)");
+
+    // Write generated entries list for tsdown config
+    const entryPoints = providerFiles.map((p) => `src/providers/${p.provider}.ts`);
+    writeFileSync(ENTRIES_PATH, JSON.stringify(entryPoints, null, 2), "utf-8");
+    ctx.logger.success(".generated/entries.json");
+
+    // Update package.json exports map
+    const pkgRaw = readFileSync(PACKAGE_JSON_PATH, "utf-8");
+    const pkg = JSON.parse(pkgRaw);
+
+    const exportsMap: Record<string, { types: string; import: string }> = {
+      ".": {
+        types: "./dist/index.d.mts",
+        import: "./dist/index.mjs",
+      },
+    };
+
+    for (const p of providerFiles) {
+      exportsMap[`./${p.provider}`] = {
+        types: `./dist/providers/${p.provider}.d.mts`,
+        import: `./dist/providers/${p.provider}.mjs`,
+      };
+    }
+
+    pkg.exports = exportsMap;
+    writeFileSync(PACKAGE_JSON_PATH, JSON.stringify(pkg, null, 2) + "\n", "utf-8");
+    ctx.logger.success("package.json exports map updated");
+
+    // Staleness timestamp
+    writeFileSync(REQ_PATH, new Date().toISOString(), "utf-8");
+
+    const totalModels = providerFiles.reduce((sum, p) => sum + p.count, 0);
+    ctx.logger.info(`done (${providerFiles.length} providers, ${totalModels} models)`);
+  },
+});