opencode-usage-report 0.2.0 → 0.4.0

package/src/report.ts

@@ -1,9 +1,9 @@
-import type { PluginOptions, ProviderAdapter, ProviderReport } from "./types.js";
-import { adapters, getAdapter } from "./providers/index.js";
-import { redact, resolveCredential } from "./auth.js";
-import { ensureSessionId, readCache, writeCache } from "./cache.js";
-import type { CacheEntry } from "./cache.js";
-import { localEstimate } from "./fallback.js";
+import type { PluginOptions, ProviderAdapter, ProviderReport } from "./types";
+import { adapters, getAdapter } from "./providers/index";
+import { redact, resolveCredential } from "./auth";
+import { ensureSessionId, readCache, writeCache } from "./cache";
+import type { CacheEntry } from "./cache";
+import { localEstimate } from "./fallback";
 
 export const DEFAULT_OPTIONS: PluginOptions = {
   thresholdPercent: 80,
@@ -102,7 +102,10 @@ async function collectOne(
       error: null,
     };
   } catch (err) {
-    failure = redact(err instanceof Error ? err.message : String(err), cred.key);
+    failure = redact(
+      redact(err instanceof Error ? err.message : String(err), cred.key),
+      cred.accountId ?? null,
+    );
   }
 
   const cached = await readCache(id, options.cacheTtlSeconds, env);
