@halix/action-sdk 1.0.24 → 1.0.26

package/lib/esm/index.mjs

@@ -46,12 +46,24 @@ MessageMethod,
 // Messaging Functions
 sendMessage, sendMessageAsObservable } from './messaging';
 // ================================================================================
+// PREFERENCE FUNCTIONS
+// ================================================================================
+export { 
+// Preference Functions
+getPreference, getPreferenceAsObservable } from './preferences';
+// ================================================================================
 // LIST DATA FUNCTIONS
 // ================================================================================
 export { 
 // Functions
 getListData, getListDataAsObservable, massEdit, massEditAsObservable, massDelete, massDeleteAsObservable } from './lists';
 // ================================================================================
+// DATA AGGREGATE FUNCTIONS
+// ================================================================================
+export { 
+// Functions
+getAggregateData, getAggregateDataAsObservable } from './data-aggregate';
+// ================================================================================
 // UTILITY FUNCTIONS
 // ================================================================================
 export { sortObjectArray, compareValues, getValueFromObject, debounceFn } from './utilities';

package/lib/esm/lists.js

@@ -14,6 +14,7 @@
  *
  * Key features:
  * - Efficient retrieval of one page of data at a time
+ * - Supports related object retrieval
  * - Pagination
  * - Sorting
  * - Filtering
