@halix/action-sdk 1.0.23 → 1.0.25

package/lib/cjs/content.js

@@ -44,18 +44,9 @@ 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.
+ * Retrieves an existing content resource by key, or creates a new one if key is null.
  *
- * @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
+ * @returns Promise<ContentResource>
  */
 function getOrCreateResource(resourceKey, fileToUpload, publicFlag, resourceType, tags) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -96,29 +87,15 @@ function getOrCreateResource(resourceKey, fileToUpload, publicFlag, resourceType
     });
 }
 /**
- * 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
+ * Observable version of getOrCreateResource. See getOrCreateResource for details.
  */
 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).
+ * Saves a content resource with appropriate ownership based on context (solution builder vs org view).
  *
- * @param resource - The ContentResource to save
- *
- * @returns Promise resolving to the saved ContentResource
+ * @returns Promise<ContentResource>
  */
 function saveResource(resource) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -146,25 +123,15 @@ function saveResource(resource) {
     });
 }
 /**
- * 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
+ * Observable version of saveResource. See saveResource for details.
  */
 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.
+ * Uploads file contents to a resource via FormData.
  *
- * @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
+ * @returns Promise<boolean> - true if successful
  */
 function sendFileContents(resourceKey, fileToUpload, publicFlag) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -188,30 +155,15 @@ function sendFileContents(resourceKey, fileToUpload, publicFlag) {
     });
 }
 /**
- * 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
+ * Observable version of sendFileContents. See sendFileContents for details.
  */
 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.
+ * Creates or updates a content resource and uploads file contents. If resourceKey is provided, updates existing; otherwise creates new.
  *
