@halix/action-sdk 1.0.17 → 1.0.19

package/README.md

@@ -39,29 +39,29 @@ export const handler = async (event) => {
   // Refresh the object from the server
   let fullObj;
   try {
-    fullObj = await hx.getObject("exampleType", obj.objKey);
+    fullObj = await hx.getObject('exampleType', obj.objKey);
   } catch (err) {
-    console.error("Error fetching object", err);
-    return hx.prepareErrorResponse("Failed to retrieve data");
+    console.error('Error fetching object', err);
+    return hx.prepareErrorResponse('Failed to retrieve data');
   }
 
   // Perform updates or logic
-  fullObj.status = "Updated";
+  fullObj.status = 'Updated';
 
   // Save the updated object
   let saved;
   try {
-    saved = await hx.saveRelatedObject("parentType", fullObj.parentKey, "exampleType", fullObj);
+    saved = await hx.saveRelatedObject('parentType', fullObj.parentKey, 'exampleType', fullObj);
   } catch (err) {
-    console.error("Error saving object", err);
-    return hx.prepareErrorResponse("Failed to save data");
+    console.error('Error saving object', err);
+    return hx.prepareErrorResponse('Failed to save data');
   }
 
   // Return a success response
   return hx.prepareSuccessResponse({
-    responseType: "formTemplateAction",
+    responseType: 'formTemplateAction',
     updatedSubject: saved,
-    successMessage: "Object saved successfully",
+    successMessage: 'Object saved successfully',
     isError: false
   });
 };
@@ -86,14 +86,40 @@ This action pattern is typical for use in Halix’s Lambda-style runtime environ
 | Function | Description |
 |----------|-------------|
 | `initialize(event)` | Initializes the SDK with event context |
-| `getObject(...)`, `getRelatedObjects(...)` | Retrieve objects from the Halix data layer |
-| `saveRelatedObject(...)` | Save objects and establish relationships |
+| `getObject(...)` / `getObjectAsObservable(...)` | Retrieve a single object |
+| `getRelatedObjects(...)` / `getRelatedObjectsAsObservable(...)` | Retrieve related objects |
+| `saveRelatedObject(...)` / `saveRelatedObjectAsObservable(...)` | Save objects and relationships |
+| `deleteRelatedObject(...)` / `deleteRelatedObjectAsObservable(...)` | Delete a single related object |
+| `deleteRelatedObjects(...)` / `deleteRelatedObjectsAsObservable(...)` | Delete multiple related objects (uses `keys` query param) |
 | `prepareSuccessResponse(...)` | Create a success response |
 | `prepareErrorResponse(...)` | Create an error response |
-| `sortObjectArray(...)` | Utility to sort object arrays |
-| `getValueFromObject(...)` | Access nested or relationship-based attributes |
 
