@darkpos/pricing 1.0.64 → 1.0.66

package/__TEST__/item/getModifierTags.test.js

@@ -146,4 +146,222 @@ describe('getModifierTags Function', () => {
       },
     ]);
   });
+
+  test('get group modifiers including Payment modifiers', () => {
+    const item = {
+      modifiers: [
+        {
+          _id: '67d9b80aefebb298f78a9045',
+          attributes: ['group'],
+          modifierId: '62cdbfd01ee1b4001932816a',
+          _parentId: null,
+          locked: null,
+          name: 'White',
+          sku: '',
+          description: 'Color: White',
+          group: 'Color',
+          type: null,
+          tags: ['default', 'all'],
+          order: null,
+          included: false,
+          direct: true,
+          hidden: false,
+          print: false,
+          required: true,
+          recommended: false,
+          default: false,
+          code: null,
+          properties: {
+            override: null,
+            group: {
+              displayType: 'card',
+              includeInGroup: true,
+              singleValue: true,
+              compact: true,
+              enableAutoPopup: false,
+              displayReplacePrompt: true,
+              promptMessage: '',
+              modifiers: [],
+              items: [],
+              values: ['RegularItem'],
+              manualModifiers: 'test1, asd,123',
+            },
+            sort: null,
+            label: {
+              text: 'White Label',
+              align: 'center',
+              backgroundColor: 'rgba(76,175,80,1)',
+            },
+            color: 'rgba(0,150,136,1)',
+          },
+          _computed: {
+            amount: 0,
+            description: 'White',
+          },
+          conditions: {
+            valid: true,
+            rules: [],
+          },
+          compute: null,
+          _createdAt: '2025-03-18T18:15:35.300Z',
+          _updatedAt: '2025-03-18T18:15:35.300Z',
+          __typename: 'Modifier',
+          addModifiers: [],
+          delModifiers: [],
+        },
+        {
+          _id: '67d9b810efebb298f78a9046',
+          attributes: [],
+          modifierId: '670d7f7e746d1ae0f847aba6',
+          _parentId: null,
+          locked: false,
+          name: 'CASH 20% DISCOUNT',
+          sku: '',
+          description: '',
+          group: 'Offers',
+          type: 'discount',
+          tags: ['default', 'all'],
+          order: null,
+          included: false,
+          direct: true,
+          hidden: false,
+          print: true,
+          required: false,
+          recommended: false,
+          default: false,
+          code: '',
+          properties: {
+            override: null,
+            sort: null,
+          },
+          _computed: {
+            amount: 0,
+            description: 'CASH 20% DISCOUNT',
+          },
+          conditions: {
+            valid: false,
+            rules: [
+              {
+                key: 'paymentMethods',
+                value: ['cash-cash'],
+                operand: '$in',
+              },
+              {
+                key: 'paymentTypes',
+                value: ['cash'],
+                operand: '$in',
+              },
+            ],
+          },
+          compute: {
+            type: 'percentage',
+            action: 'subtract',
+            amount: 20,
+          },
+          _createdAt: '2025-03-18T18:15:35.300Z',
+          _updatedAt: '2025-03-18T18:15:35.300Z',
+          __typename: 'Modifier',
+          addModifiers: [],
+          delModifiers: [],
+        },
+        {
+          name: 'CRC 5.10 discount',
+          sku: '',
+          description: '',
+          group: '',
+          type: 'discount',
+          attributes: [],
+          color: '',
+          backgroundColor: '',
+          icon: '',
+          url: '',
+          code: '',
+          tags: [],
+          order: 0,
+          included: false,
+          direct: true,
+          hidden: false,
+          required: false,
+          print: true,
+          delModifiers: [],
+          addModifiers: [],
+          conditions: null,
+          compute: {
+            action: 'subtract',
+            amount: 5.1,
+            type: 'fixed',
+          },
+          properties: {
+            override: null,
+            sort: null,
+            isCalculatedPaymentModifier: true,
+          },
+          _id: '67d9b8dee71fee48f592ce3a',
+          modifierId: '670d7f7e746d1ae0f847aba6',
+          __typename: 'Modifier',
+          _parentId: '67d9b810efebb298f78a9046',
+          _computed: {
+            amount: -5.1,
+            description: 'CRC 5.10 discount (-CRC 5.10)',
+          },
+          locked: false,
+        },
+        {
+          _id: '67d9b8470d733f348225eeac',
+          attributes: [],
+          modifierId: '670d7f7e746d1ae0f847aba6',
+          _parentId: '67d9b810efebb298f78a9046',
+          locked: true,
+          name: 'CRC 37.50 discount',
+          sku: '',
+          description: '',
+          group: '',
+          type: 'discount',
+          tags: [],
+          order: 0,
+          included: false,
+          direct: true,
+          hidden: false,
+          print: true,
+          required: false,
+          recommended: false,
+          default: false,
+          code: '',
+          properties: {
+            override: null,
+            sort: null,
+            isCalculatedPaymentModifier: true,
+            paymentId: '67d9b846837593e11861065d',
+          },
+          _computed: {
+            amount: -37.5,
+            description: 'CRC 37.50 discount (-CRC 37.50)',
+          },
+          conditions: {
+            valid: true,
+          },
+          compute: {
+            type: 'fixed',
+            action: 'subtract',
+            amount: 37.5,
+          },
+          _createdAt: '2025-03-18T18:15:35.300Z',
+          _updatedAt: '2025-03-18T18:15:35.300Z',
+          __typename: 'Modifier',
+          addModifiers: [],
+          delModifiers: [],
+        },
+      ],
+    };
+
+    const result = pricingServiceGroupModifiers.item.getModifierTags({ item });
+
+    expect(result).toHaveLength(2);
+    expect(result[0].label.replace(/\s/g, '')).toEqual(
+      '1CRC5.10discount(-CRC5.10)'
+    );
+    expect(result[1].label.replace(/\s/g, '')).toEqual(
+      '1CRC37.50discount(-CRC37.50)'
+    );
+  });
 });

