@nuskin/ns-product-lib 2.4.0-cx24-2462.1.1 → 2.4.1-cx12-5910.1

package/CHANGELOG.md

@@ -1,10 +1,21 @@
-# [2.4.0-cx24-2462.1.1](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.3.0...v2.4.0-cx24-2462.1.1) (2022-10-20)
+## [2.4.1-cx12-5910.1](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.4.0...v2.4.1-cx12-5910.1) (2022-10-26)
+
+
+### Fix
+
+* try catch block for generating env (#CX12-5910) ([86930c3](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/86930c31a70bfe35a5136bc338ec618e04d860eb)), closes [#CX12-5910](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX12-5910)
+
+# [2.4.0](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.3.0...v2.4.0) (2022-10-26)
 
 
 ### Fix
 
 * To make multiple products work (#CX24-2444) ([ce4c483](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/ce4c483b7fbb0527e60045d8174fd503a67e63fa)), closes [#CX24-2444](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-2444)
 
+### New
+
+* added support for inventory label (#CX24-2186) ([3e27481](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/3e2748106cd6098086dbd6b738964deabacc875d)), closes [#CX24-2186](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-2186)
+
 ### Release
 
 * Automated changes by GitLab pipeline [skip ci] ([8f75316](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/8f75316b692ddccda5b7bea830ee6dc625b942c7))
@@ -12,7 +23,8 @@
 
 ### Update
 
-* map product images to carousel images (CX24-2462) ([1e17c6e](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/1e17c6ec39e54b4bdb2bb804c997eb14c9e501d5))
+* added support for variant and price (#CX24-2186) ([e0bf8f2](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/e0bf8f280a838dfa4cc613e5bc34d254dbdc8e1a)), closes [#CX24-2186](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-2186)
+* added variant label (#CX24-2186) ([4c223b3](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/4c223b34438ed73cb824716cacb93482486f8195)), closes [#CX24-2186](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-2186)
 
 # [2.3.0](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.2.0...v2.3.0) (2022-10-14)
 

package/package.json

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

package/src/contentstack/contentstack.js

@@ -3,8 +3,19 @@ const axios = require('axios');
 const { getEnvironmentFromUrl } = require('@nuskin/ns-common-lib');
 const config = require('./environment');
 
+let env = 'unknown';
+
+// ns-product-lib should be multi-platform compatible i.e. lambda, web, or react native etc.
+try {
+  env = getEnvironmentFromUrl(window.location.host);
+} catch (error) {
+  console.log("getting env from url not supported. window is likely unavailable:");
+  console.log("Name: ", error.name);
+  console.log("Message: ", error.message);
+  console.log("Stack Trace: ", error.stack);
+}
+
 // contentstack HTTP service
-const env = getEnvironmentFromUrl(window.location.host);
 const envConfig = config.getCredentials(env);
 const baseURL = `${envConfig.url}/stacks/${envConfig.apiKey}?environment=${envConfig.env}`;
 const headers = {

package/src/product.js

@@ -72,6 +72,10 @@ const Product = function(productData) {
   // agelocme stuff
   this.agelocme = null; // object containing agelocme information (like code, label, name)
 
+  //equinox inventory / stock label
+  //@example "IN STOCK"
+  this.inventory = "";
+
   this.setMarketAttributes = function(productStatus) {
     if (productStatus.marketAttributes) {
       this.marketAttributes = productStatus.marketAttributes;
@@ -518,6 +522,7 @@ const Product = function(productData) {
     retData.marketAttributes = this.marketAttributes;
     retData.restrictedMarkets = this.restrictedMarkets;
     retData.addOns = this.addOns;
+    retData.inventory = this.inventory;
 
     return retData;
   };
@@ -626,6 +631,7 @@ const Product = function(productData) {
       this.marketAttributes = productData.marketAttributes;
       this.addOns = productData.addOns || [];
       this.restrictedMarkets = productData.restrictedMarkets || [];
+      this.inventory = productData.inventory || "";
 
       if (data.priceType) {
         this.addPricing(data.priceType, data.price);

package/src/productData.js

@@ -1,15 +1,15 @@
 "use strict";
 const axios = require("axios");
 const contentstack = require('./contentstack/contentstack');
-const product = require("./product");
+const Product = require("./product");
 
 /** @type {*} */
 const ProductData = {
   /**
-   * @param {string[]} skus 
-   * @param {string} locale 
-   * @param {string} market 
-   * @param {boolean} isEquinoxEnabled 
+   * @param {string[]} skus
+   * @param {string} locale
+   * @param {string} market
+   * @param {boolean} isEquinoxEnabled
    */
   getProductData: async function (skus, locale, market, isEquinoxEnabled = false) {
     const localeMarket = `${locale}_${market}`;
@@ -28,7 +28,7 @@ const ProductData = {
   getProductFromEquinox: async function (skus, locale, storeID) {
     const filter = '{"filters":[{"field":"index_key_skuId","operation":"IN","value":"' + skus.toString() + '"}]}';
     axios.defaults.withCredentials = true;
-    
+
     const url = await contentstack.getKongUrl() + `/orchestrationservices/storefront/catalogs/search/`;
     console.log("Dynamic URL", url)
     const href = `${url}?filter=${encodeURI(filter)}`;
@@ -78,7 +78,7 @@ const ProductData = {
       responseType: 'json'
     });
   },
-  
+
   /**
    * @param {contentstack.MarketConfig} marketConfig
    */
@@ -90,21 +90,149 @@ const ProductData = {
     };
   },
 
+  /**
+   * Map product variant
+   * @todo remove unnecessary fields
+   * @param {*} eqVariant
+   * @returns Array<Product>
+   */
+  eqProductVariantMapper : function (eqVariant) {
+
+    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')
+    }
+
+    return {
+      "sku": eqVariant.identifier,
+      "globalProductID": eqVariant.identifier,
+      "title": eqVariant.properties.name,
+      "country": eqVariant.properties.market,
+      "language": "en",
+      "shortDescr": eqVariant.properties.description,
+      "longDescr": eqVariant.properties.productDetailsDescription,
+      "fullImage": imageURL,
+      "imageAltText": eqVariant.properties.name,
+      "productCarouselImages": [
+        {
+          "contentType": "img",
+          "src": "/content/products/24/00/35/24003529/jcr:content/fullImage.imgw.1280.1280.png",
+          "alt": ""
+        }
+      ],
+      "thumbnail": thumbnailImage,
+      "ingredients": eqVariant.properties.ingredients,
+      "benefits": eqVariant.properties.benefits,
+      "usage": eqVariant.properties.usage,
+      "resources": eqVariant.properties.resources,
+      "videos": "",
+      "movie": "",
+      "youtube": "",
+      "salesEventText": "",
+      "contentSection": [
+        {
+          "sectionContent": "<div class=\"contentSections\"><div class=\"contentSection section\"><div>\n<h3>BENEFITS</h3>\n<div>\n<div class=\"sectionContent parsys\"><div class=\"text parbase section\">\n<p>Green tea has been used in China for thousands of years for its health-preserving and revitalizing power. Modern science has identified powerful antioxidants in green tea called polyphenols. One group of polyphenols called catechins is particularly potent and is highly effective at neutralizing free radicals at the cellular level. Catechins support healthy cell function while providing antioxidant protection to critical cell structures such as DNA. Clinical studies show catechins interfere with the production of certain enzymes involved in cell damage. Additionally, catechins have been demonstrated to cause a thermogenic effect that enhances the body s metabolic rate. Tegreen 97<sup>®</sup> from Pharmanex is a proprietary, highly concentrated extract of the catechins found in green tea. Tegreen 97<sup>®</sup> is one of the most potent antioxidant supplements on the market with a 97 percent polyphenol content, 65% catechins. Each Tegreen 97<sup>®</sup> capsule contains the catechin equivalent of approximately seven cups of green tea and is 99.5 percent caffeine free.</p>\r\n\n</div>\n\n</div>\n\n</div>\n</div>\n</div>\n<div class=\"contentSection section\"><div>\n<h3>USAGE</h3>\n<div>\n<div class=\"sectionContent parsys\"><div class=\"text parbase section\">\n<p>As a dietary supplement, take one (1) to four (4) capsules daily; preferably one (1) to two (2) each morning and evening with food. Store in a cool, dry place.</p>\r\n\n</div>\n\n</div>\n\n</div>\n</div>\n</div>\n<div class=\"contentSection section\"><div>\n<h3>INGREDIENTS</h3>\n<div>\n<div class=\"sectionContent parsys\"><div class=\"text parbase section\">\n<table border=\"1\" cellspacing=\"1\" cellpadding=\"0\" width=\"360\"><tbody>\r\n<tr>\r\n<td><b>Nutritional Facts</b></td>\r\n<td><b>Amount</b></td>\r\n<td><b>% Daily Value</b></td>\r\n</tr>\r\n<tr>\r\n<td colspan=\"3\"><b>Serving Size: 1 Capsule<br>\r\nServings Per Container: 120</b></td>\r\n</tr>\r\n<tr>\r\n<td width=\"55%\">Green tea leaf (20:1) Extract (<i>Camellia sinensis</i></td>\r\n<td width=\"20%\">250 mg</td>\r\n<td width=\"25%\">&nbsp;</td>\r\n</tr>\r\n<tr>\r\n<td width=\"55%\" colspan=\"3\">* Daily Value not established</td>\r\n</tr>\r\n<tr>\r\n<td width=\"55%\" colspan=\"3\"><b>Other Ingredients: Gelatin, Silicon Dioxide, Microcrystalline Cellulose, Magnesium Stearate.</b></td>\r\n</tr>\r\n</tbody>\r\n</table>\r\n<p>&nbsp;</p>\r\n\n</div>\n\n</div>\n\n</div>\n</div>\n</div>\n</div>\n"
+        }
+      ],
+      "scanQualified": eqVariant.properties.scanQualifiedCount,
+      "availableQuantity": eqVariant.inventoryProperties.atpQty,
+      "maxQuantity": 999,
+      "points": "",
+      "cv": (eqVariant.priceFacets.CV) ?  eqVariant.priceFacets.CV : '',
+      "pv":eqVariant.priceFacets.PV,
+      "priceType": "WRTL",
+      "price": eqVariant.priceFacets["Regular Price"],
+      "priceMap": {
+        "WRTL": eqVariant.priceFacets["Regular Price"],
+        "WADW-WRTL": eqVariant.priceFacets["Regular Price"],
+        "WADR": 9999.01,
+        "RTL": eqVariant.priceFacets["Regular Price"],
+        "WWHL": eqVariant.priceFacets["Wholesale Price"],
+        "WADW": 9998.01,
+        "WHL": eqVariant.priceFacets["Wholesale Price"]
+      },
+      "cvMap": {
+        "WWHL": (eqVariant.priceFacets.CV) ? eqVariant.priceFacets.CV : '',
+        "WADW": (eqVariant.priceFacets.CV) ? eqVariant.priceFacets.CV : '',
+        "WHL": (eqVariant.priceFacets.CV) ? eqVariant.priceFacets.CV : ''
+      },
+      "pvMap": {
+        "WWHL": eqVariant.priceFacets.PV,
+        "WADW": eqVariant.priceFacets.PV,
+        "WHL": eqVariant.priceFacets.PV
+      },
+      "orderTypes": {
+        "adr": true,
+        "order": true,
+        "zpfc": false,
+        "zadp": true,
+        "ars": true,
+        "kiosk": true,
+        "mobile": true,
+        "preferred customer": true,
+        "retail": true,
+        "web": true,
+        "web display": true
+      },
+      "division": eqVariant.properties.division,
+      "backOrderDate": null,
+      "locallyProduced": false,
+      "agelocme": null,
+      "count": "",
+      "flavor": "",
+      "size": eqVariant.properties.size,
+      "shade": "",
+      "status": this.switchStatusFromEquinox(eqVariant.properties.status),
+      "variantType": "Other",
+      "variantDropdownLabel": eqVariant.properties.variantLabel  ||  "",
+      "variantDropdownPlaceholder": "Select Type",
+      "variantsLabel": eqVariant.properties.variantLabel  ||  "",
+      "groupOffer": false,
+      "personalOffer": false,
+      "savedEventName": null,
+      "salesLabel": "",
+      "eventName": null,
+      "sizeWeight": '',
+      "nettoWeight": "",
+      "searchScore": 0,
+      "isExclusive": false,
+      "marketAttributes": {
+        "discount": true,
+        "redeem": true,
+        "earn": true
+      },
+      "restrictedMarkets": [],
+      "addOns": []
+    };
+  },
+
   eqProductMapper: function (productDataResponse) {
     let prod = [];
     let count = 0;
+    let variants = {};
 
     let prodArr = productDataResponse.map((data) => {
       let imageURL = data.sku[count].properties.imageURL;
       const regex = /\d+.\d+/
       let thumbnailImage = ''
-    
+
       if (imageURL.includes('contentstack')) {
         thumbnailImage = imageURL + '?width=40'
       } else {
         thumbnailImage = imageURL.replace(regex,'40.40')
       }
-      const skuProperties = data.sku[count].properties;
+
+      if (data.sku && data.sku.length > 1) {
+        data.sku.map(variant => {
+          variants[variant.identifier] = this.eqProductVariantMapper(variant);
+          return variant;
+        });
+      }
 
       prod = {
         "sku": data.sku[count].identifier,
@@ -116,14 +244,13 @@ const ProductData = {
         "longDescr": data.properties.productDetailsDescription,
         "fullImage": imageURL,
         "imageAltText": data.properties.name,
-        productCarouselImages: skuProperties.productImages
-          ? JSON.parse(skuProperties.productImages).map(img => (
-            {
-              contentType: /\.jpg/i.test(img.url) ? 'img' : 'video',
-              src: img.url,
-              alt: img.alt
-            }
-          )) : [],
+        "productCarouselImages": [
+          {
+            "contentType": "img",
+            "src": "/content/products/24/00/35/24003529/jcr:content/fullImage.imgw.1280.1280.png",
+            "alt": ""
+          }
+        ],
         "thumbnail": thumbnailImage,
         "ingredients": data.properties.ingredients,
         "benefits": data.properties.benefits,
@@ -139,7 +266,7 @@ const ProductData = {
           }
         ],
         "scanQualified": data.properties.scanQualifiedCount,
-        "availableQuantity": 999,
+        "availableQuantity": data.sku[count].inventoryProperties.atpQty,
         "maxQuantity": 999,
         "points": "",
         "cv": (data.sku[count].priceFacets.CV) ?  data.sku[count].priceFacets.CV : '',
@@ -151,9 +278,9 @@ const ProductData = {
           "WADW-WRTL": data.sku[count].priceFacets["Regular Price"],
           "WADR": 9999.01,
           "RTL": data.sku[count].priceFacets["Regular Price"],
-          "WWHL": 9998.01,
           "WADW": 9998.01,
-          "WHL": 9998.01
+          "WHL": data.sku[count].priceFacets["Wholesale Price"],
+          "WWHL": data.sku[count].priceFacets["Wholesale Price"]
         },
         "cvMap": {
           "WWHL": (data.sku[count].priceFacets.CV) ? data.sku[count].priceFacets.CV : '',
@@ -190,9 +317,9 @@ const ProductData = {
         "shade": "",
         "status": this.switchStatusFromEquinox(data.sku[count].properties.productStatus),
         "variantType": "Other",
-        "variantDropdownLabel": "Select Type",
+        "variantDropdownLabel": data.sku[count].properties.variantLabel  ||  "",
         "variantDropdownPlaceholder": "Select Type",
-        "variantsLabel": "Select Type",
+        "variantsLabel": data.sku[count].properties.variantLabel  ||  "",
         "groupOffer": false,
         "personalOffer": false,
         "savedEventName": null,
@@ -200,8 +327,7 @@ const ProductData = {
         "eventName": null,
         "sizeWeight": '',
         "nettoWeight": "",
-        "variants": {
-        },
+        "variants": variants,
         "searchScore": 0,
         "isExclusive": data.sku[count].properties.isExclusive,
         "marketAttributes": {
@@ -210,9 +336,11 @@ const ProductData = {
           "earn": true
         },
         "restrictedMarkets": [],
-        "addOns": []
+        "addOns": [],
+        "inventory": data.sku[count].inventory || "" //inventory label
+
       };
-      let newProduct = new product(prod);
+      let newProduct = new Product(prod);
       return newProduct
     })
 
@@ -255,13 +383,13 @@ const ProductData = {
   },
 
   /**
-   * 
-   * @param {*} custType 
-   * 
+   *
+   * @param {*} custType
+   *
    */
   switchCustType: function (custType) {
     let newCustType = [];
-    if (custType.includes('Brand Affiliate - Business Entity') || custType.includes('Brand Affiliate - Individual')) 
+    if (custType.includes('Brand Affiliate - Business Entity') || custType.includes('Brand Affiliate - Individual'))
       newCustType.push(10)
     if (custType.includes('Retail Customer'))
       newCustType.push(20)