@subrouter/opencode 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -6,8 +6,9 @@
  * URL, so opencode never installs anything). Each subrouter preset becomes a
  * model: pick `subrouter/default` (or any preset created with
  * `subrouter preset create`) in opencode. Provider id stays `subrouter`; the
- * visible name is `subrouter.org`. Model names, context limits, and
- * `experimental.chat.system.transform` follow the first live routed candidate.
+ * visible name is `subrouter.org`. Context limits follow the first live
+ * candidate. Input modalities cover every usable candidate so the
+ * router can select a compatible subscription for each prompt.
  *
  * `subrouterAuthPlugin` registers the login flow, so `opencode auth login`
  * (and any harness driving opencode's auth hook, like kimaki's Discord

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAuBjD,eAAO,MAAM,eAAe,EAAE,MA4E7B,CAAA;AAoBD,eAAO,MAAM,mBAAmB,EAAE,MA0EjC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAe,MAAM,qBAAqB,CAAA;AA0C9D,eAAO,MAAM,eAAe,EAAE,MAoH7B,CAAA;AAoBD,eAAO,MAAM,mBAAmB,EAAE,MA0EjC,CAAA"}

package/dist/index.js

@@ -6,8 +6,9 @@
  * URL, so opencode never installs anything). Each subrouter preset becomes a
  * model: pick `subrouter/default` (or any preset created with
  * `subrouter preset create`) in opencode. Provider id stays `subrouter`; the
