@narumitw/pi-usage 0.52.3 → 0.53.0

package/README.md

@@ -154,6 +154,20 @@ OpenRouter documents the distinction between credit and rate limits in its [API
 
 The fixed endpoint is queried only when the candidate OpenCode Go model and the resolved provider-auth base URL, when present, use the official `https://opencode.ai` origin; other origins fail before sending the credential.
 
+### Z.AI (GLM Coding Plan)
+
+- Provider ID: `zai` and `zai-coding-cn`
+- Semantics: GLM Coding Plan quota windows—the rolling 5-hour and weekly plan-usage windows plus the monthly MCP allowance
+- Source: Z.AI's undocumented `GET {origin}/api/monitor/usage/quota/limit` endpoint, also used by its official coding plugin, with the origin derived from the model base URL (`https://api.z.ai` or `https://open.bigmodel.cn`)
+- Displayed data: explicit used and remaining values, reset times, provider-reported per-tool MCP details, and the reported plan level. Windows that report only a percentage remain percent-based
+- Statusline: not published; Z.AI is queried only through `/usage` actions
+
+The monitor endpoint is not a published API contract and may return legacy `TOKENS_LIMIT` or newer `CREDIT_LIMIT` window names.
+The extension classifies both forms by the provider's window unit and does not label provider-reported counts as tokens or calls.
+The quota monitor expects the raw API key without a `Bearer` prefix, so the extension strips a `Bearer` prefix from the resolved authorization before sending it to the monitor endpoint.
+Fingerprinting and redaction keep using the original resolved credential.
+Only the official `api.z.ai` and `open.bigmodel.cn` origins are queried; other origins fail before sending the credential.
+
 ## 🧭 Current and configured accounts
 
 `Current` means the provider and credential used by Pi's selected model.
@@ -168,8 +182,8 @@ After the active runtime credential changes, the next command, turn, or schedule
 
 ## 📊 Statusline behavior
 
-The `usage` status item is active only for the selected model provider.
-It refreshes every five minutes while the session remains on a supported provider and is cleared when the model changes to an unsupported provider.
+The `usage` status item is active only for selected providers that publish statusline usage.
+It refreshes every five minutes while the session remains on such a provider and is cleared when the model changes to an unsupported or menu-only provider.
 
 Manual another-provider and all-provider queries never publish to the statusline.
 `@narumitw/pi-statusline` supplies the default `📊` icon; `pi-usage` publishes text-only values.
@@ -205,7 +219,7 @@ Protocol v1 interoperability is characterized for the repository's supported Pi
 ## 🚧 Limitations
 
 - Only providers with a meaningful usage source and verifiable Pi runtime auth are supported.
-- GitHub Copilot quota and OpenAI Codex reset redemption use undocumented provider endpoints that may change without notice.
+- GitHub Copilot quota, Z.AI quota, and OpenAI Codex reset redemption use undocumented provider endpoints that may change without notice.
 - Codex reset redemption requires a current ChatGPT OAuth credential from Pi's login or a compatible credential source; Codex API keys cannot redeem earned subscription resets.
 - Credentials resolved for custom provider base URLs are never forwarded to the providers' official usage endpoints; effective auth origin validation requires Pi 0.81.0 or newer.
 - Provider reports are snapshots and may themselves be delayed by the provider.
@@ -235,7 +249,7 @@ packages/pi-usage/
 │   ├── codex-resets.ts # Codex reset auth, API contracts, and normalization
 │   ├── format.ts      # Provider-aware notifications and statusline text
 │   ├── core.ts        # Cache, concurrency, fingerprint, and redaction helpers
-│   ├── providers/     # Codex, GitHub Copilot, and OpenRouter normalization adapters
+│   ├── providers/     # Provider-specific usage normalization adapters
 │   └── types.ts       # Common presentation and adapter contracts
 ├── test/
 ├── README.md

package/dist/index.ts

@@ -682,6 +682,120 @@ function asNonnegativeNumber3(value) {
   return value;
 }
 
+// src/providers/zai.ts
+var FIVE_HOUR_WINDOW_MINUTES = 300;
+var WEEKLY_WINDOW_MINUTES = 10080;
+function normalizeZaiQuotaPayload(providerId, providerName, payload, capturedAt) {
+  const data = asObject5(payload.data);
+  if (!data) throw new Error("Z.AI quota response data was not an object.");
+  const limits = Array.isArray(data.limits) ? data.limits : [];
+  const buckets = [];
+  const metrics = [];
+  for (const raw of limits) {
+    const limit = asObject5(raw);
+    if (!limit) continue;
+    const type = asString5(limit.type);
+    const unit = asNonnegativeNumber4(limit.unit);
+    const isPlanUsage = type === "TOKENS_LIMIT" || type === "CREDIT_LIMIT";
+    if (type === "TIME_LIMIT") {
+      addCountBucket(buckets, limit, "mcp-monthly", "MCP monthly allowance");
+      addUsageDetailMetrics(metrics, limit.usageDetails);
+    } else if (isPlanUsage && unit === 3) {
+      addPercentBucket(buckets, limit, "five-hour", "5h window", FIVE_HOUR_WINDOW_MINUTES);
+    } else if (isPlanUsage && unit === 6) {
+      const used = asNonnegativeNumber4(limit.currentValue);
+      const quota = asNonnegativeNumber4(limit.usage);
+      if (used !== void 0 && quota !== void 0) {
+        addCountBucket(buckets, limit, "weekly", "Weekly window", WEEKLY_WINDOW_MINUTES);
+      } else {
+        addPercentBucket(buckets, limit, "weekly", "Weekly window", WEEKLY_WINDOW_MINUTES);
+      }
+    }
+  }
+  if (buckets.length === 0) {
+    throw new Error("Z.AI quota endpoint returned no displayable usage data.");
+  }
+  const notes = [];
+  const level = asString5(data.level);
+  if (level) notes.push(`Plan: ${level}`);
+  return {
+    providerId,
+    providerName,
+    capturedAt,
+    source: "zai-quota",
+    semantics: { kind: "consumer-subscription", label: "GLM Coding Plan usage" },
+    buckets,
+    metrics,
+    ...notes.length > 0 ? { notes } : {}
+  };
+}
+function addPercentBucket(buckets, limit, id, label, windowMinutes) {
+  const used = asNonnegativeNumber4(limit.percentage);
+  if (used === void 0) return;
+  const percent = clampPercent3(used);
+  const resetsAt = asEpochSeconds2(limit.nextResetTime);
+  buckets.push({
+    id,
+    label,
+    used: percent,
+    remaining: 100 - percent,
+    limit: 100,
+    unit: "percent",
+    windowMinutes,
+    ...resetsAt !== void 0 ? { resetsAt } : {}
+  });
+}
+function addCountBucket(buckets, limit, id, label, windowMinutes) {
+  const used = asNonnegativeNumber4(limit.currentValue);
+  const quota = asNonnegativeNumber4(limit.usage);
+  if (used === void 0 || quota === void 0) return;
+  const resetsAt = asEpochSeconds2(limit.nextResetTime);
+  buckets.push({
+    id,
+    label,
+    used,
+    remaining: Math.max(0, quota - used),
+    limit: quota,
+    unit: "count",
+    ...windowMinutes !== void 0 ? { windowMinutes } : {},
+    ...resetsAt !== void 0 ? { resetsAt } : {}
+  });
+}
+function addUsageDetailMetrics(metrics, value) {
+  if (!Array.isArray(value)) return;
+  for (const raw of value) {
+    const detail = asObject5(raw);
+    if (!detail) continue;
+    const label = asString5(detail.modelCode);
+    const usage = asNonnegativeNumber4(detail.usage);
+    if (!label || usage === void 0) continue;
+    metrics.push({ id: `mcp-${kebabCase(label)}`, label, value: usage, unit: "count" });
+  }
+}
+function asObject5(value) {
+  if (!value || typeof value !== "object" || Array.isArray(value)) return void 0;
+  return value;
+}
+function asString5(value) {
+  if (typeof value !== "string") return void 0;
+  return sanitizeDisplayText(value, 80) || void 0;
+}
+function asNonnegativeNumber4(value) {
+  if (typeof value !== "number" || !Number.isFinite(value) || value < 0) return void 0;
+  return value;
+}
+function asEpochSeconds2(value) {
+  const millis = asNonnegativeNumber4(value);
+  if (millis === void 0) return void 0;
+  return Math.floor(millis / 1e3);
+}
+function kebabCase(label) {
+  return label.toLowerCase().replace(/[^a-z0-9]+/gu, "-").replace(/^-+|-+$/gu, "") || "tool";
+}
+function clampPercent3(value) {
+  return Math.min(100, Math.max(0, value));
+}
+
 // src/query.ts
 var CODEX_USAGE_URL = "https://chatgpt.com/backend-api/wham/usage";
 var GITHUB_COPILOT_USAGE_URL = "https://api.github.com/copilot_internal/user";
@@ -756,6 +870,43 @@ var SUPPORTED_ADAPTERS = [
       );
       return normalizeOpenCodeZenPayload(payload, Date.now());
     }
