@adaptabletools/adaptable-cjs 18.0.0-canary.2 → 18.0.0-canary.20

package/src/Redux/ActionsReducers/NoteRedux.d.ts

@@ -0,0 +1,38 @@
+import * as Redux from 'redux';
+import { AdaptableNote, NoteState } from '../../PredefinedConfig/NoteState';
+import { CellAddress } from '../../types';
+/**
+ * @ReduxAction A Note has been added
+ */
+export declare const NOTE_ADD = "NOTE_ADD";
+/**
+ * @ReduxAction A Note has been edited
+ */
+export declare const NOTE_EDIT = "NOTE_EDIT";
+/**
+ * @ReduxAction A Note has been deleted
+ */
+export declare const NOTE_DELETE = "NOTE_DELETE";
+/**
+ * @ReduxAction Note Module is ready
+ */
+export declare const NOTE_READY = "NOTE_READY";
+export interface AdaptableNoteAction extends Redux.Action {
+    adaptableNote: AdaptableNote;
+}
+export interface AdaptableNoteAddAction extends AdaptableNoteAction {
+}
+export interface AdaptableNoteEditAction extends AdaptableNoteAction {
+}
+export interface AdaptableNoteDeleteAction extends AdaptableNoteAction {
+}
+export interface NoteReadyAction extends Redux.Action {
+    noteState: NoteState;
+}
+export declare const NoteAdd: (note: AdaptableNote) => AdaptableNoteAddAction;
+export declare const NoteEdit: (note: AdaptableNote) => AdaptableNoteEditAction;
+export declare const NoteDelete: (note: AdaptableNote) => AdaptableNoteDeleteAction;
+export declare const NoteReady: (note: NoteState) => NoteReadyAction;
+export declare const GetAllNotesSelector: (state: NoteState) => AdaptableNote[];
+export declare const GetNotesSelector: (state: NoteState, address: CellAddress) => AdaptableNote[];
+export declare const NoteReducer: Redux.Reducer<NoteState>;

package/src/Redux/ActionsReducers/NoteRedux.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoteReducer = exports.GetNotesSelector = exports.GetAllNotesSelector = exports.NoteReady = exports.NoteDelete = exports.NoteEdit = exports.NoteAdd = exports.NOTE_READY = exports.NOTE_DELETE = exports.NOTE_EDIT = exports.NOTE_ADD = void 0;
+const tslib_1 = require("tslib");
+const AdaptableHelper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/AdaptableHelper"));
+const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
+/**
+ * @ReduxAction A Note has been added
+ */
+exports.NOTE_ADD = 'NOTE_ADD';
+/**
+ * @ReduxAction A Note has been edited
+ */
+exports.NOTE_EDIT = 'NOTE_EDIT';
+/**
+ * @ReduxAction A Note has been deleted
+ */
+exports.NOTE_DELETE = 'NOTE_DELETE';
+/**
+ * @ReduxAction Note Module is ready
+ */
+exports.NOTE_READY = 'NOTE_READY';
+const NoteAdd = (note) => ({
+    type: exports.NOTE_ADD,
+    adaptableNote: note,
+});
+exports.NoteAdd = NoteAdd;
+const NoteEdit = (note) => ({
+    type: exports.NOTE_EDIT,
+    adaptableNote: note,
+});
+exports.NoteEdit = NoteEdit;
+const NoteDelete = (note) => ({
+    type: exports.NOTE_DELETE,
+    adaptableNote: note,
+});
+exports.NoteDelete = NoteDelete;
+const NoteReady = (note) => ({
+    type: exports.NOTE_READY,
+    noteState: note,
+});
+exports.NoteReady = NoteReady;
+const GetAllNotesSelector = (state) => state.Notes;
+exports.GetAllNotesSelector = GetAllNotesSelector;
+const GetNotesSelector = (state, address) => {
+    var _a;
+    if (!address) {
+        return [];
+    }
+    return ((_a = state === null || state === void 0 ? void 0 : state.Notes) !== null && _a !== void 0 ? _a : []).filter((note) => {
+        if (note.PrimaryKeyValue === address.PrimaryKeyValue && note.ColumnId === address.ColumnId) {
+            // happy check
+            return true;
+        }
+        // Primary keys retreived from the grid dom are always strings, so we must also consider them strings
+        if ((typeof address.PrimaryKeyValue === 'number' && typeof note.PrimaryKeyValue === 'string') ||
+            (typeof address.PrimaryKeyValue === 'string' && typeof note.PrimaryKeyValue === 'number')) {
+            return (note.PrimaryKeyValue.toString() === address.PrimaryKeyValue.toString() &&
+                note.ColumnId === address.ColumnId);
+        }
+        return false;
+    });
+};
+exports.GetNotesSelector = GetNotesSelector;
+const initialState = {
+    Notes: GeneralConstants_1.EMPTY_ARRAY,
+};
+const NoteReducer = (state = initialState, action) => {
+    let adaptableNotes;
+    switch (action.type) {
+        case exports.NOTE_ADD: {
+            const note = action.adaptableNote;
+            AdaptableHelper_1.default.addUuidAndSource(note);
+            adaptableNotes = [...state.Notes, note];
+            return Object.assign(Object.assign({}, state), { Notes: adaptableNotes });
+        }
+        case exports.NOTE_EDIT: {
+            const note = action.adaptableNote;
+            return Object.assign(Object.assign({}, state), { Notes: state.Notes.map((abObject) => (abObject.Uuid === note.Uuid ? note : abObject)) });
+        }
+        case exports.NOTE_DELETE: {
+            const note = action.adaptableNote;
+            return Object.assign(Object.assign({}, state), { Notes: state.Notes.filter((abObject) => abObject.Uuid !== note.Uuid) });
+        }
+        default:
+            return state;
+    }
+};
+exports.NoteReducer = NoteReducer;

