@magpie-community/opencode-workbuddy-auth 0.2.15 → 0.2.17

package/README.md

@@ -349,15 +349,19 @@ midnight on every account. magpie's smart routing spends the account whose
 credits run out first.
 
 The plan's own credits and the rest are two windows. "Credits" is the
-packages whose credits come back each cycle, as WorkBuddy's client lists
-them (Pro monthly or yearly, youth, advanced, flagship, the plan's bonus,
-the free plan's monthly base, the Pro trials, or the subscription the
-summary names), with the plan's cycle, so its pace line is the month's.
-"Extra credits" is the packages that only lapse: gifted and activity
-credits (赠送积分) and bought credit packs. Only one of the two stops the
+plan's base credits: what the subscription grants each cycle (Pro monthly
+or yearly, youth, advanced, flagship, the Pro trials, the free plan's
+monthly base, or the subscription the summary names), with the plan's
+cycle, so its pace line is the month's. "Extra credits" is every other
+kind WorkBuddy's own usage panel lists: the plan's bonus, top-ups (bought
+credit packs) and platform rewards (gifted and activity credits,
+赠送积分). The summary's CreditGroups say which is which (plan_base
+against plan_bonus, addon and benefit); a summary without them is split
+by package code as WorkBuddy's client does. Only one of the two stops the
 account, since WorkBuddy serves it while any credits are left: the extra
 window is set aside until the plan's credits are spent. A summary with