-See [Full Documentation](https://mmastrangelo.github.io/halixsdk/) for more information.
+Notes:
+- Functions that interact with services require `initialize(event)` to have been called; they depend on `userContext`, `sandboxKey`, and `serviceAddress`.
+
+---
+
+## 📦 Content Resource Helpers
+
+These helpers simplify working with content resources and file uploads.
+
+| Function | Description |
+|----------|-------------|
+| `getOrCreateResource(...)` / `getOrCreateResourceAsObservable(...)` | Retrieve an existing content resource by key or create a new one |
+| `saveResource(...)` / `saveResourceAsObservable(...)` | Persist a content resource |
+| `sendFileContents(resourceKey, file, publicFlag)` / `sendFileContentsAsObservable(...)` | Upload file contents (multipart/form-data) to a content resource |
+| `createOrUpdateResource(resourceKey?, file, publicFlag, resourceType, tags)` / `createOrUpdateResourceAsObservable(...)` | Create or update a resource and upload the file in one call |
+
+---
+
+## 🧪 Utilities
+
+| Function | Description |
+|----------|-------------|
+| `getValueFromObject(object, attribute)` | Access nested or relationship-based attributes |
+| `debounceFn(fn, wait?)` | Debounce utility for throttling calls |
+| `compareValues(a, b, descending, caseInsensitive)` | Utility comparer for sorting |
+| `sortObjectArray(array, sort)` | Utility to sort object arrays |
 
 ---
 

package/lib/cjs/index.js

@@ -21,18 +21,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useBody = exports.params = exports.userContext = exports.actionSubject = exports.serviceAddress = exports.sandboxKey = exports.getAuthToken = void 0;
-exports.getRelatedObjects = getRelatedObjects;
-exports.getRelatedObjectsAsObservable = getRelatedObjectsAsObservable;
+exports.initialize = initialize;
+exports.prepareSuccessResponse = prepareSuccessResponse;
+exports.prepareErrorResponse = prepareErrorResponse;
 exports.getObject = getObject;
 exports.getObjectAsObservable = getObjectAsObservable;
+exports.getRelatedObjects = getRelatedObjects;
+exports.getRelatedObjectsAsObservable = getRelatedObjectsAsObservable;
 exports.saveRelatedObject = saveRelatedObject;
 exports.saveRelatedObjectAsObservable = saveRelatedObjectAsObservable;
-exports.sortObjectArray = sortObjectArray;
-exports.compareValues = compareValues;
-exports.getValueFromObject = getValueFromObject;
-exports.prepareSuccessResponse = prepareSuccessResponse;
-exports.prepareErrorResponse = prepareErrorResponse;
-exports.initialize = initialize;
+exports.deleteRelatedObject = deleteRelatedObject;
+exports.deleteRelatedObjectAsObservable = deleteRelatedObjectAsObservable;
+exports.deleteRelatedObjects = deleteRelatedObjects;
+exports.deleteRelatedObjectsAsObservable = deleteRelatedObjectsAsObservable;
 exports.getOrCreateResource = getOrCreateResource;
 exports.getOrCreateResourceAsObservable = getOrCreateResourceAsObservable;
 exports.saveResource = saveResource;
@@ -41,6 +42,9 @@ exports.sendFileContents = sendFileContents;
 exports.sendFileContentsAsObservable = sendFileContentsAsObservable;
 exports.createOrUpdateResource = createOrUpdateResource;
 exports.createOrUpdateResourceAsObservable = createOrUpdateResourceAsObservable;
+exports.sortObjectArray = sortObjectArray;
+exports.compareValues = compareValues;
+exports.getValueFromObject = getValueFromObject;
 exports.debounceFn = debounceFn;
 /**
  * @module @halix/action-sdk
@@ -51,6 +55,115 @@ exports.debounceFn = debounceFn;
  */
 const axios_1 = __importDefault(require("axios"));
 const rxjs_1 = require("rxjs");
+/**
+ * initialize initializes the SDK with event data. This should be called at the beginning of the
+ * action handler to set up the SDK with incoming information, including context information, input
+ * parameters, and authentication information needed to make API requests to the Halix service.
+ *
+ * @param event - The event object containing authentication and context information
+ */
+function initialize(event) {
+    let body = event;
+    if (event.body) {
+        body = event.body;
+        exports.useBody = true;
+    }
+    if (body) {
+        ({ sandboxKey: exports.sandboxKey, serviceAddress: exports.serviceAddress, actionSubject: exports.actionSubject, userContext: exports.userContext, params: exports.params } = body);
+        if (body.authToken) {
+            exports.getAuthToken = () => (0, rxjs_1.of)(body.authToken);
+        }
+        else if (body.authTokenRetriever) {
+            exports.getAuthToken = body.authTokenRetriever;
+        }
+    }
+}
+// ================================================================================
+// RESPONSE HELPER FUNCTIONS
+// ================================================================================
+/**
+ * prepareSuccessResponse prepares a success response in the appropriate format. The action handler
+ * should return an ActionResponse response when the action is successful. If useBody is true, the
+ * response will be returned as an object with the HTTP response code and the ActionResponse in the
+ * body field. If useBody is false, the ActionResponse will be returned directly.
+ *
+ * @param successResponse - The value to return
+ *
+ * @returns Formatted success response; an ActionResponse unless useBody is true
+ */
+function prepareSuccessResponse(successResponse) {
+    if (exports.useBody) {
+        return {
+            statusCode: 200,
+            body: JSON.stringify(successResponse)
+        };
+    }
+    return successResponse;
+}
+/**
+ * prepareErrorResponse prepares an error response in the appropriate format. The action handler
+ * should return an ErrorResponse response when the action is not successful. If useBody is true,
+ * the response will be returned as an object with the HTTP response code and the ErrorResponse in
+ * the body field. If useBody is false, the ErrorResponse will be returned directly.
+ *
+ * @param errorMessage - The error message
+ *
+ * @returns Formatted error response; an ErrorResponse unless useBody is true
+ */
+function prepareErrorResponse(errorMessage) {
+    if (exports.useBody) {
+        return {
+            statusCode: 400,
+            body: JSON.stringify({ errorMessage })
+        };
+    }
+    return { errorMessage, responseType: "error" };
+}
+// ================================================================================
+// DATA RETRIEVAL FUNCTIONS
+// ================================================================================
+/**
+ * getObject retrieves a single object from the database by its data element ID and key.
+ *
+ * @param dataElementId - The ID of the data element
+ * @param key - The key of the object
+ * @param fetchedRelationships - Optional array of relationships to fetch; if provided, the returned
+ * object will include the specified related objects as nested objects
+ * @returns Promise resolving to the object data
+ */
+function getObject(dataElementId, key, fetchedRelationships) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let params;
+        if (fetchedRelationships) {
+            let p = {};
+            if (fetchedRelationships) {
+                p.fetchedRelationships = fetchedRelationships.join(",");
+            }
+            params = new URLSearchParams(p);
+        }
+        let url = `${exports.serviceAddress}/schema/sandboxes/${exports.sandboxKey}/${dataElementId}/${key}`;
+        let authToken = yield (0, rxjs_1.lastValueFrom)((0, exports.getAuthToken)());
+        console.log("Sending GET request to " + url + " with token " + authToken);
+        let response = yield axios_1.default.get(url, {
+            headers: { "Authorization": `Bearer ${authToken}` },
+            params: params,
+        });
+        return response.data;
+    });
+}
+/**
+ * getObjectAsObservable retrieves a single object from the database by its data element ID and key.
+ *
+ * @param dataElementId - The ID of the data element
+ * @param key - The key of the object
+ * @param fetchedRelationships - Optional array of relationships to fetch; if provided, the returned
+ * object will include the specified related objects as nested objects
+ *
+ * @returns Observable resolving to the object data
+ */
+function getObjectAsObservable(dataElementId, key, fetchedRelationships) {
+    return (0, rxjs_1.from)(getObject(dataElementId, key, fetchedRelationships));
+}
 /**
  * getRelatedObjects retrieves an array of objects from the the database. The objects returned are
  * related to a parent through a defined relationship in the schema. In a typical setup, action's
@@ -123,48 +236,9 @@ function getRelatedObjects(parentElementId, parentKey, elementId, filter, fetche
 function getRelatedObjectsAsObservable(parentElementId, parentKey, elementId, filter, fetchedRelationships) {
     return (0, rxjs_1.from)(getRelatedObjects(parentElementId, parentKey, elementId, filter, fetchedRelationships));
 }
-/**
- * getObject retrieves a single object from the database by its data element ID and key.
- *
- * @param dataElementId - The ID of the data element
- * @param key - The key of the object
- * @param fetchedRelationships - Optional array of relationships to fetch; if provided, the returned
- * object will include the specified related objects as nested objects
- * @returns Promise resolving to the object data
- */
-function getObject(dataElementId, key, fetchedRelationships) {
-    return __awaiter(this, void 0, void 0, function* () {
-        let params;
-        if (fetchedRelationships) {
-            let p = {};
-            if (fetchedRelationships) {
-                p.fetchedRelationships = fetchedRelationships.join(",");
-            }
-            params = new URLSearchParams(p);
-        }
-        let url = `${exports.serviceAddress}/schema/sandboxes/${exports.sandboxKey}/${dataElementId}/${key}`;
-        let authToken = yield (0, rxjs_1.lastValueFrom)((0, exports.getAuthToken)());
-        console.log("Sending GET request to " + url + " with token " + authToken);
-        let response = yield axios_1.default.get(url, {
-            headers: { "Authorization": `Bearer ${authToken}` },
-            params: params,
-        });
-        return response.data;
-    });
-}
-/**
- * getObjectAsObservable retrieves a single object from the database by its data element ID and key.
- *
- * @param dataElementId - The ID of the data element
- * @param key - The key of the object
- * @param fetchedRelationships - Optional array of relationships to fetch; if provided, the returned
- * object will include the specified related objects as nested objects
- *
- * @returns Observable resolving to the object data
- */
-function getObjectAsObservable(dataElementId, key, fetchedRelationships) {
-    return (0, rxjs_1.from)(getObject(dataElementId, key, fetchedRelationships));
-}
+// ================================================================================
+// DATA SAVE FUNCTIONS
+// ================================================================================
 /**
  * saveRelatedObject saves a related object to the database. The objectToSave is saved, and its
  * relationship to the parent object is established based on the relationship specified in the
@@ -217,165 +291,87 @@ function saveRelatedObject(parentElementId, parentKey, elementId, objectToSave,
 function saveRelatedObjectAsObservable(parentElementId, parentKey, elementId, objectToSave, opts) {
     return (0, rxjs_1.from)(saveRelatedObject(parentElementId, parentKey, elementId, objectToSave, opts));
 }
+// ================================================================================
+// DATA DELETE FUNCTIONS
+// ================================================================================
 /**
- * sortObjectArray is a helper function that sorts the passed array in place by the given
- * attributes. Sorting by nested attributes in the form of a delimited attribute string are
- * supported (e.g., "attribute.nestedAttribute").
+ * deleteRelatedObject deletes a single object related to a specific parent.
  *
- * @param array - The array to sort
- * @param sort - Array of sort field specifications
- * @returns The sorted array
+ * @param parentElementId - The ID of the parent element
+ * @param parentKey - The key of the parent object
+ * @param childElementId - The ID of the child element to delete
+ * @param childKey - The key of the child object to delete
+ *
+ * @returns Promise resolving to true if deletion was successful
  */
