@adaptabletools/adaptable 12.1.7 → 12.1.8-canary.0

package/src/Redux/Store/AdaptableStore.js

@@ -575,7 +575,7 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                     aggregatedCalculatedColumns.forEach((calculatedColumn) => {
                         adaptable.api.internalApi
                             .getCalculatedColumnExpressionService()
-                            .createAggregatedScalarCalculatedColumn(calculatedColumn);
+                            .createAggregatedScalarLiveValue(calculatedColumn);
                     });
                     // refresh calculated columns
                     const aggCalculatedColumnIds = aggregatedCalculatedColumns.map((calculatedColumn) => calculatedColumn.ColumnId);
@@ -596,7 +596,7 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                         returnAction.type === CalculatedColumnRedux.CALCULATED_COLUMN_EDIT) {
                         adaptable.api.internalApi
                             .getCalculatedColumnExpressionService()
-                            .createAggregatedScalarCalculatedColumn(returnAction.calculatedColumn);
+                            .createAggregatedScalarLiveValue(returnAction.calculatedColumn);
                     }
                     adaptable.updateColDefsForSpecialColumns();
                     return returnAction;
@@ -621,7 +621,7 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                     const returnAction = next(actionTyped);
                     adaptable.api.internalApi
                         .getCalculatedColumnExpressionService()
-                        .destroyAggregatedScalarCalculatedColumn(returnAction.calculatedColumn);
+                        .destroyAggregatedScalarLiveValue(returnAction.calculatedColumn);
                     adaptable.updateColDefsForSpecialColumns();
                     return returnAction;
                 }
@@ -721,7 +721,11 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                 case LayoutRedux.LAYOUT_COLUMN_FILTER_EDIT:
                 case LayoutRedux.LAYOUT_COLUMN_FILTER_SET:
                 case LayoutRedux.LAYOUT_COLUMN_FILTER_CLEAR:
-                case LayoutRedux.LAYOUT_COLUMN_FILTER_CLEAR_ALL: {
+                case LayoutRedux.LAYOUT_COLUMN_FILTER_CLEAR_ALL:
+                case LayoutRedux.LAYOUT_COLUMN_FILTER_SUSPEND:
+                case LayoutRedux.LAYOUT_COLUMN_FILTER_SUSPEND_ALL:
+                case LayoutRedux.LAYOUT_COLUMN_FILTER_UNSUSPEND:
+                case LayoutRedux.LAYOUT_COLUMN_FILTER_UNSUSPEND_ALL: {
                     let returnAction;
                     // needs to be called before 'next' so previous and next column filters are known
                     const shouldTriggerGridFiltering = adaptable.api.filterApi.shouldNewColumnFilterTriggerGridFiltering(action);
@@ -868,6 +872,8 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                 case LayoutRedux.LAYOUT_SET_COLUMN_CAPTION:
                 case LayoutRedux.LAYOUT_SELECT: {
                     const oldLayoutState = middlewareAPI.getState().Layout;
+                    // this must be called before 'next(action)'
+                    const previousLayout = adaptable.api.layoutApi.getCurrentLayout();
                     let returnAction = next(action);
                     const newLayoutState = middlewareAPI.getState().Layout;
                     adaptable.api.layoutApi.fireLayoutChangedEvent(action.type, oldLayoutState, newLayoutState);
@@ -906,9 +912,12 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                     }
                     // when changing current layout via the api, the layout should update
                     if (returnAction.type == LayoutRedux.LAYOUT_SAVE) {
-                        const currentLayout = adaptable.api.layoutApi.getCurrentLayout();
                         const savingLayout = returnAction.layout;
-                        if (currentLayout.Name === savingLayout.Name) {
+                        if (previousLayout.Name === savingLayout.Name &&
+                            previousLayout !== savingLayout &&
+                            // objects may have changed, but have the same contents
+                            // this prevents pivot layout from infinite set-layout
+                            !adaptable.api.layoutApi.areLayoutsEqual(previousLayout, savingLayout)) {
                             adaptable.setLayout(savingLayout);
                         }
                     }

package/src/Strategy/AlertModule.d.ts

@@ -22,6 +22,7 @@ export declare class AlertModule extends AdaptableModuleBase implements IModule
     private getAlertDefinitionsForCellDataChange;
     private getAlertDefinitionsForGridDataChange;
     private getBaseAlertDefinitionsForDataChange;
+    private isAggregationAlertTriggered;
     private isAlertPredicateTriggered;
     private isAlertDefinitionForRowChangeEvent;
     getTeamSharingAction(): TeamSharingImportInfo<AlertDefinition>;

package/src/Strategy/AlertModule.js

@@ -18,6 +18,7 @@ const AlertEmptyView_1 = require("../View/Alert/AlertEmptyView");
 const AlertStatusSubPanel_1 = require("../View/Alert/AlertStatusSubPanel");
 const getObjectTagsViewItems_1 = require("./Utilities/getObjectTagsViewItems");
 const ActiveAlertsPanelItemLabel_1 = require("../View/Alert/ActiveAlertsPanelItemLabel");
+const ModuleConstants_1 = require("../Utilities/Constants/ModuleConstants");
 class AlertModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.AlertModuleId, ModuleConstants.AlertModuleFriendlyName, 'alert', 'AlertPopup', 'Get notified when things happen in Adaptable that you need to know about', api);
@@ -215,6 +216,14 @@ class AlertModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                         triggeredAlerts.push(alertDefinition);
                     }
                 }