- * @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
+ * @returns Promise<ContentResource> with uploaded file metadata
  */
 function createOrUpdateResource(resourceKey, fileToUpload, publicFlag, resourceType, tags) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -240,17 +192,7 @@ function createOrUpdateResource(resourceKey, fileToUpload, publicFlag, resourceT
     });
 }
 /**
- * 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
+ * Observable version of createOrUpdateResource. See createOrUpdateResource for details.
  */
 function createOrUpdateResourceAsObservable(resourceKey, fileToUpload, publicFlag, resourceType, tags) {
     return (0, rxjs_1.from)(createOrUpdateResource(resourceKey, fileToUpload, publicFlag, resourceType, tags));

package/lib/cjs/data-crud.js

@@ -49,16 +49,17 @@ 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.
+ * Retrieves a single object by dataElementId and key. Optionally fetch related objects.
  *
- * @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
+ * @returns Promise<any> - the object data
  */
 function getObject(dataElementId, key, fetchedRelationships) {
     return __awaiter(this, void 0, void 0, function* () {
+        if (!sdk_general_1.getAuthToken) {
+            const errorMessage = 'SDK not initialized.';
+            console.error(errorMessage);
+            throw new Error(errorMessage);
+        }
         let params;
         if (fetchedRelationships) {
             let p = {};
@@ -78,45 +79,28 @@ function getObject(dataElementId, key, fetchedRelationships) {
     });
 }
 /**
- * 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
+ * Observable version of getObject. See getObject for details.
  */
 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
- *
- * @see {@link FilterExpression} for filter syntax and examples
+ * Retrieves all objects related to a parent through a schema relationship. Commonly used to get objects belonging to current user/org proxy.
+ *
+ * @param parentElementId - Parent element ID
+ * @param parentKey - Parent object key
+ * @param elementId - Child element ID
+ * @param filter - Optional filter (see FilterExpression)
+ * @param fetchedRelationships - Optional relationships to include as nested objects
+ * @returns Promise<any[]>
  */
 function getRelatedObjects(parentElementId, parentKey, elementId, filter, fetchedRelationships) {
     return __awaiter(this, void 0, void 0, function* () {
+        if (!sdk_general_1.getAuthToken) {
+            const errorMessage = 'SDK not initialized.';
+            console.error(errorMessage);
+            throw new Error(errorMessage);
+        }
         let params;
         if (filter || fetchedRelationships) {
             let p = {};
@@ -139,29 +123,7 @@ function getRelatedObjects(parentElementId, parentKey, elementId, filter, fetche
     });
 }
 /**
- * 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
- *
- * @see {@link FilterExpression} for filter syntax and examples
+ * Observable version of getRelatedObjects. See getRelatedObjects for details.
  */
 function getRelatedObjectsAsObservable(parentElementId, parentKey, elementId, filter, fetchedRelationships) {
     return (0, rxjs_1.from)(getRelatedObjects(parentElementId, parentKey, elementId, filter, fetchedRelationships));
@@ -170,23 +132,19 @@ function getRelatedObjectsAsObservable(parentElementId, parentKey, elementId, fi
 // 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.
+ * Saves a related object and establishes relationship to parent. Returns saved object with any server-assigned values (objKey, calculated fields).
  *
- * @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
+ * @param objectToSave - JSON string of object data
+ * @param opts - Optional: bypassValidation
+ * @returns Promise<any> - saved object with updates
  */
 function saveRelatedObject(parentElementId, parentKey, elementId, objectToSave, opts) {
     return __awaiter(this, void 0, void 0, function* () {
+        if (!sdk_general_1.getAuthToken) {
+            const errorMessage = 'SDK not initialized.';
+            console.error(errorMessage);
+            throw new Error(errorMessage);
+        }
         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";
@@ -203,20 +161,7 @@ function saveRelatedObject(parentElementId, parentKey, elementId, objectToSave,
     });
 }
 /**
- * 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
+ * Observable version of saveRelatedObject. See saveRelatedObject for details.
  */
 function saveRelatedObjectAsObservable(parentElementId, parentKey, elementId, objectToSave, opts) {
     return (0, rxjs_1.from)(saveRelatedObject(parentElementId, parentKey, elementId, objectToSave, opts));
@@ -225,20 +170,20 @@ function saveRelatedObjectAsObservable(parentElementId, parentKey, elementId, ob
 // 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
+ * Deletes a single object related to a parent.
  *
- * @returns Promise resolving to true if deletion was successful
+ * @returns Promise<boolean> - true if 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");
         }
+        if (!sdk_general_1.getAuthToken) {
+            const errorMessage = 'SDK not initialized.';
+            console.error(errorMessage);
+            throw new Error(errorMessage);
+        }
         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);
@@ -249,33 +194,27 @@ function deleteRelatedObject(parentElementId, parentKey, childElementId, childKe
     });
 }
 /**
- * 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
+ * Observable version of deleteRelatedObject. See deleteRelatedObject for details.
  */
 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
+ * Deletes multiple objects related to a parent.
  *
- * @returns Promise resolving to true if deletion was successful
+ * @param childKeys - Array of child object keys to delete
+ * @returns Promise<boolean> - true if 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");
         }
+        if (!sdk_general_1.getAuthToken) {
+            const errorMessage = 'SDK not initialized.';
+            console.error(errorMessage);
+            throw new Error(errorMessage);
+        }
         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);
@@ -287,14 +226,7 @@ function deleteRelatedObjects(parentElementId, parentKey, childElementId, childK
     });
 }
 /**
- * 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
+ * Observable version of deleteRelatedObjects. See deleteRelatedObjects for details.
  */
 function deleteRelatedObjectsAsObservable(parentElementId, parentKey, childElementId, childKeys) {
     return (0, rxjs_1.from)(deleteRelatedObjects(parentElementId, parentKey, childElementId, childKeys));

package/lib/cjs/index.js

@@ -8,7 +8,7 @@
 // Unauthorized use outside the Halix platform is prohibited.
 // Full license terms available in the LICENSE file.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.debounceFn = exports.getValueFromObject = exports.compareValues = exports.sortObjectArray = exports.massDeleteAsObservable = exports.massDelete = exports.massEditAsObservable = exports.massEdit = exports.getListDataAsObservable = exports.getListData = exports.sendMessageAsObservable = exports.sendMessage = exports.MessageMethod = exports.createOrUpdateResourceAsObservable = exports.createOrUpdateResource = exports.sendFileContentsAsObservable = exports.sendFileContents = exports.saveResourceAsObservable = exports.saveResource = exports.getOrCreateResourceAsObservable = exports.getOrCreateResource = exports.deleteRelatedObjectsAsObservable = exports.deleteRelatedObjects = exports.deleteRelatedObjectAsObservable = exports.deleteRelatedObject = exports.saveRelatedObjectAsObservable = exports.saveRelatedObject = exports.getRelatedObjectsAsObservable = exports.getRelatedObjects = exports.getObjectAsObservable = exports.getObject = exports.prepareErrorResponse = exports.prepareSuccessResponse = exports.initialize = exports.useBody = exports.params = exports.userContext = exports.actionSubject = exports.serviceAddress = exports.sandboxKey = exports.getAuthToken = void 0;
+exports.debounceFn = exports.getValueFromObject = exports.compareValues = exports.sortObjectArray = exports.massDeleteAsObservable = exports.massDelete = exports.massEditAsObservable = exports.massEdit = exports.getListDataAsObservable = exports.getListData = exports.getPreferenceAsObservable = exports.getPreference = exports.sendMessageAsObservable = exports.sendMessage = exports.MessageMethod = exports.createOrUpdateResourceAsObservable = exports.createOrUpdateResource = exports.sendFileContentsAsObservable = exports.sendFileContents = exports.saveResourceAsObservable = exports.saveResource = exports.getOrCreateResourceAsObservable = exports.getOrCreateResource = exports.deleteRelatedObjectsAsObservable = exports.deleteRelatedObjects = exports.deleteRelatedObjectAsObservable = exports.deleteRelatedObject = exports.saveRelatedObjectAsObservable = exports.saveRelatedObject = exports.getRelatedObjectsAsObservable = exports.getRelatedObjects = exports.getObjectAsObservable = exports.getObject = exports.prepareErrorResponse = exports.prepareSuccessResponse = exports.initialize = exports.useBody = exports.params = exports.userContext = exports.actionSubject = exports.serviceAddress = exports.sandboxKey = exports.getAuthToken = void 0;
 /**
  * @module @halix/action-sdk
  * @description Halix Platform action SDK for developing NodeJS Lambda-based actions on the Halix
@@ -71,6 +71,13 @@ Object.defineProperty(exports, "MessageMethod", { enumerable: true, get: functio
 Object.defineProperty(exports, "sendMessage", { enumerable: true, get: function () { return messaging_1.sendMessage; } });
 Object.defineProperty(exports, "sendMessageAsObservable", { enumerable: true, get: function () { return messaging_1.sendMessageAsObservable; } });
 // ================================================================================
+// PREFERENCE FUNCTIONS
+// ================================================================================
+var preferences_1 = require("./preferences");
+// Preference Functions
+Object.defineProperty(exports, "getPreference", { enumerable: true, get: function () { return preferences_1.getPreference; } });
+Object.defineProperty(exports, "getPreferenceAsObservable", { enumerable: true, get: function () { return preferences_1.getPreferenceAsObservable; } });
+// ================================================================================
 // LIST DATA FUNCTIONS
 // ================================================================================
 var lists_1 = require("./lists");