@adaptabletools/adaptable 12.1.6 → 12.1.8-canary.1

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 {};