@halix/action-sdk 1.0.19 → 1.0.21

package/lib/cjs/utilities.js

@@ -0,0 +1,131 @@
+"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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sortObjectArray = sortObjectArray;
+exports.compareValues = compareValues;
+exports.getValueFromObject = getValueFromObject;
+exports.debounceFn = debounceFn;
+// ================================================================================
+// 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.
+ *
+ * @param fn - The function to debounce
+ * @param wait - The number of milliseconds to wait before calling the function
+ *
+ * @returns The debounced function
+ */
+function debounceFn(fn, wait = 200) {
+    let timeout;
+    return (...args) => {
+        clearTimeout(timeout);
+        timeout = setTimeout(() => fn(...args), wait);
+    };
+}

package/lib/esm/content.js

@@ -0,0 +1,228 @@
+// 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.
+/**
+ * @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.)
+ */
+import axios from 'axios';
+import { from, lastValueFrom } from 'rxjs';
+import { sandboxKey, serviceAddress, getAuthToken, userContext } from './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
+ */
+export async function getOrCreateResource(resourceKey, fileToUpload, publicFlag, resourceType, tags) {
+    if (!userContext) {
+        throw new Error("userContext is required but not available; check that the initialize function has been called");
+    }
+    if (resourceKey) {
+        let url = `${serviceAddress}/sandboxes/${sandboxKey}/contentResource/${resourceKey}`;
+        let authToken = await lastValueFrom(getAuthToken());
+        console.log("Sending GET request to " + url + " with token " + authToken);
+        let response = await axios.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: userContext.orgKey,
+        sandboxKey: sandboxKey,
+        userKey: 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
+ */
+export function getOrCreateResourceAsObservable(resourceKey, fileToUpload, publicFlag, resourceType, tags) {
+    return 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
+ */
+export async function saveResource(resource) {
+    if (!userContext) {
+        throw new Error("userContext is required but not available; check that the initialize function has been called");
+    }
+    let params = {};
+    if (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 = userContext.orgProxyKey;
+    }
+    else {
+        params.organizationKey = userContext.orgKey;
+        params.userKey = userContext.user.objKey;
+    }
+    let url = `${serviceAddress}/sandboxes/${sandboxKey}/contentResource`;
+    let authToken = await lastValueFrom(getAuthToken());
+    console.log("Sending POST request to " + url + " with token " + authToken);
+    let response = await axios.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
+ */
+export function saveResourceAsObservable(resource) {
+    return 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
+ */
+export async function sendFileContents(resourceKey, fileToUpload, publicFlag) {
+    if (!userContext) {
+        throw new Error("userContext is required but not available; check that the initialize function has been called");
+    }
+    let url = `${serviceAddress}/filecontent/${sandboxKey}/${resourceKey}`;
+    let authToken = await lastValueFrom(getAuthToken());
+    console.log("Sending file upload request to " + url + " with token " + authToken);
+    let formData = new FormData();
+    formData.append("fileUpload", fileToUpload);
+    formData.append("scopeKeyPath", userContext.orgProxyKey);
+    formData.append("public", String(publicFlag));
+    let response = await axios.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
+ */
+export function sendFileContentsAsObservable(resourceKey, fileToUpload, publicFlag) {
+    return 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
+ */
+export async function createOrUpdateResource(resourceKey, fileToUpload, publicFlag, resourceType, tags) {
+    if (!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 = await getOrCreateResource(resourceKey, fileToUpload, publicFlag, resourceType, tags);
+    // Save the resource to get the objKey if it's new
+    let savedResource = await saveResource(resource);
+    // Upload the file contents
+    if (!savedResource.objKey) {
+        throw new Error("Resource was saved but no objKey was returned");
+    }
+    let uploadSuccess = await sendFileContents(savedResource.objKey, fileToUpload, publicFlag);
+    if (!uploadSuccess) {
+        throw new Error("Failed to upload file contents");
+    }
+    // Get the updated resource with file metadata
+    let updatedResource = await 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
+ */
+export function createOrUpdateResourceAsObservable(resourceKey, fileToUpload, publicFlag, resourceType, tags) {
+    return from(createOrUpdateResource(resourceKey, fileToUpload, publicFlag, resourceType, tags));
+}
+//# sourceMappingURL=content.js.map

package/lib/esm/content.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content.js","sourceRoot":"","sources":["../../src/content.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,mCAAmC;AACnC,EAAE;AACF,oEAAoE;AACpE,0EAA0E;AAC1E,EAAE;AACF,6DAA6D;AAC7D,oDAAoD;AAEpD;;;;;;;;GAQG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAc,aAAa,EAAE,MAAM,MAAM,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AA0BtF,mFAAmF;AACnF,6BAA6B;AAC7B,mFAAmF;AAEnF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,WAA0B,EAAE,YAAgC,EAAE,UAAmB,EAAE,YAAoB,EAAE,IAAc;IAE7J,IAAI,CAAC,WAAW,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,+FAA+F,CAAC,CAAC;IACrH,CAAC;IAED,IAAI,WAAW,EAAE,CAAC;QACd,IAAI,GAAG,GAAG,GAAG,cAAc,cAAc,UAAU,oBAAoB,WAAW,EAAE,CAAC;QACrF,IAAI,SAAS,GAAG,MAAM,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;QAEpD,OAAO,CAAC,GAAG,CAAC,yBAAyB,GAAG,GAAG,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;QAE1E,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE;YAChC,OAAO,EAAE,EAAE,eAAe,EAAE,UAAU,SAAS,EAAE,EAAE;SACtD,CAAC,CAAC;QAEH,IAAI,QAAQ,GAAoB,QAAQ,CAAC,IAAI,CAAC;QAC9C,IAAI,YAAY,EAAE,CAAC;YACf,QAAQ,CAAC,WAAW,GAAG,YAAY,CAAC,IAAI,CAAC;YAEzC,+EAA+E;YAC/E,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;YACrB,QAAQ,CAAC,SAAS,GAAG,IAAI,CAAC;QAC9B,CAAC;QACD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,IAAI,WAAW,GAAoB;QAC/B,QAAQ,EAAE,UAAU;QACpB,YAAY,EAAE,YAAY;QAC1B,IAAI,EAAE,IAAI;QACV,eAAe,EAAE,WAAW,CAAC,MAAM;QACnC,UAAU,EAAE,UAAU;QACtB,OAAO,EAAE,WAAW,CAAC,IAAI,CAAC,MAAM;KACnC,CAAC;IAEF,IAAI,YAAY,EAAE,CAAC;QACf,WAAW,CAAC,WAAW,GAAG,YAAY,CAAC,IAAI,CAAC;QAE5C,+EAA+E;QAC/E,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC;QACxB,WAAW,CAAC,SAAS,GAAG,IAAI,CAAC;IACjC,CAAC;IAED,OAAO,WAAW,CAAC;AACvB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,+BAA+B,CAAC,WAA0B,EAAE,YAAgC,EAAE,UAAmB,EAAE,YAAoB,EAAE,IAAc;IACnK,OAAO,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC;AAChG,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,QAAyB;IAExD,IAAI,CAAC,WAAW,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,+FAA+F,CAAC,CAAC;IACrH,CAAC;IAED,IAAI,MAAM,GAAQ,EAAE,CAAC;IAErB,IAAI,WAAW,CAAC,QAAQ,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;QAC9C,gHAAgH;QAChH,oBAAoB;QACpB,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC;IACjD,CAAC;SAAM,CAAC;QACJ,MAAM,CAAC,eAAe,GAAG,WAAW,CAAC,MAAM,CAAC;QAC5C,MAAM,CAAC,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC;IAC7C,CAAC;IAED,IAAI,GAAG,GAAG,GAAG,cAAc,cAAc,UAAU,kBAAkB,CAAC;IACtE,IAAI,SAAS,GAAG,MAAM,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,GAAG,CAAC,0BAA0B,GAAG,GAAG,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;IAE3E,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE;QAC3D,OAAO,EAAE,EAAE,eAAe,EAAE,UAAU,SAAS,EAAE,EAAE;QACnD,MAAM,EAAE,MAAM;KACjB,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;AACzB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,wBAAwB,CAAC,QAAyB;IAC9D,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;AACxC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,WAAmB,EAAE,YAAyB,EAAE,UAAmB;IAEtG,IAAI,CAAC,WAAW,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,+FAA+F,CAAC,CAAC;IACrH,CAAC;IAED,IAAI,GAAG,GAAG,GAAG,cAAc,gBAAgB,UAAU,IAAI,WAAW,EAAE,CAAC;IACvE,IAAI,SAAS,GAAG,MAAM,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,GAAG,CAAC,iCAAiC,GAAG,GAAG,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;IAElF,IAAI,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAC9B,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;IAC5C,QAAQ,CAAC,MAAM,CAAC,cAAc,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;IACzD,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAE9C,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,EAAE;QAC3C,OAAO,EAAE;YACL,eAAe,EAAE,UAAU,SAAS,EAAE;YACtC,cAAc,EAAE,qBAAqB;SACxC;KACJ,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,4BAA4B,CAAC,WAAmB,EAAE,YAAyB,EAAE,UAAmB;IAC5G,OAAO,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC;AACzE,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,WAA0B,EAAE,YAAyB,EAAE,UAAmB,EAAE,YAAoB,EAAE,IAAc;IAEzJ,IAAI,CAAC,WAAW,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,+FAA+F,CAAC,CAAC;IACrH,CAAC;IAED,6BAA6B;IAC7B,IAAI,QAAQ,GAAG,MAAM,mBAAmB,CAAC,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;IAEpG,kDAAkD;IAClD,IAAI,aAAa,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC,CAAC;IAEjD,2BAA2B;IAC3B,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACrE,CAAC;IAED,IAAI,aAAa,GAAG,MAAM,gBAAgB,CAAC,aAAa,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;IAE3F,IAAI,CAAC,aAAa,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACtD,CAAC;IAED,8CAA8C;IAC9C,IAAI,eAAe,GAAG,MAAM,mBAAmB,CAAC,aAAa,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC;IAElH,8DAA8D;IAC9D,IAAI,eAAe,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,YAAY,YAAY,IAAI,EAAE,CAAC;QAC3E,eAAe,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;IAC7C,CAAC;IAED,OAAO,eAAe,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,kCAAkC,CAAC,WAA0B,EAAE,YAAyB,EAAE,UAAmB,EAAE,YAAoB,EAAE,IAAc;IAC/J,OAAO,IAAI,CAAC,sBAAsB,CAAC,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC;AACnG,CAAC"}

package/lib/esm/data-crud.js

@@ -0,0 +1,264 @@
+// 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.
+/**
+ * @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.
+ * Note: for list-like displays, the `lists` module is preferred.
+ *
+ * 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
+ */
+import axios from 'axios';
+import { from, lastValueFrom } from 'rxjs';
+import { sandboxKey, serviceAddress, getAuthToken, userContext } from './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
+ */
+export async function getObject(dataElementId, key, fetchedRelationships) {
+    let params;
+    if (fetchedRelationships) {
+        let p = {};
+        if (fetchedRelationships) {
+            p.fetchedRelationships = fetchedRelationships.join(",");
+        }
+        params = new URLSearchParams(p);
+    }
+    let url = `${serviceAddress}/schema/sandboxes/${sandboxKey}/${dataElementId}/${key}`;
+    let authToken = await lastValueFrom(getAuthToken());
+    console.log("Sending GET request to " + url + " with token " + authToken);
+    let response = await axios.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
+ */
+export function getObjectAsObservable(dataElementId, key, fetchedRelationships) {
+    return 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
+ */
+export async function getRelatedObjects(parentElementId, parentKey, elementId, filter, fetchedRelationships) {
+    let params;
+    if (filter || fetchedRelationships) {
+        let p = {};
+        if (filter) {
+            p.filter = filter;
+        }
+        if (fetchedRelationships) {
+            p.fetchedRelationships = fetchedRelationships.join(",");
+        }
+        params = new URLSearchParams(p);
+    }
+    let url = `${serviceAddress}/schema/sandboxes/${sandboxKey}/${parentElementId}/${parentKey}/${elementId}`;
+    let authToken = await lastValueFrom(getAuthToken());
+    console.log("Sending GET request to " + url + " with token " + authToken);
+    let response = await axios.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
+ */
+export function getRelatedObjectsAsObservable(parentElementId, parentKey, elementId, filter, fetchedRelationships) {
+    return 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
+ */
+export async function saveRelatedObject(parentElementId, parentKey, elementId, objectToSave, opts) {
+    let url = `${serviceAddress}/schema/sandboxes/${sandboxKey}/${parentElementId}/${parentKey}/${elementId}`;
+    if (opts?.bypassValidation === false) {
+        url += "?bypassValidation=false";
+    }
+    else {
+        url += "?bypassValidation=true";
+    }
+    let authToken = await lastValueFrom(getAuthToken());
+    console.log("Sending POST request to " + url + " with token " + authToken);
+    let response = await axios.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
+ */
+export function saveRelatedObjectAsObservable(parentElementId, parentKey, elementId, objectToSave, opts) {
+    return 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
+ */
+export async function deleteRelatedObject(parentElementId, parentKey, childElementId, childKey) {
+    if (!userContext) {
+        throw new Error("userContext is required but not available; check that the initialize function has been called");
+    }
+    let url = `${serviceAddress}/schema/sandboxes/${sandboxKey}/${parentElementId}/${parentKey}/${childElementId}/${childKey}`;
+    let authToken = await lastValueFrom(getAuthToken());
+    console.log("Sending DELETE request to " + url + " with token " + authToken);
+    let response = await axios.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
+ */
+export function deleteRelatedObjectAsObservable(parentElementId, parentKey, childElementId, childKey) {
+    return 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
+ */
+export async function deleteRelatedObjects(parentElementId, parentKey, childElementId, childKeys) {
+    if (!userContext) {
+        throw new Error("userContext is required but not available; check that the initialize function has been called");
+    }
+    let url = `${serviceAddress}/schema/sandboxes/${sandboxKey}/${parentElementId}/${parentKey}/${childElementId}`;
+    let authToken = await lastValueFrom(getAuthToken());
+    console.log("Sending DELETE request to " + url + " with token " + authToken);
+    let response = await axios.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
+ */
+export function deleteRelatedObjectsAsObservable(parentElementId, parentKey, childElementId, childKeys) {
+    return from(deleteRelatedObjects(parentElementId, parentKey, childElementId, childKeys));
+}
+//# sourceMappingURL=data-crud.js.map

package/lib/esm/data-crud.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-crud.js","sourceRoot":"","sources":["../../src/data-crud.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,mCAAmC;AACnC,EAAE;AACF,oEAAoE;AACpE,0EAA0E;AAC1E,EAAE;AACF,6DAA6D;AAC7D,oDAAoD;AAEpD;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAc,aAAa,EAAE,MAAM,MAAM,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AActF,mFAAmF;AACnF,2BAA2B;AAC3B,mFAAmF;AAEnF;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,aAAqB,EAAE,GAAW,EAAE,oBAA+B;IAE/F,IAAI,MAAM,CAAC;IACX,IAAI,oBAAoB,EAAE,CAAC;QACvB,IAAI,CAAC,GAAG,EAAE,CAAC;QACX,IAAI,oBAAoB,EAAE,CAAC;YACjB,CAAE,CAAC,oBAAoB,GAAG,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnE,CAAC;QAED,MAAM,GAAG,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;IAED,IAAI,GAAG,GAAG,GAAG,cAAc,qBAAqB,UAAU,IAAI,aAAa,IAAI,GAAG,EAAE,CAAC;IAErF,IAAI,SAAS,GAAG,MAAM,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,GAAG,CAAC,yBAAyB,GAAG,GAAG,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;IAE1E,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE;QAChC,OAAO,EAAE,EAAE,eAAe,EAAE,UAAU,SAAS,EAAE,EAAE;QACnD,MAAM,EAAE,MAAM;KACjB,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;AACzB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,qBAAqB,CAAC,aAAqB,EAAE,GAAW,EAAE,oBAA+B;IACrG,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,GAAG,EAAE,oBAAoB,CAAC,CAAC,CAAC;AACrE,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,eAAuB,EAAE,SAAiB,EAAE,SAAiB,EAAE,MAAe,EAAE,oBAA+B;IAEnJ,IAAI,MAAM,CAAC;IACX,IAAI,MAAM,IAAI,oBAAoB,EAAE,CAAC;QACjC,IAAI,CAAC,GAAG,EAAE,CAAC;QACX,IAAI,MAAM,EAAE,CAAC;YACH,CAAE,CAAC,MAAM,GAAG,MAAM,CAAC;QAC7B,CAAC;QACD,IAAI,oBAAoB,EAAE,CAAC;YACjB,CAAE,CAAC,oBAAoB,GAAG,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnE,CAAC;QAED,MAAM,GAAG,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;IAED,IAAI,GAAG,GAAG,GAAG,cAAc,qBAAqB,UAAU,IAAI,eAAe,IAAI,SAAS,IAAI,SAAS,EAAE,CAAC;IAE1G,IAAI,SAAS,GAAG,MAAM,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,GAAG,CAAC,yBAAyB,GAAG,GAAG,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;IAE1E,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE;QAChC,OAAO,EAAE,EAAE,eAAe,EAAE,UAAU,SAAS,EAAE,EAAE;QACnD,MAAM,EAAE,MAAM;KACjB,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,6BAA6B,CAAC,eAAuB,EAAE,SAAiB,EAAE,SAAiB,EAAE,MAAe,EAAE,oBAA+B;IACzJ,OAAO,IAAI,CAAC,iBAAiB,CAAC,eAAe,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,oBAAoB,CAAC,CAAC,CAAC;AACxG,CAAC;AAED,mFAAmF;AACnF,sBAAsB;AACtB,mFAAmF;AAEnF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,eAAuB,EAAE,SAAiB,EAAE,SAAiB,EAAE,YAAoB,EAAE,IAAkB;IAE3I,IAAI,GAAG,GAAG,GAAG,cAAc,qBAAqB,UAAU,IAAI,eAAe,IAAI,SAAS,IAAI,SAAS,EAAE,CAAC;IAE1G,IAAI,IAAI,EAAE,gBAAgB,KAAK,KAAK,EAAE,CAAC;QACnC,GAAG,IAAI,yBAAyB,CAAC;IACrC,CAAC;SAAM,CAAC;QACJ,GAAG,IAAI,wBAAwB,CAAC;IACpC,CAAC;IAED,IAAI,SAAS,GAAG,MAAM,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,GAAG,CAAC,0BAA0B,GAAG,GAAG,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;IAE3E,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,EAAE;QAC/C,OAAO,EAAE,EAAE,eAAe,EAAE,UAAU,SAAS,EAAE,EAAE;KACtD,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,6BAA6B,CAAC,eAAuB,EAAE,SAAiB,EAAE,SAAiB,EAAE,YAAoB,EAAE,IAAkB;IACjJ,OAAO,IAAI,CAAC,iBAAiB,CAAC,eAAe,EAAE,SAAS,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC;AAC9F,CAAC;AAED,mFAAmF;AACnF,wBAAwB;AACxB,mFAAmF;AAEnF;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,eAAuB,EAAE,SAAiB,EAAE,cAAsB,EAAE,QAAgB;IAE1H,IAAI,CAAC,WAAW,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,+FAA+F,CAAC,CAAC;IACrH,CAAC;IAED,IAAI,GAAG,GAAG,GAAG,cAAc,qBAAqB,UAAU,IAAI,eAAe,IAAI,SAAS,IAAI,cAAc,IAAI,QAAQ,EAAE,CAAC;IAC3H,IAAI,SAAS,GAAG,MAAM,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,GAAG,CAAC,4BAA4B,GAAG,GAAG,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;IAE7E,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE;QACnC,OAAO,EAAE,EAAE,eAAe,EAAE,UAAU,SAAS,EAAE,EAAE;KACtD,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,+BAA+B,CAAC,eAAuB,EAAE,SAAiB,EAAE,cAAsB,EAAE,QAAgB;IAChI,OAAO,IAAI,CAAC,mBAAmB,CAAC,eAAe,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC3F,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,eAAuB,EAAE,SAAiB,EAAE,cAAsB,EAAE,SAAmB;IAE9H,IAAI,CAAC,WAAW,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,+FAA+F,CAAC,CAAC;IACrH,CAAC;IAED,IAAI,GAAG,GAAG,GAAG,cAAc,qBAAqB,UAAU,IAAI,eAAe,IAAI,SAAS,IAAI,cAAc,EAAE,CAAC;IAC/G,IAAI,SAAS,GAAG,MAAM,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,GAAG,CAAC,4BAA4B,GAAG,GAAG,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;IAE7E,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE;QACnC,OAAO,EAAE,EAAE,eAAe,EAAE,UAAU,SAAS,EAAE,EAAE;QACnD,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;KACxC,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,gCAAgC,CAAC,eAAuB,EAAE,SAAiB,EAAE,cAAsB,EAAE,SAAmB;IACpI,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,EAAE,SAAS,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC;AAC7F,CAAC"}