+                else if (alertDefinition.Rule.AggregatedBooleanExpression) {
+                    const isValidExpression = this.api.queryLanguageApi.isValidAggregatedBooleanExpression(alertDefinition.Rule.AggregatedBooleanExpression, this.moduleInfo.ModuleName, `Invalid Alert boolean expression '${alertDefinition.Rule.AggregatedBooleanExpression}'`);
+                    const isSatisfiedExpression = isValidExpression &&
+                        this.isAggregationAlertTriggered(alertDefinition, dataChangedEvent);
+                    if (isSatisfiedExpression) {
+                        triggeredAlerts.push(alertDefinition);
+                    }
+                }
                 else {
                     if (!this.isAlertDefinitionForRowChangeEvent(alertDefinition) &&
                         this.isAlertPredicateTriggered(alertDefinition, dataChangedEvent, defaultNoPredicateReturn)) {
@@ -225,6 +234,17 @@ class AlertModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         }
         return triggeredAlerts;
     }
+    isAggregationAlertTriggered(alertDefinition, dataChangedEvent) {
+        const changedColumn = dataChangedEvent.column.columnId;
+        const aggregationColumns = this.api.queryLanguageApi.getColumnsFromExpression(alertDefinition.Rule.AggregatedBooleanExpression);
+        if (!aggregationColumns.includes(changedColumn)) {
+            return false;
+        }
+        const aggregatedBooleanValue = this.api.internalApi
+            .getQueryLanguageService()
+            .computeAggregatedBooleanValue(alertDefinition.Rule.AggregatedBooleanExpression, ModuleConstants_1.AlertModuleId);
+        return aggregatedBooleanValue;
+    }
     isAlertPredicateTriggered(alert, dataChangedEvent, defaultNoPredicateReturn = false) {
         return this.api.predicateApi.handlePredicate(alert.Rule.Predicate, {
             value: dataChangedEvent.newValue,

package/src/Strategy/CalculatedColumnModule.js

@@ -8,9 +8,9 @@ const CalculatedColumnRedux = tslib_1.__importStar(require("../Redux/ActionsRedu
 const LoggingHelper_1 = require("../Utilities/Helpers/LoggingHelper");
 const getExpressionViewItems_1 = require("./Utilities/getExpressionViewItems");
 const CalculatedColumnWizard_1 = require("../View/CalculatedColumn/Wizard/CalculatedColumnWizard");
-const getCalculatedColumnSettingTags_1 = require("../View/CalculatedColumn/Utilities/getCalculatedColumnSettingTags");
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../Utilities/Extensions/ArrayExtensions"));
 const getObjectTagsViewItems_1 = require("./Utilities/getObjectTagsViewItems");
+const getCalculatedColumnSettingsTags_1 = require("../View/CalculatedColumn/Utilities/getCalculatedColumnSettingsTags");
 class CalculatedColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.CalculatedColumnModuleId, ModuleConstants.CalculatedColumnFriendlyName, 'calculated-column', 'CalculatedColumnPopup', 'Create bespoke columns whose cell value is derived dynamically from an Expression', api);
@@ -69,7 +69,7 @@ class CalculatedColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         };
     }
     toView(calculateColumn) {
-        const settingsTags = getCalculatedColumnSettingTags_1.getCalculatedColumnSettingTags(calculateColumn.CalculatedColumnSettings);
+        const settingsTags = getCalculatedColumnSettingsTags_1.getCalculatedColumnSettingsTags(calculateColumn.CalculatedColumnSettings);
         let items = [
             {
                 name: 'Settings',

package/src/Strategy/ExportModule.d.ts

@@ -12,7 +12,6 @@ export declare class ExportModule extends AdaptableModuleBase implements IExport
     getModuleAdaptableObjects(): AdaptableObject[];
     getExplicitlyReferencedColumnIds(report: Report): string[];
     getReferencedNamedQueryNames(report: Report): string[];
-    updateOldConfig(): void;
     addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
     export(report: Report, exportDestination: ExportDestination | string): void;
     private isCustomDestination;

package/src/Strategy/ExportModule.js

@@ -9,7 +9,6 @@ const Helper_1 = require("../Utilities/Helpers/Helper");
 const ExportRedux = tslib_1.__importStar(require("../Redux/ActionsReducers/ExportRedux"));
 const GeneralConstants_1 = require("../Utilities/Constants/GeneralConstants");
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../Utilities/Extensions/ArrayExtensions"));
-const LoggingHelper_1 = require("../Utilities/Helpers/LoggingHelper");
 const StringExtensions_1 = tslib_1.__importDefault(require("../Utilities/Extensions/StringExtensions"));
 const PopupRedux = tslib_1.__importStar(require("../Redux/ActionsReducers/PopupRedux"));
 const ObjectFactory_1 = require("../Utilities/ObjectFactory");
@@ -41,21 +40,6 @@ class ExportModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         }
         return this.api.queryApi.getReferencedNamedQueryNames(report.Query.BooleanExpression);
     }
-    updateOldConfig() {
-        let reportsToEdit = [];
-        this.api.exportApi.getAllReports().forEach((report) => {
-            if (!report.Query && report.Expression) {
-                report.Query = {
-                    BooleanExpression: report.Expression,
-                };
-                LoggingHelper_1.LogAdaptableWarning(`Updating incorrect Predefined Config for Report: ${report.Name}`);
-                report.Expression = undefined;
-                LoggingHelper_1.LogAdaptableInfo('Updating Report: ' + report.Name + ' to use existing Expression');
-                reportsToEdit.push(report);
-            }
-        });
-        this.api.exportApi.editReports(reportsToEdit);
-    }
     addContextMenuItems(menuContext) {
         const canExport = !menuContext.isRowGroupColumn &&
             this.isModuleAvailable() &&

package/src/Strategy/FilterModule.js

@@ -111,6 +111,12 @@ class FilterModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     getViewProperties() {
         const api = this.api;
         return {
+            getSuspendAction: (columnFilter) => LayoutRedux.LayoutColumnFilterSuspend(columnFilter),
+            getUnSuspendAction: (columnFilter) => LayoutRedux.LayoutColumnFilterUnSuspend(columnFilter),
+            getCompactSuspendAction: (columnFilter) => LayoutRedux.LayoutColumnFilterSuspend(columnFilter),
+            getCompactUnSuspendAction: (columnFilter) => LayoutRedux.LayoutColumnFilterUnSuspend(columnFilter),
+            getSuspendAllAction: () => LayoutRedux.LayoutColumnFilterSuspendAll(),
+            getUnSuspendAllAction: () => LayoutRedux.LayoutColumnFilterUnSuspendAll(),
             getDeleteAction: LayoutRedux.LayoutColumnFilterClear,
             getCompactDeleteAction: LayoutRedux.LayoutColumnFilterClear,
             getDeleteAllAction: LayoutRedux.LayoutColumnFilterClearAll,

package/src/Strategy/Interface/IModule.d.ts

@@ -93,6 +93,10 @@ export interface AdaptableModuleView {
     getCompactDeleteAction?: (abObject: AdaptableObject) => Redux.Action;
     getSuspendAction?: (abObject: AdaptableObject) => Redux.Action;
     getUnSuspendAction?: (abObject: AdaptableObject) => Redux.Action;
+    getCompactSuspendAction?: (abObject: AdaptableObject) => Redux.Action;
+    getCompactUnSuspendAction?: (abObject: AdaptableObject) => Redux.Action;
+    getSuspendAllAction?: () => Redux.Action;
+    getUnSuspendAllAction?: () => Redux.Action;
     getDeleteAllAction?: () => Redux.Action;
     emptyView?: React.FunctionComponent<{
         module: IModule;

package/src/Strategy/LayoutModule.js

@@ -14,6 +14,7 @@ const SaveLayoutButton_1 = require("../View/Layout/SaveLayoutButton");
 const LayoutWizard_1 = require("../View/Layout/Wizard/LayoutWizard");
 const getLayoutFilterViewItems_1 = require("./Utilities/Layout/getLayoutFilterViewItems");
 const getLayoutSortViewItems_1 = require("./Utilities/Layout/getLayoutSortViewItems");
+const AggregationColumns_1 = require("../PredefinedConfig/Common/AggregationColumns");
 class LayoutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.LayoutModuleId, ModuleConstants.LayoutFriendlyName, 'layout', 'LayoutPopup', 'Named sets of column visibility, order, groupings, aggregation, pivots etc.', api);
@@ -26,26 +27,6 @@ class LayoutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             }
         });
     }
-    /*
-  // commenting this out as it doesnt make sense we dont know which filters should be applied to which layout
-  // for this we will jsut say they need to reapply them
-    updateOldConfig() {
-      // @ts-ignore ignore reading deprecated state
-      const oldColumnFilters = this.api.filterApi.getFilterState().ColumnFilters;
-      if (ArrayExtensions.IsNotNullOrEmpty(oldColumnFilters)) {
-        ConsoleLogWarning(
-          `DEPRECATED: The 'Filter.ColumnFilters' property is deprecated; use 'Layout.ColumnFilters' instead'!`
-        );
-  
-        this.api.internalApi.clearColumnFilterState();
-        const currentLayout = this.api.layoutApi.getCurrentLayout();
-  
-        if (ArrayExtensions.IsNullOrEmpty(currentLayout.ColumnFilters)) {
-          this.api.layoutApi.setColumnFilter(oldColumnFilters);
-        }
-      }
-    }
-    */
     getModuleAdaptableObjects() {
         return this.api.layoutApi.getAllLayout();
     }
@@ -264,6 +245,25 @@ class LayoutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                     name: 'Pivot Columns',
                     values: layout.PivotColumns.map((colId) => columnIdToFriendlyName(colId)),
                 },
+                (layout === null || layout === void 0 ? void 0 : layout.AggregationColumns) &&
+                    Object.keys(layout === null || layout === void 0 ? void 0 : layout.AggregationColumns).length && {
+                    name: 'Aggregation Columns',
+                    values: Object.entries(layout === null || layout === void 0 ? void 0 : layout.AggregationColumns)
+                        .map(([colId, aggFn]) => {
+                        if (colId === 'Source' || colId === 'Uuid') {
+                            return '';
+                        }
+                        let aggFnName = '';
+                        if (typeof aggFn === 'string') {
+                            aggFnName = aggFn;
+                        }
+                        else if (typeof aggFn === 'object' && aggFn.type === 'weightedAverage') {
+                            aggFnName = AggregationColumns_1.WEIGHTED_AVERAGE_AGG_FN_NAME;
+                        }
+                        return `${aggFnName}(${columnIdToFriendlyName(colId)})`;
+                    })
+                        .filter(Boolean),
+                },
             ].filter(Boolean),
             abObject: layout,
         };

