@evershop/evershop 1.1.0 → 1.2.1

package/src/modules/catalog/services/CategoryCollection.js

@@ -24,16 +24,16 @@ class CategoryCollection {
     );
 
     categoryCollectionFilters.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/catalog/services/CollectionCollection.js

@@ -18,16 +18,16 @@ class CollectionCollection {
     );
 
     collectionCollectionFilters.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/catalog/services/registerCartItemProductUrlField.js

@@ -0,0 +1,35 @@
+const { pool } = require('@evershop/evershop/src/lib/postgres/connection');
+const { buildUrl } = require('@evershop/evershop/src/lib/router/buildUrl');
+const { select } = require('@evershop/postgres-query-builder');
+
+module.exports = exports = {};
+
+exports.registerCartItemProductUrlField = (fields) => {
+  const newFields = fields.concat([
+    {
+      key: 'productUrl',
+      resolvers: [
+        async function resolver() {
+          const product = await this.getProduct();
+          if (!this.getData('product_id')) {
+            return null;
+          }
+          const urlRewrite = await select()
+            .from('url_rewrite')
+            .where('entity_uuid', '=', product.uuid)
+            .and('entity_type', '=', 'product')
+            .load(pool);
+          if (!urlRewrite) {
+            return buildUrl('productView', {
+              uuid: product.uuid
+            });
+          } else {
+            return urlRewrite.request_path;
+          }
+        }
+      ],
+      dependencies: ['product_id']
+    }
+  ]);
+  return newFields;
+};

package/src/modules/catalog/services/registerCartItemVariantOptionsField.js

@@ -0,0 +1,51 @@
+const { pool } = require('@evershop/evershop/src/lib/postgres/connection');
+const { select } = require('@evershop/postgres-query-builder');
+
+module.exports = exports = {};
+
+exports.registerCartItemVariantOptionsField = (fields) => {
+  const newFields = fields.concat([
+    {
+      key: 'variant_options',
+      resolvers: [
+        async function resolver() {
+          const product = await this.getProduct();
+          if (product.variant_group_id) {
+            const group = await select('attribute_one')
+              .select('attribute_two')
+              .select('attribute_three')
+              .select('attribute_four')
+              .select('attribute_five')
+              .from('variant_group')
+              .where('variant_group_id', '=', product.variant_group_id)
+              .load(pool);
+            if (!group) {
+              return null;
+            } else {
+              const query = select('a.attribute_code')
+                .select('a.attribute_name')
+                .select('a.attribute_id')
+                .select('o.option_id')
+                .select('o.option_text')
+                .from('attribute', 'a');
+              query
+                .innerJoin('product_attribute_value_index', 'o')
+                .on('a.attribute_id', '=', 'o.attribute_id');
+              query.where('o.product_id', '=', product.product_id).and(
+                'a.attribute_id',
+                'IN',
+                Object.values(group).filter((v) => v != null)
+              );
+
+              return JSON.stringify(await query.execute(pool));
+            }
+          } else {
+            return null;
+          }
+        }
+      ],
+      dependencies: ['variant_group_id']
+    }
+  ]);
+  return newFields;
+};

package/src/modules/catalog/services/registerDefaultCategoryCollectionFilters.js

@@ -51,6 +51,22 @@ module.exports = async function registerDefaultCategoryCollectionFilters() {
         });
       }
     },
