ftown 0.25.2 → 0.26.0

package/dist/quota/models-muse.js

@@ -0,0 +1,200 @@
+import { readFile, readdir, stat } from 'node:fs/promises';
+import { join } from 'node:path';
+/**
+ * Muse (Meta "Muse Code" CLI) model list.
+ *
+ * Muse has no `models` subcommand. It keeps a catalogue cache under
+ * `<home>/.local/share/muse/model-catalog/` (one `*.json` file per profile) and
+ * the user's selection in `<home>/.config/muse/settings.json`. Both are read
+ * locally: nothing is executed and no network is used.
+ */
+const CATALOG_SEGMENTS = ['.local', 'share', 'muse', 'model-catalog'];
+const SETTINGS_SEGMENTS = ['.config', 'muse', 'settings.json'];
+const MODEL_FLAG = '--model <id>';
+const EFFORT_FLAG = '--reasoning-effort <level>';
+const FORMAT_MESSAGE = 'unrecognised muse model catalogue format';
+const MISSING_MESSAGE = 'muse model catalogue not found (open muse once to create it)';
+function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+function nonEmptyString(value) {
+    return typeof value === 'string' && value.trim().length > 0 ? value : null;
+}
+function readEfforts(row) {
+    const variants = row.reasoning_effort_variants;
+    if (!Array.isArray(variants))
+        return [];
+    const tiers = [];
+    for (const variant of variants) {
+        if (!isRecord(variant))
+            continue;
+        const tier = nonEmptyString(variant.tier);
+        if (tier !== null && !tiers.includes(tier))
+            tiers.push(tier);
+    }
+    return tiers;
+}
+function readContextTokens(row) {
+    const limit = row.context_limit;
+    return typeof limit === 'number' && Number.isFinite(limit) ? limit : null;
+}
+function failureModels(status, observedAt, message) {
+    return {
+        provider: 'muse',
+        status,
+        models: [],
+        source: 'cached',
+        observedAt,
+        message,
+        modelFlag: MODEL_FLAG,
+        effortFlag: EFFORT_FLAG,
+    };
+}
+/**
+ * Pure: maps the parsed JSON of a muse model catalogue file onto a ProviderModels.
+ * Only visible rows are listed (a missing `visibility` counts as visible), in
+ * the catalogue's order. The default is the row named by `settingsModel`, or the
+ * row flagged `is_default` when that id is null or not a visible row. Never throws.
+ */
+export function parseMuseModelCatalog(catalogJson, settingsModel, settingsEffort, observedAt) {
+    if (!isRecord(catalogJson) || !Array.isArray(catalogJson.rows)) {
+        return failureModels('error', observedAt, FORMAT_MESSAGE);
+    }
+    const visible = [];
+    for (const row of catalogJson.rows) {
+        if (!isRecord(row))
+            continue;
+        const id = nonEmptyString(row.model_id);
+        if (id === null)
+            continue;
+        if (row.visibility !== undefined && row.visibility !== null && row.visibility !== 'visible') {
+            continue;
+        }
+        visible.push({ id, row });
+    }
+    if (visible.length === 0) {
+        return failureModels('error', observedAt, FORMAT_MESSAGE);
+    }
+    const settingsIndex = settingsModel === null ? -1 : visible.findIndex((entry) => entry.id === settingsModel);
+    const defaultIndex = settingsIndex >= 0 ? settingsIndex : visible.findIndex((entry) => entry.row.is_default === true);
+    const models = visible.map((entry, index) => {
+        const efforts = readEfforts(entry.row);
+        const isDefault = index === defaultIndex;
+        return {
+            id: entry.id,
+            name: nonEmptyString(entry.row.display_label),
+            isDefault,
+            description: nonEmptyString(entry.row.description),
+            contextTokens: readContextTokens(entry.row),
+            efforts,
+            defaultEffort: isDefault && settingsEffort !== null && efforts.includes(settingsEffort) ? settingsEffort : null,
+        };
+    });
+    return {
+        provider: 'muse',
+        status: 'ok',
+        models,
+        source: 'cached',
+        observedAt,
+        message: null,
+        modelFlag: MODEL_FLAG,
+        effortFlag: EFFORT_FLAG,
+    };
+}
+function errnoCode(error) {
+    const code = isRecord(error) ? error.code : undefined;
+    return typeof code === 'string' && /^[A-Z][A-Z0-9_]*$/.test(code) ? code : 'UNKNOWN';
+}
+function observedNow(options) {
+    try {
+        return options.now().toISOString();
+    }
+    catch {
+        return new Date().toISOString();
+    }
+}
+function unavailableModels(observedAt) {
+    return {
+        provider: 'muse',
+        status: 'unavailable',
+        models: [],
+        source: 'cached',
+        observedAt,
+        message: MISSING_MESSAGE,
+        modelFlag: MODEL_FLAG,
+        effortFlag: EFFORT_FLAG,
+    };
+}
+async function newestCatalogFile(dir, names) {
+    // Newest mtime wins; on equal mtimes the file name sorted later wins (descending).
+    let newest = null;
+    for (const name of names) {
+        if (!name.endsWith('.json'))
+            continue;
+        const path = join(dir, name);
+        const info = await stat(path);
+        if (!info.isFile())
+            continue;
+        const beats = newest === null ||
+            info.mtimeMs > newest.mtimeMs ||
+            (info.mtimeMs === newest.mtimeMs && name > newest.name);
+        if (beats) {
+            newest = { path, name, mtimeMs: info.mtimeMs };
+        }
+    }
+    return newest === null ? null : { path: newest.path, mtimeMs: newest.mtimeMs };
+}
+async function readSettings(homeDir) {
+    try {
+        const parsed = JSON.parse(await readFile(join(homeDir, ...SETTINGS_SEGMENTS), 'utf8'));
+        if (!isRecord(parsed))
+            return { model: null, effort: null };
+        return {
+            model: nonEmptyString(parsed.model),
+            effort: nonEmptyString(parsed.reasoning_effort),
+        };
+    }
+    catch {
+        return { model: null, effort: null };
+    }
+}
+async function readMuseModels(options) {
+    const catalogDir = join(options.homeDir, ...CATALOG_SEGMENTS);
+    const now = observedNow(options);
+    let names;
+    try {
+        names = await readdir(catalogDir);
+    }
+    catch (error) {
+        const code = errnoCode(error);
+        if (code === 'ENOENT' || code === 'ENOTDIR')
+            return unavailableModels(now);
+        return failureModels('error', now, `muse model catalogue read failed (${code})`);
+    }
+    const newest = await newestCatalogFile(catalogDir, names);
+    if (newest === null)
+        return unavailableModels(now);
+    const raw = await readFile(newest.path, 'utf8');
+    let catalogJson;
+    try {
+        catalogJson = JSON.parse(raw);
+    }
+    catch {
+        catalogJson = undefined;
+    }
+    const settings = await readSettings(options.homeDir);
+    return parseMuseModelCatalog(catalogJson, settings.model, settings.effort, new Date(newest.mtimeMs).toISOString());
+}
+/**
+ * Reads the newest muse catalogue file under `homeDir` and the user's selection
+ * from settings.json. Never throws or rejects.
+ */
+export const fetchMuseModels = async (options) => {
+    try {
+        return await readMuseModels(options);
+    }
+    catch (error) {
+        return failureModels('error', observedNow(options), `muse model catalogue read failed (${errnoCode(error)})`);
+    }
+};
+//# sourceMappingURL=models-muse.js.map

