@adaptabletools/adaptable 13.0.7 → 13.0.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "13.0.7",
+  "version": "13.0.9",
   "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1667316496830;
+declare const _default: 1667915288467;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1667316496830;
+exports.default = 1667915288467;

package/src/AdaptableOptions/AdaptableQLOptions.d.ts

@@ -1,13 +1,9 @@
-import { ExpressionFunction } from '../parser/src/types';
 import { AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
-import { AdaptableModule, AdaptableQLModule, AdaptableQLModules } from '../PredefinedConfig/Common/Types';
+import { AdaptableQLModule, AdaptableQLModules } from '../PredefinedConfig/Common/Types';
 import { BaseContext } from '../PredefinedConfig/Common/BaseContext';
-import { AdaptableColumn, AdaptableColumnBase } from '../PredefinedConfig/Common/AdaptableColumn';
-import { BooleanFunctionName } from '../Utilities/ExpressionFunctions/booleanExpressionFunctions';
-import { ScalarFunctionName } from '../Utilities/ExpressionFunctions/scalarExpressionFunctions';
-import { ObservableFunctionName } from '../Utilities/ExpressionFunctions/observableExpressionFunctions';
-import { AggregatedBooleanFunctionName } from '../Utilities/ExpressionFunctions/aggregatedBooleanExpressionFunctions';
-import { AggregatedScalarFunctionName } from '../Utilities/ExpressionFunctions/aggregatedScalarExpressionFunctions';
+import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
+import { ExpressionOptions } from './ExpressionOptions';
+import { PredicateOptions } from './PredicateOptions';
 /**
  * Options for managing AdaptableQL - the Adaptable Query Language which evaluates Predicates and Expressions
  */
@@ -37,6 +33,11 @@ export interface AdaptableQLOptions {
      *
      */
     expressionOptions?: ExpressionOptions;
+    /**
+     * Options for managing Predicates in AdaptableQL
+     *
+     */
+    predicateOptions?: PredicateOptions;
     /**
      * Definitions for Custom provided Predicates
      */
@@ -48,194 +49,6 @@ export interface AdaptableQLOptions {
      */
     displayColumnFriendlyNamesForExpressions?: boolean;
 }
-/**
- * Options for managing Expressions using AdaptableQL
- */
-export interface ExpressionOptions {
-    /**
-     * System (built-in) Boolean Expression Functions available in AdaptableQL
-     *
-     * @defaultValue null (sets all)
-     * @gridInfoItem
-     */
-    systemBooleanFunctions?: BooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => BooleanFunctionName[]);
-    /**
-     * Custom (user defined) Boolean Expression Functions available in AdaptableQL
-     *
-     * @defaultValue null (none)
-     * @gridInfoItem
-     */
-    customBooleanFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => Record<string, ExpressionFunction>);
-    /**
-     * System (built-in) Scalar Expression Functions available in AdaptableQL
-     *
-     * @defaultValue null (sets all)
-     * @gridInfoItem
-     */
-    systemScalarFunctions?: ScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => ScalarFunctionName[]);
-    /**
-     * Custom (user defined) Scalar Expression Functions available in AdaptableQL
-     *
-     * @defaultValue null (none)
-     * @gridInfoItem
-     */
-    customScalarFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => Record<string, ExpressionFunction>);
-    /**
-     * System (built-in) Observable Expression Functions available in AdaptableQL
-     *
-     * @defaultValue null (sets all)
-     * @gridInfoItem
-     */
-    systemObservableFunctions?: ObservableFunctionName[] | ((context: GlobalExpressionFunctionsContext<ObservableFunctionName>) => ObservableFunctionName[]);
-    /**
-     * System (built-in) AggregatedBoolean Expression Functions available in AdaptableQL
-     *
-     * @defaultValue null (sets all)
-     * @gridInfoItem
-     */
-    systemAggregatedBooleanFunctions?: AggregatedBooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedBooleanFunctionName>) => AggregatedBooleanFunctionName[]);
-    /**
-     * System (built-in) AggregatedScalar Expression Functions available in AdaptableQL
-     *
-     * @defaultValue undefined (sets all)
-     * @gridInfoItem
-     */
-    systemAggregatedScalarFunctions?: AggregatedScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedScalarFunctionName>) => AggregatedScalarFunctionName[]);
-    /**
-     * Module specific ExpressionFunctions; if not defined, it falls back to the generally defined system and custom values
-     *
-     * @defaultValue undefined (defaults to available system & custom values)
-     * @gridInfoItem
-     */
-    moduleExpressionFunctions?: ModuleExpressionFunctionsMap | ((context: ModuleExpressionFunctionsContext) => ModuleExpressionFunctions | undefined);
-    /**
-     * Specifies if a given column can be included in Queries
-     */
-    isColumnQueryable?: (queryableColumnContext: QueryableColumnContext) => boolean;
-    /**
-     * Validate Expressions before they can be run or saved
-     *
-     * @defaultValue true
-     * @gridInfoItem
-     */
-    performExpressionValidation?: boolean;
-    /**
-     * Maximum time (in milliseconds) to hold a Data Change event in a trailing timeframe (see observableExpressionFunctions); value is capped at 86400000 (~24 hours) for performance reasons
-     *
-     * @defaultValue 28800000 (~8 hours)
-     * @gridInfoItem
-     */
-    maxTimeframeSize?: number;
-    /**
-     * Custom query variables allow values to be attached to variables so that a single value can easily be expressed multiple times within a query, or quickly changed to affect the results of a query. Variables are evaluated synchronously with each expression evaluation.
-     */
-    customQueryVariables?: Record<string, string | number | boolean | Date | ((context: CustomQueryVariableContext) => string | number | boolean | Date)>;
-}
-/**
- * Module specific Expression Functions
- */
-export declare type ModuleExpressionFunctionsMap = Partial<Record<AdaptableModule, ModuleExpressionFunctions>>;
-/**
- * Type specific Expression Functions
- */
-export interface ModuleExpressionFunctions {
-    /**
-     * System (built-in) Boolean Expression Functions available in AdaptableQL
-     *
-     * @defaultValue null (sets all)
-     * @gridInfoItem
-     */
-    systemBooleanFunctions?: BooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => BooleanFunctionName[]);
-    /**
-     * Custom (user defined) Boolean Expression Functions available in AdaptableQL
-     *
-     * @defaultValue null (none)
-     * @gridInfoItem
-     */
-    customBooleanFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => Record<string, ExpressionFunction>);
-    /**
-     * System (built-in) Scalar Expression Functions available in AdaptableQL
-     *
-     * @defaultValue null (sets all)
-     * @gridInfoItem
-     */
-    systemScalarFunctions?: ScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => ScalarFunctionName[]);
-    /**
-     * Custom (user defined) Scalar Expression Functions available in AdaptableQL
-     *
-     * @defaultValue null (none)
-     * @gridInfoItem
-     */
-    customScalarFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => Record<string, ExpressionFunction>);
-    /**
-     * System (built-in) Observable Expression Functions available in AdaptableQL
-     *
-     * @defaultValue null (sets all)
-     * @gridInfoItem
-     */
-    systemObservableFunctions?: ObservableFunctionName[] | ((context: GlobalExpressionFunctionsContext<ObservableFunctionName>) => ObservableFunctionName[]);
-    /**
-     * System (built-in) AggregatedBoolean Expression Functions available in AdaptableQL
-     *
-     * @defaultValue null (sets all)
-     * @gridInfoItem
-     */
-    systemAggregatedBooleanFunctions?: AggregatedBooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedBooleanFunctionName>) => AggregatedBooleanFunctionName[]);
-    /**
-     * System (built-in) AggregatedScalar Expression Functions available in AdaptableQL
-     *
-     * @defaultValue null (sets all)
-     * @gridInfoItem
-     */
-    systemAggregatedScalarFunctions?: AggregatedScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedScalarFunctionName>) => AggregatedScalarFunctionName[]);
-}
-/**
- * Context provided to global expression functions properties property callback
- */
-export interface GlobalExpressionFunctionsContext<T> extends BaseContext {
-    /**
-     * The names of all expression functions available in this context
-     */
-    availableExpressionFunctionNames: T[];
-}
-/**
- * Context provided to ExpressionOptions.moduleExpressionFunctions property callback
- */
-export interface ModuleExpressionFunctionsContext extends BaseContext {
-    /**
-     * The Adaptable Module requesting the expression functions
-     */
-    module: AdaptableModule;
-    /**
-     * The global boolean expression functions
-     */
-    availableBooleanFunctionNames: BooleanFunctionName[];
-    /**
-     * The global scalar expression functions
-     */
-    availableScalarFunctionNames: ScalarFunctionName[];
-    /**
-     * The global observable expression functions
-     */
-    availableObservableFunctionNames: ObservableFunctionName[];
-    /**
-     * The global aggregated boolean expression functions
-     */
-    availableAggregatedBooleanFunctionNames: AggregatedBooleanFunctionName[];
-    /**
-     * The global aggregated scalar expression functions
-     */
-    availableAggregatedScalarFunctionNames: AggregatedScalarFunctionName[];
-}
-/**
- * Context passed when evaluating `ExpressionOptions.customQueryVariables`
- */
-export interface CustomQueryVariableContext extends BaseContext {
-    /**
-     * Optional variable arguments
-     */
-    args?: any[];
-}
 /**
  * Context passed when evaluating `AdaptableQLOptions.evaluateExpressionExternally()`
  */
