@nuskin/ns-product-lib 2.5.0-cx24-2462.3.3 → 2.5.0-cx24-2179.1

package/CHANGELOG.md

@@ -1,30 +1,48 @@
-# [2.5.0-cx24-2462.3.3](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.5.0-cx24-2462.3.2...v2.5.0-cx24-2462.3.3) (2022-11-16)
+# [2.5.0-cx24-2179.1](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.4.2-CX24.2.1...v2.5.0-cx24-2179.1) (2022-11-21)
 
 
+### Fix
+
+* [Equinox market] Admin > Move up/down/top/bottom of featured products and edit bundle is not working ([a89af4a](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/a89af4a5d00c6a68fcaeff22f128554270add21e))
+
+### New
+
+* added support for variant and promotion (#CX24-2179) ([cf1f623](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/cf1f623c61de55fb969e7debd5c456483f1283b5)), closes [#CX24-2179](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-2179)
+
+### Release
+
+* Automated changes by GitLab pipeline [skip ci] ([07bfa40](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/07bfa404c552c05637c2c8a537c4ff298536874e))
+* Automated changes by GitLab pipeline [skip ci] ([fa1c0d9](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/fa1c0d9d5853482e3ac49cea4e99599e7192f85b))
+* Automated changes by GitLab pipeline [skip ci] ([2d20787](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/2d2078763b2d57edb8a24f438ac90dd37c3ff41b))
+
 ### Update
 
-* map equinox properties (CX24-2462) ([406575c](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/406575c992b3aec9a0dda7d873624172f18ff9ae))
+* set ADR pricing from equinox (CX24-2862) ([65d04d2](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/65d04d2e9ff4018edfe99e5a7412bee985d3def2))
+* set ADR pricing from equinox (CX24-2862) ([54a5693](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/54a56932e5df36c9c30ce6358d8597c98be3d20d))
+* set ADR pricing from equinox (CX24-2862) ([bbd135f](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/bbd135f1ed0395c578be2274c84ba136ceed9376))
+* set ADR pricing from equinox (CX24-2862) ([197003e](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/197003e1629bd394c547a118d332b5e8574dfc7d))
 
-# [2.5.0-cx24-2462.3.2](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.5.0-cx24-2462.3.1...v2.5.0-cx24-2462.3.2) (2022-11-16)
+# [2.5.0-cx24-2862.2](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.5.0-cx24-2862.1...v2.5.0-cx24-2862.2) (2022-11-11)
 
 
 ### Update
 
-* map equinox properties (CX24-2462) ([dbfe9ed](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/dbfe9ed0a4bf5f06fd4f797fcb10f1c1246dacbd))
+* set ADR pricing from equinox (CX24-2862) ([b64dcea](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/b64dcea4dd3374be992c667db5c0b2604aacc029))
 
-# [2.5.0-cx24-2462.3.1](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.4.2-CX24.2.1...v2.5.0-cx24-2462.3.1) (2022-11-15)
+# [2.5.0-cx24-2862.1](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.4.2-cx24-2612.1.1...v2.5.0-cx24-2862.1) (2022-11-10)
 
 
 ### Update
 
-* map equinox properties (CX24-2462) ([fdb813d](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/fdb813d6b2f5d9f877ffa870e4102e7d5e0dff07))
+* set ADR pricing from equinox (CX24-2862) ([9f6dfb7](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/9f6dfb726f40b1335411318629a2ebdf1b4dac96))
+* set ADR pricing from equinox (CX24-2862) ([61f550a](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/61f550a21c5cc9d062549ec2aaf2758aebccf2be))
 
-## [2.4.2-CX24.2.1](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.4.1...v2.4.2-CX24.2.1) (2022-11-07)
+## [2.4.2-cx24-2612.1.1](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.4.1...v2.4.2-cx24-2612.1.1) (2022-11-07)
 
 
 ### Fix
 
-* [Equinox market] Admin > Move up/down/top/bottom of featured products and edit bundle is not working ([82611ca](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/82611cab93c990ed1ce05690feb9d00967090dea))
+* [Equinox market] Admin > Move up/down/top/bottom of featured products and edit bundle is not working ([9d9d106](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/9d9d10667477b4c7ef7bf8ec013aab322d3cdbcc))
 
 ## [2.4.1](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.4.0...v2.4.1) (2022-11-06)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuskin/ns-product-lib",
-  "version": "2.5.0-cx24-2462.3.3",
+  "version": "2.5.0-cx24-2179.1",
   "description": "This project contains shared Product models and code between the backend and frontend.",
   "main": "src/index.js",
   "scripts": {
@@ -25,8 +25,8 @@
     "eslint-config-prettier": "4.1.0",
     "eslint-plugin-json": "2.1.1",
     "eslint-plugin-prettier": "3.1.2",
-    "jest": "26.0.1",
-    "jest-environment-jsdom": "26.0.1",
+    "jest": "29.2.2",
+    "jest-environment-jsdom": "29.2.2",
     "jest-sonar-reporter": "2.0.0",
     "prettier": "1.19.1"
   },

package/src/productData.js

@@ -81,7 +81,7 @@ const ProductData = {
   /**
    * @param {contentstack.MarketConfig} marketConfig
    */
-  getLegacyRequestHeaders: function (marketConfig) {
+  getLegacyRequestHeaders: function(marketConfig) {
     return {
       'Content-Type': 'application/json',
       client_id: marketConfig.checkout_client_id,
@@ -90,13 +90,12 @@ const ProductData = {
   },
 
   /**
-   * Map product variant
+   * map product from equinox to nuskin product data structure
    * @todo remove unnecessary fields
    * @param {*} eqVariant
-   * @returns Array<Product>
+   * @returns  obj Product
    */
-  eqProductVariantMapper: function (eqVariant) {
-
+  productMapper : function(eqVariant) {
     let imageURL = eqVariant.properties.imageURL;
     const regex = /\d+.\d+/
     let thumbnailImage = ''
@@ -104,10 +103,13 @@ const ProductData = {
     if (imageURL.includes('contentstack')) {
       thumbnailImage = imageURL + '?width=40'
     } else {
-      thumbnailImage = imageURL.replace(regex, '40.40')
+      thumbnailImage = imageURL.replace(regex,'40.40')
     }
 
-    return {
+    //get the last promotion
+    const salesPromotion  = Array.isArray(eqVariant.promotion)  > 0 ? eqVariant.promotion[eqVariant.promotion.length - 1] : null;
+    const productPrice = salesPromotion && salesPromotion.discount  ? salesPromotion.discount :  (eqVariant.priceFacet ? eqVariant.priceFacets["Regular Price"] : '');
+    return  {
       "sku": eqVariant.identifier,
       "globalProductID": eqVariant.identifier,
       "title": eqVariant.properties.name,
@@ -125,7 +127,7 @@ const ProductData = {
         }
       ],
       "thumbnail": thumbnailImage,
-      ingredients: mapIngredients(eqVariant.properties.ingredients),
+      "ingredients": eqVariant.properties.ingredients,
       "benefits": eqVariant.properties.benefits,
       "usage": eqVariant.properties.usage,
       "resources": eqVariant.properties.resources,
@@ -142,42 +144,30 @@ const ProductData = {
       "availableQuantity": eqVariant.inventoryProperties.atpQty,
       "maxQuantity": 999,
       "points": "",
-      "cv": (eqVariant.priceFacets.CV) ? eqVariant.priceFacets.CV : '',
-      "pv": eqVariant.priceFacets.PV,
+      "cv": eqVariant.priceFacets ?  eqVariant.priceFacets.CV : '',
+      "pv": eqVariant.priceFacets ? eqVariant.priceFacets.PV : '',
       "priceType": "WRTL",
-      "price": eqVariant.priceFacets["Regular Price"],
+      "price": productPrice,
       "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"]
+        "WRTL": productPrice,
+        "WADW-WRTL": productPrice,
+        "WADR": eqVariant.priceFacet ? eqVariant.priceFacets["Regular Price"] : '',
+        "RTL": eqVariant.priceFacet ? eqVariant.priceFacets["Regular Price"] : '',
+        "WWHL": eqVariant.priceFacet ? eqVariant.priceFacets["Wholesale Price"] : '',
+        "WADW": eqVariant.priceFacet ? eqVariant.priceFacets["Wholesale Price"] : '',
+        "WHL": eqVariant.priceFacet ? 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 : ''
+        "WWHL": (eqVariant.priceFacets) ? eqVariant.priceFacets.CV : '',
+        "WADW": (eqVariant.priceFacets) ? eqVariant.priceFacets.CV : '',
+        "WHL": (eqVariant.priceFacets) ? 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
+        "WWHL":  eqVariant.priceFacets ? eqVariant.priceFacets.PV : '',
+        "WADW": eqVariant.priceFacets ? eqVariant.priceFacets.PV : '',
+        "WHL": eqVariant.priceFacets ? eqVariant.priceFacets.PV : ''
       },
+      "orderTypes": this._setOrderType(eqVariant.properties),
       "division": eqVariant.properties.division,
       "backOrderDate": null,
       "locallyProduced": false,
@@ -188,14 +178,14 @@ const ProductData = {
       "shade": "",
       "status": this.switchStatusFromEquinox(eqVariant.properties.status),
       "variantType": "Other",
-      "variantDropdownLabel": eqVariant.properties.variantLabel || "",
+      "variantDropdownLabel": eqVariant.properties.variantLabel  ||  "",
       "variantDropdownPlaceholder": "Select Type",
-      "variantsLabel": eqVariant.properties.variantLabel || "",
+      "variantsLabel": eqVariant.properties.variantLabel  ||  "",
       "groupOffer": false,
       "personalOffer": false,
-      "savedEventName": null,
-      "salesLabel": "",
-      "eventName": null,
+      "savedEventName": salesPromotion ? salesPromotion.promotionClass : '',
+      "salesLabel":  salesPromotion ? salesPromotion.message : '',
+      "eventName": salesPromotion ? salesPromotion.promotionClass : '',
       "sizeWeight": '',
       "nettoWeight": "",
       "searchScore": 0,
@@ -208,146 +198,57 @@ const ProductData = {
       "restrictedMarkets": [],
       "addOns": []
     };
+
+  },
+
+
+  /**
+   *
+   * Map product variants
+   * @param Array<eqVariant>
+   * @returns Array<Product>
+   */
+  eqProductVariantMapper : function (eqVariants) {
+
+    let variants = {};
+
+    eqVariants.map(eqVariant => {
+      variants[eqVariant.identifier] = this.productMapper(eqVariant);
+      return eqVariant;
+    });
+
+    return  variants;
   },
 
+
+  /**
+   * eqProductMapper
+   * @param {*} productDataResponse
+   * @param {*} skus
+   * @returns  obj
+   */
   eqProductMapper: function (productDataResponse, skus) {
-    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')
-      }
 
-      if (data.sku && data.sku.length > 1) {
-        data.sku.map(variant => {
-          variants[variant.identifier] = this.eqProductVariantMapper(variant);
-          return variant;
-        });
+      const mappedProduct = this.productMapper(data.sku[count]);
+
+      if (data.sku && data.sku.length > 0) {
+        variants = this.eqProductVariantMapper(data.sku);
       }
 
-      prod = {
-        "sku": data.sku[count].identifier,
-        "globalProductID": data.identifier,
-        "title": data.properties.name,
-        "country": data.sku[count].properties.market,
-        "language": "en",
-        "shortDescr": data.properties.description,
-        "longDescr": data.properties.productDetailsDescription,
-        "fullImage": imageURL,
-        "imageAltText": data.properties.name,
-        productCarouselImages: data.sku[count].properties.productImages
-          ? JSON.parse(data.sku[count].properties.productImages).map(img => (
-            {
-              contentType: /\.jpg/i.test(img.url) ? 'img' : 'video',
-              src: img.url,
-              alt: img.alt
-            }
-          )) : [],
-        "thumbnail": thumbnailImage,
-        ingredients: mapIngredients(data.properties.ingredients),
-        benefits: mapBenefits(data.properties.benefits),
-        usage: mapUsage(data.properties.usage),
-        resources: mapResources(data.properties.resources),
-        "videos": "",
-        "movie": "",
-        "youtube": "",
-        "salesEventText": "",
-        "contentSection": [
-          {
-            "sectionContent": "<div class=\"contentSections\"></div>\n"
-          }
-        ],
-        "scanQualified": data.properties.scanQualifiedCount,
-        "availableQuantity": data.sku[count].inventoryProperties.atpQty,
-        "maxQuantity": 999,
-        "points": "",
-        "cv": (data.sku[count].priceFacets.CV) ? data.sku[count].priceFacets.CV : '',
-        "pv": data.sku[count].priceFacets.PV,
-        "priceType": "WRTL",
-        "price": data.sku[count].priceFacets["Regular Price"],
-        "priceMap": {
-          "WRTL": data.sku[count].priceFacets["Regular Price"],
-          "WADW-WRTL": data.sku[count].priceFacets["Regular Price"],
-          "WADR": 9999.01,
-          "RTL": data.sku[count].priceFacets["Regular Price"],
-          "WADW": 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 : '',
-          "WADW": (data.sku[count].priceFacets.CV) ? data.sku[count].priceFacets.CV : '',
-          "WHL": (data.sku[count].priceFacets.CV) ? data.sku[count].priceFacets.CV : ''
-        },
-        "pvMap": {
-          "WWHL": data.sku[count].priceFacets.PV,
-          "WADW": data.sku[count].priceFacets.PV,
-          "WHL": data.sku[count].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
-        },
-        "childSkus": [],
-        "custTypes": this.switchCustType(data.properties.customerTypes),
-        "division": data.properties.division,
-        "backOrderDate": null,
-        "locallyProduced": false,
-        "agelocme": null,
-        "count": "",
-        "flavor": "",
-        "size": data.sku[count].properties.size,
-        "shade": "",
-        "status": this.switchStatusFromEquinox(data.sku[count].properties.productStatus),
-        "variantType": "Other",
-        "variantDropdownLabel": data.sku[count].properties.variantLabel || "",
-        "variantDropdownPlaceholder": "Select Type",
-        "variantsLabel": data.sku[count].properties.variantLabel || "",
-        "groupOffer": false,
-        "personalOffer": false,
-        "savedEventName": null,
-        "salesLabel": "",
-        "eventName": null,
-        "sizeWeight": '',
-        "nettoWeight": "",
-        "variants": variants,
-        "searchScore": 0,
-        "isExclusive": data.sku[count].properties.isExclusive,
-        "marketAttributes": {
-          "discount": true,
-          "redeem": true,
-          "earn": true
-        },
-        "restrictedMarkets": [],
-        "addOns": [],
-        "inventory": data.sku[count].inventory || "" //inventory label
-
-      };
-      let newProduct = new Product(prod);
-      return newProduct
-    })
+      let newProduct = new Product({...mappedProduct, variants: variants});
+      return newProduct;
+
+    });
 
     let data = {
       products: this._sortProductsBySku(skus, prodArr),
       count: productDataResponse.length
     };
+
     return {
       data: {
         "status": 200,
@@ -406,82 +307,73 @@ const ProductData = {
 
   _sortProductsBySku: function (skus, products) {
 
-    if (!skus || !products || products.length === 1) {
+    if(!skus || !products || products.length === 1) {
       return products
     }
 
-    return products.sort(function (a, b) {
+    const sortedProducts = products.sort(function (a, b) {
       return skus.indexOf(a.sku) - skus.indexOf(b.sku);
     });
 
-  }
-}
-
-function mapBenefits(benefits) {
-  if (!benefits) {
-    return {};
-  }
-
-  const list = JSON.parse(benefits)
-    .map(item => item.benefits.map(benefit => benefit).join(''))
-    .join('');
-
-  return {
-    benefitsHTML: list,
-    benefitsText: 'Benefits',
-    benefitItems: []
-  };
-}
-
-function mapIngredients(ingredients) {
-  if (!ingredients) {
-    return {};
-  }
-
-  // concatenating the name, description, keyIngredients, and otherIngredients
-  const list = JSON.parse(ingredients)
-    .map(i => [
-      i.keyIngredients
-        .map(k => `<img src="${k.image.url}" alt="${k.image.alt}" /> ${k.name} ${k.description}`)
-        .join(' '),
-      i.otherIngredients
-    ].join(' '))
-    .join(' ');
-
-  return {
-    ingredientsHTML: list,
-    ingredientsText: 'Ingredients',
-    ingredients: []
-  }
-}
-
-function mapResources(resources) {
-  if (!resources) {
-    return {};
-  }
+    return sortedProducts
 
-  const text = JSON.parse(resources)
-    .map(res => `<p><a href="${res.url}" target="_blank">${res.title}</a></p>`)
-    .join('');
-
-  return {
-    resourcesHTML: text,
-    resourcesText: 'Resources',
-    resourceLinks: []
-  }
-}
+  },
 
-function mapUsage(usage) {
-  if (!usage) {
-    return {};
-  }
+  /**
+   *
+   * @param {*} availableChannels
+   *
+   * This function is use to convert arsPhone,web,kiosk,mobile,subscription
+   * to orderType object
+   *  "adr”
+      "order"
+      "zpfc"
+      "zadp"
+      "ars"
+      "kiosk"
+      "mobile"
+      "preferred customer"
+      "retail"
+      "web"
+      "web display"
+   */
+  _setOrderType: function (properties) {
+    let orderTypeArr = {
+      "adr": false,
+      "order": false,
+      "zpfc": false,
+      "zadp": false,
+      "ars": false,
+      "kiosk": false,
+      "mobile": false,
+      "preferred customer": false,
+      "retail": false,
+      "web": false,
+      "web display": false
+    };
+    let availableChannelsArr = properties.availableChannels.split(',')
+
+    availableChannelsArr.forEach(channel => {
+      if (channel == 'arsPhone')
+        orderTypeArr.ars = true
+      if (channel == 'web') {
+        orderTypeArr.order = true
+        orderTypeArr.web = true
+      }
+      if (channel == 'kiosk')
+        orderTypeArr.kiosk = true
+      if (channel == 'mobile')
+        orderTypeArr.mobile = true
+      if (channel == 'subscription')
+        orderTypeArr.adr = true
 
-  const text = JSON.parse(usage).additionalText
-    .map(t => t).join('');
+    });
+    if (properties.retail)
+      orderTypeArr.retail = true
+    if (properties.prefferredCustomer)
+      orderTypeArr['preferred customer'] = true
 
-  return {
-    usageHTML: text,
-    usageText: 'Usage'
+    return orderTypeArr;
   }
 }