@adaptabletools/adaptable 20.0.0-canary.2 → 20.0.0-canary.21

package/src/View/StyledColumn/Wizard/StyledColumnWizardTypeSection.js

@@ -14,7 +14,7 @@ export const renderStyledColumnTypeSummary = (data) => {
     else if (data.PercentBarStyle) {
         type = 'Percent Bar';
     }
-    else if (data.SparkLineStyle) {
+    else if (data.SparklineStyle) {
         type = 'Spark Line';
     }
     else if (data.BadgeStyle) {
@@ -33,7 +33,7 @@ export const StyledColumnWizardTypeSection = (props) => {
         };
         delete newStyledColumn.GradientStyle;
         delete newStyledColumn.PercentBarStyle;
-        delete newStyledColumn.SparkLineStyle;
+        delete newStyledColumn.SparklineStyle;
         delete newStyledColumn.BadgeStyle;
         switch (type) {
             case 'gradient':
@@ -43,7 +43,7 @@ export const StyledColumnWizardTypeSection = (props) => {
                 newStyledColumn.PercentBarStyle = {};
                 break;
             case 'sparkline':
-                newStyledColumn.SparkLineStyle = {
+                newStyledColumn.SparklineStyle = {
                     options: {
                         type: 'line',
                     },
@@ -64,6 +64,6 @@ export const StyledColumnWizardTypeSection = (props) => {
             React.createElement(Tabs.Content, null,
                 React.createElement(TypeRadio, { text: "Gradient", description: "Colour each cell in the column using a Gradient value (Numeric Columns)", checked: Boolean(data.GradientStyle), onClick: () => handleTypeChange('gradient') }),
                 React.createElement(TypeRadio, { text: "Percent Bar", description: "Display a coloured Bar where the width is based on the cell (Numeric Columns)", checked: Boolean(data.PercentBarStyle), onClick: () => handleTypeChange('percent') }),
-                adaptable.api.styledColumnApi.canDisplaySparklines() && (React.createElement(TypeRadio, { text: "Sparkline", description: "Render the column as a Sparkline (Numeric Array Columns)", checked: Boolean(data.SparkLineStyle), onClick: () => handleTypeChange('sparkline') })),
+                adaptable.api.styledColumnApi.canDisplaySparklines() && (React.createElement(TypeRadio, { text: "Sparkline", description: "Render the column as a Sparkline (Numeric Array Columns)", checked: Boolean(data.SparklineStyle), onClick: () => handleTypeChange('sparkline') })),
                 React.createElement(TypeRadio, { text: "Badge", description: "Display the column's values as Badges (All Columns)", checked: Boolean(data.BadgeStyle), onClick: () => handleTypeChange('badge') })))));
 };

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -29,6 +29,7 @@ import { RowFormService } from '../Utilities/Services/RowFormService';
 import { GridCellWithCount } from '../PredefinedConfig/Selection/GridCell';
 import { FlashingCellService } from '../Utilities/Services/FlashingCellService';
 import { AgGridExportAdapter } from './AgGridExportAdapter';
+import { AgGridThemeAdapter } from './AgGridThemeAdapter';
 export type AdaptableLifecycleState = 'initial' | 'preprocessOptions' | 'initAdaptableState' | 'setupAgGrid' | 'initAgGrid' | 'agGridReady' | 'available' | 'ready' | 'preDestroyed';
 type RenderAgGridFrameworkComponentResult = false | GridApi;
 interface AdaptableInitInternalConfig<TData = any> {
@@ -61,11 +62,6 @@ export declare class AdaptableAgGrid implements IAdaptable {
     hasAutogeneratedPrimaryKey: boolean;
     hasAdaptableToolPanel: boolean;
     private initWithLazyData;
-    /**
-     * once layouts are properly handled with the new aggrid methods & events
-     * we can remove this hack
-     */
-    private previousAgGridLayoutState;
     _rawAdaptableOptions: AdaptableOptions;
     adaptableOptions: AdaptableOptions;
     _isDetailGrid: boolean;
@@ -75,6 +71,7 @@ export declare class AdaptableAgGrid implements IAdaptable {
     agGridColumnAdapter: AgGridColumnAdapter;
     agGridMenuAdapter: AgGridMenuAdapter;
     agGridExportAdapter: AgGridExportAdapter;
+    agGridThemeAdapter: AgGridThemeAdapter;
     private DANGER_USE_GETTER_adaptableContainerElement;
     private DANGER_USE_GETTER_agGridContainerElement;
     api: AdaptableApi;
@@ -147,6 +144,7 @@ export declare class AdaptableAgGrid implements IAdaptable {
      */
     static _initInternal(config: AdaptableInitInternalConfig): Promise<AdaptableApi>;
     private _initAdaptableAgGrid;
+    midwayDestroy(): void;
     normalizeAdaptableState(state: AdaptableState, agGridOptions: NormalizeAdaptableStateOptions): AdaptableState;
     private normaliseLayoutState;
     private normaliseToolPanelState;
@@ -299,8 +297,6 @@ export declare class AdaptableAgGrid implements IAdaptable {
     isGridGroupingActive(): boolean;
     setAgGridQuickSearch(searchText: string): void;
     clearAgGridQuickSearch(): void;
-    getAgGridCurrentThemeName(): string;
-    private getAgGridLightThemeName;
     applyAdaptableTheme(theme: AdaptableTheme | string): void;
     setRowGroupColumns(columnIds: string[]): void;
     getAllGridColumns(): Column<any>[];
@@ -337,6 +333,6 @@ export declare class AdaptableAgGrid implements IAdaptable {
     refreshLayout(): void;
     private isRowGroupDifferentInLayout;
     private onLayoutChange;
-    private getColumnSorts;
+    private validateColumnDefTypes;
 }
 export {};

package/src/agGrid/AdaptableAgGrid.js

@@ -8,7 +8,7 @@ import Emitter from '../Utilities/Emitter';
 import { applyDefaultAdaptableOptions } from '../AdaptableOptions/DefaultAdaptableOptions';
 import { AgGridAdapter } from './AgGridAdapter';
 import * as GeneralConstants from '../Utilities/Constants/GeneralConstants';
-import { AUTOGENERATED_PK_COLUMN, DARK_THEME, ERROR_LAYOUT, GROUP_PATH_SEPARATOR, HALF_SECOND, LIGHT_THEME, QUARTER_SECOND, } from '../Utilities/Constants/GeneralConstants';
+import { AUTOGENERATED_PK_COLUMN, ERROR_LAYOUT, GROUP_PATH_SEPARATOR, HALF_SECOND, QUARTER_SECOND, } from '../Utilities/Constants/GeneralConstants';
 import { DataService } from '../Utilities/Services/DataService';
 import { AdaptableStore } from '../Redux/Store/AdaptableStore';
 import { AdaptableApiImpl } from '../Api/Implementation/AdaptableApiImpl';
@@ -95,9 +95,16 @@ import { LayoutManager } from '../layout-manager/src';
 import { isPivotLayoutModel } from '../layout-manager/src/isPivotLayoutModel';
 import { ACTION_COLUMN_TYPE, CALCULATED_COLUMN_TYPE, FDC3_COLUMN_TYPE, FREE_TEXT_COLUMN_TYPE, } from '../PredefinedConfig/Common/AdaptableColumn';
 import { agGridDataTypeDefinitions } from './agGridDataTypeDefinitions';
+import { AgGridThemeAdapter } from './AgGridThemeAdapter';
+import { mapOldTypeToDataType } from '../migration/VersionUpgrade20';
 const LocalEventService_Prototype = LocalEventService.prototype;
 const LocalEventService_dispatchEvent = LocalEventService_Prototype.dispatchEvent;
 LocalEventService_Prototype.dispatchEvent = function (event) {
+    const agGridApi = event.api;
+    if (agGridApi?.isDestroyed()) {
+        // do nothing if AG Grid was destroyed in the meantime
+        return;
+    }
     LocalEventService_dispatchEvent.apply(this, arguments);
     if (event.type === 'cellChanged' || event.type === 'dataChanged') {
         const eventRowNode = event.node;
@@ -117,6 +124,10 @@ LocalEventService_Prototype.dispatchEvent = function (event) {
                     // so IGNORE IT
                     return;
                 }
+                if (adaptable.isDestroyed) {
+                    // do nothing if adaptable is destroyed (this is a rare case and happens when Adaptable is quickly destroyed and recreated)
+                    return;
+                }
                 // we're on the correct instance, so do this
                 //@ts-ignore
                 const fn = adaptable.rowListeners ? adaptable.rowListeners[event.type] : null;
@@ -131,11 +142,6 @@ const adaptableInstances = {};
 const publishTimestamp = Number(ADAPTABLE_PUBLISH_TIMESTAMP);
 export class AdaptableAgGrid {
     constructor(config) {
-        /**
-         * once layouts are properly handled with the new aggrid methods & events
-         * we can remove this hack
-         */
-        this.previousAgGridLayoutState = '';
         this.filteredOutPrimaryKeys = new Set();
         this.columnMinMaxValuesCache = {};
         this.renderReactRoot = (node, container) => defaultRenderReactRoot(node, container);
@@ -174,6 +180,7 @@ export class AdaptableAgGrid {
         this.agGridMenuAdapter = new AgGridMenuAdapter(this);
         this.agGridColumnAdapter = new AgGridColumnAdapter(this);
         this.agGridExportAdapter = new AgGridExportAdapter(this);
+        this.agGridThemeAdapter = new AgGridThemeAdapter(this);
         this.DataService = new DataService(this);
     }
     static forEachAdaptable(fn) {
@@ -295,11 +302,6 @@ export class AdaptableAgGrid {
         this.api = new AdaptableApiImpl(this);
         this.forPlugins((plugin) => plugin.afterInitApi(this, this.api));
         this.lifecycleState = 'initAdaptableState';
-        // just in case Adaptable was destroyed while loading the store (which is an async operation)
-        if (this.isDestroyed) {
-            return Promise.reject('Adaptable was destroyed while loading the store.');
-            // FIXME AFL MIG: is this enough?! talk with the team
-        }
         this.initServices();
         this.forPlugins((plugin) => plugin.afterInitServices(this));
         this.adaptableModules = this.initModules();
@@ -330,6 +332,7 @@ export class AdaptableAgGrid {
         perfLoadStore.end();
         // just in case Adaptable was destroyed while loading the store (which is an async operation)
         if (this.isDestroyed) {
+            this.midwayDestroy();
             return Promise.reject('Adaptable was destroyed while loading the store.');
             // FIXME AFL MIG: is this enough?! talk with the team
         }
@@ -360,11 +363,13 @@ 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
+        // AG Grid evaluates early on the floatingFilter params, so we need to "suppress" the floating filter temporarily
         // we will reset it once Adaptable is ready
         this.agGridColumnAdapter.setupColumnFloatingFilterTemporarily(gridOptions);
+        this.validateColumnDefTypes(gridOptions.columnDefs);
         const agGridApi = await this.initializeAgGrid(gridOptions, config.modules, config.renderAgGridFrameworkComponent);
         if (agGridApi === false) {
+            this.midwayDestroy();
             this.logger.consoleError(`Adaptable failed to initialize AG Grid!`);
             return Promise.reject('Adaptable failed to initialize AG Grid!');
         }
@@ -472,6 +477,12 @@ export class AdaptableAgGrid {
         perfInitAdaptableAgGrid.end();
         return Promise.resolve(this.api);
     }
+    midwayDestroy() {
+        this.destroy({
+            destroyAgGrid: false,
+            unmount: false,
+        });
+    }
     normalizeAdaptableState(state, agGridOptions) {
         state = this.normaliseLayoutState(state, agGridOptions);
         state = this.normaliseToolPanelState(state);
@@ -598,12 +609,12 @@ You need to define at least one Layout!`);
             this.agGridAdapter.setAgGridId(agGridId);
             return agGridId;
         });
-        // FIXME AFL: handle both ThemingApi and legacy CSS
         /**
          * `theme`
          */
-        this.agGridOptionsService.setGridOptionsProperty(gridOptions, 'theme', (original_gridId) => {
-            return 'legacy';
+        this.agGridOptionsService.setGridOptionsProperty(gridOptions, 'theme', (original_theme) => {
+            this.agGridThemeAdapter.setAgGridThemeMode(original_theme === 'legacy' ? 'legacy' : 'themingApi');
+            return original_theme;
         });
         /**
          *  `getRowId`
@@ -720,7 +731,7 @@ You need to define at least one Layout!`);
                 if (this.isGroupRowNode(node)) {
                     return true;
                 }
-                // first assess if the Row is filterable - if not, then return true so it appears in Grid
+                // first assess if the Row i s filterable - if not, then return true so it appears in Grid
                 const isRowFilterable = this.api.optionsApi.getFilterOptions().isRowFilterable;
                 if (typeof isRowFilterable === 'function') {
                     const rowFilterableContext = {
@@ -1042,7 +1053,14 @@ You need to define at least one Layout!`);
      */
     async initializeAgGrid(gridOptions, modules, renderAgGridFrameworkComponent) {
         if (renderAgGridFrameworkComponent) {
-            const result = await renderAgGridFrameworkComponent(gridOptions);
+            let result = false;
+            try {
+                result = await renderAgGridFrameworkComponent(gridOptions);
+            }
+            catch (err) {
+                console.log('Failed to get AG Grid API');
+                result = false;
+            }
             if (result === false) {
                 return false;
             }
@@ -1050,6 +1068,10 @@ You need to define at least one Layout!`);
             // framework wrapper may have altered the context value via props
             // in that case, we have to re-populate it with the Adaptable context values
             const agGridContext = agGridApi.getGridOption('context');
+            if (!agGridContext) {
+                console.log('Failed to get AG Grid context');
+                return false;
+            }
             if (!agGridContext.__adaptable) {
                 agGridContext.__adaptable = this;
                 agGridContext.adaptableApi = this.api;
@@ -1335,7 +1357,7 @@ You need to define at least one Layout!`);
         return currentLayout.AutoSizeColumns;
     }
     autoSizeLayoutIfNeeded() {
-        if (this.shouldAutoSizeLayout()) {
+        if (this.isAvailable && this.shouldAutoSizeLayout()) {
             requestAnimationFrame(() => {
                 if (this.isAvailable) {
                     this.autoSizeAllColumns();
@@ -2567,40 +2589,6 @@ You need to define at least one Layout!`);
     clearAgGridQuickSearch() {
         this.setAgGridQuickSearch('');
     }
-    getAgGridCurrentThemeName() {
-        const container = this.getAgGridContainerElement();
-        if (container && container.classList) {
-            // we detect the ag theme class
-            const classList = container.classList;
-            for (let i = 0, len = classList.length; i < len; i++) {
-                const cls = classList[i];
-                if (cls.indexOf('ag-theme-') === 0) {
-                    return cls;
-                }
-            }
-        }
-        return this.getAgGridLightThemeName();
-    }
-    getAgGridLightThemeName() {
-        const container = this.getAgGridContainerElement();
-        if (container && container.classList) {
-            // we detect the ag theme class
-            const classList = container.classList;
-            for (let i = 0, len = classList.length; i < len; i++) {
-                const cls = classList[i];
-                if (cls.indexOf('ag-theme-') === 0) {
-                    // even if dark theme is included, we compute the light theme name out of it
-                    return cls.replace('-dark', '');
-                }
-            }
-        }
-        else {
-            this.logger.warn('No AgGrid container found, defaulting to ag-theme-balham for the light theme');
-        }
-        this.logger.warn('No ag-theme- class found on the grid container, defaulting to ag-theme-balham');
-        // fallback to the default light theme
-        return 'ag-theme-balham';
-    }
     applyAdaptableTheme(theme) {
         const container = this.getAgGridContainerElement();
         if (container != null) {
@@ -2644,7 +2632,7 @@ You need to define at least one Layout!`);
         themeClassNamesToRemove.forEach((cssClassName) => el.classList.remove(cssClassName));
         // remove infinite table classnames
         themesToRemove.forEach((theme) => {
-            el.classList.remove(`infinite-${theme.Name}`);
+            el.classList.remove(`infinite-theme-mode--${theme.Name}`);
         });
         // VARIANT
         let variantTheme = '';
@@ -2660,46 +2648,13 @@ You need to define at least one Layout!`);
         }
         if (isSystemTheme) {
             // add infinite table classname for theme
-            el.classList.add(`infinite-${themeName}`);
+            el.classList.add(`infinite-theme-mode--${themeName}`);
         }
         else if (variantTheme) {
-            el.classList.add(`infinite-${variantTheme}`);
-        }
-        // AG THEME CLASS NAME
-        const getAgGridLightThemeName = () => this.getAgGridLightThemeName();
-        const getAgGridDarkThemeName = () => getAgGridLightThemeName() + '-dark';
-        if (newTheme && (isSystemTheme || variantTheme)) {
-            if ((variantTheme || themeName) === LIGHT_THEME) {
-                newTheme.AgGridClassName = newTheme.AgGridClassName || getAgGridLightThemeName();
-            }
-            if ((variantTheme || themeName) === DARK_THEME) {
-                newTheme.AgGridClassName = newTheme.AgGridClassName || getAgGridDarkThemeName();
-            }
-        }
-        if (!newTheme.AgGridClassName) {
-            // default AG Grid to its light theme
-            newTheme.AgGridClassName = getAgGridLightThemeName();
-        }
-        if (container != null) {
-            if (themesToRemove.length) {
-                themesToRemove.forEach((theme) => {
-                    if (theme.AgGridClassName) {
-                        container.classList.remove(theme.AgGridClassName);
-                    }
-                });
-            }
-            // also remove all AG Grid theme class names
-            const agGridClassNamesToRemove = [];
-            container.classList.forEach((x) => {
-                if (x && x.indexOf('ag-theme-') === 0) {
-                    agGridClassNamesToRemove.push(x);
-                }
-            });
-            agGridClassNamesToRemove.forEach((x) => container.classList.remove(x));
-            if (newTheme && newTheme.AgGridClassName) {
-                container.classList.add(newTheme.AgGridClassName);
-            }
+            el.classList.add(`infinite-theme-mode--${variantTheme}`);
         }
+        // Update AG THEME
+        this.agGridThemeAdapter.applyAgGridThemeOnAdaptableThemeChange(newTheme, variantTheme, container, themesToRemove);
         // MAC LIKE SCROLLBARS
         if (this.adaptableOptions.userInterfaceOptions &&
             this.adaptableOptions.userInterfaceOptions.useCustomMacLikeScrollbars &&
@@ -2792,8 +2747,9 @@ You need to define at least one Layout!`);
             }
         }
         this.__prevLayoutForOnChange = undefined;
-        this.layoutManager.destroy();
-        this.filteredOutPrimaryKeys.clear();
+        this.layoutManager?.destroy();
+        this.layoutManager = null;
+        this.filteredOutPrimaryKeys?.clear();
         if (this.agGridAdapter?.getAgGridApi() && !this.agGridAdapter.getAgGridApi().isDestroyed()) {
             this.agGridAdapter
                 .getAgGridApi()
@@ -2872,7 +2828,6 @@ You need to define at least one Layout!`);
         if (config?.destroyAgGrid === true) {
             this.agGridAdapter.getAgGridApi()?.destroy();
         }
-        this.previousAgGridLayoutState = '';
         const gridContainerElement = this.getAgGridContainerElement();
         if (gridContainerElement) {
             gridContainerElement.removeEventListener('keydown', this.agGridListenerKeydown, true);
@@ -2883,8 +2838,6 @@ You need to define at least one Layout!`);
             this.agGridListenerMouseLeave = null;
         }
         this.api._internalDestroySelf();
-        this.layoutManager?.destroy();
-        this.layoutManager = null;
         this.agGridOptionsService?.destroy();
         this.agGridOptionsService = null;
         this.agGridAdapter?.destroy();
@@ -2895,6 +2848,8 @@ You need to define at least one Layout!`);
         this.agGridColumnAdapter = null;
         this.agGridExportAdapter?.destroy();
         this.agGridExportAdapter = null;
+        this.agGridThemeAdapter?.destroy();
+        this.agGridThemeAdapter = null;
         this.rowListeners = null;
         this.emitter.destroy();
         this.emitter = null;
@@ -3017,6 +2972,10 @@ You need to define at least one Layout!`);
             };
             this.agGridColumnAdapter.setupColumnHeader(colSetupInfo);
         });
+        // need to refresh the header,
+        // as the Layout.ColumnHeaders state property is not implemented in the LayoutManager
+        // and is specific to Adaptable, therefore we need to refresh it manually
+        this.refreshHeader();
         const layoutModel = layoutStateToLayoutModel(layout);
         this.layoutManager?.setLayout(layoutModel, {
             skipApplyRowGroupsExpandedState: !shouldUpdateExpandState,
@@ -3340,29 +3299,24 @@ You need to define at least one Layout!`);
         this.__prevLayoutForOnChange = layout;
         this.api.layoutApi.createOrUpdateLayout(layout);
     }
-    getColumnSorts() {
-        const columnSorts = [];
-        const { columnApi } = this.api;
-        const columnState = this.agGridAdapter.getAgGridApi().getColumnState();
-        columnState.forEach((colState) => {
-            const { colId } = colState;
-            if (columnApi.isAutoRowGroupColumn(colId)) {
-                return;
-            }
-            if (colState.sort && colState.sortIndex != null) {
-                columnSorts.push({
-                    ColumnId: colId,
-                    SortOrder: colState.sort === 'asc' ? 'Asc' : 'Desc',
-                    SortIndex: colState.sortIndex,
-                });
-            }
-        });
-        columnSorts.sort((a, b) => a.SortIndex - b.SortIndex);
-        return columnSorts.map((c) => {
-            return {
-                ColumnId: c.ColumnId,
-                SortOrder: c.SortOrder,
-            };
+    validateColumnDefTypes(columnDefs) {
+        // in Adaptable version 20 we switched from colDef.type to colDef.cellDataType
+        // although we documented this change and try to infer the correct cellDataTypes, it's best to also check if the client dev forgot to adjust his colDefs
+        columnDefs.forEach((colDef) => {
+            if (colDef.children?.length) {
+                this.validateColumnDefTypes(colDef.children);
+            }
+            const columnDefinition = colDef;
+            const colDefType = columnDefinition.type;
+            const colDefTypes = typeof colDefType === 'string' ? [colDefType] : colDefType || [];
+            colDefTypes
+                .filter((colType) => colType.startsWith('abColDef'))
+                .forEach((colType) => {
+                const newValidCellDataType = mapOldTypeToDataType(colType);
+                if (newValidCellDataType) {
+                    this.logger.consoleWarn(`Column ${columnDefinition.colId ?? columnDefinition.field} has a type of ${colType} which is no longer in use${newValidCellDataType !== 'unknown' ? `. Please use 'colDef.cellDataType' instead: ${newValidCellDataType}` : ''}`);
+                }
+            });
         });
     }
 }

package/src/agGrid/AgGridAdapter.d.ts

@@ -3,6 +3,7 @@ import { AdaptableAgGrid } from './AdaptableAgGrid';
 import { AdaptableColumn, AdaptableColumnGroup } from '../PredefinedConfig/Common/AdaptableColumn';
 import { SelectedCellInfo } from '../PredefinedConfig/Selection/SelectedCellInfo';
 import { SelectedRowInfo } from '../PredefinedConfig/Selection/SelectedRowInfo';
+export type AgGridThemeMode = 'legacy' | 'themingApi';
 export declare class AgGridAdapter {
     private _adaptableInstance;
     private DANGER_USE_GETTER_gridApi;
@@ -45,7 +46,6 @@ export declare class AgGridAdapter {
     deriveSelectedCellInfoFromAgGrid(): SelectedCellInfo;
     deriveSelectedRowInfoFromAgGrid(): SelectedRowInfo;
     isPinnedRowNode(rowNode: IRowNode): boolean;
-    getFirstGroupedColumn(): string | undefined;
     createAdaptableColumnFromAgGridColumn(agGridColumn: Column, colsToGroups: Record<string, AdaptableColumnGroup>): AdaptableColumn;
     private deriveAdaptableColumnDataType;
     private isColumnReadonly;

package/src/agGrid/AgGridAdapter.js

@@ -1,11 +1,11 @@
 import { ColumnApiModule, } from 'ag-grid-enterprise';
 import { ACTION_COLUMN_TYPE, CALCULATED_COLUMN_TYPE, FDC3_COLUMN_TYPE, FREE_TEXT_COLUMN_TYPE, } from '../PredefinedConfig/Common/AdaptableColumn';
-import { ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME } from '../Utilities/Constants/GeneralConstants';
+import { ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME, } from '../Utilities/Constants/GeneralConstants';
 import { createUuid } from '../PredefinedConfig/Uuid';
 import ArrayExtensions from '../Utilities/Extensions/ArrayExtensions';
 import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
 import { ALL_AG_GRID_MODULES } from './agGridModules';
-import { agGridDataTypeDefinitions, ALL_ADAPTABLE_DATA_TYPES, } from './agGridDataTypeDefinitions';
+import { agGridDataTypeDefinitions, ALL_ADAPTABLE_DATA_TYPES } from './agGridDataTypeDefinitions';
 // AG GRID obfuscates its internals, this is (currently) the best way to get hold of its internal services
 const DANGER_AG_GRID_BEANS_MAP = {};
 const getColumnApiModule = () => ColumnApiModule;
@@ -31,6 +31,9 @@ export class AgGridAdapter {
     }
     destroy() {
         delete DANGER_AG_GRID_BEANS_MAP[this._agGridId];
+        this.initialGridOptions = null;
+        this.DANGER_gridApi_from_args = null;
+        this.DANGER_USE_GETTER_gridApi = null;
         this.DANGER_updateGridOptionsMonkeyPatcher = null;
         this._adaptableInstance = null;
     }
@@ -93,7 +96,7 @@ export class AgGridAdapter {
             // `context`
             const passedContext = options.context;
             if (passedContext) {
-                passedContext['__adaptable'] = self;
+                passedContext['__adaptable'] = self._adaptableInstance;
                 passedContext['adaptableApi'] = self.adaptableApi;
             }
             // we mutated the options array, so it's OK to use the 'arguments' object
@@ -364,10 +367,6 @@ export class AgGridAdapter {
         }
         return false;
     }
-    // TODO AFL MIG rename to getFirstGroupedColumnId()
-    getFirstGroupedColumn() {
-        return this.getAgGridApi?.()?.getRowGroupColumns()?.[0]?.getColId();
-    }
     createAdaptableColumnFromAgGridColumn(agGridColumn, colsToGroups) {
         const colId = agGridColumn.getColId();
         const colDef = agGridColumn.getColDef();
@@ -522,7 +521,7 @@ export class AgGridAdapter {
         else if (Array.isArray(value)) {
             const arrayDataType = ALL_ADAPTABLE_DATA_TYPES.find((arrayType) => {
                 const dataTypeDefinition = agGridDataTypeDefinitions[arrayType];
-                const dataTypeMatching = dataTypeDefinition.dataTypeMatcher(value);
+                const dataTypeMatching = dataTypeDefinition?.dataTypeMatcher?.(value);
                 return dataTypeMatching;
             });
             if (arrayDataType) {

package/src/agGrid/AgGridColumnAdapter.js

@@ -12,6 +12,7 @@ import Helper from '../Utilities/Helpers/Helper';
 import { AdaptableNumberEditor, AdaptableReactNumberEditor } from './editors/AdaptableNumberEditor';
 import { AdaptableDateEditor, AdaptableReactDateEditor } from './editors/AdaptableDateEditor';
 import { AgGridExportAdapter } from './AgGridExportAdapter';
+import { AdaptableHelper, } from '../Utilities/Helpers/AdaptableHelper';
 export function getEditorForColumnDataType(columnDataType, variant) {
     if (columnDataType === 'number') {
         return variant === 'react' ? AdaptableReactNumberEditor : AdaptableNumberEditor;
@@ -137,8 +138,6 @@ export class AgGridColumnAdapter {
             this.setupColumnQuickFilerText(colSetupInfo);
             this.setupColumnAllowedAggFuncs(colSetupInfo);
             this.setupColumnType(colSetupInfo);
-            // this is just to make sure that AG Grid does NOT infer the cellDataType
-            // https://github.com/AdaptableTools/adaptable/issues/2230 should render it obsolete
             this.setupColumnCellDataType(colSetupInfo);
         });
     }
@@ -278,7 +277,7 @@ export class AgGridColumnAdapter {
                 if (styledColumn.BadgeStyle) {
                     return getBadgeRendererForColumn(styledColumn.BadgeStyle, abColumn, this.adaptableApi);
                 }
-                if (styledColumn.SparkLineStyle) {
+                if (styledColumn.SparklineStyle) {
                     return 'agSparklineCellRenderer';
                 }
             }
@@ -286,8 +285,9 @@ export class AgGridColumnAdapter {
         this.setColDefProperty(col, 'cellRendererParams', (userDefined) => {
             const styledColumn = this.adaptableApi.styledColumnApi.getStyledColumnForColumnId(abColumn.columnId);
             if (styledColumn && !styledColumn.IsSuspended) {
-                if (styledColumn.SparkLineStyle) {
-                    const sparklineOptions = merge({}, userDefined?.sparklineOptions, styledColumn.SparkLineStyle.options);
+                if (styledColumn.SparklineStyle) {
+                    const sanitizedSparklineOptions = AdaptableHelper.removeAdaptableObjectPrimitives(styledColumn.SparklineStyle.options);
+                    const sparklineOptions = merge({}, userDefined?.sparklineOptions, sanitizedSparklineOptions);
                     return {
                         ...userDefined,
                         sparklineOptions,
@@ -373,8 +373,6 @@ export class AgGridColumnAdapter {
     }
     setupColumnCellDataType(columnSetupInfo) {
         const { col } = columnSetupInfo;
-        // AG Grid introduced since v30.x an inferred cellDataType
-        // the problem is that it breaks the default value formatter and/or editor (especially for Date columns)
         this.setColDefProperty(col, 'cellDataType', (original_cellDataType) => {
             return original_cellDataType ?? true;
         });
@@ -389,9 +387,6 @@ export class AgGridColumnAdapter {
             if (layoutCustomHeader) {
                 resultHeaderName = layoutCustomHeader;
             }
-            // required here for the initial layout rendering
-            // Removed by JW, 3 october 2023; i don't think we need it and it overrides stuff unnecessarily
-            abColumn.friendlyName = resultHeaderName;
             return resultHeaderName;
         });
         const newColumnHeader = col?.getColDef()?.headerName;

package/src/agGrid/AgGridExportAdapter.d.ts

@@ -1,13 +1,30 @@
 import { AdaptableAgGrid } from './AdaptableAgGrid';
 import { Report, ReportFormatType } from '../PredefinedConfig/ExportState';
-import { ExcelStyle } from 'ag-grid-enterprise';
+import { CsvExportParams, ExcelExportParams, ExcelStyle } from 'ag-grid-enterprise';
 import { ExportDestinationType, ExportResultData } from '../AdaptableOptions/ExportOptions';
+import { Layout } from '../PredefinedConfig/LayoutState';
 export interface ExportConfig {
     report: Report;
     format: ReportFormatType;
     destination: ExportDestinationType;
     showProgressIndicator: boolean;
 }
+interface ExportProcessContext extends ExportConfig {
+    exportedColumnIds: string[];
+    isExcelReport: boolean;
+    isVisualExcelReport: boolean;
+    isExportingVisibleColumnToJSON: boolean;
+    getCurrent: () => {
+        layout: Layout;
+        groupColumnIds: string[];
+        pivotColumnIds: string[];
+    };
+    isCellPartOfSelection: (rowId: string, columnId: string) => boolean;
+}
+export interface ExportProcessData {
+    exportContext: ExportProcessContext;
+    exportParams: ExcelExportParams | CsvExportParams;
+}
 export declare class AgGridExportAdapter {
     private _adaptableInstance;
     /**
@@ -23,9 +40,14 @@ export declare class AgGridExportAdapter {
     private get agGridApi();
     private get adaptableApi();
     private get exportOptions();
+    private get logger();
     static getExcelClassNameForCell(colId: string, primaryKeyValue: any, userDefinedCellClass?: string | string[]): string;
     destroy(): void;
     exportData(config: ExportConfig): Promise<null | ExportResultData>;
+    /**
+     * Creates export context and parameters for a given export configuration
+     */
+    buildExportProcessData(config: ExportConfig): ExportProcessData;
     private buildExportParams;
     private buildBaseExportParams;
     private computeProcessRowGroupCallback;
@@ -50,3 +72,4 @@ export declare class AgGridExportAdapter {
     private computeSkipColumnHeaders;
     private computeGetCustomContentBelowRow;
 }
+export {};