@adaptabletools/adaptable 22.0.1-canary.0 → 22.0.1-canary.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "22.0.1-canary.0",
+  "version": "22.0.1-canary.1",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/src/AdaptableOptions/AdaptablePlugin.d.ts

@@ -34,6 +34,10 @@ export declare abstract class AdaptablePlugin {
     afterInitStore(adaptable: IAdaptable): void;
     afterInit(ab: IAdaptable): void;
     afterSetLayout(adaptable: IAdaptable, layout: Layout): void;
+    onBeforeStoreEvent(eventName: string, data: {
+        action: Redux.Action;
+        state: AdaptableState;
+    }, adaptableStore: IAdaptableStore): void;
     onStoreEvent(eventName: string, data: {
         action: Redux.Action;
         state: AdaptableState;

package/src/AdaptableOptions/AdaptablePlugin.js

@@ -39,6 +39,7 @@ export class AdaptablePlugin {
     afterInit(ab) { }
     // hook executed after each layout update (Adaptable.setLayout())
     afterSetLayout(adaptable, layout) { }
+    onBeforeStoreEvent(eventName, data, adaptableStore) { }
     onStoreEvent(eventName, data, adaptableStore) { }
     onAdaptableReady(adaptable, adaptableOptions) { }
     interceptSetupColumnProperty;

package/src/Api/EventApi.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableReadyInfo, AdaptableStateChangedInfo, AdaptableStateReloadedInfo, AlertFiredInfo, CalculatedColumnChangedInfo, CellChangedInfo, CellSelectionChangedInfo, ChartChangedInfo, ColumnFilterAppliedInfo, CommentChangedInfo, CustomToolbarConfiguredInfo, DashboardChangedInfo, DataImportedInfo, DataSetSelectedInfo, Fdc3MessageInfo, FlashingCellDisplayedInfo, GridFilterAppliedInfo, GridSortedInfo, LayoutChangedInfo, LiveDataChangedInfo, RowChangedInfo, RowFormSubmittedInfo, RowSelectionChangedInfo, ScheduleTriggeredInfo, SystemStatusMessageDisplayedInfo, TeamSharingEntityChangedInfo, ThemeChangedInfo } from '../types';
+import { AdaptableReadyInfo, AdaptableStateChangedInfo, AdaptableStateReloadedInfo, BeforeAdaptableStateChangeInfo, AlertFiredInfo, CalculatedColumnChangedInfo, CellChangedInfo, CellSelectionChangedInfo, ChartChangedInfo, ColumnFilterAppliedInfo, CommentChangedInfo, CustomToolbarConfiguredInfo, DashboardChangedInfo, DataImportedInfo, DataSetSelectedInfo, Fdc3MessageInfo, FlashingCellDisplayedInfo, GridFilterAppliedInfo, GridSortedInfo, LayoutChangedInfo, LiveDataChangedInfo, RowChangedInfo, RowFormSubmittedInfo, RowSelectionChangedInfo, ScheduleTriggeredInfo, SystemStatusMessageDisplayedInfo, TeamSharingEntityChangedInfo, ThemeChangedInfo } from '../types';
 /**
  * Responsible for publishing the many Events that AdapTable fires
  */
@@ -210,6 +210,17 @@ export interface EventApi {
      * Unsubscribe from DashboardChanged
      */
     off(eventName: 'DashboardChanged', callback: (dashboardChangedInfo: DashboardChangedInfo) => void): void;
+    /**
+     * Event fired **before** Adaptable State changes (before the action is processed)
+     * @param eventName BeforeAdaptableStateChange
+     * @param callback BeforeAdaptableStateChangeInfo
+     * @returns the unsubscribe function
+     */
+    on(eventName: 'BeforeAdaptableStateChange', callback: (beforeAdaptableStateChangeInfo: BeforeAdaptableStateChangeInfo) => void): () => void;
+    /**
+     * Unsubscribe from BeforeAdaptableStateChange
+     */
+    off(eventName: 'BeforeAdaptableStateChange', callback: (beforeAdaptableStateChangeInfo: BeforeAdaptableStateChangeInfo) => void): void;
     /**
      * Event fired whenever **Adaptable State changes**
      * @param eventName AdaptableStateChanged
@@ -336,9 +347,10 @@ export interface EventApi {
      * @param callbackFdc3MessageInfo
      */
     off(eventName: 'Fdc3Message', callback: (fdc3MessageInfo: Fdc3MessageInfo) => void): void;
+    emitSync(eventName: 'BeforeAdaptableStateChange', data?: any): any[];
     emitSync(eventName: 'DashboardChanged', data?: any): any[];
     emitSync(eventName: 'FlashingCellDisplayed', data?: any): any[];
     emitSync(eventName: 'AdaptableDestroy'): any[];
-    emit(eventName: 'RowFormSubmitted' | 'AdaptableReady' | 'AlertFired' | 'AdaptableStateChanged' | 'AdaptableStateReloaded' | 'CellChanged' | 'ChartChanged' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'DashboardChanged' | 'DataImported' | 'DataSetSelected' | 'ColumnFilterApplied' | 'Fdc3Message' | 'RowChanged' | 'GridSorted' | 'LayoutChanged' | 'CalculatedColumnChanged' | 'LiveDataChanged' | 'ScheduleTriggered' | 'SearchChanged' | 'CellSelectionChanged' | 'RowSelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'GridFilterApplied' | 'CommentChanged', data?: any): Promise<any>;
+    emit(eventName: 'RowFormSubmitted' | 'AdaptableReady' | 'AlertFired' | 'BeforeAdaptableStateChange' | 'AdaptableStateChanged' | 'AdaptableStateReloaded' | 'CellChanged' | 'ChartChanged' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'DashboardChanged' | 'DataImported' | 'DataSetSelected' | 'ColumnFilterApplied' | 'Fdc3Message' | 'RowChanged' | 'GridSorted' | 'LayoutChanged' | 'CalculatedColumnChanged' | 'LiveDataChanged' | 'ScheduleTriggered' | 'SearchChanged' | 'CellSelectionChanged' | 'RowSelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'GridFilterApplied' | 'CommentChanged', data?: any): Promise<any>;
     destroy(): void;
 }

package/src/Api/Events/BeforeAdaptableStateChange.d.ts

@@ -0,0 +1,20 @@
+import * as Redux from 'redux';
+import { AdaptableState } from '../../AdaptableState/AdaptableState';
+import { BaseContext } from '../../types';
+/**
+ * Object returned by the `BeforeAdaptableStateChange` event, fired before the action is processed by the reducer
+ */
+export interface BeforeAdaptableStateChangeInfo extends BaseContext {
+    /**
+     * Name of the Action about to be performed
+     */
+    actionName: string;
+    /**
+     * The Redux Action that is about to be invoked
+     */
+    action: Redux.Action;
+    /**
+     * Current Adaptable State (before the Action is applied)
+     */
+    state: AdaptableState;
+}

package/src/Api/Events/BeforeAdaptableStateChange.js

@@ -0,0 +1 @@
+export {};

package/src/Api/Internal/EventInternalApi.d.ts

@@ -17,6 +17,7 @@ export declare class EventInternalApi extends ApiBase {
     fireDataSetSelectedEvent(dataSet: DataSet): void;
     fireSystemStatusMessageDisplayedEvent(systemStatusMessageInfo: SystemStatusMessageInfo): void;
     fireDataImportedEvent(importData: any[], addedRows: IRowNode[], updatedRows: IRowNode[]): DataImportedInfo;
+    fireBeforeAdaptableStateChangeEvent(action: Redux.Action, state: AdaptableState): void;
     fireAdaptableStateChangedEvent(action: Redux.Action, oldState: AdaptableState, newState: AdaptableState): void;
     fireAdaptableStateReloadedEvent(oldState: AdaptablePersistentState, newState: AdaptablePersistentState): void;
     fireCalculatedColumnChangedEvent(trigger: string, calculatedColumn: CalculatedColumn): void;

package/src/Api/Internal/EventInternalApi.js

@@ -129,6 +129,15 @@ export class EventInternalApi extends ApiBase {
         this.getEventApi().emit('DataImported', dataImportedInfo);
         return dataImportedInfo;
     }
+    fireBeforeAdaptableStateChangeEvent(action, state) {
+        const beforeAdaptableStateChangeInfo = {
+            actionName: action.type,
+            ...this.getAdaptableInternalApi().buildBaseContext(),
+            action: action,
+            state: state,
+        };
+        this.getEventApi().emitSync('BeforeAdaptableStateChange', beforeAdaptableStateChangeInfo);
+    }
     fireAdaptableStateChangedEvent(action, oldState, newState) {
         const adaptableStateChangedInfo = {
             actionName: action.type,

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

@@ -22,6 +22,7 @@ export declare class AdaptableStore implements IAdaptableStore {
     TheStore: Redux.Store<AdaptableState, Redux.Action>;
     Load: Promise<any>;
     private emitter;
+    private beforeEmitter;
     private storageEngine;
     private currentStorageState?;
     private previousStorageState?;
@@ -29,6 +30,7 @@ export declare class AdaptableStore implements IAdaptableStore {
     private loadStateOnStartup;
     on: (eventName: string, callback: EmitterCallback) => (() => void);
     onAny: (callback: EmitterAnyCallback) => (() => void);
+    onBeforeAny: (callback: EmitterAnyCallback) => (() => void);
     emit: (eventName: string, data: any) => Promise<any>;
     /**
      *

package/src/Redux/Store/AdaptableStore.js

@@ -70,6 +70,7 @@ export class AdaptableStore {
     TheStore;
     Load;
     emitter;
+    beforeEmitter;
     storageEngine;
     currentStorageState;
     previousStorageState;
@@ -81,6 +82,9 @@ export class AdaptableStore {
     onAny = (callback) => {
         return this.emitter.onAny(callback);
     };
+    onBeforeAny = (callback) => {
+        return this.beforeEmitter.onAny(callback);
+    };
     emit = (eventName, data) => {
         return this.emitter.emit(eventName, data);
     };
@@ -149,6 +153,7 @@ export class AdaptableStore {
         };
         let storageEngine;
         this.emitter = new Emitter();
+        this.beforeEmitter = new Emitter();
         // If the user has remote storage set then we use Remote Engine, otherwise we use Local Enginge
         // not sure we can do this as we need to be backwardly compatible with existing users so need to stick with adaptable id (which should be unique)
         // const localStorageKey =  'adaptable-adaptable-state-' + adaptable.adaptableOptions.primaryKey;
@@ -204,6 +209,13 @@ export class AdaptableStore {
             }
             return finalState;
         };
+        const beforeEmitterMiddleware = (middlewareAPI) => (next) => (action) => {
+            this.beforeEmitter.emitSync(action.type, {
+                action,
+                state: middlewareAPI.getState(),
+            });
+            return next(action);
+        };
         const devToolsActionMarkerMiddleware = createDevToolsActionMarkerMiddleware(adaptable);
         const pluginsMiddleware = [];
         adaptable.forPlugins((plugin) => {
@@ -212,6 +224,7 @@ export class AdaptableStore {
             }
         });
         const middlewares = [
+            beforeEmitterMiddleware, // fires before anything else processes the action
             devToolsActionMarkerMiddleware,
             adaptableMiddleware(adaptable), // the main middleware that actually does stuff,
             ...pluginsMiddleware, // the plugins middleware
@@ -224,6 +237,8 @@ export class AdaptableStore {
     destroy() {
         this.emitter?.clearListeners();
         this.emitter = null;
+        this.beforeEmitter?.clearListeners();
+        this.beforeEmitter = null;
     }
     getCurrentStorageState() {
         return this.currentStorageState;

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

@@ -17,6 +17,7 @@ export interface IAdaptableStore {
     saveStateNow: (adaptable: IAdaptable) => Promise<any>;
     on: (eventName: string, callback: (data?: any) => any) => () => void;
     onAny: (callback: (eventName: string, data?: any) => any) => () => void;
+    onBeforeAny: (callback: (eventName: string, data?: any) => any) => () => void;
     emit: (eventName: string, data: any) => Promise<any>;
     destroy: () => void;
 }

package/src/agGrid/AdaptableAgGrid.js

@@ -957,6 +957,7 @@ export class AdaptableAgGrid {
                         if (rowGroupDisplayType === 'single') {
                             return true;
                         }
+                        // this is required because of AG Grid bug, see https://github.com/AdaptableTools/adaptable/issues/3212
                         if (rowGroupDisplayType === 'multi') {
                             const groupedColumnFilterConfig = this.api.layoutApi.internalApi.areAllGroupedColumnsFilterable();
                             if (groupedColumnFilterConfig.floatingFilter) {
@@ -1612,6 +1613,12 @@ export class AdaptableAgGrid {
         const perfNewAdaptableStore = this.logger.beginPerf(`initAdaptableStore()`);
         const initAdaptableStoreMarker = getMarker(this.adaptableOptions.adaptableId).track.Init.label.InitStore.start();
         const adaptableStore = new AdaptableStore(this);
+        adaptableStore.onBeforeAny((eventName, data) => {
+            if (this.isReady) {
+                this.api.eventApi.internalApi.fireBeforeAdaptableStateChangeEvent(data.action, data.state);
+            }
+            this.forPlugins((plugin) => plugin.onBeforeStoreEvent?.(eventName, data, this.adaptableStore));
+        });
         adaptableStore.onAny((eventName, data) => {
             if (this.isReady) {
                 this.api.eventApi.internalApi.fireAdaptableStateChangedEvent(data.action, data.state, data.newState);

package/src/env.js

@@ -1,5 +1,5 @@
 export default {
     NEXT_PUBLIC_INFINITE_TABLE_LICENSE_KEY: "StartDate=2021-06-29|EndDate=2030-01-01|Owner=Adaptable|Type=distribution|TS=1624971462479|C=137829811,1004007071,2756196225,1839832928,3994409405,636616862" || '',
-    PUBLISH_TIMESTAMP: 1772037233183 || Date.now(),
-    VERSION: "22.0.1-canary.0" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1772179361165 || Date.now(),
+    VERSION: "22.0.1-canary.1" || '--current-version--',
 };

package/src/types.d.ts

@@ -139,6 +139,7 @@ export type { ThemeChangedInfo } from './Api/Events/ThemeChanged';
 export type { DashboardChangedInfo } from './Api/Events/DashboardChanged';
 export type { ScheduleTriggeredInfo } from './Api/Events/ScheduleTriggered';
 export type { AdaptableStateChangedInfo } from './Api/Events/AdaptableStateChanged';
+export type { BeforeAdaptableStateChangeInfo } from './Api/Events/BeforeAdaptableStateChange';
 export type { CommentChangedInfo } from './Api/Events/CommentChanged';
 export type { Fdc3MessageInfo, Fdc3MessageSentInfo, Fdc3MessageReceivedInfo, } from './Api/Events/Fdc3MessageInfo';
 export type { AdaptableState, AdaptablePersistentState, AdaptableTransientState, } from './AdaptableState/AdaptableState';