@halix/action-sdk 1.0.19 → 1.0.21

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

@@ -0,0 +1,212 @@
+import { Observable } from 'rxjs';
+/**
+ * SortField is an interface for specifying sort fields.
+ */
+export interface SortField {
+    /** The attribute ID to sort by */
+    attributeId: string;
+    /** Whether to sort in descending order */
+    descending?: boolean;
+    /** Whether to perform case-insensitive comparison */
+    caseInsensitive?: boolean;
+    /** Whether to use auto-sequencing */
+    autoSequence?: boolean;
+}
+/**
+ * DataSortField represents a single sort field, wrapping an attribute ID and sort direction.
+ */
+export interface DataSortField {
+    /** The ID of the attribute to sort by (can include relationship paths with dots, e.g. "customer.lastName") */
+    attributeId: string;
+    /** Whether to sort in descending order (true) or ascending order (false, default) */
+    descending?: boolean;
+}
+/**
+ * ListDataRequest is an interface defining the properties of a list data request.
+ * This request is used to retrieve list data from the Halix platform.
+ */
+export interface ListDataRequest {
+    /**
+     * The ID of the root data element to retrieve.
+     */
+    dataElementId: string;
+    /**
+     * The 1-based page number to retrieve. Works with pageSize.
+     * Alternatively, you can use traditional offset/limit pagination.
+     */
+    pageNumber?: number;
+    /**
+     * The number of records per page. Works with pageNumber.
+     */
+    pageSize?: number;
+    /**
+     * Sort configuration - list of sort fields in priority order.
+     * Each field can include relationship paths (e.g., "customer.lastName").
+     */
+    sort?: DataSortField[];
+    /**
+     * The ID of the data element that defines the overall scope of records.
+     * The dataElementId must be related to this through a foreign key or key array.
+     * Works with parentKey to scope results. This is often an organization proxy
+     * or user proxy element, but not necessarily so.
+     */
+    parentDataElementId: string;
+    /**
+     * The key of an object that all records must be related to.
+     * Works with parentDataElementId to scope results.
+     */
+    parentKey?: string;
+    /**
+     * Optional field to specify the foreign key field on the root element that defines
+     * the relationship to the parent. If omitted, a derived key is assumed.
+     */
+    parentKeyField?: string;
+    /**
+     * Optional property to specify the relationship field for foreignKeySet relationships.
+     * Required when parent has multiple relationships to the child element.
+     */
+    childKeysField?: string;
+    /**
+     * Filter expression to limit results. Evaluated within the parent key scope.
+     * Uses `dataexpr` format.
+     */
+    filter?: string;
+    /**
+     * List of fields being displayed on the list. Only these fields are populated in
+     * returned objects to reduce payload size. If fields include relationship paths,
+     * those relationships are automatically retrieved.
+     */
+    displayFields?: string[];
+    /**
+     * Additional field values to include that may not be in displayFields, sort, or filters.
+     */
+    additionalFieldsToFetch?: string[];
+}
+/**
+ * ListDataResponse wraps a data provider response to a list data request.
+ */
+export interface ListDataResponse {
+    /**
+     * A slice of the appropriate runtime struct type containing a single page-worth of data.
+     * The actual type of objects in this array depends on the dataElementId being queried.
+     */
+    data: any[];
+    /** The total number of entries across all pages */
+    total: number;
+    /**
+     * The index within the data array of the selected row.
+     * This value is provided when a search term is included in the data request.
+     */
+    selectedRow: number;
+    /** The 1-based page number included in this response */
+    pageNumber: number;
+}
+/**
+ * ListDataSearchOptions is an interface defining the search options for list data retrieval.
+ */
+export interface ListDataSearchOptions {
+    /** The attribute ID to search by */
+    attributeId: string;
+    /** The value to search for */
+    value: string;
+    /** The total number of items in the list */
+    total: number;
+}
+/**
+ * ListDataOptions is an interface defining options for list data retrieval.
+ */
+export interface ListDataOptions {
+    /** Whether to access the public endpoint (no authentication required) */
+    isPublic?: boolean;
+    /** Whether to bypass total count calculation for performance */
+    bypassTotal?: boolean;
+    /**
+     * Search options for binary search functionality; if provided, the response will include
+     * the page of data that contains the first occurrence of the search value. The selectedRow
+     * property will be set to the index of the first occurrence of the search value.
+     */
+    search?: ListDataSearchOptions;
+}
+/**
+ * getListData retrieves list data from the Halix platform. This function can operate in four
+ * different modes based on the provided options:
+ *
+ * 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
+ *
+ * @example
+ * // Basic authenticated list data retrieval
+ * const listData = await getListData({
+ *   dataElementId: 'customer',
+ *   parentDataElementId: 'company',
+ *   parentKey: orgProxyKey,
+ *   pageNumber: 1,
+ *   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 declare function getListData(request: ListDataRequest, options?: ListDataOptions): Promise<ListDataResponse>;
+/**
+ * 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
+ *
+ * @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);
+ * });
+ */
+export declare function getListDataAsObservable(request: ListDataRequest, options?: ListDataOptions): Observable<ListDataResponse>;
+//# sourceMappingURL=lists.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"lists.d.ts","sourceRoot":"","sources":["../../../src/lists.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAQ,UAAU,EAAiB,MAAM,MAAM,CAAC;AAOvD;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,0CAA0C;IAC1C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,qDAAqD;IACrD,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qCAAqC;IACrC,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,8GAA8G;IAC9G,WAAW,EAAE,MAAM,CAAC;IACpB,qFAAqF;IACrF,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,IAAI,CAAC,EAAE,aAAa,EAAE,CAAC;IAEvB;;;;;OAKG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,IAAI,EAAE,GAAG,EAAE,CAAC;IAEZ,mDAAmD;IACnD,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,wDAAwD;IACxD,UAAU,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,yEAAyE;IACzE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gEAAgE;IAChE,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAC;CAClC;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,wBAAsB,WAAW,CAAC,OAAO,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAkDhH;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAEzH"}

