@nehorai/credits 1.6.0 → 1.7.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Nehorai Hadad
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/adapters/index.d.cts

@@ -1,6 +1,6 @@
 import { c as PortableReservation, W as WithCreditsOptions } from '../types-CjLj3GW5.cjs';
 import { a as CreditsUser, I as ICreditsAuthProvider } from '../types-OZU3I5OM.cjs';
-import { I as ICreditRepository } from '../types-CZNv1U3e.cjs';
+import { I as ICreditRepository } from '../types-DFe5BoJY.cjs';
 import { D as DeferredExecutor } from '../deferred-C7rrRfkm.cjs';
 
 /**

package/dist/adapters/index.d.ts

@@ -1,6 +1,6 @@
 import { c as PortableReservation, W as WithCreditsOptions } from '../types-CjLj3GW5.js';
 import { a as CreditsUser, I as ICreditsAuthProvider } from '../types-OZU3I5OM.js';
-import { I as ICreditRepository } from '../types-G4WK0rM-.js';
+import { I as ICreditRepository } from '../types-_bSybQnb.js';
 import { D as DeferredExecutor } from '../deferred-C7rrRfkm.js';
 
 /**

package/dist/core/index.d.cts

@@ -1,7 +1,7 @@
 import { c as PortableReservation } from '../types-CjLj3GW5.cjs';
 export { A as AIProviderType, B as BuiltinTier, g as CreditCheckResult, a as CreditOperationType, C as CreditSource, D as DeductCreditsResult, J as JournalReferenceType, M as MonthlyResetResult, f as PortableJournalEntry, P as PortableTransaction, d as PortableUsageLog, b as PortableUserCredits, R as ReservationStatus, h as ResourceType, e as SubscriptionExpiryResult, S as SubscriptionTier, T as TierConfig, i as TransactionType, U as UsageHistoryEntry, j as UsageHistoryResponse, W as WithCreditsOptions, k as calculateAvailableCredits, t as toDate, l as toPortableTimestamp } from '../types-CjLj3GW5.cjs';
 export { D as DeferredExecutor, c as createDeferredExecutor, g as genericDeferred, n as noopDeferred, s as synchronousDeferred } from '../deferred-C7rrRfkm.cjs';
-import { I as ICreditRepository } from '../types-CZNv1U3e.cjs';
+import { I as ICreditRepository } from '../types-DFe5BoJY.cjs';
 
 /**
  * Credit system error classes - framework agnostic

package/dist/core/index.d.ts

@@ -1,7 +1,7 @@
 import { c as PortableReservation } from '../types-CjLj3GW5.js';
 export { A as AIProviderType, B as BuiltinTier, g as CreditCheckResult, a as CreditOperationType, C as CreditSource, D as DeductCreditsResult, J as JournalReferenceType, M as MonthlyResetResult, f as PortableJournalEntry, P as PortableTransaction, d as PortableUsageLog, b as PortableUserCredits, R as ReservationStatus, h as ResourceType, e as SubscriptionExpiryResult, S as SubscriptionTier, T as TierConfig, i as TransactionType, U as UsageHistoryEntry, j as UsageHistoryResponse, W as WithCreditsOptions, k as calculateAvailableCredits, t as toDate, l as toPortableTimestamp } from '../types-CjLj3GW5.js';
 export { D as DeferredExecutor, c as createDeferredExecutor, g as genericDeferred, n as noopDeferred, s as synchronousDeferred } from '../deferred-C7rrRfkm.js';
-import { I as ICreditRepository } from '../types-G4WK0rM-.js';
+import { I as ICreditRepository } from '../types-_bSybQnb.js';
 
 /**
  * Credit system error classes - framework agnostic

package/dist/index.cjs

@@ -912,23 +912,39 @@ var InMemoryCreditRepository = class {
     this.users.set(userId, credits);
     await this.updateReservationStatus(userId, reservationId, "released", /* @__PURE__ */ new Date());
   }
-  async addCreditsAtomic(userId, amount, description, paymentRef) {
+  async addCreditsAtomic(userId, amount, description, paymentRef, options) {
     const credits = this.users.get(userId);
     if (!credits) {
       throw new Error(`User ${userId} not found`);
     }
-    const previousBalance = credits.bonusCredits;
+    const previousTotal = credits.balance + credits.bonusCredits;
     credits.bonusCredits += amount;
     credits.updatedAt = (/* @__PURE__ */ new Date()).toISOString();
     this.users.set(userId, credits);
-    await this.createTransaction({
+    const newTotal = credits.balance + credits.bonusCredits;
+    const transaction = await this.createTransaction({
       userId,
       type: "purchase",
       amount,
       description,
       paymentRef,
-      previousBalance,
-      newBalance: credits.bonusCredits
+      previousBalance: previousTotal,
+      newBalance: newTotal
+    });
+    const journalMetadata = {
+      ...paymentRef ? { paymentRef } : {},
+      ...options?.metadata ?? {}
+    };
+    await this.createJournalEntry({
+      userId,
+      entryType: "credit",
+      amount,
+      balanceAfter: newTotal,
+      source: options?.source ?? "purchase",
+      referenceId: transaction.id ?? paymentRef ?? "unknown",
+      referenceType: options?.referenceType ?? "transaction",
+      description,
+      metadata: Object.keys(journalMetadata).length > 0 ? journalMetadata : void 0
     });
   }
   async deductCreditsAtomic(userId, amount) {
@@ -1510,9 +1526,11 @@ var CreditsService = class {
    * @param amount - Credits to add
    * @param description - Transaction description
    * @param paymentRef - Optional payment reference
+   * @param options - Optional journal source / reference type / extra metadata
+   *   for the credit journal entry (e.g. revenue-attribution fields).
    */
-  async addCredits(userId, amount, description, paymentRef) {
-    return this.repository.addCreditsAtomic(userId, amount, description, paymentRef);
+  async addCredits(userId, amount, description, paymentRef, options) {
+    return this.repository.addCreditsAtomic(userId, amount, description, paymentRef, options);
   }
   /**
    * One-shot atomic "deduct-if-sufficient" credit charge.