@darkpos/pricing 1.0.4 → 1.0.7

package/__TEST__/modifier.test.js

@@ -1,126 +0,0 @@
-const modifierActions = require('../lib/modifier/actions');
-
-describe('Modifier actions', () => {
-  test('calculate with fix amount and add action', () => {
-    const modifier = {
-      type: 'fixed',
-      action: 'add',
-      amount: 10,
-      name: 'someModifier',
-    };
-    const orderItem = { price: 30, quantity: 1 };
-    const prices = modifierActions.pricing(modifier, orderItem);
-    expect(prices && prices.subTotal).toBe(0);
-    expect(prices && prices.discount).toBe(0);
-    expect(prices && prices.fee).toBe(10);
-    expect(prices && prices.tip).toBe(0);
-    expect(prices && prices.tax).toBe(0);
-    expect(prices && prices.distributed).toBe(0);
-  });
-
-  test('calculate with fix amount and subtract action', () => {
-    const modifier = {
-      type: 'fixed',
-      action: 'subtract',
-      amount: 10,
-      name: 'someModifier',
-    };
-    const orderItem = { price: 30, quantity: 1 };
-    const prices = modifierActions.pricing(modifier, orderItem);
-    expect(prices && prices.subTotal).toBe(0);
-    expect(prices && prices.discount).toBe(0);
-    expect(prices && prices.fee).toBe(-10);
-    expect(prices && prices.tip).toBe(0);
-    expect(prices && prices.tax).toBe(0);
-    expect(prices && prices.distributed).toBe(0);
-  });
-
-  test('calculate with percentage amount and subtract action', () => {
-    const modifier = {
-      amount: 20,
-      type: 'percentage',
-      action: 'subtract',
-    };
-    const orderItem = { price: 30, quantity: 1 };
-    const prices =  modifierActions.pricing(modifier, orderItem);
-    expect(prices && prices.subTotal).toBe(0);
-    expect(prices && prices.discount).toBe(0);
-    expect(prices && prices.fee).toBe(-6);
-    expect(prices && prices.tip).toBe(0);
-    expect(prices && prices.tax).toBe(0);
-    expect(prices && prices.distributed).toBe(0);
-  });
-
-  test('calculate with percentage amount and add action', () => {
-    const modifier = { amount: 20, type: 'percentage', action: 'add' };
-    const orderItem = { price: 30, quantity: 1 };
-    const prices =  modifierActions.pricing(modifier, orderItem);
-    expect(prices && prices.subTotal).toBe(0);
-    expect(prices && prices.discount).toBe(0);
-    expect(prices && prices.fee).toBe(6);
-    expect(prices && prices.tip).toBe(0);
-    expect(prices && prices.tax).toBe(0);
-    expect(prices && prices.distributed).toBe(0);
-  });
-
-  test('calculate with fix amount and override action', () => {
-    const modifier = { amount: 10, type: 'fixed', action: 'override' };
-    const orderItem = { price: 30, quantity: 1 };
-    const prices =  modifierActions.pricing(modifier, orderItem);
-    expect(prices && prices.subTotal).toBe(10);
-    expect(prices && prices.discount).toBe(0);
-    expect(prices && prices.fee).toBe(0);
-    expect(prices && prices.tip).toBe(0);
-    expect(prices && prices.tax).toBe(0);
-    expect(prices && prices.distributed).toBe(0);
-  });
-
-  test('calculate with fix amount, subtract action and discount attribute', () => {
-    const modifier = { amount: 10, type: 'fixed', action: 'subtract', attributes: ['discount'] };
-    const orderItem = { price: 30, quantity: 1 };
-    const prices =  modifierActions.pricing(modifier, orderItem);
-    expect(prices && prices.subTotal).toBe(0);
-    expect(prices && prices.discount).toBe(-10);
-    expect(prices && prices.fee).toBe(0);
-    expect(prices && prices.tip).toBe(0);
-    expect(prices && prices.tax).toBe(0);
-    expect(prices && prices.distributed).toBe(0);
-  });
-
-  test('calculate many', () => {
-    const modifiers = [
-      { amount: 20, type: 'percentage', action: 'add' },
-      { amount: 20, type: 'percentage', action: 'subtract' },
-      { amount: 2, type: 'fixed', action: 'subtract' },
-    ];
-    const orderItem = { price: 30, quantity: 2 };
-    const prices =  modifierActions.pricingModifiers(modifiers, orderItem);
-    expect(prices).toMatchObject({
-      subTotal: 0,
-      tax: 0,
-      fee: -4,
-      tip: 0,
-      discount: 0,
-      distributed: 0,
-      total: -4,
-    });
-  });
-
-  test('calculate many discount modifier', () => {
-    const modifiers = [
-      { amount: 20, type: 'percentage', action: 'add', attributes: ['discount'] },
-      { amount: 20, type: 'percentage', action: 'subtract', attributes: ['discount'] },
-      { amount: 2, type: 'fixed', action: 'subtract', attributes: ['discount'] },
-    ];
-    const orderItem = { price: 30, quantity: 2 };
-    const prices = modifierActions.pricingModifiers(modifiers, orderItem);
-    expect(prices).toMatchObject({
-      tax: 0,
-      fee: 0,
-      tip: 0,
-      discount: -4,
-      distributed: 0,
-      total: -4,
-    });
-  });
-});

