@nuskin/contentstack-lib 2.1.0-pa-1117.6 → 2.1.0-pa-1117.8

package/README.md

@@ -11,13 +11,13 @@ FOR COMMON SPANISH AND MX-es FOR EXAMPLE.
 
 ## Installing
 
-Usng npm:
+Using npm:
 
 ```bash
 npm install @nuskin/contentstack-lib
 ```
 
-Usng yarn:
+Using yarn:
 
 ```bash
 yarn add @nuskin/contentstack-lib
@@ -28,8 +28,9 @@ yarn add @nuskin/contentstack-lib
 ```js
 const { getStack } = require('@nuskin/contentstack-lib')
 
-// Call getStack to get the stack object
-const Stack = getStack()
+// Pass an environment explicitly outside the browser.
+// In the browser, getStack() can infer the env from the hostname.
+const Stack = getStack('prod')
 
 // get all languages
 const languages = await Stack.ContentType('supported_language').Query().toJSON().find();
@@ -37,16 +38,6 @@ const languages = await Stack.ContentType('supported_language').Query().toJSON()
 // get all markets
 const markets = await Stack.ContentType('market').Query().toJSON().find();
 
-// Use the extended getStrings function to get translations
-// ==================== Deprecated - Dont use this function ==========================
-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
-});
-
-// Use this function instead to get your translations
 // The entries are returned in the order they were requested so you can destructure the array accordingly
 // To get the result in camelcase instead of snake case you can pass in the option.camelcase: true
 // Contentstack does not merge common english strings with en_US strings.  This function allows you to merge the two with mergeWithFallback: true
@@ -76,10 +67,13 @@ const addressForms = await Stack.getAddressForms(['United States']);
 //         field: 'address1',
 //         width: 'full',
 //         editable: true,
-//         max_length: 40
+//         max_length: 40,
+//         required: true
 //       }
 //     ],
-//     postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$'
+//     postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$',
+//     verify_after_autocomplete: true,
+//     wrap_address1_to_address2: false
 //   }
 // ]
 
@@ -87,8 +81,54 @@ const addressForms = await Stack.getAddressForms(['United States']);
 const camelizedAddressForms = await Stack.getAddressForms(['United States'], true);
 
 // Get shipping address forms with referenced address form fields expanded.
-// The second parameter works the same way here.
+// countries is normalized to a list of { code, name } objects.
 const shippingAddressForms = await Stack.getShippingAddressForms(['United States']);
+
+// Example result:
+// [
+//   {
+//     countries: [
+//       {
+//         code: 'US',
+//         name: 'United States'
+//       }
+//     ],
+//     pre_address_fields: [
+//       {
+//         field: 'givenName',
+//         width: 'half',
+//         editable: true,
+//         max_length: 30,
+//         required: true
+//       }
+//     ],
+//     address_form: {
+//       address_elements: [
+//         {
+//           field: 'address1',
+//           width: 'full',
+//           editable: true,
+//           max_length: 40,
+//           required: true
+//         }
+//       ],
+//       postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$',
+//       verify_after_autocomplete: true,
+//       wrap_address1_to_address2: false
+//     },
+//     post_address_fields: [
+//       {
+//         field: 'mobilePhone',
+//         width: 'full',
+//         editable: true,
+//         max_length: 20,
+//         required: true
+//       }
+//     ]
+//   }
+// ]
+
+// Pass true as the second parameter to camelCase the returned keys.
 const camelizedShippingAddressForms = await Stack.getShippingAddressForms(['United States'], true);
 
 // We could possibly add functionality to return the list of regions markets and languages in a single object structure

package/__tests__/api.spec.js

@@ -86,14 +86,16 @@ const addressFormFieldEntries = [
     width: 'full',
     editable: true,
     max_length: '40',
-    required: true
+    required: true,
+    api_mappings: ['address1']
   },
   {
     field: 'postalCode',
     width: 'half',
     editable: false,
     max_length: '10',
-    required: false
+    required: false,
+    api_mappings: ['postalCode']
   }
 ];
 
@@ -157,9 +159,9 @@ describe("ContentstackApi", () => {
       global.window = Object.create(window);
       global.window.location = { hostname };
       const {getStack} = require('../src/api');
-      getStack(env[index]);
+      getStack();
       expect(mockStack).toHaveBeenCalledWith({api_key: csCfg.apiKey, delivery_token: csCfg.deliveryToken, environment: csCfg.environment});
-    })
+    });
   });
 
   test('extractAddressFormFields maps address form field entries', () => {
@@ -171,14 +173,16 @@ describe("ContentstackApi", () => {
         width: 'full',
         editable: true,
         max_length: 40,
-        required: true
+        required: true,
+        api_mappings: ['address1']
       },
       {
         field: 'postalCode',
         width: 'half',
         editable: false,
         max_length: 10,
-        required: false
+        required: false,
+        api_mappings: ['postalCode']
       }
     ]);
   });
