@nuskin/ns-product-lib 2.6.1-cx24-3608.5 → 2.6.1-cx24-3607.2

package/CHANGELOG.md

@@ -1,41 +1,17 @@
-## [2.6.1-cx24-3608.5](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.6.1-cx24-3608.4...v2.6.1-cx24-3608.5) (2023-03-15)
+## [2.6.1-cx24-3607.2](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.6.1-cx24-3607.1...v2.6.1-cx24-3607.2) (2023-03-16)
 
 
 ### Fix
 
-* imageURL issue when product is kit ([9ccb840](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/9ccb8403d2217d0e20107c560d9fa797c9bbbb95))
-* imageURL issue when product is kit ([38eabd3](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/38eabd3b29d8b33462509c17e98805819781f344))
-* imageURL issue when product is kit ([5eb2c04](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/5eb2c0439b6e1a456a2c9f232f3d7f502ea46e4b))
+* (equinox-enabled) skip product mapping when an error occurs in PLP #CX24-3607 ([49fa749](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/49fa7499b390aa84cc887fc631037363421d252a)), closes [#CX24-3607](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3607)
 
-## [2.6.1-cx24-3608.4](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.6.1-cx24-3608.3...v2.6.1-cx24-3608.4) (2023-03-15)
+## [2.6.1-cx24-3607.1](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.6.0...v2.6.1-cx24-3607.1) (2023-03-15)
 
 
 ### Fix
 
-* imageURL issue when product is kit ([0bde1fb](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/0bde1fb0ce99186a30859c2f3509d32c1861cf7b))
-* imageURL issue when product is kit ([e302726](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/e30272648ad6214c0dca08f40a6a3f5511c661cd))
-
-## [2.6.1-cx24-3608.3](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.6.1-cx24-3608.2...v2.6.1-cx24-3608.3) (2023-03-15)
-
-
-### Fix
-
-* imageURL issue when product is kit ([0e4281d](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/0e4281de4435d1a5749ff9b6d52a7c4a45d75d6d))
-
-## [2.6.1-cx24-3608.2](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.6.1-cx24-3608.1...v2.6.1-cx24-3608.2) (2023-03-15)
-
-
-### Fix
-
-* imageURL issue when product is kit ([3172244](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/3172244e53c328e90d663a0989c25c25eba967d3))
-
-## [2.6.1-cx24-3608.1](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.6.0...v2.6.1-cx24-3608.1) (2023-03-15)
-
-
-### Fix
-
-* imageURL issue when product is kit ([2a68af6](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/2a68af668a2ca0835a4b0d0995117ea8ab019bed))
-* imageURL issue when product is kit ([656505a](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/656505a32421ae4e5d8e29dd451b68b24e72f30d))
+* (equinox-enabled) skip product mapping when an error occurs in PLP #CX24-3607 ([950c165](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/950c1650115f92badc5b898b5df722568b034afe)), closes [#CX24-3607](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3607)
+* Cannot read properties of undefined (reading 'qty') in PLP #CX24-3607 ([8cde88f](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/8cde88f2f61279d20794a0e43696187c4326ca28)), closes [#CX24-3607](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3607)
 
 # [2.6.0](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.5.2...v2.6.0) (2023-03-13)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuskin/ns-product-lib",
