@adaptabletools/adaptable 20.0.0-canary.4 → 20.0.0-canary.6

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,6 +95,7 @@ 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';
 const LocalEventService_Prototype = LocalEventService.prototype;
 const LocalEventService_dispatchEvent = LocalEventService_Prototype.dispatchEvent;
 LocalEventService_Prototype.dispatchEvent = function (event) {
@@ -169,6 +170,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) {
@@ -596,12 +598,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`
@@ -718,7 +720,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 = {
@@ -2576,40 +2578,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) {
@@ -2674,41 +2642,8 @@ You need to define at least one Layout!`);
         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);
-            }
-        }
+        // Update AG THEME
+        this.agGridThemeAdapter.applyAgGridThemeOnAdaptableThemeChange(newTheme, variantTheme, container, themesToRemove);
         // MAC LIKE SCROLLBARS
         if (this.adaptableOptions.userInterfaceOptions &&
             this.adaptableOptions.userInterfaceOptions.useCustomMacLikeScrollbars &&
@@ -2902,6 +2837,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;
@@ -3024,6 +2961,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,

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,6 +1,6 @@
 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';
@@ -96,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
@@ -367,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();
@@ -525,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

@@ -138,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);
         });
     }
@@ -375,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;
         });
@@ -391,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/AgGridThemeAdapter.d.ts

@@ -0,0 +1,19 @@
+import { AdaptableAgGrid } from './AdaptableAgGrid';
+import { AgGridThemeMode } from './AgGridAdapter';
+import { AdaptableTheme } from '../PredefinedConfig/ThemeState';
+export declare class AgGridThemeAdapter {
+    private _adaptableInstance;
+    private agGridThemeMode;
+    constructor(_adaptableInstance: AdaptableAgGrid);
+    destroy(): void;
+    get logger(): import("./AdaptableLogger").AdaptableLogger;
+    get api(): import("../types").AdaptableApi;
+    setAgGridThemeMode(themeMode: AgGridThemeMode): void;
+    getAgGridThemeMode(): AgGridThemeMode;
+    applyAgGridThemeOnAdaptableThemeChange(adaptableTheme: AdaptableTheme, variantTheme: string, agGridContainer: HTMLElement, themesToRemove: AdaptableTheme[]): void;
+    private getAgGridContainerElement;
+    private legacy_applyAgGridThemeOnAdaptableThemeChange;
+    getAgGridCurrentThemeClassNames(): string;
+    private getAgGridLightThemeName;
+    private legacy_getAgGridCurrentThemeClassNames;
+}

package/src/agGrid/AgGridThemeAdapter.js

