@nuskin/cs-product-lib 1.4.2 → 1.4.3

package/package.json

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

package/src/formatCategory.js

@@ -11,7 +11,7 @@ const formatProduct = (product) => ({
     productID: product?.product_id || ''
 });
 
-const formatCategory = (parent, language = 'en', homeUrl, allTopCategories) => ({
+const formatCategory = (parent, language = 'en', homeUrl = '', allTopCategories = null) => ({
     displayName: parent?.display_name || '',
     categoryIdentifier: parent?.category_id || '',
     status: parent?.status || 'Inactive',

package/src/formatKit.js

@@ -112,7 +112,6 @@ const parseBundleAvailableQuantity = (product) => {
         )
         return Math.min(...quantities) || 0
     } catch {
-        console.log('some error in availableQuantity')
         return 0
     }
 }
@@ -148,7 +147,6 @@ const getKitOrBundleDetails = (bundle) => {
         dates = dates.filter(date => date.isValid());
         latestBackOrderedDate = dates && dates.length > 0 && backOrderedQty !== 0  ? moment.max(dates).format(dateFormat) : null;
     } catch (error) {
-        console.error('getKitOrBundleDetails() - back order qty, available qty, max qty, latest back order date or status error', JSON.stringify(error));
         maxQty = 0;
         backOrderedQty = 0;
         availableQty = 0;

package/src/helpers.js

@@ -148,70 +148,51 @@ function mapProductImages(parent) {
 }
 
 /* istanbul ignore next */
+// Get the best SKU for this variant if there are multiple SKUs present (more than 1 SKU in the GPID)
+// This is determined by the following priority of status:
+// 1. sellable status
+// 2. the first SKU in the list that isn't discontinued or inactive
+// 3. discontined status
+// 4. inactive status
 function getBestSkuData(variant) {
-    if (
-        variant.sap_data &&
-        variant.sap_data.sku_data &&
-        variant.sap_data.sku_data.length > 0
-    ) {
+    if (variant?.sap_data?.sku_data?.length > 0) {
         if (variant.sap_data.sku_data.length > 1) {
-            let bestSKUData = variant.sap_data.sku_data.find(
-                (s) => s.status === 10
-            )
-            bestSKUData =
-                variant.sap_data.sku_data.find(
-                    (s) => (s.status_selections || {}).status === 'sellable'
-                ) || bestSKUData
+            // First: status === 10 or status_selections.status === 'sellable'
+            let bestSKUData = variant.sap_data.sku_data.find((s) => s?.status === 10 || s?.status_selections?.status === 'sellable')      
+            // Second: not status 2, 9 or status_selections 'discontinued', 'inactive'
             if (!bestSKUData) {
-                bestSKUData = variant.sap_data.sku_data.find(
-                    (s) => s.status === 9
+                bestSKUData = variant.sap_data.sku_data.find((s) => 
+                    s?.status !== 2 && s?.status !== 9 && 
+                    s?.status_selections?.status !== 'discontinued' && 
+                    s?.status_selections?.status !== 'inactive'
                 )
-                bestSKUData =
-                    variant.sap_data.sku_data.find(
-                        (s) => (s.status_selections || {}).status === 'inactive'
-                    ) || bestSKUData
-                if (!bestSKUData) {
-                    bestSKUData = variant.sap_data.sku_data.find(
-                        (s) => s.status !== 2
-                    )
-                    bestSKUData =
-                        variant.sap_data.sku_data.find(
-                            (s) =>
-                                (s.status_selections || {}).status !==
-                                'discontinued'
-                        ) || bestSKUData
-                }
-                if (!bestSKUData) {
-                    bestSKUData = variant.sap_data.sku_data[0]
-                }
             }
-            return bestSKUData
-        }
-        return variant.sap_data.sku_data[0] || {}
-    } else if (variant.sap_data && Array.isArray(variant.sap_data.sku)) {
-        if (variant.sap_data.sku.length > 1) {
-            let bestSKUData = variant.sap_data.sku.find(
-                (s) => s.retail_status === 10
-            )
+            // Third: status 2 or status_selections 'discontinued'
             if (!bestSKUData) {
-                bestSKUData = variant.sap_data.sku.find(
-                    (s) => s.retail_status === 9
-                )
-                if (!bestSKUData) {
-                    bestSKUData = variant.sap_data.sku.find(
-                        (s) => s.retail_status !== 2
-                    )
-                }
+                bestSKUData = variant.sap_data.sku_data.find((s) => s?.status === 2 || s?.status_selections?.status === 'discontinued')
             }
+            // Fourth: status 9 or status_selections 'inactive'
+            if (!bestSKUData) {
+                bestSKUData = variant.sap_data.sku_data.find((s) => s?.status === 9 || s?.status_selections?.status === 'inactive')
+            }
+            return bestSKUData || variant.sap_data.sku_data[0]
+        }
+        return variant?.sap_data?.sku_data[0] || {}
+    } else if (variant?.sap_data && Array.isArray(variant.sap_data.sku)) {
+        if (variant.sap_data.sku.length > 1) {
+            let bestSKUData = variant.sap_data.sku.find((s) => s.retail_status === 10) ||
+                             variant.sap_data.sku.find((s) => s.retail_status !== 2 && s.retail_status !== 9) ||
+                             variant.sap_data.sku.find((s) => s.retail_status === 2) ||
+                             variant.sap_data.sku.find((s) => s.retail_status === 9) ||
+                             variant.sap_data.sku[0]
             bestSKUData.status = bestSKUData.retail_status
             return bestSKUData
         }
         if (variant.sap_data.sku[0]) {
-            variant.sap_data.sku[0].status =
-                variant.sap_data.sku[0].retail_status
+            variant.sap_data.sku[0].status = variant.sap_data.sku[0].retail_status
         }
         return variant.sap_data.sku[0] || {}
-    } else if (variant.sap_data && variant.sap_data.sku) {
+    } else if (variant?.sap_data?.sku) {
         variant.sap_data.sku.status = variant.sap_data.sku.retail_status
         return variant.sap_data.sku
     }
@@ -354,7 +335,7 @@ function mapSeoInformation(parent, homeUrl, type) {
             }/${parent?.localeData?.language}/catalog/${
                 parent?.category_id || parent?.seo_information?.slug
             }`
-            seoData.metaTitle = seoData.metaTitle || parent?.display_name || '',
+            seoData.metaTitle = seoData.metaTitle || parent?.display_name || ''
             seoData.metaDescription = seoData.metaDescription || ''
             break
         default:
@@ -497,78 +478,91 @@ function mapPoints(parent) {
     }
 }
 
-/* istanbul ignore next */
-function mapImage(image, useWebp, width, height, quality, transform, useDAT) {
-    if (Array.isArray(image)) {
-        image = image[0]
+function getImageAlt(image) {
+    return image?.meta?.SEO_Tags || image.description || image.name || ''
+}
+
+function buildTransformUrl(baseUrl, useWebp, width, height, quality, transform) {
+    let url = `${baseUrl}${useWebp ? '.webp' : ''}`
+    if (width || height) {
+        const w = width ? `,width:${width}` : ''
+        const h = height ? `,height:${height}` : ''
+        url += `?quality=${quality}&io=transform:${transform}${w}${h}`
+    } else if (quality && quality !== 100) {
+        url += `?quality=${quality}`
     }
-    useWebp = !!useWebp
-    quality = quality || 100
-    transform = transform || 'fit'
-    useDAT = !!useDAT
-
-    if ((image || {}).type) {
-        if (image.type === 'VIDEO') {
-            const derivatives = image.derivatives || {}
-            if ((image.previewUrls || []).length > 0) {
-                return {
-                    url: image.previewUrls[0],
-                    alt: image.description || image.name || '',
-                    thumbnail: derivatives.thumbnail
-                }
-            }
-            return {
-                url: derivatives.webImage,
-                alt: image.description || image.name || '',
-                thumbnail: derivatives.thumbnail
-            }
-        }
+    return url
+}
+
+function handleVideoImage(image) {
+    const derivatives = image.derivatives || {}
+    const url = (image.previewUrls || []).length > 0 ? image.previewUrls[0] : derivatives.webImage
+    return {
+        url,
+        alt: image.description || image.name || '',
+        thumbnail: derivatives.thumbnail
     }
-    if ((image || {}).derivatives) {
-        const derivatives = image.derivatives || {}
-        // isSvg will only work if a public link to the original derivative is authored on the bynder asset.
-        const isSvg = derivatives.original && derivatives.original.includes('.svg');
-        let imgURL = derivatives.webImage
-        let thumbnail = derivatives.thumbnail
-        if (isSvg) {
-            imgURL = derivatives.original
-        } else if (derivatives.transformBaseUrl && useDAT) {
-            imgURL = thumbnail = `${derivatives.transformBaseUrl}${useWebp ? '.webp' : ''}`
-            if (width || height) {
-                imgURL += `?quality=${quality}&io=transform:${transform}${width ? `,width:${width}` : ''}${height ? `,height:${height}` : ''}`
-            } else if (quality && quality !== 100) {
-                imgURL += `?quality=${quality}`
-            }
-            thumbnail += '?quality=85&io=transform:fill,width:50,height:50'
-        }
+}
+
+function handleDerivativesImage(image, useWebp, width, height, quality, transform, useDAT) {
+    const derivatives = image.derivatives || {}
+    const isSvg = derivatives.original?.includes('.svg')
+    if (isSvg) {
         return {
-            url: imgURL,
-            alt:
-                (image.meta || {}).SEO_Tags ||
-                image.description ||
-                image.name ||
-                '',
-            thumbnail: thumbnail
+            url: derivatives.original,
+            alt: getImageAlt(image),
+            thumbnail: derivatives.thumbnail
         }
-    } else if ((image || {}).files) {
-        const isSvg = (image.files.original || {}).url && (image.files.original || {}).url.includes('.svg');
+    }
+    if (derivatives.transformBaseUrl && useDAT) {
+        const imgURL = buildTransformUrl(derivatives.transformBaseUrl, useWebp, width, height, quality, transform)
+        const thumbnail = `${derivatives.transformBaseUrl}${useWebp ? '.webp' : ''}?quality=85&io=transform:fill,width:50,height:50`
         return {
-            url: isSvg ? (image.files.original || {}).url : (image.files.webImage || {}).url,
-            alt:
-                (image.meta || {}).SEO_Tags ||
-                image.description ||
-                image.name ||
-                '',
-            thumbnail: (image.files.thumbnail || {}).url
+            url: imgURL,
+            alt: getImageAlt(image),
+            thumbnail
         }
     }
-    return (image || {}).url
-        ? {
-            url: image.url,
-            alt: image.description || image.title || '',
-            thumbnail: image.url
-        }
-        : null
+    return {
+        url: derivatives.webImage,
+        alt: getImageAlt(image),
+        thumbnail: derivatives.thumbnail
+    }
+}
+
+function handleFilesImage(image) {
+    const isSvg = image?.files?.original?.url?.includes('.svg')
+    return {
+        url: isSvg ? image.files.original.url : image?.files?.webImage?.url,
+        alt: getImageAlt(image),
+        thumbnail: image?.files?.thumbnail?.url
+    }
+}
+
+function mapImage(image, useWebp, width, height, quality, transform, useDAT) {
+    if (Array.isArray(image)) {
+        image = image[0]
+    }
+    const params = {
+        useWebp: !!useWebp,
+        quality: quality || 100,
+        transform: transform || 'fit',
+        useDAT: !!useDAT
+    }
+    if (image?.type === 'VIDEO') {
+        return handleVideoImage(image)
+    }
+    if (image?.derivatives) {
+        return handleDerivativesImage(image, params.useWebp, width, height, params.quality, params.transform, params.useDAT)
+    }
+    if (image?.files) {
+        return handleFilesImage(image)
+    }
+    return image?.url ? {
+        url: image.url,
+        alt: image.description || image.title || '',
+        thumbnail: image.url
+    } : null
 }
 
 function mapLink(link) {
@@ -604,9 +598,9 @@ function mapProductDetails(productOrVariant) {
     }
     const includedItems = productDetails.included_items
     const highlights = (productDetails.highlights || []).map((highlight) => ({
-        iconUrl: !isNullOrEmpty(highlight.icon_bynder)
-            ? (mapImage(highlight.icon_bynder, true, 60, 60, 95, null, productOrVariant?.useDAT) || {}).url
-            : (highlight.icon || {}).url,
+        iconUrl: !isNullOrEmpty(highlight?.icon_bynder)
+            ? mapImage(highlight?.icon_bynder, true, 60, 60, 95, null, productOrVariant?.useDAT)?.url
+            : highlight?.icon?.url,
         label: highlight.text
     }))
     const originCountry = productDetails.origin_country
@@ -861,77 +855,68 @@ function mapResources(productOrVariant) {
     }
 }
 
+function getNutritionInformationImage(ingredients, useDAT) {
+    if (!isNullOrEmpty(ingredients?.nutrition_information_image_bynder)) {
+        return mapImage(ingredients.nutrition_information_image_bynder, true, null, 1200, 95, null, useDAT)
+    }
+    if (ingredients?.nutrition_information_image) {
+        return {
+            url: ingredients.nutrition_information_image.url,
+            alt: ingredients.nutrition_information_image.title
+        }
+    }
+    return null
+}
+
 /* istanbul ignore next */
 function mapIngredients(ings, legacyIngredients, useDAT) {
     if (Array.isArray(ings)) {
         return ings.map((ingredients) => ({
-            keyIngredients: ((ingredients || {}).key_ingredients || []).map(
+            keyIngredients: (ingredients?.key_ingredients || []).map(
                 (keyIngredient) => ({
-                    image: !isNullOrEmpty(keyIngredient.icon_bynder)
+                    image: !isNullOrEmpty(keyIngredient?.icon_bynder)
                         ? mapImage(keyIngredient.icon_bynder, true, 100, 100, 95, null, useDAT)
                         : {
-                            url: (keyIngredient.icon || {}).url,
-                            alt: (keyIngredient.icon || {}).title
+                            url: keyIngredient?.icon?.url,
+                            alt: keyIngredient?.icon?.title
                         },
-                    name: keyIngredient.header,
-                    description: keyIngredient.description
+                    name: keyIngredient?.header,
+                    description: keyIngredient?.description
                 })
             ),
-            nutritionInformationImage: !isNullOrEmpty(
-                (ingredients || {}).nutrition_information_image_bynder
-            )
-                ? mapImage(ingredients.nutrition_information_image_bynder, true, null, 1200, 95, null, useDAT)
-                : (ingredients || {}).nutrition_information_image
-                    ? {
-                        url: ingredients.nutrition_information_image.url,
-                        alt: ingredients.nutrition_information_image.title
-                    }
-                    : null,
-            productName: (ingredients || {}).product_name,
-            allIngredients: decodeHTML((ingredients || {}).all_ingredients),
-            otherIngredients: (ingredients || {}).other_ingredients,
-            activeIngredients: (ingredients || {}).active_ingredients,
-            inactiveIngredients: (ingredients || {}).inactive_ingredients,
-            ingredientDisclaimers:
-                (ingredients || {}).ingredient_disclaimers || [],
-            markdown: legacyIngredients
-                ? htmlToMarkdown(legacyIngredients)
-                : null
+            nutritionInformationImage: getNutritionInformationImage(ingredients, useDAT),
+            productName: ingredients?.product_name,
+            allIngredients: decodeHTML(ingredients?.all_ingredients),
+            otherIngredients: ingredients?.other_ingredients,
+            activeIngredients: ingredients?.active_ingredients,
+            inactiveIngredients: ingredients?.inactive_ingredients,
+            ingredientDisclaimers: ingredients?.ingredient_disclaimers || [],
+            markdown: legacyIngredients ? htmlToMarkdown(legacyIngredients) : null
         }))
     }
 
-    const keyIngredients = (ings || {}).key_ingredients || []
+    const keyIngredients = ings?.key_ingredients || []
     if (keyIngredients.length > 0) {
         return [
             {
                 keyIngredients: keyIngredients.map((keyIngredient) => ({
-                    image: !isNullOrEmpty(keyIngredient.icon_bynder)
+                    image: !isNullOrEmpty(keyIngredient?.icon_bynder)
                         ? mapImage(keyIngredient.icon_bynder, true, 100, 100, 95, null, useDAT)
                         : {
-                            url: (keyIngredient.icon || {}).url,
-                            alt: (keyIngredient.icon || {}).title
+                            url: keyIngredient?.icon?.url,
+                            alt: keyIngredient?.icon?.title
                         },
-                    name: keyIngredient.header,
-                    description: keyIngredient.description
+                    name: keyIngredient?.header,
+                    description: keyIngredient?.description
                 })),
-                nutritionInformationImage: !isNullOrEmpty(
-                    (ings || {}).nutrition_information_image_bynder
-                )
-                    ? mapImage(ings.nutrition_information_image_bynder, true, null, 1200, 95, null, useDAT)
-                    : (ings || {}).nutrition_information_image
-                        ? {
-                            url: ings.nutrition_information_image.url,
-                            alt: ings.nutrition_information_image.title
-                        }: null,
-                allIngredients: decodeHTML((ings || {}).all_ingredients),
-                otherIngredients: (ings || {}).other_ingredients,
-                activeIngredients: (ings || {}).active_ingredients,
-                inactiveIngredients: (ings || {}).inactive_ingredients,
+                nutritionInformationImage: getNutritionInformationImage(ings, useDAT),
+                allIngredients: decodeHTML(ings?.all_ingredients),
+                otherIngredients: ings?.other_ingredients,
+                activeIngredients: ings?.active_ingredients,
+                inactiveIngredients: ings?.inactive_ingredients,
                 ingredientDisclaimers:
-                    (ings || {}).ingredient_disclaimers || [],
-                markdown: legacyIngredients
-                    ? htmlToMarkdown(legacyIngredients)
-                    : null
+                    ings?.ingredient_disclaimers || [],
+                markdown: legacyIngredients ? htmlToMarkdown(legacyIngredients) : null
             }
         ]
     }
@@ -993,7 +978,7 @@ function mapActiveEventDisclaimer(activeEventDisclaimer) {
 
 function hasRichTextContent(richText) {
     // when cleared, the rich text json still contains children, this checks for any text or links
-    return ((richText || {}).children || []).some((line) =>
+    return (richText?.children || []).some((line) =>
         (line.children || []).some(
             (block) =>
                 (!!block.text &&
@@ -1022,13 +1007,13 @@ function createMarkdownWithModifiers(text, bold, italic) {
 
 function createMarkdownFromRichText(richText) {
     let markdown = ''
-    for (const [index, line] of ((richText || {}).children || []).entries()) {
+    for (const [index, line] of (richText?.children || []).entries()) {
         if (index > 0) {
             markdown += '\n'
         }
         for (const block of line.children) {
             if (block.type === 'a') {
-                const url = (block.attrs || {}).url || ''
+                const url = block?.attrs?.url || ''
                 for (const part of block.children) {
                     const linkMarkdown = `[${part.text}](${url})`
                     markdown += createMarkdownWithModifiers(
@@ -1111,13 +1096,11 @@ const arrayString = (array) => {
 /* istanbul ignore next */
 function mapWarranty(product) {
     if (
-        product &&
-        product.warranty &&
-        ((product.warranty || [])[0] || {}).derivatives
+        (product?.warranty || [])[0]?.derivatives
     ) {
         const warranty = product.warranty[0]
-        const linkText = ((product.translations || {}).warranty || {}).link_text
-        const message = ((product.translations || {}).warranty || {}).message
+        const linkText = product?.translations?.warranty?.link_text
+        const message = product?.translations?.warranty?.message
         const translationPresent = `<span>${message}</span> <b>${linkText}</b>`
         const defaultTranslation = '<b>Warranty Info</b>'
         const translation =
@@ -1137,8 +1120,7 @@ function mapWarranty(product) {
 
 function mapUpSellProductIds(product) {
     if (
-        product &&
-        product.up_sell_products &&
+        product?.up_sell_products &&
         product.up_sell_products.length > 0
     ) {
         return product.up_sell_products.map((prod) => prod.uid)
@@ -1148,8 +1130,7 @@ function mapUpSellProductIds(product) {
 
 function mapCrossProductIds(product) {
     if (
-        product &&
-        product.cross_sell_products &&
+        product?.cross_sell_products &&
         product.cross_sell_products.length > 0
     ) {
         return product.cross_sell_products.map((prod) => prod.uid)
@@ -1158,7 +1139,7 @@ function mapCrossProductIds(product) {
 }
 
 function mapFaqs(product) {
-    if (product && product.faqs && product.faqs.length > 0) {
+    if (product?.faqs && product.faqs.length > 0) {
         let jsonFaqs = JSON.stringify(product.faqs);
         if (jsonFaqs.length < 10000) {
             return product?.faqs?.map((faq) => ({