@nehorai/credits 3.0.0 → 3.1.0

package/dist/index.cjs

@@ -169,6 +169,7 @@ __export(src_exports, {
   resetConfig: () => resetConfig,
   sameAmount: () => sameAmount,
   settleExpiredHoldBacking: () => settleExpiredHoldBacking,
+  signupGrantJournalInput: () => signupGrantJournalInput,
   spendableBalance: () => spendableBalance,
   storedAmountCeil: () => storedAmountCeil,
   storedAmountFloor: () => storedAmountFloor,
@@ -178,6 +179,7 @@ __export(src_exports, {
   supportsIdempotentCredit: () => supportsIdempotentCredit,
   synchronousDeferred: () => synchronousDeferred,
   terminalStatusOf: () => terminalStatusOf,
+  tierChangeJournalInput: () => tierChangeJournalInput,
   tierSchema: () => tierSchema,
   toCents: () => toCents,
   toClientUserCredits: () => toClientUserCredits,
@@ -1104,17 +1106,25 @@ var DEFAULT_CONFIG = {
   }
 };
 var currentConfig = DEFAULT_CONFIG;
+function isOperationCostMap(value) {
+  if (typeof value !== "object" || value === null || Array.isArray(value)) return false;
+  return Object.values(value).every((cost) => isRepresentableAmount(cost) && cost >= 0);
+}
 function loadConfigFromEnv() {
   const envConfig = {};
   const operationCostsEnv = process.env.CREDITS_OPERATION_COSTS;
   if (operationCostsEnv) {
     try {
       const parsed = JSON.parse(operationCostsEnv);
-      if (typeof parsed === "object" && parsed !== null) {
+      if (isOperationCostMap(parsed)) {
         envConfig.operationCosts = {
           ...DEFAULT_CONFIG.operationCosts,
           ...parsed
         };
+      } else {
+        console.warn(
+          "[Credits Config] Ignoring CREDITS_OPERATION_COSTS: it must be a JSON object whose costs are numbers >= 0, exact to the cent"
+        );
       }
     } catch {
       console.warn("[Credits Config] Failed to parse CREDITS_OPERATION_COSTS env var as JSON");
@@ -1562,6 +1572,50 @@ function assertValidBalanceUpdate(current, updates) {
     throw new Error(`Invalid balance update: ${result.errors.join("; ")}`);
   }
 }
+function signupGrantJournalInput(userId, tier, grant) {
+  if (grant <= 0) return null;
+  return {
+    userId,
+    entryType: "credit",
+    amount: grant,
+    balanceBefore: 0,
+    balanceAfter: grant,
+    source: "bonus",
+    referenceId: `signup-${userId}`,
+    referenceType: "adjustment",
+    description: `Signup grant for ${tier} tier.`,
+    metadata: { tier }
+  };
+}
+function tierChangeJournalInput(input) {
+  const { userId, previousTier, newTier, previousBalance, newBalance, bonusCredits } = input;
+  const change = sumAmounts(newBalance, -previousBalance);
+  if (change === 0) return null;
+  const raised = change > 0;
+  const amount = raised ? newBalance : 0;
+  const balanceBefore = sumAmounts(previousBalance, bonusCredits);
+  const balanceAfter = sumAmounts(newBalance, bonusCredits);
+  assertRepresentableFields(
+    {
+      "journal amount": amount,
+      "journal balanceBefore": balanceBefore,
+      "journal balanceAfter": balanceAfter
+    },
+    { userId, operation: "updateUserTier" }
+  );
+  return {
+    userId,
+    entryType: raised ? "credit" : "debit",
+    amount,
+    balanceBefore,
+    balanceAfter,
+    source: raised ? "subscription_upgrade" : "subscription_downgrade",
+    referenceId: `tier-${Date.now()}`,
+    referenceType: "subscription",
+    description: `Tier changed from ${previousTier} to ${newTier}.`,
+    metadata: { previousTier, newTier, previousBalance, newBalance }
+  };
+}
 
 // src/repository/memory/snapshot.ts
 function copyRecord(record) {
@@ -2105,6 +2159,8 @@ var InMemoryCreditRepository = class {
       updatedAt: now
     };
     this.store.users.set(userId, credits);
+    const grantLine = signupGrantJournalInput(userId, tier, initialBalance);
+    if (grantLine) this.recordJournalEntry(grantLine);
     return credits;
   }
   async updateUserCredits(userId, updates) {
@@ -2185,21 +2241,29 @@ var InMemoryCreditRepository = class {
     if (!credits) {
       throw new Error(`User ${userId} not found`);
     }
-    if (input.balanceCap !== void 0 && !isFreeTier(credits.tier)) {
-      const capped = planBalanceCap(
+    let planned;
+    if (input.balance !== void 0) {
+      planned = planBalanceTarget(input.balance, credits.reserved, credits.bonusCredits);
+    } else if (input.balanceCap !== void 0 && !isFreeTier(credits.tier)) {
+      planned = planBalanceCap(
         credits.balance,
         input.balanceCap,
         credits.reserved,
         credits.bonusCredits,
         credits.expiredHoldBacking
       );
-      credits.balance = capped.balance;
-      writeExpiredHoldBacking(this.store, credits, capped.expiredHoldBacking);
     }
+    const journalLine = planned ? tierChangeJournalInput({
+      userId,
+      previousTier: credits.tier,
+      newTier: input.tier,
+      previousBalance: credits.balance,
+      newBalance: planned.balance,
+      bonusCredits: credits.bonusCredits
+    }) : null;
     credits.tier = input.tier;
     credits.monthlyLimit = input.monthlyLimit;
-    if (input.balance !== void 0) {
-      const planned = planBalanceTarget(input.balance, credits.reserved, credits.bonusCredits);
+    if (planned) {
       credits.balance = planned.balance;
       writeExpiredHoldBacking(this.store, credits, planned.expiredHoldBacking);
     }
@@ -2218,6 +2282,7 @@ var InMemoryCreditRepository = class {
     }
     credits.updatedAt = (/* @__PURE__ */ new Date()).toISOString();
     this.store.users.set(userId, credits);
+    if (journalLine) this.recordJournalEntry(journalLine);
   }
   // ==================== Reservations ====================
   async createReservation(input) {
@@ -2839,7 +2904,7 @@ var InMemoryCreditRepository = class {
       userId,
       entryType: "debit",
       amount: 0,
-      // No credits deducted, just tier change
+      // 0, however far the cap lowered the balance: the totals record the move
       balanceBefore: sumAmounts(previousBalance, credits.bonusCredits),
       balanceAfter,
       source: "subscription_downgrade",
@@ -3003,7 +3068,7 @@ var CreditsService = class {
           userId,
           entryType: "debit",
           amount: 0,
-          // No credits deducted, just tier change
+          // 0, however far the cap lowered the balance: the totals record the move
           balanceBefore: sumAmounts(data.balance, data.bonusCredits),
           // The ledger balance, matching every other journal writer: the V2
           // transitions and add/deduct all record `balance + bonusCredits`, so
@@ -3395,7 +3460,8 @@ var CreditsService = class {
     ]);
     const historyEntries = entries.map((entry) => {
       const type = this.mapSourceToHistoryType(entry.source);
-      const creditsChange = entry.entryType === "credit" ? entry.amount : -entry.amount;
+      const signedAmount = entry.entryType === "credit" ? entry.amount : -entry.amount;
+      const creditsChange = entry.balanceBefore !== void 0 ? sumAmounts(entry.balanceAfter, -entry.balanceBefore) : signedAmount;
       return {
         id: entry.id,
         type,
@@ -4468,6 +4534,7 @@ function createDummyReservation2(userId, operationType) {
   resetConfig,
   sameAmount,
   settleExpiredHoldBacking,
+  signupGrantJournalInput,
   spendableBalance,
   storedAmountCeil,
   storedAmountFloor,
@@ -4477,6 +4544,7 @@ function createDummyReservation2(userId, operationType) {
   supportsIdempotentCredit,
   synchronousDeferred,
   terminalStatusOf,
+  tierChangeJournalInput,
   tierSchema,
   toCents,
   toClientUserCredits,