@adaptabletools/adaptable 18.1.13 → 18.1.15-canary.0

package/src/agGrid/AdaptableAgGrid.js

@@ -1,6 +1,6 @@
 import throttle from 'lodash/throttle';
 import debounce from 'lodash/debounce';
-import { createGrid, Events, ModuleNames, RowNode, GridOptionsService, } from '@ag-grid-community/core';
+import { createGrid, EventService, GridOptionsService, LocalEventService, ModuleNames, } from '@ag-grid-community/core';
 import { AdaptableLogger } from './AdaptableLogger';
 import { PrimaryKeyDocsLink } from '../Utilities/Constants/DocumentationLinkConstants';
 import StringExtensions from '../Utilities/Extensions/StringExtensions';
@@ -17,10 +17,8 @@ import { CellPopupService } from '../Utilities/Services/CellPopupService';
 import { ChartingService } from '../Utilities/Services/ChartingService';
 import { ThemeService } from '../Utilities/Services/ThemeService';
 import { ValidationService } from '../Utilities/Services/ValidationService';
-import { ReportService } from '../Utilities/Services/ReportService';
 import { ModuleService } from '../Utilities/Services/ModuleService';
 import { CalculatedColumnExpressionService } from '../Utilities/Services/CalculatedColumnExpressionService';
-import { EntitlementService } from '../Utilities/Services/EntitlementService';
 import { QueryLanguageService } from '../Utilities/Services/QueryLanguageService';
 import { AlertService } from '../Utilities/Services/AlertService';
 import { TeamSharingService } from '../Utilities/Services/TeamSharingService';
@@ -85,7 +83,6 @@ import { isWeightedAverageAggregation, WEIGHTED_AVERAGE_AGG_FN_NAME, } from '../
 import lodashIsEqual from 'lodash/isEqual';
 import { RowEditService } from '../Utilities/Services/RowEditService';
 import { weightedAverage } from './weightedAverage';
-import { sortWithOrderArray } from '../Utilities/sortWithOrder';
 import { FilterOnDataChangeOptions } from '../PredefinedConfig/Common/Enums';
 import ObjectFactory, { createBaseContext } from '../Utilities/ObjectFactory';
 import { ADAPTABLE_PUBLISH_TIMESTAMP } from '../EnvVars';
@@ -95,45 +92,49 @@ import { AdaptableLoadingScreen } from '../View/Components/Popups/AdaptableLoadi
 import { createElement } from 'react';
 import { removeUuidAndSource } from '../Utilities/Helpers/AdaptableHelper';
 import { buildSortedColumnStateForLayout } from './buildSortedColumnStateForLayout';
-const RowNodeProto = RowNode.prototype;
-const RowNode_dispatchLocalEvent = RowNodeProto.dispatchLocalEvent;
+import { ROW_SUMMARY_ROW_ID } from '../PredefinedConfig/Common/RowSummary';
+const LocalEventService_Prototype = LocalEventService.prototype;
+const LocalEventService_dispatchEvent = LocalEventService_Prototype.dispatchEvent;
 const GridOptionsService_updateGridOptions = GridOptionsService.prototype.updateGridOptions;
