@halix/action-sdk 1.0.21 → 1.0.22

package/lib/esm/lists.js

@@ -8,7 +8,7 @@
 // Full license terms available in the LICENSE file.
 /**
  * @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.
  *
@@ -18,6 +18,8 @@
  * - Sorting
  * - Filtering
  * - Search
+ * - Mass edit operations (bulk update multiple records)
+ * - Mass delete operations (bulk delete multiple records)
  */
 import axios from 'axios';
 import { from, lastValueFrom } from 'rxjs';
@@ -154,4 +156,173 @@ export async function getListData(request, options) {
 export function getListDataAsObservable(request, options) {
     return 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'
+ * });
+ */
+export async function massEdit(request) {
+    const url = `${serviceAddress}/list/sandboxes/${sandboxKey}/massedit`;
+    // Build headers with authentication token
+    let authToken = await lastValueFrom(getAuthToken());
+    let headers = {
+        Authorization: `Bearer ${authToken}`
+    };
+    console.log("Sending POST request to " + url + " with token " + authToken);
+    // Make the API request
+    let response = await axios.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`);
+ * });
+ */
+export function massEditAsObservable(request) {
+    return 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`);
+ */
+export async function massDelete(request) {
+    const url = `${serviceAddress}/list/sandboxes/${sandboxKey}/massdelete`;
+    // Build headers with authentication token
+    let authToken = await lastValueFrom(getAuthToken());
+    let headers = {
+        Authorization: `Bearer ${authToken}`
+    };
+    console.log("Sending POST request to " + url + " with token " + authToken);
+    // Make the API request
+    let response = await axios.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`);
+ * });
+ */
+export function massDeleteAsObservable(request) {
+    return from(massDelete(request));
+}
 //# sourceMappingURL=lists.js.map

package/lib/esm/lists.js.map

@@ -1 +1 @@
-{"version":3,"file":"lists.js","sourceRoot":"","sources":["../../src/lists.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,mCAAmC;AACnC,EAAE;AACF,oEAAoE;AACpE,0EAA0E;AAC1E,EAAE;AACF,6DAA6D;AAC7D,oDAAoD;AAEpD;;;;;;;;;;;;GAYG;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,MAAM,eAAe,CAAC;AAyJzE,mFAAmF;AACnF,gCAAgC;AAChC,mFAAmF;AAEnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAAwB,EAAE,OAAyB;IAEjF,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,KAAK,CAAC;IAC5C,MAAM,SAAS,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC;IAEpC,iFAAiF;IACjF,IAAI,GAAW,CAAC;IAChB,IAAI,SAAS,IAAI,QAAQ,EAAE,CAAC;QACxB,GAAG,GAAG,GAAG,cAAc,mBAAmB,UAAU,wBAAwB,CAAC;IACjF,CAAC;SAAM,IAAI,SAAS,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChC,GAAG,GAAG,GAAG,cAAc,mBAAmB,UAAU,iBAAiB,CAAC;IAC1E,CAAC;SAAM,IAAI,CAAC,SAAS,IAAI,QAAQ,EAAE,CAAC;QAChC,GAAG,GAAG,GAAG,cAAc,mBAAmB,UAAU,kBAAkB,CAAC;IAC3E,CAAC;SAAM,CAAC;QACJ,GAAG,GAAG,GAAG,cAAc,mBAAmB,UAAU,WAAW,CAAC;IACpE,CAAC;IAED,yBAAyB;IACzB,IAAI,MAAM,GAAQ,EAAE,CAAC;IAErB,yCAAyC;IACzC,IAAI,OAAO,EAAE,WAAW,KAAK,SAAS,EAAE,CAAC;QACrC,MAAM,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAC7C,CAAC;IAED,6CAA6C;IAC7C,IAAI,SAAS,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;QAC/B,MAAM,CAAC,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC;QAChD,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;QACpC,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnD,CAAC;IAED,mEAAmE;IACnE,IAAI,OAAO,GAAQ,EAAE,CAAC;IACtB,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,IAAI,SAAS,GAAG,MAAM,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;QACpD,OAAO,CAAC,aAAa,GAAG,UAAU,SAAS,EAAE,CAAC;QAE9C,OAAO,CAAC,GAAG,CAAC,0BAA0B,GAAG,GAAG,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;IAC/E,CAAC;SAAM,CAAC;QACJ,OAAO,CAAC,GAAG,CAAC,0BAA0B,GAAG,GAAG,GAAG,oBAAoB,CAAC,CAAC;IACzE,CAAC;IAED,uBAAuB;IACvB,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE;QAC1C,OAAO;QACP,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;KAC9D,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,uBAAuB,CAAC,OAAwB,EAAE,OAAyB;IACvF,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AAC/C,CAAC"}
+{"version":3,"file":"lists.js","sourceRoot":"","sources":["../../src/lists.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,mCAAmC;AACnC,EAAE;AACF,oEAAoE;AACpE,0EAA0E;AAC1E,EAAE;AACF,6DAA6D;AAC7D,oDAAoD;AAEpD;;;;;;;;;;;;;;GAcG;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,MAAM,eAAe,CAAC;AAsOzE,mFAAmF;AACnF,gCAAgC;AAChC,mFAAmF;AAEnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAA6B,EAAE,OAAyB;IAEtF,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,KAAK,CAAC;IAC5C,MAAM,SAAS,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC;IAEpC,iFAAiF;IACjF,IAAI,GAAW,CAAC;IAChB,IAAI,SAAS,IAAI,QAAQ,EAAE,CAAC;QACxB,GAAG,GAAG,GAAG,cAAc,mBAAmB,UAAU,wBAAwB,CAAC;IACjF,CAAC;SAAM,IAAI,SAAS,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChC,GAAG,GAAG,GAAG,cAAc,mBAAmB,UAAU,iBAAiB,CAAC;IAC1E,CAAC;SAAM,IAAI,CAAC,SAAS,IAAI,QAAQ,EAAE,CAAC;QAChC,GAAG,GAAG,GAAG,cAAc,mBAAmB,UAAU,kBAAkB,CAAC;IAC3E,CAAC;SAAM,CAAC;QACJ,GAAG,GAAG,GAAG,cAAc,mBAAmB,UAAU,WAAW,CAAC;IACpE,CAAC;IAED,yBAAyB;IACzB,IAAI,MAAM,GAAQ,EAAE,CAAC;IAErB,yCAAyC;IACzC,IAAI,OAAO,EAAE,WAAW,KAAK,SAAS,EAAE,CAAC;QACrC,MAAM,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAC7C,CAAC;IAED,6CAA6C;IAC7C,IAAI,SAAS,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;QAC/B,MAAM,CAAC,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC;QAChD,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;QACpC,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnD,CAAC;IAED,mEAAmE;IACnE,IAAI,OAAO,GAAQ,EAAE,CAAC;IACtB,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,IAAI,SAAS,GAAG,MAAM,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;QACpD,OAAO,CAAC,aAAa,GAAG,UAAU,SAAS,EAAE,CAAC;QAE9C,OAAO,CAAC,GAAG,CAAC,0BAA0B,GAAG,GAAG,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;IAC/E,CAAC;SAAM,CAAC;QACJ,OAAO,CAAC,GAAG,CAAC,0BAA0B,GAAG,GAAG,GAAG,oBAAoB,CAAC,CAAC;IACzE,CAAC;IAED,uBAAuB;IACvB,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE;QAC1C,OAAO;QACP,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;KAC9D,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,uBAAuB,CAAC,OAA6B,EAAE,OAAyB;IAC5F,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED,mFAAmF;AACnF,iCAAiC;AACjC,mFAAmF;AAEnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,OAAwB;IACnD,MAAM,GAAG,GAAG,GAAG,cAAc,mBAAmB,UAAU,WAAW,CAAC;IAEtE,0CAA0C;IAC1C,IAAI,SAAS,GAAG,MAAM,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;IACpD,IAAI,OAAO,GAAQ;QACf,aAAa,EAAE,UAAU,SAAS,EAAE;KACvC,CAAC;IAEF,OAAO,CAAC,GAAG,CAAC,0BAA0B,GAAG,GAAG,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;IAE3E,uBAAuB;IACvB,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAE3D,OAAO,QAAQ,CAAC,IAAI,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAwB;IACzD,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,OAA0B;IACvD,MAAM,GAAG,GAAG,GAAG,cAAc,mBAAmB,UAAU,aAAa,CAAC;IAExE,0CAA0C;IAC1C,IAAI,SAAS,GAAG,MAAM,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;IACpD,IAAI,OAAO,GAAQ;QACf,aAAa,EAAE,UAAU,SAAS,EAAE;KACvC,CAAC;IAEF,OAAO,CAAC,GAAG,CAAC,0BAA0B,GAAG,GAAG,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;IAE3E,uBAAuB;IACvB,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAE3D,OAAO,QAAQ,CAAC,IAAI,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,sBAAsB,CAAC,OAA0B;IAC7D,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;AACrC,CAAC"}

package/lib/esm/messaging.js

@@ -0,0 +1,133 @@
+// 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/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.
+ */
+import axios from 'axios';
+import { from, lastValueFrom } from 'rxjs';
+import { sandboxKey, serviceAddress, getAuthToken } from './sdk-general';
+// ================================================================================
+// ENUMS & CONSTANTS
+// ================================================================================
+/**
+ * MessageMethod represents the delivery method for a message.
+ */
+export 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 || (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>'
+ * });
+ * ```
+ */
+export async function sendMessage(orgProxyElementId, orgProxyKey, message) {
+    // Build the server request from the simplified client request
+    const serverRequest = {
+        recipientGroups: message.userProxyKeys && message.userProxyKeys.length > 0 ? [
+            {
+                type: "",
+                recipientKeys: message.userProxyKeys
+            }
+        ] : [],
+        sentAs: message.sentAs?.toString() || MessageMethod.Email,
+        type: "direct",
+        subject: message.subject,
+        body: message.body,
+        replyToEmail: message.replyToEmail,
+        resourceKeys: message.resourceKeys,
+        additionalEmails: message.directEmailAddresses
+    };
+    let url = `${serviceAddress}/notification/sandboxes/${sandboxKey}/${orgProxyElementId}/${orgProxyKey}/sendMessage`;
+    let authToken = await lastValueFrom(getAuthToken());
+    console.log("Sending POST request to " + url + " with token " + authToken);
+    await axios.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)
+ * });
+ * ```
+ */
+export function sendMessageAsObservable(orgProxyElementId, orgProxyKey, message) {
+    return from(sendMessage(orgProxyElementId, orgProxyKey, message));
+}
+//# sourceMappingURL=messaging.js.map

package/lib/esm/messaging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messaging.js","sourceRoot":"","sources":["../../src/messaging.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,mCAAmC;AACnC,EAAE;AACF,oEAAoE;AACpE,0EAA0E;AAC1E,EAAE;AACF,6DAA6D;AAC7D,oDAAoD;AAEpD;;;;GAIG;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,MAAM,eAAe,CAAC;AAEzE,mFAAmF;AACnF,oBAAoB;AACpB,mFAAmF;AAEnF;;GAEG;AACH,MAAM,CAAN,IAAY,aAOX;AAPD,WAAY,aAAa;IACrB,oBAAoB;IACpB,gCAAe,CAAA;IACf,uBAAuB;IACvB,8BAAa,CAAA;IACb,kCAAkC;IAClC,4CAA2B,CAAA;AAC/B,CAAC,EAPW,aAAa,KAAb,aAAa,QAOxB;AAgED,mFAAmF;AACnF,sBAAsB;AACtB,mFAAmF;AAEnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,iBAAyB,EAAE,WAAmB,EAAE,OAAuB;IAErG,8DAA8D;IAC9D,MAAM,aAAa,GAAyB;QACxC,eAAe,EAAE,OAAO,CAAC,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;YACzE;gBACI,IAAI,EAAE,EAAE;gBACR,aAAa,EAAE,OAAO,CAAC,aAAa;aACvC;SACJ,CAAC,CAAC,CAAC,EAAE;QACN,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,aAAa,CAAC,KAAK;QACzD,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,gBAAgB,EAAE,OAAO,CAAC,oBAAoB;KACjD,CAAC;IAEF,IAAI,GAAG,GAAG,GAAG,cAAc,2BAA2B,UAAU,IAAI,iBAAiB,IAAI,WAAW,cAAc,CAAC;IAEnH,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,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,aAAa,EAAE;QACjC,OAAO,EAAE,EAAE,eAAe,EAAE,UAAU,SAAS,EAAE,EAAE;KACtD,CAAC,CAAC;IAEH,uEAAuE;IACvE,wFAAwF;AAC5F,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,uBAAuB,CAAC,iBAAyB,EAAE,WAAmB,EAAE,OAAuB;IAC3G,OAAO,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;AACtE,CAAC"}

package/lib/esm/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/esm/types/filter-expressions.d.ts

@@ -0,0 +1,153 @@
+/**
+ * @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;

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

@@ -6,5 +6,7 @@
 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';