@darkpos/pricing 1.0.3 → 1.0.6

package/.eslintrc

@@ -0,0 +1,22 @@
+{
+  "extends": ["airbnb-base", "prettier", "plugin:jest/recommended"],
+  "env": {
+    "node": true,
+    "jest/globals": true
+  },
+  "plugins": ["prettier", "jest"],
+  "rules": {
+    "no-debugger": 0,
+    "no-underscore-dangle": 0,
+    "no-console": 0,
+    "global-require": 0,
+    "prettier/prettier": ["error", {
+      "singleQuote": true,
+      "trailingComma": "es5",
+      "bracketSpacing": true,
+      "bracketSameLine": false,
+      "arrowParens": "avoid",
+      "parser": "flow"
+    }]
+  }
+}

package/README.md

@@ -1,3 +1,5 @@
+# @dark/pricing
+
 ## Dark Pricing
 
 > TODO: calculation of defined schemas
@@ -5,9 +7,113 @@
 ### Usage
 
 ```
-const pricing = require('dark-pricing');
-const { modifier, item, order } = pricing;
+const usePricing = require('@darkpos/pricing');
+
+const options = {
+    ...localization,
+};
+
+const pricingService = usePricing(options);
+
+//
+const newOrder = pricingService.order.calculate(oldOrder);
+```
+
+Sample of a calculated Item:
+
+```
+const item = {
+    name: 'shirt',
+    price: 2,
+    modifiers: [
+    {
+        action: 'add',
+        type: 'fixed',
+        amount: 1
+        attributes: [hidden]
+        category: 'fee',
+        properties: {
+            sort: 1,
+            included: true,
+        },
+        computed: {
+            amount: 1
+        }
+    }                            ----> subTotal: 3
+    {
+        action: 'add',
+        type: 'percentage',
+        amount: 20
+        category: 'tax',
+        properties: {
+            direct: false,
+            sort: 2,
+            included: true
+        }
+        computed: {
+         amount: 0.60
+        }
+    }                          
+    {
+        action: 'add',
+        type: 'percentage',
+        amount: 30
+        category: 'tax',
+        properties: {
+            direct: false,
+            sort: 2,
+            included: true
+        }
+        computed: {
+         amount: 0.90
+        }
+    }
+                                 ----> subTotal: 4.50
+    {
+        action: 'subtract',
+        type: 'fixed',
+        amount: 1
+        category: 'discount'
+        properties: {
+            direct: false,
+            sort: 3,
+            included: false
+        }
+        computed: {
+         amount: -1
+        }
+    }],
+    subTotals: {
+        tax: (included: false)                                ---> 0.60
+        discount: (included: false)                           --->-1.00
+        fee:                                                ---> 0.00 
+        _included: (included: true)                         ---> 1
+        _xincluded                                          ---> -0.40
+        _direct: sum(modifiers with direct: true)           ---> 1.60 *
+        _xdirect: (direct: false)                           ---> -1
+        _simple: price * quantity                           ---> 2.00 *
+        _actual: _simple  + _included                       ---> 3.00
+    }
+    total: _actual + _xincluded                             ---> 2.60
+}
 
-const order = {};
-order.calculateOrder(order);
+const order = {
+    items: [item],
+    modifiers: [{
+        action: 'subtract',
+        type: 'fixed',
+        amount: 1
+        attributes: [hidden]
+        group: 'discount'
+    }],
+    subTotal: sum of _actuals                   ---> 3.00
+    ---
+    subTotals: {
+        tax: sum of subTotals.tax                ---> 0.60
+        fee: sum of subTotals.fee                ---> 0.00
+        discount: sum of subTotals.discount      --->-1.00
+    }
+    ---
+    total: sum of above                          ---> 2.60
+}
 ```

package/__TEST__/item.test.js

