@adaptabletools/adaptable 20.2.0 → 20.2.2

package/src/Api/Implementation/LayoutHelpers.js

@@ -64,6 +64,78 @@ const errorOnce = (message) => {
     console.error(message);
     errorOnceMessages.set(message, true);
 };
+export const getLayoutRowGroupValuesExceptionGroupKeys = (layout) => {
+    if (!layout.RowGroupValues) {
+        return [];
+    }
+    if (layout.RowGroupValues?.RowGroupDefaultBehavior === 'always-collapsed') {
+        return [];
+    }
+    if (layout.RowGroupValues?.RowGroupDefaultBehavior === 'always-expanded') {
+        return [];
+    }
+    if (Array.isArray(layout.RowGroupValues?.GroupKeys)) {
+        const currentGroupedColumns = (layout.RowGroupedColumns || []).join(',');
+        const matchingGroupKeys = layout.RowGroupValues.GroupKeys.find(({ RowGroupedColumns }) => {
+            return RowGroupedColumns.join(',') === currentGroupedColumns;
+        });
+        if (matchingGroupKeys) {
+            return matchingGroupKeys.ExceptionGroupKeys;
+        }
+    }
+    return layout.RowGroupValues.ExceptionGroupKeys || [];
+};
+export const toRowGroupValuesForLayoutState = (rowGroupValuesModel) => {
+    if (!rowGroupValuesModel) {
+        return undefined;
+    }
+    const rowGroupValuesState = {
+        RowGroupDefaultBehavior: rowGroupValuesModel.RowGroupDisplay,
+    };
+    if (rowGroupValuesModel.RowGroupDisplay === 'collapsed' ||
+        rowGroupValuesModel.RowGroupDisplay === 'expanded') {
+        if (rowGroupValuesModel.GroupKeys) {
+            rowGroupValuesState.GroupKeys =
+                rowGroupValuesModel.GroupKeys.map(({ RowGroupedColumns, Values }) => {
+                    return {
+                        RowGroupedColumns,
+                        ExceptionGroupKeys: Values,
+                    };
+                });
+        }
+        else {
+            rowGroupValuesState.ExceptionGroupKeys =
+                rowGroupValuesModel.Values;
+        }
+    }
+    return rowGroupValuesState;
+};
+export const toRowGroupValuesForLayoutModel = (rowGroupValuesState) => {
+    if (!rowGroupValuesState) {
+        return undefined;
+    }
+    if (rowGroupValuesState.RowGroupDefaultBehavior === 'always-collapsed' ||
+        rowGroupValuesState.RowGroupDefaultBehavior === 'always-expanded') {
+        return {
+            RowGroupDisplay: rowGroupValuesState.RowGroupDefaultBehavior,
+        };
+    }
+    if (rowGroupValuesState.GroupKeys) {
+        return {
+            RowGroupDisplay: rowGroupValuesState.RowGroupDefaultBehavior,
+            GroupKeys: rowGroupValuesState.GroupKeys.map(({ RowGroupedColumns, ExceptionGroupKeys }) => {
+                return {
+                    RowGroupedColumns,
+                    Values: ExceptionGroupKeys,
+                };
+            }),
+        };
+    }
+    return {
+        RowGroupDisplay: rowGroupValuesState.RowGroupDefaultBehavior,
+        Values: rowGroupValuesState.ExceptionGroupKeys || [],
+    };
+};
 export const checkForDuplicateColumns = (layout) => {
     if (layout.TableColumns) {
         const set = new Set(layout.TableColumns);
@@ -97,17 +169,7 @@ export const tableLayoutToTableLayoutModel = (tableLayout) => {
         ColumnSorts: tableLayout.ColumnSorts,
         RowGroupedColumns: tableLayout.RowGroupedColumns,
         ColumnPinning: tableLayout.ColumnPinning,
-        RowGroupValues: tableLayout.RowGroupValues
-            ? tableLayout.RowGroupValues.RowGroupDefaultBehavior === 'always-collapsed' ||
-                tableLayout.RowGroupValues.RowGroupDefaultBehavior === 'always-expanded'
-                ? {
-                    RowGroupDisplay: tableLayout.RowGroupValues.RowGroupDefaultBehavior,
-                }
-                : {
-                    RowGroupDisplay: tableLayout.RowGroupValues.RowGroupDefaultBehavior,
-                    Values: tableLayout.RowGroupValues.ExceptionGroupKeys || [],
-                }
-            : undefined,
+        RowGroupValues: toRowGroupValuesForLayoutModel(tableLayout.RowGroupValues),
         ColumnGroupValues: tableLayout.ColumnGroupValues
             ? tableLayout.ColumnGroupValues.ColumnGroupDefaultBehavior === 'always-expanded' ||
                 tableLayout.ColumnGroupValues.ColumnGroupDefaultBehavior === 'always-collapsed'
@@ -180,17 +242,7 @@ export const pivotLayoutToPivotLayoutModel = (pivotLayout) => {
         GrandTotalRow: pivotLayout.GrandTotalRow,
         PivotGrandTotal: pivotLayout.PivotGrandTotal,
         PivotColumnTotal: pivotLayout.PivotColumnTotal,
-        RowGroupValues: pivotLayout.RowGroupValues
-            ? pivotLayout.RowGroupValues.RowGroupDefaultBehavior === 'always-collapsed' ||
-                pivotLayout.RowGroupValues.RowGroupDefaultBehavior === 'always-expanded'
-                ? {
-                    RowGroupDisplay: pivotLayout.RowGroupValues.RowGroupDefaultBehavior,
-                }
-                : {
-                    RowGroupDisplay: pivotLayout.RowGroupValues.RowGroupDefaultBehavior,
-                    Values: pivotLayout.RowGroupValues.ExceptionGroupKeys || [],
-                }
-            : undefined,
+        RowGroupValues: toRowGroupValuesForLayoutModel(pivotLayout.RowGroupValues),
         ColumnGroupValues: pivotLayout.ColumnGroupValues
             ? pivotLayout.ColumnGroupValues.ColumnGroupDefaultBehavior === 'always-expanded' ||
                 pivotLayout.ColumnGroupValues.ColumnGroupDefaultBehavior === 'always-collapsed'
@@ -295,15 +347,7 @@ export const tableLayoutModelToTableLayout = (layoutModel) => {
         delete tableLayout.ColumnPinning;
     }
     if (layoutModel.RowGroupValues) {
-        tableLayout.RowGroupValues = {
-            RowGroupDefaultBehavior: layoutModel.RowGroupValues.RowGroupDisplay,
-        };
-        if ((layoutModel.RowGroupValues.RowGroupDisplay === 'collapsed' ||
-            layoutModel.RowGroupValues.RowGroupDisplay === 'expanded') &&
-            layoutModel.RowGroupValues.Values) {
-            // @ts-ignore
-            tableLayout.RowGroupValues.ExceptionGroupKeys = layoutModel.RowGroupValues.Values;
-        }
+        tableLayout.RowGroupValues = toRowGroupValuesForLayoutState(layoutModel.RowGroupValues);
     }
     else {
         delete tableLayout.RowGroupValues;
@@ -397,15 +441,7 @@ export const pivotLayoutModelToPivotLayout = (layoutModel) => {
         delete pivotLayout.PivotGroupedColumns;
     }
     if (layoutModel.RowGroupValues) {
-        pivotLayout.RowGroupValues = {
-            RowGroupDefaultBehavior: layoutModel.RowGroupValues.RowGroupDisplay,
-        };
-        if ((layoutModel.RowGroupValues.RowGroupDisplay === 'collapsed' ||
-            layoutModel.RowGroupValues.RowGroupDisplay === 'expanded') &&
-            layoutModel.RowGroupValues.Values) {
-            // @ts-ignore
-            pivotLayout.RowGroupValues.ExceptionGroupKeys = layoutModel.RowGroupValues.Values;
-        }
+        pivotLayout.RowGroupValues = toRowGroupValuesForLayoutState(layoutModel.RowGroupValues);
     }
     else {
         delete pivotLayout.RowGroupValues;

package/src/Api/Implementation/QuickSearchApiImpl.d.ts

@@ -9,10 +9,10 @@ export declare class QuickSearchApiImpl extends ApiBase implements QuickSearchAp
     gotoNextMatch(): void;
     gotoPreviousMatch(): void;
     getQuickSearchValue(): string;
-    getQuickSearchStyle(): AdaptableStyle;
+    getQuickSearchCellMatchStyle(): AdaptableStyle;
     getQuickSearchTextMatchStyle(): AdaptableStyle | undefined;
     getQuickSearchCurrentTextMatchStyle(): AdaptableStyle | undefined;
-    setQuickSearchStyle(style: AdaptableStyle): void;
+    setQuickSearchCellMatchStyle(style: AdaptableStyle): void;
     openQuickSearchSettingsPanel(): void;
     showFloatingQuickSearch(): void;
     hideFloatingQuickSearch(): void;

package/src/Api/Implementation/QuickSearchApiImpl.js

@@ -21,8 +21,8 @@ export class QuickSearchApiImpl extends ApiBase {
     getQuickSearchValue() {
         return this.getQuickSearchState().QuickSearchText;
     }
-    getQuickSearchStyle() {
-        return this.getQuickSearchState().Style;
+    getQuickSearchCellMatchStyle() {
+        return this.getQuickSearchState().CellMatchStyle;
     }
     getQuickSearchTextMatchStyle() {
         return this.getQuickSearchState().TextMatchStyle;
@@ -30,8 +30,8 @@ export class QuickSearchApiImpl extends ApiBase {
     getQuickSearchCurrentTextMatchStyle() {
         return this.getQuickSearchState().CurrentTextMatchStyle;
     }
-    setQuickSearchStyle(style) {
-        this.dispatchAction(QuickSearchRedux.QuickSearchSetStyle(style));
+    setQuickSearchCellMatchStyle(style) {
+        this.dispatchAction(QuickSearchRedux.QuickSearchSetCellMatchingStyle(style));
     }
     openQuickSearchSettingsPanel() {
         this.showModulePopup(ModuleConstants.QuickSearchModuleId);

package/src/Api/Implementation/StateApiImpl.d.ts

@@ -40,6 +40,7 @@ export declare class StateApiImpl extends ApiBase implements StateApi {
         flushCurrentState?: boolean;
         progressIndicatorLabel?: string;
     }): Promise<void>;
+    persistAdaptableState(): Promise<AdaptableState>;
     getDescriptionForModule(module: AdaptableModule): string;
     getHelpPageForModule(module: AdaptableModule): string;
     getUserStateByStateKey(stateKey: AdaptableStateKey, returnJson?: boolean): BaseState | string;

package/src/Api/Implementation/StateApiImpl.js

@@ -23,6 +23,7 @@ import * as SmartEditRedux from '../../Redux/ActionsReducers/SmartEditRedux';
 import * as ThemeRedux from '../../Redux/ActionsReducers/ThemeRedux';
 import * as ToolPanelRedux from '../../Redux/ActionsReducers/ToolPanelRedux';
 import { logDeprecation } from '../../Utilities/logDeprecation';
+import { buildAdaptableStateFunctionConfig } from '../../Redux/Store/buildAdaptableStateFunctionConfig';
 export class StateApiImpl extends ApiBase {
     configInit() {
         this.dispatchAction(InitState());
@@ -64,11 +65,7 @@ export class StateApiImpl extends ApiBase {
         this.getAdaptableStore()
             .saveStateNow(this._adaptable)
             .then(() => {
-            const promise = clearStateFn({
-                adaptableId: adaptableOptions.adaptableId,
-                adaptableStateKey: adaptableOptions.adaptableStateKey,
-                userName: adaptableOptions.userName,
-            });
+            const promise = clearStateFn(buildAdaptableStateFunctionConfig(this._adaptable));
             promise.then(() => {
                 this.setAdaptableStateKey(adaptableOptions.adaptableStateKey, {
                     initialState: newInitialState || adaptableOptions.initialState,
@@ -164,6 +161,10 @@ export class StateApiImpl extends ApiBase {
             });
         });
     }
+    async persistAdaptableState() {
+        await this.getAdaptableStore().saveStateNow(this._adaptable);
+        return this.getAdaptableStore().getCurrentStorageState();
+    }
     getDescriptionForModule(module) {
         return this._adaptable.ModuleService.getModuleInfoByModule(module).Description;
     }

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

@@ -33,4 +33,5 @@ export declare class ColumnInternalApi extends ApiBase {
     isSpecialColumn(columnId: string, column?: AdaptableColumn): boolean;
     getColumnHeaderName(params: HeaderValueGetterParams): string;
     private buildColumnHeaderContext;
+    getQueryableColumnsForUIEditor(): AdaptableColumn[];
 }

package/src/Api/Internal/ColumnInternalApi.js

@@ -282,4 +282,9 @@ export class ColumnInternalApi extends ApiBase {
         // if nothing matched, we skip this column[group]
         return 'skip';
     }
+    getQueryableColumnsForUIEditor() {
+        return this.getColumnApi()
+            .getQueryableColumns()
+            .filter((column) => !column.isGeneratedPivotResultColumn && !column.isGeneratedRowGroupColumn);
+    }
 }

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

@@ -77,7 +77,7 @@ export declare class FormatColumnInternalApi extends ApiBase {
      * @param scope Scope to check
      */
     getFormatColumnDefsForScope(scope: ColumnScope): AdaptablePredicateDef[];
-    formatColumnWithColumnGroupStateShouldRender(formatColumn: FormatColumn, column: AdaptableColumn): boolean;
+    formatColumnWithColumnGroupScopeShouldRender(formatColumn: FormatColumn, column: AdaptableColumn): boolean;
     /**
      * Checks if format column is relevant for a given cell (intersection of given AdaptableColumn and RowNode)
      *

package/src/Api/Internal/FormatColumnInternalApi.js

@@ -172,8 +172,8 @@ export class FormatColumnInternalApi extends ApiBase {
             .predicateApi.internalApi.getFormatColumnPredicateDefs(scope)
             .filter((predicateDef) => this.getColumnScopeApi().isScopeInScope(scope, predicateDef.columnScope));
     }
-    formatColumnWithColumnGroupStateShouldRender(formatColumn, column) {
-        if (!formatColumn.ColumnGroupState) {
+    formatColumnWithColumnGroupScopeShouldRender(formatColumn, column) {
+        if (!formatColumn.ColumnGroupScope) {
             return true;
         }
         const agGridApi = this.getAdaptableApi().agGridApi;
@@ -187,7 +187,7 @@ export class FormatColumnInternalApi extends ApiBase {
         if (!columnGroupParentForCurrentColumn) {
             return false;
         }
-        const columnGroupState = columnGroupParentForCurrentColumn.isExpanded()
+        const columnGroupScope = columnGroupParentForCurrentColumn.isExpanded()
             ? 'Expanded'
             : 'Collapsed';
         const columnGroupLeafColumns = columnGroupParentForCurrentColumn.getLeafColumns();
@@ -195,13 +195,13 @@ export class FormatColumnInternalApi extends ApiBase {
             columnGroupLeafColumns.length === 1 &&
             columnGroupLeafColumns[0] === agGridColumn;
         if (columnIsTopLevel) {
-            // for top-level columns don't apply formatColumns that have an explicit ColumnGroupState defined
+            // for top-level columns don't apply formatColumns that have an explicit ColumnGroupScope defined
             return false;
         }
-        if (formatColumn.ColumnGroupState === 'Both') {
+        if (formatColumn.ColumnGroupScope === 'Both') {
             return true;
         }
-        return formatColumn.ColumnGroupState === columnGroupState;
+        return formatColumn.ColumnGroupScope === columnGroupScope;
     }
     /**
      * Checks if format column is relevant for a given cell (intersection of given AdaptableColumn and RowNode)
@@ -233,8 +233,8 @@ export class FormatColumnInternalApi extends ApiBase {
                 return false;
             }
         }
-        if (formatColumn.ColumnGroupState &&
-            !this.formatColumnWithColumnGroupStateShouldRender(formatColumn, column)) {
+        if (formatColumn.ColumnGroupScope &&
+            !this.formatColumnWithColumnGroupScopeShouldRender(formatColumn, column)) {
             return false;
         }
         if (!formatColumn.Rule) {

package/src/Api/QuickSearchApi.d.ts

@@ -32,7 +32,7 @@ export interface QuickSearchApi {
     /**
      *  Retrieves current Quick Search style
      */
-    getQuickSearchStyle(): AdaptableStyle;
+    getQuickSearchCellMatchStyle(): AdaptableStyle;
     /**
      * Retrieves the style for the text match in the Quick Search
      */
@@ -45,7 +45,7 @@ export interface QuickSearchApi {
      * Sets style for Quick Search; can be name of (a provided) css style
      * @param style the style to use
      */
-    setQuickSearchStyle(style: AdaptableStyle): void;
+    setQuickSearchCellMatchStyle(style: AdaptableStyle): void;
     /**
      * Opens Settings Panel with Quick Search section selected and visible
      */

package/src/Api/StateApi.d.ts

@@ -210,4 +210,13 @@ export interface StateApi {
      * @param module Module which is Ready
      */
     dispatchStateReadyAction(module: AdaptableModule): void;
+    /**
+     * Persists the current Adaptable State to storage.
+     *
+     * This method first calls StateOption.saveState() to prepare the state
+     * and then StateOptions.persistState() to save it to the configured storage.
+     *
+     * @returns Promise<AdaptableState> - A promise that resolves to the persisted state
+     */
+    persistAdaptableState(): Promise<AdaptableState>;
 }

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

@@ -8,7 +8,7 @@ export declare const QUICK_SEARCH_RUN = "QUICK_SEARCH_RUN";
 /**
  * @ReduxAction Sets Quick Search style
  */
-export declare const QUICK_SEARCH_SET_STYLE = "QUICK_SEARCH_SET_STYLE";
+export declare const QUICK_SEARCH_SET_CELL_MATCHING_STYLE = "QUICK_SEARCH_SET_CELL_MATCHING_STYLE";
 /**
  * @ReduxAction Quick Search Module is ready
  */
@@ -16,13 +16,13 @@ export declare const QUICK_SEARCH_READY = "QUICK_SEARCH_READY";
 export interface QuickSearchRunAction extends Redux.Action {
     quickSearchText: string;
 }
-export interface QuickSearchSetStyleAction extends Redux.Action {
-    style: AdaptableStyle;
+export interface QuickSearchSetMatchingCellStyleAction extends Redux.Action {
+    matchingCellStyle: AdaptableStyle;
 }
 export interface QuickSearchReadyAction extends Redux.Action {
     quickSearchState: QuickSearchState;
 }
 export declare const QuickSearchRun: (quickSearchText: string) => QuickSearchRunAction;
-export declare const QuickSearchSetStyle: (style: AdaptableStyle) => QuickSearchSetStyleAction;
+export declare const QuickSearchSetCellMatchingStyle: (matchingCellStyle: AdaptableStyle) => QuickSearchSetMatchingCellStyleAction;
 export declare const QuickSearchReady: (quickSearchState: QuickSearchState) => QuickSearchReadyAction;
 export declare const QuickSearchReducer: Redux.Reducer<QuickSearchState>;

package/src/Redux/ActionsReducers/QuickSearchRedux.js

@@ -7,7 +7,7 @@ export const QUICK_SEARCH_RUN = 'QUICK_SEARCH_RUN';
 /**
  * @ReduxAction Sets Quick Search style
  */
-export const QUICK_SEARCH_SET_STYLE = 'QUICK_SEARCH_SET_STYLE';
+export const QUICK_SEARCH_SET_CELL_MATCHING_STYLE = 'QUICK_SEARCH_SET_CELL_MATCHING_STYLE';
 /**
  * @ReduxAction Quick Search Module is ready
  */
@@ -16,9 +16,9 @@ export const QuickSearchRun = (quickSearchText) => ({
     type: QUICK_SEARCH_RUN,
     quickSearchText,
 });
-export const QuickSearchSetStyle = (style) => ({
-    type: QUICK_SEARCH_SET_STYLE,
-    style,
+export const QuickSearchSetCellMatchingStyle = (matchingCellStyle) => ({
+    type: QUICK_SEARCH_SET_CELL_MATCHING_STYLE,
+    matchingCellStyle: matchingCellStyle,
 });
 export const QuickSearchReady = (quickSearchState) => ({
     type: QUICK_SEARCH_READY,
@@ -26,7 +26,7 @@ export const QuickSearchReady = (quickSearchState) => ({
 });
 const initialState = {
     QuickSearchText: EMPTY_STRING,
-    Style: {
+    CellMatchStyle: {
         BackColor: QUICK_SEARCH_DEFAULT_BACK_COLOR,
         ForeColor: QUICK_SEARCH_DEFAULT_FORE_COLOR,
     },
@@ -37,9 +37,9 @@ export const QuickSearchReducer = (state = initialState, action) => {
             return Object.assign({}, state, {
                 QuickSearchText: action.quickSearchText,
             });
-        case QUICK_SEARCH_SET_STYLE:
+        case QUICK_SEARCH_SET_CELL_MATCHING_STYLE:
             return Object.assign({}, state, {
-                Style: action.style,
+                CellMatchStyle: action.matchingCellStyle,
             });
         default:
             return state;

package/src/Redux/Store/AdaptableReduxLocalStorageEngine.js

@@ -1,6 +1,7 @@
 import debounce from 'lodash/debounce';
 import { MergeStateFunction } from './AdaptableReduxMerger';
 import { AdaptableLogger } from '../../agGrid/AdaptableLogger';
+import { buildAdaptableStateFunctionConfig } from './buildAdaptableStateFunctionConfig';
 const checkStatus = (response) => {
     const error = new Error(response.statusText);
     if (response.status >= 200 && response.status < 300) {
@@ -42,12 +43,8 @@ class AdaptableReduxLocalStorageEngine {
     setStateKey(adaptableStateKey) {
         this.adaptableStateKey = adaptableStateKey;
     }
-    load(initialState = this.initialState) {
-        return (this.loadState || loadState)({
-            adaptableId: this.adaptableId,
-            adaptableStateKey: this.adaptableStateKey,
-            userName: this.userName,
-        }).then((parsedJsonState) => {
+    load(adaptableInstance, initialState = this.initialState) {
+        return (this.loadState || loadState)(buildAdaptableStateFunctionConfig(adaptableInstance)).then((parsedJsonState) => {
             // we need to merge the Initial Adaptable State
             return Promise.resolve(initialState)
                 .then((parsedInitialState) => {
@@ -56,20 +53,19 @@ class AdaptableReduxLocalStorageEngine {
                 .catch((err) => AdaptableLogger.consoleErrorBase(`AdaptableId: ${this.adaptableId}`, err));
         });
     }
-    save(state, getState) {
-        return this.saveNow(state, getState);
+    save(adaptableInstance, state, actionName) {
+        return this.saveNow(adaptableInstance, state, actionName);
     }
-    saveNow(state, getState) {
-        const config = {
-            adaptableId: this.adaptableId,
-            adaptableStateKey: this.adaptableStateKey,
-            userName: this.userName,
-        };
-        let result = state;
-        if (getState) {
-            result = getState(state, config);
+    saveNow(adaptableInstance, state, actionName) {
+        const config = buildAdaptableStateFunctionConfig(adaptableInstance);
+        config.actionName = actionName;
+        config.previousState = adaptableInstance.adaptableStore.getPreviousStorageState() || null;
+        let stateObject = structuredClone(state);
+        const getTransformedState = adaptableInstance.adaptableOptions.stateOptions.saveState;
+        if (getTransformedState) {
+            stateObject = getTransformedState(stateObject, config);
         }
-        const promise = (this.persistState || persistState)(result, config)?.catch(rejectWithMessage);
+        const promise = (this.persistState || persistState)(stateObject, config)?.catch(rejectWithMessage);
         if (!(promise instanceof Promise)) {
             AdaptableLogger.consoleWarnBase(`AdaptableId: ${this.adaptableId}`, 'stateOptions.persistState should return a promise, it returned', 'Error', promise);
         }

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

@@ -26,6 +26,7 @@ export declare class AdaptableStore implements IAdaptableStore {
     private emitter;
     private storageEngine;
     private currentStorageState?;
+    private previousStorageState?;
     private loadStorageInProgress;
     private loadStateOnStartup;
     on: (eventName: string, callback: EmitterCallback) => (() => void);
@@ -39,6 +40,7 @@ export declare class AdaptableStore implements IAdaptableStore {
     constructor(adaptable: IAdaptable);
     destroy(): void;
     getCurrentStorageState(): AdaptableState;
+    getPreviousStorageState(): AdaptableState;
     saveStateNow(adaptable: IAdaptable): Promise<any>;
     loadStore: (config: LoadStoreConfig) => Promise<any>;
 }

package/src/Redux/Store/AdaptableStore.js

@@ -39,6 +39,7 @@ import * as TeamSharingRedux from '../ActionsReducers/TeamSharingRedux';
 import * as ThemeRedux from '../ActionsReducers/ThemeRedux';
 import * as ToolPanelRedux from '../ActionsReducers/ToolPanelRedux';
 import { isAdaptableSharedEntity, isCustomSharedEntity, } from '../../AdaptableState/TeamSharingState';
+import { buildAdaptableStateFunctionConfig } from './buildAdaptableStateFunctionConfig';
 export const INIT_STATE = 'INIT_STATE';
 export const LOAD_STATE = 'LOAD_STATE';
 const NON_PERSIST_ACTIONS = {
@@ -91,10 +92,10 @@ export class AdaptableStore {
             // START STATE LOAD
             this.loadStorageInProgress = true;
             return (this.Load = this.storageEngine
-                .load(initialState)
+                .load(adaptable, initialState)
                 .then((storedState) => {
                 if (storedState && this.loadStateOnStartup) {
-                    this.TheStore.dispatch(LoadState(postProcessState(adaptable.adaptableOptions.stateOptions.applyState(storedState))));
+                    this.TheStore.dispatch(LoadState(postProcessState(adaptable.adaptableOptions.stateOptions.applyState(storedState, buildAdaptableStateFunctionConfig(adaptable)))));
                 }
             })
                 .then(() => {
@@ -218,7 +219,11 @@ export class AdaptableStore {
                     delete storageState[key];
                 });
                 this.currentStorageState = storageState;
-                storageEngine.save(storageState, adaptable.adaptableOptions.stateOptions.saveState);
+                this.previousStorageState = { ...state };
+                NON_PERSISTENT_STORE_KEYS.forEach((key) => {
+                    delete this.previousStorageState[key];
+                });
+                storageEngine.save(adaptable, storageState, action.type);
             }
             return finalState;
         };
@@ -242,10 +247,13 @@ export class AdaptableStore {
     getCurrentStorageState() {
         return this.currentStorageState;
     }
+    getPreviousStorageState() {
+        return this.previousStorageState;
+    }
     saveStateNow(adaptable) {
         const storageState = this.getCurrentStorageState();
         if (storageState) {
-            return this.storageEngine.saveNow(storageState, adaptable.adaptableOptions.stateOptions.saveState);
+            return this.storageEngine.saveNow(adaptable, storageState, 'API_CALL_SAVE_STATE');
         }
         return Promise.resolve(true);
     }
@@ -458,7 +466,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                  * Use Case: We have updated an AdapTable Module that affects rendering
                  * Action: We set up all columns again
                  */
-                case QuickSearchRedux.QUICK_SEARCH_SET_STYLE:
+                case QuickSearchRedux.QUICK_SEARCH_SET_CELL_MATCHING_STYLE:
                 case FormatColumnRedux.FORMAT_COLUMN_ADD:
                 case FormatColumnRedux.FORMAT_COLUMN_EDIT:
                 case FormatColumnRedux.FORMAT_COLUMN_DELETE:

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

@@ -13,6 +13,7 @@ export interface IAdaptableStore {
     Load: Promise<any>;
     loadStore: (config: LoadStoreConfig) => Promise<any>;
     getCurrentStorageState: () => AdaptableState | void;
+    getPreviousStorageState: () => AdaptableState | void;
     saveStateNow: (adaptable: IAdaptable) => Promise<any>;
     on: (eventName: string, callback: (data?: any) => any) => () => void;
     onAny: (callback: (eventName: string, data?: any) => any) => () => void;

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

@@ -1,9 +1,9 @@
-import { AdaptableSaveStateFunction } from '../../../AdaptableOptions/StateOptions';
 import { AdaptableState } from '../../../AdaptableState/AdaptableState';
 import { InitialState } from '../../../AdaptableState/InitialState';
+import { IAdaptable } from '../../../AdaptableInterfaces/IAdaptable';
 export default interface IStorageEngine {
-    load(initialState?: string | InitialState): Promise<any>;
-    save(state: AdaptableState, getEnhancedState?: AdaptableSaveStateFunction): Promise<any>;
-    saveNow(state: AdaptableState, getEnhancedState?: AdaptableSaveStateFunction): Promise<any>;
+    load(adaptable: IAdaptable, initialState?: string | InitialState): Promise<any>;
+    save(adaptable: IAdaptable, state: AdaptableState, actionName: string): Promise<any>;
+    saveNow(adaptable: IAdaptable, state: AdaptableState, actionName: string): Promise<any>;
     setStateKey(stateKey: string): void;
 }

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

@@ -0,0 +1,3 @@
+import { AdaptableStateFunctionConfig } from '../../AdaptableOptions/StateOptions';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+export declare function buildAdaptableStateFunctionConfig(adaptable: IAdaptable): AdaptableStateFunctionConfig;

package/src/Redux/Store/buildAdaptableStateFunctionConfig.js

@@ -0,0 +1,9 @@
+export function buildAdaptableStateFunctionConfig(adaptable) {
+    return {
+        adaptableId: adaptable.adaptableOptions.adaptableId,
+        adaptableStateKey: adaptable.adaptableOptions.adaptableStateKey,
+        userName: adaptable.adaptableOptions.userName,
+        adaptableApi: adaptable.api,
+        adaptableContext: adaptable.api?.optionsApi?.getAdaptableContext(),
+    };
+}

package/src/Utilities/ExpressionFunctions/observableExpressionFunctions.js

@@ -291,7 +291,7 @@ const getDataChangedInfoStub = (context) => {
     const rowNode = rowNodeStub;
     if (rowNode) {
         const primaryKeyValue = context.adaptableApi.gridApi.getPrimaryKeyValueForRowNode(rowNode);
-        const columnId = context.adaptableApi.columnApi.getQueryableColumns()[0]?.columnId;
+        const columnId = context.adaptableApi.columnApi.internalApi.getQueryableColumnsForUIEditor()[0]?.columnId;
         const oldValue = context.adaptableApi.gridApi.getCellRawValue(primaryKeyValue, columnId);
         const column = context.adaptableApi.columnApi.getColumnWithColumnId(columnId);
         const newValue = oldValue;

package/src/Utilities/Helpers/StyleHelper.d.ts

@@ -1,5 +1,5 @@
 import { AdaptableStyle } from '../../types';
-export declare const AgGridCellStyleProperties: readonly ["backgroundColor", "color", "fontWeight", "fontStyle", "fontSize", "borderColor"];
+export declare const AgGridCellStyleProperties: readonly ["backgroundColor", "color", "fontWeight", "fontStyle", "fontSize", "borderColor", "--ab-dynamic-background-color", "--ab-dynamic-color", "--ab-dynamic-font-weight", "--ab-dynamic-font-style", "--ab-dynamic-font-size", "--ab-dynamic-text-decoration", "--ab-dynamic-border-radius", "--ab-dynamic-border-color"];
 export declare const normalizeStyleForAgGrid: (style: Record<string, any>) => {
     [x: string]: any;
 };

package/src/Utilities/Helpers/StyleHelper.js

@@ -7,6 +7,17 @@ export const AgGridCellStyleProperties = [
     'fontStyle',
     'fontSize',
     'borderColor',
+    // needed for quick search
+    // as otherwise, the currentTextMatchStyle is not removed correctly
+    // from the cell when looping through the values, and the cell is no longer the current match
+    '--ab-dynamic-background-color',
+    '--ab-dynamic-color',
+    '--ab-dynamic-font-weight',
+    '--ab-dynamic-font-style',
+    '--ab-dynamic-font-size',
+    '--ab-dynamic-text-decoration',
+    '--ab-dynamic-border-radius',
+    '--ab-dynamic-border-color',
 ];
 // see https://github.com/AdaptableTools/adaptable/issues/2119
 // since v29 AG Grid ignores style properties with null or undefined values