@adaptabletools/adaptable 18.0.12 → 18.1.0-canary.0

package/src/Api/ColumnApi.d.ts

@@ -292,7 +292,7 @@ export interface ColumnApi {
     setColumnDefinitions(columnDefinitions: (ColDef | ColGroupDef)[]): void;
 }
 /**
- * Column Configuration
+ * Configuration of an AG Grid Column, used for runtime updating of ColDefs
  */
 export interface ColumnConfig {
     /** Column Id */

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

@@ -1,7 +1,5 @@
 import { BaseEventInfo } from './BaseEventInfo';
-import { Fdc3Context } from '../../PredefinedConfig/Common/Fdc3Context';
-import { Fdc3IntentType } from '../../PredefinedConfig/Common/Fdc3Intent';
-import { AppIdentifier, ContextMetadata } from '@finos/fdc3';
+import { AppIdentifier, Context, ContextMetadata, Intent } from '@finos/fdc3';
 /**
  * EventInfo returned by FDC3 Message events
  */
@@ -21,11 +19,11 @@ export interface Fdc3MessageSentInfo extends BaseEventInfo {
     /**
      * FDC3 Intent which caused Event to fire (if type is `RaiseIntent`)
      */
-    intent?: Fdc3IntentType;
+    intent?: Intent;
     /**
      * Full FDC3 Context for object related to the Event
      */
-    context: Fdc3Context;
+    context: Context;
     /**
      * Target application for the message
      */
@@ -46,11 +44,11 @@ export interface Fdc3MessageReceivedInfo extends BaseEventInfo {
     /**
      * FDC3 Intent which caused Event to fire (if type is `IntentRaised`)
      */
-    intent?: Fdc3IntentType;
+    intent?: Intent;
     /**
      * Full FDC3 Context for object related to the Event
      */
-    context: Fdc3Context;
+    context: Context;
     /**
      * Metadata associated with the FDC3 Context
      */

package/src/Api/ExpressionApi.d.ts

@@ -48,12 +48,12 @@ export interface ExpressionApi {
      */
     getASTForExpression(expression: string): any;
     /**
-     * Returns the Expression string of the given AdaptableQuery: can be Boolean, AggregatedBoolean, Scalar, AggregatedScalar or Observable Expression
+     * Returns Expression string of given AdaptableQuery: can be Boolean, AggregatedBoolean, Scalar, AggregatedScalar or Observable
      * @param query - the AdaptableQuery
      */
     getAdaptableQueryExpression(query: Partial<AdaptableQuery>): string | undefined;
     /**
-     * Returns the Expression string of the given AdaptableQuery with the column friendly names (instead of their technical IDs)
+     * Returns Expression string of given AdaptableQuery with column friendly names (instead of Column IDs)
      * @param query - the AdaptableQuery
      */
     getAdaptableQueryExpressionWithColumnFriendlyNames(query: Partial<AdaptableQuery>): string | undefined;

package/src/Api/Fdc3Api.d.ts

@@ -1,7 +1,5 @@
-import { Fdc3Context, Fdc3ContextType, Fdc3StandardContextType } from '../PredefinedConfig/Common/Fdc3Context';
 import { IRowNode } from '@ag-grid-community/core';
-import { AppIdentifier, DesktopAgent, IntentResolution } from '@finos/fdc3';
-import { Fdc3IntentType, Fdc3StandardIntentType } from '../PredefinedConfig/Common/Fdc3Intent';
+import { AppIdentifier, Context, ContextType, DesktopAgent, Intent, IntentResolution } from '@finos/fdc3';
 /**
  * Provides run-time access to AdapTable's FDC3 functionality
  */
@@ -14,30 +12,27 @@ export interface Fdc3Api {
      * Returns the human-friendly label for the given Context Type
      * @param contextType - The FDC3 Context Type
      */
-    getContextLabel(contextType: Fdc3ContextType): string;
+    getContextLabel(contextType: ContextType): string;
     /**
      * Builds FDC3 Context Data based on the given Context Type and Row Node
      * @param contextType - The FDC3 Context Type
      * @param rowNode - The Row Node
      */
-    buildContextDataFromRow(contextType: Fdc3ContextType, rowNode: IRowNode): Fdc3Context;
+    buildContextDataFromRow(contextType: ContextType, rowNode: IRowNode): Context;
     /**
      * Builds FDC3 Context Data based on the given Context Type and the Row Node with the given Primary Key Value
      * @param contextType - The FDC3 Context Type
      * @param primaryKeyValue - The Primary Key Value
      */
-    buildContextDataForPrimaryKey(contextType: Fdc3ContextType, primaryKeyValue: string | number): Fdc3Context | undefined;
+    buildContextDataForPrimaryKey(contextType: ContextType, primaryKeyValue: string | number): Context | undefined;
     /**
-     * Returns the FDC3 Context Type for the given Intent
-     * @param intent - The FDC3 Intent
+     * @deprecated no longer relevant as of FDC3 v2.1
      */
-    getPossibleContextTypes(intent: Fdc3StandardIntentType): Fdc3StandardContextType[];
+    getPossibleContextTypes(intent: Intent): ContextType[];
     /**
-     * Checks if the given Context Type is compatible with the given Intent
-     * @param contextType - The FDC3 Context Type
-     * @param intent - The FDC3 Intent
+     * @deprecated no longer relevant as of FDC3 v2.1
      */
-    isContextCompatibleWithIntent(contextType: Fdc3StandardContextType, intent: Fdc3StandardIntentType): boolean;
+    isContextCompatibleWithIntent(contextType: ContextType, intent: Intent): boolean;
     /**
      * Raises an Intent with the given Context from the given Row Node
      * @param rowNode - The Row Node
@@ -45,7 +40,7 @@ export interface Fdc3Api {
      * @param contextType - The FDC3 Context Type
      * @param appIdentifier - The App Identifier
      */
-    raiseIntentFromRow(rowNode: IRowNode, intent: Fdc3IntentType, contextType: Fdc3ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
+    raiseIntentFromRow(rowNode: IRowNode, intent: Intent, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
     /**
      * Raises an Intent with the given Context from the given Row Node with the given Primary Key Value
      * @param primaryKeyValue - The Primary Key Value
@@ -53,33 +48,33 @@ export interface Fdc3Api {
      * @param contextType - The FDC3 Context Type
      * @param appIdentifier - The App Identifier
      */
-    raiseIntentFromPrimaryKey(primaryKeyValue: string | number, intent: Fdc3IntentType, contextType: Fdc3ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;
+    raiseIntentFromPrimaryKey(primaryKeyValue: string | number, intent: Intent, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;
     /**
      * Finds and raises an Intent based on the given Context from the given Row Node
      * @param rowNode - The Row Node
      * @param contextType - The FDC3 Context Type
      * @param appIdentifier - The App Identifier
      */
-    raiseIntentForContextFromRow(rowNode: IRowNode, contextType: Fdc3ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
+    raiseIntentForContextFromRow(rowNode: IRowNode, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
     /**
      * Finds and raises an Intent based on the given Context from the given Row Node with the given Primary Key Value
      * @param primaryKeyValue - The Primary Key Value
      * @param contextType - The FDC3 Context Type
      * @param appIdentifier - The App Identifier
      */
-    raiseIntentForContextFromPrimaryKey(primaryKeyValue: string | number, contextType: Fdc3ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;
+    raiseIntentForContextFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;
     /**
      * Broadcasts the given Context from the given Row Node
      * @param rowNode - The Row Node
      * @param contextType - The FDC3 Context Type
      */
-    broadcastFromRow(rowNode: IRowNode, contextType: Fdc3ContextType): Promise<void>;
+    broadcastFromRow(rowNode: IRowNode, contextType: ContextType): Promise<void>;
     /**
      * Broadcasts the given Context from the given Row Node with the given Primary Key Value
      * @param primaryKeyValue - The Primary Key Value
      * @param contextType - The FDC3 Context Type
      */
-    broadcastFromPrimaryKey(primaryKeyValue: string | number, contextType: Fdc3ContextType): Promise<void> | undefined;
+    broadcastFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType): Promise<void> | undefined;
     /**
      * Checks if the given Context Type is a FDC3 standard Context Type
      */

package/src/Api/Implementation/ConfigApiImpl.js

@@ -45,6 +45,9 @@ export class ConfigApiImpl extends ApiBase {
         var _a;
         const adaptableOptions = this.adaptable.adaptableOptions;
         const oldState = this.getPersistedState();
+        // clearing filters so that AG Grid doesnt display the filter icon in a column header after grid reloads
+        // but this is a hack so would be nicer if there was a better way to do this
+        this.getAdaptableApi().gridApi.clearGridFiltering();
         const clearStateFn = ((_a = adaptableOptions.stateOptions) === null || _a === void 0 ? void 0 : _a.clearState) ||
             (() => {
                 localStorage.removeItem(adaptableOptions.adaptableStateKey);

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

@@ -1,28 +1,26 @@
 import { IRowNode } from '@ag-grid-community/core';
-import { DesktopAgent, IntentResolution } from '@finos/fdc3';
+import { Context, ContextType, DesktopAgent, Intent, IntentResolution, StandardContextType, StandardIntent } from '@finos/fdc3';
 import { ApiBase } from './ApiBase';
 import { Fdc3Api } from '../Fdc3Api';
 import { Fdc3InternalApi } from '../Internal/Fdc3InternalApi';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
-import { Fdc3Context, Fdc3StandardContextType } from '../../PredefinedConfig/Common/Fdc3Context';
-import { Fdc3StandardIntentType } from '../../PredefinedConfig/Common/Fdc3Intent';
 import { AppIdentifier } from '@finos/fdc3/dist/api/AppIdentifier';
 export declare class Fdc3ApiImpl extends ApiBase implements Fdc3Api {
     internalApi: Fdc3InternalApi;
     constructor(adaptable: IAdaptable);
     getDesktopAgent(): DesktopAgent;
-    buildContextDataFromRow(contextType: Fdc3StandardContextType, rowNode: IRowNode): Fdc3Context;
-    buildContextDataForPrimaryKey(contextType: Fdc3StandardContextType, primaryKeyValue: string | number): Fdc3Context | undefined;
-    getPossibleContextTypes(intent: Fdc3StandardIntentType): Fdc3StandardContextType[];
-    isContextCompatibleWithIntent(contextType: Fdc3StandardContextType, intent: Fdc3StandardIntentType): boolean;
-    raiseIntentFromPrimaryKey(primaryKeyValue: string | number, intent: Fdc3StandardIntentType, contextType: Fdc3StandardContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;
-    raiseIntentFromRow(rowNode: IRowNode, intent: Fdc3StandardIntentType, contextType: Fdc3StandardContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
-    raiseIntentForContextFromRow(rowNode: IRowNode, contextType: Fdc3StandardContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
-    raiseIntentForContextFromPrimaryKey(primaryKeyValue: string | number, contextType: Fdc3StandardContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;
-    broadcastFromRow(rowNode: IRowNode, contextType: Fdc3StandardContextType): Promise<void>;
-    broadcastFromPrimaryKey(primaryKeyValue: string | number, contextType: Fdc3StandardContextType): Promise<void> | undefined;
-    getContextLabel(contextType: Fdc3StandardContextType): string;
-    isStandardContextType(contextType: string): boolean;
-    isStandardIntentType(intentType: string): boolean;
+    buildContextDataFromRow(contextType: ContextType, rowNode: IRowNode): Context;
+    buildContextDataForPrimaryKey(contextType: ContextType, primaryKeyValue: string | number): Context | undefined;
+    raiseIntentFromPrimaryKey(primaryKeyValue: string | number, intent: Intent, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;
+    raiseIntentFromRow(rowNode: IRowNode, intent: Intent, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
+    raiseIntentForContextFromRow(rowNode: IRowNode, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
+    raiseIntentForContextFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;
+    broadcastFromRow(rowNode: IRowNode, contextType: ContextType): Promise<void>;
+    broadcastFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType): Promise<void> | undefined;
+    getContextLabel(contextType: ContextType): string;
+    isStandardContextType(contextType: string): contextType is StandardContextType;
+    isStandardIntentType(intentType: string): intentType is StandardIntent;
     private getFdc3Service;
+    getPossibleContextTypes(intent: Intent): ContextType[];
+    isContextCompatibleWithIntent(contextType: ContextType, intent: Intent): boolean;
 }

package/src/Api/Implementation/Fdc3ApiImpl.js

@@ -1,7 +1,6 @@
 import { ApiBase } from './ApiBase';
 import { Fdc3InternalApi } from '../Internal/Fdc3InternalApi';
-import { ContextConfiguration, } from '../../PredefinedConfig/Common/Fdc3Context';
-import { Fdc3IntentConfiguration, } from '../../PredefinedConfig/Common/Fdc3Intent';
+import { ContextConfiguration } from '../../PredefinedConfig/Common/Fdc3Context';
 export class Fdc3ApiImpl extends ApiBase {
     constructor(adaptable) {
         super(adaptable);
@@ -21,14 +20,6 @@ export class Fdc3ApiImpl extends ApiBase {
         }
         return this.buildContextDataFromRow(contextType, rowNode);
     }
-    getPossibleContextTypes(intent) {
-        var _a;
-        const compatibleContexts = (_a = Fdc3IntentConfiguration[intent]) === null || _a === void 0 ? void 0 : _a.contexts;
-        return compatibleContexts ? [...compatibleContexts] : [];
-    }
-    isContextCompatibleWithIntent(contextType, intent) {
-        return this.getPossibleContextTypes(intent).includes(contextType);
-    }
     raiseIntentFromPrimaryKey(primaryKeyValue, intent, contextType, appIdentifier) {
         const rowNode = this.getGridApi().getRowNodeForPrimaryKey(primaryKeyValue);
         if (!rowNode) {
@@ -66,8 +57,10 @@ export class Fdc3ApiImpl extends ApiBase {
         return this.broadcastFromRow(rowNode, contextType);
     }
     getContextLabel(contextType) {
-        var _a, _b;
-        return (_b = (_a = ContextConfiguration[contextType]) === null || _a === void 0 ? void 0 : _a.label) !== null && _b !== void 0 ? _b : contextType;
+        var _a;
+        return this.isStandardContextType(contextType)
+            ? (_a = ContextConfiguration[contextType]) === null || _a === void 0 ? void 0 : _a.label
+            : contextType;
     }
     isStandardContextType(contextType) {
         return this.internalApi.isStandardContextType(contextType);
@@ -78,4 +71,35 @@ export class Fdc3ApiImpl extends ApiBase {
     getFdc3Service() {
         return this.getAdaptableApi().internalApi.getFdc3Service();
     }
+    getPossibleContextTypes(intent) {
+        this.logWarn('Fdc3Api.getPossibleContextTypes is NO longer relevant as of FDC3 v1.2 and will be removed in a future version');
+        return [
+            'fdc3.action',
+            'fdc3.chart',
+            'fdc3.chat.initSettings',
+            'fdc3.chat.message',
+            'fdc3.chat.room',
+            'fdc3.chat.searchCriteria',
+            'fdc3.contact',
+            'fdc3.contactList',
+            'fdc3.country',
+            'fdc3.currency',
+            'fdc3.email',
+            'fdc3.instrument',
+            'fdc3.instrumentList',
+            'fdc3.interaction',
+            'fdc3.message',
+            'fdc3.organization',
+            'fdc3.portfolio',
+            'fdc3.position',
+            'fdc3.nothing',
+            'fdc3.timerange',
+            'fdc3.transactionResult',
+            'fdc3.valuation',
+        ];
+    }
+    isContextCompatibleWithIntent(contextType, intent) {
+        this.logWarn('Fdc3Api.isContextCompatibleWithIntent is NO longer relevant as of FDC3 v1.2 and will be removed in a future version');
+        return true;
+    }
 }

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

@@ -77,12 +77,14 @@ export declare class AlertInternalApi extends ApiBase {
      * Returns a description of an Alert Definition
      * @param alertDefinition Alert Definition to use
      */
-    getAlertDescription(alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo): string;
+    getAlertDescriptionForDataChange(alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo): string;
     /**
      * Returns a description title of an Alert Definition
      * @param alertDefinition Alert Definition to use
      */
-    getAlertMessageHeader(alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo): string;
+    getAlertMessageHeaderForDataChange(alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo): string;
+    getAlertMessageForGridDataChange(alertDefinition: AlertDefinition, gridDataChangedInfo: GridDataChangedInfo): string;
+    getAlertHeaderForGridDataChange(alertDefinition: AlertDefinition, gridDataChangedInfo: GridDataChangedInfo): string;
     /**
      * Returns custom description for alert using the 'alertMessageText' property
      *
@@ -143,4 +145,17 @@ export declare class AlertInternalApi extends ApiBase {
     showAlertsForGridDataChanges(gridDataChangedInfo: GridDataChangedInfo, alertDefinitions: AlertDefinition[]): void;
     shouldFireAlertOnClient(alertDefinition: AlertDefinition): boolean;
     getDefaultAlertNotificationForm(): AlertButtonForm;
+    /**
+     * Supported tokens:
+     * - column-that-changed-name -> [column]
+     * - rowData.newValue -> [rowData.newValue]
+     * - rowData.oldValue -> [rowData.oldValue]
+     * - primaryKey -> [primaryKeyValue]
+     * - timestamp -> [timestamp]
+     * - trigger -> [trigger]
+     */
+    private annotateAlertText;
+    private replaceAll;
+    private extractColsFromText;
+    private extractContextKeysFromText;
 }

package/src/Api/Internal/AlertInternalApi.js

@@ -215,13 +215,36 @@ export class AlertInternalApi extends ApiBase {
      * Returns a description of an Alert Definition
      * @param alertDefinition Alert Definition to use
      */
-    getAlertDescription(alertDefinition, cellDataChangedInfo) {
-        const customMessage = this.getCustomAlertDescription(alertDefinition, { cellDataChangedInfo });
+    getAlertDescriptionForDataChange(alertDefinition, cellDataChangedInfo) {
+        let customMessage = this.getCustomAlertDescription(alertDefinition, { cellDataChangedInfo });
+        const anotationContext = cellDataChangedInfo
+            ? {
+                column: cellDataChangedInfo.column,
+                rowNode: cellDataChangedInfo.rowNode,
+                oldValue: cellDataChangedInfo.oldValue,
+                newValue: cellDataChangedInfo.newValue,
+                primaryKeyValue: cellDataChangedInfo.primaryKeyValue,
+                timestamp: cellDataChangedInfo.changedAt,
+                trigger: cellDataChangedInfo.trigger,
+            }
+            : {};
         if (customMessage) {
+            customMessage = cellDataChangedInfo
+                ? this.annotateAlertText(customMessage, anotationContext)
+                : customMessage;
             return customMessage;
         }
         if (alertDefinition.MessageText != null) {
-            return alertDefinition.MessageText;
+            let alertText = alertDefinition.MessageText;
+            try {
+                alertText = cellDataChangedInfo
+                    ? this.annotateAlertText(alertText, anotationContext)
+                    : alertText;
+                return alertText;
+            }
+            catch (e) {
+                this.logError('Error in getAlertMessageHeader', e);
+            }
         }
         let scopeDescription = this.getColumnScopeApi().getScopeDescription(alertDefinition.Scope);
         let ruleDescription = this.getAlertRuleDescription(alertDefinition);
@@ -231,11 +254,75 @@ export class AlertInternalApi extends ApiBase {
      * Returns a description title of an Alert Definition
      * @param alertDefinition Alert Definition to use
      */
-    getAlertMessageHeader(alertDefinition, cellDataChangedInfo) {
+    getAlertMessageHeaderForDataChange(alertDefinition, cellDataChangedInfo) {
         var _a, _b;
-        return ((_a = this.getCustomAlertMessageHeader(alertDefinition, {
+        const anotationContext = cellDataChangedInfo
+            ? {
+                column: cellDataChangedInfo.column,
+                rowNode: cellDataChangedInfo.rowNode,
+                oldValue: cellDataChangedInfo.oldValue,
+                newValue: cellDataChangedInfo.newValue,
+                primaryKeyValue: cellDataChangedInfo.primaryKeyValue,
+                timestamp: cellDataChangedInfo.changedAt,
+                trigger: cellDataChangedInfo.trigger,
+            }
+            : {};
+        let message = (_a = this.getCustomAlertMessageHeader(alertDefinition, {
             cellDataChangedInfo,
-        })) !== null && _a !== void 0 ? _a : (_b = cellDataChangedInfo === null || cellDataChangedInfo === void 0 ? void 0 : cellDataChangedInfo.column) === null || _b === void 0 ? void 0 : _b.friendlyName);
+        })) !== null && _a !== void 0 ? _a : (_b = cellDataChangedInfo === null || cellDataChangedInfo === void 0 ? void 0 : cellDataChangedInfo.column) === null || _b === void 0 ? void 0 : _b.friendlyName;
+        try {
+            message = cellDataChangedInfo ? this.annotateAlertText(message, anotationContext) : message;
+        }
+        catch (e) {
+            this.logError('Error in getAlertMessageHeader', e);
+        }
+        return message;
+    }
+    getAlertMessageForGridDataChange(alertDefinition, gridDataChangedInfo) {
+        const rowAdded = gridDataChangedInfo.rowTrigger === 'Add';
+        const numberOfChangedRows = gridDataChangedInfo.rowNodes.length;
+        const actionName = rowAdded ? 'Added' : 'Removed';
+        const defaultMessage = numberOfChangedRows > 1
+            ? `${numberOfChangedRows} rows were ${actionName.toLowerCase()}`
+            : `${numberOfChangedRows} row was ${actionName.toLowerCase()}`;
+        const customMessage = this.getCustomAlertDescription(alertDefinition, {
+            gridDataChangedInfo,
+        });
+        let alertMessage = alertDefinition.MessageText
+            ? alertDefinition.MessageText
+            : customMessage !== null && customMessage !== void 0 ? customMessage : defaultMessage;
+        try {
+            alertMessage = this.annotateAlertText(alertMessage, {
+                numberOfRows: numberOfChangedRows,
+                timestamp: gridDataChangedInfo.changedAt,
+                trigger: gridDataChangedInfo.rowTrigger,
+            });
+        }
+        catch (e) {
+            this.logError('Error in getAlertMessageForGridDataChange', e);
+        }
+        return alertMessage;
+    }
+    getAlertHeaderForGridDataChange(alertDefinition, gridDataChangedInfo) {
+        const rowAdded = gridDataChangedInfo.rowTrigger === 'Add';
+        const numberOfChangedRows = gridDataChangedInfo.rowNodes.length;
+        const actionName = rowAdded ? 'Added' : 'Removed';
+        const customHeader = this.getCustomAlertMessageHeader(alertDefinition, {
+            gridDataChangedInfo,
+        });
+        const alertHeader = numberOfChangedRows > 1 ? `${actionName} Rows` : `${actionName} Row `;
+        let header = customHeader !== null && customHeader !== void 0 ? customHeader : alertHeader;
+        try {
+            header = this.annotateAlertText(header, {
+                numberOfRows: numberOfChangedRows,
+                timestamp: gridDataChangedInfo.changedAt,
+                trigger: gridDataChangedInfo.rowTrigger,
+            });
+        }
+        catch (e) {
+            this.logError('Error in getAlertHeaderForGridDataChange', e);
+        }
+        return header;
     }
     /**
      * Returns custom description for alert using the 'alertMessageText' property
@@ -450,6 +537,7 @@ export class AlertInternalApi extends ApiBase {
                     }
                 }
             });
+            ``;
         }
         return triggeredAlerts;
     }
@@ -466,7 +554,6 @@ export class AlertInternalApi extends ApiBase {
     }
     isAlertPredicateTriggered(alert, dataChangedEvent, defaultNoPredicateReturn = false) {
         var _a;
-        const adapatableApi = this.getAdaptableApi();
         const predicateDefHandlerContext = Object.assign({ value: dataChangedEvent.newValue, oldValue: dataChangedEvent.oldValue, 
             // TODO send real display value
             displayValue: null, node: dataChangedEvent.rowNode, column: dataChangedEvent.column }, this.getAdaptableApi().internalApi.buildBaseContext());
@@ -480,7 +567,7 @@ export class AlertInternalApi extends ApiBase {
         if (isCellDataChangedInfo(dataChangedInfo)) {
             alertDefinitions.forEach((alertDefinition) => {
                 if (this.shouldFireAlertOnClient(alertDefinition)) {
-                    const alert = ObjectFactory.CreateCellChangedAlert(this.getAlertMessageHeader(alertDefinition, dataChangedInfo), this.getAlertDescription(alertDefinition, dataChangedInfo), alertDefinition, dataChangedInfo);
+                    const alert = ObjectFactory.CreateCellChangedAlert(this.getAlertMessageHeaderForDataChange(alertDefinition, dataChangedInfo), this.getAlertDescriptionForDataChange(alertDefinition, dataChangedInfo), alertDefinition, dataChangedInfo);
                     this.getAdaptableApi().alertApi.showAdaptableAlert(alert);
                 }
             });
@@ -490,25 +577,9 @@ export class AlertInternalApi extends ApiBase {
         }
     }
     showAlertsForGridDataChanges(gridDataChangedInfo, alertDefinitions) {
-        const rowAdded = gridDataChangedInfo.rowTrigger === 'Add';
-        const numberOfChangedRows = gridDataChangedInfo.rowNodes.length;
-        const actionName = rowAdded ? 'Added' : 'Removed';
-        const alertHeader = numberOfChangedRows > 1 ? `${actionName} Rows` : `${actionName} Row `;
-        const defaultMessage = numberOfChangedRows > 1
-            ? `${numberOfChangedRows} rows were ${actionName.toLowerCase()}`
-            : `${numberOfChangedRows} row was ${actionName.toLowerCase()}`;
         alertDefinitions === null || alertDefinitions === void 0 ? void 0 : alertDefinitions.forEach((alertDefinition) => {
             if (this.shouldFireAlertOnClient(alertDefinition)) {
-                const customMessage = this.getCustomAlertDescription(alertDefinition, {
-                    gridDataChangedInfo,
-                });
-                const customHeader = this.getCustomAlertMessageHeader(alertDefinition, {
-                    gridDataChangedInfo,
-                });
-                const alertMessage = alertDefinition.MessageText
-                    ? alertDefinition.MessageText
-                    : customMessage !== null && customMessage !== void 0 ? customMessage : defaultMessage;
-                const alert = ObjectFactory.CreateRowChangedAlert(customHeader !== null && customHeader !== void 0 ? customHeader : alertHeader, alertMessage, alertDefinition, gridDataChangedInfo);
+                const alert = ObjectFactory.CreateRowChangedAlert(this.getAlertHeaderForGridDataChange(alertDefinition, gridDataChangedInfo), this.getAlertMessageForGridDataChange(alertDefinition, gridDataChangedInfo), alertDefinition, gridDataChangedInfo);
                 this.getAlertApi().showAdaptableAlert(alert);
             }
         });
@@ -541,4 +612,104 @@ export class AlertInternalApi extends ApiBase {
             ],
         };
     }
+    /**
+     * Supported tokens:
+     * - column-that-changed-name -> [column]
+     * - rowData.newValue -> [rowData.newValue]
+     * - rowData.oldValue -> [rowData.oldValue]
+     * - primaryKey -> [primaryKeyValue]
+     * - timestamp -> [timestamp]
+     * - trigger -> [trigger]
+     */
+    annotateAlertText(text, context) {
+        var _a, _b, _c;
+        if (!text) {
+            return text;
+        }
+        if (!context) {
+            return text;
+        }
+        if (context === null || context === void 0 ? void 0 : context.newValue) {
+            text = this.replaceAll(text, '[newValue]', context.newValue);
+        }
+        if (context === null || context === void 0 ? void 0 : context.oldValue) {
+            text = this.replaceAll(text, '[oldValue]', context.oldValue);
+        }
+        if (context === null || context === void 0 ? void 0 : context.primaryKeyValue) {
+            text = this.replaceAll(text, '[primaryKeyValue]', context.primaryKeyValue);
+        }
+        if (context === null || context === void 0 ? void 0 : context.timestamp) {
+            text = this.replaceAll(text, '[timestamp]', context.timestamp + '');
+        }
+        if (context === null || context === void 0 ? void 0 : context.numberOfRows) {
+            text = this.replaceAll(text, '[numberOfRows]', context.numberOfRows + '');
+        }
+        if (context === null || context === void 0 ? void 0 : context.trigger) {
+            const dataChangeTriggerMap = {
+                edit: 'Edit',
+                tick: 'Tick',
+                undo: 'Undo',
+                aggChange: 'AggChange',
+            };
+            const rowChangeTriggerMap = {
+                Add: 'Added',
+                Edit: 'Edited',
+                Delete: 'Deleted',
+                Load: 'Loaded',
+            };
+            const mappedTrigger = 
+            // @ts-ignore
+            (_a = (dataChangeTriggerMap[context.trigger] || rowChangeTriggerMap[context.trigger])) !== null && _a !== void 0 ? _a : context.trigger;
+            text = this.replaceAll(text, '[trigger]', mappedTrigger);
+        }
+        if ((context === null || context === void 0 ? void 0 : context.column) && (context === null || context === void 0 ? void 0 : context.rowNode)) {
+            text = this.replaceAll(text, '[column]', this.getGridApi().getRawValueFromRowNode(context.rowNode, context.column.columnId));
+        }
+        if (context === null || context === void 0 ? void 0 : context.rowNode) {
+            const columns = this.extractColsFromText(text);
+            for (const column of columns) {
+                if (this.getColumnApi().getColumnWithColumnId(column)) {
+                    text = this.replaceAll(text, `[rowData.${column}]`, this.getGridApi().getRawValueFromRowNode(context.rowNode, column));
+                }
+            }
+        }
+        if (text.indexOf('[context') !== -1) {
+            const agGridContext = (_c = (_b = this.adaptable.agGridAdapter).getGridOption) === null || _c === void 0 ? void 0 : _c.call(_b, 'context');
+            const agGridContextKeys = this.extractContextKeysFromText(text);
+            for (const key of agGridContextKeys) {
+                if (agGridContext[key]) {
+                    text = this.replaceAll(text, `[context.${key}]`, agGridContext[key]);
+                }
+            }
+        }
+        return text;
+    }
+    replaceAll(text, toReplace, replaceWith) {
+        if (!text) {
+            return text;
+        }
+        // fails for []
+        toReplace = toReplace.replace('[', '\\[').replace(']', '\\]');
+        return text.replace(new RegExp(toReplace, 'g'), replaceWith);
+    }
+    extractColsFromText(text) {
+        // rowData.columnName => columnName
+        const regex = /\[rowData\.(.*?)\]/g;
+        let m;
+        const cols = [];
+        while ((m = regex.exec(text)) !== null) {
+            cols.push(m[1]);
+        }
+        return cols;
+    }
+    extractContextKeysFromText(text) {
+        // context.columnName => columnName
+        const regex = /\[context\.(.*?)\]/g;
+        let m;
+        const contextKeys = [];
+        while ((m = regex.exec(text)) !== null) {
+            contextKeys.push(m[1]);
+        }
+        return contextKeys;
+    }
 }

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

@@ -6,6 +6,7 @@ import { ColumnFilter } from '../../PredefinedConfig/Common/ColumnFilter';
 import { IRowNode } from '@ag-grid-community/core';
 import { LayoutColumnFilterAction } from '../../Redux/ActionsReducers/LayoutRedux';
 import * as Redux from 'redux';
+import { ColumnValuesFilterPredicate } from '../../AdaptableOptions/ColumnFilterOptions';
 export declare class ColumnFilterInternalApi extends ApiBase {
     /**
      * Returns Predicate Definition for given Column and Quick Filter shortcut
@@ -58,4 +59,5 @@ export declare class ColumnFilterInternalApi extends ApiBase {
     areColumnFiltersDifferent(oldFilters: ColumnFilter[], newFilters: ColumnFilter[]): boolean;
     getPredicateDefShortcuts(predicateDef: AdaptablePredicateDef): string[];
     getFilterValuesMaxNumberOfItems(column: AdaptableColumn): number | undefined;
+    getValuesFitlerPredicateIds(column: AdaptableColumn): ColumnValuesFilterPredicate[];
 }

package/src/Api/Internal/ColumnFilterInternalApi.js

@@ -206,4 +206,24 @@ export class ColumnFilterInternalApi extends ApiBase {
             return maxFilterValues;
         }
     }
+    getValuesFitlerPredicateIds(column) {
+        var _a;
+        const valuesFilterOptions = (_a = this.getOptions().columnFilterOptions) === null || _a === void 0 ? void 0 : _a.valuesFilterOptions;
+        const availablePredicates = this.getPredicateApi().getPredicateDefsByModuleScope('columnFilter');
+        let predicateIds = [];
+        if (typeof (valuesFilterOptions === null || valuesFilterOptions === void 0 ? void 0 : valuesFilterOptions.predicates) === 'function') {
+            const columnFilterContext = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { column: column });
+            predicateIds = valuesFilterOptions.predicates(columnFilterContext);
+        }
+        else if (Array.isArray(valuesFilterOptions === null || valuesFilterOptions === void 0 ? void 0 : valuesFilterOptions.predicates)) {
+            predicateIds = valuesFilterOptions.predicates;
+        }
+        return predicateIds.filter((predicateId) => {
+            const predicate = availablePredicates.find((p) => p.id === predicateId);
+            if (!predicate) {
+                return false;
+            }
+            return this.getColumnScopeApi().isColumnInScope(column, predicate.columnScope);
+        });
+    }
 }