@adaptabletools/adaptable 15.4.2 → 16.0.0-canary.0

package/src/Api/LayoutApi.d.ts

@@ -9,11 +9,10 @@ export interface LayoutApi {
      */
     getLayoutState(): LayoutState;
     /**
-     * Whether this Layout should be auto saved (based on Layout State and Layout Options)
-     * @param layout Layout to save
-     * @returns layout
+     * Whether Layouts are auto saved (based on Layout Options)
+     * @returns boolean
      */
-    shouldAutoSaveLayout(layout?: Layout): boolean;
+    shouldAutoSaveLayouts(): boolean;
     /**
      * Sets (i.e. selects) the Layout
      * @param layoutName Layout to set (has to be name of existing Layout)
@@ -175,27 +174,4 @@ export interface LayoutApi {
         ColumnFilters: boolean;
         ColumnSorts: boolean;
     };
-    /**
-     * TO BE REMOVED
-     */
-    /**
-     * @deprecated use `getLayouts()` instead
-     */
-    getAllLayout(): Layout[];
-    /**
-     * @deprecated internal method, will be removed in next major release
-     */
-    fireLayoutChangedEvent(trigger: string, oldSate: LayoutState, newState: LayoutState, skipEqualityCheck?: boolean): void;
-    /**
-     * @deprecated internal method, will be removed in next major release
-     */
-    areLayoutsEqual(layout1: Layout, layout2: Layout): boolean;
-    /**
-     * @deprecated internal method, will be removed in next major release
-     */
-    createDefaultLayoutIfNeeded(): Layout | null;
-    /**
-     * @deprecated use `openLayoutSettingsPanel()` instead
-     */
-    showLayoutPopup(): void;
 }

package/src/Api/OptionsApi.d.ts