package/src/Strategy/Utilities/FormatColumn/getFormatColumnStyleViewItems.js

@@ -6,6 +6,21 @@ const React = tslib_1.__importStar(require("react"));
 const rebass_1 = require("rebass");
 const FormatColumnStyleWizardSection_1 = require("../../../View/FormatColumn/Wizard/FormatColumnStyleWizardSection");
 const getFormatColumnStyleViewItems = (formatColumn, api) => {
-    return React.createElement(rebass_1.Box, { mt: 2 }, FormatColumnStyleWizardSection_1.renderFormatColumnStyleSummary(formatColumn, api));
+    var _a, _b;
+    let styleType = '';
+    if ((_a = formatColumn === null || formatColumn === void 0 ? void 0 : formatColumn.ColumnStyle) === null || _a === void 0 ? void 0 : _a.GradientStyle) {
+        styleType = 'Gradient';
+    }
+    else if ((_b = formatColumn === null || formatColumn === void 0 ? void 0 : formatColumn.ColumnStyle) === null || _b === void 0 ? void 0 : _b.PercentBarStyle) {
+        styleType = 'Percent Bar';
+    }
+    else {
+        styleType = 'Standard';
+    }
+    return (React.createElement(rebass_1.Box, { mt: 2 },
+        React.createElement(rebass_1.Box, { mb: 1 },
+            "Type: ",
+            styleType),
+        FormatColumnStyleWizardSection_1.renderFormatColumnStyleSummary(formatColumn, api)));
 };
 exports.getFormatColumnStyleViewItems = getFormatColumnStyleViewItems;

