pi-spark 0.4.0 → 0.5.1

package/README.md

@@ -6,6 +6,7 @@ A small, opinionated collection of [pi](https://pi.dev/) extensions.
 
 ## Extensions
 
+- **Codex usage:** shows your OpenAI Codex (ChatGPT) rate-limit usage as a footer status when a Codex model is active.
 - **Editor:** replaces the default editor with a compact working indicator (inspired by [Amp](https://ampcode.com/)) and current model info.
 - **Footer:** shows session information, extension statuses, cost, and context usage on one line.
 - **Fullscreen:** clears the screen and scrollback on session start, pins the editor and footer to the bottom for a full-screen session, and clears again on exit.
@@ -64,6 +65,10 @@ Example:
 }
 ```
 
+### Codex usage
+
+- pi-spark queries the ChatGPT backend and shows your Codex 5-hour (`5h`) and 7-day (`7d`) rate-limit usage as a footer status, refreshing on session start, model change, and after billable turns. The status appears only while a Codex (`openai-codex`) model is active and uses its stored OAuth credential.
+
 ### Editor
 
 - `editor.spinner` controls the working indicator style and can be `dots`, `lights`, or `tildes`.

package/extensions/codex-usage/client.ts

@@ -0,0 +1,69 @@
+import type { ExtensionContext } from "@earendil-works/pi-coding-agent";
+
+export const CODEX_PROVIDER = "openai-codex";
+const USAGE_URL = "https://chatgpt.com/backend-api/wham/usage";
+const REQUEST_TIMEOUT_MS = 30_000;
+
+/** Normalized Codex usage with rate-limit windows reduced to used percentages. */
+export interface CodexUsage {
+  unlimited: boolean;
+  /** Used percentage of the 5-hour window, clamped to 0-100. */
+  primaryPercent: number | undefined;
+  /** Used percentage of the 7-day window, clamped to 0-100. */
+  secondaryPercent: number | undefined;
+}
+
+interface CodexUsageResponse {
+  rate_limit?: {
+    primary_window?: CodexRateWindow | null;
+    secondary_window?: CodexRateWindow | null;
+  } | null;
+  credits?: {
+    unlimited?: boolean;
+  } | null;
+}
+
+interface CodexRateWindow {
+  used_percent?: number | string;
+}
+
+/** Read the ChatGPT account id from the stored Codex OAuth credential, if present. */
+export function readAccountId(ctx: ExtensionContext): string | undefined {
+  const credential = ctx.modelRegistry.authStorage.get(CODEX_PROVIDER) as { accountId?: string } | undefined;
+  const accountId = credential?.accountId;
+
+  return typeof accountId === "string" && accountId.trim() ? accountId.trim() : undefined;
+}
+
+/** Fetch and normalize Codex usage, aborting on timeout or when the parent signal aborts. */
+export async function fetchCodexUsage(token: string, accountId?: string, parentSignal?: AbortSignal): Promise<CodexUsage> {
+  const signals = [AbortSignal.timeout(REQUEST_TIMEOUT_MS)];
+  if (parentSignal) signals.push(parentSignal);
+
+  const headers: Record<string, string> = {
+    Accept: "application/json",
+    Authorization: `Bearer ${token}`,
+  };
+  if (accountId) headers["ChatGPT-Account-Id"] = accountId;
+
+  const response = await fetch(USAGE_URL, { method: "GET", headers, signal: AbortSignal.any(signals) });
+  if (!response.ok) throw new Error("request failed");
+
+  return normalizeUsage((await response.json()) as CodexUsageResponse);
+}
+
+function normalizeUsage(payload: CodexUsageResponse): CodexUsage {
+  return {
+    unlimited: payload.credits?.unlimited === true,
+    primaryPercent: parseUsedPercent(payload.rate_limit?.primary_window),
+    secondaryPercent: parseUsedPercent(payload.rate_limit?.secondary_window),
+  };
+}
+
+function parseUsedPercent(window: CodexRateWindow | null | undefined): number | undefined {
+  const raw = window?.used_percent;
+  if (raw === undefined || raw === null) return undefined;
+
+  const value = typeof raw === "number" ? raw : Number(raw);
+  return Number.isFinite(value) ? Math.min(100, Math.max(0, value)) : undefined;
+}

package/extensions/codex-usage/config.ts

@@ -0,0 +1,5 @@
+import * as z from "zod";
+
+export const codexUsageConfigSchema = z.object({});
+
+export type CodexUsageConfig = z.infer<typeof codexUsageConfigSchema>;

package/extensions/codex-usage/index.ts

@@ -0,0 +1,43 @@
+import { CodexUsageManager } from "./manager";
+import { loadConfig } from "../shared/config";
+import { isUsage } from "../shared/usage";
+
+import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
+import type { AgentMessage } from "@earendil-works/pi-agent-core";
+
+function hasCostedUsage(messages: AgentMessage[]): boolean {
+  return messages.some((message) => {
+    const usage = (message as { usage?: unknown }).usage;
+    if (!isUsage(usage)) return false;
+
+    return usage.cost.total > 0 || usage.input > 0 || usage.output > 0;
+  });
+}
+
+export default function (pi: ExtensionAPI) {
+  let codexUsageManager: CodexUsageManager | undefined = undefined;
+
+  pi.on("session_start", (_event, ctx) => {
+    if (!ctx.hasUI) return;
+
+    const config = loadConfig(ctx, "codexUsage");
+    if (!config) return;
+
+    codexUsageManager = new CodexUsageManager();
+    codexUsageManager.refresh(ctx);
+  });
+
+  pi.on("model_select", (_event, ctx) => {
+    codexUsageManager?.refresh(ctx);
+  });
+
+  pi.on("agent_end", (event, ctx) => {
+    if (!hasCostedUsage(event.messages)) return;
+
+    codexUsageManager?.refresh(ctx);
+  });
+
+  pi.on("session_shutdown", () => {
+    codexUsageManager = undefined;
+  });
+}

package/extensions/codex-usage/manager.ts

@@ -0,0 +1,47 @@
+import { CODEX_PROVIDER, fetchCodexUsage, readAccountId } from "./client";
+import { renderError, renderUsage } from "./status";
+
+import type { ExtensionContext } from "@earendil-works/pi-coding-agent";
+
+const STATUS_KEY = "codex-usage";
+
+export class CodexUsageManager {
+  private inflight: Promise<void> | undefined = undefined;
+
+  async refresh(ctx: ExtensionContext): Promise<void> {
+    if (!this.isCodexContext(ctx)) {
+      ctx.ui.setStatus(STATUS_KEY, undefined);
+      return;
+    }
+
+    if (this.inflight) return this.inflight;
+
+    this.inflight = this.fetch(ctx).finally(() => {
+      this.inflight = undefined;
+    });
+
+    return this.inflight;
+  }
+
+  private async fetch(ctx: ExtensionContext): Promise<void> {
+    try {
+      const token = await ctx.modelRegistry.getApiKeyForProvider(CODEX_PROVIDER);
+      if (!token) {
+        ctx.ui.setStatus(STATUS_KEY, undefined);
+        return;
+      }
+
+      const usage = await fetchCodexUsage(token, readAccountId(ctx), ctx.signal);
+      if (!this.isCodexContext(ctx)) return;
+
+      ctx.ui.setStatus(STATUS_KEY, renderUsage(ctx.ui.theme, usage));
+    } catch (error) {
+      const message = error instanceof Error ? error.message : String(error);
+      ctx.ui.setStatus(STATUS_KEY, renderError(ctx.ui.theme, message));
+    }
+  }
+
+  private isCodexContext(ctx: ExtensionContext): boolean {
+    return ctx.model?.provider === CODEX_PROVIDER;
+  }
+}

package/extensions/codex-usage/status.ts

@@ -0,0 +1,31 @@
+import type { Theme } from "@earendil-works/pi-coding-agent";
+
+import type { CodexUsage } from "./client";
+
+const LABEL = "Codex";
+
+/** Render a footer status string for normalized Codex usage. */
+export function renderUsage(theme: Theme, usage: CodexUsage): string {
+  const label = theme.fg("dim", LABEL);
+
+  if (usage.unlimited || (usage.primaryPercent === undefined && usage.secondaryPercent === undefined)) {
+    return `${label} ${theme.fg("success", "unlimited")}`;
+  }
+
+  const fiveHour = renderLane(theme, "5h", usage.primaryPercent);
+  const sevenDay = renderLane(theme, "7d", usage.secondaryPercent);
+  return `${label} ${fiveHour} ${sevenDay}`;
+}
+
+/** Render a footer status string for a usage fetch error. */
+export function renderError(theme: Theme, message: string): string {
+  return theme.fg("error", `${LABEL} usage unavailable: ${message}`);
+}
+
+function renderLane(theme: Theme, label: string, percent: number | undefined): string {
+  const text = `${label} ${percent === undefined ? "?" : percent.toFixed(1)}%`;
+
+  if (percent && percent > 90) return theme.fg("error", text);
+  if (percent && percent > 70) return theme.fg("warning", text);
+  return theme.fg("dim", text);
+}

package/extensions/footer/index.ts

@@ -35,15 +35,11 @@ class FooterComponent implements Component {
   private getLeft(): string {
     const cwd = this.ctx.sessionManager.getCwd();
     const url = pathToFileURL(resolve(cwd));
-    let text = linkText(formatCwd(cwd, homedir()), url.href);
-
+    const cwdText = linkText(formatCwd(cwd, homedir()), url.href);
     const branch = this.footerData.getGitBranch();
-    if (branch) text = `${text} [${branch}]`;
-
     const sessionName = this.ctx.sessionManager.getSessionName();
-    if (sessionName) text = `${text} • ${sessionName}`;
 
-    return this.theme.fg("dim", text);
+    return this.theme.fg("dim", [cwdText, branch, sessionName].filter(Boolean).join(" • "));
   }
 
   private getRight(): string {

package/extensions/shared/config/schema.ts

@@ -1,5 +1,6 @@
 import * as z from "zod";
 
+import { codexUsageConfigSchema } from "../../codex-usage/config";
 import { editorConfigSchema } from "../../editor/config";
 import { footerConfigSchema } from "../../footer/config";
 import { fullscreenConfigSchema } from "../../fullscreen/config";
@@ -8,6 +9,7 @@ import { recapConfigSchema } from "../../recap/config";
 import { setSessionNameConfigSchema } from "../../set-session-name/config";
 
 export const configSchemas = {
+  codexUsage: codexUsageConfigSchema,
   editor: editorConfigSchema,
   footer: footerConfigSchema,
   fullscreen: fullscreenConfigSchema,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-spark",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "description": "A small, opinionated collection of pi extensions",
   "keywords": [
     "pi-coding-agent",