@evershop/evershop 1.0.0 → 1.1.0

package/src/modules/checkout/api/updateShippingMethod/updateShippingMethod.js

@@ -0,0 +1,64 @@
+/* eslint-disable camelcase */
+const {
+  rollback,
+  commit,
+  startTransaction,
+  select,
+  update
+} = require('@evershop/postgres-query-builder');
+const {
+  getConnection
+} = require('@evershop/evershop/src/lib/postgres/connection');
+const {
+  OK,
+  INTERNAL_SERVER_ERROR,
+  INVALID_PAYLOAD
+} = require('@evershop/evershop/src/lib/util/httpStatus');
+const { error } = require('@evershop/evershop/src/lib/log/logger');
+
+// eslint-disable-next-line no-unused-vars
+module.exports = async (request, response, deledate, next) => {
+  const connection = await getConnection();
+  await startTransaction(connection);
+  const { name } = request.body;
+  const { id } = request.params;
+  try {
+    const method = await select()
+      .from('shipping_method')
+      .where('uuid', '=', id)
+      .load(connection);
+
+    if (!method) {
+      response.status(INVALID_PAYLOAD);
+      response.json({
+        error: {
+          status: INVALID_PAYLOAD,
+          message: 'Requested method not found'
+        }
+      });
+      return;
+    }
+
+    const newMethod = await update('shipping_method')
+      .given({
+        name
+      })
+      .where('uuid', '=', id)
+      .execute(connection);
+    await commit(connection);
+    response.status(OK);
+    response.json({
+      data: newMethod
+    });
+  } catch (e) {
+    error(e);
+    await rollback(connection);
+    response.status(INTERNAL_SERVER_ERROR);
+    response.json({
+      error: {
+        status: INTERNAL_SERVER_ERROR,
+        message: e.message
+      }
+    });
+  }
+};

package/src/modules/checkout/api/updateShippingZoneMethod/payloadSchema.json