+  },
+  {
+    id: "zai",
+    displayName: "Z.AI",
+    semantics: { kind: "consumer-subscription", label: "GLM Coding Plan usage" },
+    publishesStatusline: false,
+    async query(auth, signal, timeoutMs) {
+      const payload = await fetchProviderJson(
+        zaiMonitorUrl(auth.model.baseUrl),
+        zaiMonitorAuth(auth),
+        signal,
+        timeoutMs,
+        "Z.AI quota endpoint"
+      );
+      return normalizeZaiQuotaPayload("zai", "Z.AI", payload, Date.now());
+    }
+  },
+  {
+    id: "zai-coding-cn",
+    displayName: "Z.AI Coding CN",
+    semantics: { kind: "consumer-subscription", label: "GLM Coding Plan usage" },
+    publishesStatusline: false,
+    async query(auth, signal, timeoutMs) {
+      const payload = await fetchProviderJson(
+        zaiMonitorUrl(auth.model.baseUrl),
+        zaiMonitorAuth(auth),
+        signal,
+        timeoutMs,
+        "Z.AI Coding CN quota endpoint"
+      );
+      return normalizeZaiQuotaPayload(
+        "zai-coding-cn",
+        "Z.AI Coding CN",
+        payload,
+        Date.now()
+      );
+    }
   }
 ];
 function adapterForProvider(providerId) {
@@ -954,7 +1105,7 @@ function resolveGitHubCopilotUsageAuth(auth, model, salt, candidates, standalone
   const matches = /* @__PURE__ */ new Map();
   for (const candidate of candidates) {
     try {
-      const credential = asObject5(candidate);
+      const credential = asObject6(candidate);
       if (credential?.type !== "oauth") continue;
       sawOAuth = true;
       const storedAccess2 = typeof credential.access === "string" && credential.access ? credential.access : void 0;
@@ -1016,7 +1167,7 @@ function bearerToken(authorization) {
   const match = /^Bearer\s+(.+)$/iu.exec(authorization ?? "");
   return match?.[1];
 }
-function asObject5(value) {
+function asObject6(value) {
   if (!value || typeof value !== "object" || Array.isArray(value)) return void 0;
   return value;
 }
@@ -1037,6 +1188,8 @@ function hasOfficialUrlOrigin(value, providerId) {
     if (providerId === "openai-codex") return url.origin === "https://chatgpt.com";
     if (providerId === "openrouter") return url.origin === "https://openrouter.ai";
     if (providerId === "opencode-go") return url.origin === "https://opencode.ai";
+    if (providerId === "zai") return url.origin === "https://api.z.ai";
+    if (providerId === "zai-coding-cn") return url.origin === "https://open.bigmodel.cn";
     if (providerId === "github-copilot") {
       return url.protocol === "https:" && /^api\.[a-z0-9-]+\.githubcopilot\.com$/u.test(url.hostname);
     }
@@ -1054,6 +1207,17 @@ function headerValue(headers, name) {
 function hasHeader(headers, name) {
   return Object.keys(headers).some((key) => key.toLowerCase() === name.toLowerCase());
 }
+function zaiMonitorUrl(baseUrl) {
+  const base = baseUrl?.trim();
+  if (!base) throw new Error("Z.AI model base URL is unavailable.");
+  return `${new URL(base).origin}/api/monitor/usage/quota/limit`;
+}
+function zaiMonitorAuth(auth) {
+  const authorization = headerValue(auth.headers, "Authorization");
+  const token = authorization === void 0 ? void 0 : bearerToken(authorization) ?? authorization;
+  if (token === void 0 || token === authorization) return auth;
+  return { ...auth, headers: { ...auth.headers, Authorization: token } };
+}
 function isAbortError(error) {
   return error instanceof Error && error.name === "AbortError";
 }
@@ -1196,7 +1360,7 @@ function normalizeCodexResetCreditsPayload(payload) {
   if (rawCredits !== void 0 && !Array.isArray(rawCredits)) {
     throw new Error("Codex reset credits response returned invalid credits.");
   }
-  const options = (rawCredits ?? []).map(asObject6).filter((credit) => Boolean(credit)).filter((credit) => credit.status === "available" && credit.reset_type === "codex_rate_limits").map(normalizeResetOption).sort(
+  const options = (rawCredits ?? []).map(asObject7).filter((credit) => Boolean(credit)).filter((credit) => credit.status === "available" && credit.reset_type === "codex_rate_limits").map(normalizeResetOption).sort(
     (left, right) => (left.expiresAt ?? Number.MAX_SAFE_INTEGER) - (right.expiresAt ?? Number.MAX_SAFE_INTEGER)
   ).slice(0, Math.min(availableCount, MAX_RESET_OPTIONS));
   if (availableCount > 0 && options.length === 0) {
@@ -1211,7 +1375,7 @@ function selectCodexResetCredential(candidates, resolvedAccess, resolvedAccountI
   const matches = /* @__PURE__ */ new Map();
   for (const candidate of candidates) {
     try {
-      const credential = asObject6(candidate);
+      const credential = asObject7(candidate);
       if (credential?.type !== "oauth") continue;
       sawOAuth = true;
       const storedAccess = asNonemptyString(credential.access);
@@ -1250,7 +1414,7 @@ function codexAccountIdFromAccessToken(access) {
     const parts = access.split(".");
     if (parts.length !== 3 || !parts[1]) return void 0;
     const payload = JSON.parse(Buffer.from(parts[1], "base64url").toString("utf8"));
-    const claims = asObject6(asObject6(payload)?.["https://api.openai.com/auth"]);
+    const claims = asObject7(asObject7(payload)?.["https://api.openai.com/auth"]);
     return validHeaderValue(claims?.chatgpt_account_id);
   } catch {
     return void 0;
@@ -1282,7 +1446,7 @@ function normalizeResetOption(credit) {
 function isCodexResetOutcomeCode(value) {
   return value === "reset" || value === "nothing_to_reset" || value === "no_credit" || value === "already_redeemed";
 }
-function asObject6(value) {
+function asObject7(value) {
   if (!value || typeof value !== "object" || Array.isArray(value)) return void 0;
   return value;
 }
@@ -1330,7 +1494,9 @@ function formatUsageReport(report, displayState) {
   else if (report.providerId === "github-copilot") formatGitHubCopilotReport(lines, report);
   else if (report.providerId === "openrouter") formatOpenRouterReport(lines, report);
   else if (report.providerId === "opencode-go") formatOpenCodeZenReport(lines, report);
-  else formatGenericReport(lines, report);
+  else if (report.providerId === "zai" || report.providerId === "zai-coding-cn") {
+    formatZaiReport(lines, report);
+  } else formatGenericReport(lines, report);
   if (report.notes) {
     for (const note of report.notes) lines.push(note);
   }
@@ -1417,7 +1583,7 @@ function compactGitHubCopilotQuotaKind(bucket) {
 }
 function percentRemaining(bucket) {
   if (!bucket.limit || bucket.remaining === void 0) return 0;
-  return Math.round(clampPercent3(bucket.remaining / bucket.limit * 100));
+  return Math.round(clampPercent4(bucket.remaining / bucket.limit * 100));
 }
 function formatOpenRouterReport(lines, report) {
   const limit = report.buckets.find((bucket) => bucket.id === "key-limit");
@@ -1444,10 +1610,33 @@ function formatOpenCodeZenStatusline(report) {
   for (const bucket of report.buckets) {
     if (bucket.used === void 0) continue;
     const compact = bucket.id === "rolling" ? "r" : bucket.id === "weekly" ? "w" : "m";
-    parts.push(`${clampPercent3(bucket.used).toFixed(0)}% ${compact}`);
+    parts.push(`${clampPercent4(bucket.used).toFixed(0)}% ${compact}`);
   }
   return parts.length > 1 ? parts.join(" ") : void 0;
 }
+function formatZaiReport(lines, report) {
+  for (const bucket of report.buckets) {
+    const reset = bucket.resetsAt ? ` (resets ${formatReset(bucket.resetsAt)})` : "";
+    let value = "unavailable";
+    if (bucket.unit === "percent" && bucket.used !== void 0) {
+      value = `${bucket.used}% used`;
+      if (bucket.remaining !== void 0) value += ` \xB7 ${bucket.remaining}% left`;
+    } else if (bucket.used !== void 0 && bucket.limit !== void 0) {
+      value = `${bucket.used} of ${bucket.limit} used`;
+      if (bucket.remaining !== void 0) value += ` \xB7 ${bucket.remaining} left`;
+    } else if (bucket.used !== void 0) {
+      value = `${bucket.used} used`;
+    } else if (bucket.remaining !== void 0) {
+      value = `${bucket.remaining} left`;
+    }
+    lines.push(`${`${bucket.label}:`.padEnd(VALUE_COLUMN)}${value}${reset}`);
+  }
+  for (const metric of report.metrics) {
+    lines.push(
+      `${`${metric.label}:`.padEnd(VALUE_COLUMN)}${formatMetricValue(metric.value, metric.unit)}`
+    );
+  }
+}
 function formatGenericReport(lines, report) {
   for (const bucket of report.buckets) {
     lines.push(
@@ -1472,7 +1661,7 @@ function formatCodexStatusline(report, model) {
     if (bucket.remaining === void 0) continue;
     const fallback = bucket.id.endsWith(":secondary") ? "weekly" : "5h";
     parts.push(
-      `${clampPercent3(bucket.remaining).toFixed(0)}% ${formatWindowLabel(bucket.windowMinutes, fallback, true)}`
+      `${clampPercent4(bucket.remaining).toFixed(0)}% ${formatWindowLabel(bucket.windowMinutes, fallback, true)}`
     );
   }
   return parts.length > 1 ? parts.join(" ") : formatCodexCreditsStatus(report);
@@ -1539,7 +1728,7 @@ function compactLimitLabel(label) {
   return (suffix || normalized).toLowerCase().replace(/\s+/g, " ");
 }
 function formatPercentBucket(bucket) {
-  const remaining = clampPercent3(bucket.remaining ?? 0);
+  const remaining = clampPercent4(bucket.remaining ?? 0);
   const filled = Math.round(remaining / 100 * BAR_SEGMENTS);
   const reset = bucket.resetsAt ? ` (resets ${formatReset(bucket.resetsAt)})` : "";
   return `[${"\u2588".repeat(filled)}${"\u2591".repeat(BAR_SEGMENTS - filled)}] ${remaining.toFixed(0)}% left${reset}`;
@@ -1572,7 +1761,7 @@ function formatReset(epochSeconds) {
 function capitalize(value) {
   return `${value[0]?.toUpperCase() ?? ""}${value.slice(1)}`;
 }
-function clampPercent3(value) {
+function clampPercent4(value) {
   return Math.min(100, Math.max(0, value));
 }
 
@@ -1971,6 +2160,11 @@ function usageExtension(pi, dependencies = {}) {
     statusRefreshTimer.unref?.();
   };
   const publishStatus = (ctx, outcome, model, shouldSchedule) => {
+    if (adapterForProvider(model.provider)?.publishesStatusline === false) {
+      clearStatusTimer();
+      safeSetStatus(ctx, void 0);
+      return;
+    }
     if (outcome.state.status === "unsupported") {
       clearStatusTimer();
       safeSetStatus(ctx, void 0);
@@ -2153,6 +2347,10 @@ function usageExtension(pi, dependencies = {}) {
       clearStatus(ctx);
       return;
     }
+    if (adapter.publishesStatusline === false) {
+      clearStatus(ctx);
+      return;
+    }
     statusGeneration += 1;
     const generation = statusGeneration;
     statusController?.abort();
@@ -2743,6 +2941,7 @@ export {
   normalizeOpenCodeZenPayload,
   normalizeOpenRouterKeyPayload,
   normalizeUsageSettings,
+  normalizeZaiQuotaPayload,
   providerIsConfigured,
   queryProviderUsage,
   redactUsageError,