@b2y/ecommerce-common 1.1.5 → 1.1.7

package/README.md

@@ -1,4 +1,4 @@
-# ecommerce-common
-E-commerce common library 
-A reusable, modular **common package** containing shared models, utilities, enums, helpers, and base configurations for the E-Commerce platform.  
-This package centralizes ecommerce-Admin and ecommerce-customer cross-project logic so multiple services can stay consistent and maintainable.
+# ecommerce-common
+E-commerce common library 
+A reusable, modular **common package** containing shared models, utilities, enums, helpers, and base configurations for the E-Commerce platform.  
+This package centralizes ecommerce-Admin and ecommerce-customer cross-project logic so multiple services can stay consistent and maintainable.

package/constants/AppConstants.js

@@ -1,7 +1,15 @@
-const AppConstants = {
-    DASHBOARD_DEFAULT_DAYS : 7,
-    LAST_30DAYS: 'LAST30DAYS',
-    LAST_6MONTHS: 'LAST6MONTHS',
-    OLDER: 'OLDER',
-}
+const AppConstants = {
+    DASHBOARD_DEFAULT_DAYS : 7,
+    LAST_30DAYS: 'LAST30DAYS',
+    LAST_6MONTHS: 'LAST6MONTHS',
+    OLDER: 'OLDER',
+    COMPANY_NAME: 'CompanyName',
+    COMPANY_CODE: 'CompanyCode',
+    EMAIL: 'Email',
+    PHONE_NUMBER: 'PhoneNumber',
+    CUSTOMER_PORTAL_DOMAIN: 'CustomerPortalDomain',
+    ADMIN_PORTAL_DOMAIN: 'AdminPortalDomain',
+    CREATED_BY:'0000d6ab-8064-4786-a906-f458567224b8',
+    BOOLEAN:'boolean'
+}
 module.exports = AppConstants;

package/constants/ReportConstants.js

