@nuskin/contentstack-lib 2.1.0-pa-1117.7 → 2.1.0-pa-1117.9

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,18 @@ const addressFormFieldEntries = [
     width: 'full',
     editable: true,
     max_length: '40',
-    required: true
+    required: true,
+    api_mappings: ['address1'],
+    autocomplete_token: 'address-line1'
   },
   {
     field: 'postalCode',
     width: 'half',
     editable: false,
     max_length: '10',
-    required: false
+    required: false,
+    api_mappings: ['postalCode'],
+    validation_message: 'Invalid postal code'
   }
 ];
 
@@ -171,14 +175,18 @@ describe("ContentstackApi", () => {
         width: 'full',
         editable: true,
         max_length: 40,
-        required: true
+        required: true,
+        api_mappings: ['address1'],
+        autocomplete_token: 'address-line1'
       },
       {
         field: 'postalCode',
         width: 'half',
         editable: false,
         max_length: 10,
-        required: false
+        required: false,
+        api_mappings: ['postalCode'],
+        validation_message: 'Invalid postal code'
       }
     ]);
   });
@@ -192,14 +200,18 @@ describe("ContentstackApi", () => {
         width: 'full',
         editable: true,
         maxLength: 40,
-        required: true
+        required: true,
+        apiMappings: ['address1'],
+        autocompleteToken: 'address-line1'
       },
       {
         field: 'postalCode',
         width: 'half',
         editable: false,
         maxLength: 10,
-        required: false
+        required: false,
+        apiMappings: ['postalCode'],
+        validationMessage: 'Invalid postal code'
       }
     ]);
   });
@@ -217,7 +229,8 @@ describe("ContentstackApi", () => {
         address_elements: addressFormFieldEntries,
         postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$',
         verify_after_autocomplete: true,
-        wrap_address1_to_address2: false
+        wrap_address1_to_address2: false,
+        allowed_countries: ['US', 'CA']
       }
     ]]);
     const {getStack} = require('../src/api');
@@ -230,19 +243,24 @@ describe("ContentstackApi", () => {
             width: 'full',
             editable: true,
             max_length: 40,
-            required: true
+            required: true,
+            api_mappings: ['address1'],
+            autocomplete_token: 'address-line1'
           },
           {
             field: 'postalCode',
             width: 'half',
             editable: false,
             max_length: 10,
-            required: false
+            required: false,
+            api_mappings: ['postalCode'],
+            validation_message: 'Invalid postal code'
           }
         ],
         postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$',
         verify_after_autocomplete: true,
-        wrap_address1_to_address2: false
+        wrap_address1_to_address2: false,
+        allowed_countries: ['US', 'CA']
       }
     ]);
   });
@@ -253,7 +271,8 @@ describe("ContentstackApi", () => {
         address_elements: addressFormFieldEntries,
         postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$',
         verify_after_autocomplete: true,
-        wrap_address1_to_address2: false
+        wrap_address1_to_address2: false,
+        allowed_countries: ['US', 'CA']
       }
     ]]);
     const {getStack} = require('../src/api');
@@ -266,19 +285,24 @@ describe("ContentstackApi", () => {
             width: 'full',
             editable: true,
             maxLength: 40,
-            required: true
+            required: true,
+            apiMappings: ['address1'],
+            autocompleteToken: 'address-line1'
           },
           {
             field: 'postalCode',
             width: 'half',
             editable: false,
             maxLength: 10,
-            required: false
+            required: false,
+            apiMappings: ['postalCode'],
+            validationMessage: 'Invalid postal code'
           }
         ],
         postalCodeRegex: '^[0-9]{5}(?:-[0-9]{4})?$',
         verifyAfterAutocomplete: true,
-        wrapAddress1ToAddress2: false
+        wrapAddress1ToAddress2: false,
+        allowedCountries: ['US', 'CA']
       }
     ]);
   });
@@ -323,10 +347,12 @@ describe("ContentstackApi", () => {
             address_elements: addressFormFieldEntries,
             postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$',
             verify_after_autocomplete: true,
-            wrap_address1_to_address2: false
+            wrap_address1_to_address2: false,
+            allowed_countries: ['US', 'CA']
           }
         ],
-        post_address_fields: [addressFormFieldEntries[1]]
+        post_address_fields: [addressFormFieldEntries[1]],
+        display_name: 'North America'
       }
     ]]);
     const {getStack} = require('../src/api');
@@ -349,7 +375,9 @@ describe("ContentstackApi", () => {
             width: 'full',
             editable: true,
             max_length: 40,
-            required: true
+            required: true,
+            api_mappings: ['address1'],
+            autocomplete_token: 'address-line1'
           }
         ],
         address_form: {
@@ -359,19 +387,24 @@ describe("ContentstackApi", () => {
               width: 'full',
               editable: true,
               max_length: 40,
-              required: true
+              required: true,
+              api_mappings: ['address1'],
+              autocomplete_token: 'address-line1'
             },
             {
               field: 'postalCode',
               width: 'half',
               editable: false,
               max_length: 10,
-              required: false
+              required: false,
+              api_mappings: ['postalCode'],
+              validation_message: 'Invalid postal code'
             }
           ],
           postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$',
           verify_after_autocomplete: true,
-          wrap_address1_to_address2: false
+          wrap_address1_to_address2: false,
+          allowed_countries: ['US', 'CA']
         },
         post_address_fields: [
           {
@@ -379,9 +412,12 @@ describe("ContentstackApi", () => {
             width: 'half',
             editable: false,
             max_length: 10,
-            required: false
+            required: false,
+            api_mappings: ['postalCode'],
+            validation_message: 'Invalid postal code'
           }
-        ]
+        ],
+        display_name: 'North America'
       }
     ]);
   });