package/lib/item/actions.js

@@ -1,140 +0,0 @@
-const modifierConstants = require('../modifier/constants');
-const modifierActions = require('../modifier/actions');
-const { math, defaultPrices } = require('../utils');
-
-/**
- * Remove order modifiers from items
- */
-const _removeOrderModifiers = items =>
-  items.map(item => ({
-    ...item,
-    modifiers: (item.modifiers || []).filter(
-      modifier => !modifierActions._hasAttribute(modifier, modifierConstants.attributes.distributed)
-    ),
-  }));
-
-/**
- * Get items with order modifier
- */
-const _getOrderModifiers = (items = []) =>
-  items
-    .reduce((modifiers, item) => [...modifiers, ...(item.modifiers || [])], [])
-    .filter(modifier =>
-      !modifierActions._hasAttribute(modifier, modifierConstants.attributes.distributed)
-    )
-    .filter(modifier =>
-      modifierActions._hasAttribute(modifier, modifierConstants.attributes.order)
-    );
-
-/**
- * Get Total prices of items
- */
-const _itemsPricing = (items = []) =>
-  items.reduce(
-    (prices, item) => ({
-      tax: math.add(prices.tax, item.tax),
-      subTotal: math.add(prices.subTotal, item.subTotal),
-      discount: math.add(prices.discount, item.discount),
-      distributed: math.add(prices.distributed, item.distributed),
-      total: math.add(prices.total, item.total),
-      fee: math.add(prices.fee, item.fee),
-    }),
-    defaultPrices
-  );
-
-/**
- * add order modifier to items
- */
-const _addOrderModifier = (order, items, modifier) => {
-  const itemsModifiers = {};
-  if (!(modifierActions._hasAttribute(modifier, modifierConstants.attributes.discount) ||
-      modifierActions._hasAttribute(modifier, modifierConstants.attributes.promotion))
-  )
-    return itemsModifiers;
-  // get distributed price in order level
-  const modifierPrices = modifierActions.pricing(modifier, {
-    price: order.total,
-    quantity: 1,
-  });
-  const orderModifierTotal = math.abs(modifierPrices.discount);
-
-  const totalDistributed = items.reduce((acc, item) => {
-    const distributedMod = modifierActions._createDistributedModifier(order, item, modifier);
-    itemsModifiers[item._id] = distributedMod;
-    return math.add(acc, math.mul(distributedMod.amount, item.quantity));
-  }, 0);
-
-  // 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);
-
-    const distributedMod = itemsModifiers[selectedItem._id];
-    itemsModifiers[selectedItem._id] = {
-      ...distributedMod,
-      amount: math.add(distributedMod.amount, math.div(difference, selectedItem.quantity)),
-    };
-  }
-
-  return itemsModifiers;
-};
-
-/**
- * Get prices of an item
- */
-const pricing = item => {
-  const { modifiers = [] } = item;
-  const price = parseFloat(item.price);
-  const quantity = parseInt(item.quantity, 10);
-  const subTotal = math.mul(price, quantity);
-
-  if (modifiers.length) {
-    const modifiersPrices = modifierActions.pricingModifiers(modifiers, {
-      price,
-      quantity,
-    });
-    const total = math.add(subTotal, modifiersPrices.total);
-    return { ...modifiersPrices, price, total, subTotal };
-  }
-
-  return { ...defaultPrices, price, total: subTotal, subTotal };
-};
-
-/**
- * Get a calculated item
- */
-const calculateItem = item => {
-  const descriptions = [];
-  const modifiers = (item.modifiers || []).map(each => {
-    const description = modifierActions._getDescription(each);
-    if(!modifierActions._hasAttribute(each, modifierConstants.attributes.distributed))
-      descriptions.push(description);
-    return { ...each, description };
-  });
-  //
-  const prices = pricing(item);
-
-  return {
-    ...item,
-    modifiers,
-    ...prices,
-    description: descriptions.join(', '),
-  };
-};
-
-/**
- * Get calculated items
- */
-const calculateItems = (items = []) => items.map(item => calculateItem(item));
-
-//
-module.exports = {
-  calculateItem,
-  calculateItems,
-  pricing,
-  _getOrderModifiers,
-  _removeOrderModifiers,
-  _addOrderModifier,
-  _itemsPricing,
-};

