@b2y/ecommerce-common 1.2.5 → 1.2.7

package/constants/StatusMessageConstants.js

@@ -33,7 +33,6 @@ const StatusMessageConstants = {
     TENANT_SETTINGS_ALREADY_EXISTS: 'Tenant settings already exist for this tenant',
     INVALID_REQUEST: 'Invalid request',
     TENANT_SETTINGS_UPDATE_ERROR: 'Failed to update tenant settings',
-    TENANT_SETTINGS_SINGLE_LOGO_ALLOWED: "Only one logo is allowed per tenant.",
     //Location
     STATE_CODE_COUNTRY_CODE_REQUIRE: "State code and country code are required to fetch cities",
     CITIES_NOT_FOUND: "No cities found for given state code",

package/controller/TenantAbstractController.js

@@ -1,352 +1,8 @@
 const LocationUtility = require('../utility/LocationUtility');
 const StatusMessage = require('../constants/StatusMessageConstants');
 const AppUtil = require('../utility/AppUtil');
-const SubscriptionStatusEnum = require('../enum/SubscriptionStatusEnum');
-const AppConstants = require('../constants/AppConstants');
 const EntityTypeEnum = require('../enum/EntityTypeEnum');
-const updateTenant = (
-  Tenant,
-  TenantSubscription,
-  SubscriptionPlan,
-  UpdatedBy,
-  sequelize,
-  logger,
-) => {
-  return async (req, res) => {
-    let transaction;
-    try {
-      const tenantId =
-        req.params && req.params.TenantID
-          ? req.params.TenantID
-          : req.body.TenantID;
-      if (!tenantId) {
-        logger.warn("TenantID is required for update.");
-        return AppUtil.generateResponse(
-          400,
-          StatusMessage.FAILURE,
-          StatusMessage.TENANT_ID_REQUIRED_FIELD,
-          null,
-          res,
-        );
-      }
-
-      const existing = await Tenant.findOne({ where: { TenantID: tenantId } });
-      if (!existing) {
-        logger.warn("Tenant not found with ID:", tenantId);
-        return AppUtil.generateResponse(
-          404,
-          StatusMessage.FAILURE,
-          StatusMessage.TENANT_NOT_FOUND,
-          null,
-          res,
-        );
-      }
-
-      const {
-        CompanyName,
-        CompanyCode,
-        Email,
-        PhoneNumber,
-        CountryCallingCode,
-        GSTNo,
-        CustomerPortalDomain,
-        AdminPortalDomain,
-        AddressLine,
-        CityName,
-        StateCode,
-        CountryCode,
-        Zipcode,
-        SubscriptionPlanID,
-        Status,
-        StartDate,
-        EndDate,
-        AutoRenew,
-        IsTrial,
-        GraceEndDate,
-        TrialEndDate,
-      } = req.body;
-
-      // Validate optional fields when provided
-      if (Email && !AppUtil.isValidEmail(Email)) {
-        logger.warn("Invalid email format provided for update.");
-        return AppUtil.generateResponse(
-          400,
-          StatusMessage.FAILURE,
-          StatusMessage.INVALID_EMAIL_FORMAT,
-          null,
-          res,
-        );
-      }
-
-      if (PhoneNumber && !AppUtil.isValidPhone(PhoneNumber)) {
-        logger.warn("Invalid phone number format provided for update.");
-        return AppUtil.generateResponse(
-          400,
-          StatusMessage.FAILURE,
-          StatusMessage.INVALID_PHONE_FORMAT,
-          null,
-          res,
-        );
-      }
-
-      if (CompanyCode !== undefined) {
-        if (
-          !Number.isInteger(Number(CompanyCode)) ||
-          Number(CompanyCode) <= 0
-        ) {
-          logger.warn("Invalid company code provided for update.");
-          return AppUtil.generateResponse(
-            400,
-            StatusMessage.FAILURE,
-            StatusMessage.INVALID_COMPANY_CODE,
-            null,
-            res,
-          );
-        }
-      }
-
-      // Validate country code, state code and city name
-      if (CountryCode && StateCode && CityName && CountryCallingCode) {
-        const validation = await LocationUtility.validateCountryAndState(
-          CountryCode,
-          StateCode,
-          CityName,
-          CountryCallingCode,
-          logger,
-        );
-        if (!validation.isValid) {
-          return AppUtil.generateResponse(
-            400,
-            StatusMessage.FAILURE,
-            validation.error,
-            null,
-            res,
-          );
-        }
-      }
-      if (Status && !Object.values(SubscriptionStatusEnum).includes(Status)) {
-        logger.warn("Invalid Subscription status");
-        return AppUtil.generateResponse(
-          400,
-          StatusMessage.FAILURE,
-          StatusMessage.INVALID_SUBSCRIPTION_STATUS,
-          null,
-          res,
-        );
-      }
-
-      if (
-        AutoRenew !== undefined &&
-        typeof AutoRenew !== AppConstants.BOOLEAN
-      ) {
-        logger.warn("AutoRenew must be boolean type");
-        return AppUtil.generateResponse(
-          400,
-          StatusMessage.FAILURE,
-          StatusMessage.INVALID_BOOLEAN_TYPE.replace("{field}", "AutoRenew"),
-          null,
-          res,
-        );
-      }
-      if (IsTrial !== undefined && typeof IsTrial !== AppConstants.BOOLEAN) {
-        logger.warn("IsTrial must be boolean type");
-        return AppUtil.generateResponse(
-          400,
-          StatusMessage.FAILURE,
-          StatusMessage.INVALID_BOOLEAN_TYPE.replace("{field}", "IsTrial"),
-          null,
-          res,
-        );
-      }
-      transaction = await sequelize.transaction();
-      if (SubscriptionPlanID) {
-        const subscriptionPlan = await SubscriptionPlan.findOne({
-          where: {
-            SubscriptionPlanID,
-            IsActive: true,
-          },
-          transaction,
-        });
-        if (!subscriptionPlan) {
-          await transaction.rollback();
-          logger.warn("subscription plan not found");
-          return AppUtil.generateResponse(
-            404,
-            StatusMessage.FAILURE,
-            StatusMessage.SUBSCRIPTION_PLAN_NOT_FOUND,
-            null,
-            res,
-          );
-        }
-      }
-      // Build update payload only with provided fields
-      const updatePayload = {};
-      const fields = {
-        CompanyName,
-        CompanyCode,
-        Email,
-        PhoneNumber,
-        CountryCode,
-        GSTNo,
-        CustomerPortalDomain,
-        AdminPortalDomain,
-        AddressLine,
-        CityName,
-        StateCode,
-        CountryCallingCode,
-        Zipcode,
-      };
-      Object.keys(fields).forEach((k) => {
-        if (fields[k] !== undefined)
-          updatePayload[k] =
-            k === AppConstants.COMPANY_CODE ? Number(fields[k]) : fields[k];
-      });
-
-      updatePayload.UpdatedBy =
-        UpdatedBy;
-      updatePayload.UpdatedAt = new Date();
-
-      await existing.update(updatePayload, { transaction });
-
-      // update subscription
-      const updateSubscriptionPayload = {};
-      const updateSubscriptionfields = {
-        SubscriptionPlanID,
-        Status,
-        StartDate,
-        EndDate,
-        GraceEndDate,
-        TrialEndDate,
-        IsTrial,
-        AutoRenew,
-      };
-      Object.keys(updateSubscriptionfields).forEach((k) => {
-        if (updateSubscriptionfields[k] !== undefined)
-          updateSubscriptionPayload[k] = updateSubscriptionfields[k];
-      });
-      if (Object.keys(updateSubscriptionPayload).length !== 0) {
-        updateSubscriptionPayload.UpdatedBy = UpdatedBy;
-        updateSubscriptionPayload.UpdatedAt = new Date();
 
-        // find the existing subscription
-        const tenantSubscription = await TenantSubscription.findOne({
-          where: {
-            TenantID: tenantId,
-          },
-          transaction,
-        });
-        if (tenantSubscription) {
-          await tenantSubscription.update(updateSubscriptionPayload, {
-            transaction,
-          });
-        } else {
-          await TenantSubscription.create(
-            {
-              TenantID: tenantId,
-              ...updateSubscriptionPayload,
-              CreatedBy:UpdatedBy,
-              UpdatedBy: UpdatedBy,
-              CreatedAt: new Date(),
-              UpdatedAt: new Date()
-            },
-            { transaction },
-          );
-        }
-      }
-      await transaction.commit();
-
-      logger.info("Tenant updated successfully with ID:", tenantId);
-      return AppUtil.generateResponse(
-        200,
-        StatusMessage.SUCCESS,
-        StatusMessage.TENANT_UPDATED_SUCCESS,
-        null,
-        res,
-      );
-    } catch (error) {
-      if (transaction) await transaction.rollback();
-
-      if (error.name === "SequelizeUniqueConstraintError") {
-        const detail = error.original?.detail || "";
-        if (detail.includes(AppConstants.COMPANY_NAME)) {
-          return AppUtil.generateResponse(
-            400,
-            StatusMessage.FAILURE,
-            StatusMessage.COMPANY_NAME_EXISTS,
-            null,
-            res,
-          );
-        } else if (detail.includes(AppConstants.COMPANY_CODE)) {
-          return AppUtil.generateResponse(
-            400,
-            StatusMessage.FAILURE,
-            StatusMessage.COMPANY_CODE_EXISTS,
-            null,
-            res,
-          );
-        } else if (detail.includes(AppConstants.EMAIL)) {
-          return AppUtil.generateResponse(
-            400,
-            StatusMessage.FAILURE,
-            StatusMessage.EMAIL_EXISTS,
-            null,
-            res,
-          );
-        } else if (detail.includes(AppConstants.PHONE_NUMBER)) {
-          return AppUtil.generateResponse(
-            400,
-            StatusMessage.FAILURE,
-            StatusMessage.PHONE_NUMBER_EXISTS,
-            null,
-            res,
-          );
-        } else if (detail.includes(AppConstants.CUSTOMER_PORTAL_DOMAIN)) {
-          return AppUtil.generateResponse(
-            400,
-            StatusMessage.FAILURE,
-            StatusMessage.CUSTOMER_PORTAL_DOMAIN_EXISTS,
-            null,
-            res,
-          );
-        } else if (detail.includes(AppConstants.ADMIN_PORTAL_DOMAIN)) {
-          return AppUtil.generateResponse(
-            400,
-            StatusMessage.FAILURE,
-            StatusMessage.ADMIN_PORTAL_DOMAIN_EXISTS,
-            null,
-            res,
-          );
-        }
-        return AppUtil.generateResponse(
-          400,
-          StatusMessage.FAILURE,
-          StatusMessage.TENANT_ALREADY_EXISTS,
-          null,
-          res,
-        );
-      } else if (error.name === "SequelizeValidationError") {
-        const details = error.errors.map((e) => e.message);
-        logger.warn(`Validation Error detected: ${details.join("; ")}`);
-        return AppUtil.generateResponse(
-          400,
-          StatusMessage.FAILURE,
-          StatusMessage.INVALID_REQUEST,
-          null,
-          res,
-        );
-      } else {
-        logger.error("Error in UpdateTenant:", error);
-        return AppUtil.generateResponse(
-          500,
-          StatusMessage.FAILURE,
-          StatusMessage.TENANT_UPDATE_ERROR,
-          null,
-          res,
-        );
-      }
-    }
-  };
-};
 
 const getTenantById = (
   Tenant,
@@ -402,7 +58,7 @@ const getTenantById = (
               {
                 model: SubscriptionPlan,
                 as: "SubscriptionPlan",
-                attributes: ["SubscriptionPlanID", "PlanName", "PlanCode"],
+                attributes: ["SubscriptionPlanID", "PlanName", "PlanCode", "BillingCycle"],
               },
             ],
           },
@@ -462,6 +118,7 @@ const getTenantById = (
         TenantLogo: logo,
         SubscriptionPlanID: tenant.CurrentSubscription?.SubscriptionPlan?.SubscriptionPlanID,
         PlanName: tenant.CurrentSubscription?.SubscriptionPlan?.PlanName,
+        BillingCycle: tenant.CurrentSubscription?.SubscriptionPlan?.BillingCycle,
         TenantSubscriptionStatus: tenant.CurrentSubscription?.Status,
         StartDate: tenant.CurrentSubscription?.StartDate,
         EndDate: tenant.CurrentSubscription?.EndDate,
@@ -491,5 +148,5 @@ const getTenantById = (
   };
 };
 
-module.exports = { updateTenant, getTenantById };
+module.exports = { getTenantById };
 

package/enum/AccessModeEnum.js

@@ -2,7 +2,8 @@ const AccessModeEnum = Object.freeze({
   FULL: "Full",
   READ_ONLY: "Read Only",
   BLOCKED: "Blocked",
-  PAYMENT_REQUIRED: "Payment Required"
+  PAYMENT_REQUIRED: "Payment Required",
+  RENEW_SUBSCRIPTION: "Renew Subscription"
 });
 
 module.exports = AccessModeEnum;

package/model/TenantSubscription.js

@@ -28,7 +28,7 @@ module.exports = (sequelize) => {
       },
       EndDate: {
         type: DataTypes.DATE,
-        allowNull: false,
+        allowNull: true,
       },
       GraceEndDate: {
         type: DataTypes.DATE,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@b2y/ecommerce-common",
-  "version": "1.2.5",
+  "version": "1.2.7",
   "description": "E-commerce common library",
   "main": "index.js",
   "scripts": {

package/utility/ResolveAccessMode.js

@@ -4,25 +4,48 @@ function ResolveAccessMode(subscription) {
   const now = new Date(); 
  
   if (!subscription) return AccessModeEnum.BLOCKED; 
+  const status = subscription.Status;
+  // paid endDate
+  const endDate = subscription.EndDate
+    ? new Date(subscription.EndDate)
+    : null;
+    // paid graceEndDate
+    const graceEndDate = subscription.GraceEndDate
+    ? new Date(subscription.GraceEndDate)
+    : null;
+  //trialEndDate
+  const trialEndDate = subscription.TrialEndDate
+    ? new Date(subscription.TrialEndDate)
+    : null;
+
  
-  if ([SubscriptionStatusEnum.CANCELLED, SubscriptionStatusEnum.EXPIRED, SubscriptionStatusEnum.SUSPENDED].includes(subscription.Status)) { 
+  if (status === SubscriptionStatusEnum.SUSPENDED) { 
     return AccessModeEnum.BLOCKED; 
   } 
+  if(status === SubscriptionStatusEnum.EXPIRED) {
+    return AccessModeEnum.RENEW_SUBSCRIPTION;
+  }
+  // CANCELLED -> still allow till expiry
+  if(status === SubscriptionStatusEnum.CANCELLED) {
+   if (endDate && now < endDate) {
+      return AccessModeEnum.FULL;
+    }
 
+    if (graceEndDate && now <= graceEndDate) {
+      return AccessModeEnum.READ_ONLY;
+    }
+
+    return AccessModeEnum.RENEW_SUBSCRIPTION;
+  }
   if (subscription.Status === SubscriptionStatusEnum.ACTIVE) {
+    // trial plan
     if (subscription.IsTrial === true) {
-      const trialEndDate = subscription.TrialEndDate
-        ? new Date(subscription.TrialEndDate)
-        : null;
       if (trialEndDate && now < trialEndDate) {
         return AccessModeEnum.FULL;
       }
       return AccessModeEnum.PAYMENT_REQUIRED;
     }
-    const endDate = new Date(subscription.EndDate);
-    const graceEndDate = subscription.GraceEndDate
-      ? new Date(subscription.GraceEndDate)
-      : null;
+    // paid plan
     // Still in the paid period
     if (now < endDate) {
       return AccessModeEnum.FULL;
@@ -32,7 +55,7 @@ function ResolveAccessMode(subscription) {
       return AccessModeEnum.READ_ONLY;
     }
     // Past both EndDate and Grace Period
-    return AccessModeEnum.BLOCKED;
+    return AccessModeEnum.RENEW_SUBSCRIPTION;
   }
   return AccessModeEnum.BLOCKED; 
 };