@@ -28,24 +29,13 @@ import { sandboxKey, serviceAddress, getAuthToken } from './sdk-general';
 // LIST DATA RETRIEVAL FUNCTIONS
 // ================================================================================
 /**
- * getListData retrieves list data from the Halix platform. This function can operate in four
- * different modes based on the provided options:
+ * Retrieves paginated list data. Supports authenticated/public access, filtering, sorting, and binary search.
  *
- * 1. Authenticated list data retrieval (default)
- * 2. Public list data retrieval (when isPublic is true)
- * 3. Authenticated list data with search (when search options are provided)
- * 4. Public list data with search (when both isPublic and search options are provided)
- *
- * The search functionality uses binary search to efficiently locate items in a sorted list by
- * a specific attribute value.
- *
- * @param request - The list data request containing list configuration and parameters
- * @param options - Optional configuration for the request
- *
- * @returns Promise resolving to the list data response
+ * @param request - List configuration including dataElementId, parentDataElementId, parentKey, pagination, sort, filter
+ * @param options - Optional: isPublic, bypassTotal, search
+ * @returns Promise<ListDataResponse> with data array, total count, pageNumber
  *
  * @example
- * // Basic authenticated list data retrieval
  * const listData = await getListData({
  *   dataElementId: 'customer',
  *   parentDataElementId: 'company',
@@ -54,35 +44,6 @@ import { sandboxKey, serviceAddress, getAuthToken } from './sdk-general';
  *   pageSize: 50,
  *   displayFields: ['firstName', 'lastName', 'email']
  * });
- * console.log('Total customers:', listData.total);
- * console.log('Page:', listData.pageNumber);
- * console.log('Data:', listData.data);
- *
- * @example
- * // Public list data retrieval without authentication
- * const publicData = await getListData({
- *   dataElementId: 'product',
- *   parentDataElementId: 'catalog',
- *   parentKey: orgProxyKey,
- *   pageNumber: 1,
- *   pageSize: 20
- * }, { isPublic: true });
- *
- * @example
- * // List data retrieval with binary search
- * const searchData = await getListData({
- *   dataElementId: 'purchases',
- *   parentDataElementId: 'customer',
- *   parentKey: userProxyKey,
- *   sort: [{ attributeId: 'invoiceNumber', descending: false }]
- * }, {
- *   search: {
- *     attributeId: 'invoiceNumber',
- *     value: 'INV-123456',
- *     total: 1000
- *   }
- * });
- * console.log('Selected row index:', searchData.selectedRow);
  */
 export async function getListData(request, options) {
     const isPublic = options?.isPublic ?? false;
@@ -136,27 +97,11 @@ export async function getListData(request, options) {
     return response.data;
 }
 /**
- * getListDataAsObservable retrieves list data from the Halix platform as an Observable. This
- * function operates in the same four modes as getListData.
- *
- * @param request - The list data request containing list configuration and parameters
- * @param options - Optional configuration for the request
- *
- * @returns Observable resolving to the list data response
+ * Observable version of getListData. See getListData for details.
  *
  * @example
- * // Basic authenticated list data retrieval as Observable
- * getListDataAsObservable({
- *   dataElementId: 'customer',
- *   parentDataElementId: 'company',
- *   parentKey: userContext.orgProxyKey,
- *   pageNumber: 1,
- *   pageSize: 50
- * }).subscribe(response => {
- *   console.log('Total customers:', response.total);
- *   console.log('Page:', response.pageNumber);
- *   console.log('Data:', response.data);
- * });
+ * getListDataAsObservable({ dataElementId: 'customer', parentDataElementId: 'company', parentKey: orgProxyKey })
+ *   .subscribe(response => console.log(response.data));
  */
 export function getListDataAsObservable(request, options) {
     return from(getListData(request, options));
@@ -165,51 +110,21 @@ export function getListDataAsObservable(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
+ * Bulk update multiple records. The dataRequest defines security scope; only records within that scope can be updated.
+ * Use valueType 'literal' to set a value, or 'property' to copy from another field.
  *
- * @returns Promise resolving to statistics about the operation
+ * @param request - keys[], dataRequest (scope), dataElementId, property, valueType, value
+ * @returns Promise<MassChangeResponse> with tried/succeeded/failed counts
  *
  * @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
- *   },
+ *   keys: ['order-123', 'order-456'],
+ *   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) {
     if (!getAuthToken) {
@@ -229,75 +144,24 @@ export async function massEdit(request) {
     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`);
- * });
+ * Observable version of massEdit. See massEdit for details.
  */
 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
+ * Bulk soft-delete multiple records. The dataRequest defines security scope; only records within that scope can be deleted.
+ * Set emptyList: true to delete all records matching dataRequest (ignores keys array).
  *
- * @returns Promise resolving to statistics about the operation
+ * @param request - keys[], dataRequest (scope), dataElementId, emptyList?
+ * @returns Promise<MassChangeResponse> with tried/succeeded/failed counts
  *
  * @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' }
- *   },
+ *   keys: ['order-123', 'order-456'],
+ *   dataRequest: { dataElementId: 'order', parentDataElementId: 'company', parentKey: orgProxyKey },
  *   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) {
     if (!getAuthToken) {
@@ -317,25 +181,7 @@ export async function massDelete(request) {
     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`);
- * });
+ * Observable version of massDelete. See massDelete for details.
  */
 export function massDeleteAsObservable(request) {
     return from(massDelete(request));

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;;;;;;;;;;;;;;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,CAAC,YAAY,EAAE,CAAC;YAChB,MAAM,YAAY,GAAG,sBAAsB,CAAC;YAC5C,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAClC,CAAC;QACD,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,IAAI,CAAC,YAAY,EAAE,CAAC;QAChB,MAAM,YAAY,GAAG,sBAAsB,CAAC;QAC5C,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;IACD,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,IAAI,CAAC,YAAY,EAAE,CAAC;QAChB,MAAM,YAAY,GAAG,sBAAsB,CAAC;QAC5C,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;IACD,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"}
+{"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;;;;;;;;;;;;;;;GAeG;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;;;;;;;;;;;;;;;;GAgBG;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,CAAC,YAAY,EAAE,CAAC;YAChB,MAAM,YAAY,GAAG,sBAAsB,CAAC;YAC5C,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAClC,CAAC;QACD,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;;;;;;GAMG;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;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,OAAwB;IACnD,IAAI,CAAC,YAAY,EAAE,CAAC;QAChB,MAAM,YAAY,GAAG,sBAAsB,CAAC;QAC5C,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;IACD,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;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAwB;IACzD,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,OAA0B;IACvD,IAAI,CAAC,YAAY,EAAE,CAAC;QAChB,MAAM,YAAY,GAAG,sBAAsB,CAAC;QAC5C,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;IACD,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;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,OAA0B;IAC7D,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;AACrC,CAAC"}

package/lib/esm/messaging.js

@@ -33,49 +33,19 @@ export var 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.
+ * Sends email/text message to recipients. Returns when message is queued (sent asynchronously).
  *
- * @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
+ * @param orgProxyElementId - Org proxy element ID (e.g., "business")
+ * @param orgProxyKey - Org proxy key
+ * @param message - MessageRequest with userProxyKeys/directEmailAddresses, subject, body, sentAs, replyToEmail, resourceKeys
+ * @returns Promise<void> - resolves when queued
  *
  * @example
- * ```typescript
- * // Send an email to customers (sentAs defaults to email)
  * await sendMessage('business', businessKey, {
- *   userProxyKeys: [customerKey1, customerKey2, customerKey3],
+ *   userProxyKeys: [customerKey1, customerKey2],
  *   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>'
+ *   body: '<p>This is an important announcement.</p>'
  * });
- * ```
  */
 export async function sendMessage(orgProxyElementId, orgProxyKey, message) {
     // Build the server request from the simplified client request
@@ -109,28 +79,7 @@ export async function sendMessage(orgProxyElementId, orgProxyKey, message) {
     // 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)
- * });
- * ```
+ * Observable version of sendMessage. See sendMessage for details.
  */
 export function sendMessageAsObservable(orgProxyElementId, orgProxyKey, message) {
     return from(sendMessage(orgProxyElementId, orgProxyKey, message));

package/lib/esm/messaging.js.map

@@ -1 +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,CAAC,YAAY,EAAE,CAAC;QAChB,MAAM,YAAY,GAAG,sBAAsB,CAAC;QAC5C,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,GAAG,GAAG,GAAG,cAAc,2BAA2B,UAAU,gBAAgB,iBAAiB,IAAI,WAAW,EAAE,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"}
+{"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;;;;;;;;;;;;;;GAcG;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,CAAC,YAAY,EAAE,CAAC;QAChB,MAAM,YAAY,GAAG,sBAAsB,CAAC;QAC5C,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,GAAG,GAAG,GAAG,cAAc,2BAA2B,UAAU,gBAAgB,iBAAiB,IAAI,WAAW,EAAE,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;;GAEG;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/preferences.js

@@ -0,0 +1,57 @@
+// 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/preferences
+ * @description Preference management functions for the Halix Platform action SDK. This module
+ * provides functions for retrieving preference values.
+ */
+import axios from 'axios';
+import { from, lastValueFrom } from 'rxjs';
+import { serviceAddress, getAuthToken, userContext } from './sdk-general';
+// ================================================================================
+// PREFERENCE RETRIEVAL FUNCTIONS
+// ================================================================================
+/**
+ * Retrieves a preference value for the current user.
+ *
+ * @param prefID - The preference ID to retrieve
+ * @returns Promise<any> - the preference value
+ * @throws Error if SDK not initialized or user context not available
+ *
+ * @example
+ * const preferenceValue = await getPreference('myPreferenceId');
+ */
+export async function getPreference(prefID) {
+    if (!getAuthToken) {
+        const errorMessage = 'SDK not initialized.';
+        console.error(errorMessage);
+        throw new Error(errorMessage);
+    }
+    if (!userContext?.user?.objKey) {
+        const errorMessage = 'User context not available. Cannot retrieve preference value.';
+        console.error(errorMessage);
+        throw new Error(errorMessage);
+    }
+    const ownerElementID = 'user';
+    const ownerKey = userContext.user.objKey;
+    let url = `${serviceAddress}/sysapi/preference/${prefID}/${ownerElementID}/${ownerKey}`;
+    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}` },
+    });
+    return response.data;
+}
+/**
+ * Observable version of getPreference. See getPreference for details.
+ */
+export function getPreferenceAsObservable(prefID) {
+    return from(getPreference(prefID));
+}
+//# sourceMappingURL=preferences.js.map