@@ -253,12 +66,3 @@ export interface EvaluateExpressionExternallyContext extends BaseContext {
      */
     referencedColumns?: AdaptableColumn[];
 }
-/**
- * Context passed when evaluating Queryable Columns
- */
-export interface QueryableColumnContext extends BaseContext {
-    /**
-     * Basic Column Info - just ColumnId, DataType and FriendlyName
-     */
-    adaptableColumn: AdaptableColumnBase;
-}

package/src/AdaptableOptions/ExpressionOptions.d.ts

@@ -0,0 +1,204 @@
+import { ExpressionFunction } from '../parser/src/types';
+import { BooleanFunctionName } from '../Utilities/ExpressionFunctions/booleanExpressionFunctions';
+import { ScalarFunctionName } from '../Utilities/ExpressionFunctions/scalarExpressionFunctions';
+import { ObservableFunctionName } from '../Utilities/ExpressionFunctions/observableExpressionFunctions';
+import { AggregatedBooleanFunctionName } from '../Utilities/ExpressionFunctions/aggregatedBooleanExpressionFunctions';
+import { AggregatedScalarFunctionName } from '../Utilities/ExpressionFunctions/aggregatedScalarExpressionFunctions';
+import { AdaptableModule, BaseContext, AdaptableColumnBase } from '../types';
+/**
+ * Options for managing Expressions using AdaptableQL
+ */
+export interface ExpressionOptions {
+    /**
+     * System (built-in) Boolean Expression Functions available in AdaptableQL
+     *
+     * @defaultValue null (sets all)
+     * @gridInfoItem
+     */
+    systemBooleanFunctions?: BooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => BooleanFunctionName[]);
+    /**
+     * Custom (user defined) Boolean Expression Functions available in AdaptableQL
+     *
+     * @defaultValue null (none)
+     * @gridInfoItem
+     */
+    customBooleanFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => Record<string, ExpressionFunction>);
+    /**
+     * System (built-in) Scalar Expression Functions available in AdaptableQL
+     *
+     * @defaultValue null (sets all)
+     * @gridInfoItem
+     */
+    systemScalarFunctions?: ScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => ScalarFunctionName[]);
+    /**
+     * Custom (user defined) Scalar Expression Functions available in AdaptableQL
+     *
+     * @defaultValue null (none)
+     * @gridInfoItem
+     */
+    customScalarFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => Record<string, ExpressionFunction>);
+    /**
+     * System (built-in) Observable Expression Functions available in AdaptableQL
+     *
+     * @defaultValue null (sets all)
+     * @gridInfoItem
+     */
+    systemObservableFunctions?: ObservableFunctionName[] | ((context: GlobalExpressionFunctionsContext<ObservableFunctionName>) => ObservableFunctionName[]);
+    /**
+     * System (built-in) AggregatedBoolean Expression Functions available in AdaptableQL
+     *
+     * @defaultValue null (sets all)
+     * @gridInfoItem
+     */
+    systemAggregatedBooleanFunctions?: AggregatedBooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedBooleanFunctionName>) => AggregatedBooleanFunctionName[]);
+    /**
+     * System (built-in) AggregatedScalar Expression Functions available in AdaptableQL
+     *
+     * @defaultValue undefined (sets all)
+     * @gridInfoItem
+     */
+    systemAggregatedScalarFunctions?: AggregatedScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedScalarFunctionName>) => AggregatedScalarFunctionName[]);
+    /**
+     * Module specific ExpressionFunctions; if not defined, it falls back to the generally defined system and custom values
+     *
+     * @defaultValue undefined (defaults to available system & custom values)
+     * @gridInfoItem
+     */
+    moduleExpressionFunctions?: ModuleExpressionFunctionsMap | ((context: ModuleExpressionFunctionsContext) => ModuleExpressionFunctions | undefined);
+    /**
+     * Specifies if a given column can be included in Queries
+     */
+    isColumnQueryable?: (queryableColumnContext: QueryableColumnContext) => boolean;
+    /**
+     * Validate Expressions before they can be run or saved
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     */
+    performExpressionValidation?: boolean;
+    /**
+     * Maximum time (in milliseconds) to hold a Data Change event in a trailing timeframe (see observableExpressionFunctions); value is capped at 86400000 (~24 hours) for performance reasons
+     *
+     * @defaultValue 28800000 (~8 hours)
+     * @gridInfoItem
+     */
+    maxTimeframeSize?: number;
+    /**
+     * Custom query variables allow values to be attached to variables so that a single value can easily be expressed multiple times within a query, or quickly changed to affect the results of a query. Variables are evaluated synchronously with each expression evaluation.
+     */
+    customQueryVariables?: Record<string, string | number | boolean | Date | ((context: CustomQueryVariableContext) => string | number | boolean | Date)>;
+}
+/**
+ * Module specific Expression Functions
+ */
+export declare type ModuleExpressionFunctionsMap = Partial<Record<AdaptableModule, ModuleExpressionFunctions>>;
+/**
+ * Type specific Expression Functions
+ */
+export interface ModuleExpressionFunctions {
+    /**
+     * System (built-in) Boolean Expression Functions available in AdaptableQL
+     *
+     * @defaultValue null (sets all)
+     * @gridInfoItem
+     */
+    systemBooleanFunctions?: BooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => BooleanFunctionName[]);
+    /**
+     * Custom (user defined) Boolean Expression Functions available in AdaptableQL
+     *
+     * @defaultValue null (none)
+     * @gridInfoItem
+     */
+    customBooleanFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => Record<string, ExpressionFunction>);
+    /**
+     * System (built-in) Scalar Expression Functions available in AdaptableQL
+     *
+     * @defaultValue null (sets all)
+     * @gridInfoItem
+     */
+    systemScalarFunctions?: ScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => ScalarFunctionName[]);
+    /**
+     * Custom (user defined) Scalar Expression Functions available in AdaptableQL
+     *
+     * @defaultValue null (none)
+     * @gridInfoItem
+     */
+    customScalarFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => Record<string, ExpressionFunction>);
+    /**
+     * System (built-in) Observable Expression Functions available in AdaptableQL
+     *
+     * @defaultValue null (sets all)
+     * @gridInfoItem
+     */
+    systemObservableFunctions?: ObservableFunctionName[] | ((context: GlobalExpressionFunctionsContext<ObservableFunctionName>) => ObservableFunctionName[]);
+    /**
+     * System (built-in) AggregatedBoolean Expression Functions available in AdaptableQL
+     *
+     * @defaultValue null (sets all)
+     * @gridInfoItem
+     */
+    systemAggregatedBooleanFunctions?: AggregatedBooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedBooleanFunctionName>) => AggregatedBooleanFunctionName[]);
+    /**
+     * System (built-in) AggregatedScalar Expression Functions available in AdaptableQL
+     *
+     * @defaultValue null (sets all)
+     * @gridInfoItem
+     */
+    systemAggregatedScalarFunctions?: AggregatedScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedScalarFunctionName>) => AggregatedScalarFunctionName[]);
+}
+/**
+ * Context provided to global expression functions properties property callback
+ */
+export interface GlobalExpressionFunctionsContext<T> extends BaseContext {
+    /**
+     * The names of all expression functions available in this context
+     */
+    availableExpressionFunctionNames: T[];
+}
+/**
+ * Context provided to ExpressionOptions.moduleExpressionFunctions property callback
+ */
+export interface ModuleExpressionFunctionsContext extends BaseContext {
+    /**
+     * The Adaptable Module requesting the expression functions
+     */
+    module: AdaptableModule;
+    /**
+     * The global boolean expression functions
+     */
+    availableBooleanFunctionNames: BooleanFunctionName[];
+    /**
+     * The global scalar expression functions
+     */
+    availableScalarFunctionNames: ScalarFunctionName[];
+    /**
+     * The global observable expression functions
+     */
+    availableObservableFunctionNames: ObservableFunctionName[];
+    /**
+     * The global aggregated boolean expression functions
+     */
+    availableAggregatedBooleanFunctionNames: AggregatedBooleanFunctionName[];
+    /**
+     * The global aggregated scalar expression functions
+     */
+    availableAggregatedScalarFunctionNames: AggregatedScalarFunctionName[];
+}
+/**
+ * Context passed when evaluating `ExpressionOptions.customQueryVariables`
+ */
+export interface CustomQueryVariableContext extends BaseContext {
+    /**
+     * Optional variable arguments
+     */
+    args?: any[];
+}
+/**
+ * Context passed when evaluating Queryable Columns
+ */
+export interface QueryableColumnContext extends BaseContext {
+    /**
+     * Basic Column Info - just ColumnId, DataType and FriendlyName
+     */
+    adaptableColumn: AdaptableColumnBase;
+}

