@adaptabletools/adaptable 18.0.0-canary.2 → 18.0.0-canary.21

package/src/Api/Internal/FreeTextColumnInternalApi.js

@@ -1,4 +1,9 @@
 import { ApiBase } from '../Implementation/ApiBase';
+import { CreateEmptyFreeTextColumn } from '../../Utilities/ObjectFactory';
+import { AdaptableNumberEditor } from '../../agGrid/editors/AdaptableNumberEditor';
+import { AdaptableDateEditor } from '../../agGrid/editors/AdaptableDateEditor';
+import { AB_SPECIAL_COLUMN } from '../../Utilities/Constants/GeneralConstants';
+import ArrayExtensions from '../../Utilities/Extensions/ArrayExtensions';
 export class FreeTextColumnInternalApi extends ApiBase {
     /**
      * Checks if a User Edit was in a Free Text Column
@@ -37,4 +42,59 @@ export class FreeTextColumnInternalApi extends ApiBase {
         });
         return references;
     }
+    getColDefsForFreeTextColumns() {
+        const defaultSpecialColumnSettings = this.getGridApi().internalApi.deriveSpecialColumnSettingsFromAgGridDefaultColDef();
+        const defaultFreeTextColumnSettings = CreateEmptyFreeTextColumn(defaultSpecialColumnSettings).FreeTextColumnSettings;
+        return this.getFreeTextColumnApi()
+            .getFreeTextColumns()
+            .map((freeTextColumn) => {
+            var _a;
+            const freeTextColumnSettings = Object.assign(Object.assign({}, defaultFreeTextColumnSettings), freeTextColumn.FreeTextColumnSettings);
+            const dataTypeEditor = freeTextColumnSettings.DataType === 'Number'
+                ? AdaptableNumberEditor
+                : freeTextColumnSettings.DataType === 'Date'
+                    ? AdaptableDateEditor
+                    : null;
+            const columnTypes = [
+                AB_SPECIAL_COLUMN,
+                this.getGridApi().internalApi.getAgGridDataType(freeTextColumnSettings.DataType),
+            ];
+            if (ArrayExtensions.IsNotNullOrEmpty((_a = freeTextColumn === null || freeTextColumn === void 0 ? void 0 : freeTextColumn.FreeTextColumnSettings) === null || _a === void 0 ? void 0 : _a.ColumnTypes)) {
+                columnTypes.push(...freeTextColumn.FreeTextColumnSettings.ColumnTypes);
+            }
+            const newColDef = {
+                headerName: freeTextColumn.FriendlyName || freeTextColumn.ColumnId,
+                colId: freeTextColumn.ColumnId,
+                editable: true,
+                hide: false,
+                width: freeTextColumnSettings.Width,
+                enableValue: freeTextColumnSettings.Aggregatable,
+                filter: freeTextColumnSettings.Filterable,
+                floatingFilter: freeTextColumnSettings.Filterable,
+                resizable: freeTextColumnSettings.Resizable,
+                enableRowGroup: freeTextColumnSettings.Groupable,
+                sortable: freeTextColumnSettings.Sortable,
+                enablePivot: freeTextColumnSettings.Pivotable,
+                suppressHeaderMenuButton: freeTextColumnSettings.SuppressMenu,
+                suppressMovable: freeTextColumnSettings.SuppressMovable,
+                cellEditor: dataTypeEditor !== null && dataTypeEditor !== void 0 ? dataTypeEditor : (freeTextColumn.TextEditor && freeTextColumn.TextEditor == 'Large'
+                    ? 'agLargeTextCellEditor'
+                    : 'agTextCellEditor'),
+                type: columnTypes,
+                valueSetter: (params) => {
+                    return (params.data[freeTextColumn.ColumnId] = params.newValue);
+                },
+                // use a Boolean Cell Data Type if the Free Text Column is boolean
+                cellDataType: freeTextColumnSettings.DataType && freeTextColumnSettings.DataType == 'Boolean'
+                    ? 'boolean'
+                    : undefined,
+                valueGetter: (params) => this.getFreeTextColumnApi().getFreeTextColumnValueForRowNode(freeTextColumn, params.node),
+            };
+            if (freeTextColumnSettings.HeaderToolTip) {
+                newColDef.headerTooltip = freeTextColumnSettings.HeaderToolTip;
+            }
+            this.getAdaptableApi().logInfo('Setting up FreeText Column: ' + freeTextColumn.ColumnId);
+            return newColDef;
+        });
+    }
 }

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

@@ -1,4 +1,9 @@
 import { ApiBase } from '../Implementation/ApiBase';
+import { GridFilter } from '../../types';
 export declare class GridFilterInternalApi extends ApiBase {
     fireGridFilterAppliedEvent(): void;
+    /**
+   * Compares to Grid Filters to see if they are identical
+   */
+    isGridFilterDifferent(oldFilter: GridFilter, newFilter: GridFilter): boolean;
 }

