@nuskin/contentstack-lib 2.0.0 → 2.1.0-pa-1117.2

package/.releaserc

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

package/README.md

@@ -7,6 +7,7 @@ This project extends the Contentstack delivery sdk, to be shared between the bac
 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.
 4. getSingletonEntries also allows you to convert the keys from snake case to camel case.
+5. It extends the stack with getAddressForms and getShippingAddressForms for address form content types.
 
 ## Installing
 
@@ -63,6 +64,33 @@ const [
     mergeWithFallback: true
   });
 
+// Get address forms for a list of countries.
+// By default the returned keys are snake_case.
+const addressForms = await Stack.getAddressForms(['United States']);
+
+// Example result:
+// [
+//   {
+//     address_elements: [
+//       {
+//         field: 'address1',
+//         width: 'full',
+//         editable: true,
+//         max_length: 40
+//       }
+//     ],
+//     postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$'
+//   }
+// ]
+
+// Pass true as the second parameter to camelCase the returned keys.
+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.
+const shippingAddressForms = await Stack.getShippingAddressForms(['United States']);
+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

@@ -52,6 +52,13 @@ beforeEach(() => {
               findOne: mockSinglePromiseResult
             })
           })
+        }),
+        containedIn: () => ({
+          includeReference: () => ({
+            toJSON: () => ({
+              find: mockPromiseResult
+            })
+          })
         })
       })
     })
@@ -73,6 +80,23 @@ const mockResults = () => {
   mockSinglePromiseResult.mockResolvedValueOnce(singleCheckoutCartStrings);
 }
 
+const addressFormFieldEntries = [
+  {
+    field: 'address1',
+    width: 'full',
+    editable: true,
+    max_length: '40',
+    required: true
+  },
+  {
+    field: 'postalCode',
+    width: 'half',
+    editable: false,
+    max_length: '10',
+    required: false
+  }
+];
+
 describe("ContentstackApi", () => {
   test("getSingletonEntries", async () => {
     mockResults();
@@ -136,5 +160,228 @@ describe("ContentstackApi", () => {
       getStack(env[index]);
       expect(mockStack).toHaveBeenCalledWith({api_key: csCfg.apiKey, delivery_token: csCfg.deliveryToken, environment: csCfg.environment});
     })
-  })
+  });
+
+  test('extractAddressFormFields maps address form field entries', () => {
+    const {getStack} = require('../src/api');
+    const Stack = getStack('dev');
+    expect(Stack.extractAddressFormFields(addressFormFieldEntries)).toStrictEqual([
+      {
+        field: 'address1',
+        width: 'full',
+        editable: true,
+        max_length: 40,
+        required: true
+      },
+      {
+        field: 'postalCode',
+        width: 'half',
+        editable: false,
+        max_length: 10,
+        required: false
+      }
+    ]);
+  });
+
+  test('extractAddressFormFields camelcases address form field entries', () => {
+    const {getStack} = require('../src/api');
+    const Stack = getStack('dev');
+    expect(Stack.extractAddressFormFields(addressFormFieldEntries, true)).toStrictEqual([
+      {
+        field: 'address1',
+        width: 'full',
+        editable: true,
+        maxLength: 40,
+        required: true
+      },
+      {
+        field: 'postalCode',
+        width: 'half',
+        editable: false,
+        maxLength: 10,
+        required: false
+      }
+    ]);
+  });
+
+  test('getAddressForms maps address_elements', async () => {
+    mockPromiseResult.mockResolvedValueOnce([[
+      {
+        title: 'United States',
+        address_elements: addressFormFieldEntries,
+        postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$'
+      }
+    ]]);
+    const {getStack} = require('../src/api');
+    const Stack = getStack('dev');
+    await expect(Stack.getAddressForms(['United States'])).resolves.toStrictEqual([
+      {
+        address_elements: [
+          {
+            field: 'address1',
+            width: 'full',
+            editable: true,
+            max_length: 40,
+            required: true
+          },
+          {
+            field: 'postalCode',
+            width: 'half',
+            editable: false,
+            max_length: 10,
+            required: false
+          }
+        ],
+        postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$'
+      }
+    ]);
+  });
+
+  test('getAddressForms camelcases returned field names', async () => {
+    mockPromiseResult.mockResolvedValueOnce([[
+      {
+        address_elements: addressFormFieldEntries,
+        postal_code_regex: '^[0-9]{5}(?:-[0-9]{4})?$'
+      }
+    ]]);
+    const {getStack} = require('../src/api');
+    const Stack = getStack('dev');
+    await expect(Stack.getAddressForms(['United States'], true)).resolves.toStrictEqual([
+      {
+        addressElements: [
+          {
+            field: 'address1',
+            width: 'full',
+            editable: true,
+            maxLength: 40,
+            required: true
+          },
+          {
+            field: 'postalCode',
+            width: 'half',
+            editable: false,
+            maxLength: 10,
+            required: false
+          }
+        ],
+        postalCodeRegex: '^[0-9]{5}(?:-[0-9]{4})?$'
+      }
+    ]);
+  });
+
+  test('getShippingAddressForms maps nested address form fields', async () => {
+    mockPromiseResult.mockResolvedValueOnce([[
+      {
+        title: 'United States',
+        pre_address_fields: [addressFormFieldEntries[0]],
+        address_form: {
+          title: 'default',
+          address_elements: addressFormFieldEntries
+        },
+        post_address_fields: [addressFormFieldEntries[1]]
+      }
+    ]]);
+    const {getStack} = require('../src/api');
+    const Stack = getStack('dev');
+    await expect(Stack.getShippingAddressForms(['United States'])).resolves.toStrictEqual([
+      {
+        title: 'United States',
+        pre_address_fields: [
+          {
+            field: 'address1',
+            width: 'full',
+            editable: true,
+            max_length: 40,
+            required: true
+          }
+        ],
+        address_form: {
+          title: 'default',
+          address_elements: [
+            {
+              field: 'address1',
+              width: 'full',
+              editable: true,
+              max_length: 40,
+              required: true
+            },
+            {
+              field: 'postalCode',
+              width: 'half',
+              editable: false,
+              max_length: 10,
+              required: false
+            }
+          ]
+        },
+        post_address_fields: [
+          {
+            field: 'postalCode',
+            width: 'half',
+            editable: false,
+            max_length: 10,
+            required: false
+          }
+        ]
+      }
+    ]);
+  });
+
+  test('getShippingAddressForms camelcases returned field names', async () => {
+    mockPromiseResult.mockResolvedValueOnce([[
+      {
+        title: 'United States',
+        pre_address_fields: [addressFormFieldEntries[0]],
+        address_form: {
+          title: 'default',
+          address_elements: addressFormFieldEntries
+        },
+        post_address_fields: [addressFormFieldEntries[1]]
+      }
+    ]]);
+    const {getStack} = require('../src/api');
+    const Stack = getStack('dev');
+    await expect(Stack.getShippingAddressForms(['United States'], true)).resolves.toStrictEqual([
+      {
+        title: 'United States',
+        preAddressFields: [
+          {
+            field: 'address1',
+            width: 'full',
+            editable: true,
+            maxLength: 40,
+            required: true
+          }
+        ],
+        addressForm: {
+          title: 'default',
+          addressElements: [
+            {
+              field: 'address1',
+              width: 'full',
+              editable: true,
+              maxLength: 40,
+              required: true
+            },
+            {
+              field: 'postalCode',
+              width: 'half',
+              editable: false,
+              maxLength: 10,
+              required: false
+            }
+          ]
+        },
+        postAddressFields: [
+          {
+            field: 'postalCode',
+            width: 'half',
+            editable: false,
+            maxLength: 10,
+            required: false
+          }
+        ]
+      }
+    ]);
+  });
 });