@@ -0,0 +1,285 @@
+const usePricing = require('../index');
+
+const pricingService = usePricing();
+
+describe('Item actions', () => {
+  test('Get calculated Item: included: false && direct: false', () => {
+    const modifiers = [
+      {
+        compute: {
+          amount: 20,
+          type: 'percentage',
+          action: 'add',
+        },
+        name: 'modifier1',
+        type: 'discount',
+        direct: false,
+        included: false,
+      },
+      {
+        compute: {
+          amount: 20,
+          type: 'percentage',
+          action: 'subtract',
+        },
+        name: 'modifier2',
+        type: 'discount',
+        direct: false,
+        included: false,
+      },
+      {
+        compute: {
+          amount: 2,
+          type: 'fixed',
+          action: 'subtract',
+        },
+        name: 'modifier3',
+        type: 'discount',
+        direct: false,
+        included: false,
+      },
+    ];
+    const orderItem = { price: 30, quantity: 2, modifiers };
+    const newItem = pricingService.item.calculate(orderItem);
+    expect(newItem).toHaveProperty('total', 56);
+    expect(newItem).toHaveProperty('subTotals', {
+      discount: -4,
+      _included: 0,
+      _xincluded: -4,
+      _direct: 0,
+      _xdirect: -4,
+      _simple: 60,
+      _actual: 60,
+    });
+  });
+  test('Get calculated Item: included: false && direct: true', () => {
+    const modifiers = [
+      {
+        compute: { amount: 2, type: 'fixed', action: 'subtract' },
+        type: 'discount',
+        name: 'modifier1',
+        direct: true,
+        included: false,
+      },
+      {
+        compute: {
+          amount: 20,
+          type: 'percentage',
+          action: 'subtract',
+        },
+        name: 'modifier2',
+        type: 'discount',
+        direct: true,
+        included: false,
+      },
+      {
+        compute: {
+          amount: 2,
+          type: 'fixed',
+          action: 'add',
+        },
+        name: 'modifier3',
+        type: 'tax',
+        direct: true,
+        included: false,
+      },
+    ];
+    const orderItem = { price: 30, quantity: 2, modifiers };
+    const newItem = pricingService.item.calculate(orderItem);
+    expect(newItem).toHaveProperty('total', 48);
+    expect(newItem).toHaveProperty('subTotals', {
+      discount: -16,
+      tax: 4,
+      _included: 0,
+      _xincluded: -12,
+      _direct: -12,
+      _xdirect: 0,
+      _simple: 60,
+      _actual: 60,
+    });
+  });
+  test('Get calculated Item: included: true && direct: true', () => {
+    const modifiers = [
+      {
+        compute: {
+          amount: 2,
+          type: 'fixed',
+          action: 'subtract',
+        },
+        name: 'modifier1',
+        type: 'discount',
+        direct: true,
+        included: true,
+      },
+      {
+        compute: {
+          amount: 20,
+          type: 'percentage',
+          action: 'subtract',
+        },
+        name: 'modifier2',
+        type: 'discount',
+        direct: true,
+        included: true,
+      },
+      {
+        compute: {
+          amount: 2,
+          type: 'fixed',
+          action: 'add',
+        },
+        name: 'modifier3',
+        type: 'upcharge',
+        direct: true,
+        included: true,
+      },
+    ];
+    const orderItem = { price: 30, quantity: 2, modifiers };
+    const newItem = pricingService.item.calculate(orderItem);
+    expect(newItem).toHaveProperty('total', 48);
+    expect(newItem).toHaveProperty('subTotals', {
+      _included: -12,
+      _xincluded: 0,
+      _direct: -12,
+      _xdirect: 0,
+      _simple: 60,
+      _actual: 48,
+    });
+  });
+  test('Get calculated Item: included: true, sample 1', () => {
+    const modifiers = [
+      {
+        compute: {
+          amount: 2,
+          type: 'fixed',
+          action: 'add',
+        },
+        name: 'modifier1',
+        type: 'upcharge',
+        included: true,
+        direct: true,
+      },
+    ];
+    const orderItem = { price: 2, quantity: 1, modifiers };
+    const newItem = pricingService.item.calculate(orderItem);
+    expect(newItem).toHaveProperty('total', 4);
+    expect(newItem).toHaveProperty('subTotals', {
+      _included: 2,
+      _xincluded: 0,
+      _direct: 2,
+      _xdirect: 0,
+      _simple: 2,
+      _actual: 4,
+    });
+  });
+  test('Get calculated Item: included: true, sample 2', () => {
+    const modifiers = [
+      {
+        compute: { amount: 2, type: 'fixed', action: 'add' },
+        name: 'modifier1',
+        type: 'upcharge',
+        included: true,
+        direct: true,
+        properties: {
+          sort: 1,
+        },
+      },
+      {
+        compute: {
+          amount: 10,
+          type: 'percentage',
+          action: 'add',
+        },
+        name: 'modifier2',
+        type: 'tax',
+        properties: {
+          sort: 2,
+        },
+        included: true,
+        direct: true,
+      },
+    ];
+    const orderItem = { price: 2, quantity: 1, modifiers };
+    const newItem = pricingService.item.calculate(orderItem);
+    expect(newItem).toHaveProperty('total', 4.4);
+    expect(newItem).toHaveProperty('subTotals', {
+      _included: 2.4,
+      _xincluded: 0,
+      _direct: 2.4,
+      _xdirect: 0,
+      _simple: 2,
+      _actual: 4.4,
+    });
+  });
+  test('Get calculated Item: included: true, sample 3', () => {
+    const modifiers = [
+      {
+        compute: {
+          amount: 2,
+          type: 'fixed',
+          action: 'subtract',
+        },
+        name: 'modifier1',
+        type: 'discount',
+        properties: {
+          sort: 1,
+        },
+        included: true,
+        direct: true,
+      },
+      {
+        compute: {
+          amount: 2,
+          type: 'fixed',
+          action: 'add',
+        },
+        name: 'modifier1',
+        type: 'upcharge',
+        included: true,
+        direct: true,
+        properties: {
+          sort: 1,
+        },
+      },
+      {
+        compute: {
+          amount: 10,
+          type: 'percentage',
+          action: 'add',
+        },
+        name: 'modifier2',
+        type: 'tax',
+        properties: {
+          sort: 2,
+        },
+        included: true,
+        direct: true,
+      },
+      {
+        compute: {
+          amount: 6,
+          type: 'percentage',
+          action: 'add',
+        },
+        name: 'modifier3',
+        type: 'tax',
+        properties: {
+          sort: 2,
+        },
+        included: true,
+        direct: true,
+      },
+    ];
+    const orderItem = { price: 2, quantity: 1, modifiers };
+    const newItem = pricingService.item.calculate(orderItem);
+    expect(newItem).toHaveProperty('total', 2.32);
+    expect(newItem).toHaveProperty('subTotals', {
+      _xdirect: 0,
+      _simple: 2,
+      _actual: 2.32,
+      _direct: 0.32,
+      _included: 0.32,
+      _xincluded: 0,
+    });
+  });
+});