package/src/Strategy/Utilities/Layout/getLayoutFilterViewItems.js

@@ -8,17 +8,21 @@ const getLayoutFilterViewItems = (layout, api) => {
     };
     return {
         name: 'Filter',
-        values: ((_a = layout.ColumnFilters) !== null && _a !== void 0 ? _a : []).map((customFilter) => `[${columnIdToFriendlyName(customFilter.ColumnId)}: ${customFilter.Predicate.PredicateId} ${customFilter.Predicate.Inputs.map((input) => {
-            if (typeof input === 'string') {
-                return input;
-            }
-            if (typeof (input === null || input === void 0 ? void 0 : input.toString) === 'function') {
-                return input.toString();
-            }
-            return '';
-        })
-            .filter(Boolean)
-            .join(', ')}]`),
+        values: ((_a = layout.ColumnFilters) !== null && _a !== void 0 ? _a : []).map((customFilter) => {
+            var _a, _b;
+            return `[${columnIdToFriendlyName(customFilter.ColumnId)}: ${customFilter.Predicate.PredicateId} ${((_b = (_a = customFilter.Predicate) === null || _a === void 0 ? void 0 : _a.Inputs) !== null && _b !== void 0 ? _b : [])
+                .map((input) => {
+                if (typeof input === 'string') {
+                    return input;
+                }
+                if (typeof (input === null || input === void 0 ? void 0 : input.toString) === 'function') {
+                    return input.toString();
+                }
+                return '';
+            })
+                .filter(Boolean)
+                .join(', ')}]`;
+        }),
     };
 };
 exports.getLayoutFilterViewItems = getLayoutFilterViewItems;

