@adaptabletools/adaptable 18.0.0-canary.3 → 18.0.0-canary.31

package/src/Redux/Store/AdaptableStore.js

@@ -29,7 +29,7 @@ import * as FreeTextColumnRedux from '../ActionsReducers/FreeTextColumnRedux';
 import * as GridRedux from '../ActionsReducers/GridRedux';
 import * as LayoutRedux from '../ActionsReducers/LayoutRedux';
 import * as NamedQueryRedux from '../ActionsReducers/NamedQueryRedux';
-import * as NotesRedux from '../ActionsReducers/NotesRedux';
+import * as NoteRedux from '../ActionsReducers/NoteRedux';
 import * as PlusMinusRedux from '../ActionsReducers/PlusMinusRedux';
 import * as QueryRedux from '../ActionsReducers/QueryRedux';
 import * as QuickSearchRedux from '../ActionsReducers/QuickSearchRedux';
@@ -39,7 +39,7 @@ import * as SmartEditRedux from '../ActionsReducers/SmartEditRedux';
 import * as StatusBarRedux from '../ActionsReducers/StatusBarRedux';
 import * as StyledColumnRedux from '../ActionsReducers/StyledColumnRedux';
 import * as SystemRedux from '../ActionsReducers/SystemRedux';
-import { SYSTEM_PROGRESS_INDICATOR_HIDE, SYSTEM_PROGRESS_INDICATOR_SHOW, SYSTEM_VISUAL_EXPORT_BEGIN, SYSTEM_VISUAL_EXPORT_END, } from '../ActionsReducers/SystemRedux';
+import { SYSTEM_PROGRESS_INDICATOR_HIDE, SYSTEM_PROGRESS_INDICATOR_SHOW, } from '../ActionsReducers/SystemRedux';
 import * as TeamSharingRedux from '../ActionsReducers/TeamSharingRedux';
 import * as ThemeRedux from '../ActionsReducers/ThemeRedux';
 import * as ToolPanelRedux from '../ActionsReducers/ToolPanelRedux';