@@ -0,0 +1,122 @@
+import { DARK_THEME, LIGHT_THEME } from '../Utilities/Constants/GeneralConstants';
+export class AgGridThemeAdapter {
+    constructor(_adaptableInstance) {
+        this._adaptableInstance = _adaptableInstance;
+    }
+    destroy() { }
+    get logger() {
+        return this._adaptableInstance.logger;
+    }
+    get api() {
+        return this._adaptableInstance.api;
+    }
+    setAgGridThemeMode(themeMode) {
+        this.agGridThemeMode = themeMode;
+    }
+    getAgGridThemeMode() {
+        return this.agGridThemeMode;
+    }
+    applyAgGridThemeOnAdaptableThemeChange(adaptableTheme, variantTheme, agGridContainer, themesToRemove) {
+        if (this.agGridThemeMode === 'legacy') {
+            this.legacy_applyAgGridThemeOnAdaptableThemeChange(adaptableTheme, variantTheme, agGridContainer, themesToRemove);
+        }
+        const themeName = adaptableTheme.Name;
+        const isSystemTheme = this.api.themeApi.internalApi.isSystemTheme(themeName);
+        if (adaptableTheme && (isSystemTheme || variantTheme)) {
+            if ((variantTheme || themeName) === LIGHT_THEME) {
+                document.body.dataset.agThemeMode = 'light';
+            }
+            if ((variantTheme || themeName) === DARK_THEME) {
+                document.body.dataset.agThemeMode = 'dark';
+            }
+        }
+    }
+    getAgGridContainerElement() {
+        return this._adaptableInstance.getAgGridContainerElement();
+    }
+    legacy_applyAgGridThemeOnAdaptableThemeChange(adaptableTheme, variantTheme, agGridContainer, themesToRemove) {
+        const themeName = adaptableTheme.Name;
+        const isSystemTheme = this.api.themeApi.internalApi.isSystemTheme(themeName);
+        const getAgGridLightThemeName = () => this.getAgGridLightThemeName();
+        const getAgGridDarkThemeName = () => getAgGridLightThemeName() + '-dark';
+        if (adaptableTheme && (isSystemTheme || variantTheme)) {
+            if ((variantTheme || themeName) === LIGHT_THEME) {
+                adaptableTheme.AgGridClassName =
+                    adaptableTheme.AgGridClassName || getAgGridLightThemeName();
+            }
+            if ((variantTheme || themeName) === DARK_THEME) {
+                adaptableTheme.AgGridClassName = adaptableTheme.AgGridClassName || getAgGridDarkThemeName();
+            }
+        }
+        if (!adaptableTheme.AgGridClassName) {
+            // default AG Grid to its light theme
+            adaptableTheme.AgGridClassName = getAgGridLightThemeName();
+        }
+        if (agGridContainer != null) {
+            if (themesToRemove.length) {
+                themesToRemove.forEach((theme) => {
+                    if (theme.AgGridClassName) {
+                        agGridContainer.classList.remove(theme.AgGridClassName);
+                    }
+                });
+            }
+            // also remove all AG Grid theme class names
+            const agGridClassNamesToRemove = [];
+            agGridContainer.classList.forEach((x) => {
+                if (x && x.indexOf('ag-theme-') === 0) {
+                    agGridClassNamesToRemove.push(x);
+                }
+            });
+            agGridClassNamesToRemove.forEach((x) => agGridContainer.classList.remove(x));
+            if (adaptableTheme && adaptableTheme.AgGridClassName) {
+                agGridContainer.classList.add(adaptableTheme.AgGridClassName);
+            }
+        }
+    }
+    getAgGridCurrentThemeClassNames() {
+        if (this.agGridThemeMode === 'legacy') {
+            this.legacy_getAgGridCurrentThemeClassNames();
+        }
+        const currentAgGridTheme = this._adaptableInstance.agGridAdapter.getGridOption('theme');
+        if (currentAgGridTheme === 'legacy') {
+            return this.legacy_getAgGridCurrentThemeClassNames();
+        }
+        // @ts-ignore no other way than to use internals
+        const currentAgGridTheme__cssClassCache = currentAgGridTheme?._cssClassCache;
+        return currentAgGridTheme__cssClassCache ?? '';
+    }
+    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';
+    }
+    legacy_getAgGridCurrentThemeClassNames() {
+        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();
+    }
+}

package/src/components/OverlayTrigger/useAgGridClassName.js

@@ -4,7 +4,7 @@ const useAgGridClassName = (deps = []) => {
     const adaptable = useAdaptable();
     return useMemo(() => {
         if (adaptable) {
-            return adaptable.getAgGridCurrentThemeName();
+            return adaptable.agGridThemeAdapter.getAgGridCurrentThemeClassNames();
         }
         return '';
     }, deps);

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: 1740989608096 || Date.now(),
-    VERSION: "20.0.0-canary.4" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1741253338614 || Date.now(),
+    VERSION: "20.0.0-canary.6" || '--current-version--',
 };

package/src/metamodel/adaptable.metamodel.d.ts

@@ -2289,6 +2289,22 @@ export declare const ADAPTABLE_METAMODEL: {
             ref?: undefined;
         })[];
     };
+    CustomEditColumnValueInfo: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt?: undefined;
+        })[];
+    };
     CustomEditColumnValuesContext: {
         name: string;
         kind: string;