package/src/Utilities/Constants/DocumentationLinkConstants.d.ts

@@ -5,6 +5,7 @@ export declare const ScalarQueryDocsLink: string;
 export declare const ObservableQueryDocsLink: string;
 export declare const AggregatedBooleanQueryDocsLink: string;
 export declare const AggregatedScalarQueryDocsLink: string;
+export declare const CumulativeAggregatedScalarQueryDocsLink: string;
 export declare const PredicateDocsLink: string;
 export declare const PrimaryKeyDocsLink: string;
 export declare const LicenseDocsLink: string;

package/src/Utilities/Constants/DocumentationLinkConstants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AdaptableOptionsDocsLink = exports.LicenseDocsLink = exports.PrimaryKeyDocsLink = exports.PredicateDocsLink = exports.AggregatedScalarQueryDocsLink = exports.AggregatedBooleanQueryDocsLink = exports.ObservableQueryDocsLink = exports.ScalarQueryDocsLink = exports.BooleanQueryDocsLink = exports.ExpressionEditorDocsLink = exports.HOST_URL_DOCS = void 0;
+exports.AdaptableOptionsDocsLink = exports.LicenseDocsLink = exports.PrimaryKeyDocsLink = exports.PredicateDocsLink = exports.CumulativeAggregatedScalarQueryDocsLink = exports.AggregatedScalarQueryDocsLink = exports.AggregatedBooleanQueryDocsLink = exports.ObservableQueryDocsLink = exports.ScalarQueryDocsLink = exports.BooleanQueryDocsLink = exports.ExpressionEditorDocsLink = exports.HOST_URL_DOCS = void 0;
 exports.HOST_URL_DOCS = 'https://docs.adaptabletools.com';
 //export const HOST_URL_DOCS = 'http://localhost:3000';
 exports.ExpressionEditorDocsLink = `${exports.HOST_URL_DOCS}/guide/ui-expression-editor`;
