@halix/action-sdk 1.0.25 → 1.0.26

package/lib/cjs/data-aggregate.js

@@ -0,0 +1,101 @@
+"use strict";
+// Halix SDK License v1.0
+// Copyright (c) 2025 halix.io LLC.
+//
+// This source code is licensed for use **only** within applications
+// running on the Halix platform, in accordance with Halix SDK guidelines.
+//
+// Unauthorized use outside the Halix platform is prohibited.
+// Full license terms available in the LICENSE file.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAggregateData = getAggregateData;
+exports.getAggregateDataAsObservable = getAggregateDataAsObservable;
+/**
+ * @module @halix/action-sdk/data-aggregate
+ * @description Data aggregation operations for the Halix Platform action SDK. This module provides functions
+ * for performing aggregate queries (count, sum, average, etc.) on data objects grouped by specified fields.
+ * Results are returned as aggregated data suitable for charts, reports, and analytics dashboards.
+ *
+ * Key features:
+ * - Group data by one or more fields
+ * - Apply transformations to grouping fields (date functions, string functions)
+ * - Calculate aggregations (count, sum, average, min, max, median)
+ * - Sort aggregated results
+ * - Filter data before aggregation
+ * - Parent-child relationship scoping for security
+ */
+const axios_1 = __importDefault(require("axios"));
+const rxjs_1 = require("rxjs");
+const sdk_general_1 = require("./sdk-general");
+// ================================================================================
+// DATA AGGREGATION FUNCTIONS
+// ================================================================================
+/**
+ * Performs data aggregation operations (count, sum, average, etc.) on grouped data.
+ * Supports filtering, grouping with transforms, sorting, and multiple aggregations.
+ *
+ * @param request - Aggregation configuration including dataElementId, parent scope, groups, aggregations
+ * @returns Promise<AggregationResponse> with aggregated data array
+ *
+ * @example
+ * const results = await getAggregateData({
+ *   dataElementId: 'order',
+ *   parentDataElementId: 'company',
+ *   parentKey: orgProxyKey,
+ *   groups: [{
+ *     groupField: 'status',
+ *     groupDirection: 'asc'
+ *   }],
+ *   aggregations: [{
+ *     aggregation: 'Count',
+ *     aggregationField: 'objKey'
+ *   }, {
+ *     aggregation: 'Sum',
+ *     aggregationField: 'totalAmount'
+ *   }]
+ * });
+ */
+function getAggregateData(request) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!sdk_general_1.getAuthToken) {
+            const errorMessage = 'SDK not initialized.';
+            console.error(errorMessage);
+            throw new Error(errorMessage);
+        }
+        const url = `${sdk_general_1.serviceAddress}/sandboxes/${sdk_general_1.sandboxKey}/aggregateData`;
+        // Build headers with authentication token
+        let authToken = yield (0, rxjs_1.lastValueFrom)((0, sdk_general_1.getAuthToken)());
+        let headers = {
+            Authorization: `Bearer ${authToken}`
+        };
+        console.log("Sending POST request to " + url + " with token " + authToken);
+        // Make the API request
+        let response = yield axios_1.default.post(url, request, { headers });
+        return response.data;
+    });
+}
+/**
+ * Observable version of getAggregateData. See getAggregateData for details.
+ *
+ * @example
+ * getAggregateDataAsObservable({
+ *   dataElementId: 'order',
+ *   groups: [{ groupField: 'status', groupDirection: 'asc' }],
+ *   aggregations: [{ aggregation: 'Count', aggregationField: 'objKey' }]
+ * }).subscribe(response => console.log(response.data));
+ */
+function getAggregateDataAsObservable(request) {
+    return (0, rxjs_1.from)(getAggregateData(request));
+}

package/lib/cjs/index.js

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

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

