@evershop/evershop 1.1.0 → 1.2.0

package/src/modules/promotion/services/registerDefaultCalculators.js

@@ -2,13 +2,16 @@
 const { select } = require('@evershop/postgres-query-builder');
 const { pool } = require('@evershop/evershop/src/lib/postgres/connection');
 const { getConfig } = require('@evershop/evershop/src/lib/util/getConfig');
-const { getCartTotalBeforeDiscount } = require('./getCartTotalBeforeDiscount');
 const { toPrice } = require('../../checkout/services/toPrice');
 
 module.exports.registerDefaultCalculators =
   function registerDefaultCalculators() {
     return [
       async function percentageDiscountToEntireOrderCalculator(cart, coupon) {
+        const priceIncludingTax = getConfig(
+          'pricing.tax.price_including_tax',
+          false
+        );
         if (coupon.discount_type !== 'percentage_discount_to_entire_order') {
           return false;
         }
@@ -17,8 +20,11 @@ module.exports.registerDefaultCalculators =
           return false;
         }
 
+        const cartSubTotal = priceIncludingTax
+          ? cart.getData('sub_total_incl_tax')
+          : cart.getData('sub_total');
         const cartDiscountAmount = toPrice(
-          (discountPercent * getCartTotalBeforeDiscount(cart)) / 100
+          (discountPercent * cartSubTotal) / 100
         );
         let distributedAmount = 0;
         const discounts = {};
@@ -27,7 +33,7 @@ module.exports.registerDefaultCalculators =
           let sharedDiscount = 0;
           if (index === items.length - 1) {
             const precision = getConfig('pricing.precision', '2');
-            const precisionFix = parseInt(`1${'0'.repeat(precision)}`, 10);
+            const precisionFix = 10**precision;
             sharedDiscount =
               (cartDiscountAmount * precisionFix -
                 distributedAmount * precisionFix) /
@@ -35,10 +41,11 @@ module.exports.registerDefaultCalculators =
             // Fix for rounding error
             sharedDiscount = parseFloat(sharedDiscount.toFixed(precision));
           } else {
-            const rowTotal = item.getData('final_price') * item.getData('qty');
+            const lineTotal = priceIncludingTax
+              ? item.getData('line_total_incl_tax')
+              : item.getData('line_total');
             sharedDiscount = toPrice(
-              (rowTotal * cartDiscountAmount) /
-                getCartTotalBeforeDiscount(cart),
+              (lineTotal * cartDiscountAmount) / cartSubTotal,
               0
             );
           }
@@ -50,7 +57,6 @@ module.exports.registerDefaultCalculators =
           }
           distributedAmount += sharedDiscount;
         });