package/dist/quota/models-muse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models-muse.js","sourceRoot":"","sources":["../../src/quota/models-muse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAIjC;;;;;;;GAOG;AAEH,MAAM,gBAAgB,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,eAAe,CAAU,CAAC;AAC/E,MAAM,iBAAiB,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,eAAe,CAAU,CAAC;AACxE,MAAM,UAAU,GAAG,cAAc,CAAC;AAClC,MAAM,WAAW,GAAG,4BAA4B,CAAC;AACjD,MAAM,cAAc,GAAG,0CAA0C,CAAC;AAClE,MAAM,eAAe,GAAG,8DAA8D,CAAC;AAcvF,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7E,CAAC;AAED,SAAS,WAAW,CAAC,GAAS;IAC5B,MAAM,QAAQ,GAAG,GAAG,CAAC,yBAAyB,CAAC;IAC/C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;QAAE,OAAO,EAAE,CAAC;IACxC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;YAAE,SAAS;QACjC,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,iBAAiB,CAAC,GAAS;IAClC,MAAM,KAAK,GAAG,GAAG,CAAC,aAAa,CAAC;IAChC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAC5E,CAAC;AAED,SAAS,aAAa,CAAC,MAAe,EAAE,UAAkB,EAAE,OAAe;IACzE,OAAO;QACL,QAAQ,EAAE,MAAM;QAChB,MAAM;QACN,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,QAAQ;QAChB,UAAU;QACV,OAAO;QACP,SAAS,EAAE,UAAU;QACrB,UAAU,EAAE,WAAW;KACxB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACnC,WAAoB,EACpB,aAA4B,EAC5B,cAA6B,EAC7B,UAAkB;IAElB,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/D,OAAO,aAAa,CAAC,OAAO,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,KAAK,MAAM,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,SAAS;QAC7B,MAAM,EAAE,GAAG,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,EAAE,KAAK,IAAI;YAAE,SAAS;QAC1B,IAAI,GAAG,CAAC,UAAU,KAAK,SAAS,IAAI,GAAG,CAAC,UAAU,KAAK,IAAI,IAAI,GAAG,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YAC5F,SAAS;QACX,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IAC5B,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,aAAa,CAAC,OAAO,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,aAAa,GACjB,aAAa,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,aAAa,CAAC,CAAC;IACzF,MAAM,YAAY,GAChB,aAAa,IAAI,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,KAAK,IAAI,CAAC,CAAC;IAEnG,MAAM,MAAM,GAAmB,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAC1D,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvC,MAAM,SAAS,GAAG,KAAK,KAAK,YAAY,CAAC;QACzC,OAAO;YACL,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC;YAC7C,SAAS;YACT,WAAW,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC;YAClD,aAAa,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC;YAC3C,OAAO;YACP,aAAa,EACX,SAAS,IAAI,cAAc,KAAK,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI;SACnG,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE,IAAI;QACZ,MAAM;QACN,MAAM,EAAE,QAAQ;QAChB,UAAU;QACV,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,UAAU;QACrB,UAAU,EAAE,WAAW;KACxB,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IACtD,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AACvF,CAAC;AAED,SAAS,WAAW,CAAC,OAA0B;IAC7C,IAAI,CAAC;QACH,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;IACrC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAClC,CAAC;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,UAAkB;IAC3C,OAAO;QACL,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE,aAAa;QACrB,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,QAAQ;QAChB,UAAU;QACV,OAAO,EAAE,eAAe;QACxB,SAAS,EAAE,UAAU;QACrB,UAAU,EAAE,WAAW;KACxB,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,iBAAiB,CAC9B,GAAW,EACX,KAAwB;IAExB,mFAAmF;IACnF,IAAI,MAAM,GAA2D,IAAI,CAAC;IAC1E,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;YAAE,SAAS;QACtC,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC7B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAAE,SAAS;QAC7B,MAAM,KAAK,GACT,MAAM,KAAK,IAAI;YACf,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO;YAC7B,CAAC,IAAI,CAAC,OAAO,KAAK,MAAM,CAAC,OAAO,IAAI,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1D,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;QACjD,CAAC;IACH,CAAC;IACD,OAAO,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;AACjF,CAAC;AAED,KAAK,UAAU,YAAY,CAAC,OAAe;IACzC,IAAI,CAAC;QACH,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,iBAAiB,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QAChG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QAC5D,OAAO;YACL,KAAK,EAAE,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC;YACnC,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,gBAAgB,CAAC;SAChD,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACvC,CAAC;AACH,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,OAA0B;IACtD,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,gBAAgB,CAAC,CAAC;IAC9D,MAAM,GAAG,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAEjC,IAAI,KAAe,CAAC;IACpB,IAAI,CAAC;QACH,KAAK,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAC3E,OAAO,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,qCAAqC,IAAI,GAAG,CAAC,CAAC;IACnF,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAC1D,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,iBAAiB,CAAC,GAAG,CAAC,CAAC;IAEnD,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAChD,IAAI,WAAoB,CAAC;IACzB,IAAI,CAAC;QACH,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAAC,MAAM,CAAC;QACP,WAAW,GAAG,SAAS,CAAC;IAC1B,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACrD,OAAO,qBAAqB,CAC1B,WAAW,EACX,QAAQ,CAAC,KAAK,EACd,QAAQ,CAAC,MAAM,EACf,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CACvC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAkB,KAAK,EAAE,OAAO,EAAE,EAAE;IAC9D,IAAI,CAAC;QACH,OAAO,MAAM,cAAc,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,aAAa,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,qCAAqC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChH,CAAC;AACH,CAAC,CAAC"}

