@adaptabletools/adaptable 21.0.4 → 21.0.6

package/package.json

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

package/src/Api/Implementation/LayoutHelpers.js

@@ -28,6 +28,23 @@ export const layoutModelToLayoutState = (layoutModel) => {
 function cleanupAdaptableObjectPrimitives(layout) {
     const l = layout;
     for (const key in l) {
+        if (key === 'ColumnFilters') {
+            // we don't want to cleanup ColumnFilters
+            // as we rely on the Uuids for identifying the filters
+            if (Array.isArray(l[key])) {
+                l[key].forEach((item) => {
+                    if (typeof item === 'object') {
+                        // but we do want to cleanup further down - eg: predicates in the filter
+                        for (const k in item) {
+                            if (typeof item[k] === 'object') {
+                                removeAdaptableObjectPrimitivesInlineDeep(item[k]);
+                            }
+                        }
+                    }
+                });
+            }
+            continue;
+        }
         if (typeof l[key] === 'object') {
             removeAdaptableObjectPrimitivesInlineDeep(l[key]);
         }
@@ -355,9 +372,9 @@ export const tableLayoutModelToTableLayout = (layoutModel) => {
     if (layoutModel.Ignore_Metadata) {
         tableLayout.Metadata = layoutModel.Ignore_Metadata;
     }
-    if (layoutModel.RowGroupDisplayType) {
-        tableLayout.RowGroupDisplayType = layoutModel.RowGroupDisplayType;
-    }
+    // if (layoutModel.RowGroupDisplayType) {
+    tableLayout.RowGroupDisplayType = layoutModel.RowGroupDisplayType ?? 'single';
+    // }
     if (layoutModel.RowGroupedColumns) {
         tableLayout.RowGroupedColumns = layoutModel.RowGroupedColumns;
     }
@@ -511,9 +528,9 @@ export const pivotLayoutModelToPivotLayout = (layoutModel) => {
             pivotLayout.ColumnGroupValues.ExceptionGroupKeys = layoutModel.ColumnGroupValues.Values;
         }
     }
-    if (layoutModel.RowGroupDisplayType) {
-        pivotLayout.RowGroupDisplayType = layoutModel.RowGroupDisplayType;
-    }
+    // if (layoutModel.RowGroupDisplayType) {
+    pivotLayout.RowGroupDisplayType = layoutModel.RowGroupDisplayType ?? 'single';
+    // }
     return pivotLayout;
 };
 export const isPivotLayout = (layout) => Array.isArray(layout.PivotColumns);

package/src/View/Layout/Wizard/sections/ColumnsSection.js

@@ -22,7 +22,7 @@ import { ReorderDraggable } from '../../../Components/ReorderDraggable';
 import { AdaptableFormControlTextClear } from '../../../Components/Forms/AdaptableFormControlTextClear';
 import { sortColumnIdsByOrder } from '../../../../layout-manager/src/sortColumnIdsByOrder';
 import HelpBlock from '../../../../components/HelpBlock';
-import { AG_GRID_SELECTION_COLUMN } from '../../../../Utilities/Constants/GeneralConstants';
+import { AG_GRID_GROUPED_COLUMN, AG_GRID_SELECTION_COLUMN, } from '../../../../Utilities/Constants/GeneralConstants';
 import { isPivotLayout } from '../../../../Utilities/isPivotLayout';
 const PropertyOrderText = (props) => (React.createElement(Text, { fontWeight: 600, fontSize: 2 }, props.children));
 const columnTypes = {
@@ -261,7 +261,8 @@ export const ColumnsSection = (props) => {
             });
         }
     }
