@halix/action-sdk 1.0.5 → 1.0.7

package/LICENSE

@@ -1,201 +1,30 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
+Copyright (c) 2025 halix.io LLC
 
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this Software and associated documentation files (the “Software”), to view,
+use, copy, modify, and distribute the Software, subject to the following conditions:
 
-   1. Definitions.
+1. **Permitted Use**  
+   The Software may only be used:
+   - Within applications, extensions, or services that are built, hosted, or executed on the Halix platform (“Halix Platform”), and
+   - In accordance with the Halix Platform’s published SDK integration guidelines and technical requirements.
 
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
+2. **Prohibited Use**  
+   You may not:
+   - Use the Software in any application, system, or environment that is not running on or deployed via the Halix Platform;
+   - Integrate, link, compile, or otherwise incorporate the Software into non-Halix systems;
+   - Use the Software to build tools that replicate or compete with the Halix Platform;
+   - Remove, obscure, or alter any copyright, trademark, or other proprietary notices.
 
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
+3. **No Warranty**  
+   The Software is provided “as is,” without warranty of any kind, express or implied, including but not limited to warranties of merchantability or fitness for a particular purpose. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability.
 
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
+4. **Termination**  
+   This license is automatically terminated if you violate any of its terms. Upon termination, you must cease all use of the Software and destroy all copies in your possession.
 
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
+5. **Commercial Licensing**  
+   For use cases outside the scope of this license (e.g., use in non-Halix systems), please contact [your email or company] to obtain a commercial license.
 
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
+---
 
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+This License is not an open source license and does not grant any rights under any open source definition.

package/README.md

