@evershop/evershop 1.0.0 → 1.2.0

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

@@ -0,0 +1,44 @@
+{
+  "type": "object",
+  "properties": {
+    "customer_full_name": {
+      "type": "string"
+    },
+    "customer_email": {
+      "type": ["string"],
+      "format": "email",
+      "errorMessage": {
+        "type": "Email is invalid"
+      }
+    },
+    "items": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "sku": {
+            "type": "string"
+          },
+          "qty": {
+            "type": "integer"
+          }
+        },
+        "required": ["sku", "qty"],
+        "additionalProperties": true,
+        "errorMessage": {
+          "properties": {
+            "sku": "Sku is required",
+            "qty": "Qty is invalid"
+          }
+        }
+      }
+    }
+  },
+  "required": ["items"],
+  "errorMessage": {
+    "required": {
+      "items": "Must provide at least one item"
+    }
+  },
+  "additionalProperties": true
+}

package/src/modules/checkout/api/createCart/route.json

@@ -0,0 +1,5 @@
+{
+  "methods": ["POST"],
+  "path": "/carts",
+  "access": "public"
+}

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

@@ -0,0 +1,58 @@
+/* eslint-disable camelcase */
+const {
+  rollback,
+  commit,
+  startTransaction,
+  del,
+  select
+} = 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 { id } = request.params;
+  const connection = await getConnection();
+  await startTransaction(connection);
+  try {
+    // Load the shipping zone
+    const shippingZone = await select()
+      .from('shipping_zone')
+      .where('uuid', '=', id)
+      .load(connection);
+
+    if (!shippingZone) {
+      response.status(INVALID_PAYLOAD);
+      response.json({
+        error: {
+          status: INVALID_PAYLOAD,
+          message: 'Invalid zone id'
+        }
+      });
+      return;
+    }
+    await del('shipping_zone').where('uuid', '=', id).execute(connection);
+    await commit(connection);
+    response.status(OK);
+    response.json({
+      data: shippingZone
+    });
+  } 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/deleteShippingZone/route.json

@@ -0,0 +1,5 @@
+{
+  "methods": ["DELETE"],
+  "path": "/shippingZones/:id",
+  "access": "private"
+}

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

@@ -0,0 +1,85 @@
+/* eslint-disable camelcase */
+const {
+  rollback,
+  commit,
+  startTransaction,
+  select,
+  del
+} = 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');
+
+// eslint-disable-next-line no-unused-vars
+module.exports = async (request, response, deledate, next) => {
+  const { method_id, zone_id } = request.params;
+  const connection = await getConnection();
+  await startTransaction(connection);
+  try {
+    // Load the shipping zone
+    const shippingZone = await select()
+      .from('shipping_zone')
+      .where('uuid', '=', zone_id)
+      .load(connection, false);
+
+    if (!shippingZone) {
+      response.status(INVALID_PAYLOAD);
+      response.json({
+        error: {
+          status: INVALID_PAYLOAD,
+          message: 'Invalid zone id'
+        }
+      });
+      return;
+    }
+
+    const zoneMethodQuery = select().from('shipping_method');
+    zoneMethodQuery
+      .innerJoin('shipping_zone_method')
+      .on(
+        'shipping_method.shipping_method_id',
+        '=',
+        'shipping_zone_method.method_id'
+      );
+    zoneMethodQuery
+      .where('shipping_zone_method.zone_id', '=', shippingZone.shipping_zone_id)
+      .and('shipping_method.uuid', '=', method_id);
+
+    const zoneMethod = await zoneMethodQuery.load(connection, false);
+    if (!zoneMethod) {
+      response.status(INVALID_PAYLOAD);
+      response.json({
+        error: {
+          status: INVALID_PAYLOAD,
+          message: 'Invalid method id'
+        }
+      });
+      return;
+    }
+
+    // Delete the shipping zone method
+    await del('shipping_zone_method')
+      .where('method_id', '=', zoneMethod.shipping_method_id)
+      .and('zone_id', '=', shippingZone.shipping_zone_id)
+      .execute(connection);
+    await commit(connection);
+    response.status(OK);
+    response.json({
+      data: zoneMethod
+    });
+  } catch (e) {
+    await rollback(connection);
+    response.status(INTERNAL_SERVER_ERROR);
+    response.json({
+      error: {
+        status: INTERNAL_SERVER_ERROR,
+        message: e.message
+      }
+    });
+  }
+};

package/src/modules/checkout/api/deleteShippingZoneMethod/route.json