@@ -1,15 +1,15 @@
-
-const EXCEL_METADATA = {
-  CREATOR: "Ecommerce System", // this can be customized as per requirement
-  LAST_MODIFIED_BY: "Ecommerce System"
-};
-
-const EXCEL_DEFAULT_THEME = {
-  HEADER_FILL_COLOR: "1E90FF",  // default header color
-  HEADER_FONT_COLOR: "FFFFFFFF"
-};
-
-module.exports = {
-  EXCEL_METADATA,
-  EXCEL_DEFAULT_THEME
+
+const EXCEL_METADATA = {
+  CREATOR: "Ecommerce System", // this can be customized as per requirement
+  LAST_MODIFIED_BY: "Ecommerce System"
+};
+
+const EXCEL_DEFAULT_THEME = {
+  HEADER_FILL_COLOR: "1E90FF",  // default header color
+  HEADER_FONT_COLOR: "FFFFFFFF"
+};
+
+module.exports = {
+  EXCEL_METADATA,
+  EXCEL_DEFAULT_THEME
 };

package/constants/StatusMessageConstants.js

@@ -1,18 +1,55 @@
-const StatusMessageConstants = {
-    PRODUCTVARIANT_INVALID_MRP: 'Invalid MRP: must be positive',
-    PRODUCTVARIANT_MISSING_PRICE_OR_DISCOUNT: 'Either SellingPrice or DiscountPercentage must be provided',
-    PRODUCTVARIANT_INCONSISTENT_PRICING: 'Inconsistent pricing: provided discount percentage does not match calculated value',
-    PRODUCTVARIANT_SELLING_PRICE_EXCEEDS_MRP: 'SellingPrice cannot exceed MRP',
-    PRODUCTVARIANT_INVALID_SELLING_PRICE: 'SellingPrice cannot be negative',
-    PRODUCTVARIANT_INVALID_DISCOUNT_PERCENTAGE: 'DiscountPercentage must be between 0 and 100',
-    INVALID_DATE_FORMAT: "Invalid date format",
-    INVALID_DATE_RANGE: "StartDate cannot be after EndDate",
-    DATE_RANGE_REQUIRED: "Both startDate and endDate must be provided together",
-    INVALID_END_DATE: "Invalid endDate",
-    INVALID_START_DATE: "Invalid startDate",
-    INVALID_ISACTIVE_STATUS:  "IsActive must be either true or false",
-    ORDER_CREATION_FAILED:"Order creation failed",
-    PAYMENT_SIGNATURE_VERIFICATION_FAILED:"Payment signature verification failed",
-    PAYMENT_VERIFICATION_FAILED:"Payment verification failed"
-}
+const StatusMessageConstants = {
+    SUCCESS: 'Success',
+    FAILURE: 'Failure',
+    INVALID_REQUEST: 'Invalid request parameters',
+    SERVER_ERROR: 'Internal server error',
+    // Tenant
+    TENANT_NOT_FOUND: 'Tenant not found',
+    TENANT_ID_REQUIRED_FIELD: 'TenantID is required for updating the tenant',
+    TENANT_UPDATED_SUCCESS: 'Tenant updated successfully',
+    TENANT_UPDATE_ERROR: 'Failed to update tenant',
+    TENANT_ALREADY_EXISTS: 'Tenant with this information already exists',
+    INVALID_EMAIL_FORMAT: 'Invalid email format provided',
+    INVALID_PHONE_FORMAT: 'Phone number must be 10-20 digits',
+    INVALID_COMPANY_CODE: 'Company code must be a valid positive integer',
+    INVALID_SUBSCRIPTION_STATUS: "Invalid subscription status",
+    COMPANY_NAME_EXISTS: 'Company name already exists',
+    COMPANY_CODE_EXISTS: 'Company code already exists',
+    EMAIL_EXISTS: 'Email already exists',
+    PHONE_NUMBER_EXISTS: 'Phone number already exists',
+    CUSTOMER_PORTAL_DOMAIN_EXISTS: 'Customer portal domain already exists',
+    ADMIN_PORTAL_DOMAIN_EXISTS: 'Admin portal domain already exists',
+    INVALID_START_END_DATE: 'End date can not be before start date',
+    SUBSCRIPTION_PLAN_NOT_FOUND: "Subscription plan not found",
+    INVALID_BOOLEAN_TYPE: "{field} must be boolean value",
+
+    //TenantSettings
+    TENANT_SETTINGS_NOT_FOUND: "Tenant settings not foundd",
+
+    //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",
+    COUNTRY_CODE_REQUIRE: "Country code is required to fetch states",
+    STATES_NOT_FOUND: "No states found for given country code",
+    STATES_FETCH_ERROR: "Error occured while fetching states",
+    CITIES_FETCH_ERROR: "Error occurred while fetching cities",
+    COUNTRIES_FETCH_ERROR: "Error occurred while fetching countries",
+
+    // Product Variant
+    PRODUCTVARIANT_INVALID_MRP: 'Invalid MRP: must be positive',
+    PRODUCTVARIANT_MISSING_PRICE_OR_DISCOUNT: 'Either SellingPrice or DiscountPercentage must be provided',
+    PRODUCTVARIANT_INCONSISTENT_PRICING: 'Inconsistent pricing: provided discount percentage does not match calculated value',
+    PRODUCTVARIANT_SELLING_PRICE_EXCEEDS_MRP: 'SellingPrice cannot exceed MRP',
+    PRODUCTVARIANT_INVALID_SELLING_PRICE: 'SellingPrice cannot be negative',
+    PRODUCTVARIANT_INVALID_DISCOUNT_PERCENTAGE: 'DiscountPercentage must be between 0 and 100',
+    INVALID_DATE_FORMAT: "Invalid date format",
+    INVALID_DATE_RANGE: "StartDate cannot be after EndDate",
+    DATE_RANGE_REQUIRED: "Both startDate and endDate must be provided together",
+    INVALID_END_DATE: "Invalid endDate",
+    INVALID_START_DATE: "Invalid startDate",
+    INVALID_ISACTIVE_STATUS:  "IsActive must be either true or false",
+    ORDER_CREATION_FAILED:"Order creation failed",
+    PAYMENT_SIGNATURE_VERIFICATION_FAILED:"Payment signature verification failed",
+    PAYMENT_VERIFICATION_FAILED:"Payment verification failed"
+}
 module.exports = StatusMessageConstants;

package/controller/LocationController.js

@@ -0,0 +1,144 @@
+const {
+  getCountries,
+  getStatesOfCountry,
+  getCitiesOfState,
+} = require("@countrystatecity/countries");
+const AppUtil = require("../utility/AppUtil");
+const StatusMessage = require("../constants/StatusMessageConstants");
+
+// Get all cities by state filters
+const getCitiesByState = (logger) => {
+return async (req, res) => {
+  try {
+    const { countryCode, stateCode } = req.params;
+    if (!countryCode || !stateCode) {
+      return AppUtil.generateResponse(
+        400,
+        StatusMessage.FAILURE,
+        StatusMessage.STATE_CODE_COUNTRY_CODE_REQUIRE,
+        null,
+        res,
+      );
+    }
+    const cities = await getCitiesOfState(countryCode, stateCode);
+    if (!cities || cities.length === 0) {
+      logger.debug("No cities found for state code:", stateCode);
+      return AppUtil.generateResponse(
+        200,
+        StatusMessage.SUCCESS,
+        StatusMessage.CITIES_NOT_FOUND,
+        null,
+        res,
+      );
+    }
+    const cityNames = cities.map((c) => ({
+      CityName: c.name,
+      latitude: c.latitude,
+      longitude: c.longitude,
+    }));
+    logger.debug("cities retrieved successfully");
+    return AppUtil.generateResponse(
+      200,
+      StatusMessage.SUCCESS,
+      null,
+      cityNames,
+      res,
+    );
+  } catch (error) {
+    logger.error("Invalid filter format:", error);
+    return AppUtil.generateResponse(
+      500,
+      StatusMessage.FAILURE,
+      StatusMessage.CITIES_FETCH_ERROR,
+      null,
+      res,
+    );
+  }
+};
+}
+
+const getStatesByCountry = (logger) => {
+return async (req, res) => {
+  try {
+    const { countryCode } = req.params;
+    if (!countryCode) {
+      return AppUtil.generateResponse(
+        400,
+        StatusMessage.FAILURE,
+        StatusMessage.COUNTRY_CODE_REQUIRE,
+        null,
+        res,
+      );
+    }
+    const states = await getStatesOfCountry(countryCode);
+    if (!states || states.length === 0) {
+      logger.debug("No states found for country code:", countryCode);
+      return AppUtil.generateResponse(
+        200,
+        StatusMessage.SUCCESS,
+        StatusMessage.STATES_NOT_FOUND,
+        null,
+        res,
+      );
+    }
+    // Transform to simpler format
+    const formattedStates = states.map((s) => ({
+      Code: s.iso2,
+      StateName: s.name,
+      StateCode: s.state_code,
+    }));
+    logger.debug("States retrieved successfully");
+    return AppUtil.generateResponse(
+      200,
+      StatusMessage.SUCCESS,
+      null,
+      formattedStates,
+      res,
+    );
+  } catch (error) {
+    logger.error("Error searching for country:", error);
+    return AppUtil.generateResponse(
+      500,
+      StatusMessage.FAILURE,
+      StatusMessage.STATES_FETCH_ERROR,
+      null,
+      res,
+    );
+  }
+};
+}
+
+//Getall countries list
+const getAllCountries = (logger) => {
+return async (req, res) => {
+  try {
+    const countries = await getCountries();
+    // transform to simpler format
+    const formattedCountries = countries.map((country) => ({
+      CountryCode: country.iso2,
+      CountryName: country.name,
+      iso3: country.iso3,
+      PhoneCode: country.phonecode,
+      flag: country.emoji,
+    }));
+    return AppUtil.generateResponse(
+      200,
+      StatusMessage.SUCCESS,
+      null,
+      formattedCountries,
+      res,
+    );
+  } catch (error) {
+    logger.error("Error fetching countries:", error);
+    return AppUtil.generateResponse(
+      500,
+      StatusMessage.FAILURE,
+      StatusMessage.COUNTRIES_FETCH_ERROR,
+      null,
+      res,
+    );
+  }
+};
+}
+
+module.exports = { getCitiesByState, getStatesByCountry, getAllCountries };

package/controller/SubscriptionAbstractController.js

@@ -0,0 +1,161 @@
+const StatusMessage = require('../constants/StatusMessageConstants');
+const AppUtil = require('../utility/AppUtil');
+const LocationUtility = require('../utility/LocationUtility');
+
+// getAllSubscriptionPlans
+const getAllSubscriptionPlans = (
+  SubscriptionPlan,
+  SubscriptionFeature,
+  logger,
+) => {
+  return async (req, res) => {
+    const { pageNumber, pageSize } = req.query;
+    const { limit, offset } = AppUtil.getPagination(pageNumber, pageSize);
+    try {
+      const { rows, count } = await SubscriptionPlan.findAndCountAll({
+        attributes: [
+          "SubscriptionPlanID",
+          "PlanName",
+          "PlanCode",
+          "Price",
+          "BillingCycle",
+          "Currency",
+          "TrialPeriodDays",
+          "IsActive",
+        ],
+        include: [
+          {
+            model: SubscriptionFeature,
+            as: "Features",
+            attributes: ["SubscriptionFeatureID", "FeatureName", "FeatureCode"],
+            through: { attributes: ["FeatureValue"] },
+          },
+        ],
+        limit,
+        offset,
+        distinct: true,
+      });
+      logger.debug("subscription plans fetched successfully");
+      return AppUtil.generateResponse(
+        200,
+        StatusMessage.SUCCESS,
+        null,
+        { rows, count, pageNumber, limit },
+        res,
+      );
+    } catch (error) {
+      logger.error("error occurred while fetching subscription plans", error);
+      return AppUtil.generateResponse(
+        500,
+        StatusMessage.FAILURE,
+        StatusMessage.SERVER_ERROR,
+        null,
+        res,
+      );
+    }
+  };
+};
+
+const getTenantSubscription = (
+  Tenant,
+  TenantSubscription,
+  SubscriptionPlan,
+  logger,
+) => {
+  return async (req, res) => {
+    try {
+      const { id } = req.params;
+
+      const tenant = await Tenant.findOne({
+        where: { TenantID: id },
+        include: [
+          {
+            model: TenantSubscription,
+            as: "CurrentSubscription",
+            attributes: [
+              "TenantSubscriptionID",
+              "Status",
+              "StartDate",
+              "EndDate",
+              "GraceEndDate",
+              "TrialEndDate",
+              "IsTrial",
+              "AutoRenew",
+            ],
+            include: [
+              {
+                model: SubscriptionPlan,
+                as: "SubscriptionPlan",
+                attributes: ["SubscriptionPlanID", "PlanName", "PlanCode"],
+              },
+            ],
+          },
+        ],
+      });
+
+      if (!tenant) {
+        return AppUtil.generateResponse(
+          404,
+          StatusMessage.FAILURE,
+          StatusMessage.TENANT_NOT_FOUND,
+          null,
+          res,
+        );
+      }
+
+      const { countryName, stateName } =
+        await LocationUtility.resolveCountryAndState(
+          tenant.CountryCode,
+          tenant.StateCode,
+          logger,
+        );
+
+      const formattedTenant = {
+        TenantID: tenant.TenantID,
+        CompanyName: tenant.CompanyName,
+        CompanyCode: tenant.CompanyCode,
+        Email: tenant.Email,
+        CountryCallingCode: tenant.CountryCallingCode,
+        PhoneNumber: tenant.PhoneNumber,
+        GSTNo: tenant.GSTNo,
+        CustomerPortalDomain: tenant.CustomerPortalDomain,
+        AdminPortalDomain: tenant.AdminPortalDomain,
+        AddressLine: tenant.AddressLine,
+        CityName: tenant.CityName,
+        StateCode: tenant.StateCode,
+        StateName: stateName,
+        CountryCode: tenant.CountryCode,
+        CountryName: countryName,
+        Zipcode: tenant.Zipcode,
+        SubscriptionPlanID: tenant.CurrentSubscription?.SubscriptionPlan?.SubscriptionPlanID,
+        PlanName: tenant.CurrentSubscription?.SubscriptionPlan?.PlanName,
+        TenantSubscriptionStatus: tenant.CurrentSubscription?.Status,
+        StartDate: tenant.CurrentSubscription?.StartDate,
+        EndDate: tenant.CurrentSubscription?.EndDate,
+        GraceEndDate: tenant.CurrentSubscription?.GraceEndDate,
+        TrialEndDate: tenant.CurrentSubscription?.TrialEndDate,
+        IsTrial: tenant.CurrentSubscription?.IsTrial,
+        AutoRenew: tenant.CurrentSubscription?.AutoRenew,
+      };
+
+      return AppUtil.generateResponse(
+        200,
+        StatusMessage.SUCCESS,
+        null,
+        formattedTenant,
+        res,
+      );
+    } catch (error) {
+      logger.error("Error fetching tenant:", error);
+      return AppUtil.generateResponse(
+        500,
+        StatusMessage.FAILURE,
+        StatusMessage.SERVER_ERROR,
+        null,
+        res,
+      );
+    }
+  };
+};
+
+module.exports = {getAllSubscriptionPlans, getTenantSubscription}