@darkpos/pricing 1.0.5 → 1.0.8

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__/modifier/calculate.test.js

@@ -0,0 +1,73 @@
+const usePricing = require('../../index');
+
+const pricingService = usePricing();
+
+describe('Calculate Function', () => {
+  test('calculate with fix amount and add action', () => {
+    const modifier = {
+      compute: {
+        type: 'fixed',
+        action: 'add',
+        amount: 10,
+      },
+      name: 'someModifier',
+    };
+    const orderItem = { price: 30, quantity: 1 };
+    const computedModifier = pricingService.modifier.calculate(modifier, orderItem);
+    expect(computedModifier._computed).toMatchObject({
+      amount: 10,
+      description: 'someModifier ($10.00)',
+    });
+  });
+
+  test('calculate with fix amount and subtract action', () => {
+    const modifier = {
+      compute: {
+        type: 'fixed',
+        action: 'subtract',
+        amount: 10,
+      },
+      name: 'someModifier',
+    };
+    const orderItem = { price: 30, quantity: 1 };
+    const computedModifier = pricingService.modifier.calculate(modifier, orderItem);
+    expect(computedModifier._computed).toMatchObject({
+      amount: -10,
+      description: 'someModifier (-$10.00)',
+    });
+  });
+
+  test('calculate with percentage amount and subtract action', () => {
+    const modifier = {
+      compute: {
+        amount: 20,
+        type: 'percentage',
+        action: 'subtract',
+      },
+      name: 'someModifier',
+    };
+    const orderItem = { price: 30, quantity: 1 };
+    const computedModifier = pricingService.modifier.calculate(modifier, orderItem);
+    expect(computedModifier._computed).toMatchObject({
+      amount: -6,
+      description: 'someModifier (-$6.00)',
+    });
+  });
+
+  test('calculate with percentage amount and add action', () => {
+    const modifier = {
+      compute: {
+        amount: 20,
+        type: 'percentage',
+        action: 'add',
+      },
+      name: 'someModifier',
+    };
+    const orderItem = { price: 30, quantity: 1 };
+    const computedModifier = pricingService.modifier.calculate(modifier, orderItem);
+    expect(computedModifier._computed).toMatchObject({
+      amount: 6,
+      description: 'someModifier ($6.00)',
+    });
+  });
+});

package/__TEST__/modifier/getAvailablePromotionsOrSubscriptions.test.js

@@ -0,0 +1,81 @@
+const usePricing = require('../../index');
+
+const pricingService = usePricing();
+
+describe('GetAvailablePromotionsOrSubscriptions Function', () => {
+  test('usecases', () => {
+    const today = new Date();
+    expect(
+      pricingService.modifier.getAvailablePromotionsOrSubscriptions()
+    ).toStrictEqual([]);
+
+    const modifier = { attributes: ['promotion'] };
+    expect(
+      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
+    ).toStrictEqual([modifier]);
+
+    modifier.properties = {
+      promotion: { numberOfUsesLimit: 4, numberOfUses: 3 },
+    };
+    expect(
+      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
+    ).toStrictEqual([modifier]);
+
+    modifier.properties.promotion.numberOfUses = 4;
+    expect(
+      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
+    ).toStrictEqual([]);
+
+    modifier.properties.promotion.numberOfUses = 5;
+    expect(
+      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
+    ).toStrictEqual([]);
+
+    modifier.properties = {
+      promotion: { dateLimit: { from: today.toISOString(), to: '' } },
+    };
+    expect(
+      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
+    ).toStrictEqual([modifier]);
+
+    const tomorrow = new Date(today);
+    tomorrow.setDate(tomorrow.getDate() + 1);
+    modifier.properties.promotion.dateLimit.from = tomorrow.toISOString();
+    expect(
+      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
+    ).toStrictEqual([]);
+
+    const yesterday = new Date(today);
+    yesterday.setDate(yesterday.getDate() - 1);
+    modifier.properties.promotion.dateLimit.from = yesterday.toISOString();
+    expect(
+      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
+    ).toStrictEqual([modifier]);
+
+    modifier.properties.promotion.dateLimit.to = yesterday.toISOString();
+    expect(
+      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
+    ).toStrictEqual([]);
+
+    modifier.properties.promotion.dateLimit.to = today.toISOString();
+    expect(
+      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
+    ).toStrictEqual([modifier]);
+
+    modifier.properties.promotion.dateLimit.to = tomorrow.toISOString();
+    expect(
+      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
+    ).toStrictEqual([modifier]);
+
+    modifier.attributes = ['subscription'];
+    modifier.properties.subscription = modifier.properties.promotion;
+    expect(
+      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
+    ).toStrictEqual([modifier]);
+
+    delete modifier.properties;
+    expect(
+      pricingService.modifier.getAvailablePromotionsOrSubscriptions([modifier])
+    ).toStrictEqual([]);
+  });
+});