@@ -11,7 +11,49 @@
     },
     "calculation_type": {
       "type": "string",
-      "enum": ["flat_rate", "api"]
+      "enum": ["flat_rate", "price_based_rate", "weight_based_rate", "api"]
+    },
+    "price_based_cost": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "min_price": {
+            "type": ["string", "number"],
+            "pattern": "^\\d+(\\.\\d{1,2})?$"
+          },
+          "cost": {
+            "type": ["string", "number"],
+            "pattern": "^\\d+(\\.\\d{1,2})?$"
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "min_price",
+          "cost"
+        ]
+      }
+    },
+    "weight_based_cost": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "min_weight": {
+            "type": ["string", "number"],
+            "pattern": "^\\d+(\\.\\d{1,2})?$"
+          },
+          "cost": {
+            "type": ["string", "number"],
+            "pattern": "^\\d+(\\.\\d{1,2})?$"
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "min_weight",
+          "cost"
+        ]
+      }
     },
     "condition_type": {
       "type": "string",

package/src/modules/checkout/api/updateShippingZoneMethod/updateShippingZoneMethod.js

@@ -20,7 +20,15 @@ module.exports = async (request, response, deledate, next) => {
   const { method_id, zone_id } = request.params;
   const connection = await getConnection();
   await startTransaction(connection);
-  let { cost, condition_type, calculate_api, min, max } = request.body;
+  let {
+    cost,
+    condition_type,
+    calculate_api,
+    price_based_cost,
+    weight_based_cost,
+    min,
+    max
+  } = request.body;
   const { is_enabled, calculation_type } = request.body;
   try {
     // Load the shipping zone
@@ -65,9 +73,13 @@ module.exports = async (request, response, deledate, next) => {
     }
 
     if (calculation_type === 'api') {
-      cost = null;
+      cost = weight_based_cost = price_based_cost = null;
+    } else if (calculation_type === 'price_based_rate') {
+      calculate_api = cost = weight_based_cost = null;
+    } else if (calculation_type === 'weight_based_rate') {
+      calculate_api = cost = price_based_cost = null;
     } else {
-      calculate_api = null;
+      calculate_api = weight_based_cost = price_based_cost = null;
     }
     if (condition_type === 'none') {
       condition_type = null;
@@ -80,6 +92,8 @@ module.exports = async (request, response, deledate, next) => {
         is_enabled,
         calculate_api,
         condition_type,
+        price_based_cost,
+        weight_based_cost,
         max,
         min
       })

package/src/modules/checkout/bootstrap.js

@@ -1,4 +1,4 @@
-const { error } = require('../../lib/log/debuger');
+const { error } = require('../../lib/log/logger');
 const { addProcessor, addFinalProcessor } = require('../../lib/util/registry');
 const { sortFields } = require('./services/cart/sortFields');
 const {

package/src/modules/checkout/graphql/types/ShippingMethod/ShippingMethod.graphql

@@ -5,6 +5,7 @@ type ShippingMethod {
   shippingMethodId: Int!
   uuid: String!
   name: String!
+  updateApi: String!
 }
 
 extend type Query {

package/src/modules/checkout/graphql/types/ShippingMethod/ShippingMethod.resolvers.js

@@ -1,6 +1,7 @@
 const { select } = require('@evershop/postgres-query-builder');
 const { pool } = require('@evershop/evershop/src/lib/postgres/connection');
 const { camelCase } = require('@evershop/evershop/src/lib/util/camelCase');
+const { buildUrl } = require('@evershop/evershop/src/lib/router/buildUrl');
 
 module.exports = {
   Query: {
@@ -11,5 +12,8 @@ module.exports = {
         .execute(pool);
       return shippingMethods.map((row) => camelCase(row));
     }
+  },
+  ShippingMethod: {
+    updateApi: ({ uuid }) => buildUrl('updateShippingMethod', { id: uuid })
   }
 };

package/src/modules/checkout/graphql/types/ShippingZone/ShippingZone.graphql

@@ -1,3 +1,19 @@
+"""
+Represents a price based cost
+"""
+type PriceBasedCostItem {
+  minPrice: Price!
+  cost: Price!
+}
+
+"""
+Represents a weight based cost
+"""
+type WeightBasedCostItem {
+  minWeight: Price!
+  cost: Price!
+}
+
 """
 Represents a shipping method.
 """
@@ -7,12 +23,15 @@ type ShippingMethodByZone {
   uuid: String!
   name: String!
   cost: Price
+  priceBasedCost: [PriceBasedCostItem]
+  weightBasedCost: [WeightBasedCostItem]
   isEnabled: Boolean!
   calculateApi: String
   conditionType: String
   max: Float
   min: Float
   updateApi: String!
+  deleteApi: String!
 }
 
 """
@@ -22,10 +41,11 @@ type ShippingZone {
   shipping_zone_id: Int!
   uuid: String!
   name: String!
-  country: Country!
+  country: Country
   provinces: [Province]
   methods: [ShippingMethodByZone]
   updateApi: String!
+  deleteApi: String!
   addMethodApi: String!
   removeMethodApi: String!
 }

package/src/modules/checkout/graphql/types/ShippingZone/ShippingZone.resolvers.js

@@ -1,4 +1,5 @@
 const { select } = require('@evershop/postgres-query-builder');
+const { contries } = require('@evershop/evershop/src/lib/locale/countries');
 const { pool } = require('@evershop/evershop/src/lib/postgres/connection');
 const { camelCase } = require('@evershop/evershop/src/lib/util/camelCase');
 const { buildUrl } = require('@evershop/evershop/src/lib/router/buildUrl');
@@ -36,6 +37,18 @@ module.exports = {
       const methods = await query.execute(pool);
       return methods.map((row) => camelCase(row));
     },
+    country: ({ country }) => {
+      if (!country) {
+        return null;
+      } else {
+        const c = contries.find((p) => p.code === country);
+        if (c) {
+          return c;
+        } else {
+          return null;
+        }
+      }
+    },
     provinces: async ({ shippingZoneId }) => {
       const provinces = await select('province')
         .from('shipping_zone_province')
@@ -43,10 +56,10 @@ module.exports = {
         .execute(pool);
       return provinces.map((row) => row.province);
     },
-    updateApi: async ({ uuid }) => buildUrl('updateShippingZone', { id: uuid }),
-    addMethodApi: async ({ uuid }) =>
-      buildUrl('addShippingZoneMethod', { id: uuid }),
-    removeMethodApi: async ({ uuid }) =>
+    updateApi: ({ uuid }) => buildUrl('updateShippingZone', { id: uuid }),
+    deleteApi: ({ uuid }) => buildUrl('deleteShippingZone', { id: uuid }),
+    addMethodApi: ({ uuid }) => buildUrl('addShippingZoneMethod', { id: uuid }),
+    removeMethodApi: ({ uuid }) =>
       buildUrl('removeShippingZoneMethod', { id: uuid })
   },
   ShippingMethodByZone: {
@@ -60,6 +73,23 @@ module.exports = {
         zone_id: zone.uuid,
         method_id: uuid
       });
+    },
+    deleteApi: async ({ uuid, zoneId }) => {
+      const zone = await select()
+        .from('shipping_zone')
+        .where('shipping_zone_id', '=', zoneId)
+        .load(pool);
+
+      return buildUrl('deleteShippingZoneMethod', {
+        zone_id: zone.uuid,
+        method_id: uuid
+      });
     }
+  },
+  WeightBasedCostItem: {
+    minWeight: ({ min_weight }) => min_weight
+  },
+  PriceBasedCostItem: {
+    minPrice: ({ min_price }) => min_price
   }
 };

package/src/modules/checkout/graphql/types/Weight/Weight.resolvers.js

@@ -1,20 +1,17 @@
-const { getSetting } = require('../../../../setting/services/setting');
+const { getConfig } = require('@evershop/evershop/src/lib/util/getConfig');
 
 module.exports = {
   Weight: {
-    value: (raw) => parseFloat(raw), // TODO: Format for decimal value?
-    unit: async () => {
-      const unit = await getSetting('weightUnit', 'kg');
+    value: (raw) => parseFloat(raw),
+    unit: () => {
+      const unit = getConfig('shop.weightUnit', 'kg');
       return unit;
     },
-    text: async (raw) => {
-      const weight = parseFloat(raw); // TODO: Format for decimal value?
-      const unit = await getSetting('weightUnit', 'kg');
-      const language = await getSetting('storeLanguage', 'en');
+    text: (raw) => {
+      const weight = parseFloat(raw);
+      const unit = getConfig('shop.weightUnit', 'kg');
       // Localize the weight
-      return new Intl.NumberFormat(language, { style: 'unit', unit }).format(
-        weight
-      );
+      return `${weight} ${unit}`;
     }
   }
 };

package/src/modules/checkout/migration/Version-1.0.5.js

@@ -0,0 +1,28 @@
+const { execute } = require('@evershop/postgres-query-builder');
+
+// eslint-disable-next-line no-multi-assign
+module.exports = exports = async (connection) => {
+  // Add a column 'price_based_cost' to the method table if it does not exist
+  await execute(
+    connection,
+    `ALTER TABLE "shipping_zone_method" ADD COLUMN "price_based_cost" jsonb`
+  );
+
+  // Add a column 'price_based_cost' to the method table if it does not exist
+  await execute(
+    connection,
+    `ALTER TABLE "shipping_zone_method" ADD COLUMN "weight_based_cost" jsonb`
+  );
+
+  // Delete the constraint 'CONDITION_TYPE_MUST_BE_PRICE_OR_WEIGHT' from the method table
+  await execute(
+    connection,
+    `ALTER TABLE "shipping_zone_method" DROP CONSTRAINT "CONDITION_TYPE_MUST_BE_PRICE_OR_WEIGHT"`
+  );
+
+  // Delete the constraint 'CONDITION_TYPE_MUST_BE_PRICE_OR_WEIGHT' from the method table
+  await execute(
+    connection,
+    `ALTER TABLE "shipping_zone_method" DROP CONSTRAINT "CALCULATE API MUST BE PROVIDE IF COST IS NULL"`
+  );
+};

package/src/modules/{oms → checkout}/pages/admin/shippingSetting/ShippingSetting.jsx

@@ -5,9 +5,9 @@ import { Card } from '@components/admin/cms/Card';
 import SettingMenu from '@components/admin/setting/SettingMenu';
 import Button from '@components/common/form/Button';
 import { useModal } from '@components/common/modal/useModal';
-import ZoneForm from '@components/admin/oms/shippingSetting/ZoneForm';
+import ZoneForm from '@components/admin/checkout/shippingSetting/ZoneForm';
 import Spinner from '@components/common/Spinner';
-import { Zones } from '@components/admin/oms/shippingSetting/Zones';
+import { Zones } from '@components/admin/checkout/shippingSetting/Zones';
 
 const CountriesQuery = `
   query Country($countries: [String]) {
@@ -43,14 +43,36 @@ const ZonesQuery = `
           text
           value
         }
+        priceBasedCost {
+          minPrice {
+            value
+            text
+          }
+          cost {
+            value
+            text
+          }
+        }
+        weightBasedCost {
+          minWeight {
+            value
+            text
+          }
+          cost {
+            value
+            text
+          }
+        }
         isEnabled
         conditionType
         calculateApi
         max
         min
         updateApi
+        deleteApi
       }
       updateApi
+      deleteApi
       addMethodApi
     }
   }
@@ -66,14 +88,6 @@ export default function ShippingSetting({ createShippingZoneApi }) {
     query: ZonesQuery
   });
 
-  if (countriesQueryData.fetching || zonesQueryData.fetching) {
-    return (
-      <div className="flex justify-center">
-        <Spinner />
-      </div>
-    );
-  }
-
   return (
     <div className="main-content-inner">
       <div className="grid grid-cols-6 gap-x-2 grid-flow-row ">
@@ -81,27 +95,52 @@ export default function ShippingSetting({ createShippingZoneApi }) {
           <SettingMenu />
         </div>
         <div className="col-span-4">
-          <Card>
+          {countriesQueryData.fetching || zonesQueryData.fetching ? (
             <Card.Session title="Shipping">
-              <div>
-                Choose where you ship and how much you charge for shipping.
+              <div className="flex justify-center p-2">
+                <Spinner width={25} height={25} />
               </div>
             </Card.Session>
-            <Zones
-              zones={zonesQueryData.data.shippingZones}
-              countries={countriesQueryData.data.countries}
-              getZones={reexecuteQuery}
-            />
-            <Card.Session>
-              <div>
-                <Button
-                  title="Create new shipping zone"
-                  variant="primary"
-                  onAction={() => modal.openModal()}
+          ) : (
+            <Card>
+              <Card.Session title="Shipping">
+                <div>
+                  Choose where you ship and how much you charge for shipping.
+                </div>
+              </Card.Session>
+              {zonesQueryData.error ? (
+                <Card.Session>
+                  <div>
+                    <p className="text-critical">
+                      {zonesQueryData.error.message}
+                    </p>
+                  </div>
+                </Card.Session>
+              ) : (
+                <Zones
+                  zones={zonesQueryData.data.shippingZones}
+                  countries={countriesQueryData.data.countries}
+                  getZones={() => {
+                    reexecuteQuery(
+                      {
+                        requestPolicy: 'network-only'
+                      },
+                      false
+                    );
+                  }}
                 />
-              </div>
-            </Card.Session>
-          </Card>
+              )}
+              <Card.Session>
+                <div>
+                  <Button
+                    title="Create new shipping zone"
+                    variant="primary"
+                    onAction={() => modal.openModal()}
+                  />
+                </div>
+              </Card.Session>
+            </Card>
+          )}
         </div>
       </div>
       {modal.state.showing && (
@@ -144,21 +183,5 @@ export const layout = {
 export const query = `
   query Query {
     createShippingZoneApi: url(routeId: "createShippingZone")
-    shippingZones {
-      uuid
-      name
-      country {
-        name
-        code
-      }
-      provinces {
-        name
-        code
-      }
-      methods {
-        uuid
-        name
-      }
-    }
   }
 `;

package/src/modules/checkout/pages/frontStore/all/[auth]addCustomerToCart.js

@@ -1,6 +1,6 @@
 const { select, update } = require('@evershop/postgres-query-builder');
 const { pool } = require('@evershop/evershop/src/lib/postgres/connection');
-const { debug } = require('@evershop/evershop/src/lib/log/debuger');
+const { error } = require('@evershop/evershop/src/lib/log/logger');
 
 module.exports = async (request, response, delegate, next) => {
   try {
@@ -25,8 +25,8 @@ module.exports = async (request, response, delegate, next) => {
           .execute(pool);
       }
     }
-  } catch (error) {
-    debug('critical', error);
+  } catch (e) {
+    error(e);
   }
   next();
 };

package/src/modules/checkout/pages/frontStore/checkout/PaymentStep.jsx

@@ -5,6 +5,7 @@ import {
   useCheckoutStepsDispatch
 } from '@components/common/context/checkoutSteps';
 import { StepContent } from '@components/frontStore/checkout/checkout/payment/paymentStep/StepContent';
+import { _ } from '@evershop/evershop/src/lib/locale/translate';
 
 export default function PaymentStep({ cart }) {
   const steps = useCheckoutSteps();
@@ -15,8 +16,8 @@ export default function PaymentStep({ cart }) {
   React.useEffect(() => {
     addStep({
       id: 'payment',
-      title: 'Payment',
-      previewTitle: 'Payment',
+      title: _('Payment'),
+      previewTitle: _('Payment'),
       isCompleted: false,
       sortOrder: 15,
       editable: true

package/src/modules/checkout/pages/frontStore/checkout/ShippingMethods.jsx

@@ -1,6 +1,7 @@
 import PropTypes from 'prop-types';
 import React from 'react';
 import axios from 'axios';
+import { toast } from 'react-toastify';
 import { useClient } from 'urql';
 import { useFormContext } from '@components/common/form/Form';
 import { Field } from '@components/common/form/Field';
@@ -105,17 +106,29 @@ export default function ShippingMethods({
     async function saveMethods() {
       // Get the selected method
       const selectedMethod = methods.find((m) => m.selected === true);
-      const response = await axios.post(addShippingMethodApi, {
-        method_code: selectedMethod.code,
-        method_name: selectedMethod.name
-      });
-      if (!response.data.error) {
-        const result = await client.query(QUERY, { cartId }).toPromise();
-        const address = result.data.cart.shippingAddress;
-        completeStep(
-          'shipment',
-          `${address.address1}, ${address.city}, ${address.country.name}`
+      try {
+        const response = await axios.post(
+          addShippingMethodApi,
+          {
+            method_code: selectedMethod.code,
+            method_name: selectedMethod.name
+          },
+          {
+            validateStatus: () => true
+          }
         );
+        if (!response.data.error) {
+          const result = await client.query(QUERY, { cartId }).toPromise();
+          const address = result.data.cart.shippingAddress;
+          completeStep(
+            'shipment',
+            `${address.address1}, ${address.city}, ${address.country.name}`
+          );
+        } else {
+          toast.error(response.data.error.message);
+        }
+      } catch (error) {
+        toast.error(error.message);
       }
     }
     if (formContext.state === 'submitSuccess') {