@darkpos/pricing 1.0.128 → 1.0.129

package/__TEST__/modifier/isModifierValid.test.js

@@ -24,8 +24,9 @@ describe('Is valid Modifier', () => {
         },
       },
     };
-    const isPromoValid =
-      pricingService.modifier.isModifierValid(mockPromoModifier);
+    const isPromoValid = pricingService.modifier.isModifierValid({
+      modifier: mockPromoModifier,
+    });
 
     expect(isPromoValid).toBe(false);
   });
@@ -50,9 +51,91 @@ describe('Is valid Modifier', () => {
         },
       },
     };
-    const isPromoValid =
-      pricingService.modifier.isModifierValid(mockPromoModifier);
+    const isPromoValid = pricingService.modifier.isModifierValid({
+      modifier: mockPromoModifier,
+    });
 
     expect(isPromoValid).toBe(true);
   });
+
+  test('should return false when customer usage reached per-customer limit', () => {
+    const now = moment();
+    const mockPromoModifier = {
+      attributes: ['promotion'],
+      name: 'Per-Customer Limited Promo',
+      sku: '#CUSLIMIT',
+      properties: {
+        promotion: {
+          numberOfUses: 10,
+          numberOfUsesCustomerLimit: 2,
+          customerIds: ['cust-1', 'cust-1', 'cust-2'],
+          dateLimit: {
+            from: now.clone().subtract(1, 'day').format('YYYY-MM-DD'),
+            to: now.clone().add(1, 'day').format('YYYY-MM-DD'),
+          },
+        },
+      },
+    };
+
+    const isValid = pricingService.modifier.isModifierValid({
+      modifier: mockPromoModifier,
+      customer: { _id: 'cust-1' },
+    });
+
+    expect(isValid).toBe(false);
+  });
+
+  test('should return true when customer usage is below per-customer limit', () => {
+    const now = moment();
+    const mockPromoModifier = {
+      attributes: ['promotion'],
+      name: 'Per-Customer Limited Promo',
+      sku: '#CUSLIMIT2',
+      properties: {
+        promotion: {
+          numberOfUses: 5,
+          numberOfUsesCustomerLimit: 3,
+          customerIds: ['cust-1', 'cust-2', 'cust-1'],
+          dateLimit: {
+            from: now.clone().subtract(1, 'day').format('YYYY-MM-DD'),
+            to: now.clone().add(1, 'day').format('YYYY-MM-DD'),
+          },
+        },
+      },
+    };
+
+    const isValid = pricingService.modifier.isModifierValid({
+      modifier: mockPromoModifier,
+      customer: { _id: 'cust-1' },
+    });
+
+    expect(isValid).toBe(true);
+  });
+
+  test('should return true when per-customer limit exists but no customer provided', () => {
+    const now = moment();
+    const mockPromoModifier = {
+      attributes: ['promotion'],
+      name: 'Per-Customer Limited Promo (No Customer)',
+      sku: '#CUSLIMIT3',
+      properties: {
+        promotion: {
+          numberOfUses: 0,
+          numberOfUsesCustomerLimit: 1,
+          customerIds: [],
+          dateLimit: {
+            from: now.clone().subtract(1, 'day').format('YYYY-MM-DD'),
+            to: now.clone().add(1, 'day').format('YYYY-MM-DD'),
+          },
+        },
+      },
+    };
+
+    const isValid = pricingService.modifier.isModifierValid({
+      modifier: mockPromoModifier,
+      // customer omitted on purpose
+    });
+
+    expect(isValid).toBe(true);
+  });
 });

package/lib/modifier/getCountPerCustomer.js

@@ -0,0 +1,11 @@
+module.exports = ({ actions }) =>
+  function getCountPerCustomer({ modifier, customerId }) {
+    if (!actions.isPromotion(modifier)) return 0;
+
+    const customerIds = actions.getPromoCustomerIds(modifier) || [];
+
+    return customerIds.reduce(
+      (count, id) => (id === customerId ? count + 1 : count),
+      0
+    );
+  };

package/lib/modifier/getMaxUsesPerCustomer.js

@@ -0,0 +1,5 @@
+module.exports = ({ actions, _ }) =>
+  function getMaxUsesPerCustomer(modifier) {
+    if (!actions.isPromotion(modifier)) return 0;
+    return _.get(modifier, 'properties.promotion.numberOfUsesCustomerLimit', 0);
+  };

package/lib/modifier/getPromoCustomerIds.js

@@ -0,0 +1,5 @@
+module.exports = ({ actions, _ }) =>
+  function getPromoCustomerIds(modifier) {
+    if (!actions.isPromotion(modifier)) return [];
+    return _.get(modifier, 'properties.promotion.customerIds', []);
+  };

package/lib/modifier/index.js

@@ -15,8 +15,6 @@ const duplicate = require('./duplicate');
 const enableAutoPopup = require('./enableAutoPopup');
 const filterByRequiredModifiers = require('./filterByRequiredModifiers');
 const findById = require('./findById');