- * visible name is `subrouter.org`. Model names, context limits, and
- * `experimental.chat.system.transform` follow the first live routed candidate.
+ * visible name is `subrouter.org`. Context limits follow the first live
+ * candidate. Input modalities cover every usable candidate so the
+ * router can select a compatible subscription for each prompt.
  *
  * `subrouterAuthPlugin` registers the login flow, so `opencode auth login`
  * (and any harness driving opencode's auth hook, like kimaki's Discord
@@ -17,39 +18,57 @@
  * NOTE: only plugin initializer functions may be exported from this module.
  * OpenCode calls every export as a plugin.
  */
-import { adapters, addAccount, DEFAULT_PRESET_NAME, isProviderId, loadModelsDevCatalog, loadPresets, modelsDevLimit, PROVIDER_DISPLAY_NAME, PROVIDER_ID, PROVIDER_IDS, resolveActiveCandidate, setSubrouterLog, } from '@subrouter/cli';
+import { adapters, addAccount, DEFAULT_PRESET_NAME, isProviderId, loadModelsDevCatalog, loadPresets, modelsDevInputModalities, modelsDevLimit, modelsDevModel, PROVIDER_DISPLAY_NAME, PROVIDER_ID, PROVIDER_IDS, resolveCandidates, resolvePresetModels, } from '@subrouter/cli';
 import { addSubrouterHeaders, revealRoutedModel } from "./provider.js";
 function providerEntryUrl() {
     const isDev = import.meta.url.endsWith('.ts');
     return new URL(isDev ? './provider.ts' : './provider.js', import.meta.url).href;
 }
-export const subrouterPlugin = async ({ client }) => {
-    // OpenCode loads this plugin and the provider module separately. Both import
-    // @subrouter/cli; this callback is the only log sink the router may use.
-    // Never console.log here. OpenCode prints plugin logs via client.app.log.
-    if (client?.app?.log) {
-        setSubrouterLog((entry) => {
-            void client.app
-                .log({
-                body: {
-                    service: 'subrouter',
-                    level: entry.level,
-                    message: entry.message,
-                    extra: entry.extra,
-                },
-            })
-                .catch(() => { });
+function opencodeLog(client) {
+    if (!client?.app?.log)
+        return undefined;
+    const write = client.app.log.bind(client.app);
+    return (entry) => {
+        void write({
+            body: {
+                service: 'subrouter',
+                level: entry.level,
+                message: entry.message,
+                extra: entry.extra,
+            },
+        }).catch(() => { });
+    };
+}
+export const subrouterPlugin = async ({ client, directory }) => {
+    const log = opencodeLog(client);
+    const pendingNotices = new Map();
+    const onCooldownFallback = (notice) => {
+        if (!client || !notice.sessionID || !notice.agent || notice.agent === 'title')
+            return;
+        if (pendingNotices.has(notice.sessionID))
+            return;
+        const preferred = `${notice.preferred.provider}/${notice.preferred.modelId}`;
+        const active = `${notice.active.provider}/${notice.active.modelId}`;
+        pendingNotices.set(notice.sessionID, {
+            agent: notice.agent,
+            variant: notice.variant,
+            preset: notice.preset,
+            text: `Subrouter: ${preferred} was rate limited. This message started with ${active}.`,
         });
-    }
+    };
     return {
         config: async (config) => {
             const presets = await loadPresets().catch(() => {
                 return { version: 1, presets: {} };
             });
             const names = new Set([DEFAULT_PRESET_NAME, ...Object.keys(presets.presets)]);
-            const catalog = await loadModelsDevCatalog();
+            const catalog = await loadModelsDevCatalog({ log });
             const models = Object.fromEntries(await Promise.all([...names].map(async (name) => {
-                const candidate = await resolveActiveCandidate(name);
+                const presetModels = await resolvePresetModels(name);
+                const candidates = presetModels instanceof Error
+                    ? []
+                    : (await resolveCandidates({ presetModels })).candidates;
+                const candidate = candidates[0];
                 const limit = candidate
                     ? modelsDevLimit({
                         provider: candidate.provider,
@@ -57,15 +76,34 @@ export const subrouterPlugin = async ({ client }) => {
                         catalog,
                     })
                     : null;
+                const input = new Set(['text']);
+                let attachment = false;
+                for (const current of candidates) {
+                    const model = modelsDevModel({
+                        provider: current.provider,
+                        modelId: current.modelId,
+                        catalog,
+                    });
+                    const modalities = modelsDevInputModalities({
+                        provider: current.provider,
+                        modelId: current.modelId,
+                        catalog,
+                    });
+                    if (!model || !modalities)
+                        continue;
+                    attachment ||= model.attachment && modalities.some((modality) => modality !== 'text');
+                    for (const modality of modalities)
+                        input.add(modality);
+                }
                 return [
                     name,
                     {
-                        name: candidate ? `${name} (${candidate.modelId})` : name,
+                        name,
                         tool_call: true,
-                        attachment: true,
+                        attachment,
                         reasoning: false,
                         modalities: {
-                            input: ['text', 'image', 'pdf'],
+                            input: [...input],
                             output: ['text'],
                         },
                         cost: { input: 0, output: 0, cache_read: 0, cache_write: 0 },
@@ -79,10 +117,32 @@ export const subrouterPlugin = async ({ client }) => {
                     name: PROVIDER_DISPLAY_NAME,
                     npm: providerEntryUrl(),
                     models,
-                    options: {},
+                    options: { log, onCooldownFallback },
                 },
             };
         },
+        event: async ({ event }) => {
+            if (event.type !== 'session.idle')
+                return;
+            const pending = pendingNotices.get(event.properties.sessionID);
+            if (!pending)
+                return;
+            pendingNotices.delete(event.properties.sessionID);
+            const body = {
+                noReply: true,
+                agent: pending.agent,
+                model: { providerID: PROVIDER_ID, modelID: pending.preset },
+                variant: pending.variant,
+                parts: [{ type: 'text', text: pending.text, ignored: true }],
+            };
+            await client.session
+                .prompt({
+                path: { id: event.properties.sessionID },
+                query: { directory },
+                body,
+            })
+                .catch(() => { });
+        },
         'chat.headers': async (input, output) => addSubrouterHeaders(input, output),
         // OpenCode identity uses the preset id; rewrite it to the live routed model.
         'experimental.chat.system.transform': async (input, output) => {

package/dist/opencode-e2e.test.js

@@ -17,7 +17,7 @@ import { tmpdir } from 'node:os';
 import path from 'node:path';
 import { pathToFileURL } from 'node:url';
 import { afterAll, beforeAll, describe, expect, test } from 'vitest';
-import { OPENAI_WEBSOCKET_SESSION_HEADER, OPENAI_WEBSOCKET_TITLE_HEADER, addAccount, markCooldown, } from '@subrouter/cli';
+import { OPENCODE_AGENT_HEADER, OPENCODE_VARIANT_HEADER, OPENAI_WEBSOCKET_SESSION_HEADER, OPENAI_WEBSOCKET_TITLE_HEADER, addAccount, markCooldown, } from '@subrouter/cli';
 import { addSubrouterHeaders } from "./provider.js";
 function summarizeSessionEvents(events) {
     const summary = [];
@@ -58,7 +58,7 @@ async function startMockServer(handler) {
             body += String(chunk);
         });
         req.on('end', () => {
-            requests.push(req.url ?? '');
+            requests.push({ path: req.url ?? '', body });
             handler({ path: req.url ?? '', body }, res);
         });
     });
@@ -88,6 +88,7 @@ function sseChunk(data) {
 let home;
 let projectDir;
 let anthropicMock;
+let modelsDevMock;
 let zenMock;
 let server;
 const savedEnv = {};
@@ -138,12 +139,35 @@ beforeAll(async () => {
         res.write('data: [DONE]\n\n');
         res.end();
     });
+    modelsDevMock = await startMockServer((_request, res) => {
+        const emptyProvider = { models: {} };
+        const pdfModel = (id) => ({
+            id,
+            attachment: true,
+            modalities: { input: ['text', 'image', 'pdf'], output: ['text'] },
+            limit: { context: 200_000, output: 64_000 },
+        });
+        res.writeHead(200, { 'content-type': 'application/json' });
+        res.end(JSON.stringify({
+            anthropic: { models: { 'claude-opus-4-6': pdfModel('claude-opus-4-6') } },
+            openai: emptyProvider,
+            xai: emptyProvider,
+            'opencode-go': { models: { 'grok-4.6': pdfModel('grok-4.6') } },
+            'github-copilot': emptyProvider,
+            poe: emptyProvider,
+            'minimax-coding-plan': emptyProvider,
+            'kimi-for-coding': emptyProvider,
+            'zai-coding-plan': emptyProvider,
+            'alibaba-coding-plan': emptyProvider,
+        }));
+    });
     // Subrouter state: one rate-limited anthropic account + one zen key
     const subrouterHome = path.join(home, 'subrouter');
     await mkdir(subrouterHome, { recursive: true });
     for (const [key, value] of Object.entries({
         SUBROUTER_HOME: subrouterHome,
         SUBROUTER_ANTHROPIC_BASE_URL: `${anthropicMock.url}/v1`,
+        SUBROUTER_MODELS_DEV_URL: modelsDevMock.url,
         SUBROUTER_OPENCODE_GO_BASE_URL: `${zenMock.url}/v1`,
         // Isolate opencode from the user's real global config and auth
         XDG_CONFIG_HOME: path.join(home, 'xdg-config'),
@@ -171,10 +195,12 @@ beforeAll(async () => {
         account: { type: 'api', key: 'zen-key', addedAt: 1, lastUsed: 1 },
     });
     const providerEntry = pathToFileURL(path.join(import.meta.dirname, '..', 'dist', 'provider.js')).href;
+    const pluginEntry = pathToFileURL(path.join(import.meta.dirname, '..', 'dist', 'index.js')).href;
     server = await createOpencodeServer({
         port: 0,
         timeout: 60_000,
         config: {
+            plugin: [pluginEntry],
             provider: {
                 subrouter: {
                     name: 'Subrouter',
@@ -183,6 +209,8 @@ beforeAll(async () => {
                         default: {
                             name: 'subrouter default',
                             tool_call: true,
+                            attachment: true,
+                            modalities: { input: ['text', 'image', 'pdf'], output: ['text'] },
                             cost: { input: 0, output: 0, cache_read: 0, cache_write: 0 },
                             limit: { context: 200_000, output: 64_000 },
                         },
@@ -195,6 +223,7 @@ beforeAll(async () => {
 afterAll(async () => {
     server?.close();
     await anthropicMock?.close();
+    await modelsDevMock?.close();
     await zenMock?.close();
     for (const [key, value] of Object.entries(savedEnv)) {
         if (value === undefined)
@@ -211,14 +240,27 @@ describe('opencode + subrouter provider', () => {
             sessionID: 'session-1',
             agent: 'build',
             model: { providerID: 'subrouter' },
+            message: {
+                agent: 'build',
+                model: { providerID: 'subrouter', modelID: 'build', variant: 'high' },
+            },
         }, output);
-        expect(output.headers).toEqual({ [OPENAI_WEBSOCKET_SESSION_HEADER]: 'session-1' });
+        expect(output.headers).toEqual({
+            [OPENAI_WEBSOCKET_SESSION_HEADER]: 'session-1',
+            [OPENCODE_AGENT_HEADER]: 'build',
+            [OPENCODE_VARIANT_HEADER]: 'high',
+        });
+        const titleOutput = { headers: {} };
         addSubrouterHeaders({
             sessionID: 'session-2',
             agent: 'title',
             model: { providerID: 'subrouter' },
-        }, output);
-        expect(output.headers).toEqual({
+            message: {
+                agent: 'build',
+                model: { providerID: 'subrouter', modelID: 'build', variant: 'high' },
+            },
+        }, titleOutput);
+        expect(titleOutput.headers).toEqual({
             [OPENAI_WEBSOCKET_SESSION_HEADER]: 'session-2',
             [OPENAI_WEBSOCKET_TITLE_HEADER]: 'true',
         });
@@ -248,6 +290,92 @@ describe('opencode + subrouter provider', () => {
         expect(anthropicMock.requests.length).toBeGreaterThan(0);
         expect(zenMock.requests.length).toBeGreaterThan(0);
     }, 120_000);
+    test('a pre-existing cooldown leaves a visible ignored route notice without another model turn', async () => {
+        const client = createOpencodeClient({ baseUrl: server.url });
+        const session = await client.session.create({
+            query: { directory: projectDir },
+            body: { title: 'subrouter route notice' },
+        });
+        expect(session.data).toBeTruthy();
+        const requestsBefore = zenMock.requests.length;
+        const result = await client.session.prompt({
+            path: { id: session.data.id },
+            query: { directory: projectDir },
+            body: {
+                model: { providerID: 'subrouter', modelID: 'default' },
+                parts: [{ type: 'text', text: 'say hi again' }],
+            },
+        });
+        expect((result.data?.parts ?? [])
+            .filter((part) => part.type === 'text')
+            .map((part) => part.text)
+            .join('\n')).toContain('hello from fallback');
+        await expect
+            .poll(async () => {
+            const messages = await client.session.messages({
+                path: { id: session.data.id },
+                query: { directory: projectDir },
+            });
+            return (messages.data ?? []).some(({ parts }) => parts.some((part) => part.type === 'text' &&
+                part.ignored === true &&
+                part.text.includes('was rate limited. This message started with opencode-go/')));
+        })
+            .toBe(true);
+        const messages = await client.session.messages({
+            path: { id: session.data.id },
+            query: { directory: projectDir },
+        });
+        const notice = (messages.data ?? []).find(({ parts }) => parts.some((part) => part.type === 'text' && part.ignored === true));
+        expect(notice?.info).toMatchObject({
+            role: 'user',
+            agent: 'build',
+            model: { providerID: 'subrouter', modelID: 'default' },
+        });
+        expect((messages.data ?? []).filter(({ info }) => info.role === 'assistant')).toHaveLength(1);
+        expect(zenMock.requests).toHaveLength(requestsBefore + 1);
+    }, 120_000);
+    test('PDF file parts reach a compatible fallback through opencode', async () => {
+        const client = createOpencodeClient({ baseUrl: server.url });
+        const session = await client.session.create({
+            query: { directory: projectDir },
+            body: { title: 'subrouter PDF e2e' },
+        });
+        expect(session.data).toBeTruthy();
+        const result = await client.session.prompt({
+            path: { id: session.data.id },
+            query: { directory: projectDir },
+            body: {
+                model: { providerID: 'subrouter', modelID: 'default' },
+                parts: [
+                    {
+                        type: 'file',
+                        filename: 'document.pdf',
+                        mime: 'application/pdf',
+                        url: `data:application/pdf;base64,${Buffer.from('%PDF-1.4\n%%EOF').toString('base64')}`,
+                    },
+                    { type: 'text', text: 'read the PDF' },
+                ],
+            },
+        });
+        const texts = (result.data?.parts ?? [])
+            .filter((part) => part.type === 'text')
+            .map((part) => part.text)
+            .join('\n');
+        expect(texts).toContain('hello from fallback');
+        const request = zenMock.requests.at(-1);
+        expect(request).toBeTruthy();
+        const body = JSON.parse(request.body);
+        expect(body.messages.at(-1)?.content).toEqual([
+            {
+                type: 'file',
+                file: {
+                    filename: 'document.pdf',
+                    file_data: `data:application/pdf;base64,${Buffer.from('%PDF-1.4\n%%EOF').toString('base64')}`,
+                },
+            },
+            { type: 'text', text: 'read the PDF' },
+        ]);
+    }, 120_000);
     test('all cooling-down accounts retry through opencode instead of dying', async () => {
         const untilMs = Date.now() + 2_000;
         await markCooldown({