@@ -192,18 +196,26 @@ describe("ContentstackApi", () => {
         width: 'full',
         editable: true,
         maxLength: 40,
-        required: true
+        required: true,
+        apiMappings: ['address1']
       },
       {
         field: 'postalCode',
         width: 'half',
         editable: false,
         maxLength: 10,
-        required: false
+        required: false,
+        apiMappings: ['postalCode']
       }
     ]);
   });
 
+  test('extractAddressFormFields returns an empty list when no entries are provided', () => {
+    const {getStack} = require('../src/api');
+    const Stack = getStack('dev');
+    expect(Stack.extractAddressFormFields()).toStrictEqual([]);
+  });
+
   test('getAddressForms maps address_elements', async () => {
     mockPromiseResult.mockResolvedValueOnce([[
       {
@@ -224,14 +236,16 @@ describe("ContentstackApi", () => {
             width: 'full',
             editable: true,
             max_length: 40,
-            required: true
+            required: true,
+            api_mappings: ['address1']
           },
           {
             field: 'postalCode',
             width: 'half',
             editable: false,
             max_length: 10,
-            required: false
+            required: false,
+            api_mappings: ['postalCode']
           }
         ],
         postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$',
@@ -260,14 +274,16 @@ describe("ContentstackApi", () => {
             width: 'full',
             editable: true,
             maxLength: 40,
-            required: true
+            required: true,
+            apiMappings: ['address1']
           },
           {
             field: 'postalCode',
             width: 'half',
             editable: false,
             maxLength: 10,
-            required: false
+            required: false,
+            apiMappings: ['postalCode']
           }
         ],
         postalCodeRegex: '^[0-9]{5}(?:-[0-9]{4})?$',
@@ -277,6 +293,21 @@ describe("ContentstackApi", () => {
     ]);
   });
 
+  test('getAddressForms returns an empty list when no forms are found', async () => {
+    mockPromiseResult.mockResolvedValueOnce([undefined]);
+    const {getStack} = require('../src/api');
+    const Stack = getStack('dev');
+    await expect(Stack.getAddressForms(['Unknown'])).resolves.toStrictEqual([]);
+  });
+
+  test('getSingletonEntries maps language code in to id', async () => {
+    mockSinglePromiseResult.mockResolvedValueOnce(singleCheckoutAdrStrings);
+    const {getStack} = require('../src/api');
+    const Stack = getStack('dev');
+    await Stack.getSingletonEntries({contentTypeUIDs: ['checkout_adr_strings'], language: 'in'});
+    expect(mockSinglePromiseResult).toHaveBeenCalled();
+  });
+
   test('getShippingAddressForms maps nested address form fields', async () => {
     mockPromiseResult.mockResolvedValueOnce([[
       {
@@ -296,13 +327,15 @@ describe("ContentstackApi", () => {
           }
         ],
         pre_address_fields: [addressFormFieldEntries[0]],
-        address_form: {
-          title: 'default',
-          address_elements: addressFormFieldEntries,
-          postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$',
-          verify_after_autocomplete: true,
-          wrap_address1_to_address2: false
-        },
+        address_form: [
+          {
+            title: 'default',
+            address_elements: addressFormFieldEntries,
+            postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$',
+            verify_after_autocomplete: true,
+            wrap_address1_to_address2: false
+          }
+        ],
         post_address_fields: [addressFormFieldEntries[1]]
       }
     ]]);
@@ -326,7 +359,8 @@ describe("ContentstackApi", () => {
             width: 'full',
             editable: true,
             max_length: 40,
-            required: true
+            required: true,
+            api_mappings: ['address1']
           }
         ],
         address_form: {
@@ -336,14 +370,16 @@ describe("ContentstackApi", () => {
               width: 'full',
               editable: true,
               max_length: 40,
-              required: true
+              required: true,
+              api_mappings: ['address1']
             },
             {
               field: 'postalCode',
               width: 'half',
               editable: false,
               max_length: 10,
-              required: false
+              required: false,
+              api_mappings: ['postalCode']
             }
           ],
           postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$',
@@ -356,7 +392,8 @@ describe("ContentstackApi", () => {
             width: 'half',
             editable: false,
             max_length: 10,
-            required: false
+            required: false,
+            api_mappings: ['postalCode']
           }
         ]
       }
@@ -382,13 +419,15 @@ describe("ContentstackApi", () => {
           }
         ],
         pre_address_fields: [addressFormFieldEntries[0]],
-        address_form: {
-          title: 'default',
-          address_elements: addressFormFieldEntries,
-          postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$',
-          verify_after_autocomplete: true,
-          wrap_address1_to_address2: false
-        },
+        address_form: [
+          {
+            title: 'default',
+            address_elements: addressFormFieldEntries,
+            postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$',
+            verify_after_autocomplete: true,
+            wrap_address1_to_address2: false
+          }
+        ],
         post_address_fields: [addressFormFieldEntries[1]]
       }
     ]]);
@@ -412,7 +451,8 @@ describe("ContentstackApi", () => {
             width: 'full',
             editable: true,
             maxLength: 40,
-            required: true
+            required: true,
+            apiMappings: ['address1']
           }
         ],
         addressForm: {
@@ -422,14 +462,16 @@ describe("ContentstackApi", () => {
               width: 'full',
               editable: true,
               maxLength: 40,
-              required: true
+              required: true,
+              apiMappings: ['address1']
             },
             {
               field: 'postalCode',
               width: 'half',
               editable: false,
               maxLength: 10,
-              required: false
+              required: false,
+              apiMappings: ['postalCode']
             }
           ],
           postalCodeRegex: '^[0-9]{5}(?:-[0-9]{4})?$',
@@ -442,10 +484,32 @@ describe("ContentstackApi", () => {
             width: 'half',
             editable: false,
             maxLength: 10,
-            required: false
+            required: false,
+            apiMappings: ['postalCode']
           }
         ]
       }
     ]);
   });
