@adaptabletools/adaptable-cjs 18.0.0-canary.8 → 18.0.0

package/src/Api/Internal/NoteInternalApi.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoteInternalApi = void 0;
+const ApiBase_1 = require("../Implementation/ApiBase");
+class NoteInternalApi extends ApiBase_1.ApiBase {
+    areNotesSupported() {
+        var _a;
+        const currentLayout = this.getLayoutApi().getCurrentLayout();
+        if (currentLayout.EnablePivot) {
+            return false;
+        }
+        if ((_a = currentLayout === null || currentLayout === void 0 ? void 0 : currentLayout.RowGroupedColumns) === null || _a === void 0 ? void 0 : _a.length) {
+            return false;
+        }
+        return true;
+    }
+}
+exports.NoteInternalApi = NoteInternalApi;

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

@@ -2,7 +2,7 @@ import { ApiBase } from '../Implementation/ApiBase';
 import { AdaptablePredicate, AdaptablePredicateDef } from '../../PredefinedConfig/Common/AdaptablePredicate';
 import { SystemFilterPredicateId } from '../../PredefinedConfig/Common/ColumnFilter';
 import { AdaptableColumnDataType } from '../../PredefinedConfig/Common/AdaptableColumn';
-import { AdaptableScope } from '../../types';
+import { ColumnScope } from '../../types';
 export declare class PredicateInternalApi extends ApiBase {
     /**
      * Returns true if the predicate has a dropdown.
@@ -13,23 +13,23 @@ export declare class PredicateInternalApi extends ApiBase {
     /**
      * Get all Filter Predicate Definitions - System and Custom
      */
-    getFilterPredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
+    getFilterPredicateDefs(scope: ColumnScope): AdaptablePredicateDef[];
     private getSystemFilterPredicateIds;
     /**
      * Get all Alert Predicate Definitions - System and Custom
      */
-    getAlertPredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
+    getAlertPredicateDefs(scope: ColumnScope): AdaptablePredicateDef[];
     private getSystemAlertPredicateIds;
     private getSystemBadgeStylePredicateIds;
     /**
      * Get all Format Column Predicate Definitions - System and Custom
      */
-    getFormatColumnPredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
+    getFormatColumnPredicateDefs(scope: ColumnScope): AdaptablePredicateDef[];
     private getSystemFormatColumnPredicateIds;
     /**
      * Get all Flashing Cell Predicate Definitions - System and Custom
      */
-    getFlashingCellPredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
+    getFlashingCellPredicateDefs(scope: ColumnScope): AdaptablePredicateDef[];
     private getSystemFlashingCellPredicateIds;
     /**
      * Gets the correct Equality-type System Predicate for a particular DataType
@@ -39,7 +39,7 @@ export declare class PredicateInternalApi extends ApiBase {
     /**
      * Get all Badge Style Predicate Definitions - System and Custom
      */
-    getBadgeStylePredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
+    getBadgeStylePredicateDefs(scope: ColumnScope): AdaptablePredicateDef[];
     /**
      * Merges System and Custom Predicate Definitions but ensures that Custom ones take precedence
      * (i.e. if there is a Custom Predicate with the same Id as a System one, the Custom one is used)

package/src/Api/Internal/PredicateInternalApi.js

@@ -21,14 +21,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
     getSystemFilterPredicateIds(scope) {
         const systemFilterPredicates = this.getPredicateOptions().systemFilterPredicates;
         if (typeof systemFilterPredicates === 'function') {
-            const systemPredicateContext = {
-                adaptableApi: this.adaptable.api,
-                userName: this.getOptions().userName,
-                adaptableId: this.getOptions().adaptableId,
-                systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('columnFilter'),
-                moduleScope: 'columnFilter',
-                columnScope: scope,
-            };
+            const systemPredicateContext = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('columnFilter'), moduleScope: 'columnFilter', columnScope: scope });
             return systemFilterPredicates(systemPredicateContext);
         }
         return systemFilterPredicates;
@@ -43,14 +36,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
     getSystemAlertPredicateIds(scope) {
         const systemAlertPredicates = this.getPredicateOptions().systemAlertPredicates;
         if (typeof systemAlertPredicates === 'function') {
-            const systemPredicateContext = {
-                adaptableApi: this.adaptable.api,
-                userName: this.getOptions().userName,
-                adaptableId: this.getOptions().adaptableId,
-                systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('alert'),
-                moduleScope: 'alert',
-                columnScope: scope,
-            };
+            const systemPredicateContext = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('alert'), moduleScope: 'alert', columnScope: scope });
             return systemAlertPredicates(systemPredicateContext);
         }
         return systemAlertPredicates;
@@ -58,14 +44,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
     getSystemBadgeStylePredicateIds(scope) {
         const systemBadgeStylePredicates = this.getPredicateOptions().systemBadgeStylePredicates;
         if (typeof systemBadgeStylePredicates === 'function') {
-            const systemPredicateContext = {
-                adaptableApi: this.adaptable.api,
-                userName: this.getOptions().userName,
-                adaptableId: this.getOptions().adaptableId,
-                systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('badgeStyle'),
-                moduleScope: 'badgeStyle',
-                columnScope: scope,
-            };
+            const systemPredicateContext = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('badgeStyle'), moduleScope: 'badgeStyle', columnScope: scope });
             return systemBadgeStylePredicates(systemPredicateContext);
         }
         return systemBadgeStylePredicates;
@@ -80,14 +59,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
     getSystemFormatColumnPredicateIds(scope) {
         const systemFormatColumnPredicates = this.getPredicateOptions().systemFormatColumnPredicates;
         if (typeof systemFormatColumnPredicates === 'function') {
-            const systemPredicateContext = {
-                adaptableApi: this.adaptable.api,
-                userName: this.getOptions().userName,
-                adaptableId: this.getOptions().adaptableId,
-                systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('formatColumn'),
-                moduleScope: 'formatColumn',
-                columnScope: scope,
-            };
+            const systemPredicateContext = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('formatColumn'), moduleScope: 'formatColumn', columnScope: scope });
             return systemFormatColumnPredicates(systemPredicateContext);
         }
         return systemFormatColumnPredicates;
@@ -102,14 +74,7 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
     getSystemFlashingCellPredicateIds(scope) {
         const systemFlashingCellPredicates = this.getPredicateOptions().systemFlashingCellPredicates;
         if (typeof systemFlashingCellPredicates === 'function') {
-            const systemPredicateContext = {
-                adaptableApi: this.adaptable.api,
-                userName: this.getOptions().userName,
-                adaptableId: this.getOptions().adaptableId,
-                systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('flashingcell'),
-                moduleScope: 'flashingcell',
-                columnScope: scope,
-            };
+            const systemPredicateContext = Object.assign({ systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('flashingcell'), moduleScope: 'flashingcell', columnScope: scope }, this.getAdaptableApi().internalApi.buildBaseContext());
             return systemFlashingCellPredicates(systemPredicateContext);
         }
         return systemFlashingCellPredicates;

package/src/Api/Internal/ScheduleInternalApi.js

@@ -8,12 +8,7 @@ class ScheduleInternalApi extends ApiBase_1.ApiBase {
      */
     fireScheduleTriggeredEvent(schedule) {
         const adaptableApi = this.getAdaptableApi();
-        const scheduleTriggeredInfo = {
-            adaptableApi: adaptableApi,
-            userName: adaptableApi.optionsApi.getUserName(),
-            adaptableId: adaptableApi.optionsApi.getAdaptableId(),
-            schedule: schedule,
-        };
+        const scheduleTriggeredInfo = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { schedule: schedule });
         adaptableApi.eventApi.emit('ScheduleTriggered', scheduleTriggeredInfo);
     }
 }

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

