@halix/action-sdk 1.0.21 → 1.0.22

package/lib/cjs/data-crud.js

@@ -112,6 +112,8 @@ function getObjectAsObservable(dataElementId, key, fetchedRelationships) {
  * 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
  */
 function getRelatedObjects(parentElementId, parentKey, elementId, filter, fetchedRelationships) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -158,6 +160,8 @@ function getRelatedObjects(parentElementId, parentKey, elementId, filter, fetche
  * 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
  */
 function getRelatedObjectsAsObservable(parentElementId, parentKey, elementId, filter, fetchedRelationships) {
     return (0, rxjs_1.from)(getRelatedObjects(parentElementId, parentKey, elementId, filter, fetchedRelationships));

package/lib/cjs/filter-expressions.js

@@ -0,0 +1,10 @@
+"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 });

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.getListDataAsObservable = exports.getListData = 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.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
@@ -62,12 +62,25 @@ Object.defineProperty(exports, "sendFileContentsAsObservable", { enumerable: tru
 Object.defineProperty(exports, "createOrUpdateResource", { enumerable: true, get: function () { return content_1.createOrUpdateResource; } });
 Object.defineProperty(exports, "createOrUpdateResourceAsObservable", { enumerable: true, get: function () { return content_1.createOrUpdateResourceAsObservable; } });
 // ================================================================================
+// MESSAGING FUNCTIONS
+// ================================================================================
+var messaging_1 = require("./messaging");
+// Messaging Enums
+Object.defineProperty(exports, "MessageMethod", { enumerable: true, get: function () { return messaging_1.MessageMethod; } });
+// Messaging Functions
+Object.defineProperty(exports, "sendMessage", { enumerable: true, get: function () { return messaging_1.sendMessage; } });
+Object.defineProperty(exports, "sendMessageAsObservable", { enumerable: true, get: function () { return messaging_1.sendMessageAsObservable; } });
+// ================================================================================
 // LIST DATA FUNCTIONS
 // ================================================================================
 var lists_1 = require("./lists");
 // Functions
 Object.defineProperty(exports, "getListData", { enumerable: true, get: function () { return lists_1.getListData; } });
 Object.defineProperty(exports, "getListDataAsObservable", { enumerable: true, get: function () { return lists_1.getListDataAsObservable; } });
+Object.defineProperty(exports, "massEdit", { enumerable: true, get: function () { return lists_1.massEdit; } });
+Object.defineProperty(exports, "massEditAsObservable", { enumerable: true, get: function () { return lists_1.massEditAsObservable; } });
+Object.defineProperty(exports, "massDelete", { enumerable: true, get: function () { return lists_1.massDelete; } });
+Object.defineProperty(exports, "massDeleteAsObservable", { enumerable: true, get: function () { return lists_1.massDeleteAsObservable; } });
 // ================================================================================
 // UTILITY FUNCTIONS
 // ================================================================================

package/lib/cjs/lists.js

@@ -22,9 +22,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getListData = getListData;
 exports.getListDataAsObservable = getListDataAsObservable;
+exports.massEdit = massEdit;
+exports.massEditAsObservable = massEditAsObservable;
+exports.massDelete = massDelete;
+exports.massDeleteAsObservable = massDeleteAsObservable;
 /**
  * @module @halix/action-sdk/lists
- * @description List data retrieval functions. Use this to efficiently retrieve objects
+ * @description List data retrieval and bulk operations. Use this to efficiently retrieve objects
  * from the database for display in list-like user interfaces. This is preferred over
  * the `data-crud` module when showing one page of data at a time.
  *
@@ -34,6 +38,8 @@ exports.getListDataAsObservable = getListDataAsObservable;
  * - Sorting
  * - Filtering
  * - Search
+ * - Mass edit operations (bulk update multiple records)
+ * - Mass delete operations (bulk delete multiple records)
  */
 const axios_1 = __importDefault(require("axios"));
 const rxjs_1 = require("rxjs");
@@ -173,3 +179,176 @@ function getListData(request, options) {
 function getListDataAsObservable(request, options) {
     return (0, rxjs_1.from)(getListData(request, options));
 }
+// ================================================================================
+// MASS EDIT AND DELETE FUNCTIONS
+// ================================================================================
+/**
+ * massEdit performs a bulk update operation on multiple records. This function allows you to
+ * update a specific property on multiple objects in a single request.
+ *
+ * **Security Scoping**: The dataRequest serves as a security boundary. Only records that would
+ * be returned by the dataRequest can be updated. The keys array must reference records within
+ * this scope. This allows efficient security validation without checking each record individually.
+ *
+ * The value can be set in two ways based on valueType:
+ * - 'literal': Set the property to a literal value
+ * - 'property': Copy the value from another property on the same object
+ *
+ * @param request - The mass edit request specifying what to update and how
+ *
+ * @returns Promise resolving to statistics about the operation
+ *
+ * @example
+ * // Update the status of multiple orders to 'shipped'
+ * const result = await massEdit({
+ *   keys: ['order-123', 'order-456', 'order-789'],
+ *   dataRequest: {
+ *     dataElementId: 'order',
+ *     parentDataElementId: 'company',
+ *     parentKey: orgProxyKey
+ *   },
+ *   dataElementId: 'order',
+ *   property: 'status',
+ *   valueType: 'literal',
+ *   value: 'shipped'
+ * });
+ * console.log(`Updated ${result.succeeded} of ${result.tried} orders`);
+ *
+ * @example
+ * // Copy shipping address to billing address for multiple customers
+ * const result = await massEdit({
+ *   keys: selectedCustomerKeys,
+ *   dataRequest: {
+ *     dataElementId: 'customer',
+ *     parentDataElementId: 'company',
+ *     parentKey: orgProxyKey
+ *   },
+ *   dataElementId: 'customer',
+ *   property: 'billingAddress',
+ *   valueType: 'property',
+ *   value: 'shippingAddress'
+ * });
+ */
+function massEdit(request) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const url = `${sdk_general_1.serviceAddress}/list/sandboxes/${sdk_general_1.sandboxKey}/massedit`;
+        // Build headers with authentication token
+        let authToken = yield (0, rxjs_1.lastValueFrom)((0, sdk_general_1.getAuthToken)());
+        let headers = {
+            Authorization: `Bearer ${authToken}`
+        };
+        console.log("Sending POST request to " + url + " with token " + authToken);
+        // Make the API request
+        let response = yield axios_1.default.post(url, request, { headers });
+        return response.data;
+    });
+}
+/**
+ * massEditAsObservable performs a bulk update operation on multiple records, returning an Observable.
+ * See massEdit for detailed documentation.
+ *
+ * @param request - The mass edit request specifying what to update and how
+ *
+ * @returns Observable resolving to statistics about the operation
+ *
+ * @example
+ * massEditAsObservable({
+ *   keys: ['order-123', 'order-456'],
+ *   dataRequest: {
+ *     dataElementId: 'order',
+ *     parentDataElementId: 'company',
+ *     parentKey: orgProxyKey
+ *   },
+ *   dataElementId: 'order',
+ *   property: 'status',
+ *   valueType: 'literal',
+ *   value: 'shipped'
+ * }).subscribe(result => {
+ *   console.log(`Updated ${result.succeeded} of ${result.tried} orders`);
+ * });
+ */
+function massEditAsObservable(request) {
+    return (0, rxjs_1.from)(massEdit(request));
+}
+/**
+ * massDelete performs a bulk delete operation on multiple records. This function allows you to
+ * soft-delete multiple objects in a single request.
+ *
+ * **Security Scoping**: The dataRequest serves as a security boundary. Only records that would
+ * be returned by the dataRequest can be deleted. The keys array must reference records within
+ * this scope. This allows efficient security validation without checking each record individually.
+ *
+ * If emptyList is set to true, all records returned by the dataRequest will be deleted,
+ * ignoring the keys array.
+ *
+ * @param request - The mass delete request specifying what to delete
+ *
+ * @returns Promise resolving to statistics about the operation
+ *
+ * @example
+ * // Delete specific orders
+ * const result = await massDelete({
+ *   keys: ['order-123', 'order-456', 'order-789'],
+ *   dataRequest: {
+ *     dataElementId: 'order',
+ *     parentDataElementId: 'company',
+ *     parentKey: orgProxyKey,
+ *     filter: { field: 'status', operator: '==', value: 'cancelled' }
+ *   },
+ *   dataElementId: 'order'
+ * });
+ * console.log(`Deleted ${result.succeeded} of ${result.tried} orders`);
+ *
+ * @example
+ * // Delete all records matching the filter
+ * const result = await massDelete({
+ *   keys: [],
+ *   dataRequest: {
+ *     dataElementId: 'tempRecord',
+ *     parentDataElementId: 'company',
+ *     parentKey: orgProxyKey,
+ *     filter: { field: 'createdDate', operator: '<', value: '2023-01-01' }
+ *   },
+ *   dataElementId: 'tempRecord',
+ *   emptyList: true
+ * });
+ * console.log(`Deleted ${result.succeeded} old records`);
+ */
+function massDelete(request) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const url = `${sdk_general_1.serviceAddress}/list/sandboxes/${sdk_general_1.sandboxKey}/massdelete`;
+        // Build headers with authentication token
+        let authToken = yield (0, rxjs_1.lastValueFrom)((0, sdk_general_1.getAuthToken)());
+        let headers = {
+            Authorization: `Bearer ${authToken}`
+        };
+        console.log("Sending POST request to " + url + " with token " + authToken);
+        // Make the API request
+        let response = yield axios_1.default.post(url, request, { headers });
+        return response.data;
+    });
+}
+/**
+ * massDeleteAsObservable performs a bulk delete operation on multiple records, returning an Observable.
+ * See massDelete for detailed documentation.
+ *
+ * @param request - The mass delete request specifying what to delete
+ *
+ * @returns Observable resolving to statistics about the operation
+ *
+ * @example
+ * massDeleteAsObservable({
+ *   keys: ['order-123', 'order-456'],
+ *   dataRequest: {
+ *     dataElementId: 'order',
+ *     parentDataElementId: 'company',
+ *     parentKey: orgProxyKey
+ *   },
+ *   dataElementId: 'order'
+ * }).subscribe(result => {
+ *   console.log(`Deleted ${result.succeeded} of ${result.tried} orders`);
+ * });
+ */
+function massDeleteAsObservable(request) {
+    return (0, rxjs_1.from)(massDelete(request));
+}