-
         await Promise.all(
           items.map(async (item) => {
             await item.setData('discount_amount', discounts[item.getId()] || 0);
@@ -60,6 +66,10 @@ module.exports.registerDefaultCalculators =
         return true;
       },
       async function fixedDiscountToEntireOrderCalculator(cart, coupon) {
+        const priceIncludingTax = getConfig(
+          'pricing.tax.price_including_tax',
+          false
+        );
         if (coupon.discount_type !== 'fixed_discount_to_entire_order')
           return false;
 
@@ -69,9 +79,11 @@ module.exports.registerDefaultCalculators =
         if (cartDiscountAmount < 0) {
           return false;
         }
-        const cartTotal = getCartTotalBeforeDiscount(cart);
+        const cartSubTotal = priceIncludingTax
+          ? cart.getData('sub_total_incl_tax')
+          : cart.getData('sub_total');
         cartDiscountAmount =
-          cartTotal > cartDiscountAmount ? cartDiscountAmount : cartTotal;
+          cartSubTotal > cartDiscountAmount ? cartDiscountAmount : cartSubTotal;
         let distributedAmount = 0;
         const discounts = {};
         const items = cart.getItems();
@@ -87,10 +99,11 @@ module.exports.registerDefaultCalculators =
             // Fix for rounding error
             sharedDiscount = parseFloat(sharedDiscount.toFixed(precision));
           } else {
-            const rowTotal = item.getData('final_price') * item.getData('qty');
+            const lineTotal = priceIncludingTax
+              ? item.getData('line_total_incl_tax')
+              : item.getData('line_total');
             sharedDiscount = toPrice(
-              (rowTotal * cartDiscountAmount) /
-                getCartTotalBeforeDiscount(cart),
+              (lineTotal * cartDiscountAmount) / cartSubTotal,
               0
             );
           }
@@ -110,6 +123,10 @@ module.exports.registerDefaultCalculators =
         return true;
       },
       async function discountToSpecificProductsCalculator(cart, coupon) {
+        const priceIncludingTax = getConfig(
+          'pricing.tax.price_including_tax',
+          false
+        );
         if (
           ![
             'fixed_discount_to_specific_products',
@@ -261,18 +278,21 @@ module.exports.registerDefaultCalculators =
             return;
           }
           if (coupon.discount_type === 'fixed_discount_to_specific_products') {
-            if (discountAmount > item.getData('final_price')) {
-              discountAmount = item.getData('final_price');
-            }
+            discountAmount = Math.min(
+              discountAmount,
+              priceIncludingTax
+                ? item.getData('final_price_incl_tax')
+                : item.getData('final_price')
+            );
             discounts[item.getId()] =
-              maxQty > item.getData('qty')
-                ? toPrice(discountAmount * item.getData('qty'))
-                : toPrice(discountAmount * maxQty);
+              Math.min(item.getData('qty'), maxQty) * discountAmount;
           } else {
             const discountPercent = Math.min(discountAmount, 100);
             discounts[item.getId()] = toPrice(
               (Math.min(item.getData('qty'), maxQty) *
-                (item.getData('final_price') * discountPercent)) /
+                (priceIncludingTax
+                  ? item.getData('final_price_incl_tax')
+                  : item.getData('final_price') * discountPercent)) /
                 100
             );
           }
@@ -286,6 +306,10 @@ module.exports.registerDefaultCalculators =
         return true;
       },
       async function buyXGetYCalculator(cart, coupon) {
+        const priceIncludingTax = getConfig(
+          'pricing.tax.price_including_tax',
+          false
+        );
         if (coupon.discount_type !== 'buy_x_get_y') {
           return true;
         }
@@ -311,7 +335,11 @@ module.exports.registerDefaultCalculators =
               item.getData('qty') >= buyQty + getQty
             ) {
               const discountPerUnit = toPrice(
-                (discount * item.getData('final_price')) / 100
+                (discount *
+                  (priceIncludingTax
+                    ? item.getData('final_price_incl_tax')
+                    : item.getData('final_price'))) /
+                  100
               );
               const discountAbleUnits =
                 Math.floor(item.getData('qty') / buyQty) * getQty;

package/src/modules/promotion/services/registerDefaultValidators.js

@@ -2,7 +2,7 @@
 const { select } = require('@evershop/postgres-query-builder');
 const { DateTime } = require('luxon');
 const { pool } = require('@evershop/evershop/src/lib/postgres/connection');
-const { getCartTotalBeforeDiscount } = require('./getCartTotalBeforeDiscount');
+const { getConfig } = require('@evershop/evershop/src/lib/util/getConfig');
 
 module.exports.registerDefaultValidators =
   function registerDefaultValidators() {
@@ -76,6 +76,10 @@ module.exports.registerDefaultValidators =
         return true;
       },
       function subTotalValidator(cart, coupon) {
+        const priceIncludingTax = getConfig(
+          'pricing.tax.price_including_tax',
+          false
+        );
         const conditions = coupon.condition;
         const minimumSubTotal = !Number.isNaN(
           parseFloat(conditions.order_total)
@@ -83,8 +87,9 @@ module.exports.registerDefaultValidators =
           ? parseFloat(conditions.order_total)
           : null;
         if (
-          minimumSubTotal &&
-          parseFloat(getCartTotalBeforeDiscount(cart)) < minimumSubTotal
+          minimumSubTotal && priceIncludingTax
+            ? cart.getData('sub_total_incl_tax')
+            : cart.getData('sub_total') < minimumSubTotal
         ) {
           return false;
         }
@@ -280,6 +285,10 @@ module.exports.registerDefaultValidators =
         return flag;
       },
       async function requiredProductByPriceValidator(cart, coupon) {
+        const priceIncludingTax = getConfig(
+          'pricing.tax.price_including_tax',
+          false
+        );
         let flag = true;
         const items = cart.getItems();
         const conditions = coupon.condition;
@@ -306,8 +315,11 @@ module.exports.registerDefaultValidators =
               operator = '===';
             }
             items.forEach((item) => {
+              const price = priceIncludingTax
+                ? item.getData('final_price_incl_tax')
+                : item.getData('final_price');
               // eslint-disable-next-line no-eval
-              if (eval(`${item.getData('final_price')} ${operator} ${value}`)) {
+              if (eval(`${price} ${operator} ${value}`)) {
                 qty += item.getData('qty');
               }
             });

package/src/modules/setting/pages/admin/paymentSetting/PaymentSetting.jsx

@@ -8,7 +8,7 @@ import SettingMenu from '@components/admin/setting/SettingMenu';
 export default function PaymentSetting({ saveSettingApi }) {
   return (
     <div className="main-content-inner">
-      <div className="grid grid-cols-6 gap-x-2 grid-flow-row ">
+      <div className="grid grid-cols-6 gap-x-8 grid-flow-row ">
         <div className="col-span-2">
           <SettingMenu />
         </div>
@@ -25,7 +25,7 @@ export default function PaymentSetting({ saveSettingApi }) {
               }
             }}
           >
-            <Area id="paymentSetting" className="grid gap-2" />
+            <Area id="paymentSetting" className="grid gap-8" />
           </Form>
         </div>
       </div>

package/src/modules/setting/pages/admin/storeSetting/StoreSetting.jsx

@@ -6,6 +6,7 @@ import { Field } from '@components/common/form/Field';
 import { Form } from '@components/common/form/Form';
 import { Card } from '@components/admin/cms/Card';
 import SettingMenu from '@components/admin/setting/SettingMenu';
+import Area from '@components/common/Area';
 
 const ProvincesQuery = `
   query Province($countries: [String]) {
@@ -182,6 +183,46 @@ Currency.defaultProps = {
   fieldName: 'storeCurrency'
 };
 
+function StorePhoneNumber({ storePhoneNumber }) {
+  return <div>
+    <Field
+      name="storePhoneNumber"
+      label="Store Phone Number"
+      placeholder="Store Phone Number"
+      value={storePhoneNumber}
+      type="text"
+    />
+  </div>
+}
+
+StorePhoneNumber.propTypes = {
+  storePhoneNumber: PropTypes.string
+};
+
+StorePhoneNumber.defaultProps = {
+  storePhoneNumber: ''
+};
+
+function StoreEmail({ storeEmail }) {
+  return <div>
+    <Field
+      name="storeEmail"
+      label="Store Email"
+      placeholder="Store Email"
+      value={storeEmail}
+      type="text"
+    />
+  </div>
+}
+
+StoreEmail.propTypes = {
+  storeEmail: PropTypes.string
+};
+
+StoreEmail.defaultProps = {
+  storeEmail: ''
+};
+
 export default function StoreSetting({
   saveSettingApi,
   setting: {
@@ -207,7 +248,7 @@ export default function StoreSetting({
 
   return (
     <div className="main-content-inner">
-      <div className="grid grid-cols-6 gap-x-2 grid-flow-row ">
+      <div className="grid grid-cols-6 gap-x-8 grid-flow-row ">
         <div className="col-span-2">
           <SettingMenu />
         </div>
@@ -226,42 +267,64 @@ export default function StoreSetting({
           >
             <Card>
               <Card.Session title="Store Information">
-                <Field
-                  name="storeName"
-                  label="Store Name"
-                  placeholder="Store Name"
-                  value={storeName}
-                  type="text"
-                />
-                <Field
-                  name="storeDescription"
-                  label="Store Description"
-                  placeholder="Store Description"
-                  value={storeDescription}
-                  type="textarea"
+                <Area
+                  id="storeInfoSetting"
+                  coreComponents={[
+                    {
+                      component: {
+                        default: Field
+                      },
+                      props: {
+                        name: 'storeName',
+                        label: 'Store Name',
+                        placeholder: 'Store Name',
+                        value: storeName,
+                        type: 'text'
+                      },
+                      sortOrder: 10
+                    },
+                    {
+                      component: {
+                        default: Field
+                      },
+                      props: {
+                        name: 'storeDescription',
+                        label: 'Store Description',
+                        placeholder: 'Store Description',
+                        value: storeDescription,
+                        type: 'textarea'
+                      },
+                      sortOrder: 20
+                    }
+                  ]}
+                  noOuter
                 />
               </Card.Session>
               <Card.Session title="Contact Information">
-                <div className="grid grid-cols-2 gap-2 mt-2">
-                  <div>
-                    <Field
-                      name="storePhoneNumber"
-                      label="Store Phone Number"
-                      value={storePhoneNumber}
-                      placeholder="Store Phone Number"
-                      type="text"
-                    />
-                  </div>
-                  <div>
-                    <Field
-                      name="storeEmail"
-                      label="Store Email"
-                      value={storeEmail}
-                      placeholder="Store Email"
-                      type="text"
-                    />
-                  </div>
-                </div>
+                <Area
+                  id="storeContactSetting"
+                  coreComponents={[
+                    {
+                      component: {
+                        default: StorePhoneNumber
+                      },
+                      props: {
+                        storePhoneNumber
+                      },
+                      sortOrder: 10
+                    },
+                    {
+                      component: {
+                        default: StoreEmail
+                      },
+                      props: {
+                        storeEmail
+                      },
+                      sortOrder: 20
+                    }
+                  ]}
+                  className="grid grid-cols-2 gap-8 mt-8"
+                />
               </Card.Session>
               <Card.Session title="Address">
                 <Country
@@ -275,7 +338,7 @@ export default function StoreSetting({
                   placeholder="Store Address"
                   type="text"
                 />
-                <div className="grid grid-cols-3 gap-2 mt-2">
+                <div className="grid grid-cols-3 gap-8 mt-8">
                   <div>
                     <Field
                       name="storeCity"

package/src/modules/stripe/pages/admin/paymentSetting/StripePayment.jsx

@@ -16,7 +16,7 @@ export default function StripePayment({
   return (
     <Card title="Stripe Payment">
       <Card.Session>
-        <div className="grid grid-cols-3 gap-2">
+        <div className="grid grid-cols-3 gap-8">
           <div className="col-span-1 items-center flex">
             <h4>Enable?</h4>
           </div>
@@ -26,7 +26,7 @@ export default function StripePayment({
         </div>
       </Card.Session>
       <Card.Session>
-        <div className="grid grid-cols-3 gap-2">
+        <div className="grid grid-cols-3 gap-8">
           <div className="col-span-1 items-center flex">
             <h4>Dislay Name</h4>
           </div>
@@ -41,7 +41,7 @@ export default function StripePayment({
         </div>
       </Card.Session>
       <Card.Session>
-        <div className="grid grid-cols-3 gap-2">
+        <div className="grid grid-cols-3 gap-8">
           <div className="col-span-1 items-center flex">
             <h4>Publishable Key</h4>
           </div>
@@ -56,7 +56,7 @@ export default function StripePayment({
         </div>
       </Card.Session>
       <Card.Session>
-        <div className="grid grid-cols-3 gap-2">
+        <div className="grid grid-cols-3 gap-8">
           <div className="col-span-1 items-center flex">
             <h4>Secret Key</h4>
           </div>
@@ -71,7 +71,7 @@ export default function StripePayment({
         </div>
       </Card.Session>
       <Card.Session>
-        <div className="grid grid-cols-3 gap-2">
+        <div className="grid grid-cols-3 gap-8">
           <div className="col-span-1 items-center flex">
             <h4>Webhook Secret Key</h4>
           </div>

package/src/modules/stripe/pages/frontStore/checkout/Stripe.jsx

@@ -42,7 +42,7 @@ export default function StripeMethod({ setting }) {
 
   return (
     <div>
-      <div className="flex justify-start items-center gap-1">
+      <div className="flex justify-start items-center gap-4">
         {(!selectedPaymentMethod ||
           selectedPaymentMethod.code !== 'stripe') && (
           <a

package/src/modules/tax/bootstrap.js

@@ -1,22 +1,57 @@
 const config = require('config');
+const { merge } = require('@evershop/evershop/src/lib/util/merge');
 const { addProcessor } = require('../../lib/util/registry');
 const registerDefaultTaxClassCollectionFilters = require('./services/registerDefaultTaxClassCollectionFilters');
 const {
   defaultPaginationFilters
 } = require('../../lib/util/defaultPaginationFilters');
+const {
+  registerCartItemTaxPercentField
+} = require('./services/registerCartItemTaxPercentField');
 
 module.exports = () => {
-  // Pricing configuration
-  const pricingConfig = {
+  addProcessor('cartItemFields', registerCartItemTaxPercentField, 0);
+  addProcessor('configuratonSchema', (schema) => {
+    merge(schema, {
+      properties: {
+        pricing: {
+          type: 'object',
+          properties: {
+            tax: {
+              type: 'object',
+              properties: {
+                rounding: {
+                  type: 'string',
+                  enum: ['round', 'ceil', 'floor']
+                },
+                precision: {
+                  type: 'integer'
+                },
+                round_level: {
+                  type: 'string',
+                  enum: ['total', 'line', 'unit']
+                },
+                price_including_tax: {
+                  type: 'boolean'
+                }
+              }
+            }
+          }
+        }
+      }
+    });
+    return schema;
+  });
+  // Default tax configuration
+  const defaultTaxConfig = {
     tax: {
       rounding: 'round',
       precision: 2,
       round_level: 'total',
-      display_catalog_price_including_tax: true,
-      display_checkout_price_including_tax: true
+      price_including_tax: true
     }
   };
-  config.util.setModuleDefaults('pricing', pricingConfig);
+  config.util.setModuleDefaults('pricing', defaultTaxConfig);
   // Getting config value like this: config.get('pricing.tax.rounding');
 
   // Reigtering the default filters for tax class collection

package/src/modules/tax/graphql/types/Product/Price/ProductPrice.resolvers.js

@@ -1,48 +1,15 @@
-const {
-  getSetting
-} = require('@evershop/evershop/src/modules/setting/services/setting');
 const {
   toPrice
 } = require('@evershop/evershop/src/modules/checkout/services/toPrice');
-const { getConfig } = require('@evershop/evershop/src/lib/util/getConfig');
-const { getTaxRates } = require('../../../../services/getTaxRates');
-const { getTaxPercent } = require('../../../../services/getTaxPercent');
-const {
-  calculateTaxAmount
-} = require('../../../../services/calculateTaxAmount');
 
 module.exports = {
   Product: {
-    price: async (product, _, { user }) => {
-      const price = parseFloat(product.price);
-      const taxConfigDisplay = getConfig(
-        'pricing.tax.display_catalog_price_including_tax',
-        false
-      );
-      const taxClassId = product.taxClass;
-      if (!taxClassId || !taxConfigDisplay || user) {
-        return {
-          regular: price,
-          special: price // TODO: implement special price
-        };
-      } else {
-        const taxRates = await getTaxRates(
-          taxClassId,
-          await getSetting('storeCountry', null),
-          await getSetting('storeProvince', null),
-          await getSetting('storePostalCode', null)
-        );
-
-        // We display the price including tax based on the store address.
-        // TODO: This has to be changed to the customer address.
-        const percentage = getTaxPercent(taxRates);
-        const taxAmount = calculateTaxAmount(percentage, price, 1);
-        const includedTaxPrice = toPrice(price + taxAmount);
-        return {
-          regular: includedTaxPrice,
-          special: includedTaxPrice // TODO: implement special price
-        };
-      }
+    price: async (product) => {
+      const price = toPrice(product.price);
+      return {
+        regular: price,
+        special: price // TODO: implement special price
+      };
     }
   }
 };

package/src/modules/tax/graphql/types/TaxSetting/TaxSetting.graphql

@@ -1,4 +1,3 @@
 extend type Setting {
-  displayCatalogPriceIncludeTax: Boolean
-  displayCheckoutPriceIncludeTax: Boolean
+  priceIncludingTax: Boolean
 }

package/src/modules/tax/graphql/types/TaxSetting/TaxSetting.resolvers.js

@@ -2,13 +2,6 @@ const { getConfig } = require('@evershop/evershop/src/lib/util/getConfig');
 
 module.exports = {
   Setting: {
-    displayCatalogPriceIncludeTax: () => getConfig(
-        'pricing.tax.display_catalog_price_including_tax',
-        false
-      ),
-    displayCheckoutPriceIncludeTax: () => getConfig(
-        'pricing.tax.display_checkout_price_including_tax',
-        false
-      )
+    priceIncludingTax: () => getConfig('pricing.tax.price_including_tax', false)
   }
 };

package/src/modules/tax/pages/admin/taxSetting/TaxSetting.jsx

@@ -68,7 +68,7 @@ export default function TaxSetting({
   if (countriesQueryData.fetching || taxClassesQueryData.fetching) {
     return (
       <div className="main-content-inner">
-        <div className="grid grid-cols-6 gap-x-2 grid-flow-row ">
+        <div className="grid grid-cols-6 gap-x-8 grid-flow-row ">
           <div className="col-span-2">
             <SettingMenu />
           </div>
@@ -82,11 +82,11 @@ export default function TaxSetting({
 
   return (
     <div className="main-content-inner">
-      <div className="grid grid-cols-6 gap-x-2 grid-flow-row ">
+      <div className="grid grid-cols-6 gap-x-8 grid-flow-row ">
         <div className="col-span-2">
           <SettingMenu />
         </div>
-        <div className="col-span-4 grid grid-cols-1 gap-2">
+        <div className="col-span-4 grid grid-cols-1 gap-8">
           <Card>
             <Card.Session title="Tax">
               <div>
@@ -107,7 +107,7 @@ export default function TaxSetting({
                   }
                 }}
               >
-                <div className="grid grid-cols-2 gap-2">
+                <div className="grid grid-cols-2 gap-8">
                   <div>
                     <Field
                       type="select"

package/src/modules/tax/services/TaxClassCollection.js

@@ -17,16 +17,16 @@ class TaxClassCollection {
     );
 
     taxClassCollectionFilters.forEach((filter) => {
-      const check = filters.find((f) => f.key === filter.key);
-      if (check) {
-        if (filter.operation.includes(check.operation)) {
-          filter.callback(
-            this.baseQuery,
-            check.operation,
-            check.value,
-            currentFilters
-          );
-        }
+      const check = filters.find(
+        (f) => f.key === filter.key && filter.operation.includes(f.operation)
+      );
+      if (filter.key === '*' || check) {
+        filter.callback(
+          this.baseQuery,
+          check?.operation,
+          check?.value,
+          currentFilters
+        );
       }
     });