@leo000001/opencode-quota-sidebar 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -1,70 +1,17 @@
 # Changelog
 
-## Unreleased
+## 1.0.0
 
-### Features
-
-- Refactor quota provider handling to an adapter registry (`src/providers/*`), so adding a new provider no longer requires editing core dispatch code.
-- Add RightCode provider support (`https://www.right.codes/account/summary`) with baseURL-based matching.
-- RightCode subscription display now uses daily quota logic and ignores tiny plans (`total_quota < 10`); when not matched, falls back to account balance.
-
-### UX
-
-- Merge Reasoning tokens into Output across sidebar, toast, and markdown report.
-- Sidebar quota windows now support indented multiline layout with compact reset time (`Rst HH:MM` / `Rst MM-DD`).
-- Toast now includes a dedicated `Cost as API` section with per-provider equivalent API cost.
-- Quota rendering now de-duplicates provider snapshots before output (prevents duplicate RightCode lines).
-- Remove `sidebar.maxQuotaProviders` config (unused in current design).
-
-### Bug Fixes
-
-- Invalidate stale RightCode cache entries that still use old non-daily window formats (auto-refetch on next render).
-
-### Bug Fixes (Critical)
-
-- H1: Fix `saveState` empty dirty keys triggering full writeAll on every save.
-- H2: Fix `persistState` dirty-key race condition — delete captured keys instead of clearing the whole set.
-- H3: Fix `pendingAppliedTitle` TTL corruption — detect decorated titles to prevent double-decoration; increase TTL to 15s.
-- H4: Fix `updateAuth` silently dropping token persistence — log and return error snapshot on failure.
-- H5: Add per-session concurrency lock for `applyTitle` to prevent conflicting concurrent updates.
-
-### Bug Fixes (Medium)
+Initial release.
 
-- M1: `refreshTimer` entries are now cleaned up when timers fire.
-- M2: Sessions older than `retentionDays` (default 730 days) are evicted from memory on startup.
-- M3: v1→v2 migration now recovers `createdAt` from v1 data when available.
-- M4: State and chunk file writes are now atomic (write to temp + rename).
-- M5: `flushSave` now flushes current dirty keys even when no timer is pending.
-- M6: `shortNumber` now handles negative, NaN, and Infinity values gracefully.
-- M7: `dateKeysInRange` is capped at 400 iterations to prevent runaway loops.
-- M8: Deduplicated `isRecord`/`asNumber`/`asBoolean` into shared `helpers.ts`.
-- M9: `scanSessionsByCreatedRange` now prefers in-memory state over disk reads.
-- M10: `summarizeRangeUsage` now fetches session messages in parallel (concurrency 5).
-- M11: `saveState` now only iterates sessions belonging to dirty date keys.
-- M12: Removed double timestamp normalization in `dateKeyFromTimestamp`.
-
-### Performance
-
-- P1: Incremental usage aggregation — tracks last processed message cursor per session.
-- P2: LRU chunk cache (64 entries) for loaded day chunks.
-- P3: `restoreAllVisibleTitles` limited to concurrency 5.
-- P4: `sessionDateMap` dirty tracking integrated with chunk-level dirty keys.
-
-### Security
-
-- S1: Replaced 15+ silent `.catch(() => undefined)` with debug-mode logging via `swallow()`.
-- S2: Added screen-sharing privacy warning to README.
-- S3: State file writes now refuse to follow symlinks.
-- S4: Renamed `OPENCODE_TEST_HOME` env var to `OPENCODE_QUOTA_DATA_HOME`.
-
-### Open-Source Prep
-
-- O1: Added `repository`, `homepage`, `bugs`, `author` to package.json; moved SDK deps to `peerDependencies`.
-- O2: Added `*.tsbuildinfo`, `.DS_Store`, `coverage/`, `.env` to `.gitignore`.
-- O3: README config example now includes `sidebar.enabled` and `retentionDays`.
-- O4: Added unit tests for helpers, storage, and usage modules.
-- O5: Main entry now exports consumer types (`QuotaSidebarConfig`, `QuotaSnapshot`, etc.).
-
-## 0.1.0
+### Features
 
-- Initial release.
+- Show token usage (Input/Output/Cache) in session sidebar title.
+- Show subscription quota for OpenAI Codex, GitHub Copilot, and RightCode.
+- `quota_summary` tool — usage report for session/day/week/month (markdown + toast).
+- `quota_show` tool — toggle sidebar title display on/off.
+- Provider adapter registry — add new quota providers without editing core code.
+- Incremental usage aggregation with per-session cursor.
+- Date-partitioned storage with LRU chunk cache.
+- API-equivalent cost display for subscription providers.
+- Atomic file writes with symlink refusal.

