@leo000001/opencode-quota-sidebar 2.0.2 → 2.0.4

package/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+- Add built-in `kimi-for-coding` subscription quota support via `GET https://api.kimi.com/coding/v1/usages`.
+- Parse Kimi's `5h` and `Weekly` windows, including reset timestamps, and render them like other subscription providers.
+- Accept OpenCode provider discovery responses that expose Kimi API keys through provider `key` fields.
 - Add Buzz API balance support for OpenAI-compatible providers that use a Buzz `baseURL`.
 - Document Buzz configuration, rendering, and outbound billing endpoints.
 - Keep session measured cost aligned with OpenCode root-session `message.cost` while still including descendant subagent usage in API-equivalent cost.

package/CONTRIBUTING.md

@@ -19,6 +19,7 @@ The plugin now uses a provider adapter registry, so adding a new provider does n
 - `baseURL` match: best for OpenAI-compatible relays such as RightCode or Buzz
 - Prefix/variant normalization: best when one provider has multiple runtime IDs
 - Balance-only providers should prefer `balance` over inventing fake percent windows
+- Built-in API-key providers such as `kimi-for-coding` may need both: direct ID matching for the canonical provider and support for OpenCode's discovered `key -> options.apiKey` bridge
 
 ## Add a new provider
 
@@ -70,6 +71,10 @@ If your provider is an OpenAI-compatible relay, prefer matching on
 `providerOptions.baseURL` instead of the runtime `providerID`; that keeps custom
 aliases working without extra user config.
 
+If your provider is built into OpenCode and already has a stable runtime ID
+(for example `kimi-for-coding`), prefer a direct provider-ID match first, then
+add a `baseURL` fallback only when it helps older/custom runtime shapes.
+
 If the new provider should appear in default `quota_summary` reports even when
 it has not yet been used in the current session, also update
 `listDefaultQuotaProviderIDs()` in `src/quota.ts`.
@@ -98,7 +103,7 @@ At minimum:
 - format output if using special fields (e.g. `balance`)
 - cache compatibility if the change replaces an older snapshot shape
 - mixed-provider rendering if the new provider will commonly appear next to
-  OpenAI/Copilot/RightCode in sidebar or toast output
+  OpenAI/Copilot/Kimi/RightCode in sidebar or toast output
 
 If the provider introduces new rendering rules or multi-window behavior, add
 coverage in both `src/__tests__/quota.test.ts` and `src/__tests__/format.test.ts`.

package/README.md

