@goweekdays/core 2.11.12 → 2.11.14

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @goweekdays/core
 
+## 2.11.14
+
+### Patch Changes
+
+- 9fd2d52: Improve promo usage and subscription transaction handling
+
+## 2.11.13
+
+### Patch Changes
+
+- 0458614: Add support for next promo code and billing period start
+
 ## 2.11.12
 
 ### Patch Changes

package/dist/index.d.ts

@@ -866,8 +866,10 @@ type TSubscription = {
     currency: string;
     billingCycle: "monthly" | "yearly";
     promoCode?: string;
+    nextPromoCode?: string;
     retry?: number;
     status?: string;
+    billingPeriodStart: Date | string;
     nextBillingDate: Date | string;
     createdAt?: Date | string;
     updatedAt?: Date | string;
@@ -904,7 +906,9 @@ declare function useSubscriptionRepo(): {
         paidSeats?: number;
         amount?: number;
         promoCode?: string;
+        nextPromoCode?: string;
         status?: string;
+        billingPeriodStart?: Date;
         nextBillingDate?: Date;
     }, session?: ClientSession) => Promise<string>;
     getByStatus: (status?: string, limit?: number, retry?: number) => Promise<TSubscription[]>;
@@ -949,12 +953,23 @@ declare function useSubscriptionService(): {
     processPaidInvoice: (invoiceId: string) => Promise<string>;
 };
 
