@adaptabletools/adaptable 12.2.0-canary.1 → 12.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "12.2.0-canary.1",
+  "version": "12.2.2",
   "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1661757179502;
+declare const _default: 1661928464536;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1661757179502;
+exports.default = 1661928464536;

package/src/AdaptableOptions/AdaptableQLOptions.d.ts

@@ -114,7 +114,7 @@ export interface ExpressionOptions {
     /**
      * Custom query variables allow values to be attached to variables so that a single value can easily be expressed multiple times within a query, or quickly changed to affect the results of a query. Variables are evaluated synchronously with each expression evaluation.
      */
-    customQueryVariable?: Record<string, string | number | boolean | Date | ((context: CustomQueryVariableContext) => string | number | boolean | Date)>;
+    customQueryVariables?: Record<string, string | number | boolean | Date | ((context: CustomQueryVariableContext) => string | number | boolean | Date)>;
 }
 /**
  * Module specific Expression Functions
@@ -127,7 +127,7 @@ export interface ModuleExpressionFunctions {
     aggregatedScalarFunctions?: ExpressionFunctionMap;
 }
 /**
- * Context passed when evaluating `ExpressionOptions.customQueryVariable`
+ * Context passed when evaluating `ExpressionOptions.customQueryVariables`
  */
 export interface CustomQueryVariableContext extends BaseContext {
     /**
@@ -139,7 +139,16 @@ export interface CustomQueryVariableContext extends BaseContext {
  * Context passed when evaluating `AdaptableQLOptions.evaluateExpressionExternally()`
  */
 export interface EvaluateExpressionExternallyContext extends BaseContext {
+    /**
+     * Module where the Expression is being evaluated
+     */
     module: AdaptableQLModule;
+    /**
+     * Expression to evlauate
+     */
     expression?: string;
+    /**
+     * Columns contained in the Expression
+     */
     referencedColumns?: AdaptableColumn[];
 }

package/src/Utilities/Services/QueryLanguageService.js

@@ -312,7 +312,7 @@ class QueryLanguageService {
             adaptableApi: this.adaptableApi,
             args,
         };
-        const customQueryVariableDefinition = (_c = (_b = (_a = this.adaptableApi.internalApi.getAdaptableOptions().adaptableQLOptions) === null || _a === void 0 ? void 0 : _a.expressionOptions) === null || _b === void 0 ? void 0 : _b.customQueryVariable) === null || _c === void 0 ? void 0 : _c[functionName];
+        const customQueryVariableDefinition = (_c = (_b = (_a = this.adaptableApi.internalApi.getAdaptableOptions().adaptableQLOptions) === null || _a === void 0 ? void 0 : _a.expressionOptions) === null || _b === void 0 ? void 0 : _b.customQueryVariables) === null || _c === void 0 ? void 0 : _c[functionName];
         return typeof customQueryVariableDefinition === 'function'
             ? customQueryVariableDefinition(context)
             : customQueryVariableDefinition;

package/src/agGrid/Adaptable.d.ts

@@ -226,7 +226,7 @@ export declare class Adaptable implements IAdaptable {
     private mapColumnDefs;
     private getColDefsForSpecialColumns;
     getColDefsForFreeTextColumns(): ColDef[];
-    setupColumnValueGetter({ col, abColumn }: ColumnSetupInfo): void;
+    setupColumnValueGetter({ col }: ColumnSetupInfo): void;
     setupColumnAggFunc({ col }: ColumnSetupInfo): void;
     private getColDefsForRowEditColumns;
     getColDefsForActionColumns(): ColDef[];

package/src/agGrid/Adaptable.js

@@ -2197,31 +2197,10 @@ class Adaptable {
             return newColDef;
         });
     }
