@darkpos/pricing 1.0.14 → 1.0.16

package/__TEST__/order/order.test.js

@@ -0,0 +1,610 @@
+const usePricing = require('../../index');
+const mockStores = require('../mocks/stores');
+
+const orderNotPaid = require('../mocks/unpaid/order-not-paid.json');
+const orderModifiersNotPaid = require('../mocks/unpaid/order-modifiers.json');
+const inputItemsNotPaidOrder = require('../mocks/unpaid/input-items.json');
+
+const orderPartiallyPaid = require('../mocks/partially-paid/order-partially-paid.json');
+const orderModifiersPartiallyPaid = require('../mocks/partially-paid/order-modifiers.json');
+const inputItemsPartiallyPaidOrder = require('../mocks/partially-paid/input-items.json');
+
+const session = {
+  store: mockStores[0],
+};
+
+const pricingService = usePricing(session);
+
+describe('Order actions', () => {
+  test('Get calculated Order, one item', () => {
+    const modifiers = [
+      {
+        compute: {
+          amount: 20,
+          type: 'percentage',
+          action: 'add',
+        },
+        name: 'modifier1',
+        type: 'discount',
+      },
+      {
+        compute: {
+          amount: 20,
+          type: 'percentage',
+          action: 'subtract',
+        },
+        name: 'modifier2',
+        type: 'discount',
+      },
+      {
+        compute: { amount: 2, type: 'fixed', action: 'subtract' },
+        name: 'modifier3',
+        type: 'discount',
+      },
+    ];
+    const orderItem = { price: 30, quantity: 2, modifiers };
+    const order = { items: [orderItem] };
+    const newOrder = pricingService.order.calculate(order);
+
+    expect(newOrder).toHaveProperty('total', 56);
+    expect(newOrder).toHaveProperty('subTotal', 60);
+    expect(newOrder).toHaveProperty('subTotals', {
+      discount: -4,
+    });
+  });
+  test('Get calculated Order, multiple items', () => {
+    const item1 = {
+      _id: 1,
+      price: 30,
+      quantity: 2,
+      modifiers: [
+        {
+          compute: {
+            amount: 2,
+            type: 'fixed',
+            action: 'subtract',
+          },
+          name: 'modifier1',
+          type: 'discount',
+        },
+      ],
+    };
+    const item2 = {
+      _id: 2,
+      price: 10,
+      quantity: 1,
+      modifiers: [
+        {
+          compute: {
+            amount: 2,
+            type: 'fixed',
+            action: 'subtract',
+          },
+          name: 'modifier1',
+          type: 'discount',
+        },
+      ],
+    };
+    const order = { items: [item1, item2] };
+    const newOrder = pricingService.order.calculate(order);
+    expect(newOrder).toHaveProperty('total', 64);
+    expect(newOrder).toHaveProperty('subTotal', 70);
+    expect(newOrder).toHaveProperty('subTotals', {
+      discount: -6,
+    });
+    // console.log(JSON.stringify(newOrder, 0, 2));
+  });
+  test('Get calculated Order, multiple items and indirect modifiers', () => {
+    const item1 = {
+      _id: 1,
+      price: 30,
+      quantity: 2,
+    };
+    const item2 = {
+      _id: 2,
+      price: 10,
+      quantity: 1,
+    };
+    const modifier1 = {
+      compute: {
+        amount: 2,
+        type: 'fixed',
+        action: 'subtract',
+      },
+      name: 'modifier1',
+      type: 'discount',
+    };
+
+    const order = { items: [item1, item2], modifiers: [modifier1] };
+
+    const newOrder = pricingService.order.calculate(order);
+    expect(newOrder).toHaveProperty('total', 68);
+    expect(newOrder).toHaveProperty('subTotal', 70);
+    expect(newOrder).toHaveProperty('subTotals', {
+      discount: -2,
+    });
+    expect(newOrder.items[0]).toHaveProperty('total', 58.28);
+    expect(newOrder.items[0]).toHaveProperty('subTotals', {
+      discount: -1.72,
+      _included: 0,
+      _xincluded: -1.72,
+      _direct: 0,
+      _xdirect: -1.72,
+      _simple: 60,
+      _actual: 60,
+    });
+    expect(newOrder.items[1]).toHaveProperty('total', 9.72);
+    expect(newOrder.items[1]).toHaveProperty('subTotals', {
+      discount: -0.28,
+      _included: 0,
+      _xincluded: -0.28,
+      _direct: 0,
+      _xdirect: -0.28,
+      _simple: 10,
+      _actual: 10,
+    });
+  });
+  test('Get calculated Order, multiple items and indirect modifiers #2', () => {
+    const item1 = {
+      _id: 1,
+      price: 15.99,
+      quantity: 1,
+    };
+    const item2 = {
+      _id: 2,
+      price: 4.65,
+      quantity: 1,
+    };
+    const modifier1 = {
+      compute: {
+        amount: 10,
+        action: 'subtract',
+        type: 'percentage',
+      },
+      name: 'modifier1',
+      type: 'discount',
+    };
+
+    const order = { items: [item1, item2], modifiers: [modifier1] };
+    const newOrder = pricingService.order.calculate(order);
+    expect(newOrder).toHaveProperty('total', 18.58);
+    expect(newOrder).toHaveProperty('subTotal', 20.64);
+    expect(newOrder).toHaveProperty('subTotals', {
+      discount: -2.06,
+    });
+    expect(newOrder.items[0]).toHaveProperty('total', 14.39);
+    expect(newOrder.items[0]).toHaveProperty('subTotals', {
+      discount: -1.6,
+      _included: 0,
+      _xincluded: -1.6,
+      _direct: 0,
+      _xdirect: -1.6,
+      _simple: 15.99,
+      _actual: 15.99,
+    });
+    expect(newOrder.items[1]).toHaveProperty('total', 4.19);
+    expect(newOrder.items[1]).toHaveProperty('subTotals', {
+      discount: -0.46,
+      _included: 0,
+      _xincluded: -0.46,
+      _direct: 0,
+      _xdirect: -0.46,
+      _simple: 4.65,
+      _actual: 4.65,
+    });
+  });
+  test('Get calculated Order, multiple items and indirect modifiers #3', () => {
+    const item1 = {
+      _id: 1,
+      price: 3,
+      quantity: 1,
+    };
+    const item2 = {
+      _id: 2,
+      price: 3,
+      quantity: 1,
+    };
+    const item3 = {
+      _id: 3,
+      price: 4,
+      quantity: 1,
+    };
+    const modifier1 = {
+      _id: 1,
+      compute: {
+        amount: 10,
+        type: 'percentage',
+        action: 'subtract',
+      },
+      name: `10% Discount`,
+      type: 'discount',
+    };
+
+    const modifier2 = {
+      _id: 2,
+      name: `20% tax`,
+      type: 'tax',
+      compute: {
+        amount: 20,
+        type: 'percentage',
+        action: 'add',
+      },
+    };
+
+    const order = {
+      items: [item1, item2, item3],
+      modifiers: [modifier1, modifier2],
+    };
+    const newOrder = pricingService.order.calculate(order);
+    expect(newOrder).toHaveProperty('total', 11);
+    expect(newOrder).toHaveProperty('subTotal', 10);
+    expect(newOrder).toHaveProperty('subTotals', {
+      discount: -1,
+      tax: 2,
+    });
+  });
+
+  test('Auto split a Parent Order', () => {
+    const parentOrder = {
+      _id: '6392069cb6c81965a442289d',
+      displayId: '1',
+      parentId: null,
+      isParent: false,
+      subTotal: 15,
+      tax: 0,
+      discount: 0,
+      total: 15,
+      description: '',
+      type: '',
+      fee: 0,
+      location: {},
+      status: {
+        order: 'open',
+        kitchen: 'open',
+        delivery: 'none',
+        detailed: true,
+      },
+      attributes: [],
+      properties: {
+        pieces: [],
+        notify: {
+          sms: false,
+        },
+        print: {},
+        split: 'auto',
+      },
+      subTotals: {},
+      user: {
+        _id: '5a09fd650cd56e741f78aba6',
+      },
+      items: [
+        {
+          _id: '639206f1b6c81965a44228ba',
+          itemId: '62cdbfd01ee1b40019328252',
+          name: 'Box Shirt - Fold',
+          description: '',
+          modifiersTotalAmount: 0,
+          location: {},
+          price: 2,
+          pieces: 1,
+          quantity: 1,
+          path: ['menuCategories', 8],
+          menuId: '62cdbfd0aaf93c00193d2efe',
+          serial: null,
+          sku: null,
+          total: 2,
+          status: {
+            picked: {
+              value: false,
+              date: '',
+            },
+            paid: {
+              value: false,
+              date: '',
+            },
+            tracker: [],
+          },
+          subTotals: {
+            _included: 0,
+            _xincluded: 0,
+            _direct: 0,
+            _xdirect: 0,
+            _simple: 2,
+            _actual: 2,
+          },
+          properties: false,
+          modifiers: [
+            {
+              _id: '639206f1b6c81965a44228bc',
+              modifierId: '62cdbfd01ee1b4001932816c',
+              name: 'Laundry',
+              sku: '',
+              description: '',
+              group: '',
+              type: null,
+              attributes: ['department'],
+              color: '',
+              backgroundColor: null,
+              icon: null,
+              url: '',
+              tags: [],
+              order: 2,
+              included: false,
+              direct: true,
+              hidden: true,
+              print: false,
+              required: true,
+              recommended: false,
+              default: false,
+              code: 'L',
+              properties: {
+                department: {
+                  tagSize: 'Small',
+                  customerTagsExtend: null,
+                  maxItems: 4,
+                },
+              },
+              _computed: {
+                amount: 0,
+                description: 'Laundry ($0.00)',
+              },
+              addModifiers: [],
+              delModifiers: [],
+              conditions: null,
+              compute: null,
+            },
+          ],
+          notes: [],
+        },
+        {
+          _id: '639206efb6c81965a44228b7',
+          itemId: '62cdbfd01ee1b40019328284',
+          name: 'Pants',
+          description: '',
+          modifiersTotalAmount: 0,
+          location: {},
+          price: 4,
+          pieces: 1,
+          quantity: 1,
+          path: ['menuCategories', 11],
+          menuId: '62cdbfd0aaf93c00193d2efe',
+          serial: null,
+          sku: null,
+          total: 4,
+          status: {
+            picked: {
+              value: false,
+              date: '',
+            },
+            paid: {
+              value: false,
+              date: '',
+            },
+            tracker: [],
+          },
+          subTotals: {
+            _included: 0,
+            _xincluded: 0,
+            _direct: 0,
+            _xdirect: 0,
+            _simple: 4,
+            _actual: 4,
+          },
+          properties: false,
+          modifiers: [
+            {
+              _id: '639206efb6c81965a44228b9',
+              modifierId: '62cdbfd01ee1b4001932816d',
+              name: 'Dry Cleaning',
+              sku: '',
+              description: '',
+              group: '',
+              type: null,
+              attributes: ['department'],
+              color: '',
+              backgroundColor: null,
+              icon: null,
+              url: '',
+              tags: null,
+              order: 1,
+              included: false,
+              direct: true,
+              hidden: true,
+              print: false,
+              required: true,
+              recommended: false,
+              default: false,
+              code: 'D',
+              properties: {
+                department: {
+                  tagSize: 'Small',
+                  customerTagsExtend: null,
+                  maxItems: 4,
+                },
+              },
+              _computed: {
+                amount: 0,
+                description: 'Dry Cleaning ($0.00)',
+              },
+              addModifiers: [],
+              delModifiers: [],
+              conditions: null,
+              compute: null,
+            },
+          ],
+          notes: [],
+        },
+        {
+          _id: '639206edb6c81965a44228b4',
+          itemId: '62cdbfd01ee1b400193281f1',
+          name: 'M-L 2pc Suit',
+          description: null,
+          modifiersTotalAmount: 0,
+          location: {},
+          price: 9,
+          pieces: 2,
+          quantity: 1,
+          path: ['menuCategories', 0],
+          menuId: '62cdbfd0aaf93c00193d2efe',
+          serial: null,
+          sku: null,
+          total: 9,
+          status: {
+            picked: {
+              value: false,
+              date: '',
+            },
+            paid: {
+              value: false,
+              date: '',
+            },
+            tracker: [],
+          },
+          subTotals: {
+            _included: 0,
+            _xincluded: 0,
+            _direct: 0,
+            _xdirect: 0,
+            _simple: 9,
+            _actual: 9,
+          },
+          properties: false,
+          modifiers: [
+            {
+              _id: '639206edb6c81965a44228b6',
+              modifierId: '62cdbfd01ee1b4001932816d',
+              name: 'Dry Cleaning',
+              sku: '',
+              description: '',
+              group: '',
+              type: null,
+              attributes: ['department'],
+              color: '',
+              backgroundColor: null,
+              icon: null,
+              url: '',
+              tags: null,
+              order: 1,
+              included: false,
+              direct: true,
+              hidden: true,
+              print: false,
+              required: true,
+              recommended: false,
+              default: false,
+              code: 'D',
+              properties: {
+                department: {
+                  tagSize: 'Small',
+                  customerTagsExtend: null,
+                  maxItems: 4,
+                },
+              },
+              _computed: {
+                amount: 0,
+                description: 'Dry Cleaning ($0.00)',
+              },
+              addModifiers: [],
+              delModifiers: [],
+              conditions: null,
+              compute: null,
+            },
+          ],
+          notes: [],
+        },
+      ],
+      notes: [],
+      start: {
+        actualDate: '2022-12-08T15:45:27.838Z',
+        requestDate: '2022-12-08T15:45:27.838Z',
+        location: null,
+      },
+      end: {
+        actualDate: '',
+        requestDate: '2022-12-12T22:00:00.000Z',
+        location: {
+          name: 'Location Name',
+          locationType: 'store',
+          storeId: '59c042222a985ae70278619f',
+        },
+      },
+      customer: {
+        _id: '5c73d50b213453368dd30422',
+      },
+      modifiers: [],
+    };
+
+    const subOrders = pricingService.order
+      .autoSplit({ parentOrder })
+      .sort((a, b) => {
+        if (a.displayId < b.displayId) return -1;
+        if (a.displayId > b.displayId) return 1;
+        return 0;
+      });
+
+    expect(subOrders[0].displayId).toBe('1-1');
+    expect(subOrders[0].items.map(item => item.name)).toEqual([
+      'Box Shirt - Fold',
+    ]);
+    expect(subOrders[1].displayId).toBe('1-2');
+    expect(subOrders[1].items.map(item => item.name)).toEqual([
+      'Pants',
+      'M-L 2pc Suit',
+    ]);
+  });
+  test('Get calculated UNPAID Order, multiple items and paymentModifiers', () => {
+    const paymentModifiers = orderModifiersNotPaid.map(orderMod =>
+      pricingService.modifier.createPaymentModifier({
+        modifier: orderMod,
+        items: inputItemsNotPaidOrder,
+      })
+    );
+
+    let order = { ...orderNotPaid };
+
+    order = pricingService.order.addModifiers({
+      modifiers: paymentModifiers,
+      order,
+    });
+
+    const newOrder = pricingService.order.calculate(order);
+
+    expect(newOrder).toHaveProperty('total', 34.45);
+    expect(newOrder).toHaveProperty('subTotal', 42.45);
+    expect(newOrder).toHaveProperty('subTotals', {
+      discount: -10,
+      fee: 2,
+    });
+    expect(newOrder.items[0]).toHaveProperty('total', 8.08);
+    expect(newOrder.items[1]).toHaveProperty('total', 7.71);
+    expect(newOrder.items[2]).toHaveProperty('total', 11.36);
+    expect(newOrder.items[3]).toHaveProperty('total', 7.3);
+  });
+  test('Get calculated PARTIALLY PAID Order, multiple items and paymentModifiers', () => {
+    const paymentModifiers = orderModifiersPartiallyPaid.map(orderMod =>
+      pricingService.modifier.createPaymentModifier({
+        modifier: orderMod,
+        items: inputItemsPartiallyPaidOrder,
+      })
+    );
+
+    let order = { ...orderPartiallyPaid };
+
+    order = pricingService.order.addModifiers({
+      modifiers: paymentModifiers,
+      order,
+    });
+    const newOrder = pricingService.order.calculate(order);
+
+    expect(newOrder).toHaveProperty('total', 36.45);
+    expect(newOrder).toHaveProperty('subTotal', 42.45);
+    expect(newOrder).toHaveProperty('subTotals', {
+      discount: -10,
+      fee: 4,
+    });
+    expect(newOrder.items[0]).toHaveProperty('total', 8.07);
+    expect(newOrder.items[1]).toHaveProperty('total', 7.71);
+    expect(newOrder.items[2]).toHaveProperty('total', 11.37);
+    expect(newOrder.items[3]).toHaveProperty('total', 9.3);
+  });
+});