package/dist/quota/models-opencode.d.ts

@@ -0,0 +1,51 @@
+import type { ModelsFetcher, ProviderModels } from './types.js';
+/**
+ * Providers whose zero-priced models are covered by a subscription plan the
+ * user holds (priced 'included' rather than 'free'). Any provider id
+ * containing `coding-plan` also counts, see isOpencodePlanProvider.
+ */
+export declare const OPENCODE_PLAN_PROVIDERS: readonly string[];
+/** Pure: true for a subscription-plan provider (listed, or id contains `coding-plan`). */
+export declare function isOpencodePlanProvider(providerId: string): boolean;
+/**
+ * Pure: the provider ids to list, from FTOWN_QUOTA_OPENCODE_PROVIDERS (comma
+ * separated; entries are trimmed, empties and ids that fail the pattern are
+ * dropped, duplicates removed). Falls back to the defaults when the variable is
+ * unset, empty, or leaves no valid id.
+ */
+export declare function opencodeSubscriptionProviders(env: NodeJS.ProcessEnv): string[];
+/**
+ * Pure: the `provider/model` lines of `opencode models` stdout, in output
+ * order, without duplicates. CRLF and blank lines are tolerated; lines with no
+ * slash, an empty provider or model part, or whitespace/control characters are
+ * ignored.
+ */
+export declare function parseOpencodeModelIds(stdout: string): string[];
+/**
+ * Pure: joins the `opencode models` stdout with the parsed catalogue
+ * (`models.json`, or null/anything malformed for "no details"). Only ids
+ * present in the stdout are returned: first every model of `providers`
+ * (provider order, then output order), then every 'free' model of any other
+ * provider, sorted by id. No duplicates. Error when the stdout has no ids.
+ * Never throws.
+ */
+export declare function parseOpencodeModels(idsStdout: string, catalogue: unknown, providers: readonly string[], observedAt: string): ProviderModels;
+/**
+ * Resolves the opencode binary: `<homeDir>/.opencode/bin/opencode` when that is
+ * an executable regular file, else the first such `opencode` on PATH. An empty
+ * homeDir skips the home candidate; relative or empty PATH entries are skipped,
+ * so nothing resolves against the working directory. Nothing is spawned.
+ * Returns null when neither exists. Never throws.
+ */
+export declare function resolveOpencodeBinary(homeDir: string, pathValue: string | undefined): Promise<string | null>;
+/**
+ * Reads and parses `<homeDir>/.cache/opencode/models.json`. Returns null when
+ * homeDir is empty, or the file is missing, not a regular file, larger than the
+ * size bound, or not valid JSON. Never throws.
+ */
+export declare function readOpencodeCatalogue(homeDir: string): Promise<unknown>;
+/**
+ * Lists the subscription-provider models plus every free model opencode
+ * offers. Never throws or rejects.
+ */
+export declare const fetchOpencodeModels: ModelsFetcher;