+type TSubscriptionTransactionMetadata = {
+    additionalSeats?: number;
+    seats?: number;
+    paidSeats?: number;
+    plan?: string | ObjectId;
+    promoCode?: string;
+    nextPromoCode?: string;
+    billingPeriodStart?: Date | string;
+    nextBillingDate?: Date | string;
+};
 type TSubscriptionTransaction = {
     _id?: ObjectId;
     subscription: string | ObjectId;
     amount: number;
     currency: string;
     type: "initiate" | "add-seat" | "remove-seat" | "renewal" | "promo-applied" | "promo-removed" | "promo-expired" | "promo-updated";
+    metadata?: TSubscriptionTransactionMetadata;
     description?: string;
     createdBy: string | ObjectId;
     createdByName?: string;

package/dist/index.js

@@ -5486,6 +5486,7 @@ var schemaSubscriptionCompute = import_joi20.default.object({
   seats: import_joi20.default.number().integer().min(1).required(),
   plan: import_joi20.default.string().hex().length(24).required(),
   promoCode: import_joi20.default.string().optional().allow("", null),
+  nextPromoCode: import_joi20.default.string().optional().allow("", null),
   org: import_joi20.default.string().hex().length(24).required()
 });
 var schemaSubscribe = import_joi20.default.object({
@@ -5504,6 +5505,7 @@ var schema2 = {
 };
 var schemaSubscription = import_joi20.default.object({
   ...schema2,
+  billingPeriodStart: import_joi20.default.date().optional().allow("", null),
   org: import_joi20.default.string().hex().length(24).required(),
   orgName: import_joi20.default.string().optional().allow("", null),
   currency: import_joi20.default.string().length(3).required(),
@@ -5550,9 +5552,11 @@ function modelSubscription(data) {
     amount: data.amount,
     currency: data.currency,
     billingCycle: data.billingCycle,
-    promoCode: data.promoCode,
+    promoCode: data.promoCode ?? "",
+    nextPromoCode: data.nextPromoCode ?? "",
     status: data.status ?? "active",
     retry: data.retry ?? 0,
+    billingPeriodStart: data.billingPeriodStart,
     nextBillingDate: data.nextBillingDate,
     createdAt: data.createdAt ?? /* @__PURE__ */ new Date(),
     updatedAt: data.updatedAt ?? ""
@@ -5864,7 +5868,9 @@ function useSubscriptionRepo() {
       paidSeats: import_joi21.default.number().integer().min(0).optional(),
       amount: import_joi21.default.number().positive().optional().allow(0),
       promoCode: import_joi21.default.string().max(50).optional().allow("", null),
+      nextPromoCode: import_joi21.default.string().max(50).optional().allow("", null),
       status: import_joi21.default.string().valid("active", "due", "overdue", "suspended").optional().allow("", null),
+      billingPeriodStart: import_joi21.default.date().optional().allow("", null),
       nextBillingDate: import_joi21.default.date().optional().allow("", null)
     });
     const { error } = validation.validate(options);
@@ -6020,6 +6026,16 @@ var schemaSubscriptionTransaction = import_joi22.default.object({
     "promo-expired",
     "promo-updated"
   ).required(),
+  metadata: import_joi22.default.object({
+    additionalSeats: import_joi22.default.number().integer().min(1).optional(),
+    seats: import_joi22.default.number().integer().min(0).optional(),
+    paidSeats: import_joi22.default.number().integer().min(0).optional(),
+    plan: import_joi22.default.string().hex().length(24).optional(),
+    promoCode: import_joi22.default.string().optional().allow("", null),
+    nextPromoCode: import_joi22.default.string().optional().allow("", null),
+    billingPeriodStart: import_joi22.default.date().optional().allow("", null),
+    nextBillingDate: import_joi22.default.date().optional().allow("", null)
+  }).optional(),
   description: import_joi22.default.string().optional().allow("", null),
   createdBy: import_joi22.default.string().hex().length(24).required(),
   createdByName: import_joi22.default.string().optional().allow("", null)
@@ -6052,12 +6068,22 @@ function modelSubscriptionTransaction(data) {
       throw new import_utils29.BadRequestError("Invalid createdBy ID.");
     }
   }
+  if (data.metadata) {
+    if (data.metadata.plan && typeof data.metadata.plan === "string" && data.metadata.plan.length === 24) {
+      try {
+        data.metadata.plan = new import_mongodb17.ObjectId(data.metadata.plan);
+      } catch (error2) {
+        throw new import_utils29.BadRequestError("Invalid plan ID in metadata.");
+      }
+    }
+  }
   return {
     _id: data._id,
     subscription: data.subscription,
     amount: data.amount,
     currency: data.currency,
     type: data.type,
+    metadata: data.metadata ?? {},
     description: data.description ?? "",
     createdBy: data.createdBy,
     createdByName: data.createdByName,
@@ -7861,7 +7887,7 @@ var schemaPromoUsage = import_joi34.default.object({
 function modelPromoUsage(value) {
   const { error } = schemaPromoUsage.validate(value);
   if (error) {
-    throw new Error(`Invalid Promo Usage model: ${error.message}`);
+    throw new import_utils40.BadRequestError(`Invalid Promo Usage model: ${error.message}`);
   }
   if (value._id && typeof value._id === "string") {
     try {
@@ -7944,6 +7970,9 @@ function usePromoUsageRepo() {
       delCachedData();
       return "Successfully added promo usage.";
     } catch (error) {
+      if (error instanceof import_utils41.AppError) {
+        throw error;
+      }
       throw new import_utils41.InternalServerError("Failed to add promo usage.");
     }
   }
@@ -8384,7 +8413,6 @@ function useSubscriptionService() {
   const { getById: getOrgById, updateStatusById: updateOrgStatusById } = useOrgRepo();
   const { getByCode: getPromoByCode } = usePromoRepo();
   const {
-    countByPromoId,
     add: addPromoUsage,
     updateStatusByOrgId: updatePromoUsageStatusByOrgId
   } = usePromoUsageRepo();
@@ -8499,7 +8527,7 @@ function useSubscriptionService() {
         "Cannot change promo code while increasing seats. Perform actions separately."
       );
     }
-    const effectivePromoCode = isPromoChange ? value.promoCode : existingSubscription?.promoCode;
+    const effectivePromoCode = isNew ? value.promoCode : isPromoChange ? value.promoCode : existingSubscription?.promoCode;
     const promo = effectivePromoCode ? await getPromoByCode(effectivePromoCode) : null;
     const monthlyAmount = computeMonthlyAmount(value.seats, plan.price, promo);
     let proratedAmount = 0;
@@ -8563,7 +8591,8 @@ function useSubscriptionService() {
       if (!membership) {
         throw new import_utils44.BadRequestError("User is not a member of the organization.");
       }
-      const nextBillingDate = /* @__PURE__ */ new Date();
+      const billingPeriodStart = /* @__PURE__ */ new Date();
+      const nextBillingDate = new Date(billingPeriodStart);
       nextBillingDate.setDate(nextBillingDate.getDate() + 30);
       const { subscriptionAmount, currency } = await computeFee({
         seats: value.seats,
@@ -8588,6 +8617,7 @@ function useSubscriptionService() {
           amount: subscriptionAmount,
           currency,
           billingCycle: plan.billingCycle,
+          billingPeriodStart,
           nextBillingDate,
           promoCode: value.promoCode
         },
@@ -8691,7 +8721,40 @@ function useSubscriptionService() {
             currency,
             subscription: subscription._id?.toString() ?? "",
             createdBy: value.user,
-            createdByName: `${userData.firstName} ${userData.lastName}`
+            createdByName: `${userData.firstName} ${userData.lastName}`,
+            metadata: {
+              additionalSeats,
+              seats: value.seats,
+              paidSeats,
+              plan: value.plan ?? "",
+              promoCode: subscription.promoCode ?? "",
+              nextPromoCode: subscription.nextPromoCode ?? "",
+              billingPeriodStart: subscription.billingPeriodStart,
+              nextBillingDate: subscription.nextBillingDate
+            }
+          },
+          session
+        );
+      }
+      if (!seatIncreased) {
+        await addTransaction(
+          {
+            type: "remove-seat",
+            description: `Removed ${subscription.seats - value.seats} seats.`,
+            amount: 0,
+            currency,
+            subscription: subscription._id?.toString() ?? "",
+            createdBy: value.user,
+            createdByName: `${userData.firstName} ${userData.lastName}`,
+            metadata: {
+              seats: subscription.seats - value.seats,
+              paidSeats,
+              plan: value.plan ?? "",
+              promoCode: subscription.promoCode ?? "",
+              nextPromoCode: subscription.nextPromoCode ?? "",
+              billingPeriodStart: subscription.billingPeriodStart,
+              nextBillingDate: subscription.nextBillingDate
+            }
           },
           session
         );
@@ -8748,23 +8811,14 @@ function useSubscriptionService() {
       if (!plan) {
         throw new import_utils44.BadRequestError("Plan not found.");
       }
-      const { subscriptionAmount, currency } = await computeFee({
-        seats: subscription.seats,
-        promoCode: value.promoCode ?? "",
-        plan: plan._id?.toString() ?? "",
-        org: value.org
-      });
       await updateById(
         subscription._id?.toString() ?? "",
-        { promoCode: value.promoCode ?? "", amount: subscriptionAmount },
+        { nextPromoCode: value.promoCode ?? "" },
         session
       );
       if (subscription.promoCode) {
         await updatePromoUsageStatusByOrgId(value.org, "inactive", session);
       }
-      let description = `Promo code updated to ${value.promoCode ?? "none"}. At the time of update, ${(0, import_utils44.formatNumber)(subscription.paidSeats, {
-        decimalPlaces: 0
-      })} seat(s) were already included in the subscription.`;
       if (promo && promo._id) {
         await addPromoUsage(
           {
@@ -8774,49 +8828,23 @@ function useSubscriptionService() {
           },
           session
         );
-        const additionalDescription = `${promo.seats ? `Seats beyond ${(0, import_utils44.formatNumber)(promo.seats, {
-          decimalPlaces: 0
-        })} are charged at the standard rate.` : ""}`;
-        if (promo.type === "flat") {
-          description += ` ${(0, import_utils44.formatNumber)(promo.flatRate ?? 0, {
-            currency,
-            useSymbol: true
-          })} ${promo.seats ? `limited to ${(0, import_utils44.formatNumber)(promo.seats, {
-            decimalPlaces: 0
-          })} seat(s)` : " for all seats"}. ${additionalDescription}`;
-        }
-        if (promo.type === "fixed") {
-          description += ` ${(0, import_utils44.formatNumber)(promo.fixedRate ?? 0, {
-            currency,
-            useSymbol: true
-          })} per seat${promo.seats ? `, limited to ${(0, import_utils44.formatNumber)(promo.seats, {
-            decimalPlaces: 0
-          })} seat(s)` : ""}. ${additionalDescription}`;
-        }
-        if (promo.type === "volume") {
-          if (promo.tiers && promo.tiers.length > 0) {
-            const tierDescriptions = promo.tiers.map((tier) => {
-              const maxSeatsDesc = tier.maxSeats === 0 ? "and above" : `to ${(0, import_utils44.formatNumber)(tier.maxSeats, { decimalPlaces: 0 })}`;
-              return `${(0, import_utils44.formatNumber)(tier.minSeats, {
-                decimalPlaces: 0
-              })} ${maxSeatsDesc} ${(0, import_utils44.formatNumber)(tier.rate, {
-                currency,
-                useSymbol: true
-              })} per seat`;
-            }).join(", ");
-            description += ` Volume tiers, ${tierDescriptions}.`;
-          }
-        }
       }
       await addTransaction(
         {
           type: "promo-updated",
-          description,
+          description: `Promo code ${value.promoCode || "removed"} scheduled to take effect on the next billing cycle.`,
           amount: 0,
-          currency,
+          currency: subscription.currency,
           subscription: subscription._id?.toString() ?? "",
           createdBy: value.user,
-          createdByName: `${userData.firstName} ${userData.lastName}`
+          metadata: {
+            seats: subscription.seats,
+            paidSeats: subscription.paidSeats,
+            promoCode: subscription.promoCode,
+            nextPromoCode: value.promoCode ?? "",
+            billingPeriodStart: subscription.billingPeriodStart,
+            nextBillingDate: subscription.nextBillingDate
+          }
         },
         session
       );
@@ -8901,9 +8929,11 @@ function useSubscriptionService() {
       }
       for (let index = 0; index < subscriptions.length; index++) {
         const subscription = subscriptions[index];
-        const today = /* @__PURE__ */ new Date();
-        const nextBillingDate = new Date(subscription.updatedAt ?? "");
-        if (nextBillingDate.getFullYear() === today.getFullYear() && nextBillingDate.getMonth() === today.getMonth() && nextBillingDate.getDate() === today.getDate() || subscription.retry && subscription.retry >= retry) {
+        const now = /* @__PURE__ */ new Date();
+        if (now < new Date(subscription.nextBillingDate)) {
+          continue;
+        }
+        if ((subscription.retry ?? 0) >= retry) {
           continue;
         }
         try {
@@ -8976,39 +9006,43 @@ function useSubscriptionService() {
     }
     const ledgerBill = await getByInvoice(invoiceId);
     if (!ledgerBill) {
-      throw new import_utils44.BadRequestError(
-        "Ledger bill not found for the given invoice ID."
-      );
+      throw new import_utils44.BadRequestError("Ledger bill not found.");
     }
     const orgId = String(ledgerBill.org);
-    const org = await getOrgById(orgId);
-    if (!org) {
-      throw new import_utils44.BadRequestError("Organization not found for the ledger bill.");
-    }
     const subscription = await getByOrg(orgId);
     if (!subscription) {
-      throw new import_utils44.BadRequestError("Subscription not found for the organization.");
+      throw new import_utils44.BadRequestError("Subscription not found.");
     }
     const plan = await getDefaultPlan();
     if (!plan) {
-      throw new import_utils44.BadRequestError("Default plan not found.");
+      throw new import_utils44.BadRequestError("Plan not found.");
     }
     const session = import_utils44.useAtlas.getClient()?.startSession();
     if (!session) {
-      throw new Error("Unable to start database session.");
+      throw new import_utils44.InternalServerError("Unable to start database session.");
     }
     try {
       session.startTransaction();
-      const subscriptionId = String(subscription._id);
-      const nextBillingDate = /* @__PURE__ */ new Date();
+      const billingPeriodStart = /* @__PURE__ */ new Date();
+      const nextBillingDate = new Date(billingPeriodStart);
       nextBillingDate.setMonth(nextBillingDate.getMonth() + 1);
+      const effectivePromoCode = subscription.nextPromoCode || subscription.promoCode;
+      const promo = effectivePromoCode ? await getPromoByCode(effectivePromoCode) : null;
+      const monthlyAmount = computeMonthlyAmount(
+        subscription.seats,
+        plan.price,
+        promo
+      );
       await updateById(
-        subscriptionId,
+        subscription._id?.toString() ?? "",
         {
           status: "active",
+          billingPeriodStart,
           nextBillingDate,
           paidSeats: subscription.seats,
-          amount: plan.price * subscription.seats
+          amount: Math.round(monthlyAmount * 100) / 100,
+          promoCode: effectivePromoCode,
+          nextPromoCode: ""
         },
         session
       );
@@ -9019,14 +9053,7 @@ function useSubscriptionService() {
       return "Successfully processed paid invoice.";
     } catch (error2) {
       await session.abortTransaction();
-      import_utils44.logger.log({
-        level: "error",
-        message: `Failed to process paid invoice ${invoiceId}: ${error2 instanceof Error ? error2.message : String(error2)}`
-      });
-      if (error2 instanceof import_utils44.AppError) {
-        throw error2;
-      }
-      throw new import_utils44.InternalServerError("Failed to process paid invoice.");
+      throw error2;
     } finally {
       session.endSession();
     }
@@ -9562,6 +9589,7 @@ function useOrgService() {
           paidSeats: value.seats,
           currency: plan.currency,
           billingCycle: plan.billingCycle,
+          billingPeriodStart: currentDate,
           nextBillingDate
         },
         session