@darkpos/pricing 1.0.51 → 1.0.53

package/lib/item/calculate.js

@@ -85,7 +85,14 @@ module.exports = ({ _, utils, actions, modifierActions }) => {
             ceach => ceach.modifierId === each.modifierId
           )
       )
-      .map(each => modifierActions.calculate(each, { skip: true }));
+      .map(each =>
+        modifierActions.calculate(each, {
+          price,
+          quantity,
+          skip: true,
+          basePrice: actions.getBasePrice(item),
+        })
+      );
 
     if (modifiersToCompute.length || paymentModifiersToCompute.length) {
       // sort modifiers based on sort
@@ -130,6 +137,7 @@ module.exports = ({ _, utils, actions, modifierActions }) => {
           {
             price: computedPrice,
             quantity,
+            basePrice: actions.getBasePrice(item),
           }
         );
 
@@ -147,11 +155,22 @@ module.exports = ({ _, utils, actions, modifierActions }) => {
 
         // adding this computeField because now the compute from a modifier can be null
         const computeField = getComputeModField(_modifier);
+
+        const isPercentage = computeField.type === 'percentage';
+        const isIgnoreQuantity = modifierActions.isIgnoreQuantity(_modifier);
+        const isNotFixedAddAndAmountGtPrice =
+          !modifierActions.isFixedAdd(_modifier) &&
+          math.gt(math.abs(computedAmountCalc), computedPriceCalc);
+
+        const isAmountOverrideAndNotMultiplier =
+          modifierActions.isAmountOverride(_modifier) &&
+          !modifierActions.isMultiplier(_modifier);
+
         let computedAmount =
-          computeField.type === 'percentage' ||
-          modifierActions.isIgnoreQuantity(_modifier) ||
-          (!modifierActions.isFixedAdd(_modifier) &&
-            math.gt(math.abs(computedAmountCalc), computedPriceCalc))
+          isPercentage ||
+          isIgnoreQuantity ||
+          isNotFixedAddAndAmountGtPrice ||
+          isAmountOverrideAndNotMultiplier
             ? _computed.amount
             : computedAmountCalc;
 

package/lib/item/getBasePrice.js

@@ -0,0 +1,7 @@
+module.exports = () =>
+  function getBasePrice(item) {
+    if (!item) return 0;
+    if (!item.properties || typeof item.properties.basePrice !== 'number')
+      return item.price;
+    return item.properties.basePrice;
+  };

package/lib/item/getModifierTags.js

@@ -0,0 +1,45 @@
+module.exports = ({ modifierActions, settings }) =>
+  function getModifierTags({ item, skipGrouping = false }) {
+    const groupModifiers =
+      settings && settings.order && settings.order.groupModifiers;
+
+    if (!item || !Array.isArray(item.modifiers)) return [];
+
+    let modifierTags = item.modifiers
+      .filter(
+        each => modifierActions.isValid(each) && !modifierActions.isGroup(each)
+      )
+      .map(modifier => {
+        const { name, _id } = modifier;
+
+        let label = name;
+
+        if (modifierActions.isGroupOfValues(modifier)) {
+          label = modifierActions.getSelectedValues(modifier) || label;
+        }
+
+        if (
+          modifier &&
+          !modifier.included &&
+          modifier._computed &&
+          modifier._computed.description
+        ) {
+          label = modifier._computed.description;
+        }
+
+        const modifierValue = {
+          label,
+          value: _id,
+          data: modifier,
+          quantity: 1,
+        };
+
+        return modifierValue;
+      });
+
+    if (groupModifiers && !skipGrouping) {
+      modifierTags = modifierActions.getGroupedModifiers(modifierTags);
+    }
+
+    return modifierTags;
+  };

package/lib/{modifier/getNotesToModifierTags.js → item/getNoteTags.js}

@@ -1,5 +1,5 @@
 module.exports = () =>
-  function getNotesToModifierTags({ notes, modifierTags }) {
+  function getNoteTags({ notes }) {
     let noteTags = [];
     if (notes && notes.length > 0) {
       noteTags =
@@ -17,5 +17,5 @@ module.exports = () =>
           }) || [];
     }
 
-    return modifierTags.concat(noteTags);
+    return noteTags;
   };

package/lib/item/index.js

@@ -23,7 +23,7 @@ const getItemsTotals = require('./getItemsTotals');
 const getNotIncludedModifiers = require('./getNotIncludedModifiers');
 const hasModifierWithValue = require('./hasModifierWithValue');
 const getItemsTotalPaid = require('./getItemsTotalPaid');
-const getItemModifiersDescription = require('./getItemModifiersDescription');
+const getModifierTags = require('./getModifierTags');
 const isRelatedItem = require('./isRelatedItem');
 const getParentItem = require('./getParentItem');
 const isParentIncluded = require('./isParentIncluded');
@@ -44,6 +44,8 @@ const getInvalidRequiredModifiers = require('./getInvalidRequiredModifiers');
 const getPriceWithoutModifiers = require('./getPriceWithoutModifiers');
 const getTotalsDifference = require('./getTotalsDifference');
 const getTotalNeareastDifference = require('./getTotalNeareastDifference');
+const getNoteTags = require('./getNoteTags');
+const getBasePrice = require('./getBasePrice');
 
 const itemActions = (deps = {}) => {
   const actions = {};
@@ -79,7 +81,7 @@ const itemActions = (deps = {}) => {
     getNotIncludedModifiers: getNotIncludedModifiers(innerDeps),
     hasModifierWithValue: hasModifierWithValue(innerDeps),
     getItemsTotalPaid: getItemsTotalPaid(innerDeps),
-    getItemModifiersDescription: getItemModifiersDescription(innerDeps),
+    getModifierTags: getModifierTags(innerDeps),
     isRelatedItem: isRelatedItem(innerDeps),
     getParentItem: getParentItem(innerDeps),
     isParentIncluded: isParentIncluded(innerDeps),
@@ -101,6 +103,8 @@ const itemActions = (deps = {}) => {
     getPriceWithoutModifiers: getPriceWithoutModifiers(innerDeps),
     getTotalsDifference: getTotalsDifference(innerDeps),
     getTotalNeareastDifference: getTotalNeareastDifference(innerDeps),
+    getNoteTags: getNoteTags(innerDeps),
+    getBasePrice: getBasePrice(innerDeps),
   });
 
   Object.keys(freezedActions).forEach(actionName => {

package/lib/item/removeModifier.js

@@ -56,10 +56,8 @@ module.exports = ({ modifierActions, _, actions }) => {
         )
     );
 
-    const hasOverride = modifiersToApply.find(
-      each =>
-        modifierActions.isOverride(each) ||
-        modifierActions.isComputedOverride(each)
+    const hasOverride = modifiersToApply.find(each =>
+      modifierActions.isOverride(each)
     );
 
     if (hasOverride) {
@@ -68,10 +66,7 @@ module.exports = ({ modifierActions, _, actions }) => {
 
       if (modifierActions.isQuantityOverride(modifier)) nextItem.quantity = 1;
 
-      if (
-        modifierActions.isPriceOverride(modifier) ||
-        modifierActions.isComputedOverride(modifier)
-      )
+      if (modifierActions.isPriceOverride(modifier))
         nextItem.price = actions.getItemPrice({
           item: originalItem,
           cache,

package/lib/modifier/calculate.js

@@ -9,7 +9,7 @@ module.exports = ({ _, constants, utils, localization, actions }) => {
 
   return function calculate(
     _modifier = {},
-    options = { price: 0, quantity: 0, skip: false }
+    options = { price: 0, quantity: 0, skip: false, basePrice: 0 }
   ) {
     const modifier = _modifier;
     const { name } = modifier;
@@ -43,16 +43,49 @@ module.exports = ({ _, constants, utils, localization, actions }) => {
           100
         );
 
-      if (!type || action === Modifier.Compute.Actions.OVERRIDE)
-        _computed.amount = 0;
+      if (!type) _computed.amount = 0;
 
       if (math.gt(math.abs(_computed.amount), maxAmount)) {
         _computed.amount = maxAmount * multiplier;
       }
     }
 
-    const localAmount = localization.formatAmount(_computed.amount);
-    _computed.description = `${name} (${localAmount})`;
+    const localAmount =
+      !!_computed.amount && Number(_computed.amount) !== 0
+        ? `${localization.formatAmount(_computed.amount)}`
+        : '';
+
+    const localBasePrice = localization.formatAmount(
+      options.basePrice || options.price || 0
+    );
+
+    const isMultiplier = actions.isMultiplier(modifier);
+
+    _computed.description = `${name}${localAmount ? ` (${localAmount})` : ''}`;
+
+    if (actions.isPriceOverride(modifier)) {
+      _computed.description = isMultiplier
+        ? `${name} (${compute.amount} Unit @ ${localBasePrice}/Unit)`
+        : `${name} (${localization.formatAmount(compute.amount)}/Unit)`;
+    }
+
+    if (actions.isAmountOverride(modifier) && isMultiplier) {
+      _computed.description = `${name} (${localization.formatAmount(
+        math.mul(_computed.amount, options.quantity)
+      )})`;
+    }
+
+    if (actions.isOptionsSelectedOverride(modifier)) {
+      const selectedOverrideOptions = _.get(
+        modifier,
+        'properties.override.selected'
+      );
+      _computed.description = isMultiplier
+        ? `${name} (${compute.amount} Unit @ ${localBasePrice}/${selectedOverrideOptions.selectedUnit})`
+        : `${name} (${localization.formatAmount(compute.amount)}/${
+            selectedOverrideOptions.selectedUnit
+          })`;
+    }
 
     return { ..._.cloneDeep(modifier), _computed };
   };

package/lib/modifier/index.js

@@ -89,7 +89,6 @@ const isService = require('./isService');
 const isSingleValue = require('./isSingleValue');
 const isGroupOfItems = require('./isGroupOfItems');
 const isOverride = require('./isOverride');
-const isComputedOverride = require('./isComputedOverride');
 const isDepartment = require('./isDepartment');
 const isRequired = require('./isRequired');
 const isMultiplier = require('./isMultiplier');
@@ -129,7 +128,6 @@ const hasItems = require('./hasItems');
 const removeGroupData = require('./removeGroupData');
 const isRelatedModifier = require('./isRelatedModifier');
 const getGroupedModifiers = require('./getGroupedModifiers');
-const getNotesToModifierTags = require('./getNotesToModifierTags');
 const isOptionsOverride = require('./isOptionsOverride');
 const getGroupedModifierLabels = require('./getGroupedModifierLabels');
 const validate = require('./validate');
@@ -149,6 +147,7 @@ const isChild = require('./isChild');
 const isExtractCalculatedValue = require('./isExtractCalculatedValue');
 const getPriceWithoutModifier = require('./getPriceWithoutModifier');
 const isGroup = require('./isGroup');
+const isOptionsSelectedOverride = require('./isOptionsSelectedOverride');
 
 const modifierActions = (deps = {}) => {
   const actions = {};
@@ -250,7 +249,6 @@ const modifierActions = (deps = {}) => {
     isSingleValue: isSingleValue(innerDeps),
     isGroupOfItems: isGroupOfItems(innerDeps),
     isOverride: isOverride(innerDeps),
-    isComputedOverride: isComputedOverride(innerDeps),
     isDepartment: isDepartment(innerDeps),
     isRequired: isRequired(innerDeps),
     isMultiplier: isMultiplier(innerDeps),
@@ -289,7 +287,6 @@ const modifierActions = (deps = {}) => {
     removeGroupData: removeGroupData(innerDeps),
     isRelatedModifier: isRelatedModifier(innerDeps),
     getGroupedModifiers: getGroupedModifiers(innerDeps),
-    getNotesToModifierTags: getNotesToModifierTags(innerDeps),
     isOptionsOverride: isOptionsOverride(innerDeps),
     getGroupedModifierLabels: getGroupedModifierLabels(innerDeps),
     validate: validate(innerDeps),
@@ -311,6 +308,7 @@ const modifierActions = (deps = {}) => {
     isExtractCalculatedValue: isExtractCalculatedValue(innerDeps),
     getPriceWithoutModifier: getPriceWithoutModifier(innerDeps),
     isGroup: isGroup(innerDeps),
+    isOptionsSelectedOverride: isOptionsSelectedOverride(innerDeps),
   });
 
   Object.keys(freezedActions).forEach(actionName => {

package/lib/modifier/isGroup.js

@@ -1,10 +1,5 @@
 module.exports = ({ actions }) =>
   function isGroup(modifier) {
     if (!modifier) return false;
-    return !!(
-      actions.hasAttribute(modifier, 'group') ||
-      (modifier.properties &&
-        modifier.properties.group &&
-        Object.keys(modifier.properties.group) > 0)
-    );
+    return !!actions.hasAttribute(modifier, 'group');
   };

package/lib/modifier/isOptionsSelectedOverride.js

@@ -0,0 +1,7 @@
+module.exports = ({ _, actions }) =>
+  function isOptionsSelectedOverride(modifier) {
+    return !!(
+      actions.isOverride(modifier) &&
+      !!_.get(modifier, 'properties.override.selected')
+    );
+  };

package/lib/order/addItemModifier.js

@@ -143,13 +143,25 @@ module.exports = ({ actions, itemActions, modifierActions, utils, _ }) => {
       };
     }
 
-    if (modifierActions.isQuantityOverride(modifier) && modifier.compute) {
-      item.quantity = modifier.compute.amount || 1;
+    if (modifierActions.isQuantityOverride(modifier)) {
+      if (modifier.compute && typeof modifier.compute.amount === 'number') {
+        item.quantity = modifier.compute.amount || 1;
+      } else if (typeof modifier.properties.override.fixedValue === 'number') {
+        item.quantity = modifier.properties.override.fixedValue;
+      }
     }
 
-    if (isPriceOverride || modifierActions.isComputedOverride(modifier)) {
+    if (isPriceOverride) {
+      item.properties = {
+        ...(item.properties || {}),
+        basePrice: item.price,
+      };
       item.price = getPrice({ modifier: modifierToAdd, item });
     } else {
+      item.properties = {
+        ...(item.properties || {}),
+        basePrice: item.price,
+      };
       item.price = itemActions.getItemPrice({
         item,
         cache,

package/lib/order/calculate.js

@@ -40,89 +40,92 @@ module.exports = ({
       ),
     });
 
+    let calculatedItems = itemsWNIM || [];
+
     const newOrder = {
       ...order,
       ...itemActions.getItemsTotals(itemsWNIM),
       items: itemsWNIM,
     };
 
-    if (!sortedOrderModifiers.length) return newOrder;
-
-    itemsWNIM = itemActions.calculate(itemsWNIM, {});
-
-    let tempItems = itemsWNIM || items;
-    let itemsWIM = _.cloneDeep(tempItems);
-    let prvSort = null;
-
-    let computedTotal = newOrder.total;
-
-    for (const modifier of sortedOrderModifiers) {
-      const isCredit = modifierActions.isCredit(modifier);
-      const sort = modifierActions.getProperty(modifier, 'sort');
+    if (sortedOrderModifiers.length > 0) {
+      itemsWNIM = itemActions.calculate(itemsWNIM, {});
+
+      let tempItems = itemsWNIM || items;
+      let itemsWIM = _.cloneDeep(tempItems);
+      let prvSort = null;
+
+      let computedTotal = newOrder.total;
+
+      for (const modifier of sortedOrderModifiers) {
+        const isCredit = modifierActions.isCredit(modifier);
+        const sort = modifierActions.getProperty(modifier, 'sort');
+
+        if (prvSort !== sort) {
+          if (sort) {
+            tempItems = itemsWIM.map(item => ({
+              ...item,
+              modifiers: modifierActions.getModifiersByMaxSort(
+                item.modifiers,
+                modifier.properties.sort
+              ),
+            }));
+          } else {
+            tempItems = itemsWIM;
+          }
+          tempItems = itemActions.calculate(tempItems, options);
+        }
 
-      if (prvSort !== sort) {
-        if (sort) {
-          tempItems = itemsWIM.map(item => ({
-            ...item,
-            modifiers: modifierActions.getModifiersByMaxSort(
-              item.modifiers,
-              modifier.properties.sort
-            ),
-          }));
-        } else {
-          tempItems = itemsWIM;
+        if (isCredit) {
+          const calculatedItemWIM = itemActions.calculate(itemsWIM, options);
+          computedTotal = itemActions.getItemsTotals(calculatedItemWIM).total;
         }
-        tempItems = itemActions.calculate(tempItems, options);
-      }
 
-      if (isCredit) {
-        const calculatedItemWIM = itemActions.calculate(itemsWIM, options);
-        computedTotal = itemActions.getItemsTotals(calculatedItemWIM).total;
-      }
+        if (modifierActions.hasItems({ modifier })) {
+          tempItems = itemActions.getItems(tempItems, modifier.items);
+        }
 
-      if (modifierActions.hasItems({ modifier })) {
-        tempItems = itemActions.getItems(tempItems, modifier.items);
+        computedTotal = itemActions.getItemsTotals(tempItems).total;
+
+        const itemsModifiers = itemActions.addIndirectModifier({
+          orderTotal: computedTotal,
+          items: tempItems,
+          modifier,
+        });
+
+        // adding the modifiers to items
+        itemsWIM = itemsWIM.map(item => ({
+          ...item,
+          modifiers: [
+            ...(item.modifiers || []),
+            itemsModifiers[item._id],
+          ].filter(Boolean),
+        }));
+        prvSort = sort;
       }
 
-      computedTotal = itemActions.getItemsTotals(tempItems).total;
-
-      const itemsModifiers = itemActions.addIndirectModifier({
-        orderTotal: computedTotal,
-        items: tempItems,
-        modifier,
-      });
-
-      // adding the modifiers to items
-      itemsWIM = itemsWIM.map(item => ({
-        ...item,
-        modifiers: [...(item.modifiers || []), itemsModifiers[item._id]].filter(
-          Boolean
-        ),
-      }));
-      prvSort = sort;
+      calculatedItems = itemActions.calculate(itemsWIM, options);
     }
 
-    const calculatedItemWIM = itemActions.calculate(itemsWIM, options);
-
     const addToItemTotal = difference => {
-      if (difference > 0 && calculatedItemWIM.length) {
-        calculatedItemWIM[0].total = utils.math.toDecimalPlaces(
-          utils.math.add(calculatedItemWIM[0].total, difference)
+      if (difference > 0 && calculatedItems.length) {
+        calculatedItems[0].total = utils.math.toDecimalPlaces(
+          utils.math.add(calculatedItems[0].total, difference)
         );
       }
     };
 
-    if (calculatedItemWIM.length > 1) {
+    if (calculatedItems.length > 1) {
       const difference = itemActions.getTotalsDifference({
-        items: calculatedItemWIM,
+        items: calculatedItems,
       });
 
       addToItemTotal(difference);
     }
 
-    if (storeActions.isNeareastMultiple() && calculatedItemWIM.length > 0) {
+    if (storeActions.isNeareastMultiple() && calculatedItems.length > 0) {
       const difference = itemActions.getTotalNeareastDifference({
-        items: calculatedItemWIM,
+        items: calculatedItems,
       });
 
       if (difference > 0) addToItemTotal(difference);
@@ -130,7 +133,7 @@ module.exports = ({
 
     return {
       ...order,
-      ...itemActions.getItemsTotals(calculatedItemWIM),
-      items: calculatedItemWIM,
+      ...itemActions.getItemsTotals(calculatedItems),
+      items: calculatedItems,
     };
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@darkpos/pricing",
-  "version": "1.0.51",
+  "version": "1.0.53",
   "description": "Pricing calculator",
   "author": "Dark POS",
   "license": "ISC",
@@ -18,6 +18,7 @@
     "test:hasModifier": "jest --runInBand --detectOpenHandles --logHeapUsage  --forceExit ./__TEST__/modifier/hasModifier.test.js",
     "test:item": "jest --runInBand --detectOpenHandles --logHeapUsage  --forceExit ./__TEST__/item.test.js",
     "test:split": "jest --runInBand --detectOpenHandles --logHeapUsage  --forceExit ./__TEST__/order/split.test.js",
+    "test:getModifierTags": "jest --runInBand --detectOpenHandles --logHeapUsage  --forceExit ./__TEST__/item/getModifierTags.test.js",
     "lint": "eslint --quiet lib/"
   },
   "publishConfig": {
@@ -41,5 +42,5 @@
     "supertest": "^6.2.3",
     "supervisor": "^0.12.0"
   },
-  "gitHead": "256cf9e7f41cbdf88d38713f8edae725ec5e855e"
+  "gitHead": "ad5528b8430430e2a34e124218dc4ac1d3da1681"
 }

package/__TEST__/modifier/getNotesToModifierTags.test.js

@@ -1,78 +0,0 @@
-const getNotesToModifierTagsFunction = require('../../lib/modifier/getNotesToModifierTags');
-
-describe('getNotesToModifierTags Function', () => {
-  const getNotesToModifierTags = getNotesToModifierTagsFunction();
-
-  test('should return modifierTags if no notes are provided', () => {
-    const modifierTags = [
-      { label: 'Modifier 1', value: 'mod1', data: {}, quantity: 1 },
-    ];
-
-    const result = getNotesToModifierTags({ notes: null, modifierTags });
-    expect(result).toEqual(modifierTags);
-  });
-
-  test('should return modifierTags if notes array is empty', () => {
-    const modifierTags = [
-      { label: 'Modifier 1', value: 'mod1', data: {}, quantity: 1 },
-    ];
-
-    const result = getNotesToModifierTags({ notes: [], modifierTags });
-    expect(result).toEqual(modifierTags);
-  });
-
-  test('should filter out notes that are null or have a url', () => {
-    const notes = [
-      { message: 'Note 1' },
-      { message: 'Note 2', url: 'http://example.com' }, // Should be filtered out
-      null, // Should be filtered out
-    ];
-
-    const modifierTags = [
-      { label: 'Modifier 1', value: 'mod1', data: {}, quantity: 1 },
-    ];
-
-    const result = getNotesToModifierTags({ notes, modifierTags });
-
-    expect(result).toEqual([
-      { label: 'Modifier 1', value: 'mod1', data: {}, quantity: 1 },
-      { label: 'Note 1', value: '0', data: { message: 'Note 1' }, quantity: 1 },
-    ]);
-  });
-
-  test('should map notes to noteTags and append to modifierTags', () => {
-    const notes = [{ message: 'Note 1' }, { message: 'Note 2' }];
-
-    const modifierTags = [
-      { label: 'Modifier 1', value: 'mod1', data: {}, quantity: 1 },
-    ];
-
-    const result = getNotesToModifierTags({ notes, modifierTags });
-
-    expect(result).toEqual([
-      { label: 'Modifier 1', value: 'mod1', data: {}, quantity: 1 },
-      { label: 'Note 1', value: '0', data: { message: 'Note 1' }, quantity: 1 },
-      { label: 'Note 2', value: '1', data: { message: 'Note 2' }, quantity: 1 },
-    ]);
-  });
-
-  test('should handle case where notes contain falsy values', () => {
-    const notes = [null, undefined, { message: 'Valid Note' }];
-
-    const modifierTags = [
-      { label: 'Modifier 1', value: 'mod1', data: {}, quantity: 1 },
-    ];
-
-    const result = getNotesToModifierTags({ notes, modifierTags });
-
-    expect(result).toEqual([
-      { label: 'Modifier 1', value: 'mod1', data: {}, quantity: 1 },
-      {
-        label: 'Valid Note',
-        value: '0',
-        data: { message: 'Valid Note' },
-        quantity: 1,
-      },
-    ]);
-  });
-});

package/__TEST__/modifier/isComputedOverride.test.js

@@ -1,38 +0,0 @@
-const isComputedOverrideFunction = require('../../lib/modifier/isComputedOverride');
-
-describe('isComputedOverride Function', () => {
-  const Modifier = {
-    Attributes: {
-      OVERRIDE: 'override',
-    },
-  };
-
-  const isComputedOverride = isComputedOverrideFunction({
-    constants: { Modifier },
-  });
-
-  test('should return false if modifier is null or undefined', () => {
-    expect(isComputedOverride(null)).toBe(false);
-    expect(isComputedOverride(undefined)).toBe(false);
-  });
-
-  test('should return false if modifier does not have compute property', () => {
-    const modifier = {};
-    expect(isComputedOverride(modifier)).toBe(false);
-  });
-
-  test('should return false if compute does not have action property', () => {
-    const modifier = { compute: {} };
-    expect(isComputedOverride(modifier)).toBe(false);
-  });
-
-  test('should return false if compute action is not OVERRIDE', () => {
-    const modifier = { compute: { action: 'other_action' } };
-    expect(isComputedOverride(modifier)).toBe(false);
-  });
-
-  test('should return true if compute action is OVERRIDE', () => {
-    const modifier = { compute: { action: 'override' } };
-    expect(isComputedOverride(modifier)).toBe(true);
-  });
-});