@nuskin/cs-product-lib 1.0.2-cx12-6001.2 → 1.0.3-solace-changes.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuskin/cs-product-lib",
-  "version": "1.0.2-cx12-6001.2",
+  "version": "1.0.3-solace-changes.1",
   "description": "Library for pulling and parsing product content (and applying business logic) retrieved from Contentstack",
   "main": "src/index.js",
   "scripts": {

package/src/csProduct.js

@@ -60,7 +60,7 @@ const csProduct = (props) => {
     const optionalIncludes = `&include[]=${OPTIONAL}${VARIANTS}&include[]=${OPTIONAL}${PRODUCT_FAQS}&include[]=${OPTIONAL}${KEY_INGREDIENTS}&include[]=${OPTIONAL}${PRODUCT_HIGHLIGHTS}&include[]=${OPTIONAL}${PRODUCT_RESOURCES}&include[]=${OPTIONAL}${VARIANT_KEY_INGREDIENTS}&include[]=${OPTIONAL}${VARIANT_HIGHLIGHTS}&include[]=${OPTIONAL}${VARIANT_FAQS}&include[]=${OPTIONAL}${VARIANT_RESOURCES}&include[]=${OPTIONAL}${PRODUCT_CATEGORY}&include[]=${OPTIONAL}${PRODUCT_SUBCATEGORIES}`
 
     validateConfig(props)
-    const { apiKey, environment, deliveryToken, ...config } = props
+    const { apiKey, environment, deliveryToken, homeUrl, awsBase, clientId } = props
     const axios = deliveryAxios({ apiKey, deliveryToken})
 
     const asObject = () => {
@@ -84,7 +84,7 @@ const csProduct = (props) => {
         let status = {}
         let marketData = {}
         if (validSkus?.length > 0) {
-            status = await getProductStatus(validSkus, locale, config)
+            status = await getProductStatus(validSkus, locale, homeUrl, awsBase, clientId)
             const localeSplit = locale.split('_')
             let market =
                 localeSplit?.length > 1 ? localeSplit[1].toUpperCase() : 'XX'
@@ -151,9 +151,9 @@ const csProduct = (props) => {
         }
     }
 
-    const formatProductWithSchima = (products = []) => {
+    const formatProductWithSchema = (products = []) => {
         return products?.map((product) => {
-            const formatedProduct = formatProduct(product, config)
+            const formatedProduct = formatProduct(product, homeUrl)
             formatedProduct.variants = formatedProduct?.variants?.map(
                 (variant) => formatVariant(variant)
             )
@@ -161,20 +161,20 @@ const csProduct = (props) => {
         })
     }
 
-    const formatBundleWithSchima = (bundles = []) => {
+    const formatBundleWithSchema = (bundles = []) => {
         return bundles?.map((bundle) => {
-            const formatedBundle = transformBundle(bundle, config)
+            const formatedBundle = transformBundle(bundle, homeUrl)
 
             formatedBundle.requiredProducts = formatedBundle?.requiredProducts?.map(
                 ({product, quantity}) => {
-                    const [formatedProduct] = formatProductWithSchima([product])
+                    const [formatedProduct] = formatProductWithSchema([product])
                     return {product : formatedProduct, quantity}
                 }
             )
 
             formatedBundle.optionalProducts = formatedBundle?.optionalProducts?.map(
                 ({product, quantity}) => {
-                    const [formatedProduct] = formatProductWithSchima([product])
+                    const [formatedProduct] = formatProductWithSchema([product])
                     return {product : formatedProduct, quantity}
                 }
             )
@@ -264,7 +264,7 @@ const csProduct = (props) => {
                 )
             }
         }
-        return formatBundleWithSchima(bundles)?.[0]
+        return formatBundleWithSchema(bundles)?.[0]
     }
     const getBundles = async (ids, locale) => {
         const query = `{ "$or": [{ "bundle_id": { "$in": ${helpers?.arrayString(ids)} }}, { "uid": { "$in": ${helpers?.arrayString(ids)} }}] }`
@@ -299,7 +299,7 @@ const csProduct = (props) => {
                 )
             }
         }
-        return formatBundleWithSchima(bundles)
+        return formatBundleWithSchema(bundles)
     }
 
     const getProductsBySku = async (skus, locale) => {
@@ -318,7 +318,7 @@ const csProduct = (props) => {
             product.skus = skus
             product.locale = locale
         }
-        return formatProductWithSchima(products)
+        return formatProductWithSchema(products)
     }
 
     const getProductsByGlobalId = async (ids, locale) => {
@@ -333,7 +333,7 @@ const csProduct = (props) => {
         const translations = await getTranslations(locale)
         // await parseSharedStrings(translations);
         await removeInvalidVariants(products, locale, translations)
-        return formatProductWithSchima(products)
+        return formatProductWithSchema(products)
     }
 
     const getProductsBySlug = async (slugs, locale) => {
@@ -348,7 +348,7 @@ const csProduct = (props) => {
         const translations = await getTranslations(locale)
         // await parseSharedStrings(translations);
         await removeInvalidVariants(products, locale, translations)
-        return formatProductWithSchima(products)
+        return formatProductWithSchema(products)
     }
 
     const getProductsByUID = async (ids, locale) => {
@@ -360,7 +360,7 @@ const csProduct = (props) => {
         const translations = await getTranslations(locale)
         // await parseSharedStrings(translations);
         await removeInvalidVariants(products, locale, translations)
-        return formatProductWithSchima(products)
+        return formatProductWithSchema(products)
     }
 
     const getTranslations = async (locale) => {
@@ -392,7 +392,7 @@ const csProduct = (props) => {
         products = products?.entries || []
         const translations = await getTranslations(locale)
         await removeInvalidVariants(products, locale, translations)
-        const transformProduct = formatProductWithSchima(products)
+        const transformProduct = formatProductWithSchema(products)
         return {
             products: transformProduct,
             validCount: products.length,

package/src/formatProduct.js

@@ -2,7 +2,7 @@ const helpers = require('./helpers')
 const entities = require('entities')
 
 /* istanbul ignore next */
-const formatProduct = (parent, config) => ({
+const formatProduct = (parent, homeUrl) => ({
     // Each value is a function with a parameter 'parent' that is the current instance of a Product
     // ContentStack references need to be queried separately (ie: variants)
     id: parent.uid,
@@ -54,7 +54,7 @@ const formatProduct = (parent, config) => ({
     disclaimerWarnings: helpers?.mapDisclaimerWarnings(
         parent.disclaimer_warnings
     ),
-    seoInformation: helpers?.mapSeoInformation(parent, config),
+    seoInformation: helpers?.mapSeoInformation(parent, homeUrl),
     variants: helpers?.mapVariants(parent),
     refund: helpers?.mapRefund(parent),
     shipping: helpers?.mapShipping(parent),

package/src/formatVariant.js

@@ -92,7 +92,7 @@ const formatVariant = (parent) => ({
         locale: parent.locale || ''
     },
     searchKeywords: parent.search_keywords,
-    excludeFromSearch: parent.exclude_from_search,
+    excludeFromSearch: parent.exclude_from_search || helpers?.mapCsStatus(parent).status === 'discontinued' || _.get(parent, 'defaults.status.status.retail', null) === 'DISCONTINUED',
     customerTypes: helpers?.getBestSkuData(parent)?.status_selections
         ?.customer_types,
     availableChannels: helpers?.getBestSkuData(parent)?.status_selections

package/src/helpers.js

@@ -312,21 +312,17 @@ function mapVariants(parent) {
     return _variants
 }
 
-function mapSeoInformation(parent, config) {
-    const ogImage = (parent.seo_information || {}).og_image
+function mapSeoInformation(parent, homeUrl) {
+    const { ogImage } = parent.seo_information
     const seoData = {
-        metaTitle:
-            (parent.seo_information && parent.seo_information.meta_title) ||
-            parent.name,
+        metaTitle: parent?.seo_information?.meta_title || parent.name,
         metaDescription:
-            (parent.seo_information &&
-                parent.seo_information.meta_description) ||
-            parent.short_description,
-        canonicalURL: `${config?.homeUrl}/catalog/${
-            (parent.localeData || {}).country
-        }/${(parent.localeData || {}).language}/product/${
-            (parent.seo_information && parent.seo_information.slug) ||
-            parent.sku
+            parent.seo_information?.meta_description ||
+            parent?.short_description,
+        canonicalURL: `${homeUrl}/catalog/${
+            parent.localeData?.country
+        }/${parent.localeData?.language}/product/${
+            parent?.seo_information?.slug || parent.sku
         }`,
         ogImage: { url: '', alt: '' }
     }
@@ -504,12 +500,16 @@ function mapProductDetails(productOrVariant) {
     }
     let description = productDetails.long_description
     if (!Array.isArray(description)) {
-        description = createMarkdown(
-            description && description.type ? description : null,
-            description
-        )
+        if (description?.uid) {
+            description = null
+        } else {
+            description = createMarkdown(
+                description && description.type ? description : null,
+                description
+            )
+        }
         description =
-            description.type ||
+            description?.type ||
             description === '' ||
             description === 'undefined' ||
             description === null
@@ -1036,28 +1036,6 @@ function mapWarranty(product) {
     return null
 }
 
-/* istanbul ignore next */
-const getSeoInformation = (parent, config) => {
-    const { ogImage } = parent.seo_information
-    const seoData = {
-        metaTitle: parent?.seo_information?.meta_title || parent.name,
-        metaDescription:
-            parent.seo_information?.meta_description ||
-            parent?.short_description,
-        canonicalURL: `${config?.homeUrl}/catalog/${
-            parent.localeData?.country
-        }/${parent.localeData?.language}/product/${
-            parent?.seo_information?.slug || parent.sku
-        }`,
-        ogImage: { url: '', alt: '' }
-    }
-    if (ogImage) {
-        seoData.ogImage.url = ogImage.url
-        seoData.ogImage.alt = ogImage.description || ogImage.title || ''
-    }
-    return seoData
-}
-
 function mapUpSellProductIds(product) {
     if (
         product &&
@@ -1120,6 +1098,5 @@ module.exports = {
     mapPurchaseTypes,
     getProductImages,
     parseLocale,
-    reorderLocale,
-    getSeoInformation
+    reorderLocale
 }

package/src/productStatus.js

@@ -21,13 +21,13 @@ const { isNullOrEmpty, getLocaleInfo } = require('@nuskin/ns-common-lib')
  * @param {string} locale the country code and language (ex: en_US)
  */
 /* istanbul ignore next */
-async function getProductStatus(skus, locale, config) {
+async function getProductStatus(skus, locale, homeUrl, awsBase, clientId) {
     validateRequest(skus, locale)
 
     const localeInfo = getLocaleInfo(locale)
 
     // get market configuration from AEM
-    const marketConfig = await getMarketConfig(localeInfo, config)
+    const marketConfig = await getMarketConfig(localeInfo, homeUrl)
 
     // if (products.length) {
     // get product status data for each product
@@ -35,7 +35,8 @@ async function getProductStatus(skus, locale, config) {
         marketConfig,
         localeInfo,
         skus,
-        config
+        awsBase,
+        clientId
     )
     if (productStatusResponse && productStatusResponse.items) {
         for (let i = 0; i < skus.length; i++) {
@@ -85,8 +86,8 @@ function validateRequest(skus, locale) {
  * @param {{language: string, countryCode: string}} localeInfo
  */
 /* istanbul ignore next */
-async function getMarketConfig(localeInfo, config) {
-    const siteHome = config?.homeUrl
+async function getMarketConfig(localeInfo, homeUrl) {
+    const siteHome = homeUrl
     const region = MarketRegionMappings[localeInfo.countryCode]
     const marketConfigUrl = `${siteHome}/content/configuration/global/markets/${region}.service.${localeInfo.countryCode}.json`
 
@@ -135,7 +136,7 @@ async function getMarketConfig(localeInfo, config) {
  * @param {array} skus an array of all variant skus to get status for
  */
 /* istanbul ignore next */
-async function getProductStatusResponse(marketConfig, localeInfo, skus, config) {
+async function getProductStatusResponse(marketConfig, localeInfo, skus, awsBase, clientId) {
     const marketRequestedQuantity =
         marketConfig.productStatusRequestedQuantity || 999
 
@@ -146,7 +147,7 @@ async function getProductStatusResponse(marketConfig, localeInfo, skus, config)
         return result
     }, {})
 
-    const productStatusUrl = `${config?.awsBase}/product/v2/status?country=${localeInfo.countryCode}`
+    const productStatusUrl = `${awsBase}/product/v2/status?country=${localeInfo.countryCode}`
     const productStatusPayload = JSON.stringify(skusRequest)
 
     try {
@@ -154,7 +155,7 @@ async function getProductStatusResponse(marketConfig, localeInfo, skus, config)
             baseURL: productStatusUrl,
             timeout: 10000,
             headers: {
-                client_id: config?.clientId
+                client_id: clientId
                 // 'x-correlation-id': correlate.retrieveCorrelationId(),
             }
         })

package/src/transformBundle.js

@@ -1,7 +1,7 @@
 const helpers = require('./helpers')
 
 /* istanbul ignore next */
-const transformBundle = (parent, config) => ({
+const transformBundle = (parent, homeUrl) => ({
     id: parent.bundle_id,
     uid: parent.uid,
     title: parent.name,
@@ -33,7 +33,7 @@ const transformBundle = (parent, config) => ({
     disclaimerWarnings: helpers?.mapDisclaimerWarnings(
         parent.disclaimer_warnings
     ),
-    seoInformation: helpers?.getSeoInformation(parent, config),
+    seoInformation: helpers?.mapSeoInformation(parent, homeUrl),
     resources: helpers?.mapResources(parent),
     categories: parent?.categories?.map((category) => ({
         displayName: category.display_name,