@@ -1,6 +1,6 @@
 import { ApiBase } from '../Implementation/ApiBase';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
-import { BadgeStyleDefinition, CellColorRange, ColumnComparison, NumericStyledColumn, StyledColumn } from '../../PredefinedConfig/StyledColumnState';
+import { BadgeStyle, BadgeStyleDefinition, CellColorRange, ColumnComparison, NumericStyledColumn, StyledColumn } from '../../PredefinedConfig/StyledColumnState';
 import { IRowNode } from '@ag-grid-community/core';
 import { PredicateDefHandlerContext } from '../../types';
 export declare class StyledColumnInternalApi extends ApiBase {
@@ -57,6 +57,6 @@ export declare class StyledColumnInternalApi extends ApiBase {
      * @param styledColumn Styled Column to Add
      */
     hasStyledColumnRelativeCellRange(styledColumn: StyledColumn): boolean;
-    getApplicableBadge(styledColumn: StyledColumn, context: PredicateDefHandlerContext): BadgeStyleDefinition | null;
+    getApplicableBadge(badgeStyle: BadgeStyle, context: PredicateDefHandlerContext): BadgeStyleDefinition | null;
     getBadgePredicateDefsForColumn(columnId: string): import("../../types").AdaptablePredicateDef<string>[];
 }

package/src/Api/Internal/StyledColumnInternalApi.js

@@ -34,11 +34,11 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
             }
             else {
                 let columnId = columnComparison.MinValue;
-                if (!this.adaptable.api.columnApi.isColumnInGrid(columnId)) {
+                if (!this.getAdaptableApi().columnApi.isColumnInGrid(columnId)) {
                     return 0;
                 }
                 else {
-                    return this.adaptable.api.gridApi.getRawValueFromRowNode(rowNode, columnId);
+                    return this.getAdaptableApi().gridApi.getRawValueFromRowNode(rowNode, columnId);
                 }
             }
         }