package/lib/cjs/types/sdk-general.d.ts

@@ -0,0 +1,263 @@
+/**
+ * @module @halix/action-sdk/sdk-general
+ * @description Core SDK module providing global variables, initialization, and common types used
+ * across the entire SDK. This module includes:
+ * - Global variables for authentication, service configuration, and user context
+ * - initialize() function for setting up the SDK with incoming event data
+ * - Action response type definitions (ListActionResponse, FormTemplateActionResponse, etc.)
+ * - Response formatting helpers (prepareSuccessResponse, prepareErrorResponse)
+ * - Common interfaces (UserContext, IncomingEventBody, NotificationConfig)
+ *
+ * This module should be initialized by calling initialize() before using any other SDK functions.
+ * The global variables are then available for use and are automatically used by other SDK functions.
+ */
+import { Observable } from 'rxjs';
+/**
+ * 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.
+ */
+export declare let getAuthToken: () => Observable<string>;
+/**
+ * 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.
+ */
+export declare let sandboxKey: string;
+/**
+ * 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.
+ */
+export declare let serviceAddress: string;
+/**
+ * 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
+ */
+export declare let actionSubject: any;
+/**
+ * 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.
+ */
+export declare let userContext: 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.
+ */
+export declare let params: string;
+/**
+ * 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.
+ */
+export declare let useBody: boolean;
+/**
+ * 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.
+ *
+ * @param event - The event object containing authentication and context information
+ */
+export declare function initialize(event: {
+    body?: IncomingEventBody;
+}): void;
+/**
+ * UserContext is an interface defining the properties of the user context.
+ */
+export interface UserContext {
+    user: any;
+    userProxy: any;
+    orgProxy: any;
+    orgProxyKey: string;
+    orgKey: string;
+    userProxyKey: string;
+}
+/**
+ * IncomingEventBody is an interface defining the properties of an incoming event body. The halix
+ * platform provides these properties when an action is triggered.
+ */
+export interface IncomingEventBody {
+    authToken?: string;
+    authTokenRetriever?: () => Observable<string>;
+    sandboxKey: string;
+    serviceAddress: string;
+    actionSubject: any;
+    userContext: UserContext;
+    params: Record<string, any>;
+}
+/**
+ * BaseActionResponse is an interface defining the base properties of an action response.
+ */
+export interface BaseActionResponse {
+    /**
+     * The type of action response
+     *
+     * listAction - Use when the action is being run from a list
+     * formTemplateAction - Use when the action is being run from a form template
+     * pageTemplateAction - Use when the action is being run from a page template
+     * objectSaveAction - Use when the action has been specified for use on object save events
+     * calculatedFieldAction - Use when the action is being used to determine calculated field values
+     * singleValueAction - Use when the action is being used to determine a single value in specific
+     * build-in platform events (e.g., determining shopping cart prices)
+     * error - Use when the action is not successful
+     */
+    responseType: "listAction" | "formTemplateAction" | "pageTemplateAction" | "objectSaveAction" | "calculatedFieldAction" | "singleValueAction" | "error";
+    /** Whether the action is an error */
+    isError: boolean;
+    /** Notification configurations; present only if the action should trigger one or more notifications */
+    notificationConfigs?: NotificationConfig[];
+}
+/**
+ * ActionResponse is an interface defining the properties of an action response.
+ */
+export type ActionResponse = ListActionResponse | FormTemplateActionResponse | PageTemplateActionResponse | ObjectSaveActionResponse | CalculatedFieldActionResponse | SingleValueActionResponse;
+/**
+ * NotificationConfig is an interface defining a notification that should be triggered by a
+ * successful action response.
+ */
+export interface NotificationConfig {
+    /** The ID of a notification definition setup within the solution */
+    notificationDefinitionId: string;
+    /** The key of the organization proxy */
+    organizationProxyKey: string;
+    /** The object type of the data associated with the notification */
+    dataObjectType: string;
+    /** The key of the data object associated with the notification */
+    dataObjectKey: string;
+    /** The parameters to pass to the notification */
+    params: Record<string, any>;
+    emailConfig?: {
+        /** The type of user proxy to send the email to */
+        recipientUserProxyType: string;
+        /** The keys of the user proxies to send the email to */
+        recipientUserProxyKeys: string[];
+        /** The email address of the sender */
+        fromEmailAddress?: string;
+        /** The name of the sender */
+        fromNameView?: string;
+        /** The email address to reply to */
+        replyEmailAddress?: string;
+        /** The email address to send the email to; use when sending emails to non-user proxies/free-form email addresses; can contain a comma-separated list of email addresses */
+        recipientEmail?: string;
+    };
+    smsConfig?: {
+        /** The type of user proxy to send the SMS to */
+        recipientUserProxyType: string;
+        /** The keys of the user proxies to send the SMS to */
+        recipientUserProxyKeys: string[];
+        /** The phone number to send the SMS to; can contain a comma-separated list of phone numbers */
+        recipientPhone: string;
+    };
+    pushConfig?: {
+        /** The type of user proxy to send the push notification to */
+        recipientUserProxyType: string;
+        /** The keys of the user proxies to send the push notification to */
+        recipientUserProxyKeys: string[];
+        /** The navigation data to pass to the push notification */
+        navigationData?: Record<string, string>;
+    };
+}
+/**
+ * ListActionResponse is an interface defining the properties of a list action response. These
+ * properties are expected by the list framework unpon receiving an action response from an action
+ * handler.
+ */
+export interface ListActionResponse extends BaseActionResponse {
+    responseType: "listAction";
+    updatedSubject: any;
+    successMessage: string;
+}
+/**
+ * FormTemplateActionResponse is an interface defining the properties of a form template action
+ * response. These properties are expected by the form framework unpon receiving an action response
+ * from an action handler.
+ */
+export interface FormTemplateActionResponse extends BaseActionResponse {
+    responseType: "formTemplateAction";
+    updatedSubject: any;
+    successMessage: string;
+}
+/**
+ * PageTemplateActionResponse is an interface defining the properties of a page template action
+ * response. These properties are expected by the page framework unpon receiving an action response
+ * from an action handler.
+ */
+export interface PageTemplateActionResponse extends BaseActionResponse {
+    responseType: "pageTemplateAction";
+    successMessage: string;
+    updatedSubject?: Record<string, any>;
+    refreshPage?: boolean;
+}
+/**
+ * ObjectSaveActionResponse is an interface defining the properties of an object save action
+ * response. These properties are expected by the object save framework unpon receiving an action
+ * response from an action handler.
+ */
+export interface ObjectSaveActionResponse extends BaseActionResponse {
+    responseType: "objectSaveAction";
+    updatedSubject: any;
+    successMessage: string;
+}
+/**
+ * CalculatedFieldActionResponse is an interface defining the properties of a calculated field
+ * action response. These properties are expected by the calculated field framework unpon receiving
+ * an action response from an action handler.
+ */
+export interface CalculatedFieldActionResponse extends BaseActionResponse {
+    responseType: "calculatedFieldAction";
+    calculatedValue: any;
+}
+/**
+ * SingleValueActionResponse is an interface defining the properties of a single value action
+ * response. These properties are expected by the caller of the action.
+ */
+export interface SingleValueActionResponse extends BaseActionResponse {
+    responseType: "singleValueAction";
+    successMessage: string;
+    value: any;
+}
+/**
+ * ErrorResponse is an interface defining the properties of an error response.
+ */
+export interface ErrorResponse {
+    responseType: "error";
+    errorMessage: string;
+}
+/**
+ * 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.
+ *
+ * @param successResponse - The value to return
+ *
+ * @returns Formatted success response; an ActionResponse unless useBody is true
+ */
+export declare function prepareSuccessResponse(successResponse: ActionResponse): {
+    statusCode: number;
+    body: string;
+} | ActionResponse;
+/**
+ * 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
+ *
+ * @returns Formatted error response; an ErrorResponse unless useBody is true
+ */
+export declare function prepareErrorResponse(errorMessage: string): {
+    statusCode: number;
+    body: string;
+} | ErrorResponse;
+//# sourceMappingURL=sdk-general.d.ts.map