-const getAvailablePromotions = require('./getAvailablePromotions');
-const getAvailablePromotionsOrSubscriptions = require('./getAvailablePromotionsOrSubscriptions');
 const getAvailableSubscriptions = require('./getAvailableSubscriptions');
 const getByAttribute = require('./getByAttribute');
 const getCreditModifier = require('./getCreditModifier');
@@ -29,7 +27,6 @@ const getDirectModifiers = require('./getDirectModifiers');
 const getDescriptions = require('./getDescriptions');
 const getEntityModifiers = require('./getEntityModifiers');
 const getExtendedTags = require('./getExtendedTags');
-const getEntityPromotions = require('./getEntityPromotions');
 const getGroupOfItemsModifiers = require('./getGroupOfItemsModifiers');
 const getGroupRelatedModifiers = require('./getGroupRelatedModifiers');
 const getGroupModifiers = require('./getGroupModifiers');
@@ -179,6 +176,9 @@ const isSplitDepartment = require('./isSplitDepartment');
 const isModifierValid = require('./isModifierValid');
 const markModifierAsNotValid = require('./markModifierAsNotValid');
 const isEmptyOverride = require('./isEmptyOverride');
+const getMaxUsesPerCustomer = require('./getMaxUsesPerCustomer');
+const getPromoCustomerIds = require('./getPromoCustomerIds');
+const getCountPerCustomer = require('./getCountPerCustomer');
 
 const modifierActions = (deps = {}) => {
   const actions = {};
@@ -205,9 +205,6 @@ const modifierActions = (deps = {}) => {
     enableAutoPopup: enableAutoPopup(innerDeps),
     filterByRequiredModifiers: filterByRequiredModifiers(innerDeps),
     findById: findById(innerDeps),
-    getAvailablePromotions: getAvailablePromotions(innerDeps),
-    getAvailablePromotionsOrSubscriptions:
-      getAvailablePromotionsOrSubscriptions(innerDeps),
     getAvailableSubscriptions: getAvailableSubscriptions(innerDeps),
     getByAttribute: getByAttribute(innerDeps),
     getCreditModifier: getCreditModifier(innerDeps),
@@ -220,7 +217,6 @@ const modifierActions = (deps = {}) => {
     getDefaultModifiers: getDefaultModifiers(innerDeps),
     getEntityModifiers: getEntityModifiers(innerDeps),
     getExtendedTags: getExtendedTags(innerDeps),
-    getEntityPromotions: getEntityPromotions(innerDeps),
     getGroupRelatedModifiers: getGroupRelatedModifiers(innerDeps),
     getGroupModifiers: getGroupModifiers(innerDeps),
     getGroupOfItemsModifiers: getGroupOfItemsModifiers(innerDeps),
@@ -371,6 +367,9 @@ const modifierActions = (deps = {}) => {
     isModifierValid: isModifierValid(innerDeps),
     markModifierAsNotValid: markModifierAsNotValid(innerDeps),
     isEmptyOverride: isEmptyOverride(innerDeps),
+    getMaxUsesPerCustomer: getMaxUsesPerCustomer(innerDeps),
+    getPromoCustomerIds: getPromoCustomerIds(innerDeps),
+    getCountPerCustomer: getCountPerCustomer(innerDeps),
   });
 
   Object.keys(freezedActions).forEach(actionName => {

package/lib/modifier/isAvailablePromotion.js

@@ -1,7 +1,7 @@
 module.exports = ({ utils, actions }) => {
   const { date, math } = utils;
 
-  return function isAvailablePromotion(modifier) {
+  return function isAvailablePromotion({ modifier, customer }) {
     if (!actions.isPromotion(modifier)) return false;
 
     const { promotion } = modifier.properties || {};
@@ -15,6 +15,16 @@ module.exports = ({ utils, actions }) => {
     )
       return false;
 
+    const maxUsesPerCustomer = actions.getMaxUsesPerCustomer(modifier);
+
+    if (maxUsesPerCustomer && customer && customer._id) {
+      const customerCount = actions.getCountPerCustomer({
+        modifier,
+        customerId: customer._id,
+      });
+      if (math.gte(customerCount, maxUsesPerCustomer)) return false;
+    }
+
     if (promotion.dateLimit && !date.isBetween(promotion.dateLimit))
       return false;
 

package/lib/modifier/isModifierValid.js

@@ -1,8 +1,8 @@
 module.exports = ({ actions }) =>
-  function isModifierValid(modifier) {
+  function isModifierValid({ modifier, customer }) {
     // Promotion modifiers
     if (actions.isPromotion(modifier)) {
-      return actions.isAvailablePromotion(modifier);
+      return actions.isAvailablePromotion({ modifier, customer });
     }
 
     // Add more modifier checks here ...

package/lib/order/addItemModifier.js

@@ -23,7 +23,7 @@ module.exports = ({ actions, itemActions, modifierActions, utils, _ }) => {
     }
 
     // Check if Modifier is Valid/Available
-    if (!modifierActions.isModifierValid(_modifier)) {
+    if (!modifierActions.isModifierValid({ modifier: _modifier, customer })) {
       if (onError) onError('modifier.has.reached.the.maximum.of.uses');
       return itemProp;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@darkpos/pricing",
-  "version": "1.0.128",
+  "version": "1.0.129",
   "description": "Pricing calculator",
   "author": "Dark POS",
   "license": "ISC",
@@ -52,5 +52,5 @@
     "supertest": "^6.2.3",
     "supervisor": "^0.12.0"
   },
-  "gitHead": "8246fe8ba99264f6428a8fa725fb951b49961c95"
+  "gitHead": "958c254c252446558919666dfd3c524e5ec3acb5"
 }

package/__TEST__/modifier/getAvailablePromotionsOrSubscriptions.test.js

@@ -1,81 +0,0 @@
-const usePricing = require('../../index');
-
-const pricingService = usePricing();
-
-describe('GetAvailablePromotionsOrSubscriptions Function', () => {
-  test('usecases', () => {
-    const today = new Date();
-    expect(
-      pricingService.modifier.getAvailablePromotionsOrSubscriptions()
-    ).toStrictEqual([]);
-
-    const modifier = { attributes: ['promotion'] };
-    expect(
-      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
-    ).toStrictEqual([modifier]);
-
-    modifier.properties = {
-      promotion: { numberOfUsesLimit: 4, numberOfUses: 3 },
-    };
-    expect(
-      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
-    ).toStrictEqual([modifier]);
-
-    modifier.properties.promotion.numberOfUses = 4;
-    expect(
-      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
-    ).toStrictEqual([]);
-
-    modifier.properties.promotion.numberOfUses = 5;
-    expect(
-      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
-    ).toStrictEqual([]);
-
-    modifier.properties = {
-      promotion: { dateLimit: { from: today.toISOString(), to: '' } },
-    };
-    expect(
-      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
-    ).toStrictEqual([modifier]);
-
-    const tomorrow = new Date(today);
-    tomorrow.setDate(tomorrow.getDate() + 1);
-    modifier.properties.promotion.dateLimit.from = tomorrow.toISOString();
-    expect(
-      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
-    ).toStrictEqual([]);
-
-    const yesterday = new Date(today);
-    yesterday.setDate(yesterday.getDate() - 1);
-    modifier.properties.promotion.dateLimit.from = yesterday.toISOString();
-    expect(
-      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
-    ).toStrictEqual([modifier]);
-
-    modifier.properties.promotion.dateLimit.to = yesterday.toISOString();
-    expect(
-      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
-    ).toStrictEqual([]);
-
-    modifier.properties.promotion.dateLimit.to = today.toISOString();
-    expect(
-      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
-    ).toStrictEqual([modifier]);
-
-    modifier.properties.promotion.dateLimit.to = tomorrow.toISOString();
-    expect(
-      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
-    ).toStrictEqual([modifier]);
-
-    modifier.attributes = ['subscription'];
-    modifier.properties.subscription = modifier.properties.promotion;
-    expect(
-      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
-    ).toStrictEqual([modifier]);
-
-    delete modifier.properties;
-    expect(
-      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
-    ).toStrictEqual([]);
-  });
-});

package/lib/modifier/getAvailablePromotions.js

@@ -1,5 +0,0 @@
-module.exports = ({ actions }) =>
-  function getAvailablePromotions(modifiers) {
-    if (!Array.isArray(modifiers)) return [];
-    return modifiers.filter(each => actions.isAvailablePromotion(each));
-  };

package/lib/modifier/getAvailablePromotionsOrSubscriptions.js

@@ -1,15 +0,0 @@
-module.exports = ({ actions }) =>
-  /*
-   * This function will receive a list of promotion modifiers and filter them by the limits that we have for promotions
-   * Filters are:
-   *  modifier.properties.promotion.dateLimit.{from, to} which compares today with these two dates
-   *  modifier.properties.promotion.numberOfUsesLimit which will be checked with modifier.properties.promotion.numberOfUses
-   */
-  function getAvailablePromotionsOrSubscriptions(modifiers) {
-    if (!Array.isArray(modifiers)) return [];
-    return modifiers.filter(
-      each =>
-        actions.isAvailableSubscription(each) ||
-        actions.isAvailablePromotion(each)
-    );
-  };

package/lib/modifier/getEntityPromotions.js

@@ -1,11 +0,0 @@
-module.exports = ({ actions }) =>
-  function getEntityPromotions({ modifiers, entity }) {
-    if (!entity) return [];
-    let entityModifiers = actions.getMatchTagsModifiers({
-      modifiers,
-      entity,
-    });
-    entityModifiers = actions.getUnhiddenModifiers(entityModifiers);
-    const promotions = actions.getAvailablePromotions(entityModifiers);
-    return promotions;
-  };