@@ -41,13 +41,14 @@ On Windows, use forward slashes: `"file:///D:/Lab/opencode-quota-sidebar/dist/in
 
 ## Supported quota providers
 
-| Provider       | Endpoint                               | Auth            | Status                                  |
-| -------------- | -------------------------------------- | --------------- | --------------------------------------- |
-| OpenAI Codex   | `chatgpt.com/backend-api/wham/usage`   | OAuth (ChatGPT) | Multi-window (short-term + weekly)      |
-| GitHub Copilot | `api.github.com/copilot_internal/user` | OAuth           | Monthly quota                           |
-| RightCode      | `www.right.codes/account/summary`      | API key         | Subscription or balance (by prefix)     |
-| Buzz           | `buzzai.cc/v1/dashboard/billing/*`     | API key         | Balance only (computed from total-used) |
-| Anthropic      | `api.anthropic.com/api/oauth/usage`    | OAuth           | Multi-window (5h + weekly / plan-based) |
+| Provider       | Endpoint                               | Auth            | Status                                  |
+| -------------- | -------------------------------------- | --------------- | --------------------------------------- |
+| OpenAI Codex   | `chatgpt.com/backend-api/wham/usage`   | OAuth (ChatGPT) | Multi-window (short-term + weekly)      |
+| GitHub Copilot | `api.github.com/copilot_internal/user` | OAuth           | Monthly quota                           |
+| Kimi For Coding | `api.kimi.com/coding/v1/usages`       | API key         | Multi-window subscription (5h + weekly) |
+| RightCode      | `www.right.codes/account/summary`      | API key         | Subscription or balance (by prefix)     |
+| Buzz           | `buzzai.cc/v1/dashboard/billing/*`     | API key         | Balance only (computed from total-used) |
+| Anthropic      | `api.anthropic.com/api/oauth/usage`    | OAuth           | Multi-window (5h + weekly / plan-based) |
 
 Want to add support for another provider (Google Antigravity, Zhipu AI, Firmware AI, etc.)? See [CONTRIBUTING.md](CONTRIBUTING.md).
 
@@ -71,16 +72,25 @@ Want to add support for another provider (Google Antigravity, Zhipu AI, Firmware
   - `quota_summary` — generate usage report for session/day/week/month (markdown + toast)
 - `quota_show` — toggle sidebar title display on/off (state persists across sessions)
 - After startup, titles are restored immediately when persisted display mode is OFF; when persisted display mode is ON, touched titles refresh on startup and the rest update on the next relevant session/message event or when `quota_show` is toggled
-- Quota connectors:
-  - OpenAI Codex OAuth (`/backend-api/wham/usage`)
-  - GitHub Copilot OAuth (`/copilot_internal/user`)
-  - RightCode API key (`/account/summary`)
-  - Buzz API key (`/v1/dashboard/billing/subscription` + `/v1/dashboard/billing/usage`)
-  - Anthropic Claude OAuth (`/api/oauth/usage`, with beta header)
+- Quota connectors:
+  - OpenAI Codex OAuth (`/backend-api/wham/usage`)
+  - GitHub Copilot OAuth (`/copilot_internal/user`)
+  - Kimi For Coding API key (`/usages`, built-in `kimi-for-coding` provider)
+  - RightCode API key (`/account/summary`)
+  - Buzz API key (`/v1/dashboard/billing/subscription` + `/v1/dashboard/billing/usage`)
+  - Anthropic Claude OAuth (`/api/oauth/usage`, with beta header)
 - OpenAI OAuth quota checks auto-refresh expired access token (using refresh token)
-- API key providers still show usage aggregation (quota only applies to subscription providers)
-- Incremental usage aggregation — only processes new messages since last cursor
-- Sidebar token units are adaptive (`k`/`m` with one decimal where applicable)
+- API key providers still show usage aggregation (quota only applies to subscription providers)
+- Incremental usage aggregation — only processes new messages since last cursor
+- Sidebar token units are adaptive (`k`/`m` with one decimal where applicable)
+
+### Kimi For Coding notes
+
+- OpenCode's built-in provider ID is `kimi-for-coding` and its runtime base URL is `https://api.kimi.com/coding/v1`.
+- The plugin treats Kimi as a subscription quota source, not a balance source.
+- Quota data is read from `GET https://api.kimi.com/coding/v1/usages`.
+- The current implementation maps the short rolling window in `limits[]` to `5h` and the top-level `usage` block to `Weekly`.
+- Rendering follows the same compact reset formatting as OpenAI: short windows show `Rst MM-DD HH:MM` when they cross days, and longer windows show `Rst MM-DD`.
 
 ## Storage layout
 
@@ -455,12 +465,13 @@ Set `OPENCODE_QUOTA_DEBUG=1` to enable debug logging to stderr. This logs:
 ## Security & privacy notes
 
 - The plugin reads OpenCode credentials from `<opencode-data>/auth.json`.
-- If enabled, quota checks call external endpoints:
-  - OpenAI Codex: `https://chatgpt.com/backend-api/wham/usage`
-  - GitHub Copilot: `https://api.github.com/copilot_internal/user`
-  - RightCode: `https://www.right.codes/account/summary`
-  - Buzz: `https://buzzai.cc/v1/dashboard/billing/subscription` and `https://buzzai.cc/v1/dashboard/billing/usage`
-  - Anthropic: `https://api.anthropic.com/api/oauth/usage`
+- If enabled, quota checks call external endpoints:
+  - OpenAI Codex: `https://chatgpt.com/backend-api/wham/usage`
+  - GitHub Copilot: `https://api.github.com/copilot_internal/user`
+  - Kimi For Coding: `https://api.kimi.com/coding/v1/usages`
+  - RightCode: `https://www.right.codes/account/summary`
+  - Buzz: `https://buzzai.cc/v1/dashboard/billing/subscription` and `https://buzzai.cc/v1/dashboard/billing/usage`
+  - Anthropic: `https://api.anthropic.com/api/oauth/usage`
 - **Screen-sharing warning**: Session titles and toasts surface usage/quota
   information. If you are screen-sharing or recording, consider toggling the
   sidebar display off (`/qtoggle` or `quota_show` tool) to avoid leaking
@@ -470,8 +481,9 @@ Set `OPENCODE_QUOTA_DEBUG=1` to enable debug logging to stderr. This logs:
 - OpenAI OAuth token refresh is disabled by default; set
   `quota.refreshAccessToken=true` if you want the plugin to refresh access
   tokens when expired.
-- Anthropic quota currently uses a beta/internal-style OAuth usage endpoint and
-  request header; response fields may change without notice.
+- Anthropic quota currently uses a beta/internal-style OAuth usage endpoint and
+  request header; response fields may change without notice.
+- Kimi For Coding quota uses the current `/usages` response shape exposed by the Kimi coding service; if Kimi changes that payload, window parsing may need to be updated.
 - State/chunk file writes refuse to write through symlinked targets (best-effort defense-in-depth).
 - The `OPENCODE_QUOTA_DATA_HOME` env var overrides the OpenCode data directory
   path (for testing); do not set this in production.

package/SECURITY.md

@@ -25,7 +25,7 @@ We will acknowledge reports as quickly as possible and provide a remediation tim
 - Keep debug logs free of secrets.
 - Prefer fail-closed behavior for writes (already enforced via symlink checks and atomic writes).
 - Quota fetching may contact provider-operated endpoints such as OpenAI, GitHub,
-  RightCode, Buzz, and Anthropic; review any new provider integration for
+  Kimi, RightCode, Buzz, and Anthropic; review any new provider integration for
   outbound data exposure and header/token handling.
 - Some quota integrations rely on beta or internal-style endpoints; document
   instability risks clearly and avoid assuming long-term API compatibility.

package/dist/providers/core/kimi_for_coding.d.ts

@@ -0,0 +1,2 @@
+import type { QuotaProviderAdapter } from '../types.js';
+export declare const kimiForCodingAdapter: QuotaProviderAdapter;

package/dist/providers/core/kimi_for_coding.js

@@ -0,0 +1,219 @@
+import { isRecord, swallow } from '../../helpers.js';
+import { asNumber, configuredProviderEnabled, fetchWithTimeout, sanitizeBaseURL, toIso, } from '../common.js';
+const KIMI_FOR_CODING_BASE_URL = 'https://api.kimi.com/coding/v1';
+function resolveApiKey(auth, providerOptions) {
+    const optionKey = providerOptions?.apiKey;
+    if (typeof optionKey === 'string' && optionKey)
+        return optionKey;
+    if (!auth)
+        return undefined;
+    if (auth.type === 'api' && typeof auth.key === 'string' && auth.key) {
+        return auth.key;
+    }
+    if (auth.type === 'wellknown') {
+        if (typeof auth.key === 'string' && auth.key)
+            return auth.key;
+        if (typeof auth.token === 'string' && auth.token)
+            return auth.token;
+    }
+    if (auth.type === 'oauth' && typeof auth.access === 'string' && auth.access) {
+        return auth.access;
+    }
+    return undefined;
+}
+function isKimiCodingBaseURL(value) {
+    const normalized = sanitizeBaseURL(value);
+    if (!normalized)
+        return false;
+    try {
+        const parsed = new URL(normalized);
+        if (parsed.protocol !== 'https:')
+            return false;
+        const pathname = parsed.pathname.replace(/\/+$/, '');
+        return parsed.host === 'api.kimi.com' && pathname === '/coding/v1';
+    }
+    catch {
+        return false;
+    }
+}
+function usagesUrl(baseURL) {
+    const normalized = sanitizeBaseURL(baseURL);
+    if (isKimiCodingBaseURL(normalized)) {
+        return `${normalized}/usages`;
+    }
+    return `${KIMI_FOR_CODING_BASE_URL}/usages`;
+}
+function percentFromQuota(limit, remaining) {
+    const total = asNumber(limit) ??
+        (typeof limit === 'string' && limit.trim() ? Number(limit) : undefined);
+    const left = asNumber(remaining) ??
+        (typeof remaining === 'string' && remaining.trim()
+            ? Number(remaining)
+            : undefined);
+    if (total === undefined || left === undefined || total <= 0)
+        return undefined;
+    if (!Number.isFinite(total) || !Number.isFinite(left))
+        return undefined;
+    return Math.max(0, Math.min(100, (left / total) * 100));
+}
+function windowLabel(duration, timeUnit) {
+    if (timeUnit === 'TIME_UNIT_MINUTE' && duration === 300)
+        return '5h';
+    if (timeUnit === 'TIME_UNIT_DAY' && duration === 7)
+        return 'Weekly';
+    if (timeUnit === 'TIME_UNIT_MINUTE' && duration && duration > 0) {
+        const hours = duration / 60;
+        if (hours <= 24)
+            return `${Math.round(hours)}h`;
+    }
+    if (timeUnit === 'TIME_UNIT_HOUR' && duration && duration > 0) {
+        if (duration <= 24)
+            return `${Math.round(duration)}h`;
+        const days = duration / 24;
+        if (days <= 6)
+            return `${Math.round(days)}d`;
+    }
+    if (timeUnit === 'TIME_UNIT_DAY' && duration && duration > 0) {
+        if (duration <= 6)
+            return `${Math.round(duration)}d`;
+        if (duration === 7)
+            return 'Weekly';
+    }
+    return undefined;
+}
+function parseWindow(value) {
+    if (!isRecord(value))
+        return undefined;
+    const window = isRecord(value.window) ? value.window : undefined;
+    const detail = isRecord(value.detail) ? value.detail : undefined;
+    if (!window || !detail)
+        return undefined;
+    const duration = asNumber(window.duration);
+    const timeUnit = typeof window.timeUnit === 'string' ? window.timeUnit : undefined;
+    const label = windowLabel(duration, timeUnit);
+    const remainingPercent = percentFromQuota(detail.limit, detail.remaining);
+    if (!label || remainingPercent === undefined)
+        return undefined;
+    return {
+        label,
+        remainingPercent,
+        resetAt: toIso(detail.resetTime),
+    };
+}
+function dedupeWindows(windows) {
+    const seen = new Set();
+    const deduped = [];
+    for (const window of windows) {
+        const key = `${window.label}|${window.resetAt || ''}|${window.remainingPercent ?? ''}`;
+        if (seen.has(key))
+            continue;
+        seen.add(key);
+        deduped.push(window);
+    }
+    return deduped;
+}
+async function fetchKimiForCodingQuota({ providerID, providerOptions, auth, config, }) {
+    const checkedAt = Date.now();
+    const base = {
+        providerID,
+        adapterID: 'kimi-for-coding',
+        label: 'Kimi For Coding',
+        shortLabel: 'Kimi',
+        sortOrder: 15,
+    };
+    const apiKey = resolveApiKey(auth, providerOptions);
+    if (!apiKey) {
+        return {
+            ...base,
+            status: 'unavailable',
+            checkedAt,
+            note: 'missing api key',
+        };
+    }
+    const response = await fetchWithTimeout(usagesUrl(providerOptions?.baseURL), {
+        method: 'GET',
+        headers: {
+            Accept: 'application/json',
+            Authorization: `Bearer ${apiKey}`,
+            'User-Agent': 'opencode-quota-sidebar',
+        },
+    }, config.quota.requestTimeoutMs).catch(swallow('fetchKimiForCodingQuota:usage'));
+    if (!response) {
+        return {
+            ...base,
+            status: 'error',
+            checkedAt,
+            note: 'network request failed',
+        };
+    }
+    if (!response.ok) {
+        return {
+            ...base,
+            status: 'error',
+            checkedAt,
+            note: `http ${response.status}`,
+        };
+    }
+    const payload = await response
+        .json()
+        .catch(swallow('fetchKimiForCodingQuota:json'));
+    if (!isRecord(payload)) {
+        return {
+            ...base,
+            status: 'error',
+            checkedAt,
+            note: 'invalid response',
+        };
+    }
+    const windows = Array.isArray(payload.limits)
+        ? payload.limits.map((item) => parseWindow(item)).filter(Boolean)
+        : [];
+    const usage = isRecord(payload.usage) ? payload.usage : undefined;
+    const topLevelRemainingPercent = usage
+        ? percentFromQuota(usage.limit, usage.remaining)
+        : undefined;
+    const topLevelResetAt = usage ? toIso(usage.resetTime) : undefined;
+    const allWindows = dedupeWindows([
+        ...windows,
+        topLevelRemainingPercent !== undefined
+            ? {
+                label: 'Weekly',
+                remainingPercent: topLevelRemainingPercent,
+                resetAt: topLevelResetAt,
+            }
+            : undefined,
+    ].filter((value) => Boolean(value))).sort((left, right) => {
+        const order = (label) => {
+            if (label === '5h')
+                return 0;
+            if (label === 'Weekly')
+                return 1;
+            return 2;
+        };
+        return order(left.label) - order(right.label);
+    });
+    const primary = allWindows[0];
+    return {
+        ...base,
+        status: primary ? 'ok' : 'error',
+        checkedAt,
+        remainingPercent: primary?.remainingPercent,
+        resetAt: primary?.resetAt,
+        note: primary ? undefined : 'missing quota fields',
+        windows: allWindows.length > 0 ? allWindows : undefined,
+    };
+}
+export const kimiForCodingAdapter = {
+    id: 'kimi-for-coding',
+    label: 'Kimi For Coding',
+    shortLabel: 'Kimi',
+    sortOrder: 15,
+    normalizeID: (providerID) => providerID === 'kimi-for-coding' ? 'kimi-for-coding' : undefined,
+    matchScore: ({ providerID, providerOptions }) => {
+        if (providerID === 'kimi-for-coding')
+            return 100;
+        return isKimiCodingBaseURL(providerOptions?.baseURL) ? 95 : 0;
+    },
+    isEnabled: (config) => configuredProviderEnabled(config.quota, 'kimi-for-coding', true),
+    fetch: fetchKimiForCodingQuota,
+};

package/dist/providers/index.d.ts

@@ -1,9 +1,10 @@
 import { anthropicAdapter } from './core/anthropic.js';
 import { buzzAdapter } from './third_party/buzz.js';
 import { copilotAdapter } from './core/copilot.js';
+import { kimiForCodingAdapter } from './core/kimi_for_coding.js';
 import { openaiAdapter } from './core/openai.js';
 import { QuotaProviderRegistry } from './registry.js';
 import { rightCodeAdapter } from './third_party/rightcode.js';
 export declare function createDefaultProviderRegistry(): QuotaProviderRegistry;
-export { anthropicAdapter, buzzAdapter, copilotAdapter, openaiAdapter, rightCodeAdapter, QuotaProviderRegistry, };
+export { anthropicAdapter, buzzAdapter, copilotAdapter, kimiForCodingAdapter, openaiAdapter, rightCodeAdapter, QuotaProviderRegistry, };
 export type { AuthUpdate, AuthValue, ProviderResolveContext, QuotaFetchContext, QuotaProviderAdapter, RefreshedOAuthAuth, } from './types.js';

package/dist/providers/index.js

@@ -1,6 +1,7 @@
 import { anthropicAdapter } from './core/anthropic.js';
 import { buzzAdapter } from './third_party/buzz.js';
 import { copilotAdapter } from './core/copilot.js';
+import { kimiForCodingAdapter } from './core/kimi_for_coding.js';
 import { openaiAdapter } from './core/openai.js';
 import { QuotaProviderRegistry } from './registry.js';
 import { rightCodeAdapter } from './third_party/rightcode.js';
@@ -8,9 +9,10 @@ export function createDefaultProviderRegistry() {
     const registry = new QuotaProviderRegistry();
     registry.register(rightCodeAdapter);
     registry.register(buzzAdapter);
+    registry.register(kimiForCodingAdapter);
     registry.register(openaiAdapter);
     registry.register(copilotAdapter);
     registry.register(anthropicAdapter);
     return registry;
 }
-export { anthropicAdapter, buzzAdapter, copilotAdapter, openaiAdapter, rightCodeAdapter, QuotaProviderRegistry, };
+export { anthropicAdapter, buzzAdapter, copilotAdapter, kimiForCodingAdapter, openaiAdapter, rightCodeAdapter, QuotaProviderRegistry, };

package/dist/quota.js

@@ -33,7 +33,7 @@ export function quotaSort(left, right) {
 }
 export function listDefaultQuotaProviderIDs() {
     // Keep default report behavior stable for built-in subscription providers.
-    return ['openai', 'github-copilot', 'anthropic'];
+    return ['openai', 'kimi-for-coding', 'github-copilot', 'anthropic'];
 }
 export function createQuotaRuntime() {
     const providerRegistry = createDefaultProviderRegistry();

package/dist/quota_render.js

@@ -1,5 +1,6 @@
 const PROVIDER_SHORT_LABELS = {
     openai: 'OpenAI',
+    'kimi-for-coding': 'Kimi',
     'github-copilot': 'Copilot',
     anthropic: 'Anthropic',
     rightcode: 'RC',

package/dist/quota_service.js

@@ -107,13 +107,21 @@ export function createQuotaService(deps) {
                         const record = item;
                         const id = record.id;
                         const options = record.options;
+                        const key = record.key;
                         if (typeof id !== 'string')
                             return acc;
                         if (!options || typeof options !== 'object' || Array.isArray(options)) {
-                            acc[id] = {};
+                            acc[id] =
+                                typeof key === 'string' && key ? { apiKey: key } : {};
                             return acc;
                         }
-                        acc[id] = options;
+                        const optionsRecord = options;
+                        acc[id] = {
+                            ...optionsRecord,
+                            ...(typeof key === 'string' && key && optionsRecord.apiKey === undefined
+                                ? { apiKey: key }
+                                : {}),
+                        };
                         return acc;
                     }, {})
                     : {};
@@ -159,13 +167,20 @@ export function createQuotaService(deps) {
                     const record = item;
                     const id = record.id;
                     const options = record.options;
+                    const key = record.key;
                     if (typeof id !== 'string')
                         return acc;
                     if (!options || typeof options !== 'object' || Array.isArray(options)) {
-                        acc[id] = {};
+                        acc[id] = typeof key === 'string' && key ? { apiKey: key } : {};
                         return acc;
                     }
-                    acc[id] = options;
+                    const optionsRecord = options;
+                    acc[id] = {
+                        ...optionsRecord,
+                        ...(typeof key === 'string' && key && optionsRecord.apiKey === undefined
+                            ? { apiKey: key }
+                            : {}),
+                    };
                     return acc;
                 }, {})
                 : {};
@@ -187,15 +202,22 @@ export function createQuotaService(deps) {
                 const record = item;
                 const id = record.id;
                 const options = record.options;
+                const key = record.key;
                 if (typeof id !== 'string')
                     return acc;
                 if (!options ||
                     typeof options !== 'object' ||
                     Array.isArray(options)) {
-                    acc[id] = {};
+                    acc[id] = typeof key === 'string' && key ? { apiKey: key } : {};
                     return acc;
                 }
-                acc[id] = options;
+                const optionsRecord = options;
+                acc[id] = {
+                    ...optionsRecord,
+                    ...(typeof key === 'string' && key && optionsRecord.apiKey === undefined
+                        ? { apiKey: key }
+                        : {}),
+                };
                 return acc;
             }, {})
             : {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leo000001/opencode-quota-sidebar",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "OpenCode plugin that shows quota and token usage in session titles",
   "type": "module",
   "main": "dist/index.js",