@@ -0,0 +1,5 @@
+{
+  "methods": ["DELETE"],
+  "path": "/shippingZones/:zone_id/methods/:method_id",
+  "access": "private"
+}

package/src/modules/checkout/api/getShippingMethods/sendMethods.js

@@ -131,6 +131,43 @@ module.exports = async (request, response, delegate, next) => {
             ...method,
             cost: toPrice(jsonResponse.data.data.cost, true)
           };
+        } else if (method.weight_based_cost) {
+          const totalWeight = cart.total_weight;
+          const weightBasedCost = method.weight_based_cost
+            .map(({ min_weight, cost }) => ({
+              min_weight: parseFloat(min_weight),
+              cost: toPrice(cost)
+            }))
+            .sort((a, b) => a.min_weight - b.min_weight);
+
+          let cost = 0;
+          for (let i = 0; i < weightBasedCost.length; i += 1) {
+            if (totalWeight >= weightBasedCost[i].min_weight) {
+              cost = weightBasedCost[i].cost;
+            }
+          }
+          return {
+            ...method,
+            cost: toPrice(cost, true)
+          };
+        } else if (method.price_based_cost) {
+          const subTotal = toPrice(cart.sub_total);
+          const priceBasedCost = method.price_based_cost
+            .map(({ min_price, cost }) => ({
+              min_price: toPrice(min_price),
+              cost: toPrice(cost)
+            }))
+            .sort((a, b) => a.min_price - b.min_price);
+          let cost = 0;
+          for (let i = 0; i < priceBasedCost.length; i += 1) {
+            if (subTotal >= priceBasedCost[i].min_price) {
+              cost = priceBasedCost[i].cost;
+            }
+          }
+          return {
+            ...method,
+            cost: toPrice(cost, true)
+          };
         } else {
           return {
             ...method,

package/src/modules/checkout/api/updateCartItemQty/[bodyParser]updateQty.js

@@ -0,0 +1,49 @@
+const {
+  INVALID_PAYLOAD,
+  INTERNAL_SERVER_ERROR,
+  OK
+} = require('@evershop/evershop/src/lib/util/httpStatus');
+const {
+  translate
+} = require('@evershop/evershop/src/lib/locale/translate/translate');
+const { error } = require('@evershop/evershop/src/lib/log/logger');
+const { getCartByUUID } = require('../../services/getCartByUUID');
+const { saveCart } = require('../../services/saveCart');
+
+module.exports = async (request, response, delegate, next) => {
+  try {
+    const { cart_id, item_id } = request.params;
+    const cart = await getCartByUUID(cart_id);
+    if (!cart) {
+      response.status(INVALID_PAYLOAD);
+      response.json({
+        error: {
+          message: translate('Invalid cart'),
+          status: INVALID_PAYLOAD
+        }
+      });
+      return;
+    }
+    const { action, qty } = request.body;
+    const item = await cart.updateItemQty(item_id, qty, action);
+    await saveCart(cart);
+    response.status(OK);
+    response.$body = {
+      data: {
+        item: item.export(),
+        count: cart.getItems().length,
+        cartId: cart.getData('uuid')
+      }
+    };
+    next();
+  } catch (err) {
+    error(err);
+    response.status(INTERNAL_SERVER_ERROR);
+    response.json({
+      error: {
+        status: INTERNAL_SERVER_ERROR,
+        message: err.message
+      }
+    });
+  }
+};

package/src/modules/checkout/api/updateCartItemQty/[context]bodyParser[auth].js

@@ -0,0 +1,5 @@
+const bodyParser = require('body-parser');
+
+module.exports = (request, response, delegate, next) => {
+  bodyParser.json({ inflate: false })(request, response, next);
+};

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

@@ -0,0 +1,21 @@
+{
+  "type": "object",
+  "properties": {
+    "action": {
+      "type": "string",
+      "enum": ["increase", "decrease"] 
+    },
+    "qty": {
+      "type": ["string", "integer"],
+      "pattern": "^[1-9][0-9]*$"
+    }
+  },
+  "required": ["action", "qty"],
+  "additionalProperties": true,
+  "errorMessage": {
+    "properties": {
+      "action": "Action is required. It must be either 'increase' or 'decrease'",
+      "qty": "Qty is invalid"
+    }
+  }
+}

package/src/modules/checkout/api/updateCartItemQty/route.json

@@ -0,0 +1,5 @@
+{
+  "methods": ["PATCH"],
+  "path": "/cart/:cart_id/items/:item_id",
+  "access": "public"
+}

package/src/modules/checkout/api/updateMineCartItemQty/[context]bodyParser[auth].js

@@ -0,0 +1,5 @@
+const bodyParser = require('body-parser');
+
+module.exports = (request, response, delegate, next) => {
+  bodyParser.json({ inflate: false })(request, response, next);
+};

package/src/modules/checkout/api/updateMineCartItemQty/[detectCurrentCart]updateQty.js

@@ -0,0 +1,51 @@
+const {
+  INVALID_PAYLOAD,
+  INTERNAL_SERVER_ERROR,
+  OK
+} = require('@evershop/evershop/src/lib/util/httpStatus');
+const {
+  translate
+} = require('@evershop/evershop/src/lib/locale/translate/translate');
+const { error } = require('@evershop/evershop/src/lib/log/logger');
+const { getCartByUUID } = require('../../services/getCartByUUID');
+const { saveCart } = require('../../services/saveCart');
+const { getContextValue } = require('../../../graphql/services/contextHelper');
+
+module.exports = async (request, response, delegate, next) => {
+  try {
+    const { item_id } = request.params;
+    const cartId = getContextValue(request, 'cartId');
+    const cart = await getCartByUUID(cartId);
+    if (!cart) {
+      response.status(INVALID_PAYLOAD);
+      response.json({
+        error: {
+          message: translate('Invalid cart'),
+          status: INVALID_PAYLOAD
+        }
+      });
+      return;
+    }
+    const { action, qty } = request.body;
+    const item = await cart.updateItemQty(item_id, qty, action);
+    await saveCart(cart);
+    response.status(OK);
+    response.$body = {
+      data: {
+        item: item.export(),
+        count: cart.getItems().length,
+        cartId: cart.getData('uuid')
+      }
+    };
+    next();
+  } catch (err) {
+    error(err);
+    response.status(INTERNAL_SERVER_ERROR);
+    response.json({
+      error: {
+        status: INTERNAL_SERVER_ERROR,
+        message: err.message
+      }
+    });
+  }
+};

package/src/modules/checkout/api/updateMineCartItemQty/[getCurrentCustomer]detectCurrentCart.js

@@ -0,0 +1,32 @@
+const { pool } = require('@evershop/evershop/src/lib/postgres/connection');
+const { select } = require('@evershop/postgres-query-builder');
+const { UNAUTHORIZED } = require('@evershop/evershop/src/lib/util/httpStatus');
+const { setContextValue } = require('../../../graphql/services/contextHelper');
+
+module.exports = async (request, response, delegate, next) => {
+  /**
+   * We firstly get the sessionID from the request.
+   * This API needs the client to send the session cookie in the request.
+   * Base on the sessionID, we can get the cart
+   */
+  const { sessionID } = request.locals;
+  if (!sessionID) {
+    response.status(UNAUTHORIZED);
+    response.json({
+      error: {
+        status: UNAUTHORIZED,
+        message: 'Unauthorized'
+      }
+    });
+  } else {
+    const cart = await select()
+      .from('cart')
+      .where('sid', '=', sessionID)
+      .and('status', '=', 1)
+      .load(pool);
+    if (cart) {
+      setContextValue(request, 'cartId', cart.uuid);
+    }
+    next();
+  }
+};

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

@@ -0,0 +1,21 @@
+{
+  "type": "object",
+  "properties": {
+    "action": {
+      "type": "string",
+      "enum": ["increase", "decrease"] 
+    },
+    "qty": {
+      "type": ["string", "integer"],
+      "pattern": "^[1-9][0-9]*$"
+    }
+  },
+  "required": ["action", "qty"],
+  "additionalProperties": true,
+  "errorMessage": {
+    "properties": {
+      "action": "Action is required. It must be either 'increase' or 'decrease'",
+      "qty": "Qty is invalid"
+    }
+  }
+}

package/src/modules/checkout/api/updateMineCartItemQty/route.json

@@ -0,0 +1,5 @@
+{
+  "methods": ["PATCH"],
+  "path": "/cart/mine/items/:item_id",
+  "access": "public"
+}

package/src/modules/checkout/api/updateShippingMethod/[context]borderParser[auth].js

@@ -0,0 +1,5 @@
+const bodyParser = require('body-parser');
+
+module.exports = (request, response, delegate, next) => {
+  bodyParser.json({ inflate: false })(request, response, next);
+};

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

@@ -0,0 +1,12 @@
+{
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": true,
+  "required": [
+    "name"
+  ]
+}

package/src/modules/checkout/api/updateShippingMethod/route.json

@@ -0,0 +1,5 @@
+{
+  "methods": ["PATCH"],
+  "path": "/shippingMethods/:id",
+  "access": "private"
+}

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
       })