package/src/AdaptableOptions/ExpressionOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -1,8 +1,7 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { FilterActionOnDataChange } from '../PredefinedConfig/Common/FilterActionOnDataChange';
-import { AdaptablePredicateDef, SystemFilterPredicateId, SystemFilterPredicateIds } from '../../types';
+import { SystemFilterPredicateId, SystemFilterPredicateIds } from '../../types';
 import { StrictExtract } from '../Utilities/Extensions/TypeExtensions';
-import { BaseContext } from '../types';
 /**
  * Options for managing Filtering in AdapTable
  */
@@ -149,9 +148,10 @@ export interface FilterOptions {
      */
     enableFilterOnSpecialColumns?: boolean;
     /**
-     * Set which System Filter Predicates are available, using list or function
+     * Set which System Filter Predicates are available
+     * @deprecated use systemFilterPredicates in PredicateOptions
      */
-    systemFilters?: SystemFilterPredicateIds | ((context: SystemFiltersPredicateContext) => SystemFilterPredicateIds);
+    systemFilters?: SystemFilterPredicateIds;
     /**
      * Whether to display Quick Filter Bar between Column Header and the Grid (provided its been setup)
      * @defaultValue  true
@@ -177,12 +177,3 @@ export interface FilterOptions {
      */
     showSuspendFilterButton?: boolean;
 }
