@funkai/models 0.3.0 → 0.3.2

package/scripts/generate-models.ts

@@ -53,29 +53,47 @@ interface ApiProvider {
 /**
  * Convert a provider key to a TypeScript constant name.
  * e.g. "openai" → "OPENAI_MODELS", "meta-llama" → "META_LLAMA_MODELS"
+ *
+ * @private
  */
 function toConstName(provider: string): string {
-  return `${provider.toUpperCase().replace(/[^A-Z0-9]/g, "_")}_MODELS`;
+  return `${provider.toUpperCase().replaceAll(/[^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"
+ *
+ * @private
  */
 function lowerFirst(s: string): string {
-  return s.length === 0 ? s : s[0]!.toLowerCase() + s.slice(1);
+  if (s.length === 0) {
+    return s;
+  }
+  const [first] = s;
+  if (first === undefined) {
+    return s;
+  }
+  return first.toLowerCase() + s.slice(1);
 }
 
 /**
  * Return the correct indefinite article ("a" or "an") for a word.
+ *
+ * @private
  */
 function article(word: string): string {
-  return /^[aeiou]/i.test(word) ? "an" : "a";
+  if (/^[aeiou]/i.test(word)) {
+    return "an";
+  }
+  return "a";
 }
 
 /**
  * Convert per-million-token rate to per-token rate, rounding to
  * eliminate floating-point noise (e.g. `8.000000000000001e-7`).
+ *
+ * @private
  */
 function toPerToken(perMillion: number): number {
   return parseFloat((perMillion / 1_000_000).toPrecision(6));
@@ -84,29 +102,56 @@ function toPerToken(perMillion: number): number {
 /**
  * Format a number for codegen output, using scientific notation for
  * very small values.
+ *
+ * @private
  */
 function fmtNum(n: number): string {
-  if (n === 0) return "0";
-  if (n < 0.0000001) return n.toExponential();
+  if (n === 0) {
+    return "0";
+  }
+  if (n < 0.000_000_1) {
+    return n.toExponential();
+  }
   return String(n);
 }
 
+/** @private */
+function extractExampleId(model: ApiModel | undefined): string {
+  if (model !== undefined && model !== null) {
+    return model.id;
+  }
+  return "example-id";
+}
+
 /**
  * Build the pricing object literal string for a model.
+ *
+ * @private
  */
+function extractCostField(cost: ApiModel["cost"], field: "input" | "output"): number {
+  if (cost !== undefined && cost !== null) {
+    return cost[field] ?? 0;
+  }
+  return 0;
+}
+
 function buildPricing(cost: ApiModel["cost"]): string {
-  const input = toPerToken(cost?.input ?? 0);
-  const output = toPerToken(cost?.output ?? 0);
+  const costInput = extractCostField(cost, "input");
+  const costOutput = extractCostField(cost, "output");
+  const input = toPerToken(costInput);
+  const output = toPerToken(costOutput);
   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))}`);
+  if (cost !== undefined && cost !== null) {
+    if (cost.cache_read !== undefined && cost.cache_read !== null && cost.cache_read > 0) {
+      parts.push(`cacheRead: ${fmtNum(toPerToken(cost.cache_read))}`);
+    }
+    if (cost.cache_write !== undefined && cost.cache_write !== null && cost.cache_write > 0) {
+      parts.push(`cacheWrite: ${fmtNum(toPerToken(cost.cache_write))}`);
+    }
+    if (cost.reasoning !== undefined && cost.reasoning !== null && cost.reasoning > 0) {
+      parts.push(`reasoning: ${fmtNum(toPerToken(cost.reasoning))}`);
+    }
   }
 
   return `{ ${parts.join(", ")} }`;
@@ -114,15 +159,31 @@ function buildPricing(cost: ApiModel["cost"]): string {
 
 /**
  * Build the modalities object literal string.
+ *
+ * @private
  */
+function extractModalityField(
+  modalities: ApiModel["modalities"],
+  field: "input" | "output",
+): string[] {
+  if (modalities !== undefined && modalities !== null) {
+    return modalities[field] ?? ["text"];
+  }
+  return ["text"];
+}
+
 function buildModalities(modalities: ApiModel["modalities"]): string {
-  const input = JSON.stringify(modalities?.input ?? ["text"]);
-  const output = JSON.stringify(modalities?.output ?? ["text"]);
+  const modalInput = extractModalityField(modalities, "input");
+  const modalOutput = extractModalityField(modalities, "output");
+  const input = JSON.stringify(modalInput);
+  const output = JSON.stringify(modalOutput);
   return `{ input: ${input}, output: ${output} }`;
 }
 
 /**
  * Build the capabilities object literal string.
+ *
+ * @private
  */
 function buildCapabilities(m: ApiModel): string {
   return [
@@ -133,19 +194,44 @@ function buildCapabilities(m: ApiModel): string {
   ].join(", ");
 }
 
+/**
+ * Extract context window and max output from a model's limit field.
+ *
+ * @private
+ */
+function getModelLimits(limit: ApiModel["limit"]): { contextWindow: number; maxOutput: number } {
+  if (limit === undefined || limit === null) {
+    return { contextWindow: 0, maxOutput: 0 };
+  }
+  const contextWindow = limit.context ?? 0;
+  const maxOutput = limit.output ?? 0;
+  return { contextWindow, maxOutput };
+}
+
 /**
  * Escape a string for use in a TypeScript single-quoted string literal.
+ *
+ * @private
  */
 function escapeStr(s: string): string {
-  return s.replace(/\\/g, "\\\\").replace(/'/g, "\\'").replace(/\n/g, "\\n").replace(/\r/g, "\\r");
+  return s
+    .replaceAll("\\", String.raw`\\`)
+    .replaceAll("'", String.raw`\'`)
+    .replaceAll("\n", String.raw`\n`)
+    .replaceAll("\r", String.raw`\r`);
 }
 
+/**
+ * Check whether the staleness cache file indicates a recent fetch.
+ *
+ * @private
+ */
 function isFresh(reqPath: string): boolean {
   if (!existsSync(reqPath)) {
     return false;
   }
   try {
-    const timestamp = readFileSync(reqPath, "utf-8").trim();
+    const timestamp = readFileSync(reqPath, "utf8").trim();
     const lastRun = new Date(timestamp).getTime();
     return Date.now() - lastRun < STALE_MS;
   } catch {
@@ -175,7 +261,7 @@ export default lauf({
 
     // Read provider config
     const providers: Record<string, ProviderEntry> = JSON.parse(
-      readFileSync(PROVIDERS_PATH, "utf-8"),
+      readFileSync(PROVIDERS_PATH, "utf8"),
     );
     const providerKeys = Object.keys(providers);
 
@@ -210,30 +296,30 @@ export default lauf({
     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 providerFiles = providerKeys.flatMap((providerKey) => {
+      const apiProviderEntry = apiData[providerKey];
+      const providerEntry = providers[providerKey];
+      if (apiProviderEntry === undefined || providerEntry === undefined) {
+        return [];
+      }
+      if (apiProviderEntry.models === undefined || apiProviderEntry.models === null) {
+        throw new Error(
+          `models.dev API returned no models for configured provider: ${providerKey}`,
+        );
+      }
+      const apiModels = apiProviderEntry.models;
       const constName = toConstName(providerKey);
-      const lines: string[] = [];
-
-      for (const [, m] of Object.entries(apiModels)) {
+      const lines = Object.values(apiModels).map((m) => {
         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 { contextWindow, maxOutput } = getModelLimits(m.limit);
         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} } },`,
-        );
-      }
+        return `  { 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}
@@ -246,14 +332,15 @@ ${lines.join("\n")}
 `;
 
       const catalogPath = join(CATALOG_DIR, `${providerKey}.ts`);
-      writeFileSync(catalogPath, catalogContent, "utf-8");
+      writeFileSync(catalogPath, catalogContent, "utf8");
 
       // Write per-provider entry point
-      const prefix = providers[providerKey]!.prefix;
+      const { prefix } = providerEntry;
       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 [firstModel] = Object.values(apiModels);
+      const exampleId = escapeStr(extractExampleId(firstModel));
+      const providerName = escapeStr(providerEntry.name);
+      const art = article(providerEntry.name);
       const entryContent = `${BANNER}
 
 import type { LiteralUnion } from 'type-fest'
@@ -286,6 +373,7 @@ export type ${prefix}ModelId = (typeof ${constName})[number]['id']
  */
 export const ${camel}Models = ${constName}
 
+/** @private */
 const MODEL_INDEX = new Map<string, ModelDefinition>(${constName}.map((m) => [m.id, m]))
 
 /**
@@ -310,11 +398,11 @@ export function ${camel}Model(id: LiteralUnion<${prefix}ModelId, string>): Model
 `;
 
       const entryPath = join(ENTRY_DIR, `${providerKey}.ts`);
-      writeFileSync(entryPath, entryContent, "utf-8");
+      writeFileSync(entryPath, entryContent, "utf8");
 
       ctx.logger.success(`${providerKey} (${lines.length} models)`);
-      providerFiles.push({ provider: providerKey, constName, count: lines.length });
-    }
+      return [{ provider: providerKey, constName, count: lines.length }];
+    });
 
     // Catalog barrel
     const imports = providerFiles
@@ -325,6 +413,7 @@ export function ${camel}Model(id: LiteralUnion<${prefix}ModelId, string>): Model
 
     const catalogBarrel = `${BANNER}
 
+// oxlint-disable eslint-plugin-import/max-dependencies
 import type { ModelDefinition } from '../types.js'
 ${imports}
 
@@ -333,16 +422,16 @@ ${spreads}
 ] as const satisfies readonly ModelDefinition[]
 `;
 
-    writeFileSync(join(CATALOG_DIR, "index.ts"), catalogBarrel, "utf-8");
+    writeFileSync(join(CATALOG_DIR, "index.ts"), catalogBarrel, "utf8");
     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");
+    writeFileSync(ENTRIES_PATH, JSON.stringify(entryPoints, null, 2), "utf8");
     ctx.logger.success(".generated/entries.json");
 
     // Update package.json exports map
-    const pkgRaw = readFileSync(PACKAGE_JSON_PATH, "utf-8");
+    const pkgRaw = readFileSync(PACKAGE_JSON_PATH, "utf8");
     const pkg = JSON.parse(pkgRaw);
 
     const exportsMap: Record<string, { types: string; import: string }> = {
@@ -350,21 +439,23 @@ ${spreads}
         types: "./dist/index.d.mts",
         import: "./dist/index.mjs",
       },
+      ...Object.fromEntries(
+        providerFiles.map((p) => [
+          `./${p.provider}`,
+          {
+            types: `./dist/providers/${p.provider}.d.mts`,
+            import: `./dist/providers/${p.provider}.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");
+    writeFileSync(PACKAGE_JSON_PATH, `${JSON.stringify(pkg, null, 2)}\n`, "utf8");
     ctx.logger.success("package.json exports map updated");
 
     // Staleness timestamp
-    writeFileSync(REQ_PATH, new Date().toISOString(), "utf-8");
+    writeFileSync(REQ_PATH, new Date().toISOString(), "utf8");
 
     const totalModels = providerFiles.reduce((sum, p) => sum + p.count, 0);
     ctx.logger.info(`done (${providerFiles.length} providers, ${totalModels} models)`);

package/src/catalog/index.test.ts

@@ -2,7 +2,7 @@ import { describe, expect, it } from "vitest";
 
 import { model, models, MODELS } from "@/catalog/index.js";
 
-describe("MODELS", () => {
+describe("MODELS catalog", () => {
   it("is a non-empty array", () => {
     expect(MODELS.length).toBeGreaterThan(0);
   });
@@ -14,8 +14,8 @@ describe("MODELS", () => {
       expect(typeof m.provider).toBe("string");
       expect(typeof m.pricing.input).toBe("number");
       expect(typeof m.pricing.output).toBe("number");
-      expect(Array.isArray(m.modalities.input)).toBe(true);
-      expect(Array.isArray(m.modalities.output)).toBe(true);
+      expect(Array.isArray(m.modalities.input)).toBeTruthy();
+      expect(Array.isArray(m.modalities.output)).toBeTruthy();
       expect(typeof m.capabilities.reasoning).toBe("boolean");
     }
   });
@@ -30,7 +30,7 @@ describe("MODELS", () => {
     const seen = new Map<string, Set<string>>();
     for (const m of MODELS) {
       const providerSet = seen.get(m.provider) ?? new Set<string>();
-      expect(providerSet.has(m.id)).toBe(false);
+      expect(providerSet.has(m.id)).toBeFalsy();
       providerSet.add(m.id);
       seen.set(m.provider, providerSet);
     }
@@ -58,7 +58,7 @@ describe("model()", () => {
     const result = model("o1");
 
     expect(result).not.toBeNull();
-    expect(result!.capabilities.reasoning).toBe(true);
+    expect(result!.capabilities.reasoning).toBeTruthy();
   });
 
   it("returns model with correct modalities", () => {
@@ -82,7 +82,7 @@ describe("models()", () => {
 
     expect(reasoningModels.length).toBeGreaterThan(0);
     for (const m of reasoningModels) {
-      expect(m.capabilities.reasoning).toBe(true);
+      expect(m.capabilities.reasoning).toBeTruthy();
     }
   });
 
@@ -102,11 +102,11 @@ describe("models()", () => {
   });
 
   it("supports arbitrary filter predicates", () => {
-    const result = models((m) => m.pricing.input > 0.000001);
+    const result = models((m) => m.pricing.input > 0.000_001);
 
     expect(result.length).toBeGreaterThan(0);
     for (const m of result) {
-      expect(m.pricing.input).toBeGreaterThan(0.000001);
+      expect(m.pricing.input).toBeGreaterThan(0.000_001);
     }
   });
 });

package/src/catalog/index.ts

@@ -23,6 +23,7 @@ export type ModelId = LiteralUnion<KnownModelId, string>;
  */
 export const MODELS = GENERATED_MODELS satisfies readonly ModelDefinition[];
 
+/** @private */
 const MODEL_INDEX = new Map<string, ModelDefinition>(MODELS.map((m) => [m.id, m]));
 
 /**
@@ -61,5 +62,8 @@ export function model(id: ModelId): ModelDefinition | null {
  * ```
  */
 export function models(filter?: (m: ModelDefinition) => boolean): readonly ModelDefinition[] {
-  return filter ? MODELS.filter(filter) : MODELS;
+  if (filter) {
+    return MODELS.filter(filter);
+  }
+  return MODELS;
 }