@adaptabletools/adaptable 10.0.2 → 10.0.4-canary.2

package/src/AdaptableOptions/NotificationsOptions.d.ts

@@ -1,7 +1,8 @@
-import { AlertButton, FlashingAlertProperties } from '../PredefinedConfig/AlertState';
+import { AlertButton, AlertDefinition, FlashingAlertProperties } from '../PredefinedConfig/AlertState';
 import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
 import { ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
 import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
+import { DataChangedInfo } from '../types';
 /**
  * Options related to Alerts, System Status Messages and Notifications in Adaptable.
  */
@@ -111,6 +112,15 @@ export interface NotificationsOptions {
      * @gridInfoItem
      */
     maxSystemMessagesInStore?: number;
+    /**
+     * Displays the application icon in Notifications (if provided in `UserInterfaceOptions`)
+     * @defaultValue false
+     */
+    showApplicationIcon?: boolean;
+    /**
+     * Function providing Message to display in Alert; if empty, AdapTable provides dynamically
+     */
+    alertMessageText?: (alertDefinition: AlertDefinition, dataChangedInfo?: DataChangedInfo) => string | undefined;
 }
 /**
  * Handles a Form Button Action

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -49,9 +49,9 @@ export interface ToolPanelOptions {
     /**
      * Order of displayed ToolPanels in Sidebar
      *
-     * @defaultValue ['filters', 'columns', 'AdaptableToolPanel']
+     * @defaultValue ['filters', 'columns', 'adaptable']
      */
-    toolPanelOrder?: ('AdaptableToolPanel' | 'columns' | 'filters')[];
+    toolPanelOrder?: ('adaptable' | 'columns' | 'filters')[];
     /**
      * Display the Modules dropdown
      *

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -6,6 +6,7 @@ import { AdaptableButton, ButtonContext } from '../PredefinedConfig/Common/Adapt
 import { RowNode } from '@ag-grid-community/all-modules';
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
 import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
+import { AdaptableApi, GridCell } from '../../types';
 /**
  * Options for managing the User Interface of AdapTable
  */
@@ -30,11 +31,27 @@ export interface UserInterfaceOptions {
     /**
      * List of values which are permitted (e.g. to show in filter)
      */
-    permittedValues?: CellValuesList[];
+    permittedValues?: PermittedValues[];
     /**
-     * Dropdown values displayed when column is being edited
+     * Dropdown values displayed when column is being edited.
+     * When not defined it defaults to permittedValues.
      */
-    editLookUpItems?: CellValuesList[];
+    editLookUpItems?: EditLookUpPermittedValues[];
+    /**
+     * Dropdown values for filter options inside floating and header filter.
+     * When not defined it defaults to permittedValues.
+     */
+    filterPermittedValues?: FilterPermittedValues[];
+    /**
+     * Custom column values for defining custom sort.
+     * When not defined it defaults to permittedValues.
+     */
+    customSortPermittedValues?: CustomSortPermittedValues[];
+    /**
+     * Custom column values for editing via bulk-update.
+     * When not defined it defaults to permittedValues.
+     */
+    bulkUpdatePermittedValues?: BulkUpdatePermittedValues[];
     /**
      * Colours to display in Colour Picker (in place of AdapTable's default set)
      */
@@ -65,16 +82,55 @@ export interface UserInterfaceOptions {
      */
     showDocumentationLinks?: boolean;
 }
-export interface CellValuesList {
+export interface BasePermittedValues {
     /**
      * Scope where Values will appear (Mandatory property)
      */
     scope: AdaptableScope;
+}
+/**
+ * Permitted/possible values, when column values can be selected (e.g. sort, bulk-update)
+ */
+export interface PermittedValues extends BasePermittedValues {
     /**
      * Values to display: either hardcoded list or a function
      */
-    values?: any[] | ((column: AdaptableColumn) => any[]);
+    values?: any[] | ((params: PermittedValuesParams) => any[]);
+}
+/**
+ * Used to define permitted values for inline column editor
+ */
+export interface EditLookUpPermittedValues extends BasePermittedValues {
+    values?: any[] | ((params: EditLookUpParams) => any[]);
+}
+/**
+ * Used to define values inside the floating filter and floating filter (quick filter)
+ */
+export interface FilterPermittedValues extends BasePermittedValues {
+    /**
+     * Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed
+     * @default false
+     */
+    suppressFilterSearchBar?: boolean;
+    values: (params: FilterPermittedValuesParams) => any[] | Promise<any[]>;
+}
+/**
+ * Custom column values for custom sort.
+ */
+export interface CustomSortPermittedValues extends BasePermittedValues {
+    values: (params: PermittedValuesParams) => any[] | Promise<any[]>;
+}
+/**
+ * User to define permitted values when updating cells via bulk update
+ */
+export interface BulkUpdatePermittedValues extends BasePermittedValues {
+    values: (params: BulkUpdatePermittedValuesParams) => any[] | Promise<any[]>;
 }
+/**
+ * Use PermittedValues instead
+ * @deprecated
+ */
+export declare type CellValuesList = PermittedValues;
 /**
  * A Special Column that wraps an AdapTable Button
  */
@@ -95,6 +151,10 @@ export interface ActionColumn extends AdaptableObject {
      * Shows Action Column also in grouped rows
      */
     includeGroupedRows?: boolean;
+    /**
+     * Additional optional properties for Column (e.g. filterable, resizable)
+     */
+    actionColumnSettings?: ActionColumnSettings;
 }
 /**
  * Context required by functions when using an Action Column Button
@@ -109,7 +169,49 @@ export interface ActionColumnButtonContext extends ButtonContext {
      */
     primaryKeyValue: any;
     /**
-     * Current Row Node
+     * Current AG Grid Row Node
      */
     rowNode: RowNode;
 }
+/**
+ * Set of optional properties that define an Action Columns behaviour
+ */
+export interface ActionColumnSettings {
+    /**
+     * Preferred width (in pixels) for Column; if unset, calculated dynamically by AG Grid
+     */
+    width?: number;
+    /**
+     * Whether Column can be resized (by dragging column header edges)
+     * @defaultValue true
+     */
+    resizable?: boolean;
+    /**
+     * Whether no menu should be shown for this Column header.
+     * @defaultValue false
+     */
+    suppressMenu?: boolean;
+    /**
+     * Whether if this Column should be movable via dragging
+     * @defaultValue false
+     */
+    suppressMovable?: boolean;
+}
+export interface BaseParams {
+    adaptableApi: AdaptableApi;
+}
+export interface EditLookUpParams extends BaseParams {
+    column: AdaptableColumn;
+    gridCell: GridCell;
+}
+export interface PermittedValuesParams extends BaseParams {
+    column: AdaptableColumn;
+}
+export interface FilterPermittedValuesParams extends BaseParams {
+    column: AdaptableColumn;
+    filter: string;
+}
+export interface BulkUpdatePermittedValuesParams extends BaseParams {
+    column: AdaptableColumn;
+    gridCells: GridCell[];
+}

package/src/Api/AdaptableApi.d.ts

@@ -65,14 +65,14 @@ export interface AdaptableApi {
      * Provides a number of column-related methods
      */
     columnApi: ColumnApi;
-    /**
-     * Methods giving access to Adaptable State
-     */
-    configApi: ConfigApi;
     /**
      * Provides access to the Conditional Style Module
      */
     conditionalStyleApi: ConditionalStyleApi;
+    /**
+     * Methods giving access to Adaptable State
+     */
+    configApi: ConfigApi;
     /**
      * Provides access to the Custom Sort Module
      */
@@ -81,6 +81,10 @@ export interface AdaptableApi {
      * Provides access to the Dashboard
      */
     dashboardApi: DashboardApi;
+    /**
+     * Provides run-time access to the Data Change History Module
+     **/
+    dataChangeHistoryApi: DataChangeHistoryApi;
     /**
      * Provides access to the Data Source Module
      */
@@ -161,6 +165,10 @@ export interface AdaptableApi {
      * Methods related to displaying System Status and application health messages
      */
     systemStatusApi: SystemStatusApi;
+    /**
+     * Functions related to run-time Team Sharing of AdapTable objects between colleagues
+     */
+    teamSharingApi: TeamSharingApi;
     /**
      * Api methods related to Theme management
      */
@@ -173,14 +181,6 @@ export interface AdaptableApi {
      * Manages User Interface Options where colours, styles and permitted values are configured
      */
     userInterfaceApi: UserInterfaceApi;
-    /**
-     * Functions related to run-time Team Sharing of AdapTable objects between colleagues
-     */
-    teamSharingApi: TeamSharingApi;
-    /**
-     * Provides run-time access to the Data Change History Module
-     **/
-    dataChangeHistoryApi: DataChangeHistoryApi;
     /**
      * Api methods used *internally* within AdapTable.
      */

package/src/Api/AlertApi.d.ts

@@ -241,7 +241,7 @@ export interface AlertApi {
      * Returns a description of an Alert Definition
      * @param alertDefinition Alert Definition to use
      */
-    getAlertDescription(alertDefinition: AlertDefinition): string;
+    getAlertDescription(alertDefinition: AlertDefinition, dataChangedInfo?: DataChangedInfo): string;
     /**
      * Returns a description of an Alert Definition's Rule
      * @param alertDefinition Alert Definition to use

package/src/Api/CalculatedColumnApi.d.ts

@@ -63,4 +63,19 @@ export interface CalculatedColumnApi {
      * @param calculatedColumn CalculatedColumn to be checked
      */
     getCalculatedColumnModuleReferences(calculatedColumn: CalculatedColumn): string[];
+    /**
+     * Returns all Calculated Columns whose Expression contains the ColumnId
+     * @param columnId ColumnId to check
+     */
+    getCalculatedColumnsReferencingColumnId(columnId: string): CalculatedColumn[];
+    /**
+     * Gets any ColumnIds referenced in a Calculated Column
+     * @param calculatedColumn Calculated Column to check
+     */
+    getReferencedColumnIdsForCalculatedColumn(calculatedColumn: CalculatedColumn): string[];
+    /**
+     * Gets any ColumnIds referenced in a Calculated Column
+     * @param calculatedColumnId CalculatedColumnId to check
+     */
+    getReferencedColumnIdsForCalculatedColumnId(calculatedColumnId: string): string[];
 }

package/src/Api/ColumnApi.d.ts

@@ -1,6 +1,7 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { DataType } from '../PredefinedConfig/Common/Enums';
-import { RowNode } from '@ag-grid-community/all-modules';
+import { Column, RowNode } from '@ag-grid-community/all-modules';
+import { GridCell } from '../../types';
 /**
  * A large range of column-related functions in AdapTable
  */
@@ -13,7 +14,7 @@ export interface ColumnApi {
      * Retrieves 'ColumnType' property for a given Column
      * @param columnId Colmun to use
      */
-    getVendorColumnType(columnId: string): string | string[];
+    getAgGridColumnType(columnId: string): string | string[];
     /**
      * Returns all visible Columns
      * */
@@ -131,6 +132,10 @@ export interface ColumnApi {
      * @param columnId Column to check
      */
     isNumericColumn(column: AdaptableColumn): boolean;
+    /**
+     * Is Column Boolean
+     * @param columnId Column to check
+     */
     isBooleanColumn(column: AdaptableColumn): boolean;
     /**
      * Is Column a Date
@@ -205,6 +210,26 @@ export interface ColumnApi {
      * @param columnId Column to check
      */
     getDistinctDisplayValuesForColumn(columnId: string): any[];
+    /**
+     * Gets all distinct display values in for filter column, used for Floating Filter and Column Header filter
+     * @param columnId Column to check
+     * @param columnFilter Current applied filter
+     */
+    getDistinctFilterDisplayValuesForColumn(columnId: string, filter: string): Promise<{
+        values: any[];
+        suppressClientSideFilter: boolean;
+    }>;
+    /**
+     * Gets all distinct column display values in for custom sort.
+     * @param columnId Column to check
+     */
+    getDistinctCustomSortDisplayValuesForColumn(columnId: string): Promise<any[]>;
+    /**
+     * Gets all distinct column display values for bulk update.
+     * @param columnId Column to check
+     * @param selectedGridCells Selected grid cells
+     */
+    getDistinctBulkUpdateDisplayValuesForColumn(columnId: string, selectedGridCells: GridCell[]): Promise<any[]>;
     /**
      * Gets all distinct visible display values in the Column
      * @param columnId Column to check
@@ -230,10 +255,29 @@ export interface ColumnApi {
      */
     getAllColumnFriendlyNames(): string[];
     /**
-     * Retrieves the field property for the column
-     * @param columnId string
+     * Retrieves AG Grid's field property for the column
+     * @param columnId columnId to look up
+     */
+    getAgGridColumnFieldForAdaptableColumn(columnId: string): string;
+    /**
+     * Retrieves AG Grid's column for an Adaptable column
+     * @param columnId columnId to look up
+     */
+    getAgGridColumnForAdaptableColumn(columnId: string): Column;
+    /**
+     * Does Column use AdapTable's Filter Form
+     * @param columnId Column to Check
      */
-    getVendorGridColumnFieldForColumn(columnId: string): string;
     usesAdaptableFilterForm(columnId: string): boolean;
+    /**
+     * Does Column use AdapTable's Quick Filter
+     * @param columnId Column to Check
+     */
     usesAdaptableQuickFilter(columnId: string): boolean;
+    /**
+     * Checks if a column is referenced in a given Expression
+     * @param columnId Column to Check
+     * @param expression Expression to Lookup
+     */
+    isColumnReferencedInExpression(columnId: string, expression: string): boolean;
 }

package/src/Api/ConfigApi.d.ts

@@ -94,6 +94,10 @@ export interface ConfigApi {
      * @param returnJson whether to return section as JSON or object
      */
     getUserStateByStateKey(stateKey: AdaptableStateKey, returnJson: boolean): ConfigState | string;
+    /**
+     * Adds '1' to current revision number of State element
+     * @param stateKey Adaptable State Key to update
+     */
     incrementUerStateRevision(stateKey: AdaptableStateKey): void;
     /**
      * Returns Alert section of Adaptable State
@@ -200,5 +204,9 @@ export interface ConfigApi {
      * @param returnJson return as JSON rather than object
      */
     getToolPanelState(returnJson: boolean): ToolPanelState;
+    /**
+     * Sent by each Module when it is Ready
+     * @param module Module which is Ready
+     */
     dispatchStateReadyAction(module: AdaptableModule): void;
 }

package/src/Api/EventApi.d.ts

@@ -196,7 +196,7 @@ export interface EventApi {
     /**
      * Fired when Adaptable is up and running - has no arguments.
      * @param eventName AdaptableReady - use as: adaptableApi.eventApi.on('AdaptableReady', (adaptableReadyInfo: AdaptableReadyInfo) => { .....[do stuff]...})
-     * @param callback An `AdaptableReadyInfo` object which contains the adaptableApi and the vendorGrid
+     * @param callback An `AdaptableReadyInfo` object which contains the adaptableApi and GridOptions
      * @returns the unsubscribe function
      */
     on(eventName: 'AdaptableReady', callback: (adaptableReadyInfo: AdaptableReadyInfo) => void): VoidFunction;

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

@@ -1,14 +1,11 @@
-import { AdaptableApi } from '../AdaptableApi';
+import { GridOptions } from '@ag-grid-community/all-modules';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by `AdaptableReady` event - fired when AdapTable has loaded
  */
-export interface AdaptableReadyInfo {
+export interface AdaptableReadyInfo extends BaseEventInfo {
     /**
-     * Instance of the underlying vendor grid (e.g. for AG Grid its the GridOptions object)
+     * Underlying AG Grid instance
      */
-    vendorGrid: any;
-    /**
-     * Adaptable API object used for runtime programmatic access to AdapTable
-     */
-    adaptableApi: AdaptableApi;
+    gridOptions: GridOptions;
 }

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

@@ -1,9 +1,10 @@
 import * as Redux from 'redux';
 import { AdaptableState } from '../../PredefinedConfig/AdaptableState';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by the `AdaptableStateChanged` event
  */
-export interface AdaptableStateChangedInfo {
+export interface AdaptableStateChangedInfo extends BaseEventInfo {
     /**
      * Name of the Action
      */

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

@@ -1,8 +1,9 @@
 import { AdaptableAlert } from '../../PredefinedConfig/Common/AdaptableAlert';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by the `AlertFired` event
  */
-export interface AlertFiredInfo {
+export interface AlertFiredInfo extends BaseEventInfo {
     /**
      * Alert which has been fired
      */

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

@@ -0,0 +1,10 @@
+import { AdaptableApi } from '../AdaptableApi';
+/**
+ * Base Object returned by all events - contains the Adaptable API
+ */
+export interface BaseEventInfo {
+    /**
+     * Adaptable API object used for runtime programmatic access to AdapTable
+     */
+    adaptableApi: AdaptableApi;
+}

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

@@ -1,8 +1,9 @@
 import { DataChangedInfo } from '../../PredefinedConfig/Common/DataChangedInfo';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * EventInfo returned by CellChanged event
  */
-export interface CellChangedInfo {
+export interface CellChangedInfo extends BaseEventInfo {
     /**
      * Object providing full information of the cell (and column and row) that changed
      */

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

@@ -1,8 +1,9 @@
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Event Info published by CheckboxColumnClicked event
  */
-export interface CheckboxColumnClickedInfo {
+export interface CheckboxColumnClickedInfo extends BaseEventInfo {
     /**
      * Name of Column where Checkbox was clicked
      */

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

@@ -1,8 +1,9 @@
 import { CustomToolbar } from '../../AdaptableOptions/DashboardOptions';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * EventInfo returned by the CustomToolbarConfigured event
  */
-export interface CustomToolbarConfiguredInfo {
+export interface CustomToolbarConfiguredInfo extends BaseEventInfo {
     /**
      * Custom Toolbar in which the 'Configure' button has been clicked
      */

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

@@ -1,8 +1,9 @@
 import { DashboardState } from '../../PredefinedConfig/DashboardState';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by the `DashboardChanged` event
  */
-export interface DashboardChangedInfo {
+export interface DashboardChangedInfo extends BaseEventInfo {
     /**
      * What caused Dashboard State to change
      */

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

@@ -1,8 +1,9 @@
 import { AdaptableFlashingAlert } from '../../PredefinedConfig/Common/AdaptableFlashingAlert';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by the `FlashingAlertFired` event
  */
-export interface FlashingAlertFiredInfo {
+export interface FlashingAlertFiredInfo extends BaseEventInfo {
     /**
      * FlashingAlert which has been fired
      */

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

@@ -1,7 +1,8 @@
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * EventInfo returned by GridDataChanged event
  */
-export interface GridDataChangedInfo {
+export interface GridDataChangedInfo extends BaseEventInfo {
     /**
      * Rows that have been added, updated, or deleted
      */

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

@@ -1,8 +1,9 @@
 import { LayoutState } from '../../PredefinedConfig/LayoutState';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * EventInfo returned by LayoutChanged event
  */
-export interface LayoutChangedInfo {
+export interface LayoutChangedInfo extends BaseEventInfo {
     /**
      * What caused Layout State to change
      */

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

@@ -1,8 +1,9 @@
 import { Report } from '../../PredefinedConfig/ExportState';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * EventInfo returned by LiveDataChanged event
  */
-export interface LiveDataChangedInfo {
+export interface LiveDataChangedInfo extends BaseEventInfo {
     /**
      * Which Adaptable partner is the export destination for the live data
      */

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

@@ -2,10 +2,11 @@ import { DataSource } from '../../PredefinedConfig/DataSourceState';
 import { CustomSort } from '../../PredefinedConfig/CustomSortState';
 import { ColumnSort } from '../../PredefinedConfig/Common/ColumnSort';
 import { ColumnFilter } from '../../PredefinedConfig/FilterState';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * EventInfo returned by SearchChanged event; includes full AdapTable search and sort info plus the event's trigger
  */
-export interface SearchChangedInfo {
+export interface SearchChangedInfo extends BaseEventInfo {
     /**
      * What action caused event to fire: DataSource, CurrentQuery, Filter, DataChange or Sort
      */

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

@@ -1,9 +1,10 @@
 import { SelectedCellInfo } from '../../PredefinedConfig/Selection/SelectedCellInfo';
 import { SelectedRowInfo } from '../../PredefinedConfig/Selection/SelectedRowInfo';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Event Info published by SelectionChanged event
  */
-export interface SelectionChangedInfo {
+export interface SelectionChangedInfo extends BaseEventInfo {
     /**
      * Details of cells currently selected in the Grid
      */

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

@@ -1,8 +1,9 @@
 import { SystemStatusMessageInfo } from '../../PredefinedConfig/Common/SystemStatusMessageInfo';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by the `SystemStatusMessageDisplayed' event
  */
-export interface SystemStatusMessageDisplayedInfo {
+export interface SystemStatusMessageDisplayedInfo extends BaseEventInfo {
     /**
      * Details of the System Status Message and Type
      */

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

@@ -1,8 +1,9 @@
 import { SharedEntity } from '../../PredefinedConfig/TeamSharingState';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * EventInfo returned by TeamSharingEntityChanged event
  */
-export interface TeamSharingEntityChangedInfo {
+export interface TeamSharingEntityChangedInfo extends BaseEventInfo {
     /**
      * Object containing the Shared Entity that has changed
      */

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

@@ -1,8 +1,9 @@
 import { AdaptableTheme } from '../../PredefinedConfig/ThemeState';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by the `ThemeChanged` event
  */
-export interface ThemeChangedInfo {
+export interface ThemeChangedInfo extends BaseEventInfo {
     /**
      * Selected Theme: either name of a (System) theme or the (Custom) Theme itself
      */