@adaptabletools/adaptable 10.0.4-canary.1 → 10.0.4-canary.5

package/src/Redux/Store/AdaptableStore.js

@@ -9,6 +9,7 @@ const AdaptableReduxMerger_1 = require("./AdaptableReduxMerger");
 const PopupRedux = tslib_1.__importStar(require("../ActionsReducers/PopupRedux"));
 const PluginsRedux = tslib_1.__importStar(require("../ActionsReducers/PluginsRedux"));
 const AlertRedux = tslib_1.__importStar(require("../ActionsReducers/AlertRedux"));
+const FlashingCellRedux = tslib_1.__importStar(require("../ActionsReducers/FlashingCellRedux"));
 const DeadRedux = tslib_1.__importStar(require("../DeadRedux"));
 const SmartEditRedux = tslib_1.__importStar(require("../ActionsReducers/SmartEditRedux"));
 const BulkUpdateRedux = tslib_1.__importStar(require("../ActionsReducers/BulkUpdateRedux"));
@@ -66,13 +67,13 @@ class AdaptableStore {
     /**
      *
      * @param adaptable The Adaptable instance
-     * @param isVendorReady A promise which is resolved when the underlying grid is ready for binding
+     * @param isAgGridReady A promise which is resolved when AG Grid is ready for binding
      */
-    constructor(adaptable, isVendorReady) {
+    constructor(adaptable, isAgGridReady) {
         /*
-    This is the main store for Adaptable State
-    */
-        this.isVendorReady = isVendorReady;
+          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) => {
@@ -95,8 +96,8 @@ class AdaptableStore {
                     this.TheStore.dispatch(exports.LoadState(adaptable.adaptableOptions.stateOptions.applyState(storedState)));
                 }
             })
-                // we need the vendor grid to be ready because several states(ex. Layout) depend on its API
-                .then(() => this.isVendorReady)
+                // we need AG Grid to be ready because several states(ex. Layout) depend on its API
+                .then(() => this.isAgGridReady)
                 .then(() => {
                 this.TheStore.dispatch(exports.InitState());
                 // END STATE LOAD
@@ -124,6 +125,7 @@ class AdaptableStore {
             SparklineColumn: SparklineColumnRedux.SparklineColumnReducer,
             // Reducers for Persisted State
             Alert: AlertRedux.AlertReducer,
+            FlashingCell: FlashingCellRedux.FlashingCellReducer,
             Application: ApplicationRedux.ApplicationReducer,
             CalculatedColumn: CalculatedColumnRedux.CalculatedColumnReducer,
             // replaced by `charts` plugin
@@ -149,7 +151,6 @@ class AdaptableStore {
             Query: QueryRedux.QueryReducer,
             // dead reducers
             PercentBar: DeadRedux.PercentBarReducer,
-            FlashingCell: DeadRedux.FlashingCellReducer,
             UpdatedRow: DeadRedux.UpdatedRowReducer,
             GradientColumn: DeadRedux.GradientColumnReducer,
         };
@@ -252,7 +253,7 @@ exports.AdaptableStore = AdaptableStore;
 const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
     return function (next) {
         return function (action) {
-            var _a, _b, _c, _d, _e;
+            var _a, _b, _c, _d, _e, _f;
             switch (action.type) {
                 /*******************
                  * NAMED QUERY ACTIONS
@@ -313,11 +314,11 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                  *******************/
                 case SystemRedux.SYSTEM_FLASHING_ALERT_ADD:
                 case SystemRedux.SYSTEM_FLASHING_ALERT_DELETE: {
-                    const { flashingAlert: FlashingAlert, } = action;
-                    const { dataChangedInfo } = FlashingAlert;
+                    const { flashingCell: FlashingCell, } = action;
+                    const { dataChangedInfo } = FlashingCell;
                     let ret = next(action);
                     if (dataChangedInfo) {
-                        adaptable.refreshCells([dataChangedInfo.rowNode], Object.keys(FlashingAlert.flashColumnIds), true);
+                        adaptable.refreshCells([dataChangedInfo.rowNode], Object.keys(FlashingCell.flashColumnIds), true);
                     }
                     return ret;
                 }
@@ -330,52 +331,43 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                     reactiveAlertDefinitions.forEach((reactiveAlertDefinition) => adaptable.api.internalApi
                         .getAlertService()
                         .createReactiveAlert(reactiveAlertDefinition));
-                    const reactiveFlashingAlertDefinitions = adaptable.api.alertApi.getActiveReactiveFlashingAlertDefinitions();
-                    reactiveFlashingAlertDefinitions.forEach((reactiveAlertDefinition) => adaptable.api.internalApi
-                        .getAlertService()
-                        .createReactiveAlert(reactiveAlertDefinition, true));
                     return;
                 }
                 case AlertRedux.ALERT_DEFINITION_ADD:
                 case AlertRedux.ALERT_DEFINITION_EDIT:
                 case AlertRedux.ALERT_DEFINITION_DELETE:
-                case AlertRedux.FLASHING_ALERT_DEFINITION_ADD:
-                case AlertRedux.FLASHING_ALERT_DEFINITION_EDIT:
-                case AlertRedux.FLASHING_ALERT_DEFINITION_DELETE:
                 case AlertRedux.ALERT_DEFINITION_UN_SUSPEND:
-                case AlertRedux.ALERT_DEFINITION_SUSPEND:
-                case AlertRedux.FLASHING_ALERT_DEFINITION_UN_SUSPEND:
-                case AlertRedux.FLASHING_ALERT_DEFINITION_SUSPEND: {
+                case AlertRedux.ALERT_DEFINITION_SUSPEND: {
                     const returnAction = next(action);
-                    const isFlashingAlert = returnAction.type === AlertRedux.FLASHING_ALERT_DEFINITION_ADD ||
-                        returnAction.type === AlertRedux.FLASHING_ALERT_DEFINITION_EDIT ||
-                        returnAction.type === AlertRedux.FLASHING_ALERT_DEFINITION_DELETE ||
-                        returnAction.type === AlertRedux.FLASHING_ALERT_DEFINITION_SUSPEND ||
-                        returnAction.type === AlertRedux.FLASHING_ALERT_DEFINITION_UN_SUSPEND;
-                    const alertDefinition = isFlashingAlert
-                        ? returnAction.flashingAlertDefinition
-                        : returnAction.alertDefinition;
+                    const alertDefinition = returnAction
+                        .alertDefinition;
                     if (returnAction.type === AlertRedux.ALERT_DEFINITION_ADD ||
                         returnAction.type === AlertRedux.ALERT_DEFINITION_EDIT ||
-                        returnAction.type === AlertRedux.FLASHING_ALERT_DEFINITION_ADD ||
-                        returnAction.type === AlertRedux.FLASHING_ALERT_DEFINITION_EDIT ||
-                        returnAction.type === AlertRedux.ALERT_DEFINITION_UN_SUSPEND ||
-                        returnAction.type === AlertRedux.FLASHING_ALERT_DEFINITION_UN_SUSPEND) {
+                        returnAction.type === AlertRedux.ALERT_DEFINITION_UN_SUSPEND) {
                         // in case of edit, the existing reactive alert will be deleted and recreated
-                        adaptable.api.internalApi
-                            .getAlertService()
-                            .createReactiveAlert(alertDefinition, isFlashingAlert);
+                        adaptable.api.internalApi.getAlertService().createReactiveAlert(alertDefinition);
                     }
                     if (returnAction.type === AlertRedux.ALERT_DEFINITION_DELETE ||
-                        returnAction.type === AlertRedux.FLASHING_ALERT_DEFINITION_DELETE ||
-                        returnAction.type === AlertRedux.ALERT_DEFINITION_SUSPEND ||
-                        returnAction.type === AlertRedux.FLASHING_ALERT_DEFINITION_SUSPEND) {
+                        returnAction.type === AlertRedux.ALERT_DEFINITION_SUSPEND) {
                         adaptable.api.internalApi.getAlertService().deleteReactiveAlert(alertDefinition);
                     }
                     // called also for rendered column actions, see RENDERED COLUMN ACTIONS block
                     adaptable.setupColumns();
                     return returnAction;
                 }
+                /*******************
+                 * Flashing Cell ACTIONS
+                 *******************/
+                case FlashingCellRedux.FLASHING_ALERT_DEFINITION_ADD:
+                case FlashingCellRedux.FLASHING_ALERT_DEFINITION_EDIT:
+                case FlashingCellRedux.FLASHING_ALERT_DEFINITION_DELETE:
+                case FlashingCellRedux.FLASHING_ALERT_DEFINITION_UN_SUSPEND:
+                case FlashingCellRedux.FLASHING_ALERT_DEFINITION_SUSPEND: {
+                    const returnAction = next(action);
+                    // called also for rendered column actions, see RENDERED COLUMN ACTIONS block
+                    adaptable.setupColumns();
+                    return returnAction;
+                }
                 /**
                  * Use Case: User has deleted a System Alert which has a Highlight Cell
                  * Action: Refresh the cell (to clear the style)
@@ -388,6 +380,11 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                         let rowNode = actionTyped.alert.dataChangedInfo.rowNode;
                         adaptable.refreshCells([rowNode], [actionTyped.alert.dataChangedInfo.column.columnId], true);
                     }
+                    if (((_d = actionTyped.alert.alertDefinition.AlertProperties) === null || _d === void 0 ? void 0 : _d.HighlightRow) &&
+                        actionTyped.alert.dataChangedInfo) {
+                        let rowNode = actionTyped.alert.dataChangedInfo.rowNode;
+                        adaptable.api.gridApi.refreshRowNode(rowNode);
+                    }
                     return ret;
                 }
                 /**
@@ -399,11 +396,15 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                     let ret = next(action);
                     let alerts = actionTyped.alerts;
                     alerts.forEach((alert) => {
-                        var _a;
+                        var _a, _b;
                         if (((_a = alert.alertDefinition.AlertProperties) === null || _a === void 0 ? void 0 : _a.HighlightCell) && alert.dataChangedInfo) {
                             let rowNode = alert.dataChangedInfo.rowNode;
                             adaptable.refreshCells([rowNode], [alert.dataChangedInfo.column.columnId], true);
                         }
+                        if (((_b = alert.alertDefinition.AlertProperties) === null || _b === void 0 ? void 0 : _b.HighlightRow) && alert.dataChangedInfo) {
+                            let rowNode = alert.dataChangedInfo.rowNode;
+                            adaptable.api.gridApi.refreshRowNode(rowNode);
+                        }
                     });
                     return ret;
                 }
@@ -412,11 +413,16 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                  * Action: Refresh the cell (to clear the style)
                  */
                 case SystemRedux.SYSTEM_ALERT_REMOVE_HIGHLIGHT: {
-                    const actionTyped = action;
                     let ret = next(action);
+                    const actionTyped = action;
                     if (actionTyped.alert.dataChangedInfo) {
                         let rowNode = actionTyped.alert.dataChangedInfo.rowNode;
-                        adaptable.refreshCells([rowNode], [actionTyped.alert.dataChangedInfo.column.columnId], true);
+                        if (actionTyped.alert.alertDefinition.AlertProperties.HighlightCell) {
+                            adaptable.refreshCells([rowNode], [actionTyped.alert.dataChangedInfo.column.columnId], true);
+                        }
+                        if (actionTyped.alert.alertDefinition.AlertProperties.HighlightRow) {
+                            adaptable.api.gridApi.refreshRowNode(rowNode);
+                        }
                     }
                     return ret;
                 }
@@ -433,10 +439,9 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                 case SystemRedux.SYSTEM_HIGHLIGHT_CELL_DELETE: {
                     const actionTyped = action;
                     const ret = next(action);
-                    const cellHighlightInfo = actionTyped.cellHighlightInfo;
-                    const rowNode = adaptable.getRowNodeForPrimaryKey(cellHighlightInfo.primaryKeyValue);
+                    const rowNode = adaptable.getRowNodeForPrimaryKey(actionTyped.primaryKeyValue);
                     if (rowNode) {
-                        adaptable.refreshCells([rowNode], [cellHighlightInfo.columnId], true);
+                        adaptable.refreshCells([rowNode], [actionTyped.columnId], true);
                     }
                     return ret;
                 }
@@ -452,6 +457,37 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                     });
                     return ret;
                 }
+                case SystemRedux.SYSTEM_HIGHLIGHT_ROW_ADD: {
+                    const actionTyped = action;
+                    const ret = next(action);
+                    const rowHighlightInfo = actionTyped.rowHighlightInfo;
+                    const rowNode = adaptable.getRowNodeForPrimaryKey(rowHighlightInfo.primaryKeyValue);
+                    if (rowNode) {
+                        adaptable.api.gridApi.refreshRowNode(rowNode);
+                    }
+                    return ret;
+                }
+                case SystemRedux.SYSTEM_HIGHLIGHT_ROW_DELETE: {
+                    const actionTyped = action;
+                    const ret = next(action);
+                    const rowNode = adaptable.getRowNodeForPrimaryKey(actionTyped.primaryKeyValue);
+                    if (rowNode) {
+                        adaptable.api.gridApi.refreshRowNode(rowNode);
+                    }
+                    return ret;
+                }
+                case SystemRedux.SYSTEM_HIGHLIGHT_CELL_DELETE_ALL: {
+                    const rowHighlightInfos = middlewareAPI.getState().System.HighlightedRows;
+                    const ret = next(action);
+                    rowHighlightInfos.forEach((rowHighlightInfo) => {
+                        const rowNode = adaptable.getRowNodeForPrimaryKey(rowHighlightInfo.primaryKeyValue);
+                        if (!rowNode) {
+                            return;
+                        }
+                        adaptable.api.gridApi.refreshRowNode(rowNode);
+                    });
+                    return ret;
+                }
                 /*******************
                  * SPECIAL COLUMN ACTIONS
                  *******************/
@@ -682,13 +718,15 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                 case LayoutRedux.LAYOUT_EDIT:
                 case LayoutRedux.LAYOUT_SAVE:
                 case LayoutRedux.LAYOUT_DELETE:
+                case LayoutRedux.LAYOUT_SET_COLUMN_CAPTION:
                 case LayoutRedux.LAYOUT_SELECT: {
                     const oldLayoutState = middlewareAPI.getState().Layout;
                     let returnAction = next(action);
                     const newLayoutState = middlewareAPI.getState().Layout;
                     adaptable.api.layoutApi.fireLayoutChangedEvent(action.type, oldLayoutState, newLayoutState);
                     if (returnAction.type == LayoutRedux.LAYOUT_SELECT ||
-                        returnAction.type == LayoutRedux.LAYOUT_DELETE) {
+                        returnAction.type == LayoutRedux.LAYOUT_DELETE ||
+                        returnAction.type == LayoutRedux.LAYOUT_SET_COLUMN_CAPTION) {
                         let gridState = middlewareAPI.getState().Grid;
                         let currentLayout = newLayoutState.Layouts.find((l) => l.Name == newLayoutState.CurrentLayout);
                         if (gridState.CurrentLayout) {
@@ -698,7 +736,7 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                             // tell grid the layout has been selected
                             adaptable.setLayout(currentLayout);
                         }
-                        if (!((_d = adaptable.adaptableOptions.layoutOptions) === null || _d === void 0 ? void 0 : _d.autoSaveLayouts)) {
+                        if (!((_e = adaptable.adaptableOptions.layoutOptions) === null || _e === void 0 ? void 0 : _e.autoSaveLayouts)) {
                             middlewareAPI.dispatch(LayoutRedux.LayoutUpdateCurrentDraft(currentLayout));
                         }
                     }
@@ -706,7 +744,7 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                         returnAction.type == LayoutRedux.LAYOUT_SAVE) {
                         const actionTyped = action;
                         // if autosave is false
-                        if (!((_e = adaptable.adaptableOptions.layoutOptions) === null || _e === void 0 ? void 0 : _e.autoSaveLayouts)) {
+                        if (!((_f = adaptable.adaptableOptions.layoutOptions) === null || _f === void 0 ? void 0 : _f.autoSaveLayouts)) {
                             // and the current layout is saved, make sure we also update the draft
                             if (actionTyped.layout.Name === newLayoutState.CurrentLayout) {
                                 middlewareAPI.dispatch(LayoutRedux.LayoutUpdateCurrentDraft(actionTyped.layout));
@@ -910,7 +948,6 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                     let module = adaptable.modules.get(ModuleConstants.ExportModuleId);
                     const actionTyped = action;
                     module.export(actionTyped.Report, actionTyped.ExportDestination);
-                    middlewareAPI.dispatch(PopupRedux.PopupHideScreen());
                     return next(action);
                 }
                 // When deleting a report check if its the currently selected one
@@ -1195,7 +1232,7 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                 case GridRedux.GRID_REFRESH_CELLS: {
                     const actionTyped = action;
                     let ret = next(action);
-                    adaptable.refreshCells(actionTyped.rows, actionTyped.columnIds, true);
+                    adaptable.refreshCells(actionTyped.rowNodes, actionTyped.columnIds, true);
                     return ret;
                 }
                 case GridRedux.GRID_SET_SORT: {
@@ -1246,6 +1283,9 @@ 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;

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, MenuContext } from '../PredefinedConfig/Common/Menu';
+import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
 import { AdaptableModule } from '../PredefinedConfig/Common/Types';
 import { TeamSharingImportInfo } from '../PredefinedConfig/TeamSharingState';
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
@@ -33,7 +33,7 @@ export declare abstract class AdaptableModuleBase implements IModule {
     addModuleMenuItem(source: 'ModuleMenu' | 'ModuleButton'): AdaptableMenuItem | undefined;
     addModuleButtonMenuItem(): AdaptableMenuItem | undefined;
     addColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem[] | undefined;
-    addContextMenuItems(menuContext: MenuContext): AdaptableMenuItem[] | undefined;
+    addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
     createMainMenuItemShowPopup({ Label, ComponentName, Icon, PopupParams, }: {
         Label: string;
         ComponentName: string;

package/src/Strategy/AlertModule.d.ts

@@ -1,11 +1,12 @@
+/// <reference types="react" />
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AlertDefinition } from '../PredefinedConfig/AlertState';
-import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
-import { AdaptableMenuItem, MenuContext } from '../PredefinedConfig/Common/Menu';
+import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
 import { TeamSharingImportInfo } from '../PredefinedConfig/TeamSharingState';
+import * as AlertRedux from '../Redux/ActionsReducers/AlertRedux';
 import { AdaptableModuleBase } from './AdaptableModuleBase';
-import { IModule } from './Interface/IModule';
+import { AdaptableObjectView, IModule } from './Interface/IModule';
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
 export declare class AlertModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
@@ -13,15 +14,23 @@ export declare class AlertModule extends AdaptableModuleBase implements IModule
     getExplicitlyReferencedColumnIds(alertDefinition: AlertDefinition): string[];
     getReferencedNamedQueryNames(alertDefinition: AlertDefinition): string[];
     updateOldConfig(): void;
-    addColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem[] | undefined;
-    addContextMenuItems(menuContext: MenuContext): AdaptableMenuItem[] | undefined;
+    addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
     protected handleDataSourceChanged(dataChangedInfo: DataChangedInfo): void;
     private handleReactiveAlertTriggered;
     private showAlertForDefinitions;
-    private showFlashingAlertsForDefinitions;
     private getAlertDefinitionsForDataChange;
-    private getFlashingAlertDefinitionsForDataChange;
     private getBaseAlertDefinitionsForDataChange;
     private isAlertPredicateTriggered;
     getTeamSharingAction(): TeamSharingImportInfo<AlertDefinition>;
+    toView(alert: AlertDefinition): AdaptableObjectView;
+    toViewAll(): AdaptableObjectView[];
+    getViewProperties(): {
+        getDeleteAction: (alertDefinition: AlertDefinition) => AlertRedux.AlertDefinitionDeleteAction;
+        getSuspendAction: (alertDefinition: AlertDefinition) => AlertRedux.AlertDefinitionSuspendAction;
+        getUnSuspendAction: (alertDefinition: AlertDefinition) => AlertRedux.AlertDefinitionUnSuspendAction;
+        emptyView: import("react").FunctionComponent<{
+            module: IModule;
+        }>;
+        getEditWizard: () => (props: import("../View/Alert/Wizard/AlertWizard").AlertWizardProps) => JSX.Element;
+    };
 }