+    {
+      key: 'parent',
+      operation: ['eq'],
+      callback: (query, operation, value, currentFilters) => {
+        if (value === null) {
+          query.andWhere('category.parent_id', 'IS NULL');
+        } else {
+          query.andWhere('category.parent_id', OPERATION_MAP[operation], value);
+        }
+        currentFilters.push({
+          key: 'parent',
+          operation,
+          value
+        });
+      }
+    },
     {
       key: 'ob',
       operation: ['eq'],

package/src/modules/checkout/api/addShippingNote/[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/addShippingNote/payloadSchema.json

@@ -0,0 +1,15 @@
+{
+  "type": "object",
+  "properties": {
+    "note": {
+      "type": "string"
+    }
+  },
+  "required": ["note"],
+  "additionalProperties": false,
+  "errorMessage": {
+    "properties": {
+      "note": "Note is required"
+    }
+  }
+}

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

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

package/src/modules/checkout/api/addShippingNote/saveShippingNote.js

@@ -0,0 +1,50 @@
+/* eslint-disable camelcase */
+const {
+  OK,
+  INTERNAL_SERVER_ERROR,
+  INVALID_PAYLOAD
+} = require('@evershop/evershop/src/lib/util/httpStatus');
+const { error } = require('@evershop/evershop/src/lib/log/logger');
+const {
+  translate
+} = require('@evershop/evershop/src/lib/locale/translate/translate');
+const { getCartByUUID } = require('../../services/getCartByUUID');
+const { saveCart } = require('../../services/saveCart');
+
+module.exports = async (request, response, delegate, next) => {
+  try {
+    const { cart_id } = request.params;
+    const { note } = request.body;
+    // Check if cart exists
+    const cart = await getCartByUUID(cart_id);
+    if (!cart) {
+      response.status(INVALID_PAYLOAD).json({
+        error: {
+          message: 'Invalid cart',
+          status: INVALID_PAYLOAD
+        }
+      });
+    } else {
+      // Save shipping note
+      await cart.setData('shipping_note', note);
+      // Save the cart
+      await saveCart(cart);
+      response.status(OK);
+      response.$body = {
+        data: {
+          note
+        }
+      };
+      next();
+    }
+  } catch (e) {
+    error(e);
+    response.status(INTERNAL_SERVER_ERROR);
+    response.json({
+      error: {
+        message: translate('Failed to set shipping note'),
+        status: INTERNAL_SERVER_ERROR
+      }
+    });
+  }
+};

package/src/modules/checkout/api/createCart/createNewCart.js

@@ -4,10 +4,11 @@ const {
   OK
 } = require('@evershop/evershop/src/lib/util/httpStatus');
 const { getConfig } = require('@evershop/evershop/src/lib/util/getConfig');
-const { error } = require('@evershop/evershop/src/lib/log/logger');
 const {
   translate
 } = require('@evershop/evershop/src/lib/locale/translate/translate');
+const { select } = require('@evershop/postgres-query-builder');
+const { pool } = require('@evershop/evershop/src/lib/postgres/connection');
 const { setContextValue } = require('../../../graphql/services/contextHelper');
 const { saveCart } = require('../../services/saveCart');
 const { Cart } = require('../../services/cart/Cart');
@@ -60,10 +61,35 @@ module.exports = async (request, response, delegate, next) => {
       },
       [{ sku: items[0].sku, qty: 0 }]
     );
+    const products = await select()
+      .from('product')
+      .where(
+        'sku',
+        'IN',
+        groupedItems.map((item) => item.sku)
+      )
+      .and('status', '=', 1)
+      .execute(pool);
+    // Check if all products are available
+    if (products.length !== groupedItems.length) {
+      response.status(INVALID_PAYLOAD);
+      response.json({
+        error: {
+          status: INVALID_PAYLOAD,
+          message: translate('Some products are not available')
+        }
+      });
+      return;
+    }
+    // Map the grouped items to include product_id
+    products.forEach((product) => {
+      const item = groupedItems.find((i) => i.sku === product.sku);
+      item.product_id = product.product_id;
+    });
     // Loop through the grouped items and add them to the cart
     const cartItems = await Promise.all(
       groupedItems.map(async (item) => {
-        const cartItem = await cart.addItem(item.sku, item.qty);
+        const cartItem = await cart.addItem(item.product_id, item.qty);
         return cartItem;
       })
     );
@@ -80,7 +106,6 @@ module.exports = async (request, response, delegate, next) => {
     };
     next();
   } catch (e) {
-    error(e);
     response.status(INTERNAL_SERVER_ERROR);
     response.json({
       error: {

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/bootstrap.js

@@ -8,6 +8,11 @@ const {
 const {
   registerCartItemBaseFields
 } = require('./services/cart/registerCartItemBaseFields');
+const {
+  getProductsBaseQuery
+} = require('../catalog/services/getProductsBaseQuery');
+const { pool } = require('../../lib/postgres/connection');
+const { merge } = require('../../lib/util/merge');
 
 module.exports = () => {
   addProcessor('cartFields', registerCartBaseFields, 0);
@@ -33,4 +38,26 @@ module.exports = () => {
       throw e;
     }
   });
+
+  addProcessor('cartItemProductLoaderFunction', () => async (id) => {
+    const productQuery = getProductsBaseQuery();
+    const product = await productQuery.where('product_id', '=', id).load(pool);
+    return product;
+  });
+
+  addProcessor('configuratonSchema', (schema) => {
+    merge(schema, {
+      properties: {
+        checkout: {
+          type: 'object',
+          properties: {
+            showShippingNote: {
+              type: 'boolean'
+            }
+          }
+        }
+      }
+    });
+    return schema;
+  });
 };

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

@@ -15,9 +15,12 @@ interface ShoppingCart {
   shippingFeeInclTax: Price!
   discountAmount: Price!
   subTotal: Price!
+  subTotalWithDiscount: Price!
+  subTotalWithDiscountInclTax: Price!
   totalQty: Int!
   totalWeight: Weight!
   taxAmount: Price!
+  taxAmountBeforeDiscount: Price!
   grandTotal: Price!
   shippingMethod: String
   shippingMethodName: String
@@ -44,8 +47,12 @@ interface ShoppingCartItem {
   finalPriceInclTax: Price!
   taxPercent: Float!
   taxAmount: Price!
+  taxAmountBeforeDiscount: Price!
   discountAmount: Price!
-  total: Price!
+  lineTotal: Price!
+  lineTotalWithDiscount: Price!
+  lineTotalWithDiscountInclTax: Price!
+  lineTotalInclTax: Price!
   variantGroupId: Int
   variantOptions: String
   productCustomOptions: String
@@ -90,6 +97,7 @@ type CartItem implements ShoppingCartItem {
   uuid: String!
   cartId: ID!
   removeApi: String!
+  updateQtyApi: String!
   productId: ID!
   productSku: String!
   productName: String
@@ -102,9 +110,14 @@ type CartItem implements ShoppingCartItem {
   finalPriceInclTax: Price!
   taxPercent: Float!
   taxAmount: Price!
+  taxAmountBeforeDiscount: Price!
   discountAmount: Price!
-  subTotal: Price!
-  total: Price!
+  lineTotal: Price!
+  subTotal: Price! # Deprecated, this field is equivalent to lineTotal
+  lineTotalWithDiscount: Price!
+  lineTotalWithDiscountInclTax: Price!
+  lineTotalInclTax: Price!
+  total: Price! # Deprecated, this field is equivalent to lineTotalInclTax
   variantGroupId: Int
   variantOptions: String
   productCustomOptions: String
@@ -132,12 +145,17 @@ type Cart implements ShoppingCart {
   coupon: String
   shippingFeeExclTax: Price!
   shippingFeeInclTax: Price!
+  shippingTaxAmount: Price!
   discountAmount: Price!
   subTotal: Price!
   subTotalInclTax: Price!
+  subTotalWithDiscount: Price!
+  subTotalWithDiscountInclTax: Price!
   totalQty: Int!
   totalWeight: Weight!
   taxAmount: Price!
+  taxAmountBeforeDiscount: Price!
+  totalTaxAmount: Price!
   grandTotal: Price!
   shippingMethod: String
   shippingMethodName: String
@@ -149,6 +167,7 @@ type Cart implements ShoppingCart {
   addShippingMethodApi: String!
   addContactInfoApi: String!
   addAddressApi: String!
+  addNoteApi: String!
 }
 
 extend type Query {

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

@@ -19,7 +19,14 @@ module.exports = {
       const items = cart.items || [];
       return items.map((item) => ({
         ...camelCase(item),
-        removeApi: buildUrl('removeMineCartItem', { item_id: item.uuid })
+        removeApi: buildUrl('removeCartItem', {
+          item_id: item.uuid,
+          cart_id: cart.uuid
+        }),
+        updateQtyApi: buildUrl('updateCartItemQty', {
+          cart_id: cart.uuid,
+          item_id: item.uuid
+        })
       }));
     },
     shippingAddress: async ({ shippingAddressId }, _, { pool }) => {
@@ -43,6 +50,15 @@ module.exports = {
       buildUrl('addCartShippingMethod', { cart_id: cart.uuid }),
     addContactInfoApi: (cart) =>
       buildUrl('addCartContactInfo', { cart_id: cart.uuid }),
-    addAddressApi: (cart) => buildUrl('addCartAddress', { cart_id: cart.uuid })
+    addAddressApi: (cart) => buildUrl('addCartAddress', { cart_id: cart.uuid }),
+    addNoteApi: (cart) => buildUrl('addShippingNote', { cart_id: cart.uuid })
+  },
+  CartItem: {
+    total: ({ lineTotalInclTax }) =>
+      // This field is deprecated, use lineTotalInclTax instead
+      lineTotalInclTax,
+    subTotal: ({ lineTotal }) =>
+      // This field is deprecated, use lineTotal instead
+      lineTotal
   }
 };

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

@@ -0,0 +1,3 @@
+extend type Setting {
+  showShippingNote: Boolean
+}

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

@@ -0,0 +1,7 @@
+const { getConfig } = require('@evershop/evershop/src/lib/util/getConfig');
+
+module.exports = {
+  Setting: {
+    showShippingNote: () => getConfig('checkout.showShippingNote', true)
+  }
+};