@nuskin/contentstack-lib 1.0.0-pur-1208.2 → 1.0.0

package/.releaserc

@@ -1,6 +1,6 @@
 {
     "branches": [
-      "master", {"name":"PUR-1208", "channel":"prerelease", "prerelease":"pur-1208"}
+      "master"
     ],
     "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

@@ -48,43 +48,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');

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)
+# 1.0.0 (2024-09-30)

package/gl-sbom-npm-yarn.cdx.json

@@ -1,15 +1,15 @@
 {
   "bomFormat": "CycloneDX",
   "specVersion": "1.4",
-  "serialNumber": "urn:uuid:dc2481eb-ad26-437b-800b-0c6d982cf40d",
+  "serialNumber": "urn:uuid:701c511f-f50c-425c-8761-df965916315e",
   "version": 1,
   "metadata": {
-    "timestamp": "2024-09-17T23:00:18Z",
+    "timestamp": "2024-09-30T15:46:41Z",
     "tools": [
       {
         "vendor": "GitLab",
         "name": "Gemnasium",
-        "version": "5.7.0"
+        "version": "5.7.2"
       }
     ],
     "authors": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuskin/contentstack-lib",
-  "version": "1.0.0-pur-1208.2",
+  "version": "1.0.0",
   "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

@@ -169,6 +169,13 @@ function getStack() {
   return Stack;
 }
 
+/**
+ * init needs to be called first before getStack can be called
+ *
+ * @param {string} env - environment for the getStack call
+ * @param {stirng} apiKey - api_key for the getStack call
+ * @param {string} deliveryToken - delivery_token for the getStack call
+ */
 function init({env, apiKey, deliveryToken}) {
   environment = env;
   api_key = apiKey;