-function sortObjectArray(array, sort) {
-    return array.sort((a, b) => {
-        let comparison = 0;
-        for (let s of sort) {
-            let valueA = getValueFromObject(a, s.attributeId);
-            let valueB = getValueFromObject(b, s.attributeId);
-            comparison = compareValues(valueA, valueB, !!s.descending, !!s.caseInsensitive);
-            if (comparison !== 0) {
-                break;
-            }
+function deleteRelatedObject(parentElementId, parentKey, childElementId, childKey) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!exports.userContext) {
+            throw new Error("userContext is required but not available; check that the initialize function has been called");
         }
-        return comparison;
+        let url = `${exports.serviceAddress}/schema/sandboxes/${exports.sandboxKey}/${parentElementId}/${parentKey}/${childElementId}/${childKey}`;
+        let authToken = yield (0, rxjs_1.lastValueFrom)((0, exports.getAuthToken)());
+        console.log("Sending DELETE request to " + url + " with token " + authToken);
+        let response = yield axios_1.default.delete(url, {
+            headers: { "Authorization": `Bearer ${authToken}` },
+        });
+        return response.status === 204;
     });
 }
 /**
- * compareValues is a helper function that compares two values for sorting purposes. If the values
- * are strings, the comparison is case-insensitive. If the values are numbers, the comparison is
- * performed numerically.
+ * deleteRelatedObjectAsObservable deletes a single object related to a specific parent.
  *
- * @param valueA - First value to compare
- * @param valueB - Second value to compare
- * @param descending - Whether to sort in descending order
- * @param caseInsensitive - Whether to perform case-insensitive comparison for strings
+ * @param parentElementId - The ID of the parent element
+ * @param parentKey - The key of the parent object
+ * @param childElementId - The ID of the child element to delete
+ * @param childKey - The key of the child object to delete
  *
- * @returns Comparison result (-1, 0, or 1)
+ * @returns Observable resolving to true if deletion was successful
  */
