@adaptabletools/adaptable 24.0.0-canary.1 → 24.0.0-canary.10

package/src/Api/StyledColumnApi.d.ts

@@ -2,11 +2,12 @@ import type { AgChartInstance, AgSparklineOptions } from 'ag-charts-types';
 import { AdaptableColumn } from '../AdaptableState/Common/AdaptableColumn';
 import { StyledColumn, StyledColumnState } from '../AdaptableState/StyledColumnState';
 /**
- * Provides run-time access to Styled Column Module and associated state
+ * Styled Columns: badges, bars, sparklines and the other styles AdapTable draws in a cell.
  */
 export interface StyledColumnApi {
     /**
      * Retrieves Styled Column section from Adaptable State
+     * @returns Styled Column section from Adaptable State
      */
     getStyledColumnState(): StyledColumnState;
     /**
@@ -28,7 +29,7 @@ export interface StyledColumnApi {
     getStyledColumnByName(name: StyledColumn['Name']): StyledColumn | undefined;
     /**
      * Retrieves Styled Column for given Column Id
-     * @param columnId Styled Column id
+     * @param columnId Column the Styled Column is drawn in
      * @returns Styled Column
      */
     getStyledColumnForColumnId(columnId: StyledColumn['ColumnId']): StyledColumn;
@@ -43,13 +44,14 @@ export interface StyledColumnApi {
      */
     getSuspendedStyledColumns(): StyledColumn[];
     /**
-     * Delete a Styled column
-     * @param styledColumn
+     * Deletes a Styled Column from state.
+     * @param styledColumn Styled Column to delete
      */
     deleteStyledColumn(styledColumn: StyledColumn): void;
     /**
      * Edits a Styled Column
      * @param styledColumn Styled Column to edit
+     * @returns The Styled Column after it is saved
      */
     editStyledColumn(styledColumn: StyledColumn): StyledColumn;
     /**
@@ -57,18 +59,18 @@ export interface StyledColumnApi {
      */
     deleteAllStyledColumns(): void;
     /**
-     * Create a Styled column
-     * @param styledColumn
+     * Adds a Styled Column to state.
+     * @param styledColumn Styled Column to add
      */
     addStyledColumn(styledColumn: StyledColumn): void;
     /**
-     * Suspends an active Styled Column
-     * @param styledColumn
+     * Suspends an active Styled Column so its style is no longer drawn.
+     * @param styledColumn Styled Column to suspend
      */
     suspendStyledColumn(styledColumn: StyledColumn): void;
     /**
-     * Activates a suspended Styled Column
-     * @param styledColumn
+     * Activates a suspended Styled Column so its style is drawn again.
+     * @param styledColumn Styled Column to activate
      */
     unSuspendStyledColumn(styledColumn: StyledColumn): void;
     /**
@@ -82,31 +84,37 @@ export interface StyledColumnApi {
     /**
      * Checks whether Column with given `columnId` has a PercentBar Style applied
      * @param columnId column ID
+     * @returns `true` when the column has a Percent Bar style
      */
     hasPercentBarStyle(columnId: string): boolean;
     /**
      * Checks whether Column with given `columnId` has a Gradient Style applied
      * @param columnId column ID
+     * @returns `true` when the column has a Gradient style
      */
     hasGradientStyle(columnId: string): boolean;
     /**
      * Checks whether Column with given `columnId` has a Bullet Chart Style applied
      * @param columnId column ID
+     * @returns `true` when the column has a Bullet Chart style
      */
     hasBulletChartStyle(columnId: string): boolean;
     /**
      * Checks whether Column with given `columnId` has a Rating Style applied
      * @param columnId column ID
+     * @returns `true` when the column has a Rating style
      */
     hasRatingStyle(columnId: string): boolean;
     /**
-     * Checks whether Column is a Sparkline Column
-     * @param columnId column ID
+     * Whether this column is drawn as a sparkline.
+     * @param column Column to check
+     * @returns `true` when this column is drawn as a sparkline
      */
     isSparklineStyleStyledColumn(column: AdaptableColumn): boolean;
     /**
      * Returns a Styled Column for a given column
      * @param column Column to check
+     * @returns A Styled Column for a given column
      */
     getActiveStyledColumnForColumn(column: AdaptableColumn): StyledColumn | undefined;
     /**
@@ -115,6 +123,7 @@ export interface StyledColumnApi {
     openStyledColumnSettingsPanel(): void;
     /**
      * Can this AdapTable instance display Sparklines (e.g. is AG Grid SparklinesModule installed)
+     * @returns `true` when this instance can draw sparklines
      */
     canDisplaySparklines(): boolean;
     /**
@@ -128,6 +137,8 @@ export interface StyledColumnApi {
      * The caller owns the returned instance and is responsible for its lifecycle: call `update()` to
      * re-render it when the data or options change, and `destroy()` to dispose of it (e.g. when the
      * `container` is removed) to avoid memory leaks. AdapTable does not track or clean it up for you.
+     * @param options Where to render and what to plot. `container` and `data` are required
+     * @returns Renders a standalone [Sparkline](https://www.ag-grid.com/javascript-data-grid/sparklines-overview/) into a DOM element you provide, using the same AG Charts engine as Sparkline Styled Columns. Provide at least `container` (where to render) and `data` (what to plot) on `options`; see [AgSparklineOptions](https://www.ag-grid.com/javascript-data-grid/sparklines-overview/) for the full set (`type`, `width`/`height`, `min`/`max`, etc.). The caller owns the returned instance and is responsible for its lifecycle: call `update()` to re-render it when the data or options change, and `destroy()` to dispose of it (e.g. when the `container` is removed) to avoid memory leaks. AdapTable does not track or clean it up for you
      */
     renderSparkline(options: AgSparklineOptions): AgChartInstance<AgSparklineOptions> | null;
 }

package/src/Api/SystemStatusApi.d.ts

@@ -4,23 +4,34 @@ import { SystemStatusMessageInfo } from '../AdaptableState/Common/SystemStatusMe
  */
 export interface SystemStatusApi {
     /**
-     * Sets a new System Status message; appears in System Status toolbar, tool panel (and popup).
+     * Sets the System Status message shown in the System Status toolbar, tool panel and popup.
+     * @param statusMessage Text of the message
+     * @param messageType `Success`, `Info`, `Warning` or `Error`. Sets the colour of the message
+     * @param statusFurtherInformation Optional longer text shown with the message
      */
     setSystemStatus(statusMessage: string, messageType: 'Success' | 'Info' | 'Warning' | 'Error', statusFurtherInformation?: string): void;
     /**
-     * Sets an **Error** System Status Message
+     * Sets an Error System Status message.
+     * @param statusMessage Text of the message
+     * @param furtherInformation Optional longer text shown with the message
      */
     setErrorSystemStatus(statusMessage: string, furtherInformation?: string): void;
     /**
-     * Sets a **Warning** System Status Message
+     * Sets a Warning System Status message.
+     * @param statusMessage Text of the message
+     * @param furtherInformation Optional longer text shown with the message
      */
     setWarningSystemStatus(statusMessage: string, furtherInformation?: string): void;
     /**
-     * Sets a **Success** System Status Message
+     * Sets a Success System Status message.
+     * @param statusMessage Text of the message
+     * @param furtherInformation Optional longer text shown with the message
      */
     setSuccessSystemStatus(statusMessage: string, furtherInformation?: string): void;
     /**
-     * Sets an **Info** System Status Message
+     * Sets an Info System Status message.
+     * @param statusMessage Text of the message
+     * @param furtherInformation Optional longer text shown with the message
      */
     setInfoSystemStatus(statusMessage: string, furtherInformation?: string): void;
     /**
@@ -28,7 +39,8 @@ export interface SystemStatusApi {
      */
     openSystemStatusSettingsPanel(): void;
     /**
-     * Retrieves current System Status Message
+     * The System Status message currently on display.
+     * @returns The current message, or `undefined` when none is set
      */
     getCurrentSystemStatusMessageInfo(): SystemStatusMessageInfo | undefined;
     /**

package/src/Api/TeamSharingApi.d.ts

@@ -2,25 +2,29 @@ import { AdaptableObject } from '../AdaptableState/Common/AdaptableObject';
 import { AdaptableSharedEntity, CustomSharedEntity, CustomSharedEntityConfig, SharedEntity } from '../AdaptableState/TeamSharingState';
 import { AdaptableModule, AdaptableSharedEntityConfig } from '../types';
 /**
- * Provides run-time access to Team Sharing Module and associated state
+ * Team Sharing: load shared objects, share an object, and import an entry someone else shared.
  */
 export interface TeamSharingApi {
     /**
      * Retrieves all currently shared entities; async operation leveraging `TeamSharingOptions.loadSharedEntities(...)` method
+     * @returns All currently shared entities; async operation leveraging `TeamSharingOptions.loadSharedEntities(...)` method
      */
     loadSharedEntities(): Promise<SharedEntity[]>;
     /**
      * Sets currently shared entities; async operation leveraging `TeamSharingOptions.persistSharedEntities(...)` method
      * @param sharedEntities the shared entities
      * @return either TRUE if the shared entities were successfully set or FALSE if the shared entities were not set
+     * @returns `true` after the entities are saved. `false` when Team Sharing is not available
      */
     persistSharedEntities(sharedEntities: SharedEntity[]): Promise<boolean>;
     /**
      * Whether Team Sharing is available to use
+     * @returns `true` when Team Sharing is available to use
      */
     isTeamSharingAvailable(): boolean;
     /**
      * Whether current user has full Team Sharing rights (for creating & updating shared items)
+     * @returns `true` when current user has full Team Sharing rights (for creating & updating shared items)
      */
     hasTeamSharingFullRights(): boolean;
     /**
@@ -57,14 +61,17 @@ export interface TeamSharingApi {
     importSharedEntry(sharedEntity: SharedEntity): void;
     /**
      * Retrieves all locally loaded shared entries (`AdaptableSharedEntity` & `CustomSharedEntity`).
+     * @returns All locally loaded shared entries (`AdaptableSharedEntity` & `CustomSharedEntity`)
      */
     getLoadedSharedEntities(): SharedEntity[];
     /**
      * Retrieves locally loaded Adaptable Shared Entries.
+     * @returns Locally loaded Adaptable Shared Entries
      */
     getLoadedAdaptableSharedEntities(): AdaptableSharedEntity[];
     /**
      * Retrieves locally loaded Custom Shared Entries.
+     * @returns Locally loaded Custom Shared Entries
      */
     getLoadedCustomSharedEntities(): CustomSharedEntity[];
     /**

package/src/Api/ThemeApi.d.ts

@@ -1,10 +1,11 @@
 import { AdaptableTheme, SystemThemeEntry, ThemeState } from '../AdaptableState/ThemeState';
 /**
- * Provides run-time access to the Theme Module and associated state
+ * The theme currently applied, and the system and user themes in state.
  */
 export interface ThemeApi {
     /**
      * Retrieves Theme section from Adaptable State
+     * @returns Theme section from Adaptable State
      */
     getThemeState(): ThemeState;
     /**
@@ -26,14 +27,17 @@ export interface ThemeApi {
     loadDarkTheme(): void;
     /**
      * Retrieves name of Current Theme
+     * @returns Name of Current Theme
      */
     getCurrentTheme(): string;
     /**
      * Retrieves the current theme object
+     * @returns The current theme object
      */
     getCurrentThemeObject(): AdaptableTheme;
     /**
-     * Edits an existing theme
+     * Replaces a theme already in state.
+     * @param theme Theme to save
      */
     editTheme(theme: AdaptableTheme): void;
     /**
@@ -50,33 +54,37 @@ export interface ThemeApi {
      */
     setUserThemes(userThemes: AdaptableTheme[]): void;
     /**
-     * Adds a User Theme to State
-     * @param theme
+     * Adds a user theme to state.
+     * @param theme Theme to add
      * @deprecated Will be removed in the next major version.
      */
     addUserTheme(theme: AdaptableTheme): void;
     /**
-     * Deletes a User Theme from State
-     * @param theme
+     * Removes a user theme from state.
+     * @param theme Theme to delete
      * @deprecated Will be removed in the next major version.
      */
     deleteUserTheme(theme: AdaptableTheme): void;
     /**
      * Retrieves System Themes in State
+     * @returns System Themes in State
      */
     getSystemThemes(): AdaptableTheme[];
     /**
      * Retrieves User Themes in State
      * @deprecated Will be removed in the next major version.
+     * @returns User Themes in State
      */
     getUserThemes(): AdaptableTheme[];
     /**
      * Retrieves all Themes (both System &  User) in State
+     * @returns All Themes (both System & User) in State
      */
     getThemes(): AdaptableTheme[];
     /**
-     * Retrieves a Theme by name
-     * @param themeName
+     * A theme looked up by name, system or user.
+     * @param themeName Name of the theme
+     * @returns A theme looked up by name, system or user
      */
     getThemeByName(themeName: string): AdaptableTheme;
     /**
@@ -87,6 +95,7 @@ export interface ThemeApi {
      * Get the name of the current AG Grid theme
      *
      * @deprecated required only for legacy AG Grid themes, see https://www.ag-grid.com/javascript-data-grid/theming-v32/
+     * @returns The name of the current AG Grid theme
      */
     getAgGridCurrentThemeName(): string;
 }

package/src/Api/ToolPanelApi.d.ts

@@ -8,6 +8,7 @@ import { AdaptableModuleButtons, AdaptableToolPanel } from '../AdaptableState/Co
 export interface ToolPanelApi {
     /**
      * Retrieves Tool Panel section from Tool Panel State
+     * @returns Tool Panel section from Tool Panel State
      */
     getToolPanelState(): ToolPanelState;
     /**
@@ -24,27 +25,30 @@ export interface ToolPanelApi {
     closeAdapTableToolPanel(): void;
     /**
      * Retrieves all Custom Tool Panels defined in ToolPanelOptions
+     * @returns All Custom Tool Panels defined in ToolPanelOptions
      */
     getCustomToolPanels(): CustomToolPanel[];
     /**
      * Retrieves all Custom Tool Panel Buttons defined in ToolPanelOptions
+     * @returns All Custom Tool Panel Buttons defined in ToolPanelOptions
      */
     getCustomToolPanelButtons(): AdaptableButton<ToolPanelButtonContext>[];
     /**
      * Retrieves the CustomToolPanel with the given name (or undefined if no match is found)
      * @param name the CustomToolPanel name
+     * @returns The CustomToolPanel with the given name (or undefined if no match is found)
      */
     getCustomToolPanelByName(name: string): CustomToolPanel | undefined;
     /**
-     * Sets the given Adaptable ToolPanel with the provided visibilityMode (expanded / collapsed)
-     * @param adaptableToolPanel
-     * @param visibilityMode
+     * Expands or collapses one of the AdapTable tool panels.
+     * @param adaptableToolPanel Which AdapTable tool panel
+     * @param visibilityMode `'expanded'` or `'collapsed'`
      */
     setAdaptableToolPanelVisibilityMode(adaptableToolPanel: AdaptableToolPanel, visibilityMode: ToolPanelVisibilityMode): void;
     /**
-     * Sets the Custom ToolPanel with the given name with the provided visibilityMode (expanded / collapsed)
-     * @param customToolPanelName
-     * @param visibilityMode
+     * Expands or collapses a custom tool panel.
+     * @param customToolPanelName Name of the custom tool panel
+     * @param visibilityMode `'expanded'` or `'collapsed'`
      */
     setCustomToolPanelVisibilityMode(customToolPanelName: string, visibilityMode: ToolPanelVisibilityMode): void;
     /**
@@ -53,7 +57,8 @@ export interface ToolPanelApi {
      */
     setModuleButtons(moduleButtons: AdaptableModuleButtons): void;
     /**
-     * Sets the Module buttons from the Adaptable ToolPanel
+     * The module buttons currently shown in the AdapTable tool panel.
+     * @returns The module buttons currently shown in the AdapTable tool panel
      */
     getModuleButtons(): AdaptableModuleButtons;
 }

package/src/Api/UserInterfaceApi.d.ts

@@ -5,41 +5,44 @@ import { CustomWindowConfig } from '../AdaptableState/Common/CustomWindowConfig'
 import { ProgressIndicatorConfig } from '../AdaptableState/Common/ProgressIndicatorConfig';
 import { UserInterfaceState } from '../AdaptableState/UserInterfaceState';
 /**
- * Functions relating to User Interface section of Adaptable State
+ * Icons, editable and read-only styles, the progress indicator, custom windows, and showing or hiding the UI.
  */
 export interface UserInterfaceApi {
-    /**
-     * Retrieves Color Palette currently being used
-     */
-    getColorPalette(): string[];
     /**
      * Retrieves Custom Icons provided by users
+     * @returns Custom Icons provided by users
      */
     getCustomIcons(): CustomIcon[];
     /**
      * Retrieves any Style Class Names from User Interface Options
+     * @returns Any Style Class Names from User Interface Options
      */
     getStyleClassNames(): string[] | undefined;
     /**
      * Returns Style set for Editable cells
+     * @returns Style set for Editable cells
      */
     getEditableCellStyle(): AdaptableStyle | undefined;
     /**
      * Returns Style for Cells that have been edited
+     * @returns Style for Cells that have been edited
      */
     getEditedCellStyle(): AdaptableStyle | undefined;
     /**
      * Returns Style set for ReadOnly Cells
+     * @returns Style set for ReadOnly Cells
      */
     getReadOnlyCellStyle(): AdaptableStyle | undefined;
     /**
      * Retrieves any Object Tags (provided in User Interface Options)
+     * @returns Any Object Tags (provided in User Interface Options)
      */
     getAdaptableObjectTags(): AdaptableObjectTag[] | undefined;
     /**
      * Retrieves all objects in list which contain the given Tag
      * @param tag Tag to check
      * @param adaptableModule optional Module to check
+     * @returns All objects in list which contain the given Tag
      */
     getAdaptableObjectsWithTag(tag: AdaptableObjectTag, adaptableModule?: AdaptableModule): AdaptableObject[] | undefined;
     /**
@@ -81,10 +84,12 @@ export interface UserInterfaceApi {
     closeCustomWindowPopup(windowId: string): void;
     /**
      * Retrieves the current User Interface State
+     * @returns The current User Interface State
      */
     getUserInterfaceState(): UserInterfaceState;
     /**
      * Returns whether the AdapTable UI is currently visible
+     * @returns `true` when the AdapTable UI is currently visible
      */
     isAdaptableUIVisible(): boolean;
     /**

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

@@ -4,7 +4,7 @@ import { LayoutState, Layout } from '../../AdaptableState/LayoutState';
 import { ColumnFilter } from '../../types';
 import { LayoutExtensionInfo, LayoutExtensionModule } from '../../AdaptableState/Common/ExtendedLayout';
 /**
- * @ReduxAction Layout Module is ready
+ * @ReduxAction Layout Module is ready — fired once after AdapTable starts, for the Layout that is already current
  */
 export declare const LAYOUT_READY = "LAYOUT_READY";
 /**
@@ -20,11 +20,11 @@ export declare const LAYOUT_EDIT = "LAYOUT_EDIT";
  */
 export declare const LAYOUT_DELETE = "LAYOUT_DELETE";
 /**
- * @ReduxAction A Layout has been selected
+ * @ReduxAction A different Layout has been selected
  */
 export declare const LAYOUT_SELECT = "LAYOUT_SELECT";
 /**
- * @ReduxAction A Layout has been (auto)saved
+ * @ReduxAction A Layout has been saved, including auto-save after grid edits (sort, grouping, columns, and so on)
  */
 export declare const LAYOUT_SAVE = "LAYOUT_SAVE";
 /**

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

@@ -1,10 +1,6 @@
 import * as Redux from 'redux';
 import { QuickSearchState } from '../../AdaptableState/QuickSearchState';
 import { AdaptableStyle } from '../../AdaptableState/Common/AdaptableStyle';
-export declare const QUICK_SEARCH_DEFAULT_CELL_MATCH_STYLE: {
-    BackColor: string;
-    ForeColor: string;
-};
 export declare const QUICK_SEARCH_DEFAULT_TEXT_MATCH_STYLE: {
     BackColor: string;
     ForeColor: string;
@@ -18,6 +14,10 @@ export declare const QUICK_SEARCH_DEFAULT_CURRENT_TEXT_MATCH_STYLE: {
  * @ReduxAction Runs Quick Search
  */
 export declare const QUICK_SEARCH_RUN = "QUICK_SEARCH_RUN";
+/**
+ * @ReduxAction Clears Quick Search text
+ */
+export declare const QUICK_SEARCH_CLEAR = "QUICK_SEARCH_CLEAR";
 /**
  * @ReduxAction Sets Quick Search whole-cell style (SSRM / legacy)
  */
@@ -37,6 +37,8 @@ export declare const QUICK_SEARCH_READY = "QUICK_SEARCH_READY";
 export interface QuickSearchRunAction extends Redux.Action {
     quickSearchText: string;
 }
+export interface QuickSearchClearAction extends Redux.Action {
+}
 export interface QuickSearchSetMatchingCellStyleAction extends Redux.Action {
     matchingCellStyle: AdaptableStyle;
 }
@@ -50,6 +52,9 @@ export interface QuickSearchReadyAction extends Redux.Action {
     quickSearchState: QuickSearchState;
 }
 export declare const QuickSearchRun: (quickSearchText: string) => QuickSearchRunAction;
+export declare const QuickSearchClear: () => QuickSearchClearAction;
+/** Runs Quick Search, or clears it when the text is empty. */
+export declare const QuickSearchTextAction: (quickSearchText: string) => QuickSearchRunAction | QuickSearchClearAction;
 export declare const QuickSearchSetCellMatchingStyle: (matchingCellStyle: AdaptableStyle) => QuickSearchSetMatchingCellStyleAction;
 export declare const QuickSearchSetTextMatchingStyle: (textMatchStyle: AdaptableStyle) => QuickSearchSetTextMatchingStyleAction;
 export declare const QuickSearchSetCurrentTextMatchingStyle: (currentTextMatchStyle: AdaptableStyle) => QuickSearchSetCurrentTextMatchingStyleAction;

package/src/Redux/ActionsReducers/QuickSearchRedux.js

@@ -1,19 +1,16 @@
-import { QUICK_SEARCH_DEFAULT_CELL_BACK_COLOR, QUICK_SEARCH_DEFAULT_CURRENT_BACK_COLOR, QUICK_SEARCH_DEFAULT_FORE_COLOR, QUICK_SEARCH_DEFAULT_TEXT_BACK_COLOR, } from '../../Utilities/Constants/ReduxConstants';
+import { QUICK_SEARCH_DEFAULT_CURRENT_BACK_COLOR, QUICK_SEARCH_DEFAULT_CURRENT_FORE_COLOR, QUICK_SEARCH_DEFAULT_TEXT_BACK_COLOR, QUICK_SEARCH_DEFAULT_TEXT_FORE_COLOR, } from '../../Utilities/Constants/ReduxConstants';
 import { EMPTY_STRING } from '../../Utilities/Constants/GeneralConstants';
-export const QUICK_SEARCH_DEFAULT_CELL_MATCH_STYLE = {
-    BackColor: QUICK_SEARCH_DEFAULT_CELL_BACK_COLOR,
-    ForeColor: QUICK_SEARCH_DEFAULT_FORE_COLOR,
-};
 export const QUICK_SEARCH_DEFAULT_TEXT_MATCH_STYLE = {
     BackColor: QUICK_SEARCH_DEFAULT_TEXT_BACK_COLOR,
-    ForeColor: QUICK_SEARCH_DEFAULT_FORE_COLOR,
+    ForeColor: QUICK_SEARCH_DEFAULT_TEXT_FORE_COLOR,
 };
 export const QUICK_SEARCH_DEFAULT_CURRENT_TEXT_MATCH_STYLE = {
     BackColor: QUICK_SEARCH_DEFAULT_CURRENT_BACK_COLOR,
-    ForeColor: QUICK_SEARCH_DEFAULT_FORE_COLOR,
+    ForeColor: QUICK_SEARCH_DEFAULT_CURRENT_FORE_COLOR,
     FontWeight: 'Bold',
 };
 export const QUICK_SEARCH_RUN = 'QUICK_SEARCH_RUN';
+export const QUICK_SEARCH_CLEAR = 'QUICK_SEARCH_CLEAR';
 export const QUICK_SEARCH_SET_CELL_MATCHING_STYLE = 'QUICK_SEARCH_SET_CELL_MATCHING_STYLE';
 export const QUICK_SEARCH_SET_TEXT_MATCHING_STYLE = 'QUICK_SEARCH_SET_TEXT_MATCHING_STYLE';
 export const QUICK_SEARCH_SET_CURRENT_TEXT_MATCHING_STYLE = 'QUICK_SEARCH_SET_CURRENT_TEXT_MATCHING_STYLE';
@@ -22,6 +19,10 @@ export const QuickSearchRun = (quickSearchText) => ({
     type: QUICK_SEARCH_RUN,
     quickSearchText,
 });
+export const QuickSearchClear = () => ({
+    type: QUICK_SEARCH_CLEAR,
+});
+export const QuickSearchTextAction = (quickSearchText) => quickSearchText ? QuickSearchRun(quickSearchText) : QuickSearchClear();
 export const QuickSearchSetCellMatchingStyle = (matchingCellStyle) => ({
     type: QUICK_SEARCH_SET_CELL_MATCHING_STYLE,
     matchingCellStyle: matchingCellStyle,
@@ -47,6 +48,10 @@ export const QuickSearchReducer = (state = initialState, action) => {
             return Object.assign({}, state, {
                 QuickSearchText: action.quickSearchText,
             });
+        case QUICK_SEARCH_CLEAR:
+            return Object.assign({}, state, {
+                QuickSearchText: EMPTY_STRING,
+            });
         case QUICK_SEARCH_SET_CELL_MATCHING_STYLE:
             return Object.assign({}, state, {
                 CellMatchStyle: action.matchingCellStyle,

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

@@ -1,6 +1,14 @@
 import IStorageEngine from './Interface/IStorageEngine';
 import { InitialState } from '../../AdaptableState/InitialState';
 import { AdaptableLoadStateFunction, AdaptablePersistStateFunction } from '../../AdaptableOptions/StateOptions';
+/**
+ * Default `persistState` implementation - writes the state to localStorage under `adaptableStateKey`
+ */
+export declare const persistState: AdaptablePersistStateFunction;
+/**
+ * Default `loadState` implementation - reads the state from localStorage under `adaptableStateKey`
+ */
+export declare const loadState: AdaptableLoadStateFunction;
 export declare function createEngine(config: {
     adaptableId: string;
     adaptableStateKey: string;

package/src/Redux/Store/AdaptableReduxLocalStorageEngine.js

@@ -1,6 +1,7 @@
 import { debounce } from '../../Utilities/Helpers/TimingHelper';
 import { MergeStateFunction } from './AdaptableReduxMerger';
 import { AdaptableLogger } from '../../agGrid/AdaptableLogger';
+import { runAsyncStateFunction, runSyncStateFunction } from './StateOptionsGuards';
 const checkStatus = (response) => {
     const error = new Error(response.statusText);
     if (response.status >= 200 && response.status < 300) {
@@ -8,7 +9,7 @@ const checkStatus = (response) => {
     }
     throw error;
 };
-const persistState = (state, config) => {
+export const persistState = (state, config) => {
     return new Promise((resolve, reject) => {
         try {
             localStorage.setItem(config.adaptableStateKey, JSON.stringify(state));
@@ -19,7 +20,7 @@ const persistState = (state, config) => {
         }
     });
 };
-const loadState = ({ adaptableId, adaptableStateKey }) => {
+export const loadState = ({ adaptableStateKey }) => {
     const jsonState = localStorage.getItem(adaptableStateKey);
     const parsedJsonState = JSON.parse(jsonState) || {};
     return Promise.resolve(parsedJsonState);
@@ -49,7 +50,7 @@ class AdaptableReduxLocalStorageEngine {
         this.adaptableStateKey = adaptableStateKey;
     }
     load(adaptableInstance, initialState = this.initialState) {
-        return (this.loadState || loadState)(adaptableInstance.api.stateApi.internalApi.buildAdaptableStateFunctionConfig()).then((parsedJsonState) => {
+        return runAsyncStateFunction('loadState', this.loadState || loadState, [adaptableInstance.api.stateApi.internalApi.buildAdaptableStateFunctionConfig()], adaptableInstance.logger).then((parsedJsonState) => {
             return Promise.resolve(initialState)
                 .then((parsedInitialState) => {
                 return MergeStateFunction(parsedInitialState, parsedJsonState);
@@ -67,20 +68,19 @@ class AdaptableReduxLocalStorageEngine {
         const config = adaptableInstance.api.stateApi.internalApi.buildAdaptableStateFunctionConfig();
         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);
+        let stateObject;
+        try {
+            stateObject = runSyncStateFunction('saveState', adaptableInstance.adaptableOptions.stateOptions.saveState, structuredClone(state), config, adaptableInstance.logger);
         }
-        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);
+        catch (error) {
+            adaptableInstance.logger.consoleError('Adaptable State was NOT persisted:', error instanceof Error ? error.message : error);
+            return Promise.reject(error);
         }
-        return promise;
+        return runAsyncStateFunction('persistState', this.persistState || persistState, [stateObject, config], adaptableInstance.logger).catch(rejectWithMessage);
     }
 }
 function rejectWithMessage(error) {
-    return Promise.reject(error.message);
+    return Promise.reject(error?.message ?? error);
 }
 export function createEngine(config) {
     return new AdaptableReduxLocalStorageEngine(config);

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

@@ -1,11 +1,14 @@
 import * as Redux from 'redux';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
-import { AdaptableState } from '../../AdaptableState/AdaptableState';
+import { AdaptablePersistentState, AdaptableState } from '../../AdaptableState/AdaptableState';
 import { BaseState } from '../../AdaptableState/BaseState';
 import { IAdaptableStore, LoadStoreConfig } from './Interface/IAdaptableStore';
 type EmitterCallback = (data?: any) => any;
 type EmitterAnyCallback = (eventName: string, data?: any) => any;
-export declare const getPersistableState: (state: AdaptableState) => AdaptableState;
+/**
+ * Strips the transient (non-persisted) sections from the given state object - mutates and returns the same object.
+ */
+export declare const getPersistableState: (state: AdaptableState) => AdaptablePersistentState;
 export interface ResetUserDataAction extends Redux.Action {
 }
 export interface InitStateAction extends Redux.Action {
@@ -40,9 +43,9 @@ export declare class AdaptableStore implements IAdaptableStore {
      */
     constructor(adaptable: IAdaptable);
     destroy(): void;
-    getCurrentStorageState(): AdaptableState;
-    getPreviousStorageState(): AdaptableState;
-    saveStateNow(adaptable: IAdaptable, state?: AdaptableState): Promise<any>;
+    getCurrentStorageState(): AdaptablePersistentState;
+    getPreviousStorageState(): AdaptablePersistentState;
+    saveStateNow(adaptable: IAdaptable, state?: AdaptablePersistentState): Promise<any>;
     loadStore: (config: LoadStoreConfig) => Promise<any>;
 }
 export {};