package/README.md

@@ -1,7 +1,12 @@
 # opencode-quota-sidebar
 
+[![npm version](https://img.shields.io/npm/v/@leo000001/opencode-quota-sidebar.svg)](https://www.npmjs.com/package/@leo000001/opencode-quota-sidebar)
+[![license](https://img.shields.io/npm/l/@leo000001/opencode-quota-sidebar.svg)](https://github.com/xihuai18/opencode-quota-sidebar/blob/main/LICENSE)
+
 OpenCode plugin: show token usage and subscription quota in the session sidebar title.
 
+![Example sidebar title with usage and quota](./assets/OpenCode-Quota-Sidebar.png)
+
 ## Install
 
 Add the package name to `plugin` in your `opencode.json`. OpenCode uses Bun to install it automatically on startup:
@@ -27,6 +32,8 @@ Add the built file to your `opencode.json`:
 }
 ```
 
+On Windows, use forward slashes: `"file:///D:/Lab/opencode-quota-sidebar/dist/index.js"`
+
 ## Supported quota providers
 
 | Provider       | Endpoint                               | Auth            | Status                                 |
@@ -63,7 +70,7 @@ Want to add support for another provider (Google Antigravity, Zhipu AI, Firmware
 - Incremental usage aggregation — only processes new messages since last cursor
 - Sidebar token units are adaptive (`k`/`m` with one decimal where applicable)
 
-## Storage layout (v2)
+## Storage layout
 
 The plugin stores lightweight global state and date-partitioned session chunks.
 
@@ -89,19 +96,9 @@ Example tree:
         24.json
 ```
 
-This replaces the old fixed-entry cap approach. `quota_summary` now scans date chunks
-for day/week/month ranges by session creation date.
-
 Sessions older than `retentionDays` (default 730 days / 2 years) are evicted from
 memory on startup. Chunk files remain on disk for historical range scans.
 
-## Migration from v1
-
-If an old `quota-sidebar.state.json` exists (`version: 1`), the plugin migrates it
-to `version: 2` automatically on load and then persists data in the new chunked layout.
-
-On Windows, use forward slashes: `"file:///D:/Lab/opencode-quota-sidebar/dist/index.js"`
-
 ## Compatibility
 
 - Node.js: >= 18 (for `fetch` + `AbortController`)
@@ -183,10 +180,6 @@ Set `OPENCODE_QUOTA_DEBUG=1` to enable debug logging to stderr. This logs:
 - Session eviction counts
 - Symlink write refusals
 
-## Independent repository
-
-This folder is initialized as its own git repository.
-
 ## Security & privacy notes
 
 - The plugin reads OpenCode credentials from `<opencode-data>/auth.json`.

package/dist/storage.js

@@ -3,7 +3,7 @@ import path from 'node:path';
 import { asBoolean, asNumber, debug, isRecord, swallow } from './helpers.js';
 import { discoverChunks, readDayChunk, safeWriteFile, writeDayChunk, } from './storage_chunks.js';
 import { dateKeyFromTimestamp, dateKeysInRange, dateStartFromKey, isDateKey, normalizeTimestampMs, } from './storage_dates.js';
-import { parseQuotaCache, parseSessionTitleForMigration, } from './storage_parse.js';
+import { parseQuotaCache } from './storage_parse.js';
 import { authFilePath, chunkRootPathFromStateFile, resolveOpencodeDataDir, stateFilePath, } from './storage_paths.js';
 export { authFilePath, dateKeyFromTimestamp, normalizeTimestampMs, resolveOpencodeDataDir, stateFilePath, };
 // ─── Default config ──────────────────────────────────────────────────────────
@@ -131,40 +131,6 @@ async function loadVersion2State(raw, statePath) {
         quotaCache,
     };
 }
-/**
- * M3 fix: use session.createdAt from v1 state if available,
- * otherwise fall back to Date.now() (unavoidable for truly missing data).
- */
-function migrateVersion1State(raw) {
-    const titleEnabled = asBoolean(raw.titleEnabled, true);
-    const quotaCache = parseQuotaCache(raw.quotaCache);
-    const sessionsRaw = isRecord(raw.sessions) ? raw.sessions : {};
-    const sessions = {};
-    const sessionDateMap = {};
-    for (const [sessionID, value] of Object.entries(sessionsRaw)) {
-        const title = parseSessionTitleForMigration(value);
-        if (!title)
-            continue;
-        // M3: try to recover createdAt from v1 data
-        const rawCreatedAt = isRecord(value) ? asNumber(value.createdAt) : undefined;
-        const createdAt = rawCreatedAt
-            ? normalizeTimestampMs(rawCreatedAt)
-            : Date.now();
-        const dateKey = dateKeyFromTimestamp(createdAt);
-        sessions[sessionID] = {
-            ...title,
-            createdAt,
-        };
-        sessionDateMap[sessionID] = dateKey;
-    }
-    return {
-        version: 2,
-        titleEnabled,
-        sessionDateMap,
-        sessions,
-        quotaCache,
-    };
-}
 export async function loadState(statePath) {
     const raw = await fs
         .readFile(statePath, 'utf8')
@@ -174,12 +140,6 @@ export async function loadState(statePath) {
         return defaultState();
     if (raw.version === 2)
         return loadVersion2State(raw, statePath);
-    if (raw.version === 1) {
-        const migrated = migrateVersion1State(raw);
-        // Persist immediately so chunk files exist for range scans.
-        await saveState(statePath, migrated, { writeAll: true }).catch(swallow('loadState:migrate'));
-        return migrated;
-    }
     return defaultState();
 }
 // ─── State saving ────────────────────────────────────────────────────────────

package/dist/storage_parse.d.ts

@@ -1,4 +1,3 @@
-import type { SessionState, SessionTitleState } from './types.js';
+import type { SessionState } from './types.js';
 export declare function parseSessionState(value: unknown): SessionState | undefined;
-export declare function parseSessionTitleForMigration(value: unknown): SessionTitleState | undefined;
 export declare function parseQuotaCache(value: unknown): Record<string, import("./types.js").QuotaSnapshot>;

package/dist/storage_parse.js

@@ -76,9 +76,6 @@ export function parseSessionState(value) {
         cursor: parseCursor(value.cursor),
     };
 }
-export function parseSessionTitleForMigration(value) {
-    return parseSessionTitleState(value);
-}
 export function parseQuotaCache(value) {
     const raw = isRecord(value) ? value : {};
     return Object.entries(raw).reduce((acc, [key, item]) => {

package/dist/title.js

@@ -28,9 +28,6 @@ export function looksDecorated(title) {
             return true;
         if (/^\$\S+\s+as API cost/.test(line))
             return true;
-        // Backward compatibility: old plugin versions had a separate Reasoning line.
-        if (/^Reasoning\s+\S+/.test(line))
-            return true;
         if (/^(OpenAI|Copilot|Anthropic|RightCode|RC)\b/.test(line))
             return true;
         return false;

package/dist/usage.d.ts

@@ -4,7 +4,7 @@ export type ProviderUsage = {
     providerID: string;
     input: number;
     output: number;
-    /** Legacy field kept for cache compatibility; display merges into output. */
+    /** Reasoning tokens (merged into output for display; persisted as 0). */
     reasoning: number;
     cacheRead: number;
     cacheWrite: number;
@@ -16,7 +16,7 @@ export type ProviderUsage = {
 export type UsageSummary = {
     input: number;
     output: number;
-    /** Legacy field kept for cache compatibility; display merges into output. */
+    /** Reasoning tokens (merged into output for display; persisted as 0). */
     reasoning: number;
     cacheRead: number;
     cacheWrite: number;

package/dist/usage.js

@@ -185,7 +185,7 @@ export function toCachedSessionUsage(summary) {
         acc[providerID] = {
             input: provider.input,
             output: provider.output,
-            // Legacy persisted field for backward compatibility with old chunks.
+            // Always 0 after merge into output; kept for serialization shape.
             reasoning: provider.reasoning,
             cacheRead: provider.cacheRead,
             cacheWrite: provider.cacheWrite,
@@ -199,7 +199,7 @@ export function toCachedSessionUsage(summary) {
     return {
         input: summary.input,
         output: summary.output,
-        // Legacy persisted field for backward compatibility with old chunks.
+        // Always 0 after merge into output; kept for serialization shape.
         reasoning: summary.reasoning,
         cacheRead: summary.cacheRead,
         cacheWrite: summary.cacheWrite,
@@ -211,7 +211,7 @@ export function toCachedSessionUsage(summary) {
     };
 }
 export function fromCachedSessionUsage(cached, sessionCount = 1) {
-    // Merge legacy cached reasoning into output for a single output metric.
+    // Merge cached reasoning into output for a single output metric.
     const mergedOutputValue = cached.output + cached.reasoning;
     return {
         input: cached.input,

package/package.json

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