@i4e/invest4edu-access-core 0.20.0 → 0.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@i4e/invest4edu-access-core",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "Shared access-control primitives for NeoFindesk: tenant keystone, role capabilities, reportee tree, feature flags, and the unified access engine (registry schema, snapshot resolver, visibleWhen).",
   "type": "module",
   "exports": {
@@ -19,7 +19,8 @@
     "./route-features": "./src/route-features.js",
     "./subscription-lifecycle": "./src/subscription-lifecycle.js",
     "./entitlement-store": "./src/entitlement-store.js",
-    "./proration": "./src/proration.js"
+    "./proration": "./src/proration.js",
+    "./credits": "./src/credits.js"
   },
   "scripts": {
     "test": "node --test test/"

package/src/credits.js

@@ -0,0 +1,128 @@
+/**
+ * Credits — what happens to an unused allowance when a term ends.
+ *
+ * A credits plan hands out an allowance per term (500 credits a month) and every service spends
+ * from it at its own price. At the term boundary the counter resets, and the question nobody can
+ * avoid answering is what the unspent remainder was worth. Silence is itself an answer — the
+ * default today is that it evaporates, which is fine as a policy and indefensible as an accident.
+ *
+ * ── Rollover is a POLICY, resolved in layers ─────────────────────────────────────────────────
+ * platform default < plan. Same shape and same merge rule as proration, because they are the
+ * same kind of decision: what unused value is worth when the ground moves under it.
+ *
+ * ── The rules that are NOT configurable, because getting them wrong invents credits ──────────
+ *   · you can never roll more than went unused — the cap trims, it never tops up
+ *   · an unlimited allowance rolls nothing: there was no scarcity to carry forward
+ *   · rounding is DOWN, so a rollover never hands out a credit that was not left over
+ *   · rolled credits expire; carrying them forever turns a monthly allowance into a savings
+ *     account and makes the liability unbounded. They lapse at the end of the term they land in
+ *
+ * Kept pure — no database, no clock, no subscription — so the arithmetic is testable on its own.
+ */
+
+/** Every knob, with the conservative answer as the default. */
+export const CREDITS_DEFAULTS = {
+  /**
+   *   none   — the remainder lapses at the term boundary (today's behaviour)
+   *   full   — everything unused carries into the next term
+   *   capped — carries, but no more than `cap_percent` of the allowance
+   */
+  rollover_mode: "none",
+  /** Ceiling on what may roll, as a percentage of the term's allowance. Only used by `capped`. */
+  rollover_cap_percent: 50,
+  /**
+   * How long rolled credits survive, in terms. 1 = they must be used in the term they land in.
+   * Rolled credits never roll again regardless — carrying a carry compounds into a balance that
+   * no one budgeted for.
+   */
+  rollover_expires_in_terms: 1,
+};
+
+/**
+ * Merge policy layers. Later wins, and only for keys it actually specifies — a plan that sets
+ * only the mode must not silently reset a cap someone configured globally.
+ */
+export function resolveCreditsPolicy(...layers) {
+  const out = { ...CREDITS_DEFAULTS };
+  for (const layer of layers) {
+    if (!layer || typeof layer !== "object") continue;
+    for (const k of Object.keys(CREDITS_DEFAULTS)) {
+      if (layer[k] !== undefined && layer[k] !== null) out[k] = layer[k];
+    }
+  }
+  return out;
+}
+
+/**
+ * How many credits carry into the next term.
+ *
+ * @param {object}  a
+ * @param {number|null} a.quota  the term's allowance. null = unlimited ⇒ nothing to carry
+ * @param {number}  a.used       credits spent this term
+ * @param {object}  a.policy     resolved policy (see resolveCreditsPolicy)
+ * @returns {{units:number, reason:string, unused:number, cap:number|null, mode:string}}
+ */
+export function computeRollover({ quota, used = 0, policy = CREDITS_DEFAULTS } = {}) {
+  const p = resolveCreditsPolicy(policy);
+  const mode = p.rollover_mode;
+  const nil = (reason) => ({ units: 0, reason, unused: 0, cap: null, mode });
+
+  if (mode === "none") return nil("rollover is off");
+  // Unlimited means the allowance never constrained anything, so there is no remainder to carry.
+  // Rolling "infinity minus what you used" is not a number, and any finite stand-in is invented.
+  if (quota == null) return nil("allowance is unlimited — nothing to carry");
+
+  const allowance = Number(quota);
+  if (!Number.isFinite(allowance) || allowance <= 0) return nil("no allowance this term");
+
+  const spent = Math.max(0, Number(used) || 0);
+  // Overage can push `used` past the quota under a warn policy; a negative remainder is not a debt.
+  const unused = Math.max(0, allowance - spent);
+  if (unused <= 0) return { units: 0, reason: "allowance fully used", unused: 0, cap: null, mode };
+
+  if (mode === "full") {
+    return { units: Math.floor(unused), reason: "carried in full", unused, cap: null, mode };
+  }
+
+  if (mode === "capped") {
+    const pct = Math.max(0, Math.min(100, Number(p.rollover_cap_percent) || 0));
+    const cap = Math.floor((allowance * pct) / 100);
+    const units = Math.min(Math.floor(unused), cap);
+    return {
+      units,
+      reason: units < unused ? `capped at ${pct}% of the allowance` : "carried in full (under the cap)",
+      unused,
+      cap,
+      mode,
+    };
+  }
+
+  // An unrecognised mode is a config error. Carrying nothing is the safe reading of it — the
+  // alternative invents a balance from a typo.
+  return nil(`unknown rollover mode "${mode}"`);
+}
+
+/**
+ * When rolled credits lapse: the end of the term they can be used in.
+ *
+ * Needs the length of the term they are landing in, which the caller knows and this module
+ * deliberately does not. A term with no end (open-ended subscription) yields null — nothing to
+ * expire against, and inventing a date would silently destroy paid-for value.
+ */
+export function rolloverExpiryDate({ nextPeriodStart, nextPeriodEnd, policy = CREDITS_DEFAULTS } = {}) {
+  const p = resolveCreditsPolicy(policy);
+  if (!nextPeriodEnd) return null;
+  const end = new Date(nextPeriodEnd);
+  if (Number.isNaN(end.getTime())) return null;
+
+  const terms = Math.max(1, Math.floor(Number(p.rollover_expires_in_terms) || 1));
+  if (terms === 1) return end;
+
+  // More than one term: extend by the length of the term they land in, which is the only measure
+  // of "a term" available here. Without a start we cannot know that length, so we keep the single
+  // term rather than guess — under-granting is recoverable, over-granting is not.
+  const start = nextPeriodStart ? new Date(nextPeriodStart) : null;
+  if (!start || Number.isNaN(start.getTime()) || start >= end) return end;
+  const termMs = end.getTime() - start.getTime();
+  return new Date(end.getTime() + termMs * (terms - 1));
+}