package/lib/cjs/types/sdk-general.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdk-general.d.ts","sourceRoot":"","sources":["../../../src/sdk-general.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,UAAU,EAAM,MAAM,MAAM,CAAC;AAMtC;;;;GAIG;AACH,eAAO,IAAI,YAAY,EAAE,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC;AAElD;;;;GAIG;AACH,eAAO,IAAI,UAAU,EAAE,MAAM,CAAC;AAE9B;;;GAGG;AACH,eAAO,IAAI,cAAc,EAAE,MAAM,CAAC;AAElC;;;;;;;;;;;GAWG;AACH,eAAO,IAAI,aAAa,EAAE,GAAG,CAAC;AAE9B;;;GAGG;AACH,eAAO,IAAI,WAAW,EAAE,WAAW,CAAC;AAEpC;;;;GAIG;AACH,eAAO,IAAI,MAAM,EAAE,MAAM,CAAC;AAE1B;;;;;GAKG;AACH,eAAO,IAAI,OAAO,EAAE,OAAO,CAAC;AAE5B;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE;IAAE,IAAI,CAAC,EAAE,iBAAiB,CAAA;CAAE,QAiB7D;AAMD;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,GAAG,CAAC;IACV,SAAS,EAAE,GAAG,CAAC;IACf,QAAQ,EAAE,GAAG,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC;IAC9C,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,GAAG,CAAC;IACnB,WAAW,EAAE,WAAW,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;;;;;;;;;OAWG;IACH,YAAY,EAAE,YAAY,GAAG,oBAAoB,GAAG,oBAAoB,GAAG,kBAAkB,GAAG,uBAAuB,GAAG,mBAAmB,GAAG,OAAO,CAAC;IACxJ,qCAAqC;IACrC,OAAO,EAAE,OAAO,CAAC;IACjB,uGAAuG;IACvG,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,kBAAkB,GAAG,0BAA0B,GAAG,0BAA0B,GAAG,wBAAwB,GAAG,6BAA6B,GAAG,yBAAyB,CAAC;AAEjM;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,oEAAoE;IACpE,wBAAwB,EAAE,MAAM,CAAC;IACjC,wCAAwC;IACxC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,mEAAmE;IACnE,cAAc,EAAE,MAAM,CAAC;IACvB,kEAAkE;IAClE,aAAa,EAAE,MAAM,CAAC;IACtB,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE5B,WAAW,CAAC,EAAE;QACV,kDAAkD;QAClD,sBAAsB,EAAE,MAAM,CAAC;QAC/B,wDAAwD;QACxD,sBAAsB,EAAE,MAAM,EAAE,CAAC;QACjC,sCAAsC;QACtC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,6BAA6B;QAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,oCAAoC;QACpC,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,2KAA2K;QAC3K,cAAc,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;IAEF,SAAS,CAAC,EAAE;QACR,gDAAgD;QAChD,sBAAsB,EAAE,MAAM,CAAC;QAC/B,sDAAsD;QACtD,sBAAsB,EAAE,MAAM,EAAE,CAAC;QACjC,+FAA+F;QAC/F,cAAc,EAAE,MAAM,CAAC;KAC1B,CAAC;IAEF,UAAU,CAAC,EAAE;QACT,8DAA8D;QAC9D,sBAAsB,EAAE,MAAM,CAAC;QAC/B,oEAAoE;QACpE,sBAAsB,EAAE,MAAM,EAAE,CAAC;QACjC,2DAA2D;QAC3D,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAC3C,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;IAC1D,YAAY,EAAE,YAAY,CAAC;IAC3B,cAAc,EAAE,GAAG,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IAClE,YAAY,EAAE,oBAAoB,CAAC;IACnC,cAAc,EAAE,GAAG,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IAClE,YAAY,EAAE,oBAAoB,CAAC;IACnC,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACrC,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,kBAAkB;IAChE,YAAY,EAAE,kBAAkB,CAAC;IACjC,cAAc,EAAE,GAAG,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA8B,SAAQ,kBAAkB;IACrE,YAAY,EAAE,uBAAuB,CAAC;IACtC,eAAe,EAAE,GAAG,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,kBAAkB;IACjE,YAAY,EAAE,mBAAmB,CAAC;IAClC,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,GAAG,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;CACxB;AAMD;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CAAC,eAAe,EAAE,cAAc,GAAG;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,cAAc,CAS7H;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,YAAY,EAAE,MAAM,GAAG;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAS/G"}

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