@@ -1,2 +1,121 @@
-# halixsdk
-Halix Platform action SDK
+# Halix Action SDK
+
+The **Halix Action SDK** (`@halix/action-sdk`) provides a development framework for creating NodeJS Lambda-based actions that run inside the [Halix Platform](https://halix.io). It offers a streamlined API for handling incoming events, interacting with Halix data services, and sending structured responses back to the platform.
+
+> 📌 **Note:** This SDK is **source-available** and is **licensed for use only within applications running on the Halix platform.**  
+> See the [LICENSE](./LICENSE) file for full terms.
+
+---
+## 📦 Installation
+
+No installation is required.
+
+The `@halix/action-sdk` is **natively available in the Halix platform runtime** and does not need to be manually installed or included via NPM.
+
+Import the SDK using ECMAScript module syntax:
+
+```js
+import * as hx from '@halix/action-sdk';
+```
+
+This makes all SDK utilities available under the `hx.` namespace for clean and consistent access throughout your action logic.
+
+---
+
+## 🚀 Getting Started
+
+Here’s a minimal example of a Halix action written in Node.js with ES module syntax:
+
+```js
+import * as hx from '@halix/action-sdk';
+
+export const handler = async (event) => {
+  // Initialize the SDK with incoming event context
+  hx.initialize(event);
+
+  // Get the subject of the action
+  const obj = hx.actionSubject;
+
+  // Refresh the object from the server
+  let fullObj;
+  try {
+    fullObj = await hx.getObject("exampleType", obj.objKey);
+  } catch (err) {
+    console.error("Error fetching object", err);
+    return hx.prepareErrorResponse("Failed to retrieve data");
+  }
+
+  // Perform updates or logic
+  fullObj.status = "Updated";
+
+  // Save the updated object
+  let saved;
+  try {
+    saved = await hx.saveRelatedObject("parentType", fullObj.parentKey, "exampleType", fullObj);
+  } catch (err) {
+    console.error("Error saving object", err);
+    return hx.prepareErrorResponse("Failed to save data");
+  }
+
+  // Return a success response
+  return hx.prepareSuccessResponse({
+    responseType: "formTemplateAction",
+    updatedSubject: saved,
+    successMessage: "Object saved successfully",
+    isError: false
+  });
+};
+```
+
+This action pattern is typical for use in Halix’s Lambda-style runtime environment.
+
+---
+
+## 📘 Key Concepts
+
+- `authToken`: Auth token for secure API calls
+- `sandboxKey`: Identifies the current Halix solution environment
+- `actionSubject`: Object being acted on (varies by context)
+- `userContext`: Info about the executing user
+- `params`: Inputs passed to the action
+
+---
+
+## 🛠️ Core Functions
+
+| 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 |
+| `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.
+
+---
+
+## 🔐 License
+
+**Halix SDK License v1.0**
+
+This SDK is licensed for **use only within applications running on the Halix platform**, in accordance with Halix SDK guidelines.
+
+- **You may not** use this SDK outside the Halix platform.
+- Full license text is available in the [LICENSE](./LICENSE) file.
+
+For commercial licensing outside this scope, contact [hello@halix.io](mailto:hello@halix.io).
+
+---
+
+## 🧰 Contributing
+
+This repository is source-available but not open source. Contributions are currently limited to internal Halix developers and partners. Please open an issue to discuss improvements or bug reports.
+
+---
+
+## 🧭 About Halix
+
+Halix is a low-code platform designed to empower developers and business users to build powerful applications quickly. Learn more at [halix.io](https://halix.io).

package/lib/cjs/index.js

@@ -1,4 +1,12 @@
 "use strict";
+// Halix SDK License v1.0
+// Copyright (c) 2025 halix.io LLC.
+//
+// This source code is licensed for use **only** within applications
+// running on the Halix platform, in accordance with Halix SDK guidelines.
+//
+// Unauthorized use outside the Halix platform is prohibited.
+// Full license terms available in the LICENSE file.
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -12,13 +20,63 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initialize = exports.prepareErrorResponse = exports.prepareSuccessResponse = exports.getValueFromObject = exports.compareValues = exports.sortObjectArray = exports.saveRelatedObject = exports.getObject = exports.getRelatedObjects = exports.useBody = exports.params = exports.userContext = exports.actionSubject = exports.serviceAddress = exports.sandboxKey = exports.authToken = void 0;
+exports.useBody = exports.params = exports.userContext = exports.actionSubject = exports.serviceAddress = exports.sandboxKey = exports.authToken = void 0;
+exports.getRelatedObjects = getRelatedObjects;
+exports.getRelatedObjectsAsObservable = getRelatedObjectsAsObservable;
+exports.getObject = getObject;
+exports.getObjectAsObservable = getObjectAsObservable;
+exports.saveRelatedObject = saveRelatedObject;
+exports.saveRelatedObjectAsObservable = saveRelatedObjectAsObservable;
+exports.sortObjectArray = sortObjectArray;
+exports.compareValues = compareValues;
+exports.getValueFromObject = getValueFromObject;
+exports.prepareSuccessResponse = prepareSuccessResponse;
+exports.prepareErrorResponse = prepareErrorResponse;
+exports.initialize = initialize;
+/**
+ * @module @halix/action-sdk
+ * @description Halix Platform action SDK for developing NodeJS Lambda-based actions on the Halix
+ * platform. Defines a framework for accepting incoming events from the Halix platform, making API
+ * requests to the Halix data service, and returning structured action responses back to the Halix
+ * platform.
+ */
 const axios_1 = __importDefault(require("axios"));
-function getRelatedObjects(parentElementId, parentKey, elementId, filter) {
+const rxjs_1 = require("rxjs");
+/**
+ * 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
+ * auth token must have scope access to the parent object in order to access all of its related
+ * objects.
+ *
+ * It is common to use getRelatedObjects to retrieve all objects belonging to the current user proxy
+ * or organization proxy. For example, in a user context where the current user proxy element is
+ * "customer," an action might want to retrieve all "purchase" objects related to the current
+ * customer. Similarly, in an organization context where the current organization proxy is
+ * "business," an action might want to retrieve all "employee" objects related to the current
+ * business.
+ *
+ * @param parentElementId - The ID of the parent element
+ * @param parentKey - The key of the parent object
+ * @param elementId - The ID of the element
+ * @param filter - Optional filter criteria for the query; if not provided, all related objects will
+ * be returned
+ * @param fetchedRelationships - Optional array of relationships to fetch; if provided, the returned
+ * objects will include the specified related objects as nested objects
+ *
+ * @returns Promise resolving to an array of objects
+ */
+function getRelatedObjects(parentElementId, parentKey, elementId, filter, fetchedRelationships) {
     return __awaiter(this, void 0, void 0, function* () {
         let params;
-        if (filter) {
-            params = new URLSearchParams({ filter: filter });
+        if (filter || fetchedRelationships) {
+            let p = {};
+            if (filter) {
+                p.filter = filter;
+            }
+            if (fetchedRelationships) {
+                p.fetchedRelationships = fetchedRelationships.join(",");
+            }
+            params = new URLSearchParams(p);
         }
         let url = `${exports.serviceAddress}/schema/sandboxes/${exports.sandboxKey}/${parentElementId}/${parentKey}/${elementId}`;
         console.log("Sending GET request to " + url + " with token " + exports.authToken);
@@ -29,18 +87,89 @@ function getRelatedObjects(parentElementId, parentKey, elementId, filter) {
         return response.data;
     });
 }
-exports.getRelatedObjects = getRelatedObjects;
-function getObject(dataElementId, key) {
+/**
+ * getRelatedObjectsAsObservable 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 auth token must have scope access to the parent object in order to access all of
+ * its related objects.
+ *
+ * It is common to use getRelatedObjects to retrieve all objects belonging to the current user proxy
+ * or organization proxy. For example, in a user context where the current user proxy element is
+ * "customer," an action might want to retrieve all "purchase" objects related to the current
+ * customer. Similarly, in an organization context where the current organization proxy is
+ * "business," an action might want to retrieve all "employee" objects related to the current
+ * business.
+ *
+ * @param parentElementId - The ID of the parent element
+ * @param parentKey - The key of the parent element
+ * @param elementId - The ID of the element
+ * @param filter - Optional filter criteria for the query; if not provided, all related objects will
+ * be returned
+ * @param fetchedRelationships - Optional array of relationships to fetch; if provided, the returned
+ * objects will include the specified related objects as nested objects
+ *
+ * @returns Observable resolving to an array of objects
+ */
+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}`;
         console.log("Sending GET request to " + url + " with token " + exports.authToken);
         let response = yield axios_1.default.get(url, {
             headers: { "Authorization": `Bearer ${exports.authToken}` },
+            params: params,
         });
         return response.data;
     });
 }
