@adaptabletools/adaptable 20.3.0 → 21.0.0-canary.1

package/src/Redux/Store/AdaptableStore.js

@@ -892,18 +892,18 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     const newLayout = (newLayoutState.Layouts || []).find((l) => l.Name == newLayoutState.CurrentLayout) ||
                         newLayoutState.Layouts[0] ||
                         ERROR_LAYOUT;
-                    // Apply filtering if Column or Grid filters have been changed
-                    let refreshFilters = false;
+                    const changedColumnSorts = adaptable.api.layoutApi.internalApi.getChangedColumnSorts(oldLayout.ColumnSorts, newLayout.ColumnSorts);
+                    changedColumnSorts.forEach((columnId) => adaptable.api.filterApi.columnFilterApi.resetFilterValues(columnId));
+                    let refreshColumnFilters = false;
                     if (adaptable.api.filterApi.columnFilterApi.internalApi.areColumnFiltersDifferent(oldLayout.ColumnFilters, newLayout.ColumnFilters)) {
-                        refreshFilters = true;
+                        refreshColumnFilters = true;
                     }
-                    // Apply Grid filtering if Grid filter has been changed
-                    if (!refreshFilters &&
-                        adaptable.api.filterApi.gridFilterApi.internalApi.isGridFilterDifferent(oldLayout.GridFilter, newLayout.GridFilter)) {
-                        refreshFilters = true;
+                    let refreshGridFilter = false;
+                    if (adaptable.api.filterApi.gridFilterApi.internalApi.isGridFilterDifferent(oldLayout.GridFilter, newLayout.GridFilter)) {
+                        refreshGridFilter = true;
                     }
-                    if (refreshFilters) {
-                        adaptable.applyFiltering();
+                    if (refreshColumnFilters || refreshGridFilter) {
+                        adaptable.applyFiltering({ updateColumnFilterModel: refreshColumnFilters });
                     }
                     if (returnAction.type == LayoutRedux.LAYOUT_SELECT ||
                         returnAction.type == LayoutRedux.LAYOUT_DELETE) {
@@ -969,7 +969,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     adaptable.api.eventApi.internalApi.fireGridFilterAppliedEvent();
                     adaptable.api.eventApi.internalApi.fireLayoutChangedEvent(action.type, null, middlewareAPI.getState().Layout);
                     setTimeout(() => {
-                        adaptable.applyFiltering();
+                        adaptable.applyFiltering({ updateColumnFilterModel: false });
                     }, 5);
                     return next(returnAction);
                 }

package/src/Strategy/AdaptableModuleBase.d.ts

@@ -1,3 +1,4 @@
+import { AgModuleName } from 'ag-grid-enterprise';
 import { IModule, ModuleInfo, TeamSharingReferences } from './Interface/IModule';
 import { Action } from 'redux';
 import { AdaptableColumn } from '../AdaptableState/Common/AdaptableColumn';
@@ -20,15 +21,24 @@ export declare abstract class AdaptableModuleBase implements IModule {
     protected api: AdaptableApi;
     moduleInfo: ModuleInfo;
     AccessLevel: AccessLevel;
+    agGridModuleDepsInfo: {
+        hasRequiredAgGridModuleDependencies: boolean;
+        missingAgGridModuleDependencies?: AgModuleName[];
+    };
     constructor(module: AdaptableModule, friendlyName: string, glyph: AdaptableSystemIconName, popup: string, description: string, api: AdaptableApi);
     protected getViewAccessLevel(): AccessLevel;
     protected getEditAccessLevel(): AccessLevel;
+    protected getAgGridModuleDependencies(): AgModuleName[];
+    isModuleEnabled(): boolean;
     isModuleAvailable(): boolean;
+    isModuleVisible(): boolean;
+    isModuleEditable(): boolean;
+    setAgGridDepsInfo(): void;
+    logMissingAgGridDepsInfos(): void;
     /**
      * Used inside the unified UI to show the share button
      */
     isModuleObjectsShareable(): boolean;
-    isModuleEditable(): boolean;
     getModuleAdaptableObjects(): AdaptableObject[];
     getExplicitlyReferencedColumnIds(adaptableObject: AdaptableObject): string[];
     getReferencedNamedQueryNames(adaptableObject: AdaptableObject): string[];
@@ -56,10 +66,10 @@ export declare abstract class AdaptableModuleBase implements IModule {
     getTeamSharingReferences(adaptableObject: AdaptableObject): TeamSharingReferences;
     getPopupMaxWidth(): number | undefined;
     /**
-     * TRUE for objects of type {@link LayoutAssociatedObject}
+     * TRUE for objects of type {@link LayoutExtensionObject}
      */
-    canBeAssociatedWithLayouts(): boolean;
-    showLayoutNotAssociatedObjects(): boolean;
+    containsLayoutExtensions(): boolean;
+    showLayoutNonExtendedObjects(): boolean;
     private getFriendlyName;
     private hasRequiredAccessLevel;
 }

package/src/Strategy/AdaptableModuleBase.js

@@ -31,8 +31,48 @@ export class AdaptableModuleBase {
         // override where necessary
         return 'Full';
     }
+    getAgGridModuleDependencies() {
+        // override where necessary
+        return [];
+    }
+    isModuleEnabled() {
+        // by default all modules are enabled; some modules may override this to check specific flags, configs, etc.
+        return true;
+    }
     isModuleAvailable() {
-        return this.hasRequiredAccessLevel(this.getViewAccessLevel());
+        return this.agGridModuleDepsInfo?.hasRequiredAgGridModuleDependencies;
+    }
+    isModuleVisible() {
+        return (this.isModuleEnabled() &&
+            this.isModuleAvailable() &&
+            this.hasRequiredAccessLevel(this.getViewAccessLevel()));
+    }
+    isModuleEditable() {
+        return (this.isModuleEnabled() &&
+            this.isModuleAvailable() &&
+            this.hasRequiredAccessLevel(this.getEditAccessLevel()));
+    }
+    setAgGridDepsInfo() {
+        const agGridModulesAdapter = this.api.internalApi.getAgGridModulesAdapter();
+        const missingAgGridModuleDependencies = this.getAgGridModuleDependencies().filter((agGridModule) => !agGridModulesAdapter.isAgGridModuleRegistered(agGridModule));
+        if (missingAgGridModuleDependencies.length) {
+            this.agGridModuleDepsInfo = {
+                hasRequiredAgGridModuleDependencies: false,
+                missingAgGridModuleDependencies,
+            };
+        }
+        else {
+            this.agGridModuleDepsInfo = {
+                hasRequiredAgGridModuleDependencies: true,
+            };
+        }
+    }
+    logMissingAgGridDepsInfos() {
+        if (this.isModuleEnabled() &&
+            this.hasRequiredAccessLevel(this.getViewAccessLevel()) &&
+            !this.isModuleAvailable()) {
+            this.api.logWarn(`Module '${this.moduleInfo.ModuleName}' is not available -  missing required AG Grid modules: ${this.agGridModuleDepsInfo.missingAgGridModuleDependencies.join(', ')}`);
+        }
     }
     /**
      * Used inside the unified UI to show the share button
@@ -40,9 +80,6 @@ export class AdaptableModuleBase {
     isModuleObjectsShareable() {
         return true;
     }
-    isModuleEditable() {
-        return this.hasRequiredAccessLevel(this.getEditAccessLevel());
-    }
     getModuleAdaptableObjects() {
         // override where necessary in base classes
         return [];
@@ -70,7 +107,7 @@ export class AdaptableModuleBase {
         this.AccessLevel = this.api.entitlementApi.getEntitlementAccessLevelForModule(this.moduleInfo.ModuleName);
     }
     createModuleMenuItem(source) {
-        if (this.isModuleAvailable() && this.moduleInfo.Popup) {
+        if (this.isModuleVisible() && this.moduleInfo.Popup) {
             const moduleParams = {
                 source: source,
                 maxWidth: this.getPopupMaxWidth(),
@@ -192,13 +229,13 @@ export class AdaptableModuleBase {
         return undefined;
     }
     /**
-     * TRUE for objects of type {@link LayoutAssociatedObject}
+     * TRUE for objects of type {@link LayoutExtensionObject}
      */
-    canBeAssociatedWithLayouts() {
+    containsLayoutExtensions() {
         return false;
     }
-    showLayoutNotAssociatedObjects() {
-        return this.api.layoutApi.internalApi.showLayoutNotAssociatedObjects();
+    showLayoutNonExtendedObjects() {
+        return this.api.layoutApi.internalApi.showLayoutNonExtendedObjects();
     }
     getFriendlyName(module, friendlyName) {
         let returnValue = friendlyName;

package/src/Strategy/AlertModule.d.ts

@@ -5,6 +5,7 @@ import { AdaptableObject } from '../AdaptableState/Common/AdaptableObject';
 import { ContextMenuContext } from '../AdaptableState/Common/Menu';
 import { TeamSharingImportInfo } from '../AdaptableState/TeamSharingState';
 import { MenuItemShowPopup } from '../Utilities/MenuItem';
+import { LayoutExtendedConfig } from '../types';
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { ICellDataChangeListenerModule } from './Interface/ICellDataChangeListenerModule';
 import { AdaptableModuleView, AdaptableObjectCompactView, AdaptableObjectView } from './Interface/IModule';
@@ -15,9 +16,7 @@ export declare class AlertModule extends AdaptableModuleBase implements ICellDat
     shouldListenToDataChanges(): boolean;
     checkListenToCellDataChanged(): void;
     setupCellDataChangeListener(): void;
-    getModuleAdaptableObjects(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): AdaptableObject[];
+    getModuleAdaptableObjects(config?: LayoutExtendedConfig): AdaptableObject[];
     getExplicitlyReferencedColumnIds(alertDefinition: AlertDefinition): string[];
     getReferencedNamedQueryNames(alertDefinition: AlertDefinition): string[];
     createContextMenuItems(menuContext: ContextMenuContext): MenuItemShowPopup<"calculated-column-edit" | "cell-summary-show" | "column-group" | "column-filter-group" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "grid-group" | "grid-info-show" | "layout-edit" | "settings-panel-open" | "system-status-show" | "menu-group" | "alert-clear" | "bulk-update-apply" | "column-filter-on-cell-value" | "comment-add" | "comment-remove" | "edit-group" | "export-group" | "export-all-data" | "export-all-data-excel-download" | "export-all-data-visualexcel-download" | "export-all-data-csv" | "export-all-data-csv-download" | "export-all-data-csv-clipboard" | "export-all-data-json" | "export-all-data-json-download" | "export-all-data-json-clipboard" | "export-current-layout" | "export-current-layout-excel-download" | "export-current-layout-visualexcel-download" | "export-current-layout-csv" | "export-current-layout-csv-download" | "export-current-layout-csv-clipboard" | "export-current-layout-json" | "export-current-layout-json-download" | "export-current-layout-json-clipboard" | "export-selected-data" | "export-selected-data-excel-download" | "export-selected-data-visualexcel-download" | "export-selected-data-csv" | "export-selected-data-csv-download" | "export-selected-data-csv-clipboard" | "export-selected-data-json" | "export-selected-data-json-download" | "export-selected-data-json-clipboard" | "fdc3-broadcast" | "fdc3-raise-intent" | "flashing-cell-clear" | "flashing-row-clear" | "layout-aggregated-view" | "layout-auto-size" | "layout-clear-selection" | "layout-select-all" | "note-add" | "note-remove" | "smart-edit-apply">[];
@@ -30,5 +29,5 @@ export declare class AlertModule extends AdaptableModuleBase implements ICellDat
     toView(alert: AlertDefinition): AdaptableObjectView;
     toViewAll(): AdaptableObjectView[];
     getViewProperties(): AdaptableModuleView;
-    canBeAssociatedWithLayouts(): boolean;
+    containsLayoutExtensions(): boolean;
 }

package/src/Strategy/AlertModule.js

@@ -99,7 +99,7 @@ export class AlertModule extends AdaptableModuleBase {
     }
     createContextMenuItems(menuContext) {
         const items = [];
-        if (!menuContext.isRowGroupColumn && this.isModuleAvailable()) {
+        if (!menuContext.isRowGroupColumn && this.isModuleVisible()) {
             if (menuContext.adaptableColumn && menuContext.rowNode) {
                 let relevantAlert;
                 // find alerts which highlight the current cell
@@ -159,8 +159,11 @@ export class AlertModule extends AdaptableModuleBase {
         });
     }
     getTeamSharingAction() {
+        const config = {
+            includeLayoutNotExtendedObjects: false,
+        };
         return {
-            ModuleEntities: this.api.alertApi.getAlertDefinitions(),
+            ModuleEntities: this.api.alertApi.getAlertDefinitions(config),
             AddAction: AlertRedux.AlertDefinitionAdd,
             EditAction: AlertRedux.AlertDefinitionEdit,
         };
@@ -195,7 +198,7 @@ export class AlertModule extends AdaptableModuleBase {
     }
     toViewAll() {
         return this.getModuleAdaptableObjects({
-            includeLayoutNotAssociatedObjects: this.showLayoutNotAssociatedObjects(),
+            includeLayoutNotExtendedObjects: this.showLayoutNonExtendedObjects(),
         }).map((alert) => this.toView(alert));
     }
     getViewProperties() {
@@ -221,7 +224,7 @@ export class AlertModule extends AdaptableModuleBase {
             },
         };
     }
-    canBeAssociatedWithLayouts() {
+    containsLayoutExtensions() {
         return true;
     }
 }

package/src/Strategy/CalculatedColumnModule.js

@@ -63,7 +63,7 @@ export class CalculatedColumnModule extends AdaptableModuleBase {
         if (!column) {
             return;
         }
-        if (!this.isModuleAvailable()) {
+        if (!this.isModuleVisible()) {
             return;
         }
         if (this.isModuleEditable() && column.isCalculatedColumn) {
@@ -81,7 +81,7 @@ export class CalculatedColumnModule extends AdaptableModuleBase {
         if (!menuContext.adaptableColumn) {
             return;
         }
-        if (!this.isModuleAvailable()) {
+        if (!this.isModuleVisible()) {
             return;
         }
         if (this.isModuleEditable() &&

package/src/Strategy/CellSummaryModule.js

@@ -16,7 +16,7 @@ export class CellSummaryModule extends AdaptableModuleBase {
         return 'Full';
     }
     createColumnMenuItems(column) {
-        if (!this.isModuleAvailable()) {
+        if (!this.isModuleVisible()) {
             return;
         }
         if (column.dataType !== 'number') {
@@ -36,7 +36,7 @@ export class CellSummaryModule extends AdaptableModuleBase {
         ];
     }
     createContextMenuItems(menuContext) {
-        if (!this.isModuleAvailable()) {
+        if (!this.isModuleVisible()) {
             return;
         }
         if (menuContext.adaptableColumn &&

package/src/Strategy/ChartingModule.d.ts

@@ -3,9 +3,11 @@ import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableColumn, ChartDefinition } from '../types';
 import { ExternalChartDefinition } from '../AdaptableState/ChartingState';
+import { AgModuleName } from 'ag-grid-enterprise';
 export declare class ChartingModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
-    isModuleAvailable(): boolean;
+    protected getAgGridModuleDependencies(): AgModuleName[];
+    isModuleEnabled(): boolean;
     createColumnMenuItems(column: AdaptableColumn): import("../Utilities/MenuItem").MenuItemShowPopup<"separator" | "calculated-column-edit" | "cell-summary-show" | "chart-show" | "column-group" | "column-filter-group" | "column-filter-bar-hide" | "column-filter-bar-show" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "custom-sort-add" | "custom-sort-edit" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "flashing-cell-add" | "flashing-cell-delete" | "format-column-add" | "format-column-edit" | "free-text-column-edit" | "grid-group" | "grid-info-show" | "layout-column-caption-change" | "layout-column-hide" | "layout-edit" | "layout-column-select" | "layout-column-select-preserve" | "layout-column-select-reset" | "layout-grid-select" | "plus-minus-add" | "settings-panel-open" | "styling-group" | "styled-column-badge-add" | "styled-column-badge-edit" | "styled-column-gradient-add" | "styled-column-gradient-edit" | "styled-column-percent-bar-add" | "styled-column-percent-bar-edit" | "styled-column-sparkline-add" | "styled-column-sparkline-edit" | "system-status-show" | "_navbar">[];
     getModuleAdaptableObjects(): (ChartDefinition | ExternalChartDefinition)[];
     toViewAll(): AdaptableObjectView[];

package/src/Strategy/ChartingModule.js

@@ -12,10 +12,16 @@ export class ChartingModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.ChartingModuleId, ModuleConstants.ChartingFriendlyName, 'chart', 'ChartPopup', 'Create AG Grid Charts in order to see Adaptable Data visually', api);
     }
-    isModuleAvailable() {
-        const agChartsAvailable = this.api.chartingApi.isChartingEnabled() && super.isModuleAvailable();
+    getAgGridModuleDependencies() {
+        return ['IntegratedChartsModule'];
+    }
+    isModuleEnabled() {
+        const agGridChartsEnabled = this.api.agGridApi.getGridOption('enableCharts');
+        if (agGridChartsEnabled) {
+            return true;
+        }
         const externalChartsAvailable = Helper.objectHasKeys(this.api.optionsApi.getChartingOptions().externalChartingOptions);
-        return Boolean(agChartsAvailable || externalChartsAvailable);
+        return externalChartsAvailable;
     }
     createColumnMenuItems(column) {
         if (column &&

package/src/Strategy/ColumnFilterModule.d.ts

@@ -8,11 +8,11 @@ import { AdaptableObject } from '../AdaptableState/Common/AdaptableObject';
 import { ColumnFilter } from '../types';
 export declare class ColumnFilterModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
+    onAdaptableReady(): void;
     setModuleEntitlement(): void;
     getModuleAdaptableObjects(): AdaptableObject[];
     getExplicitlyReferencedColumnIds(columnFilter: ColumnFilter): string[];
     hasNamedQueryReferences(): boolean;
-    onAdaptableReady(): void;
     createColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem<"separator" | "calculated-column-edit" | "cell-summary-show" | "chart-show" | "column-group" | "column-filter-group" | "column-filter-bar-hide" | "column-filter-bar-show" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "custom-sort-add" | "custom-sort-edit" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "flashing-cell-add" | "flashing-cell-delete" | "format-column-add" | "format-column-edit" | "free-text-column-edit" | "grid-group" | "grid-info-show" | "layout-column-caption-change" | "layout-column-hide" | "layout-edit" | "layout-column-select" | "layout-column-select-preserve" | "layout-column-select-reset" | "layout-grid-select" | "plus-minus-add" | "settings-panel-open" | "styling-group" | "styled-column-badge-add" | "styled-column-badge-edit" | "styled-column-gradient-add" | "styled-column-gradient-edit" | "styled-column-percent-bar-add" | "styled-column-percent-bar-edit" | "styled-column-sparkline-add" | "styled-column-sparkline-edit" | "system-status-show" | "_navbar">[];
     createContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem<AdaptableContextMenuItemName>[] | undefined;
     getTeamSharingAction(): TeamSharingImportInfo<ColumnFilter>;

package/src/Strategy/ColumnFilterModule.js

@@ -8,6 +8,36 @@ export class ColumnFilterModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.ColumnFilterModuleId, ModuleConstants.ColumnFilterFriendlyName, 'filter', 'FilterPopup', 'Advanced filtering capability allows users to see precisely the data they want', api);
     }
+    onAdaptableReady() {
+        if (this.api.optionsApi.getFilterOptions().columnFilterOptions.showQuickFilter == false) {
+            this.api.filterApi.columnFilterApi.hideQuickFilterBar();
+        }
+        else {
+            this.api.filterApi.columnFilterApi.showQuickFilterBar();
+        }
+        const columnFilters = this.api.filterApi.columnFilterApi.getColumnFilters();
+        columnFilters.forEach((cf) => {
+            if (!this.api.columnApi.isColumnInGrid(cf.ColumnId)) {
+                this.api.logError('Column Filter contains missing column: ' + cf.ColumnId);
+            }
+        });
+        this.api.internalApi
+            .getDataService()
+            .on('CellDataChanged', (cellDataChangedInfo) => {
+            const changedColumnId = cellDataChangedInfo.column.columnId;
+            this.api.filterApi.columnFilterApi.resetFilterValues(changedColumnId);
+        });
+        // we reset the filter cache on sort change, because we might have columns
+        // with "In" filters, with custom values, which use `context.orderedValues`
+        // customInFilterValues: (context: CustomInFilterValuesContext<Car>) => {
+        //   return context.orderedValues;
+        // }
+        // and that order will most likely change when sorting happens
+        // so we need to reset the cached filter values when sorting changes
+        this.api.eventApi.on('GridSorted', () => {
+            this.api.filterApi.columnFilterApi.resetAllFilterValues();
+        });
+    }
     setModuleEntitlement() {
         if (!this.api.optionsApi.getFilterOptions().useAdaptableFiltering) {
             this.AccessLevel = 'Hidden';
@@ -25,20 +55,6 @@ export class ColumnFilterModule extends AdaptableModuleBase {
     hasNamedQueryReferences() {
         return false;
     }
-    onAdaptableReady() {
-        if (this.api.optionsApi.getFilterOptions().columnFilterOptions.showQuickFilter == false) {
-            this.api.filterApi.columnFilterApi.hideQuickFilterBar();
-        }
-        else {
-            this.api.filterApi.columnFilterApi.showQuickFilterBar();
-        }
-        const columnFilters = this.api.filterApi.columnFilterApi.getColumnFilters();
-        columnFilters.forEach((cf) => {
-            if (!this.api.columnApi.isColumnInGrid(cf.ColumnId)) {
-                this.api.logError('Column Filter contains missing column: ' + cf.ColumnId);
-            }
-        });
-    }
     createColumnMenuItems(column) {
         let columnFilterMenuItems = [];
         if (column &&
@@ -64,7 +80,7 @@ export class ColumnFilterModule extends AdaptableModuleBase {
         }
     }
     createContextMenuItems(menuContext) {
-        if (!menuContext.isRowGroupColumn && this.isModuleAvailable()) {
+        if (!menuContext.isRowGroupColumn && this.isModuleVisible()) {
             if (menuContext.adaptableColumn &&
                 menuContext.adaptableColumn.filterable &&
                 menuContext.isSingleSelectedColumn &&

package/src/Strategy/ColumnInfoModule.js

@@ -8,7 +8,7 @@ export class ColumnInfoModule extends AdaptableModuleBase {
         return 'Full';
     }
     createColumnMenuItems(column) {
-        if (this.isModuleAvailable() && !column.isTreeColumn) {
+        if (this.isModuleVisible() && !column.isTreeColumn) {
             const columnPopUpParams = {
                 source: 'ColumnMenu',
                 column: column,
@@ -25,7 +25,7 @@ export class ColumnInfoModule extends AdaptableModuleBase {
         }
     }
     createContextMenuItems(menuContext) {
-        if (this.isModuleAvailable()) {
+        if (this.isModuleVisible()) {
             const columnPopUpParams = {
                 source: 'ColumnMenu',
                 column: menuContext.adaptableColumn,

package/src/Strategy/CommentModule.d.ts

@@ -5,7 +5,7 @@ import { IModule } from './Interface/IModule';
 export declare class CommentModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
     onAdaptableReady(): void;
-    isModuleAvailable(): boolean;
+    isModuleEnabled(): boolean;
     private loadComments;
     createContextMenuItems(menuContext: ContextMenuContext): import("../Utilities/MenuItem").MenuItemDoClickFunction<"calculated-column-edit" | "cell-summary-show" | "column-group" | "column-filter-group" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "grid-group" | "grid-info-show" | "layout-edit" | "settings-panel-open" | "system-status-show" | "menu-group" | "alert-clear" | "bulk-update-apply" | "column-filter-on-cell-value" | "comment-add" | "comment-remove" | "edit-group" | "export-group" | "export-all-data" | "export-all-data-excel-download" | "export-all-data-visualexcel-download" | "export-all-data-csv" | "export-all-data-csv-download" | "export-all-data-csv-clipboard" | "export-all-data-json" | "export-all-data-json-download" | "export-all-data-json-clipboard" | "export-current-layout" | "export-current-layout-excel-download" | "export-current-layout-visualexcel-download" | "export-current-layout-csv" | "export-current-layout-csv-download" | "export-current-layout-csv-clipboard" | "export-current-layout-json" | "export-current-layout-json-download" | "export-current-layout-json-clipboard" | "export-selected-data" | "export-selected-data-excel-download" | "export-selected-data-visualexcel-download" | "export-selected-data-csv" | "export-selected-data-csv-download" | "export-selected-data-csv-clipboard" | "export-selected-data-json" | "export-selected-data-json-download" | "export-selected-data-json-clipboard" | "fdc3-broadcast" | "fdc3-raise-intent" | "flashing-cell-clear" | "flashing-row-clear" | "layout-aggregated-view" | "layout-auto-size" | "layout-clear-selection" | "layout-select-all" | "note-add" | "note-remove" | "smart-edit-apply">[];
 }

package/src/Strategy/CommentModule.js

@@ -7,7 +7,7 @@ export class CommentModule extends AdaptableModuleBase {
     onAdaptableReady() {
         this.loadComments();
     }
-    isModuleAvailable() {
+    isModuleEnabled() {
         const options = this.api.optionsApi.getCommentOptions();
         if (!options || !options.persistCommentThreads || !options.loadCommentThreads) {
             return false;
@@ -15,7 +15,7 @@ export class CommentModule extends AdaptableModuleBase {
         if (this.api.optionsApi.isAutogeneratePrimaryKey()) {
             return false;
         }
-        return super.isModuleAvailable();
+        return super.isModuleEnabled();
     }
     async loadComments() {
         const commentThreads = await this.api.optionsApi
@@ -24,7 +24,7 @@ export class CommentModule extends AdaptableModuleBase {
         this.api.commentApi.setComments(commentThreads);
     }
     createContextMenuItems(menuContext) {
-        if (!this.isModuleAvailable()) {
+        if (!this.isModuleVisible()) {
             return;
         }
         if (!this.api.commentApi.internalApi.areCommentsSupportedInLayout()) {

package/src/Strategy/CustomSortModule.d.ts

@@ -5,11 +5,10 @@ import { TeamSharingImportInfo } from '../AdaptableState/TeamSharingState';
 import { AdaptableModuleView, AdaptableObjectView, IModule } from './Interface/IModule';
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableObject } from '../AdaptableState/Common/AdaptableObject';
+import { LayoutExtendedConfig } from '../types';
 export declare class CustomSortModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
-    getModuleAdaptableObjects(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): AdaptableObject[];
+    getModuleAdaptableObjects(config?: LayoutExtendedConfig): AdaptableObject[];
     getExplicitlyReferencedColumnIds(customSort: CustomSort): string[];
     hasNamedQueryReferences(): boolean;
     createColumnMenuItems(column: AdaptableColumn): import("../Utilities/MenuItem").MenuItemShowPopup<"custom-sort-add" | "custom-sort-edit">[];
@@ -17,5 +16,5 @@ export declare class CustomSortModule extends AdaptableModuleBase implements IMo
     toView(customSort: CustomSort): AdaptableObjectView;
     toViewAll(): AdaptableObjectView[];
     getViewProperties(): AdaptableModuleView;
-    canBeAssociatedWithLayouts(): boolean;
+    containsLayoutExtensions(): boolean;
 }

package/src/Strategy/CustomSortModule.js

@@ -56,7 +56,7 @@ export class CustomSortModule extends AdaptableModuleBase {
     }
     toViewAll() {
         return this.getModuleAdaptableObjects({
-            includeLayoutNotAssociatedObjects: this.showLayoutNotAssociatedObjects(),
+            includeLayoutNotExtendedObjects: this.showLayoutNonExtendedObjects(),
         }).map((customSort) => this.toView(customSort));
     }
     getViewProperties() {
@@ -73,7 +73,7 @@ export class CustomSortModule extends AdaptableModuleBase {
             },
         };
     }
-    canBeAssociatedWithLayouts() {
+    containsLayoutExtensions() {
         return true;
     }
 }

package/src/Strategy/DashboardModule.js

@@ -25,7 +25,7 @@ export class DashboardModule extends AdaptableModuleBase {
         return this.buildMenuItems();
     }
     buildMenuItems() {
-        if (this.isModuleAvailable()) {
+        if (this.isModuleVisible()) {
             let menuItems = [];
             const dashboardState = this.api.dashboardApi.getDashboardState();
             if (this.isModuleEditable()) {

package/src/Strategy/DataChangeHistoryModule.d.ts

@@ -2,14 +2,15 @@ import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { AdaptableModuleView } from './Interface/IModule';
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { ICellDataChangeListenerModule } from './Interface/ICellDataChangeListenerModule';
+import { AgModuleName } from 'ag-grid-enterprise';
 export declare class DataChangeHistoryModule extends AdaptableModuleBase implements ICellDataChangeListenerModule {
     isListeningToCellDataChanges: boolean;
     constructor(api: AdaptableApi);
     onAdaptableReady(): void;
+    protected getAgGridModuleDependencies(): AgModuleName[];
     shouldListenToDataChanges(): boolean;
     checkListenToCellDataChanged(): void;
     setupCellDataChangeListener(): void;
-    isModuleAvailable(): boolean;
     getPopupMaxWidth(): number;
     hasNamedQueryReferences(): boolean;
     private isDataChangeLoggable;

package/src/Strategy/DataChangeHistoryModule.js

@@ -10,6 +10,9 @@ export class DataChangeHistoryModule extends AdaptableModuleBase {
         this.api.internalApi.initializeDataChangeHistory();
         this.checkListenToCellDataChanged();
     }
+    getAgGridModuleDependencies() {
+        return ['ClientSideRowModelModule'];
+    }
     shouldListenToDataChanges() {
         return this.api.dataChangeHistoryApi.getDataChangeHistoryMode() === 'ACTIVE';
     }
@@ -30,16 +33,6 @@ export class DataChangeHistoryModule extends AdaptableModuleBase {
             }
         });
     }
-    isModuleAvailable() {
-        const isAdaptableModuleAvailable = super.isModuleAvailable();
-        const isAgGridModuleAvailable = this.api.internalApi
-            .getAdaptableInstance()
-            .agGridAdapter.isAgGridModuleRegistered('ClientSideRowModel');
-        if (isAdaptableModuleAvailable && !isAgGridModuleAvailable) {
-            this.api.logWarn(`Data Change History is NOT available due to missing required AG Grid module: ClientSideRowModel`);
-        }
-        return isAdaptableModuleAvailable && isAgGridModuleAvailable;
-    }
     getPopupMaxWidth() {
         return 1000;
     }

package/src/Strategy/DataImportModule.js

@@ -5,18 +5,18 @@ export class DataImportModule extends AdaptableModuleBase {
         super(ModuleConstants.DataImportModuleId, ModuleConstants.DataImportFriendyName, 'import', 'DataImportPopup', 'Import Data', api);
     }
     createModuleMenuItem(source) {
-        if (this.isModuleAvailable()) {
+        if (this.isModuleVisible()) {
             return this.createDataImportMenuItem(source);
         }
     }
     createContextMenuItems() {
-        if (this.isModuleAvailable()) {
+        if (this.isModuleVisible()) {
             return [this.createDataImportMenuItem('ContextMenu')];
         }
         return undefined;
     }
     createColumnMenuItems() {
-        if (this.isModuleAvailable()) {
+        if (this.isModuleVisible()) {
             return [this.createDataImportMenuItem('ColumnMenu')];
         }
     }

package/src/Strategy/ExportModule.js

@@ -30,7 +30,7 @@ export class ExportModule extends AdaptableModuleBase {
         return this.api.namedQueryApi.internalApi.getReferencedNamedQueryNames(report.Query.BooleanExpression);
     }
     createContextMenuItems(menuContext) {
-        const canExport = !menuContext.isRowGroupColumn && this.isModuleAvailable();
+        const canExport = !menuContext.isRowGroupColumn && this.isModuleVisible();
         if (!canExport) {
             return;
         }

package/src/Strategy/Fdc3Module.js

@@ -5,7 +5,7 @@ export class Fdc3Module extends AdaptableModuleBase {
         super(ModuleConstants.Fdc3ModuleId, ModuleConstants.Fdc3FriendlyName, 'fdc3', null, 'The FDC3 Module - handles the FDC3 integration', api);
     }
     createContextMenuItems(menuContext) {
-        if (!this.isModuleAvailable()) {
+        if (!this.isModuleVisible()) {
             return;
         }
         if (menuContext.adaptableColumn && menuContext.rowNode) {

package/src/Strategy/FlashingCellModule.d.ts

@@ -5,7 +5,7 @@ import { TeamSharingImportInfo } from '../AdaptableState/TeamSharingState';
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { AdaptableModuleView, AdaptableObjectView } from './Interface/IModule';
 import { AdaptableObject } from '../AdaptableState/Common/AdaptableObject';
-import { FlashingCellDefinition } from '../types';
+import { FlashingCellDefinition, LayoutExtendedConfig } from '../types';
 import { ICellDataChangeListenerModule } from './Interface/ICellDataChangeListenerModule';
 export declare class FlashingCellModule extends AdaptableModuleBase implements ICellDataChangeListenerModule {
     private isListeningToCellDataChanges;
@@ -16,9 +16,7 @@ export declare class FlashingCellModule extends AdaptableModuleBase implements I
     setupCellDataChangeListener(): void;
     private getFlashingCellDefinitionsForDataChange;
     private showFlashingCellsForDefinitions;
-    getModuleAdaptableObjects(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): AdaptableObject[];
+    getModuleAdaptableObjects(config?: LayoutExtendedConfig): AdaptableObject[];
     getExplicitlyReferencedColumnIds(alertDefinition: FlashingCellDefinition): string[];
     getReferencedNamedQueryNames(alertDefinition: FlashingCellDefinition): string[];
     createColumnMenuItems(column: AdaptableColumn): import("../Utilities/MenuItem").MenuItemDoReduxAction<"separator" | "calculated-column-edit" | "cell-summary-show" | "chart-show" | "column-group" | "column-filter-group" | "column-filter-bar-hide" | "column-filter-bar-show" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "custom-sort-add" | "custom-sort-edit" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "flashing-cell-add" | "flashing-cell-delete" | "format-column-add" | "format-column-edit" | "free-text-column-edit" | "grid-group" | "grid-info-show" | "layout-column-caption-change" | "layout-column-hide" | "layout-edit" | "layout-column-select" | "layout-column-select-preserve" | "layout-column-select-reset" | "layout-grid-select" | "plus-minus-add" | "settings-panel-open" | "styling-group" | "styled-column-badge-add" | "styled-column-badge-edit" | "styled-column-gradient-add" | "styled-column-gradient-edit" | "styled-column-percent-bar-add" | "styled-column-percent-bar-edit" | "styled-column-sparkline-add" | "styled-column-sparkline-edit" | "system-status-show" | "_navbar">[];
@@ -29,5 +27,5 @@ export declare class FlashingCellModule extends AdaptableModuleBase implements I
     toView(flashingCell: FlashingCellDefinition): AdaptableObjectView;
     toViewAll(): AdaptableObjectView[];
     getViewProperties(): AdaptableModuleView;
-    canBeAssociatedWithLayouts(): boolean;
+    containsLayoutExtensions(): boolean;
 }