@adaptabletools/adaptable 19.0.1 → 19.0.2

package/src/agGrid/ActionColumnRenderer.js

@@ -2,6 +2,7 @@ import SimpleButton from '../components/SimpleButton';
 import * as React from 'react';
 import { useRerender } from '../components/utils/useRerender';
 import { renderWithAdaptableContext } from '../View/renderWithAdaptableContext';
+import { LAYOUT_SELECT } from '../Redux/ActionsReducers/LayoutRedux';
 const ActionButtons = (props) => {
     const { buttons, adaptableApi, context, rerender } = props;
     return (React.createElement(React.Fragment, null, buttons.map((button, index) => {
@@ -65,6 +66,20 @@ export const ReactActionColumnRenderer = (props) => {
     if (!shouldRender) {
         return null;
     }
+    // subscribe to the LayoutChange event and rerender on change
+    const unsubscribe = adaptable.api.eventApi.on('AdaptableStateChanged', (eventInfo) => {
+        if (eventInfo.actionName === LAYOUT_SELECT) {
+            if (eventInfo.oldState.Layout.CurrentLayout !== eventInfo.newState.Layout.CurrentLayout) {
+                rerender();
+            }
+        }
+    });
+    // unsubscribe on unmount
+    React.useEffect(() => {
+        return () => {
+            unsubscribe();
+        };
+    }, []);
     const pkValue = adaptable.getPrimaryKeyValueFromRowNode(props.node, props.api);
     const buttonContext = Object.assign(Object.assign({ actionColumn, primaryKeyValue: pkValue, rowNode: props.node }, adaptable.api.internalApi.buildBaseContext()), { data: props.data });
     return (React.createElement("div", { className: "ab-ActionColumn" },
@@ -83,6 +98,7 @@ export class ActionColumnRenderer {
         if (!actionColumn || !actionButtons.length) {
             return;
         }
+        this.actionButtons = actionButtons;
         // create the cell
         this.eGui = document.createElement('div');
         this.eGui.className = 'ab-ActionColumn';
@@ -114,13 +130,22 @@ export class ActionColumnRenderer {
         const eGui = this.eGui;
         const doRender = () => {
             this.unmountReactRoot = adaptable.renderReactRoot(renderWithAdaptableContext(ActionButtons({
-                buttons: actionButtons,
+                buttons: this.actionButtons,
                 context: buttonContext,
                 rerender: doRender,
                 adaptableApi: adaptable.api,
             }), adaptable), eGui);
         };
         this.render = doRender;
+        this.layoutSwitchUnsubscribe = adaptable.api.eventApi.on('AdaptableStateChanged', (eventInfo) => {
+            if (eventInfo.actionName === LAYOUT_SELECT) {
+                if (eventInfo.oldState.Layout.CurrentLayout !== eventInfo.newState.Layout.CurrentLayout) {
+                    const { actionButtons: freshActionButtons } = adaptable.api.internalApi.getActionButtonsAndActionColumn(params.colDef);
+                    this.actionButtons = freshActionButtons;
+                    doRender();
+                }
+            }
+        });
         doRender();
     }
     // defined on init
@@ -138,8 +163,9 @@ export class ActionColumnRenderer {
     }
     // gets called when the cell is removed from the grid
     destroy() {
-        var _a;
-        (_a = this.unmountReactRoot) === null || _a === void 0 ? void 0 : _a.call(this);
+        var _a, _b;
+        (_a = this.layoutSwitchUnsubscribe) === null || _a === void 0 ? void 0 : _a.call(this);
+        (_b = this.unmountReactRoot) === null || _b === void 0 ? void 0 : _b.call(this);
         // do cleanup, remove event listener from button
         if (this.eGui) {
             this.eGui.removeEventListener('click', this.eventListener);

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -249,7 +249,6 @@ export declare class AdaptableAgGrid implements IAdaptable {
     getRowNodeByIndex(index: number): IRowNode;
     getAgGridStatusPanels(): import("@ag-grid-community/core").StatusPanelDef[];
     setDataValue(value: any, column: AdaptableColumn, primaryKeyValue: any, rowNode?: IRowNode): void;
-    isCellEditable(rowNode: IRowNode, column: Column): boolean;
     forAllRowNodesDo(func: (rowNode: IRowNode, rowIndex: number) => void, config?: {
         includeGroupRows?: boolean;
         filterFn?: (rowNode: IRowNode) => boolean;
@@ -285,6 +284,7 @@ export declare class AdaptableAgGrid implements IAdaptable {
     updateChart(chart: ChartDefinition): void;
     getChartModels(): import("@ag-grid-community/core").ChartModel[];
     getRowCount(): number;
+    getVisibleRowCount(): number;
     getColumnCount(): number;
     getVisibleColumnCount(): number;
     isGridGroupable(): boolean;

package/src/agGrid/AdaptableAgGrid.js

@@ -978,6 +978,14 @@ export class AdaptableAgGrid {
                 original_processPivotResultColDef === null || original_processPivotResultColDef === void 0 ? void 0 : original_processPivotResultColDef(colDef);
             };
         });
+        /**
+         * `maintainColumnOrder`
+         */
+        this.agGridOptionsService.setGridOptionsProperty(gridOptions, 'maintainColumnOrder', () => {
+            // see https://www.ag-grid.com/javascript-data-grid/column-updating-definitions/#maintain-column-order
+            // we want to always maintain the column order (provided by Adaptable Layouts), even when column definitions change
+            return true;
+        });
         /**
          * `columnTypes`
          */
@@ -1929,6 +1937,7 @@ export class AdaptableAgGrid {
         return rawValue;
     }
     updateColumnModelAndRefreshGrid(config) {
+        this.logger.info(`Updating Column Model and Refreshing Grid ${config ? `with config ${JSON.stringify(config)}` : ''}`);
         if (config === null || config === void 0 ? void 0 : config.preemptiveColumnStateRefresh) {
             this.deriveAdaptableColumnStateFromAgGrid();
         }
@@ -2488,10 +2497,6 @@ export class AdaptableAgGrid {
             }
         }
     }
-    isCellEditable(rowNode, column) {
-        // it's safe to rely on the AG Grid implementation because we override the colDef.editable property, which is in this case the single source of truth
-        return column === null || column === void 0 ? void 0 : column.isCellEditable(rowNode);
-    }
     forAllRowNodesDo(func, config) {
         this.agGridAdapter.getAgGridApi().forEachNode((rowNode, rowIndex) => {
             const includeGroupRows = (config === null || config === void 0 ? void 0 : config.includeGroupRows) || !this.isGroupRowNode(rowNode);
@@ -2692,6 +2697,10 @@ export class AdaptableAgGrid {
         return this.agGridAdapter.getAgGridApi().getChartModels();
     }
     getRowCount() {
+        const allNodes = this.getAllRowNodes({ includeGroupRows: false });
+        return allNodes.length;
+    }
+    getVisibleRowCount() {
         return this.agGridAdapter.getAgGridApi().getDisplayedRowCount();
     }
     getColumnCount() {
@@ -3434,7 +3443,11 @@ export class AdaptableAgGrid {
             });
             perfApplyColumnState.end();
             this.api.gridApi.setColumnSorts(layout.ColumnSorts);
-            this.agGridAdapter.getAgGridApi().setPivotColumns(layout.PivotColumns || []);
+            if (shouldUpdatePivoted) {
+                // simply setting PivotColumns fires an AG Grid 'modelChanged' event which cascades to a full row reload in SSRM
+                // this includes the case when we simply set an empty array of pivot columns
+                this.agGridAdapter.getAgGridApi().setPivotColumns(layout.PivotColumns || []);
+            }
             // aggrid 25.1.0 introduced a bug such that a layout that has a grouped column, if the column has enableRowGroup: true but not rowGroup: true
             // the group column is not possitioned correctly at the start of the layout
             // see the test in layout/layout-switch/"should be able to switch from grouped to non-grouped and back"

package/src/agGrid/AgGridAdapter.d.ts

@@ -60,6 +60,7 @@ export declare class AgGridAdapter {
      */
     assignColumnIdsToColDefs(colDefs?: (ColDef | ColGroupDef)[]): void;
     patchColDefs(colDefs: (ColDef | ColGroupDef)[], patchFn: (colDef: ColDef) => void): void;
+    traverseColDefs(colDefs: (ColDef | ColGroupDef)[], modifyFn: (colDef: ColDef) => ColDef | null): (ColDef | ColGroupDef)[];
     getDefaultColumnDefinition(): GridOptions['defaultColDef'];
     _agGridApi_getValue(colKey: string | Column, rowNode: IRowNode, gridApi?: GridApi): any;
 }

package/src/agGrid/AgGridAdapter.js

@@ -587,6 +587,18 @@ export class AgGridAdapter {
         };
         colDefs.forEach((colDef) => applyPatch(colDef));
     }
+    traverseColDefs(colDefs, modifyFn) {
+        const applyModification = (colDef) => {
+            if ('children' in colDef) {
+                const updatedChildren = colDef.children.map(applyModification).filter(Boolean);
+                return Object.assign(Object.assign({}, colDef), { children: updatedChildren });
+            }
+            else {
+                return modifyFn(colDef);
+            }
+        };
+        return colDefs.map(applyModification).filter(Boolean);
+    }
     getDefaultColumnDefinition() {
         var _a, _b;
         // for early init phase, gridApi might not be ready yet

package/src/agGrid/AgGridColumnAdapter.d.ts

@@ -36,6 +36,7 @@ export declare class AgGridColumnAdapter {
     private isQuickSearchActive;
     private getEditableCellClass;
     private getReadonlyCellClass;
+    private getEditedCellClass;
     private getAlertCellClass;
     private getFlashingCellClass;
     private getNoteCellClassName;
@@ -44,6 +45,7 @@ export declare class AgGridColumnAdapter {
     private getQuickSearchCellStyle;
     private getReadOnlyCellStyle;
     private getEditableCellStyle;
+    private getEditedCellStyle;
     /**
      * The combination of styled column and format cells
      * This functiond decides when the two can be merged.

package/src/agGrid/AgGridColumnAdapter.js

@@ -138,6 +138,7 @@ export class AgGridColumnAdapter {
                 const isQuickSearchActive = hasQuickSearchStyleClassName && this.isQuickSearchActive(gridCell, params);
                 const editableClassName = this.getEditableCellClass(gridCell, params);
                 const readonlyClassName = this.getReadonlyCellClass(gridCell, params);
+                const editedClassName = this.getEditedCellClass(gridCell, params);
                 const highlightAlertClassName = this.getAlertCellClass(gridCell, params);
                 const flashingClassName = this.getFlashingCellClass(gridCell, params);
                 const styledColumn = this.adaptableApi.styledColumnApi.getStyledColumnForColumnId(colId);
@@ -152,6 +153,7 @@ export class AgGridColumnAdapter {
                     isQuickSearchActive ? quickSearchStyleClassName : null,
                     editableClassName,
                     readonlyClassName,
+                    editedClassName,
                     highlightAlertClassName,
                     flashingClassName,
                     noteClassName,
@@ -174,7 +176,7 @@ export class AgGridColumnAdapter {
                 const gridCell = this.adaptableInstance.getGridCellFromRowNode(params.node, abColumn.columnId);
                 const isQuickSearchActive = hasQuickSearchStyle && this.isQuickSearchActive(gridCell, params);
                 const userDefined = typeof userCellStyle === 'function' ? userCellStyle(params) : userCellStyle;
-                const result = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, userDefined), this.getReadOnlyCellStyle(gridCell, params)), this.getEditableCellStyle(gridCell, params)), this.getFormatColumnAndStyledColumnCellStyle(gridCell, params)), (isQuickSearchActive ? quickSearchStyle : {})), this.getAlertCellStyle(gridCell, params)), this.getFlashingCellStyle(gridCell, params)), this.getCellHighlightStyle(gridCell, params));
+                const result = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, userDefined), this.getReadOnlyCellStyle(gridCell, params)), this.getEditableCellStyle(gridCell, params)), this.getEditedCellStyle(gridCell, params)), this.getFormatColumnAndStyledColumnCellStyle(gridCell, params)), (isQuickSearchActive ? quickSearchStyle : {})), this.getAlertCellStyle(gridCell, params)), this.getFlashingCellStyle(gridCell, params)), this.getCellHighlightStyle(gridCell, params));
                 return normalizeStyleForAgGrid(result);
             };
             return cellStyle;
@@ -424,19 +426,9 @@ export class AgGridColumnAdapter {
             if (typeof userValue === 'boolean' && userValue === false) {
                 return userValue;
             }
-            const cellEditableFn = this.adaptableOptions.editOptions.isCellEditable;
             const editableCallback = (params) => {
-                // Adaptable Row Summarie rows are not editable
-                //        if (params.node.data[ROW_SUMMARY_ROW_ID]) {
-                if (this.adaptableApi.gridApi.isSummaryNode(params.node)) {
-                    return false;
-                }
-                if (!cellEditableFn) {
-                    return typeof userValue === 'function' ? userValue(params) : userValue;
-                }
                 const gridCell = this.adaptableInstance.getGridCellFromRowNode(params.node, params.column.getColId());
-                const cellEditableContext = Object.assign({ gridCell }, this.adaptableApi.internalApi.buildBaseContext());
-                return cellEditableFn(cellEditableContext);
+                return this.adaptableApi.gridApi.isCellEditable(gridCell);
             };
             return editableCallback;
         });
@@ -586,6 +578,14 @@ export class AgGridColumnAdapter {
         const isCellReadonly = !this.adaptableApi.gridApi.isCellEditable(gridCell);
         return isCellReadonly ? readonlyCellStyle.ClassName : null;
     }
+    getEditedCellClass(gridCell, params) {
+        const editedCellStyle = this.adaptableApi.userInterfaceApi.getEditedCellStyle();
+        if (!(editedCellStyle === null || editedCellStyle === void 0 ? void 0 : editedCellStyle.ClassName)) {
+            return null;
+        }
+        const isCellEdited = this.adaptableApi.gridApi.isCellEdited(gridCell);
+        return isCellEdited ? editedCellStyle.ClassName : null;
+    }
     getAlertCellClass(gridCell, params) {
         var _a, _b;
         const alert = this.adaptableApi.alertApi.internalApi.getAdaptableAlertWithHighlightCell(gridCell.column.columnId, params.node);
@@ -686,6 +686,18 @@ export class AgGridColumnAdapter {
         }
         return undefined;
     }
+    getEditedCellStyle(gridCell, params) {
+        const editedCellStyle = this.adaptableApi.userInterfaceApi.getEditedCellStyle();
+        if (!editedCellStyle) {
+            return undefined;
+        }
+        if (gridCell) {
+            if (this.adaptableApi.gridApi.isCellEdited(gridCell)) {
+                return convertAdaptableStyleToCSS(editedCellStyle);
+            }
+        }
+        return undefined;
+    }
     /**
      * The combination of styled column and format cells
      * This functiond decides when the two can be merged.

package/src/agGrid/defaultAdaptableOptions.js

@@ -284,6 +284,7 @@ const DefaultAdaptableOptions = {
         colorPalette: UIHelper.getDefaultColors(),
         editableCellStyle: undefined,
         readOnlyCellStyle: undefined,
+        editedCellStyle: undefined,
         styleClassNames: EMPTY_ARRAY,
         permittedValues: undefined,
         editLookUpItems: undefined,

package/src/env.js

@@ -1,5 +1,5 @@
 export default {
     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: 1726230070583 || Date.now(),
-    VERSION: "19.0.1" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1728328912394 || Date.now(),
+    VERSION: "19.0.2" || '--current-version--',
 };