@goweekdays/core 2.11.11 → 2.11.13

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @goweekdays/core
 
+## 2.11.13
+
+### Patch Changes
+
+- 0458614: Add support for next promo code and billing period start
+
+## 2.11.12
+
+### Patch Changes
+
+- ab6a66f: Update dependencies
+
 ## 2.11.11
 
 ### 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;
+    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,7 +6026,17 @@ var schemaSubscriptionTransaction = import_joi22.default.object({
     "promo-expired",
     "promo-updated"
   ).required(),
-  description: import_joi22.default.string().max(255).optional().allow("", null),
+  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)
 });
@@ -6058,6 +6074,7 @@ function modelSubscriptionTransaction(data) {
     amount: data.amount,
     currency: data.currency,
     type: data.type,
+    metadata: data.metadata ?? {},
     description: data.description ?? "",
     createdBy: data.createdBy,
     createdByName: data.createdByName,
@@ -8425,13 +8442,42 @@ function useSubscriptionService() {
       case "fixed":
         return Math.min(seats, limit) * (promo.fixedRate ?? 0) + Math.max(seats - limit, 0) * planPrice;
       case "flat":
-        return (promo.flatRate ?? 0) + Math.max(seats - limit, 0) * planPrice;
+        return (promo.flatRate ?? 0) + Math.max(0, seats - limit) * planPrice;
       case "volume":
         return promo.tiers?.length ? calculateVolumeTierAmount(promo.tiers, 1, seats, planPrice) : planPrice * seats;
       default:
         return planPrice * seats;
     }
   }
+  function computeAdditionalSeatAmount(additionalSeats, planPrice, promo, paidSeats) {
+    if (additionalSeats <= 0)
+      return 0;
+    if (!promo) {
+      return additionalSeats * planPrice;
+    }
+    const limit = promo.seats && promo.seats > 0 ? promo.seats : Infinity;
+    switch (promo.type) {
+      case "flat": {
+        const chargeableSeats = Math.max(0, paidSeats + additionalSeats - limit) - Math.max(0, paidSeats - limit);
+        return chargeableSeats * planPrice;
+      }
+      case "fixed": {
+        const promoSeatsLeft = Math.max(0, limit - paidSeats);
+        const promoSeats = Math.min(additionalSeats, promoSeatsLeft);
+        const normalSeats = additionalSeats - promoSeats;
+        return promoSeats * (promo.fixedRate ?? 0) + normalSeats * planPrice;
+      }
+      case "volume":
+        return promo.tiers?.length ? calculateVolumeTierAmount(
+          promo.tiers,
+          paidSeats + 1,
+          additionalSeats,
+          planPrice
+        ) : additionalSeats * planPrice;
+      default:
+        return additionalSeats * planPrice;
+    }
+  }
   function computeProration(subscription, seats, plan, promo) {
     const additionalSeats = Math.max(0, seats - subscription.paidSeats);
     if (additionalSeats === 0)
@@ -8445,10 +8491,11 @@ function useSubscriptionService() {
     const cycleDays = plan.billingCycle === "yearly" ? 365 : 30;
     if (daysRemaining === 0)
       return 0;
-    const additionalAmount = computeMonthlyAmount(
+    const additionalAmount = computeAdditionalSeatAmount(
       additionalSeats,
       plan.price,
-      promo
+      promo,
+      subscription.paidSeats
     );
     return additionalAmount / cycleDays * daysRemaining;
   }
@@ -8464,7 +8511,6 @@ function useSubscriptionService() {
     const isNew = !existingSubscription;
     const isPromoChange = !!existingSubscription && value.promoCode !== void 0 && value.promoCode !== existingSubscription.promoCode;
     const isSeatIncrease = !!existingSubscription && value.seats > existingSubscription.seats;
-    const isSeatDecrease = !!existingSubscription && value.seats < existingSubscription.seats;
     if (isPromoChange && isSeatIncrease) {
       throw new import_utils44.BadRequestError(
         "Cannot change promo code while increasing seats. Perform actions separately."
@@ -8534,7 +8580,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,
@@ -8559,6 +8606,7 @@ function useSubscriptionService() {
           amount: subscriptionAmount,
           currency,
           billingCycle: plan.billingCycle,
+          billingPeriodStart,
           nextBillingDate,
           promoCode: value.promoCode
         },
@@ -8662,7 +8710,17 @@ 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
         );
@@ -8727,7 +8785,7 @@ function useSubscriptionService() {
       });
       await updateById(
         subscription._id?.toString() ?? "",
-        { promoCode: value.promoCode ?? "", amount: subscriptionAmount },
+        { nextPromoCode: value.promoCode ?? "" },
         session
       );
       if (subscription.promoCode) {
@@ -8738,7 +8796,7 @@ function useSubscriptionService() {
           {
             promo: promo._id,
             org: value.org,
-            usedBy: userData.email
+            usedBy: value.user
           },
           session
         );
@@ -8746,12 +8804,19 @@ function useSubscriptionService() {
       await addTransaction(
         {
           type: "promo-updated",
-          description: `Updated promo code to ${value.promoCode || "none"}.`,
+          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
       );
@@ -8911,39 +8976,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
       );
@@ -8954,14 +9023,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();
     }
@@ -9497,6 +9559,7 @@ function useOrgService() {
           paidSeats: value.seats,
           currency: plan.currency,
           billingCycle: plan.billingCycle,
+          billingPeriodStart: currentDate,
           nextBillingDate
         },
         session