@@ -0,0 +1,73 @@
+/**
+ * @module @halix/action-sdk/utilities
+ * @description Utility functions for data manipulation and processing in the Halix Platform action SDK.
+ * This module provides helper functions for common data operations that are useful across various
+ * action handler scenarios.
+ *
+ * Key features:
+ * - sortObjectArray: In-place sorting of object arrays with multi-field priority sorting
+ * - compareValues: Flexible value comparison with support for strings, numbers, and null values
+ * - getValueFromObject: Extract values from nested objects using dot-notation paths
+ * - debounceFn: Debounce function calls to prevent excessive execution
+ */
+/**
+ * SortField is an interface for specifying sort fields.
+ */
+export interface SortField {
+    /** The attribute ID to sort by */
+    attributeId: string;
+    /** Whether to sort in descending order */
+    descending?: boolean;
+    /** Whether to perform case-insensitive comparison */
+    caseInsensitive?: boolean;
+    /** Whether to use auto-sequencing */
+    autoSequence?: boolean;
+}
+/**
+ * sortObjectArray is a helper function that sorts the passed array in place by the given
+ * attributes. Sorting by nested attributes in the form of a delimited attribute string are
+ * supported (e.g., "attribute.nestedAttribute").
+ *
+ * @param array - The array to sort
+ * @param sort - Array of sort field specifications
+ * @returns The sorted array
+ */
+export declare function sortObjectArray<T>(array: Array<T>, sort: SortField[]): Array<T>;
+/**
+ * compareValues is a helper function that compares two values for sorting purposes. If the values
+ * are strings, the comparison is case-insensitive. If the values are numbers, the comparison is
+ * performed numerically.
+ *
+ * @param valueA - First value to compare
+ * @param valueB - Second value to compare
+ * @param descending - Whether to sort in descending order
+ * @param caseInsensitive - Whether to perform case-insensitive comparison for strings
+ *
+ * @returns Comparison result (-1, 0, or 1)
+ */
+export declare function compareValues(valueA: any, valueB: any, descending: boolean, caseInsensitive: boolean): number;
+/**
+ * getValueFromObject is a helper function that extracts a value from an object using a dot-notation
+ * path. The path can include relationships. Relationship IDs may include a colon delimiter (e.g.,
+ * "accountMember:ownerAccountMemberKey") to specify the key of the related object. This is useful
+ * when an element has more than one relationship to the same object type. Otherwise, if only one
+ * relationship to the same object type exists, the key may be specified without the relationship ID
+ * (e.g., simply, "accountMember").
+ *
+ * @param object - The object to extract value from
+ * @param attribute - The attribute path (e.g., "user.address.city")
+ *
+ * @returns The extracted value
+ */
+export declare function getValueFromObject(object: any, attribute: string): any;
+/**
+ * debounceFn is a utility function that debounces a function call. It is used to prevent multiple
+ * calls to the same function within a short period of time.
+ *
+ * @param fn - The function to debounce
+ * @param wait - The number of milliseconds to wait before calling the function
+ *
+ * @returns The debounced function
+ */
+export declare function debounceFn<T extends (...args: any[]) => void>(fn: T, wait?: number): (...args: Parameters<T>) => void;
+//# sourceMappingURL=utilities.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.d.ts","sourceRoot":"","sources":["../../../src/utilities.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;GAWG;AAMH;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,0CAA0C;IAC1C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,qDAAqD;IACrD,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qCAAqC;IACrC,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAMD;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAiB/E;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,MAAM,CA2B7G;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,GAAG,GAAG,CAuBtE;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,SAAM,IAEpE,GAAG,MAAM,UAAU,CAAC,CAAC,CAAC,UAIjC"}