-/**
- * AgGrid does not expose 'cellChanged' and 'dataChanged'
- * so we have to override `dispatchLocalEvent`
- * and hook our own functionality into it
- */
-RowNodeProto.dispatchLocalEvent = function (event) {
-    const node = event.node;
-    const result = RowNode_dispatchLocalEvent.apply(this, arguments);
-    const extractGridApiFromRowNode = (rowNode) => {
-        var _a, _b, _c, _d;
-        // starting with AG Grid 26.1.0 the gridApi is wrapped in a Beans property
-        const rowNodeApi = (_b = (_a = rowNode === null || rowNode === void 0 ? void 0 : rowNode.beans) === null || _a === void 0 ? void 0 : _a.gridApi) !== null && _b !== void 0 ? _b : (_d = (_c = rowNode === null || rowNode === void 0 ? void 0 : rowNode.beans) === null || _c === void 0 ? void 0 : _c.gos) === null || _d === void 0 ? void 0 : _d.api;
-        if (!rowNodeApi) {
-            AdaptableLogger.consoleErrorBase(`No GridAPI found in passed RowNode, this should never happen!`, rowNode);
-        }
-        return rowNodeApi;
-    };
-    // we don't know from which instance of aggrid this is coming,
-    // as this fn is shared by all instances
-    if (node) {
-        AdaptableAgGrid.forEachAdaptable((adaptable) => {
+const EventService_Prototype = EventService.prototype;
+const EventService_wireBeans = EventService_Prototype.wireBeans;
+// AG GRID obfuscates its internals, this is (currently) the best way to get hold of its internal services
+let DANGER_AG_GRID_BEANS;
+EventService_Prototype.wireBeans = function (beans) {
+    EventService_wireBeans.apply(this, arguments);
+    DANGER_AG_GRID_BEANS = beans;
+};
+LocalEventService_Prototype.dispatchEvent = function (event) {
+    LocalEventService_dispatchEvent.apply(this, arguments);
+    if (event.type === 'cellChanged' || event.type === 'dataChanged') {
+        const eventRowNode = event.node;
+        const extractGridApiFromRowNode = (rowNode) => {
             var _a;
-            if (extractGridApiFromRowNode(node) !== ((_a = adaptable.agGridAdapter) === null || _a === void 0 ? void 0 : _a.getAgGridApi(true))) {
-                // the event is coming from another aggrid instance
-                // so IGNORE IT
-                return;
+            const rowNodeApi = (_a = rowNode === null || rowNode === void 0 ? void 0 : rowNode.beans) === null || _a === void 0 ? void 0 : _a.gridApi;
+            if (!rowNodeApi) {
+                AdaptableLogger.consoleErrorBase(`No GridAPI found in passed RowNode, this should never happen!`, rowNode);
             }
-            // we're on the correct instance, so do this
-            //@ts-ignore
-            const fn = adaptable.rowListeners ? adaptable.rowListeners[event.type] : null;
-            if (fn) {
-                fn(event);
-            }
-        });
+            return rowNodeApi;
+        };
+        // we don't know from which instance of aggrid this is coming,
+        // as this fn is shared by all instances
+        if (eventRowNode) {
+            AdaptableAgGrid.forEachAdaptable((adaptable) => {
+                var _a;
+                if (extractGridApiFromRowNode(eventRowNode) !== ((_a = adaptable.agGridAdapter) === null || _a === void 0 ? void 0 : _a.getAgGridApi(true))) {
+                    // the event is coming from another aggrid instance
+                    // so IGNORE IT
+                    return;
+                }
+                // we're on the correct instance, so do this
+                //@ts-ignore
+                const fn = adaptable.rowListeners ? adaptable.rowListeners[event.type] : null;
+                if (fn) {
+                    fn(event);
+                }
+            });
+        }
     }
-    return result;
 };
 const adaptableInstances = {};
 const publishTimestamp = Number(ADAPTABLE_PUBLISH_TIMESTAMP);
@@ -199,6 +200,9 @@ export class AdaptableAgGrid {
     static dismissInstance(adaptable) {
         delete adaptableInstances[adaptable._id];
     }
+    get isAgGridInitialising() {
+        return this.lifecycleState === 'initAgGrid';
+    }
     get isReady() {
         return this.lifecycleState === 'ready';
     }
@@ -334,7 +338,7 @@ export class AdaptableAgGrid {
         }
         this.forPlugins((plugin) => plugin.afterInitialStateLoaded(this));
         // do this now so it sets module entitlements
-        this.EntitlementService.setModulesEntitlements();
+        this.api.entitlementApi.internalApi.setModulesEntitlements();
         /**
          * At this point it's mandatory to have the ALL the Adaptable blocks initialized:
          * Store, APIs, Services, Modules
@@ -349,6 +353,9 @@ export class AdaptableAgGrid {
         this.lifecycleState = 'initAgGrid';
         this.agGridAdapter.initialGridOptions = gridOptions;
         const perfInitAgGrid = this.logger.beginPerf(`initAgGrid()`);
+        // AG Grid evaluates early on the floatingFilter params, so we need to "suppres" the floating filter temporarily
+        // we will reset it once Adaptable is ready
+        this.agGridColumnAdapter.setupColumnFloatingFilterTemporarily(gridOptions);
         const agGridApi = await this.initializeAgGrid(gridOptions, config.modules, config.renderAgGridFrameworkComponent);
         if (agGridApi === false) {
             this.logger.consoleError(`Adaptable failed to initialize AG Grid!`);
@@ -360,6 +367,7 @@ export class AdaptableAgGrid {
         // we need to intercept several AG Grid Api methods and trigger Adaptale state changes
         this.monkeyPatchingGridOptionsUpdates(agGridApi);
         this.agGridAdapter.setAgGridApi(agGridApi);
+        this.lifecycleState = 'agGridReady';
         this.logger.info(`Registered AG Grid modules: `, this.agGridAdapter.getRegisteredModuleNames().sort());
         /**
          * At this point AG Grid is initialized!
@@ -427,15 +435,15 @@ export class AdaptableAgGrid {
         perfInitAdaptableAgGrid.end();
         return Promise.resolve(this.api);
     }
-    normalizeAdaptableState(state, gridOptions) {
-        state = this.normaliseLayoutState(state, gridOptions);
+    normalizeAdaptableState(state, agGridOptions) {
+        state = this.normaliseLayoutState(state, agGridOptions);
         state = this.normaliseToolPanelState(state);
         return state;
     }
     normaliseLayoutState(state, gridOptions) {
         var _a, _b, _c, _d, _e, _f;
         if (this.shouldCreateDefaultLayout(state, this.adaptableOptions)) {
-            const defaultLayout = this.createDefaultLayout(state, gridOptions.columnDefs, gridOptions.autoGroupColumnDef);
+            const defaultLayout = this.createDefaultLayout(state, gridOptions);
             const layoutState = state.Layout || {};
             const availableLayouts = layoutState.Layouts || [];
             availableLayouts.push(defaultLayout);
@@ -598,12 +606,20 @@ export class AdaptableAgGrid {
                 };
             }
             return (params) => {
-                var _a;
-                if (params.data[primaryKey]) {
-                    return params.data[primaryKey];
-                }
-                // row does not have primary key => might be a group row
-                const parentKeys = (_a = params.parentKeys) !== null && _a !== void 0 ? _a : [];
+                var _a, _b, _c;
+                if ((_a = params.data) === null || _a === void 0 ? void 0 : _a[primaryKey]) {
+                    const primaryKeyValue = params.data[primaryKey];
+                    return typeof primaryKeyValue === 'number'
+                        ? `${primaryKeyValue}`
+                        : params.data[primaryKey];
+                }
+                // might be a summary row
+                if ((_b = params.data) === null || _b === void 0 ? void 0 : _b[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
+                const parentKeys = (_c = params.parentKeys) !== null && _c !== void 0 ? _c : [];
                 const values = Object.values(params.data);
                 if (values.length) {
                     const id = [...parentKeys, values[0]].join('/');
@@ -804,7 +820,7 @@ export class AdaptableAgGrid {
                 // lucky us, no sideBar is defined, so we don't have to do anything
                 return original_sideBar;
             }
-            const isAdaptableToolPanelHidden = this.EntitlementService.isModuleHiddenEntitlement('ToolPanel');
+            const isAdaptableToolPanelHidden = this.api.entitlementApi.isModuleHiddenEntitlement('ToolPanel');
             const adaptableToolPanelDef = {
                 id: GeneralConstants.ADAPTABLE_TOOLPANEL_ID,
                 toolPanel: GeneralConstants.ADAPTABLE_TOOLPANEL_COMPONENT,
@@ -1032,7 +1048,7 @@ export class AdaptableAgGrid {
      * Either initializes the AG Grid instance or delegates it to the framework wrappers (React/Anglar)
      */
     async initializeAgGrid(gridOptions, modules, renderAgGridFrameworkComponent) {
-        var _a, _b, _c;
+        var _a;
         if (renderAgGridFrameworkComponent) {
             const result = await renderAgGridFrameworkComponent(gridOptions);
             if (result === false) {
@@ -1055,7 +1071,7 @@ export class AdaptableAgGrid {
             if (!this.getAgGridContainerElement()) {
                 // initialize the agGridContainerElement from the AgGrid instance
                 // @ts-ignore
-                const gridRoot = (_c = (_b = (_a = agGridApi.ctrlsService) === null || _a === void 0 ? void 0 : _a.getGridBodyCtrl) === null || _b === void 0 ? void 0 : _b.call(_a)) === null || _c === void 0 ? void 0 : _c.eGridBody;
+                const gridRoot = (_a = this.DANGER_getPrivateAgGridBeans()) === null || _a === void 0 ? void 0 : _a.eGridDiv;
                 const gridContainer = gridRoot === null || gridRoot === void 0 ? void 0 : gridRoot.closest('[class*="ag-theme"]');
                 if (!gridContainer) {
                     this.logger.consoleError(`No AG Grid container could be derived from the Adaptable framework wrapper.
@@ -1102,14 +1118,10 @@ export class AdaptableAgGrid {
             }
             return false;
         };
-        const isColGroupDef = (columnDefinition) => {
-            // @ts-ignore
-            return columnDefinition['children'] != null;
-        };
         const processedSpecialColDefIds = [];
         const mapColDefs = (colDefs) => {
             return colDefs.map((colDef) => {
-                if (isColGroupDef(colDef)) {
+                if (this.agGridColumnAdapter.isColGroupDef(colDef)) {
                     // if it's a group column, recursively map its children
                     colDef.children = mapColDefs(colDef.children);
                     return colDef;
@@ -1245,7 +1257,7 @@ export class AdaptableAgGrid {
                 .map((colDef) => colDef.colId),
         };
         agGridState.columnOrder = {
-            orderedColIds: sortWithOrderArray(allAgGridColDefIds, currentLayout.Columns || [], {
+            orderedColIds: ArrayExtensions.sortArrayWithOrder(allAgGridColDefIds, currentLayout.Columns || [], {
                 sortUnorderedItems: false,
             }),
         };
@@ -1354,12 +1366,12 @@ export class AdaptableAgGrid {
             this.deriveAdaptableColumnStateFromAgGrid();
         }, HALF_SECOND);
         const columnEventsThatTriggersStateChange = [
-            Events.EVENT_COLUMN_MOVED,
-            Events.EVENT_GRID_COLUMNS_CHANGED,
-            Events.EVENT_COLUMN_EVERYTHING_CHANGED,
-            Events.EVENT_DISPLAYED_COLUMNS_CHANGED,
-            Events.EVENT_COLUMN_VISIBLE,
-            Events.EVENT_NEW_COLUMNS_LOADED,
+            'columnMoved',
+            'gridColumnsChanged',
+            'columnEverythingChanged',
+            'displayedColumnsChanged',
+            'columnVisible',
+            'newColumnsLoaded',
         ];
         this.agGridAdapter.getAgGridApi().addGlobalListener((this.listenerGlobalColumnEventsThatTriggerStateChange = (type) => {
             if (columnEventsThatTriggersStateChange.indexOf(type) > -1) {
@@ -1370,7 +1382,7 @@ export class AdaptableAgGrid {
          * Use Case: User has started inline editing but its distabled in Action Row Options
          * Action: Stop editing
          */
-        this.agGridAdapter.getAgGridApi().addEventListener(Events.EVENT_CELL_EDITING_STARTED, (this.listenerCellEditingStarted = () => {
+        this.agGridAdapter.getAgGridApi().addEventListener('cellEditingStarted', (this.listenerCellEditingStarted = () => {
             var _a;
             if ((_a = this.adaptableOptions.actionRowOptions) === null || _a === void 0 ? void 0 : _a.disableInlineEditing)
                 this.agGridAdapter.getAgGridApi().stopEditing();
@@ -1381,7 +1393,7 @@ export class AdaptableAgGrid {
          * Action2: Ensure that we have set column data types
          * Note: Deals with scenario where the data is provided to AdapTable after grid has been setup
          */
-        this.agGridAdapter.getAgGridApi().addEventListener(Events.EVENT_FIRST_DATA_RENDERED, (this.listenerFirstDataRendered = () => {
+        this.agGridAdapter.getAgGridApi().addEventListener('firstDataRendered', (this.listenerFirstDataRendered = () => {
             if (this.initWithLazyData) {
                 this.updateColumnModelAndRefreshGrid({ skipColDefsRefresh: true });
                 this.api.calculatedColumnApi.refreshAggregatedCalculatedColumns();
@@ -1394,7 +1406,7 @@ export class AdaptableAgGrid {
          * Action 1: Autosize pivot columns when entering pivot mode (if autosize pivot in Layout is true)
          * Action 2: Set pivot mode on / off in api as necessary
          */
-        this.agGridAdapter.getAgGridApi().addEventListener(Events.EVENT_COLUMN_PIVOT_MODE_CHANGED, (this.listenerPivotModeChanged = (params) => {
+        this.agGridAdapter.getAgGridApi().addEventListener('columnPivotModeChanged', (this.listenerPivotModeChanged = (params) => {
             if (params.type == 'columnPivotModeChanged' &&
                 params.columnApi != null &&
                 params.columnApi.columnController != null &&
@@ -1412,7 +1424,7 @@ export class AdaptableAgGrid {
          * Use Case: A pivot column has changed
          * Action: Autosize pivot columns (if autosize pivot in Layout is true)
          */
-        this.agGridAdapter.getAgGridApi().addEventListener(Events.EVENT_COLUMN_PIVOT_CHANGED, (this.listenerPivotChanged = (params) => {
+        this.agGridAdapter.getAgGridApi().addEventListener('columnPivotChanged', (this.listenerPivotChanged = (params) => {
             if (params.type == 'columnPivotChanged' &&
                 params.columnApi != null &&
                 params.columnApi.columnController != null &&
@@ -1427,13 +1439,13 @@ export class AdaptableAgGrid {
          * Action: Save the Layout (on a debounce)
          */
         const columnEventsThatTriggersAutoLayoutSave = [
-            Events.EVENT_COLUMN_PINNED,
-            Events.EVENT_COLUMN_PIVOT_CHANGED,
-            Events.EVENT_COLUMN_PIVOT_MODE_CHANGED,
-            Events.EVENT_DISPLAYED_COLUMNS_CHANGED,
-            Events.EVENT_SORT_CHANGED,
-            Events.EVENT_COLUMN_ROW_GROUP_CHANGED,
-            Events.EVENT_COLUMN_VALUE_CHANGED,
+            'columnPinned',
+            'columnPivotChanged',
+            'columnPivotModeChanged',
+            'displayedColumnsChanged',
+            'sortChanged',
+            'columnRowGroupChanged',
+            'columnValueChanged',
         ];
         // ADD filter event
         this.agGridAdapter.getAgGridApi().addGlobalListener((this.listenerGlobalColumnEventsThatTriggerAutoLayoutSave = (type) => {
@@ -1452,8 +1464,8 @@ export class AdaptableAgGrid {
             this.updateLayoutFromGrid();
         }, HALF_SECOND);
         const rowGroupEventsThatTriggersAutoLayoutSave = [
-            Events.EVENT_ROW_GROUP_OPENED,
-            Events.EVENT_EXPAND_COLLAPSE_ALL,
+            'rowGroupOpened',
+            'expandOrCollapseAll',
         ];
         this.agGridAdapter.getAgGridApi().addGlobalListener((this.listenerGlobalRowGroupEventsThatTriggerAutoLayoutSave = (type) => {
             if (rowGroupEventsThatTriggersAutoLayoutSave.indexOf(type) > -1) {
@@ -1466,7 +1478,7 @@ export class AdaptableAgGrid {
          * Use Case: Column Row Grouping changes and 'restoreUngroupedColumns' is true
          * Action: Make the column invisiblel
          */
-        this.agGridAdapter.getAgGridApi().addEventListener(Events.EVENT_COLUMN_ROW_GROUP_CHANGED, (this.listenerColumnRowGroupChanged = (params) => {
+        this.agGridAdapter.getAgGridApi().addEventListener('columnRowGroupChanged', (this.listenerColumnRowGroupChanged = (params) => {
             var _a, _b;
             if (this.api.internalApi.isGridInPivotMode()) {
                 return;
@@ -1480,7 +1492,7 @@ export class AdaptableAgGrid {
          * Action 1: Save the Layout (on a debounce)
          * Action 2: Emit the internal ColumnResized event - used by Sparkline Column (in Charts)
          */
-        this.agGridAdapter.getAgGridApi().addEventListener(Events.EVENT_COLUMN_RESIZED, (this.listenerColumnResized = (params) => {
+        this.agGridAdapter.getAgGridApi().addEventListener('columnResized', (this.listenerColumnResized = (params) => {
             if (params.finished == true && params.type == 'columnResized' && params.column) {
                 this.debouncedSaveGridLayout(params.type);
             }
@@ -1496,9 +1508,9 @@ export class AdaptableAgGrid {
             this.refreshSelectedRowsState();
         }, HALF_SECOND);
         const columnEventsThatTriggerSetRowSelection = [
-            Events.EVENT_ROW_GROUP_OPENED,
-            Events.EVENT_SELECTION_CHANGED,
-            Events.EVENT_ROW_SELECTED,
+            'rowGroupOpened',
+            'selectionChanged',
+            'rowSelected',
         ];
         this.agGridAdapter.getAgGridApi().addGlobalListener((this.listenerGlobalSetRowSelection = (type) => {
             if (ArrayExtensions.ContainsItem(columnEventsThatTriggerSetRowSelection, type)) {
@@ -1515,7 +1527,7 @@ export class AdaptableAgGrid {
             }
             this.refreshSelectedCellsState();
         }, 250);
-        this.agGridAdapter.getAgGridApi().addEventListener(Events.EVENT_RANGE_SELECTION_CHANGED, (this.listenerRangeSelectionChanged = (params) => {
+        this.agGridAdapter.getAgGridApi().addEventListener('rangeSelectionChanged', (this.listenerRangeSelectionChanged = (params) => {
             if (params.finished == true) {
                 this.debouncedSetSelectedCells();
             }
@@ -1525,18 +1537,18 @@ export class AdaptableAgGrid {
          * Action1: Update AdapTable Sort Info
          * Action2: Set Selected Cells (on a debounce)
          */
-        this.agGridAdapter.getAgGridApi().addEventListener(Events.EVENT_SORT_CHANGED, (this.listenerSortChanged = () => {
+        this.agGridAdapter.getAgGridApi().addEventListener('sortChanged', (this.listenerSortChanged = () => {
             this.onSortChanged();
             this.debouncedSetSelectedCells();
         }));
         const eventsThatTriggerChartingChanges = [
-            Events.EVENT_CHART_CREATED,
+            'chartCreated',
             /** Chart Range selection has changed */
-            Events.EVENT_CHART_RANGE_SELECTION_CHANGED,
+            'chartRangeSelectionChanged',
             /** Chart Options have changed */
-            Events.EVENT_CHART_OPTIONS_CHANGED,
+            'chartOptionsChanged',
             /** Chart was destroyed */
-            Events.EVENT_CHART_DESTROYED,
+            'chartDestroyed',
         ];
         const chartingModule = this.ModuleService.getModuleById('Charting');
         if (chartingModule.isModuleAvailable()) {
@@ -1591,17 +1603,7 @@ export class AdaptableAgGrid {
     }
     performAudit(action, oldState, newState) {
         if (this.isReady) {
-            const adaptableStateChangedInfo = {
-                adaptableApi: this.api,
-                actionName: action.type,
-                clientTimestamp: new Date(),
-                userName: this.adaptableOptions.userName,
-                adaptableId: this.adaptableOptions.adaptableId,
-                adaptableStateKey: this.adaptableOptions.adaptableStateKey,
-                action: action,
-                oldState: oldState,
-                newState: newState,
-            };
+            const adaptableStateChangedInfo = Object.assign(Object.assign({ actionName: action.type, clientTimestamp: new Date() }, this.api.internalApi.buildBaseContext()), { adaptableStateKey: this.adaptableOptions.adaptableStateKey, action: action, oldState: oldState, newState: newState });
             this.api.eventApi.emit('AdaptableStateChanged', adaptableStateChangedInfo);
         }
     }
@@ -1636,10 +1638,8 @@ export class AdaptableAgGrid {
         this.ChartingService = new ChartingService(this.api);
         this.ThemeService = new ThemeService(this.api);
         this.ValidationService = new ValidationService(this.api);
-        this.ReportService = new ReportService(this.api);
         this.ModuleService = new ModuleService(this.api);
         this.CalculatedColumnExpressionService = new CalculatedColumnExpressionService(this.api);
-        this.EntitlementService = new EntitlementService(this.api);
         this.QueryLanguageService = new QueryLanguageService(this.api);
         this.AlertService = new AlertService(this.api);
         this.TeamSharingService = new TeamSharingService(this.api);
@@ -1713,20 +1713,27 @@ export class AdaptableAgGrid {
         });
     }
     validatePrimaryKey() {
+        var _a;
         if (this.hasAutogeneratedPrimaryKey) {
             return;
         }
         const primaryKey = this.adaptableOptions.primaryKey;
+        // first check if there is a primary key column
         const primaryKeyColDef = this.agGridAdapter.getAgGridApi().getColumnDef(primaryKey);
         if (!primaryKeyColDef) {
-            const errorMessage = `The Primary Key Column '${this.adaptableOptions.primaryKey}' does not exist.  This will affect many functions in Adaptable.`;
-            if (this.adaptableOptions.alertOptions.showMissingPrimaryKeyAlert) {
-                // show an alert if that is the option
-                this.api.alertApi.showAlertError('No Primary Key', errorMessage);
-            }
-            else {
-                if (this.adaptableOptions.columnOptions.showMissingColumnsWarning) {
-                    this.logger.consoleError(errorMessage);
+            let errorMessage;
+            // if no primary key column then lets check the first row to see if its a data item
+            const primaryKeyDataItem = (_a = this.getFirstRowNode()) === null || _a === void 0 ? void 0 : _a.data[primaryKey];
+            if (!primaryKeyDataItem) {
+                errorMessage = `The Primary Key '${this.adaptableOptions.primaryKey}' does not exist.  This will affect many functions in AdapTable.`;
+                if (this.adaptableOptions.alertOptions.showMissingPrimaryKeyAlert) {
+                    // show an alert if that is the option
+                    this.api.alertApi.showAlertError('No Primary Key', errorMessage);
+                }
+                else {
+                    if (this.adaptableOptions.columnOptions.showMissingColumnsWarning) {
+                        this.logger.consoleError(errorMessage);
+                    }
                 }
             }
         }
@@ -1855,7 +1862,6 @@ export class AdaptableAgGrid {
         return this.getDisplayValueFromRawValue(rowNode, columnId, rawValue);
     }
     getDisplayValueFromRawValue(rowNode, columnId, rawValue) {
-        var _a;
         const isActionColumn = this.api.columnApi.isActionColumn(columnId);
         if (isActionColumn) {
             return this.getCleanValue(rawValue);
@@ -1871,8 +1877,7 @@ export class AdaptableAgGrid {
                     colDef,
                     column,
                     api: this.agGridAdapter.getAgGridApi(),
-                    columnApi: (_a = this.agGridAdapter.getLiveGridOptions()) === null || _a === void 0 ? void 0 : _a.columnApi,
-                    context: this.agGridAdapter.getLiveGridOptions().context,
+                    context: this.agGridAdapter.getGridOption('context'),
                 };
                 const formattedValue = colDef.valueFormatter(params);
                 return formattedValue || '';
@@ -2297,7 +2302,7 @@ export class AdaptableAgGrid {
                 };
             }),
             layout: Object.assign(Object.assign({}, layout), { Columns: visibleColumnList }),
-            gridOptions: this.agGridAdapter.getLiveGridOptions(),
+            groupDisplayType: this.agGridAdapter.getGridOption('groupDisplayType'),
         });
     }
     getDistinctValuesForColumn(column, distinctValuesParams) {
@@ -2439,8 +2444,8 @@ export class AdaptableAgGrid {
         return this.agGridAdapter.getAgGridApi().getDisplayedRowAtIndex(index);
     }
     getAgGridStatusPanels() {
-        var _a, _b, _c;
-        return (_c = (_b = (_a = this.agGridAdapter.getLiveGridOptions()) === null || _a === void 0 ? void 0 : _a.statusBar) === null || _b === void 0 ? void 0 : _b.statusPanels) !== null && _c !== void 0 ? _c : [];
+        var _a, _b;
+        return (_b = (_a = this.agGridAdapter.getGridOption('statusBar')) === null || _a === void 0 ? void 0 : _a.statusPanels) !== null && _b !== void 0 ? _b : [];
     }
     setDataValue(value, column, primaryKeyValue, rowNode) {
         // note: because we use RowNode.setDataValue() this will cause Validation to fire
@@ -2938,35 +2943,35 @@ export class AdaptableAgGrid {
         return this.agGridAdapter.getRegisteredModules();
     }
     destroy(config) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6;
         if (((_a = this.agGridAdapter) === null || _a === void 0 ? void 0 : _a.getAgGridApi()) && !this.agGridAdapter.getAgGridApi().isDestroyed()) {
             this.agGridAdapter
                 .getAgGridApi()
-                .removeEventListener(Events.EVENT_FIRST_DATA_RENDERED, this.listenerFirstDataRendered);
+                .removeEventListener('firstDataRendered', this.listenerFirstDataRendered);
             this.agGridAdapter
                 .getAgGridApi()
-                .removeEventListener(Events.EVENT_COLUMN_PIVOT_MODE_CHANGED, this.listenerPivotModeChanged);
+                .removeEventListener('columnPivotModeChanged', this.listenerPivotModeChanged);
             this.agGridAdapter
                 .getAgGridApi()
-                .removeEventListener(Events.EVENT_COLUMN_PIVOT_CHANGED, this.listenerPivotChanged);
+                .removeEventListener('columnPivotChanged', this.listenerPivotChanged);
             this.agGridAdapter
                 .getAgGridApi()
-                .removeEventListener(Events.EVENT_CELL_EDITING_STARTED, this.listenerCellEditingStarted);
+                .removeEventListener('cellEditingStarted', this.listenerCellEditingStarted);
             this.agGridAdapter
                 .getAgGridApi()
-                .removeEventListener(Events.EVENT_COLUMN_ROW_GROUP_CHANGED, this.listenerColumnRowGroupChanged);
+                .removeEventListener('columnRowGroupChanged', this.listenerColumnRowGroupChanged);
             this.agGridAdapter
                 .getAgGridApi()
-                .removeEventListener(Events.EVENT_RANGE_SELECTION_CHANGED, this.listenerRangeSelectionChanged);
+                .removeEventListener('rangeSelectionChanged', this.listenerRangeSelectionChanged);
             this.agGridAdapter
                 .getAgGridApi()
-                .removeEventListener(Events.EVENT_COLUMN_RESIZED, this.listenerColumnResized);
+                .removeEventListener('columnResized', this.listenerColumnResized);
             this.agGridAdapter
                 .getAgGridApi()
-                .removeEventListener(Events.EVENT_SORT_CHANGED, this.listenerSortChanged);
+                .removeEventListener('sortChanged', this.listenerSortChanged);
             this.agGridAdapter
                 .getAgGridApi()
-                .removeEventListener(Events.EVENT_MODEL_UPDATED, this.listenerModelUpdated);
+                .removeEventListener('modelUpdated', this.listenerModelUpdated);
             this.agGridAdapter.getAgGridApi().removeGlobalListener(this.listenerGlobalSetRowSelection);
             this.agGridAdapter
                 .getAgGridApi()
@@ -2992,7 +2997,7 @@ export class AdaptableAgGrid {
             this.listenerGlobalRowGroupEventsThatTriggerAutoLayoutSave = null;
             this.throttleFilterOnEditDataChange = null;
             this.throttleFilterOnTickingDataChange = null;
-            const liveGridOptions = this.agGridAdapter.getLiveGridOptions();
+            const liveGridOptions = this.DANGER_getPrivateAgGridBeans().gridOptions;
             if (liveGridOptions) {
                 this.agGridOptionsService.revertGridOptionsPropertiesToUserValue(liveGridOptions, [
                     'aggFuncs',
@@ -3020,6 +3025,7 @@ export class AdaptableAgGrid {
                 }
             }
         }
+        DANGER_AG_GRID_BEANS = null;
         if ((config === null || config === void 0 ? void 0 : config.destroyApi) === true) {
             (_b = this.agGridAdapter.getAgGridApi()) === null || _b === void 0 ? void 0 : _b.destroy();
         }
@@ -3069,27 +3075,23 @@ export class AdaptableAgGrid {
         this.CalculatedColumnExpressionService = null;
         (_o = (_m = this.DataService) === null || _m === void 0 ? void 0 : _m.destroy) === null || _o === void 0 ? void 0 : _o.call(_m);
         this.DataService = null;
-        (_q = (_p = this.EntitlementService) === null || _p === void 0 ? void 0 : _p.destroy) === null || _q === void 0 ? void 0 : _q.call(_p);
-        this.EntitlementService = null;
-        (_s = (_r = this.Fdc3Service) === null || _r === void 0 ? void 0 : _r.destroy) === null || _s === void 0 ? void 0 : _s.call(_r);
+        (_q = (_p = this.Fdc3Service) === null || _p === void 0 ? void 0 : _p.destroy) === null || _q === void 0 ? void 0 : _q.call(_p);
         this.Fdc3Service = null;
-        (_u = (_t = this.ReportService) === null || _t === void 0 ? void 0 : _t.destroy) === null || _u === void 0 ? void 0 : _u.call(_t);
-        this.ReportService = null;
-        (_w = (_v = this.ModuleService) === null || _v === void 0 ? void 0 : _v.destroy) === null || _w === void 0 ? void 0 : _w.call(_v);
+        (_s = (_r = this.ModuleService) === null || _r === void 0 ? void 0 : _r.destroy) === null || _s === void 0 ? void 0 : _s.call(_r);
         this.ModuleService = null;
-        (_y = (_x = this.ValidationService) === null || _x === void 0 ? void 0 : _x.destroy) === null || _y === void 0 ? void 0 : _y.call(_x);
+        (_u = (_t = this.ValidationService) === null || _t === void 0 ? void 0 : _t.destroy) === null || _u === void 0 ? void 0 : _u.call(_t);
         this.ValidationService = null;
-        (_0 = (_z = this.QueryLanguageService) === null || _z === void 0 ? void 0 : _z.destroy) === null || _0 === void 0 ? void 0 : _0.call(_z);
+        (_w = (_v = this.QueryLanguageService) === null || _v === void 0 ? void 0 : _v.destroy) === null || _w === void 0 ? void 0 : _w.call(_v);
         this.QueryLanguageService = null;
-        (_2 = (_1 = this.AlertService) === null || _1 === void 0 ? void 0 : _1.destroy) === null || _2 === void 0 ? void 0 : _2.call(_1);
+        (_y = (_x = this.AlertService) === null || _x === void 0 ? void 0 : _x.destroy) === null || _y === void 0 ? void 0 : _y.call(_x);
         this.AlertService = null;
-        (_4 = (_3 = this.TeamSharingService) === null || _3 === void 0 ? void 0 : _3.destroy) === null || _4 === void 0 ? void 0 : _4.call(_3);
+        (_0 = (_z = this.TeamSharingService) === null || _z === void 0 ? void 0 : _z.destroy) === null || _0 === void 0 ? void 0 : _0.call(_z);
         this.TeamSharingService = null;
-        (_6 = (_5 = this.RowEditService) === null || _5 === void 0 ? void 0 : _5.destroy) === null || _6 === void 0 ? void 0 : _6.call(_5);
+        (_2 = (_1 = this.RowEditService) === null || _1 === void 0 ? void 0 : _1.destroy) === null || _2 === void 0 ? void 0 : _2.call(_1);
         this.RowEditService = null;
-        (_8 = (_7 = this.MetamodelService) === null || _7 === void 0 ? void 0 : _7.destroy) === null || _8 === void 0 ? void 0 : _8.call(_7);
+        (_4 = (_3 = this.MetamodelService) === null || _3 === void 0 ? void 0 : _3.destroy) === null || _4 === void 0 ? void 0 : _4.call(_3);
         this.MetamodelService = null;
-        (_10 = (_9 = this.LicenseService) === null || _9 === void 0 ? void 0 : _9.destroy) === null || _10 === void 0 ? void 0 : _10.call(_9);
+        (_6 = (_5 = this.LicenseService) === null || _5 === void 0 ? void 0 : _5.destroy) === null || _6 === void 0 ? void 0 : _6.call(_5);
         this.LicenseService = null;
     }
     canExportToExcel() {
@@ -3142,13 +3144,13 @@ export class AdaptableAgGrid {
     }
     exportVisualDataToExcel() {
         try {
-            const exportExcelStyles = this.ReportService.buildExcelStylesForVisualReports();
+            const exportExcelStyles = this.api.exportApi.internalApi.buildExcelStylesForVisualReports();
             // set DANGER_excelStyles without changing the array reference
             this.DANGER_excelStyles.splice(0, this.DANGER_excelStyles.length, ...exportExcelStyles);
             // this.agGridOptionsService.CAREFUL_patchGridOptionsProperty('excelStyles', exportExcelStyles);
             this.agGridAdapter.getAgGridApi().exportDataAsExcel({
                 sheetName: 'Sheet 1',
-                fileName: this.ReportService.getReportFileName(this.adaptableOptions.adaptableId, 'Excel'),
+                fileName: this.api.exportApi.internalApi.getReportFileName(this.adaptableOptions.adaptableId, 'Excel'),
                 // delegate the cell value processing to Adaptable
                 processCellCallback: ({ node, column, value }) => {
                     var _a;
@@ -3207,18 +3209,18 @@ export class AdaptableAgGrid {
                 rawValue = dateRawValue;
             }
         }
-        return this.ReportService.getCellExportValueFromRawValue(rowNode, rawValue, columnId);
+        return this.api.exportApi.internalApi.getCellExportValueFromRawValue(rowNode, rawValue, columnId);
     }
     processCellForExcelExport(rowNode, columnId) {
         if (this.api.exportApi.internalApi.isVisualDataExportInProgress()) {
             const cellKey = this.agGridColumnAdapter.getExcelClassNameForCell(columnId, this.getPrimaryKeyValueFromRowNode(rowNode));
-            const isoFormattedDate = this.ReportService.getExcelStyleWithFormattedDate(cellKey);
+            const isoFormattedDate = this.api.exportApi.internalApi.getExcelStyleWithFormattedDate(cellKey);
             if (isoFormattedDate) {
                 // this is a Date cell which will be formatted by Excel
                 return isoFormattedDate;
             }
         }
-        return this.ReportService.getCellExportValueFromRowNode(rowNode, columnId);
+        return this.api.exportApi.internalApi.getCellExportValueFromRowNode(rowNode, columnId);
     }
     isQuickFilterAvailable() {
         if (this.api.layoutApi.isCurrentLayoutPivot() &&
@@ -3730,8 +3732,10 @@ export class AdaptableAgGrid {
         }
         return !((_c = layoutState.Layouts) === null || _c === void 0 ? void 0 : _c.length);
     }
-    createDefaultLayout(state, agGridColDefs, agGridAutoGroupColDef) {
+    createDefaultLayout(state, agGridOptions) {
         var _a, _b, _c;
+        const agGridColDefs = agGridOptions.columnDefs;
+        const agGridAutoGroupColDef = agGridOptions.autoGroupColumnDef;
         const allColumnDefs = this.agGridAdapter.getFlattenedColDefs(agGridColDefs);
         const defaultLayout = ObjectFactory.CreateEmptyLayout({
             Name: DEFAULT_LAYOUT,
@@ -3757,7 +3761,8 @@ export class AdaptableAgGrid {
             }, []),
         });
         // handle optional 'gridOptions.autoGroupColumnDefs' parameter
-        if (agGridAutoGroupColDef && ((_a = defaultLayout.RowGroupedColumns) === null || _a === void 0 ? void 0 : _a.length)) {
+        if (agGridAutoGroupColDef &&
+            (((_a = defaultLayout.RowGroupedColumns) === null || _a === void 0 ? void 0 : _a.length) || agGridOptions.treeData)) {
             defaultLayout.Columns = [AG_GRID_GROUPED_COLUMN, ...defaultLayout.Columns];
         }
         if (agGridAutoGroupColDef === null || agGridAutoGroupColDef === void 0 ? void 0 : agGridAutoGroupColDef.pinned) {
@@ -4006,8 +4011,11 @@ export class AdaptableAgGrid {
     }
     // we need to intercept some of the GridOptions updates and refresh the Adaptable state
     monkeyPatchingGridOptionsUpdates(agGridApi) {
-        // @ts-ignore
-        const gridOptionsService = agGridApi.gos;
+        var _a;
+        const gridOptionsService = (_a = this.DANGER_getPrivateAgGridBeans()) === null || _a === void 0 ? void 0 : _a.gos;
+        if (!gridOptionsService) {
+            this.logger.consoleError('Could not get hold of GridOptionsService! This is a critical error and will prevent Adaptable from working correctly.');
+        }
         const self = this;
         gridOptionsService.updateGridOptions = function ({ options, force, source = 'api', }) {
             // `columnDefs`
@@ -4037,4 +4045,7 @@ export class AdaptableAgGrid {
             GridOptionsService_updateGridOptions.apply(this, arguments);
         };
     }
+    DANGER_getPrivateAgGridBeans() {
+        return DANGER_AG_GRID_BEANS;
+    }
 }