package/lib/item/addIndirectModifier.js

@@ -1,14 +1,13 @@
 module.exports = ({ utils, modifierActions }) => {
   const { math } = utils;
 
-  return function addIndirectModifier(orderTotal, items, modifier) {
+  return function addIndirectModifier({ orderTotal, items, modifier }) {
     const itemsModifiers = {};
     // get distributed price in order level
     const { _computed } = modifierActions.calculate(modifier, {
       price: orderTotal,
       quantity: 1,
     });
-
     const orderModifierTotal = math.abs(_computed.amount);
     const totalDistributed = items.reduce((acc, item) => {
       const inheritedModifier = modifierActions.createIndirectModifier(
@@ -29,7 +28,6 @@ module.exports = ({ utils, modifierActions }) => {
     // check validation
     if (math.abs(totalDistributed) !== math.abs(orderModifierTotal)) {
       const difference = math.sub(orderModifierTotal, totalDistributed);
-      // console.log('difference => ', difference);
       const selectedItem = items.find(
         item => math.sub(item.total, difference) > 0
       );
@@ -51,6 +49,7 @@ module.exports = ({ utils, modifierActions }) => {
           },
         };
       }
+
       return itemsModifiers;
     }
 

package/lib/item/calculate.js

@@ -66,7 +66,6 @@ module.exports = ({ _, utils, modifierActions }) => {
 
         modifiers.push(_modifier);
         const { type, _computed } = _modifier;
-        // console.log('computedPrice => ', _computed);
         let computedAmount = modifierActions.isIgnoreQuantity(_modifier)
           ? _computed.amount
           : math.mul(_computed.amount, quantity);
@@ -89,7 +88,7 @@ module.exports = ({ _, utils, modifierActions }) => {
     }
 
     subTotals._actual = math.add(subTotals._simple, subTotals._included);
-    // console.log('subTotals =>', subTotals);
+
     const total = math.add(subTotals._actual, subTotals._xincluded);
 
     return {

package/lib/item/getBalance.js

@@ -0,0 +1,9 @@
+module.exports = ({ utils }) => {
+  const { math } = utils;
+  return function getBalance({ item }) {
+    if (!item) return 0;
+    if (Array.isArray(item)) return 0;
+
+    return math.sub(item.total, item.totalPaid);
+  };
+};

package/lib/item/getItemModifiers.js

@@ -1,16 +1,5 @@
-module.exports = ({ modifierActions }) =>
-  function getItemModifiers(item, orderModifiers) {
-    const existsInOrderModifier = modifier =>
-      orderModifiers &&
-      orderModifiers.find(each => each.modifierId === modifier.modifierId);
+module.exports = () =>
+  function getItemModifiers(item) {
 
-    let modifiers = [];
-    if (!item || !Array.isArray(item.modifiers)) return modifiers;
-
-    modifiers.push(...item.modifiers);
-
-    if (Array.isArray(orderModifiers) && orderModifiers.length)
-      modifiers = modifiers.filter(each => !existsInOrderModifier(each));
-
-    return modifiers.filter(modifierActions.isDirect);
+    return item.modifiers;
   };

package/lib/item/getItems.js

@@ -0,0 +1,5 @@
+module.exports = () =>
+  function getItems(items, itemsToPay) {
+    if (!Array.isArray(itemsToPay)) return items;
+    return items.filter(item => itemsToPay.includes(item._id));
+  };

package/lib/item/getTotal.js

@@ -3,6 +3,6 @@ module.exports = ({ utils }) => {
   return function getTotal(item) {
     if (!item || !item.subTotals) return 0;
 
-    return math.add(item.subTotals._simple, item.subTotals._direct);
+    return math.add(item.subTotals._simple, item.subTotals._xincluded);
   };
 };

package/lib/item/getTotalPrice.js

@@ -0,0 +1,10 @@
+module.exports = ({ utils }) =>
+  function getTotalPrice({ items = [] }) {
+    if (!Array.isArray(items)) return 0;
+
+    return items.reduce(
+      (totalPrice, item) => utils.math.add(totalPrice, item.price),
+      0
+    );
+
+  };