@adaptabletools/adaptable 13.0.7 → 13.0.9

package/src/Api/FinanceApi.d.ts

@@ -1,6 +1,6 @@
 import { RowNode } from '@ag-grid-community/core';
 import { ContactColumn, ContactIntent, CountryColumn, CustomFDC3Column, CustomFDC3Intent, FDC3Intent, FinancePluginOptions, InstrumentColumn, InstrumentIntent, OrganizationColumn, PositionColumn, PositionIntent } from '../AdaptableOptions/FinancePluginOptions';
-import { ContactContext, ContactListContext, CountryContext, FDC3Context, InstrumentContext, InstrumentListContext, OrganizationContext, PortfolioContext, PositionContext } from '../types';
+import { ContactContext, ContactListContext, ContextData, CountryContext, FDC3Context, InstrumentContext, InstrumentListContext, OrganizationContext, PortfolioContext, PositionContext } from '../types';
 /**
  * Provides run-time access to the Finance Plugin
  */
@@ -13,50 +13,58 @@ export interface FinanceApi {
      * Creates FDC3 Instrument Context
      * @param instrumentColumn Instrument Column to create Context For
      * @param rowNode Row Node to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3InstrumentContext(instrumentColumn: InstrumentColumn, rowNode: RowNode): InstrumentContext;
+    createFDC3InstrumentContext(instrumentColumn: InstrumentColumn, rowNode: RowNode, data?: ContextData): InstrumentContext;
     /**
      * Creates FDC3 Instrumentlist Context
      * @param instrumentColumn Instrument Column to create Context For
      * @param rowNode Row Nodes to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3InstrumentListContext(instrumentColumn: InstrumentColumn, rowNodes: RowNode[]): InstrumentListContext;
+    createFDC3InstrumentListContext(instrumentColumn: InstrumentColumn, rowNodes: RowNode[], data?: ContextData): InstrumentListContext;
     /**
      * Creates FDC3 Position Context
      * @param instrumentColumn Position Column to create Context For
      * @param rowNode Row Node to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3PositionContext(positionColumn: PositionColumn, rowNode: RowNode): PositionContext;
+    createFDC3PositionContext(positionColumn: PositionColumn, rowNode: RowNode, data?: ContextData): PositionContext;
     /**
      * Creates FDC3 Portfolio Context
      * @param instrumentColumn Position Column to create Context For
      * @param rowNode Row Nodes to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3PortfolioContext(positionColumn: PositionColumn, rowNodes: RowNode[]): PortfolioContext;
+    createFDC3PortfolioContext(positionColumn: PositionColumn, rowNodes: RowNode[], data?: ContextData): PortfolioContext;
     /**
      * Creates FDC3 Contact Context
      * @param instrumentColumn Contact Column to create Context For
      * @param rowNode Row Node to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3ContactContext(contactColumn: ContactColumn, rowNode: RowNode): ContactContext;
+    createFDC3ContactContext(contactColumn: ContactColumn, rowNode: RowNode, data?: ContextData): ContactContext;
     /**
      * Creates FDC3 Contact List Context
      * @param instrumentColumn Contact Column to create Context For
      * @param rowNode Row Nodes to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3ContactListContext(contactColumn: ContactColumn, rowNodes: RowNode[]): ContactListContext;
+    createFDC3ContactListContext(contactColumn: ContactColumn, rowNodes: RowNode[], data?: ContextData): ContactListContext;
     /**
      * Creates FDC3 Organization Context
      * @param instrumentColumn Organization Column to create Context For
      * @param rowNode Row Node to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3OrganizationContext(organizationColumn: OrganizationColumn, rowNode: RowNode): OrganizationContext;
+    createFDC3OrganizationContext(organizationColumn: OrganizationColumn, rowNode: RowNode, data?: ContextData): OrganizationContext;
     /**
      * Creates FDC3 Country Context
      * @param instrumentColumn Country Column to create Context For
      * @param rowNode Row Node to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3CountryContext(countryColumn: CountryColumn, rowNode: RowNode): CountryContext;
+    createFDC3CountryContext(countryColumn: CountryColumn, rowNode: RowNode, data?: ContextData): CountryContext;
     /**
      * Gets Instrument Column with given Id
      * @param instrumentColumnId Column to Look

package/src/Api/FlashingCellApi.d.ts

@@ -83,10 +83,6 @@ export interface FlashingCellApi {
      * @returns flashing cell definition
      */
     unSuspendFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
-    /**
-     * Retrieves all Predicate Defs with Module Scope of Flashing Cell
-     */
-    getFlashingCellPredicateDefs(): AdaptablePredicateDef[];
     /**
      * Retrieves all Predicate Defs that match given Scope
      * @param scope the Scope to check
@@ -96,4 +92,8 @@ export interface FlashingCellApi {
      * Clears all Cells and Rows which have been flashed (primarily used if duration is 'Always')
      */
     clearGridFlashing(): void;
+    /**
+     * Are there any cells/rows currently being flashed
+     */
+    areCellsCurrentlyFlashed(): boolean;
 }