package/lib/modifier/actions.js

@@ -1,172 +0,0 @@
-const { math, applyQuantity, defaultPrices, objId } = require('../utils');
-const constants = require('./constants');
-
-/**
- * If Modifier has an attribute
- */
-const _hasAttribute = (modifier = {}, attribute) => {
-  if (!Array.isArray(modifier.attributes)) return false;
-  const { attributes = [] } = modifier;
-  return attributes.includes(attribute);
-};
-
-//
-const _getNonOrderOverrideModifiers = (modifiers = []) =>
-  modifiers.filter(
-    modifier =>
-      !_hasAttribute(modifier, constants.attributes.order) && modifier.action !== 'override'
-  );
-
-//
-const _getTotalOverrideModifier = (modifiers = []) =>
-  modifiers.find(modifier => _hasAttribute(modifier, constants.attributes.modifierTotalOverride));
-
-//
-const _getDistributedModifiers = (modifiers = []) =>
-  modifiers.filter(modifier => _hasAttribute(modifier, constants.attributes.distributed));
-
-/**
- * create a distrubuted Modifier based on Order and Item
- */
-const _createDistributedModifier = (order, item, modifier) => {
-  let { attributes } = modifier;
-
-  // if (!attributes.includes(constants.attributes.distributed))
-  //   attributes = [...(modifier.attributes || []), constants.attributes.distributed];
-
-  let modifierAmount = 0;
-
-  if (modifier.type === 'percentage')
-    modifierAmount = math.div(math.mul(order.total, modifier.amount), 100);
-  else ({ amount: modifierAmount } = modifier);
-
-  const amountToApply = math.div(math.mul(modifierAmount, item.total), order.total, item.quantity);
-  return {
-    _id: objId(),
-    ...modifier,
-    type: 'fixed',
-    attributes:  [constants.attributes.distributed], //attributes.filter(a => a !== constants.attributes.order),
-    amount: amountToApply,
-  };
-};
-
-/**
- * Get Description of a modifier based on its fields
- */
-const descriptionType = {
-  'fixed': (amount, symbol) => [symbol, math.toFixed(amount)].filter(Boolean).join(''),
-  'percentage': (amount, symbol) => [symbol, amount, '%'].filter(Boolean).join('')
-};
-const _getDescription = (modifier = {}) => {
-  const { name, amount, properties = {}, action, type } = modifier;
-  if (
-    _hasAttribute(modifier, constants.attributes.list) &&
-    properties.selectedValue &&
-    Array.isArray(properties.selectedValue)
-  )
-    return properties.selectedValue.join(', ');
-
-  const symbol = constants.symbols[action];
-  const amountStr = math.gt(amount, 0)
-    ? `(${descriptionType[type](amount, symbol)})`
-    : null;
-  const description = [name, amountStr].filter(Boolean).join('');
-
-  return description;
-};
-
-/**
- * Get pricing of modifier
- */
-const pricing = (modifier = {}, options = { price: 0, quantity: 1 }) => {
-  const isType = type => modifier.type === type;
-  const isAction = action => modifier.action === action;
-
-  let actionValue = 1;
-  let amount = 0;
-  const prices = { ...defaultPrices };
-  const minItems = (modifier.properties || {}).minItems || 0;
-  const isOverrideModifier = isAction('override');
-
-  if (isAction('add')) actionValue = 1;
-  else if (isAction('subtract')) actionValue = -1;
-  else if (isOverrideModifier) actionValue = 1;
-
-  if (isType('fixed')) amount = parseFloat(modifier.amount);
-  else if (isType('percentage')) amount = math.div(math.mul(options.price, modifier.amount), 100);
-
-  const value = math.mul(actionValue, amount);
-  if (isOverrideModifier) prices.subTotal = value;
-  // TODO: promotion needs to be fixed
-  else if (
-    (_hasAttribute(modifier, constants.attributes.discount) ||
-      _hasAttribute(modifier, constants.attributes.promotion)) &&
-    ((minItems > 0 && options.quantity && options.quantity >= minItems) || minItems <= 0)
-  )
-    prices.discount = value;
-  else if (_hasAttribute(modifier, constants.attributes.tax)) prices.tax = value;
-  else if (_hasAttribute(modifier, constants.attributes.gratuity)) prices.tip = value;
-
-  //  TODO: upcharges needs to be added to fee 
-  else if (
-    _hasAttribute(modifier, constants.attributes.paymentMethods) ||
-    _hasAttribute(modifier, constants.attributes.paymentTypes) ||
-    !modifier.attributes || !modifier.attributes.length // for Upcharge
-  )
-    prices.fee = value;
-
-  //
-  else prices.subTotal = value;
-
-  if (_hasAttribute(modifier, constants.attributes.distributed))
-    prices.distributed = math.add(prices.discount, prices.tax, prices.subTotal);
-
-  return applyQuantity(prices, options.quantity);
-};
-
-/**
- * Get pricing of modifirs in item
- */
-const pricingModifiers = (modifiers, options = { price: 0, quantity: 1 }) => {
-  const modifierDPrices = { ...defaultPrices };
-  if (!modifiers.length) return modifierDPrices;
-
-  // get modifiers in order level and without override action
-  const itemModifiers = _getNonOrderOverrideModifiers(modifiers);
-  // get distributed modifiers
-  const distributedModifiers = _getDistributedModifiers(itemModifiers);
-  // find one override modifier
-  const totalOverrideModifier = _getTotalOverrideModifier(modifiers);
-
-  if (totalOverrideModifier) {
-    modifierDPrices.subTotal = totalOverrideModifier.amount;
-    modifierDPrices.total = totalOverrideModifier.amount;
-  }
-  const modifiersToCalculate = totalOverrideModifier ? distributedModifiers : itemModifiers;
-
-  const prices = modifiersToCalculate.reduce((acc, modifier) => {
-    const modifierPrices = pricing(modifier, options);
-    const subTotal = math.add(acc.subTotal, modifierPrices.subTotal);
-    const tax = math.add(acc.tax, modifierPrices.tax);
-    const fee = math.add(acc.fee, modifierPrices.fee);
-    const tip = math.add(acc.tip, modifierPrices.tip);
-    const discount = math.add(acc.discount, modifierPrices.discount);
-    const distributed = math.add(acc.distributed, modifierPrices.distributed);
-    return { subTotal, tax, fee, tip, discount, distributed };
-  }, modifierDPrices);
-
-  prices.total = math.add(prices.subTotal, prices.tax, prices.fee, prices.tip, prices.discount);
-  return prices;
-};
-
-//
-module.exports = {
-  pricing,
-  pricingModifiers,
-  _getDescription,
-  _hasAttribute,
-  _getDistributedModifiers,
-  _getNonOrderOverrideModifiers,
-  _getTotalOverrideModifier,
-  _createDistributedModifier,
-};