@@ -0,0 +1,140 @@
+import { Observable } from 'rxjs';
+/**
+ * TransformType specifies the type of transformation to apply to a group field.
+ */
+export type TransformType = 'Year' | 'Month' | 'Week' | 'Day' | 'Hour' | 'Minute' | 'Substring';
+/**
+ * AggregationType specifies the type of aggregation to perform on a field.
+ */
+export type AggregationType = 'Average' | 'Count' | 'Sum' | 'Max' | 'Min' | 'Median';
+/**
+ * AggregationGroupTransform represents a transform function with parameters to be applied to a group field.
+ */
+export interface AggregationGroupTransform {
+    /** The transformation function to apply */
+    transform: TransformType;
+    /** Arguments for the transformation function */
+    args?: {
+        [key: string]: any;
+    };
+}
+/**
+ * AggregationGroup defines a grouping field with optional transforms and sort direction.
+ */
+export interface AggregationGroup {
+    /** The field to group by (can include relationship paths with dots, e.g. "customer.lastName") */
+    groupField: string;
+    /** Sort direction for this group ('asc' or 'desc') */
+    groupDirection: 'asc' | 'desc';
+    /** Optional transforms to apply to the grouping field */
+    transforms?: AggregationGroupTransform[];
+}
+/**
+ * AggregationSort defines a secondary sort field for aggregated results.
+ */
+export interface AggregationSort {
+    /** The field to sort by (can include relationship paths with dots) */
+    sortField: string;
+    /** Sort direction ('asc' or 'desc') */
+    sortDirection: 'asc' | 'desc';
+    /** The aggregation type to sort by (must match an aggregation in the request) */
+    sortAggregation: AggregationType;
+}
+/**
+ * Aggregation defines an aggregation operation to perform on a field.
+ */
+export interface Aggregation {
+    /** The aggregation function to apply ('Average', 'Count', 'Sum', 'Max', 'Min', 'Median') */
+    aggregation: AggregationType;
+    /** The field to aggregate (can include relationship paths with dots) */
+    aggregationField: string;
+}
+/**
+ * AggregationRequest defines the parameters for an aggregation query.
+ * The data scope is controlled by parentDataElementId, parentKey, and dataElementId.
+ */
+export interface AggregationRequest {
+    /**
+     * The ID of the data element to aggregate.
+     */
+    dataElementId: string;
+    /**
+     * The ID of the parent data element that defines the overall scope of records.
+     * The dataElementId must be related to this through a foreign key or key array.
+     */
+    parentDataElementId?: string;
+    /**
+     * The key of a parent 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 data element that defines
+     * the relationship to the parent. If omitted, a derived key is assumed.
+     */
+    parentKeyField?: string;
+    /**
+     * Filter expression to limit records before aggregation.
+     * @see the filter-expressions module for filter syntax and examples
+     */
+    filter?: string;
+    /**
+     * List of grouping specifications. Groups are formed by field values with optional transforms.
+     * Results will be grouped by these fields in the order specified.
+     */
+    groups: AggregationGroup[];
+    /**
+     * List of secondary sort specifications for the aggregated results.
+     * Groups are the primary sorts; these are additional sorting criteria.
+     */
+    sort?: AggregationSort[];
+    /**
+     * List of aggregation operations to perform on the grouped data.
+     */
+    aggregations: Aggregation[];
+}
+/**
+ * AggregationResponse wraps the aggregated data results.
+ */
+export interface AggregationResponse {
+    /** The aggregated data results */
+    data: any[];
+}
+/**
+ * Performs data aggregation operations (count, sum, average, etc.) on grouped data.
+ * Supports filtering, grouping with transforms, sorting, and multiple aggregations.
+ *
+ * @param request - Aggregation configuration including dataElementId, parent scope, groups, aggregations
+ * @returns Promise<AggregationResponse> with aggregated data array
+ *
+ * @example
+ * const results = await getAggregateData({
+ *   dataElementId: 'order',
+ *   parentDataElementId: 'company',
+ *   parentKey: orgProxyKey,
+ *   groups: [{
+ *     groupField: 'status',
+ *     groupDirection: 'asc'
+ *   }],
+ *   aggregations: [{
+ *     aggregation: 'Count',
+ *     aggregationField: 'objKey'
+ *   }, {
+ *     aggregation: 'Sum',
+ *     aggregationField: 'totalAmount'
+ *   }]
+ * });
+ */
+export declare function getAggregateData(request: AggregationRequest): Promise<AggregationResponse>;
+/**
+ * Observable version of getAggregateData. See getAggregateData for details.
+ *
+ * @example
+ * getAggregateDataAsObservable({
+ *   dataElementId: 'order',
+ *   groups: [{ groupField: 'status', groupDirection: 'asc' }],
+ *   aggregations: [{ aggregation: 'Count', aggregationField: 'objKey' }]
+ * }).subscribe(response => console.log(response.data));
+ */
+export declare function getAggregateDataAsObservable(request: AggregationRequest): Observable<AggregationResponse>;
+//# sourceMappingURL=data-aggregate.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"data-aggregate.d.ts","sourceRoot":"","sources":["../../../src/data-aggregate.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAQ,UAAU,EAAiB,MAAM,MAAM,CAAC;AAOvD;;GAEG;AACH,MAAM,MAAM,aAAa,GACnB,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GACrD,WAAW,CAAC;AAElB;;GAEG;AACH,MAAM,MAAM,eAAe,GACrB,SAAS,GAAG,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACtC,2CAA2C;IAC3C,SAAS,EAAE,aAAa,CAAC;IACzB,gDAAgD;IAChD,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,iGAAiG;IACjG,UAAU,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,cAAc,EAAE,KAAK,GAAG,MAAM,CAAC;IAC/B,yDAAyD;IACzD,UAAU,CAAC,EAAE,yBAAyB,EAAE,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,sEAAsE;IACtE,SAAS,EAAE,MAAM,CAAC;IAClB,uCAAuC;IACvC,aAAa,EAAE,KAAK,GAAG,MAAM,CAAC;IAC9B,iFAAiF;IACjF,eAAe,EAAE,eAAe,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,4FAA4F;IAC5F,WAAW,EAAE,eAAe,CAAC;IAC7B,wEAAwE;IACxE,gBAAgB,EAAE,MAAM,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAE3B;;;OAGG;IACH,IAAI,CAAC,EAAE,eAAe,EAAE,CAAC;IAEzB;;OAEG;IACH,YAAY,EAAE,WAAW,EAAE,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,kCAAkC;IAClC,IAAI,EAAE,GAAG,EAAE,CAAC;CACf;AAMD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAqBhG;AAED;;;;;;;;;GASG;AACH,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,kBAAkB,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAEzG"}

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