package/src/Redux/ActionsReducers/SystemRedux.d.ts

@@ -77,6 +77,7 @@ export declare const SYSTEM_VISUAL_EXPORT_END = "SYSTEM_VISUAL_EXPORT_END";
 export declare const SYSTEM_CELL_POPUP_SHOW = "SYSTEM_CELL_POPUP_SHOW";
 export declare const SYSTEM_CELL_POPUP_HIDE = "SYSTEM_CELL_POPUP_HIDE";
 export declare const SYSTEM_CELL_POPUP_EDIT_FOCUSED_ENTITY = "SYSTEM_CELL_POPUP_EDIT_FOCUSED_ENTITY";
+export declare const SYSTEM_SUMMARY_ROW_SET = "SYSTEM_SUMMARY_ROW_SET";
 export declare const DATA_IMPORT_COMPLETED = "DATA_IMPORT_COMPLETED";
 export interface DataImportCompletedAction extends Redux.Action {
     dataImportedInfo: DataImportedInfo;
@@ -328,12 +329,16 @@ export declare const SystemVisualExportEnd: () => SystemVisualExportEndAction;
 export declare const SystemQuickSearchFloatingVisibility: (visible: boolean) => SystemQuickSearchFloatingVisibilityAction;
 export declare const SystemCellPopupShow: (cellPosition: CellAddress, editMode?: boolean) => SystemCellPopupShowAction;
 export declare const SystemCellPopupEditFocusedEntity: (focusedEntity: 'Note' | 'Comment') => SystemCellPopupEditFocusedEntityAction;
+export declare const SystemRowSummarySet: (systemRowSummaries: SystemState['RowSummary']['rowSummaries']) => {
+    readonly type: "SYSTEM_SUMMARY_ROW_SET";
+    readonly rowSummaries: import("../../PredefinedConfig/SystemState").SystemRowSummary[];
+};
 export declare const SystemCellPopupHide: () => SystemCellPopupHideAction;
 export declare const SystemDisableDeleteConfirmationSelector: (state: SystemState) => boolean;
 export declare const SystemPreviousGroupedColumnsSelector: (state: SystemState) => Record<string, Record<string, number>>;
 export declare const SystemQuickSearchFloatingVisibilitySelector: (state: SystemState) => boolean;
 export declare const SystemCommentsAndNotesSelector: (state: SystemState) => CellAddress;
 export declare const SystemCommentsAndNotesEditModeSelector: (state: SystemState) => boolean;
-export declare const SystemCommentsAndNotesFocusedEntitySelector: (state: SystemState) => "Note" | "Comment";
+export declare const SystemCommentsAndNotesFocusedEntitySelector: (state: SystemState) => "Comment" | "Note";
 export declare const DataImportCompleted: (dataImportedInfo: DataImportedInfo) => DataImportCompletedAction;
 export declare const SystemReducer: Redux.Reducer<SystemState>;

package/src/Redux/ActionsReducers/SystemRedux.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SYSTEM_DISABLE_DELETE_CONFIRMATION = exports.SYSTEM_FILTER_FORM_HIDE = exports.SYSTEM_QUICK_FILTER_BAR_HIDE = exports.SYSTEM_QUICK_FILTER_BAR_SHOW = exports.SYSTEM_SETTINGS_PANEL_SET = exports.SYSTEM_DATA_CHANGE_HISTORY_RESUME = exports.SYSTEM_DATA_CHANGE_HISTORY_SUSPEND = exports.SYSTEM_DATA_CHANGE_HISTORY_DISABLE = exports.SYSTEM_DATA_CHANGE_HISTORY_ENABLE = exports.SYSTEM_DATA_CHANGE_HISTORY_CLEAR_ROW = exports.SYSTEM_DATA_CHANGE_HISTORY_UNDO = exports.SYSTEM_DATA_CHANGE_HISTORY_ADD = exports.SYSTEM_LICENSE_DISABLE_PERSISTENCE = exports.SYSTEM_LICENSE_SHOW_WATERMARK = exports.SYSTEM_PROGRESS_INDICATOR_HIDE = exports.SYSTEM_PROGRESS_INDICATOR_SHOW = exports.SYSTEM_CELL_SUMMARY_CHANGE_OPERATION = exports.SYSTEM_CACHED_QUERY_ADD = exports.SYSTEM_SET_LAST_APPLIED_SHORTCUT = exports.SYSTEM_SET_NEW_COLUMN_LIST_ORDER = exports.SYSTEM_HIGHLIGHT_ROW_DELETE_ALL = exports.SYSTEM_HIGHLIGHT_ROWS_DELETE = exports.SYSTEM_HIGHLIGHT_ROW_DELETE = exports.SYSTEM_HIGHLIGHT_ROWS_ADD = exports.SYSTEM_HIGHLIGHT_ROW_ADD = exports.SYSTEM_HIGHLIGHT_CELL_DELETE_ALL = exports.SYSTEM_HIGHLIGHT_CELL_DELETE = exports.SYSTEM_HIGHLIGHT_CELL_ADD = exports.SYSTEM_BULK_UPDATE_CHANGE_VALUE = exports.SYSTEM_BULK_UPDATE_SET_PREVIEW = exports.SYSTEM_BULK_UPDATE_SET_VALID_SELECTION = exports.SYSTEM_BULK_UPDATE_CHECK_CELL_SELECTION = exports.SYSTEM_SMART_EDIT_CHANGE_OPERATION = exports.SYSTEM_SMART_EDIT_CHANGE_VALUE = exports.SYSTEM_SMARTEDIT_SET_PREVIEW = exports.SYSTEM_SMARTEDIT_SET_VALID_SELECTION = exports.SYSTEM_SMARTEDIT_FETCH_PREVIEW = exports.SYSTEM_SMARTEDIT_CHECK_CELL_SELECTION = exports.SYSTEM_STATUS_MESSAGE_INFO_DELETE_ALL = exports.SYSTEM_STATUS_MESSAGE_INFO_DELETE = exports.SYSTEM_STATUS_MESSAGE_INFO_ADD = exports.SYSTEM_FLASHING_CELL_DELETE_ALL = exports.SYSTEM_FLASHING_CELL_DELETE = exports.SYSTEM_FLASHING_CELL_ADD = exports.SYSTEM_ALERT_REMOVE_ROW_HIGHLIGHT = exports.SYSTEM_ALERT_REMOVE_CELL_HIGHLIGHT = exports.SYSTEM_ALERT_DELETE_ALL = exports.SYSTEM_ALERT_DELETE = exports.SYSTEM_ALERT_ADD = exports.FLASHING_CELL_ROW_KEY = void 0;
-exports.SystemDataChangeHistoryUndo = exports.SystemDataChangeHistoryAdd = exports.SystemLicenseDisablePersistence = exports.SystemLicenseShowWatermark = exports.SystemProgressIndicatorHide = exports.SystemProgressIndicatorShow = exports.SystemCellSummaryChangeOperation = exports.SystemCachedQueryAdd = exports.SetLastAppliedShortcut = exports.SetNewColumnListOrder = exports.BulkUpdateChangeValue = exports.BulkUpdateSetPreview = exports.BulkUpdateSetValidSelection = exports.BulkUpdateCheckCellSelection = exports.SmartEditSetPreview = exports.SmartEditSetValidSelection = exports.SmartEditCheckCellSelection = exports.SmartEditChangeOperation = exports.SmartEditChangeValue = exports.SystemStatusMessageInfoDeleteAll = exports.SystemStatusMessageInfoDelete = exports.SystemStatusMessageInfoAdd = exports.SystemFlashingCellDeleteAll = exports.SystemFlashingCellDelete = exports.SystemFlashingCellAdd = exports.SystemAlertRemoveRowHighlight = exports.SystemAlertRemoveCellHighlight = exports.SystemAlertDeleteAll = exports.SystemAlertDelete = exports.SystemAlertAdd = exports.SystemHighlightRowDeleteAll = exports.SystemHighlightRowsDelete = exports.SystemHighlightRowDelete = exports.SystemHighlightRowsAdd = exports.SystemHighlightRowAdd = exports.SystemHighlightCellDeleteAll = exports.SystemHighlightCellDelete = exports.SystemHighlightCellAdd = exports.DATA_IMPORT_COMPLETED = exports.SYSTEM_CELL_POPUP_EDIT_FOCUSED_ENTITY = exports.SYSTEM_CELL_POPUP_HIDE = exports.SYSTEM_CELL_POPUP_SHOW = exports.SYSTEM_VISUAL_EXPORT_END = exports.SYSTEM_VISUAL_EXPORT_BEGIN = exports.SYSTEM_SET_QUICK_SEARCH_FLOATING_VISIBILITY = exports.SYSTEM_SET_PREVIOUS_GROUPED_COLUMN_INDEX = exports.SYSTEM_CHARTING_SET_CURRENT_CHART_MODELS = exports.SYSTEM_DATA_SET_SELECT = exports.DASHBOARD_REFRESH = exports.SYSTEM_LAYOUT_SHOW_NOT_ASSOCIATED_OBJECTS = void 0;
-exports.SystemReducer = exports.DataImportCompleted = exports.SystemCommentsAndNotesFocusedEntitySelector = exports.SystemCommentsAndNotesEditModeSelector = exports.SystemCommentsAndNotesSelector = exports.SystemQuickSearchFloatingVisibilitySelector = exports.SystemPreviousGroupedColumnsSelector = exports.SystemDisableDeleteConfirmationSelector = exports.SystemCellPopupHide = exports.SystemCellPopupEditFocusedEntity = exports.SystemCellPopupShow = exports.SystemQuickSearchFloatingVisibility = exports.SystemVisualExportEnd = exports.SystemVisualExportBegin = exports.SystemDisableDeleteConfirmation = exports.SystemSetPreviousGroupedColumnsIndex = exports.SystemChartingCurrentChartModelsSelector = exports.SystemChartingSetCurrentChartModels = exports.SystemDataSetSelect = exports.SystemDashboardRefresh = exports.SystemLayoutShowNotAssociatedObjects = exports.SystemFilterFormHide = exports.SystemQuickFilterBarHide = exports.SystemQuickFilterBarShow = exports.SystemSettingsPanelSet = exports.SystemDataChangeHistoryResume = exports.SystemDataChangeHistorySuspend = exports.SystemDataChangeHistoryDisable = exports.SystemDataChangeHistoryEnable = exports.SystemDataChangeHistoryClearRow = void 0;
+exports.SystemDataChangeHistoryAdd = exports.SystemLicenseDisablePersistence = exports.SystemLicenseShowWatermark = exports.SystemProgressIndicatorHide = exports.SystemProgressIndicatorShow = exports.SystemCellSummaryChangeOperation = exports.SystemCachedQueryAdd = exports.SetLastAppliedShortcut = exports.SetNewColumnListOrder = exports.BulkUpdateChangeValue = exports.BulkUpdateSetPreview = exports.BulkUpdateSetValidSelection = exports.BulkUpdateCheckCellSelection = exports.SmartEditSetPreview = exports.SmartEditSetValidSelection = exports.SmartEditCheckCellSelection = exports.SmartEditChangeOperation = exports.SmartEditChangeValue = exports.SystemStatusMessageInfoDeleteAll = exports.SystemStatusMessageInfoDelete = exports.SystemStatusMessageInfoAdd = exports.SystemFlashingCellDeleteAll = exports.SystemFlashingCellDelete = exports.SystemFlashingCellAdd = exports.SystemAlertRemoveRowHighlight = exports.SystemAlertRemoveCellHighlight = exports.SystemAlertDeleteAll = exports.SystemAlertDelete = exports.SystemAlertAdd = exports.SystemHighlightRowDeleteAll = exports.SystemHighlightRowsDelete = exports.SystemHighlightRowDelete = exports.SystemHighlightRowsAdd = exports.SystemHighlightRowAdd = exports.SystemHighlightCellDeleteAll = exports.SystemHighlightCellDelete = exports.SystemHighlightCellAdd = exports.DATA_IMPORT_COMPLETED = exports.SYSTEM_SUMMARY_ROW_SET = exports.SYSTEM_CELL_POPUP_EDIT_FOCUSED_ENTITY = exports.SYSTEM_CELL_POPUP_HIDE = exports.SYSTEM_CELL_POPUP_SHOW = exports.SYSTEM_VISUAL_EXPORT_END = exports.SYSTEM_VISUAL_EXPORT_BEGIN = exports.SYSTEM_SET_QUICK_SEARCH_FLOATING_VISIBILITY = exports.SYSTEM_SET_PREVIOUS_GROUPED_COLUMN_INDEX = exports.SYSTEM_CHARTING_SET_CURRENT_CHART_MODELS = exports.SYSTEM_DATA_SET_SELECT = exports.DASHBOARD_REFRESH = exports.SYSTEM_LAYOUT_SHOW_NOT_ASSOCIATED_OBJECTS = void 0;
+exports.SystemReducer = exports.DataImportCompleted = exports.SystemCommentsAndNotesFocusedEntitySelector = exports.SystemCommentsAndNotesEditModeSelector = exports.SystemCommentsAndNotesSelector = exports.SystemQuickSearchFloatingVisibilitySelector = exports.SystemPreviousGroupedColumnsSelector = exports.SystemDisableDeleteConfirmationSelector = exports.SystemCellPopupHide = exports.SystemRowSummarySet = exports.SystemCellPopupEditFocusedEntity = exports.SystemCellPopupShow = exports.SystemQuickSearchFloatingVisibility = exports.SystemVisualExportEnd = exports.SystemVisualExportBegin = exports.SystemDisableDeleteConfirmation = exports.SystemSetPreviousGroupedColumnsIndex = exports.SystemChartingCurrentChartModelsSelector = exports.SystemChartingSetCurrentChartModels = exports.SystemDataSetSelect = exports.SystemDashboardRefresh = exports.SystemLayoutShowNotAssociatedObjects = exports.SystemFilterFormHide = exports.SystemQuickFilterBarHide = exports.SystemQuickFilterBarShow = exports.SystemSettingsPanelSet = exports.SystemDataChangeHistoryResume = exports.SystemDataChangeHistorySuspend = exports.SystemDataChangeHistoryDisable = exports.SystemDataChangeHistoryEnable = exports.SystemDataChangeHistoryClearRow = exports.SystemDataChangeHistoryUndo = void 0;
 const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
 const Enums_1 = require("../../PredefinedConfig/Common/Enums");
 const Helper_1 = require("../../Utilities/Helpers/Helper");
@@ -92,10 +92,12 @@ exports.SYSTEM_SET_QUICK_SEARCH_FLOATING_VISIBILITY = 'SYSTEM_SET_QUICK_SEARCH_F
 // Data Export (Report)
 exports.SYSTEM_VISUAL_EXPORT_BEGIN = 'SYSTEM_VISUAL_EXPORT_BEGIN';
 exports.SYSTEM_VISUAL_EXPORT_END = 'SYSTEM_VISUAL_EXPORT_END';
-// Notes
+// Notes and Comments
 exports.SYSTEM_CELL_POPUP_SHOW = 'SYSTEM_CELL_POPUP_SHOW';
 exports.SYSTEM_CELL_POPUP_HIDE = 'SYSTEM_CELL_POPUP_HIDE';
 exports.SYSTEM_CELL_POPUP_EDIT_FOCUSED_ENTITY = 'SYSTEM_CELL_POPUP_EDIT_FOCUSED_ENTITY';
+// Row Summaries
+exports.SYSTEM_SUMMARY_ROW_SET = 'SYSTEM_SUMMARY_ROW_SET';
 // Data Import
 exports.DATA_IMPORT_COMPLETED = 'DATA_IMPORT_COMPLETED';
 const SystemHighlightCellAdd = (cellHighlightInfo) => ({
@@ -380,6 +382,11 @@ const SystemCellPopupEditFocusedEntity = (focusedEntity) => ({
     focusedEntity,
 });
 exports.SystemCellPopupEditFocusedEntity = SystemCellPopupEditFocusedEntity;
+const SystemRowSummarySet = (systemRowSummaries) => ({
+    type: exports.SYSTEM_SUMMARY_ROW_SET,
+    rowSummaries: systemRowSummaries,
+});
+exports.SystemRowSummarySet = SystemRowSummarySet;
 const SystemCellPopupHide = () => ({
     type: exports.SYSTEM_CELL_POPUP_HIDE,
 });
@@ -461,7 +468,7 @@ const initialState = {
     },
     DisableDeleteConfirmation: false,
     Export: {
-        inProgressVisualData: false,
+        visualDataExportInProgress: false,
     },
 };
 const SystemReducer = (state = initialState, action) => {
@@ -794,12 +801,12 @@ const SystemReducer = (state = initialState, action) => {
         }
         case exports.SYSTEM_VISUAL_EXPORT_BEGIN: {
             return Object.assign(Object.assign({}, state), { Export: {
-                    inProgressVisualData: true,
+                    visualDataExportInProgress: true,
                 } });
         }
         case exports.SYSTEM_VISUAL_EXPORT_END: {
             return Object.assign(Object.assign({}, state), { Export: {
-                    inProgressVisualData: false,
+                    visualDataExportInProgress: false,
                 } });
         }
         case exports.SYSTEM_SET_QUICK_SEARCH_FLOATING_VISIBILITY: {
@@ -830,6 +837,12 @@ const SystemReducer = (state = initialState, action) => {
                     popupPosition: null,
                 } });
         }
+        case exports.SYSTEM_SUMMARY_ROW_SET: {
+            const typedAction = action;
+            return Object.assign(Object.assign({}, state), { RowSummary: {
+                    rowSummaries: typedAction.rowSummaries,
+                } });
+        }
         default:
             return state;
     }