package/lib/esm/preferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"preferences.js","sourceRoot":"","sources":["../../src/preferences.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,cAAc,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE1E,mFAAmF;AACnF,iCAAiC;AACjC,mFAAmF;AAEnF;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,MAAc;IAC9C,IAAI,CAAC,YAAY,EAAE,CAAC;QAChB,MAAM,YAAY,GAAG,sBAAsB,CAAC;QAC5C,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAC7B,MAAM,YAAY,GAAG,+DAA+D,CAAC;QACrF,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,CAAC;IAC9B,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC;IAEzC,IAAI,GAAG,GAAG,GAAG,cAAc,sBAAsB,MAAM,IAAI,cAAc,IAAI,QAAQ,EAAE,CAAC;IAExF,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;KACtD,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;AACzB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,yBAAyB,CAAC,MAAc;IACpD,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;AACvC,CAAC"}

package/lib/esm/sdk-general.js

@@ -24,59 +24,37 @@ import { of } from 'rxjs';
 // GLOBAL VARIABLES AND INITIALIZATION
 // ================================================================================
 /**
- * authToken contains the authentication token that the action handler can use to make API requests
- * to Halix web services. This value is set upon calling the initialize function with incoming event
- * data.
+ * Authentication token for API requests. Set by initialize().
  */
 export let getAuthToken;
 /**
- * sandboxKey contains the sandbox key identifier; identifies the sandbox that the action handler is
- * running in. The sandbox identifies the current solution. This value is set upon calling the
- * initialize function with incoming event data.
+ * Sandbox key identifier for the current solution. Set by initialize().
  */
 export let sandboxKey;
 /**
- * serviceAddress contains the URL of the Halix service that the action handler can use to make API
- * requests to. This value is set upon calling the initialize function with incoming event data.
+ * Halix service URL for API requests. Set by initialize().
  */
 export let serviceAddress;
 /**
- * actionSubject contains the identifier of the subject of the action. The subject is the object
- * that the action is being performed on. The action subject's contents will differ depending on the
- * context in which the action is being executed. This value is set upon calling the initialize
- * function with incoming event data.
- * - for formTemplateActions, the action subject is the data being edited on the form
- * - for pageTemplateActions, the action subject is record containing the context variables and
- *   their corresponding values on the page
- * - for objectSaveActions, the action subject is the object being saved
- * - for calculatedFieldActions, the action subject is the object containing the calculated field
- * - for singleValueActions, the action subject may differ depending on the caller
+ * Subject of the action (context-dependent: form data, page variables, object being saved, etc.). Set by initialize().
  */
 export let actionSubject;
 /**
- * userContext contains the user context information for the user that is executing the action.
- * This value is set upon calling the initialize function with incoming event data.
+ * User context (user, userProxy, orgProxy, keys). Set by initialize().
  */
 export let userContext;
 /**
- * params contains the parameters passed to the action. If an input dialog is used, params will
- * contain the values entered in the dialog. This value is set upon calling the initialize
- * function with incoming event data.
+ * Parameters passed to the action (e.g., from input dialog). Set by initialize().
  */
 export let params;
 /**
- * useBody is a flag indicating how responses should be formatted. If true, the response will be
- * returned as an object with the HTTP response code and ActionResponse in the body field. If false,
- * the ActionResponse will be returned directly. Typically, this does not need to be set by the
- * action handler and should remain false.
+ * Response format flag (internal). Typically leave as false.
  */
 export let useBody;
 /**
- * initialize initializes the SDK with event data. This should be called at the beginning of the
- * action handler to set up the SDK with incoming information, including context information, input
- * parameters, and authentication information needed to make API requests to the Halix service.
+ * Initializes SDK with event data. Call at the beginning of action handler to set up authentication, context, and parameters.
  *
- * @param event - The event object containing authentication and context information
+ * @param event - Event object with body containing IncomingEventBody
  */
 export function initialize(event) {
     let body = event;
@@ -98,14 +76,9 @@ export function initialize(event) {
 // RESPONSE HELPER FUNCTIONS
 // ================================================================================
 /**
- * prepareSuccessResponse prepares a success response in the appropriate format. The action handler
- * should return an ActionResponse response when the action is successful. If useBody is true, the
- * response will be returned as an object with the HTTP response code and the ActionResponse in the
- * body field. If useBody is false, the ActionResponse will be returned directly.
+ * Formats a success response. Returns ActionResponse directly, or wrapped with statusCode if useBody is true.
  *
- * @param successResponse - The value to return
- *
- * @returns Formatted success response; an ActionResponse unless useBody is true
+ * @returns ActionResponse or {statusCode: 200, body: string}
  */
 export function prepareSuccessResponse(successResponse) {
     if (useBody) {
@@ -117,14 +90,9 @@ export function prepareSuccessResponse(successResponse) {
     return successResponse;
 }
 /**
- * prepareErrorResponse prepares an error response in the appropriate format. The action handler
- * should return an ErrorResponse response when the action is not successful. If useBody is true,
- * the response will be returned as an object with the HTTP response code and the ErrorResponse in
- * the body field. If useBody is false, the ErrorResponse will be returned directly.
- *
- * @param errorMessage - The error message
+ * Formats an error response. Returns ErrorResponse directly, or wrapped with statusCode if useBody is true.
  *
- * @returns Formatted error response; an ErrorResponse unless useBody is true
+ * @returns ErrorResponse or {statusCode: 400, body: string}
  */
 export function prepareErrorResponse(errorMessage) {
     if (useBody) {

package/lib/esm/sdk-general.js.map

@@ -1 +1 @@
-{"version":3,"file":"sdk-general.js","sourceRoot":"","sources":["../../src/sdk-general.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,mCAAmC;AACnC,EAAE;AACF,oEAAoE;AACpE,0EAA0E;AAC1E,EAAE;AACF,6DAA6D;AAC7D,oDAAoD;AAEpD;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAc,EAAE,EAAE,MAAM,MAAM,CAAC;AAEtC,mFAAmF;AACnF,sCAAsC;AACtC,mFAAmF;AAEnF;;;;GAIG;AACH,MAAM,CAAC,IAAI,YAAsC,CAAC;AAElD;;;;GAIG;AACH,MAAM,CAAC,IAAI,UAAkB,CAAC;AAE9B;;;GAGG;AACH,MAAM,CAAC,IAAI,cAAsB,CAAC;AAElC;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,IAAI,aAAkB,CAAC;AAE9B;;;GAGG;AACH,MAAM,CAAC,IAAI,WAAwB,CAAC;AAEpC;;;;GAIG;AACH,MAAM,CAAC,IAAI,MAAc,CAAC;AAE1B;;;;;GAKG;AACH,MAAM,CAAC,IAAI,OAAgB,CAAC;AAE5B;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,KAAmC;IAE1D,IAAI,IAAI,GAAQ,KAAK,CAAC;IACtB,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAClB,OAAO,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,IAAI,IAAI,EAAE,CAAC;QACP,CAAC,EAAE,UAAU,EAAE,cAAc,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;QAE5E,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,YAAY,GAAG,GAAG,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;aAAM,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACjC,YAAY,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC3C,CAAC;IACL,CAAC;AACL,CAAC;AAuLD,mFAAmF;AACnF,4BAA4B;AAC5B,mFAAmF;AAEnF;;;;;;;;;GASG;AACH,MAAM,UAAU,sBAAsB,CAAC,eAA+B;IAClE,IAAI,OAAO,EAAE,CAAC;QACV,OAAO;YACH,UAAU,EAAE,GAAG;YACf,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC;SACxC,CAAC;IACN,CAAC;IAED,OAAO,eAAe,CAAC;AAC3B,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,oBAAoB,CAAC,YAAoB;IACrD,IAAI,OAAO,EAAE,CAAC;QACV,OAAO;YACH,UAAU,EAAE,GAAG;YACf,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,YAAY,EAAE,CAAC;SACzC,CAAC;IACN,CAAC;IAED,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC;AACnD,CAAC"}
+{"version":3,"file":"sdk-general.js","sourceRoot":"","sources":["../../src/sdk-general.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,mCAAmC;AACnC,EAAE;AACF,oEAAoE;AACpE,0EAA0E;AAC1E,EAAE;AACF,6DAA6D;AAC7D,oDAAoD;AAEpD;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAc,EAAE,EAAE,MAAM,MAAM,CAAC;AAEtC,mFAAmF;AACnF,sCAAsC;AACtC,mFAAmF;AAEnF;;GAEG;AACH,MAAM,CAAC,IAAI,YAAsC,CAAC;AAElD;;GAEG;AACH,MAAM,CAAC,IAAI,UAAkB,CAAC;AAE9B;;GAEG;AACH,MAAM,CAAC,IAAI,cAAsB,CAAC;AAElC;;GAEG;AACH,MAAM,CAAC,IAAI,aAAkB,CAAC;AAE9B;;GAEG;AACH,MAAM,CAAC,IAAI,WAAwB,CAAC;AAEpC;;GAEG;AACH,MAAM,CAAC,IAAI,MAAc,CAAC;AAE1B;;GAEG;AACH,MAAM,CAAC,IAAI,OAAgB,CAAC;AAE5B;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,KAAmC;IAE1D,IAAI,IAAI,GAAQ,KAAK,CAAC;IACtB,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAClB,OAAO,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,IAAI,IAAI,EAAE,CAAC;QACP,CAAC,EAAE,UAAU,EAAE,cAAc,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;QAE5E,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,YAAY,GAAG,GAAG,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;aAAM,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACjC,YAAY,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC3C,CAAC;IACL,CAAC;AACL,CAAC;AAgKD,mFAAmF;AACnF,4BAA4B;AAC5B,mFAAmF;AAEnF;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,eAA+B;IAClE,IAAI,OAAO,EAAE,CAAC;QACV,OAAO;YACH,UAAU,EAAE,GAAG;YACf,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC;SACxC,CAAC;IACN,CAAC;IAED,OAAO,eAAe,CAAC;AAC3B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,YAAoB;IACrD,IAAI,OAAO,EAAE,CAAC;QACV,OAAO;YACH,UAAU,EAAE,GAAG;YACf,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,YAAY,EAAE,CAAC;SACzC,CAAC;IACN,CAAC;IAED,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC;AACnD,CAAC"}