package/src/Api/Internal/GridFilterInternalApi.js

@@ -1,7 +1,7 @@
 import { ApiBase } from '../Implementation/ApiBase';
 export class GridFilterInternalApi extends ApiBase {
     fireGridFilterAppliedEvent() {
-        if (this.adaptable.isLive) {
+        if (this.adaptable.isReady) {
             const currentGridFilter = this.getGridFilterApi().getCurrentGridFilter();
             const adaptableApi = this.getAdaptableApi();
             const gridFilterAppliedInfo = {
@@ -16,4 +16,10 @@ export class GridFilterInternalApi extends ApiBase {
             adaptableApi.eventApi.emit('GridFilterApplied', gridFilterAppliedInfo);
         }
     }
+    /**
+   * Compares to Grid Filters to see if they are identical
+   */
+    isGridFilterDifferent(oldFilter, newFilter) {
+        return (oldFilter === null || oldFilter === void 0 ? void 0 : oldFilter.Expression) === (newFilter === null || newFilter === void 0 ? void 0 : newFilter.Expression);
+    }
 }

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

@@ -1,12 +1,16 @@
 import { ApiBase } from '../Implementation/ApiBase';
 import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
-import { IRowNode } from '@ag-grid-community/core';
+import { IRowNode, RowClassParams } from '@ag-grid-community/core';
+import { GridDataChangeTrigger } from '../Events/GridDataChanged';
 import { GridCell } from '../../PredefinedConfig/Selection/GridCell';
-import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
+import { AdaptableColumn, AdaptableColumnDataType } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { SelectedCellInfo } from '../../PredefinedConfig/Selection/SelectedCellInfo';
 import { SelectedRowInfo } from '../../PredefinedConfig/Selection/SelectedRowInfo';
 import { AdaptableMenuItem } from '../../PredefinedConfig/Common/Menu';
 import { EditLookUpPermittedValues } from '../../AdaptableOptions/UserInterfaceOptions';
+import { DistinctValuesParams } from '../../AdaptableInterfaces/IAdaptable';
+import { AdaptableColumnType } from '../../PredefinedConfig/Common/Types';
+import { SpecialColumnSettings } from '../../PredefinedConfig/Common/SpecialColumnSettings';
 export declare class GridInternalApi extends ApiBase {
     /**
      * Fires Grid Sorted Event
@@ -19,7 +23,7 @@ export declare class GridInternalApi extends ApiBase {
     /**
      * Fires Grid Data Changed Event - when a row has changed in AG Grid
      */
-    fireGridDataChangedEvent(dataRows: any[], rowNodes: IRowNode[], rowTrigger: 'Add' | 'Edit' | 'Delete'): void;
+    fireGridDataChangedEvent(dataRows: any[], rowNodes: IRowNode[], rowTrigger: GridDataChangeTrigger): void;
     /**
      * Gets all distinct display values in the Column with the given ColumnId
      * @param columnId Column to check
@@ -39,17 +43,23 @@ export declare class GridInternalApi extends ApiBase {
         }[];
         suppressClientSideFilter: boolean;
     }>;
+    getDistinctFilterListValuesForColumn(column: AdaptableColumn, filter: string, distinctValuesParams: DistinctValuesParams): Promise<{
+        suppressClientSideFilter?: boolean;
+        gridCells: GridCell[];
+    }>;
     /**
      * Gets all distinct Custom Sort values for the Column with the given ColumnId
      * @param columnId Column to check
      */
     getDistinctCustomSortDisplayValuesForColumn(columnId: string): Promise<any[]>;
+    getDistinctCustomSortValuesForColumn(column: AdaptableColumn, distinctValuesParams: DistinctValuesParams): Promise<GridCell<any>[]>;
     /**
      * Gets all distinct Bulk Update values for the Column with the given ColumnId
      * @param columnId Column to check
      * @param selectedGridCells Selected grid cells
      */
     getDistinctBulkUpdateDisplayValuesForColumn(columnId: string, selectedGridCells: GridCell[]): Promise<any[]>;
+    getDistinctBulkUpdateValuesForColumn(column: AdaptableColumn, selectedGridCells: GridCell[], distinctValuesParams: DistinctValuesParams): Promise<GridCell<any>[]>;
     /**
      * Gets all distinct visible (after current filters are applied) display values in the Column with the given ColumnId
      * @param columnId Column to check
@@ -78,4 +88,14 @@ export declare class GridInternalApi extends ApiBase {
     setSelectedRows(selectedRowInfo: SelectedRowInfo): void;
     buildStandaloneColumnHeader(column: AdaptableColumn): AdaptableMenuItem[];
     getEditLookUpValuesForColumn(editLookUpItem: EditLookUpPermittedValues, column: AdaptableColumn, gridCell?: GridCell): any[] | undefined;
+    getAgGridDataType(dataType: AdaptableColumnDataType): AdaptableColumnType;
+    getRowHighlightStyle(params: RowClassParams): {
+        [cssProperty: string]: string;
+    };
+    getAlertRowStyle(params: RowClassParams): {
+        [cssProperty: string]: string;
+    };
+    getAlertRowClass(params: RowClassParams): string | null;
+    getRowHighlightClass(params: RowClassParams): string | null;
+    deriveSpecialColumnSettingsFromAgGridDefaultColDef(): Partial<SpecialColumnSettings>;
 }

package/src/Api/Internal/GridInternalApi.js

@@ -3,12 +3,15 @@ import { SortOrder } from '../../PredefinedConfig/Common/Enums';
 import ArrayExtensions from '../../Utilities/Extensions/ArrayExtensions';
 import * as GridRedux from '../../Redux/ActionsReducers/GridRedux';
 import NumberExtensions from '../../Utilities/Extensions/NumberExtensions';
+import { convertAdaptableStyleToCSS } from '../../Utilities/Helpers/StyleHelper';
+import UIHelper from '../../View/UIHelper';
+import { createBaseContext } from '../../Utilities/ObjectFactory';
 export class GridInternalApi extends ApiBase {
     /**
      * Fires Grid Sorted Event
      */
     fireGridSortedEvent() {
-        if (this.adaptable.isLive) {
+        if (this.adaptable.isReady) {
             const adaptableSortState = this.adaptable.api.configApi.getAdaptableSortState();
             const adaptableApi = this.getAdaptableApi();
             const gridSortedInfo = {
@@ -24,7 +27,7 @@ export class GridInternalApi extends ApiBase {
      * Fires Cell Changed Changed Event - when any data in AG Grid's dataset has changed
      */
     fireCellChangedEvent(cellDataChangedInfo) {
-        if (this.adaptable.isLive) {
+        if (this.adaptable.isReady) {
             const cellChangedInfo = {
                 adaptableApi: this.adaptable.api,
                 cellChange: cellDataChangedInfo,
@@ -38,7 +41,7 @@ export class GridInternalApi extends ApiBase {
      * Fires Grid Data Changed Event - when a row has changed in AG Grid
      */
     fireGridDataChangedEvent(dataRows, rowNodes, rowTrigger) {
-        if (this.adaptable.isLive) {
+        if (this.adaptable.isReady) {
             const gridDataChangedInfo = {
                 changedAt: Date.now(),
                 adaptableApi: this.adaptable.api,
@@ -88,7 +91,7 @@ export class GridInternalApi extends ApiBase {
         const distinctValuesParams = {
             visibleRowsOnly: showFilteredRowsOnly,
         };
-        const { gridCells, suppressClientSideFilter } = await this.adaptable.getDistinctFilterListValuesForColumn(abColumn, filter, distinctValuesParams);
+        const { gridCells, suppressClientSideFilter } = await this.getDistinctFilterListValuesForColumn(abColumn, filter, distinctValuesParams);
         const sortedDistinctValues = this.sortDistinctValues(gridCells, abColumn);
         let shouldShowValuesCount = false;
         const showValuesCountFunction = this.getColumnFilterOptions().valuesFilterOptions.showValuesCount;
@@ -128,6 +131,26 @@ export class GridInternalApi extends ApiBase {
             suppressClientSideFilter,
         };
     }
+    async getDistinctFilterListValuesForColumn(column, filter, distinctValuesParams) {
+        var _a;
+        const filterPermittedValues = (_a = this.getUserInterfaceApi().getFilterPermittedValuesForColumn(column)) !== null && _a !== void 0 ? _a : {
+            suppressFilterSearchBar: false,
+            values: () => undefined,
+        };
+        let preparedPermittedValues = undefined;
+        try {
+            const filterPermittedValuesParams = Object.assign(Object.assign({}, createBaseContext(this.adaptable.api)), { column: column, searchFilter: filter });
+            preparedPermittedValues = await (filterPermittedValues === null || filterPermittedValues === void 0 ? void 0 : filterPermittedValues.values(filterPermittedValuesParams));
+        }
+        catch (error) {
+            this.adaptable.logger.consoleError(`Failed to load filter permitted values`, column, filter, error);
+        }
+        distinctValuesParams.permittedValues = preparedPermittedValues;
+        return {
+            suppressClientSideFilter: filterPermittedValues.suppressFilterSearchBar,
+            gridCells: this.adaptable.getDistinctValuesForColumn(column, distinctValuesParams),
+        };
+    }
     /**
      * Gets all distinct Custom Sort values for the Column with the given ColumnId
      * @param columnId Column to check
@@ -140,11 +163,24 @@ export class GridInternalApi extends ApiBase {
         const distinctValuesParams = {
             visibleRowsOnly: false,
         };
-        const gridCells = await this.adaptable.getDistinctCustomSortValuesForColumn(abColumn, distinctValuesParams);
+        const gridCells = await this.getDistinctCustomSortValuesForColumn(abColumn, distinctValuesParams);
         return this.sortDistinctValues(gridCells, abColumn).map((cv) => {
             return cv.normalisedValue;
         });
     }
+    async getDistinctCustomSortValuesForColumn(column, distinctValuesParams) {
+        const customSortPermittedValues = await this.getUserInterfaceApi().getCustomSortPermittedValuesForColumn(column);
+        let preparedPermittedValues = undefined;
+        try {
+            const permittedValuesParams = Object.assign(Object.assign({}, createBaseContext(this.adaptable.api)), { column: column });
+            preparedPermittedValues = await (customSortPermittedValues === null || customSortPermittedValues === void 0 ? void 0 : customSortPermittedValues.values(permittedValuesParams));
+        }
+        catch (error) {
+            this.adaptable.logger.consoleError(`Failed to load custom sort permitted values`, column, error);
+        }
+        distinctValuesParams.permittedValues = preparedPermittedValues;
+        return this.adaptable.getDistinctValuesForColumn(column, distinctValuesParams);
+    }
     /**
      * Gets all distinct Bulk Update values for the Column with the given ColumnId
      * @param columnId Column to check
@@ -158,11 +194,24 @@ export class GridInternalApi extends ApiBase {
         const distinctValuesParams = {
             visibleRowsOnly: false,
         };
-        const gridCells = await this.adaptable.getDistinctBulkUpdateValuesForColumn(abColumn, selectedGridCells, distinctValuesParams);
+        const gridCells = await this.getDistinctBulkUpdateValuesForColumn(abColumn, selectedGridCells, distinctValuesParams);
         return this.sortDistinctValues(gridCells, abColumn).map((cv) => {
             return cv.normalisedValue;
         });
     }
+    async getDistinctBulkUpdateValuesForColumn(column, selectedGridCells, distinctValuesParams) {
+        const bulkUpdatePermittedValues = await this.getUserInterfaceApi().getBulkUpdatePermittedValuesForColumn(column);
+        let preparedPermittedValues = undefined;
+        try {
+            const bulkUpdatePermittedValuesParams = Object.assign(Object.assign({}, createBaseContext(this.adaptable.api)), { column: column, gridCells: selectedGridCells });
+            preparedPermittedValues = await (bulkUpdatePermittedValues === null || bulkUpdatePermittedValues === void 0 ? void 0 : bulkUpdatePermittedValues.values(bulkUpdatePermittedValuesParams));
+        }
+        catch (error) {
+            this.adaptable.logger.consoleError(`Failed to load bulk permitted values`, error, column, selectedGridCells);
+        }
+        distinctValuesParams.permittedValues = preparedPermittedValues;
+        return this.adaptable.getDistinctValuesForColumn(column, distinctValuesParams);
+    }
     /**
      * Gets all distinct visible (after current filters are applied) display values in the Column with the given ColumnId
      * @param columnId Column to check
@@ -257,7 +306,7 @@ export class GridInternalApi extends ApiBase {
         this.dispatchAction(GridRedux.GridSetSelectedRows(selectedRowInfo));
     }
     buildStandaloneColumnHeader(column) {
-        return this.adaptable.buildStandaloneColumnHeader(column);
+        return this.adaptable.agGridMenuAdapter.buildStandaloneColumnHeader(column);
     }
     getEditLookUpValuesForColumn(editLookUpItem, column, gridCell) {
         if (!editLookUpItem || !column) {
@@ -285,4 +334,89 @@ export class GridInternalApi extends ApiBase {
         // this will use the columnApi method that first looks for permitted values and then distinct values
         return this.getDistinctDisplayValuesForColumn(column.columnId);
     }
+    getAgGridDataType(dataType) {
+        if (!dataType) {
+            return 'abColDefString';
+        }
+        switch (dataType) {
+            case 'Boolean':
+                return 'abColDefBoolean';
+            case 'Date':
+                return 'abColDefDate';
+            case 'Number':
+                return 'abColDefNumber';
+            case 'Object':
+                return 'abColDefObject';
+            case 'String':
+                return 'abColDefString';
+            case 'NumberArray':
+                return 'abColDefNumberArray';
+            case 'TupleNumberArray':
+                return 'abColDefTupleNumberArray';
+            case 'ObjectNumberArray':
+                return 'abColDefObjectNumberArray';
+            default:
+                return 'abColDefCustom';
+        }
+    }
+    getRowHighlightStyle(params) {
+        var _a;
+        const primaryKeyValue = this.adaptable.getPrimaryKeyValueFromRowNode(params.node, params.api);
+        const highlightRow = (_a = this.getAdaptableApi()
+            .internalApi.getSystemState()
+            .HighlightedRows) === null || _a === void 0 ? void 0 : _a.find((highlightRow) => {
+            return highlightRow.primaryKeyValue === primaryKeyValue;
+        });
+        if (highlightRow) {
+            return convertAdaptableStyleToCSS(highlightRow.highlightStyle);
+        }
+    }
+    getAlertRowStyle(params) {
+        var _a, _b;
+        const alert = this.getAlertApi().internalApi.getAdaptableAlertWithHighlightRow(params.node);
+        const highlightRow = (_b = (_a = alert === null || alert === void 0 ? void 0 : alert.alertDefinition) === null || _a === void 0 ? void 0 : _a.AlertProperties) === null || _b === void 0 ? void 0 : _b.HighlightRow;
+        if (highlightRow) {
+            return typeof highlightRow === 'object'
+                ? convertAdaptableStyleToCSS(highlightRow)
+                : {
+                    backgroundColor: UIHelper.getColorByMessageType(alert.alertDefinition.MessageType),
+                };
+        }
+        return null;
+    }
+    getAlertRowClass(params) {
+        var _a, _b;
+        const alert = this.getAlertApi().internalApi.getAdaptableAlertWithHighlightRow(params.node);
+        const highlightRow = (_b = (_a = alert === null || alert === void 0 ? void 0 : alert.alertDefinition) === null || _a === void 0 ? void 0 : _a.AlertProperties) === null || _b === void 0 ? void 0 : _b.HighlightRow;
+        return typeof highlightRow === 'object' && (highlightRow === null || highlightRow === void 0 ? void 0 : highlightRow.ClassName)
+            ? highlightRow === null || highlightRow === void 0 ? void 0 : highlightRow.ClassName
+            : null;
+    }
+    getRowHighlightClass(params) {
+        var _a;
+        const primaryKeyValue = this.adaptable.getPrimaryKeyValueFromRowNode(params.node, params.api);
+        const highlightRow = (_a = this.getAdaptableApi()
+            .internalApi.getSystemState()
+            .HighlightedRows) === null || _a === void 0 ? void 0 : _a.find((highlightRow) => {
+            return highlightRow.primaryKeyValue === primaryKeyValue;
+        });
+        return typeof (highlightRow === null || highlightRow === void 0 ? void 0 : highlightRow.highlightStyle) === 'object'
+            ? highlightRow.highlightStyle.ClassName
+            : null;
+    }
+    deriveSpecialColumnSettingsFromAgGridDefaultColDef() {
+        const defaultColumnDefinition = this.adaptable.agGridAdapter.getDefaultColumnDefinition();
+        return {
+            Filterable: defaultColumnDefinition.filter,
+            Resizable: defaultColumnDefinition.resizable,
+            Groupable: defaultColumnDefinition.enableRowGroup,
+            Sortable: defaultColumnDefinition.sortable,
+            Pivotable: defaultColumnDefinition.enablePivot,
+            Aggregatable: defaultColumnDefinition.enableValue,
+            SuppressMenu: defaultColumnDefinition.suppressHeaderMenuButton,
+            SuppressMovable: defaultColumnDefinition.suppressMovable,
+            HeaderToolTip: defaultColumnDefinition.headerTooltip,
+            Width: defaultColumnDefinition.width,
+        };
+    }
 }

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

@@ -47,4 +47,5 @@ export declare class LayoutInternalApi extends ApiBase {
     isObjectAvailableInLayout(object: LayoutAssociatedObject, module: AdaptableModule, layout: Layout): boolean;
     showLayoutNotAssociatedObjects(): boolean;
     isLayoutGrouped(layout?: Layout): boolean;
+    setupRowSummaries(): void;
 }

package/src/Api/Internal/LayoutInternalApi.js

@@ -175,4 +175,20 @@ export class LayoutInternalApi extends ApiBase {
         }
         return ((_a = layout === null || layout === void 0 ? void 0 : layout.RowGroupedColumns) === null || _a === void 0 ? void 0 : _a.length) > 0;
     }
+    setupRowSummaries() {
+        var _a, _b, _c;
+        const rowSummaries = (_c = (_b = (_a = this.getAdaptableState().System) === null || _a === void 0 ? void 0 : _a.RowSummary) === null || _b === void 0 ? void 0 : _b.rowSummaries) !== null && _c !== void 0 ? _c : [];
+        const { top, bottom } = rowSummaries.reduce((acc, summaryRow) => {
+            const row = summaryRow.RowData;
+            if (summaryRow.Position === 'Bottom' || !summaryRow.Position) {
+                acc.bottom.push(row);
+            }
+            else {
+                acc.top.push(row);
+            }
+            return acc;
+        }, { top: [], bottom: [] });
+        this.adaptable.agGridAdapter.setGridOption('pinnedTopRowData', top);
+        this.adaptable.agGridAdapter.setGridOption('pinnedBottomRowData', bottom);
+    }
 }

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

@@ -0,0 +1,4 @@
+import { ApiBase } from '../Implementation/ApiBase';
+export declare class NoteInternalApi extends ApiBase {
+    areNotesAvailable(): boolean;
+}

package/src/Api/Internal/NoteInternalApi.js

@@ -0,0 +1,14 @@
+import { ApiBase } from '../Implementation/ApiBase';
+export class NoteInternalApi extends ApiBase {
+    areNotesAvailable() {
+        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;
+    }
+}

package/src/Api/Internal/TeamSharingInternalApi.js

@@ -5,7 +5,7 @@ export class TeamSharingInternalApi extends ApiBase {
      * @param sharedEntity Entity that has been changed
      */
     fireTeamSharingEntityChangedEvent(sharedEntity) {
-        if (this.adaptable.isLive) {
+        if (this.adaptable.isReady) {
             const teamSharingEntityChangedInfo = {
                 adaptableApi: this.adaptable.api,
                 sharedEntity: sharedEntity,

package/src/Api/InteropioPluginApi.d.ts

@@ -1,10 +1,10 @@
 import { InteropioPluginOptions } from '../AdaptableOptions/InteropioPluginOptions';
 /**
- * Provides run-time access to the Glue42Web Plugin
+ * Provides run-time access to the Interopio Plugin
  */
 export interface InteropioPluginApi {
     /**
-     * Retrieves the Glue42WebPlugOptions provided in Glue42Web Plugin
+     * Retrieves the InteropioPlugOptions provided in interopio Plugin
      */
     getPluginOptions(): InteropioPluginOptions;
 }

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
@@ -163,6 +167,17 @@ export interface LayoutApi {
      * @param layoutName layout from which to remove Column
      */
     removeColumnFromLayout(columnId: string, layoutName: string): void;
+    /**
+     * Adds a Column to a given Layout
+     * @param columnId Column to add
+     * @param layoutName layout to which to add Column
+     */
+    addColumnToLayout(columnId: string, layoutName: string): void;
+    /**
+     * Adds a Column to Current Layout
+     * @param columnId Column to add
+     */
+    addColumnToCurrentLayout(columnId: string): void;
     /**
      * Returns what the layout supports.
      * This takes into account the data-source.

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
+     */
+    getNotesForCell(CellAddress: CellAddress): AdaptableNote[];
+    /**
+     * Returns a Note by uuid
+     * @param uuid note uuid
+     */
+    getNoteByUuid(uuid: string): AdaptableNote | undefined;
+}

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, ColumnOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FlashingCellOptions, FormatColumnOptions, GridFilterOptions, LayoutOptions, MenuOptions, 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/CommentsOptions';
+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`
      */
@@ -146,6 +142,10 @@ export interface OptionsApi {
      * Returns `AdaptableOptions.formatColumnOptions`
      */
     getFormatColumnOptions(): Readonly<FormatColumnOptions>;
+    /**
+     * Returns `AdaptableOptions.noteOptions`
+     */
+    getNoteOptions(): Readonly<NoteOptions>;
     /**
      * Returns `AdaptableOptions.settingsPanelOptions`
      */

package/src/Api/ScopeApi.d.ts

@@ -31,6 +31,11 @@ export interface ScopeApi {
      * @param scope Scope to check
      */
     scopeHasDataType(scope: AdaptableScope): boolean;
+    /**
+     * True if Scope contains ColumnTypes
+     * @param scope Scope to check
+     */
+    scopeHasColumnType(scope: AdaptableScope): boolean;
     /**
      * True if the Scope is DataTypes and contains only Boolean
      * @param scope Scope to check
@@ -87,6 +92,11 @@ export interface ScopeApi {
      * @param scope Scope to check
      */
     getColumnIdsInScope(scope: AdaptableScope): string[] | undefined;
+    /**
+     * Returns all the ColumnTypes in the Scope
+     * @param scope Scope to check
+     */
+    getColumnTypesInScope(scope: AdaptableScope): string[] | undefined;
     /**
      * Returns all the DataTypes in the Scope
      * @param scope Scope to check

package/src/Api/UserInterfaceApi.d.ts

@@ -1,6 +1,5 @@
 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';
@@ -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
      */

package/src/EnvVars.d.ts

@@ -0,0 +1,3 @@
+export declare const ADAPTABLE_VERSION: any;
+export declare const ADAPTABLE_PUBLISH_TIMESTAMP: any;
+export declare const INFINITE_TABLE_LICENSE_KEY: any;

package/src/EnvVars.js

@@ -0,0 +1,4 @@
+import env from './env';
+export const ADAPTABLE_VERSION = env.VERSION;
+export const ADAPTABLE_PUBLISH_TIMESTAMP = env.PUBLISH_TIMESTAMP;
+export const INFINITE_TABLE_LICENSE_KEY = env.INFINITE_TABLE_LICENSE_KEY;