@@ -10,5 +10,6 @@ export { MessageMethod, type MessageRequest, sendMessage, sendMessageAsObservabl
 export { getPreference, getPreferenceAsObservable } from './preferences';
 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 { type AggregationRequest, type AggregationResponse, type AggregationGroup, type AggregationSort, type Aggregation, type AggregationGroupTransform, type TransformType, type AggregationType, getAggregateData, getAggregateDataAsObservable } from './data-aggregate';
 export { sortObjectArray, compareValues, getValueFromObject, debounceFn } from './utilities';
 //# sourceMappingURL=index.d.ts.map

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

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

package/lib/esm/data-aggregate.js

@@ -0,0 +1,84 @@
+// 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/data-aggregate
+ * @description Data aggregation operations for the Halix Platform action SDK. This module provides functions
+ * for performing aggregate queries (count, sum, average, etc.) on data objects grouped by specified fields.
+ * Results are returned as aggregated data suitable for charts, reports, and analytics dashboards.
+ *
+ * Key features:
+ * - Group data by one or more fields
+ * - Apply transformations to grouping fields (date functions, string functions)
+ * - Calculate aggregations (count, sum, average, min, max, median)
+ * - Sort aggregated results
+ * - Filter data before aggregation
+ * - Parent-child relationship scoping for security
+ */
+import axios from 'axios';
+import { from, lastValueFrom } from 'rxjs';
+import { sandboxKey, serviceAddress, getAuthToken } from './sdk-general';
+// ================================================================================
+// DATA AGGREGATION FUNCTIONS
+// ================================================================================
+/**
+ * Performs data aggregation operations (count, sum, average, etc.) on grouped data.
+ * Supports filtering, grouping with transforms, sorting, and multiple aggregations.
+ *
+ * @param request - Aggregation configuration including dataElementId, parent scope, groups, aggregations
+ * @returns Promise<AggregationResponse> with aggregated data array
+ *
+ * @example
+ * const results = await getAggregateData({
+ *   dataElementId: 'order',
+ *   parentDataElementId: 'company',
+ *   parentKey: orgProxyKey,
+ *   groups: [{
+ *     groupField: 'status',
+ *     groupDirection: 'asc'
+ *   }],
+ *   aggregations: [{
+ *     aggregation: 'Count',
+ *     aggregationField: 'objKey'
+ *   }, {
+ *     aggregation: 'Sum',
+ *     aggregationField: 'totalAmount'
+ *   }]
+ * });
+ */
+export async function getAggregateData(request) {
+    if (!getAuthToken) {
+        const errorMessage = 'SDK not initialized.';
+        console.error(errorMessage);
+        throw new Error(errorMessage);
+    }
+    const url = `${serviceAddress}/sandboxes/${sandboxKey}/aggregateData`;
+    // 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;
+}
+/**
+ * Observable version of getAggregateData. See getAggregateData for details.
+ *
+ * @example
+ * getAggregateDataAsObservable({
+ *   dataElementId: 'order',
+ *   groups: [{ groupField: 'status', groupDirection: 'asc' }],
+ *   aggregations: [{ aggregation: 'Count', aggregationField: 'objKey' }]
+ * }).subscribe(response => console.log(response.data));
+ */
+export function getAggregateDataAsObservable(request) {
+    return from(getAggregateData(request));
+}
+//# sourceMappingURL=data-aggregate.js.map

package/lib/esm/data-aggregate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-aggregate.js","sourceRoot":"","sources":["../../src/data-aggregate.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,mCAAmC;AACnC,EAAE;AACF,oEAAoE;AACpE,0EAA0E;AAC1E,EAAE;AACF,6DAA6D;AAC7D,oDAAoD;AAEpD;;;;;;;;;;;;;GAaG;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;AA2HzE,mFAAmF;AACnF,6BAA6B;AAC7B,mFAAmF;AAEnF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,OAA2B;IAC9D,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,MAAM,GAAG,GAAG,GAAG,cAAc,cAAc,UAAU,gBAAgB,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;;;;;;;;;GASG;AACH,MAAM,UAAU,4BAA4B,CAAC,OAA2B;IACpE,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;AAC3C,CAAC"}

package/lib/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,mCAAmC;AACnC,EAAE;AACF,oEAAoE;AACpE,0EAA0E;AAC1E,EAAE;AACF,6DAA6D;AAC7D,oDAAoD;AAEpD;;;;GAIG;AAEH,mFAAmF;AACnF,sDAAsD;AACtD,mFAAmF;AAEnF,OAAO;AACH,UAAU;AACV,YAAY,EACZ,UAAU,EACV,cAAc,EACd,aAAa,EACb,WAAW,EACX,MAAM,EACN,OAAO;AAEP,iBAAiB;AACjB,UAAU;AAkBV,mBAAmB;AACnB,sBAAsB,EACtB,oBAAoB,EACvB,MAAM,eAAe,CAAC;AAEvB,mFAAmF;AACnF,sBAAsB;AACtB,mFAAmF;AAEnF,OAAO;AAIH,iBAAiB;AACjB,SAAS,EACT,qBAAqB,EACrB,iBAAiB,EACjB,6BAA6B;AAE7B,YAAY;AACZ,iBAAiB,EACjB,6BAA6B;AAE7B,cAAc;AACd,mBAAmB,EACnB,+BAA+B,EAC/B,oBAAoB,EACpB,gCAAgC,EACnC,MAAM,aAAa,CAAC;AAErB,mFAAmF;AACnF,oBAAoB;AACpB,mFAAmF;AAEnF,OAAO;AAIH,oBAAoB;AACpB,mBAAmB,EACnB,+BAA+B,EAC/B,YAAY,EACZ,wBAAwB,EACxB,gBAAgB,EAChB,4BAA4B,EAC5B,sBAAsB,EACtB,kCAAkC,EACrC,MAAM,WAAW,CAAC;AAEnB,mFAAmF;AACnF,sBAAsB;AACtB,mFAAmF;AAEnF,OAAO;AACH,kBAAkB;AAClB,aAAa;AAKb,sBAAsB;AACtB,WAAW,EACX,uBAAuB,EAC1B,MAAM,aAAa,CAAC;AAErB,mFAAmF;AACnF,uBAAuB;AACvB,mFAAmF;AAEnF,OAAO;AACH,uBAAuB;AACvB,aAAa,EACb,yBAAyB,EAC5B,MAAM,eAAe,CAAC;AAUvB,mFAAmF;AACnF,sBAAsB;AACtB,mFAAmF;AAEnF,OAAO;AAcH,YAAY;AACZ,WAAW,EACX,uBAAuB,EACvB,QAAQ,EACR,oBAAoB,EACpB,UAAU,EACV,sBAAsB,EACzB,MAAM,SAAS,CAAC;AAEjB,mFAAmF;AACnF,oBAAoB;AACpB,mFAAmF;AAEnF,OAAO,EACH,eAAe,EACf,aAAa,EACb,kBAAkB,EAClB,UAAU,EACb,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,mCAAmC;AACnC,EAAE;AACF,oEAAoE;AACpE,0EAA0E;AAC1E,EAAE;AACF,6DAA6D;AAC7D,oDAAoD;AAEpD;;;;GAIG;AAEH,mFAAmF;AACnF,sDAAsD;AACtD,mFAAmF;AAEnF,OAAO;AACH,UAAU;AACV,YAAY,EACZ,UAAU,EACV,cAAc,EACd,aAAa,EACb,WAAW,EACX,MAAM,EACN,OAAO;AAEP,iBAAiB;AACjB,UAAU;AAkBV,mBAAmB;AACnB,sBAAsB,EACtB,oBAAoB,EACvB,MAAM,eAAe,CAAC;AAEvB,mFAAmF;AACnF,sBAAsB;AACtB,mFAAmF;AAEnF,OAAO;AAIH,iBAAiB;AACjB,SAAS,EACT,qBAAqB,EACrB,iBAAiB,EACjB,6BAA6B;AAE7B,YAAY;AACZ,iBAAiB,EACjB,6BAA6B;AAE7B,cAAc;AACd,mBAAmB,EACnB,+BAA+B,EAC/B,oBAAoB,EACpB,gCAAgC,EACnC,MAAM,aAAa,CAAC;AAErB,mFAAmF;AACnF,oBAAoB;AACpB,mFAAmF;AAEnF,OAAO;AAIH,oBAAoB;AACpB,mBAAmB,EACnB,+BAA+B,EAC/B,YAAY,EACZ,wBAAwB,EACxB,gBAAgB,EAChB,4BAA4B,EAC5B,sBAAsB,EACtB,kCAAkC,EACrC,MAAM,WAAW,CAAC;AAEnB,mFAAmF;AACnF,sBAAsB;AACtB,mFAAmF;AAEnF,OAAO;AACH,kBAAkB;AAClB,aAAa;AAKb,sBAAsB;AACtB,WAAW,EACX,uBAAuB,EAC1B,MAAM,aAAa,CAAC;AAErB,mFAAmF;AACnF,uBAAuB;AACvB,mFAAmF;AAEnF,OAAO;AACH,uBAAuB;AACvB,aAAa,EACb,yBAAyB,EAC5B,MAAM,eAAe,CAAC;AAUvB,mFAAmF;AACnF,sBAAsB;AACtB,mFAAmF;AAEnF,OAAO;AAcH,YAAY;AACZ,WAAW,EACX,uBAAuB,EACvB,QAAQ,EACR,oBAAoB,EACpB,UAAU,EACV,sBAAsB,EACzB,MAAM,SAAS,CAAC;AAEjB,mFAAmF;AACnF,2BAA2B;AAC3B,mFAAmF;AAEnF,OAAO;AAWH,YAAY;AACZ,gBAAgB,EAChB,4BAA4B,EAC/B,MAAM,kBAAkB,CAAC;AAE1B,mFAAmF;AACnF,oBAAoB;AACpB,mFAAmF;AAEnF,OAAO,EACH,eAAe,EACf,aAAa,EACb,kBAAkB,EAClB,UAAU,EACb,MAAM,aAAa,CAAC"}

package/lib/esm/index.mjs

@@ -58,6 +58,12 @@ 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/types/data-aggregate.d.ts

@@ -0,0 +1,139 @@
+import { Observable } from 'rxjs';
+/**
+ * TransformType specifies the type of transformation to apply to a group field.
+ */
+export type TransformType = 'Year' | 'Month' | 'Week' | 'Day' | 'Hour' | 'Minute' | 'Substring';
+/**
+ * AggregationType specifies the type of aggregation to perform on a field.
+ */
+export type AggregationType = 'Average' | 'Count' | 'Sum' | 'Max' | 'Min' | 'Median';
+/**
+ * AggregationGroupTransform represents a transform function with parameters to be applied to a group field.
+ */
+export interface AggregationGroupTransform {
+    /** The transformation function to apply */
+    transform: TransformType;
+    /** Arguments for the transformation function */
+    args?: {
+        [key: string]: any;
+    };
+}
+/**
+ * AggregationGroup defines a grouping field with optional transforms and sort direction.
+ */
+export interface AggregationGroup {
+    /** The field to group by (can include relationship paths with dots, e.g. "customer.lastName") */
+    groupField: string;
+    /** Sort direction for this group ('asc' or 'desc') */
+    groupDirection: 'asc' | 'desc';
+    /** Optional transforms to apply to the grouping field */
+    transforms?: AggregationGroupTransform[];
+}
+/**
+ * AggregationSort defines a secondary sort field for aggregated results.
+ */
+export interface AggregationSort {
+    /** The field to sort by (can include relationship paths with dots) */
+    sortField: string;
+    /** Sort direction ('asc' or 'desc') */
+    sortDirection: 'asc' | 'desc';
+    /** The aggregation type to sort by (must match an aggregation in the request) */
+    sortAggregation: AggregationType;
+}
+/**
+ * Aggregation defines an aggregation operation to perform on a field.
+ */
+export interface Aggregation {
+    /** The aggregation function to apply ('Average', 'Count', 'Sum', 'Max', 'Min', 'Median') */
+    aggregation: AggregationType;
+    /** The field to aggregate (can include relationship paths with dots) */
+    aggregationField: string;
+}
+/**
+ * AggregationRequest defines the parameters for an aggregation query.
+ * The data scope is controlled by parentDataElementId, parentKey, and dataElementId.
+ */
+export interface AggregationRequest {
+    /**
+     * The ID of the data element to aggregate.
+     */
+    dataElementId: string;
+    /**
+     * The ID of the parent data element that defines the overall scope of records.
+     * The dataElementId must be related to this through a foreign key or key array.
+     */
+    parentDataElementId?: string;
+    /**
+     * The key of a parent 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 data element that defines
+     * the relationship to the parent. If omitted, a derived key is assumed.
+     */
+    parentKeyField?: string;
+    /**
+     * Filter expression to limit records before aggregation.
+     * @see the filter-expressions module for filter syntax and examples
+     */
+    filter?: string;
+    /**
+     * List of grouping specifications. Groups are formed by field values with optional transforms.
+     * Results will be grouped by these fields in the order specified.
+     */
+    groups: AggregationGroup[];
+    /**
+     * List of secondary sort specifications for the aggregated results.
+     * Groups are the primary sorts; these are additional sorting criteria.
+     */
+    sort?: AggregationSort[];
+    /**
+     * List of aggregation operations to perform on the grouped data.
+     */
+    aggregations: Aggregation[];
+}
+/**
+ * AggregationResponse wraps the aggregated data results.
+ */
+export interface AggregationResponse {
+    /** The aggregated data results */
+    data: any[];
+}
+/**
+ * Performs data aggregation operations (count, sum, average, etc.) on grouped data.
+ * Supports filtering, grouping with transforms, sorting, and multiple aggregations.
+ *
+ * @param request - Aggregation configuration including dataElementId, parent scope, groups, aggregations
+ * @returns Promise<AggregationResponse> with aggregated data array
+ *
+ * @example
+ * const results = await getAggregateData({
+ *   dataElementId: 'order',
+ *   parentDataElementId: 'company',
+ *   parentKey: orgProxyKey,
+ *   groups: [{
+ *     groupField: 'status',
+ *     groupDirection: 'asc'
+ *   }],
+ *   aggregations: [{
+ *     aggregation: 'Count',
+ *     aggregationField: 'objKey'
+ *   }, {
+ *     aggregation: 'Sum',
+ *     aggregationField: 'totalAmount'
+ *   }]
+ * });
+ */
+export declare function getAggregateData(request: AggregationRequest): Promise<AggregationResponse>;
+/**
+ * Observable version of getAggregateData. See getAggregateData for details.
+ *
+ * @example
+ * getAggregateDataAsObservable({
+ *   dataElementId: 'order',
+ *   groups: [{ groupField: 'status', groupDirection: 'asc' }],
+ *   aggregations: [{ aggregation: 'Count', aggregationField: 'objKey' }]
+ * }).subscribe(response => console.log(response.data));
+ */
+export declare function getAggregateDataAsObservable(request: AggregationRequest): Observable<AggregationResponse>;

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

@@ -10,4 +10,5 @@ export { MessageMethod, type MessageRequest, sendMessage, sendMessageAsObservabl
 export { getPreference, getPreferenceAsObservable } from './preferences';
 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 { type AggregationRequest, type AggregationResponse, type AggregationGroup, type AggregationSort, type Aggregation, type AggregationGroupTransform, type TransformType, type AggregationType, getAggregateData, getAggregateDataAsObservable } from './data-aggregate';
 export { sortObjectArray, compareValues, getValueFromObject, debounceFn } from './utilities';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@halix/action-sdk",
-  "version": "1.0.25",
+  "version": "1.0.26",
   "description": "Halix Platform action SDK",
   "types": "./lib/cjs/types/index.d.ts",
   "main": "./lib/cjs/index.js",