package/src/Api/FormatColumnApi.d.ts

@@ -177,10 +177,6 @@ export interface FormatColumnApi {
      * @param formatColumn Format Column
      */
     hasCustomDisplayFormatter(formatColumn: FormatColumn): boolean;
-    /**
-     * Returns all Predicates usable in Format Columns
-     */
-    getFormatColumnPredicateDefs(): AdaptablePredicateDef[];
     /**
      * Returns all Predicates appropriate for the given Scope
      * @param scope Scope to check

package/src/Api/GridApi.d.ts

@@ -24,7 +24,7 @@ export interface GridApi {
      * Repopulates grid with given data
      * @param data any data from any datasource that is suitable for AG Grid
      */
-    setGridData(data: any): void;
+    setGridData(data: any[]): void;
     /**
      * Retrieves all data from the grid
      */

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

@@ -10,6 +10,7 @@ import { CustomSortApi } from '../CustomSortApi';
 import { DashboardApi } from '../DashboardApi';
 import { ToolPanelApi } from '../ToolPanelApi';
 import { DataSetApi } from '../DataSetApi';
+import { EntitlementApi } from '../EntitlementApi';
 import { EventApi } from '../EventApi';
 import { PluginsApi } from '../PluginsApi';
 import { ExportApi } from '../ExportApi';
@@ -56,6 +57,7 @@ export declare class AdaptableApiImpl implements AdaptableApi {
     customSortApi: CustomSortApi;
     dashboardApi: DashboardApi;
     dataSetApi: DataSetApi;
+    entitlementApi: EntitlementApi;
     eventApi: EventApi;
     exportApi: ExportApi;
     formatColumnApi: FormatColumnApi;

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

@@ -37,7 +37,6 @@ export declare class AlertApiImpl extends ApiBase implements AlertApi {
     showAlertWarning(alertHeader: string, alertMessage: string, alertProperties?: AlertProperties): void;
     showAlertError(alertHeader: string, alertMessage: string, alertProperties?: AlertProperties): void;
     showAlertPopup(): void;
-    getAlertPredicateDefs(): AdaptablePredicateDef[];
     getAlertPredicateDefsForScope(scope: AdaptableScope): AdaptablePredicateDef[];
     editAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
     suspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;

package/src/Api/Implementation/AlertApiImpl.js

@@ -279,11 +279,10 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
     showAlertPopup() {
         this.showModulePopup(ModuleConstants.AlertModuleId);
     }
-    getAlertPredicateDefs() {
-        return this.adaptable.api.predicateApi.getPredicateDefsByModuleScope('alert');
-    }
     getAlertPredicateDefsForScope(scope) {
-        return this.getAlertPredicateDefs().filter((predicateDef) => this.adaptable.api.scopeApi.isScopeInScope(scope, predicateDef.columnScope));
+        return this.getAdaptableApi()
+            .predicateApi.getAlertPredicateDefs()
+            .filter((predicateDef) => this.adaptable.api.scopeApi.isScopeInScope(scope, predicateDef.columnScope));
     }
     editAlertDefinition(alertDefinition) {
         this.dispatchAction(AlertRedux.AlertDefinitionEdit(alertDefinition));

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

@@ -11,7 +11,8 @@ import { ActionOptions, ContainerOptions, DashboardOptions, EditOptions, FilterO
 import { NotificationsOptions } from '../../AdaptableOptions/NotificationsOptions';
 import { ToolPanelOptions } from '../../AdaptableOptions/ToolPanelOptions';
 import { ModuleParams } from '../../View/Components/SharedProps/ModuleViewPopupProps';
-import { AdaptableQLOptions, ExpressionOptions } from '../../AdaptableOptions/AdaptableQLOptions';
+import { AdaptableQLOptions } from '../../AdaptableOptions/AdaptableQLOptions';
+import { ExpressionOptions } from '../../AdaptableOptions/ExpressionOptions';
 import { AlertOptions } from '../../AdaptableOptions/AlertOptions';
 import { ColumnOptions } from '../../AdaptableOptions/ColumnOptions';
 export declare abstract class ApiBase {

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

@@ -0,0 +1,11 @@
+import { ApiBase } from './ApiBase';
+import { EntitlementApi } from '../EntitlementApi';
+import { AdaptableModule, AccessLevel, AdaptableObject } from '../../types';
+export declare class EntitlementApiImpl extends ApiBase implements EntitlementApi {
+    private getEntitlementService;
+    getEntitlementAccessLevelForModule(adaptableModule: AdaptableModule): AccessLevel;
+    isObjectReadonly(object: AdaptableObject): boolean;
+    isModuleHiddenEntitlement(adaptableModule: AdaptableModule): boolean;
+    isModuleFullEntitlement(adaptableModule: AdaptableModule): boolean;
+    isModuleReadOnlyEntitlement(adaptableModule: AdaptableModule): boolean;
+}

package/src/Api/Implementation/EntitlementApiImpl.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntitlementApiImpl = void 0;
+const ApiBase_1 = require("./ApiBase");
+class EntitlementApiImpl extends ApiBase_1.ApiBase {
+    getEntitlementService() {
+        return this.getAdaptableApi().internalApi.getEntitlementService();
+    }
+    getEntitlementAccessLevelForModule(adaptableModule) {
+        return this.getEntitlementService().getEntitlementAccessLevelForModule(adaptableModule);
+    }
+    isObjectReadonly(object) {
+        return object.IsReadOnly;
+    }
+    isModuleHiddenEntitlement(adaptableModule) {
+        return this.getEntitlementService().isModuleHiddenEntitlement(adaptableModule);
+    }
+    isModuleFullEntitlement(adaptableModule) {
+        return this.getEntitlementService().isModuleFullEntitlement(adaptableModule);
+    }
+    isModuleReadOnlyEntitlement(adaptableModule) {
+        return this.getEntitlementService().isModuleReadOnlyEntitlement(adaptableModule);
+    }
+}
+exports.EntitlementApiImpl = EntitlementApiImpl;

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

@@ -4,14 +4,12 @@ import { ApiBase } from './ApiBase';
 import { FilterApi } from '../FilterApi';
 import { AdaptablePredicateDef, ColumnFilterDef } from '../../PredefinedConfig/Common/AdaptablePredicate';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
-import { ColumnFilter, GridCell, SystemFilterPredicateIds } from '../../types';
+import { ColumnFilter, GridCell } from '../../types';
 import { RowNode } from '@ag-grid-community/core';
 export declare class FilterApiImpl extends ApiBase implements FilterApi {
-    getAllSystemFilterIds(): SystemFilterPredicateIds;
     findPredicateDefByShortcut(shortcut: string, column: AdaptableColumn): AdaptablePredicateDef;
     getFilterPredicateDefsForColumn(column: AdaptableColumn): AdaptablePredicateDef[];
     getFilterPredicateDefsForColumnId(columnId: string): AdaptablePredicateDef[] | undefined;
-    private getAllFilterPredicates;
     showQuickFilterBar(): void;
     hideQuickFilterBar(): void;
     isQuickFilterAvailable(): boolean;

package/src/Api/Implementation/FilterApiImpl.js

@@ -9,34 +9,18 @@ const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Exte
 const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
 class FilterApiImpl extends ApiBase_1.ApiBase {
-    getAllSystemFilterIds() {
-        const systemFilters = this.getFilterOptions().systemFilters;
-        if (typeof systemFilters === 'function') {
-            const systemFiltersPredicateContext = {
-                adaptableApi: this.adaptable.api,
-                systemFiltersPredicateDefs: this.adaptable.api.predicateApi.getSystemPredicateDefs(),
-            };
-            return systemFilters(systemFiltersPredicateContext);
-        }
-        return systemFilters;
-    }
     findPredicateDefByShortcut(shortcut, column) {
         return this.getFilterPredicateDefsForColumn(column).find((i) => { var _a; return (_a = i.shortcuts) === null || _a === void 0 ? void 0 : _a.includes(shortcut); });
     }
     getFilterPredicateDefsForColumn(column) {
-        return this.getAllFilterPredicates().filter((predicate) => this.adaptable.api.scopeApi.isColumnInScope(column, predicate.columnScope));
+        return this.getAdaptableApi()
+            .predicateApi.getFilterPredicateDefs()
+            .filter((predicate) => this.adaptable.api.scopeApi.isColumnInScope(column, predicate.columnScope));
     }
     getFilterPredicateDefsForColumnId(columnId) {
-        const column = this.adaptable.api.columnApi.getColumnFromId(columnId);
+        const column = this.getAdaptableApi().columnApi.getColumnFromId(columnId);
         return column ? this.getFilterPredicateDefsForColumn(column) : undefined;
     }
-    getAllFilterPredicates() {
-        var _a;
-        return [
-            ...(_a = this.getAllSystemFilterIds()) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.adaptable.api.predicateApi.getPredicateDefById(predicateId)),
-            ...this.adaptable.api.predicateApi.getCustomPredicateDefs(),
-        ].filter((predicateDef) => predicateDef.moduleScope.includes('filter'));
-    }
     showQuickFilterBar() {
         this.dispatchAction(SystemRedux.SystemQuickFilterBarShow());
     }

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

@@ -19,7 +19,7 @@ export declare class FlashingCellApiImpl extends ApiBase implements FlashingCell
     unSuspendFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
     addFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): FlashingCellDefinition[];
     editFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): FlashingCellDefinition[];
-    getFlashingCellPredicateDefs(): AdaptablePredicateDef[];
     getFlashingCellPredicateDefsForScope(scope: AdaptableScope): AdaptablePredicateDef[];
     clearGridFlashing(): void;
+    areCellsCurrentlyFlashed(): boolean;
 }

package/src/Api/Implementation/FlashingCellApiImpl.js

@@ -103,15 +103,18 @@ class FlashingCellApiImpl extends ApiBase_1.ApiBase {
         });
         return flashingCellDefinitions === null || flashingCellDefinitions === void 0 ? void 0 : flashingCellDefinitions.map((flashingCell) => this.getFlashingCellDefinitionById(flashingCell === null || flashingCell === void 0 ? void 0 : flashingCell.Uuid));
     }
-    getFlashingCellPredicateDefs() {
-        return this.adaptable.api.predicateApi.getPredicateDefsByModuleScope('flashingcell');
-    }
     getFlashingCellPredicateDefsForScope(scope) {
-        return this.getFlashingCellPredicateDefs().filter((predicateDef) => this.adaptable.api.scopeApi.isScopeInScope(scope, predicateDef.columnScope));
+        return this.getAdaptableApi()
+            .predicateApi.getFlashingCellPredicateDefs()
+            .filter((predicateDef) => this.adaptable.api.scopeApi.isScopeInScope(scope, predicateDef.columnScope));
     }
     clearGridFlashing() {
         const currentFlashingCells = this.getAdaptableState().System.AdaptableFlashingCells;
         this.dispatchAction(SystemRedux.SystemFlashingCellDeleteAll());
     }
+    areCellsCurrentlyFlashed() {
+        const currentFlashingCells = this.getAdaptableState().System.AdaptableFlashingCells;
+        return currentFlashingCells.keys != null;
+    }
 }
 exports.FlashingCellApiImpl = FlashingCellApiImpl;

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

@@ -1,7 +1,7 @@
 import { AdaptableStyle } from '../../PredefinedConfig/Common/AdaptableStyle';
 import { ApiBase, LayoutAssociatedObjectLoadConfig } from './ApiBase';
 import { FormatColumnApi } from '../FormatColumnApi';
-import { FormatColumnState, FormatColumn } from '../../PredefinedConfig/FormatColumnState';
+import { FormatColumn, FormatColumnState } from '../../PredefinedConfig/FormatColumnState';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { RowNode } from '@ag-grid-community/core';
 import { AdaptableFormat } from '../../types';
@@ -54,7 +54,6 @@ export declare class FormatColumnApiImpl extends ApiBase implements FormatColumn
     getStringFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
     getDateFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
     hasCustomDisplayFormatter(formatColumn: FormatColumn): boolean;
-    getFormatColumnPredicateDefs(): AdaptablePredicateDef[];
     getFormatColumnDefsForScope(scope: AdaptableScope): AdaptablePredicateDef[];
     getFormatColumnsRelevantForColumn(formatColumns: FormatColumn[], column: AdaptableColumn, params: {
         node: RowNode;

package/src/Api/Implementation/FormatColumnApiImpl.js

@@ -9,6 +9,7 @@ const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Exten
 const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
 const FormatHelper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/FormatHelper"));
 const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectFactory"));
+const Helper_1 = require("../../Utilities/Helpers/Helper");
 class FormatColumnApiImpl extends ApiBase_1.ApiBase {
     getFormatColumnState() {
         return this.getAdaptableState().FormatColumn;
@@ -169,7 +170,7 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
         }, customDisplayFormatterContext);
     }
     getNumberFormattedValue(value, node, abColumn, options) {
-        if (!value) {
+        if (Helper_1.Helper.objectNotExists(value)) {
             return undefined;
         }
         const preparedValue = this.applyCustomFormatters(value, node, abColumn, options);
@@ -202,11 +203,10 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
         }
         return true;
     }
-    getFormatColumnPredicateDefs() {
-        return this.adaptable.api.predicateApi.getPredicateDefsByModuleScope('formatColumn');
-    }
     getFormatColumnDefsForScope(scope) {
-        return this.getFormatColumnPredicateDefs().filter((predicateDef) => this.adaptable.api.scopeApi.isScopeInScope(scope, predicateDef.columnScope));
+        return this.getAdaptableApi()
+            .predicateApi.getFormatColumnPredicateDefs()
+            .filter((predicateDef) => this.adaptable.api.scopeApi.isScopeInScope(scope, predicateDef.columnScope));
     }
     getFormatColumnsRelevantForColumn(formatColumns, column, params) {
         return formatColumns.filter((formatColumn) => this.isFormatColumnRelevantForColumn(formatColumn, column, params));

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

@@ -16,7 +16,7 @@ import { RowsHighlightInfo } from '../../PredefinedConfig/Common/RowsHighlightIn
 import { AccessLevel } from '../../PredefinedConfig/Common/Entitlement';
 export declare class GridApiImpl extends ApiBase implements GridApi {
     getGridState(): GridState;
-    setGridData(dataSource: any): void;
+    setGridData(dataSource: any[]): void;
     getGridData(): any[];
     getFilteredData(): any[];
     loadGridData(dataSource: any): void;

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

@@ -1,12 +1,12 @@
 import { ApiBase } from './ApiBase';
 import { PredicateApi } from '../PredicateApi';
-import { AdaptablePredicateDef, AdaptablePredicate, PredicateDefHandlerParams, ModuleScope } from '../../PredefinedConfig/Common/AdaptablePredicate';
+import { AdaptablePredicateDef, AdaptablePredicate, PredicateDefHandlerParams, PredicateModuleScope } from '../../PredefinedConfig/Common/AdaptablePredicate';
 import { AdaptableColumnDataType, SystemFilterPredicateId } from '../../types';
 export declare class PredicateApiImpl extends ApiBase implements PredicateApi {
     getPredicateDefs(): AdaptablePredicateDef[];
     getSystemPredicateDefs(): AdaptablePredicateDef[];
     getCustomPredicateDefs(): AdaptablePredicateDef[];
-    getPredicateDefsByModuleScope(moduleScope: ModuleScope): AdaptablePredicateDef[];
+    getPredicateDefsByModuleScope(moduleScope: PredicateModuleScope): AdaptablePredicateDef[];
     getPredicateDefById(predicateId: string): AdaptablePredicateDef;
     getSystemPredicateDefById(predicateId: string): AdaptablePredicateDef;
     getCustomPredicateDefById(predicateId: string): AdaptablePredicateDef;
@@ -15,4 +15,12 @@ export declare class PredicateApiImpl extends ApiBase implements PredicateApi {
     handlePredicate(predicate: AdaptablePredicate | undefined, params: Omit<PredicateDefHandlerParams, 'api' | 'inputs'>, defaultReturn: boolean): boolean;
     getEqualityPredicateForDataType(dataType: AdaptableColumnDataType): SystemFilterPredicateId;
     hasPredicateValues(predicate: AdaptablePredicate): boolean;
+    private getSystemFilterPredicateIds;
+    getFilterPredicateDefs(): AdaptablePredicateDef[];
+    private getSystemAlertPredicateIds;
+    getAlertPredicateDefs(): AdaptablePredicateDef[];
+    private getSystemFormatColumnPredicateIds;
+    getFormatColumnPredicateDefs(): AdaptablePredicateDef[];
+    private getSystemFlashingCellPredicateIds;
+    getFlashingCellPredicateDefs(): AdaptablePredicateDef[];
 }

package/src/Api/Implementation/PredicateApiImpl.js

@@ -103,5 +103,88 @@ class PredicateApiImpl extends ApiBase_1.ApiBase {
     hasPredicateValues(predicate) {
         return (predicate === null || predicate === void 0 ? void 0 : predicate.PredicateId) === 'Values' || (predicate === null || predicate === void 0 ? void 0 : predicate.PredicateId) === 'ExcludeValues';
     }
+    getSystemFilterPredicateIds() {
+        // for now we still need to get the old ones in case they have been provided
+        // however they have been deprectated and they are not populated by AdapTable
+        const oldSystemFilterPredicates = this.getFilterOptions().systemFilters;
+        if (oldSystemFilterPredicates) {
+            return oldSystemFilterPredicates;
+        }
+        // if old list not provided use the new property in Predicate Options
+        const systemFilterPredicates = this.getAdaptableQLOptions().predicateOptions.systemFilterPredicates;
+        if (typeof systemFilterPredicates === 'function') {
+            const systemPredicateContext = {
+                adaptableApi: this.adaptable.api,
+                systemPredicateDefs: this.getSystemPredicateDefs().filter((p) => p.moduleScope.includes('filter')),
+                moduleScope: 'filter',
+            };
+            return systemFilterPredicates(systemPredicateContext);
+        }
+        return systemFilterPredicates;
+    }
+    getFilterPredicateDefs() {
+        var _a;
+        return [
+            ...(_a = this.getSystemFilterPredicateIds()) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.getPredicateDefById(predicateId)),
+            ...this.getCustomPredicateDefs(),
+        ].filter((predicateDef) => predicateDef.moduleScope.includes('filter'));
+    }
+    getSystemAlertPredicateIds() {
+        const systemAlertPredicates = this.getAdaptableQLOptions().predicateOptions.systemAlertPredicates;
+        if (typeof systemAlertPredicates === 'function') {
+            const systemPredicateContext = {
+                adaptableApi: this.adaptable.api,
+                systemPredicateDefs: this.getSystemPredicateDefs().filter((p) => p.moduleScope.includes('alert')),
+                moduleScope: 'alert',
+            };
+            return systemAlertPredicates(systemPredicateContext);
+        }
+        return systemAlertPredicates;
+    }
+    getAlertPredicateDefs() {
+        var _a;
+        return [
+            ...(_a = this.getSystemAlertPredicateIds()) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.getPredicateDefById(predicateId)),
+            ...this.getCustomPredicateDefs(),
+        ].filter((predicateDef) => predicateDef.moduleScope.includes('alert'));
+    }
+    getSystemFormatColumnPredicateIds() {
+        const systemFormatColumnPredicates = this.getAdaptableQLOptions().predicateOptions.systemFormatColumnPredicates;
+        if (typeof systemFormatColumnPredicates === 'function') {
+            const systemPredicateContext = {
+                adaptableApi: this.adaptable.api,
+                systemPredicateDefs: this.getSystemPredicateDefs().filter((p) => p.moduleScope.includes('formatColumn')),
+                moduleScope: 'formatColumn',
+            };
+            return systemFormatColumnPredicates(systemPredicateContext);
+        }
+        return systemFormatColumnPredicates;
+    }
+    getFormatColumnPredicateDefs() {
+        var _a;
+        return [
+            ...(_a = this.getSystemFormatColumnPredicateIds()) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.getPredicateDefById(predicateId)),
+            ...this.getCustomPredicateDefs(),
+        ].filter((predicateDef) => predicateDef.moduleScope.includes('formatColumn'));
+    }
+    getSystemFlashingCellPredicateIds() {
+        const systemFlashingCellPredicates = this.getAdaptableQLOptions().predicateOptions.systemFlashingCellPredicates;
+        if (typeof systemFlashingCellPredicates === 'function') {
+            const systemPredicateContext = {
+                adaptableApi: this.adaptable.api,
+                systemPredicateDefs: this.getSystemPredicateDefs().filter((p) => p.moduleScope.includes('flashingcell')),
+                moduleScope: 'flashingcell',
+            };
+            return systemFlashingCellPredicates(systemPredicateContext);
+        }
+        return systemFlashingCellPredicates;
+    }
+    getFlashingCellPredicateDefs() {
+        var _a;
+        return [
+            ...(_a = this.getSystemFlashingCellPredicateIds()) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.getPredicateDefById(predicateId)),
+            ...this.getCustomPredicateDefs(),
+        ].filter((predicateDef) => predicateDef.moduleScope.includes('flashingcell'));
+    }
 }
 exports.PredicateApiImpl = PredicateApiImpl;

package/src/Api/InternalApi.d.ts

@@ -31,7 +31,7 @@ import { AdaptableForm } from '../PredefinedConfig/Common/AdaptableForm';
 import { AlertButtonForm } from '../PredefinedConfig/AlertState';
 import { AdaptableFrameworkComponent } from '../AdaptableOptions/AdaptableFrameworkComponent';
 import { IMetamodelService } from '../Utilities/Services/Interface/IMetamodelService';
-import { RowNode } from '@ag-grid-community/core';
+import { GridOptions, RowNode } from '@ag-grid-community/core';
 import { IModuleCollection } from '../Strategy/Interface/IModule';
 import { AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
 import { IRowEditService } from '../Utilities/Services/Interface/IRowEditService';
@@ -88,7 +88,7 @@ export interface InternalApi {
     updateCurrentDraftLayout(layout: Layout): void;
     getPrimaryKey(): any;
     getAdaptableInstance(): IAdaptable;
-    getAgGridInstance(): any;
+    getAgGridInstance(): GridOptions;
     getPredefinedConfig(): any;
     getState(): AdaptableState;
     getAdaptableOptions(): AdaptableOptions;

package/src/Api/PredicateApi.d.ts

@@ -1,5 +1,5 @@
 import { AdaptableColumnDataType, SystemFilterPredicateId } from '../../types';
-import { AdaptablePredicateDef, AdaptablePredicate, PredicateDefHandlerParams, ModuleScope } from '../PredefinedConfig/Common/AdaptablePredicate';
+import { AdaptablePredicateDef, AdaptablePredicate, PredicateDefHandlerParams, PredicateModuleScope } from '../PredefinedConfig/Common/AdaptablePredicate';
 /**
  * Functions which manage the Predicate object in AdapTable
  */
@@ -20,7 +20,7 @@ export interface PredicateApi {
      * Retrieves all Predicate Definitions for given Module Scope
      * @param moduleScope Module Scope to use
      */
-    getPredicateDefsByModuleScope(moduleScope: ModuleScope): AdaptablePredicateDef[];
+    getPredicateDefsByModuleScope(moduleScope: PredicateModuleScope): AdaptablePredicateDef[];
     /**
      * Gets the Predicate Definition for a given Id
      * @param predicateId Id of Predicate Definition
@@ -64,4 +64,20 @@ export interface PredicateApi {
      * @param predicate
      */
     hasPredicateValues(predicate: AdaptablePredicate): boolean;
+    /**
+     * Get all Filter Predicate Definitions - System and Custom
+     */
+    getFilterPredicateDefs(): AdaptablePredicateDef[];
+    /**
+     * Get all Alert Predicate Definitions - System and Custom
+     */
+    getAlertPredicateDefs(): AdaptablePredicateDef[];
+    /**
+     * Get all Format Column Predicate Definitions - System and Custom
+     */
+    getFormatColumnPredicateDefs(): AdaptablePredicateDef[];
+    /**
+     * Get all Flashing Cell Predicate Definitions - System and Custom
+     */
+    getFlashingCellPredicateDefs(): AdaptablePredicateDef[];
 }

package/src/PredefinedConfig/AlertState.d.ts

@@ -126,4 +126,11 @@ export interface AlertProperties {
      */
     PreventEdit?: boolean;
 }
-export declare type SystemAlertPredicateId = 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'True' | 'False' | 'PercentChange' | 'PrimaryKeyDuplicate' | 'ExistingValuesOnly' | 'NoDuplicateValues' | 'IsNumeric' | 'IsNotNumeric' | 'AddedRow' | 'RemovedRow' | 'Any';
+/**
+ * Array containing all System Alert Predicates
+ */
+export declare type SystemAlertPredicateIds = SystemAlertPredicateId[];
+/**
+ * List of System Predicates available for Alerts
+ */
+export declare type SystemAlertPredicateId = 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'WorkDay' | 'Holiday' | 'True' | 'False' | 'PercentChange' | 'PrimaryKeyDuplicate' | 'ExistingValuesOnly' | 'NoDuplicateValues' | 'IsNumeric' | 'IsNotNumeric' | 'AddedRow' | 'RemovedRow' | 'Any';

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

@@ -34,7 +34,7 @@ export interface AdaptablePredicateDef {
     /**
      * Modules where the Predicate can run
      */
-    moduleScope: ModuleScope[];
+    moduleScope: PredicateModuleScope[];
     /**
      * Inputs the Predicate can take
      */
@@ -103,12 +103,15 @@ export interface PredicateDefHandlerParams {
 export interface PredicateDefToStringParams {
     inputs: any[];
 }
-export declare type ModuleScope = 'filter' | 'alert' | 'flashingcell' | 'formatColumn';
+export declare type PredicateModuleScope = 'filter' | 'alert' | 'flashingcell' | 'formatColumn';
 /**
  * Array of Predicate Defs which are shipped by AdapTable
  */
 export declare const SystemPredicateDefs: AdaptablePredicateDef[];
 export declare const SystemFilterPredicateIds: string[];
+export declare const SystemAlertPredicateIds: string[];
+export declare const SystemFormatColumnPredicateIds: string[];
+export declare const SystemFlashingCellPredicateIds: string[];
 export interface ColumnFilterDef {
     dataType: AdaptableColumnDataType;
     predicate: AdaptablePredicateDef;

package/src/PredefinedConfig/Common/AdaptablePredicate.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SystemFilterPredicateIds = exports.SystemPredicateDefs = void 0;
+exports.SystemFlashingCellPredicateIds = exports.SystemFormatColumnPredicateIds = exports.SystemAlertPredicateIds = exports.SystemFilterPredicateIds = exports.SystemPredicateDefs = void 0;
 const tslib_1 = require("tslib");
 const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
 const isToday_1 = tslib_1.__importDefault(require("date-fns/isToday"));
@@ -603,3 +603,6 @@ exports.SystemPredicateDefs = [
     },
 ];
 exports.SystemFilterPredicateIds = exports.SystemPredicateDefs.filter((p) => p.moduleScope.includes('filter')).map((p) => p.id);
+exports.SystemAlertPredicateIds = exports.SystemPredicateDefs.filter((p) => p.moduleScope.includes('alert')).map((p) => p.id);
+exports.SystemFormatColumnPredicateIds = exports.SystemPredicateDefs.filter((p) => p.moduleScope.includes('formatColumn')).map((p) => p.id);
+exports.SystemFlashingCellPredicateIds = exports.SystemPredicateDefs.filter((p) => p.moduleScope.includes('flashingcell')).map((p) => p.id);

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

@@ -24,6 +24,6 @@ export interface ColumnFilterPredicate extends AdaptablePredicate {
  */
 export declare type SystemFilterPredicateIds = SystemFilterPredicateId[];
 /**
- * List of all the Filter Predicates shipped by AdapTable
+ * List of System Predicates available for Filters
  */
-export declare type SystemFilterPredicateId = 'Values' | 'ExcludeValues' | 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'InRange' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'True' | 'False' | 'BooleanToggle';
+export declare type SystemFilterPredicateId = 'Values' | 'ExcludeValues' | 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'InRange' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'WorkDay' | 'Holiday' | 'True' | 'False' | 'BooleanToggle';

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

@@ -241,3 +241,4 @@ export declare type FDC3ContextType = 'fdc3.instrument' | 'fdc3.instrumentList'
 export interface CustomFDC3Context extends FDC3Context {
     type: any;
 }
+export declare type ContextData = Record<string, unknown>;

package/src/PredefinedConfig/FlashingCellState.d.ts

@@ -65,4 +65,11 @@ export interface FlashingCellDefinition extends SuspendableObject {
      */
     FlashDuration?: number | 'always';
 }
-export declare type SystemFlashingCellPredicateId = 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'True' | 'False' | 'PercentChange' | 'IsNumeric' | 'IsNotNumeric' | 'Any';
+/**
+ * Array containing all System Flashing Cell Predicates
+ */
+export declare type SystemFlashingCellPredicateIds = SystemFlashingCellPredicateId[];
+/**
+ * List of System Predicates available for Flashing Cells
+ */
+export declare type SystemFlashingCellPredicateId = 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'WorkDay' | 'Holiday' | 'True' | 'False' | 'PercentChange' | 'IsNumeric' | 'IsNotNumeric' | 'Any';