@evershop/evershop 1.1.0 → 1.2.1

package/src/modules/promotion/bootstrap.js

@@ -1,10 +1,15 @@
+const { select } = require('@evershop/postgres-query-builder');
+const { pool } = require('../../lib/postgres/connection');
 const {
   defaultPaginationFilters
 } = require('../../lib/util/defaultPaginationFilters');
 const { addProcessor } = require('../../lib/util/registry');
-const { toPrice } = require('../checkout/services/toPrice');
-const { validateCoupon } = require('./services/couponValidator');
-const { calculateDiscount } = require('./services/discountCalculator');
+const {
+  registerCartItemPromotionFields
+} = require('./services/registerCartItemPromotionFields');
+const {
+  registerCartPromotionFields
+} = require('./services/registerCartPromotionFields');
 const {
   registerDefaultCalculators
 } = require('./services/registerDefaultCalculators');
@@ -14,106 +19,19 @@ const {
 } = require('./services/registerDefaultValidators');
 
 module.exports = () => {
-  addProcessor('cartFields', (fields) =>
-    fields.concat(
-      /** Adding fields to the Cart object */
-      [
-        {
-          key: 'coupon',
-          resolvers: [
-            async function resolver(coupon) {
-              if (coupon) {
-                const check = await validateCoupon(this, coupon);
-                if (check === true) {
-                  return coupon;
-                } else {
-                  return null;
-                }
-              } else {
-                return null;
-              }
-            }
-          ],
-          dependencies: ['items'] // TODO: Add customer id and customer group id as a dependency
-        },
-        {
-          key: 'discount_amount',
-          resolvers: [
-            async function resolver() {
-              const coupon = this.getData('coupon');
-              const items = this.getItems();
-              if (!coupon) {
-                await Promise.all(
-                  items.map(async (item) => {
-                    item.setData('discount_amount', 0);
-                  })
-                );
-                return 0;
-              }
-              // Start calculate discount amount
-              await calculateDiscount(this, coupon);
-              let discountAmount = 0;
-              // eslint-disable-next-line no-restricted-syntax
-              for (const item of items) {
-                discountAmount += item.getData('discount_amount');
-              }
-              return discountAmount;
-            }
-          ],
-          dependencies: ['coupon']
-        },
-        {
-          key: 'grand_total',
-          resolvers: [
-            async function resolver(previousValue) {
-              return previousValue - this.getData('discount_amount');
-            }
-          ],
-          dependencies: ['discount_amount']
-        },
-        {
-          key: 'shipping_fee_excl_tax', // This is to make sure the shipping fee is calculated after the coupon validation
-          resolvers: [],
-          dependencies: ['coupon']
-        }
-      ]
-    )
-  );
-
   addProcessor(
-    'cartItemFields',
-    (fields) =>
-      fields.concat(
-        /** Adding fields to the Cart Item object */
-        [
-          {
-            key: 'discount_amount',
-            resolvers: [
-              async function resolver() {
-                const requestedField = this.getTriggeredField();
-                const requestedValue = this.getRequestedValue();
-                if (requestedField === 'discount_amount') {
-                  return toPrice(requestedValue);
-                } else {
-                  return 0;
-                }
-              }
-            ]
-          },
-          {
-            key: 'total',
-            resolvers: [
-              async function resolver(previousValue) {
-                return previousValue - this.getData('discount_amount');
-              }
-            ],
-            dependencies: ['discount_amount']
-          }
-        ]
-      ),
-    11
+    'couponLoaderFunction',
+    () => async (couponCode) => {
+        const coupon = await select()
+          .from('coupon')
+          .where('coupon', '=', couponCode)
+          .load(pool);
+        return coupon;
+      },
+    0
   );
-
+  addProcessor('cartFields', registerCartPromotionFields, 0);
+  addProcessor('cartItemFields', registerCartItemPromotionFields, 11);
   addProcessor('couponValidatorFunctions', registerDefaultValidators);
   addProcessor('discountCalculatorFunctions', registerDefaultCalculators);
 

package/src/modules/promotion/pages/admin/couponEdit+couponNew/DiscountType.jsx

@@ -51,7 +51,7 @@ export default function DiscountType({ coupon = {} }) {
           ]}
         />
       </div>