@@ -47,9 +47,9 @@ import { isAdaptableSharedEntity, isCustomSharedEntity, } from '../../Predefined
 export const INIT_STATE = 'INIT_STATE';
 export const LOAD_STATE = 'LOAD_STATE';
 const NON_PERSIST_ACTIONS = {
-    [LOAD_STATE]: true,
     '@@INIT': true,
     '@@redux/init': true,
+    [LOAD_STATE]: true,
     [INIT_STATE]: true,
     // progress indicators should NOT interfere with state management as it may lead to race conditions due to load/persist state being async
     [SYSTEM_PROGRESS_INDICATOR_SHOW]: true,
@@ -66,13 +66,12 @@ export class AdaptableStore {
     /**
      *
      * @param adaptable The Adaptable instance
-     * @param isAgGridReady A promise which is resolved when AG Grid is ready for binding
+     * @param postLoadHook A function that hydrates the state after it has been loaded from storage
      */
-    constructor(adaptable, isAgGridReady) {
+    constructor(adaptable) {
         /*
           This is the main store for Adaptable State
         */
-        this.isAgGridReady = isAgGridReady;
         this.loadStorageInProgress = false;
         this.loadStateOnStartup = true; // set to false if you want no state
         this.on = (eventName, callback) => {
@@ -84,7 +83,9 @@ export class AdaptableStore {
         this.emit = (eventName, data) => {
             return this.emitter.emit(eventName, data);
         };
-        this.loadStore = (adaptable, adaptableStateKey, predefinedConfig) => {
+        this.loadStore = (config) => {
+            const { adaptable, adaptableStateKey, predefinedConfig, postLoadHook } = config;
+            const postProcessState = postLoadHook !== null && postLoadHook !== void 0 ? postLoadHook : ((state) => state);
             this.storageEngine.setStateKey(adaptableStateKey);
             // START STATE LOAD
             this.loadStorageInProgress = true;
@@ -92,17 +93,15 @@ export class AdaptableStore {
                 .load(predefinedConfig)
                 .then((storedState) => {
                 if (storedState && this.loadStateOnStartup) {
-                    this.TheStore.dispatch(LoadState(adaptable.adaptableOptions.stateOptions.applyState(storedState)));
+                    this.TheStore.dispatch(LoadState(postProcessState(adaptable.adaptableOptions.stateOptions.applyState(storedState))));
                 }
             })
-                // we need AG Grid to be ready because several states(ex. Layout) depend on its API
-                .then(() => this.isAgGridReady)
                 .then(() => {
                 this.TheStore.dispatch(InitState());
                 // END STATE LOAD
                 this.loadStorageInProgress = false;
             }, (e) => {
-                adaptable.logger.error('Failed to load previous Adaptable State : ', e);
+                adaptable.logger.consoleError('Failed to load previous Adaptable State : ', e);
                 //for now i'm still initializing Adaptable even if loading state has failed....
                 //we may revisit that later
                 this.TheStore.dispatch(InitState());
@@ -122,6 +121,7 @@ export class AdaptableStore {
             Popup: PopupRedux.PopupReducer,
             System: SystemRedux.SystemReducer,
             Plugins: PluginsRedux.PluginsReducer,
+            Comment: CommentsRedux.CommentsReducer,
             // Reducers for Persisted State
             Alert: AlertRedux.AlertReducer,
             FlashingCell: FlashingCellRedux.FlashingCellReducer,
@@ -143,8 +143,7 @@ export class AdaptableStore {
             ToolPanel: ToolPanelRedux.ToolPanelReducer,
             Charting: ChartingRedux.ChartingReducer,
             StyledColumn: StyledColumnRedux.StyledColumnReducer,
-            Notes: NotesRedux.NotesReducer,
-            Comment: CommentsRedux.CommentsReducer,
+            Note: NoteRedux.NoteReducer,
             Query: QueryRedux.QueryReducer,
             NamedQuery: NamedQueryRedux.NamedQueryReducer,
         };
@@ -160,17 +159,6 @@ export class AdaptableStore {
                 case LOAD_STATE:
                     const { State } = action;
                     Object.keys(State).forEach((key) => {
-                        // this check should be removed in version 12 !!!
-                        if (key === 'Chart') {
-                            adaptable.logger.consoleWarn(`DEPRECATED: AdapTable Charts Plugin is deprecated! AG Grid built-in charts are fully supported & integrated in AdapTable.
-
-            Please contact 'support@adaptabletools.com' if you require any charting features that are not currently available.`);
-                        }
-                        if (key === 'SparklineColumn') {
-                            adaptable.logger.consoleWarn(`DEPRECATED: AdapTable SparklineColumn is deprecated! AG Grid built-in Sparklines are fully supported & integrated in AdapTable.
-
-            Please contact 'support@adaptabletools.com' if you require any sparklines features that are not currently available.`);
-                        }
                         state[key] = State[key];
                     });
                     break;
@@ -251,7 +239,6 @@ export class AdaptableStore {
         ...pluginsMiddleware // the plugins middleware
         )));
         this.storageEngine = storageEngine;
-        this.loadStore(adaptable, adaptable.adaptableOptions.adaptableStateKey);
     }
     destroy() {
         var _a;
@@ -275,7 +262,7 @@ export class AdaptableStore {
 const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
     return function (next) {
         return function (action) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
             switch (action.type) {
                 /*******************
                  * NAMED QUERY ACTIONS
@@ -323,6 +310,14 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     const ret = next(action);
                     return ret;
                 }
+                /*******************
+                 * System Row Summary ACTIONS
+                 *******************/
+                case SystemRedux.SYSTEM_SUMMARY_ROW_SET: {
+                    let nextAction = next(action);
+                    adaptable.api.layoutApi.internalApi.setupRowSummaries();
+                    return nextAction;
+                }
                 /*******************
                  * FLASHING CELL ACTIONS
                  *******************/
@@ -338,7 +333,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                 }
                 case SystemRedux.SYSTEM_FLASHING_CELL_DELETE_ALL: {
                     let ret = next(action);
-                    adaptable.redrawRenderedRows();
+                    adaptable.redrawBody();
                     return ret;
                 }
                 /*******************
@@ -394,7 +389,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                         });
                     }
                     // called also for rendered column actions, see RENDERED COLUMN ACTIONS block
-                    adaptable.setupColumns();
+                    adaptable.updateColumnModelAndRefreshGrid();
                     return returnAction;
                 }
                 /*******************
@@ -409,7 +404,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                 case FlashingCellRedux.FLASHING_CELL_DEFINITION_SUSPEND_ALL: {
                     const returnAction = next(action);
                     // called also for rendered column actions, see RENDERED COLUMN ACTIONS block
-                    adaptable.setupColumns();
+                    adaptable.updateColumnModelAndRefreshGrid();
                     return returnAction;
                 }
                 /**
@@ -574,11 +569,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                 /*******************
                  * SPECIAL COLUMN ACTIONS
                  *******************/
-                case CalculatedColumnRedux.CALCULATED_COLUMN_READY: {
-                    // create aggregated scalar columns at grid startup
-                    adaptable.api.calculatedColumnApi.refreshAggregatedCalculatedColumns();
-                    return;
-                }
                 /**
                  * Use Case: We have added / edited / deleted a Special Column (i.e. one not in initial ColumnDefs)
                  * Action: We update the Special ColumnDefs
@@ -596,7 +586,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                             .createAggregatedScalarLiveValue(returnAction.calculatedColumn);
                         adaptable.api.calculatedColumnApi.internalApi.fireCalculatedColumnChangedEvent(action.type, actionTyped.calculatedColumn);
                     }
-                    adaptable.updateColDefsForSpecialColumns();
+                    adaptable.updateColumnModelAndRefreshGrid();
                     return returnAction;
                 }
                 /**
@@ -621,7 +611,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                         .getCalculatedColumnExpressionService()
                         .destroyAggregatedScalarLiveValue(returnAction.calculatedColumn);
                     adaptable.api.calculatedColumnApi.internalApi.fireCalculatedColumnChangedEvent(action.type, actionTyped.calculatedColumn);
-                    adaptable.updateColDefsForSpecialColumns();
+                    adaptable.updateColumnModelAndRefreshGrid();
                     return returnAction;
                 }
                 /**
@@ -642,7 +632,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                         return;
                     }
                     const returnAction = next(action);
-                    adaptable.updateColDefsForSpecialColumns();
+                    adaptable.updateColumnModelAndRefreshGrid();
                     return returnAction;
                 }
                 /*******************
@@ -679,7 +669,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                 case CustomSortRedux.CUSTOM_SORT_UNSUSPEND_ALL: {
                     const returnAction = next(action);
                     // called also for alert actions, see ALERT ACTIONS block
-                    adaptable.setupColumns();
+                    adaptable.updateColumnModelAndRefreshGrid();
                     return returnAction;
                 }
                 /*******************
@@ -778,7 +768,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                                 draftLayoutAction = GridRedux.LayoutDraftColumnFilterUnsuspendAll();
                                 break;
                         }
-                        //  GRID FILTER
                         returnAction = next(draftLayoutAction);
                     }
                     setTimeout(() => {
@@ -798,17 +787,27 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                 case LayoutRedux.LAYOUT_GRID_FILTER_CLEAR:
                 case LayoutRedux.LAYOUT_GRID_FILTER_SUSPEND:
                 case LayoutRedux.LAYOUT_GRID_FILTER_UNSUSPEND: {
-                    setTimeout(() => adaptable.applyGridFiltering(), 5);
-                    adaptable.api.gridFilterApi.internalApi.fireGridFilterAppliedEvent();
-                    adaptable.api.layoutApi.internalApi.fireLayoutChangedEvent(action.type, null, middlewareAPI.getState().Layout);
                     const currentLayout = adaptable.api.layoutApi.getCurrentLayout();
                     let returnAction;
+                    // - calls GridFilterApplied - examples
+                    adaptable.api.gridFilterApi.internalApi.fireGridFilterAppliedEvent();
+                    // - layout change event, row summary is triggered
+                    adaptable.api.layoutApi.internalApi.fireLayoutChangedEvent(action.type, null, middlewareAPI.getState().Layout);
+                    setTimeout(() => {
+                        // - agGridApi.onFilterChanged
+                        // - internal 'AdapTableFiltersApplied' event - evaluates row summary
+                        // - refresh selected cells and rows
+                        adaptable.applyGridFiltering();
+                    }, 5);
                     if (((_h = adaptable.adaptableOptions.layoutOptions) === null || _h === void 0 ? void 0 : _h.autoSaveLayouts) &&
                         !currentLayout.IsReadOnly) {
-                        returnAction = action;
+                        return next(action);
                     }
                     else {
-                        // save in draft
+                        if (!middlewareAPI.getState().Grid.CurrentLayout) {
+                            const currentLayout = adaptable.api.layoutApi.getCurrentLayout();
+                            middlewareAPI.dispatch(GridRedux.LayoutUpdateCurrentDraft(currentLayout));
+                        }
                         switch (action.type) {
                             case LayoutRedux.LAYOUT_GRID_FILTER_SET:
                                 returnAction = GridRedux.LayoutDraftGridFilterSet(Object.assign(Object.assign({}, currentLayout.GridFilter), { Expression: action.gridFilter }));
@@ -869,12 +868,12 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                  * Note ACTIONS
                  *******************/
                 /**
-                 * Use Case: Notes has been edited/deleted/added
+                 * Use Case: Note has been edited/deleted/added
                  * Action: Triangle can be removed/added
                  */
-                case NotesRedux.NOTES_ADD:
-                case NotesRedux.NOTES_EDIT:
-                case NotesRedux.NOTES_DELETE: {
+                case NoteRedux.NOTE_ADD:
+                case NoteRedux.NOTE_EDIT:
+                case NoteRedux.NOTE_DELETE: {
                     let returnAction = next(action);
                     const node = adaptable.api.gridApi.getRowNodeForPrimaryKey(returnAction.adaptableNote.PrimaryKeyValue);
                     adaptable.refreshCells([node], [returnAction.adaptableNote.ColumnId], true);
@@ -907,18 +906,18 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                         adaptable.refreshCells([node], [columnId], true);
                         requestAnimationFrame(() => {
                             var _a, _b;
-                            const commentThreads = adaptable.api.commentApi.getCommentThreads();
-                            adaptable.api.eventApi.emit('CommentsChanged', adaptable.api.commentApi.getCommentThreads());
+                            const commentThreads = adaptable.api.commentApi.getGridComments();
+                            adaptable.api.eventApi.emit('CommentChanged', adaptable.api.commentApi.getGridComments());
                             (_b = (_a = adaptable.api.optionsApi
-                                .getCommentsOptions()) === null || _a === void 0 ? void 0 : _a.persistCommentThreads) === null || _b === void 0 ? void 0 : _b.call(_a, commentThreads);
+                                .getCommentOptions()) === null || _a === void 0 ? void 0 : _a.persistCommentThreads) === null || _b === void 0 ? void 0 : _b.call(_a, commentThreads);
                         });
                     }
                     return returnAction;
                 }
                 case CommentsRedux.COMMENTS_LOAD: {
-                    const previousCommentThreads = adaptable.api.commentApi.getCommentThreads();
+                    const previousCommentThreads = adaptable.api.commentApi.getGridComments();
                     let returnAction = next(action);
-                    const newCommentThreads = (_j = adaptable.api.commentApi.getCommentThreads()) !== null && _j !== void 0 ? _j : [];
+                    const newCommentThreads = (_j = adaptable.api.commentApi.getGridComments()) !== null && _j !== void 0 ? _j : [];
                     requestAnimationFrame(() => {
                         let addedCommentThreads = [];
                         let deletedCommentThreads = [];
@@ -935,7 +934,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                             }
                         }
                         // This cannot be called because it would trigger an infinite loop
-                        // adaptable.api.eventApi.emit('CommentsChanged', commentThreads);
+                        // adaptable.api.eventApi.emit('CommentChanged', commentThreads);
                         // refresh all comments cells to show or hide the triangle
                         [...addedCommentThreads, ...deletedCommentThreads].forEach((commentThread) => {
                             const node = adaptable.api.gridApi.getRowNodeForPrimaryKey(commentThread.PrimaryKeyValue);
@@ -1019,12 +1018,18 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     let returnAction = next(action);
                     const newLayoutState = middlewareAPI.getState().Layout;
                     adaptable.api.layoutApi.internalApi.fireLayoutChangedEvent(action.type, oldLayoutState, newLayoutState);
+                    // Tell Grid to apply column filtering if filters have been changed in a loaded Layout
                     const oldFilters = (_k = oldLayoutState.Layouts.find((l) => l.Name == oldLayoutState.CurrentLayout)) === null || _k === void 0 ? void 0 : _k.ColumnFilters;
                     const newFilters = (_l = newLayoutState.Layouts.find((l) => l.Name == newLayoutState.CurrentLayout)) === null || _l === void 0 ? void 0 : _l.ColumnFilters;
-                    // Tell Grid to apply filtering if filters have been changed in a loaded Layout
                     if (adaptable.api.columnFilterApi.internalApi.areColumnFiltersDifferent(oldFilters, newFilters)) {
                         adaptable.applyColumnFiltering();
                     }
+                    // Tell Grid to apply filtering if filters have been changed in a loaded Layout
+                    const oldGridFilter = (_m = oldLayoutState.Layouts.find((l) => l.Name == oldLayoutState.CurrentLayout)) === null || _m === void 0 ? void 0 : _m.GridFilter;
+                    const newGridFilter = (_o = newLayoutState.Layouts.find((l) => l.Name == newLayoutState.CurrentLayout)) === null || _o === void 0 ? void 0 : _o.GridFilter;
+                    if (adaptable.api.gridFilterApi.internalApi.isGridFilterDifferent(oldGridFilter, newGridFilter)) {
+                        adaptable.applyGridFiltering();
+                    }
                     if (returnAction.type == LayoutRedux.LAYOUT_SELECT ||
                         returnAction.type == LayoutRedux.LAYOUT_DELETE ||
                         returnAction.type == LayoutRedux.LAYOUT_SET_COLUMN_CAPTION) {
@@ -1037,7 +1042,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                             // tell grid the layout has been selected
                             adaptable.setLayout(currentLayout);
                         }
-                        if (!((_m = adaptable.adaptableOptions.layoutOptions) === null || _m === void 0 ? void 0 : _m.autoSaveLayouts)) {
+                        if (!((_p = adaptable.adaptableOptions.layoutOptions) === null || _p === void 0 ? void 0 : _p.autoSaveLayouts)) {
                             middlewareAPI.dispatch(GridRedux.LayoutUpdateCurrentDraft(currentLayout));
                         }
                     }
@@ -1045,7 +1050,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                         returnAction.type == LayoutRedux.LAYOUT_SAVE) {
                         const actionTyped = action;
                         // if autosave is false
-                        if (!((_o = adaptable.adaptableOptions.layoutOptions) === null || _o === void 0 ? void 0 : _o.autoSaveLayouts)) {
+                        if (!((_q = adaptable.adaptableOptions.layoutOptions) === null || _q === void 0 ? void 0 : _q.autoSaveLayouts)) {
                             // and the current layout is saved, make sure we also update the draft
                             if (actionTyped.layout.Name === newLayoutState.CurrentLayout) {
                                 middlewareAPI.dispatch(GridRedux.LayoutUpdateCurrentDraft(actionTyped.layout));
@@ -1063,6 +1068,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                             adaptable.setLayout(savingLayout);
                         }
                     }
+                    adaptable.refreshQuickFilter();
                     return returnAction;
                 }
                 /*******************
@@ -1273,12 +1279,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     }
                     return next(action);
                 }
-                case SYSTEM_VISUAL_EXPORT_BEGIN:
-                case SYSTEM_VISUAL_EXPORT_END: {
-                    let returnAction = next(action);
-                    adaptable.ReportService.resetExcelStyleMemoization();
-                    return returnAction;
-                }
                 /*******************
                  * CHARTING ACTIONS
                  *******************/
@@ -1656,24 +1656,14 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                  *******************/
                 case INIT_STATE: {
                     let returnAction = next(action);
-                    if (adaptable.isDestroyed) {
-                        return returnAction;
-                    }
-                    // make sure we have the grid columns in state, before we do any layout work
-                    adaptable.updateColumnsIntoStore();
-                    const layoutState = middlewareAPI.getState().Layout;
-                    const defaultLayout = adaptable.api.layoutApi.internalApi.createDefaultLayoutIfNeeded();
-                    let currentLayout = (layoutState === null || layoutState === void 0 ? void 0 : layoutState.CurrentLayout) || (defaultLayout === null || defaultLayout === void 0 ? void 0 : defaultLayout.Name);
-                    if (!adaptable.api.layoutApi.getLayoutByName(currentLayout)) {
-                        currentLayout = defaultLayout ? defaultLayout.Name : layoutState.Layouts[0].Name;
+                    if (adaptable.isReady) {
+                        // TODO see #create-create-module-menu
+                        // create the module menu (for use in the dashboard and the toolpanel)
+                        // we need this here for when the state key is changed
+                        // since we need the transient state to be restored in the same
+                        // way as when Adaptable is initialised.
+                        adaptable.ModuleService.createModuleMenus();
                     }
-                    middlewareAPI.dispatch(LayoutRedux.LayoutSelect(currentLayout));
-                    // do this now so it sets module entitlements
-                    adaptable.EntitlementService.setModulesEntitlements();
-                    // create the module menu (for use in the dashboard and the toolpanel)
-                    adaptable.ModuleService.createModuleMenus();
-                    // update initial mode of DataChangeHistory
-                    adaptable.api.internalApi.initializeDataChangeHistory();
                     return returnAction;
                 }
                 default: {

package/src/Redux/Store/Interface/IAdaptableStore.d.ts

@@ -2,10 +2,16 @@ import * as Redux from 'redux';
 import { AdaptableState } from '../../../PredefinedConfig/AdaptableState';
 import { PredefinedConfig } from '../../../types';
 import { IAdaptable } from '../../../AdaptableInterfaces/IAdaptable';
+export interface LoadStoreConfig {
+    adaptable: IAdaptable;
+    adaptableStateKey: string;
+    predefinedConfig?: PredefinedConfig;
+    postLoadHook?: (state: AdaptableState) => AdaptableState;
+}
 export interface IAdaptableStore {
     TheStore: Redux.Store<AdaptableState>;
-    Load: PromiseLike<any>;
-    loadStore: (adaptable: IAdaptable, adaptableStateKey: string, predefinedConfig?: PredefinedConfig) => PromiseLike<any>;
+    Load: Promise<any>;
+    loadStore: (config: LoadStoreConfig) => Promise<any>;
     getCurrentStorageState: () => AdaptableState | void;
     saveStateNow: (adaptable: IAdaptable) => Promise<any>;
     on: (eventName: string, callback: (data?: any) => any) => () => void;

package/src/Strategy/AdaptableModuleBase.d.ts

@@ -3,7 +3,7 @@ import { Action } from 'redux';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { ModuleParams } from '../View/Components/SharedProps/ModuleViewPopupProps';
 import { MenuItemShowPopup, MenuItemDoReduxAction, MenuItemDoClickFunction } from '../Utilities/MenuItem';
-import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
+import { AdaptableMenuItem, AdaptableContextMenuItemName, ContextMenuContext, AdaptableColumnMenuItemName } from '../PredefinedConfig/Common/Menu';
 import { AdaptableModule } from '../PredefinedConfig/Common/Types';
 import { TeamSharingImportInfo } from '../PredefinedConfig/TeamSharingState';
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
@@ -29,27 +29,26 @@ export declare abstract class AdaptableModuleBase implements IModule {
      */
     isModuleObjectsShareable(): boolean;
     isModuleEditable(): boolean;
-    updateOldConfig(): void;
     getModuleAdaptableObjects(): AdaptableObject[];
     getExplicitlyReferencedColumnIds(adaptableObject: AdaptableObject): string[];
     getReferencedNamedQueryNames(adaptableObject: AdaptableObject): string[];
     hasNamedQueryReferences(): boolean;
-    handleAdaptableReady(): void;
-    handleConfigReloaded(adaptableStateReloadedInfo: AdaptableStateReloadedInfo): void;
+    onAdaptableReady(): void;
+    onAdaptableStateReloaded(adaptableStateReloadedInfo: AdaptableStateReloadedInfo): void;
     setModuleEntitlement(): void;
-    addModuleMenuItem(source: 'ModuleMenu' | 'ModuleButton'): AdaptableMenuItem | undefined;
-    addModuleButtonMenuItem(): AdaptableMenuItem | undefined;
-    addColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem[] | undefined;
-    addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
-    createMainMenuItemShowPopup({ Label, ComponentName, Icon, PopupParams, }: {
+    createModuleMenuItem(source: 'ModuleMenu' | 'ModuleButton'): AdaptableMenuItem | undefined;
+    createColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem[] | undefined;
+    createContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
+    createMainMenuItemShowPopup({ Name, Label, ComponentName, Icon, PopupParams, }: {
+        Name: AdaptableColumnMenuItemName | AdaptableContextMenuItemName;
         Label: string;
         ComponentName: string;
         Icon: AdaptableSystemIconName;
         PopupParams?: ModuleParams;
     }): MenuItemShowPopup;
-    createColumnMenuItemClickFunction(Label: string, Icon: AdaptableSystemIconName, ClickFunction: () => void): MenuItemDoClickFunction;
-    createColumnMenuItemReduxAction(Label: string, Icon: AdaptableSystemIconName, Action: Action): MenuItemDoReduxAction;
-    createColumnMenuItemShowPopup(Label: string, ComponentName: string, Icon: AdaptableSystemIconName, PopupParams?: ModuleParams): MenuItemShowPopup;
+    createMenuItemClickFunction(Name: AdaptableColumnMenuItemName | AdaptableContextMenuItemName, Label: string, Icon: AdaptableSystemIconName, ClickFunction: () => void): MenuItemDoClickFunction;
+    createMenuItemReduxAction(Name: AdaptableColumnMenuItemName | AdaptableContextMenuItemName, Label: string, Icon: AdaptableSystemIconName, Action: Action): MenuItemDoReduxAction;
+    createMenuItemShowPopup(Name: AdaptableColumnMenuItemName | AdaptableContextMenuItemName, Label: string, ComponentName: string, Icon: AdaptableSystemIconName, PopupParams?: ModuleParams): MenuItemShowPopup;
     getTeamSharingAction(): TeamSharingImportInfo<AdaptableObject> | undefined;
     getModuleNamedQueryReferences(): string[];
     getModuleCalculatedColumnReferences(): CalculatedColumn[];

package/src/Strategy/AdaptableModuleBase.js

@@ -16,11 +16,11 @@ export class AdaptableModuleBase {
         };
         this.api = api;
         this.api.eventApi.on('AdaptableReady', () => {
-            this.handleAdaptableReady();
+            this.onAdaptableReady();
             this.api.configApi.dispatchStateReadyAction(this.moduleInfo.ModuleName);
         });
         this.api.eventApi.on('AdaptableStateReloaded', (adaptableStateReloadedInfo) => {
-            this.handleConfigReloaded(adaptableStateReloadedInfo);
+            this.onAdaptableStateReloaded(adaptableStateReloadedInfo);
         });
     }
     getViewAccessLevel() {
@@ -43,9 +43,6 @@ export class AdaptableModuleBase {
     isModuleEditable() {
         return this.hasRequiredAccessLevel(this.getEditAccessLevel());
     }
-    updateOldConfig() {
-        // override where deprecated configs have to be migrated
-    }
     getModuleAdaptableObjects() {
         // override where necessary in base classes
         return [];
@@ -63,10 +60,10 @@ export class AdaptableModuleBase {
         // this will skip the unnecessary evaluation of modules which do not have Named Query references
         return true;
     }
-    handleAdaptableReady() {
+    onAdaptableReady() {
         // override where necessary in base classes
     }
-    handleConfigReloaded(adaptableStateReloadedInfo) {
+    onAdaptableStateReloaded(adaptableStateReloadedInfo) {
         // override where necessary in base classes
     }
     setModuleEntitlement() {
@@ -74,13 +71,14 @@ export class AdaptableModuleBase {
             .getEntitlementService()
             .getEntitlementAccessLevelForModule(this.moduleInfo.ModuleName);
     }
-    addModuleMenuItem(source) {
+    createModuleMenuItem(source) {
         if (this.isModuleAvailable() && this.moduleInfo.Popup) {
             const moduleParams = {
                 source: source,
                 maxWidth: this.getPopupMaxWidth(),
             };
             return this.createMainMenuItemShowPopup({
+                Name: '_navbar',
                 Label: this.moduleInfo.FriendlyName,
                 ComponentName: this.moduleInfo.Popup,
                 Icon: this.moduleInfo.Glyph,
@@ -88,33 +86,29 @@ export class AdaptableModuleBase {
             });
         }
     }
-    addModuleButtonMenuItem() {
-        // base class implementation which is empty
-        return undefined;
-    }
-    addColumnMenuItems(column) {
+    createColumnMenuItems(column) {
         // base class implementation which is empty
         return undefined;
     }
-    addContextMenuItems(menuContext) {
+    createContextMenuItems(menuContext) {
         // base class implementation which is empty
         return undefined;
     }
-    // creates the menu items in the main dropdown
-    createMainMenuItemShowPopup({ Label, ComponentName, Icon, PopupParams, }) {
-        return new MenuItemShowPopup(Label, this.moduleInfo.ModuleName, ComponentName, Icon, true, PopupParams);
+    // creates the module menu items in the navbar
+    createMainMenuItemShowPopup({ Name, Label, ComponentName, Icon, PopupParams, }) {
+        return new MenuItemShowPopup(Name, Label, this.moduleInfo.ModuleName, ComponentName, Icon, true, PopupParams);
     }
     // creates a menu item for the column menu to perform a function
-    createColumnMenuItemClickFunction(Label, Icon, ClickFunction) {
-        return new MenuItemDoClickFunction(Label, this.moduleInfo.ModuleName, ClickFunction, Icon, true);
+    createMenuItemClickFunction(Name, Label, Icon, ClickFunction) {
+        return new MenuItemDoClickFunction(Name, Label, this.moduleInfo.ModuleName, ClickFunction, Icon, true);
     }
     // creates a menu item for the column menu to enact a Redux action
-    createColumnMenuItemReduxAction(Label, Icon, Action) {
-        return new MenuItemDoReduxAction(Label, this.moduleInfo.ModuleName, Action, Icon, true);
+    createMenuItemReduxAction(Name, Label, Icon, Action) {
+        return new MenuItemDoReduxAction(Name, Label, this.moduleInfo.ModuleName, Action, Icon, true);
     }
     // popups called by the column menu - invisible if module is hidden or readonly
-    createColumnMenuItemShowPopup(Label, ComponentName, Icon, PopupParams) {
-        return new MenuItemShowPopup(Label, this.moduleInfo.ModuleName, ComponentName, Icon, true, PopupParams);
+    createMenuItemShowPopup(Name, Label, ComponentName, Icon, PopupParams) {
+        return new MenuItemShowPopup(Name, Label, this.moduleInfo.ModuleName, ComponentName, Icon, true, PopupParams);
     }
     getTeamSharingAction() {
         return undefined;

package/src/Strategy/AlertModule.d.ts

@@ -8,14 +8,13 @@ import { AdaptableModuleView, AdaptableObjectCompactView, AdaptableObjectView, I
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
 export declare class AlertModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
+    onAdaptableReady(): void;
     getModuleAdaptableObjects(config?: {
         includeLayoutNotAssociatedObjects?: boolean;
     }): AdaptableObject[];
     getExplicitlyReferencedColumnIds(alertDefinition: AlertDefinition): string[];
     getReferencedNamedQueryNames(alertDefinition: AlertDefinition): string[];
-    updateOldConfig(): void;
-    private updateAlertSingleToMultiplePredicates;
-    addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
+    createContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
     private handleCellDataChanged;
     private handleGridDataChanged;
     private handleReactiveAlertTriggered;