@darkpos/pricing 1.0.5 → 1.0.6

package/.eslintrc

@@ -7,18 +7,16 @@
   "plugins": ["prettier", "jest"],
   "rules": {
     "no-debugger": 0,
-    "import/no-extraneous-dependencies": 0,
     "no-underscore-dangle": 0,
-    "import/no-dynamic-require": 0,
     "no-console": 0,
     "global-require": 0,
-    "prettier/prettier": [
-      "error",
-      {
-        "trailingComma": "es5",
-        "singleQuote": true,
-        "printWidth": 100
-      }
-    ]
+    "prettier/prettier": ["error", {
+      "singleQuote": true,
+      "trailingComma": "es5",
+      "bracketSpacing": true,
+      "bracketSameLine": false,
+      "arrowParens": "avoid",
+      "parser": "flow"
+    }]
   }
 }

package/__TEST__/item.test.js

@@ -6,25 +6,37 @@ describe('Item actions', () => {
   test('Get calculated Item: included: false && direct: false', () => {
     const modifiers = [
       {
-        amount: 20,
-        type: 'percentage',
-        action: 'add',
+        compute: {
+          amount: 20,
+          type: 'percentage',
+          action: 'add',
+        },
         name: 'modifier1',
-        category: 'discount',
+        type: 'discount',
+        direct: false,
+        included: false,
       },
       {
-        amount: 20,
-        type: 'percentage',
-        action: 'subtract',
+        compute: {
+          amount: 20,
+          type: 'percentage',
+          action: 'subtract',
+        },
         name: 'modifier2',
-        category: 'discount',
+        type: 'discount',
+        direct: false,
+        included: false,
       },
       {
-        amount: 2,
-        type: 'fixed',
-        action: 'subtract',
+        compute: {
+          amount: 2,
+          type: 'fixed',
+          action: 'subtract',
+        },
         name: 'modifier3',
-        category: 'discount',
+        type: 'discount',
+        direct: false,
+        included: false,
       },
     ];
     const orderItem = { price: 30, quantity: 2, modifiers };
@@ -34,8 +46,8 @@ describe('Item actions', () => {
       discount: -4,
       _included: 0,
       _xincluded: -4,
-      _direct: -4,
-      _xdirect: 0,
+      _direct: 0,
+      _xdirect: -4,
       _simple: 60,
       _actual: 60,
     });
@@ -43,28 +55,33 @@ describe('Item actions', () => {
   test('Get calculated Item: included: false && direct: true', () => {
     const modifiers = [
       {
-        amount: 2,
-        type: 'fixed',
-        action: 'subtract',
-        properties: {
-          direct: false,
-        },
-        category: 'discount',
+        compute: { amount: 2, type: 'fixed', action: 'subtract' },
+        type: 'discount',
         name: 'modifier1',
+        direct: true,
+        included: false,
       },
       {
-        amount: 20,
-        type: 'percentage',
-        action: 'subtract',
+        compute: {
+          amount: 20,
+          type: 'percentage',
+          action: 'subtract',
+        },
         name: 'modifier2',
-        category: 'discount',
+        type: 'discount',
+        direct: true,
+        included: false,
       },
       {
-        amount: 2,
-        type: 'fixed',
-        action: 'add',
+        compute: {
+          amount: 2,
+          type: 'fixed',
+          action: 'add',
+        },
         name: 'modifier3',
-        category: 'tax',
+        type: 'tax',
+        direct: true,
+        included: false,
       },
     ];
     const orderItem = { price: 30, quantity: 2, modifiers };
@@ -75,8 +92,8 @@ describe('Item actions', () => {
       tax: 4,
       _included: 0,
       _xincluded: -12,
-      _direct: -8,
-      _xdirect: -4,
+      _direct: -12,
+      _xdirect: 0,
       _simple: 60,
       _actual: 60,
     });
@@ -84,57 +101,63 @@ describe('Item actions', () => {
   test('Get calculated Item: included: true && direct: true', () => {
     const modifiers = [
       {
-        amount: 2,
-        type: 'fixed',
-        action: 'subtract',
-        name: 'modifier1',
-        category: 'discount',
-        properties: {
-          direct: false,
+        compute: {
+          amount: 2,
+          type: 'fixed',
+          action: 'subtract',
         },
+        name: 'modifier1',
+        type: 'discount',
+        direct: true,
+        included: true,
       },
       {
-        amount: 20,
-        type: 'percentage',
-        action: 'subtract',
+        compute: {
+          amount: 20,
+          type: 'percentage',
+          action: 'subtract',
+        },
         name: 'modifier2',
-        category: 'discount',
+        type: 'discount',
+        direct: true,
+        included: true,
       },
       {
-        amount: 2,
-        type: 'fixed',
-        action: 'add',
-        name: 'modifier3',
-        category: 'upcharge',
-        properties: {
-          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', {
-      discount: -16,
-      _included: 4,
-      _xincluded: -16,
-      _direct: -8,
-      _xdirect: -4,
+      _included: -12,
+      _xincluded: 0,
+      _direct: -12,
+      _xdirect: 0,
       _simple: 60,
-      _actual: 64,
+      _actual: 48,
     });
   });
   test('Get calculated Item: included: true, sample 1', () => {
     const modifiers = [
       {
-        amount: 2,
-        type: 'fixed',
-        action: 'add',
-        name: 'modifier1',
-        category: 'upcharge',
-        properties: {
-          included: true,
+        compute: {
+          amount: 2,
+          type: 'fixed',
+          action: 'add',
         },
+        name: 'modifier1',
+        type: 'upcharge',
+        included: true,
+        direct: true,
       },
     ];
     const orderItem = { price: 2, quantity: 1, modifiers };
@@ -152,96 +175,111 @@ describe('Item actions', () => {
   test('Get calculated Item: included: true, sample 2', () => {
     const modifiers = [
       {
-        amount: 2,
-        type: 'fixed',
-        action: 'add',
+        compute: { amount: 2, type: 'fixed', action: 'add' },
         name: 'modifier1',
-        category: 'upcharge',
+        type: 'upcharge',
+        included: true,
+        direct: true,
         properties: {
-          included: true,
           sort: 1,
         },
       },
       {
-        amount: 10,
-        type: 'percentage',
-        action: 'add',
+        compute: {
+          amount: 10,
+          type: 'percentage',
+          action: 'add',
+        },
         name: 'modifier2',
-        category: 'tax',
+        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,
-      _xincluded: 0.4,
+      _included: 2.4,
+      _xincluded: 0,
       _direct: 2.4,
       _xdirect: 0,
       _simple: 2,
-      _actual: 4,
-      tax: 0.4,
+      _actual: 4.4,
     });
   });
   test('Get calculated Item: included: true, sample 3', () => {
     const modifiers = [
       {
-        amount: 2,
-        type: 'fixed',
-        action: 'subtract',
+        compute: {
+          amount: 2,
+          type: 'fixed',
+          action: 'subtract',
+        },
         name: 'modifier1',
-        category: 'discount',
+        type: 'discount',
         properties: {
           sort: 1,
         },
+        included: true,
+        direct: true,
       },
       {
-        amount: 2,
-        type: 'fixed',
-        action: 'add',
+        compute: {
+          amount: 2,
+          type: 'fixed',
+          action: 'add',
+        },
         name: 'modifier1',
-        category: 'upcharge',
+        type: 'upcharge',
+        included: true,
+        direct: true,
         properties: {
-          included: true,
           sort: 1,
         },
       },
       {
-        amount: 10,
-        type: 'percentage',
-        action: 'add',
+        compute: {
+          amount: 10,
+          type: 'percentage',
+          action: 'add',
+        },
         name: 'modifier2',
-        category: 'tax',
+        type: 'tax',
         properties: {
           sort: 2,
         },
+        included: true,
+        direct: true,
       },
       {
-        amount: 6,
-        type: 'percentage',
-        action: 'add',
+        compute: {
+          amount: 6,
+          type: 'percentage',
+          action: 'add',
+        },
         name: 'modifier3',
-        category: 'tax',
+        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.64);
+    expect(newItem).toHaveProperty('total', 2.32);
     expect(newItem).toHaveProperty('subTotals', {
-      _included: 2,
-      _xincluded: -1.36,
-      _direct: 0.64,
       _xdirect: 0,
       _simple: 2,
-      _actual: 4,
-      tax: 0.64,
-      discount: -2,
+      _actual: 2.32,
+      _direct: 0.32,
+      _included: 0.32,
+      _xincluded: 0,
     });
   });
 });

package/__TEST__/order.test.js

@@ -6,25 +6,27 @@ describe('Order actions', () => {
   test('Get calculated Order, one item', () => {
     const modifiers = [
       {
-        amount: 20,
-        type: 'percentage',
-        action: 'add',
+        compute: {
+          amount: 20,
+          type: 'percentage',
+          action: 'add',
+        },
         name: 'modifier1',
-        category: 'discount',
+        type: 'discount',
       },
       {
-        amount: 20,
-        type: 'percentage',
-        action: 'subtract',
+        compute: {
+          amount: 20,
+          type: 'percentage',
+          action: 'subtract',
+        },
         name: 'modifier2',
-        category: 'discount',
+        type: 'discount',
       },
       {
-        amount: 2,
-        type: 'fixed',
-        action: 'subtract',
+        compute: { amount: 2, type: 'fixed', action: 'subtract' },
         name: 'modifier3',
-        category: 'discount',
+        type: 'discount',
       },
     ];
     const orderItem = { price: 30, quantity: 2, modifiers };
@@ -44,11 +46,13 @@ describe('Order actions', () => {
       quantity: 2,
       modifiers: [
         {
-          amount: 2,
-          type: 'fixed',
-          action: 'subtract',
+          compute: {
+            amount: 2,
+            type: 'fixed',
+            action: 'subtract',
+          },
           name: 'modifier1',
-          category: 'discount',
+          type: 'discount',
         },
       ],
     };
@@ -58,11 +62,13 @@ describe('Order actions', () => {
       quantity: 1,
       modifiers: [
         {
-          amount: 2,
-          type: 'fixed',
-          action: 'subtract',
+          compute: {
+            amount: 2,
+            type: 'fixed',
+            action: 'subtract',
+          },
           name: 'modifier1',
-          category: 'discount',
+          type: 'discount',
         },
       ],
     };
@@ -87,11 +93,13 @@ describe('Order actions', () => {
       quantity: 1,
     };
     const modifier1 = {
-      amount: 2,
-      type: 'fixed',
-      action: 'subtract',
+      compute: {
+        amount: 2,
+        type: 'fixed',
+        action: 'subtract',
+      },
       name: 'modifier1',
-      category: 'discount',
+      type: 'discount',
     };
 
     const order = { items: [item1, item2], modifiers: [modifier1] };
@@ -135,11 +143,13 @@ describe('Order actions', () => {
       quantity: 1,
     };
     const modifier1 = {
-      amount: 10,
-      action: 'subtract',
-      type: 'percentage',
+      compute: {
+        amount: 10,
+        action: 'subtract',
+        type: 'percentage',
+      },
       name: 'modifier1',
-      category: 'discount',
+      type: 'discount',
     };
 
     const order = { items: [item1, item2], modifiers: [modifier1] };
@@ -188,20 +198,24 @@ describe('Order actions', () => {
     };
     const modifier1 = {
       _id: 1,
+      compute: {
+        amount: 10,
+        type: 'percentage',
+        action: 'subtract',
+      },
       name: `10% Discount`,
-      amount: 10,
-      type: 'percentage',
-      action: 'subtract',
-      category: 'discount',
+      type: 'discount',
     };
 
     const modifier2 = {
       _id: 2,
       name: `20% tax`,
-      amount: 20,
-      type: 'percentage',
-      action: 'add',
-      category: 'tax',
+      type: 'tax',
+      compute: {
+        amount: 20,
+        type: 'percentage',
+        action: 'add',
+      },
     };
 
     const order = {

package/index.js

@@ -1,25 +1 @@
-const useModifierService = require('@darkpos/modifier');
-const utils = require('@darkpos/utils');
-const _ = require('lodash');
-/** services  */
-const makeItemService = require('./lib/item');
-const makeOrderService = require('./lib/order');
-
-module.exports = (deps = {}) => {
-  //
-  const modifierService = useModifierService(deps);
-
-  const itemService = makeItemService({ ...deps, _, utils, modifierService });
-  const orderService = makeOrderService({
-    ...deps,
-    _,
-    utils,
-    modifierService,
-    itemService,
-  });
-
-  return Object.freeze({
-    item: itemService,
-    order: orderService,
-  });
-};
+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,
+});

package/lib/index.js

@@ -0,0 +1,36 @@
+const makeModifierService = require('@darkpos/modifier');
+const utils = require('@darkpos/utils');
+const _ = require('lodash');
+const moment = require('moment-timezone');
+/** services  */
+const makeItemActions = require('./item');
+const makeOrderActions = require('./order');
+
+module.exports = session => {
+  const { useLocalization } = utils;
+  const settings = _.get(session, 'store._settings', {});
+  const localization = useLocalization(settings.localization);
+
+  const deps = {
+    settings,
+    utils,
+    localization,
+    _,
+    moment,
+  };
+
+  //
+  const modifierActions = makeModifierService(session);
+  const itemActions = makeItemActions({ ...deps, modifierActions });
+  const orderActions = makeOrderActions({
+    ...deps,
+    itemActions,
+    modifierActions,
+  });
+
+  return {
+    item: itemActions,
+    order: orderActions,
+    modifier: modifierActions,
+  };
+};