@goweekdays/core 2.11.3 → 2.11.5

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @goweekdays/core
 
+## 2.11.5
+
+### Patch Changes
+
+- cb8aa36: Enhance promo usage tracking and seat limit logic
+
+## 2.11.4
+
+### Patch Changes
+
+- 2697ef3: Refactor subscription amount calculation logic
+
 ## 2.11.3
 
 ### Patch Changes

package/dist/index.d.ts

@@ -470,6 +470,33 @@ declare function usePromoController(): {
     deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
+type TPromoUsage = {
+    _id?: ObjectId;
+    promo: ObjectId;
+    org: ObjectId | string;
+    usedBy: string;
+    status?: "active" | "inactive";
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+};
+
+declare function usePromoUsageRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TPromoUsage, session?: ClientSession) => Promise<string>;
+    getAll: ({ page, limit, promo, org, }?: {
+        page?: number | undefined;
+        limit?: number | undefined;
+        promo?: string | undefined;
+        org?: string | undefined;
+    }) => Promise<TPaginate<TPromoUsage>>;
+    getByPromo: (promo: string | ObjectId) => Promise<TPromoUsage | null>;
+    getById: (_id: string | ObjectId) => Promise<TPromoUsage | null>;
+    getByOrgId: (orgId: string | ObjectId) => Promise<TPromoUsage[]>;
+    countByPromoId: (promoId: string | ObjectId) => Promise<number>;
+    updateStatusByOrgId: (orgId: string | ObjectId, status: "active" | "inactive", session?: ClientSession) => Promise<string>;
+    deleteById: (_id: string | ObjectId) => Promise<string>;
+};
+
 type TRole = {
     _id?: ObjectId;
     id?: string | ObjectId;
@@ -1255,4 +1282,4 @@ declare const XENDIT_BASE_URL: string;
 declare const DOMAIN: string;
 declare const APP_ORG: string;
 
-export { ACCESS_TOKEN_EXPIRY, ACCESS_TOKEN_SECRET, APP_ACCOUNT, APP_MAIN, APP_ORG, DEFAULT_USER_EMAIL, DEFAULT_USER_FIRST_NAME, DEFAULT_USER_LAST_NAME, DEFAULT_USER_PASSWORD, DOMAIN, MAILER_EMAIL, MAILER_PASSWORD, MAILER_TRANSPORT_HOST, MAILER_TRANSPORT_PORT, MAILER_TRANSPORT_SECURE, MBuilding, MBuildingUnit, MFile, MONGO_DB, MONGO_URI, PAYPAL_API_URL, PAYPAL_CLIENT_ID, PAYPAL_CLIENT_SECRET, PAYPAL_WEBHOOK_ID, PORT, PaypalWebhookHeaders, REDIS_HOST, REDIS_PASSWORD, REDIS_PORT, REFRESH_TOKEN_EXPIRY, REFRESH_TOKEN_SECRET, SECRET_KEY, SPACES_ACCESS_KEY, SPACES_BUCKET, SPACES_ENDPOINT, SPACES_REGION, SPACES_SECRET_KEY, TApp, TBuilding, TBuildingUnit, TCounter, TFile, TJobPost, TLedgerBill, TMember, TOrg, TPermission, TPermissionGroup, TPlan, TPromo, TRole, TSubscribe, TSubscription, TSubscriptionTransaction, TUser, TVerification, TVerificationMetadata, VERIFICATION_FORGET_PASSWORD_DURATION, VERIFICATION_USER_INVITE_DURATION, XENDIT_BASE_URL, XENDIT_SECRET_KEY, currencies, isDev, ledgerBillStatuses, ledgerBillTypes, modelApp, modelJobPost, modelLedgerBill, modelMember, modelOrg, modelPermission, modelPermissionGroup, modelPlan, modelPromo, modelRole, modelSubscription, modelSubscriptionTransaction, modelUser, modelVerification, schemaApp, schemaAppUpdate, schemaBuilding, schemaBuildingUnit, schemaInviteMember, schemaJobPost, schemaJobPostUpdate, schemaLedgerBill, schemaLedgerBillingSummary, schemaMember, schemaMemberRole, schemaMemberStatus, schemaOrg, schemaOrgAdd, schemaOrgUpdate, schemaPermission, schemaPermissionGroup, schemaPermissionGroupUpdate, schemaPermissionUpdate, schemaPlan, schemaPromo, schemaRole, schemaRoleUpdate, schemaSubscribe, schemaSubscription, schemaSubscriptionCompute, schemaSubscriptionPromoCode, schemaSubscriptionSeats, schemaSubscriptionTransaction, schemaSubscriptionUpdate, schemaUpdateOptions, schemaUser, schemaVerification, transactionSchema, useAppController, useAppRepo, useAppService, useAuthController, useAuthService, useBuildingController, useBuildingRepo, useBuildingService, useBuildingUnitController, useBuildingUnitRepo, useBuildingUnitService, useCounterModel, useCounterRepo, useFileController, useFileRepo, useFileService, useGitHubService, useJobPostController, useJobPostRepo, useJobPostService, useLedgerBillingController, useLedgerBillingRepo, useMemberController, useMemberRepo, useOrgController, useOrgRepo, useOrgService, usePaypalService, usePermissionController, usePermissionGroupController, usePermissionGroupRepo, usePermissionGroupService, usePermissionRepo, usePermissionService, usePlanController, usePlanRepo, usePlanService, usePromoController, usePromoRepo, useRoleController, useRoleRepo, useRoleService, useSubscriptionController, useSubscriptionRepo, useSubscriptionService, useSubscriptionTransactionController, useSubscriptionTransactionRepo, useUserController, useUserRepo, useUserService, useUtilController, useVerificationController, useVerificationRepo, useVerificationService };
+export { ACCESS_TOKEN_EXPIRY, ACCESS_TOKEN_SECRET, APP_ACCOUNT, APP_MAIN, APP_ORG, DEFAULT_USER_EMAIL, DEFAULT_USER_FIRST_NAME, DEFAULT_USER_LAST_NAME, DEFAULT_USER_PASSWORD, DOMAIN, MAILER_EMAIL, MAILER_PASSWORD, MAILER_TRANSPORT_HOST, MAILER_TRANSPORT_PORT, MAILER_TRANSPORT_SECURE, MBuilding, MBuildingUnit, MFile, MONGO_DB, MONGO_URI, PAYPAL_API_URL, PAYPAL_CLIENT_ID, PAYPAL_CLIENT_SECRET, PAYPAL_WEBHOOK_ID, PORT, PaypalWebhookHeaders, REDIS_HOST, REDIS_PASSWORD, REDIS_PORT, REFRESH_TOKEN_EXPIRY, REFRESH_TOKEN_SECRET, SECRET_KEY, SPACES_ACCESS_KEY, SPACES_BUCKET, SPACES_ENDPOINT, SPACES_REGION, SPACES_SECRET_KEY, TApp, TBuilding, TBuildingUnit, TCounter, TFile, TJobPost, TLedgerBill, TMember, TOrg, TPermission, TPermissionGroup, TPlan, TPromo, TRole, TSubscribe, TSubscription, TSubscriptionTransaction, TUser, TVerification, TVerificationMetadata, VERIFICATION_FORGET_PASSWORD_DURATION, VERIFICATION_USER_INVITE_DURATION, XENDIT_BASE_URL, XENDIT_SECRET_KEY, currencies, isDev, ledgerBillStatuses, ledgerBillTypes, modelApp, modelJobPost, modelLedgerBill, modelMember, modelOrg, modelPermission, modelPermissionGroup, modelPlan, modelPromo, modelRole, modelSubscription, modelSubscriptionTransaction, modelUser, modelVerification, schemaApp, schemaAppUpdate, schemaBuilding, schemaBuildingUnit, schemaInviteMember, schemaJobPost, schemaJobPostUpdate, schemaLedgerBill, schemaLedgerBillingSummary, schemaMember, schemaMemberRole, schemaMemberStatus, schemaOrg, schemaOrgAdd, schemaOrgUpdate, schemaPermission, schemaPermissionGroup, schemaPermissionGroupUpdate, schemaPermissionUpdate, schemaPlan, schemaPromo, schemaRole, schemaRoleUpdate, schemaSubscribe, schemaSubscription, schemaSubscriptionCompute, schemaSubscriptionPromoCode, schemaSubscriptionSeats, schemaSubscriptionTransaction, schemaSubscriptionUpdate, schemaUpdateOptions, schemaUser, schemaVerification, transactionSchema, useAppController, useAppRepo, useAppService, useAuthController, useAuthService, useBuildingController, useBuildingRepo, useBuildingService, useBuildingUnitController, useBuildingUnitRepo, useBuildingUnitService, useCounterModel, useCounterRepo, useFileController, useFileRepo, useFileService, useGitHubService, useJobPostController, useJobPostRepo, useJobPostService, useLedgerBillingController, useLedgerBillingRepo, useMemberController, useMemberRepo, useOrgController, useOrgRepo, useOrgService, usePaypalService, usePermissionController, usePermissionGroupController, usePermissionGroupRepo, usePermissionGroupService, usePermissionRepo, usePermissionService, usePlanController, usePlanRepo, usePlanService, usePromoController, usePromoRepo, usePromoUsageRepo, useRoleController, useRoleRepo, useRoleService, useSubscriptionController, useSubscriptionRepo, useSubscriptionService, useSubscriptionTransactionController, useSubscriptionTransactionRepo, useUserController, useUserRepo, useUserService, useUtilController, useVerificationController, useVerificationRepo, useVerificationService };

package/dist/index.js

@@ -161,6 +161,7 @@ __export(src_exports, {
   usePlanService: () => usePlanService,
   usePromoController: () => usePromoController,
   usePromoRepo: () => usePromoRepo,
+  usePromoUsageRepo: () => usePromoUsageRepo,
   useRoleController: () => useRoleController,
   useRoleRepo: () => useRoleRepo,
   useRoleService: () => useRoleService,
@@ -5810,7 +5811,7 @@ function useSubscriptionRepo() {
     const validation = import_joi21.default.object({
       seats: import_joi21.default.number().integer().min(1).optional().allow("", null),
       paidSeats: import_joi21.default.number().integer().min(0).optional(),
-      amount: import_joi21.default.number().positive().optional(),
+      amount: import_joi21.default.number().positive().optional().allow(0),
       promoCode: import_joi21.default.string().max(50).optional().allow("", null),
       status: import_joi21.default.string().valid("active", "due", "overdue", "suspended").optional().allow("", null),
       nextBillingDate: import_joi21.default.date().optional().allow("", null)
@@ -7803,7 +7804,8 @@ var import_mongodb23 = require("mongodb");
 var schemaPromoUsage = import_joi34.default.object({
   promo: import_joi34.default.string().hex().length(24).required(),
   org: import_joi34.default.string().hex().length(24).required(),
-  usedBy: import_joi34.default.string().email().required()
+  usedBy: import_joi34.default.string().email().required(),
+  status: import_joi34.default.string().valid("active", "inactive").optional()
 });
 function modelPromoUsage(value) {
   const { error } = schemaPromoUsage.validate(value);
@@ -7817,14 +7819,14 @@ function modelPromoUsage(value) {
       throw new import_utils40.BadRequestError("Invalid Promo Usage _id");
     }
   }
-  if (typeof value.promo === "string") {
+  if (value.promo && typeof value.promo === "string") {
     try {
       value.promo = new import_mongodb23.ObjectId(value.promo);
     } catch (error2) {
       throw new import_utils40.BadRequestError("Invalid Promo Usage promo");
     }
   }
-  if (typeof value.org === "string") {
+  if (value.org && typeof value.org === "string") {
     try {
       value.org = new import_mongodb23.ObjectId(value.org);
     } catch (error2) {
@@ -7836,6 +7838,7 @@ function modelPromoUsage(value) {
     promo: value.promo,
     org: value.org,
     usedBy: value.usedBy,
+    status: value.status ?? "active",
     createdAt: value.createdAt ? new Date(value.createdAt) : /* @__PURE__ */ new Date(),
     updatedAt: value.updatedAt ?? ""
   };
@@ -7868,6 +7871,9 @@ function usePromoUsageRepo() {
   async function createIndexes() {
     try {
       await collection.createIndexes([
+        {
+          key: { status: 1 }
+        },
         {
           key: { promo: 1, org: 1 },
           name: "promo_org_index"
@@ -7880,10 +7886,10 @@ function usePromoUsageRepo() {
     } catch (error) {
     }
   }
-  async function add(value) {
+  async function add(value, session) {
     try {
       value = modelPromoUsage(value);
-      await collection.insertOne(value);
+      await collection.insertOne(value, { session });
       delCachedData();
       return "Successfully added promo usage.";
     } catch (error) {
@@ -8075,7 +8081,10 @@ function usePromoUsageRepo() {
       if (cachedData !== null && cachedData !== void 0) {
         return cachedData;
       }
-      const count = await collection.countDocuments({ promo: promoId });
+      const count = await collection.countDocuments({
+        promo: promoId,
+        status: "active"
+      });
       setCache(cacheKey, count).then(() => {
         import_utils41.logger.log({
           level: "info",
@@ -8092,6 +8101,28 @@ function usePromoUsageRepo() {
       throw new import_utils41.InternalServerError("Failed to count promo usages.");
     }
   }
+  async function updateStatusByOrgId(orgId, status, session) {
+    const { error } = import_joi35.default.string().hex().length(24).required().validate(orgId);
+    if (error) {
+      throw new import_utils41.BadRequestError(`Invalid org ID: ${error.message}`);
+    }
+    try {
+      orgId = new import_mongodb24.ObjectId(orgId);
+    } catch (error2) {
+      throw new import_utils41.BadRequestError("Invalid org ID.");
+    }
+    try {
+      await collection.updateMany(
+        { org: orgId, status: "active" },
+        { $set: { status, updatedAt: /* @__PURE__ */ new Date() } },
+        { session }
+      );
+      delCachedData();
+      return "Successfully updated promo usage status.";
+    } catch (error2) {
+      throw new import_utils41.InternalServerError("Failed to update promo usage status.");
+    }
+  }
   async function deleteById(_id) {
     const { error } = import_joi35.default.string().hex().length(24).required().validate(_id);
     if (error) {
@@ -8124,6 +8155,7 @@ function usePromoUsageRepo() {
     getById,
     getByOrgId,
     countByPromoId,
+    updateStatusByOrgId,
     deleteById
   };
 }
@@ -8300,6 +8332,11 @@ function useSubscriptionService() {
   const { getDefault: getDefaultPlan, getById: getPlanById } = usePlanRepo();
   const { getById: getOrgById, updateStatusById: updateOrgStatusById } = useOrgRepo();
   const { getByCode: getPromoByCode } = usePromoRepo();
+  const {
+    countByPromoId,
+    add: addPromoUsage,
+    updateStatusByOrgId: updatePromoUsageStatusByOrgId
+  } = usePromoUsageRepo();
   const { getByApp: getMembershipByApp } = useMemberRepo();
   function calculateVolumeTierAmount(tiers, startSeat, seatCount, fallbackRate) {
     const sortedTiers = [...tiers].sort((a, b) => a.minSeats - b.minSeats);
@@ -8350,16 +8387,33 @@ function useSubscriptionService() {
       if (!promo) {
         throw new import_utils44.BadRequestError("Promo code not found.");
       }
+      if (promo.usage && promo.usage > 0) {
+        const currentUsageCount = await countByPromoId(
+          promo._id?.toString() ?? ""
+        );
+        const isAlreadyUsingPromo = existingSubscription?.promoCode === promoCode;
+        if (!isAlreadyUsingPromo && currentUsageCount >= promo.usage) {
+          throw new import_utils44.BadRequestError(
+            "Promo code has reached its maximum usage limit."
+          );
+        }
+      }
     }
     let monthlyAmount = plan.price * value.seats;
     if (promo) {
+      const promoSeatLimit = promo.seats && promo.seats > 0 ? promo.seats : Infinity;
       switch (promo.type) {
-        case "fixed":
-          monthlyAmount = Math.max(promo.fixedRate ?? 0, 0) * value.seats;
+        case "fixed": {
+          const promoSeats = Math.min(value.seats, promoSeatLimit);
+          const standardSeats = Math.max(value.seats - promoSeatLimit, 0);
+          monthlyAmount = Math.max(promo.fixedRate ?? 0, 0) * promoSeats + plan.price * standardSeats;
           break;
-        case "flat":
-          monthlyAmount = Math.max((promo.flatRate ?? 0) / value.seats, 0) * value.seats;
+        }
+        case "flat": {
+          const standardSeats = Math.max(value.seats - promoSeatLimit, 0);
+          monthlyAmount = (promo.flatRate ?? 0) + plan.price * standardSeats;
           break;
+        }
         case "volume": {
           if (promo.tiers && promo.tiers.length > 0) {
             monthlyAmount = calculateVolumeTierAmount(
@@ -8402,17 +8456,32 @@ function useSubscriptionService() {
             plan.price
           );
         } else if (promo?.type === "fixed") {
-          const discountedPricePerSeat = Math.max(
-            plan.price - (promo.fixedRate ?? 0),
-            0
+          const promoSeatLimit = promo.seats && promo.seats > 0 ? promo.seats : Infinity;
+          const startSeat = existingSubscription.paidSeats + 1;
+          const endSeat = value.seats;
+          const promoSeatsInRange = Math.max(
+            0,
+            Math.min(promoSeatLimit, endSeat) - startSeat + 1
           );
-          additionalSeatsAmount = discountedPricePerSeat * additionalSeats;
-        } else if (promo?.type === "flat") {
-          const effectivePricePerSeat = Math.max(
-            plan.price - (promo.flatRate ?? 0) / value.seats,
-            0
+          const standardSeatsInRange = Math.max(
+            0,
+            additionalSeats - promoSeatsInRange
           );
-          additionalSeatsAmount = effectivePricePerSeat * additionalSeats;
+          additionalSeatsAmount = (promo.fixedRate ?? 0) * promoSeatsInRange + plan.price * standardSeatsInRange;
+        } else if (promo?.type === "flat") {
+          const promoSeatLimit = promo.seats && promo.seats > 0 ? promo.seats : Infinity;
+          const startSeat = existingSubscription.paidSeats + 1;
+          const endSeat = value.seats;
+          if (startSeat > promoSeatLimit) {
+            additionalSeatsAmount = plan.price * additionalSeats;
+          } else {
+            const seatsStillCoveredByFlat = Math.max(
+              0,
+              Math.min(promoSeatLimit, endSeat) - startSeat + 1
+            );
+            const seatsAtPlanPrice = additionalSeats - seatsStillCoveredByFlat;
+            additionalSeatsAmount = plan.price * seatsAtPlanPrice;
+          }
         } else {
           additionalSeatsAmount = plan.price * additionalSeats;
         }
@@ -8420,17 +8489,24 @@ function useSubscriptionService() {
         proratedAmount = dailyRate * daysRemaining;
       }
     }
-    const isDecrease = existingSubscription && value.seats < existingSubscription.paidSeats;
+    const isIncrease = existingSubscription && value.seats > existingSubscription.paidSeats;
+    let subscriptionAmount;
+    if (!existingSubscription) {
+      subscriptionAmount = Math.round(monthlyAmount * 100) / 100;
+    } else if (proratedAmount > 0) {
+      subscriptionAmount = Math.round((existingSubscription.amount + proratedAmount) * 100) / 100;
+    } else if (isIncrease) {
+      subscriptionAmount = Math.round(monthlyAmount * 100) / 100;
+    } else {
+      subscriptionAmount = Math.round(existingSubscription.amount * 100) / 100;
+    }
     return {
       // The monthly fee for the next billing cycle
       monthlyAmount: Math.round(monthlyAmount * 100) / 100,
       // The prorated amount to charge now for mid-cycle seat additions
       proratedAmount: Math.round(proratedAmount * 100) / 100,
       // The new subscription.amount for updates
-      // - Seat increase with proration: existing amount + prorated
-      // - Seat decrease: keep existing amount (decrease takes effect next cycle)
-      // - Same day change or no proration: use monthlyAmount
-      subscriptionAmount: existingSubscription ? proratedAmount > 0 ? Math.round((existingSubscription.amount + proratedAmount) * 100) / 100 : isDecrease ? Math.round(existingSubscription.amount * 100) / 100 : Math.round(monthlyAmount * 100) / 100 : Math.round(monthlyAmount * 100) / 100,
+      subscriptionAmount,
       currency: plan.currency
     };
   }
@@ -8477,6 +8553,13 @@ function useSubscriptionService() {
         org: value.org,
         plan: value.plan
       });
+      let promo = null;
+      if (value.promoCode) {
+        promo = await getPromoByCode(value.promoCode);
+        if (!promo) {
+          throw new import_utils44.BadRequestError("Promo code not found.");
+        }
+      }
       const subId = await _add(
         {
           org: value.org,
@@ -8492,6 +8575,16 @@ function useSubscriptionService() {
         },
         session
       );
+      if (promo && promo._id) {
+        await addPromoUsage(
+          {
+            promo: promo._id,
+            org: value.org,
+            usedBy: userData.email
+          },
+          session
+        );
+      }
       await addTransaction(
         {
           type: "initiate",
@@ -8648,6 +8741,19 @@ function useSubscriptionService() {
         { promoCode: value.promoCode ?? "", amount: subscriptionAmount },
         session
       );
+      if (subscription.promoCode) {
+        await updatePromoUsageStatusByOrgId(value.org, "inactive", session);
+      }
+      if (promo && promo._id) {
+        await addPromoUsage(
+          {
+            promo: promo._id,
+            org: value.org,
+            usedBy: userData.email
+          },
+          session
+        );
+      }
       await addTransaction(
         {
           type: "promo-updated",
@@ -13531,6 +13637,7 @@ function useJobPostController() {
   usePlanService,
   usePromoController,
   usePromoRepo,
+  usePromoUsageRepo,
   useRoleController,
   useRoleRepo,
   useRoleService,