@halix/action-sdk 1.0.18 → 1.0.20

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/content.js

@@ -0,0 +1,257 @@
+"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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOrCreateResource = getOrCreateResource;
+exports.getOrCreateResourceAsObservable = getOrCreateResourceAsObservable;
+exports.saveResource = saveResource;
+exports.saveResourceAsObservable = saveResourceAsObservable;
+exports.sendFileContents = sendFileContents;
+exports.sendFileContentsAsObservable = sendFileContentsAsObservable;
+exports.createOrUpdateResource = createOrUpdateResource;
+exports.createOrUpdateResourceAsObservable = createOrUpdateResourceAsObservable;
+/**
+ * @module @halix/action-sdk/content
+ * @description Content resource management functions for the Halix Platform action SDK. This module
+ * handles file uploads, content resources, and file storage operations.
+ *
+ * Key features:
+ * - Retrieve content resources (images, documents, etc.)
+ * - Upload/save content resources (images, documents, etc.)
+ */
+const axios_1 = __importDefault(require("axios"));
+const rxjs_1 = require("rxjs");
+const sdk_general_1 = require("./sdk-general");
+// ================================================================================
+// 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
+ * resource from the server. If no key is provided, it creates a new resource with the specified
+ * properties.
+ *
+ * @param resourceKey - Optional key of the existing resource to retrieve
+ * @param fileToUpload - Optional file or blob to upload
+ * @param publicFlag - Whether the resource should be public
+ * @param resourceType - The type of resource
+ * @param tags - Array of tags for the resource
+ *
+ * @returns Promise resolving to a ContentResource
+ */
+function getOrCreateResource(resourceKey, fileToUpload, publicFlag, resourceType, tags) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!sdk_general_1.userContext) {
+            throw new Error("userContext is required but not available; check that the initialize function has been called");
+        }
+        if (resourceKey) {
+            let url = `${sdk_general_1.serviceAddress}/sandboxes/${sdk_general_1.sandboxKey}/contentResource/${resourceKey}`;
+            let authToken = yield (0, rxjs_1.lastValueFrom)((0, sdk_general_1.getAuthToken)());
+            console.log("Sending GET request to " + url + " with token " + authToken);
+            let response = yield axios_1.default.get(url, {
+                headers: { "Authorization": `Bearer ${authToken}` },
+            });
+            let resource = response.data;
+            if (fileToUpload) {
+                resource.contentType = fileToUpload.type;
+                // Null out the name and extension; the server will set these if they are blank
+                resource.name = null;
+                resource.extension = null;
+            }
+            return resource;
+        }
+        let newResource = {
+            isPublic: publicFlag,
+            resourceType: resourceType,
+            tags: tags,
+            organizationKey: sdk_general_1.userContext.orgKey,
+            sandboxKey: sdk_general_1.sandboxKey,
+            userKey: sdk_general_1.userContext.user.objKey
+        };
+        if (fileToUpload) {
+            newResource.contentType = fileToUpload.type;
+            // Null out the name and extension; the server will set these if they are blank
+            newResource.name = null;
+            newResource.extension = null;
+        }
+        return newResource;
+    });
+}
+/**
+ * getOrCreateResourceAsObservable 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
+ * resource from the server. If no key is provided, it creates a new resource with the specified
+ * properties.
+ *
+ * @param resourceKey - Optional key of the existing resource to retrieve
+ * @param fileToUpload - Optional file or blob to upload
+ * @param publicFlag - Whether the resource should be public
+ * @param resourceType - The type of resource
+ * @param tags - Array of tags for the resource
+ *
+ * @returns Observable resolving to a ContentResource
+ */
+function getOrCreateResourceAsObservable(resourceKey, fileToUpload, publicFlag, resourceType, tags) {
+    return (0, rxjs_1.from)(getOrCreateResource(resourceKey, fileToUpload, publicFlag, resourceType, tags));
+}
+/**
+ * saveResource saves a content resource to the server. The resource is saved with appropriate
+ * ownership parameters based on the current context (solution builder vs regular organization view).
+ *
+ * @param resource - The ContentResource to save
+ *
+ * @returns Promise resolving to the saved ContentResource
+ */
+function saveResource(resource) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!sdk_general_1.userContext) {
+            throw new Error("userContext is required but not available; check that the initialize function has been called");
+        }
+        let params = {};
+        if (sdk_general_1.userContext.orgProxy.objType === "Solution") {
+            // When in the solution builder view, content is owned by the solution. The solution key is the org proxy key in
+            // the builder view.
+            params.solutionKey = sdk_general_1.userContext.orgProxyKey;
+        }
+        else {
+            params.organizationKey = sdk_general_1.userContext.orgKey;
+            params.userKey = sdk_general_1.userContext.user.objKey;
+        }
+        let url = `${sdk_general_1.serviceAddress}/sandboxes/${sdk_general_1.sandboxKey}/contentResource`;
+        let authToken = yield (0, rxjs_1.lastValueFrom)((0, sdk_general_1.getAuthToken)());
+        console.log("Sending POST request to " + url + " with token " + authToken);
+        let response = yield axios_1.default.post(url, JSON.stringify(resource), {
+            headers: { "Authorization": `Bearer ${authToken}` },
+            params: params,
+        });
+        return response.data;
+    });
+}
+/**
+ * saveResourceAsObservable saves a content resource to the server. The resource is saved with appropriate
+ * ownership parameters based on the current context (solution builder vs regular organization view).
+ *
+ * @param resource - The ContentResource to save
+ *
+ * @returns Observable resolving to the saved ContentResource
+ */
+function saveResourceAsObservable(resource) {
+    return (0, rxjs_1.from)(saveResource(resource));
+}
+/**
+ * sendFileContents uploads file contents to the server for a specific resource. The file is uploaded
+ * via FormData with the appropriate scope and public flag settings.
+ *
+ * @param resourceKey - The key of the resource to upload file contents for
+ * @param fileToUpload - The file or blob to upload
+ * @param publicFlag - Whether the file should be public
+ *
+ * @returns Promise resolving to true if upload was successful
+ */
+function sendFileContents(resourceKey, fileToUpload, publicFlag) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!sdk_general_1.userContext) {
+            throw new Error("userContext is required but not available; check that the initialize function has been called");
+        }
+        let url = `${sdk_general_1.serviceAddress}/filecontent/${sdk_general_1.sandboxKey}/${resourceKey}`;
+        let authToken = yield (0, rxjs_1.lastValueFrom)((0, sdk_general_1.getAuthToken)());
+        console.log("Sending file upload request to " + url + " with token " + authToken);
+        let formData = new FormData();
+        formData.append("fileUpload", fileToUpload);
+        formData.append("scopeKeyPath", sdk_general_1.userContext.orgProxyKey);
+        formData.append("public", String(publicFlag));
+        let response = yield axios_1.default.post(url, formData, {
+            headers: {
+                "Authorization": `Bearer ${authToken}`,
+                "Content-Type": "multipart/form-data"
+            },
+        });
+        return response.status === 204;
+    });
+}
+/**
+ * sendFileContentsAsObservable uploads file contents to the server for a specific resource. The file is uploaded
+ * via FormData with the appropriate scope and public flag settings.
+ *
+ * @param resourceKey - The key of the resource to upload file contents for
+ * @param fileToUpload - The file or blob to upload
+ * @param publicFlag - Whether the file should be public
+ *
+ * @returns Observable resolving to true if upload was successful
+ */
+function sendFileContentsAsObservable(resourceKey, fileToUpload, publicFlag) {
+    return (0, rxjs_1.from)(sendFileContents(resourceKey, fileToUpload, publicFlag));
+}
+/**
+ * createOrUpdateResource creates a new content resource or updates an existing one, then uploads
+ * the file contents to that resource. If a resourceKey is provided, it updates the existing resource;
+ * otherwise, it creates a new resource and uploads the file to the newly created resource.
+ *
+ * @param resourceKey - Optional key of the existing resource to update; if not provided, a new resource is created
+ * @param fileToUpload - The file or blob to upload
+ * @param publicFlag - Whether the resource should be public
+ * @param resourceType - The type of resource
+ * @param tags - Array of tags for the resource
+ *
+ * @returns Promise resolving to the ContentResource with uploaded file
+ */
+function createOrUpdateResource(resourceKey, fileToUpload, publicFlag, resourceType, tags) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!sdk_general_1.userContext) {
+            throw new Error("userContext is required but not available; check that the initialize function has been called");
+        }
+        // Get or create the resource
+        let resource = yield getOrCreateResource(resourceKey, fileToUpload, publicFlag, resourceType, tags);
+        // Save the resource to get the objKey if it's new
+        let savedResource = yield saveResource(resource);
+        // Upload the file contents
+        if (!savedResource.objKey) {
+            throw new Error("Resource was saved but no objKey was returned");
+        }
+        let uploadSuccess = yield sendFileContents(savedResource.objKey, fileToUpload, publicFlag);
+        if (!uploadSuccess) {
+            throw new Error("Failed to upload file contents");
+        }
+        // Get the updated resource with file metadata
+        let updatedResource = yield getOrCreateResource(savedResource.objKey, fileToUpload, publicFlag, resourceType, []);
+        // Set the name if it's not set and we have a File with a name
+        if (updatedResource && !updatedResource.name && fileToUpload instanceof File) {
+            updatedResource.name = fileToUpload.name;
+        }
+        return updatedResource;
+    });
+}
+/**
+ * createOrUpdateResourceAsObservable creates a new content resource or updates an existing one, then uploads
+ * the file contents to that resource. If a resourceKey is provided, it updates the existing resource;
+ * otherwise, it creates a new resource and uploads the file to the newly created resource.
+ *
+ * @param resourceKey - Optional key of the existing resource to update; if not provided, a new resource is created
+ * @param fileToUpload - The file or blob to upload
+ * @param publicFlag - Whether the resource should be public
+ * @param resourceType - The type of resource
+ * @param tags - Array of tags for the resource
+ *
+ * @returns Observable resolving to the ContentResource with uploaded file
+ */
+function createOrUpdateResourceAsObservable(resourceKey, fileToUpload, publicFlag, resourceType, tags) {
+    return (0, rxjs_1.from)(createOrUpdateResource(resourceKey, fileToUpload, publicFlag, resourceType, tags));
+}