package/__TEST__/order.test.js

@@ -0,0 +1,234 @@
+const usePricing = require('../index');
+
+const pricingService = usePricing();
+
+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,
+    });
+    console.log('order =>', JSON.stringify(newOrder, 0, 2));
+  });
+});

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./lib');

package/lib/constants/index.js

@@ -0,0 +1,5 @@
+const status = require('./status');
+
+module.exports = {
+  status,
+};

package/lib/constants/status.js

@@ -0,0 +1,39 @@
+const Order = Object.freeze({
+  OPEN: 'open',
+  HOLD: 'hold',
+  VOID: 'void',
+  CLOSED: 'close',
+});
+
+const Invoice = Object.freeze({
+  PARTIAL: 'partial',
+  PENDING: 'pending',
+  CLOSED: 'close',
+});
+
+const Kitchen = Object.freeze({
+  OPEN: 'open',
+  CLOSED: 'closed',
+});
+
+const Delivery = Object.freeze({
+  NONE: 'none',
+  BOOKED: 'booked',
+  PICKED: 'picked',
+  DELIVER: 'deliver',
+  DELIVERED: 'delivered',
+  DELIVERED_PARTIAL: 'delivered.partial',
+  RETURNED: 'returned',
+  RETURNED_PARTIAL: 'returned.partial',
+  HELD_NOT_READY: 'held.not.ready',
+  HELD_FOR_RELEASE_APPROVAL: 'held.for.release.approval',
+  CANCELLED: 'cancelled',
+  LOST: 'lost',
+});
+
+module.exports = Object.freeze({
+  Order,
+  Invoice,
+  Kitchen,
+  Delivery,
+});