@nuskin/ns-product-lib 2.7.2-cx24-3964.1 → 2.8.0-cx12-7493.1

package/CHANGELOG.md

@@ -1,9 +1,13 @@
-## [2.7.2-cx24-3964.1](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.7.1...v2.7.2-cx24-3964.1) (2023-04-28)
+# [2.8.0-cx12-7493.1](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.7.1...v2.8.0-cx12-7493.1) (2023-05-02)
 
 
 ### Fix
 
-* Products in sales event not showing adjusted price and sales ribbon #CX24-3964 ([1242901](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/124290157798010c82b5e30a273b342fe707e884)), closes [#CX24-3964](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX24-3964)
+* lint and error fixes (#CX12-7493) ([632e74e](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/632e74ebefca8279cf5dceeb608fc9427f352096)), closes [#CX12-7493](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX12-7493)
+
+### New
+
+* Begin work on new nsProduct.js (#CX12-7493) ([e2a4ec2](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/commit/e2a4ec29ee495869ee6463a7f9a6896d1aa0f95b)), closes [#CX12-7493](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/issues/CX12-7493)
 
 ## [2.7.1](https://code.tls.nuskin.io/ns-am/product/js-libs/ns-product-lib/compare/v2.7.0...v2.7.1) (2023-04-15)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuskin/ns-product-lib",
-  "version": "2.7.2-cx24-3964.1",
+  "version": "2.8.0-cx12-7493.1",
   "description": "This project contains shared Product models and code between the backend and frontend.",
   "main": "src/index.js",
   "scripts": {
@@ -33,7 +33,7 @@
   "dependencies": {
     "@nuskin/configuration-sdk": "2.2.3",
     "@nuskin/ns-common-lib": "1.4.5",
-    "@nuskin/ns-util": "4.4.0",
+    "@nuskin/ns-util": "4.3.2",
     "axios": "0.27.2",
     "qs": "6.11.0"
   },

package/src/contentstack/environment.js

@@ -8,17 +8,21 @@ const config = {
   dev: {
     ...baseConfig,
     accessToken: 'cs74599c107573ea7f6c7a1413',
-    env: 'public-dev'
+    env: 'public-dev',
+    graphqlUrl: 'https://dev.nuskin.com/product-api/graphql'
   },
   prod: {
     ...baseConfig,
     accessToken: 'cs7029c5e32f0e99978efc683d',
-    env: 'public-prod'
+    env: 'public-prod',
+    graphqlUrl: 'https://www.nuskin.com/product-api/graphql'
+    
   },
   test: {
     ...baseConfig,
     accessToken: 'cs67e9fdd60eb15c301add40ea',
-    env: 'public-test'
+    env: 'public-test',
+    graphqlUrl: 'https://product.api.test.nuskin.com/graphql'
   }
 };
 
@@ -26,7 +30,7 @@ const config = {
  * getCredentials returns contentstack config.
  *
  * @param {string} env
- * @return {{accessToken: string; apiKey: string; env: string; url: string;}} 
+ * @return {{accessToken: string; apiKey: string; env: string; graphqlUrl: string; url: string; }} 
  */
 function getCredentials(env) {
   if (config[env] === undefined) {

package/src/index.js

@@ -15,16 +15,20 @@ const ProductStatusMapper = require("./productStatusMapper.js");
 const ProductUtils = require("./productUtils.js");
 const ProductData = require("./productData.js");
 const CustomerTypes = require('./models/customerTypes');
+const NsProduct = require('./nsProduct.js')
+const GraphQLQueries = require('./models/productGraphQLQueries')
 
 module.exports = {
   Agelocme,
   Contentstack,
+  CustomerTypes,
+  GraphQLQueries,
+  NsProduct,
   PriceType,
   Product,
   ProductContentMapper,
   ProductStatus,
   ProductStatusMapper,
   ProductUtils,
-  ProductData,
-  CustomerTypes
+  ProductData
 };

package/src/models/productGraphQLQueries.js

@@ -0,0 +1,396 @@
+'use strict'
+
+const VariantQuery = `
+    id
+    globalId
+    sku
+    slug
+    variantLabel
+    variantColor
+    title
+    salesLabel
+    salesText
+    description
+    nettoWeight
+    size
+    isExclusive
+    availableQuantity
+    maxQuantity
+    purchaseTypes {
+      buyOnce
+      subscription
+    }
+    matchingVariant
+    shadeable
+    productType
+    primaryBrand
+    brandFamily
+    marketAttributes {
+      discount
+      redeem
+      earn
+    }
+    disclaimers
+    restrictedMarkets
+    searchKeywords
+    excludeFromSearch
+    availableChannels
+    customerTypes
+    scanQualifiedCount
+    chargeShipping
+    dangerousGoods
+    channels
+    foreignOrderLimit
+    orderType
+    salesDisclaimer 
+    productImages {
+      url
+      alt
+      thumbnail
+    }
+    productDetails {
+      description
+      includedItems
+      highlights {
+        iconUrl
+        label
+      }
+      originCountry
+      importer
+      warnings
+    }
+    ingredients {
+      keyIngredients {
+        name
+        description
+        image {
+          url
+          alt
+          thumbnail
+        }
+      }
+      nutritionInformationImage {
+        url
+        alt
+        thumbnail
+      }
+      productName
+      allIngredients
+      otherIngredients
+      activeIngredients
+      inactiveIngredients
+      ingredientDisclaimers
+      markdown
+    }
+    disclaimerWarnings {
+      icon {
+        url
+        alt
+        thumbnail
+      }
+      markdown
+    }
+    features {
+      image {
+        url
+        alt
+        thumbnail
+      }
+      subtitle
+      features
+      backgroundColor
+      textColor
+    }
+    benefits {
+      benefits
+      youTubeVideoId
+      image {
+        url
+        alt
+        thumbnail
+      }
+    }
+    results {
+      summary
+      results {
+        percentage
+        text
+      }
+      report {
+        url
+        text
+      }
+      youTubeVideoId
+      image {
+        url
+        alt
+        thumbnail
+      }
+    }
+    usage {
+      steps
+      recommendations
+      warnings
+      additionalText
+      youTubeVideoId
+      image {
+        url
+        alt
+        thumbnail
+      }
+      markdown
+    }
+    resources {
+      title
+      url
+      image {
+        url
+        alt
+        thumbnail
+      }
+    }
+    faqs {
+      question
+      answers
+    }
+    status {
+        status
+        isBackordered
+        backorderedAvailableDate
+    }
+  `;
+
+const BundleProduct = `
+  type
+  price {
+    currencyCode
+    retail
+    wholesale
+    retailSales
+    wholesaleSales
+    retailSubscription
+    wholesaleSubscription
+  }
+  retailDiscount
+  wholesaleDiscount
+  pvDiscount
+  cvDiscount
+  sbDiscount
+  grpDiscount
+  availableChannels
+  customerTypes
+  purchaseTypes {
+    buyOnce
+    subscription
+  }
+  status {
+    status
+    isBackordered
+    backorderedAvailableDate
+  }
+  availableQuantity
+  chargeShipping
+  dangerousGoods
+  excludeFromSearch
+  isExclusive
+  marketAttributes {
+    discount
+    redeem
+    earn
+  }
+  restrictedMarkets
+  scanQualifiedCount
+  kitProducts {
+    quantity
+    isMandatory
+    product {
+      id
+    }
+  }
+`;
+
+const ProductQuery = `
+    id
+    slug
+    variantSelectLabel
+    title
+    productImages {
+      url
+      alt
+      thumbnail
+    }
+    salesLabel
+    salesText
+    description
+    salesDisclaimer
+    features {
+      image {
+        url
+        alt
+        thumbnail
+      }
+      subtitle
+      features
+      backgroundColor
+      textColor
+    }
+    productDetails {
+      description
+      includedItems
+      highlights {
+        iconUrl
+        label
+      }
+      originCountry
+      importer
+      warnings
+    }
+    benefits {
+      benefits
+      youTubeVideoId
+      image {
+        url
+        alt
+        thumbnail
+      }
+    }
+    results {
+      summary
+      results {
+        percentage
+        text
+      }
+      report {
+        url
+        text
+      }
+      youTubeVideoId
+      image {
+        url
+        alt
+        thumbnail
+      }
+    }
+    sustainability {
+      youTubeVideoId
+      description
+      highlights {
+        description
+        image {
+          url
+          alt
+          thumbnail
+        }
+      }
+      image {
+        url
+        alt
+        thumbnail
+      }
+    }
+    usage {
+      steps
+      recommendations
+      warnings
+      additionalText
+      youTubeVideoId
+      image {
+        url
+        alt
+        thumbnail
+      }
+      markdown
+    }
+    resources {
+      title
+      url
+      image {
+        url
+        alt
+        thumbnail
+      }
+    }
+    faqs {
+      question
+      answers
+    }
+    ingredients {
+      keyIngredients {
+        name
+        description
+        image {
+          url
+          alt
+          thumbnail
+        }
+      }
+      nutritionInformationImage {
+        url
+        alt
+        thumbnail
+      }
+      productName
+      allIngredients
+      otherIngredients
+      activeIngredients
+      inactiveIngredients
+      ingredientDisclaimers
+      markdown
+    }
+    disclaimers
+    disclaimerWarnings {
+      icon {
+        url
+        alt
+        thumbnail
+      }
+      markdown
+    }
+    seoInformation {
+      metaDescription
+      metaTitle
+      canonicalURL
+      ogImage {
+        url
+        alt
+        thumbnail
+      }
+    }
+    refundPolicy
+    shippingText
+    thirdPartyScripts
+    categories {
+      displayName
+      id
+      subcategories {
+        displayName
+        id
+      }
+    }
+    warranty
+    secondaryTitle
+    variants {
+      ${VariantQuery}
+    }
+    bundle {
+      ${BundleProduct}
+    }
+    productDataSource {
+        source
+        webBaseUrl
+        apiBaseUrl
+        storeId
+    }
+    error {
+        name
+        errors
+        lines
+        message
+        status
+    }
+`;
+
+module.exports = {
+  VariantQuery,
+  ProductQuery
+}

package/src/nsProduct.js

@@ -0,0 +1,108 @@
+'use strict'
+
+const axios = require('axios')
+const {ProductQuery} = require('./models/productGraphQLQueries')
+const config = require('./contentstack/environment')
+
+let envConfig = {}
+
+const processProps = (props) => {
+  if (!props) {
+    return "empty"
+  } else if (props.fromId) {
+    if(!props.env || !['dev', 'test', 'prod'].includes(props.env)) {
+      return "missingEnv"
+    }
+    else {
+      return "id"
+    }
+  } else if (props.fromSlug) {
+    if(!props.env || !['dev', 'test', 'prod'].includes(props.env)) {
+      return "missingEnv"
+    } else {
+      return "slug"
+    }
+  } else if (props.data) {
+    return "data"
+  } 
+}
+
+const getProductById = async(id, market, language) => {
+  const payload = {variables:{market, language, id}}
+  payload.operationName = 'ProductById'
+  payload.query = `query ProductById($id: String!, $market: String, $language: String) {
+            productById(id: $id, market: $market, language: $language) {
+              ${ProductQuery}}}`
+  try {
+    const idRes = await axios.post(`${envConfig.graphqlUrl}`, payload);
+    return ((idRes.data || {}).data || {}).productById || idRes.error;
+  } catch(ex) {
+    console.error(ex)
+  }
+}
+
+const getProductBySlug = async(slug, market, language) => {
+  const payload = {variables:{market, language, slug}}
+  payload.operationName = 'ProductBySlug'
+  payload.query = `query ProductBySlug($slug: String!, $market: String, $language: String) {
+              productBySlug(slug: $slug, market: $market, language: $language) {
+                ${ProductQuery}}}`
+  try {
+    const idRes = await axios.post(`${envConfig.graphqlUrl}`, payload);
+    return ((idRes.data || {}).data || {}).productBySlug || idRes.error;
+  } catch(ex) {
+    console.error(ex)
+  }
+}
+
+/*
+    This is the "constructor" for a nuskin product object. 
+    You send it an object that will be used to determine what to do  when it initializes
+    Possible options:
+        {} - Create an empty nsProduct object with no data
+        {data: Object} - Create an object using the data previously retrived from the product graphql
+        {fromId: String, market: String, language: String, env: String} - Create an object using data retrieved using the ID, market, language, environment sent
+        {fromSlug: String, market: String, language: String, env: String} - Create an object using data retrieved using the slug, market, language, environment sent
+
+    Example usage:
+        const product = await nsProduct({fromSlug: 'tegreen', market: 'US', language: 'en', env: 'dev'});
+        const fromSku = await nsProduct({fromId: '01003440', market: 'US', language: 'en', env: 'dev'});
+        const fromUid = await nsProduct({fromId: 'blta50746fc33f83470', market: 'US', language: 'en', env: 'dev'});
+*/
+const nsProduct = async (props) =>
+{
+  let data = {}
+  // Validate props passed in
+  const constructorType = processProps(props)
+  if (constructorType === 'missingEnv') {
+    data.error = "Missing env in props, please include the environment and re-initialize"
+  } else if (['id', 'slug'].includes(constructorType)) {
+    // initialize configs and libs
+    envConfig = config.getCredentials(props.env);
+  }
+  // Initialize NsProduct based on constructor used
+  switch (constructorType) {
+    case "id":
+      data = await getProductById(props.fromId, props.market || 'US', props.language || 'en') || {}
+      break
+    case "slug":
+      data = await getProductBySlug(props.fromSlug, props.market || 'US', props.language || 'en') || {}
+      break
+    case "data":
+      data = props.data
+      break
+  }
+
+  const getPricing = async() => {
+    data.pricing = await "hello"
+  }
+
+  return {
+    data,
+    getPricing
+  }
+}
+
+module.exports = {
+  nsProduct
+}