@nehorai/credits 2.0.0 → 2.2.0

package/dist/repository/index.cjs

@@ -22,6 +22,7 @@ var repository_exports = {};
 __export(repository_exports, {
   InMemoryCreditRepository: () => InMemoryCreditRepository,
   addCreditsThroughRepository: () => addCreditsThroughRepository,
+  assertValidBalanceUpdate: () => assertValidBalanceUpdate,
   commitThroughRepository: () => commitThroughRepository,
   createInMemoryCreditRepository: () => createInMemoryCreditRepository,
   generateId: () => generateId,
@@ -32,7 +33,8 @@ __export(repository_exports, {
   supportsCreditsV2: () => supportsCreditsV2,
   supportsIdempotentCredit: () => supportsIdempotentCredit,
   toClientUserCredits: () => toClientUserCredits,
-  toDate: () => toDate
+  toDate: () => toDate,
+  validateBalanceUpdate: () => validateBalanceUpdate
 });
 module.exports = __toCommonJS(repository_exports);
 
@@ -54,6 +56,8 @@ function toClientUserCredits(credits) {
     monthlyUsed: credits.monthlyUsed,
     monthlyResetAt: toISOString(credits.monthlyResetAt),
     subscriptionExpiresAt: credits.subscriptionExpiresAt ? toISOString(credits.subscriptionExpiresAt) : null,
+    ...credits.expiredHoldBacking !== void 0 ? { expiredHoldBacking: credits.expiredHoldBacking } : {},
+    ...credits.signupGrant !== void 0 ? { signupGrant: credits.signupGrant } : {},
     createdAt: toISOString(credits.createdAt),
     updatedAt: toISOString(credits.updatedAt)
   };
@@ -144,6 +148,83 @@ function backedBalanceFloor(reserved, bonusCredits) {
   assertRepresentableAmount(floor, "backedBalanceFloor", { reserved, bonusCredits });
   return floor;
 }
+function spendableBalance(balance, expiredHoldBacking = 0) {
+  return sumAmounts(balance, -Math.min(expiredHoldBacking, balance));
+}
+function planBalanceTarget(target, reserved, bonusCredits) {
+  const balance = Math.max(target, backedBalanceFloor(reserved, bonusCredits));
+  return { balance, expiredHoldBacking: sumAmounts(balance, -target) };
+}
+function planBalanceCap(balance, cap, reserved, bonusCredits, expiredHoldBacking = 0) {
+  const spendable = spendableBalance(balance, expiredHoldBacking);
+  const target = Math.min(spendable, cap);
+  const kept = Math.max(
+    sumAmounts(balance, -spendable),
+    sumAmounts(backedBalanceFloor(reserved, bonusCredits), -target)
+  );
+  const next = Math.min(balance, sumAmounts(target, kept));
+  return { balance: next, expiredHoldBacking: Math.max(0, sumAmounts(next, -target)) };
+}
+function settleExpiredHoldBacking(balance, expiredHoldBacking, holdBacking) {
+  const held = Math.min(expiredHoldBacking, balance);
+  const used = Math.min(held, holdBacking);
+  return { used, remaining: sumAmounts(held, -used) };
+}
+function planHoldCommit(balance, bonusCredits, expiredHoldBacking, holdBacking, amount) {
+  const backing = settleExpiredHoldBacking(balance, expiredHoldBacking, holdBacking);
+  const rest = sumAmounts(amount, -backing.used);
+  const fromSpendable = Math.min(spendableBalance(balance, expiredHoldBacking), rest);
+  const fromBonus = sumAmounts(rest, -fromSpendable);
+  return {
+    covered: fromBonus <= bonusCredits,
+    balance: sumAmounts(balance, -backing.used, -fromSpendable),
+    bonusCredits: sumAmounts(bonusCredits, -fromBonus),
+    expiredHoldBacking: backing.remaining
+  };
+}
+function attributeExpiredBacking(holds, total) {
+  const placed = holds.filter((hold) => hold.holdPlacedAt).sort(
+    (a, b) => a.holdPlacedAt === b.holdPlacedAt ? a.id < b.id ? -1 : 1 : a.holdPlacedAt < b.holdPlacedAt ? -1 : 1
+  );
+  const shares = /* @__PURE__ */ new Map();
+  let left = total;
+  for (const hold of placed) {
+    const kept = Math.min(hold.expiredBacking ?? 0, hold.amount, left);
+    shares.set(hold.id, kept);
+    left = sumAmounts(left, -kept);
+  }
+  for (const hold of placed) {
+    const share = shares.get(hold.id);
+    const added = Math.min(sumAmounts(hold.amount, -share), left);
+    shares.set(hold.id, sumAmounts(share, added));
+    left = sumAmounts(left, -added);
+  }
+  return shares;
+}
+function expiredHoldBackingPatch(next, stored = 0) {
+  return next > 0 || stored > 0 ? { expiredHoldBacking: next } : {};
+}
+function assertValidBalanceTarget(value, field, context) {
+  assertRepresentableAmount(value, field, context);
+  if (value < 0) {
+    throw new CreditError(
+      `${field} cannot be negative (got ${value})`,
+      CreditErrorCode.INVALID_AMOUNT,
+      { field, value, ...context }
+    );
+  }
+}
+function assertValidTierBalanceInput(input, context) {
+  if (input.balanceCap === void 0) return;
+  if (input.balance !== void 0) {
+    throw new CreditError(
+      "A tier update cannot set both balance and balanceCap",
+      CreditErrorCode.INVALID_AMOUNT,
+      { balance: input.balance, balanceCap: input.balanceCap, ...context }
+    );
+  }
+  assertValidBalanceTarget(input.balanceCap, "balanceCap", context);
+}
 function assertRepresentableTierAmount(value, field, context) {
   if (value === Number.POSITIVE_INFINITY) return;
   assertRepresentableAmount(value, field, context);
@@ -333,11 +414,13 @@ var creditSystemConfigSchema = import_zod.z.object({
   /**
    * Operation costs in credits
    * Keys are operation type names (any non-empty string)
-   * Values are positive numbers representing credit cost
+   * Values are non-negative numbers representing credit cost. 0 marks a free
+   * operation: `withCredits` runs it without touching the ledger. Amounts that
+   * move credits stay strictly positive, so `reserveCredits` refuses a 0.
    */
   operationCosts: import_zod.z.record(
     import_zod.z.string().min(1),
-    import_zod.z.number().positive()
+    import_zod.z.number().nonnegative()
   ),
   /**
    * Display labels for operation types (English canonical labels).
@@ -359,9 +442,9 @@ var creditSystemConfigSchema = import_zod.z.object({
    */
   reservationExpiryMs: import_zod.z.number().positive().default(5 * 60 * 1e3),
   /**
-   * Default credits for new users (free tier)
+   * Default credits for new users (free tier). 0 means no signup grant.
    */
-  defaultFreeCredits: import_zod.z.number().positive().default(25),
+  defaultFreeCredits: import_zod.z.number().min(0).default(25),
   /**
    * Grace period in days after subscription expires before downgrade
    */
@@ -791,11 +874,36 @@ function toDate(value) {
   return /* @__PURE__ */ new Date();
 }
 function getNextMonthlyReset(from = /* @__PURE__ */ new Date()) {
-  const next = new Date(from);
-  next.setMonth(next.getMonth() + 1);
-  next.setDate(1);
-  next.setHours(0, 0, 0, 0);
-  return next;
+  return new Date(from.getFullYear(), from.getMonth() + 1, 1);
+}
+function validateBalanceUpdate(current, updates) {
+  const next = (base, absolute, increment) => sumAmounts(absolute ?? base, increment ?? 0);
+  const balance = next(current.balance, updates.balance, updates.balanceIncrement);
+  const bonusCredits = next(
+    current.bonusCredits ?? 0,
+    updates.bonusCredits,
+    updates.bonusCreditsIncrement
+  );
+  const reserved = next(current.reserved ?? 0, updates.reserved, updates.reservedIncrement);
+  const errors = [];
+  if (balance < 0) errors.push(`Balance cannot be negative: ${balance}`);
+  const marked = updates.balance === void 0 ? current.expiredHoldBacking ?? 0 : 0;
+  if ((updates.balanceIncrement ?? 0) < 0 && balance >= 0 && balance < marked) {
+    errors.push(`Balance (${balance}) cannot go below expired hold backing (${marked})`);
+  }
+  if (bonusCredits < 0) errors.push(`BonusCredits cannot be negative: ${bonusCredits}`);
+  if (reserved < 0) errors.push(`Reserved cannot be negative: ${reserved}`);
+  const covering = sumAmounts(balance, bonusCredits);
+  if (reserved > covering) {
+    errors.push(`Reserved (${reserved}) exceeds balance + bonusCredits (${covering})`);
+  }
+  return { valid: errors.length === 0, errors };
+}
+function assertValidBalanceUpdate(current, updates) {
+  const result = validateBalanceUpdate(current, updates);
+  if (!result.valid) {
+    throw new Error(`Invalid balance update: ${result.errors.join("; ")}`);
+  }
 }
 
 // src/repository/memory/snapshot.ts
@@ -1076,6 +1184,22 @@ function assertTrustworthy(reservation, transition) {
   assertLockedAmount(reservation, transition);
   assertHoldPlaced(reservation, transition);
 }
+function openHolds(store, userId) {
+  return [...store.reservations.get(userId)?.values() ?? []].filter(
+    (reservation) => reservation.status === "reserved"
+  );
+}
+function writeExpiredHoldBacking(store, credits, next) {
+  const stored = credits.expiredHoldBacking;
+  if (next <= 0 && !stored) return;
+  const holds = openHolds(store, credits.userId);
+  const shares = attributeExpiredBacking(holds, next);
+  for (const hold of holds) {
+    const share = shares.get(hold.id) ?? 0;
+    if (share !== (hold.expiredBacking ?? 0)) hold.expiredBacking = share;
+  }
+  Object.assign(credits, expiredHoldBackingPatch(sumAmounts(...shares.values()), stored));
+}
 function getReservation(store, userId, reservationId) {
   return store.reservations.get(userId)?.get(reservationId);
 }
@@ -1173,16 +1297,22 @@ async function commitReservationV2(store, userId, reservationId, options) {
     const amount = reservation.amount;
     await yieldPoint(store);
     assertReservedCoversHold(credits, userId, reservationId, amount);
-    if (sumAmounts(credits.balance, credits.bonusCredits) < amount) {
+    const paid = planHoldCommit(
+      credits.balance,
+      credits.bonusCredits,
+      credits.expiredHoldBacking ?? 0,
+      reservation.expiredBacking ?? 0,
+      amount
+    );
+    if (!paid.covered) {
       throw new CreditError(
         `Insufficient credits to commit reservation ${reservationId}`,
         CreditErrorCode.INSUFFICIENT_CREDITS,
         { userId, reservationId, required: amount }
       );
     }
-    const fromBalance = Math.min(credits.balance, amount);
-    const nextBalance = sumAmounts(credits.balance, -fromBalance);
-    const nextBonusCredits = sumAmounts(credits.bonusCredits, -sumAmounts(amount, -fromBalance));
+    const nextBalance = paid.balance;
+    const nextBonusCredits = paid.bonusCredits;
     const balanceAfter = sumAmounts(nextBalance, nextBonusCredits);
     const journal = {
       userId,
@@ -1216,6 +1346,10 @@ async function commitReservationV2(store, userId, reservationId, options) {
     credits.bonusCredits = nextBonusCredits;
     credits.reserved = nextReserved;
     credits.monthlyUsed = nextMonthlyUsed;
+    Object.assign(
+      credits,
+      expiredHoldBackingPatch(paid.expiredHoldBacking, credits.expiredHoldBacking)
+    );
     credits.updatedAt = (/* @__PURE__ */ new Date()).toISOString();
     const journalEntryId = commitTransitionJournal(store, journal, existingEntryId);
     return {
@@ -1295,19 +1429,26 @@ function finishUnspent(store, reservation, transition) {
     reservation.id,
     reservation.amount
   );
+  const backing = settleExpiredHoldBacking(
+    credits.balance,
+    credits.expiredHoldBacking ?? 0,
+    reservation.expiredBacking ?? 0
+  );
+  const nextBalance = sumAmounts(credits.balance, -backing.used);
   const journal = {
     userId: reservation.userId,
     operation: `${transition.transition}Reservation`,
     entryType: "credit",
     amount: 0,
-    balanceAfter: sumAmounts(credits.balance, credits.bonusCredits),
+    balanceAfter: sumAmounts(nextBalance, credits.bonusCredits),
     source: transition.source,
     reservationId: reservation.id,
     description: transition.options?.description ?? `${transition.verb} ${reservation.amount} reserved credits for ${getOperationLabel(reservation.operationType)}`,
     metadata: {
       ...transition.options?.metadata,
       operationType: reservation.operationType,
-      amount: reservation.amount
+      amount: reservation.amount,
+      ...backing.used > 0 ? { expiredCreditsRemoved: backing.used } : {}
     },
     idempotencyKey: reservationJournalKey(reservation.id, transition.transition)
   };
@@ -1320,6 +1461,8 @@ function finishUnspent(store, reservation, transition) {
   reservation.status = transition.status;
   reservation.completedAt = (/* @__PURE__ */ new Date()).toISOString();
   credits.reserved = nextReserved;
+  credits.balance = nextBalance;
+  Object.assign(credits, expiredHoldBackingPatch(backing.remaining, credits.expiredHoldBacking));
   credits.updatedAt = (/* @__PURE__ */ new Date()).toISOString();
   return commitTransitionJournal(store, journal, existingEntryId);
 }
@@ -1330,6 +1473,10 @@ function isoOf(value) {
 }
 var InMemoryCreditRepository = class {
   store = new MemoryStore();
+  options;
+  constructor(options = {}) {
+    this.options = options;
+  }
   // ==================== User Credits ====================
   /**
    * A copy, never the live record.
@@ -1346,7 +1493,8 @@ var InMemoryCreditRepository = class {
     return copyRecord(credits) ?? null;
   }
   async initializeUserCredits(userId, tier, initialBalance) {
-    return copyRecord(this.seedUser(userId, tier, initialBalance));
+    const existing = this.store.users.get(userId);
+    return copyRecord(existing ?? this.seedUser(userId, tier, initialBalance));
   }
   /**
    * The synchronous body of `initializeUserCredits`.
@@ -1397,8 +1545,11 @@ var InMemoryCreditRepository = class {
     if (!credits) {
       throw new Error(`User ${userId} not found`);
     }
+    assertValidBalanceUpdate(credits, updates);
     const next = { ...credits };
-    if (updates.balance !== void 0) next.balance = updates.balance;
+    if (updates.balance !== void 0) {
+      next.balance = updates.balance;
+    }
     if (updates.bonusCredits !== void 0) next.bonusCredits = updates.bonusCredits;
     if (updates.reserved !== void 0) next.reserved = updates.reserved;
     if (updates.tier !== void 0) next.tier = updates.tier;
@@ -1435,6 +1586,9 @@ var InMemoryCreditRepository = class {
       userId,
       operation: "updateUserCredits"
     });
+    if ((credits.expiredHoldBacking ?? 0) > 0 && updates.balance !== void 0) {
+      writeExpiredHoldBacking(this.store, next, 0);
+    }
     next.updatedAt = (/* @__PURE__ */ new Date()).toISOString();
     this.store.users.set(userId, next);
   }
@@ -1443,17 +1597,28 @@ var InMemoryCreditRepository = class {
       { monthlyLimit: input.monthlyLimit, balance: input.balance, monthlyUsed: input.monthlyUsed },
       { userId, operation: "updateUserTier" }
     );
+    assertValidTierBalanceInput(input, { userId, operation: "updateUserTier" });
     const credits = this.store.users.get(userId);
     if (!credits) {
       throw new Error(`User ${userId} not found`);
     }
+    if (input.balanceCap !== void 0 && !isFreeTier(credits.tier)) {
+      const capped = planBalanceCap(
+        credits.balance,
+        input.balanceCap,
+        credits.reserved,
+        credits.bonusCredits,
+        credits.expiredHoldBacking
+      );
+      credits.balance = capped.balance;
+      writeExpiredHoldBacking(this.store, credits, capped.expiredHoldBacking);
+    }
     credits.tier = input.tier;
     credits.monthlyLimit = input.monthlyLimit;
     if (input.balance !== void 0) {
-      credits.balance = Math.max(
-        input.balance,
-        backedBalanceFloor(credits.reserved, credits.bonusCredits)
-      );
+      const planned = planBalanceTarget(input.balance, credits.reserved, credits.bonusCredits);
+      credits.balance = planned.balance;
+      writeExpiredHoldBacking(this.store, credits, planned.expiredHoldBacking);
     }
     if (input.monthlyUsed !== void 0) credits.monthlyUsed = input.monthlyUsed;
     if (input.subscriptionExpiresAt !== void 0) {
@@ -1674,13 +1839,17 @@ var InMemoryCreditRepository = class {
     if (!credits) {
       throw new Error(`User credits not found for userId: ${userId}`);
     }
-    const available = sumAmounts(credits.balance, credits.bonusCredits, -credits.reserved);
+    const spendable = spendableBalance(credits.balance, credits.expiredHoldBacking);
+    const available = Math.min(
+      sumAmounts(credits.balance, credits.bonusCredits, -credits.reserved),
+      sumAmounts(spendable, credits.bonusCredits)
+    );
     if (available < amount) {
       throw new Error(
         `Insufficient credits. Available: ${available}, requested: ${amount}`
       );
     }
-    const balanceDeduction = Math.min(credits.balance, amount);
+    const balanceDeduction = Math.min(spendable, amount);
     const bonusDeduction = sumAmounts(amount, -balanceDeduction);
     const previousBalance = sumAmounts(credits.balance, credits.bonusCredits);
     const nextBalance = sumAmounts(credits.balance, -balanceDeduction);
@@ -1917,7 +2086,11 @@ var InMemoryCreditRepository = class {
     return { expiredCount, creditsReleased, errors };
   }
   // ==================== Atomic Monthly Reset ====================
-  async atomicMonthlyReset(userId, tier, expectedResetAt) {
+  /**
+   * @param _tier - Not trusted. The caller read it earlier and the account may
+   *   have changed tier since, so the reset uses the tier stored on the account.
+   */
+  async atomicMonthlyReset(userId, _tier, expectedResetAt) {
     const credits = this.store.users.get(userId);
     if (!credits) {
       throw new Error(`User ${userId} not found`);
@@ -1927,17 +2100,41 @@ var InMemoryCreditRepository = class {
     if (currentResetAt !== expected) {
       return { wasReset: false, credits: { ...credits } };
     }
-    assertRepresentableTierAmount(getConfigMonthlyLimit(tier), "monthlyLimit", { userId, tier });
+    const tier = credits.tier;
+    const spendable = spendableBalance(credits.balance, credits.expiredHoldBacking);
+    const decision = this.options.resolveMonthlyReset?.({ tier, balance: spendable });
+    if (decision === null) {
+      return { wasReset: false, credits: { ...credits } };
+    }
+    if (decision) {
+      assertValidBalanceTarget(decision.balance, "resolveMonthlyReset balance", { userId, tier });
+      if (decision.monthlyLimit !== void 0) {
+        assertValidBalanceTarget(decision.monthlyLimit, "resolveMonthlyReset monthlyLimit", {
+          userId,
+          tier
+        });
+      }
+    } else {
+      assertRepresentableTierAmount(getConfigMonthlyLimit(tier), "monthlyLimit", { userId, tier });
+    }
     const nextReset = getNextMonthlyReset();
-    const target = monthlyResetBalance(tier);
-    const floor = backedBalanceFloor(credits.reserved, credits.bonusCredits);
     const previousBalance = credits.balance;
-    const newBalance = target.kind === "atLeast" ? Math.max(credits.balance, target.value, floor) : Math.max(target.value, floor);
+    let target;
+    if (decision) {
+      target = decision.balance;
+    } else {
+      const configured = monthlyResetBalance(tier);
+      target = configured.kind === "atLeast" ? Math.max(spendable, configured.value) : configured.value;
+    }
+    const planned = planBalanceTarget(target, credits.reserved, credits.bonusCredits);
+    const newBalance = planned.balance;
     const change = sumAmounts(newBalance, -previousBalance);
     const balanceAfter = sumAmounts(newBalance, credits.bonusCredits);
     assertRepresentableAmount(Math.abs(change), "journal amount", { userId });
     assertRepresentableAmount(balanceAfter, "journal balanceAfter", { userId });
     credits.balance = newBalance;
+    writeExpiredHoldBacking(this.store, credits, planned.expiredHoldBacking);
+    if (decision?.monthlyLimit !== void 0) credits.monthlyLimit = decision.monthlyLimit;
     credits.monthlyUsed = 0;
     credits.monthlyResetAt = nextReset.toISOString();
     credits.updatedAt = (/* @__PURE__ */ new Date()).toISOString();
@@ -1991,23 +2188,34 @@ var InMemoryCreditRepository = class {
       };
     }
     const defaultTier = getDefaultTier();
-    const configured = getConfigMonthlyLimit(defaultTier);
-    assertRepresentableTierAmount(configured, "monthlyLimit", {
-      userId,
-      tier: defaultTier
-    });
-    const limit = storedMonthlyLimit(configured);
+    let limit;
+    if (this.options.getDowngradeBalanceCap) {
+      limit = this.options.getDowngradeBalanceCap();
+      assertValidBalanceTarget(limit, "getDowngradeBalanceCap", { userId, tier: defaultTier });
+    } else {
+      const configured = getConfigMonthlyLimit(defaultTier);
+      assertRepresentableTierAmount(configured, "monthlyLimit", {
+        userId,
+        tier: defaultTier
+      });
+      limit = storedMonthlyLimit(configured);
+    }
     const previousTier = credits.tier;
     const previousBalance = credits.balance;
-    const newBalance = Math.max(
-      Math.min(credits.balance, limit),
-      backedBalanceFloor(credits.reserved, credits.bonusCredits)
+    const planned = planBalanceCap(
+      credits.balance,
+      limit,
+      credits.reserved,
+      credits.bonusCredits,
+      credits.expiredHoldBacking
     );
+    const newBalance = planned.balance;
     const balanceAfter = sumAmounts(newBalance, credits.bonusCredits);
     assertRepresentableAmount(balanceAfter, "journal balanceAfter", { userId });
     credits.tier = defaultTier;
     credits.monthlyLimit = limit;
     credits.balance = newBalance;
+    writeExpiredHoldBacking(this.store, credits, planned.expiredHoldBacking);
     credits.subscriptionExpiresAt = null;
     credits.updatedAt = (/* @__PURE__ */ new Date()).toISOString();
     this.store.users.set(userId, credits);
@@ -2065,13 +2273,14 @@ var InMemoryCreditRepository = class {
     return copyRecords(Array.from(userReservations.values()));
   }
 };
-function createInMemoryCreditRepository() {
-  return new InMemoryCreditRepository();
+function createInMemoryCreditRepository(options = {}) {
+  return new InMemoryCreditRepository(options);
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   InMemoryCreditRepository,
   addCreditsThroughRepository,
+  assertValidBalanceUpdate,
   commitThroughRepository,
   createInMemoryCreditRepository,
   generateId,
@@ -2082,6 +2291,7 @@ function createInMemoryCreditRepository() {
   supportsCreditsV2,
   supportsIdempotentCredit,
   toClientUserCredits,
-  toDate
+  toDate,
+  validateBalanceUpdate
 });
 //# sourceMappingURL=index.cjs.map