-exports.getObject = getObject;
+/**
+ * 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));
+}
+/**
+ * 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
+ * schema. The objectToSave must have a relationship to the parent object and the user must have
+ * scope access to the parent object.
+ *
+ * @param parentElementId - The ID of the parent element
+ * @param parentKey - The key of the parent object
+ * @param elementId - The element ID of the object to save
+ * @param objectToSave - The object data to save (as a JSON string)
+ * @param opts - Optional save options
+ *
+ * @returns Promise resolving to saved object, including any updates made to the object during the
+ * save operation (such as assigning an objKey if the object is new), or the assignment of
+ * calculated values
+ */
 function saveRelatedObject(parentElementId, parentKey, elementId, objectToSave, opts) {
     return __awaiter(this, void 0, void 0, function* () {
         let url = `${exports.serviceAddress}/schema/sandboxes/${exports.sandboxKey}/${parentElementId}/${parentKey}/${elementId}`;
@@ -54,10 +183,33 @@ function saveRelatedObject(parentElementId, parentKey, elementId, objectToSave,
         return response.data;
     });
 }
-exports.saveRelatedObject = saveRelatedObject;
-/*
- * 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").
+/**
+ * saveRelatedObjectAsObservable 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 schema. The objectToSave must have a relationship to the parent object and the user must have
+ * scope access to the parent object.
+ *
+ * @param parentElementId - The ID of the parent element
+ * @param parentKey - The key of the parent object
+ * @param elementId - The element ID of the object to save
+ * @param objectToSave - The object data to save (as a JSON string)
+ * @param opts - Optional save options
+ *
+ * @returns Observable resolving to saved object, including any updates made to the object during
+ * the save operation (such as assigning an objKey if the object is new), or the assignment of
+ * calculated values
+ */
+function saveRelatedObjectAsObservable(parentElementId, parentKey, elementId, objectToSave, opts) {
+    return (0, rxjs_1.from)(saveRelatedObject(parentElementId, parentKey, elementId, objectToSave, opts));
+}
+/**
+ * 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) => {
@@ -73,7 +225,18 @@ function sortObjectArray(array, sort) {
         return comparison;
     });
 }
-exports.sortObjectArray = sortObjectArray;
+/**
+ * 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) {
@@ -103,7 +266,19 @@ function compareValues(valueA, valueB, descending, caseInsensitive) {
     }
     return 0;
 }
-exports.compareValues = compareValues;
+/**
+ * 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;
@@ -125,17 +300,35 @@ function getValueFromObject(object, attribute) {
     }
     return value;
 }
-exports.getValueFromObject = getValueFromObject;
-function prepareSuccessResponse(returnVal) {
+/**
+ * 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(returnVal)
+            body: JSON.stringify(successResponse)
         };
     }
-    return returnVal;
+    return successResponse;
 }
-exports.prepareSuccessResponse = prepareSuccessResponse;
+/**
+ * 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 {
@@ -145,13 +338,20 @@ function prepareErrorResponse(errorMessage) {
     }
     return { errorMessage, responseType: "error" };
 }
-exports.prepareErrorResponse = prepareErrorResponse;
+/**
+ * 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;
     }
-    ({ authToken: exports.authToken, sandboxKey: exports.sandboxKey, serviceAddress: exports.serviceAddress, actionSubject: exports.actionSubject, userContext: exports.userContext, params: exports.params } = body);
+    if (body) {
+        ({ authToken: exports.authToken, sandboxKey: exports.sandboxKey, serviceAddress: exports.serviceAddress, actionSubject: exports.actionSubject, userContext: exports.userContext, params: exports.params } = body);
+    }
 }
-exports.initialize = initialize;