-    setupColumnValueGetter({ col, abColumn }) {
+    setupColumnValueGetter({ col }) {
+        // need this here if we want plugins to intercept
         this.setColDefProperty(col, 'valueGetter', (userValue) => {
-            return (params) => {
-                const columnId = abColumn.columnId;
-                let evaluatedUserValue = userValue;
-                if (typeof userValue === 'function') {
-                    evaluatedUserValue = userValue(params);
-                }
-                const defaultValue = evaluatedUserValue
-                    ? evaluatedUserValue
-                    : (params === null || params === void 0 ? void 0 : params.data)
-                        ? params.data[columnId]
-                        : undefined;
-                const adaptableAggFunc = this.getActiveAdaptableAggFuncForCol(columnId);
-                if (adaptableAggFunc && adaptableAggFunc.type === 'weightedAverage' && !params.node.group) {
-                    const weightedColumnId = adaptableAggFunc.weightedColumnId;
-                    return {
-                        [columnId]: defaultValue,
-                        [weightedColumnId]: params.data[weightedColumnId],
-                        toString: () => (defaultValue ? `${defaultValue}` : ''),
-                        valueOf: () => defaultValue,
-                    };
-                }
-                return defaultValue;
-            };
+            return userValue;
         });
     }
     setupColumnAggFunc({ col }) {

package/src/agGrid/weightedAverage.d.ts

@@ -1,5 +1,6 @@
 import { IAggFuncParams } from '@ag-grid-community/all-modules';
 import { CellSummaryOperationContext } from '../types';
+export declare const getNumericValue: (input: unknown) => number | null;
 export declare const weightedAverage: (params: IAggFuncParams, columnId: string, weightColumnId: string) => {
     [x: string]: number | (() => number | "");
     toString: () => number | "";

package/src/agGrid/weightedAverage.js

@@ -1,64 +1,51 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cellSummaryWeightedAverage = exports.weightedAverage = void 0;
+exports.cellSummaryWeightedAverage = exports.weightedAverage = exports.getNumericValue = void 0;
 const tslib_1 = require("tslib");
-const StringExtensions_1 = tslib_1.__importDefault(require("../Utilities/Extensions/StringExtensions"));
 const FormatHelper_1 = tslib_1.__importDefault(require("../Utilities/Helpers/FormatHelper"));
+const toNumber_1 = tslib_1.__importDefault(require("lodash/toNumber"));
+const getNumericValue = (input) => {
+    if (typeof input === 'number') {
+        return input;
+    }
+    const numericValue = toNumber_1.default(input);
+    return isNaN(numericValue) ? null : numericValue;
+};
+exports.getNumericValue = getNumericValue;
 const weightedAverage = (params, columnId, weightColumnId) => {
+    const { api: gridApi, rowNode: groupRowNode } = params;
     let weightedColumnValueSum = 0;
     let columnValueSum = 0;
-    params.values.forEach((value) => {
-        if (!value) {
-            return;
-        }
-        // when editing values become string
-        const rawColumnValue = value[columnId];
-        if (typeof rawColumnValue === 'object') {
-            return;
-        }
-        const columnValue = StringExtensions_1.default.IsNotNullOrEmpty(rawColumnValue)
-            ? Number(value[columnId])
-            : null;
-        const rawWeightedColumnValue = value[weightColumnId];
-        if (typeof rawWeightedColumnValue === 'object') {
-            return;
-        }
-        const weightedColumnValue = StringExtensions_1.default.IsNotNullOrEmpty(rawWeightedColumnValue)
-            ? Number(value[weightColumnId])
-            : null;
-        if (params.rowNode.leafGroup) {
-            if (weightedColumnValue !== null) {
-                weightedColumnValueSum += weightedColumnValue;
-            }
-            if (columnValue !== null && weightedColumnValue !== null) {
-                columnValueSum += weightedColumnValue * columnValue;
-            }
+    // TODO AFL: improve performance by using the intermediary aggregated values (for nested groups)
+    groupRowNode.allLeafChildren.forEach((rowNode) => {
+        // when editing values might be converted to strings
+        const rawColumnValue = gridApi.getValue(columnId, rowNode);
+        const columnValue = exports.getNumericValue(rawColumnValue);
+        const rawWeightedColumnValue = gridApi.getValue(weightColumnId, rowNode);
+        const weightedColumnValue = exports.getNumericValue(rawWeightedColumnValue);
+        if (weightedColumnValue !== null) {
+            weightedColumnValueSum += weightedColumnValue;
         }
-        else {
-            if (weightedColumnValue !== null) {
-                weightedColumnValueSum += weightedColumnValue;
-            }
-            if (columnValue !== null) {
-                columnValueSum += columnValue;
-            }
+        if (columnValue !== null) {
+            columnValueSum += columnValue * weightedColumnValue;
         }
     });
     return {
         toString: () => {
-            const rez = columnValueSum / weightedColumnValueSum;
+            const result = columnValueSum / weightedColumnValueSum;
             // 0 / 0 = NaN
-            if (isNaN(rez)) {
+            if (isNaN(result)) {
                 return '';
             }
-            return rez;
+            return result;
         },
         valueOf: () => {
-            const rez = columnValueSum / weightedColumnValueSum;
+            const result = columnValueSum / weightedColumnValueSum;
             // 0 / 0 = NaN
-            if (isNaN(rez)) {
+            if (isNaN(result)) {
                 return 0;
             }
-            return rez;
+            return result;
         },
         [columnId]: columnValueSum,
         [weightColumnId]: weightedColumnValueSum,
@@ -69,10 +56,6 @@ const cellSummaryWeightedAverage = ({ numericColumns, selectedCellInfo, adaptabl
     if ((numericColumns === null || numericColumns === void 0 ? void 0 : numericColumns.length) != 1) {
         return '';
     }
-    const currentSummaryOperation = adaptableApi.cellSummaryApi.getCurrentCellSummaryOperation();
-    if (typeof currentSummaryOperation !== 'string' || currentSummaryOperation !== 'Weighted Avg') {
-        return '';
-    }
     const columnId = numericColumns[0];
     const currentLayout = adaptableApi.layoutApi.getCurrentLayout();
     const selectedColumnAgg = currentLayout.AggregationColumns[columnId];

package/src/metamodel/adaptable.metamodel.d.ts

@@ -1967,6 +1967,18 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         description: string;
     };
+    CustomQueryVariableContext: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            isOptional: boolean;
+        }[];
+    };
     CustomRenderContext: {
         name: string;
         kind: string;