@adaptabletools/adaptable 10.0.4-canary.0 → 10.0.4-canary.4

package/src/Api/Implementation/UserInterfaceApiImpl.js

@@ -67,7 +67,11 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
         // first do the function then get hardcoded items
         if (permittedValues != null && typeof permittedValues === 'function') {
             if (column) {
-                return permittedValues(column);
+                const permittedValuesParams = {
+                    adaptableApi: this.adaptable.api,
+                    column: column,
+                };
+                return permittedValues(permittedValuesParams);
             }
         }
         else {
@@ -131,7 +135,12 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
         let editLookUpValues = editLookUpItem.values;
         // first do the function then get hardcoded items
         if (editLookUpValues != null && typeof editLookUpValues === 'function') {
-            return editLookUpValues(gridCell.column, gridCell);
+            const editLookUpParams = {
+                adaptableApi: this.adaptable.api,
+                column: gridCell.column,
+                gridCell: gridCell,
+            };
+            return editLookUpValues(editLookUpParams);
         }
         else {
             let arr = editLookUpValues;
@@ -143,13 +152,13 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
         // this will use the columnapi method that first looks for permitted values and then distinct values
         return this.adaptable.api.columnApi.getDistinctDisplayValuesForColumn(gridCell.column.columnId);
     }
-    addColumnMenuItem(columnMenuItem) {
+    addColumnMenuItem(userMenuItem) {
         var _a;
-        (_a = this.getMenuOptions().columnMenuItems) === null || _a === void 0 ? void 0 : _a.push(columnMenuItem);
+        (_a = this.getMenuOptions().columnMenuItems) === null || _a === void 0 ? void 0 : _a.push(userMenuItem);
     }
-    addContextMenuItem(contextMenuItem) {
+    addContextMenuItem(userMenuItem) {
         var _a;
-        (_a = this.getMenuOptions().contextMenuItems) === null || _a === void 0 ? void 0 : _a.push(contextMenuItem);
+        (_a = this.getMenuOptions().contextMenuItems) === null || _a === void 0 ? void 0 : _a.push(userMenuItem);
     }
     getEditableCellStyle() {
         return this.getUserInterfaceOptions().editableCellStyle;

package/src/Api/InternalApi.d.ts

@@ -84,7 +84,7 @@ export interface InternalApi {
     updateCurrentDraftLayout(layout: Layout): void;
     getPrimaryKey(): any;
     getAdaptableInstance(): IAdaptable;
-    getVendorGridInstance(): any;
+    getAgGridInstance(): any;
     getPredefinedConfig(): any;
     getState(): AdaptableState;
     getAdaptableOptions(): AdaptableOptions;

package/src/Api/LayoutApi.d.ts

@@ -121,4 +121,11 @@ export interface LayoutApi {
      * Opens Layout popup screen
      */
     showLayoutPopup(): void;
+    /**
+     * Sets a new Caption / Header for a Column (this Layout only)
+     * @param columnId Column to Update
+     * @param caption New Caption to display
+     */
+    setColumnCaption(columnId: string, caption: string): void;
+    isCurrentLayoutReadOnly(): boolean;
 }

package/src/Api/PluginsApi.d.ts

@@ -12,13 +12,7 @@ export interface PluginsApi {
     getPluginState(pluginId: string): any;
     registerPlugin(pluginId: string, initialPluginState: any): void;
     setPluginState(pluginId: string, pluginState: any): void;
-    getPluginApi(pluginId: string): any;
-    getPluginApi(pluginId: 'ipushpull'): IPushPullApi;
-    getPluginApi(pluginId: 'glue42'): Glue42Api;
-    getPluginApi(pluginId: 'finance'): FinanceApi;
-    getPluginApi(pluginId: 'openfin'): OpenFinApi;
-    getPluginApi(pluginId: 'charts'): ChartApi;
-    getIpushpullPluginApi(): IPushPullApi;
+    getipushpullPluginApi(): IPushPullApi;
     getGlue42PluginApi(): Glue42Api;
     getOpenFinPluginApi(): OpenFinApi;
     getChartsPluginApi(): ChartApi;

package/src/Api/TeamSharingApi.d.ts

@@ -28,7 +28,7 @@ export interface TeamSharingApi {
      */
     checkForUpdates(): void;
     /**
-     * Fires the Team S
+     * Fires the Team Sharing Entity Changed Event
      * @param sharedEntity Entity that has been changed
      */
     fireTeamSharingEntityChangedEvent(sharedEntity: SharedEntity): void;

package/src/Api/ThemeApi.d.ts

@@ -17,11 +17,11 @@ export interface ThemeApi {
      */
     loadTheme(theme: string): void;
     /**
-     * Sets AdapTable Light Theme - updates underlying vendor grid theme to match
+     * Sets AdapTable Light Theme - updates the AG Grid theme to match
      */
     loadLightTheme(): void;
     /**
-     * Sets AdapTable Dark Theme - updates underlying vendor grid theme to match
+     * Sets AdapTable Dark Theme - updates the AG Grid theme to match
      */
     loadDarkTheme(): void;
     /**

package/src/Api/UserInterfaceApi.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
-import { UserMenuItem } from '../PredefinedConfig/Common/Menu';
+import { ColumnMenuContext, ContextMenuContext, UserMenuItem } from '../PredefinedConfig/Common/Menu';
 import { ActionColumn, BulkUpdatePermittedValues, CustomSortPermittedValues, EditLookUpPermittedValues, FilterPermittedValues, PermittedValues } from '../AdaptableOptions/UserInterfaceOptions';
 import { GridCell } from '../PredefinedConfig/Selection/GridCell';
 /**
@@ -52,12 +52,12 @@ export interface UserInterfaceApi {
      * Adds menu item to Column Menu
      * @param userMenuItem Menu Item to add
      */
-    addColumnMenuItem(userMenuItem: UserMenuItem): void;
+    addColumnMenuItem(userMenuItem: UserMenuItem<ColumnMenuContext>): void;
     /**
      * Adds menu item to Context Menu
      * @param userMenuItem Menu Item to add
      */
-    addContextMenuItem(userMenuItem: UserMenuItem): void;
+    addContextMenuItem(userMenuItem: UserMenuItem<ContextMenuContext>): void;
     /**
      * Returns Style set for Editable cells
      */

package/src/PredefinedConfig/AdaptableState.d.ts

@@ -12,7 +12,6 @@ import { ExportState } from './ExportState';
 import { FormatColumnState } from './FormatColumnState';
 import { FreeTextColumnState } from './FreeTextColumnState';
 import { LayoutState } from './LayoutState';
-import { PercentBarState } from './DeprecatedState';
 import { ScheduleState } from './ScheduleState';
 import { PlusMinusState } from './PlusMinusState';
 import { QuickSearchState } from './QuickSearchState';
@@ -24,10 +23,7 @@ import { FilterState } from './FilterState';
 import { SparklineColumnState } from './SparklineColumnState';
 import { ApplicationState } from './ApplicationState';
 import { ToolPanelState } from './ToolPanelState';
-import { GradientColumnState } from './DeprecatedState';
 import { QueryState } from './QueryState';
-import { FlashingCellState } from './DeprecatedState';
-import { UpdatedRowState } from './DeprecatedState';
 /**
  * The main state object that Adaptable persists
  */
@@ -52,17 +48,13 @@ export interface AdaptableState {
     Filter: FilterState;
     FormatColumn: FormatColumnState;
     FreeTextColumn: FreeTextColumnState;
-    GradientColumn: GradientColumnState;
     Layout: LayoutState;
-    PercentBar: PercentBarState;
-    Schedule: ScheduleState;
     PlusMinus: PlusMinusState;
+    Query: QueryState;
     QuickSearch: QuickSearchState;
+    Schedule: ScheduleState;
     Shortcut: ShortcutState;
     TeamSharing: TeamSharingState;
     Theme: ThemeState;
     ToolPanel: ToolPanelState;
-    Query: QueryState;
-    FlashingCell: FlashingCellState;
-    UpdatedRow: UpdatedRowState;
 }

package/src/PredefinedConfig/AlertState.d.ts

@@ -11,9 +11,8 @@ import { XOR } from '../Utilities/Extensions/TypeExtensions';
 import { AdaptableAggregationQuery, AdaptableBooleanQuery, AdaptableObservableQuery } from './Common/AdaptableQuery';
 import { ButtonStyle } from './Common/ButtonStyle';
 import { AlertButtonContext } from '../AdaptableOptions/NotificationsOptions';
-import { DataChangedInfo } from './Common/DataChangedInfo';
 /**
- * Predefined Configuration for Alert function
+ * Predefined Configuration for Alert Module
  */
 export interface AlertState extends ConfigState {
     /**
@@ -86,7 +85,7 @@ export interface AlertDefinition extends BaseAlertDefinition {
     /**
      * Alert Message - can be string or function; if not provided AdapTable creates dynamically using Rule & Scope
      */
-    MessageText?: string | ((scope: AdaptableScope, rule: AlertRule, dataChangedInfo?: DataChangedInfo) => string);
+    MessageText?: string;
     /**
      * Series of properties which set what happens when Alert is triggered
      */

package/src/PredefinedConfig/ApplicationState.d.ts

@@ -1,6 +1,6 @@
 import { ConfigState } from './ConfigState';
 /**
- * Predefined Configuration for the Application function
+ * Predefined Configuration for the Application Module
  **/
 export interface ApplicationState extends ConfigState {
     /**

package/src/PredefinedConfig/CalculatedColumnState.d.ts

@@ -3,7 +3,7 @@ import { AdaptableObject } from './Common/AdaptableObject';
 import { AdaptableScalarQuery } from './Common/AdaptableQuery';
 import { SpecialColumnSettings } from './Common/SpecialColumnSettings';
 /**
- * Predefined Configuration for Calculated Column function
+ * Predefined Configuration for Calculated Column Module
  **/
 export interface CalculatedColumnState extends ConfigState {
     /**

package/src/PredefinedConfig/Common/AdaptableButton.d.ts

@@ -36,5 +36,5 @@ export interface AdaptableButton<CONTEXT_TYPE extends ButtonContext> extends Ada
     hidden?: (button: AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => boolean;
 }
 export interface ButtonContext {
-    api: AdaptableApi;
+    adaptableApi: AdaptableApi;
 }

package/src/PredefinedConfig/Common/AdaptableColumn.d.ts

@@ -4,11 +4,11 @@ import { AdaptableObject } from './AdaptableObject';
  */
 export interface AdaptableColumnBase extends AdaptableObject {
     /**
-     * Name of Column in underlying grid (e.g. field or colId)
+     * Name of Column in AG Grid (e.g. field or colId)
      */
     columnId: string;
     /**
-     * How Column is referred to in Adaptable UI; 'Caption' or 'Header' property in underlying grid
+     * How Column is referred to in Adaptable UI; `Caption` property in AG Grid
      */
     friendlyName: string;
     /**
@@ -30,7 +30,7 @@ export interface AdaptableColumnGroup {
     groupCount: number;
 }
 /**
- * Defines an Adaptable Column - created at run-time based on vendor grid column definition
+ * Defines an Adaptable Column - created at run-time based on AG Grid column definition
  */
 export interface AdaptableColumn extends AdaptableColumnBase {
     /**

package/src/PredefinedConfig/Common/AdaptablePredicate.d.ts

@@ -7,11 +7,11 @@ import { RowNode } from '@ag-grid-community/all-modules';
  */
 export interface AdaptablePredicate {
     /**
-     * Id of Predicate (e.g. 'Equals', 'GreaterThan')
+     * Id of Predicate (e.g. `Equals`, `GreaterThan`)
      */
     PredicateId: string;
     /**
-     * Optional inputs - needed to evaluate some Predicates (e.g. 'GreaterThan')
+     * Optional Inputs that might be needed for evaluation
      */
     Inputs?: any[];
 }
@@ -32,7 +32,7 @@ export interface AdaptablePredicateDef {
      */
     columnScope: AdaptableScope;
     /**
-     * Adaptable Modules where Predicate can run
+     * Modules where Predicate can run: 'filter', 'alert', 'conditionalstyle'
      */
     moduleScope: ModuleScope[];
     /**
@@ -60,7 +60,7 @@ export interface AdaptablePredicateDef {
      */
     shortcuts?: string[];
     /**
-     * Wether to display this predicate only in QuickFilter (and NOT in Column Filter)
+     * Display this predicate only in Quick Filter Bar (and NOT in Filter Form)
      */
     onlyQuickFilter?: boolean;
 }

package/src/PredefinedConfig/Common/AdaptableScope.d.ts

@@ -2,8 +2,8 @@ export declare type ScopeDataType = 'String' | 'Number' | 'Boolean' | 'Date';
 export declare type ScopeAll = {
     All: true;
 };
-export declare type ScopeDataTypes = {
-    DataTypes: ScopeDataType[];
+export declare type ScopeDataTypes<Type = ScopeDataType> = {
+    DataTypes: Type[];
 };
 export declare type ScopeColumnIds = {
     ColumnIds: string[];
@@ -11,4 +11,4 @@ export declare type ScopeColumnIds = {
 /**
  * Defines where a given Object / Module is active
  */
-export declare type AdaptableScope = ScopeAll | ScopeDataTypes | ScopeColumnIds;
+export declare type AdaptableScope<Type = ScopeDataType> = ScopeAll | ScopeDataTypes<Type> | ScopeColumnIds;

package/src/PredefinedConfig/Common/AdaptableStyle.d.ts

@@ -3,31 +3,31 @@
  */
 export interface AdaptableStyle {
     /**
-     * Colour background of cell - provide a hex value.
+     * Colour background of cell: provide hex value or name
      */
     BackColor?: string;
     /**
-     * Font colour in cell - provide a hex value.
+     * Font colour in cell: provide hex value or name
      */
     ForeColor?: string;
     /**
-     * Whether font appears as 'Normal' or 'Bold'
+     * Weight of font: `Normal` or `Bold`
      */
     FontWeight?: 'Normal' | 'Bold';
     /**
-     * Style of the font: 'Normal' or 'Italic'
+     * Style of font: `Normal` or `Italic`
      */
     FontStyle?: 'Normal' | 'Italic';
     /**
-     * Size of font: 'XSmall', 'Small', 'Medium', 'Large' or 'XLarge'
+     * Size of font: `XSmall`, `Small`, `Medium`, `Large` or `XLarge`
      */
     FontSize?: 'XSmall' | 'Small' | 'Medium' | 'Large' | 'XLarge';
     /**
-     * Colour of cell border - provide a hex value.
+     * Colour of cell border: provide hex value or name
      */
     BorderColor?: string;
     /**
-     * Name of existing Css Class; use instead of setting other object properties
+     * Existing CSS Class; use instead of setting other object properties
      */
     ClassName?: string;
 }

package/src/PredefinedConfig/Common/DataChangedInfo.d.ts

@@ -25,7 +25,7 @@ export interface DataChangedInfo {
      */
     primaryKeyValue: any;
     /**
-     * RowNode that contains the cell (an AG Grid object)
+     * AG Grid RowNode that contains the cell
      */
     rowNode?: RowNode;
     /**

package/src/PredefinedConfig/Common/Menu.d.ts

@@ -6,6 +6,12 @@ import { AdaptableApi } from '../../Api/AdaptableApi';
 import { SelectedCellInfo } from '../Selection/SelectedCellInfo';
 import { SelectedRowInfo } from '../Selection/SelectedRowInfo';
 import { Column, RowNode } from '@ag-grid-community/all-modules';
+export interface MenuContext {
+    /**
+     * The Adaptable Api - included as a convenience
+     */
+    adaptableApi: AdaptableApi;
+}
 /**
  * Menu item used by Adaptable in 3 places: Module Menu (at left of Dashboard Header), Column Header Menu and Context Menu
  */
@@ -15,15 +21,15 @@ export interface AdaptableMenuItem {
      */
     label: string;
     /**
-     * Adaptable Module associated with (shipped) menu item.
+     * Adaptable Module associated with (Adaptable) menu item.
      */
     module?: AdaptableModule | 'General';
     /**
-     * Adaptable Redux Action to invoke when (shipped) menu item is clicked
+     * Adaptable Redux Action to invoke when (Adaptable) menu item is clicked
      */
     reduxAction?: Redux.Action;
     /**
-     * Function to invoice when (custom) menu item is clicked
+     * Function to invoke when (custom) menu item is clicked
      */
     onClick?: () => void;
     /**
@@ -40,38 +46,55 @@ export interface AdaptableMenuItem {
     subItems?: AdaptableMenuItem[];
 }
 /**
- * Defines a Menu Item created at design-time, can be added to Column Header or Context Menu, and can contain sub items.
+ * Menu Item created at design-time which is added to Column Header or Context Menu, and can contain sub items
  */
-export interface UserMenuItem {
+export interface UserMenuItem<CONTEXT_TYPE extends MenuContext> {
     /**
      * The text that will appear in the Menu Item
      */
-    label: string | ((menuContext: MenuContext) => string);
+    label: string | ((context: CONTEXT_TYPE) => string);
     /**
      * Function to invoke when the Menu Item is clicked
      */
-    onClick?: (menuContext: MenuContext) => void;
+    onClick?: (menuContext: CONTEXT_TYPE) => void;
     /**
      * Function to evaluate whether Menu Item is visible
      */
-    hidden?: (menuContext: MenuContext) => boolean;
+    hidden?: (menuContext: CONTEXT_TYPE) => boolean;
     /**
      * Function to evaluate whether Menu Item is enabled
      */
-    disabled?: (menuContext: MenuContext) => boolean;
+    disabled?: (menuContext: CONTEXT_TYPE) => boolean;
     /**
-     * Optional icon to show in the Menu Item
+     * Optional icon to show in the Column Menu Item
      */
     icon?: string;
     /**
      * Array of Menu Items, enabling creation of (limitless levels of) sub menus
      */
-    subMenuItems?: UserMenuItem[];
+    subMenuItems?: UserMenuItem<CONTEXT_TYPE>[];
 }
 /**
- * Provides full details about current Menu; used for both Column and Context Menus
+ * Provides full details about current Column where Column Header Menu will appear
  */
-export interface MenuContext {
+export interface ColumnMenuContext extends MenuContext {
+    /**
+     * Current Adaptable Column
+     */
+    adaptableColumn: AdaptableColumn;
+    /**
+     * Current AG Grid Column
+     */
+    agGridColumn: Column;
+    /**
+     * Whether current Column is Row Group
+     */
+    isRowGroupColumn: boolean;
+}
+/**
+ * Provides full details about current cell (and selected cells) where Context Menu will appear
+ */
+export interface ContextMenuContext extends MenuContext {
     /**
      *  Cell that has been clicked; contains cell value
      */
@@ -81,9 +104,9 @@ export interface MenuContext {
      */
     adaptableColumn: AdaptableColumn;
     /**
-     * Current Vendor Grid Column
+     * Current AG Grid Column
      */
-    vendorColumn: Column;
+    agGridColumn: Column;
     /**
      * Whether cell that was clicked is also currently selected
      */
@@ -97,11 +120,11 @@ export interface MenuContext {
      */
     rowNode: RowNode;
     /**
-     * Whether current row node is grouped
+     * Whether current AG Grid row node is grouped
      */
     isGroupedNode: boolean;
     /**
-     * Whether current Column is Row Group
+     * Whether current Column is Row Grouped
      */
     isRowGroupColumn: boolean;
     /**

package/src/PredefinedConfig/Common/SpecialColumnSettings.d.ts

@@ -3,7 +3,7 @@
  */
 export interface SpecialColumnSettings {
     /**
-     * Preferred width (in pixels) for Column; if unset, calculated dynamically by underlying Grid
+     * Preferred width (in pixels) for Column; if unset, calculated dynamically by AG Grid
      */
     Width?: number;
     /**

package/src/PredefinedConfig/Common/Types.d.ts

@@ -5,10 +5,10 @@ export declare type AdaptableDashboardToolbars = AdaptableDashboardToolbar[];
 /**
  * List of all the Toolbars that Adaptable provides
  */
-export declare type AdaptableDashboardToolbar = 'Query' | 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Chart' | 'Filter' | 'DataSource' | 'Export' | 'Glue42' | 'OpenFin' | 'IPushPull' | 'Layout' | 'QuickSearch' | 'SmartEdit' | 'SystemStatus' | 'Theme' | 'DataChangeHistory';
+export declare type AdaptableDashboardToolbar = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Chart' | 'DataChangeHistory' | 'DataSource' | 'Export' | 'Filter' | 'Glue42' | 'IPushPull' | 'Layout' | 'OpenFin' | 'Query' | 'QuickSearch' | 'SmartEdit' | 'StateManagement' | 'SystemStatus' | 'Theme';
 export declare const ALL_TOOLBARS: AdaptableDashboardToolbar[];
 export declare type AdaptableToolPanels = AdaptableToolPanel[];
-export declare type AdaptableToolPanel = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Chart' | 'Filter' | 'Dashboard' | 'Export' | 'IPushPull' | 'OpenFin' | 'Layout' | 'Query' | 'QuickSearch' | 'SmartEdit' | 'SystemStatus' | 'Theme' | 'DataChangeHistory';
+export declare type AdaptableToolPanel = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Chart' | 'Dashboard' | 'DataChangeHistory' | 'Export' | 'Filter' | 'IPushPull' | 'Layout' | 'OpenFin' | 'Query' | 'QuickSearch' | 'SmartEdit' | 'StateManagement' | 'SystemStatus' | 'Theme';
 export declare const ALL_TOOL_PANELS: AdaptableToolPanels;
 /**
  * Adaptable Module Button collection
@@ -19,10 +19,10 @@ export declare type AdaptableModuleButtons = AdaptableModuleButton[];
 /**
  * List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button
  */
-export declare type AdaptableModuleButton = 'Query' | 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'Filter' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataSource' | 'Export' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'DataChangeHistory';
+export declare type AdaptableModuleButton = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSource' | 'Export' | 'Filter' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme';
 export declare type AdaptableStateKeys = AdaptableStateKey[];
-export declare type AdaptableStateKey = 'Query' | 'Alert' | 'Application' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataSource' | 'Entitlement' | 'Export' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'Filter' | 'SystemStatus' | 'Theme' | 'ToolPanel' | 'UserInterface';
-export declare type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'Filter' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataSource' | 'Export' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'DataChangeHistory';
+export declare type AdaptableStateKey = 'Alert' | 'Application' | 'CalculatedColumn' | 'Chart' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataSource' | 'Export' | 'Filter' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SparklineColumn' | 'Theme' | 'ToolPanel';
+export declare type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSource' | 'Export' | 'Filter' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
 export declare type TypeHint<Base, Literals> = (Base & {
     __subType?: true;
 }) | Literals;

package/src/PredefinedConfig/Common/Types.js

@@ -5,21 +5,22 @@ This page includes frequently used typed - particularly helpful for State and Ap
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ALL_TOOL_PANELS = exports.ALL_TOOLBARS = void 0;
 exports.ALL_TOOLBARS = [
-    'Query',
     'Alert',
     'BulkUpdate',
     'CellSummary',
     'Chart',
-    'Filter',
     'DataChangeHistory',
     'DataSource',
     'Export',
+    'Filter',
     'Glue42',
-    'OpenFin',
     'IPushPull',
     'Layout',
-    'SmartEdit',
+    'OpenFin',
+    'Query',
     'QuickSearch',
+    'SmartEdit',
+    'StateManagement',
     'SystemStatus',
     'Theme',
 ];
@@ -28,16 +29,17 @@ exports.ALL_TOOL_PANELS = [
     'BulkUpdate',
     'CellSummary',
     'Chart',
-    'Filter',
     'Dashboard',
+    'DataChangeHistory',
     'Export',
+    'Filter',
     'IPushPull',
-    'OpenFin',
     'Layout',
+    'OpenFin',
     'Query',
     'QuickSearch',
     'SmartEdit',
+    'StateManagement',
     'SystemStatus',
     'Theme',
-    'DataChangeHistory',
 ];

package/src/PredefinedConfig/ConditionalStyleState.d.ts

@@ -7,7 +7,7 @@ import { XOR } from '../Utilities/Extensions/TypeExtensions';
 import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
 import { SuspendableObject } from './Common/SuspendableObject';
 /**
- * Predefined Configuration for the Conditional Style function
+ * Predefined Configuration for the Conditional Style Module
  **/
 export interface ConditionalStyleState extends ConfigState {
     /**

package/src/PredefinedConfig/CustomSortState.d.ts

@@ -1,7 +1,7 @@
 import { ConfigState } from './ConfigState';
 import { SuspendableObject } from './Common/SuspendableObject';
 /**
- * Predefined Configuration for Custom Sort function
+ * Predefined Configuration for Custom Sort Module
  */
 export interface CustomSortState extends ConfigState {
     /**

package/src/PredefinedConfig/DataSourceState.d.ts

@@ -3,7 +3,7 @@ import { AdaptableObject } from './Common/AdaptableObject';
 import { AdaptableForm } from './Common/AdaptableForm';
 import { ButtonContext } from './Common/AdaptableButton';
 /**
- * Predefined Configuration for Data Source function
+ * Predefined Configuration for Data Source Module
  */
 export interface DataSourceState extends ConfigState {
     /**

package/src/PredefinedConfig/ExportState.d.ts

@@ -12,7 +12,7 @@ export interface ExportCustomDestinationPopup {
     ReportName: Report['Name'];
 }
 /**
- * Predefined Configuration for Export function
+ * Predefined Configuration for Export Module
  */
 export interface ExportState extends ConfigState {
     /**
@@ -34,11 +34,11 @@ export interface Report extends AdaptableObject {
      */
     Name: SystemReportName | string;
     /**
-     * Columns to display in Report
+     * Columns to display: options are 'AllColumns', 'VisibleColumns', 'SelectedColumns', 'ScopeColumns', 'CustomColumns'
      */
     ReportColumnScope: 'AllColumns' | 'VisibleColumns' | 'SelectedColumns' | 'ScopeColumns' | 'CustomColumns';
     /**
-     * Rows to export when Report runs
+     * Rows to export: options are 'AllRows', 'VisibleRows', 'SelectedCellRows', 'SelectedRows', 'ExpressionRows', 'CustomRows'
      */
     ReportRowScope: 'AllRows' | 'VisibleRows' | 'SelectedCellRows' | 'SelectedRows' | 'ExpressionRows' | 'CustomRows';
     /**

package/src/PredefinedConfig/FilterState.d.ts

@@ -12,7 +12,7 @@ export interface FilterState extends ConfigState {
      */
     ColumnFilters?: ColumnFilter[];
     /**
-     * Whether to display Quick Filter Bar - at least one column must have Quick Filter set to true
+     * Whether to display Quick Filter Bar between Column Header and the Grid
      * @defaultValue  true
      */
     IsQuickFilterVisible?: boolean;
@@ -40,7 +40,7 @@ export interface ColumnFilter extends AdaptableObject {
      */
     ColumnId: string;
     /**
-     * Predicate function to evaluate when Filter is run
+     * `AdaptablePredicate` which AdaptableQL will evaluate when the Filter is run
      */
     Predicate: ColumnFilterPredicate;
 }

package/src/PredefinedConfig/FormatColumnState.d.ts

@@ -4,7 +4,7 @@ import { AdaptableFormat } from './Common/AdaptableFormat';
 import { AdaptableScope } from './Common/AdaptableScope';
 import { SuspendableObject } from './Common/SuspendableObject';
 /**
- * Predefined Configuration for Format Column function
+ * Predefined Configuration for Format Column Module
  */
 export interface FormatColumnState extends ConfigState {
     /**