@nuskin/ns-product-lib 2.7.0-cx24-3682.7 → 2.7.0-cx24-3682.9

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [2.7.0-cx24-3682.9](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.7.0-cx24-3682.8...v2.7.0-cx24-3682.9) (2023-03-26)
+
+
+### New
+
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([66c977b](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/66c977b3114e0cd7517d6eaa19174b0a3a13d1ed)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+
+# [2.7.0-cx24-3682.8](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.7.0-cx24-3682.7...v2.7.0-cx24-3682.8) (2023-03-26)
+
+
+### New
+
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([3d69bbe](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/3d69bbe486f13f4ae2a9fe4c07f53c4d27932177)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+
 # [2.7.0-cx24-3682.7](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.7.0-cx24-3682.6...v2.7.0-cx24-3682.7) (2023-03-25)
 
 

package/package.json

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

@@ -38,16 +38,22 @@
  * @description This model represents the response.
  * @typedef EquinoxResponse
  * @type {object}
- * @property {EquinoxProduct[]} product
+ * @property {EquinoxNormalProduct[]} product
  */
 
 /**
- * @description This model represents a product within an Equinox response.
- * @typedef EquinoxProduct
+ * @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 {EquinoxProductVariant[]} sku or varaints - available only when product is a normal product.
+ */
+
+/**
+ * @description EquinoxKitProduct represents an equinox Kit product type.
+ * @typedef EquinoxKitProduct
+ * @type {object}
  * @property {"kit"|"bundle"} [type] available only when product is type of kit.
  */
 
@@ -107,6 +113,7 @@
  */
 
 /**
+ * @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"
@@ -123,6 +130,10 @@
  * @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} [variantLabel]
  * @property {string} [isExclusive] E.g., "false" - Why is this a string??
  */

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

@@ -8,7 +8,7 @@ const httpStatus = { notFound: 404 };
  * Note: Do not polute this file. Create a new file for new interceptor.
  * 
  * @param {import('axios').AxiosError} error 
- * @returns {import('axios').AxiosError<import('../').EquinoxResponse>}
+ * @returns {import('axios').AxiosResponse<import('../').EquinoxResponse>}
 */
 function productNotFoundInterceptor(error) {
   const segments = 'catalogs/search';
@@ -20,18 +20,17 @@ function productNotFoundInterceptor(error) {
     const sku = getSKU(filterParam);
 
     if (sku !== null) {
-      return {
-        ...error,
-        response: {
-          ...error.response,
-          data: {
-            product: [
-              productNotFound(sku)
-            ]
-          },
-          statusText: getStatusText(error.response)
-        }
-      }
+      const response = {
+        ...error.response,
+        data: {
+          product: [
+            productNotFound(sku)
+          ]
+        },
+        statusText: getStatusText(error.response)
+      };
+
+      return response;
     }
 
     console.error('Unable to detect SKU from the given parameter', filterParam);

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

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

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

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

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} available
+ * @returns {boolean}
+ */
+function mapAvailable(available) {
+  if (available) {
+    return available;
+  }
+
+  return false;
+}
+
+/**
+ * @param {boolean} lowStock
+ * @returns {boolean}
+ */
+function mapLowStock(lowStock) {
+  if (lowStock) {
+    return lowStock;
+  }
+
+  return false;
+}
+
+/**
+ * @param {string} binName
+ * @returns {string}
+ */
+function mapBinName(binName) {
+  if (binName) {
+    return binName;
+  }
+
+  return '';
+}
+
+/**
+ * @param {boolean} backOrdered
+ * @returns {boolean}
+ */
+function mapBackOrdered(backOrdered) {
+  if (backOrdered) {
+    return backOrdered;
+  }
+
+  return false;
+}
+
+/**
+ * @param {number} expectedBackOrderAvailabilityDate
+ * @returns {number}
+ */
+function mapExpectedBackOrderAvailabilityDate(expectedBackOrderAvailabilityDate) {
+  if (expectedBackOrderAvailabilityDate) {
+    return expectedBackOrderAvailabilityDate;
+  }
+
+  return 0;
+}
+
+/**
+ * @param {boolean} preOrdered
+ * @returns {boolean}
+ */
+function mapPreOrdered(preOrdered) {
+  if (preOrdered) {
+    return preOrdered;
+  }
+
+  return false;
+}
+
+/**
+ * @param {number} expectedPreOrderAvailabilityDate
+ * @returns {number}
+ */
+function mapExpectedPreOrderAvailabilityDate(expectedPreOrderAvailabilityDate) {
+  if (expectedPreOrderAvailabilityDate) {
+    return expectedPreOrderAvailabilityDate;
+  }
+
+  return 0;
+}
+
+/**
+ * @param {number} atpQty
+ * @returns {number}
+ */
+function mapAtpQty(atpQty) {
+  if (atpQty) {
+    return atpQty;
+  }
+
+  return 0;
+}
+
+/**
+ * @param {number} preOrderedQty
+ * @returns {number}
+ */
+function mapPreOrderedQty(preOrderedQty) {
+  if (preOrderedQty) {
+    return preOrderedQty;
+  }
+
+  return 0;
+}
+
+/**
+ * @param {number} backOrderedQty
+ * @returns {number}
+ */
+function mapBackOrderedQty(backOrderedQty) {
+  if (backOrderedQty) {
+    return backOrderedQty;
+  }
+
+  return 0;
+}
+
+/**
+ * @param {number|null} lowStockThreshold
+ * @returns {number|null}
+ */
+function mapLowStockThreshold(lowStockThreshold) {
+  if (lowStockThreshold) {
+    return lowStockThreshold;
+  }
+
+  return null;
+}
+
+/**
+ * @param {number|null} outOfStockThreshold
+ * @returns {number|null}
+ */
+function mapOutOfStockThreshold(outOfStockThreshold) {
+  if (outOfStockThreshold) {
+    return outOfStockThreshold;
+  }
+
+  return null;
+}
+
+module.exports = mapInventoryProperties;

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

@@ -0,0 +1,70 @@
+// @ts-check
+const mapIdentifier = require('./identifier');
+const mapInventoryProperties = require('./inventoryProperties');
+
+/**
+ * @param {import('../').EquinoxProductVariant} variant
+ */
+function mapVariant(variant) {
+  /** @type {import('../').EquinoxProductVariant} */
+  const model = {
+    identifier: mapIdentifier(variant.identifier),
+    inventory: '',
+    properties: {
+      benefits: '{}',
+      excludeFromSearch: '',
+      usage: '{}',
+      description: '',
+      chargeShipping: '',
+      globalProductId: '',
+      title: '',
+      scanQualifiedCount: '0',
+      division: '',
+      isExclusive: 'false',
+      imageURL: '',
+      customerTypes: 'BrandAffiliate,Preferred,Retail',
+      ingredients: '',
+      availableChannels: 'subscription,arsPhone,kiosk,mobile,web',
+      resources: '',
+      market: 'CA',
+      size: '',
+      name: '',
+      status: 'active'
+    },
+    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/models/productNotFound.js

@@ -1,14 +1,14 @@
 // @ts-check
-const { mapProperties } = require('../mappers');
+const { mapProperties, mapVariant, mapIdentifier, mapInventoryProperties } = require('../mappers');
 
 /**
  * @param {string} sku 
- * @returns {import('../').EquinoxProduct}
+ * @returns {import('../').EquinoxNormalProduct}
  */
 function productNotFound(sku) {
-  /** @type {import('../').EquinoxProduct} */
+  /** @type {import('../').EquinoxNormalProduct} */
   const model = {};
-  model.identifier = sku || '';
+  model.identifier = mapIdentifier(sku);
   model.properties = mapProperties({
     name: '',
     imageURL: '',
@@ -25,6 +25,28 @@ function productNotFound(sku) {
     size: '',
     productDetailsDescription: ''
   });
+  model.sku = [mapVariant({
+    identifier: '',
+    inventory: '',
+    inventoryProperties: mapInventoryProperties({
+      available: false,
+      lowStock: false,
+      binName: '',
+      backOrdered: false,
+      expectedBackOrderAvailabilityDate: 0,
+      preOrdered: false,
+      expectedPreOrderAvailabilityDate: 0,
+      atpQty: 0,
+      preOrderedQty: 0,
+      backOrderedQty: 0,
+      lowStockThreshold: null,
+      outOfStockThreshold: null
+    }),
+    properties: {},
+    promotion: [],
+    priceFacets: {},
+    totalValue: {}
+  })];
 
   return model;
 }