package/lib/modifier/constants.js

@@ -1,46 +0,0 @@
-const primaryAttributes = {
-  promotion: 'promotion',
-  discount: 'discount',
-  tax: 'tax',
-  paymentMethods: 'paymentMethods',
-  paymentTypes: 'paymentTypes',
-  group: 'group',
-  list: 'list',
-  priceOverride: 'priceOverride',
-  quantityOverride: 'quantityOverride',
-  department: 'department',
-  starch: 'starch',
-};
-
-const secondAttributes = {
-  hidden: 'hidden',
-  required: 'required',
-  default: 'default',
-  order: 'order',
-  relatedItems: 'relatedItems',
-  recommended: 'recommended',
-  category: 'category',
-  multiple: 'multiple',
-  bind: 'bind',
-  customerTagsExtend: 'customerTagsExtend',
-  removeModifiers: 'removeModifiers',
-};
-
-const attributes = {
-  ...primaryAttributes,
-  ...secondAttributes,
-  gratuity: 'gratuity',
-  subscription: 'subscription',
-  distributed: 'distributed',
-  modifierTotalOverride: 'modifierTotalOverride',
-};
-
-const symbols = {
-  add: '+',
-  subtract: '-',
-};
-
-module.exports = {
-  attributes,
-  symbols,
-};

