@magpie-community/opencode-zcode-auth 0.1.10 → 0.1.12

package/README.md

@@ -92,6 +92,18 @@ behind an error, so a gift hiccup must not black out a working Coding
 Plan. A gift that goes out of date while requests use it simply stops
 showing.
 
+**Gift plans ZCode holds but has not granted.** ZCode hands out one-off
+trust-build / gift plans (a day's ZCode Trust Build, say) that are not
+on the account until the ZCode app claims them. The plugin reads the
+app's own list of them (`GET /api/v1/zcode-plan/billing/preview`) with
+the card and names them there — "1 to claim · claim it in the ZCode app"
+— set aside, so the line stops nothing and routing, usage caps and the
+menu bar pass it over. The plugin never claims one: the claim needs the
+Aliyun captcha attestation only the app's renderer can make. A preview
+that fails, or lists nothing, adds no line at all, and a card that is an
+error keeps its error. Claim the plan in the ZCode app (open it once);
+the next read shows it as an ordinary gift bucket.
+
 ## Models
 
 The models are the ones ZCode offers for the account's plan. They come

package/index.mjs

@@ -366,7 +366,9 @@ const isNum = (v) => typeof v === "number" && Number.isFinite(v)
 // the current value), else the percentage given. TIME_LIMIT is the month's
 // MCP tool calls, which ZCode shows but never stops the models on, so it is
 // set aside, as is a limit whose whole is told as 0: no cap (an older
-// plan's), which the vendor may still give as 100% used.
+// plan's), which the vendor may still give as 100% used. A window whose
+// count is told carries it as amount of limit, so magpie's card says the
+// count as used or as left, as it says the share beside it (#659).
 function limitWindows(d) {
   const out = []
   for (const x of d?.limits ?? []) {
@@ -380,9 +382,13 @@ function limitWindows(d) {
       if (isNum(x.remaining)) {
         const used = total - x.remaining
         w.used = (100 * used) / total
+        w.amount = used
+        w.limit = total
         w.display = `${compact(used)} / ${compact(total)}`
       } else if (isNum(x.currentValue)) {
         if (!isNum(x.percentage)) w.used = (100 * x.currentValue) / total
+        w.amount = x.currentValue
+        w.limit = total
         w.display = `${compact(x.currentValue)} / ${compact(total)}`
       }
     }
@@ -508,7 +514,11 @@ async function giftOf(s) {
     const w = { name: base, used: 0, _plan: str(owner.name), _spent: giftSpent(x) }
     if (used === undefined) used = total !== undefined && left !== undefined ? total - left : 0
     if (total > 0) {
+      // the bucket's count as amount of limit, as the Coding windows' is
+      // (#659): magpie says it as used or as left, as it says the share
       w.used = (100 * used) / total
+      w.amount = used
+      w.limit = total
       w.display = `${compact(used)} / ${compact(total)}`
     }
     if (w._spent) w.used = Math.max(100, w.used)
@@ -531,6 +541,30 @@ async function giftOf(s) {
   return out
 }
 
+// claimHint is the card's line for gift plans ZCode is holding for the
+// account but has not put on it: GET /billing/preview lists them, and
+// only the ZCode app claims one — its claim takes the Aliyun captcha
+// attestation the app's own renderer makes, so the plugin reads the list
+// and asks the user to claim it there. A window, set aside (it is no
+// allowance: using it up stops nothing), so the card shows it and
+// routing, caps and the menu bar pass it over. null when there is
+// nothing to claim, the preview failing or listing none among it: a
+// failed read is no line at all, never a card or a refusal of its own.
+async function claimHint(s) {
+  if (!s.jwt || jwtExpired(s.jwt)) return null
+  let d
+  try {
+    d = await call("GET", `${ZCODE}/api/v1/zcode-plan/billing/preview?app_version=${APP_VERSION}&platform=${platform()}`, { auth: "Bearer " + s.jwt, device: s.device })
+  } catch {
+    return null
+  }
+  const plans = (Array.isArray(d?.plans) ? d.plans : []).filter((p) => typeof p?.plan_id === "string" && p.plan_id.trim())
+  if (!plans.length) return null
+  const n = plans.length
+  const name = first(...plans.map((p) => (typeof p?.name === "string" ? p.name : "")), "ZCode gift plan")
+  return { name, used: 0, aside: true, display: `${n} to claim · claim ${n === 1 ? "it" : "them"} in the ZCode app` }
+}
+
 // startUsage is a gift-only account's card: its buckets, or the words
 // for having none to show. The card's header already names the plan, so
 // the windows keep their own names.
@@ -1523,9 +1557,16 @@ export async function ZCodeAuthPlugin({ client }) {
             return saved(await teamUsage(s, key))
           }
           const { start, gift } = await plansOf(s)
-          if (start) return saved(await startUsage(s))
-          if (gift) return saved(await dualUsage(s))
-          return saved(await codingUsage(s))
+          const card = saved(start ? await startUsage(s) : gift ? await dualUsage(s) : await codingUsage(s))
+          // a gift plan ZCode holds for the account but has not put on it:
+          // named on the card, claimed in the ZCode app (its claim needs
+          // the app's captcha attestation, see claimHint). A card that is
+          // an error keeps its error and asks nothing
+          if (!card.error) {
+            const hint = await claimHint(s)
+            if (hint) card.windows = [...(card.windows ?? []), hint]
+          }
+          return card
         } catch (e) {
           return saved({ error: e?.message ?? String(e) })
         }
@@ -1555,4 +1596,4 @@ export async function ZCodeAuthPlugin({ client }) {
 }
 
 // for tests
-export const _internal = { entry, limitWindows, termOf, startUsage, routes, blocked, plansOf, giftOf, dualUsage, spentUp, giftServes, modelOf, teamKeys, ownSignIn, stateOf, dress, PROMPT }
+export const _internal = { entry, limitWindows, termOf, startUsage, routes, blocked, plansOf, giftOf, dualUsage, claimHint, spentUp, giftServes, modelOf, teamKeys, ownSignIn, stateOf, dress, PROMPT }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magpie-community/opencode-zcode-auth",
-  "version": "0.1.10",
+  "version": "0.1.12",
   "description": "OpenCode provider plugin: signs in to Z.ai's or BigModel's (智谱) GLM Coding Plan as ZCode does, including team seats and ZCode's Start Plan",
   "type": "module",
   "main": "./index.mjs",