@@ -9,6 +9,7 @@ exports.ScalarQueryDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-expre
 exports.ObservableQueryDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-expression-observable`;
 exports.AggregatedBooleanQueryDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-expression-aggregation-boolean`;
 exports.AggregatedScalarQueryDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-expression-aggregation-scalar`;
+exports.CumulativeAggregatedScalarQueryDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-expression-aggregation-scalar#cumulative-aggregation`;
 exports.PredicateDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-predicate`;
 exports.PrimaryKeyDocsLink = `${exports.HOST_URL_DOCS}/guide/dev-guide-tutorial-primary-key`;
 exports.LicenseDocsLink = `${exports.HOST_URL_DOCS}/guide/licensing`;

package/src/Utilities/Defaults/DefaultAdaptableOptions.js

@@ -206,6 +206,8 @@ exports.DefaultAdaptableOptions = {
         systemFilters: AdaptablePredicate_1.SystemFilterPredicateIds,
         showQuickFilter: true,
         showDistinctFilteredValuesOnly: false,
+        showClearFilterButton: false,
+        showSuspendFilterButton: false,
     },
     searchOptions: {
         excludeColumnFromQuickSearch: undefined,

package/src/Utilities/ExpressionFunctions/aggregatedBooleanExpressionFunctions.d.ts

@@ -1,9 +1,19 @@
 import { ExpressionFunction } from '../../parser/src/types';
+import { BaseParameter } from './expressionFunctionUtils';
+import { AggregatedScalarExpressionEvaluation } from './aggregatedScalarExpressionFunctions';
 /**
  * List of all the Aggregation Functions available in AdaptableQL
  */
-export declare type AggregationFunctionName = 'WHERE' | 'COL' | AggregationFunction | ComparisonFunction;
-declare type AggregationFunction = 'SUM';
+export declare type AggregationFunctionName = 'WHERE' | 'COL' | 'GROUP_BY' | AggregationFunction | ComparisonFunction;
+declare type AggregationFunction = 'SUM' | 'MIN' | 'MAX' | 'AVG';
 declare type ComparisonFunction = 'EQ' | 'NEQ' | 'LT' | 'GT' | 'LTE' | 'GTE';
+export interface BooleanAggregationParameter extends BaseParameter<'aggregationBoolean', AggregationFunction> {
+    scalarAggregation: ScalarAggregationOperand;
+    conditionValue: number;
+    conditionFn: (aggregatedValue: number, conditionValue: number) => boolean;
+}
+export interface ScalarAggregationOperand extends BaseParameter<'aggregationScalar', AggregationFunction> {
+    value: AggregatedScalarExpressionEvaluation;
+}
 export declare const aggregatedBooleanExpressionFunctions: Record<AggregationFunctionName, ExpressionFunction>;
 export {};

package/src/Utilities/ExpressionFunctions/aggregatedBooleanExpressionFunctions.js

@@ -2,13 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.aggregatedBooleanExpressionFunctions = void 0;
 const tslib_1 = require("tslib");
-const rxjs_1 = require("rxjs");
 const parseInt_1 = tslib_1.__importDefault(require("lodash/parseInt"));
 const ExpressionEvaluationError_1 = require("../../parser/src/ExpressionEvaluationError");
-const operators_1 = require("rxjs/operators");
 const expressionFunctionUtils_1 = require("./expressionFunctionUtils");
+const aggregatedScalarExpressionFunctions_1 = require("./aggregatedScalarExpressionFunctions");
+const SUPPORTED_AGGREGATION_FNS = ['SUM', 'MIN', 'MAX', 'AVG'];
 const aggregationScalarOperandMap = {
     SUM: ['string', 'number'],
+    MIN: ['string', 'number'],
+    MAX: ['string', 'number'],
+    AVG: ['string', 'number'],
 };
 // 0. optional non-capturing block of empty spaces
 // 1. block containing a numeric value (any digits) (required)
@@ -25,23 +28,11 @@ exports.aggregatedBooleanExpressionFunctions = {
         examples: ['<main_query> WHERE <boolean_query>', '<main_query> WHERE QUERY("abc")'],
         hasEagerEvaluation: true,
     },
-    SUM: {
-        handler(args, context) {
-            const columnParameter = expressionFunctionUtils_1.extractColumnParameter('SUM', args);
-            expressionFunctionUtils_1.validateColumnType(columnParameter.value, ['Number'], 'SUM', context.adaptableApi);
-            const sumAggregationFn = (dataSource$) => getSumAggregation$(dataSource$, getColumnValueSum(columnParameter.value, context));
-            const result = {
-                type: 'aggregation',
-                name: 'SUM',
-                column: columnParameter.value,
-                aggregationFn: sumAggregationFn,
-            };
-            return result;
-        },
-        description: 'Aggregates a column over multiple rows by summing up the column values',
-        signatures: ['SUM( [colName] )', 'SUM( COL(name: string) )'],
-        examples: ['SUM( [colA] )', "SUM( COL('col1') )"],
-    },
+    SUM: aggregatedScalarExpressionFunctions_1.aggregatedScalarExpressionFunctions['SUM'],
+    MIN: aggregatedScalarExpressionFunctions_1.aggregatedScalarExpressionFunctions['MIN'],
+    MAX: aggregatedScalarExpressionFunctions_1.aggregatedScalarExpressionFunctions['MAX'],
+    AVG: aggregatedScalarExpressionFunctions_1.aggregatedScalarExpressionFunctions['AVG'],
+    GROUP_BY: aggregatedScalarExpressionFunctions_1.aggregatedScalarExpressionFunctions['GROUP_BY'],
     COL: {
         handler(args, context) {
             return expressionFunctionUtils_1.handleColumnFunction(args, context);
@@ -52,7 +43,7 @@ exports.aggregatedBooleanExpressionFunctions = {
     },
     EQ: {
         handler(args, context) {
-            return handleAggregationCondition(args, context, '=', (aggregatedValue, conditionValue) => aggregatedValue === conditionValue);
+            return buildBooleanAggregationParameter(args, context, '=', (aggregatedValue, conditionValue) => aggregatedValue === conditionValue);
         },
         isHiddenFromMenu: true,
         description: 'Evaluates if the aggregation result equals a numerical value defined either as a number or a string abbreviation for thousands(K), millions(M) or billions(B)',
@@ -66,7 +57,7 @@ exports.aggregatedBooleanExpressionFunctions = {
     },
     NEQ: {
         handler(args, context) {
-            return handleAggregationCondition(args, context, '!=', (aggregatedValue, conditionValue) => aggregatedValue !== conditionValue);
+            return buildBooleanAggregationParameter(args, context, '!=', (aggregatedValue, conditionValue) => aggregatedValue !== conditionValue);
         },
         isHiddenFromMenu: true,
         description: 'Evaluates if the aggregation result is NOT equal with a numerical value defined either as a number or a string abbreviation for thousands(K), millions(M) or billions(B)',
@@ -80,7 +71,7 @@ exports.aggregatedBooleanExpressionFunctions = {
     },
     LT: {
         handler(args, context) {
-            return handleAggregationCondition(args, context, '<', (aggregatedValue, conditionValue) => aggregatedValue < conditionValue);
+            return buildBooleanAggregationParameter(args, context, '<', (aggregatedValue, conditionValue) => aggregatedValue < conditionValue);
         },
         isHiddenFromMenu: true,
         description: 'Evaluates if the aggregation result is less than a numerical value defined either as a number or a string abbreviation for thousands(K), millions(M) or billions(B)',
@@ -94,7 +85,7 @@ exports.aggregatedBooleanExpressionFunctions = {
     },
     LTE: {
         handler(args, context) {
-            return handleAggregationCondition(args, context, '<=', (aggregatedValue, conditionValue) => aggregatedValue <= conditionValue);
+            return buildBooleanAggregationParameter(args, context, '<=', (aggregatedValue, conditionValue) => aggregatedValue <= conditionValue);
         },
         isHiddenFromMenu: true,
         description: 'Evaluates if the aggregation result is less than or equals a numerical value defined either as a number or a string abbreviation for thousands(K), millions(M) or billions(B)',
@@ -108,7 +99,7 @@ exports.aggregatedBooleanExpressionFunctions = {
     },
     GT: {
         handler(args, context) {
-            return handleAggregationCondition(args, context, '>', (aggregatedValue, conditionValue) => aggregatedValue > conditionValue);
+            return buildBooleanAggregationParameter(args, context, '>', (aggregatedValue, conditionValue) => aggregatedValue > conditionValue);
         },
         isHiddenFromMenu: true,
         description: 'Evaluates if the aggregation result is greater than a numerical value defined either as a number or a string abbreviation for thousands(K), millions(M) or billions(B)',
@@ -122,7 +113,7 @@ exports.aggregatedBooleanExpressionFunctions = {
     },
     GTE: {
         handler(args, context) {
-            return handleAggregationCondition(args, context, '>=', (aggregatedValue, conditionValue) => aggregatedValue >= conditionValue);
+            return buildBooleanAggregationParameter(args, context, '>=', (aggregatedValue, conditionValue) => aggregatedValue >= conditionValue);
         },
         isHiddenFromMenu: true,
         description: 'Evaluates if the aggregation result is greater than or equals a numerical value defined either as a number or a string abbreviation for thousands(K), millions(M) or billions(B)',
@@ -135,24 +126,25 @@ exports.aggregatedBooleanExpressionFunctions = {
         examples: [`SUM([col1]) >= '5M'`, 'GTE( SUM([col1]), 250000)'],
     },
 };
-const handleAggregationCondition = (args, context, comparisonOperator, conditionFn) => {
+const buildBooleanAggregationParameter = (args, context, comparisonOperator, conditionFn) => {
     // LHS
-    const aggregationOperand = extractAggregationOperand(comparisonOperator, ['SUM'], args[0]);
+    const aggregationOperand = extractScalarAggregationOperand(comparisonOperator, args[0]);
     // RHS
     const scalarOperand = extractScalarOperand(comparisonOperator, args[1], aggregationScalarOperandMap[aggregationOperand.name]);
-    let dataChangeLog$ = expressionFunctionUtils_1.getDataChangeLog$(context, aggregationOperand.column);
-    const aggregatedValue$ = aggregationOperand.aggregationFn(dataChangeLog$);
-    return dataChangeLog$.pipe(operators_1.withLatestFrom(aggregatedValue$), operators_1.filter(([_, currentAggregationValue]) => {
-        // check if new aggregated value satisfies the criteria
-        return conditionFn(currentAggregationValue, scalarOperand);
-    }), operators_1.map(([source]) => source));
+    return {
+        type: 'aggregationBoolean',
+        name: aggregationOperand.name,
+        scalarAggregation: aggregationOperand,
+        conditionValue: scalarOperand,
+        conditionFn,
+    };
 };
-const extractAggregationOperand = (consumingFunctionName, allowedAggregations, argument) => {
+const extractScalarAggregationOperand = (consumingFunctionName, argument) => {
     const result = argument;
-    if (argument == undefined ||
-        argument.type !== 'aggregation' ||
-        !allowedAggregations.includes(argument.name)) {
-        throw new ExpressionEvaluationError_1.ExpressionEvaluationError(consumingFunctionName, `comparison operator expects as a left-hand operand an aggregation function of type '${allowedAggregations.join(' | ')}'`);
+    if (result == undefined ||
+        result.type !== 'aggregationScalar' ||
+        !SUPPORTED_AGGREGATION_FNS.includes(result.name)) {
+        throw new ExpressionEvaluationError_1.ExpressionEvaluationError(consumingFunctionName, `comparison operator expects as a left-hand operand an aggregation function of type '${SUPPORTED_AGGREGATION_FNS.join(' | ')}'`);
     }
     return result;
 };
@@ -182,31 +174,3 @@ const extractScalarOperand = (consumingFunctionName, value, allowedTypes) => {
     // numeric value
     return parseInt_1.default(numericString) * numberUnitRatios[largeNumberUnit.toLowerCase()];
 };
-const getSumAggregation$ = (source$, initialSum) => {
-    return rxjs_1.defer(() => {
-        let sumValue = initialSum;
-        const updateSum = (dataChangeLog) => {
-            const oldValue = expressionFunctionUtils_1.getNumericValue(dataChangeLog.oldValue);
-            const newValue = expressionFunctionUtils_1.getNumericValue(dataChangeLog.newValue);
-            sumValue = sumValue - oldValue + newValue;
-        };
-        return source$.pipe(operators_1.tap((dataChangeLog) => updateSum(dataChangeLog)), operators_1.map(() => sumValue));
-    });
-};
-const getColumnValueSum = (column, context) => {
-    let sum = 0;
-    context.adaptableApi.internalApi.forAllRowNodesDo((rowNode) => {
-        // if there is a WHERE clause defined, check if the current rowNode satisfies the condition
-        if (context.filterFn && !context.filterFn(rowNode)) {
-            return;
-        }
-        if (context.adaptableApi.gridApi.isGroupRowNode(rowNode)) {
-            return;
-        }
-        const cellValue = context.adaptableApi.gridApi.getRawValueFromRowNode(rowNode, column);
-        if (cellValue != undefined) {
-            sum = sum + expressionFunctionUtils_1.getNumericValue(rowNode.data[column]);
-        }
-    });
-    return sum;
-};

package/src/Utilities/ExpressionFunctions/aggregatedScalarExpressionFunctions.d.ts

@@ -5,25 +5,41 @@ import { AggregateParams } from './scalarAggregationHelper';
 /**
  * List of all the AggregatedScalar Functions available in AdaptableQL
  */
-export declare type AggregatedScalarFunctionName = AggregationFunction | OperandFunction;
-declare type AggregationFunction = 'SUM' | 'PERCENTAGE' | 'QUANT' | 'AVG' | 'MIN' | 'MAX' | 'CUMUL';
-declare type OperandFunction = 'COL' | 'OVER' | 'GROUP_BY';
-export interface AggregationParameter extends BaseParameter<'aggregation', AggregationFunction> {
+export declare type AggregatedScalarFunctionName = ScalarAggregationFunction | OperandFunction;
+export declare type ScalarAggregationFunction = 'SUM' | 'PERCENTAGE' | 'QUANT' | 'AVG' | 'MIN' | 'MAX' | 'CUMUL';
+declare type OperandFunction = 'COL' | 'OVER' | 'GROUP_BY' | 'WEIGHT';
+export interface ScalarAggregationParameter extends BaseParameter<'aggregationScalar', ScalarAggregationFunction> {
     value: AggregatedScalarExpressionEvaluation;
 }
 export interface OverParameter extends BaseParameter<'operand', 'OVER'> {
     value: string;
 }
 export interface GroupByParameter extends BaseParameter<'operand', 'GROUP_BY'> {
+    value: string[];
+}
+export interface WeightParameter extends BaseParameter<'operand', 'WEIGHT'> {
     value: string;
 }
 export interface AggregatedScalarExpressionEvaluation {
     aggregationParams: AggregateParams<any, string | number>;
     rowValueGetter?: (rowNode: RowNode, aggregatedValue: any) => string | number | Date | boolean;
+    /**
+     * @deprecated remove this
+     */
     columnDependencies: string[];
-    cumulateOver?: string;
+    context?: {
+        weightParam?: WeightParameter;
+    };
     sortByColumn?: string;
-    filterUndefinedValues?: boolean;
+    rowFilterFn?: (rowNode: RowNode) => boolean;
+}
+export interface CumulatedAggregationValue {
+    currentValue: number;
+    cumulatedValues: Record<number | string, number>;
+    numberOfCumulatedValues?: number;
+    totalAggregationValue?: number;
 }
+export declare const cumulativeAggregatedExpressionFunctions: AggregatedScalarFunctionName[];
+export declare const aggregatedExpressionFunctions: AggregatedScalarFunctionName[];
 export declare const aggregatedScalarExpressionFunctions: Record<AggregatedScalarFunctionName, ExpressionFunction>;
 export {};