@adaptabletools/adaptable 14.0.0-canary.0 → 14.0.0-canary.1

package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts

@@ -46,7 +46,7 @@ export interface DataChangeHistoryOptions {
      */
     showDataChange?: (cellDataChangedInfo: CellDataChangedInfo) => boolean;
     /**
-     * Action button definition. Can be used to implement undo functionality.
+     * Action button definition; can be used to implement undo functionality
      *
      * @defaultValue undefined
      */

package/src/AdaptableOptions/EntitlementOptions.d.ts

@@ -16,7 +16,7 @@ export interface EntitlementOptions {
      * @defaultValue 'Full'
      * @gridInfoItem
      */
-    defaultAccessLevel?: AccessLevel | ((userName: string, adaptableId: string) => AccessLevel);
+    defaultAccessLevel?: AccessLevel | ((defaultAccessLevelContext: DefaultAccessLevelContext) => AccessLevel);
 }
 /**
  * Provided to moduleEntitlements function when setting Entitlements programatically
@@ -39,3 +39,16 @@ export interface EntitlementContext {
      */
     defaultAccessLevel: AccessLevel;
 }
+/**
+ * Provided to defaultAccessLevel function when setting Default Entitlement value programatically
+ */
+export interface DefaultAccessLevelContext {
+    /**
+     * Name of Current User
+     */
+    userName: string;
+    /**
+     * Id of current AdapTable instance
+     */
+    adaptableId: string;
+}

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -28,9 +28,9 @@ export interface ExportOptions {
      */
     customDestinations?: CustomDestination[];
     /**
-     * Reports run entirely by users (and not AdapTable)
+     * Reports generated entirely by users (and not AdapTable)
      */
-    customReports?: CustomReport[];
+    serverReports?: ServerReport[];
     /**
      * System Reports to use; leave blank for all, empty array for none
      *
@@ -57,7 +57,7 @@ export declare type DataFormatType = 'rawValue' | 'formattedValue';
 /**
  * Defines a Report where all the data is provided entirely by the user
  */
-export interface CustomReport {
+export interface ServerReport {
     /**
      * Name of the Report
      */

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/FilterOptions.d.ts

@@ -23,6 +23,7 @@ export interface FilterOptions {
      *
      * @defaultValue 2,000
      * @gridInfoItem
+     * @noCodeItem
      */
     maxFilterValuesToDisplay?: number;
     /**
@@ -30,12 +31,14 @@ export interface FilterOptions {
      *
      * @defaultValue true
      * @gridInfoItem
+     * @noCodeItem
      */
     indicateFilteredColumns?: boolean;
     /**
      * Uses Adaptable's Filter Form in Column Menu for all columns if 'true' (the default) or those listed, in preference to AG Grid's Filter Form
      *
      * @defaultValue true
+     * @noCodeItem
      */
     useAdaptableFilterForm?: boolean | string[];
     /**
@@ -43,6 +46,7 @@ export interface FilterOptions {
      *
      * @defaultValue true
      * @gridInfoItem
+     * @noCodeItem
      */
     useAgGridFilterFormStyle?: boolean;
     /**
@@ -50,6 +54,7 @@ export interface FilterOptions {
      *
      * @defaultValue true
      * @gridInfoItem
+     * @noCodeItem
      */
     useAdaptableQuickFilter?: boolean | string[];
     /**
@@ -90,6 +95,7 @@ export interface FilterOptions {
      *
      * @defaultValue true
      * @gridInfoItem
+     * @noCodeItem
      */
     autoApplyFilter?: boolean;
     /**
@@ -142,7 +148,8 @@ export interface FilterOptions {
      */
     enableFilterOnSpecialColumns?: boolean;
     /**
-     * Which Adaptable System Filter Predicates are available
+     * Set which System Filter Predicates are available
+     * @deprecated use systemFilterPredicates in PredicateOptions
      */
     systemFilters?: SystemFilterPredicateIds;
     /**

package/src/AdaptableOptions/FinancePluginOptions.d.ts

@@ -45,6 +45,12 @@ export interface FinancePluginOptions {
      * @deprecated - use Weighted Average Layout Aggregation
      */
     weightedAverageColumns?: WeightedAverageColumn[];
+    /**
+     * Whether `FDC3MessageSent` Adaptable events should be automatically delegated to the FDC3 API (either via `fdc3.raiseIntent(...)` or `fdc3.broadcast(...)` )
+     *
+     * @defaultValue TRUE
+     */
+    autoHandleFDC3AdaptableMessages?: boolean;
     /**
      * Called when an intent from `availableIntents` is raised.
      */
@@ -77,10 +83,18 @@ export interface FDC3Column {
      * Should Column display a 'Broadcast' context menu item
      */
     showBroadcastContextMenu?: boolean;
+    /**
+     * Should Column display a 'Raise Intent for Context' context menu item
+     */
+    showRaiseIntentForContextMenu?: boolean;
     /**
      * Label to display in Broadcast Context Menu Item
      */
     broadcastContextMenuLabel?: string | ((broadcastFDC3MessageContext: ContextMenuContext) => string);
+    /**
+     * Label to display in RaiseIntentForContext Context Menu Item
+     */
+    raiseIntentForContextMenuLabel?: string | ((raiseFDC3IntentForContext: ContextMenuContext) => string);
     /**
      * FDC3 intents which the Column can raise
      */
@@ -127,11 +141,11 @@ export interface InstrumentColumn extends FDC3Column {
      */
     permidColumnId?: string;
     /**
-     * Column which holds a FIGI value as instrument data
+     * Column which holds a [FIGI](https://www.openfigi.com/about/figi) value as instrument data
      */
     figiColumnId?: string;
     /**
-     * FDC3 Intents invoked by Column; can be: `ViewChart` `ViewQuote` `ViewNews` `ViewAnalysis` `ViewInstrument`
+     * Instrument-related FDC3 Intents; can be: `ViewChart` `ViewQuote` `ViewNews` `ViewAnalysis` `ViewInstrument`
      */
     intents?: InstrumentIntents;
 }
@@ -152,7 +166,7 @@ export interface PositionColumn extends FDC3Column {
      */
     instrumentColumnId: string;
     /**
-     * FDC3 Intents invoked by Column; can be: `ViewChart` `ViewNews` `ViewAnalysis`
+     * Position-related FDC3 Intents; can be: `ViewChart` `ViewNews` `ViewAnalysis`
      */
     intents?: PositionIntents;
 }
@@ -178,7 +192,7 @@ export interface ContactColumn extends FDC3Column {
      */
     fds_idColumnId?: string;
     /**
-     * FDC3 Intents invoked by Column; can be: `StartCall` `StartChat` `ViewContact`
+     * Contact-related FDC3 Intents; can be: `StartCall` `StartChat` `ViewContact`
      */
     intents?: ContactIntents;
 }
@@ -207,7 +221,7 @@ export interface OrganizationColumn extends FDC3Column {
      */
     fds_idColumnId?: string;
     /**
-     * FDC3 Intents invoked by Column; can be: `ViewNews` `ViewAnalysis`
+     * Organization-related FDC3 Intents; can be: `ViewNews` `ViewAnalysis`
      */
     intents?: OrganizationIntents;
 }
@@ -229,7 +243,7 @@ export interface CountryColumn extends FDC3Column {
      */
     isoalpha3ColumnId?: string;
     /**
-     * FDC3 Intents invoked by Column; can be: `ViewChart`
+     * Country-related FDC3 Intents; can only be: `ViewChart`
      */
     intents?: CountryIntents;
 }
@@ -275,6 +289,7 @@ export declare type FDC3ContextHandler = (context: FDC3Context) => void;
 export interface FDC3DesktopAgent {
     raiseIntent: (intent: FDC3Intent, context: FDC3Context) => void;
     broadcast: (context: FDC3Context) => void;
+    raiseIntentForContext: (context: FDC3Context) => void;
     addIntentListener: (intent: FDC3Intent | CustomFDC3Intent, listener: (context: FDC3Context) => void) => void;
     addContextListener: (contextType: string | null, handler: FDC3ContextHandler) => {
         unsubscribe: () => void;

package/src/AdaptableOptions/FinsemblePluginOptions.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Options required for when using the Finsemble plugin
+ */
+export interface FinsemblePluginOptions {
+    /**
+     * Application name - used to identify the application in Finsemble console
+     */
+    applicationName?: string;
+    /**
+     * Options for managing Adaptable State with Finsemble State
+     */
+    stateOptions?: FinsemblePluginStateOptions;
+    /**
+     * Should Adaptable's Alerts appear as Finsemble Notifications
+     * @defaultValue true
+     */
+    showAdaptableAlertsAsNotifications?: boolean;
+}
+export interface FinsemblePluginStateOptions {
+    /**
+     * Whether to persist AdapTable State inside Finsemble
+     */
+    persistInFinsemble: boolean;
+    /**
+     * Key used to persist/load AdapTable State in Finsemble
+     */
+    key: string;
+    /**
+     * Topic used to persist/load AdapTable State in Finsemble
+     */
+    topic: string;
+}

package/src/AdaptableOptions/GeneralOptions.d.ts

@@ -13,6 +13,8 @@ export interface GeneralOptions {
      *
      * @defaultValue false
      * @gridInfoItem
+     * @noCodeItem
+     * @uiLabel Show Missing Primary Key Warning
      */
     showMissingPrimaryKeyAlert?: boolean;
     /**
@@ -36,12 +38,10 @@ export interface GeneralOptions {
      */
     alternativeModuleNames?: AlternativeModuleName[];
     /**
-     * Calendar to use for calculating Holidays & Working Days
-     *
-     * @defaultValue 'United Kingdom'
-     * @gridInfoItem
+     * Holidays - used to determine Working Days
+     * @defaultValue null
      */
-    currentCalendar?: string;
+    holidays?: Holidays;
     /**
      * English variant to use in UI labels
      *
@@ -65,6 +65,17 @@ export interface GeneralOptions {
      * Value to use for 'Unbalanced Groups' (string columns)
      */
     unbalancedGroupsKey?: string | ((context: UnbalancedGroupsKeyContext) => string);
+    /**
+     * Places ungrouped columns at pre-grouping indexed position
+     * @defaultValue false
+     */
+    restoreUngroupedColumns?: boolean;
+    /**
+     * By default, a confirmation dialog is displayed whenever an AdaptableObject is deleted. This option allows to suppress the confirmation dialog.
+     *
+     * @defaultValue false
+     */
+    disableDeleteConfirmation?: boolean;
 }
 /**
  * Comparer object for Column Values - used for custom sorting
@@ -118,3 +129,33 @@ export interface UnbalancedGroupsKeyContext extends BaseContext {
      */
     params: KeyCreatorParams;
 }
+/**
+ * Holidays - can be list or function (latter takes preference)
+ */
+export interface Holidays {
+    /**
+     * Holidays provided as valid ISO date strings
+     */
+    list?: string[];
+    /**
+     * Function which returns true if given date is a holiday
+     */
+    isHoliday?: (holidayContext: HolidayContext) => boolean;
+}
+/**
+ * Context used for isHoliday function
+ */
+export interface HolidayContext extends BaseContext {
+    /**
+     * Date being checked
+     */
+    dateToCheck: Date;
+    /**
+     * Name of Current User
+     */
+    userName: string;
+    /**
+     * Id of current AdapTable instance
+     */
+    adaptableId: string;
+}

package/src/AdaptableOptions/LayoutOptions.d.ts

@@ -1,10 +1,10 @@
 import { AlertDefinition } from '../PredefinedConfig/AlertState';
-import { ConditionalStyle } from '../PredefinedConfig/ConditionalStyleState';
 import { CustomSort } from '../PredefinedConfig/CustomSortState';
 import { FlashingCellDefinition } from '../PredefinedConfig/FlashingCellState';
 import { FormatColumn } from '../PredefinedConfig/FormatColumnState';
 import { PlusMinusNudge } from '../PredefinedConfig/PlusMinusState';
 import { Shortcut } from '../PredefinedConfig/ShortcutState';
+import { StyledColumn } from '../PredefinedConfig/StyledColumnState';
 import { BaseSchedule } from '../PredefinedConfig/Common/Schedule';
 import { Layout } from '../PredefinedConfig/LayoutState';
 import { AdaptableModule } from '../PredefinedConfig/Common/Types';
@@ -33,6 +33,7 @@ export interface LayoutOptions {
      *
      * @defaultValue true
      * @gridInfoItem
+     * @noCodeItem
      */
     autoSaveLayouts?: boolean;
     /**
@@ -64,6 +65,10 @@ export interface LayoutOptions {
      * Options for leveraging Object Tags to extend Layouts
      */
     layoutTagOptions?: LayoutTagOptions;
+    /**
+     * Columns displayed in Table that opens when viewing contents of Pivot Cells
+     */
+    pivotPreviewColumns?: string[] | ((context: PivotPreviewColumnsContext) => string[]);
 }
 export interface LayoutTagOptions {
     /**
@@ -116,7 +121,7 @@ export interface LayoutAvailableContext extends BaseContext {
 /**
  * Types of Adaptable Objects that can be associated with a Layout
  */
-export declare type LayoutAssociatedObject = AlertDefinition | ConditionalStyle | CustomSort | FlashingCellDefinition | FormatColumn | PlusMinusNudge | Shortcut | BaseSchedule;
+export declare type LayoutAssociatedObject = AlertDefinition | CustomSort | FlashingCellDefinition | FormatColumn | PlusMinusNudge | StyledColumn | Shortcut | BaseSchedule;
 /**
  * Context for `LayoutOptions.autoGenerateTagsForLayouts` method
  */
@@ -130,3 +135,16 @@ export interface AutoGenerateTagsForLayoutsContext extends BaseContext {
      */
     objectTags: AdaptableObjectTag[];
 }
+/**
+ * Context uses for pivotPreviewColumns function in Layout Options
+ */
+export interface PivotPreviewColumnsContext extends BaseContext {
+    /**
+     * Current Layout
+     */
+    layout: Layout;
+    /**
+     * Column being opened
+     */
+    columnId: string;
+}

package/src/AdaptableOptions/MasterDetailPluginOptions.d.ts

@@ -1,14 +1,16 @@
-import { AdaptableOptions, AdaptableApi } from '../types';
+import { AdaptableOptions, BaseContext } from '../types';
 /**
  * Plugin Options used when creating a Master / Detail grid - passed into the plugin as the only argument.
  */
 export interface MasterDetailPluginOptions {
     /**
-     * `AdaptableOptions` object to use for child Data Grids; **all** will share the same behaviour and State
+     * `AdaptableOptions` used in Detail Grids; all share same behaviour & State
      */
     detailAdaptableOptions: AdaptableOptions;
     /**
-     *  Function called when Detail Grid is initialised (i.e. opens) receives an Adaptable Api object
+     *  Function called when Detail Grid is initialised receives context that includes Adaptable Api object
      */
-    onDetailInit?: (api: AdaptableApi) => void;
+    onDetailInit?: (context: DetailInitContext) => void;
+}
+export interface DetailInitContext extends BaseContext {
 }

package/src/AdaptableOptions/NotificationsOptions.d.ts

@@ -52,7 +52,7 @@ export interface NotificationsOptions {
      */
     isDraggable?: boolean;
     /**
-     * How Notification will appear: 'Bounce', 'Slide', 'Zoom' or 'Flip'
+     * How Notification will appear: Bounce, Slide, Zoom or Flip
      *
      * @defaultValue 'Slide'
      * @gridInfoItem
@@ -70,6 +70,7 @@ export interface NotificationsOptions {
      *
      * @defaultValue  100
      * @gridInfoItem
+     * @transition
      */
     maxSystemMessagesInStore?: number;
     /**

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 });