-only one kind keeps the one "Credits" window (akic404 on Discord).
+only one kind keeps the one "Credits" window (akic404 on Discord; since
+0.2.16 the plan's bonus is extra too, Jiabubu on Discord).
 
 An enterprise (team) account's resource summary lists no packages. Its
 credits are read from the enterprise meter

package/index.mjs

@@ -2868,12 +2868,15 @@ function pinning() {
 // The plan's own credits and the rest are two windows (akic404 on
 // Discord): summed, the gifted and activity packages' credits used long
 // ago put the card at most of its allowance on the first day of the
-// month, and the plan's pace line said nothing. "Credits" is the packages
-// whose credits come back each cycle — WorkBuddy's client's own
-// onlyRefreshCodes (PLAN_CODES), or the subscription the summary names —
-// and "Extra credits" the ones that only lapse (gift, activity, bought
-// credit packs, any code the client doesn't list). A summary with only
-// one kind keeps the one "Credits" window, as before.
+// month, and the plan's pace line said nothing. "Credits" is the plan's
+// base credits and "Extra credits" every other kind, as WorkBuddy's own
+// usage panel breaks them down (Jiabubu on Discord: a plan's bonus and
+// bought credits were nowhere on the card). The summary's CreditGroups
+// say it in WorkBuddy's words: plan_base ("Plan Base Credits") is the
+// plan's, plan_bonus, addon ("Top-up Credits") and benefit ("Platform
+// Reward Credits") are extra. A summary without them is split by code as
+// the client's resolveCreditGroup does (PLAN_CODES, see planCodes). A
+// summary with only one kind keeps the one "Credits" window, as before.
 //
 // Only one of the two stops the account at a time: WorkBuddy serves it
 // while any credits are left, so the one set aside is the one whose
@@ -2881,36 +2884,79 @@ function pinning() {
 // spent and extra ones are left.
 function usageOf(sum, plan, site) {
   const out = { plan: plan || (sum?.IsPaidUser ? "Pro" : "Free plan"), windows: [] }
-  const ofPlan = planCodes(sum, site)
-  const kinds = { plan: { total: 0, used: 0 }, extra: { total: 0, used: 0 } }
-  let left = 0, bags = 0
-  for (const p of sum?.Packages ?? []) {
-    const hasTotal = p?.CycleTotalCapacity != null && p.CycleTotalCapacity !== ""
-    if (hasTotal) {
-      const k = kinds[ofPlan(p?.PackageCode) ? "plan" : "extra"]
-      k.total += capacity(p.CycleTotalCapacity)
-      k.used += capacity(p?.CycleUsedCapacity)
-    } else if (p?.CycleRemainCapacity != null && p.CycleRemainCapacity !== "") {
-      left += capacity(p.CycleRemainCapacity)
-      bags++
-    }
-  }
-  const window = (name, { used, total }) => ({ name, used: (100 * used) / total, display: `${compact(used)} / ${compact(total)}`, amount: used, limit: total, unit: "credits" })
-  const { plan: mine, extra } = kinds
+  const { plan: mine, extra, left, bags } = kindsOf(sum, site)
   if (mine.total > 0 && extra.total > 0) {
-    const credits = window("Credits", mine), more = window("Extra credits", extra)
+    const credits = creditWindow("Credits", mine), more = creditWindow("Extra credits", extra)
     if (mine.used >= mine.total && extra.used < extra.total) credits.aside = true
     else more.aside = true
     out.windows.push(credits, more)
   } else {
     const total = mine.total + extra.total, used = mine.used + extra.used
-    if (total > 0) out.windows.push(window("Credits", { used, total }))
+    if (total > 0) out.windows.push(creditWindow("Credits", { used, total }))
   }
   const total = mine.total + extra.total
   if (bags > 0 && (total === 0 || left > 0)) out.windows.push({ name: "Prepaid credits", balance: left, display: `${compact(left)} credits`, unit: "credits" })
   return out
 }
 
+// creditWindow is a window of credits used of a total.
+const creditWindow = (name, { used, total }) => ({ name, used: (100 * used) / total, display: `${compact(used)} / ${compact(total)}`, amount: used, limit: total, unit: "credits" })
+
+// kindsOf is the summary's credits, the plan's and the extra ones (see
+// usageOf), and what is left in its packages with no total (a prepaid
+// balance).
+function kindsOf(sum, site) {
+  const ofPlan = planCodes(sum, site)
+  const kinds = { plan: { total: 0, used: 0 }, extra: { total: 0, used: 0 }, left: 0, bags: 0 }
+  const hasTotal = (p) => p?.CycleTotalCapacity != null && p.CycleTotalCapacity !== ""
+  const add = (k, p) => ((k.total += capacity(p.CycleTotalCapacity)), (k.used += capacity(p?.CycleUsedCapacity)))
+  const groups = (Array.isArray(sum?.CreditGroups) ? sum.CreditGroups : []).filter(hasTotal)
+  for (const g of groups) add(kinds[g?.Kind === "plan_base" ? "plan" : "extra"], g)
+  for (const p of sum?.Packages ?? []) {
+    if (hasTotal(p)) {
+      if (!groups.length) add(kinds[ofPlan(p?.PackageCode) ? "plan" : "extra"], p)
+    } else if (p?.CycleRemainCapacity != null && p.CycleRemainCapacity !== "") {
+      kinds.left += capacity(p.CycleRemainCapacity)
+      kinds.bags++
+    }
+  }
+  return kinds
+}
+
+// listedExtra is the extra credits of the detail lists (packagesOf) that
+// the summary doesn't list at all, as WorkBuddy's own usage panel counts
+// them (jiabubu on Discord, magpie 0.1.2774, a China-site free account:
+// magpie's card read "0 / 500" alone, while the panel shows the extra
+// kinds beside the plan's). The panel's groups come from the detail
+// lists, not the summary (buildCreditGroups over fetchUserResources' paid
+// and free lists), and leave out a package past its end; a slice package
+// (CapacityType 4) counts the day's slice, as resolveResourceCapacity
+// does. null when there are none with credits.
+function listedExtra(sum, packages, site, now = Date.now()) {
+  const summed = new Set((sum?.Packages ?? []).map((p) => p?.PackageCode))
+  const codes = site?.ai ? [...EXTRA_CODES, ...EXTRA_AI] : EXTRA_CODES
+  let total = 0, left = 0, at = 0, lapsing = 0
+  for (const p of packages ?? []) {
+    const code = p?.PackageCode
+    if (!codes.includes(code) || summed.has(code)) continue
+    const end = endOf(p)
+    if (end > 0 && end <= now) continue
+    const slice = String(p?.CapacityType) === SLICE ? p?.SlicePeriodUsageDetails?.[0] : null
+    const of = (v) => { const n = Number(v); return Number.isFinite(n) && n > 0 ? n : 0 }
+    const t = of(slice ? slice.SlicePeriodCapacitySizePrecise : p?.CycleCapacitySizePrecise)
+    const l = Math.min(t, of(slice ? slice.SlicePeriodCapacityRemainPrecise : p?.CycleCapacityRemainPrecise))
+    if (!(t > 0)) continue
+    total += t
+    left += l
+    if (l > 0 && end > 0 && !slice) {
+      if (!at || end < at) at = end, lapsing = l
+      else if (end === at) lapsing += l
+    }
+  }
+  if (!(total > 0)) return null
+  return { total, used: total - left, ...(at ? { runsOutAt: new Date(at).toISOString(), runsOut: lapsing } : {}) }
+}
+
 // enterpriseUsageOf is an enterprise (team) account's credits, from
 // /billing/meter/get-enterprise-user-usage, the meter WorkBuddy's own usage
 // page (www.workbuddy.cn/profile/usage) reads for one (magpie #1904,
@@ -2953,7 +2999,7 @@ async function spareFree(site, a, windows) {
 // detail list without them (10001 "PackageCodes required").
 const CODE = (n, s) => `TCACA_code_${n}_${s}`
 const PAID_CODES = [CODE("002", "AkiJS3ZHF5"), CODE("005", "maRGyrHhw1"), CODE("003", "FAnt7lcmRT"), CODE("023", "4xbGhMrE6q"),
-  CODE("026", "BaESVICNoi"), CODE("027", "0FCGVA6vSa"), CODE("009", "0XmEQc2xOf"), CODE("038", "OhvqZtiPKr"), CODE("036", "lupO5WgNdG")]
+  CODE("026", "BaESVICNoi"), CODE("027", "0FCGVA6vSa"), CODE("043", "6oIkxT7Z0S"), CODE("009", "0XmEQc2xOf"), CODE("038", "OhvqZtiPKr"), CODE("036", "lupO5WgNdG")]
 const DAILY_CODE = CODE("001", "PqouKr6QWV")
 const FREE_CODES = [DAILY_CODE, CODE("008", "cfWoLwvjU4"), CODE("035", "ArVxJcGDsm"), CODE("006", "DbXS0lrypC"), CODE("039", "KRcQj7wUat"),
   CODE("040", "mi9rCYg46x"), CODE("007", "nzdH5h4Nl0"), CODE("028", "NtpWi0jzXs"), CODE("037", "WxOD3MpI2o"), CODE("029", "6wCGEWquYy"),
@@ -2962,19 +3008,30 @@ const FREE_CODES = [DAILY_CODE, CODE("008", "cfWoLwvjU4"), CODE("035", "ArVxJcGD
 // lost at the same midnight on every account, so they tell none apart
 const SLICE = "4"
 
-// PLAN_CODES are the packages whose credits come back each cycle, as
-// WorkBuddy's client (5.9.x) lists them (onlyRefreshCodes): Pro monthly,
-// Pro monthly plus, Pro yearly, youth, advanced, flagship, the plan's
-// bonus (bonus28; bonusIntl, "Plan Bonus Quota"), the international free
-// plan (freeMonIntl), the Pro trials, and on the China build alone the
-// free plan's monthly base (freeMon, 套餐基础积分). Every other code only
-// lapses: gift (006, "Bonus Pack" / Pro trial), activity (007, 赠送积分),
-// bonus29/30, and the credit packs (009, 036, 038).
+// PLAN_CODES are the plan's base credits, as WorkBuddy's client (WorkBuddy
+// AI 5.9.4) groups them in its usage panel (resolveCreditGroup's
+// planBase): Pro monthly, Pro monthly plus, Pro yearly, youth, advanced,
+// flagship, buddyOneVip, the international free plan (freeMonIntl), the
+// Pro trials, and on the China build alone the free plan's monthly base
+// (freeMon, 套餐基础积分). The plan's bonus (bonus28; bonusIntl, "Plan
+// Bonus Quota") comes back each cycle too, but the client says it apart
+// (planBonus), as it does the credit packs (009, 036, 038: addon) and
+// activity, bonus29/30 and gift (benefit).
 const PLAN_CODES = [CODE("002", "AkiJS3ZHF5"), CODE("005", "maRGyrHhw1"), CODE("003", "FAnt7lcmRT"), CODE("023", "4xbGhMrE6q"),
-  CODE("026", "BaESVICNoi"), CODE("027", "0FCGVA6vSa"), CODE("028", "NtpWi0jzXs"), CODE("035", "ArVxJcGDsm"),
-  CODE("039", "KRcQj7wUat"), CODE("040", "mi9rCYg46x"), CODE("037", "WxOD3MpI2o")]
+  CODE("026", "BaESVICNoi"), CODE("027", "0FCGVA6vSa"), CODE("043", "6oIkxT7Z0S"), CODE("035", "ArVxJcGDsm"),
+  CODE("039", "KRcQj7wUat"), CODE("040", "mi9rCYg46x")]
 const FREE_MON = CODE("008", "cfWoLwvjU4")
 
+// EXTRA_CODES are the kinds of extra credits WorkBuddy's own usage panel
+// shows beside the plan's base (WorkBuddy 5.5.6, the China build's
+// resolveCreditGroup): the plan's bonus (bonus28, bonusIntl), top-ups
+// (extra 009, extra38 038, extraIntl 036) and platform rewards (activity
+// 007, bonus29, bonus30), and on WorkBuddy AI the free month (008) and
+// gift (006) too. The China build puts gift in no group, so it shows none.
+const EXTRA_CODES = [CODE("028", "NtpWi0jzXs"), CODE("037", "WxOD3MpI2o"), CODE("009", "0XmEQc2xOf"), CODE("038", "OhvqZtiPKr"),
+  CODE("036", "lupO5WgNdG"), CODE("007", "nzdH5h4Nl0"), CODE("029", "6wCGEWquYy"), CODE("030", "BjSt89qTvr")]
+const EXTRA_AI = [FREE_MON, CODE("006", "DbXS0lrypC")]
+
 // planCodes says whether a package of the summary is the plan's own: one
 // of PLAN_CODES on that site, or the subscription the summary names.
 function planCodes(sum, site) {
@@ -3811,6 +3868,18 @@ function makePlugin(site) {
               Object.assign(stops, runsOutOf(sum, packages) ?? {})
               const aside = extra ? (stops === credits ? extra : credits) : null
               if (aside) Object.assign(aside, runsOutOf(sum, packages, Date.now(), (code) => ofPlan(code) === (aside === credits)) ?? {})
+              // the summary of the plan's credits alone: the extra ones
+              // only the detail lists have (listedExtra) are their window,
+              // always set aside. Whether WorkBuddy spends them once the
+              // plan's are gone isn't seen, so the plan's window stops the
+              // account as it did before.
+              const kinds = !extra && kindsOf(sum, site)
+              const more = kinds && kinds.plan.total > 0 && kinds.extra.total === 0 ? listedExtra(sum, packages, site) : null
+              if (more) {
+                const { runsOutAt, runsOut, ...counts } = more
+                const w = { ...creditWindow("Extra credits", counts), aside: true, ...(runsOutAt ? { runsOutAt, runsOut } : {}) }
+                out.windows.splice(out.windows.indexOf(credits) + 1, 0, w)
+              }
             } catch {}
           }
           await spareFree(site, a, out.windows)
@@ -3968,4 +4037,4 @@ export const WorkBuddyAuthPlugin = makePlugin(SITES.workbuddy)
 export const WorkBuddyAIAuthPlugin = makePlugin(SITES["workbuddy-ai"])
 
 // for tests
-export const _internal = { planCodes, idFor, OFF_TAKEN, replyAfterToolsOn, withDefaultEffort, SMALL_BUDGET, defaultEffortOf, gzipped, FREE_ONLY, PRICE_TTL, keyAccount, remoteConfig, cycleOf, typeUnions, systemAsUser, systemKey, DEFAULT_SYSTEM, EDGE_READS, fitShape, replyAfterTools, AFTER_TOOLS_REFUSED, enterpriseUsageOf, accountName, notDesktop, textOnly, runsOutOf, packagesOf, endOf, enterpriseHeaders, enterpriseOf, liveModels, browserSignIn, withSystem, asReasoning, normalizeToolChoice, fitTools, fitted, renamed, unsaid, FILTER_SAYS, unflagged, usageOf, desktopHeld, explained, REFUSED_HINT, RESTRICTED_HINT, EXHAUSTED_HINT, REFUSED_DOC, commaPaused, commaPausedOn, opened, freeCredits, creditsOf, priceOf, fresh, SITES, renewing, renewed, SESSION, attend, scopeOf, turnKey, conversationKey, signatureOf, isMessages, withoutUnsigned, withoutSignedThinking, prepared, answeredBefore, nativeOf, modelOf, configModels, freeWindowOf, tokensShort, freeWindowRows, freeWindowLedger, readLedgerTail, pinned, pinning, rowTime, rowAccount, ofAccount, windowOffset, windowReset, FREE_WINDOW_MODELS, FREE_WINDOW_CN, FREE_WINDOW_AI, FREE_WINDOW_SPAN, FREE_WINDOW_GAP, FREE_WINDOW_LEAD, checkinOf, API_MESSAGES: NPM_MESSAGES, API_CHAT: NPM }
+export const _internal = { planCodes, listedExtra, idFor, OFF_TAKEN, replyAfterToolsOn, withDefaultEffort, SMALL_BUDGET, defaultEffortOf, gzipped, FREE_ONLY, PRICE_TTL, keyAccount, remoteConfig, cycleOf, typeUnions, systemAsUser, systemKey, DEFAULT_SYSTEM, EDGE_READS, fitShape, replyAfterTools, AFTER_TOOLS_REFUSED, enterpriseUsageOf, accountName, notDesktop, textOnly, runsOutOf, packagesOf, endOf, enterpriseHeaders, enterpriseOf, liveModels, browserSignIn, withSystem, asReasoning, normalizeToolChoice, fitTools, fitted, renamed, unsaid, FILTER_SAYS, unflagged, usageOf, desktopHeld, explained, REFUSED_HINT, RESTRICTED_HINT, EXHAUSTED_HINT, REFUSED_DOC, commaPaused, commaPausedOn, opened, freeCredits, creditsOf, priceOf, fresh, SITES, renewing, renewed, SESSION, attend, scopeOf, turnKey, conversationKey, signatureOf, isMessages, withoutUnsigned, withoutSignedThinking, prepared, answeredBefore, nativeOf, modelOf, configModels, freeWindowOf, tokensShort, freeWindowRows, freeWindowLedger, readLedgerTail, pinned, pinning, rowTime, rowAccount, ofAccount, windowOffset, windowReset, FREE_WINDOW_MODELS, FREE_WINDOW_CN, FREE_WINDOW_AI, FREE_WINDOW_SPAN, FREE_WINDOW_GAP, FREE_WINDOW_LEAD, checkinOf, API_MESSAGES: NPM_MESSAGES, API_CHAT: NPM }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magpie-community/opencode-workbuddy-auth",
-  "version": "0.2.15",
+  "version": "0.2.17",
   "description": "OpenCode provider plugins for WorkBuddy's plans: WorkBuddy (CodeBuddy, copilot.tencent.com) and WorkBuddy AI (www.workbuddy.ai)",
   "type": "module",
   "main": "./index.mjs",