-/**
- * Context used for providing System Filters
- */
-export interface SystemFiltersPredicateContext extends BaseContext {
-    /**
-     * AdapTable-provided System Filter Predicate Definitions
-     */
-    systemFiltersPredicateDefs: AdaptablePredicateDef[];
-}

package/src/AdaptableOptions/PredicateOptions.d.ts

@@ -0,0 +1,32 @@
+import { AdaptablePredicateDef, BaseContext, SystemAlertPredicateIds, SystemFilterPredicateIds, SystemFormatColumnPredicateIds, SystemFlashingCellPredicateIds, PredicateModuleScope } from '../types';
+/**
+ * Options for managing Adaptable Predicates using AdaptableQL
+ */
+export interface PredicateOptions {
+    /**
+     * Set which System Filter Predicates are available - by List or Function
+     */
+    systemFilterPredicates?: SystemFilterPredicateIds | ((context: SystemPredicatesContext) => SystemFilterPredicateIds);
+    /**
+     * Set which System Alert Predicates are available - by List or Function
+     */
+    systemAlertPredicates?: SystemAlertPredicateIds | ((context: SystemPredicatesContext) => SystemAlertPredicateIds);
+    /**
+     * Set which System Format Column Predicates are available - by List or Function
+     */
+    systemFormatColumnPredicates?: SystemFormatColumnPredicateIds | ((context: SystemPredicatesContext) => SystemFormatColumnPredicateIds);
+    /**
+     * Set which System Flashing Cell Predicates are available - by List or Function
+     */
+    systemFlashingCellPredicates?: SystemFlashingCellPredicateIds | ((context: SystemPredicatesContext) => SystemFlashingCellPredicateIds);
+}
+export interface SystemPredicatesContext extends BaseContext {
+    /**
+     * AdapTable-provided System Predicate Definitions
+     */
+    systemPredicateDefs: AdaptablePredicateDef[];
+    /**
+     * Module for which Predicates are being retrieved
+     */
+    moduleScope: PredicateModuleScope;
+}

