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

package/src/Api/CommentsApi.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableComment, AdaptableComments, CommentPosition, CommentsState } from '../PredefinedConfig/CommentsState';
+import { AdaptableComment, AdaptableComments, CommentGridCell, CommentsState } from '../PredefinedConfig/CommentsState';
 /**
  * Provides run-time access to Comments Module and related State
  */
@@ -21,9 +21,9 @@ export interface CommentsApi {
     getAllComments(): AdaptableComments;
     /**
      * Gets all comments for a cell
-     * @param commentPosition comment position
+     * @param commentGridCell comment position
      */
-    getCellComments(commentPosition: CommentPosition): AdaptableComment[];
+    getCellComments(commentGridCell: CommentGridCell): AdaptableComment[];
     /**
      * Returns a comment by uuid
      * @param uuid comment uuid
@@ -31,10 +31,10 @@ export interface CommentsApi {
     getCommentByUuid(uuid: string): AdaptableComment | undefined;
     /**
      * Gets all comments for a cell
-     * @param commentPosition comment position
+     * @param commentGridCell comment position
      * @param editMode whether to show the comment in edit mode
      */
-    showComment(commentPosition: CommentPosition, editMode?: boolean): void;
+    showComment(commentGridCell: CommentGridCell, editMode?: boolean): void;
     /**
      * Hides the comment popup
      */
@@ -42,7 +42,7 @@ export interface CommentsApi {
     /**
      * Gets the comment position of the currently open comment popup
      */
-    getOpenCommentPosition(): CommentPosition | null;
+    getOpenCommentGridCell(): CommentGridCell | null;
     /**
      * Gets the comment edit mode
      */

package/src/Api/EventApi.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableFDC3EventInfo, SelectionChangedInfo, LiveDataChangedInfo, DashboardChangedInfo, ThemeChangedInfo, AlertFiredInfo, LayoutChangedInfo, AdaptableReadyInfo, CustomToolbarConfiguredInfo, CellChangedInfo, SystemStatusMessageDisplayedInfo, CheckboxColumnClickedInfo, AdaptableStateChangedInfo, FlashingCellDisplayedInfo, GridDataChangedInfo, TeamSharingEntityChangedInfo, ActionRowSubmittedInfo, DataSetSelectedInfo, AdaptableStateReloadedInfo, GridSortedInfo, QueryRunInfo, ScheduleTriggeredInfo, ChartChangedInfo, ThemeEditedInfo, FilterAppliedInfo } from '../types';
+import { SelectionChangedInfo, LiveDataChangedInfo, DashboardChangedInfo, ThemeChangedInfo, AlertFiredInfo, LayoutChangedInfo, AdaptableReadyInfo, CustomToolbarConfiguredInfo, CellChangedInfo, SystemStatusMessageDisplayedInfo, CheckboxColumnClickedInfo, AdaptableStateChangedInfo, FlashingCellDisplayedInfo, GridDataChangedInfo, TeamSharingEntityChangedInfo, ActionRowSubmittedInfo, DataSetSelectedInfo, AdaptableStateReloadedInfo, GridSortedInfo, QueryRunInfo, ScheduleTriggeredInfo, ChartChangedInfo, ThemeEditedInfo, FilterAppliedInfo } from '../types';
 /**
  * Responsible for publishing the many Events that AdapTable fires
  */
@@ -308,21 +308,9 @@ export interface EventApi {
      * Unsubscribe from AdaptableReady
      */
     off(eventName: 'AdaptableReady', callback: (adaptableReadyInfo: AdaptableReadyInfo) => void): void;
-    /**
-     * Fired when an FDC3Message is sent
-     * @param eventName - FDC3MessageSent
-     * @param callback - A callback for listening to `FDC3MessageSent`
-     * @returns the unsubscribe function
-     *
-     */
-    on(eventName: 'FDC3MessageSent', callback: (eventInfo: AdaptableFDC3EventInfo) => void): VoidFunction;
-    /**
-     * Unsubscribe from FDC3MessageSent
-     */
-    off(eventName: 'FDC3MessageSent', callback: (eventInfo: AdaptableFDC3EventInfo) => void): void;
     emitSync(eventName: 'DashboardChanged', data?: any): any[];
     emitSync(eventName: 'FlashingCellDisplayed', data?: any): any[];
     emitSync(eventName: 'AdaptableDestroy'): any[];
-    emit(eventName: 'ActionRowSubmitted' | 'AdaptableReady' | 'AlertFired' | 'AdaptableStateChanged' | 'AdaptableStateReloaded' | 'CellChanged' | 'ChartChanged' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'DashboardChanged' | 'DataSetSelected' | 'FDC3MessageSent' | 'FilterApplied' | 'GridDataChanged' | 'GridSorted' | 'LayoutChanged' | 'LiveDataChanged' | 'QueryRun' | 'ScheduleTriggered' | 'SearchChanged' | 'SelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'ThemeEdited', data?: any): Promise<any>;
+    emit(eventName: 'ActionRowSubmitted' | 'AdaptableReady' | 'AlertFired' | 'AdaptableStateChanged' | 'AdaptableStateReloaded' | 'CellChanged' | 'ChartChanged' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'DashboardChanged' | 'DataSetSelected' | 'FilterApplied' | 'GridDataChanged' | 'GridSorted' | 'LayoutChanged' | 'LiveDataChanged' | 'QueryRun' | 'ScheduleTriggered' | 'SearchChanged' | 'SelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'ThemeEdited', data?: any): Promise<any>;
     destroy(): void;
 }

package/src/Api/GridApi.d.ts

@@ -15,7 +15,7 @@ import { RowsHighlightInfo } from '../PredefinedConfig/Common/RowsHighlightInfo'
  */
 export interface GridApi {
     /**
-     * Returns Grid section from Adaptable State
+     * Returns Grid section from AdapTable State
      */
     getGridState(): GridState;
     /**
@@ -27,41 +27,41 @@ export interface GridApi {
      */
     getFilteredData(): any[];
     /**
-     * Repopulates grid with given data and fires a 'GridDataChanged' event
-     * @param data any data from any datasource that is suitable for AG Grid
+     * Repopulates EXISTING grid with given data; fires GridDataChanged' Event
+     * @param data any data suitable as AG Grid data source
      */
     setGridData(data: any[]): void;
     /**
-     * Sets grid with given data; does NOT fire a 'GridDataChanged' event
-     * @param data any data from any datasource that is suitable for AG Grid
+     * Sets grid with given data for FIRST use; doesn't fire 'GridDataChanged' Event
+     * @param dataany data suitable as AG Grid data source
      */
     setInitialGridData(data: any): void;
     /**
-     * Updates Adaptable (and AG Grid) with rows that have changed
-     * @param dataRows rows which have been updated - send whole row and Adaptable will take care of the rest
+     * Updates AdapTable (and AG Grid) with rows that have changed
+     * @param dataRows rows which have been updated - send whole row and AdapTable take cares of the rest
      * @param config batch option and callback function to run post update
      */
     updateGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;
     /**
-   * Adds or Updates Adaptable (and AG Grid) with new and changed rows
+   * Adds or Updates AdapTable (and AG Grid) with new and changed rows
    * @param dataRows rows to add or update
    * @param config batch option and callback function to run post change
    */
     addOrUpdateGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;
     /**
-     * Adds rows to Adaptable (and AG Grid)
+     * Adds rows to AdapTable (and AG Grid)
      * @param dataRows rows to add; ensure all 'mandatory' fields are included and Primary Key is unique
      * @param config batch option and callback function to run post addition
      */
     addGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;
     /**
-     * Deletes rows from Adaptable (and AG Grid)
+     * Deletes rows from AdapTable (and AG Grid)
      * @param dataRows rows which should be deleted
      * @param config batch option and callback function to run post deletion
      */
     deleteGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;
     /**
-     * Updates cell in Adaptable (first performs Cell & Server Validation)
+     * Updates cell in AdapTable (first performs Cell & Server Validation)
      * @param cellUpdateRequest (contains columnId, newValue and primaryKeyValue
      *
      */
@@ -88,7 +88,7 @@ export interface GridApi {
      */
     getAgGridInstance(): GridOptions;
     /**
-     * Returns Column Sort information in Adaptable
+     * Returns Column Sort information in AdapTable
      */
     getColumnSorts(): ColumnSort[];
     /**
@@ -497,7 +497,7 @@ export interface GridApi {
      */
     deselectAll(): void;
     /**
-     * Returns the Grid Container in which the Adaptable Instance is present
+     * Returns the Grid Container in which the AdapTable Instance is present
      */
     getGridContainerElement(): HTMLElement | null;
     /**

package/src/Api/Implementation/ApiBase.d.ts

@@ -21,6 +21,7 @@ import { ExpressionApi } from '../ExpressionApi';
 import { CalendarOptions } from '../../AdaptableOptions/CalendarOptions';
 import { Fdc3Api } from '../Fdc3Api';
 import { Fdc3Options } from '../../AdaptableOptions/Fdc3Options';
+import { CommentOptions } from '../../AdaptableOptions/CommentsOptions';
 export declare abstract class ApiBase {
     protected adaptable: IAdaptable;
     /**
@@ -64,6 +65,7 @@ export declare abstract class ApiBase {
     protected getActionColumnOptions(): ActionColumnOptions;
     protected getActionRowOptions(): ActionRowOptions;
     protected getColumnOptions(): ColumnOptions;
+    protected getCommentOptions(): CommentOptions;
     protected getCustomSortOptions(): CustomSortOptions;
     protected getDataSetOptions(): DataSetOptions;
     protected getCalendarOptions(): CalendarOptions;

package/src/Api/Implementation/ApiBase.js

@@ -102,6 +102,9 @@ class ApiBase {
     getColumnOptions() {
         return this.getOptions().columnOptions;
     }
+    getCommentOptions() {
+        return this.getOptions().commentOptions;
+    }
     getCustomSortOptions() {
         return this.getOptions().customSortOptions;
     }

package/src/Api/Implementation/CalendarApiImpl.js

@@ -27,8 +27,7 @@ class CalendarApiImpl extends ApiBase_1.ApiBase {
             return dateToCheck.getDay() != 0 && dateToCheck.getDay() != 6;
         }
         for (let holiday of holidays) {
-            let holidayDate = new Date(holiday);
-            if (holidayDate.setHours(0, 0, 0, 0) == dateToCheck.setHours(0, 0, 0, 0)) {
+            if (holiday.setHours(0, 0, 0, 0) == dateToCheck.setHours(0, 0, 0, 0)) {
                 return false;
             }
         }

package/src/Api/Implementation/CommentsApiImpl.d.ts

@@ -1,6 +1,6 @@
 import { ApiBase } from './ApiBase';
 import { CommentsApi } from '../CommentsApi';
-import { AdaptableComment, AdaptableComments, CommentPosition, CommentsState } from '../../PredefinedConfig/CommentsState';
+import { AdaptableComment, AdaptableComments, CommentGridCell, CommentsState } from '../../PredefinedConfig/CommentsState';
 export declare class CommentsApiImpl extends ApiBase implements CommentsApi {
     addComment(comment: string, primaryKeyValue: any, columnId: string): void;
     editComment(adaptableComment: AdaptableComment): void;
@@ -13,8 +13,8 @@ export declare class CommentsApiImpl extends ApiBase implements CommentsApi {
         ColumnId: string;
     }): AdaptableComments;
     getCommentByUuid(uuid: string): AdaptableComment | undefined;
-    showComment(commentPosition: CommentPosition, editMode?: boolean): void;
+    showComment(commentGridCell: CommentGridCell, editMode?: boolean): void;
     hideComment(): void;
-    getOpenCommentPosition(): CommentPosition | undefined;
+    getOpenCommentGridCell(): CommentGridCell | undefined;
     getCommentPopupEditMode(): boolean;
 }

package/src/Api/Implementation/CommentsApiImpl.js

@@ -43,13 +43,13 @@ class CommentsApiImpl extends ApiBase_1.ApiBase {
     getCommentByUuid(uuid) {
         return this.getAllComments().find((comment) => comment.Uuid === uuid);
     }
-    showComment(commentPosition, editMode) {
-        this.dispatchAction(SystemRedux.SystemCommentsShow(commentPosition, editMode));
+    showComment(commentGridCell, editMode) {
+        this.dispatchAction(SystemRedux.SystemCommentsShow(commentGridCell, editMode));
     }
     hideComment() {
         this.dispatchAction(SystemRedux.SystemCommentsHide());
     }
-    getOpenCommentPosition() {
+    getOpenCommentGridCell() {
         return SystemRedux.SystemCommentsSelector(this.getAdaptableState().System);
     }
     getCommentPopupEditMode() {

package/src/Api/Implementation/GridApiImpl.js

@@ -17,12 +17,12 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         return this.getAdaptableState().Grid;
     }
     setGridData(dataSource) {
-        this.adaptable.setDataSource(dataSource);
+        this.adaptable.setGridData(dataSource);
         const allRowNodes = this.getAllRowNodes();
         this.internalApi.fireGridDataChangedEvent(dataSource, allRowNodes, 'Add');
     }
     setInitialGridData(data) {
-        this.adaptable.setDataSource(data);
+        this.adaptable.setInitialGridData(data);
     }
     getGridData() {
         return this.adaptable.getGridData();

package/src/Api/Implementation/OptionsApiImpl.d.ts

@@ -1,5 +1,5 @@
 import { ApiBase } from './ApiBase';
-import { ActionColumnOptions, ActionRowOptions, AdaptableOptions, AdaptableQLOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, DataSetOptions, EditOptions, EntitlementOptions, ExportOptions, FilterOptions, FlashingCellOptions, FormatColumnOptions, LayoutOptions, MenuOptions, NotificationsOptions, OptionsApi, QuickSearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../../types';
+import { ActionColumnOptions, ActionRowOptions, AdaptableOptions, AdaptableQLOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnOptions, CommentOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, DataSetOptions, EditOptions, EntitlementOptions, ExportOptions, FilterOptions, FlashingCellOptions, FormatColumnOptions, LayoutOptions, MenuOptions, NotificationsOptions, OptionsApi, QuickSearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../../types';
 import { GroupingOptions } from '../../AdaptableOptions/GroupingOptions';
 import { CustomSortOptions } from '../../AdaptableOptions/CustomSortOptions';
 import { Fdc3Options } from '../../AdaptableOptions/Fdc3Options';
@@ -16,6 +16,7 @@ export declare class OptionsApiImpl extends ApiBase implements OptionsApi {
     getCellSummaryOptions(): CellSummaryOptions;
     getCalendarOptions(): CalendarOptions;
     getColumnOptions(): ColumnOptions;
+    getCommentOptions(): CommentOptions;
     getCustomSortOptions(): CustomSortOptions;
     getContainerOptions(): ContainerOptions;
     getDataSetOptions(): DataSetOptions;

package/src/Api/Implementation/OptionsApiImpl.js

@@ -39,6 +39,9 @@ class OptionsApiImpl extends ApiBase_1.ApiBase {
     getColumnOptions() {
         return this.getOptions().columnOptions;
     }
+    getCommentOptions() {
+        return this.getOptions().commentOptions;
+    }
     getCustomSortOptions() {
         return this.getOptions().customSortOptions;
     }

package/src/Api/Implementation/PluginsApiImpl.d.ts

@@ -4,7 +4,6 @@ import { ApiBase } from './ApiBase';
 import { IPushPullApi } from '../IPushPullApi';
 import { Glue42Api } from '../Glue42Api';
 import { OpenFinApi } from '../OpenFinApi';
-import { FinanceApi } from '../FinanceApi';
 import { FinsembleApi } from '../FinsembleApi';
 import { Glue42WebApi } from '../Glue42WebApi';
 export declare class PluginsApiImpl extends ApiBase implements PluginsApi {
@@ -17,6 +16,5 @@ export declare class PluginsApiImpl extends ApiBase implements PluginsApi {
     getGlue42PluginApi(): Glue42Api;
     getGlue42WebPluginApi(): Glue42WebApi;
     getOpenFinPluginApi(): OpenFinApi;
-    getFinancePluginApi(): FinanceApi;
     getFinsemblePluginApi(): FinsembleApi;
 }

package/src/Api/Implementation/PluginsApiImpl.js

@@ -23,9 +23,6 @@ class PluginsApiImpl extends ApiBase_1.ApiBase {
             if (pluginId === 'ipushpull') {
                 return api;
             }
-            if (pluginId === 'finance') {
-                return api;
-            }
             if (pluginId === 'glue42') {
                 return api;
             }
@@ -56,9 +53,6 @@ class PluginsApiImpl extends ApiBase_1.ApiBase {
     getOpenFinPluginApi() {
         return this.getPluginApi('openfin');
     }
-    getFinancePluginApi() {
-        return this.getPluginApi('finance');
-    }
     getFinsemblePluginApi() {
         return this.getPluginApi('finsemble');
     }

package/src/Api/Internal/AdaptableInternalApi.js

@@ -467,7 +467,7 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
         if (!actionColumn && this.getFdc3Api().internalApi.isFdc3MainActionColumn(colDef.colId)) {
             const actionButtons = this.getFdc3Api().internalApi.getButtonsForFdc3MainActionColumn();
             actionColumn = {
-                columnId: GeneralConstants_1.ADAPTABLE_FDC3_ACTION_COLUMN,
+                columnId: this.getFdc3Options().actionColumnDefaultConfiguration.columnId,
                 actionColumnButton: actionButtons,
             };
         }

package/src/Api/Internal/Fdc3InternalApi.js

@@ -43,7 +43,7 @@ class Fdc3InternalApi extends ApiBase_1.ApiBase {
         if (this.isAtLeastOneActionButtonConfigured()) {
             const actionColumnConfig = this.getFdc3Options().actionColumnDefaultConfiguration;
             actionColDefs.push({
-                colId: GeneralConstants_1.ADAPTABLE_FDC3_ACTION_COLUMN,
+                colId: actionColumnConfig.columnId,
                 headerName: actionColumnConfig.headerName,
                 hide: false,
                 lockVisible: true,
@@ -241,7 +241,7 @@ class Fdc3InternalApi extends ApiBase_1.ApiBase {
         return buttons;
     }
     isFdc3MainActionColumn(columnId) {
-        return columnId === GeneralConstants_1.ADAPTABLE_FDC3_ACTION_COLUMN;
+        return columnId === this.getFdc3Options().actionColumnDefaultConfiguration.columnId;
     }
     isFdc3StandaloneActionColumn(columnId, columnType) {
         const types = typeof columnType === 'string' ? [columnType] : columnType;

package/src/Api/OptionsApi.d.ts

@@ -1,7 +1,7 @@
 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, FormatColumnOptions, LayoutOptions, MenuOptions, NotificationsOptions, QuickSearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
+import { ActionColumnOptions, ActionRowOptions, AdaptableOptions, AdaptableQLOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnOptions, CommentOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FilterOptions, FlashingCellOptions, FormatColumnOptions, LayoutOptions, MenuOptions, NotificationsOptions, QuickSearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
 import { Fdc3Options } from '../AdaptableOptions/Fdc3Options';
 /**
  * Range of functions to access Adaptable Options
@@ -71,6 +71,10 @@ export interface OptionsApi {
      * Returns `AdaptableOptions.columnOptions`
      */
     getColumnOptions(): Readonly<ColumnOptions>;
+    /**
+     * Returns `AdaptableOptions.commentOptions`
+     */
+    getCommentOptions(): Readonly<CommentOptions>;
     /**
      * Returns `AdaptableOptions.customSortOptions`
      */

package/src/Api/PluginsApi.d.ts

@@ -2,7 +2,6 @@ import { PluginsState } from '../Redux/ActionsReducers/PluginsRedux';
 import { IPushPullApi } from './IPushPullApi';
 import { Glue42Api } from './Glue42Api';
 import { OpenFinApi } from './OpenFinApi';
-import { FinanceApi } from './FinanceApi';
 import { FinsembleApi } from './FinsembleApi';
 import { Glue42WebApi } from './Glue42WebApi';
 /**
@@ -46,10 +45,6 @@ export interface PluginsApi {
      * Returns OpenFin API class in Adaptable API
      */
     getOpenFinPluginApi(): OpenFinApi;
-    /**
-     * Returns Finance API class in Adaptable API
-     */
-    getFinancePluginApi(): FinanceApi;
     /**
      * Returns Finsemble API class in Adaptable API
      */

package/src/PredefinedConfig/CommentsState.d.ts

@@ -4,26 +4,53 @@ import { ConfigState } from './ConfigState';
  * Comment that can be applied to a Cell in AdapTable
  */
 export interface AdaptableComment extends AdaptableObject {
+    /**
+     * When Comment was made
+     */
     Timestamp: number;
+    /**
+     * Value of the Comment
+     */
     Value: string;
+    /**
+     * Author of the Comment
+     */
     Author: {
         UserName: string;
     };
+    /**
+     * Value in Grid's Primary Key Column
+     */
     PrimaryKeyValue: any;
+    /**
+     * Id of Column containing the Comment
+     */
     ColumnId: string;
+    /**
+     * Id of this AdapTable instance
+     */
     AdaptableId: string;
 }
 export declare type AdaptableComments = AdaptableComment[];
 /**
- * Predefined Configuration for Styled Column Module
+ * Predefined Configuration for Comments Module
  */
 export interface CommentsState extends ConfigState {
     /**
-     * Collection of Special Column Styles
+     * Collection of AdapTable Comments
      */
     Comments?: AdaptableComments;
 }
-export declare type CommentPosition = {
+/**
+ * Cell that contains a Comment
+ */
+export declare type CommentGridCell = {
+    /**
+     * Value in Primary Key Column
+     */
     PrimaryKeyValue: string | number;
+    /**
+     * Id of Column containing the Comment
+     */
     ColumnId: string;
 };

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

@@ -13,6 +13,6 @@ export interface Entitlement {
     accessLevel: AccessLevel;
 }
 /**
- * Defines Access Level for an Entitlement: `ReadOnly`, `Hidden` or `Full`
+ * Whether an Entitlement is `ReadOnly`, `Hidden` or `Full`
  */
 export declare type AccessLevel = 'ReadOnly' | 'Hidden' | 'Full';

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

@@ -1,4 +1,7 @@
 import { Chart, ChatInitSettings, Contact, ContactList, Context, Country, Currency, Email, Instrument, InstrumentList, Nothing, Organization, Portfolio, Position, TimeRange, Valuation, ContextTypes } from '@finos/fdc3';
+/**
+ * FDC3 (2.0) Context Types supported by AdapTable
+ */
 export declare type Fdc3ContextType = ChartContextType | ChatInitSettingsContextType | ContactContextType | ContactListContextType | CountryContextType | CurrencyContextType | EmailContextType | InstrumentContextType | InstrumentListContextType | OrganizationContextType | PortfolioContextType | PositionContextType | TimeRangeContextType | ValuationContextType | NothingContextType;
 export declare type Fdc3CustomContextType = string;
 export declare const ChartContextKey = "fdc3.chart";
@@ -31,6 +34,9 @@ export declare const ValuationContextKey = "fdc3.valuation";
 export declare type ValuationContextType = typeof ValuationContextKey;
 export declare const NothingContextKey = "fdc3.nothing";
 export declare type NothingContextType = typeof NothingContextKey;
+/**
+ * FDC3 (2.0) Contexts
+ */
 export declare type Fdc3Context = ChartContext | ChatInitSettingsContext | ContactContext | ContactListContext | CountryContext | CurrencyContext | EmailContext | InstrumentContext | InstrumentListContext | OrganizationContext | PortfolioContext | PositionContext | TimeRangeContext | ValuationContext | NothingContext;
 export declare type Fdc3CustomContext = Context;
 export declare type TypedFdc3Context<CONTEXT, TYPE extends Fdc3ContextType> = CONTEXT & {

package/src/PredefinedConfig/SystemState.d.ts

@@ -14,7 +14,7 @@ import { AdaptableFlashingCell } from './Common/AdaptableFlashingCell';
 import { TypeUuid } from './Uuid';
 import { SummaryOperation } from './Common/Enums';
 import { ChartModel } from '@ag-grid-community/core';
-import { CommentPosition } from './CommentsState';
+import { CommentGridCell } from './CommentsState';
 export type { IPushPullReport, IPushPullDomain };
 export type { Glue42Report };
 export type { OpenFinReport };
@@ -100,7 +100,7 @@ export interface SystemState extends InternalState, IPushPullState, Glue42State,
     };
     Comments?: {
         editMode?: boolean;
-        popupPosition?: CommentPosition | null;
+        popupPosition?: CommentGridCell | null;
     };
 }
 export interface ProgressIndicator {

package/src/Redux/ActionsReducers/SystemRedux.d.ts

@@ -14,7 +14,7 @@ import { SummaryOperation } from '../../PredefinedConfig/Common/Enums';
 import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
 import { RowsHighlightInfo } from '../../PredefinedConfig/Common/RowsHighlightInfo';
 import { SmartEditOperation } from '../../AdaptableOptions/EditOptions';
-import { CommentPosition, DataSet } from '../../types';
+import { CommentGridCell, DataSet } from '../../types';
 import { ChartModel } from '@ag-grid-community/core';
 export declare const FLASHING_CELL_ROW_KEY = "__ROW";
 export declare const SYSTEM_ALERT_ADD = "SYSTEM_ALERT_ADD";
@@ -256,7 +256,7 @@ export interface SystemQuickSearchFloatingVisibilityAction extends Redux.Action
     visible: boolean;
 }
 export interface SystemCommentsShowAction extends Redux.Action {
-    cellPosition: CommentPosition;
+    cellPosition: CommentGridCell;
     editMode?: boolean;
 }
 export interface SystemCommentsHideAction extends Redux.Action {
@@ -318,11 +318,11 @@ export declare const SystemDisableDeleteConfirmation: () => SystemDisableDeleteC
 export declare const SystemVisualExportBegin: () => SystemVisualExportBeginAction;
 export declare const SystemVisualExportEnd: () => SystemVisualExportEndAction;
 export declare const SystemQuickSearchFloatingVisibility: (visible: boolean) => SystemQuickSearchFloatingVisibilityAction;
-export declare const SystemCommentsShow: (cellPosition: CommentPosition, editMode?: boolean) => SystemCommentsShowAction;
+export declare const SystemCommentsShow: (cellPosition: CommentGridCell, editMode?: boolean) => SystemCommentsShowAction;
 export declare const SystemCommentsHide: () => SystemCommentsHideAction;
 export declare const SystemDisableDeleteConfirmationSelector: (state: SystemState) => boolean;
 export declare const SystemPreviousGroupedColumnsSelector: (state: SystemState) => Record<string, Record<string, number>>;
 export declare const SystemQuickSearchFloatingVisibilitySelector: (state: SystemState) => boolean;
-export declare const SystemCommentsSelector: (state: SystemState) => CommentPosition;
+export declare const SystemCommentsSelector: (state: SystemState) => CommentGridCell;
 export declare const SystemCommentsEditModeSelector: (state: SystemState) => boolean;
 export declare const SystemReducer: Redux.Reducer<SystemState>;

package/src/Strategy/CommentsModule.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
-import { CommentPosition } from '../types';
+import { CommentGridCell } from '../types';
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { IModule } from './Interface/IModule';
 /**
@@ -19,5 +19,5 @@ export declare class CommentsModule extends AdaptableModuleBase implements IModu
         ColumnId: string;
     };
     handleMouseEnter(event: MouseEvent): void;
-    handleCellSelected(cellPosition: CommentPosition): void;
+    handleCellSelected(commentGridCell: CommentGridCell): void;
 }

package/src/Strategy/CommentsModule.js

@@ -41,7 +41,7 @@ class CommentsModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             return undefined;
         }
         const items = [];
-        const isCellCommentable = (_b = (_a = this.adaptable.api.optionsApi) === null || _a === void 0 ? void 0 : _a.getUserInterfaceOptions()) === null || _b === void 0 ? void 0 : _b.isCellCommentable;
+        const isCellCommentable = (_b = (_a = this.adaptable.api.optionsApi) === null || _a === void 0 ? void 0 : _a.getCommentOptions()) === null || _b === void 0 ? void 0 : _b.isCellCommentable;
         if (!isCellCommentable ||
             isCellCommentable({
                 adaptableApi: this.adaptable.api,
@@ -102,9 +102,9 @@ class CommentsModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             return;
         }
         const cellPosition = this.getCellPositionFromEvent(event);
-        const openCommentPosition = this.adaptable.api.commentsApi.getOpenCommentPosition();
+        const openCommentGridCell = this.adaptable.api.commentsApi.getOpenCommentGridCell();
         // Hovering over someting that is not a cell and there is no open comment
-        if (!cellPosition && openCommentPosition) {
+        if (!cellPosition && openCommentGridCell) {
             // need to close if the new cell does not have a comment
             this.adaptable.api.commentsApi.hideComment();
         }
@@ -112,16 +112,16 @@ class CommentsModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             this.adaptable.api.commentsApi.showComment(cellPosition, false);
         }
     }
-    handleCellSelected(cellPosition) {
+    handleCellSelected(commentGridCell) {
         // if already opened - do nothing
-        const openCommentPosition = this.adaptable.api.commentsApi.getOpenCommentPosition();
-        if ((openCommentPosition === null || openCommentPosition === void 0 ? void 0 : openCommentPosition.PrimaryKeyValue) === cellPosition.PrimaryKeyValue &&
-            (openCommentPosition === null || openCommentPosition === void 0 ? void 0 : openCommentPosition.ColumnId) === cellPosition.ColumnId) {
+        const openCommentGridCell = this.adaptable.api.commentsApi.getOpenCommentGridCell();
+        if ((openCommentGridCell === null || openCommentGridCell === void 0 ? void 0 : openCommentGridCell.PrimaryKeyValue) === commentGridCell.PrimaryKeyValue &&
+            (openCommentGridCell === null || openCommentGridCell === void 0 ? void 0 : openCommentGridCell.ColumnId) === commentGridCell.ColumnId) {
             return;
         }
         // if open but this has no comment, close
-        const cellComments = this.adaptable.api.commentsApi.getCellComments(cellPosition);
-        if (openCommentPosition && !(cellComments === null || cellComments === void 0 ? void 0 : cellComments.length)) {
+        const cellComments = this.adaptable.api.commentsApi.getCellComments(commentGridCell);
+        if (openCommentGridCell && !(cellComments === null || cellComments === void 0 ? void 0 : cellComments.length)) {
             // hide only if in edit mode
             // because if you select a cell and move the mouse fast over another cell
             // with a comment, you do not want to close that comment
@@ -132,8 +132,8 @@ class CommentsModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             return;
         }
         // if open but the new selection has a comment open that one in edit mode (because of click)
-        if (openCommentPosition && (cellComments === null || cellComments === void 0 ? void 0 : cellComments.length)) {
-            this.adaptable.api.commentsApi.showComment(cellPosition, true);
+        if (openCommentGridCell && (cellComments === null || cellComments === void 0 ? void 0 : cellComments.length)) {
+            this.adaptable.api.commentsApi.showComment(commentGridCell, true);
             return;
         }
     }

package/src/Strategy/Fdc3Module.d.ts

@@ -4,7 +4,6 @@ import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
 export declare class Fdc3Module extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
-    isModuleAvailable(): boolean;
     addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
     private buildRaiseIntentMenuItem;
     private buildBroadcastMenuItem;

package/src/Strategy/Fdc3Module.js

@@ -8,9 +8,6 @@ class Fdc3Module extends AdaptableModuleBase_1.AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.Fdc3ModuleId, ModuleConstants.Fdc3FriendlyName, 'fdc3', null, 'The FDC3 Module - handles the FDC3 integration', api);
     }
-    isModuleAvailable() {
-        return this.getFdc3Options().enableFdc3;
-    }
     addContextMenuItems(menuContext) {
         var _a, _b, _c, _d;
         if (!this.isModuleAvailable()) {

package/src/Utilities/Constants/GeneralConstants.d.ts

@@ -31,7 +31,6 @@ export declare const AG_GRID_PIVOT_COLUMN: string;
 export declare const AG_GRID_CHART_WINDOW = "AG Grid Window";
 export declare const ADAPTABLE_ROW_ACTION_BUTTONS = "adaptableRowActionButtons";
 export declare const ADAPTABLE_ROW_ACTION_BUTTONS_FRIENDLY_NAME = "(ActionRowButtons)";
-export declare const ADAPTABLE_FDC3_ACTION_COLUMN = "fdc3ActionColumn";
 export declare const ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = "(FDC3ActionColumn)";
 export declare const DEFAULT_DATE_FORMAT_PATTERN = "dd-MM-yyyy";
 export declare const SYSTEM_STATUS_DEFAULT_MAX_MESSAGES_IN_STORE: number;