package/docs/CHANGELOG.md

@@ -1 +1 @@
-# [2.0.0](https://code.tls.nuskin.io/ns-am/utility/npm/contentstack-lib/compare/v1.0.0...v2.0.0) (2026-03-24)
+# [2.1.0-pa-1117.2](https://code.tls.nuskin.io/ns-am/utility/npm/contentstack-lib/compare/v2.1.0-pa-1117.1...v2.1.0-pa-1117.2) (2026-04-06)

package/package.json

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

@@ -173,6 +173,71 @@ async function getSingletonEntries(options) {
   }
 }
 
+/**
+ * Gets all the specified entries for a multiple content type
+ * @param {string} contentType
+ * @param {string[]} values
+ * @return {Promise<{Object}>} config
+ */
+const _getMultiEntries = async (contentType, includeRefs, values) => {
+  try {
+    const [results] = await Stack
+      .ContentType(contentType)
+      .Query()
+      .containedIn('title', values)
+      .includeReference(includeRefs)
+      .toJSON()
+      .find();
+
+    return results;
+  } catch(err) {
+    console.error(err);
+  }
+}
+
+/**
+ * Maps address form field entries into a small normalized dataset.
+ * @param {Object[]} addressFormFields
+ * @return {Object[]}
+ * @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
+  }));
+
+  return camelcase ? _snakeObjectToCamel(mappedFields) : mappedFields;
+}
+
+const getShippingAddressForms = async (countries, camelcase = false) => {
+  const results = await _getMultiEntries('shipping_address_form', ['pre_address_fields', 'address_form', 'address_form.address_elements', 'post_address_fields'], countries);
+  const mappedResults = (results || []).map(result => ({
+    ...result,
+    pre_address_fields: _extractAddressFormFields(result.pre_address_fields, camelcase),
+    address_form: result.address_form ? {
+      ...result.address_form,
+      address_elements: _extractAddressFormFields(result.address_form.address_elements, camelcase)
+    } : result.address_form,
+    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 mappedResults = (results || []).map(({address_elements, postal_code_regex}) => ({
+    address_elements: _extractAddressFormFields(address_elements, camelcase),
+    postal_code_regex
+  }));
+
+  return camelcase ? _snakeObjectToCamel(mappedResults) : mappedResults;
+}
+
 /**
  * Returns contentstack Stack object initialized with the api key, deliveryToken, and extended with custom functionality
  * @param {'dev' | 'test' | 'stage' | 'prod'} envrnmnt
@@ -197,6 +262,11 @@ function getStack(envrnmnt) {
 
   // extend the Stack with a custom function to get translations
   Stack.getSingletonEntries = getSingletonEntries;
+  // extend the Stack with a custom function to get ShippingAddressForms
+  Stack.getAddressForms = getAddressForms;
+  // extend the Stack with a custom function to get ShippingAddressForms
+  Stack.getShippingAddressForms = getShippingAddressForms;
+  Stack.extractAddressFormFields = _extractAddressFormFields;
 
   return Stack;
 }

package/src/index.js

@@ -5,9 +5,8 @@
 
 "use strict";
 
-const {getStack, init} = require("./api.js");
+const {getStack} = require("./api.js");
 
 module.exports = {
-  init,
   getStack
 };