@adaptabletools/adaptable 22.0.8 → 22.0.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "22.0.8",
+  "version": "22.0.10",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -227,7 +227,6 @@ export interface InFilterValueResult {
  * Information about items in the IN Column Filter
  */
 export interface InFilterValueInfo extends InFilterValue {
-    id: string | number;
     /**
      * Whether Item is currently selected
      */
@@ -255,23 +254,41 @@ export interface InFilterValueInfo extends InFilterValue {
  */
 export interface CustomInFilterValuesContext<TData = any> extends AdaptableColumnContext {
     /**
-     * Default list of values that will be displayed
+     * Distinct Column values in natural (unsorted) row iteration order.
+     *
+     * When the Column uses a Tree Filter, items have a hierarchical structure.
+     *
+     * Computed lazily on first access.
      */
     defaultValues: Required<InFilterValueInfo>[];
     /**
-     * Default values but sorted (if Column is sorted)
+     * Distinct Column values sorted by the Column's own sort direction (Asc / Desc).
+     *
+     * If the Column has no active sort, values are returned in the same order as `defaultValues`.
+     *
+     * When the Column uses a Tree Filter, items have a hierarchical structure.
+     *
+     * Computed lazily on first access.
      */
     sortedValues: Required<InFilterValueInfo>[];
     /**
-     * Default values in order which currently listed in the grid
+     * Distinct Column values in the order they appear in the grid from top to bottom.
+     *
+     * Always a flat list, even when the Column uses a Tree Filter.
+     *
+     * Computed lazily on first access.
      */
     orderedValues: Required<InFilterValueInfo>[];
     /**
-     * Search text in the IN Filter component - used when filtering on server
+     * Current text in the IN Filter search box.
+     *
+     * Useful when implementing server-side filtering of the value list.
      */
     currentSearchValue: string;
     /**
-     * Last filter result; avoids expensive recomputations (eg if async or server-side filtering)
+     * The result returned by the previous invocation of `FilterOptions.customInFilterValues`, if any.
+     *
+     * Useful for avoiding expensive recomputations (e.g. when filtering is async or server-side).
      */
     previousFilterResult?: InFilterValueResult;
 }

package/src/AdaptableState/Common/CellDataChangedInfo.d.ts

@@ -36,4 +36,8 @@ export interface CellDataChangedInfo<TData = any> {
      * What triggered the change - user, background change or a reverted change?
      */
     trigger?: 'edit' | 'tick' | 'undo' | 'aggChange';
+    /**
+     * Whether the change was prevented by a validation rule
+     */
+    preventEdit?: boolean;
 }

package/src/Api/Implementation/ColumnFilterApiImpl.js

@@ -194,7 +194,6 @@ export class ColumnFilterApiImpl extends ApiBase {
         if (columnDistinctValues.some((item) => StringExtensions.IsNullOrEmpty(item.value))) {
             return [
                 {
-                    id: '_blanks',
                     label: 'Blanks',
                     value: 'Blanks',
                 },

package/src/Strategy/CalculatedColumnModule.js

@@ -32,7 +32,7 @@ export class CalculatedColumnModule extends AdaptableModuleBase {
         this.api.internalApi
             .getDataService()
             .on('CellDataChanged', (cellDataChangedInfo) => {
-            if (cellDataChangedInfo.trigger !== 'aggChange') {
+            if (cellDataChangedInfo.trigger !== 'aggChange' && !cellDataChangedInfo.preventEdit) {
                 this.api.internalApi
                     .getCalculatedColumnExpressionService()
                     .listentoCellDataChange(cellDataChangedInfo);

package/src/Strategy/ColumnFilterModule.js

@@ -24,8 +24,10 @@ export class ColumnFilterModule extends AdaptableModuleBase {
         this.api.internalApi
             .getDataService()
             .on('CellDataChanged', (cellDataChangedInfo) => {
-            const changedColumnId = cellDataChangedInfo.column.columnId;
-            this.api.filterApi.columnFilterApi.resetFilterValues(changedColumnId);
+            if (!cellDataChangedInfo.preventEdit) {
+                const changedColumnId = cellDataChangedInfo.column.columnId;
+                this.api.filterApi.columnFilterApi.resetFilterValues(changedColumnId);
+            }
         });
         // we reset the filter cache on sort change, because we might have columns
         // with "In" filters, with custom values, which use `context.orderedValues`

package/src/Strategy/DataChangeHistoryModule.js

@@ -29,7 +29,9 @@ export class DataChangeHistoryModule extends AdaptableModuleBase {
         this.api.internalApi
             .getDataService()
             .on('CellDataChanged', (cellDataChangedInfo) => {
-            if (this.isListeningToCellDataChanges && this.isDataChangeLoggable(cellDataChangedInfo)) {
+            if (this.isListeningToCellDataChanges &&
+                this.isDataChangeLoggable(cellDataChangedInfo) &&
+                !cellDataChangedInfo.preventEdit) {
                 this.api.dataChangeHistoryApi.addDataChangeHistoryEntry(cellDataChangedInfo);
             }
         });

package/src/Strategy/FlashingCellModule.js

@@ -35,7 +35,7 @@ export class FlashingCellModule extends AdaptableModuleBase {
         this.api.internalApi
             .getDataService()
             .on('CellDataChanged', (cellDataChangedInfo) => {
-            if (cellDataChangedInfo.trigger === 'undo') {
+            if (cellDataChangedInfo.trigger === 'undo' || cellDataChangedInfo.preventEdit) {
                 // do NOT handle reverted changes
                 return;
             }

package/src/Strategy/FreeTextColumnModule.js

@@ -30,7 +30,7 @@ export class FreeTextColumnModule extends AdaptableModuleBase {
         this.api.internalApi
             .getDataService()
             .on('CellDataChanged', (cellDataChangedInfo) => {
-            if (cellDataChangedInfo.trigger !== 'aggChange') {
+            if (cellDataChangedInfo.trigger !== 'aggChange' && !cellDataChangedInfo.preventEdit) {
                 this.api.freeTextColumnApi.internalApi.handleFreeTextColumnDataChange(cellDataChangedInfo);
             }
         });

package/src/Utilities/Services/DataService.js

@@ -41,6 +41,12 @@ export class DataService {
     emit = (eventName, data) => this.emitter.emit(eventName, data);
     CreateCellDataChangedEvent(cellDataChangedInfo) {
         if (cellDataChangedInfo.newValue != cellDataChangedInfo.oldValue) {
+            const validationRules = this.adaptable.api.internalApi
+                .getValidationService()
+                .getValidationRulesForDataChange(cellDataChangedInfo);
+            if (validationRules.length) {
+                cellDataChangedInfo.preventEdit = true;
+            }
             this.emitter.emitSync('CellDataChanged', cellDataChangedInfo);
             this.adaptable.api.eventApi.internalApi.fireCellChangedEvent(cellDataChangedInfo);
             const dataChangeLogEntry = this.extractDataChangeLogEntry(cellDataChangedInfo);

package/src/agGrid/AdaptableAgGrid.js

@@ -503,6 +503,7 @@ export class AdaptableAgGrid {
         this.agGridAdapter.setAgGridApi(agGridApi);
         this.agGridAdapter.monkeyPatchingGridOptionsUpdates();
         this.agGridAdapter.monkeyPatchingAggColumnFilters();
+        this.agGridAdapter.monkeyPatchingAggFuncLabels();
         this.lifecycleState = 'agGridReady';
         this.api.entitlementApi.internalApi.setModulesAgGridDepsInfos();
         this.ModuleService.logMissingAgGridDepsInfos();
@@ -1020,7 +1021,7 @@ export class AdaptableAgGrid {
             }
             return (params) => {
                 // might be a summary row
-                if (params.data?.[ROW_SUMMARY_ROW_ID]) {
+                if (params.data?.[ROW_SUMMARY_ROW_ID] != undefined) {
                     return params.data[ROW_SUMMARY_ROW_ID];
                 }
                 if (params.level > 0) {
@@ -1036,7 +1037,7 @@ export class AdaptableAgGrid {
                     const id = [...parentKeys, Math.abs(hash)].join('/');
                     return id;
                 }
-                if (params.data?.[primaryKey]) {
+                if (params.data?.[primaryKey] != undefined) {
                     const primaryKeyValue = params.data[primaryKey];
                     return typeof primaryKeyValue === 'number'
                         ? `${primaryKeyValue}`
@@ -2709,11 +2710,9 @@ export class AdaptableAgGrid {
         };
         // No distinct values so lets return unique grid cells
         const mapFn = (gridCell, level) => {
-            const itemId = `${gridCell.rowNode?.id}-${gridCell.column?.columnId}`;
             if (level || Array.isArray(gridCell.children)) {
                 const cell = gridCell;
                 const inFilterValue = {
-                    id: itemId,
                     value: gridCell.rawValue,
                     label: gridCell.displayValue,
                     level: level ?? 0,
@@ -2734,7 +2733,6 @@ export class AdaptableAgGrid {
                 return inFilterValue;
             }
             return {
-                id: itemId,
                 value: gridCell.rawValue,
                 label: gridCell.displayValue,
             };

package/src/agGrid/AgGridAdapter.d.ts

@@ -11,6 +11,7 @@ export declare class AgGridAdapter {
     private DANGER_updateGridOptionsMonkeyPatcher;
     private DANGER_doFiltersPassMonkeyPatcher;
     private DANGER_isAggFilterPresentMonkeyPatcher;
+    private DANGER_getDefaultFuncLabelMonkeyPatcher;
     private activePivotColumnFilters_MEMO;
     initialGridOptions: GridOptions;
     private _agGridId;
@@ -28,6 +29,7 @@ export declare class AgGridAdapter {
     getAgGridApi(skipLogging?: boolean): GridApi | undefined;
     monkeyPatchingGridOptionsUpdates(): void;
     monkeyPatchingAggColumnFilters(): void;
+    monkeyPatchingAggFuncLabels(): void;
     private DANGER_getPrivateAgGridBeans;
     DANGER_getLiveGridOptions(): GridOptions<any>;
     getAgGridRootElement(): HTMLElement;

package/src/agGrid/AgGridAdapter.js

@@ -21,6 +21,8 @@ export class AgGridAdapter {
     // see #aggColumnFilters_monkey_patch
     DANGER_doFiltersPassMonkeyPatcher;
     DANGER_isAggFilterPresentMonkeyPatcher;
+    // see #aggFuncLabels_monkey_patch
+    DANGER_getDefaultFuncLabelMonkeyPatcher;
     activePivotColumnFilters_MEMO = new WeakMap();
     initialGridOptions;
     _agGridId;
@@ -51,6 +53,7 @@ export class AgGridAdapter {
         this.DANGER_updateGridOptionsMonkeyPatcher = null;
         this.DANGER_doFiltersPassMonkeyPatcher = null;
         this.DANGER_isAggFilterPresentMonkeyPatcher = null;
+        this.DANGER_getDefaultFuncLabelMonkeyPatcher = null;
         this.activePivotColumnFilters_MEMO = null;
         this._adaptableInstance = null;
     }
@@ -208,6 +211,27 @@ export class AgGridAdapter {
         };
         agGridColumnFilterService.isAggFilterPresent = this.DANGER_isAggFilterPresentMonkeyPatcher;
     }
+    // #aggFuncLabels_monkey_patch
+    monkeyPatchingAggFuncLabels() {
+        const agGridAggFuncService = this.DANGER_getPrivateAgGridBeans()?.aggFuncSvc;
+        if (!agGridAggFuncService) {
+            return;
+        }
+        const original_getDefaultFuncLabel = agGridAggFuncService.getDefaultFuncLabel;
+        if (typeof original_getDefaultFuncLabel !== 'function') {
+            return;
+        }
+        this.DANGER_getDefaultFuncLabelMonkeyPatcher = function (fctName) {
+            if (fctName === 'only') {
+                return 'Only';
+            }
+            if (fctName === 'weightedAvg') {
+                return 'Weighted Average';
+            }
+            return original_getDefaultFuncLabel.call(this, fctName);
+        };
+        agGridAggFuncService.getDefaultFuncLabel = this.DANGER_getDefaultFuncLabelMonkeyPatcher;
+    }
     DANGER_getPrivateAgGridBeans() {
         const beans = DANGER_AG_GRID_BEANS_MAP[this._agGridId];
         if (!beans) {
@@ -655,9 +679,14 @@ export class AgGridAdapter {
         return false;
     }
     getColumnAggregationFunctions(colDef) {
-        let result = [].concat(colDef.allowedAggFuncs || ['sum', 'min', 'max', 'count', 'avg', 'first', 'last']); // those are the default fns aggrid supports out-of-the-box
+        const defaultAggFuncs = ['sum', 'min', 'max', 'count', 'avg', 'first', 'last'];
+        const hasAllowedAggFuncs = Array.isArray(colDef.allowedAggFuncs);
+        let result = hasAllowedAggFuncs ? [...colDef.allowedAggFuncs] : [...defaultAggFuncs];
         const gridOptionsAggFuncs = this.adaptableApi.agGridApi.getGridOption('aggFuncs') || {};
-        result.push(...Object.keys(gridOptionsAggFuncs));
+        const gridOptionsAggFuncNames = Object.keys(gridOptionsAggFuncs);
+        if (!hasAllowedAggFuncs) {
+            result.push(...gridOptionsAggFuncNames);
+        }
         result = result.filter((func) => !isWeightedAverageAggFuncName(func));
         return [...new Set(result)];
     }

package/src/agGrid/AgGridColumnAdapter.js

@@ -17,7 +17,7 @@ import { AdaptableFilterHandler } from './AdaptableFilterHandler';
 import { AgGridFilterAdapterFactory } from './AgGridFilterAdapter';
 import { AgGridFloatingFilterAdapterFactory } from './AgGridFloatingFilterAdapter';
 import { errorOnce } from './AdaptableLogger';
-import { isWeightedAverageAggFuncName } from '../AdaptableState/Common/AggregationColumns';
+import { isWeightedAverageAggFuncName, } from '../AdaptableState/Common/AggregationColumns';
 export function getEditorForColumnDataType(columnDataType, variant) {
     if (columnDataType === 'number') {
         return variant === 'react' ? AdaptableReactNumberEditor : AdaptableNumberEditor;
@@ -571,6 +571,7 @@ export class AgGridColumnAdapter {
                 return undefined;
             }
             return abColumn.availableAggregationFunctions.filter((func) => !isWeightedAverageAggFuncName(func));
+            // .filter((func) => func !== ONLY_AGG_FN_NAME);
         });
     }
     setupColumnType(columnSetupInfo) {

package/src/components/Tree/TreeList/index.d.ts

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { DataSourcePropOnTreeSelectionChange_MultiNode, InfiniteTableProps, TreeDataSourceProps } from '../../InfiniteTable';
 export type TreeListItem<T = any> = {
-    id: string | number;
+    id?: string | number;
     label: string;
     children?: TreeListItem<T>[];
 };

package/src/env.js

@@ -1,5 +1,5 @@
 export default {
     NEXT_PUBLIC_INFINITE_TABLE_LICENSE_KEY: "StartDate=2021-06-29|EndDate=2030-01-01|Owner=Adaptable|Type=distribution|TS=1624971462479|C=137829811,1004007071,2756196225,1839832928,3994409405,636616862" || '',
-    PUBLISH_TIMESTAMP: 1775221022738 || Date.now(),
-    VERSION: "22.0.8" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1775746119161 || Date.now(),
+    VERSION: "22.0.10" || '--current-version--',
 };