package/lib/cjs/data-crud.js

@@ -0,0 +1,296 @@
+"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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getObject = getObject;
+exports.getObjectAsObservable = getObjectAsObservable;
+exports.getRelatedObjects = getRelatedObjects;
+exports.getRelatedObjectsAsObservable = getRelatedObjectsAsObservable;
+exports.saveRelatedObject = saveRelatedObject;
+exports.saveRelatedObjectAsObservable = saveRelatedObjectAsObservable;
+exports.deleteRelatedObject = deleteRelatedObject;
+exports.deleteRelatedObjectAsObservable = deleteRelatedObjectAsObservable;
+exports.deleteRelatedObjects = deleteRelatedObjects;
+exports.deleteRelatedObjectsAsObservable = deleteRelatedObjectsAsObservable;
+/**
+ * @module @halix/action-sdk/data-crud
+ * @description Data CRUD operations for the Halix Platform action SDK. This module provides functions
+ * for creating, reading, updating, and deleting data objects through the Halix data service API.
+ *
+ * Key features:
+ * - Retrieve one object a time
+ * - Retrieve all objects related to a parent object
+ * - Save a single object
+ * - Delete a single or multiple objects
+ */
+const axios_1 = __importDefault(require("axios"));
+const rxjs_1 = require("rxjs");
+const sdk_general_1 = require("./sdk-general");
+// ================================================================================
+// 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 = `${sdk_general_1.serviceAddress}/schema/sandboxes/${sdk_general_1.sandboxKey}/${dataElementId}/${key}`;
+        let authToken = yield (0, rxjs_1.lastValueFrom)((0, sdk_general_1.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
+ * 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 || fetchedRelationships) {
+            let p = {};
+            if (filter) {
+                p.filter = filter;
+            }
+            if (fetchedRelationships) {
+                p.fetchedRelationships = fetchedRelationships.join(",");
+            }
+            params = new URLSearchParams(p);
+        }
+        let url = `${sdk_general_1.serviceAddress}/schema/sandboxes/${sdk_general_1.sandboxKey}/${parentElementId}/${parentKey}/${elementId}`;
+        let authToken = yield (0, rxjs_1.lastValueFrom)((0, sdk_general_1.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;
+    });
+}
+/**
+ * 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));
+}
+// ================================================================================
+// 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
+ * 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 = `${sdk_general_1.serviceAddress}/schema/sandboxes/${sdk_general_1.sandboxKey}/${parentElementId}/${parentKey}/${elementId}`;
+        if ((opts === null || opts === void 0 ? void 0 : opts.bypassValidation) === false) {
+            url += "?bypassValidation=false";
+        }
+        else {
+            url += "?bypassValidation=true";
+        }
+        let authToken = yield (0, rxjs_1.lastValueFrom)((0, sdk_general_1.getAuthToken)());
+        console.log("Sending POST request to " + url + " with token " + authToken);
+        let response = yield axios_1.default.post(url, objectToSave, {
+            headers: { "Authorization": `Bearer ${authToken}` },
+        });
+        return response.data;
+    });
+}
+/**
+ * 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));
+}
+// ================================================================================
+// DATA DELETE FUNCTIONS
+// ================================================================================
+/**
+ * deleteRelatedObject deletes a single object related to a specific parent.
+ *
+ * @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 deleteRelatedObject(parentElementId, parentKey, childElementId, childKey) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!sdk_general_1.userContext) {
+            throw new Error("userContext is required but not available; check that the initialize function has been called");
+        }
+        let url = `${sdk_general_1.serviceAddress}/schema/sandboxes/${sdk_general_1.sandboxKey}/${parentElementId}/${parentKey}/${childElementId}/${childKey}`;
+        let authToken = yield (0, rxjs_1.lastValueFrom)((0, sdk_general_1.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;
+    });
+}
+/**
+ * deleteRelatedObjectAsObservable deletes a single object related to a specific parent.
+ *
+ * @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 Observable resolving to true if deletion was successful
+ */
+function deleteRelatedObjectAsObservable(parentElementId, parentKey, childElementId, childKey) {
+    return (0, rxjs_1.from)(deleteRelatedObject(parentElementId, parentKey, childElementId, childKey));
+}
+/**
+ * deleteRelatedObjects deletes multiple objects related to a specific parent.
+ *
+ * @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 Promise resolving to true if deletion was successful
+ */
+function deleteRelatedObjects(parentElementId, parentKey, childElementId, childKeys) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!sdk_general_1.userContext) {
+            throw new Error("userContext is required but not available; check that the initialize function has been called");
+        }
+        let url = `${sdk_general_1.serviceAddress}/schema/sandboxes/${sdk_general_1.sandboxKey}/${parentElementId}/${parentKey}/${childElementId}`;
+        let authToken = yield (0, rxjs_1.lastValueFrom)((0, sdk_general_1.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;
+    });
+}
+/**
+ * deleteRelatedObjectsAsObservable deletes multiple objects related to a specific parent.
+ *
+ * @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 Observable resolving to true if deletion was successful
+ */
+function deleteRelatedObjectsAsObservable(parentElementId, parentKey, childElementId, childKeys) {
+    return (0, rxjs_1.from)(deleteRelatedObjects(parentElementId, parentKey, childElementId, childKeys));
+}