@darkpos/pricing 1.0.25 → 1.0.27

package/__TEST__/order/order.test.js

@@ -10,6 +10,7 @@ const orderModifiersPartiallyPaid = require('../mocks/partially-paid/order-modif
 const inputItemsPartiallyPaidOrder = require('../mocks/partially-paid/input-items.json');
 
 const orderCredit = require('../mocks/order-credit.json');
+const { Types } = require('../../lib/constants/Modifier/Compute');
 
 const session = {
   store: mockStores[0],
@@ -1917,208 +1918,326 @@ describe('Order actions', () => {
 
     expect(balanceToPay).toBe(102.79);
   });
-});
 
-test('CU-8678p4ky3. Get Calculated order. Multiple Items. 2 Modifiers. 1 Item tax. 1 Orde discount', () => {
-  const taxMod = {
-    _id: 2,
-    name: `7.75% tax`,
-    type: 'tax',
-    compute: {
-      amount: 7.75,
-      type: 'percentage',
-      action: 'add',
-    },
-    properties: {
-      sort: 2,
-    },
-  };
-
-  const discountMod = {
-    _id: 1,
-    compute: {
-      amount: 15,
+  test('CU-8678p4ky3. Get Calculated order. Multiple Items. 2 Modifiers. 1 Item tax. 1 Orde discount', () => {
+    const taxMod = {
+      _id: 2,
+      name: `7.75% tax`,
+      type: 'tax',
+      compute: {
+        amount: 7.75,
+        type: 'percentage',
+        action: 'add',
+      },
+      properties: {
+        sort: 2,
+      },
+    };
+
+    const discountMod = {
+      _id: 1,
+      compute: {
+        amount: 15,
+        type: 'percentage',
+        action: 'subtract',
+      },
+      name: `15%`,
       type: 'percentage',
-      action: 'subtract',
-    },
-    name: `15%`,
-    type: 'percentage',
-    properties: {
-      sort: 1,
-    },
-  };
-
-  const item1 = {
-    _id: 1,
-    price: 35.95,
-    quantity: 2,
-    modifiers: [taxMod],
-  };
-  const item2 = {
-    _id: 2,
-    price: 28.95,
-    quantity: 2,
-    modifiers: [taxMod],
-  };
-  const item3 = {
-    _id: 3,
-    price: 17.95,
-    quantity: 4,
-    modifiers: [taxMod],
-  };
-  const item4 = {
-    _id: 4,
-    price: 158,
-    quantity: 1,
-    modifiers: [taxMod],
-  };
-  const item5 = {
-    _id: 5,
-    price: 148,
-    quantity: 2,
-    modifiers: [taxMod],
-  };
-  const item6 = {
-    _id: 6,
-    price: 120,
-    quantity: 1,
-    modifiers: [taxMod],
-  };
-
-  const order = {
-    items: [item1, item2, item3, item4, item5, item6],
-    modifiers: [discountMod],
-  };
-
-  const newOrder = pricingService.order.calculate(order);
-
-  expect(newOrder).toHaveProperty('total', 710.35);
-  expect(newOrder).toHaveProperty('subTotal', 775.6);
-  expect(newOrder).toHaveProperty('subTotals', {
-    percentage: -116.34,
-    tax: 51.09,
+      properties: {
+        sort: 1,
+      },
+    };
+
+    const item1 = {
+      _id: 1,
+      price: 35.95,
+      quantity: 2,
+      modifiers: [taxMod],
+    };
+    const item2 = {
+      _id: 2,
+      price: 28.95,
+      quantity: 2,
+      modifiers: [taxMod],
+    };
+    const item3 = {
+      _id: 3,
+      price: 17.95,
+      quantity: 4,
+      modifiers: [taxMod],
+    };
+    const item4 = {
+      _id: 4,
+      price: 158,
+      quantity: 1,
+      modifiers: [taxMod],
+    };
+    const item5 = {
+      _id: 5,
+      price: 148,
+      quantity: 2,
+      modifiers: [taxMod],
+    };
+    const item6 = {
+      _id: 6,
+      price: 120,
+      quantity: 1,
+      modifiers: [taxMod],
+    };
+
+    const order = {
+      items: [item1, item2, item3, item4, item5, item6],
+      modifiers: [discountMod],
+    };
+
+    const newOrder = pricingService.order.calculate(order);
+
+    expect(newOrder).toHaveProperty('total', 710.35);
+    expect(newOrder).toHaveProperty('subTotal', 775.6);
+    expect(newOrder).toHaveProperty('subTotals', {
+      percentage: -116.34,
+      tax: 51.09,
+    });
+    expect(newOrder.items[0]).toHaveProperty('total', 65.8514125);
+    expect(newOrder.items[1]).toHaveProperty('total', 53.0291625);
+    expect(newOrder.items[2]).toHaveProperty('total', 65.759825);
+    expect(newOrder.items[3]).toHaveProperty('total', 144.70825);
+    expect(newOrder.items[4]).toHaveProperty('total', 271.099);
+    expect(newOrder.items[5]).toHaveProperty('total', 109.905);
+    expect(newOrder.items[0].modifiers[0]._computed).toHaveProperty(
+      'amount',
+      -10.785
+    );
+    expect(newOrder.items[0].modifiers[1]._computed).toHaveProperty(
+      'amount',
+      4.7364125
+    );
+
+    expect(newOrder.items[1].modifiers[0]._computed).toHaveProperty(
+      'amount',
+      -8.685
+    );
+    expect(newOrder.items[1].modifiers[1]._computed).toHaveProperty(
+      'amount',
+      3.8141625
+    );
+
+    expect(newOrder.items[2].modifiers[0]._computed).toHaveProperty(
+      'amount',
+      -10.77
+    );
+    expect(newOrder.items[2].modifiers[1]._computed).toHaveProperty(
+      'amount',
+      4.729825
+    );
+
+    expect(newOrder.items[3].modifiers[0]._computed).toHaveProperty(
+      'amount',
+      -23.7
+    );
+    expect(newOrder.items[3].modifiers[1]._computed).toHaveProperty(
+      'amount',
+      10.40825
+    );
+
+    expect(newOrder.items[4].modifiers[0]._computed).toHaveProperty(
+      'amount',
+      -44.4
+    );
+    expect(newOrder.items[4].modifiers[1]._computed).toHaveProperty(
+      'amount',
+      19.499
+    );
+
+    expect(newOrder.items[5].modifiers[0]._computed).toHaveProperty(
+      'amount',
+      -18
+    );
+    expect(newOrder.items[5].modifiers[1]._computed).toHaveProperty(
+      'amount',
+      7.905
+    );
   });
-  expect(newOrder.items[0]).toHaveProperty('total', 65.8514125);
-  expect(newOrder.items[1]).toHaveProperty('total', 53.0291625);
-  expect(newOrder.items[2]).toHaveProperty('total', 65.759825);
-  expect(newOrder.items[3]).toHaveProperty('total', 144.70825);
-  expect(newOrder.items[4]).toHaveProperty('total', 271.099);
-  expect(newOrder.items[5]).toHaveProperty('total', 109.905);
-  expect(newOrder.items[0].modifiers[0]._computed).toHaveProperty(
-    'amount',
-    -10.785
-  );
-  expect(newOrder.items[0].modifiers[1]._computed).toHaveProperty(
-    'amount',
-    4.7364125
-  );
-
-  expect(newOrder.items[1].modifiers[0]._computed).toHaveProperty(
-    'amount',
-    -8.685
-  );
-  expect(newOrder.items[1].modifiers[1]._computed).toHaveProperty(
-    'amount',
-    3.8141625
-  );
-
-  expect(newOrder.items[2].modifiers[0]._computed).toHaveProperty(
-    'amount',
-    -10.77
-  );
-  expect(newOrder.items[2].modifiers[1]._computed).toHaveProperty(
-    'amount',
-    4.729825
-  );
-
-  expect(newOrder.items[3].modifiers[0]._computed).toHaveProperty(
-    'amount',
-    -23.7
-  );
-  expect(newOrder.items[3].modifiers[1]._computed).toHaveProperty(
-    'amount',
-    10.40825
-  );
-
-  expect(newOrder.items[4].modifiers[0]._computed).toHaveProperty(
-    'amount',
-    -44.4
-  );
-  expect(newOrder.items[4].modifiers[1]._computed).toHaveProperty(
-    'amount',
-    19.499
-  );
-
-  expect(newOrder.items[5].modifiers[0]._computed).toHaveProperty(
-    'amount',
-    -18
-  );
-  expect(newOrder.items[5].modifiers[1]._computed).toHaveProperty(
-    'amount',
-    7.905
-  );
-});
 
-test('CU-8678tdrvq. Get Calculated order. Multiple Items. 1 Order tax', () => {
-  const taxMod = {
-    _id: 2,
-    name: `7.75% tax`,
-    type: 'tax',
-    compute: {
-      amount: 7.75,
-      type: 'percentage',
-      action: 'add',
-    },
-    properties: {
-      sort: 2,
-    },
-  };
-
-  const item1 = {
-    _id: 1,
-    price: 38,
-    quantity: 1,
-    modifiers: [],
-  };
-  const item2 = {
-    _id: 2,
-    price: 42,
-    quantity: 1,
-    modifiers: [],
-  };
-  const item3 = {
-    _id: 3,
-    price: 48,
-    quantity: 1,
-    modifiers: [],
-  };
-
-  const order = {
-    items: [item1, item2, item3],
-    modifiers: [taxMod],
-  };
-
-  const newOrder = pricingService.order.calculate(order);
-
-  expect(newOrder).toHaveProperty('total', 137.92);
-  expect(newOrder).toHaveProperty('subTotal', 128);
-  expect(newOrder).toHaveProperty('subTotals', {
-    tax: 9.92,
+  test('CU-8678tdrvq. Get Calculated order. Multiple Items. 1 Order tax', () => {
+    const taxMod = {
+      _id: 2,
+      name: `7.75% tax`,
+      type: 'tax',
+      compute: {
+        amount: 7.75,
+        type: 'percentage',
+        action: 'add',
+      },
+      properties: {
+        sort: 2,
+      },
+    };
+
+    const item1 = {
+      _id: 1,
+      price: 38,
+      quantity: 1,
+      modifiers: [],
+    };
+    const item2 = {
+      _id: 2,
+      price: 42,
+      quantity: 1,
+      modifiers: [],
+    };
+    const item3 = {
+      _id: 3,
+      price: 48,
+      quantity: 1,
+      modifiers: [],
+    };
+
+    const order = {
+      items: [item1, item2, item3],
+      modifiers: [taxMod],
+    };
+
+    const newOrder = pricingService.order.calculate(order);
+
+    expect(newOrder).toHaveProperty('total', 137.92);
+    expect(newOrder).toHaveProperty('subTotal', 128);
+    expect(newOrder).toHaveProperty('subTotals', {
+      tax: 9.92,
+    });
+    expect(newOrder.items[0]).toHaveProperty('total', 40.945);
+    expect(newOrder.items[1]).toHaveProperty('total', 45.255);
+    expect(newOrder.items[2]).toHaveProperty('total', 51.72);
+    expect(newOrder.items[0].modifiers[0]._computed).toHaveProperty(
+      'amount',
+      2.945
+    );
+
+    expect(newOrder.items[1].modifiers[0]._computed).toHaveProperty(
+      'amount',
+      3.255
+    );
+    expect(newOrder.items[2].modifiers[0]._computed).toHaveProperty(
+      'amount',
+      3.72
+    );
+  });
+
+  test('CU-86dtxh2y5: #1- Get calculated Order, One item and fixed Fee Modifier', () => {
+    const newOrderFixedModifier = pricingService.order.calculate({
+      items: [
+        {
+          _id: 1,
+          price: 5,
+          quantity: 2,
+        },
+      ],
+      modifiers: [
+        {
+          compute: {
+            amount: 10,
+            type: 'fixed',
+            action: 'add',
+          },
+          name: 'fee 10 USD',
+          type: 'fee',
+        },
+      ],
+    });
+    expect(newOrderFixedModifier).toHaveProperty('total', 20);
+  });
+
+  test('CU-86dtxh2y5: #2.A- Get calculated Order, One item and fixed Fee Modifier (ignoreQuantity: false)', () => {
+    const newOrderFixedModifier = pricingService.order.calculate({
+      items: [
+        {
+          _id: 1,
+          price: 5,
+          quantity: 2,
+          modifiers: [
+            {
+              compute: {
+                amount: 20,
+                type: 'fixed',
+                action: 'add',
+              },
+              name: 'fee 20 USD',
+              type: 'fee',
+            },
+          ],
+        },
+      ],
+    });
+    expect(newOrderFixedModifier).toHaveProperty('total', 50);
+  });
+
+  test('CU-86dtxh2y5: #2.B- Get calculated Order, One item and fixed Fee Modifier (ignoreQuantity: true)', () => {
+    const newOrderFixedModifier = pricingService.order.calculate({
+      items: [
+        {
+          _id: 1,
+          price: 5,
+          quantity: 2,
+          modifiers: [
+            {
+              compute: {
+                amount: 20,
+                type: 'fixed',
+                action: 'add',
+              },
+              name: 'fee 20 USD',
+              type: 'fee',
+              properties: {
+                ignoreQuantity: true,
+              },
+            },
+          ],
+        },
+      ],
+    });
+    expect(newOrderFixedModifier).toHaveProperty('total', 30);
+  });
+
+  test('CU-86dtxh2y5: #3- Get calculated Order, One item and fixed Fee Modifier, using createFeeModifier', () => {
+    const newOrderFixedModifier = pricingService.order.calculate({
+      items: [
+        {
+          _id: 1,
+          price: 10,
+          quantity: 2,
+        },
+      ],
+      modifiers: [
+        pricingService.modifier.createFeeModifier({
+          amount: 100,
+          type: Types.FIXED,
+        }),
+      ],
+    });
+
+    expect(newOrderFixedModifier).toHaveProperty('total', 120);
+  });
+
+  test('CU-86dtxh2y5: #4- Get calculated Order, One item and fixed Fee Modifier, using createFeeModifier (ignoreQuantity: true)', () => {
+    const newOrderFixedModifier = pricingService.order.calculate({
+      items: [
+        {
+          _id: 1,
+          price: 10,
+          quantity: 2,
+        },
+      ],
+      modifiers: [
+        pricingService.modifier.createFeeModifier({
+          amount: 100,
+          type: Types.FIXED,
+          properties: {
+            ignoreQuantity: true,
+          },
+        }),
+      ],
+    });
+
+    expect(newOrderFixedModifier).toHaveProperty('total', 120);
   });
-  expect(newOrder.items[0]).toHaveProperty('total', 40.945);
-  expect(newOrder.items[1]).toHaveProperty('total', 45.255);
-  expect(newOrder.items[2]).toHaveProperty('total', 51.72);
-  expect(newOrder.items[0].modifiers[0]._computed).toHaveProperty(
-    'amount',
-    2.945
-  );
-
-  expect(newOrder.items[1].modifiers[0]._computed).toHaveProperty(
-    'amount',
-    3.255
-  );
-  expect(newOrder.items[2].modifiers[0]._computed).toHaveProperty(
-    'amount',
-    3.72
-  );
 });

package/lib/constants/Modifier/Types.js

@@ -2,6 +2,7 @@
 module.exports = {
   DISCOUNT: 'discount',
   TAX: 'tax',
+  FEE: 'fee',
   GRATUITY: 'gratuity',
   CREDIT: 'credit',
 };

package/lib/index.js

@@ -34,5 +34,6 @@ module.exports = session => {
     item: itemActions,
     order: orderActions,
     modifier: modifierActions,
+    constants,
   };
 };

package/lib/item/calculate.js

@@ -73,7 +73,8 @@ module.exports = ({ _, utils, actions, modifierActions }) => {
         let computedAmount =
           _modifier.compute.type === 'percentage' ||
           modifierActions.isIgnoreQuantity(_modifier) ||
-          math.gt(math.abs(computedAmountCalc), computedPriceCalc)
+          (!modifierActions.isFixedAdd(_modifier) &&
+            math.gt(math.abs(computedAmountCalc), computedPriceCalc))
             ? _computed.amount
             : computedAmountCalc;
 

package/lib/modifier/calculate.js

@@ -19,7 +19,9 @@ module.exports = ({ _, constants, utils, localization, actions }) => {
     const maxAmountProp = actions.getProperty(modifier, 'maxAmount');
 
     if (!options.skip) {
-      const maxAmountCalc = math.mul(options.price, options.quantity);
+      const maxAmountCalc = actions.isFixedAdd(modifier)
+        ? amount
+        : math.mul(options.price, options.quantity);
 
       const maxAmount = maxAmountProp
         ? math.min(maxAmountProp, maxAmountCalc)

package/lib/modifier/createDiscountModifier.js

@@ -2,7 +2,7 @@ module.exports = ({ constants, actions, localization }) => {
   const { Modifier } = constants;
 
   return function createDiscountModifier(params) {
-    const { amount, type } = params;
+    const { amount, type, properties } = params;
     const { formatAmount } = localization;
 
     const name =
@@ -18,6 +18,9 @@ module.exports = ({ constants, actions, localization }) => {
       },
       type: Modifier.Types.DISCOUNT,
       name: `${name} ${Modifier.Types.DISCOUNT}`,
+      properties: {
+        ...properties,
+      },
     });
   };
 };

package/lib/modifier/createFeeModifier.js

@@ -0,0 +1,27 @@
+module.exports = ({ constants, actions, localization }) => {
+  const { Modifier } = constants;
+
+  return function createFeeModifier(params) {
+    const { amount, type, properties } = params;
+    const { formatAmount } = localization;
+
+    const name =
+      type === Modifier.Compute.Types.PERCENTAGE
+        ? `${amount}%`
+        : `${formatAmount(amount)}`;
+
+    return actions.create({
+      compute: {
+        action: Modifier.Compute.Actions.ADD,
+        amount,
+        type,
+      },
+      type: Modifier.Types.FEE,
+      name: `${name} ${Modifier.Types.FEE}`,
+      properties: {
+        ignoreQuantity: true,
+        ...properties,
+      },
+    });
+  };
+};

package/lib/modifier/createIndirectModifier.js

@@ -35,10 +35,15 @@ module.exports = ({ _, utils, constants, actions }) => {
       !math.isZero(options.orderTotal) &&
       (type !== Modifier.Compute.Types.PERCENTAGE || modifier.type === 'credit')
     ) {
+      const modififierQuantity =
+        modifier.properties && modifier.properties.ignoreQuantity
+          ? 1
+          : options.itemQuantity;
+
       amountToApply = math.div(
         math.mul(modifierAmount, options.itemTotal),
         options.orderTotal,
-        options.itemQuantity
+        modififierQuantity
       );
     }
 

package/lib/modifier/index.js

@@ -8,6 +8,7 @@ const create = require('./create');
 const createAmountOverrideModifier = require('./createAmountOverrideModifier');
 const createCreditModifier = require('./createCreditModifier');
 const createDiscountModifier = require('./createDiscountModifier');
+const createFeeModifier = require('./createFeeModifier');
 const createGroupValuesModifier = require('./createGroupValuesModifier');
 const createIndirectModifier = require('./createIndirectModifier');
 const createSubscriptionModifier = require('./createSubscriptionModifier');
@@ -120,6 +121,10 @@ const isPaymentModifier = require('./isPaymentModifier');
 const createPaymentModifier = require('./createPaymentModifier');
 const isSubtract = require('./isSubtract');
 const isFixed = require('./isFixed');
+const isFixedAdd = require('./isFixedAdd');
+const isFee = require('./isFee');
+const isAdd = require('./isAdd');
+
 const isFixedDiscount = require('./isFixedDiscount');
 const removeLocked = require('./removeLocked');
 const hasItems = require('./hasItems');
@@ -143,6 +148,7 @@ const modifierActions = (deps = {}) => {
     createAmountOverrideModifier: createAmountOverrideModifier(innerDeps),
     createCreditModifier: createCreditModifier(innerDeps),
     createDiscountModifier: createDiscountModifier(innerDeps),
+    createFeeModifier: createFeeModifier(innerDeps),
     createGroupValuesModifier: createGroupValuesModifier(innerDeps),
     createIndirectModifier: createIndirectModifier(innerDeps),
     createSubscriptionModifier: createSubscriptionModifier(innerDeps),
@@ -260,6 +266,9 @@ const modifierActions = (deps = {}) => {
     removeLocked: removeLocked(innerDeps),
     hasItems: hasItems(innerDeps),
     getLockedModifiers: getLockedModifiers(innerDeps),
+    isFixedAdd: isFixedAdd(innerDeps),
+    isFee: isFee(innerDeps),
+    isAdd: isAdd(innerDeps),
   });
 
   Object.keys(freezedActions).forEach(actionName => {

package/lib/modifier/isAdd.js

@@ -0,0 +1,10 @@
+module.exports = ({ constants }) => {
+  const { Modifier } = constants;
+  return function isAdd(modifier) {
+    return !!(
+      modifier &&
+      modifier.compute &&
+      modifier.compute.action === Modifier.Compute.Actions.ADD
+    );
+  };
+};

package/lib/modifier/isFee.js

@@ -0,0 +1,6 @@
+module.exports = ({ constants }) => {
+  const { Modifier } = constants;
+  return function isFee(modifier) {
+    return !!(modifier && modifier.type === Modifier.Types.FEE);
+  };
+};

package/lib/modifier/isFixedAdd.js

@@ -0,0 +1,4 @@
+module.exports = ({ actions }) =>
+  function isFixedAdd(modifier) {
+    return actions.isAdd(modifier) && actions.isFixed(modifier);
+  };

package/lib/modifier/isFixedFee.js

@@ -0,0 +1,4 @@
+module.exports = ({ actions }) =>
+  function isFixedFee(modifier) {
+    return actions.isFee(modifier) && actions.isFixed(modifier);
+  };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@darkpos/pricing",
-  "version": "1.0.25",
+  "version": "1.0.27",
   "description": "Pricing calculator",
   "author": "Dark POS",
   "license": "ISC",
@@ -36,5 +36,5 @@
     "supertest": "^6.2.3",
     "supervisor": "^0.12.0"
   },
-  "gitHead": "e8af4c6528df412d450ff6382f930723b32e6a1d"
+  "gitHead": "575378174e6efda3e4bffa65d1226e55eb09725e"
 }