-      <div className="mt-1">
+      <div className="mt-4">
         <TargetProducts
           products={get(targetProducts, 'products', [])}
           maxQty={get(targetProducts, 'maxQty', '')}

package/src/modules/promotion/pages/admin/couponEdit+couponNew/FormContent.jsx

@@ -10,7 +10,7 @@ export default function FormContent({ gridUrl }) {
   const { state } = useFormContext();
   return (
     <>
-      <div className="grid grid-cols-1 gap-2">
+      <div className="grid grid-cols-1 gap-8">
         <Card title="General">
           <Card.Session>
             <Area id="couponEditGeneral" noOuter />
@@ -21,15 +21,15 @@ export default function FormContent({ gridUrl }) {
             <Area id="couponEditDiscountType" noOuter />
           </Card.Session>
         </Card>
-        <div className="grid grid-cols-3 gap-x-2 grid-flow-row ">
-          <div className="col-span-2 grid grid-cols-1 gap-2 auto-rows-max">
+        <div className="grid grid-cols-3 gap-x-8 grid-flow-row ">
+          <div className="col-span-2 grid grid-cols-1 gap-8 auto-rows-max">
             <Card title="Order conditions">
               <Card.Session>
                 <Area id="couponEditLeft" noOuter className="col-8" />
               </Card.Session>
             </Card>
           </div>
-          <div className="col-span-1 grid grid-cols-1 gap-2 auto-rows-max">
+          <div className="col-span-1 grid grid-cols-1 gap-8 auto-rows-max">
             <Card title="Customer conditions">
               <Card.Session>
                 <Area id="couponEditRight" className="col-4" noOuter />
@@ -38,7 +38,7 @@ export default function FormContent({ gridUrl }) {
           </div>
         </div>
       </div>
-      <div className="form-submit-button flex border-t border-divider mt-15 pt-15 justify-between">
+      <div className="form-submit-button flex border-t border-divider mt-6 pt-6 justify-between">
         <Button
           title="Cancel"
           variant="critical"

package/src/modules/promotion/pages/admin/couponGrid/Grid.jsx

@@ -123,7 +123,7 @@ function Actions({ coupons = [], selectedIds = [] }) {
       {selectedIds.length > 0 && (
         <td style={{ borderTop: 0 }} colSpan="100">
           <div className="inline-flex border border-divider rounded justify-items-start">
-            <a href="#" className="font-semibold pt-075 pb-075 pl-15 pr-15">
+            <a href="#" className="font-semibold pt-3 pb-3 pl-6 pr-6">
               {selectedIds.length} selected
             </a>
             {actions.map((action) => (
@@ -133,7 +133,7 @@ function Actions({ coupons = [], selectedIds = [] }) {
                   e.preventDefault();
                   action.onAction();
                 }}
-                className="font-semibold pt-075 pb-075 pl-15 pr-15 block border-l border-divider self-center"
+                className="font-semibold pt-3 pb-3 pl-6 pr-6 block border-l border-divider self-center"
               >
                 <span>{action.name}</span>
               </a>
@@ -173,7 +173,7 @@ export default function CouponGrid({
       <Card.Session
         title={
           <Form submitBtn={false}>
-            <div className="flex gap-2 justify-center items-center">
+            <div className="flex gap-8 justify-center items-center">
               <Area
                 id="couponGridFilter"
                 noOuter

package/src/modules/promotion/pages/frontStore/cart/Coupon.jsx

@@ -11,7 +11,7 @@ export default function CouponForm({ cart: { applyCouponApi } }) {
   const AppContextDispatch = useAppDispatch();
 
   return (
-    <div className="mt-4">
+    <div className="mt-16">
       <Form
         method="POST"
         isJSON
@@ -34,7 +34,7 @@ export default function CouponForm({ cart: { applyCouponApi } }) {
         id="couponForm"
       >
         <p style={{ fontWeight: 600 }}>{_('Promotion code?')}</p>
-        <div className="grid grid-cols-3 gap-2" style={{ width: '300px' }}>
+        <div className="grid grid-cols-3 gap-8" style={{ width: '300px' }}>
           <div className="col-span-2">
             <Field
               type="text"

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

@@ -17,16 +17,16 @@ class CouponCollection {
     );
 
     couponCollectionFilters.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
+        );
       }
     });
 

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

@@ -1,5 +1,4 @@
-const { select } = require('@evershop/postgres-query-builder');
-const { pool } = require('@evershop/evershop/src/lib/postgres/connection');
+const { info } = require('@evershop/evershop/src/lib/log/logger');
 const { getValueSync } = require('@evershop/evershop/src/lib/util/registry');
 
 /**
@@ -10,11 +9,9 @@ const { getValueSync } = require('@evershop/evershop/src/lib/util/registry');
  */
 async function validateCoupon(cart, couponCode) {
   const validatorFunctions = getValueSync('couponValidatorFunctions', []);
+  const couponLoader = getValueSync('couponLoaderFunction');
   let flag = true;
-  const coupon = await select()
-    .from('coupon')
-    .where('coupon', '=', couponCode)
-    .load(pool);
+  const coupon = await couponLoader(couponCode);
   if (!coupon) {
     return false;
   }
@@ -27,11 +24,11 @@ async function validateCoupon(cart, couponCode) {
           flag = false;
         }
       } catch (e) {
+        info(e);
         flag = false;
       }
     })
   );
-
   return flag;
 }
 

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

@@ -1,17 +1,12 @@
-const { pool } = require('@evershop/evershop/src/lib/postgres/connection');
 const { getValueSync } = require('@evershop/evershop/src/lib/util/registry');
-const { select } = require('@evershop/postgres-query-builder');
 
 exports.calculateDiscount = async function calculateDiscount(
   cart,
   couponCode = null
 ) {
   const calculatorFunctions = getValueSync('discountCalculatorFunctions', []);
-  const coupon = await select()
-    .from('coupon')
-    .where('coupon', '=', couponCode)
-    .load(pool);
-
+  const couponLoader = getValueSync('couponLoaderFunction');
+  const coupon = await couponLoader(couponCode);
   // Calling calculator functions
   for (let i = 0; i < calculatorFunctions.length; i += 1) {
     await calculatorFunctions[i](cart, coupon);

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

@@ -0,0 +1,80 @@
+const { getConfig } = require('@evershop/evershop/src/lib/util/getConfig');
+const { toPrice } = require('../../checkout/services/toPrice');
+
+module.exports = exports = {};
+module.exports.registerCartItemPromotionFields =
+  function registerCartItemPromotionFields(fields) {
+    const newFields = fields.concat(
+      /** Adding fields to the Cart Item object */
+      [
+        {
+          key: 'discount_amount',
+          resolvers: [
+            async function resolver() {
+              const requestedField = this.getTriggeredField();
+              const requestedValue = this.getRequestedValue();
+              if (requestedField === 'discount_amount') {
+                return toPrice(requestedValue);
+              } else {
+                return 0;
+              }
+            }
+          ]
+        },
+        {
+          key: 'line_total_with_discount',
+          resolvers: [
+            async function resolver() {
+              const priceIncludingTax = getConfig(
+                'pricing.tax.price_including_tax',
+                false
+              );
+              if (!priceIncludingTax) {
+                return (
+                  this.getData('line_total') - this.getData('discount_amount')
+                );
+              } else {
+                return (
+                  this.getData('line_total_incl_tax') -
+                  this.getData('discount_amount') -
+                  this.getData('tax_amount')
+                );
+              }
+            }
+          ],
+          dependencies: ['line_total', 'line_total_incl_tax', 'tax_amount']
+        },
+        {
+          key: 'line_total_with_discount_incl_tax',
+          resolvers: [
+            async function resolver() {
+              const priceIncludingTax = getConfig(
+                'pricing.tax.price_including_tax',
+                false
+              );
+              if (!priceIncludingTax) {
+                return toPrice(
+                  this.getData('line_total') -
+                    this.getData('discount_amount') +
+                    this.getData('tax_amount')
+                );
+              } else {
+                return toPrice(
+                  this.getData('line_total_incl_tax') -
+                    this.getData('discount_amount')
+                );
+              }
+            }
+          ],
+          dependencies: [
+            'line_total_incl_tax',
+            'line_total',
+            'qty',
+            'tax_amount',
+            'discount_amount'
+          ]
+        }
+      ]
+    );
+    return newFields;
+  };

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

@@ -0,0 +1,128 @@
+const { getConfig } = require('@evershop/evershop/src/lib/util/getConfig');
+const { validateCoupon } = require('./couponValidator');
+const { calculateDiscount } = require('./discountCalculator');
+const { toPrice } = require('../../checkout/services/toPrice');
+
+module.exports = exports = {};
+module.exports.registerCartPromotionFields =
+  function registerCartPromotionFields(fields) {
+    const newFields = fields.concat(
+      /** Adding fields to the Cart object */
+      [
+        {
+          key: 'coupon',
+          resolvers: [
+            async function resolver(coupon) {
+              if (coupon) {
+                const check = await validateCoupon(this, coupon);
+                if (check === true) {
+                  return coupon;
+                } else {
+                  return null;
+                }
+              } else {
+                return null;
+              }
+            }
+          ],
+          dependencies: ['items'] // TODO: Add customer id and customer group id as a dependency
+        },
+        {
+          key: 'discount_amount',
+          resolvers: [
+            async function resolver() {
+              const coupon = this.getData('coupon');
+              const items = this.getItems();
+              if (!coupon) {
+                await Promise.all(
+                  items.map(async (item) => {
+                    item.setData('discount_amount', 0);
+                  })
+                );
+                return 0;
+              }
+              // Start calculate discount amount
+              await calculateDiscount(this, coupon);
+              let discountAmount = 0;
+              // eslint-disable-next-line no-restricted-syntax
+              for (const item of items) {
+                discountAmount += item.getData('discount_amount');
+              }
+              return discountAmount;
+            }
+          ],
+          dependencies: ['coupon', 'sub_total', 'sub_total_incl_tax']
+        },
+        {
+          key: 'tax_amount',
+          resolvers: [
+            async function resolver(previousValue) {
+              return previousValue;
+            }
+          ],
+          dependencies: ['discount_amount']
+        },
+        {
+          key: 'sub_total_with_discount',
+          resolvers: [
+            async function resolver() {
+              const priceIncludingTax = getConfig(
+                'pricing.tax.price_including_tax',
+                false
+              );
+              if (!priceIncludingTax) {
+                return toPrice(
+                  this.getData('sub_total') - this.getData('discount_amount')
+                );
+              } else {
+                return toPrice(
+                  this.getData('sub_total_incl_tax') -
+                    this.getData('discount_amount') -
+                    this.getData('tax_amount')
+                );
+              }
+            }
+          ],
+          dependencies: [
+            'sub_total',
+            'sub_total_incl_tax',
+            'discount_amount',
+            'tax_amount'
+          ]
+        },
+        {
+          key: 'sub_total_with_discount_incl_tax',
+          resolvers: [
+            async function resolver() {
+              return toPrice(
+                this.getData('sub_total_with_discount') +
+                  this.getData('tax_amount')
+              );
+            }
+          ],
+          dependencies: ['sub_total_with_discount', 'tax_amount']
+        },
+        {
+          key: 'shipping_fee_excl_tax', // This is to make sure the shipping fee is calculated after the coupon validation
+          resolvers: [],
+          dependencies: ['coupon']
+        },
+        {
+          key: 'grand_total',
+          resolvers: [
+            async function resolver() {
+              return toPrice(
+                this.getData('sub_total_with_discount_incl_tax') +
+                  this.getData('shipping_fee_incl_tax')
+              );
+            }
+          ],
+          dependencies: [
+            'sub_total_with_discount_incl_tax',
+            'shipping_fee_incl_tax'
+          ]
+        }
+      ]
+    );
+    return newFields;
+  };