package/lib/order/actions.js

@@ -1,47 +0,0 @@
-const { uniqBy, cloneDeep } = require('lodash');
-const itemActions = require('../item/actions');
-const modifierActions = require('../modifier/actions');
-
-/**
- * return calculated Order
- */
-const calculateOrder = order => {
-  const { items = [] } = order;
-  if (!items.length) return order;
-
-  // WNDM: with not distributed modifiers
-  let itemsWNDM = [];
-  let newOrder = null;
-  let prices = {};
-
-  const orderItemsModifiers = itemActions._getOrderModifiers(items);
-  const concatModifiers = [...(order.modifiers || []), ...orderItemsModifiers];
-  const modifiers = uniqBy(concatModifiers, '_id');
-  // if there is no order level modifiers, we have to remove them from items
-  itemsWNDM = itemActions._removeOrderModifiers(items);
-  itemsWNDM = itemActions.calculateItems(itemsWNDM);
-  prices = itemActions._itemsPricing(itemsWNDM);
-  newOrder = { ...order, ...prices, items: itemsWNDM };
-
-  if (!modifiers.length) return newOrder;
-
-  const newItems = itemsWNDM || items;
-  let itemsWDM = cloneDeep(newItems);
-  modifiers.forEach(mod => {
-    const itemsModifiers = itemActions._addOrderModifier(newOrder, newItems, mod);
-    // adding the modifiers to items
-    itemsWDM = itemsWDM.map(item => ({
-      ...item,
-      modifiers: [...(item.modifiers || []), itemsModifiers[item._id]].filter(Boolean),
-    }));
-  });
-
-  const calculatedItemWDM = itemActions.calculateItems(itemsWDM);
-  prices = itemActions._itemsPricing(calculatedItemWDM);
-  return { ...order, ...prices, items: calculatedItemWDM };
-};
-
-//
-module.exports = {
-  calculateOrder,
-};

