@i4e/invest4edu-access-core 0.19.0 → 0.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@i4e/invest4edu-access-core",
-  "version": "0.19.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));
+}

package/src/entitlement-schema.js

@@ -33,6 +33,16 @@ export const SUBSCRIPTION_STATUSES = Object.freeze([
  */
 export const QUOTA_TIMEZONE = "Asia/Kolkata";
 
+/**
+ * The synthetic feature that carries a credits-mode plan's allowance.
+ *
+ * Credits mode needed no new machinery precisely because the allowance is an ordinary
+ * entitlement row on this code: it inherits cycle columns, effective-date versioning, trial
+ * precedence, as-of resolution and the race-free counter. A plan IS credits-mode when a row for
+ * this code resolves — there is no separate flag to drift out of step with the data.
+ */
+export const CREDITS_FEATURE_CODE = "SUBSCRIPTION.CREDITS";
+
 /** Reasons an entitlement decision can carry. Stable strings — they surface in APIs and logs. */
 export const ENTITLEMENT_REASONS = Object.freeze({
   OK: "ok",
@@ -169,6 +179,7 @@ export const METER_CLIENT_DEF = Object.freeze({
 
 export default {
   PERIOD_GRANULARITIES,
+  CREDITS_FEATURE_CODE,
   QUOTA_SCOPES,
   OVERAGE_POLICIES,
   SUBSCRIPTION_STATUSES,

package/src/entitlement-store.js

@@ -23,7 +23,8 @@
  * outage into a customer-visible one. Absence is far more likely to be our gap than a customer
  * genuinely owning nothing.
  */
-import { resolveEntitlement, periodKey, subjectKeyFor } from "./entitlement.js";
+import { resolveEntitlement, resolveEntitlementRow, periodKey, subjectKeyFor } from "./entitlement.js";
+import { CREDITS_FEATURE_CODE } from "./entitlement-schema.js";
 import { LIVE_STATUSES } from "./subscription-lifecycle.js";
 
 /** Every failure path returns this, so callers never have to branch on "did the lookup work". */
@@ -96,15 +97,105 @@ export function createEntitlementStore({ getDb, toObjectId = (v) => v, logger =
       const cycles = subscription.status === "trialing"
         ? ["trial", subscription.cycle]
         : [subscription.cycle];
+      /**
+       * Fetched together: the feature's own rows AND the plan's credit-allowance rows. A plan IS
+       * credits-mode when a SUBSCRIPTION.CREDITS row resolves — the mode is the data, so there is
+       * no flag to drift out of step with it.
+       */
       const fetched = await db.collection("plan_entitlements").find({
         plan_code: subscription.plan_code,
         cycle: { $in: cycles },
-        feature_code: featureCode,
+        feature_code: featureCode === CREDITS_FEATURE_CODE
+          ? featureCode
+          : { $in: [featureCode, CREDITS_FEATURE_CODE] },
       }).toArray();
-      const trialRows = fetched.filter((r) => r.cycle === "trial");
-      const rows = subscription.status === "trialing" && trialRows.length
-        ? trialRows
-        : fetched.filter((r) => r.cycle === subscription.cycle);
+      const pick = (code) => {
+        const mine = fetched.filter((r) => r.feature_code === code);
+        const trial = mine.filter((r) => r.cycle === "trial");
+        return subscription.status === "trialing" && trial.length
+          ? trial
+          : mine.filter((r) => r.cycle === subscription.cycle);
+      };
+      const rows = pick(featureCode);
+      const creditRows = featureCode === CREDITS_FEATURE_CODE ? [] : pick(CREDITS_FEATURE_CODE);
+      const creditsMode = creditRows.length > 0 && feature.is_meterable;
+
+      /**
+       * CREDITS MODE — the feature's own row says whether it is INCLUDED (and may override the
+       * cost); the guard runs against the shared credit allowance, priced per use.
+       *
+       *   cost = plan row's credit_cost  >  service's registry credit_cost  >  1
+       *
+       * The per-plan override is your "premium plans give more usage" lever: eCAS can cost 2 on
+       * Discover and 1 on Grow without any per-feature matrix returning through the back door.
+       */
+      if (creditsMode) {
+        const svcRow = resolveEntitlementRow(rows, featureCode, now);
+        // Not named in a credits plan → the same fail-open NOT_IN_PLAN as count mode. A plan
+        // that forgot to include a feature is a config gap, not a paywall.
+        if (svcRow && svcRow.unlocked !== false) {
+          const cost = Number(svcRow.credit_cost) > 0
+            ? Number(svcRow.credit_cost)
+            : (Number(feature.credit_cost) > 0 ? Number(feature.credit_cost) : 1);
+
+          let packBalance = 0;
+          try {
+            const bal = await db.collection("feature_credits").aggregate([
+              { $match: {
+                subject_type: subjectType,
+                subject_id: oid(subjectId),
+                feature_code: CREDITS_FEATURE_CODE,
+                $expr: { $lt: ["$consumed", "$purchased"] },
+                $or: [{ expires_at: null }, { expires_at: { $exists: false } }, { expires_at: { $gt: now } }],
+              } },
+              { $group: { _id: null, n: { $sum: { $subtract: ["$purchased", "$consumed"] } } } },
+            ]).toArray();
+            packBalance = bal[0]?.n || 0;
+          } catch (e) {
+            logger.warn(`[entitlement] credit-pack balance unreadable: ${e.message}`);
+          }
+
+          const creditRow = creditRows[0];
+          const period = periodKey(creditRow.period_granularity || "month", {
+            now, subscriptionId: subscription._id, periodStart: subscription.period_start,
+          });
+          const subjectKey = subjectKeyFor(creditRow.quota_scope, identity) || "";
+          const usage = await db.collection("subscription_usage").findOne({
+            subscription_id: subscription._id,
+            feature_code: CREDITS_FEATURE_CODE,
+            period,
+            subject_key: subjectKey,
+          });
+
+          const result = await resolveEntitlement({
+            subscription,
+            entitlementRows: creditRows,
+            featureCode: CREDITS_FEATURE_CODE,
+            feature: { is_meterable: true },
+            used: usage?.used || 0,
+            credits: packBalance,
+            identity, bypass, now, cost,
+          });
+
+          const effectiveCreditRow = creditRows[0]
+            ? { ...creditRows[0], quota: result.quota, overage_policy: result.overage_policy || creditRows[0].overage_policy }
+            : null;
+
+          return {
+            ...result,
+            mode: "credits",
+            carriedSubjectType: subjectType,
+            carriedSubjectId: subjectId,
+            carriedSubscriptionId: subscription._id,
+            carriedPeriodStart: subscription.period_start || null,
+            carriedIdentity: identity,
+            carriedRow: effectiveCreditRow,
+            // consume() counts against THIS bucket, at THIS price — never recomputed.
+            carriedFeatureCode: CREDITS_FEATURE_CODE,
+            carriedCost: cost,
+          };
+        }
+      }
 
       /**
        * À-la-carte credits — units bought singly. Summed across purchases that still have units
@@ -184,6 +275,31 @@ export function createEntitlementStore({ getDb, toObjectId = (v) => v, logger =
     }
   }
 
+  /**
+   * Per-service breakdown when a shared bucket pays — "where did my 500 credits go".
+   *
+   * Fire-and-forget and unguarded: it is reporting, not enforcement, and a failed attribution
+   * row must never undo a consumption the guard already allowed. Only written when the bucket
+   * differs from the feature (credits mode) — in count mode the guarded row IS the attribution.
+   */
+  function recordAttribution({ db, entitlement, featureCode, bucketCode, subId, ident, n, units, now }) {
+    if (!db || bucketCode === featureCode) return;
+    try {
+      const row = entitlement?.carriedRow || {};
+      const period = periodKey(row.period_granularity || "month", {
+        now, subscriptionId: subId, periodStart: entitlement?.carriedPeriodStart,
+      });
+      const subjectKey = subjectKeyFor(row.quota_scope, ident) || "";
+      db.collection("subscription_usage").updateOne(
+        { subscription_id: subId, feature_code: featureCode, period, subject_key: subjectKey },
+        { $inc: { used: n, credits_spent: units }, $setOnInsert: { attribution: true } },
+        { upsert: true },
+      ).catch((e) => logger.warn(`[entitlement] attribution write failed: ${e.message}`));
+    } catch (e) {
+      logger.warn(`[entitlement] attribution skipped: ${e.message}`);
+    }
+  }
+
   /**
    * Consume one unit — race-free by construction.
    *
@@ -210,6 +326,14 @@ export function createEntitlementStore({ getDb, toObjectId = (v) => v, logger =
       if (entitlement && !entitlement.metered) return { consumed: false, reason: "not_metered" };
       if (!db || !subId || !useRow) return { consumed: false, reason: "not_metered" };
 
+      /**
+       * Credits mode: the BUCKET is the plan's credit allowance, and one action costs `cost`
+       * units. Both were decided by the resolve that authorised this call — recomputing either
+       * here could draw from a bucket nobody checked, at a price nobody quoted.
+       */
+      const bucketCode = entitlement?.carriedFeatureCode || featureCode;
+      const units = n * (Number(entitlement?.carriedCost) > 0 ? Number(entitlement.carriedCost) : 1);
+
       // The SAME bucket that entitlementFor just checked — recomputing it from different inputs
       // would count against a period nobody validated.
       const start = periodStart !== undefined ? periodStart : entitlement?.carriedPeriodStart;
@@ -228,14 +352,24 @@ export function createEntitlementStore({ getDb, toObjectId = (v) => v, logger =
           {
             subject_type: entitlement.carriedSubjectType,
             subject_id: oid(entitlement.carriedSubjectId),
-            feature_code: featureCode,
-            $expr: { $lt: ["$consumed", "$purchased"] },
+            feature_code: bucketCode,
+            /**
+             * The WHOLE cost must fit in one pack row, decided atomically. A 2-credit action
+             * against a pack with 1 left is refused rather than split across purchases —
+             * splitting would need a transaction across rows, and the boundary case (the last
+             * unit of one pack) is not worth that machinery. The refusal falls through to the
+             * plan counter, which answers honestly.
+             */
+            $expr: { $lte: [{ $add: ["$consumed", units] }, "$purchased"] },
             $or: [{ expires_at: null }, { expires_at: { $exists: false } }, { expires_at: { $gt: now } }],
           },
-          { $inc: { consumed: n } },
+          { $inc: { consumed: units } },
           { sort: { expires_at: 1, createdAt: 1 } },
         );
-        if (hit) return { consumed: true, fromCredit: true };
+        if (hit) {
+          recordAttribution({ db, entitlement, featureCode, bucketCode, subId, ident, n, units, now });
+          return { consumed: true, fromCredit: true };
+        }
         // No credit left after all — fall through and let the plan counter answer, which may well
         // refuse. Better than silently succeeding on a balance that just went to zero.
       }
@@ -244,7 +378,7 @@ export function createEntitlementStore({ getDb, toObjectId = (v) => v, logger =
       const subjectKey = subjectKeyFor(useRow.quota_scope, ident) || "";
       const filter = {
         subscription_id: subId,
-        feature_code: featureCode,
+        feature_code: bucketCode,
         period,
         subject_key: subjectKey,
       };
@@ -255,15 +389,21 @@ export function createEntitlementStore({ getDb, toObjectId = (v) => v, logger =
       // that record is the evidence for whether a quota is set correctly before anyone is refused.
       if (!capped) {
         await db.collection("subscription_usage").updateOne(
-          filter, { $inc: { used: n }, $setOnInsert: { ...filter } }, { upsert: true },
+          filter, { $inc: { used: units }, $setOnInsert: { ...filter } }, { upsert: true },
         );
+        recordAttribution({ db, entitlement, featureCode, bucketCode, subId, ident, n, units, now });
         return { consumed: true };
       }
 
-      // Capped: try the GUARDED update first, without upsert.
-      const guarded = { ...filter, used: { $lt: Number(useRow.quota) } };
-      const hit = await db.collection("subscription_usage").updateOne(guarded, { $inc: { used: n } });
-      if (hit.matchedCount > 0) return { consumed: true };
+      // Capped: try the GUARDED update first, without upsert. Cost-aware — the whole cost must
+      // fit ($lte quota - units is exactly $lt quota when units is 1), and a balance never goes
+      // negative on an in-flight action.
+      const guarded = { ...filter, used: { $lte: Number(useRow.quota) - units } };
+      const hit = await db.collection("subscription_usage").updateOne(guarded, { $inc: { used: units } });
+      if (hit.matchedCount > 0) {
+        recordAttribution({ db, entitlement, featureCode, bucketCode, subId, ident, n, units, now });
+        return { consumed: true };
+      }
 
       // No match means either "no row yet" (first use this period) or "quota reached". Distinguish
       // by INSERTING — the unique index makes that safe under concurrency: exactly one racer wins
@@ -272,7 +412,11 @@ export function createEntitlementStore({ getDb, toObjectId = (v) => v, logger =
       // Doing this as an upsert on the guarded filter instead would rely on a duplicate-key
       // EXCEPTION to mean "quota exceeded" — correct by accident, and unreadable.
       try {
-        await db.collection("subscription_usage").insertOne({ ...filter, used: n, createdAt: new Date() });
+        // First use this period must ALSO fit — an allowance smaller than one action's cost is
+        // refused on action one, not discovered at minus-something.
+        if (Number(useRow.quota) - units < 0) return { consumed: false, reason: "quota_exceeded" };
+        await db.collection("subscription_usage").insertOne({ ...filter, used: units, createdAt: new Date() });
+        recordAttribution({ db, entitlement, featureCode, bucketCode, subId, ident, n, units, now });
         return { consumed: true };
       } catch (e) {
         if (e?.code === 11000) return { consumed: false, reason: "quota_exceeded" };

package/src/entitlement.js

@@ -134,6 +134,12 @@ function withOverride(row, overrides = [], featureCode) {
 export function resolveEntitlement({
   subscription, entitlementRows = [], featureCode, feature = {},
   used = 0, credits = 0, identity = {}, bypass = false, now = new Date(),
+  /**
+   * Units this ONE action costs. 1 for count-mode (used + 1 ≤ quota is exactly the old
+   * used < quota), the service's credit cost when a credits-mode plan is paying. Threading it
+   * through here is what lets one resolver serve both modes instead of a parallel copy.
+   */
+  cost = 1,
 } = {}) {
   const base = {
     quota: null, used, remaining: null, period: null, subject_key: null,
@@ -177,8 +183,11 @@ export function resolveEntitlement({
   const granularity = row.period_granularity || "month";
   const period = periodKey(granularity, { now, subscriptionId: subscription._id, periodStart: subscription.period_start });
   const subject_key = subjectKeyFor(row.quota_scope, identity);
+  const unitCost = Number(cost) > 0 ? Number(cost) : 1;
   const planRemaining = Math.max(0, Number(row.quota) - Number(used || 0));
-  const withinQuota = Number(used || 0) < Number(row.quota);
+  // Cost-aware: the action is allowed only if the WHOLE cost fits. Refusing at balance < cost is
+  // the agreed rule — a balance never goes negative on an in-flight action.
+  const withinQuota = Number(used || 0) + unitCost <= Number(row.quota);
   const policy = row.overage_policy || "block";
 
   /**
@@ -192,7 +201,7 @@ export function resolveEntitlement({
    * Credits do not reset with the period — they were paid for, so they last until used.
    */
   const creditBalance = Math.max(0, Number(credits || 0));
-  const usingCredit = !withinQuota && creditBalance > 0;
+  const usingCredit = !withinQuota && creditBalance >= unitCost;
   const remaining = planRemaining + creditBalance;
 
   return {
@@ -210,6 +219,7 @@ export function resolveEntitlement({
     period,
     subject_key,
     metered: true,
+    cost: unitCost,
   };
 }