@nuskin/ns-product-lib 2.7.0-cx24-3702.6 → 2.7.0-cx24-3702.7

package/CHANGELOG.md

@@ -1,3 +1,45 @@
+# [2.7.0-cx24-3702.7](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.7.0-cx24-3702.6...v2.7.0-cx24-3702.7) (2023-04-03)
+
+
+### New
+
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([d1094e0](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/d1094e0dbaf0f64f34650500094d952255b9979b)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([9024499](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/9024499db81b4d73f0c013404d57bbd58c05ce9f)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([e1f51c4](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/e1f51c4b427c3f2b82de92c355c41f5d2bbcc4ba)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([4d58678](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/4d58678e861447d24a87693a3f3b979943e0b656)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([a424d30](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/a424d3087d331dd83b3445ac1083b6529992cea9)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([58e4cee](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/58e4cee8f68939b838f0609f85bf40eff29d6971)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([bb7a0ce](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/bb7a0ce35c4d3c3ad3f9426ca44df1f3ce682b21)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([eccd473](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/eccd473d3f5d4197f8ebefa40c4c117f1875abe9)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([abb1dc8](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/abb1dc857554593de9ff47a3b13b9616211e6624)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([9a676d9](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/9a676d94f52622035f78e1f508bfa006b28911a8)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([6eefd88](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/6eefd88adb1c039b6864d1c19606e42c47b4cb94)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([1d733f9](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/1d733f9f2c4b59e4d851836a4c544c4445b75c83)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([ae00507](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/ae00507b78872a8585b73fe8b3123b8271f95f01)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([73fdf79](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/73fdf79edf1c2aab894d5572409c77c02e89455d)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([9f78445](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/9f78445c414a84d031de2cdc17cbeefef3a7d9ee)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([451729a](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/451729a2293af27f4c82094fa723ed93ae53f2e2)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([34db83a](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/34db83a117e111ef8da046e2caa976093ba4fe3b)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([3842d97](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/3842d97115374ca66ca6078bd5926f8490bb4df3)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([e10b59e](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/e10b59e07a31e3003af780ac1743880fb318b8f9)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([9f877d6](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/9f877d6952782346ffe064aa204a3af916bd0be9)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([6e86abd](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/6e86abd352d363b63508c46484974f0180813b67)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([ec62b77](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/ec62b779549effda493f23aada23d4be3bc0e4e0)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([30aa6d4](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/30aa6d4dcef2c35e643184fe9bff3ce9c3d667d0)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([260338f](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/260338f51daedbd19c1b4ed9b45b60e6a3b01651)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([0f2f90c](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/0f2f90ceb309bb26fcd5ca177d9c984cf78d2f2e)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([6e249e5](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/6e249e522ef1222fcbf57e1f03aca7cac7463c19)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([ce1ff2d](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/ce1ff2d5f06a68f7321f97f75b5604bcff5727b5)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([8dda5f5](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/8dda5f531a06d549563b5c13855e8ceadddebfd7)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([138d119](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/138d1198ed24367702f80579e64b76754cb5e633)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([f002b19](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/f002b1933941fc58e6be2b729064cc39e6c6fc1f)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([9ad765d](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/9ad765de73518c3f8369959921156c71faa050b1)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([67ab153](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/67ab153d076e20820800bec0e608e4e41652d743)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+
+### Update
+
+* Merge CX24-3682 into CX24-3702 ([3421235](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/342123505aceb09de5645fbf638ee93cf62c1c7f))
+
 # [2.7.0-cx24-3702.6](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.7.0-cx24-3702.5...v2.7.0-cx24-3702.6) (2023-04-03)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuskin/ns-product-lib",
-  "version": "2.7.0-cx24-3702.6",
+  "version": "2.7.0-cx24-3702.7",
   "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

@@ -2,7 +2,7 @@
  * childSKU maps a product variant. Used mainly in subscription.
  *
  * @param {import('.').KitSKUQuantity[]} kits 
- * @param {import('.').EquinoxProduct} product 
+ * @param {import('.').EquinoxNormalProduct} product 
  */
 function childSKU(kits, product) {
   const sku = product.sku.filter(sku => sku.default)[0];

package/src/equinox-helpers/index.js

@@ -4,7 +4,9 @@
  * @type {object}
  * @property {ProductChildSku[]} childSkus
  * @property {Inventory} [inventoryProperties]
- *
+ */
+
+/**
  * @typedef ProductChildSku
  * @type {object}
  * @property {string} productId
@@ -13,43 +15,183 @@
  * @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
- *
- * ---
- *
+ */
+
+/**
+ * @description This model represents the error response.
+ * @typedef EquinoxErrorResponse
+ * @type {object}
+ * @property {string} code e.g., SFOSER002
+ * @property {string} message e.g., No Results Found dot Search Term  null
+ * @property {number} timestamp e.g., 1679715447962
+ */
+
+/**
+ * @description This model represents the response.
+ * @typedef EquinoxResponse
+ * @type {object}
+ * @property {EquinoxNormalProduct[]} product
+ */
+
+/**
+ * @description EquinoxNormalProduct represents an equinox Normal product type.
+ * @typedef EquinoxNormalProduct
+ * @type {object}
+ * @property {string} identifier e.g., Normal - "blt8b757df6dcaa199c" | Kit - "02001076"
+ * @property {EquinoxProductProperties} properties
+ * @property {EquinoxProductVariant[]} sku or varaints - available only when product is a normal product.
+ * @property {boolean} [exists] indicates whethere the SKU exists or not (HTTP 404) e.g., false
+ */
+
+/**
+ * @description EquinoxKitProduct represents an equinox Kit product type.
+ * @typedef EquinoxKitProduct
+ * @type {object}
+ * @property {"kit"|"bundle"} [type] available only when product is type of kit.
+ */
+
+/**
+ * @typedef {(
+ *  EquinoxProductCommonProperties & EquinoxNormalProductProperties
+ * )} EquinoxProductProperties
+ */
+
+/**
+ * @description These are the properties unique to Normal product type.
+ * @typedef EquinoxNormalProductProperties
+ * @type {object}
+ * @property {string} [ingredients]
+ * @property {string} [benefits]
+ * @property {string} [usage]
+ * @property {string} [resources]
+ * @property {string} [scanQualifiedCount] e.g., "0"
+ * @property {string} [status] e.g., "active"
+ * @property {string} [size] e.g., "30 mL / 1 fl.oz"
+ * @property {string} [productDetailsDescription] e.g., "[]"
+ */
+
+/**
+ * @description These are the properties unique to Kit product type.
+ * @typedef EquinoxKitProductProperties
+ * @type {object}
+ * @property {string} [skukits] e.g., "02002145~1,02002146~1,02002147~1,02002148~1,02002142~1,02002143~1"
+ * @property {string} [productStatus] e.g., "Sellable"
+ * @property {string} [availableChannels] e.g., "subscription,arsPhone,kiosk,mobile,web"
+ * @property {string} [market] e.g., "CA"
+ */
+
+/**
+ * @description These are the common properties between Normal and Kit product types
+ * @typedef EquinoxProductCommonProperties
+ * @type {object}
+ * @property {string} [name] e.g., "180° Cell Renewal Fluid"
+ * @property {string} [imageURL] e.g., "https://nuskin.com/content/dam/global/...ule-refreshed.jpg"
+ * @property {string} [description] e.g., "180° Ampoule"
+ * @property {string} [customerTypes] e.g., "BrandAffiliate,Preferred,Retail"
+ * @property {string} [division] e.g., "Nu Skin"
+ */
+
+/**
+ * @typedef EquinoxProductVariant
+ * @type {object}
+ * @property {string} [identifier] e.g., "02002145"
+ * @property {string} [inventory] e.g., "IN STOCK"
+ * @property {EquinoxProductVariantProperties} [properties]
+ * @property {any[]} [promotion] e.g., ???
+ * @property {EquinoxProductPriceFacets} [priceFacets]
+ * @property {EquinoxProductInventoryProperties} [inventoryProperties]
+ * @property {EquinxProductTotalValue} [totalValue]
+ * @property {boolean} [default] For multi-variant products, this indicates that this is the searched SKU
+ *  when using catalogs/search endpoint.
+ */
+
+/**
+ * @description This does not contain the full list of properties from the response.
+ * @typedef EquinoxProductVariantProperties
+ * @type {object}
+ * @property {string} [availableChannels] e.g., "subscription,arsPhone,kiosk,mobile,web"
+ * @property {string} [imageURL] e.g., "https://nuskin.com/cont...21/ca-180-Ampoule-refreshed.jpg"
+ * @property {string} [name] e.g., "180° Cell Renewal Fluid"
+ * @property {string} [market] e.g., "CA"
+ * @property {string} [description] e.g., "180° Ampoule"
+ * @property {string} [ingredients]
+ * @property {string} [benefits]
+ * @property {string} [usage]
+ * @property {string} [resources]
+ * @property {string} [scanQualifiedCount] e.g., "0"
+ * @property {string} [customerTypes] e.g., "BrandAffiliate,Preferred,Retail"
+ * @property {string} [division] e.g., "Nu Skin"
+ * @property {string} [status] e.g., "active"
+ * @property {string} [size] e.g., "30 mL / 1 fl.oz"
+ * @property {string} [globalProductId]
+ * @property {string} [excludeFromSearch]
+ * @property {string} [chargeShipping]
+ * @property {string} [title]
+ * @property {string} [productStatus] e.g., "Sellable"
+ * @property {string} [variantLabel]
+ * @property {string} [isExclusive] e.g., "false" - Why is this a string??
+ */
+
+/**
+ * @description Why are properties not camelCase and type of string instead of number? Super weird!
+ * @typedef EquinoxProductPriceFacets
+ * @type {object}
+ * @property {string} CV e.g., "76.0"
+ * @property {string} Regular Price e.g., "76.0"
+ * @property {string} PV e.g., "54.15"
+ * @property {string} Wholesale Price e.g., "88.0"
+ * @property {string} SB e.g., "4.25"
+ */
+
+/**
+ * @description
+ * @typedef EquinoxProductInventoryProperties
+ * @type {object}
+ * @property {boolean} [available] e.g., true
+ * @property {boolean} [lowStock] e.g., false
+ * @property {string} [binName] e.g., "1046_CA01"
+ * @property {boolean} [backOrdered] e.g., false
+ * @property {number} [expectedBackOrderAvailabilityDate] e.g., 0
+ * @property {boolean} [preOrdered] e.g., false
+ * @property {number} [expectedPreOrderAvailabilityDate] e.g., 0
+ * @property {number} [atpQty] e.g., 49882
+ * @property {number} [preOrderedQty] e.g., 0
+ * @property {number} [backOrderedQty] e.g., 0
+ * @property {number|null} [lowStockThreshold] e.g., null
+ * @property {number|null} [outOfStockThreshold] e.g., null
+ */
+
+/**
+ * @description
+ * @typedef EquinxProductTotalValue
+ * @type {object}
+ * @property {number} priceAfterDiscount e.g., 2
+ * @property {number} originalPrice e.g., 2
+ * @property {number} totaldiscount e.g., 0
+ * @property {{
+ *  CV: { CV: number },
+ *  "Regular Price": {
+ *    "Regular Price": number
+ *  },
+ *  PV: { PV: number },
+ *  "Wholesale Price": {
+ *    "Wholesale Price": number
+ *  },
+ *  SB: { SB: number },
+ * }} priceFacets
+ */
+
+/**
  * Standalone types. These are types not related to Product
  * and Equinox Product models.
- *
  * @typedef KitSKUQuantity
  * @type {object}
  * @property {string} sku

package/src/equinox-helpers/interceptors/index.js

@@ -0,0 +1,5 @@
+const productNotFoundInterceptor = require('./productNotFound');
+
+module.exports = {
+  productNotFoundInterceptor
+}

package/src/equinox-helpers/interceptors/productNotFound.js

@@ -0,0 +1,72 @@
+const { getCachedConfiguration } = require('@nuskin/configuration-sdk');
+const { productNotFound } = require('../models');
+
+// httpStatus codes
+const httpStatus = { notFound: 404 };
+
+/**
+ * productNotFoundInterceptor returns a model "ProductNotFound" when the status code is Not Found.
+ * Note: Do not polute this file. Create a new file for new interceptor.
+ * 
+ * @param {import('axios').AxiosError} error 
+ * @returns {import('axios').AxiosResponse<import('../').EquinoxResponse>}
+*/
+function productNotFoundInterceptor(error) {
+  const segments = 'catalogs/search';
+  const { config, response } = error;
+
+  if (response.status === httpStatus.notFound && config.url.includes(segments)) {
+    const params = new URLSearchParams(config.url);
+    const filterParam = Array.from(params.values())[0];
+    const sku = getSKU(filterParam);
+
+    if (sku !== null) {
+      const market = getCachedConfiguration('Equinox_Markets').country_code;
+      const response = {
+        ...error.response,
+        data: {
+          product: [
+            productNotFound({ identifier: sku, exists: false }, market)
+          ]
+        },
+        statusText: getStatusText(error.response)
+      };
+
+      return response;
+    }
+
+    console.error('Unable to detect SKU from the given parameter', filterParam);
+  }
+
+  return Promise.reject(error);
+}
+
+/**
+ * getSKU returns the SKU from the given parameter.
+ * @param {string} param '\\''index_key_productId="02010489" OR index_key_skuId="02010489"'''
+ * @returns {string|null} SKU 
+ */
+function getSKU(param) {
+  const result = param.match(/\d{8}/);
+
+  if (result === null) {
+    return null;
+  }
+
+  return result[0];
+}
+
+/**
+ * @param {import('axios').AxiosResponse<import('../').EquinoxErrorResponse>} [response] 
+ * @returns {string}
+ */
+function getStatusText(response) {
+  if (response) {
+    const { code, message, timestamp } = response.data;
+    return `Floating product found -- ${timestamp} ${code}: ${message}`;
+  }
+
+  return '';
+}
+
+module.exports = productNotFoundInterceptor;

package/src/equinox-helpers/mappers/identifier.js

@@ -0,0 +1,13 @@
+/**
+ * @param {string|undefined} identifier 
+ * @returns {string}
+ */
+function mapIdentifier(identifier) {
+  if (identifier) {
+    return identifier;
+  }
+
+  return '';
+}
+
+module.exports = mapIdentifier;

package/src/equinox-helpers/mappers/index.js

@@ -0,0 +1,13 @@
+const mapIdentifier = require('./identifier');
+const mapInventoryProperties = require('./inventoryProperties');
+const mapProperties = require('./properties');
+const mapVariant = require('./variant');
+const mapVariantProperties = require('./variantProperties');
+
+module.exports = {
+  mapIdentifier,
+  mapInventoryProperties,
+  mapProperties,
+  mapVariant,
+  mapVariantProperties
+};

package/src/equinox-helpers/mappers/inventoryProperties.js

@@ -0,0 +1,173 @@
+// @ts-check
+
+/**
+ * @param {import('../').EquinoxProductInventoryProperties} inventoryProperties 
+ */
+function mapInventoryProperties(inventoryProperties = {}) {
+  /** @type {import('../').EquinoxProductInventoryProperties} */
+  const model = {};
+  model.available = mapAvailable(inventoryProperties.available);
+  model.lowStock = mapLowStock(inventoryProperties.lowStock);
+  model.binName = mapBinName(inventoryProperties.binName);
+  model.backOrdered = mapBackOrdered(inventoryProperties.backOrdered);
+  model.expectedBackOrderAvailabilityDate = mapExpectedBackOrderAvailabilityDate(
+    inventoryProperties.expectedBackOrderAvailabilityDate
+  );
+  model.preOrdered = mapPreOrdered(inventoryProperties.preOrdered);
+  model.expectedPreOrderAvailabilityDate = mapExpectedPreOrderAvailabilityDate(
+    inventoryProperties.expectedPreOrderAvailabilityDate
+  );
+  model.atpQty = mapAtpQty(inventoryProperties.atpQty);
+  model.preOrderedQty = mapPreOrderedQty(inventoryProperties.preOrderedQty);
+  model.backOrderedQty = mapBackOrderedQty(inventoryProperties.backOrderedQty);
+  model.lowStockThreshold = mapLowStockThreshold(inventoryProperties.lowStockThreshold);
+  model.outOfStockThreshold = mapOutOfStockThreshold(inventoryProperties.outOfStockThreshold);
+
+  return model;
+}
+
+/**
+ * @param {boolean|undefined} available
+ * @returns {boolean}
+ */
+function mapAvailable(available) {
+  if (available) {
+    return available;
+  }
+
+  return false;
+}
+
+/**
+ * @param {boolean|undefined} lowStock
+ * @returns {boolean}
+ */
+function mapLowStock(lowStock) {
+  if (lowStock) {
+    return lowStock;
+  }
+
+  return false;
+}
+
+/**
+ * @param {string|undefined} binName
+ * @returns {string}
+ */
+function mapBinName(binName) {
+  if (binName) {
+    return binName;
+  }
+
+  return '';
+}
+
+/**
+ * @param {boolean|undefined} backOrdered
+ * @returns {boolean}
+ */
+function mapBackOrdered(backOrdered) {
+  if (backOrdered) {
+    return backOrdered;
+  }
+
+  return false;
+}
+
+/**
+ * @param {number|undefined} expectedBackOrderAvailabilityDate
+ * @returns {number}
+ */
+function mapExpectedBackOrderAvailabilityDate(expectedBackOrderAvailabilityDate) {
+  if (expectedBackOrderAvailabilityDate) {
+    return expectedBackOrderAvailabilityDate;
+  }
+
+  return 0;
+}
+
+/**
+ * @param {boolean|undefined} preOrdered
+ * @returns {boolean}
+ */
+function mapPreOrdered(preOrdered) {
+  if (preOrdered) {
+    return preOrdered;
+  }
+
+  return false;
+}
+
+/**
+ * @param {number|undefined} expectedPreOrderAvailabilityDate
+ * @returns {number}
+ */
+function mapExpectedPreOrderAvailabilityDate(expectedPreOrderAvailabilityDate) {
+  if (expectedPreOrderAvailabilityDate) {
+    return expectedPreOrderAvailabilityDate;
+  }
+
+  return 0;
+}
+
+/**
+ * @param {number|undefined} atpQty
+ * @returns {number}
+ */
+function mapAtpQty(atpQty) {
+  if (atpQty) {
+    return atpQty;
+  }
+
+  return 0;
+}
+
+/**
+ * @param {number|undefined} preOrderedQty
+ * @returns {number}
+ */
+function mapPreOrderedQty(preOrderedQty) {
+  if (preOrderedQty) {
+    return preOrderedQty;
+  }
+
+  return 0;
+}
+
+/**
+ * @param {number|undefined} backOrderedQty
+ * @returns {number}
+ */
+function mapBackOrderedQty(backOrderedQty) {
+  if (backOrderedQty) {
+    return backOrderedQty;
+  }
+
+  return 0;
+}
+
+/**
+ * @param {number|null|undefined} lowStockThreshold
+ * @returns {number|null}
+ */
+function mapLowStockThreshold(lowStockThreshold) {
+  if (lowStockThreshold) {
+    return lowStockThreshold;
+  }
+
+  return null;
+}
+
+/**
+ * @param {number|null|undefined} outOfStockThreshold
+ * @returns {number|null}
+ */
+function mapOutOfStockThreshold(outOfStockThreshold) {
+  if (outOfStockThreshold) {
+    return outOfStockThreshold;
+  }
+
+  return null;
+}
+
+module.exports = mapInventoryProperties;

package/src/equinox-helpers/mappers/properties.js

@@ -0,0 +1,169 @@
+// @ts-check
+/**
+ * mapProperties maps the properties of a product.
+ * @param {import('../').EquinoxProductProperties} props
+ */
+function mapProperties(props = {}) {
+  /** @type {import('../').EquinoxProductProperties} */
+  const properties = {};
+  properties.name = mapName(props.name);
+  properties.description = mapDescription(props.description);
+  properties.productDetailsDescription = mapProductDetailsDescription(props.productDetailsDescription);
+  properties.ingredients = mapIngredients(props.ingredients);
+  properties.benefits = mapBenefits(props.benefits);
+  properties.usage = mapUsage(props.usage);
+  properties.scanQualifiedCount = mapScanQualifiedCount(props.scanQualifiedCount);
+  properties.division = mapDivision(props.division);
+  properties.imageURL = mapImageURL(props.imageURL);
+  properties.resources = mapResources(props.resources);
+  properties.customerTypes = mapCustomerTypes(props.customerTypes);
+  properties.size = mapSize(props.size);
+
+  return properties;
+}
+
+/**
+ * @param {string|undefined} name 
+ * @returns {string}
+ */
+function mapName(name) {
+  if (name) {
+    return name;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} description 
+ * @returns {string}
+ */
+function mapDescription(description) {
+  if (description) {
+    return description;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} productDetailsDescription 
+ * @returns {string}
+ */
+function mapProductDetailsDescription(productDetailsDescription) {
+  if (productDetailsDescription) {
+    return productDetailsDescription;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} ingredients 
+ * @returns {string}
+ */
+function mapIngredients(ingredients) {
+  if (ingredients) {
+    return ingredients;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} benefits 
+ * @returns {string}
+ */
+function mapBenefits(benefits) {
+  if (benefits) {
+    return benefits;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} usage 
+ * @returns {string}
+ */
+function mapUsage(usage) {
+  if (usage) {
+    return usage;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} scanQualifiedCount 
+ * @returns {string}
+ */
+function mapScanQualifiedCount(scanQualifiedCount) {
+  if (scanQualifiedCount) {
+    return scanQualifiedCount;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} division 
+ * @returns {string}
+ */
+function mapDivision(division) {
+  if (division) {
+    return division;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} imageURL 
+ * @returns {string}
+ */
+function mapImageURL(imageURL) {
+  if (imageURL) {
+    return imageURL;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} resources 
+ * @returns {string}
+ */
+function mapResources(resources) {
+  if (resources) {
+    return resources;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} customerTypes 
+ * @returns {string}
+ */
+function mapCustomerTypes(customerTypes) {
+  if (customerTypes) {
+    return customerTypes;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} size 
+ * @returns {string}
+ */
+function mapSize(size) {
+  if (size) {
+    return size;
+  }
+
+  return '';
+}
+
+module.exports = mapProperties;

package/src/equinox-helpers/mappers/variant.js

@@ -0,0 +1,51 @@
+// @ts-check
+const mapIdentifier = require('./identifier');
+const mapInventoryProperties = require('./inventoryProperties');
+const mapVariantProperties = require('./variantProperties');
+
+/**
+ * @param {import('../').EquinoxProductVariant} variant
+ */
+function mapVariant(variant) {
+  /** @type {import('../').EquinoxProductVariant} */
+  const model = {
+    identifier: mapIdentifier(variant.identifier),
+    inventory: '',
+    properties: mapVariantProperties(variant.properties),
+    promotion: [],
+    priceFacets: {
+      CV: '',
+      PV: '',
+      SB: '',
+      'Wholesale Price': '',
+      'Regular Price': ''
+    },
+    inventoryProperties: mapInventoryProperties(variant.inventoryProperties),
+    totalValue: {
+      originalPrice: 0,
+      priceAfterDiscount: 0,
+      priceFacets: {
+        CV: {
+          CV: 36
+        },
+        'Regular Price': {
+          'Regular Price': 52
+        },
+        PV: {
+          PV: 25.65
+        },
+        'Wholesale Price': {
+          'Wholesale Price': 42
+        },
+        SB: {
+          SB: 2
+        }
+      },
+      totaldiscount: 0
+    }
+  };
+
+  return model;
+}
+
+module.exports = mapVariant;

package/src/equinox-helpers/mappers/variantProperties.js

@@ -0,0 +1,273 @@
+// @ts-check
+
+/**
+ * @param {import('../').EquinoxProductVariantProperties} properties 
+ */
+function mapVariantProperties(properties = {}) {
+  /** @type {import('../').EquinoxProductVariantProperties} */
+  const model = {};
+  model.benefits = mapBenefits(properties.benefits);
+  model.excludeFromSearch = mapExcludeFromSearch(properties.excludeFromSearch);
+  model.usage = mapUsage(properties.usage);
+  model.description = mapDescription(properties.description);
+  model.chargeShipping = mapChargeShipping(properties.chargeShipping);
+  model.globalProductId = mapGlobalProductId(properties.globalProductId);
+  model.title = mapTitle(properties.title);
+  model.scanQualifiedCount = mapScanQualifiedCount(properties.scanQualifiedCount);
+  model.division = mapDivision(properties.division);
+  model.isExclusive = mapIsExclusive('false',);
+  model.imageURL = mapImageURL(properties.imageURL);
+  model.customerTypes = mapCustomerTypes(properties.customerTypes);
+  model.ingredients = mapIngredients(properties.ingredients);
+  model.availableChannels = mapAvailableChannels(properties.availableChannels);
+  model.resources = mapResources(properties.resources);
+  model.market = mapMarket(properties.market);
+  model.size = mapSize(properties.size);
+  model.name = mapName(properties.name);
+  model.status = mapStatus(properties.status);
+  model.productStatus = mapProductStatus(properties.productStatus);
+
+  return model;
+}
+
+/**
+ * @param {string|undefined} benefits
+ * @returns {string}
+ */
+function mapBenefits(benefits) {
+  if (benefits) {
+    return benefits;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} excludeFromSearch
+ * @returns {string}
+ */
+function mapExcludeFromSearch(excludeFromSearch) {
+  if (excludeFromSearch) {
+    return excludeFromSearch;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} usage
+ * @returns {string}
+ */
+function mapUsage(usage) {
+  if (usage) {
+    return usage;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} description
+ * @returns {string}
+ */
+function mapDescription(description) {
+  if (description) {
+    return description;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} chargeShipping
+ * @returns {string}
+ */
+function mapChargeShipping(chargeShipping) {
+  if (chargeShipping) {
+    return chargeShipping;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} globalProductId
+ * @returns {string}
+ */
+function mapGlobalProductId(globalProductId) {
+  if (globalProductId) {
+    return globalProductId;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} title
+ * @returns {string}
+ */
+function mapTitle(title) {
+  if (title) {
+    return title;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} scanQualifiedCount
+ * @returns {string}
+ */
+function mapScanQualifiedCount(scanQualifiedCount) {
+  if (scanQualifiedCount) {
+    return scanQualifiedCount;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} division
+ * @returns {string}
+ */
+function mapDivision(division) {
+  if (division) {
+    return division;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} isExclusive
+ * @returns {string}
+ */
+function mapIsExclusive(isExclusive) {
+  if (isExclusive) {
+    return isExclusive;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} imageURL
+ * @returns {string}
+ */
+function mapImageURL(imageURL) {
+  if (imageURL) {
+    return imageURL;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} customerTypes
+ * @returns {string}
+ */
+function mapCustomerTypes(customerTypes) {
+  if (customerTypes) {
+    return customerTypes;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} ingredients
+ * @returns {string}
+ */
+function mapIngredients(ingredients) {
+  if (ingredients) {
+    return ingredients;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} availableChannels
+ * @returns {string}
+ */
+function mapAvailableChannels(availableChannels) {
+  if (availableChannels) {
+    return availableChannels;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} resources
+ * @returns {string}
+ */
+function mapResources(resources) {
+  if (resources) {
+    return resources;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} market
+ * @returns {string}
+ */
+function mapMarket(market) {
+  if (market) {
+    return market;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} size
+ * @returns {string}
+ */
+function mapSize(size) {
+  if (size) {
+    return size;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} name
+ * @returns {string}
+ */
+function mapName(name) {
+  if (name) {
+    return name;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} status
+ * @returns {string}
+ */
+function mapStatus(status) {
+  if (status) {
+    return status;
+  }
+
+  return '';
+}
+
+/**
+ * @param {string|undefined} productStatus
+ * @returns {string}
+ */
+function mapProductStatus(productStatus) {
+  if (productStatus) {
+    return productStatus;
+  }
+
+  return '';
+}
+
+module.exports = mapVariantProperties;

package/src/equinox-helpers/models/index.js

@@ -0,0 +1,5 @@
+const productNotFound = require('./productNotFound');
+
+module.exports = {
+  productNotFound
+};

package/src/equinox-helpers/models/productNotFound.js

@@ -0,0 +1,48 @@
+// @ts-check
+const { mapIdentifier, mapProperties, mapVariant } = require('../mappers');
+
+/**
+ * @param {import('../').EquinoxNormalProduct} product
+ * @param {string} market
+ * @returns {import('../').EquinoxNormalProduct}
+ */
+function productNotFound(product, market) {
+  /** @type {import('../').EquinoxNormalProduct} */
+  const model = {};
+  model.identifier = mapIdentifier(` ${product.identifier}`);
+  model.properties = mapProperties();
+  model.exists = mapExists(product.exists);
+  model.sku = [mapVariant({
+    // adding a whitespace allows us to display an SKU with 55
+    // without initializing the variant selector of ns-product-small
+    identifier: ` ${product.identifier}`,
+    properties: {
+      availableChannels: 'subscription,arsPhone,kiosk,mobile,web',
+      customerTypes: 'BrandAffiliate,Preferred,Retail',
+      description: 'not-found',
+      imageURL: 'https://nuskin.com/content/dam/global/images/products/01102730-nu-skin-tri-phasic-white-essence.png',
+      isExclusive: 'false',
+      market,
+      name: ` ${product.identifier}`,
+      productStatus: 'stopped',
+      scanQualifiedCount: '0',
+      status: 'active',
+      title: ` ${product.identifier}`
+    }
+  })];
+
+  return model;
+}
+
+/**
+ * @param {boolean|undefined} exists 
+ */
+function mapExists(exists) {
+  if (exists === undefined) {
+    return true;
+  }
+
+  return exists;
+}
+
+module.exports = productNotFound;

package/src/product.js

@@ -75,8 +75,15 @@ const Product = function (productData) {
   //equinox inventory / stock label
   //@example "IN STOCK"
   this.inventory = "";
+  
+  // equinox specific properties
   this.equinoxProductId = "";
   this.properties = {};
+  this.equinox = {
+    sku: {
+      exists: true
+    }
+  };
 
   this.setMarketAttributes = function (productStatus) {
     if (productStatus.marketAttributes) {
@@ -540,6 +547,11 @@ const Product = function (productData) {
     retData.inventory = this.inventory;
     retData.equinoxProductId = this.equinoxProductId;
     retData.properties = this.properties;
+    retData.equinox = {
+      sku: {
+        exists: this.equinox.sku.exists
+      }
+    };
 
     return retData;
   };
@@ -682,6 +694,14 @@ const Product = function (productData) {
 
       this.equinoxProductId = data.equinoxProductId;
       this.properties = data.properties;
+
+      if (data.equinox && data.equinox.sku) {
+        this.equinox = {
+          sku: {
+            exists: data.equinox.sku.exists
+          }
+        };
+      }
     }
   };
 

package/src/productData.js

@@ -6,6 +6,7 @@ const Product = require("./product");
 const CustomerTypes = require('./models/customerTypes');
 const ProductStatus = require("./models/productStatus");
 const { mapAvailableQuantity, mapChildSKU } = require('./equinox-helpers');
+const { productNotFoundInterceptor } = require('./equinox-helpers/interceptors');
 
 const productTypes = {
   kit: 'kit'
@@ -69,6 +70,7 @@ const ProductData = {
 
     const url = `${config.API_Base_URLs}/orchestrationservices/storefront/catalogs/search/`;
     const href = `${url}?filter='\\\\''${encodeURI(filter)}'\\''`;
+    axios.interceptors.response.use((res) => res, productNotFoundInterceptor);
     const response = await axios.request({
       method: 'get',
       url: href,
@@ -81,6 +83,7 @@ const ProductData = {
       withCredentials: true
     });
 
+    axios.interceptors.response.eject(productNotFoundInterceptor);
     return response;
   },
 
@@ -478,7 +481,12 @@ const ProductData = {
           "addOns": [],
           "inventory": product.inventory || "", //inventory label
           "equinoxProductId": productData.identifier,
-          "properties": product.properties
+          "properties": product.properties,
+          equinox: {
+            sku: {
+              exists: this.mapEquinoxSKUExists(productData.exists)
+            }
+          }
         };
 
         products.push(new Product(product));
@@ -502,6 +510,17 @@ const ProductData = {
     };
   },
 
+  mapEquinoxSKUExists: function(exists) {
+    // this could be avoided if only we are using response mapper
+    // for equinox products that exists.
+    // @todo: clean-up
+    if (exists === undefined) {
+      return true;
+    }
+
+    return exists;
+  },
+
   /**
    * fetchChildSkus make requests to Equinox to get the SKUs of a kit.
    * @param {*} product