@nuskin/ns-product-lib 2.7.0-cx24-3682.8 → 2.7.0-cx24-3682.10

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [2.7.0-cx24-3682.10](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.7.0-cx24-3682.9...v2.7.0-cx24-3682.10) (2023-03-27)
+
+
+### New
+
+* MySite product cards show blank data when users have setup AEM Base SKU's(55) in Admin #CX24-3682 ([249f3b7](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/249f3b79b30a774c45e90886f01d8bd4d4874b4b)), closes [#CX24-3682](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3682)
+
+# [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)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuskin/ns-product-lib",
-  "version": "2.7.0-cx24-3682.8",
+  "version": "2.7.0-cx24-3682.10",
   "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 {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.
  */
 
@@ -65,40 +71,40 @@
  * @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., "[]"
+ * @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} 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"
  */
 
 /**
  * @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} market E.g., "CA"
- * @property {string} description E.g., "180° Ampoule"
- * @property {string} customerTypes E.g., "BrandAffiliate,Preferred,Retail"
- * @property {string} division E.g., "Nu Skin"
+ * @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} market e.g., "CA"
+ * @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 {string} identifier e.g., "02002145"
+ * @property {string} inventory e.g., "IN STOCK"
  * @property {EquinoxProductVariantProperties} properties
- * @property {any[]} promotion E.g., ???
+ * @property {any[]} promotion e.g., ???
  * @property {EquinoxProductPriceFacets} priceFacets
  * @property {EquinoxProductInventoryProperties} inventoryProperties
  * @property {EquinxProductTotalValue} totalValue
@@ -107,62 +113,68 @@
  */
 
 /**
+ * @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} 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} 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??
+ * @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"
+ * @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
+ * @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 {number} priceAfterDiscount e.g., 2
+ * @property {number} originalPrice e.g., 2
+ * @property {number} totaldiscount e.g., 0
  * @property {{
  *  CV: { CV: number },
  *  "Regular Price": {

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,71 @@
+// @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',
+      productStatus: 'Sellable'
+    },
+    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;
 }