@@ -1,5 +1,7 @@
-import { GridOptions } from '@ag-grid-community/core';
-import { ActionOptions, AdaptableOptions, AdaptableQLOptions, AlertOptions, ChartingOptions, ColumnOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FilterOptions, FlashingCellOptions, GeneralOptions, LayoutOptions, MenuOptions, NotificationsOptions, SearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
+import { CustomSortOptions } from '../AdaptableOptions/CustomSortOptions';
+import { DataSetOptions } from '../AdaptableOptions/DataSetOptions';
+import { GroupingOptions } from '../AdaptableOptions/GroupingOptions';
+import { ActionColumnOptions, ActionRowOptions, AdaptableOptions, AdaptableQLOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FilterOptions, FlashingCellOptions, LayoutOptions, MenuOptions, NotificationsOptions, SearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
 /**
  * Range of functions to access Adaptable Options
  */
@@ -16,10 +18,6 @@ export interface OptionsApi {
      * Returns `AdaptableOptions.autogeneratePrimaryKey`
      */
     getAutogeneratePrimaryKey(): boolean;
-    /**
-     * Returns `AdaptableOptions.gridOptions`
-     */
-    getAgGridOptions(): GridOptions;
     /**
      * Returns `AdaptableOptions.licenseKey`
      */
@@ -37,9 +35,13 @@ export interface OptionsApi {
      */
     getAdaptableOptions(): Readonly<AdaptableOptions>;
     /**
-     * Returns `AdaptableOptions.actionOptions`
+     * Returns `AdaptableOptions.actionColumnOptions`
+     */
+    getActionColumnOptions(): Readonly<ActionColumnOptions>;
+    /**
+     * Returns `AdaptableOptions.actionRowOptions`
      */
-    getActionOptions(): Readonly<ActionOptions>;
+    getActionRowOptions(): Readonly<ActionRowOptions>;
     /**
      * Returns `AdaptableOptions.alertOptions`
      */
@@ -48,6 +50,14 @@ export interface OptionsApi {
      * Returns `AdaptableOptions.adaptableQLOptions`
      */
     getAdaptableQLOptions(): Readonly<AdaptableQLOptions>;
+    /**
+     * Returns `AdaptableOptions.calendarOptions`
+     */
+    getCalendarOptions(): Readonly<CalendarOptions>;
+    /**
+     * Returns `AdaptableOptions.cellSummaryOptions`
+     */
+    getCellSummaryOptions(): Readonly<CellSummaryOptions>;
     /**
      * Returns `AdaptableOptions.chartingOptions`
      */
@@ -60,6 +70,10 @@ export interface OptionsApi {
      * Returns `AdaptableOptions.columnOptions`
      */
     getColumnOptions(): Readonly<ColumnOptions>;
+    /**
+     * Returns `AdaptableOptions.customSortOptions`
+     */
+    getCustomSortOptions(): Readonly<CustomSortOptions>;
     /**
      * Returns `AdaptableOptions.dashboardOptions`
      */
@@ -68,6 +82,10 @@ export interface OptionsApi {
      * Returns `AdaptableOptions.dataChangeHistoryOptions`
      */
     getDataChangeHistoryOptions(): Readonly<DataChangeHistoryOptions>;
+    /**
+     * Returns `AdaptableOptions.dataSetOptions`
+     */
+    getDataSetOptions(): Readonly<DataSetOptions>;
     /**
      * Returns `AdaptableOptions.editOptions`
      */
@@ -89,9 +107,9 @@ export interface OptionsApi {
      */
     getFlashingCellOptions(): Readonly<FlashingCellOptions>;
     /**
-     * Returns `AdaptableOptions.generalOptions`
+     * Returns `AdaptableOptions.groupingOptions`
      */
-    getGeneralOptions(): Readonly<GeneralOptions>;
+    getGroupingOptions(): Readonly<GroupingOptions>;
     /**
      * Returns `AdaptableOptions.layoutOptions`
      */

package/src/Api/PlusMinusApi.d.ts

@@ -71,11 +71,4 @@ export interface PlusMinusApi {
      * @returns plus minus rule
      */
     unSuspendPlusMinusNudge(plusMinusNudge: PlusMinusNudge): PlusMinusNudge;
-    /**
-     * TO BE REMOVED
-     */
-    /**
-     * @deprecated use `openPlusMinusSettingsPanel()` instead
-     */
-    showPlusMinusPopup(): void;
 }

package/src/Api/PredicateApi.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableColumnDataType, AdaptableColumnPredicate, AdaptableScope, SystemFilterPredicateId } from '../../types';
+import { AdaptableColumnPredicate } from '../../types';
 import { AdaptablePredicateDef, AdaptablePredicate, PredicateDefHandlerParams, PredicateModuleScope } from '../PredefinedConfig/Common/AdaptablePredicate';
 /**
  * Functions which manage the Predicate object in AdapTable
@@ -81,35 +81,4 @@ export interface PredicateApi {
      * @param defaultReturn Whether to return the default
      */
     handlePredicates(predicates: AdaptablePredicate[], params: Omit<PredicateDefHandlerParams, 'api' | 'inputs'>, defaultReturn: boolean): boolean;
-    /**
-     * TO BE REMOVED
-     */
-    /**
-     * @deprecated use `IsEveryPredicateValid()` instead
-     */
-    arePredicatesValid(predicates: AdaptablePredicate[]): boolean;
-    /**
-     * @deprecated internal method, will be removed in next major release
-     */
-    hasPredicateValues(predicate: AdaptablePredicate): boolean;
-    /**
-     * @deprecated internal method, will be removed in next major release
-     */
-    getFilterPredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
-    /**
-     * @deprecated internal method, will be removed in next major release
-     */
-    getAlertPredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
-    /**
-     * @deprecated internal method, will be removed in next major release
-     */
-    getFormatColumnPredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
-    /**
-     * @deprecated internal method, will be removed in next major release
-     */
-    getFlashingCellPredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
-    /**
-     * @deprecated internal method, will be removed in next major release
-     */
-    getEqualityPredicateForDataType(dataType: AdaptableColumnDataType): SystemFilterPredicateId;
 }

package/src/Api/QueryApi.d.ts

@@ -48,27 +48,4 @@ export interface QueryApi {
      * @param query - query to edit
      */
     expandCurrentQuery(query?: string): void;
-    /**
-     * TO BE REMOVED
-     */
-    /**
-     * @deprecated use `getNamedQueries()` instead
-     */
-    getAllNamedQuery(): NamedQuery[];
-    /**
-     * @deprecated internal method, will be removed in next major release
-     */
-    getReferencedNamedQueryNames(expression: string): string[];
-    /**
-     * @deprecated internal method, will be removed in next major release
-     */
-    getNamedQueryModuleReferences(namedQueryName: string): string[];
-    /**
-     * @deprecated use `openQuerySettingsPanel()` instead
-     */
-    showQueryPopup(): void;
-    /**
-     * @deprecated internal method, will be removed in next major release
-     */
-    fireQueryRunEvent(): void;
 }

package/src/Api/QuickSearchApi.d.ts

@@ -30,10 +30,6 @@ export interface QuickSearchApi {
      * @param style the style to use
      */
     setQuickSearchStyle(style: AdaptableStyle): void;
-    /**
-     * @deprecated use `openQuickSearchSettingsPanel()` instead
-     */
-    showQuickSearchPopup(): void;
     /**
      * Opens Settings Panel with Quick Search section selected and visible
      */

package/src/Api/ScheduleApi.d.ts

@@ -264,85 +264,4 @@ export interface ScheduleApi {
      * Opens Settings Panel with Schedule section selected and visible
      */
     openScheduleSettingsPanel(): void;
-    /**
-     * TO BE REMOVED
-     */
-    /**
-     * @deprecated use `getSchedules()` instead
-     */
-    getAllSchedule(): BaseSchedule[];
-    /**
-     * @deprecated use `getReminderSchedules()` instead
-     */
-    getAllReminderSchedule(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): ReminderSchedule[];
-    /**
-     * @deprecated use `getActiveReminderSchedules()` instead
-     */
-    getAllActiveReminderSchedule(): ReminderSchedule[];
-    /**
-     * @deprecated use `getSuspendedReminderSchedules()` instead
-     */
-    getAllSuspendedReminderSchedule(): ReminderSchedule[];
-    /**
-     * @deprecated use `getReportSchedules()` instead
-     */
-    getAllReportSchedule(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): ReportSchedule[];
-    /**
-     * @deprecated use `getActiveReportSchedules()` instead
-     */
-    getAllActiveReportSchedule(): ReportSchedule[];
-    /**
-     * @deprecated use `getSuspendedReportSchedules()` instead
-     */
-    getAllSuspendedReportSchedule(): ReportSchedule[];
-    /**
-     * @deprecated use `getIPushPullSchedules()` instead
-     */
-    getAllIPushPullSchedule(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): IPushPullSchedule[];
-    /**
-     * @deprecated use `getActiveIPushPullSchedules()` instead
-     */
-    getAllActiveIPushPullSchedule(): IPushPullSchedule[];
-    /**
-     * @deprecated use `getSuspendedIPushPullSchedules()` instead
-     */
-    getAllSuspendedIPushPullSchedule(): IPushPullSchedule[];
-    /**
-     * @deprecated use `getGlue42Schedules()` instead
-     */
-    getAllGlue42Schedule(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): Glue42Schedule[];
-    /**
-     * @deprecated use `getActiveGlue42Schedules()` instead
-     */
-    getAllActiveGlue42Schedule(): Glue42Schedule[];
-    /**
-     * @deprecated use `getSuspendedGlue42Schedules()` instead
-     */
-    getAllSuspendedGlue42Schedule(): Glue42Schedule[];
-    /**
-     * @deprecated use `getOpenFinSchedules()` instead
-     */
-    getAllOpenFinSchedule(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): OpenFinSchedule[];
-    /**
-     * @deprecated use `getActiveOpenFinSchedules()` instead
-     */
-    getAllActiveOpenFinSchedule(): OpenFinSchedule[];
-    /**
-     * @deprecated use `getSuspendedOpenFinSchedules()` instead
-     */
-    getAllSuspendedOpenFinSchedule(): OpenFinSchedule[];
-    /**
-     * @deprecated use `openScheduleSettingsPanel()` instead
-     */
-    showSchedulePopup(): void;
 }

package/src/Api/SettingsPanelApi.d.ts

@@ -13,15 +13,4 @@ export interface SettingsPanelApi {
      * @param name name of Custom Settings Panel to display
      */
     openCustomSettingsPanel(name: string): void;
-    /**
-     * TO BE REMOVED
-     */
-    /**
-     * @deprecated use `openSettingsPanel()` instead
-     */
-    showSettingsPanel(moduleName?: AdaptableModule): void;
-    /**
-     * @deprecated use `openCustomSettingsPanel()` instead
-     */
-    showCustomSettingsPanel(name: string): void;
 }

package/src/Api/ShortcutApi.d.ts

@@ -57,29 +57,4 @@ export interface ShortcutApi {
      * Opens Settings Panel with Shortcut section selected and visible
      */
     openShortcutSettingsPanel(): void;
-    /**
-     * TO BE REMOVED
-     */
-    /**
-     * @deprecated use `getShortcuts()` instead
-     */
-    getAllShortcut(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): Shortcut[];
-    /**
-     * @deprecated use `getActiveShortcuts()` instead
-     */
-    getAllActiveShortcut(): Shortcut[];
-    /**
-     * @deprecated use `getSuspendedShortcuts()` instead
-     */
-    getAllSuspendedShortcut(): Shortcut[];
-    /**
-     * @deprecated use `deleteAllShortcuts()` instead
-     */
-    deleteAllShortcut(): void;
-    /**
-     * @deprecated use `openShortcutSettingsPanel()` instead
-     */
-    showShortcutPopup(): void;
 }

package/src/Api/SmartEditApi.d.ts

@@ -42,11 +42,4 @@ export interface SmartEditApi {
      * Retrieves an Smart Edit Custom Operations (provided in Edit Options)
      */
     getSmartEditCustomOperations(): SmartEditCustomOperation[];
-    /**
-     * TO BE REMOVED
-     */
-    /**
-     * @deprecated use `openSmartEditSettingsPanel()` instead
-     */
-    showSmartEditPopup(): void;
 }

package/src/Api/StyledColumnApi.d.ts

@@ -95,27 +95,6 @@ export interface StyledColumnApi {
      * Open Styled Column section of Settings Panel
      */
     openStyledColumnSettingsPanel(): void;
-    /**
-     * TO BE REMOVED
-     */
-    /**
-     * @deprecated use `getStyledColumns()` instead
-     */
-    getAllStyledColumn(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): StyledColumn[];
-    /**
-     * @deprecated use `getStyledColumnForColumnId()` instead
-     */
-    getStyledColumnByColumnId(columnId: StyledColumn['ColumnId']): StyledColumn;
-    /**
-     * @deprecated use `getActiveStyledColumns()` instead
-     */
-    getAllActiveStyledColumn(): StyledColumn[];
-    /**
-     * @deprecated use `getSuspendedStyledColumns()` instead
-     */
-    getAllSuspendedStyledColumn(): StyledColumn[];
     /**
      * Can this AdapTable instance display Sparklines (e.g. is AG Grid SparklinesModule installed)
      */

package/src/Api/SystemStatusApi.d.ts

@@ -35,15 +35,4 @@ export interface SystemStatusApi {
      * Deletes all System Status messages
      */
     deleteAllSystemStatusMessages(): void;
-    /**
-     * TO BE REMOVED
-     */
-    /**
-     * @deprecated internal method, will be removed in next major release
-     */
-    fireSystemStatusMessageDisplayedEvent(systemStatusMessageInfo: SystemStatusMessageInfo): void;
-    /**
-     * @deprecated use `openSystemStatusSettingsPanel()` instead
-     */
-    showSystemStatusPopup(): void;
 }

package/src/Api/TeamSharingApi.d.ts

@@ -71,27 +71,4 @@ export interface TeamSharingApi {
      * Refreshes the local TeamSharing state by (re)loading the remote state.
      */
     refreshTeamSharing(): void;
-    /**
-     * TO BE REMOVED
-     */
-    /**
-     *@deprecated use `openTeamSharingSettingsPanel()` instead
-     */
-    showTeamSharingPopup(): void;
-    /**
-     * @deprecated use `refreshTeamSharing()` instead
-     */
-    triggerLoadingTeamSharingEntries(): void;
-    /**
-     * @deprecated use `loadSharedEntities()` instead ()
-     */
-    getSharedEntities(): Promise<SharedEntity[]>;
-    /**
-     * @deprecated use `persistSharedEntities()` instead
-     */
-    setSharedEntities(sharedEntities: SharedEntity[]): Promise<boolean>;
-    /**
-     * @deprecated use `shareAdaptableEntity()` instead
-     */
-    shareEntity(entity: AdaptableObject, module: AdaptableModule, sharedEntityConfig: AdaptableSharedEntityConfig): void;
 }

package/src/Api/ThemeApi.d.ts

@@ -78,23 +78,4 @@ export interface ThemeApi {
      * Get the name of the current AG Grid theme
      */
     getAgGridCurrentThemeName(): string;
-    /**
-     * TO BE REMOVED
-     */
-    /**
-     * @deprecated use `getSystemThemes()` instead
-     */
-    getAllSystemTheme(): AdaptableTheme[];
-    /**
-     * @deprecated use `getUserThemes()` instead
-     */
-    getAllUserTheme(): AdaptableTheme[];
-    /**
-     * @deprecated use `getThemes()` instead
-     */
-    getAllTheme(): AdaptableTheme[];
-    /**
-     * @deprecated use `openThemeSettingsPanel()` instead
-     */
-    showThemePopup(): void;
 }

package/src/Api/UserInterfaceApi.d.ts

@@ -4,6 +4,7 @@ import { ColumnMenuContext, ContextMenuContext, UserMenuItem } from '../Predefin
 import { BulkUpdatePermittedValues, CustomSortPermittedValues, EditLookUpPermittedValues, FilterPermittedValues, PermittedValues } from '../AdaptableOptions/UserInterfaceOptions';
 import { GridCell } from '../PredefinedConfig/Selection/GridCell';
 import { AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
+import { AdaptableIcon } from '../types';
 /**
  * Functions relating to User Interface section of Adaptable State
  */
@@ -75,14 +76,8 @@ export interface UserInterfaceApi {
      */
     getAdaptableObjectTags(): AdaptableObjectTag[] | undefined;
     /**
-     * TO BE REMOVED
+     * Returns AdapTable Icon with given name
+     * @param name name of Icon
      */
-    /**
-     * @deprecated use `getPermittedValuesItems()` instead
-     */
-    getAllPermittedValuesItems(): PermittedValues[];
-    /**
-     * @deprecated use `getEditLookUpItems()` instead
-     */
-    getAllEditLookUpItems(): EditLookUpPermittedValues[];
+    getCustomIconDefinition(name: string): AdaptableIcon | undefined;
 }

package/src/PredefinedConfig/AlertState.d.ts

@@ -37,11 +37,11 @@ export interface AlertDefinition extends SuspendableObject {
      */
     MessageType: AdaptableMessageType;
     /**
-     * The Alert Title Message to display
+     * Title of displayed Alert Message
      */
     MessageHeader?: string;
     /**
-     * Alert Message; if not provided AdapTable creates dynamically using Rule & Scope (Note: can be provided as a function in AlertOptions)
+     * Title of dipslayed Alert Message; if null, AdapTable creates dynamically using Rule & Scope
      */
     MessageText?: string;
     /**
@@ -53,9 +53,15 @@ export interface AlertDefinition extends SuspendableObject {
      */
     AlertForm?: string | AlertButtonForm;
 }
+/**
+ * Form triggered by an Alert which contains only Buttons
+ */
 export declare type AlertButtonForm = Omit<AdaptableForm<AlertFormContext>, 'title' | 'buttons' | 'description'> & {
     Buttons?: AlertButton<AlertFormContext>[];
 };
+/**
+ * Predicate used when creating a Predicate-based Rule for an Alert
+ */
 export interface AlertDefinitionPredicate extends AdaptableColumnPredicate {
     PredicateId: TypeHint<string, SystemAlertPredicateId>;
 }
@@ -104,15 +110,15 @@ export interface AlertProperties {
      */
     DisplayNotification?: boolean;
     /**
-     * Notifiction duration, it defaults to NotificationOptions.duration
+     * Notifiction duration(defaults to `NotificationOptions.duration`)
      */
     NotificationDuration?: NotificationsOptions['duration'];
     /**
-     * Colours updated cell using `MessageType` property of triggering Alert Definition
+     * Colours updated Row using `MessageType` of triggering Alert Definition
      */
     HighlightCell?: boolean | AdaptableStyle;
     /**
-     * Colours updated cell using `MessageType` property of triggering Alert Definition
+     * Colours updated Row using `MessageType` of triggering Alert Definition
      */
     HighlightRow?: boolean | AdaptableStyle;
     /**

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

@@ -19,7 +19,7 @@ export interface BaseFormatterOptions {
  */
 export interface NumberFormatterOptions extends BaseFormatterOptions {
     /**
-     * Number of digits to show in fractions
+     * Number of digits to show in Fractions (up to 20)
      */
     FractionDigits?: number;
     /**
@@ -27,11 +27,11 @@ export interface NumberFormatterOptions extends BaseFormatterOptions {
      */
     FractionSeparator?: string;
     /**
-     * Number of digits to show for integers
+     * Number of digits to show for Integers (up to 20)
      */
     IntegerDigits?: number;
     /**
-     * Separator to use in integers
+     * Separator to use in Integers
      */
     IntegerSeparator?: string;
     /**

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

@@ -1,4 +1,5 @@
 import * as React from 'react';
+import { TypeHint } from './Types';
 /**
  * Defines an icon to be used in AdapTable (e.g. in Dashboard Header, Buttons, Menu, etc.)
  */
@@ -9,8 +10,10 @@ export declare type AdaptableIcon = AdaptableInternalIcon | AdaptableExternalIco
 export interface AdaptableInternalIcon extends AdaptableBaseIcon {
     /**
      * The name of the icon to use (referencing the AdapTable Icon Library)
+     *
+     * The icon can be a adaptable icon or a custom one defined in `interfaceOptions.customIcons`
      */
-    name: AdaptableInternalIconName;
+    name: TypeHint<string, AdaptableInternalIconName>;
     /**
      * The size (in pixels) of the SVG icon (defaults to `17px`)
      *

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

@@ -15,9 +15,12 @@ export interface AdaptablePredicate {
      */
     Inputs?: any[];
 }
+/**
+ * Restricts a Predicate to a given Column
+ */
 export interface AdaptableColumnPredicate extends AdaptablePredicate {
     /**
-     * If specified, ColumnId restricts the predicate evaluation to the given column
+     * Id of Column which will be evaluated by the Predicate
      */
     ColumnId?: string;
 }
@@ -68,6 +71,9 @@ export interface AdaptablePredicateDef {
      */
     onlyQuickFilter?: boolean;
 }
+/**
+ * Defines an Input to a Predicate
+ */
 export interface PredicateDefInput {
     type: 'number' | 'text' | 'date' | 'boolean';
     label?: string;
@@ -106,9 +112,15 @@ export interface PredicateDefHandlerParams {
      */
     api: AdaptableApi;
 }
+/**
+ * Inputs required for a Predicate
+ */
 export interface PredicateDefToStringParams {
     inputs: any[];
 }
+/**
+ * Defines which in Modules the Predicate is available
+ */
 export declare type PredicateModuleScope = 'filter' | 'alert' | 'flashingcell' | 'formatColumn' | 'badgeStyle';
 /**
  * Array of Predicate Defs which are shipped by AdapTable

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

@@ -12,4 +12,7 @@ export interface WeightedAverageAggregation {
      */
     weightedColumnId: string;
 }
+/**
+ * Defines which Columns in a Layout display Aggregated values when Row-Grouped
+ */
 export declare type AggregationColumns = Record<string, string | true | WeightedAverageAggregation>;

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

@@ -7,4 +7,12 @@ export interface BaseContext {
      * The Adaptable Api - included as a convenience
      */
     adaptableApi: AdaptableApi;
+    /**
+     * Name of Current User
+     */
+    userName: string;
+    /**
+     * Id of current AdapTable instance
+     */
+    adaptableId: string;
 }

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

@@ -1,4 +1,13 @@
+/**
+ * Defines where a Data Change should be monitored
+ */
 export interface DataChangedScope {
+    /**
+     * Scopes every Column in the Row
+     */
     wholeRow: boolean;
+    /**
+     * Scopes a group of Column Ids
+     */
     columnIds: Set<string>;
 }