-function compareValues(valueA, valueB, descending, caseInsensitive) {
-    if (caseInsensitive && (typeof valueA === 'string' || valueA instanceof String)) {
-        if (valueA && valueB) {
-            let comp = valueA.toLowerCase().localeCompare(valueB.toLowerCase());
-            if (descending) {
-                comp = comp * -1;
-            }
-            return comp;
-        }
-        else if (valueA && !valueB) {
-            return -1;
-        }
-        else if (!valueA && valueB) {
-            return 1;
-        }
-        else {
-            return 0;
-        }
-    }
-    else {
-        if (valueA < valueB) {
-            return (descending ? 1 : -1);
-        }
-        if (valueA > valueB) {
-            return (descending ? -1 : 1);
-        }
-    }
-    return 0;
+function deleteRelatedObjectAsObservable(parentElementId, parentKey, childElementId, childKey) {
+    return (0, rxjs_1.from)(deleteRelatedObject(parentElementId, parentKey, childElementId, childKey));
 }
 /**
- * getValueFromObject is a helper function that extracts a value from an object using a dot-notation
- * path. The path can include relationships. Relationship IDs may include a colon delimiter (e.g.,
- * "accountMember:ownerAccountMemberKey") to specify the key of the related object. This is useful
- * when an element has more than one relationship to the same object type. Otherwise, if only one
- * relationship to the same object type exists, the key may be specified without the relationship ID
- * (e.g., simply, "accountMember").
+ * deleteRelatedObjects deletes multiple objects related to a specific parent.
  *
- * @param object - The object to extract value from
- * @param attribute - The attribute path (e.g., "user.address.city")
+ * @param parentElementId - The ID of the parent element
+ * @param parentKey - The key of the parent object
+ * @param childElementId - The ID of the child element to delete
+ * @param childKeys - Array of keys of the child objects to delete
  *
- * @returns The extracted value
+ * @returns Promise resolving to true if deletion was successful
  */
-function getValueFromObject(object, attribute) {
-    let components = attribute.split(".");
-    let value = object;
-    for (let component of components) {
-        if (value) {
-            // If a relationship specifies a key, it will be in the format [datatype]:[key]. Otherwise the colon
-            // delimiter will not be present.
-            // The related value will be in a field named after the key. For example: accountMember:ownerAccountMemberKey
-            // the related owner account member will be in a field called "ownerAccountMember".
-            let compSplit = component.split(":");
-            if (compSplit.length > 1) {
-                let keyField = compSplit[1];
-                value = value[keyField.replace("Key", "")];
-            }
-            else {
-                value = value[component];
-            }
+function deleteRelatedObjects(parentElementId, parentKey, childElementId, childKeys) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!exports.userContext) {
+            throw new Error("userContext is required but not available; check that the initialize function has been called");
         }
-    }
-    return value;
-}
-/**
- * prepareSuccessResponse prepares a success response in the appropriate format. The action handler
- * should return an ActionResponse response when the action is successful. If useBody is true, the
- * response will be returned as an object with the HTTP response code and the ActionResponse in the
- * body field. If useBody is false, the ActionResponse will be returned directly.
- *
- * @param successResponse - The value to return
- *
- * @returns Formatted success response; an ActionResponse unless useBody is true
- */
-function prepareSuccessResponse(successResponse) {
-    if (exports.useBody) {
-        return {
-            statusCode: 200,
-            body: JSON.stringify(successResponse)
-        };
-    }
-    return successResponse;
+        let url = `${exports.serviceAddress}/schema/sandboxes/${exports.sandboxKey}/${parentElementId}/${parentKey}/${childElementId}`;
+        let authToken = yield (0, rxjs_1.lastValueFrom)((0, exports.getAuthToken)());
+        console.log("Sending DELETE request to " + url + " with token " + authToken);
+        let response = yield axios_1.default.delete(url, {
+            headers: { "Authorization": `Bearer ${authToken}` },
+            params: { keys: childKeys.join(",") },
+        });
+        return response.status === 204;
+    });
 }
 /**
- * prepareErrorResponse prepares an error response in the appropriate format. The action handler
- * should return an ErrorResponse response when the action is not successful. If useBody is true,
- * the response will be returned as an object with the HTTP response code and the ErrorResponse in
- * the body field. If useBody is false, the ErrorResponse will be returned directly.
- *
- * @param errorMessage - The error message
+ * deleteRelatedObjectsAsObservable deletes multiple objects related to a specific parent.
  *
- * @returns Formatted error response; an ErrorResponse unless useBody is true
- */
-function prepareErrorResponse(errorMessage) {
-    if (exports.useBody) {
-        return {
-            statusCode: 400,
-            body: JSON.stringify({ errorMessage })
-        };
-    }
-    return { errorMessage, responseType: "error" };
-}
-/**
- * initialize initializes the SDK with event data. This should be called at the beginning of the
- * action handler to set up the SDK with incoming information, including context information, input
- * parameters, and authentication information needed to make API requests to the Halix service.
+ * @param parentElementId - The ID of the parent element
+ * @param parentKey - The key of the parent object
+ * @param childElementId - The ID of the child element to delete
+ * @param childKeys - Array of keys of the child objects to delete
  *
- * @param event - The event object containing authentication and context information
+ * @returns Observable resolving to true if deletion was successful
  */