package/src/Redux/Store/AdaptableStore.d.ts

@@ -2,8 +2,7 @@ import * as Redux from 'redux';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { AdaptableState } from '../../PredefinedConfig/AdaptableState';
 import { ConfigState } from '../../PredefinedConfig/ConfigState';
-import { PredefinedConfig } from '../../PredefinedConfig/PredefinedConfig';
-import { IAdaptableStore } from './Interface/IAdaptableStore';
+import { IAdaptableStore, LoadStoreConfig } from './Interface/IAdaptableStore';
 type EmitterCallback = (data?: any) => any;
 type EmitterAnyCallback = (eventName: string, data?: any) => any;
 export declare const INIT_STATE = "INIT_STATE";
@@ -22,7 +21,6 @@ export declare const LoadState: (State: {
     [s: string]: ConfigState;
 }) => LoadStateAction;
 export declare class AdaptableStore implements IAdaptableStore {
-    private isAgGridReady;
     TheStore: Redux.Store<AdaptableState>;
     Load: Promise<any>;
     private emitter;
@@ -36,12 +34,12 @@ export declare class AdaptableStore implements IAdaptableStore {
     /**
      *
      * @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: IAdaptable, isAgGridReady: Promise<any>);
+    constructor(adaptable: IAdaptable);
     destroy(): void;
     getCurrentStorageState(): AdaptableState;
     saveStateNow(adaptable: IAdaptable): Promise<any>;
-    loadStore: (adaptable: IAdaptable, adaptableStateKey: string, predefinedConfig?: PredefinedConfig) => Promise<any>;
+    loadStore: (config: LoadStoreConfig) => Promise<any>;
 }
 export {};

package/src/Redux/Store/AdaptableStore.js

@@ -33,7 +33,7 @@ const FreeTextColumnRedux = tslib_1.__importStar(require("../ActionsReducers/Fre
 const GridRedux = tslib_1.__importStar(require("../ActionsReducers/GridRedux"));
 const LayoutRedux = tslib_1.__importStar(require("../ActionsReducers/LayoutRedux"));
 const NamedQueryRedux = tslib_1.__importStar(require("../ActionsReducers/NamedQueryRedux"));
-const NotesRedux = tslib_1.__importStar(require("../ActionsReducers/NotesRedux"));
+const NoteRedux = tslib_1.__importStar(require("../ActionsReducers/NoteRedux"));
 const PlusMinusRedux = tslib_1.__importStar(require("../ActionsReducers/PlusMinusRedux"));
 const QueryRedux = tslib_1.__importStar(require("../ActionsReducers/QueryRedux"));
 const QuickSearchRedux = tslib_1.__importStar(require("../ActionsReducers/QuickSearchRedux"));
@@ -51,9 +51,9 @@ const TeamSharingState_1 = require("../../PredefinedConfig/TeamSharingState");
 exports.INIT_STATE = 'INIT_STATE';
 exports.LOAD_STATE = 'LOAD_STATE';
 const NON_PERSIST_ACTIONS = {
-    [exports.LOAD_STATE]: true,
     '@@INIT': true,
     '@@redux/init': true,
+    [exports.LOAD_STATE]: true,
     [exports.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
     [SystemRedux_1.SYSTEM_PROGRESS_INDICATOR_SHOW]: true,
@@ -72,13 +72,12 @@ 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) => {
@@ -90,7 +89,9 @@ 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;
@@ -98,17 +99,15 @@ class AdaptableStore {
                 .load(predefinedConfig)
                 .then((storedState) => {
                 if (storedState && this.loadStateOnStartup) {
-                    this.TheStore.dispatch((0, exports.LoadState)(adaptable.adaptableOptions.stateOptions.applyState(storedState)));
+                    this.TheStore.dispatch((0, exports.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((0, exports.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((0, exports.InitState)());
@@ -128,6 +127,7 @@ class AdaptableStore {
             Popup: PopupRedux.PopupReducer,
             System: SystemRedux.SystemReducer,
             Plugins: PluginsRedux.PluginsReducer,
+            Comment: CommentsRedux.CommentsReducer,
             // Reducers for Persisted State
             Alert: AlertRedux.AlertReducer,
             FlashingCell: FlashingCellRedux.FlashingCellReducer,
@@ -149,8 +149,7 @@ 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,
         };
@@ -166,17 +165,6 @@ class AdaptableStore {
                 case exports.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;
@@ -257,7 +245,6 @@ class AdaptableStore {
         ...pluginsMiddleware // the plugins middleware
         )));
         this.storageEngine = storageEngine;
-        this.loadStore(adaptable, adaptable.adaptableOptions.adaptableStateKey);
     }
     destroy() {
         var _a;
@@ -282,7 +269,7 @@ exports.AdaptableStore = 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
@@ -330,6 +317,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
                  *******************/
@@ -345,7 +340,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                 }
                 case SystemRedux.SYSTEM_FLASHING_CELL_DELETE_ALL: {
                     let ret = next(action);
-                    adaptable.redrawRenderedRows();
+                    adaptable.redrawBody();
                     return ret;
                 }
                 /*******************
@@ -401,7 +396,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                         });
                     }
                     // called also for rendered column actions, see RENDERED COLUMN ACTIONS block
-                    adaptable.setupColumns();
+                    adaptable.updateColumnModelAndRefreshGrid();
                     return returnAction;
                 }
                 /*******************
@@ -416,7 +411,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;
                 }
                 /**
@@ -581,11 +576,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
@@ -603,7 +593,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                             .createAggregatedScalarLiveValue(returnAction.calculatedColumn);
                         adaptable.api.calculatedColumnApi.internalApi.fireCalculatedColumnChangedEvent(action.type, actionTyped.calculatedColumn);
                     }
-                    adaptable.updateColDefsForSpecialColumns();
+                    adaptable.updateColumnModelAndRefreshGrid();
                     return returnAction;
                 }
                 /**
@@ -628,7 +618,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;
                 }
                 /**
@@ -649,7 +639,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                         return;
                     }
                     const returnAction = next(action);
-                    adaptable.updateColDefsForSpecialColumns();
+                    adaptable.updateColumnModelAndRefreshGrid();
                     return returnAction;
                 }
                 /*******************
@@ -686,7 +676,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;
                 }
                 /*******************
@@ -785,7 +775,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                                 draftLayoutAction = GridRedux.LayoutDraftColumnFilterUnsuspendAll();
                                 break;
                         }
-                        //  GRID FILTER
                         returnAction = next(draftLayoutAction);
                     }
                     setTimeout(() => {
@@ -805,17 +794,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 }));
@@ -876,12 +875,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);
@@ -915,9 +914,9 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                         requestAnimationFrame(() => {
                             var _a, _b;
                             const commentThreads = adaptable.api.commentApi.getCommentThreads();
-                            adaptable.api.eventApi.emit('CommentsChanged', adaptable.api.commentApi.getCommentThreads());
+                            adaptable.api.eventApi.emit('CommentChanged', adaptable.api.commentApi.getCommentThreads());
                             (_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;
@@ -942,7 +941,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);
@@ -1026,12 +1025,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) {
@@ -1044,7 +1049,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));
                         }
                     }
@@ -1052,7 +1057,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));
@@ -1070,6 +1075,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                             adaptable.setLayout(savingLayout);
                         }
                     }
+                    adaptable.refreshQuickFilter();
                     return returnAction;
                 }
                 /*******************
@@ -1280,12 +1286,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     }
                     return next(action);
                 }
-                case SystemRedux_1.SYSTEM_VISUAL_EXPORT_BEGIN:
-                case SystemRedux_1.SYSTEM_VISUAL_EXPORT_END: {
-                    let returnAction = next(action);
-                    adaptable.ReportService.resetExcelStyleMemoization();
-                    return returnAction;
-                }
                 /*******************
                  * CHARTING ACTIONS
                  *******************/
@@ -1663,24 +1663,14 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                  *******************/
                 case exports.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: {