-  "version": "2.6.1-cx24-3608.5",
+  "version": "2.6.1-cx24-3607.2",
   "description": "This project contains shared Product models and code between the backend and frontend.",
   "main": "src/index.js",
   "scripts": {

package/src/equinox-helpers/childSKU.js

@@ -0,0 +1,31 @@
+/**
+ * childSKU maps a product variant. Used mainly in subscription.
+ *
+ * @param {import('.').KitSKUQuantity[]} kits 
+ * @param {import('.').EquinoxProduct} product 
+ */
+function childSKU(kits, product) {
+  const sku = product.sku.filter(sku => sku.default)[0];
+  if (!sku) {
+    throw Error('Unable to find the default SKU.');
+  }
+
+  const kit = kits.filter(k => k.sku === sku.identifier)[0];
+  if (!kit) {
+    throw Error('SKU kit does not exist in the list of available variants.');
+  }
+
+  return {
+    productId: product.identifier,
+    skuId: sku.identifier,
+    type: 'MANDATORY',
+    skuQuantity: kit.qty,
+    availableChannels: sku.properties.availableChannels,
+    inventory: {
+      atpQty: sku.inventoryProperties.atpQty,
+      backOrdered: sku.inventoryProperties.backOrdered
+    }
+  }
+}
+
+module.exports = childSKU;

package/src/equinox-helpers/index.js

@@ -1,10 +1,11 @@
 /**
+ * @description This model represents the mapped values of a product
  * @typedef Product
  * @type {object}
- * @property {ChildSku[]} childSkus
+ * @property {ProductChildSku[]} childSkus
  * @property {Inventory} [inventoryProperties]
- * 
- * @typedef ChildSku
+ *
+ * @typedef ProductChildSku
  * @type {object}
  * @property {string} productId
  * @property {string} skuId
@@ -12,14 +13,52 @@
  * @property {number} skuQuantity
  * @property {string} availableChannels
  * @property {Inventory} [inventory]
+ *
+ * ---
+ *
+ * @description This model represents a product within an Equinox response.
+ * @typedef EquinoxProduct
+ * @type {object}
+ * @property {string} identifier
+ * @property {EquinoxProductSKU[]} sku
+ * @property {"kit"|"bundle"} [type]
+ *
+ * @typedef EquinoxProductSKU
+ * @type {object}
+ * @property {boolean} default
+ *  For multi-variant products, this indicates that this is the searched SKU
+ *  when using catalogs/search endpoint.
+ * @property {string} identifier
+ * @property {Inventory} inventoryProperties
+ * @property {EquinoxProductProperties} properties
+ *
+ * @typedef EquinoxProductProperties
+ * @type {object}
+ * @property {string} availableChannels
+ *
+ * ---
+ *
+ * Types common to Product model and Equinox Product model
  * 
  * @typedef Inventory
  * @type {object}
  * @property {number} atpQty
  * @property {boolean} backOrdered
+ *
+ * ---
+ *
+ * Standalone types. These are types not related to Product
+ * and Equinox Product models.
+ *
+ * @typedef KitSKUQuantity
+ * @type {object}
+ * @property {string} sku
+ * @property {number} qty
  */
 const availableQuantity = require('./availableQuantity');
+const childSKU = require('./childSKU');
 
 module.exports = {
-  mapAvailableQuantity: availableQuantity
+  mapAvailableQuantity: availableQuantity,
+  mapChildSKU: childSKU
 };

package/src/productData.js

@@ -5,7 +5,7 @@ const contentstack = require('./contentstack/contentstack');
 const Product = require("./product");
 const CustomerTypes = require('./models/customerTypes');
 const ProductStatus = require("./models/productStatus");
-const { mapAvailableQuantity } = require('./equinox-helpers');
+const { mapAvailableQuantity, mapChildSKU } = require('./equinox-helpers');
 
 const productTypes = {
   kit: 'kit'
@@ -129,8 +129,15 @@ const ProductData = {
    */
   eqProductVariantMapper: function (eqVariant) {
 
-    let imageURL = eqVariant.properties.imageURL ? eqVariant.properties.imageURL : '';
-    let thumbnailImage = (imageURL) ? imageURL + '?width=40' : ''
+    let imageURL = eqVariant.properties.imageURL;
+    const regex = /\d+\.\d+/
+    let thumbnailImage = ''
+
+    if (imageURL.includes('contentstack')) {
+      thumbnailImage = imageURL + '?width=40'
+    } else {
+      thumbnailImage = imageURL.replace(regex, '40.40')
+    }
 
     const { eventName, eventLabels, computedPrice, defaultProductPrice } = this.getEqProductPromotions(eqVariant);
     const productPrice = eventName ? defaultProductPrice : eqVariant.priceFacets["Regular Price"];
@@ -337,131 +344,142 @@ const ProductData = {
   },
 
   eqProductMapper: async function (productDataResponse, skus) {
-    // console.log(productDataResponse, skus);
     let count = 0;
     let variants = {};
     const products = [];
 
     for (const productData of productDataResponse) {
-      let product = (productData.type && productData.type === "kit") ? productData : productData.sku[count];
-      let imageURL = product.properties.imageURL ? product.properties.imageURL : '';
-      let thumbnailImage = imageURL ? imageURL + '?width=40' : ''
+      try {
+        let product = (productData.type && productData.type === "kit") ? productData : productData.sku[count];
+        let imageURL = product.properties.imageURL;
+        const regex = /\d+\.\d+/
+        let thumbnailImage = ''
+
+        if (imageURL.includes('contentstack')) {
+          thumbnailImage = imageURL + '?width=40'
+        } else {
+          thumbnailImage = imageURL.replace(regex, '40.40')
+        }
 
+        if (productData.sku && productData.sku.length > 1) {
+          // exclude base product from variants
+          productData.sku.filter(v => v.identifier.substring(2, 4) !== "55").map(variant => {
+            variants[variant.identifier] = this.eqProductVariantMapper(variant);
+            return variant;
+          });
+        }
 
-      if (productData.sku && productData.sku.length > 1) {
-        // exclude base product from variants
-        productData.sku.filter(v => v.identifier.substring(2, 4) !== "55").map(variant => {
-          variants[variant.identifier] = this.eqProductVariantMapper(variant);
-          return variant;
-        });
+        const {
+          eventName,
+          eventLabels,
+          computedPrice,
+          defaultProductPrice
+        } = this.getEqProductPromotions(product);
+        const productPrice = eventName ? defaultProductPrice : product.priceFacets["Regular Price"];
+        const discountedPrice = eventName ? computedPrice : product.priceFacets["Regular Price"];
+
+        product.childSkus = await this.fetchChildSkus(product);
+        product.availableQuantity = mapAvailableQuantity(product);
+        product = {
+          ...product,
+          "sku": product.identifier,
+          "globalProductID": productData.identifier,
+          "title": productData.properties.name,
+          "country": product.properties.market,
+          "language": "en",
+          "shortDescr": productData.properties.description,
+          "longDescr": productData.properties.productDetailsDescription,
+          "fullImage": imageURL,
+          "imageAltText": productData.properties.name,
+          "productCarouselImages": [
+            {
+              "contentType": "img",
+              "src": "/content/products/24/00/35/24003529/jcr:content/fullImage.imgw.1280.1280.png",
+              "alt": ""
+            }
+          ],
+          "thumbnail": thumbnailImage,
+          "ingredients": productData.properties.ingredients,
+          "benefits": productData.properties.benefits,
+          "usage": productData.properties.usage,
+          "resources": product.properties.resources,
+          "videos": "",
+          "movie": "",
+          "youtube": "",
+          "salesEventText": "",
+          "contentSection": [
+            {
+              "sectionContent": "<div class=\"contentSections\"></div>\n"
+            }
+          ],
+          "scanQualified": productData.properties.scanQualifiedCount,
+          "maxQuantity": 999,
+          "points": "",
+          "cv": (product.priceFacets.CV) ? product.priceFacets.CV : '',
+          "pv": product.priceFacets.PV,
+          "priceType": "WRTL",
+          "price": discountedPrice,
+          "priceMap": {
+            "WRTL": productPrice,
+            "WADW-WRTL": product.priceFacets["Regular Price"],
+            "WADR": product.priceFacets["Regular Price"],
+            "RTL": product.priceFacets["Regular Price"],
+            "WADW": product.priceFacets["Wholesale Price"],
+            "WHL": product.priceFacets["Wholesale Price"],
+            "WWHL": product.priceFacets["Wholesale Price"]
+          },
+          "cvMap": {
+            "WWHL": (product.priceFacets.CV) ? product.priceFacets.CV : '',
+            "WADW": (product.priceFacets.CV) ? product.priceFacets.CV : '',
+            "WHL": (product.priceFacets.CV) ? product.priceFacets.CV : ''
+          },
+          "pvMap": {
+            "WWHL": product.priceFacets.PV,
+            "WADW": product.priceFacets.PV,
+            "WHL": product.priceFacets.PV
+          },
+          "orderTypes": this._setOrderType(product.properties),
+          "custTypes": this.switchCustType(product.properties.customerTypes),
+          "division": productData.properties.division,
+          "backOrderDate": null,
+          "locallyProduced": false,
+          "agelocme": null,
+          "count": "",
+          "flavor": "",
+          "size": product.properties.size,
+          "shade": "",
+          "status": this.switchStatusFromEquinox(product.properties.productStatus),
+          "variantType": "Other",
+          "variantDropdownLabel": product.properties.variantLabel || "",
+          "variantDropdownPlaceholder": "Select Type",
+          "variantsLabel": product.properties.variantLabel || "",
+          "groupOffer": false,
+          "personalOffer": false,
+          "savedEventName": eventName,
+          "salesLabel": eventLabels,
+          "eventName": eventName,
+          "sizeWeight": '',
+          "nettoWeight": "",
+          "variants": variants,
+          "searchScore": 0,
+          "isExclusive": product.properties.isExclusive || false,
+          "marketAttributes": {
+            "discount": true,
+            "redeem": true,
+            "earn": true
+          },
+          "restrictedMarkets": [],
+          "addOns": [],
+          "inventory": product.inventory || "", //inventory label
+          "equinoxProductId": productData.identifier
+        };
+
+        products.push(new Product(product));
+      } catch (err) {
+        console.error('Unable to map the product', productData.identifier, ':', err);
+        console.error('Product info:', productDataResponse, skus);
+        continue;
       }
-
-      const {
-        eventName,
-        eventLabels,
-        computedPrice,
-        defaultProductPrice
-      } = this.getEqProductPromotions(product);
-      const productPrice = eventName ? defaultProductPrice : product.priceFacets["Regular Price"];
-      const discountedPrice = eventName ? computedPrice : product.priceFacets["Regular Price"];
-
-      product.childSkus = await this.fetchChildSkus(product);
-      product.availableQuantity = mapAvailableQuantity(product);
-      product = {
-        ...product,
-        "sku": product.identifier,
-        "globalProductID": productData.identifier,
-        "title": productData.properties.name,
-        "country": product.properties.market,
-        "language": "en",
-        "shortDescr": productData.properties.description,
-        "longDescr": productData.properties.productDetailsDescription,
-        "fullImage": imageURL,
-        "imageAltText": productData.properties.name,
-        "productCarouselImages": [
-          {
-            "contentType": "img",
-            "src": "/content/products/24/00/35/24003529/jcr:content/fullImage.imgw.1280.1280.png",
-            "alt": ""
-          }
-        ],
-        "thumbnail": thumbnailImage,
-        "ingredients": productData.properties.ingredients,
-        "benefits": productData.properties.benefits,
-        "usage": productData.properties.usage,
-        "resources": product.properties.resources,
-        "videos": "",
-        "movie": "",
-        "youtube": "",
-        "salesEventText": "",
-        "contentSection": [
-          {
-            "sectionContent": "<div class=\"contentSections\"></div>\n"
-          }
-        ],
-        "scanQualified": productData.properties.scanQualifiedCount,
-        "maxQuantity": 999,
-        "points": "",
-        "cv": (product.priceFacets.CV) ? product.priceFacets.CV : '',
-        "pv": product.priceFacets.PV,
-        "priceType": "WRTL",
-        "price": discountedPrice,
-        "priceMap": {
-          "WRTL": productPrice,
-          "WADW-WRTL": product.priceFacets["Regular Price"],
-          "WADR": product.priceFacets["Regular Price"],
-          "RTL": product.priceFacets["Regular Price"],
-          "WADW": product.priceFacets["Wholesale Price"],
-          "WHL": product.priceFacets["Wholesale Price"],
-          "WWHL": product.priceFacets["Wholesale Price"]
-        },
-        "cvMap": {
-          "WWHL": (product.priceFacets.CV) ? product.priceFacets.CV : '',
-          "WADW": (product.priceFacets.CV) ? product.priceFacets.CV : '',
-          "WHL": (product.priceFacets.CV) ? product.priceFacets.CV : ''
-        },
-        "pvMap": {
-          "WWHL": product.priceFacets.PV,
-          "WADW": product.priceFacets.PV,
-          "WHL": product.priceFacets.PV
-        },
-        "orderTypes": this._setOrderType(product.properties),
-        "custTypes": this.switchCustType(product.properties.customerTypes),
-        "division": productData.properties.division,
-        "backOrderDate": null,
-        "locallyProduced": false,
-        "agelocme": null,
-        "count": "",
-        "flavor": "",
-        "size": product.properties.size,
-        "shade": "",
-        "status": this.switchStatusFromEquinox(product.properties.productStatus),
-        "variantType": "Other",
-        "variantDropdownLabel": product.properties.variantLabel || "",
-        "variantDropdownPlaceholder": "Select Type",
-        "variantsLabel": product.properties.variantLabel || "",
-        "groupOffer": false,
-        "personalOffer": false,
-        "savedEventName": eventName,
-        "salesLabel": eventLabels,
-        "eventName": eventName,
-        "sizeWeight": '',
-        "nettoWeight": "",
-        "variants": variants,
-        "searchScore": 0,
-        "isExclusive": product.properties.isExclusive || false,
-        "marketAttributes": {
-          "discount": true,
-          "redeem": true,
-          "earn": true
-        },
-        "restrictedMarkets": [],
-        "addOns": [],
-        "inventory": product.inventory || "", //inventory label
-        "equinoxProductId": productData.identifier
-      };
-
-      products.push(new Product(product));
     }
 
     let data = {
@@ -504,7 +522,7 @@ const ProductData = {
           type: 'SKUKIT',
           availableChannels: product.properties.availableChannels
         },
-        ...res.data.product.map(p => this.buildChildSkus(kits, p))
+        ...res.data.product.map(p => mapChildSKU(kits, p))
       ];
 
       return childSkus;
@@ -513,23 +531,6 @@ const ProductData = {
     return [];
   },
 
-  buildChildSkus: function (kits, product) {
-    const sku = product.sku[0];
-    const kit = kits.filter(k => k.sku === sku.identifier)[0];
-
-    return {
-      productId: product.identifier,
-      skuId: sku.identifier,
-      type: 'MANDATORY',
-      skuQuantity: kit.qty,
-      availableChannels: sku.properties.availableChannels,
-      inventory: {
-        atpQty: sku.inventoryProperties.atpQty,
-        backOrdered: sku.inventoryProperties.backOrdered
-      }
-    }
-  },
-
   /**
    *
    * Map status from equinox to  legacy