-function initialize(event) {
-    let body = event;
-    if (event.body) {
-        body = event.body;
-        exports.useBody = true;
-    }
-    if (body) {
-        ({ sandboxKey: exports.sandboxKey, serviceAddress: exports.serviceAddress, actionSubject: exports.actionSubject, userContext: exports.userContext, params: exports.params } = body);
-        if (body.authToken) {
-            exports.getAuthToken = () => (0, rxjs_1.of)(body.authToken);
-        }
-        else if (body.authTokenRetriever) {
-            exports.getAuthToken = body.authTokenRetriever;
-        }
-    }
+function deleteRelatedObjectsAsObservable(parentElementId, parentKey, childElementId, childKeys) {
+    return (0, rxjs_1.from)(deleteRelatedObjects(parentElementId, parentKey, childElementId, childKeys));
 }
+// ================================================================================
+// CONTENT RESOURCE FUNCTIONS
+// ================================================================================
 /**
  * getOrCreateResource retrieves an existing content resource by its key, or creates a new one
  * if the key is not provided. If a resource key is provided, it attempts to fetch the existing
@@ -588,6 +584,107 @@ function createOrUpdateResource(resourceKey, fileToUpload, publicFlag, resourceT
 function createOrUpdateResourceAsObservable(resourceKey, fileToUpload, publicFlag, resourceType, tags) {
     return (0, rxjs_1.from)(createOrUpdateResource(resourceKey, fileToUpload, publicFlag, resourceType, tags));
 }
+// ================================================================================
+// UTILITY FUNCTIONS
+// ================================================================================
+/**
+ * sortObjectArray is a helper function that sorts the passed array in place by the given
+ * attributes. Sorting by nested attributes in the form of a delimited attribute string are
+ * supported (e.g., "attribute.nestedAttribute").
+ *
+ * @param array - The array to sort
+ * @param sort - Array of sort field specifications
+ * @returns The sorted array
+ */
+function sortObjectArray(array, sort) {
+    return array.sort((a, b) => {
+        let comparison = 0;
+        for (let s of sort) {
+            let valueA = getValueFromObject(a, s.attributeId);
+            let valueB = getValueFromObject(b, s.attributeId);
+            comparison = compareValues(valueA, valueB, !!s.descending, !!s.caseInsensitive);
+            if (comparison !== 0) {
+                break;
+            }
+        }
+        return comparison;
+    });
+}
+/**
+ * compareValues is a helper function that compares two values for sorting purposes. If the values
+ * are strings, the comparison is case-insensitive. If the values are numbers, the comparison is
+ * performed numerically.
+ *
+ * @param valueA - First value to compare
+ * @param valueB - Second value to compare
+ * @param descending - Whether to sort in descending order
+ * @param caseInsensitive - Whether to perform case-insensitive comparison for strings
+ *
+ * @returns Comparison result (-1, 0, or 1)
+ */
+function compareValues(valueA, valueB, descending, caseInsensitive) {
+    if (caseInsensitive && (typeof valueA === 'string' || valueA instanceof String)) {
+        if (valueA && valueB) {
+            let comp = valueA.toLowerCase().localeCompare(valueB.toLowerCase());
+            if (descending) {
+                comp = comp * -1;
+            }
+            return comp;
+        }
+        else if (valueA && !valueB) {
+            return -1;
+        }
+        else if (!valueA && valueB) {
+            return 1;
+        }
+        else {
+            return 0;
+        }
+    }
+    else {
+        if (valueA < valueB) {
+            return (descending ? 1 : -1);
+        }
+        if (valueA > valueB) {
+            return (descending ? -1 : 1);
+        }
+    }
+    return 0;
+}
+/**
+ * getValueFromObject is a helper function that extracts a value from an object using a dot-notation
+ * path. The path can include relationships. Relationship IDs may include a colon delimiter (e.g.,
+ * "accountMember:ownerAccountMemberKey") to specify the key of the related object. This is useful
+ * when an element has more than one relationship to the same object type. Otherwise, if only one
+ * relationship to the same object type exists, the key may be specified without the relationship ID
+ * (e.g., simply, "accountMember").
+ *
+ * @param object - The object to extract value from
+ * @param attribute - The attribute path (e.g., "user.address.city")
+ *
+ * @returns The extracted value
+ */
+function getValueFromObject(object, attribute) {
+    let components = attribute.split(".");
+    let value = object;
+    for (let component of components) {
+        if (value) {
+            // If a relationship specifies a key, it will be in the format [datatype]:[key]. Otherwise the colon
+            // delimiter will not be present.
+            // The related value will be in a field named after the key. For example: accountMember:ownerAccountMemberKey
+            // the related owner account member will be in a field called "ownerAccountMember".
+            let compSplit = component.split(":");
+            if (compSplit.length > 1) {
+                let keyField = compSplit[1];
+                value = value[keyField.replace("Key", "")];
+            }
+            else {
+                value = value[component];
+            }
+        }
+    }
+    return value;
+}
 /**
  * debounceFn is a utility function that debounces a function call. It is used to prevent multiple
  * calls to the same function within a short period of time.