@@ -411,10 +447,12 @@ describe("ContentstackApi", () => {
             address_elements: addressFormFieldEntries,
             postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$',
             verify_after_autocomplete: true,
-            wrap_address1_to_address2: false
+            wrap_address1_to_address2: false,
+            allowed_countries: ['US', 'CA']
           }
         ],
-        post_address_fields: [addressFormFieldEntries[1]]
+        post_address_fields: [addressFormFieldEntries[1]],
+        display_name: 'North America'
       }
     ]]);
     const {getStack} = require('../src/api');
@@ -437,7 +475,9 @@ describe("ContentstackApi", () => {
             width: 'full',
             editable: true,
             maxLength: 40,
-            required: true
+            required: true,
+            apiMappings: ['address1'],
+            autocompleteToken: 'address-line1'
           }
         ],
         addressForm: {
@@ -447,19 +487,24 @@ describe("ContentstackApi", () => {
               width: 'full',
               editable: true,
               maxLength: 40,
-              required: true
+              required: true,
+              apiMappings: ['address1'],
+              autocompleteToken: 'address-line1'
             },
             {
               field: 'postalCode',
               width: 'half',
               editable: false,
               maxLength: 10,
-              required: false
+              required: false,
+              apiMappings: ['postalCode'],
+              validationMessage: 'Invalid postal code'
             }
           ],
           postalCodeRegex: '^[0-9]{5}(?:-[0-9]{4})?$',
           verifyAfterAutocomplete: true,
-          wrapAddress1ToAddress2: false
+          wrapAddress1ToAddress2: false,
+          allowedCountries: ['US', 'CA']
         },
         postAddressFields: [
           {
@@ -467,9 +512,12 @@ describe("ContentstackApi", () => {
             width: 'half',
             editable: false,
             maxLength: 10,
-            required: false
+            required: false,
+            apiMappings: ['postalCode'],
+            validationMessage: 'Invalid postal code'
           }
-        ]
+        ],
+        displayName: 'North America'
       }
     ]);
   });

package/docs/CHANGELOG.md

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

package/package.json

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

@@ -22,6 +22,22 @@ const COMMON_LANGUAGES = {
   'tr': 'tr-tr'
 };
 
+const CONTENTSTACK_SYSTEM_FIELDS = new Set([
+  '_content_type_uid',
+  'uid',
+  'title',
+  'tags',
+  'locale',
+  'created_by',
+  'updated_by',
+  'created_at',
+  'updated_at',
+  'ACL',
+  '_version',
+  '_in_progress',
+  'publish_details'
+]);
+
 /**
  * Gets the correct contentstack config settings
  * @param {string} env
@@ -195,6 +211,18 @@ const _getMultiEntries = async (contentType, includeRefs, values) => {
   }
 }
 
+/**
+ * Removes Contentstack-managed metadata fields while preserving custom content fields.
+ * @param {Object} entry
+ * @return {Object}
+ * @private
+ */
+const _omitContentstackSystemFields = (entry = {}) => {
+  return Object.fromEntries(
+    Object.entries(entry).filter(([key]) => !CONTENTSTACK_SYSTEM_FIELDS.has(key))
+  );
+}
+
 /**
  * Maps address form field entries into a small normalized dataset.
  * @param {Object[]} addressFormFields
@@ -202,13 +230,15 @@ const _getMultiEntries = async (contentType, includeRefs, values) => {
  * @private
  */
 const _extractAddressFormFields = (addressFormFields = [], camelcase = false) => {
-  const mappedFields = addressFormFields.map(({field, width, editable, max_length, required}) => ({
-    field,
-    width,
-    editable,
-    max_length: Number(max_length),
-    required
-  }));
+  const mappedFields = addressFormFields.map((addressFormField) => {
+    const mappedField = _omitContentstackSystemFields(addressFormField);
+
+    if (mappedField.max_length !== undefined && mappedField.max_length !== null) {
+      mappedField.max_length = Number(mappedField.max_length);
+    }
+
+    return mappedField;
+  });
 
   return camelcase ? _snakeObjectToCamel(mappedFields) : mappedFields;
 }
@@ -218,12 +248,8 @@ const _extractAddressForm = (addressForm, camelcase = false) => {
     return addressForm;
   }
 
-  const mappedForm = {
-    address_elements: _extractAddressFormFields(addressForm.address_elements, camelcase),
-    postal_code_regex: addressForm.postal_code_regex,
-    verify_after_autocomplete: addressForm.verify_after_autocomplete,
-    wrap_address1_to_address2: addressForm.wrap_address1_to_address2
-  };
+  const mappedForm = _omitContentstackSystemFields(addressForm);
+  mappedForm.address_elements = _extractAddressFormFields(addressForm.address_elements, camelcase);
 
   return camelcase ? _snakeObjectToCamel(mappedForm) : mappedForm;
 }
@@ -237,24 +263,26 @@ 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[0], camelcase),
-    post_address_fields: _extractAddressFormFields(result.post_address_fields, camelcase)
-  }));
+  const mappedResults = (results || []).map((result) => {
+    const mappedResult = _omitContentstackSystemFields(result);
+    mappedResult.countries = _extractShippingCountries(result.countries);
+    mappedResult.pre_address_fields = _extractAddressFormFields(result.pre_address_fields, camelcase);
+    mappedResult.address_form = _extractAddressForm(result.address_form[0], camelcase);
+    mappedResult.post_address_fields = _extractAddressFormFields(result.post_address_fields, camelcase);
+    return mappedResult;
+  });
 
   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;