package/lib/cjs/messaging.js

@@ -0,0 +1,152 @@
+"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.MessageMethod = void 0;
+exports.sendMessage = sendMessage;
+exports.sendMessageAsObservable = sendMessageAsObservable;
+/**
+ * @module @halix/action-sdk/messaging
+ * @description Messaging and notification functions for the Halix Platform action SDK. This module
+ * provides functions for sending messages (email, text) through the Halix notification service.
+ */
+const axios_1 = __importDefault(require("axios"));
+const rxjs_1 = require("rxjs");
+const sdk_general_1 = require("./sdk-general");
+// ================================================================================
+// ENUMS & CONSTANTS
+// ================================================================================
+/**
+ * MessageMethod represents the delivery method for a message.
+ */
+var MessageMethod;
+(function (MessageMethod) {
+    /** Send as email */
+    MessageMethod["Email"] = "email";
+    /** Send as text/SMS */
+    MessageMethod["Text"] = "text";
+    /** Send as both email and text */
+    MessageMethod["EmailAndText"] = "email,text";
+})(MessageMethod || (exports.MessageMethod = MessageMethod = {}));
+// ================================================================================
+// MESSAGING FUNCTIONS
+// ================================================================================
+/**
+ * sendMessage sends a message (email and/or text) to recipients through the Halix notification
+ * service. The message is sent asynchronously - this function returns immediately after the
+ * message is queued for sending.
+ *
+ * @param orgProxyElementId - The ID of the organization proxy element (e.g., "business", "school")
+ * @param orgProxyKey - The key of the organization proxy object
+ * @param message - The message request object containing recipients, content, and delivery options
+ *
+ * @returns Promise that resolves when the message has been queued for sending
+ *
+ * @example
+ * ```typescript
+ * // Send an email to customers (sentAs defaults to email)
+ * await sendMessage('business', businessKey, {
+ *   userProxyKeys: [customerKey1, customerKey2, customerKey3],
+ *   subject: 'Important Announcement',
+ *   body: '<p>This is an important announcement.</p>',
+ *   replyToEmail: 'sender@example.com'
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Send to user proxies and direct email addresses
+ * await sendMessage('business', businessKey, {
+ *   userProxyKeys: [clientKey1, clientKey2],
+ *   directEmailAddresses: ['manager@example.com'],
+ *   sentAs: MessageMethod.EmailAndText,
+ *   subject: 'Project Reminder',
+ *   body: '<p>Don\'t forget about the deadline.</p>',
+ *   resourceKeys: [attachmentKey]
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Send email to direct addresses only (no user proxies)
+ * await sendMessage('business', businessKey, {
+ *   directEmailAddresses: ['partner@example.com', 'vendor@example.com'],
+ *   subject: 'External Notification',
+ *   body: '<p>Important information for external stakeholders.</p>'
+ * });
+ * ```
+ */
+function sendMessage(orgProxyElementId, orgProxyKey, message) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        // Build the server request from the simplified client request
+        const serverRequest = {
+            recipientGroups: message.userProxyKeys && message.userProxyKeys.length > 0 ? [
+                {
+                    type: "",
+                    recipientKeys: message.userProxyKeys
+                }
+            ] : [],
+            sentAs: ((_a = message.sentAs) === null || _a === void 0 ? void 0 : _a.toString()) || MessageMethod.Email,
+            type: "direct",
+            subject: message.subject,
+            body: message.body,
+            replyToEmail: message.replyToEmail,
+            resourceKeys: message.resourceKeys,
+            additionalEmails: message.directEmailAddresses
+        };
+        let url = `${sdk_general_1.serviceAddress}/notification/sandboxes/${sdk_general_1.sandboxKey}/${orgProxyElementId}/${orgProxyKey}/sendMessage`;
+        let authToken = yield (0, rxjs_1.lastValueFrom)((0, sdk_general_1.getAuthToken)());
+        console.log("Sending POST request to " + url + " with token " + authToken);
+        yield axios_1.default.post(url, serverRequest, {
+            headers: { "Authorization": `Bearer ${authToken}` },
+        });
+        // Note: The message is sent asynchronously by the notification service
+        // This function returns once the message has been queued, not when delivery is complete
+    });
+}
+/**
+ * sendMessageAsObservable sends a message (email and/or text) to recipients through the Halix
+ * notification service. The message is sent asynchronously - this observable completes immediately
+ * after the message is queued for sending.
+ *
+ * @param orgProxyElementId - The ID of the organization proxy element (e.g., "business", "school")
+ * @param orgProxyKey - The key of the organization proxy object
+ * @param message - The message request object containing recipients, content, and delivery options
+ *
+ * @returns Observable that completes when the message has been queued for sending
+ *
+ * @example
+ * ```typescript
+ * sendMessageAsObservable('business', businessKey, {
+ *   userProxyKeys: [customerKey1, customerKey2],
+ *   directEmailAddresses: ['admin@example.com'],
+ *   subject: 'Monthly Newsletter',
+ *   body: '<p>Newsletter content here...</p>'
+ * }).subscribe({
+ *   next: () => console.log('Message queued for sending'),
+ *   error: (err) => console.error('Failed to send message:', err)
+ * });
+ * ```
+ */
+function sendMessageAsObservable(orgProxyElementId, orgProxyKey, message) {
+    return (0, rxjs_1.from)(sendMessage(orgProxyElementId, orgProxyKey, message));
+}