+
+  test('getShippingAddressForms returns empty nested data when optional references are missing', async () => {
+    mockPromiseResult.mockResolvedValueOnce([[
+      {
+        countries: [],
+        pre_address_fields: undefined,
+        address_form: [],
+        post_address_fields: undefined
+      }
+    ]]);
+    const {getStack} = require('../src/api');
+    const Stack = getStack('dev');
+    await expect(Stack.getShippingAddressForms(['Unknown'])).resolves.toStrictEqual([
+      {
+        countries: [],
+        pre_address_fields: [],
+        address_form: undefined,
+        post_address_fields: []
+      }
+    ]);
+  });
 });

package/docs/CHANGELOG.md

@@ -1 +1 @@
-# [2.1.0-pa-1117.6](https://code.tls.nuskin.io/ns-am/utility/npm/contentstack-lib/compare/v2.1.0-pa-1117.5...v2.1.0-pa-1117.6) (2026-04-08)
+# [2.1.0-pa-1117.8](https://code.tls.nuskin.io/ns-am/utility/npm/contentstack-lib/compare/v2.1.0-pa-1117.7...v2.1.0-pa-1117.8) (2026-05-08)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuskin/contentstack-lib",
-  "version": "2.1.0-pa-1117.6",
+  "version": "2.1.0-pa-1117.8",
   "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

@@ -202,12 +202,13 @@ const _getMultiEntries = async (contentType, includeRefs, values) => {
  * @private
  */
 const _extractAddressFormFields = (addressFormFields = [], camelcase = false) => {
-  const mappedFields = addressFormFields.map(({field, width, editable, max_length, required}) => ({
+  const mappedFields = addressFormFields.map(({field, width, editable, max_length, required, api_mappings}) => ({
     field,
     width,
     editable,
     max_length: Number(max_length),
-    required
+    required,
+    api_mappings
   }));
 
   return camelcase ? _snakeObjectToCamel(mappedFields) : mappedFields;
@@ -237,24 +238,24 @@ const _extractShippingCountries = (countries = []) => {
   }));
 }
 
-const getShippingAddressForms = async (countries, camelcase = false) => {
+const getShippingAddressForms = async (forms, camelcase = false) => {
   const results = await _getMultiEntries(
     'shipping_address_form',
     ['countries', 'pre_address_fields', 'address_form', 'address_form.address_elements', 'post_address_fields'],
-    countries
+    forms
   );
   const mappedResults = (results || []).map((result) => ({
     countries: _extractShippingCountries(result.countries),
     pre_address_fields: _extractAddressFormFields(result.pre_address_fields, camelcase),
-    address_form: _extractAddressForm(result.address_form, camelcase),
+    address_form: _extractAddressForm(result.address_form[0], camelcase),
     post_address_fields: _extractAddressFormFields(result.post_address_fields, camelcase)
   }));
 
   return camelcase ? _snakeObjectToCamel(mappedResults) : mappedResults;
 }
 
-const getAddressForms = async (countries, camelcase = false) => {
-  const results = await _getMultiEntries('address_form', 'address_elements', countries);
+const getAddressForms = async (forms, camelcase = false) => {
+  const results = await _getMultiEntries('address_form', 'address_elements', forms);
   const mappedResults = (results || []).map((result) => _extractAddressForm(result, camelcase));
 
   return camelcase ? _snakeObjectToCamel(mappedResults) : mappedResults;