package/dist/quota/models-opencode.js

@@ -0,0 +1,400 @@
+import { execFile } from 'node:child_process';
+import { constants } from 'node:fs';
+import { access, open, stat } from 'node:fs/promises';
+import { delimiter, isAbsolute, join } from 'node:path';
+/**
+ * opencode model list (opencode 2.3.0).
+ *
+ * Ids come from plain `opencode models` (no arguments): one `provider/model`
+ * per line for every connected provider. Details (name, context, cost,
+ * reasoning efforts) are joined from opencode's own catalogue cache,
+ * `<home>/.cache/opencode/models.json`, keyed by provider id then model id. A
+ * missing or unreadable catalogue only drops the details; the ids are still
+ * listed.
+ *
+ * Returned: every model of the selected subscription providers, then every
+ * zero-priced ('free') model of any other listed provider.
+ *
+ * Nothing here starts a model turn. The binary is `<home>/.opencode/bin/opencode`
+ * when that file exists, otherwise `opencode` from PATH.
+ */
+const PROVIDERS_ENV = 'FTOWN_QUOTA_OPENCODE_PROVIDERS';
+const DEFAULT_PROVIDERS = ['opencode-go', 'zai-coding-plan'];
+const PROVIDER_ID_PATTERN = /^[a-z0-9][a-z0-9-]*$/;
+const BINARY_NAME = 'opencode';
+const MODEL_FLAG = '-m <id>';
+/** opencode 2.3.0 takes the effort as a `#variant` suffix on the model id. */
+const EFFORT_FLAG = '-m <id>#<level>';
+const MAX_BUFFER_BYTES = 16 * 1024 * 1024;
+const MAX_CATALOGUE_BYTES = 64 * 1024 * 1024;
+const CATALOGUE_RELATIVE_PATH = join('.cache', 'opencode', 'models.json');
+const UNEXPECTED_OUTPUT_MESSAGE = 'unexpected output from `opencode models`';
+const NOT_FOUND_MESSAGE = 'opencode CLI not found';
+const FAILED_MESSAGE = '`opencode models` failed';
+const TIMED_OUT_MESSAGE = '`opencode models` timed out';
+const TOO_LARGE_MESSAGE = '`opencode models` output was too large';
+/** A model id line: no whitespace or control characters. */
+const ID_LINE_PATTERN = /^[^\s\u0000-\u001f\u007f]+$/;
+/**
+ * Providers whose zero-priced models are covered by a subscription plan the
+ * user holds (priced 'included' rather than 'free'). Any provider id
+ * containing `coding-plan` also counts, see isOpencodePlanProvider.
+ */
+export const OPENCODE_PLAN_PROVIDERS = [];
+function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+function nonEmptyString(value) {
+    return typeof value === 'string' && value.trim().length > 0 ? value : null;
+}
+function ownRecord(container, key) {
+    if (!Object.prototype.hasOwnProperty.call(container, key))
+        return null;
+    const value = container[key];
+    return isRecord(value) ? value : null;
+}
+/** Pure: true for a subscription-plan provider (listed, or id contains `coding-plan`). */
+export function isOpencodePlanProvider(providerId) {
+    return OPENCODE_PLAN_PROVIDERS.includes(providerId) || providerId.includes('coding-plan');
+}
+/**
+ * Pure: the provider ids to list, from FTOWN_QUOTA_OPENCODE_PROVIDERS (comma
+ * separated; entries are trimmed, empties and ids that fail the pattern are
+ * dropped, duplicates removed). Falls back to the defaults when the variable is
+ * unset, empty, or leaves no valid id.
+ */
+export function opencodeSubscriptionProviders(env) {
+    const raw = env[PROVIDERS_ENV];
+    const ids = [];
+    if (raw !== undefined) {
+        for (const part of raw.split(',')) {
+            const id = part.trim();
+            if (PROVIDER_ID_PATTERN.test(id) && !ids.includes(id))
+                ids.push(id);
+        }
+    }
+    return ids.length > 0 ? ids : [...DEFAULT_PROVIDERS];
+}
+/**
+ * Pure: the `provider/model` lines of `opencode models` stdout, in output
+ * order, without duplicates. CRLF and blank lines are tolerated; lines with no
+ * slash, an empty provider or model part, or whitespace/control characters are
+ * ignored.
+ */
+export function parseOpencodeModelIds(stdout) {
+    return modelRefs(stdout).map((ref) => ref.id);
+}
+function modelRefs(stdout) {
+    const refs = [];
+    const seen = new Set();
+    for (const rawLine of stdout.split('\n')) {
+        const line = rawLine.trim();
+        if (line.length === 0 || !ID_LINE_PATTERN.test(line))
+            continue;
+        const slash = line.indexOf('/');
+        if (slash <= 0 || slash === line.length - 1)
+            continue;
+        if (seen.has(line))
+            continue;
+        seen.add(line);
+        refs.push({ id: line, provider: line.slice(0, slash), model: line.slice(slash + 1) });
+    }
+    return refs;
+}
+function finiteNumber(value) {
+    return typeof value === 'number' && Number.isFinite(value) ? value : null;
+}
+/** Cost class from a catalogue entry's `cost`, or undefined when not stated. */
+function pricingOf(entry, provider) {
+    const cost = entry === null ? null : entry.cost;
+    if (!isRecord(cost))
+        return undefined;
+    const input = finiteNumber(cost.input);
+    const output = finiteNumber(cost.output);
+    if (input === null || output === null || input < 0 || output < 0)
+        return undefined;
+    if (input > 0 || output > 0)
+        return 'paid';
+    return isOpencodePlanProvider(provider) ? 'included' : 'free';
+}
+/** Effort levels from `reasoning_options` entries of type `effort`, in catalogue order. */
+function effortsOf(entry) {
+    const efforts = [];
+    let defaultEffort = null;
+    const options = entry === null ? undefined : entry.reasoning_options;
+    if (!Array.isArray(options))
+        return { efforts, defaultEffort };
+    for (const option of options) {
+        if (!isRecord(option) || option.type !== 'effort' || !Array.isArray(option.values))
+            continue;
+        for (const value of option.values) {
+            const rawLevel = nonEmptyString(value);
+            const level = rawLevel === null ? null : rawLevel.trim();
+            if (level !== null && level.length > 0 && !efforts.includes(level))
+                efforts.push(level);
+        }
+        const rawDefault = nonEmptyString(option.default);
+        const stated = rawDefault === null ? null : rawDefault.trim();
+        if (defaultEffort === null && stated !== null)
+            defaultEffort = stated;
+    }
+    if (defaultEffort !== null && !efforts.includes(defaultEffort))
+        defaultEffort = null;
+    return { efforts, defaultEffort };
+}
+function catalogueEntry(catalogue, ref) {
+    if (!isRecord(catalogue))
+        return null;
+    const provider = ownRecord(catalogue, ref.provider);
+    const models = provider === null ? null : ownRecord(provider, 'models');
+    return models === null ? null : ownRecord(models, ref.model);
+}
+function singleLine(value) {
+    const text = nonEmptyString(value);
+    return text === null ? null : text.replace(/\s+/g, ' ').trim();
+}
+function harnessModel(ref, entry) {
+    const limit = entry === null ? undefined : entry.limit;
+    const { efforts, defaultEffort } = effortsOf(entry);
+    const model = {
+        id: ref.id,
+        name: entry === null ? null : singleLine(entry.name),
+        isDefault: false,
+        description: entry === null ? null : singleLine(entry.description),
+        contextTokens: isRecord(limit) ? finiteNumber(limit.context) : null,
+        efforts,
+        defaultEffort,
+    };
+    const pricing = pricingOf(entry, ref.provider);
+    if (pricing !== undefined)
+        model.pricing = pricing;
+    return model;
+}
+function okModels(models, observedAt) {
+    return {
+        provider: 'opencode',
+        status: 'ok',
+        models,
+        source: 'live',
+        observedAt,
+        message: null,
+        modelFlag: MODEL_FLAG,
+        effortFlag: EFFORT_FLAG,
+    };
+}
+function failedModels(status, observedAt, message) {
+    return {
+        provider: 'opencode',
+        status,
+        models: [],
+        source: 'live',
+        observedAt,
+        message,
+        modelFlag: MODEL_FLAG,
+        effortFlag: EFFORT_FLAG,
+    };
+}
+/**
+ * Pure: joins the `opencode models` stdout with the parsed catalogue
+ * (`models.json`, or null/anything malformed for "no details"). Only ids
+ * present in the stdout are returned: first every model of `providers`
+ * (provider order, then output order), then every 'free' model of any other
+ * provider, sorted by id. No duplicates. Error when the stdout has no ids.
+ * Never throws.
+ */
+export function parseOpencodeModels(idsStdout, catalogue, providers, observedAt) {
+    const refs = modelRefs(idsStdout);
+    if (refs.length === 0)
+        return failedModels('error', observedAt, UNEXPECTED_OUTPUT_MESSAGE);
+    const all = refs.map((ref) => harnessModel(ref, catalogueEntry(catalogue, ref)));
+    const providerOf = new Map(refs.map((ref) => [ref.id, ref.provider]));
+    const selected = [];
+    const taken = new Set();
+    for (const provider of providers) {
+        for (const model of all) {
+            if (providerOf.get(model.id) === provider && !taken.has(model.id)) {
+                selected.push(model);
+                taken.add(model.id);
+            }
+        }
+    }
+    const free = all
+        .filter((model) => model.pricing === 'free' && !taken.has(model.id))
+        .sort((a, b) => (a.id < b.id ? -1 : a.id > b.id ? 1 : 0));
+    return okModels([...selected, ...free], observedAt);
+}
+function observedNow(options) {
+    try {
+        return options.now().toISOString();
+    }
+    catch {
+        return new Date().toISOString();
+    }
+}
+/** A regular file that the current user may execute (no spawn). */
+async function isExecutableFile(path) {
+    try {
+        await access(path, constants.X_OK);
+        return (await stat(path)).isFile();
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Resolves the opencode binary: `<homeDir>/.opencode/bin/opencode` when that is
+ * an executable regular file, else the first such `opencode` on PATH. An empty
+ * homeDir skips the home candidate; relative or empty PATH entries are skipped,
+ * so nothing resolves against the working directory. Nothing is spawned.
+ * Returns null when neither exists. Never throws.
+ */
+export async function resolveOpencodeBinary(homeDir, pathValue) {
+    if (homeDir.length > 0) {
+        const bundled = join(homeDir, '.opencode', 'bin', BINARY_NAME);
+        if (await isExecutableFile(bundled))
+            return bundled;
+    }
+    for (const dir of (pathValue ?? '').split(delimiter)) {
+        if (dir.length === 0 || !isAbsolute(dir))
+            continue;
+        const candidate = join(dir, BINARY_NAME);
+        if (await isExecutableFile(candidate))
+            return candidate;
+    }
+    return null;
+}
+/**
+ * Reads and parses `<homeDir>/.cache/opencode/models.json`. Returns null when
+ * homeDir is empty, or the file is missing, not a regular file, larger than the
+ * size bound, or not valid JSON. Never throws.
+ */
+export async function readOpencodeCatalogue(homeDir) {
+    if (homeDir.length === 0)
+        return null;
+    let handle = null;
+    try {
+        handle = await open(join(homeDir, CATALOGUE_RELATIVE_PATH), 'r');
+        const info = await handle.stat();
+        if (!info.isFile() || info.size > MAX_CATALOGUE_BYTES)
+            return null;
+        const buffer = Buffer.alloc(info.size);
+        let offset = 0;
+        while (offset < info.size) {
+            const { bytesRead } = await handle.read(buffer, offset, info.size - offset, offset);
+            if (bytesRead === 0)
+                break;
+            offset += bytesRead;
+        }
+        return JSON.parse(buffer.subarray(0, offset).toString('utf8'));
+    }
+    catch {
+        return null;
+    }
+    finally {
+        try {
+            await handle?.close();
+        }
+        catch {
+            // ignore
+        }
+    }
+}
+/** The one `opencode models` call (no arguments). Never rejects. */
+function runModelsCall(binary, timeoutMs) {
+    return new Promise((resolve) => {
+        try {
+            execFile(binary, ['models'], {
+                timeout: timeoutMs,
+                killSignal: 'SIGKILL',
+                encoding: 'utf8',
+                maxBuffer: MAX_BUFFER_BYTES,
+                windowsHide: true,
+            }, (error, stdout) => {
+                try {
+                    if (!error) {
+                        resolve({ kind: 'ok', stdout: String(stdout) });
+                        return;
+                    }
+                    const failure = error;
+                    if (failure.code === 'ERR_CHILD_PROCESS_STDIO_MAXBUFFER')
+                        resolve({ kind: 'too_large' });
+                    else if (failure.killed === true)
+                        resolve({ kind: 'timeout' });
+                    else if (failure.code === 'ENOENT')
+                        resolve({ kind: 'missing' });
+                    else
+                        resolve({ kind: 'failed' });
+                }
+                catch {
+                    resolve({ kind: 'failed' });
+                }
+            });
+        }
+        catch {
+            resolve({ kind: 'failed' });
+        }
+    });
+}
+/**
+ * Resolves the promise, but falls back after `ms` if still pending. The
+ * underlying work is left to finish in the background; only the awaited
+ * result is bounded. Never rejects.
+ */
+function withDeadline(promise, ms, fallback) {
+    if (ms <= 0)
+        return Promise.resolve(fallback);
+    let timer = null;
+    const timeoutPromise = new Promise((resolve) => {
+        timer = setTimeout(() => resolve(fallback), ms);
+        if (typeof timer.unref === 'function')
+            timer.unref();
+    });
+    return Promise.race([promise.catch(() => fallback), timeoutPromise]).finally(() => {
+        if (timer !== null)
+            clearTimeout(timer);
+    });
+}
+async function readOpencodeModels(options) {
+    const observedAt = observedNow(options);
+    const providers = opencodeSubscriptionProviders(process.env);
+    const startedAt = Date.now();
+    const capped = Number.isFinite(options.timeoutMs);
+    const binary = await resolveOpencodeBinary(options.homeDir, process.env.PATH);
+    if (binary === null)
+        return failedModels('unavailable', observedAt, NOT_FOUND_MESSAGE);
+    const remainingMs = capped ? startedAt + options.timeoutMs - Date.now() : options.timeoutMs;
+    if (capped && remainingMs <= 0) {
+        return failedModels('error', observedAt, TIMED_OUT_MESSAGE);
+    }
+    const outcomePromise = runModelsCall(binary, capped ? remainingMs : options.timeoutMs);
+    const cataloguePromise = readOpencodeCatalogue(options.homeDir);
+    const catalogue = capped
+        ? await withDeadline(cataloguePromise, remainingMs, null)
+        : await cataloguePromise;
+    const outcome = await outcomePromise;
+    switch (outcome.kind) {
+        case 'ok':
+            return parseOpencodeModels(outcome.stdout, catalogue, providers, observedAt);
+        case 'missing':
+            return failedModels('unavailable', observedAt, NOT_FOUND_MESSAGE);
+        case 'timeout':
+            return failedModels('error', observedAt, TIMED_OUT_MESSAGE);
+        case 'too_large':
+            return failedModels('error', observedAt, TOO_LARGE_MESSAGE);
+        default:
+            return failedModels('error', observedAt, FAILED_MESSAGE);
+    }
+}
+/**
+ * Lists the subscription-provider models plus every free model opencode
+ * offers. Never throws or rejects.
+ */
+export const fetchOpencodeModels = async (options) => {
+    try {
+        return await readOpencodeModels(options);
+    }
+    catch {
+        return failedModels('error', observedNow(options), FAILED_MESSAGE);
+    }
+};
+//# sourceMappingURL=models-opencode.js.map