package/lib/cjs/types/data-crud.d.ts

@@ -1,4 +1,5 @@
 import { Observable } from 'rxjs';
+import { FilterExpression } from './filter-expressions';
 /**
  * SaveOptions is an interface for specifying save operation options.
  */
@@ -49,8 +50,10 @@ export declare function getObjectAsObservable(dataElementId: string, key: string
  * 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
  */
-export declare function getRelatedObjects(parentElementId: string, parentKey: string, elementId: string, filter?: string, fetchedRelationships?: string[]): Promise<any[]>;
+export declare function getRelatedObjects(parentElementId: string, parentKey: string, elementId: string, filter?: FilterExpression, fetchedRelationships?: string[]): Promise<any[]>;
 /**
  * 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
@@ -73,8 +76,10 @@ export declare function getRelatedObjects(parentElementId: string, parentKey: st
  * 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
  */
-export declare function getRelatedObjectsAsObservable(parentElementId: string, parentKey: string, elementId: string, filter?: string, fetchedRelationships?: string[]): Observable<any[]>;
+export declare function getRelatedObjectsAsObservable(parentElementId: string, parentKey: string, elementId: string, filter?: FilterExpression, fetchedRelationships?: string[]): Observable<any[]>;
 /**
  * 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

package/lib/cjs/types/data-crud.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data-crud.d.ts","sourceRoot":"","sources":["../../../src/data-crud.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAQ,UAAU,EAAiB,MAAM,MAAM,CAAC;AAOvD;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,mCAAmC;IACnC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAMD;;;;;;;;GAQG;AACH,wBAAsB,SAAS,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,gBAwBlG;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,CAE1H;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,iBAAiB,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CA2BvK;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,6BAA6B,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,CAEhL;AAMD;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,iBAAiB,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAmB7J;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,6BAA6B,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC,GAAG,CAAC,CAEtK;AAMD;;;;;;;;;GASG;AACH,wBAAsB,mBAAmB,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAgBhJ;AAED;;;;;;;;;GASG;AACH,wBAAgB,+BAA+B,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAEzJ;AAED;;;;;;;;;GASG;AACH,wBAAsB,oBAAoB,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAiBpJ;AAED;;;;;;;;;GASG;AACH,wBAAgB,gCAAgC,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,CAE7J"}
+{"version":3,"file":"data-crud.d.ts","sourceRoot":"","sources":["../../../src/data-crud.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAQ,UAAU,EAAiB,MAAM,MAAM,CAAC;AAEvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAMxD;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,mCAAmC;IACnC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAMD;;;;;;;;GAQG;AACH,wBAAsB,SAAS,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,gBAwBlG;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,CAE1H;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,iBAAiB,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CA2BjL;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,6BAA6B,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,CAE1L;AAMD;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,iBAAiB,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAmB7J;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,6BAA6B,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC,GAAG,CAAC,CAEtK;AAMD;;;;;;;;;GASG;AACH,wBAAsB,mBAAmB,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAgBhJ;AAED;;;;;;;;;GASG;AACH,wBAAgB,+BAA+B,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAEzJ;AAED;;;;;;;;;GASG;AACH,wBAAsB,oBAAoB,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAiBpJ;AAED;;;;;;;;;GASG;AACH,wBAAgB,gCAAgC,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,CAE7J"}

package/lib/cjs/types/filter-expressions.d.ts

@@ -0,0 +1,154 @@
+/**
+ * @module @halix/action-sdk/filter-expressions
+ * @description Filter expression language (dataexpr format) used throughout the SDK for filtering
+ * data in queries.
+ */
+/**
+ * FilterExpression represents a filter expression string in the Halix dataexpr format.
+ *
+ * Filter expressions are used to filter data based on logical comparisons and boolean conditions.
+ * They support a wide range of operators, boolean logic, arrays, and special variables.
+ *
+ * ## Expression Structure
+ *
+ * An expression consists of:
+ * - One or more comparisons
+ * - Optionally combined using boolean operators (`AND`, `OR`)
+ * - Grouped using parentheses `(...)` for logical grouping and precedence
+ *
+ * ### Basic Forms
+ * ```
+ * <left> <operator> <right>
+ * (<expression1>) AND (<expression2>)
+ * (<expression1>) OR (<expression2>)
+ * ```
+ *
+ * ## Supported Operators
+ *
+ * | Operator | Description | Example |
+ * |----------|-------------|---------|
+ * | `=` | Equals | `status = 'active'` |
+ * | `!=` | Not equals | `status != 'closed'` |
+ * | `~` | Equals (case-insensitive) | `name ~ 'ADMIN'` |
+ * | `!~` | Not equals (case-insensitive) | `role !~ 'ADMIN'` |
+ * | `<` | Less than | `score < '80'` |
+ * | `>` | Greater than | `score > '90'` |
+ * | `<=` | Less than or equal to | `score <= '90'` |
+ * | `>=` | Greater than or equal to | `score >= '70'` |
+ * | `!>` | Begins with | `name !> 'Jo'` |
+ * | `<!` | Ends with | `email <! '@example.com'` |
+ * | `<>` | Contains (string or array) | `tags <> 'urgent'` |
+ * | `!<>` | Does not contain | `tags !<> 'archived'` |
+ * | `<empty> $void` | Value is empty | `notes <empty> $void` |
+ * | `!<empty> $void` | Value is not empty | `notes !<empty> $void` |
+ *
+ * ## Value Types
+ *
+ * Values in expressions can be:
+ * - **String literals**: Must be wrapped in single quotes - `'value'`
+ * - **Attribute references**: Must not be quoted - `status`, `score`
+ * - **Arrays**: Literal arrays - `['A', 'B', 'C']`
+ * - **Variables**: Special variables - `$today`, `$daysAgo:5`
+ * - **Page/group variables**: Must be quoted - `'@{page.fieldName}'`, `'@{group.fieldName}'`
+ *
+ * ## Boolean Logic
+ *
+ * Combine comparisons using:
+ * - `AND` – all subexpressions must be true
+ * - `OR` – at least one subexpression must be true
+ *
+ * **Important**: Each operand of `AND`/`OR` must be enclosed in parentheses.
+ *
+ * ### Examples
+ * ```
+ * (status = 'active') AND (priority = 'high')
+ * (status = 'active') AND ((priority = 'high') OR (escalated = 'true'))
+ * ```
+ *
+ * ## Expression Variables
+ *
+ * Use special `$variables` for dynamic time-based filtering:
+ *
+ * | Variable | Meaning |
+ * |----------|---------|
+ * | `$today` | Current date (e.g. `2023-06-25`) |
+ * | `$todayTimestamp` | Timestamp for midnight today |
+ * | `$todayUnixTimestamp` | Unix timestamp (ms) for today |
+ * | `$startOfMonth` | First day of the current month |
+ * | `$endOfMonth` | Last day of the current month |
+ * | `$yearsAgo:N` | Timestamp N years ago |
+ * | `$monthsAgo:N` | Timestamp N months ago |
+ * | `$weeksAgo:N` | Timestamp N weeks ago |
+ * | `$daysAgo:N` | Timestamp N days ago |
+ * | `$hoursAgo:N` | Timestamp N hours ago |
+ * | `$minutesAgo:N` | Timestamp N minutes ago |
+ * | `$secondsAgo:N` | Timestamp N seconds ago |
+ * | `$yearsAhead:N` | Timestamp N years in the future |
+ * | `$monthsAhead:N` | Timestamp N months in the future |
+ * | `$weeksAhead:N` | Timestamp N weeks in the future |
+ * | `$daysAhead:N` | Timestamp N days in the future |
+ * | `$hoursAhead:N` | Timestamp N hours in the future |
+ * | `$minutesAhead:N` | Timestamp N minutes in the future |
+ * | `$secondsAhead:N` | Timestamp N seconds in the future |
+ *
+ * ## Common Examples
+ *
+ * ### Simple Comparison
+ * ```typescript
+ * const filter = "status = 'active'";
+ * ```
+ *
+ * ### Case-Insensitive Match
+ * ```typescript
+ * const filter = "role ~ 'ADMIN'";
+ * ```
+ *
+ * ### Contains Check
+ * ```typescript
+ * const filter = "notes <> 'important'";
+ * ```
+ *
+ * ### Array Contains
+ * ```typescript
+ * const filter = "['pending', 'active', 'review'] <> status";
+ * ```
+ *
+ * ### Empty/Not Empty
+ * ```typescript
+ * const filter = "notes !<empty> $void";  // Has notes
+ * ```
+ *
+ * ### Compound Expression
+ * ```typescript
+ * const filter = "(status = 'active') AND (priority = 'high')";
+ * ```
+ *
+ * ### Nested Logic
+ * ```typescript
+ * const filter = "(status = 'active') AND ((score > '90') OR (grade = 'A'))";
+ * ```
+ *
+ * ### Time-Based Filtering
+ * ```typescript
+ * const filter = "createdAt > $daysAgo:30";  // Created in last 30 days
+ * ```
+ *
+ * ### Boolean Values
+ * ```typescript
+ * const filter = "enabled = boolean:true";
+ * ```
+ *
+ * ### Using Page Variables
+ * ```typescript
+ * const filter = "category = '@{page.selectedCategory.value}'";
+ * ```
+ *
+ * ### Complex Multi-Condition Filter
+ * ```typescript
+ * const filter = "(status = 'active') AND " +
+ *                "((priority = 'high') OR (dueDate < $today)) AND " +
+ *                "(assignedTo !<empty> $void)";
+ * ```
+ */
+export type FilterExpression = string;
+//# sourceMappingURL=filter-expressions.d.ts.map

package/lib/cjs/types/filter-expressions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-expressions.d.ts","sourceRoot":"","sources":["../../../src/filter-expressions.ts"],"names":[],"mappings":"AASA;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkJG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC"}

package/lib/cjs/types/index.d.ts

@@ -6,6 +6,8 @@
 export { getAuthToken, sandboxKey, serviceAddress, actionSubject, userContext, params, useBody, initialize, type UserContext, type IncomingEventBody, type BaseActionResponse, type ActionResponse, type NotificationConfig, type ListActionResponse, type FormTemplateActionResponse, type PageTemplateActionResponse, type ObjectSaveActionResponse, type CalculatedFieldActionResponse, type SingleValueActionResponse, type ErrorResponse, prepareSuccessResponse, prepareErrorResponse } from './sdk-general';
 export { type SaveOptions, getObject, getObjectAsObservable, getRelatedObjects, getRelatedObjectsAsObservable, saveRelatedObject, saveRelatedObjectAsObservable, deleteRelatedObject, deleteRelatedObjectAsObservable, deleteRelatedObjects, deleteRelatedObjectsAsObservable } from './data-crud';
 export { type ContentResource, getOrCreateResource, getOrCreateResourceAsObservable, saveResource, saveResourceAsObservable, sendFileContents, sendFileContentsAsObservable, createOrUpdateResource, createOrUpdateResourceAsObservable } from './content';
-export { type SortField, type DataSortField, type ListDataRequest, type ListDataResponse, type ListDataOptions, type ListDataSearchOptions, getListData, getListDataAsObservable } from './lists';
+export { MessageMethod, type MessageRequest, sendMessage, sendMessageAsObservable } from './messaging';
+export { type FilterExpression } from './filter-expressions';
+export { type SortField, type DataSortField, type BaseListDataRequest, type PagedListDataRequest, type ListDataResponse, type ListDataOptions, type ListDataSearchOptions, type MassEditValueType, type MassEditRequest, type MassDeleteRequest, type MassChangeResponse, getListData, getListDataAsObservable, massEdit, massEditAsObservable, massDelete, massDeleteAsObservable } from './lists';
 export { sortObjectArray, compareValues, getValueFromObject, debounceFn } from './utilities';
 //# sourceMappingURL=index.d.ts.map

package/lib/cjs/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AASA;;;;GAIG;AAMH,OAAO,EAEH,YAAY,EACZ,UAAU,EACV,cAAc,EACd,aAAa,EACb,WAAW,EACX,MAAM,EACN,OAAO,EAGP,UAAU,EAGV,KAAK,WAAW,EAChB,KAAK,iBAAiB,EAGtB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,6BAA6B,EAClC,KAAK,yBAAyB,EAC9B,KAAK,aAAa,EAGlB,sBAAsB,EACtB,oBAAoB,EACvB,MAAM,eAAe,CAAC;AAMvB,OAAO,EAEH,KAAK,WAAW,EAGhB,SAAS,EACT,qBAAqB,EACrB,iBAAiB,EACjB,6BAA6B,EAG7B,iBAAiB,EACjB,6BAA6B,EAG7B,mBAAmB,EACnB,+BAA+B,EAC/B,oBAAoB,EACpB,gCAAgC,EACnC,MAAM,aAAa,CAAC;AAMrB,OAAO,EAEH,KAAK,eAAe,EAGpB,mBAAmB,EACnB,+BAA+B,EAC/B,YAAY,EACZ,wBAAwB,EACxB,gBAAgB,EAChB,4BAA4B,EAC5B,sBAAsB,EACtB,kCAAkC,EACrC,MAAM,WAAW,CAAC;AAMnB,OAAO,EAEH,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAG1B,WAAW,EACX,uBAAuB,EAC1B,MAAM,SAAS,CAAC;AAMjB,OAAO,EACH,eAAe,EACf,aAAa,EACb,kBAAkB,EAClB,UAAU,EACb,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AASA;;;;GAIG;AAMH,OAAO,EAEH,YAAY,EACZ,UAAU,EACV,cAAc,EACd,aAAa,EACb,WAAW,EACX,MAAM,EACN,OAAO,EAGP,UAAU,EAGV,KAAK,WAAW,EAChB,KAAK,iBAAiB,EAGtB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,6BAA6B,EAClC,KAAK,yBAAyB,EAC9B,KAAK,aAAa,EAGlB,sBAAsB,EACtB,oBAAoB,EACvB,MAAM,eAAe,CAAC;AAMvB,OAAO,EAEH,KAAK,WAAW,EAGhB,SAAS,EACT,qBAAqB,EACrB,iBAAiB,EACjB,6BAA6B,EAG7B,iBAAiB,EACjB,6BAA6B,EAG7B,mBAAmB,EACnB,+BAA+B,EAC/B,oBAAoB,EACpB,gCAAgC,EACnC,MAAM,aAAa,CAAC;AAMrB,OAAO,EAEH,KAAK,eAAe,EAGpB,mBAAmB,EACnB,+BAA+B,EAC/B,YAAY,EACZ,wBAAwB,EACxB,gBAAgB,EAChB,4BAA4B,EAC5B,sBAAsB,EACtB,kCAAkC,EACrC,MAAM,WAAW,CAAC;AAMnB,OAAO,EAEH,aAAa,EAGb,KAAK,cAAc,EAGnB,WAAW,EACX,uBAAuB,EAC1B,MAAM,aAAa,CAAC;AAMrB,OAAO,EACH,KAAK,gBAAgB,EACxB,MAAM,sBAAsB,CAAC;AAM9B,OAAO,EAEH,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EAGvB,WAAW,EACX,uBAAuB,EACvB,QAAQ,EACR,oBAAoB,EACpB,UAAU,EACV,sBAAsB,EACzB,MAAM,SAAS,CAAC;AAMjB,OAAO,EACH,eAAe,EACf,aAAa,EACb,kBAAkB,EAClB,UAAU,EACb,MAAM,aAAa,CAAC"}