package/__TEST__/modifier/getGroupedModifiers.test.js

@@ -1,10 +1,10 @@
-const getGroupedModifiersFunction = require('../../lib/modifier/getGroupedModifiers');
+const usePricing = require('../../index');
 
-describe('getGroupedModifiers Function', () => {
-  const getGroupedModifiers = getGroupedModifiersFunction();
+const pricingService = usePricing();
 
+describe('pricingService.modifier.getGroupedModifiers Function', () => {
   test('should return an empty array if no tags are provided', () => {
-    const result = getGroupedModifiers([]);
+    const result = pricingService.modifier.getGroupedModifiers([]);
     expect(result).toEqual([]);
   });
 
@@ -15,7 +15,7 @@ describe('getGroupedModifiers Function', () => {
       { label: 'Modifier 1', data: { modifierId: 'mod1' }, quantity: 1 },
     ];
 
-    const result = getGroupedModifiers(tags);
+    const result = pricingService.modifier.getGroupedModifiers(tags);
 
     expect(result).toEqual([
       { label: '2 Modifier 1', data: { modifierId: 'mod1' }, quantity: 2 },
@@ -29,7 +29,7 @@ describe('getGroupedModifiers Function', () => {
       { label: 'Modifier 2', data: { modifierId: 'mod2' }, quantity: 1 },
     ];
 
-    const result = getGroupedModifiers(tags);
+    const result = pricingService.modifier.getGroupedModifiers(tags);
 
     expect(result).toEqual([
       { label: '1 Modifier 1', data: { modifierId: 'mod1' }, quantity: 1 },
@@ -45,7 +45,7 @@ describe('getGroupedModifiers Function', () => {
 
     const originalTagsCopy = [...tags];
 
-    getGroupedModifiers(tags);
+    pricingService.modifier.getGroupedModifiers(tags);
 
     expect(tags).toEqual(originalTagsCopy); // Ensure original array is not mutated
   });
@@ -56,7 +56,7 @@ describe('getGroupedModifiers Function', () => {
       { label: 'Modifier 1', data: { modifierId: 'mod1' }, quantity: 1 },
     ];
 
-    const result = getGroupedModifiers(tags);
+    const result = pricingService.modifier.getGroupedModifiers(tags);
 
     expect(result).toEqual([
       { label: '2 Modifier 1', data: { modifierId: 'mod1' }, quantity: 2 },

package/__TEST__/order/order-payment-modifier.test.js

@@ -55,7 +55,21 @@ describe('Order actions', () => {
     expect(cashPercentageDiscountOrder).toHaveProperty('subTotals', {
       discount: -1,
     });
-    expect(cashPercentageDiscountOrder.items[0].modifiers).toHaveLength(1);
+    expect(cashPercentageDiscountOrder.items[0].modifiers).toHaveLength(2);
+
+    expect(cashPercentageDiscountOrder.items[0].modifiers[0]._computed).toEqual(
+      expect.objectContaining({
+        amount: 0,
+        description: 'CASH 10% DISCOUNT',
+      })
+    );
+
+    expect(cashPercentageDiscountOrder.items[0].modifiers[1]._computed).toEqual(
+      expect.objectContaining({
+        amount: -1,
+        description: '$1.00 discount (-$1.00)',
+      })
+    );
 
     expect(cashPercentageDiscountOrder.items[0].modifiers[0]._computed).toEqual(
       expect.objectContaining({
@@ -211,7 +225,7 @@ describe('Order actions', () => {
     expect(cashFixedDiscountOrder).toHaveProperty('subTotals', {
       discount: -2,
     });
-    expect(cashFixedDiscountOrder.items[0].modifiers).toHaveLength(1);
+    expect(cashFixedDiscountOrder.items[0].modifiers).toHaveLength(2);
 
     cashFixedDiscountOrder = pricingService.order.calculate(
       { items: [orderItem] },
@@ -301,7 +315,7 @@ describe('Order actions', () => {
     expect(cashFixedDiscountOrder).toHaveProperty('subTotals', {
       fee: 2,
     });
-    expect(cashFixedDiscountOrder.items[0].modifiers).toHaveLength(1);
+    expect(cashFixedDiscountOrder.items[0].modifiers).toHaveLength(2);
 
     cashFixedDiscountOrder = pricingService.order.calculate(
       { items: [orderItem] },
@@ -464,7 +478,7 @@ describe('Order actions', () => {
       fee: 0.675,
     });
 
-    expect(testOrder.items[0].modifiers).toHaveLength(2);
+    expect(testOrder.items[0].modifiers).toHaveLength(3);
 
     expect(testOrder.items[0].modifiers[0]._computed).toEqual(
       expect.objectContaining({
@@ -924,7 +938,7 @@ describe('Order actions', () => {
               attributes: [],
               modifierId: '670d7f7e746d1ae0f847aba6',
               _parentId: '671818d60e5dd150d983090a',
-              locked: false,
+              locked: true,
               name: '$2.59 discount',
               sku: '',
               description: '',
@@ -1091,7 +1105,7 @@ describe('Order actions', () => {
       tax: 0.675,
     });
 
-    expect(resultedOrder.items[0].modifiers).toHaveLength(6);
+    expect(resultedOrder.items[0].modifiers).toHaveLength(7);
 
     expect(resultedOrder.items[0].modifiers[0]._computed).toEqual(
       expect.objectContaining({

package/lib/item/calculate.js

@@ -29,9 +29,15 @@ module.exports = ({ _, utils, actions, modifierActions }) => {
     subTotals._simple = math.mul(price, quantity);
 
     const modifiers = [];
-    const { modifiers: itemModifiers = [] } =
+    const { modifiers: itemModifiersPrev = [] } =
       actions.removeModifiersByQuantity(item);
 
+    const itemModifiers = [...itemModifiersPrev].filter(
+      mod =>
+        !modifierActions.isCalculatedPaymentModifier(mod) ||
+        modifierActions.isLocked(mod)
+    );
+
     const validatedModifiers = itemModifiers.map(each =>
       modifierActions.validate(each, {
         item,
@@ -143,10 +149,9 @@ module.exports = ({ _, utils, actions, modifierActions }) => {
           }
         );
 
-        if (
-          !modifierActions.isPaymentModifier(modifier) ||
-          lockPaymentModifiers
-        ) {
+        if (modifierActions.isPaymentModifier(modifier)) {
+          modifiers.push({ ..._modifier, locked: !!lockPaymentModifiers });
+        } else {
           modifiers.push(_modifier);
         }
 

package/lib/item/getModifierTags.js

@@ -1,5 +1,9 @@
 module.exports = ({ modifierActions, settings }) =>
-  function getModifierTags({ item, skipGrouping = false }) {
+  function getModifierTags({
+    item,
+    includePaymentModifiers,
+    skipGrouping = false,
+  }) {
     const groupModifiers =
       settings && settings.order && settings.order.groupModifiers;
 
@@ -7,7 +11,11 @@ module.exports = ({ modifierActions, settings }) =>
 
     let modifierTags = item.modifiers
       .filter(
-        each => modifierActions.isValid(each) && !modifierActions.isGroup(each)
+        each =>
+          (modifierActions.isValid(each) ||
+            (modifierActions.isPaymentModifier(each) &&
+              includePaymentModifiers)) &&
+          !modifierActions.isGroup(each)
       )
       .map(modifier => {
         const { name, _id } = modifier;

package/lib/modifier/getGroupedModifiers.js

@@ -1,9 +1,11 @@
-module.exports = () =>
+module.exports = ({ actions }) =>
   function getGroupedModifiers(tags) {
     return tags
       .reduce((acc, curr) => {
         const found = acc.find(
-          item => item.data.modifierId === curr.data.modifierId
+          item =>
+            item.data.modifierId === curr.data.modifierId &&
+            !actions.isCalculatedPaymentModifier(curr.data)
         );
 
         if (found) {

package/lib/modifier/index.js

@@ -140,6 +140,7 @@ const isFixedSubtract = require('./isFixedSubtract');
 const isQuantityMultiplier = require('./isQuantityMultiplier');
 const isCompute = require('./isCompute');
 const isFixedOverride = require('./isFixedOverride');
+const isLocked = require('./isLocked');
 
 const modifierActions = (deps = {}) => {
   const actions = {};
@@ -293,6 +294,7 @@ const modifierActions = (deps = {}) => {
     isQuantityMultiplier: isQuantityMultiplier(innerDeps),
     isCompute: isCompute(innerDeps),
     isFixedOverride: isFixedOverride(innerDeps),
+    isLocked: isLocked(innerDeps),
   });
 
   Object.keys(freezedActions).forEach(actionName => {

package/lib/modifier/isLocked.js

@@ -0,0 +1,6 @@
+module.exports = () =>
+  function isLocked(modifier) {
+    if (!modifier) return false;
+
+    return modifier.locked;
+  };

package/lib/order/getSuborder.js

@@ -1,14 +1,7 @@
 module.exports = ({ utils, _, settings }) => {
   const orderSettings = _.get(settings, 'order');
-  const { date, helpers } = utils;
-  const noteDefaults = {
-    message: '',
-    attributes: [],
-    date: date.toISOString(),
-    user: null,
-    url: '',
-    __typename: 'Note',
-  };
+  const { helpers } = utils;
+
   const getSubOrder =
     ({ order }) =>
     (items, index) => {
@@ -35,13 +28,7 @@ module.exports = ({ utils, _, settings }) => {
         parentId: orderSettings.allowSuborder ? order._id : null,
         items,
         modifiers: [],
-        notes: [
-          ...(order.notes || []),
-          {
-            ...noteDefaults,
-            message: `Suborder from ${order.displayId}`, // ask about this message
-          },
-        ],
+        notes: order.notes || [],
       };
     };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@darkpos/pricing",
-  "version": "1.0.64",
+  "version": "1.0.66",
   "description": "Pricing calculator",
   "author": "Dark POS",
   "license": "ISC",
@@ -23,6 +23,7 @@
     "test:conditionsNotMet": "jest --runInBand --detectOpenHandles --logHeapUsage  --forceExit ./__TEST__/order/conditionsNotMet.test.js",
     "test:pickEndDate": "jest --runInBand --detectOpenHandles --logHeapUsage  --forceExit ./__TEST__/order/pickEndDate.test.js",
     "test:modifier": "jest --runInBand --detectOpenHandles --logHeapUsage  --forceExit ./__TEST__/modifier.test.js",
+    "test:paymentModifiers": "jest --runInBand --detectOpenHandles --logHeapUsage  --forceExit ./__TEST__/order/order-payment-modifier.test.js",
     "lint": "eslint --quiet lib/"
   },
   "publishConfig": {
@@ -46,5 +47,5 @@
     "supertest": "^6.2.3",
     "supervisor": "^0.12.0"
   },
-  "gitHead": "000ac6a4b480b4a219b1411d29cbd74f86aa9716"
+  "gitHead": "d007d8455487fed168f127c6b338dc4301a7da79"
 }