@@ -97,11 +97,11 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
             }
             else {
                 let columnId = columnComparison.MaxValue;
-                if (!this.adaptable.api.columnApi.isColumnInGrid(columnId)) {
+                if (!this.getAdaptableApi().columnApi.isColumnInGrid(columnId)) {
                     return 0;
                 }
                 else {
-                    return this.adaptable.api.gridApi.getRawValueFromRowNode(rowNode, columnId);
+                    return this.getAdaptableApi().gridApi.getRawValueFromRowNode(rowNode, columnId);
                 }
             }
         }
@@ -245,15 +245,14 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
                 return cellColorRange.Min == 'Col-Min' || cellColorRange.Max == 'Col-Max';
             })))) !== null && _e !== void 0 ? _e : false);
     }
-    getApplicableBadge(styledColumn, context) {
-        var _a, _b;
-        if (!((_a = styledColumn.BadgeStyle) === null || _a === void 0 ? void 0 : _a.Badges.length)) {
+    getApplicableBadge(badgeStyle, context) {
+        if (!badgeStyle.Badges.length) {
             return null;
         }
         // first that matches, sort last ones without predicate
         const badgesWithoutAll = [];
         const badgesWithAll = [];
-        for (let badge of (_b = styledColumn.BadgeStyle) === null || _b === void 0 ? void 0 : _b.Badges) {
+        for (let badge of badgeStyle.Badges) {
             if (!badge.Predicate) {
                 badgesWithAll.push(badge);
             }
@@ -279,7 +278,7 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
         };
         return this.getAdaptableApi()
             .predicateApi.internalApi.getBadgeStylePredicateDefs(scope)
-            .filter((predicate) => this.adaptable.api.scopeApi.isColumnInScope(column, predicate.columnScope));
+            .filter((predicate) => this.getAdaptableApi().columnScopeApi.isColumnInScope(column, predicate.columnScope));
     }
 }
 exports.StyledColumnInternalApi = StyledColumnInternalApi;

package/src/Api/Internal/SystemStatusInternalApi.js

@@ -10,13 +10,7 @@ class SystemStatusInternalApi extends ApiBase_1.ApiBase {
      * @param systemStatusMessageInfo Info about new System Status Message
      */
     fireSystemStatusMessageDisplayedEvent(systemStatusMessageInfo) {
-        const adaptableApi = this.getAdaptableApi();
-        const systemStatusMessageDisplayedInfo = {
-            adaptableApi,
-            systemStatusMessageInfo: systemStatusMessageInfo,
-            userName: adaptableApi.optionsApi.getUserName(),
-            adaptableId: adaptableApi.optionsApi.getAdaptableId(),
-        };
+        const systemStatusMessageDisplayedInfo = Object.assign({ systemStatusMessageInfo: systemStatusMessageInfo }, this.getAdaptableApi().internalApi.buildBaseContext());
         this.getAdaptableApi().eventApi.emit('SystemStatusMessageDisplayed', systemStatusMessageDisplayedInfo);
     }
     addSystemStatusMessageInfo(systemStatusMessageInfo) {

package/src/Api/Internal/TeamSharingInternalApi.js

@@ -9,12 +9,7 @@ class TeamSharingInternalApi extends ApiBase_1.ApiBase {
      */
     fireTeamSharingEntityChangedEvent(sharedEntity) {
         if (this.adaptable.isReady) {
-            const teamSharingEntityChangedInfo = {
-                adaptableApi: this.adaptable.api,
-                sharedEntity: sharedEntity,
-                userName: this.adaptable.api.optionsApi.getUserName(),
-                adaptableId: this.adaptable.api.optionsApi.getAdaptableId(),
-            };
+            const teamSharingEntityChangedInfo = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { sharedEntity: sharedEntity });
             this.getAdaptableApi().eventApi.emit('TeamSharingEntityChanged', teamSharingEntityChangedInfo);
         }
     }
@@ -41,7 +36,7 @@ class TeamSharingInternalApi extends ApiBase_1.ApiBase {
                 reject(false);
             }, waitThreshold);
             // poll state for changes:
-            const unsubscribe = this.adaptable.api.eventApi.on('AdaptableStateChanged', () => {
+            const unsubscribe = this.getAdaptableApi().eventApi.on('AdaptableStateChanged', () => {
                 clearTimeout(pollTimer);
                 pollTimer = setTimeout(() => {
                     // state is stable, cleanup all subscriptions before returning

package/src/Api/Internal/ThemeInternalApi.js

@@ -13,7 +13,7 @@ class ThemeInternalApi extends ApiBase_1.ApiBase {
         return `ab--theme-${theme}`;
     }
     openInWindow() {
-        this.adaptable.api.internalApi.showPopupWindow({
+        this.getAdaptableApi().internalApi.showPopupWindow({
             id: windowFactory_1.SHOW_THEME_EDITOR,
             title: 'Theme',
             icon: 'theme',

package/src/Api/Internal/UserInterfaceInternalApi.js

@@ -6,7 +6,7 @@ class UserInterfaceInternalApi extends ApiBase_1.ApiBase {
     prepareAdaptableIconDef(icon) {
         if (icon && 'name' in icon) {
             let customIcon = icon && 'name' in icon
-                ? this.adaptable.api.userInterfaceApi.getCustomIconDefinition(icon.name)
+                ? this.getAdaptableApi().userInterfaceApi.getCustomIconDefinition(icon.name)
                 : null;
             if (customIcon) {
                 icon = customIcon;

package/src/Api/LayoutApi.d.ts

@@ -23,6 +23,10 @@ export interface LayoutApi {
      * @returns layout
      */
     getCurrentLayout(): Layout;
+    /**
+     * Returns true if the current layout is a pivot layout
+     */
+    isCurrentLayoutPivot(): boolean;
     /**
      * Retrieves the sort order of a column from the current layout
      * @param columnId Column id
@@ -38,6 +42,10 @@ export interface LayoutApi {
      * Retrieves array of visible ColumnIds in current Layout
      */
     getCurrentVisibleColumnIds(): string[];
+    /**
+     * Retrieves array of visible ColumnIds in current Layout
+     */
+    getCurrentRowGroupsColumnIds(): string[];
     /**
      * Retrieves name of current Layout
      */
@@ -164,22 +172,14 @@ export interface LayoutApi {
      */
     removeColumnFromLayout(columnId: string, layoutName: string): void;
     /**
-     * Returns what the layout supports.
-     * This takes into account the data-source.
+     * Adds a Column to a given Layout
+     * @param columnId Column to add
+     * @param layoutName layout to which to add Column
      */
-    getLayoutSupportedFeatures(): {
-        RowGroupedColumns: boolean;
-        AggregationColumns: boolean;
-        PivotColumns: boolean;
-        ColumnFilters: boolean;
-        ColumnSorts: boolean;
-    };
+    addColumnToLayout(columnId: string, layoutName: string): void;
     /**
-     * Opens a window with a transposed view of the grid
-     * it only works for client side data
+     * Adds a Column to Current Layout
+     * @param columnId Column to add
      */
-    showTransposePopup(config: {
-        transposedColumnId: string;
-        hideTransposedColumn?: boolean;
-    }): void;
+    addColumnToCurrentLayout(columnId: string): void;
 }

package/src/Api/NoteApi.d.ts

@@ -0,0 +1,48 @@
+import { AdaptableNote, AdaptableNotes, NoteState } from '../PredefinedConfig/NoteState';
+import { CellAddress } from '../../types';
+/**
+ * Provides run-time access to Notes Module and related State
+ */
+export interface NoteApi {
+    /**
+     * Adds a new Note
+     * @param text
+     * @param primaryKeyValue
+     * @param columnId
+     */
+    addNote(text: string, primaryKeyValue: any, columnId: string): void;
+    /**
+     * Edits a Note
+     * @param note
+     */
+    editNote(note: AdaptableNote): void;
+    /**
+     * Edits text of a Note
+     * @param text
+     * @param note
+     */
+    updateNoteText(text: string, note: AdaptableNote): void;
+    /**
+     * Deletes a Note
+     * @param note
+     */
+    deleteNote(note: AdaptableNote): void;
+    /**
+     * Gets the Note State
+     */
+    getNoteState(): NoteState;
+    /**
+     * Gets all Notes
+     */
+    getAllNotes(): AdaptableNotes;
+    /**
+     * Gets all Notes for a cell
+     * @param CellAddress note position
+     */
+    getNoteForCell(CellAddress: CellAddress): AdaptableNote;
+    /**
+     * Returns a Note by uuid
+     * @param uuid note uuid
+     */
+    getNoteByUuid(uuid: string): AdaptableNote | undefined;
+}

package/src/Api/NoteApi.js

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

package/src/Api/OptionsApi.d.ts

@@ -1,11 +1,11 @@
 import { CustomSortOptions } from '../AdaptableOptions/CustomSortOptions';
 import { DataSetOptions } from '../AdaptableOptions/DataSetOptions';
 import { GroupingOptions } from '../AdaptableOptions/GroupingOptions';
-import { ActionColumnOptions, ActionRowOptions, AdaptableOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnFilterOptions, ColumnOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FlashingCellOptions, FormatColumnOptions, GridFilterOptions, LayoutOptions, MenuOptions, NotesOptions, NotificationsOptions, QuickSearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
+import { ActionColumnOptions, ActionRowOptions, AdaptableOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnFilterOptions, ColumnMenuOptions, ColumnOptions, ContainerOptions, ContextMenuOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FlashingCellOptions, FormatColumnOptions, GridFilterOptions, LayoutOptions, NoteOptions, NotificationsOptions, QuickSearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
 import { Fdc3Options } from '../AdaptableOptions/Fdc3Options';
 import { ExpressionOptions } from '../AdaptableOptions/ExpressionOptions';
 import { DataImportOptions } from '../AdaptableOptions/DataImportOptions';
-import { CommentsOptions } from '../AdaptableOptions/CommentOptions';
+import { CommentOptions } from '../AdaptableOptions/CommentOptions';
 /**
  * Range of functions to access Adaptable Options
  */
@@ -75,13 +75,9 @@ export interface OptionsApi {
      */
     getColumnOptions(): Readonly<ColumnOptions>;
     /**
-     * Returns `AdaptableOptions.noteOptions`
-     */
-    getNotesOptions(): Readonly<NotesOptions>;
-    /**
-     * Returns `AdaptableOptions.commentsOptions`
+     * Returns `AdaptableOptions.commentOptions`
      */
-    getCommentsOptions(): Readonly<CommentsOptions>;
+    getCommentOptions(): Readonly<CommentOptions>;
     /**
      * Returns `AdaptableOptions.customSortOptions`
      */
@@ -131,9 +127,13 @@ export interface OptionsApi {
      */
     getLayoutOptions(): Readonly<LayoutOptions>;
     /**
-     * Returns `AdaptableOptions.menuOptions`
+     * Returns `AdaptableOptions.columnMenuOptions`
+     */
+    getColumnMenuOptions(): Readonly<ColumnMenuOptions>;
+    /**
+     * Returns `AdaptableOptions.contextMenuOptions`
      */
-    getMenuOptions(): Readonly<MenuOptions>;
+    getContextMenuOptions(): Readonly<ContextMenuOptions>;
     /**
      * Returns `AdaptableOptions.notificationsOptions`
      */
@@ -146,6 +146,10 @@ export interface OptionsApi {
      * Returns `AdaptableOptions.formatColumnOptions`
      */
     getFormatColumnOptions(): Readonly<FormatColumnOptions>;
+    /**
+     * Returns `AdaptableOptions.noteOptions`
+     */
+    getNoteOptions(): Readonly<NoteOptions>;
     /**
      * Returns `AdaptableOptions.settingsPanelOptions`
      */

package/src/Api/UserInterfaceApi.d.ts

@@ -1,11 +1,10 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
-import { ColumnMenuContext, ContextMenuContext, UserMenuItem } from '../PredefinedConfig/Common/Menu';
 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';
-import { CustomWindowConfig } from '../AdaptableOptions/AdaptableFrameworkComponent';
+import { AdaptableFrameworkComponent, AdaptableIcon } from '../types';
+import { CustomRenderFunction, CustomWindowConfig } from '../AdaptableOptions/AdaptableFrameworkComponent';
 /**
  * Functions relating to User Interface section of Adaptable State
  */
@@ -54,16 +53,6 @@ export interface UserInterfaceApi {
      * @param  gridCell: the currently edited Grid Cell
      */
     getEditLookUpValuesForEditLookUpItem(editLookUpItem: EditLookUpPermittedValues, gridCell: GridCell): any[] | undefined;
-    /**
-     * Adds menu item to Column Menu
-     * @param userMenuItem Menu Item to add
-     */
-    addColumnMenuItem(userMenuItem: UserMenuItem<ColumnMenuContext>): void;
-    /**
-     * Adds menu item to Context Menu
-     * @param userMenuItem Menu Item to add
-     */
-    addContextMenuItem(userMenuItem: UserMenuItem<ContextMenuContext>): void;
     /**
      * Returns Style set for Editable cells
      */
@@ -83,12 +72,25 @@ export interface UserInterfaceApi {
     getCustomIconDefinition(name: string): AdaptableIcon | undefined;
     /**
      * Displays the popup that says getting data and initialising grid
+     * @deprecated use `showProgressIndicator()` instead
      */
     showLoadingScreen(): void;
     /**
      * Hides the popup that says getting data and initialising grid
+     * @deprecated use `hideProgressIndicator()` instead
      */
     hideLoadingScreen(): void;
+    /**
+     *
+     * @param config
+     */
+    showProgressIndicator(config: {
+        text?: string;
+        render?: CustomRenderFunction;
+        frameworkComponent?: AdaptableFrameworkComponent;
+        delay?: number;
+    }): void;
+    hideProgressIndicator(): void;
     /**
      * Opens window with custom content
      * @param config

package/src/PredefinedConfig/AdaptableState.d.ts

@@ -23,7 +23,7 @@ import { FlashingCellState } from './FlashingCellState';
 import { StatusBarState } from './StatusBarState';
 import { ChartingState } from './ChartingState';
 import { StyledColumnState } from './StyledColumnState';
-import { NotesState } from './NotesState';
+import { NoteState } from './NoteState';
 import { NamedQueryState } from './NamedQueryState';
 import { CommentState } from './CommentState';
 /**
@@ -57,7 +57,7 @@ export interface AdaptablePersistentState {
     Theme: ThemeState;
     ToolPanel: ToolPanelState;
     Charting: ChartingState;
-    Notes: NotesState;
+    Note: NoteState;
     /**
      * @deprecated
      */

package/src/PredefinedConfig/AlertState.d.ts

@@ -1,5 +1,5 @@
 import { ConfigState } from './ConfigState';
-import { AdaptableScope } from './Common/AdaptableScope';
+import { ColumnScope } from './Common/ColumnScope';
 import { AdaptableColumnPredicate } from './Common/AdaptablePredicate';
 import { TypeHint } from './Common/Types';
 import { AdaptableMessageType } from './Common/AdaptableMessageType';
@@ -27,7 +27,7 @@ export interface AlertDefinition extends SuspendableObject {
     /**
      * Where Alert can be triggered: one, some or all columns or DataTypes
      */
-    Scope: AdaptableScope;
+    Scope: ColumnScope;
     /**
      * When Alert should be triggered
      */

package/src/PredefinedConfig/CommentState.d.ts

@@ -1,19 +1,33 @@
-import { AdaptableObject } from '../types';
-import { ConfigState } from './ConfigState';
+import { CellAddress } from '../types';
+import { InternalState } from './InternalState';
+import { TypeUuid } from './Uuid';
 /**
- * Note that can be applied to a Cell in AdapTable
+ * Internal State used for Comments Module
  */
-export interface AdaptableComment extends AdaptableObject {
+export interface CommentState extends InternalState {
     /**
-     * When Note was made
+     * Collection of AdapTable Comments
+     */
+    CommentThreads?: CommentThread[];
+}
+/**
+ * Comment that can be applied to a Cell in AdapTable
+ */
+export interface AdaptableComment {
+    /**
+     * Unique identifier for the Comment
+     */
+    Uuid?: TypeUuid;
+    /**
+     * When Comment was made
      */
     Timestamp: number;
     /**
-     * Value of the Note
+     * Content of the Comment
      */
     Value: string;
     /**
-     * Author of the Note
+     * Author of the Comment
      */
     Author?: {
         UserName: string;
@@ -23,26 +37,16 @@ export interface AdaptableComment extends AdaptableObject {
      */
     AdaptableId?: string;
 }
-export interface CommentThread extends AdaptableObject {
-    /**
-     * Value in Primary Key Column
-     */
-    PrimaryKeyValue: string | number;
+/**
+ * Thread of Comments for an Adaptable Cell
+ */
+export interface CommentThread extends CellAddress {
     /**
-     * Id of Column containing the Note
+     * Unique identifier for Comment
      */
-    ColumnId: string;
+    Uuid?: TypeUuid;
     /**
      * Collection of Comments for this Cell
      */
     Comments: AdaptableComment[];
 }
-/**
- * Predefined Configuration for Notes Module
- */
-export interface CommentState extends ConfigState {
-    /**
-     * Collection of AdapTable Notes
-     */
-    CommentThreads?: CommentThread[];
-}

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

@@ -19,6 +19,10 @@ export interface AdaptableColumnBase extends AdaptableObject {
      * DataType of the Column
      */
     dataType: AdaptableColumnDataType;
+    /**
+     * Column Types of the Column
+     */
+    columnTypes?: string[];
 }
 export declare const isValidOrderForColumnGroups: ({ oldColumns, newColumns, }: {
     oldColumns: AdaptableColumn[];