@@ -136,7 +139,7 @@ async function collectOne(
  * `source: "error"` rows.
  */
 export async function collectReports(opts: CollectReportsOptions = {}): Promise<ProviderReport[]> {
-  const options: PluginOptions = { ...DEFAULT_OPTIONS, ...(opts.options ?? {}) };
+  const options: PluginOptions = { ...DEFAULT_OPTIONS, ...opts.options };
   const env = opts.env ?? process.env;
   const refresh = opts.refresh === true;
 

package/src/tui-format.ts

@@ -2,7 +2,7 @@
  * Pure formatting helpers for the TUI sidebar usage panel. No JSX, no Solid
  * imports (the only module dependency is the shared `DEFAULT_OPTIONS`).
  */
-import { DEFAULT_OPTIONS } from "./report.js";
+import { DEFAULT_OPTIONS } from "./report";
 
 export type ToneName = "success" | "warning" | "error" | "textMuted";
 
@@ -160,9 +160,7 @@ function toFiniteNumber(value: unknown): number | null {
  * `barWidth` is floored and clamped to 4..40; `refreshIntervalSeconds` is
  * rounded and clamped to 5..3600 so the timer can never hot-loop or overflow.
  */
-export function coerceTuiOptions(
-  raw: Record<string, unknown> | undefined,
-): ResolvedTuiOptions {
+export function coerceTuiOptions(raw: Record<string, unknown> | undefined): ResolvedTuiOptions {
   const opts: ResolvedTuiOptions = {
     cacheTtlSeconds: DEFAULT_OPTIONS.cacheTtlSeconds,
     thresholdPercent: DEFAULT_OPTIONS.thresholdPercent,

package/src/tui.tsx

@@ -6,129 +6,20 @@ import type {
   TuiSlotPlugin,
 } from "@opencode-ai/plugin/tui";
 import { For, createSignal } from "solid-js";
-import { DEFAULT_OPTIONS, collectReports } from "./report.js";
-import {
-  bar,
-  coerceTuiOptions,
-  countdown,
-  percentText,
-  toneFor,
-  windowLabel,
-} from "./tui-format.js";
-import type { ProviderReport, WindowKind } from "./types.js";
-
-type Theme = TuiPluginApi["theme"]["current"];
-type ThemeColor = Theme["text"];
-
-interface Segment {
-  text: string;
-  fg: ThemeColor;
-  bold?: boolean;
-}
-
-interface Line {
-  segments: Segment[];
-}
-
-const NAMED_WIDTH = 14;
-const EXTRAS_MAX_LENGTH = 80;
-
-/** Order windows for display; unknown kinds sort last. */
-const WINDOW_ORDER: Record<WindowKind, number> = {
-  "5h": 0,
-  weekly: 1,
-  monthly: 2,
-  daily: 3,
-  other: 4,
-};
-
-function windowRank(kind: WindowKind): number {
-  return WINDOW_ORDER[kind] ?? WINDOW_ORDER.other;
-}
-
-/** Collapses whitespace and truncates to a single-line label. */
-function clip(value: string, max = 60): string {
-  const single = value.replace(/\s+/g, " ").trim();
-  if (single.length <= max) return single;
-  return single.slice(0, Math.max(0, max - 1)) + "…";
-}
-
-/** Pads a label to a fixed width, truncating (with a trailing space) when long. */
-function alignLabel(label: string): string {
-  const text =
-    label.length > NAMED_WIDTH ? label.slice(0, NAMED_WIDTH - 1) + " " : label;
-  return text.padEnd(NAMED_WIDTH);
-}
-
-/** Flattens the current signal state into plain, pre-colored text lines. */
-function buildLines(
-  theme: Theme,
-  reports: ProviderReport[],
-  busy: boolean,
-  error: string | null,
-  now: Date,
-  barWidth: number,
-): Line[] {
-  const lines: Line[] = [];
-
-  if (error !== null) {
-    lines.push({
-      segments: [{ text: `api error: ${clip(error)}`, fg: theme.error }],
-    });
-  }
-
-  if (reports.length === 0 && busy) {
-    lines.push({
-      segments: [{ text: "loading…", fg: theme.textMuted }],
-    });
-  }
-
-  for (const report of reports) {
-    const nameColor = report.source === "error" ? theme.textMuted : theme.accent;
-    const segments: Segment[] = [{ text: report.displayName, fg: nameColor, bold: true }];
-    if (report.stale) segments.push({ text: " (stale)", fg: theme.textMuted });
-    if (report.source === "local-estimate") {
-      segments.push({ text: " (est)", fg: theme.textMuted });
-    }
-    lines.push({ segments });
-
-    if (report.source === "error") {
-      lines.push({
-        segments: [
-          { text: clip(report.error ?? "unknown error"), fg: theme.error },
-        ],
-      });
-      continue;
-    }
-
-    const windows = [...report.windows].sort(
-      (a, b) => windowRank(a.kind) - windowRank(b.kind),
-    );
-    for (const w of windows) {
-      const tone = toneFor(w.usedPercent, w.status);
-      const row: Segment[] = [
-        { text: alignLabel(windowLabel(w.kind, w.label)), fg: theme.textMuted },
-        { text: bar(w.usedPercent, barWidth), fg: theme[tone] },
-        { text: " ", fg: theme.text },
-        { text: percentText(w), fg: theme.text },
-      ];
-      const reset = countdown(w.resetsAt, now);
-      if (reset !== null) {
-        row.push({ text: ` resets in ${reset}`, fg: theme.textMuted });
-      }
-      lines.push({ segments: row });
-    }
-
-    for (const [key, value] of Object.entries(report.extras)) {
-      lines.push({
-        segments: [
-          { text: clip(`${key}: ${value}`, EXTRAS_MAX_LENGTH), fg: theme.textMuted },
-        ],
-      });
-    }
-  }
-
-  return lines;
+import { DEFAULT_OPTIONS, collectReports } from "./report";
+import { coerceTuiOptions } from "./tui-format";
+import { buildLines } from "./quota-lines";
+import { UsageDialog } from "./context/dialog";
+import { readCapture } from "./context/system";
+import type { SystemCapture } from "./context/types";
+import type { ProviderReport } from "./types";
+
+/** Resolves the session the `/usage` dialog should describe, if any. */
+function activeSessionID(api: TuiPluginApi): string | null {
+  const route = api.route.current;
+  if (route.name !== "session") return null;
+  const id: unknown = route.params?.sessionID;
+  return typeof id === "string" ? id : null;
 }
 
 export const tui: TuiPlugin = async (api, rawOptions) => {
@@ -138,11 +29,13 @@ export const tui: TuiPlugin = async (api, rawOptions) => {
   const [inFlight, setInFlight] = createSignal(0);
   const [error, setError] = createSignal<string | null>(null);
   const [tick, setTick] = createSignal(Date.now());
+  const [capture, setCapture] = createSignal<SystemCapture | null>(null);
+  const [scope, setScope] = createSignal(0);
+  const [showJson, setShowJson] = createSignal(false);
 
   const busy = (): boolean => inFlight() > 0;
 
   let disposed = false;
-
   const load = async (refresh = false): Promise<void> => {
     if (disposed) return;
     setInFlight((n) => n + 1);
@@ -167,11 +60,22 @@ export const tui: TuiPlugin = async (api, rawOptions) => {
     }
   };
 
-  // Single timer: refreshes data and advances countdowns.
+  // Single timer: refreshes data, advances countdowns, reloads the capture.
+  const refreshCapture = async (): Promise<void> => {
+    if (disposed) return;
+    const sessionID = activeSessionID(api);
+    if (sessionID === null) {
+      setCapture(null);
+      return;
+    }
+    setCapture(await readCapture(sessionID));
+  };
+
   const intervalMs = Math.max(1, Math.floor(options.refreshIntervalSeconds)) * 1000;
   const timer = setInterval(() => {
     setTick(Date.now());
     void load();
+    void refreshCapture();
   }, intervalMs);
 
   api.lifecycle.onDispose(() => {
@@ -182,9 +86,35 @@ export const tui: TuiPlugin = async (api, rawOptions) => {
   const offIdle = api.event.on("session.idle", () => {
     setTick(Date.now());
     void load();
+    void refreshCapture();
   });
   api.lifecycle.onDispose(offIdle);
 
+  const openDialog = (): void => {
+    const sessionID = activeSessionID(api);
+    void refreshCapture().finally(() => {
+      if (disposed) return;
+      setScope(0);
+      setShowJson(false);
+      api.ui.dialog.replace(() => (
+        <UsageDialog
+          api={api}
+          sessionID={sessionID}
+          reports={reports}
+          busy={busy}
+          error={error}
+          now={() => new Date(tick())}
+          system={capture}
+          scope={scope}
+          showJson={showJson}
+          barWidth={options.barWidth}
+        />
+      ));
+      // Must follow replace(): the stack resets the size to "medium".
+      api.ui.dialog.setSize("xlarge");
+    });
+  };
+
   api.lifecycle.onDispose(
     api.keymap.registerLayer({
       commands: [
@@ -197,9 +127,43 @@ export const tui: TuiPlugin = async (api, rawOptions) => {
             void load(true);
           },
         },
+        {
+          name: "usage.open",
+          title: "Usage: open report",
+          description: "Context usage and provider quota windows",
+          category: "Plugin",
+          namespace: "palette",
+          slashName: "usage",
+          run: openDialog,
+        },
+      ],
+      bindings: [{ key: "ctrl+shift+u", cmd: "usage.refresh", desc: "Refresh usage panel" }],
+    }),
+  );
+
+  // Scoped to the dialog's "modal" mode so these keys only fire while it is open.
+  api.lifecycle.onDispose(
+    api.keymap.registerLayer({
+      mode: "modal",
+      commands: [
+        { name: "usage.dialog.refresh", run: () => void load(true) },
+        {
+          name: "usage.dialog.scope",
+          run: () => {
+            setScope((n) => (n + 1) % Math.max(1, reports().length + 1));
+          },
+        },
+        {
+          name: "usage.dialog.json",
+          run: () => {
+            setShowJson((v) => !v);
+          },
+        },
       ],
       bindings: [
-        { key: "ctrl+shift+u", cmd: "usage.refresh", desc: "Refresh usage panel" },
+        { key: "r", cmd: "usage.dialog.refresh", desc: "Refresh usage report" },
+        { key: "tab", cmd: "usage.dialog.scope", desc: "Cycle provider scope" },
+        { key: "j", cmd: "usage.dialog.json", desc: "Toggle raw JSON" },
       ],
     }),
   );
@@ -215,7 +179,14 @@ export const tui: TuiPlugin = async (api, rawOptions) => {
               <b>Usage</b>
             </text>
             <For
-              each={buildLines(theme, reports(), busy(), error(), new Date(tick()), options.barWidth)}
+              each={buildLines(
+                theme,
+                reports(),
+                busy(),
+                error(),
+                new Date(tick()),
+                options.barWidth,
+              )}
             >
               {(line) => (
                 <text>

package/src/types.ts

@@ -28,6 +28,8 @@ export interface ProviderReport {
 export interface Credential {
   type: "api" | "oauth";
   key: string;
+  /** Provider account id, when the auth entry carries one (e.g. ChatGPT). */
+  accountId?: string;
 }
 export interface AdapterResult {
   windows: UsageWindow[];
@@ -50,7 +52,10 @@ export interface PluginOptions {
 
 export type AdapterErrorKind = "auth" | "no-plan" | "rate-limited" | "network" | "bad-response";
 export class AdapterError extends Error {
-  constructor(public kind: AdapterErrorKind, message: string) {
+  constructor(
+    public kind: AdapterErrorKind,
+    message: string,
+  ) {
     super(message);
     this.name = "AdapterError";
   }

package/src/warn.ts

@@ -1,8 +1,8 @@
 import { mkdirSync, readFileSync, renameSync, writeFileSync } from "node:fs";
 import { join } from "node:path";
-import type { ProviderReport, UsageWindow } from "./types.js";
-import { pluginStateDir } from "./paths.js";
-import { formatReset } from "./render.js";
+import type { ProviderReport, UsageWindow } from "./types";
+import { pluginStateDir } from "./paths";
+import { formatReset } from "./render";
 
 export interface WarnHit {
   provider: string;
@@ -72,7 +72,8 @@ export async function checkWarnings(
     for (const w of report.windows) {
       const key = `${report.provider}/${w.kind}`;
       const crossed =
-        (w.usedPercent !== null && w.usedPercent >= thresholdPercent) || HITS_WINDOW_STATUSES.has(w.status);
+        (w.usedPercent !== null && w.usedPercent >= thresholdPercent) ||
+        HITS_WINDOW_STATUSES.has(w.status);
 
       if (crossed) {
         const prev = state[key];