-    if (adaptable.api.gridApi.isTreeDataGrid()) {
+    if (adaptable.api.gridApi.isTreeDataGrid() &&
+        !allColumns.find((col) => col.columnId === AG_GRID_GROUPED_COLUMN)) {
         allColumns.unshift(generateAutoTreeSingleColumn());
     }
     const colIdToCol = allColumns.reduce((acc, col) => {

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -200,7 +200,9 @@ export declare class AdaptableAgGrid implements IAdaptable {
     getDisplayValueFromRawValue(rowNode: IRowNode, columnId: string, rawValue: any): string | undefined;
     private getCleanValue;
     getNormalisedValueFromRawValue(rawValue: any, column: AdaptableColumn): string | number | boolean | Date | unknown;
+    private __updateColumnModelAndRefreshGrid_already_called;
     updateColumnModelAndRefreshGrid(): void;
+    _updateColumnModelAndRefreshGridNow(): void;
     redrawBody(): void;
     refreshHeader(): void;
     redrawRows(rowNodes?: IRowNode[]): void;

package/src/agGrid/AdaptableAgGrid.js

@@ -179,6 +179,7 @@ export class AdaptableAgGrid {
             }
             return this.emitter.onIncludeFired(eventName, callback);
         };
+        this.__updateColumnModelAndRefreshGrid_already_called = false;
         this.lifecycleState = 'initial';
         this.emitter = new Emitter();
         this.agGridOptionsService = new AgGridOptionsService(this);
@@ -356,6 +357,13 @@ export class AdaptableAgGrid {
         const gridOptions = config.gridOptions;
         // Needed here because special column defs are required for deriving the adaptable column state
         let columnDefs = this.agGridAdapter.getColumnDefinitionsInclSpecialColumns(gridOptions.columnDefs || []);
+        // see #map_dateString_to_date
+        this.agGridAdapter.patchColDefs(columnDefs, (colDef) => {
+            if (colDef.cellDataType === 'dateString') {
+                this.logger.consoleError(`AG Grid: Column '${colDef.colId}' specifies cellDataType='dateString' which is no longer supported. It has been automatically replaced with cellDataType='date'. Please update your column definition.`);
+                colDef.cellDataType = 'date';
+            }
+        });
         gridOptions.columnDefs = columnDefs;
         this.setInitialGridOptions(gridOptions, config.variant);
         const { gridState: initialGridState, layoutModel } = this.mapAdaptableStateToAgGridState(this.adaptableStore.TheStore.getState(), gridOptions.columnDefs, {
@@ -705,18 +713,30 @@ You need to define at least one Layout!`);
                 };
             }
             return (params) => {
+                // might be a summary row
+                if (params.data?.[ROW_SUMMARY_ROW_ID]) {
+                    return params.data[ROW_SUMMARY_ROW_ID];
+                }
+                if (params.level > 0) {
+                    const parentKeys = params.parentKeys ?? [];
+                    const values = Object.values(params.data);
+                    let hash = 0;
+                    for (let i = 0; i < values.length; i++) {
+                        const str = String(values[i] ?? '');
+                        for (let j = 0; j < str.length; j++) {
+                            hash = ((hash << 5) - hash + str.charCodeAt(j)) | 0;
+                        }
+                    }
+                    const id = [...parentKeys, Math.abs(hash)].join('/');
+                    return id;
+                }
                 if (params.data?.[primaryKey]) {
                     const primaryKeyValue = params.data[primaryKey];
                     return typeof primaryKeyValue === 'number'
                         ? `${primaryKeyValue}`
                         : params.data[primaryKey];
                 }
-                // might be a summary row
-                if (params.data?.[ROW_SUMMARY_ROW_ID]) {
-                    return params.data[ROW_SUMMARY_ROW_ID];
-                }
-                // AFL 2024.08.17 - no idea why is this here and when it's used
-                //  might be a group row
+                // fallback
                 const parentKeys = params.parentKeys ?? [];
                 const values = Object.values(params.data);
                 if (values.length) {
@@ -1858,6 +1878,20 @@ You need to define at least one Layout!`);
         return rawValue;
     }
     updateColumnModelAndRefreshGrid() {
+        if (this.__updateColumnModelAndRefreshGrid_already_called) {
+            return;
+        }
+        try {
+            this._updateColumnModelAndRefreshGridNow();
+            this.__updateColumnModelAndRefreshGrid_already_called = true;
+        }
+        finally {
+            queueMicrotask(() => {
+                this.__updateColumnModelAndRefreshGrid_already_called = false;
+            });
+        }
+    }
+    _updateColumnModelAndRefreshGridNow() {
         this.logger.info(`Updating Column Model and Refreshing Grid.`);
         this.deriveAdaptableColumnStateFromAgGrid();
         this.agGridColumnAdapter.setupColumns();
@@ -3544,8 +3578,8 @@ You need to define at least one Layout!`);
     isRowGroupDifferentInLayout(one, other) {
         const prevRowGroupedColumns = one.RowGroupedColumns || one.PivotGroupedColumns || [];
         const currentRowGroupedColumns = other.RowGroupedColumns || other.PivotGroupedColumns || [];
-        const prevRowGroupDisplayType = one.RowGroupDisplayType;
-        const currentRowGroupDisplayType = other.RowGroupDisplayType;
+        const prevRowGroupDisplayType = one.RowGroupDisplayType ?? 'single';
+        const currentRowGroupDisplayType = other.RowGroupDisplayType ?? 'single';
         if (prevRowGroupDisplayType !== currentRowGroupDisplayType) {
             return true;
         }

package/src/agGrid/AgGridColumnAdapter.js

@@ -532,6 +532,7 @@ export class AgGridColumnAdapter {
     setupColumnCellDataType(columnSetupInfo) {
         const { col, colId } = columnSetupInfo;
         this.setColDefProperty(col, 'cellDataType', (original_cellDataType) => {
+            // #map_dateString_to_date
             if (original_cellDataType === 'dateString') {
                 errorOnce(`AG Grid: Column '${colId}' specifies cellDataType='dateString' which is no longer supported. It has been automatically replaced with cellDataType='date'. Please update your column definition.`);
                 return 'date';

package/src/agGrid/AgGridModulesAdapter.js

@@ -16,7 +16,20 @@ export class AgGridModulesAdapter {
         return this.adaptableInstance.agGridAdapter.getAgGridApi();
     }
     isAgGridModuleRegistered(moduleName) {
-        return this.agGridApi.isModuleRegistered(moduleName);
+        let isModuleRegistered = this.agGridApi.isModuleRegistered(moduleName);
+        if (!isModuleRegistered) {
+            // SSRM module comes with its own implementations of Pivot, MasterDetail and TreeData
+            // #ssrm_pivot_module
+            const serverSideDependencies = [
+                'PivotModule',
+                'MasterDetailModule',
+                'TreeDataModule',
+            ];
+            if (serverSideDependencies.includes(moduleName)) {
+                isModuleRegistered = this.agGridApi.isModuleRegistered('ServerSideRowModelModule');
+            }
+        }
+        return isModuleRegistered;
     }
     getAgGridRegisteredModules() {
         const registeredModules = [];

package/src/components/Select/Select.js

@@ -279,10 +279,10 @@ export const Select = function (props) {
                                 // ignore the event if the focus is still inside the menu
                                 return;
                             }
-                            setTimeout(() => {
+                            requestAnimationFrame(() => {
                                 // wee need to wait for the single value selection to complete before closing
                                 closeSelectMenu();
-                            }, 100);
+                            });
                         },
                         onMouseDown: (event) => {
                             if (!props.isMulti) {

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: 1758887585115 || Date.now(),
-    VERSION: "21.0.4" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1759506293070 || Date.now(),
+    VERSION: "21.0.6" || '--current-version--',
 };

package/src/layout-manager/src/index.js

@@ -342,9 +342,15 @@ export class LayoutManager extends LMEmitter {
         let ColumnSizing = layout.ColumnSizing || {};
         //let's also include the column widths of the pivotResult columns
         pivotResultColumns.forEach((col) => {
-            ColumnSizing[col.getColId()] = {
-                Width: col.getActualWidth(),
-            };
+            const colId = col.getColId();
+            const Width = col.getActualWidth();
+            const initialWidth = this.initialColumnWidths[colId] ?? DEFAULT_COLUMN_WIDTH;
+            // but if the width is the initial/default width, don't include it in the ColumnSizing
+            if (Width !== initialWidth) {
+                ColumnSizing[colId] = {
+                    Width,
+                };
+            }
         });
         if (!Object.keys(ColumnSizing).length) {
             ColumnSizing = undefined;
@@ -1707,6 +1713,10 @@ export class LayoutManager extends LMEmitter {
         }
     }
     isInPivotMode() {
-        return this.gridApi.isModuleRegistered('PivotModule') && this.gridApi.isPivotMode();
+        // SSRM comes with its own pivot module implementation
+        // see #ssrm_pivot_module
+        const isModuleRegistered = this.gridApi.isModuleRegistered('PivotModule') ||
+            this.gridApi.isModuleRegistered('ServerSideRowModelModule');
+        return isModuleRegistered && this.gridApi.isPivotMode();
     }
 }