package/src/AdaptableOptions/PredicateOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Api/AdaptableApi.d.ts

@@ -11,6 +11,7 @@ import { ToolPanelApi } from './ToolPanelApi';
 import { DataSetApi } from './DataSetApi';
 import { EventApi } from './EventApi';
 import { ExportApi } from './ExportApi';
+import { EntitlementApi } from './EntitlementApi';
 import { FormatColumnApi } from './FormatColumnApi';
 import { FreeTextColumnApi } from './FreeTextColumnApi';
 import { LayoutApi } from './LayoutApi';
@@ -98,6 +99,10 @@ export interface AdaptableApi {
      * Provides access to Data Sets
      */
     dataSetApi: DataSetApi;
+    /**
+     * Functions for managing Entitlements and Permissions
+     */
+    entitlementApi: EntitlementApi;
     /**
      * Used for listenning / subscribing to the various Events published by AdapTable
      */

package/src/Api/AlertApi.d.ts

@@ -135,10 +135,6 @@ export interface AlertApi {
      * Opens Settings Panel with Alert section selected and visible
      */
     showAlertPopup(): void;
-    /**
-     * Retrieves all Predicate Defs with Module Scope of Alert
-     */
-    getAlertPredicateDefs(): AdaptablePredicateDef[];
     /**
      * Retrieves all Predicate Defs that match given Scope
      * @param scope the Scope to check

package/src/Api/EntitlementApi.d.ts

@@ -0,0 +1,31 @@
+import { AdaptableModule, AccessLevel, AdaptableObject } from '../types';
+/**
+ * Provides functions for Entitlements and Permissions
+ **/
+export interface EntitlementApi {
+    /**
+     * Returns Access Level of an Entitlement
+     * @param adaptableModule Module to Check
+     */
+    getEntitlementAccessLevelForModule(adaptableModule: AdaptableModule): AccessLevel;
+    /**
+     * Is the Adaptable Object ReadOnly
+     * @param object Object to Check
+     */
+    isObjectReadonly(object: AdaptableObject): boolean;
+    /**
+     * Is Module Hidden
+     * @param adaptableModule Module to Check
+     */
+    isModuleHiddenEntitlement(adaptableModule: AdaptableModule): boolean;
+    /**
+     * Is Module Full
+     * @param adaptableModule Module to Check
+     */
+    isModuleFullEntitlement(adaptableModule: AdaptableModule): boolean;
+    /**
+     * Is Module ReadOnly
+     * @param adaptableModule Module to Check
+     */
+    isModuleReadOnlyEntitlement(adaptableModule: AdaptableModule): boolean;
+}

package/src/Api/EntitlementApi.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Api/FilterApi.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableColumn, ColumnFilter, GridCell, SystemFilterPredicateIds } from '../types';
+import { AdaptableColumn, ColumnFilter, GridCell } from '../types';
 import * as Redux from 'redux';
 import { ColumnFilterDef, AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
 import { RowNode } from '@ag-grid-community/core';
@@ -23,10 +23,6 @@ export interface FilterApi {
      * @param columnId Id of Column to lookup
      */
     getFilterPredicateDefsForColumnId(columnId: string): AdaptablePredicateDef[] | undefined;
-    /**
-     * Retrieves Ids for all System Filters
-     */
-    getAllSystemFilterIds(): SystemFilterPredicateIds;
     /**
      * Makes Quick Filter Bar appear
      */