@adaptabletools/adaptable 12.1.7 → 12.1.8-canary.0

package/src/Utilities/Services/CalculatedColumnExpressionService.js

@@ -3,11 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CalculatedColumnExpressionService = void 0;
 const LoggingHelper_1 = require("../Helpers/LoggingHelper");
 const ModuleConstants_1 = require("../Constants/ModuleConstants");
-const scalarAggregationHelper_1 = require("../ExpressionFunctions/scalarAggregationHelper");
+const AggregatedScalarLiveValue_1 = require("./AggregatedScalarLiveValue");
 class CalculatedColumnExpressionService {
     constructor(adaptableApi) {
         this.adaptableApi = adaptableApi;
-        this.aggregatedScalarCalculatedColumnsMap = new Map();
+        this.aggregatedScalarLiveValuesMap = new Map();
         this.adaptableApi = adaptableApi;
         this.adaptableApi.internalApi
             .getDataService()
@@ -17,12 +17,12 @@ class CalculatedColumnExpressionService {
                 return;
             }
             const refreshedCalculatedColumns = [];
-            this.aggregatedScalarCalculatedColumnsMap.forEach((aggregatedScalarCalculatedColumn) => {
-                if (aggregatedScalarCalculatedColumn
-                    .getColumnDependencies()
-                    .includes(cellDataChangedInfo.column.columnId)) {
-                    aggregatedScalarCalculatedColumn.refreshAggregatedColumnValue();
-                    refreshedCalculatedColumns.push(aggregatedScalarCalculatedColumn.getCalculatedColumnId());
+            this.aggregatedScalarLiveValuesMap.forEach((aggregatedScalarLiveValue, calculatedColumnId) => {
+                const calculatedColumn = this.adaptableApi.calculatedColumnApi.getCalculatedColumnById(calculatedColumnId);
+                const columnDependencies = this.adaptableApi.calculatedColumnApi.getReferencedColumnIdsForCalculatedColumn(calculatedColumn);
+                if (columnDependencies.includes(cellDataChangedInfo.column.columnId)) {
+                    aggregatedScalarLiveValue.refresh();
+                    refreshedCalculatedColumns.push(calculatedColumn.ColumnId);
                 }
             });
             if (refreshedCalculatedColumns.length) {
@@ -31,9 +31,10 @@ class CalculatedColumnExpressionService {
         });
         this.adaptableApi.eventApi.on('GridDataChanged', () => {
             const refreshedCalculatedColumns = [];
-            this.aggregatedScalarCalculatedColumnsMap.forEach((aggregatedScalarCalculatedColumn) => {
-                aggregatedScalarCalculatedColumn.refreshAggregatedColumnValue();
-                refreshedCalculatedColumns.push(aggregatedScalarCalculatedColumn.getCalculatedColumnId());
+            this.aggregatedScalarLiveValuesMap.forEach((aggregatedScalarLiveValue, calculatedColumnId) => {
+                const calculatedColumn = this.adaptableApi.calculatedColumnApi.getCalculatedColumnById(calculatedColumnId);
+                aggregatedScalarLiveValue.refresh();
+                refreshedCalculatedColumns.push(calculatedColumn.ColumnId);
             });
             if (refreshedCalculatedColumns.length) {
                 this.adaptableApi.gridApi.refreshCells(null, refreshedCalculatedColumns);
@@ -41,9 +42,8 @@ class CalculatedColumnExpressionService {
         });
     }
     destroy() {
-        [...this.aggregatedScalarCalculatedColumnsMap.values()].forEach((aggregatedScalarCalculatedColumn) => aggregatedScalarCalculatedColumn.destroy());
-        this.aggregatedScalarCalculatedColumnsMap.clear();
-        this.aggregatedScalarCalculatedColumnsMap = null;
+        this.aggregatedScalarLiveValuesMap.clear();
+        this.aggregatedScalarLiveValuesMap = null;
     }
     getCalculatedColumnDataType(calculatedColumnQuery) {
         try {
@@ -99,21 +99,21 @@ class CalculatedColumnExpressionService {
         // if query has neither a ScalarExpression nor an AggregatedScalarExpression => it can only be false
         return false;
     }
-    evaluateCalculatedColumnQuery(calculatedColumn, node) {
+    evaluateCalculatedColumnQuery(calculatedColumn, rowNode) {
         var _a, _b, _c, _d, _e;
         try {
-            if (this.adaptableApi.gridApi.isGroupRowNode(node)) {
+            if (this.adaptableApi.gridApi.isGroupRowNode(rowNode)) {
                 return undefined;
             }
             // no validation here, this function has to be as performant as possible
             if ((_a = calculatedColumn === null || calculatedColumn === void 0 ? void 0 : calculatedColumn.Query) === null || _a === void 0 ? void 0 : _a.ScalarExpression) {
                 return this.adaptableApi.internalApi
                     .getQueryLanguageService()
-                    .evaluateScalarExpression(calculatedColumn.Query.ScalarExpression, ModuleConstants_1.CalculatedColumnModuleId, node);
+                    .evaluateScalarExpression(calculatedColumn.Query.ScalarExpression, ModuleConstants_1.CalculatedColumnModuleId, rowNode);
             }
             if ((_b = calculatedColumn === null || calculatedColumn === void 0 ? void 0 : calculatedColumn.Query) === null || _b === void 0 ? void 0 : _b.AggregatedScalarExpression) {
-                const aggregatedScalarCalculatedColumn = this.aggregatedScalarCalculatedColumnsMap.get(calculatedColumn.Uuid);
-                return aggregatedScalarCalculatedColumn === null || aggregatedScalarCalculatedColumn === void 0 ? void 0 : aggregatedScalarCalculatedColumn.getAggregatedColumnValue(node);
+                const aggregatedScalarLiveValue = this.aggregatedScalarLiveValuesMap.get(calculatedColumn.Uuid);
+                return aggregatedScalarLiveValue === null || aggregatedScalarLiveValue === void 0 ? void 0 : aggregatedScalarLiveValue.getAggregatedValueForRow(rowNode);
             }
         }
         catch (error) {
@@ -121,149 +121,24 @@ class CalculatedColumnExpressionService {
             return null;
         }
     }
-    createAggregatedScalarCalculatedColumn(calculatedColumn) {
-        var _a, _b;
+    createAggregatedScalarLiveValue(calculatedColumn) {
+        var _a, _b, _c;
         // if there is already an aggregated scalar, delete it (possible when editing)
-        this.destroyAggregatedScalarCalculatedColumn(calculatedColumn);
+        this.destroyAggregatedScalarLiveValue(calculatedColumn);
         if ((_a = calculatedColumn.Query) === null || _a === void 0 ? void 0 : _a.AggregatedScalarExpression) {
             try {
-                const aggregatedScalarCalculatedColumn = new AggregatedScalarCalculatedColumn(calculatedColumn, this.adaptableApi);
-                this.aggregatedScalarCalculatedColumnsMap.set(calculatedColumn.Uuid, aggregatedScalarCalculatedColumn);
+                const aggregatedScalarLiveValue = new AggregatedScalarLiveValue_1.AggregatedScalarLiveValue({
+                    aggregatedScalarExpression: (_b = calculatedColumn.Query) === null || _b === void 0 ? void 0 : _b.AggregatedScalarExpression,
+                }, ModuleConstants_1.CalculatedColumnModuleId, this.adaptableApi);
+                this.aggregatedScalarLiveValuesMap.set(calculatedColumn.Uuid, aggregatedScalarLiveValue);
             }
             catch (e) {
-                LoggingHelper_1.LogAdaptableError(`Creating CalculatedColumn ('${(_b = calculatedColumn.Query) === null || _b === void 0 ? void 0 : _b.AggregatedScalarExpression}') failed!\n${e.message}`);
+                LoggingHelper_1.LogAdaptableError(`Creating CalculatedColumn ('${(_c = calculatedColumn.Query) === null || _c === void 0 ? void 0 : _c.AggregatedScalarExpression}') failed!\n${e.message}`);
             }
         }
     }
-    destroyAggregatedScalarCalculatedColumn(calculatedColumn) {
-        var _a;
-        (_a = this.aggregatedScalarCalculatedColumnsMap.get(calculatedColumn.Uuid)) === null || _a === void 0 ? void 0 : _a.destroy();
-        this.aggregatedScalarCalculatedColumnsMap.delete(calculatedColumn.Uuid);
+    destroyAggregatedScalarLiveValue(calculatedColumn) {
+        this.aggregatedScalarLiveValuesMap.delete(calculatedColumn.Uuid);
     }
 }
 exports.CalculatedColumnExpressionService = CalculatedColumnExpressionService;
-class AggregatedScalarCalculatedColumn {
-    constructor(calculatedColumn, adaptableApi) {
-        this.calculatedColumn = calculatedColumn;
-        this.adaptableApi = adaptableApi;
-        const aggregationConfig = this.adaptableApi.internalApi
-            .getQueryLanguageService()
-            .evaluateAggregatedScalarExpression(calculatedColumn.Query.AggregatedScalarExpression, ModuleConstants_1.CalculatedColumnModuleId);
-        this.expressionEvaluation = aggregationConfig.value;
-        this.aggregationResult = this.computeAggregatedValue(this.expressionEvaluation);
-        // currently we support only one reducer
-        this.aggregationReducerName = Object.keys(this.expressionEvaluation.aggregationParams.reducers)[0];
-    }
-    destroy() {
-        this.expressionEvaluation = null;
-        this.calculatedColumn = null;
-        this.adaptableApi = null;
-        this.aggregationResult = null;
-    }
-    getAggregatedColumnValue(rowNode) {
-        const aggregationValue = this.getAggregationValue(rowNode);
-        if (this.expressionEvaluation.rowValueGetter) {
-            return this.expressionEvaluation.rowValueGetter(rowNode, aggregationValue);
-        }
-        return aggregationValue;
-    }
-    refreshAggregatedColumnValue() {
-        const aggregationConfig = this.adaptableApi.internalApi
-            .getQueryLanguageService()
-            .evaluateAggregatedScalarExpression(this.calculatedColumn.Query.AggregatedScalarExpression, ModuleConstants_1.CalculatedColumnModuleId);
-        this.expressionEvaluation = aggregationConfig.value;
-        this.aggregationResult = this.computeAggregatedValue(this.expressionEvaluation);
-    }
-    getCalculatedColumnId() {
-        return this.calculatedColumn.ColumnId;
-    }
-    getColumnDependencies() {
-        return this.expressionEvaluation.columnDependencies;
-    }
-    computeAggregatedValue(expressionEvaluation) {
-        var _a;
-        const gridRowNodes = this.adaptableApi.gridApi.getAllRowNodes();
-        // we iterate over the RowNode list (we need this to handle complex column values (nested values, valueGetters etc)
-        // so we will map the fieldNames to RowNode.data
-        const mapReducerValueGetter = (fieldName) => {
-            return (rowNode) => {
-                return this.adaptableApi.gridApi.getRawValueFromRowNode(rowNode, fieldName);
-            };
-        };
-        Object.values(expressionEvaluation.aggregationParams.reducers).forEach((aggregationReducer) => {
-            aggregationReducer.getter = mapReducerValueGetter(aggregationReducer.field);
-            // nullify the field to force the fallback on the getter fn
-            aggregationReducer.field = null;
-        });
-        const mapGroupByToKey = (fieldName) => {
-            return (_unusableProperty, rowNode) => this.adaptableApi.gridApi.getRawValueFromRowNode(rowNode, fieldName);
-        };
-        (_a = expressionEvaluation.aggregationParams.groupBy) === null || _a === void 0 ? void 0 : _a.forEach((groupByDef) => {
-            groupByDef.toKey = mapGroupByToKey(groupByDef.field);
-        });
-        if (!expressionEvaluation.cumulateOver) {
-            let aggregatedRowNodes = gridRowNodes;
-            if (expressionEvaluation.sortByColumn) {
-                const sortByColumn = expressionEvaluation.sortByColumn;
-                const getRowNodeValue = (rowNode, columnId) => this.adaptableApi.gridApi.getRawValueFromRowNode(rowNode, columnId);
-                if (expressionEvaluation.filterUndefinedValues) {
-                    aggregatedRowNodes = gridRowNodes.filter((node) => {
-                        const rowValue = getRowNodeValue(node, sortByColumn);
-                        return rowValue != undefined;
-                    });
-                }
-                // currently, we support only ascending sorting
-                aggregatedRowNodes.sort((first, second) => {
-                    const firstValue = getRowNodeValue(first, sortByColumn);
-                    const secondValue = getRowNodeValue(second, sortByColumn);
-                    if (firstValue < secondValue) {
-                        return -1;
-                    }
-                    if (firstValue > secondValue) {
-                        return 1;
-                    }
-                    return 0;
-                });
-            }
-            return scalarAggregationHelper_1.aggregate(expressionEvaluation.aggregationParams, aggregatedRowNodes);
-        }
-        else {
-            // 1. sort grid data by given OVER column
-            const sortByColumn = expressionEvaluation.cumulateOver;
-            const getRowNodeValue = (rowNode, columnId) => this.adaptableApi.gridApi.getRawValueFromRowNode(rowNode, columnId);
-            // currently, we support only ascending sorting
-            gridRowNodes.sort((first, second) => {
-                const firstValue = getRowNodeValue(first, sortByColumn);
-                const secondValue = getRowNodeValue(second, sortByColumn);
-                if (firstValue < secondValue) {
-                    return -1;
-                }
-                if (firstValue > secondValue) {
-                    return 1;
-                }
-                return 0;
-            });
-            // 2. add primary key column as the most specific groupBy
-            if (!expressionEvaluation.aggregationParams.groupBy) {
-                expressionEvaluation.aggregationParams.groupBy = [];
-            }
-            const gridPrimaryKeyColumn = this.adaptableApi.internalApi.getAdaptableOptions().primaryKey;
-            // !! aggregationParams mutated
-            expressionEvaluation.aggregationParams.groupBy.push({
-                field: gridPrimaryKeyColumn,
-                toKey: mapGroupByToKey(gridPrimaryKeyColumn),
-            });
-            // 3. cumulate
-            return scalarAggregationHelper_1.cumulate(expressionEvaluation.aggregationParams, gridRowNodes);
-        }
-    }
-    getAggregationValue(rowNode) {
-        var _a, _b;
-        if ((_a = this.expressionEvaluation.aggregationParams.groupBy) === null || _a === void 0 ? void 0 : _a.length) {
-            const groupColumns = this.expressionEvaluation.aggregationParams.groupBy.map((groupByParam) => groupByParam.field);
-            const groupKeys = groupColumns.map((groupColumnName) => this.adaptableApi.gridApi.getRawValueFromRowNode(rowNode, groupColumnName));
-            return (_b = this.aggregationResult.deepMap.get(groupKeys)) === null || _b === void 0 ? void 0 : _b.reducerResults[this.aggregationReducerName];
-        }
-        return this.aggregationResult.reducerResults[this.aggregationReducerName];
-    }
-}

package/src/Utilities/Services/Interface/ICalculatedColumnExpressionService.d.ts

@@ -5,6 +5,6 @@ export interface ICalculatedColumnExpressionService extends IAdaptableService {
     isCalculatedColumnQueryValid(calculatedColumnQuery: AdaptableCalculatedColumnQuery): boolean;
     evaluateCalculatedColumnQuery(calculatedColumn: CalculatedColumn, rowNode: RowNode): any;
     getCalculatedColumnDataType(calculatedColumnQuery: AdaptableCalculatedColumnQuery): 'String' | 'Number' | 'Boolean' | 'Date';
-    createAggregatedScalarCalculatedColumn(calculatedColumn: CalculatedColumn): void;
-    destroyAggregatedScalarCalculatedColumn(calculatedColumn: CalculatedColumn): void;
+    createAggregatedScalarLiveValue(calculatedColumn: CalculatedColumn): void;
+    destroyAggregatedScalarLiveValue(calculatedColumn: CalculatedColumn): void;
 }

package/src/Utilities/Services/Interface/IQueryLanguageService.d.ts

@@ -3,14 +3,15 @@ import { IAdaptableService } from './IAdaptableService';
 import { RowNode } from '@ag-grid-community/all-modules';
 import { CellDataChangedInfo } from '../../../PredefinedConfig/Common/CellDataChangedInfo';
 import { AdaptableModule } from '../../../PredefinedConfig/Common/Types';
-import { AggregationParameter } from '../../ExpressionFunctions/aggregatedScalarExpressionFunctions';
+import { ScalarAggregationParameter } from '../../ExpressionFunctions/aggregatedScalarExpressionFunctions';
 import { ModuleExpressionFunctions } from '../../../AdaptableOptions/AdaptableQLOptions';
+import { BooleanAggregationParameter } from '../../ExpressionFunctions/aggregatedBooleanExpressionFunctions';
 export interface IQueryLanguageService extends IAdaptableService {
     evaluateBooleanExpression(expression: string, module: AdaptableModule, rowNode: RowNode): boolean;
     evaluateScalarExpression(expression: string, module: AdaptableModule, rowNode: RowNode): any;
     evaluateObservableExpression(expression: string, module: AdaptableModule): Observable<CellDataChangedInfo>;
-    evaluateAggregatedBooleanExpression(expression: string, module: AdaptableModule): Observable<CellDataChangedInfo>;
-    evaluateAggregatedScalarExpression(expression: string, module: AdaptableModule): AggregationParameter;
+    evaluateAggregatedBooleanExpression(expression: string, module: AdaptableModule): BooleanAggregationParameter;
+    evaluateAggregatedScalarExpression(expression: string, module: AdaptableModule): ScalarAggregationParameter;
     validateBoolean(expression: string, module: AdaptableModule, config?: {
         force?: boolean;
     }): {
@@ -29,7 +30,9 @@ export interface IQueryLanguageService extends IAdaptableService {
         isValid: boolean;
         errorMessage: string;
     };
+    computeAggregatedBooleanValue(expression: string, module: AdaptableModule): boolean;
     getModuleExpressionFunctions(module: AdaptableModule): ModuleExpressionFunctions;
     getColumnsFromExpression(input: string): string[];
     getNamedQueryNamesFromExpression(input: string): string[];
+    isCumulativeAggregate(input: string): boolean;
 }

package/src/Utilities/Services/QueryLanguageService.d.ts

@@ -4,8 +4,9 @@ import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChang
 import { RowNode } from '@ag-grid-community/all-modules';
 import { AdaptableModule } from '../../PredefinedConfig/Common/Types';
 import { ModuleExpressionFunctions } from '../../AdaptableOptions/AdaptableQLOptions';
-import { AggregationParameter } from '../ExpressionFunctions/aggregatedScalarExpressionFunctions';
+import { ScalarAggregationParameter } from '../ExpressionFunctions/aggregatedScalarExpressionFunctions';
 import { AdaptableApi } from '../../../types';
+import { BooleanAggregationParameter } from '../ExpressionFunctions/aggregatedBooleanExpressionFunctions';
 export declare class QueryLanguageService implements IQueryLanguageService {
     private adaptableApi;
     private cacheBooleanValidation;
@@ -16,9 +17,9 @@ export declare class QueryLanguageService implements IQueryLanguageService {
     constructor(adaptableApi: AdaptableApi);
     evaluateBooleanExpression(expression: string, module: AdaptableModule, rowNode: any): any;
     evaluateScalarExpression(expression: string, module: AdaptableModule, rowNode: RowNode): any;
-    evaluateAggregatedScalarExpression(expression: string, module: AdaptableModule): AggregationParameter;
+    evaluateAggregatedScalarExpression(expression: string, module: AdaptableModule): ScalarAggregationParameter;
     evaluateObservableExpression(reactiveExpression: string, module: AdaptableModule): Observable<CellDataChangedInfo>;
-    evaluateAggregatedBooleanExpression(aggregationExpression: string, module: AdaptableModule): Observable<CellDataChangedInfo>;
+    evaluateAggregatedBooleanExpression(aggregationExpression: string, module: AdaptableModule): BooleanAggregationParameter;
     validateBoolean(expressionInput: string, module: AdaptableModule, config?: {
         force?: boolean;
     }): {
@@ -37,8 +38,10 @@ export declare class QueryLanguageService implements IQueryLanguageService {
         isValid: boolean;
         errorMessage: string;
     };
+    computeAggregatedBooleanValue(expression: string, module: AdaptableModule): boolean;
     getColumnsFromExpression(input?: string): string[];
     getNamedQueryNamesFromExpression(input?: string): string[];
+    isCumulativeAggregate(input: string): boolean;
     getModuleExpressionFunctions(module: AdaptableModule): ModuleExpressionFunctions;
     destroy(): void;
     private getBooleanAndScalarFunctions;

package/src/Utilities/Services/QueryLanguageService.js

@@ -5,6 +5,7 @@ const tslib_1 = require("tslib");
 const parser = tslib_1.__importStar(require("../../parser/src"));
 const rxjs_1 = require("rxjs");
 const LoggingHelper_1 = require("../Helpers/LoggingHelper");
+const AggregatedScalarLiveValue_1 = require("./AggregatedScalarLiveValue");
 class QueryLanguageService {
     constructor(adaptableApi) {
         this.adaptableApi = adaptableApi;
@@ -49,13 +50,13 @@ class QueryLanguageService {
     evaluateAggregatedBooleanExpression(aggregationExpression, module) {
         const moduleExpressionFunctions = this.getModuleExpressionFunctions(module);
         const booleanAndScalarFunctions = this.getBooleanAndScalarFunctions(moduleExpressionFunctions);
-        const aggregationExpression$ = parser.evaluate(aggregationExpression, {
+        const aggregationEvaluation = parser.evaluate(aggregationExpression, {
             node: aggregationExpression,
             adaptableApi: this.adaptableApi,
             functions: moduleExpressionFunctions.aggregatedBooleanFunctions,
             whereClauseFunctions: booleanAndScalarFunctions,
         });
-        return aggregationExpression$;
+        return aggregationEvaluation;
     }
     validateBoolean(expressionInput = '', module, config = { force: false }) {
         var _a;
@@ -170,15 +171,16 @@ class QueryLanguageService {
             return result;
         }
         try {
-            const aggregatedBooleanExpressionEvaluation = this.evaluateAggregatedBooleanExpression(expression, module);
-            if (!rxjs_1.isObservable(aggregatedBooleanExpressionEvaluation)) {
+            const evaluationResult = this.evaluateAggregatedBooleanExpression(expression, module);
+            if (evaluationResult.type !== 'aggregationBoolean') {
                 const result = {
                     isValid: false,
-                    errorMessage: `provided AggregatedBoolean expression does not evaluate to an Observable`,
+                    errorMessage: 'provided AggregatedBBoolean expression does not evaluate to a supported aggregation',
                 };
                 this.cacheAggregatedBooleanValidation.set(cacheKey, result);
                 return result;
             }
+            // no exception,so everything seems to be fine
             const result = { isValid: true, errorMessage: '' };
             this.cacheAggregatedBooleanValidation.set(cacheKey, result);
             return result;
@@ -208,7 +210,7 @@ class QueryLanguageService {
         }
         try {
             const evaluationResult = this.evaluateAggregatedScalarExpression(expression, module);
-            if (evaluationResult.type !== 'aggregation') {
+            if (evaluationResult.type !== 'aggregationScalar') {
                 const result = {
                     isValid: false,
                     errorMessage: 'provided AggregatedScalar expression does not evaluate to a supported aggregation',
@@ -230,12 +232,27 @@ class QueryLanguageService {
             return result;
         }
     }
+    computeAggregatedBooleanValue(expression, module) {
+        const booleanAggregationParameter = this.evaluateAggregatedBooleanExpression(expression, module);
+        const aggregatedScalarExpressionEvaluation = booleanAggregationParameter.scalarAggregation.value;
+        const aggregatedScalarLiveValue = new AggregatedScalarLiveValue_1.AggregatedScalarLiveValue({ aggregatedScalarExpressionEvaluation }, module, this.adaptableApi);
+        const allAggregationValues = aggregatedScalarLiveValue.getAllAggregationValues();
+        const numericOperand = booleanAggregationParameter.conditionValue;
+        const booleanConditionFn = booleanAggregationParameter.conditionFn;
+        return allAggregationValues.some((aggregationValue) => {
+            return booleanConditionFn(aggregationValue, numericOperand);
+        });
+    }
     getColumnsFromExpression(input = '') {
         return this.getNodesFromExpression(input, 'COL');
     }
     getNamedQueryNamesFromExpression(input = '') {
         return this.getNodesFromExpression(input, 'QUERY');
     }
+    isCumulativeAggregate(input) {
+        var _a;
+        return !!((_a = this.getNodesFromExpression(input, 'CUMUL')) === null || _a === void 0 ? void 0 : _a.length);
+    }
     // Returns the ExpressionFunctions available for the given Module as specified in the `QueryLanguageOptions.moduleExpressionFunctions`
     // if there are no specific functions defined, it falls back to the default values
     getModuleExpressionFunctions(module) {

package/src/Utilities/Services/ReportService.js

@@ -21,8 +21,8 @@ class ReportService {
                 return {
                     Uuid: Uuid_1.createUuid(),
                     Name: GeneralConstants_1.VISUAL_DATA_REPORT,
-                    ReportColumnScope: Enums_1.ReportColumnScope.VisibleColumns,
-                    ReportRowScope: Enums_1.ReportRowScope.VisibleRows,
+                    ReportColumnScope: 'VisibleColumns',
+                    ReportRowScope: 'VisibleRows',
                     Query: undefined,
                     IsReadOnly: true,
                 };
@@ -30,8 +30,8 @@ class ReportService {
                 return {
                     Uuid: Uuid_1.createUuid(),
                     Name: GeneralConstants_1.ALL_DATA_REPORT,
-                    ReportColumnScope: Enums_1.ReportColumnScope.AllColumns,
-                    ReportRowScope: Enums_1.ReportRowScope.AllRows,
+                    ReportColumnScope: 'AllColumns',
+                    ReportRowScope: 'AllRows',
                     Query: undefined,
                     IsReadOnly: true,
                 };
@@ -39,8 +39,8 @@ class ReportService {
                 return {
                     Uuid: Uuid_1.createUuid(),
                     Name: GeneralConstants_1.CURRENT_DATA_REPORT,
-                    ReportColumnScope: Enums_1.ReportColumnScope.VisibleColumns,
-                    ReportRowScope: Enums_1.ReportRowScope.VisibleRows,
+                    ReportColumnScope: 'VisibleColumns',
+                    ReportRowScope: 'VisibleRows',
                     Query: undefined,
                     IsReadOnly: true,
                 };
@@ -48,8 +48,8 @@ class ReportService {
                 return {
                     Uuid: Uuid_1.createUuid(),
                     Name: GeneralConstants_1.SELECTED_CELLS_REPORT,
-                    ReportColumnScope: Enums_1.ReportColumnScope.SelectedColumns,
-                    ReportRowScope: Enums_1.ReportRowScope.SelectedCellRows,
+                    ReportColumnScope: 'SelectedColumns',
+                    ReportRowScope: 'SelectedCellRows',
                     Query: undefined,
                     IsReadOnly: true,
                 };
@@ -57,8 +57,8 @@ class ReportService {
                 return {
                     Uuid: Uuid_1.createUuid(),
                     Name: GeneralConstants_1.SELECTED_ROWS_REPORT,
-                    ReportColumnScope: Enums_1.ReportColumnScope.VisibleColumns,
-                    ReportRowScope: Enums_1.ReportRowScope.SelectedRows,
+                    ReportColumnScope: 'VisibleColumns',
+                    ReportRowScope: 'SelectedRows',
                     Query: undefined,
                     IsReadOnly: true,
                 };
@@ -91,38 +91,43 @@ class ReportService {
     }
     GetReportColumnScopeShortDescription(report) {
         var _a, _b;
+        if (this.adaptableApi.exportApi.isCustomReport(report)) {
+            return ['[Custom Columns]'];
+        }
         switch (report.ReportColumnScope) {
-            case Enums_1.ReportColumnScope.AllColumns:
+            case 'AllColumns':
                 return ['[All Columns]'];
-            case Enums_1.ReportColumnScope.VisibleColumns:
+            case 'VisibleColumns':
                 return ['[Visible Columns]'];
-            case Enums_1.ReportColumnScope.SelectedColumns:
+            case 'SelectedColumns':
                 return ['[Selected Columns]'];
-            case Enums_1.ReportColumnScope.ScopeColumns:
+            case 'ScopeColumns':
                 if ('ColumnIds' in (report === null || report === void 0 ? void 0 : report.Scope)) {
                     return (_b = (_a = report.Scope.ColumnIds).map) === null || _b === void 0 ? void 0 : _b.call(_a, (columnId) => { var _a; return (_a = this.adaptableApi.columnApi.getFriendlyNameFromColumnId(columnId)) !== null && _a !== void 0 ? _a : columnId; });
                 }
                 return ['[Bespoke Columns]'];
-            case Enums_1.ReportColumnScope.CustomColumns:
-                return ['[Custom Columns]'];
         }
     }
     GetReportColumnScopeLongDescription(report) {
+        if (this.adaptableApi.exportApi.isCustomReport(report)) {
+            return '[Custom Columns]';
+        }
         switch (report.ReportColumnScope) {
-            case Enums_1.ReportColumnScope.AllColumns:
+            case 'AllColumns':
                 return '[All Columns]';
-            case Enums_1.ReportColumnScope.VisibleColumns:
+            case 'VisibleColumns':
                 return '[Visible Columns]';
-            case Enums_1.ReportColumnScope.SelectedColumns:
+            case 'SelectedColumns':
                 return '[Selected Columns]';
-            case Enums_1.ReportColumnScope.ScopeColumns:
+            case 'ScopeColumns':
                 return this.adaptableApi.scopeApi.getScopeDescription(report.Scope);
-            case Enums_1.ReportColumnScope.CustomColumns:
-                return '[Custom Columns]';
         }
     }
     GetReportExpressionDescription(report, cols) {
         var _a;
+        if (this.adaptableApi.exportApi.isCustomReport(report)) {
+            return '[Custom Data]';
+        }
         if (this.IsSystemReport(report.Name)) {
             if (report.Name == GeneralConstants_1.ALL_DATA_REPORT) {
                 return '[All Data]';
@@ -142,38 +147,39 @@ class ReportService {
         }
         else {
             switch (report.ReportRowScope) {
-                case Enums_1.ReportRowScope.AllRows:
+                case 'AllRows':
                     return '[All Rows]';
-                case Enums_1.ReportRowScope.VisibleRows:
+                case 'VisibleRows':
                     return '[Visible Rows]';
-                case Enums_1.ReportRowScope.SelectedRows:
+                case 'SelectedRows':
                     return '[Selected Rows]';
-                case Enums_1.ReportRowScope.ExpressionRows:
+                case 'ExpressionRows':
                     return (_a = report.Query) === null || _a === void 0 ? void 0 : _a.BooleanExpression;
-                case Enums_1.ReportRowScope.CustomRows:
-                    return '[Custom Rows]';
             }
         }
     }
     GetReportColumnsForReport(report, includePrimaryKey = false) {
         let reportColumns = [];
         let gridColumns = this.adaptableApi.columnApi.getColumns();
+        if (this.adaptableApi.exportApi.isCustomReport(report)) {
+            return reportColumns;
+        }
         // first get the cols depending on the Column Scope
         switch (report.ReportColumnScope) {
-            case Enums_1.ReportColumnScope.AllColumns:
+            case 'AllColumns':
                 reportColumns = gridColumns;
                 break;
-            case Enums_1.ReportColumnScope.VisibleColumns:
+            case 'VisibleColumns':
                 reportColumns = gridColumns.filter((c) => c.visible);
                 break;
-            case Enums_1.ReportColumnScope.SelectedColumns:
+            case 'SelectedColumns':
                 // we extract the selected columns from the grid columns to preserve the grid column order
                 const selectedColumnIds = this.adaptableApi.gridApi
                     .getSelectedCellInfo()
                     .columns.map((column) => column.columnId);
                 reportColumns = gridColumns.filter((gridColumn) => selectedColumnIds.includes(gridColumn.columnId));
                 break;
-            case Enums_1.ReportColumnScope.ScopeColumns:
+            case 'ScopeColumns':
                 if ('ColumnIds' in report.Scope) {
                     reportColumns = report.Scope.ColumnIds.map((columnId) => this.adaptableApi.columnApi.getColumnFromId(columnId)).filter((c) => c);
                 }
@@ -181,9 +187,6 @@ class ReportService {
                     reportColumns = this.adaptableApi.scopeApi.getColumnsForScope(report.Scope);
                 }
                 break;
-            case Enums_1.ReportColumnScope.CustomColumns:
-                // nothing required if custom coluns
-                break;
         }
         if (includePrimaryKey) {
             const pkColumn = reportColumns.find((column) => column.columnId === this.adaptableApi.internalApi.getAdaptableOptions().primaryKey);
@@ -202,14 +205,16 @@ class ReportService {
             friendlyName: column.friendlyName,
             dataType: column.dataType,
         }));
-        if (ArrayExtensions_1.default.IsNullOrEmpty(columns) &&
-            report.ReportRowScope !== Enums_1.ReportRowScope.CustomRows) {
+        if (this.adaptableApi.exportApi.isCustomReport(report)) {
+            return this.adaptableApi.exportApi.runCustomReport(report.Name);
+        }
+        if (ArrayExtensions_1.default.IsNullOrEmpty(columns)) {
             return { columns: [], rows: [] };
         }
         const data = { columns, rows: [] };
         const columnIds = columns.map((column) => column.columnId);
         switch (report.ReportRowScope) {
-            case Enums_1.ReportRowScope.AllRows:
+            case 'AllRows':
                 this.adaptableApi.internalApi.forAllRowNodesDo((rowNode) => {
                     // skip row groups
                     if (!rowNode.group) {
@@ -217,7 +222,7 @@ class ReportService {
                     }
                 });
                 break;
-            case Enums_1.ReportRowScope.VisibleRows:
+            case 'VisibleRows':
                 this.adaptableApi.internalApi.forAllVisibleRowNodesDo((rowNode) => {
                     // skip row groups
                     if (!rowNode.group) {
@@ -225,7 +230,7 @@ class ReportService {
                     }
                 });
                 break;
-            case Enums_1.ReportRowScope.ExpressionRows:
+            case 'ExpressionRows':
                 this.adaptableApi.internalApi.forAllRowNodesDo((rowNode) => {
                     var _a;
                     if (this.adaptableApi.internalApi
@@ -235,7 +240,7 @@ class ReportService {
                     }
                 });
                 break;
-            case Enums_1.ReportRowScope.SelectedCellRows:
+            case 'SelectedCellRows':
                 const selectedCellInfo = this.adaptableApi.gridApi.getSelectedCellInfo();
                 const { gridCells: GridCells } = selectedCellInfo;
                 let selectedCellsByPrimaryKey = groupBy_1.default(GridCells, 'primaryKeyValue');
@@ -255,7 +260,7 @@ class ReportService {
                     }
                 });
                 break;
-            case Enums_1.ReportRowScope.SelectedRows:
+            case 'SelectedRows':
                 const selectedRowInfo = this.adaptableApi.gridApi.getSelectedRowInfo();
                 const selectedGridRowPrimaryKeys = (_b = (_a = selectedRowInfo === null || selectedRowInfo === void 0 ? void 0 : selectedRowInfo.gridRows) === null || _a === void 0 ? void 0 : _a.filter((gr) => gr.rowInfo.isGroup == false).map((gridRow) => gridRow.primaryKeyValue)) !== null && _b !== void 0 ? _b : [];
                 if (selectedGridRowPrimaryKeys.length) {
@@ -267,10 +272,6 @@ class ReportService {
                     });
                 }
                 break;
-            case Enums_1.ReportRowScope.CustomRows:
-                const reportData = this.adaptableApi.exportApi.runCustomReport(report.Name);
-                return reportData;
-            //  break;
         }
         return data;
     }