@bacnh85/pi-sub 0.1.13 → 0.1.15

package/README.md

@@ -2,7 +2,7 @@
 
 Pi extension that shows subscription usage for the currently selected supported model provider.
 
-Supports OpenAI Codex (`openai-codex`) with live usage windows from ChatGPT's usage endpoint, OpenCode Go (`opencode-go`) with session cost tracking, and Z.ai (`zai`) with GLM Coding Plan quota monitoring. Displays a subscription footer status after Pi's built-in status/token usage line.
+Supports OpenAI Codex (`openai-codex`) with live usage windows from ChatGPT's usage endpoint, OpenCode Go (`opencode-go`) with session cost tracking, and Z.ai GLM Coding Plan — both the international (`zai`) and China (`zai-coding-cn`, `open.bigmodel.cn`) endpoints — with quota monitoring. Displays a subscription footer status after Pi's built-in status/token usage line.
 
 ## Install
 
@@ -53,6 +53,14 @@ Z.ai (GLM Coding Plan) shows the active account/key label, 5-hour rolling and we
 (Z.ai key#1a2b3c4d) R:55%/2H W:80%/3D 42 tok/s
 ```
 
+### Z.ai Coding Plan (China)
+
+The built-in `zai-coding-cn` provider targets the domestic BigModel endpoint (`open.bigmodel.cn`) and returns the same GLM Coding Plan quota format as the international `zai` provider, so the footer and `/sub` detail behave identically, distinguished only by the `Z.ai (CN)` label:
+
+```text
+(Z.ai (CN) key#1a2b3c4d) R:55%/2H W:80%/3D 42 tok/s
+```
+
 ### Tokens per second
 
 `pi-sub` tracks each response's tokens-per-second (tok/s) speed by measuring the time from provider request to message completion against the response's output token count. The last response's speed is shown in the footer next to usage data. The `/sub` detail view shows both the last response speed and the session-wide average.
@@ -104,6 +112,8 @@ Last response: 42 tok/s · Session avg: 39 tok/s
 * Z.ai key#1a2b3c4d  Pro   55%/2H        80%/3D            Now
 ```
 
+For Z.ai Coding Plan (China), the `/sub` detail is the same with a `Z.ai (CN)` provider/account label:
+
 ## Refresh behavior
 
 `pi-sub` refreshes usage data:
@@ -123,9 +133,10 @@ Refreshes are cached briefly to avoid excessive usage endpoint calls.
 - **OpenAI Codex**: Pi auth must contain an `openai-codex` OAuth entry in `~/.pi/agent/auth.json` or `$PI_CODING_AGENT_DIR/auth.json`. The entry must include `access` and `accountId` fields.
 - **OpenCode Go**: Pi auth must contain an `opencode-go` API key entry (via `/login` or env var). The entry must have a `key` field or an `accountId` field. OpenCode Go/Zen usage windows and Zen balance are not shown because no public API is currently documented for those values.
 - **Z.ai**: Pi auth must contain a `zai` entry in `auth.json` with a `key` field (the same API key used for Z.ai model access via `@czottmann/pi-zai-api`). The Z.ai provider must be registered (e.g., `pi install npm:@czottmann/pi-zai-api`).
+- **Z.ai Coding Plan (China)**: The built-in `zai-coding-cn` provider targets `https://open.bigmodel.cn/api/coding/paas/v4`. Pi auth must contain a `zai-coding-cn` entry with a `key` field (set via `/login` or the `ZAI_CODING_CN_API_KEY` env var). Quota is read from the BigModel endpoint `https://open.bigmodel.cn/api/monitor/usage/quota/limit`.
 - For API-key-only providers, account labels come from stored auth metadata (`email`, `label`, `name`, or `accountId`) when available; otherwise `pi-sub` displays a non-secret SHA-256 key fingerprint such as `Z.ai key#1a2b3c4d`.
 - `pi-sub` redacts auth/token-related errors and never prints credentials.
 
 ## Design notes
 
-The extension is named `pi-sub` rather than `pi-codex-usage` so future subscription providers can be added as separate adapters. Supports OpenAI Codex (live usage API) and OpenCode Go (session cost only).
+The extension is named `pi-sub` rather than `pi-codex-usage` so future subscription providers can be added as separate adapters. Supports OpenAI Codex (live usage API), OpenCode Go (session cost only), and the Z.ai GLM Coding Plan (international `zai` and China `zai-coding-cn`, which share a quota response format and are served by one parameterized adapter).

package/extensions/index.ts

@@ -1,6 +1,5 @@
-import type { ExtensionAPI, ExtensionContext } from "@earendil-works/pi-coding-agent";
+import { readStoredCredential, type ExtensionAPI, type ExtensionContext } from "@earendil-works/pi-coding-agent";
 import { createHash } from "node:crypto";
-import fs from "node:fs/promises";
 import os from "node:os";
 import path from "node:path";
 
@@ -14,6 +13,8 @@ const CODEX_PROVIDER = "openai-codex";
 const OPC_PROVIDER = "opencode-go";
 const ZAI_PROVIDER = "zai";
 const ZAI_USAGE_URL = "https://api.z.ai/api/monitor/usage/quota/limit";
+const ZAI_CODING_CN_PROVIDER = "zai-coding-cn";
+const ZAI_CODING_CN_USAGE_URL = "https://open.bigmodel.cn/api/monitor/usage/quota/limit";
 
 type ModelLike = { provider?: string; id?: string } | undefined;
 
@@ -28,8 +29,6 @@ type UsageApiSnapshot = {
 	plan_type?: string;
 };
 
-type PiAuthFile = Record<string, PiAuthEntry | undefined>;
-
 type PiAuthEntry = {
 	type?: string;
 	access?: string;
@@ -104,15 +103,15 @@ function isZaiModel(model: ModelLike): boolean {
 	return (model?.provider?.toLowerCase() ?? "") === ZAI_PROVIDER;
 }
 
+function isZaiCodingCnModel(model: ModelLike): boolean {
+	return (model?.provider?.toLowerCase() ?? "") === ZAI_CODING_CN_PROVIDER;
+}
+
 function piAuthPath(): string {
 	const configDir = process.env.PI_CODING_AGENT_DIR?.trim() || path.join(os.homedir(), ".pi", "agent");
 	return path.join(configDir, "auth.json");
 }
 
-async function readJsonFile<T>(file: string): Promise<T> {
-	return JSON.parse(await fs.readFile(file, "utf8")) as T;
-}
-
 function decodeJwtPayload(token: string | undefined): Record<string, any> | undefined {
 	if (!token) return undefined;
 	const parts = token.split(".");
@@ -274,25 +273,22 @@ function parseUsageResponse(body: unknown): UsageApiSnapshot | undefined {
 }
 
 async function readPiCodexAuth(): Promise<PiAuthEntry & { accountId: string }> {
-	const auth = await readJsonFile<PiAuthFile>(piAuthPath());
-	const entry = auth[CODEX_PROVIDER];
+	const entry = readStoredCredential(CODEX_PROVIDER, piAuthPath()) as PiAuthEntry | undefined;
 	const accountId = getCodexAccountId(entry);
 	if (!entry?.access || !accountId) throw new Error("Missing openai-codex OAuth entry in Pi auth");
 	return { ...entry, accountId };
 }
 
 async function readOpenCodeGoAuth(): Promise<SubscriptionAccountSnapshot> {
-	const auth = await readJsonFile<PiAuthFile>(piAuthPath());
-	const entry = auth[OPC_PROVIDER];
+	const entry = readStoredCredential(OPC_PROVIDER, piAuthPath()) as PiAuthEntry | undefined;
 	if (!entry?.key && !entry?.accountId) throw new Error("Missing opencode-go API key or accountId in Pi auth");
 	return authAccountSnapshot("OpenCode Go", entry, { plan: "Go" });
 }
 
-async function readZaiAuth(): Promise<{ key: string; account: SubscriptionAccountSnapshot }> {
-	const auth = await readJsonFile<PiAuthFile>(piAuthPath());
-	const entry = auth[ZAI_PROVIDER];
-	if (!entry?.key) throw new Error("Missing zai API key in Pi auth");
-	return { key: entry.key, account: authAccountSnapshot("Z.ai", entry) };
+async function readZaiAuth(providerId: string, label: string): Promise<{ key: string; account: SubscriptionAccountSnapshot }> {
+	const entry = readStoredCredential(providerId, piAuthPath()) as PiAuthEntry | undefined;
+	if (!entry?.key) throw new Error(`Missing ${providerId} API key in Pi auth`);
+	return { key: entry.key, account: authAccountSnapshot(label, entry) };
 }
 
 async function fetchUsageFromPiAuth(entry: PiAuthEntry, signal?: AbortSignal): Promise<UsageApiSnapshot | undefined> {
@@ -382,6 +378,7 @@ interface ZaiUsageApiResponse {
 		plan?: string;
 		plan_type?: string;
 		packageName?: string;
+		level?: string;
 	};
 }
 
@@ -409,75 +406,81 @@ function zaiLimitToUsageWindow(limit: ZaiLimitEntry): UsageWindow | undefined {
 
 function zaiPlanLabel(response: ZaiUsageApiResponse): string | undefined {
 	const data = response.data;
-	return planLabel(firstString(data?.planName, data?.plan, data?.plan_type, data?.packageName));
-}
+	return planLabel(firstString(data?.planName, data?.plan, data?.plan_type, data?.packageName, data?.level));
+}
+
+// Factory: the international `zai` and China `zai-coding-cn` endpoints share an
+// identical quota response; only the provider id, host, and label differ.
+function zaiUsageAdapter(providerId: string, usageUrl: string, displayName: string): { fetchUsage(signal?: AbortSignal): Promise<SubscriptionUsageSnapshot> } {
+	async function fetchUsage(signal?: AbortSignal): Promise<SubscriptionUsageSnapshot> {
+		try {
+			const { key: apiKey, account: authAccount } = await readZaiAuth(providerId, displayName);
+			const timeoutSignal = AbortSignal.timeout(7_000);
+			const combinedSignal = signal ? AbortSignal.any([signal, timeoutSignal]) : timeoutSignal;
+
+			const response = await fetch(usageUrl, {
+				headers: {
+					Accept: "application/json",
+					Authorization: `Bearer ${apiKey}`,
+					"User-Agent": "pi-sub/0.1.0",
+				},
+				signal: combinedSignal,
+			});
+
+			const body = await response.json();
+
+			// Z.ai / BigModel return HTTP 200 even on auth errors: {"code":401,"msg":"...","success":false}
+			// Also handle missing success field, empty msg, or presence of code.
+			const apiError = body as ZaiUsageApiError;
+			if (apiError.code >= 400 || (typeof apiError.success === "boolean" && !apiError.success) || (apiError.msg && apiError.msg.length > 0 && apiError.success === undefined)) {
+				const message = apiError.msg || `HTTP status ${apiError.code}`;
+				throw new Error(`${displayName} API error: ${message}`);
+			}
 
-async function fetchZaiUsage(signal?: AbortSignal): Promise<SubscriptionUsageSnapshot> {
-	try {
-		const { key: apiKey, account: authAccount } = await readZaiAuth();
-		const timeoutSignal = AbortSignal.timeout(7_000);
-		const combinedSignal = signal ? AbortSignal.any([signal, timeoutSignal]) : timeoutSignal;
-
-		const response = await fetch(ZAI_USAGE_URL, {
-			headers: {
-				Accept: "application/json",
-				Authorization: `Bearer ${apiKey}`,
-				"User-Agent": "pi-sub/0.1.0",
-			},
-			signal: combinedSignal,
-		});
-
-		const body = await response.json();
-
-		// Z.ai returns HTTP 200 even on auth errors: {"code":401,"msg":"...","success":false}
-		// Also handle missing success field, empty msg, or presence of code.
-		const apiError = body as ZaiUsageApiError;
-		if (apiError.code >= 400 || (typeof apiError.success === "boolean" && !apiError.success) || (apiError.msg && apiError.msg.length > 0 && apiError.success === undefined)) {
-			const message = apiError.msg || `HTTP status ${apiError.code}`;
-			throw new Error(`Z.ai API error: ${message}`);
-		}
+			const parsed = body as ZaiUsageApiResponse;
+			const tokenLimits = (parsed.data?.limits ?? [])
+				.filter((l) => l.type === "TOKENS_LIMIT")
+				.sort((a, b) => (a.nextResetTime ?? 0) - (b.nextResetTime ?? 0));
 
-		const parsed = body as ZaiUsageApiResponse;
-		const tokenLimits = (parsed.data?.limits ?? [])
-			.filter((l) => l.type === "TOKENS_LIMIT")
-			.sort((a, b) => (a.nextResetTime ?? 0) - (b.nextResetTime ?? 0));
+			if (tokenLimits.length === 0) {
+				throw new Error(`No TOKENS_LIMIT entries in ${displayName} usage response`);
+			}
 
-		if (tokenLimits.length === 0) {
-			throw new Error("No TOKENS_LIMIT entries in Z.ai usage response");
+			// The limit with the nearest reset is the 5-hour rolling window;
+			// the next one (if present) is the weekly window.
+			const fiveHour = zaiLimitToUsageWindow(tokenLimits[0]);
+			const weekly = tokenLimits.length >= 2 ? zaiLimitToUsageWindow(tokenLimits[1]) : undefined;
+
+			const account: SubscriptionAccountSnapshot = {
+				...authAccount,
+				plan: zaiPlanLabel(parsed) ?? authAccount.plan,
+				fiveHour,
+				weekly,
+			};
+
+			return {
+				providerDisplayName: displayName,
+				accounts: [account],
+				activeAccount: account,
+				fetchedAt: Date.now(),
+			};
+		} catch (error) {
+			return {
+				providerDisplayName: displayName,
+				accounts: [],
+				fetchedAt: Date.now(),
+				error: redactedError(error, displayName),
+			};
 		}
-
-		// The limit with the nearest reset is the 5-hour rolling window;
-		// the next one (if present) is the weekly window.
-		const fiveHour = zaiLimitToUsageWindow(tokenLimits[0]);
-		const weekly = tokenLimits.length >= 2 ? zaiLimitToUsageWindow(tokenLimits[1]) : undefined;
-
-		const account: SubscriptionAccountSnapshot = {
-			...authAccount,
-			plan: zaiPlanLabel(parsed) ?? authAccount.plan,
-			fiveHour,
-			weekly,
-		};
-
-		return {
-			providerDisplayName: "Z.ai",
-			accounts: [account],
-			activeAccount: account,
-			fetchedAt: Date.now(),
-		};
-	} catch (error) {
-		return {
-			providerDisplayName: "Z.ai",
-			accounts: [],
-			fetchedAt: Date.now(),
-			error: redactedError(error, "Z.ai"),
-		};
 	}
+	return { fetchUsage };
 }
 
 function supportedAdapter(model: ModelLike): SubscriptionProviderAdapter | undefined {
 	if (isCodexModel(model)) return { id: CODEX_PROVIDER, displayName: "Codex", fetchUsage: fetchCodexUsage };
 	if (isOpenCodeGoModel(model)) return { id: OPC_PROVIDER, displayName: "OpenCode Go", fetchUsage: fetchOpenCodeGoUsage };
-	if (isZaiModel(model)) return { id: ZAI_PROVIDER, displayName: "Z.ai", fetchUsage: fetchZaiUsage };
+	if (isZaiModel(model)) return { id: ZAI_PROVIDER, displayName: "Z.ai", ...zaiUsageAdapter(ZAI_PROVIDER, ZAI_USAGE_URL, "Z.ai") };
+	if (isZaiCodingCnModel(model)) return { id: ZAI_CODING_CN_PROVIDER, displayName: "Z.ai (CN)", ...zaiUsageAdapter(ZAI_CODING_CN_PROVIDER, ZAI_CODING_CN_USAGE_URL, "Z.ai (CN)") };
 	return undefined;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bacnh85/pi-sub",
-  "version": "0.1.13",
+  "version": "0.1.15",
   "description": "Pi extension showing subscription usage for supported model providers.",
   "type": "module",
   "license": "MIT",
@@ -38,6 +38,6 @@
     "node": ">=20.3.0"
   },
   "peerDependencies": {
-    "@earendil-works/pi-coding-agent": "*"
+    "@earendil-works/pi-coding-agent": ">=0.80.8 <0.81.0"
   }
 }