@nuskin/contentstack-lib 1.0.0-pur-1208.2 → 2.0.0-pa-954.1

package/.releaserc

@@ -1,6 +1,6 @@
 {
     "branches": [
-      "master", {"name":"PUR-1208", "channel":"prerelease", "prerelease":"pur-1208"}
+      "master", {"name":"PA-954", "channel":"prerelease", "prerelease":"pa-954"}
     ],
     "plugins": [
         "@semantic-release/release-notes-generator",

package/README.md

@@ -1,36 +1,38 @@
-# @nuskin/ns-contentstack-lib
+# @nuskin/contentstack-lib
 
 This project extends the Contentstack delivery sdk, to be shared between the backend (AWS Lambda) and frontend.
 1. It simplifies initializing the Stack object.
 2. It extends the stack with a new function getSingletonEntries most commonly used to get translations
 3. CONTENTSTACK DOES NOT MERGE COMMON ENGLISH WITH US-en STRINGS.  FALLBACK IN CONTENTSTACK DOES NOT WORK AS EXPECTED.
 getSingletonEntries TAKES AN OPTION CALLED mergeWithFallback.  IF THAT IS SET TO TRUE THEN IT WILL MERGE THE RESULTS
-FOR COMMON SPANISH AND MX-es FOR EXAMPLE. 
+FOR COMMON SPANISH AND MX-es FOR EXAMPLE.
 4. getSingletonEntries also allows you to convert the keys from snake case to camel case.
 
 ## Installing
 
-Update the .npmrc in your project to use the nexus registry @ns:registry=https://nexus3.nuskin.net/repository/npm-internal/
-
 Usng npm:
 
 ```bash
-npm install @ns/ns-contentstack-lib
+npm install @nuskin/contentstack-lib
 ```
 
 Usng yarn:
 
 ```bash
-yarn add @ns/ns-contentstack-lib
+yarn add @nuskin/contentstack-lib
 ```
 
 ## Example usage
 
 ```js
-const { getStack } = require('@ns/ns-contentstack-lib')
+const { getStack, init } = require('@nuskin/contentstack-lib')
+
+// Initialize the module with params needed for connecting to contentstack
+// These fields can be gotten from the parameter store
+init({env, apiKey, deliveryToken})
 
-// Pass the environment to getStack (dev, test, stage, prod)
-const Stack = getStack('dev')
+// Call getStack to get the stack object
+const Stack = getStack()
 
 // get all languages
 const languages = await Stack.ContentType('supported_language').Query().toJSON().find();
@@ -44,7 +46,7 @@ const translations = Stack.getStrings({
     contentTypes: ['checkout_adr_strings', 'checkout_cart_strings'],  // List of content types you want to get translations for
     language: 'en',
     country: 'US',
-    merge: true  // Will combine checkout_adr_strings and checkout_cart_strings object with single list of strings 
+    merge: true  // Will combine checkout_adr_strings and checkout_cart_strings object with single list of strings
 });
 
 // Use this function instead to get your translations
@@ -65,12 +67,12 @@ const [
     mergeWithFallback: true
   });
 
-// We could possibly add functionality to return the list of regions markets and languages in a single object structure 
+// We could possibly add functionality to return the list of regions markets and languages in a single object structure
 ```
 
 ## Resources
 
-- https://code.tls.nuskin.io/ns-am/utility/npm/ns-contentstack-lib
+- https://code.tls.nuskin.io/ns-am/utility/npm/contentstack-lib
 
 ## License
 

package/__tests__/api.spec.js

@@ -8,12 +8,38 @@ const singleCheckoutAdrStringsCommon = require('./resources/singleCheckoutAdrStr
 const singleCheckoutCartStrings = require('./resources/singleCheckoutCartStrings.json');
 const singleCheckoutAdrCamelResult = require('./resources/singleCheckoutAdrStringsCamel.json');
 const singleCheckoutCartCamelResult = require('./resources/singleCheckoutCartStringsCamel.json');
+const {contentstack: devEnvConfig} = require(`../config/dev.json`);
+const {contentstack: testEnvConfig} = require(`../config/test.json`);
+const {contentstack: stageEnvConfig} = require(`../config/stage.json`);
+const {contentstack: prodEnvConfig} = require(`../config/prod.json`);
 const mockPromiseResult = jest.fn();
 const mockSinglePromiseResult = jest.fn();
 const mockStack = jest.fn();
 
-const apiKey = 'testkey';
-const deliveryToken = 'testDeliveryToken';
+function getConfig(env) {
+  let config = {};
+
+  switch (env) {
+    case 'dev': {
+      config = devEnvConfig;
+      break;
+    }
+    case 'test': {
+      config = testEnvConfig;
+      break;
+    }
+    case 'stage': {
+      config = stageEnvConfig;
+      break;
+    }
+    case 'prod': {
+      config = prodEnvConfig;
+      break;
+    }
+  }
+
+  return config;
+}
 
 beforeEach(() => {
   mockStack.mockImplementation(() => ({
@@ -48,43 +74,6 @@ const mockResults = () => {
 }
 
 describe("ContentstackApi", () => {
-  // test("retries with just the language if can't get strings for country", async () => {
-  //   mockPromiseResult.mockClear();
-  //   mockPromiseResult.mockRejectedValueOnce(new Error("Failed"));
-  //   mockResults();
-  //   const {getStack} = require('../src/api');
-  //   const Stack = getStack('dev');
-  //   await Stack.getStrings({contentTypes: ['checkout_adr_strings', 'checkout_cart_strings'], language: 'en', country: 'US', merge: true});
-  //   expect(mockPromiseResult).toHaveBeenCalledTimes(4);
-  // });
-
-  // test("getStrings for multiple contentTypes", async () => {
-  //   mockResults();
-  //   const {getStack} = require('../src/api');
-  //   const Stack = getStack('dev');
-  //   const strings = await Stack.getStrings({contentTypes: ['checkout_adr_strings', 'checkout_cart_strings'], language: 'en', merge: false});
-  //   expect(strings).toStrictEqual(stringsResult);
-  // });
-
-  // test("getStrings merged", async () => {
-  //   mockResults();
-  //   const {getStack} = require('../src/api');
-  //   const Stack = getStack('dev');
-  //   const strings = await Stack.getStrings({contentTypes: ['checkout_adr_strings', 'checkout_cart_strings'], language: 'en', merge: true});
-  //   expect(strings).toStrictEqual(mergedResult);
-  // });
-
-  // test("getStrings throws error", async () => {
-  //   mockResults();
-  //   const {getStack} = require('../src/api');
-  //   const Stack = getStack('dev');
-  //   try {
-  //     await Stack.getStrings({});
-  //   } catch(err) {
-  //     expect(err).toStrictEqual(new Error('Call to getStrings: options.contentTypes and language are required'));
-  //   }
-  // })
-
   test("getSingletonEntries", async () => {
     mockResults();
     const {getStack} = require('../src/api');
@@ -96,9 +85,8 @@ describe("ContentstackApi", () => {
 
   test("getSingletonEntries in camelcase", async () => {
     mockResults();
-    const {getStack, init} = require('../src/api');
-    init({env: 'dev'})
-    const Stack = getStack();
+    const {getStack} = require('../src/api');
+    const Stack = getStack('dev');
     const [checkoutAdrStrings, checkoutCartStrings] = await Stack.getSingletonEntries({contentTypeUIDs: ['checkout_adr_strings', 'checkout_cart_strings'], language: 'en', camelcase: true});
     expect(checkoutAdrStrings).toStrictEqual(singleCheckoutAdrCamelResult);
     expect(checkoutCartStrings).toStrictEqual(singleCheckoutCartCamelResult);
@@ -109,9 +97,8 @@ describe("ContentstackApi", () => {
     mockSinglePromiseResult.mockResolvedValueOnce(singleCheckoutAdrStringsCommon);
     // The second api call is for en_US
     mockSinglePromiseResult.mockResolvedValueOnce(singleCheckoutAdrStrings);
-    const {getStack, init} = require('../src/api');
-    init({})
-    const Stack = getStack();
+    const {getStack} = require('../src/api');
+    const Stack = getStack('dev');
     const [checkoutAdrStrings] = await Stack.getSingletonEntries({contentTypeUIDs: ['checkout_adr_strings'], language: 'en', country: 'US', mergeWithFallback: true});
     expect(checkoutAdrStrings.overridden_value).toEqual("This value overrides the common value");
     expect(checkoutAdrStrings.new_value).toEqual("This value only exists in en_US");
@@ -120,8 +107,7 @@ describe("ContentstackApi", () => {
 
   test("getSingletonEntries throws error", async () => {
     mockResults();
-    const {getStack, init} = require('../src/api');
-    init({deliveryToken, apiKey});
+    const {getStack} = require('../src/api');
     const Stack = getStack();
     try {
       await Stack.getSingletonEntries({});
@@ -132,10 +118,9 @@ describe("ContentstackApi", () => {
 
   test("getStack initialized using sdk", () => {
     mockResults();
-    const {getStack, init} = require('../src/api');
-    init({apiKey, deliveryToken, env: 'test'});
-    getStack();
-    expect(mockStack).toHaveBeenCalledWith({api_key: apiKey, delivery_token: deliveryToken, environment: 'test'});
+    const {getStack} = require('../src/api');
+    getStack('dev');
+    expect(mockStack).toHaveBeenCalledWith({api_key: devEnvConfig.apiKey, delivery_token: devEnvConfig.deliveryToken, environment: 'public-dev'});
   });
 
   test('getStack without environment', () => {
@@ -143,13 +128,13 @@ describe("ContentstackApi", () => {
     const hostnames = ['dev.nuskin.com', 'test.nuskin.com', 'stage.nuskin.com', 'www.nuskin.com'];
     const env = ['dev', 'test', 'stage', 'prod'];
     hostnames.forEach((hostname, index) => {
+      const csCfg = getConfig(env[index]);
       delete global.window.location;
       global.window = Object.create(window);
       global.window.location = { hostname };
-      const {getStack, init} = require('../src/api');
-      init({apiKey, deliveryToken})
-      getStack();
-      expect(mockStack).toHaveBeenCalledWith({api_key: apiKey, delivery_token: deliveryToken, environment: env[index]});
+      const {getStack} = require('../src/api');
+      getStack(env[index]);
+      expect(mockStack).toHaveBeenCalledWith({api_key: csCfg.apiKey, delivery_token: csCfg.deliveryToken, environment: csCfg.environment});
     })
   })
 });

package/config/dev.json

@@ -1,6 +1,8 @@
 {
   "contentstack": {
     "baseUrl": "https://cdn.contentstack.io",
-    "environment": "public-dev"
+    "environment": "public-dev",
+    "apiKey": "blt7d4c4f4a1bf5a819",
+    "deliveryToken": "csb0f10375c807538aad91a5e7"
   }
 }

package/config/prod.json

@@ -1,6 +1,8 @@
 {
   "contentstack": {
     "baseUrl": "https://cdn.contentstack.io",
-    "environment": "public-prod"
+    "environment": "public-prod",
+    "apiKey": "blt7d4c4f4a1bf5a819",
+    "deliveryToken": "cs7029c5e32f0e99978efc683d"
   }
 }

package/config/stage.json

@@ -1,6 +1,8 @@
 {
   "contentstack": {
     "baseUrl": "https://cdn.contentstack.io",
-    "environment": "public-stage"
+    "environment": "public-stage",
+    "apiKey": "blt7d4c4f4a1bf5a819",
+    "deliveryToken": "cs4c1de6b00d219e11c4863215"
   }
 }

package/config/test.json

@@ -1,6 +1,8 @@
 {
   "contentstack": {
     "baseUrl": "https://cdn.contentstack.io",
-    "environment": "public-test"
+    "environment": "public-test",
+    "apiKey": "blt7d4c4f4a1bf5a819",
+    "deliveryToken": "cs9a111e7615cf94011266b5e6"
   }
 }

package/docs/CHANGELOG.md

@@ -1 +1 @@
-# [1.0.0-pur-1208.2](https://code.tls.nuskin.io/ns-am/utility/npm/contentstack-lib/compare/v1.0.0-pur-1208.1...v1.0.0-pur-1208.2) (2024-09-17)
+# [2.0.0-pa-954.1](https://code.tls.nuskin.io/ns-am/utility/npm/contentstack-lib/compare/v1.0.0...v2.0.0-pa-954.1) (2026-03-09)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuskin/contentstack-lib",
-  "version": "1.0.0-pur-1208.2",
+  "version": "2.0.0-pa-954.1",
   "description": "This project contains configuration and api code to access Contentstack, to be shared between the backend (AWS Lambda) and frontend (Vue, etc).",
   "main": "src/index.js",
   "scripts": {

package/src/api.js

@@ -1,13 +1,14 @@
 "use strict";
 
 const Contentstack = require('contentstack');
+const {contentstack: devEnvConfig} = require(`../config/dev.json`);
+const {contentstack: testEnvConfig} = require(`../config/test.json`);
+const {contentstack: stageEnvConfig} = require(`../config/stage.json`);
+const {contentstack: prodEnvConfig} = require(`../config/prod.json`);
+
 let env = null;
 let Stack = null;
 
-let api_key;
-let delivery_token;
-let environment;
-
 const COMMON_LANGUAGES = {
   'da': 'da-dk',
   'id': 'id-id',
@@ -21,6 +22,36 @@ const COMMON_LANGUAGES = {
   'tr': 'tr-tr'
 };
 
+/**
+ * Gets the correct contentstack config settings
+ * @param {string} env
+ * @returns {object}
+ */
+function getConfig(env) {
+  let config = {};
+
+  switch (env) {
+    case 'dev': {
+      config = devEnvConfig;
+      break;
+    }
+    case 'test': {
+      config = testEnvConfig;
+      break;
+    }
+    case 'stage': {
+      config = stageEnvConfig;
+      break;
+    }
+    case 'prod': {
+      config = prodEnvConfig;
+      break;
+    }
+  }
+
+  return config;
+}
+
 /**
  * Convert string from snake case to camel case
  * @param {string} snakeCasedString
@@ -144,23 +175,24 @@ async function getSingletonEntries(options) {
 
 /**
  * Returns contentstack Stack object initialized with the api key, deliveryToken, and extended with custom functionality
- * @param {'dev' | 'test' | 'stage' | 'prod'} environment
+ * @param {'dev' | 'test' | 'stage' | 'prod'} envrnmnt
  * @return {Object} Stack - contentstack Stack sdk object with additional getStrings function
  */
-function getStack() {
-  if (!environment) {
+function getStack(envrnmnt) {
+  if (!envrnmnt) {
     if (!window || !window.location) {
       throw new Error('Environment must be passed into getStack');
     }
-    environment = _getEnv();
+    envrnmnt = _getEnv();
   }
 
   // If the environment requested hasn't changed return the stack we already have
-  if (environment === env && Stack) {
+  if (envrnmnt === env && Stack) {
     return Stack;
   }
 
-  env = environment;
+  env = envrnmnt;
+  const {apiKey: api_key, deliveryToken: delivery_token, environment} = getConfig(env)
   Stack = Contentstack.Stack({api_key, delivery_token, environment})
 
   // extend the Stack with a custom function to get translations
@@ -169,13 +201,6 @@ function getStack() {
   return Stack;
 }
 
-function init({env, apiKey, deliveryToken}) {
-  environment = env;
-  api_key = apiKey;
-  delivery_token = deliveryToken;
-}
-
 module.exports = {
-  init,
   getStack
 };