package/__TEST__/modifier/getMatchTagsModifiers.test.js

@@ -0,0 +1,109 @@
+const usePricing = require('../../index');
+
+const pricingService = usePricing();
+
+describe('GetMatchTagsModifiers Function', () => {
+  test('usecases', () => {
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers: [] })
+    ).toHaveLength(0);
+    const customer = {};
+    let modifiers = [];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(0);
+    customer.tags = [];
+    modifiers = [{ tags: [] }];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(1);
+    customer.tags = ['all'];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(1);
+    modifiers = [{ tags: ['test'] }];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(0);
+    modifiers = [{ tags: ['all'] }, { tags: ['test'] }];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(1);
+    modifiers = [{ tags: ['all'] }, { tags: ['test'] }, { tags: [] }];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(2);
+    customer.tags = ['test'];
+    modifiers = [{ tags: [] }];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(0);
+    modifiers = [{ tags: ['test'] }];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(1);
+    modifiers = [{ tags: ['all'] }, { tags: ['test'] }];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(1);
+    modifiers = [{ tags: ['all'] }, { tags: ['test'] }, { tags: [] }];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(1);
+    modifiers = [
+      { tags: ['all'] },
+      { tags: ['test'] },
+      { tags: [] },
+      { tags: ['Test'] },
+    ];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(1);
+    modifiers = [
+      { tags: ['all'] },
+      { tags: ['test'] },
+      { tags: [] },
+      { tags: ['Test'] },
+      { tags: ['test', 'Test'] },
+    ];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(2);
+    modifiers = [{ tags: ['all'] }];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(0);
+    modifiers = [{ tags: ['all'] }, { tags: ['test'] }];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(1);
+    modifiers = [
+      { tags: ['all'] },
+      { tags: ['test'] },
+      { tags: ['test'], attributes: ['hidden'] },
+      {},
+    ];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(2);
+    customer.tags = ['all'];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(2);
+    modifiers = [
+      { tags: ['all'] },
+      { tags: ['test'] },
+      { tags: ['all'], attributes: ['hidden'] },
+      { tags: ['all'], attributes: ['default'] },
+      { tags: ['all'], attributes: ['required'] },
+      {},
+    ];
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(5);
+    customer.tags = undefined;
+    expect(
+      pricingService.modifier.getMatchTagsModifiers({ modifiers, entity: customer })
+    ).toHaveLength(5);
+  });
+});

package/__TEST__/modifier/getModifierIndex.test.js

@@ -0,0 +1,40 @@
+const usePricing = require('../../index');
+
+const pricingService = usePricing();
+
+describe('GetModifierIndex Function', () => {
+  test('usecases', () => {
+    expect(
+      pricingService.modifier.getModifierIndex({
+        entity: undefined,
+        modifier: undefined,
+      })
+    ).toBe(-1);
+    const order = { modifiers: [{ modifierId: '123' }] };
+    expect(
+      pricingService.modifier.getModifierIndex({ entity: order, modifier: undefined })
+    ).toBe(-1);
+    const modifier = { _id: '123' };
+    expect(
+      pricingService.modifier.getModifierIndex({
+        entity: order,
+        modifier,
+      })
+    ).toBe(0);
+    modifier._id = '234';
+    expect(
+      pricingService.modifier.getModifierIndex({
+        entity: order,
+        modifier,
+      })
+    ).toBe(-1);
+    order.modifiers = [{ modifierId: '123' }, { modifierId: '234' }];
+    expect(pricingService.modifier.getModifierIndex({ entity: order, modifier })).toBe(
+      1
+    );
+    modifier._id = '123';
+    expect(pricingService.modifier.getModifierIndex({ entity: order, modifier })).toBe(
+      0
+    );
+  });
+});