package/lib/utils/defaultPrices.js

@@ -1,10 +0,0 @@
-module.exports = {
-  subTotal: 0,
-  total: 0,
-  tax: 0,
-  discount: 0,
-  fee: 0,
-  tip: 0,
-  distributed: 0,
-  totalPaid: 0,
-};

package/lib/utils/helpers.js

@@ -1,26 +0,0 @@
-const ObjectID = require('bson-objectid');
-const math = require('./math');
-const defaultPrices = require('./defaultPrices');
-
-const objId = () => ObjectID();
-
-const applyQuantity = (prices = defaultPrices, quantity = 1) =>
-  Object.keys(prices).reduce(
-    (obj, key) => ({
-      ...obj,
-      [key]: math.mul(prices[key], quantity),
-    }),
-    prices
-  );
-
-const filterExports = funcs => {
-  const names = Object.keys(funcs).filter(name => !name.includes('_'));
-  return names.reduce((newFuncs, name) => ({ ...newFuncs, [name]: funcs[name] }), {});
-};
-
-//
-module.exports = {
-  objId,
-  applyQuantity,
-  filterExports,
-};

package/lib/utils/index.js

@@ -1,9 +0,0 @@
-const helpers = require('./helpers');
-const math = require('./math');
-const defaultPrices = require('./defaultPrices');
-
-module.exports = {
-  ...helpers,
-  math,
-  defaultPrices,
-};

package/lib/utils/math.js

@@ -1,71 +0,0 @@
-const Decimal = require('decimal.js');
-
-//
-const add = (...args) => {
-  if (!args || !Array.isArray(args) || !args.length) throw new Error('Invalid argument');
-
-  const sum = args.reduce((acc, current) => acc.add(Decimal(current)), Decimal(0));
-
-  // console.log('add =>', args, ' : ', sum);
-  return Decimal(sum.toFixed(2, 1)).toNumber();
-};
-
-//
-const sub = (...args) => {
-  if (!args || !Array.isArray(args) || !args.length) throw new Error('Invalid argument');
-
-  const numbers = [...args];
-  const first = numbers.shift();
-  const sum = numbers.reduce((acc, current) => acc.sub(Decimal(current)), Decimal(first));
-
-  // console.log('sub =>', args, ' : ', sum);
-  return Decimal(sum.toFixed(2, 1)).toNumber();
-};
-
-//
-const mul = (...args) => {
-  if (!args || !Array.isArray(args) || !args.length) throw new Error('Invalid argument');
-
-  const sum = args.reduce((acc, current) => acc.mul(Decimal(current)), Decimal(1));
-
-  // console.log('mul =>', args, ' : ', sum);
-  return Decimal(sum.toFixed(2, 1)).toNumber();
-};
-
-//
-const div = (...args) => {
-  if (!args || !Array.isArray(args) || !args.length) throw new Error('Invalid argument');
-
-  const numbers = [...args];
-  const first = numbers.shift();
-  const sum = numbers.reduce((acc, current) => acc.div(Decimal(current)), Decimal(first));
-
-  // console.log('div =>', args, ' : ', sum);
-  return Decimal(sum.toFixed(2, 1)).toNumber();
-};
-
-//
-const lte = (x, y) => Decimal(x).lte(Decimal(y));
-
-//
-const gt = (x, y) => Decimal(x).gt(Decimal(y));
-
-//
-const abs = x =>
-  Decimal(x)
-    .abs()
-    .toNumber();
-
-//
-const toFixed = x => Decimal(x).toFixed(2, 1);
-
-module.exports = {
-  mul,
-  div,
-  add,
-  sub,
-  abs,
-  lte,
-  gt,
-  toFixed,
-};