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

package/src/Api/DashboardApi.d.ts

@@ -1,5 +1,5 @@
 import { DashboardState, DashboardTab } from '../PredefinedConfig/DashboardState';
-import { AdaptableModuleButtons, AdaptableDashboardToolbars, AdaptableDashboardToolbar } from '../PredefinedConfig/Common/Types';
+import { AdaptableDashboardToolbar, AdaptableDashboardToolbars, AdaptableModuleButtons } from '../PredefinedConfig/Common/Types';
 import { DashboardChangedInfo } from './Events/DashboardChanged';
 import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
 import { CustomToolbar, DashboardButtonContext } from '../AdaptableOptions/DashboardOptions';
@@ -108,16 +108,12 @@ export interface DashboardApi {
     /**
      * Opens Settings Panel with Dashboard section selected and visible
      */
-    showDashboardPopup(): void;
+    openDashboardSettingsPanel(): void;
     /**
      * Retrieves the Tab from State that matches inputted name
      * @param tabName the tab to check
      */
     getTabByName(tabName: string): DashboardTab;
-    /**
-     * Fires Dashboard Changed Event
-     */
-    fireDashboardChangedEvent(trigger: string, oldSate: DashboardState, newState: DashboardState): void;
     /**
      * Has a custom toolbar become visible or
      * @param dashboardChangedInfo Info raised by Dashboard Changed Event
@@ -148,4 +144,15 @@ export interface DashboardApi {
      * Is Dashboard Visible
      */
     isDashboardVisible(): boolean;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `openDashboardSettingsPanel()` instead
+     */
+    showDashboardPopup(): void;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    fireDashboardChangedEvent(trigger: string, oldState: DashboardState, newState: DashboardState): void;
 }

package/src/Api/DataChangeHistoryApi.d.ts

@@ -32,7 +32,14 @@ export interface DataChangeHistoryApi {
      */
     undoDataChangeHistoryEntry(dataChangeInfo: CellDataChangedInfo): void;
     /**
-     * Opens Data Change History screen
+     * Opens Data Change History panel
+     */
+    openDataChangeHistorySettingsPanel(): void;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `openDataChangeHistorySettingsPanel()` instead
      */
     showDataChangeHistoryPopup(): void;
 }

package/src/Api/DataSetApi.d.ts

@@ -7,7 +7,7 @@ export interface DataSetApi {
      * Retrieves the Data Sets from General Options
      * @returns data Sets
      */
-    getAllDataSets(): DataSet[];
+    getDataSets(): DataSet[];
     /**
      * Retrieves the currently applied Data Set
      * @returns data Set
@@ -31,10 +31,20 @@ export interface DataSetApi {
     /**
      * Opens Settings Panel with Data Set section selected and visible
      */
+    openDataSetSettingsPanel(): void;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `getDataSets()` instead
+     */
+    getAllDataSets(): DataSet[];
+    /**
+     * @deprecated use `openDataSetSettingsPanel()` instead
+     */
     showDataSetPopup(): void;
     /**
-     * Fires the DataSet Selected Event
-     * @param dataSet Data Set which has been selected
+     * @deprecated internal method, will be removed in next major release
      */
     fireDataSetSelectedEvent(dataSet: DataSet): void;
 }

package/src/Api/EntitlementApi.d.ts

@@ -0,0 +1,31 @@
+import { AdaptableModule, AccessLevel, AdaptableObject } from '../types';
+/**
+ * Provides functions for Entitlements and Permissions
+ **/
+export interface EntitlementApi {
+    /**
+     * Returns Access Level of an Entitlement
+     * @param adaptableModule Module to Check
+     */
+    getEntitlementAccessLevelForModule(adaptableModule: AdaptableModule): AccessLevel;
+    /**
+     * Is the Adaptable Object ReadOnly
+     * @param object Object to Check
+     */
+    isObjectReadonly(object: AdaptableObject): boolean;
+    /**
+     * Is Module Hidden
+     * @param adaptableModule Module to Check
+     */
+    isModuleHiddenEntitlement(adaptableModule: AdaptableModule): boolean;
+    /**
+     * Is Module Full
+     * @param adaptableModule Module to Check
+     */
+    isModuleFullEntitlement(adaptableModule: AdaptableModule): boolean;
+    /**
+     * Is Module ReadOnly
+     * @param adaptableModule Module to Check
+     */
+    isModuleReadOnlyEntitlement(adaptableModule: AdaptableModule): boolean;
+}

package/src/Api/EntitlementApi.js

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

package/src/Api/EventApi.d.ts

@@ -1,35 +1,14 @@
-import { SelectionChangedInfo } from './Events/SelectionChanged';
-import { LiveDataChangedInfo } from './Events/LiveDataChanged';
-import { DashboardChangedInfo } from './Events/DashboardChanged';
-import { ThemeChangedInfo } from './Events/ThemeChanged';
-import { AlertFiredInfo } from './Events/AlertFired';
-import { LayoutChangedInfo } from './Events/LayoutChanged';
-import { SearchChangedInfo } from './Events/SearchChanged';
-import { AdaptableReadyInfo } from './Events/AdaptableReady';
-import { CustomToolbarConfiguredInfo } from './Events/CustomToolbarConfigured';
-import { CellChangedInfo } from './Events/CellChanged';
-import { SystemStatusMessageDisplayedInfo } from './Events/SystemStatusMessageDisplayed';
-import { CheckboxColumnClickedInfo } from './Events/ChexboxColumnClicked';
-import { AdaptableStateChangedInfo } from './Events/AdaptableStateChanged';
-import { FlashingCellDisplayedInfo } from './Events/FlashingCellDisplayed';
-import { GridDataChangedInfo } from './Events/GridDataChanged';
-import { TeamSharingEntityChangedInfo } from './Events/TeamSharingEntityChanged';
-import { ActionRowSubmittedInfo } from './Events/ActionRowSubmitted';
-import { DataSetSelectedInfo } from './Events/DataSetSelected';
-import { AdaptableStateReloadedInfo } from './Events/AdaptableStateReloaded';
-import { GridSortedInfo } from './Events/GridSorted';
-import { QueryRunInfo } from './Events/QueryRun';
-import { FilterAppliedInfo } from './Events/FilterApplied';
+import { AdaptableFDC3EventInfo, SelectionChangedInfo, LiveDataChangedInfo, DashboardChangedInfo, ThemeChangedInfo, AlertFiredInfo, LayoutChangedInfo, SearchChangedInfo, AdaptableReadyInfo, CustomToolbarConfiguredInfo, CellChangedInfo, SystemStatusMessageDisplayedInfo, CheckboxColumnClickedInfo, AdaptableStateChangedInfo, FlashingCellDisplayedInfo, GridDataChangedInfo, TeamSharingEntityChangedInfo, ActionRowSubmittedInfo, DataSetSelectedInfo, AdaptableStateReloadedInfo, GridSortedInfo, QueryRunInfo, FilterAppliedInfo } from '../types';
 /**
  * Responsible for publishing the many Events that AdapTable fires
  */
 export interface EventApi {
     /**
-     * @deprecated - use FilterApplied, QueryRun or GridSorted
+     * @deprecated - use `FilterApplied`, `QueryRun` or `GridSorted` instead
      */
     on(eventName: 'SearchChanged', callback: (searchChangedInfo: SearchChangedInfo) => void): VoidFunction;
     /**
-     *@deprecated - use FilterApplied, QueryRun or GridSorted
+     *@deprecated - use `FilterApplied`, `QueryRun` or `GridSorted` instead
      */
     off(eventName: 'SearchChanged', callback: (searchChangedInfo: SearchChangedInfo) => void): void;
     /**
@@ -298,6 +277,18 @@ 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[];

package/src/Api/ExportApi.d.ts

@@ -1,7 +1,7 @@
 import { AdaptableForm } from '../PredefinedConfig/Common/AdaptableForm';
 import { ExportState, Report, ReportData, ReportSchedule, SystemReportNames } from '../PredefinedConfig/ExportState';
 import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
-import { CustomDestination, CustomReport, ExportFormContext } from '../AdaptableOptions/ExportOptions';
+import { CustomDestination, ServerReport, ExportFormContext } from '../AdaptableOptions/ExportOptions';
 import { ExportDestination } from '../PredefinedConfig/Common/Enums';
 /**
  * Provides run-time access to the Export Module and Report state
@@ -43,14 +43,14 @@ export interface ExportApi {
      */
     getCurrentReportName(): string;
     /**
-     * Retrieves all Reports in State - both System and User-created Reports
+     * Retrieves all Reports in State - System, Server and User-created Reports
      * @returns reports
      */
-    getAllReports(): Report[];
+    getReports(): Report[];
     /**
-     * Returns any Custom Reports that have been provided to Export Options
+     * Returns all Server Reports that have been provided to Export Options
      */
-    getAllCustomReports(): CustomReport[] | undefined;
+    getServerReports(): ServerReport[];
     /**
      * Retrieves System Reports section of Export State
      */
@@ -99,7 +99,7 @@ export interface ExportApi {
     /**
      * Opens Settings Panel with Export section selected and visible
      */
-    showExportPopup(): void;
+    openExportSettingsPanel(): void;
     /**
      * Edits an existing report
      * @param report report to edit
@@ -116,7 +116,7 @@ export interface ExportApi {
      * Retrieves all Custom Destinations from Export Options
      * @returns custom destinations
      */
-    getAllCustomDestination(): CustomDestination[];
+    getCustomDestinations(): CustomDestination[];
     /**
      * If the given destination is a Custom one
      * @param destination destination to check
@@ -127,29 +127,46 @@ export interface ExportApi {
      * @param destination Custom Destination for which to get Form Def
      */
     getExportDestinationForm(destinationName: string): AdaptableForm<ExportFormContext> | undefined;
-    /**
-     * Whether given data change affects given report
-     * @param cellDataChangedInfo data change to check
-     * @param report report to check
-     */
-    isDataChangeInReport(cellDataChangedInfo: CellDataChangedInfo, report: Report): boolean;
     /**
      * Exports data currently in grid to Excel as What-You-See-Is-What-You-Get
      */
     exportVisualDataToExcel(): void;
     /**
-     * Whether a Report is a Custom Report
-     * @param customReportName Report to Check
+     * Whether the given Report is a user-generated (server) one
+     * @param report Report to Check
      */
-    isCustomReport(report: Report): boolean;
+    isServerReport(report: Report): boolean;
     /**
-     * Runs the report function of the CustomReport with the given reportName
+     * Runs the report function of the ServerReport with the given reportName
      * @param reportName custom report name
      */
-    runCustomReport(reportName: string): ReportData | undefined;
+    runServerReport(reportName: string): ReportData | undefined;
     /**
      * Returns the ReportData for the Report with the given name
      * @param reportName - the name of the report
      */
     getReportDataForReport(reportName: string): ReportData | undefined;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `getReports()` instead
+     */
+    getAllReports(): Report[];
+    /**
+     * @deprecated use `getServerReports()` instead
+     */
+    getAllServerReports(): ServerReport[] | undefined;
+    /**
+     * @deprecated use `showExportSettingsPanel()` instead
+     */
+    showExportPopup(): void;
+    /**
+     * @deprecated use `getCustomDestinations()` instead
+     */
+    getAllCustomDestination(): CustomDestination[];
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    isDataChangeInReport(cellDataChangedInfo: CellDataChangedInfo, report: Report): boolean;
 }

package/src/Api/FilterApi.d.ts

@@ -1,18 +1,12 @@
-import { AdaptableColumn, ColumnFilter, GridCell, SystemFilterPredicateIds } from '../types';
+import { AdaptableColumn, ColumnFilter, GridCell } from '../types';
 import * as Redux from 'redux';
-import { ColumnFilterDef, AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
+import { AdaptablePredicateDef, ColumnFilterDef } from '../PredefinedConfig/Common/AdaptablePredicate';
 import { RowNode } from '@ag-grid-community/core';
 import { LayoutColumnFilterAction } from '../Redux/ActionsReducers/LayoutRedux';
 /**
  * Provides run-time access to Filter section of Adaptable State.
  */
 export interface FilterApi {
-    /**
-     * Returns Predicate Definition for given Column and Quick Filter shortcut
-     * @param shortcut Quick Filter shortcut to lookup
-     * @param column Adaptable Column being Filtered
-     */
-    findPredicateDefByShortcut(shortcut: string, column: AdaptableColumn): AdaptablePredicateDef;
     /**
      * Gets all Filter Predicates available for a given Column
      * @param column Column to lookup
@@ -23,10 +17,6 @@ export interface FilterApi {
      * @param columnId Id of Column to lookup
      */
     getFilterPredicateDefsForColumnId(columnId: string): AdaptablePredicateDef[] | undefined;
-    /**
-     * Retrieves Ids for all System Filters
-     */
-    getAllSystemFilterIds(): SystemFilterPredicateIds;
     /**
      * Makes Quick Filter Bar appear
      */
@@ -49,7 +39,7 @@ export interface FilterApi {
      */
     getColumnFilters(): ColumnFilter[];
     /**
-     * Retrieves all active/no-suspedned Column Filters in currently applied Layout
+     * Retrieves all active/no-suspended Column Filters in currently applied Layout
      * @returns column filters
      */
     getActiveColumnFilters(): ColumnFilter[];
@@ -57,20 +47,20 @@ export interface FilterApi {
      * Retrieves the Column Filter for the specified Column.
      * @param columnId Column ID to lookup
      */
-    getColumnFilter(columnId: string): ColumnFilter | undefined;
+    getColumnFilterForColumn(columnId: string): ColumnFilter | undefined;
     /**
      * Retrieves all Column Filters in a given Layout
      * @param layoutName Layout to retrieve Column Filters for
      */
     getColumnFiltersForLayout(layoutName: string): ColumnFilter[];
     /**
-     * Sets Column Filters - will replace filters for existing column and leave other column filters in place
+     * Sets Column Filters in the current Layout - will replace filters for existing column and leave other column filters in place
      * @param columnFilters Column Filters to set
      * @returns column filters
      */
-    setColumnFilter(columnFilters: ColumnFilter[]): ColumnFilter[] | null;
+    setColumnFilters(columnFilters: ColumnFilter[]): ColumnFilter[] | null;
     /**
-     * Clears given Column Filter
+     * Clears given Column Filter in the current Layout
      * @param columnFilter Column Filter to clear
      */
     clearColumnFilter(columnFilter: ColumnFilter): void;
@@ -78,12 +68,12 @@ export interface FilterApi {
      * Clears Column Filter for given Column
      * @param columnId Column for which Column Filter should be cleared
      */
-    clearColumnFilterByColumn(columnId: string): void;
+    clearColumnFilterForColumn(columnId: string): void;
     /**
      * Clears Column Filters for given set of Columns
-     * @param columns Columns for which Column Filte should be cleared
+     * @param columns Columns for which Column Filter should be cleared
      */
-    clearColumnFilterByColumns(columns: string[]): void;
+    clearColumnFiltersForColumns(columns: string[]): void;
     /**
      * Clears all Column Filters in the Current Layout
      */
@@ -92,79 +82,97 @@ export interface FilterApi {
      * Clears existing Column Filters and sets new ones
      * @param columnFilters Column Filters to set
      */
-    clearAndSetColumnFilter(columnFilters: ColumnFilter[]): void;
+    clearAndSetColumnFilters(columnFilters: ColumnFilter[]): void;
     /**
-     * Retrieves all Column Filters for given Column
-     * @param columnId column to retrieve Column Filters for
-     * @returns column filters
+     * Checks if a filter is active or applied.
+     * It is applied when:
+     * - filter predicate does not have inputs
+     * - filter predicate has inputs with values
      */
-    getAllColumnFilterForColumn(columnId: string): ColumnFilter[];
+    isFilterActive(columnFilter: ColumnFilter): boolean;
     /**
-     * Creates an Equality Filter based on given Grid Cells
-     * @param gridCells cells to create Filter for
+     * Retrieves the Column Filter definitions for all available Column Filters
      */
-    createValuesColumnFilterForCells(gridCells: GridCell[]): ColumnFilter | null;
+    getColumnFilterDefs(): ColumnFilterDef[];
     /**
-     *  Creates an Equality Filter based on given Grid Cell
-     * @param gridCell cell to create Filter for
+     * Suspends a Column Filter
+     * @param columnFilter Column Filter to Suspend
      */
-    createEqualityColumnFilterForCell(gridCell: GridCell): ColumnFilter | null;
+    suspendColumnFilter(columnFilter: ColumnFilter): void;
     /**
-     * Retrieves description of given Column Filter
-     * @param columnFilter Column Filter to use
+     * Unsuspend a Column Filter
+     * @param columnFilter Column Filter to UnSuspend
      */
-    columnFilterToString(columnFilter: ColumnFilter): string;
+    unSuspendColumnFilter(columnFilter: ColumnFilter): void;
     /**
-     * Retrieves descriptions of given Column Filters
-     * @param columnFilters Column Filters to use
+     * Suspends all Column Filters
      */
-    columnFiltersToString(columnFilters: ColumnFilter[]): string;
+    suspendAllColumnFilters(): void;
     /**
-     * Calls AdapTableQL to evaluate Filter for given Row
-     * @param columnFilter Column Filter to use
-     * @param node Row Node to evaluate
+     * Unsuspend all Column Filters
      */
-    evaluateColumnFilter(columnFilter: ColumnFilter, node: RowNode): boolean;
+    unSuspendAllColumnFilters(): void;
     /**
-     * Checks if a filter is active or applied.
-     * It is applied when:
-     * - filter predicate does not have inputs
-     * - filter predicate has inputs with values
+     * TO BE REMOVED
      */
-    isFilterActive(columnFilter: ColumnFilter): boolean;
-    getColumnFilterDefs(): ColumnFilterDef[];
     /**
-     * Checks if the filter action should trigger grid filtering.
-     *
-     * @param action Filtering Action
+     * @deprecated internal method, will be removed in next major release
      */
-    shouldNewColumnFilterTriggerGridFiltering(action: LayoutColumnFilterAction | Redux.Action): boolean;
+    findPredicateDefByShortcut(shortcut: string, column: AdaptableColumn): AdaptablePredicateDef;
     /**
-     * Fires Filter Applied Event - typically used to enable filtering on the server
+     * @deprecated use `clearColumnFilterForColumn()` instead
      */
-    fireFilterAppliedEvent(): void;
+    clearColumnFilterByColumn(columnId: string): void;
     /**
-     * Compares to sets of Column Filters to see if they are identical
-     * @param filters1
-     * @param filters2
+     * @deprecated use `clearColumnFiltersForColumns()` instead
      */
-    areColumnFiltersDifferent(filters1: ColumnFilter[], filters2: ColumnFilter[]): boolean;
+    clearColumnFilterByColumns(columns: string[]): void;
     /**
-     * Suspends a Column Filter
-     * @param columnFilter Column Filter to Suspend
+     * @deprecated use `setColumnFilters()` instead
      */
-    suspendColumnFilter(columnFilter: ColumnFilter): void;
+    setColumnFilter(columnFilters: ColumnFilter[]): ColumnFilter[] | null;
     /**
-     * Unsuspends a Column Filter
-     * @param columnFilter Column Filter to UnSuspend
+     * @deprecated use `clearAndSetColumnFilters()` instead
      */
-    unSuspendColumnFilter(columnFilter: ColumnFilter): void;
+    clearAndSetColumnFilter(columnFilters: ColumnFilter[]): void;
     /**
-     * Suspends all Column Filters
+     * @deprecated use `getColumnFilterForColumn()` instead
      */
-    suspendAllColumnFilters(): void;
+    getAllColumnFilterForColumn(columnId: string): ColumnFilter[];
     /**
-     * Unsuspends all Column Filters
+     * @deprecated use `getColumnFilterForColumn()` instead
      */
-    unSuspendAllColumnFilters(): void;
+    getColumnFilter(columnId: string): ColumnFilter | undefined;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    createValuesColumnFilterForCells(gridCells: GridCell[]): ColumnFilter | null;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    createEqualityColumnFilterForCell(gridCell: GridCell): ColumnFilter | null;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    columnFilterToString(columnFilter: ColumnFilter): string;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    columnFiltersToString(columnFilters: ColumnFilter[]): string;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    evaluateColumnFilter(columnFilter: ColumnFilter, node: RowNode): boolean;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    shouldNewColumnFilterTriggerGridFiltering(action: LayoutColumnFilterAction | Redux.Action): boolean;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    fireFilterAppliedEvent(): void;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    areColumnFiltersDifferent(filters1: ColumnFilter[], filters2: ColumnFilter[]): boolean;
 }

package/src/Api/FinanceApi.d.ts

@@ -1,6 +1,6 @@
 import { RowNode } from '@ag-grid-community/core';
 import { ContactColumn, ContactIntent, CountryColumn, CustomFDC3Column, CustomFDC3Intent, FDC3Intent, FinancePluginOptions, InstrumentColumn, InstrumentIntent, OrganizationColumn, PositionColumn, PositionIntent } from '../AdaptableOptions/FinancePluginOptions';
-import { ContactContext, ContactListContext, CountryContext, FDC3Context, InstrumentContext, InstrumentListContext, OrganizationContext, PortfolioContext, PositionContext } from '../types';
+import { ContactContext, ContactListContext, ContextData, CountryContext, FDC3Context, InstrumentContext, InstrumentListContext, OrganizationContext, PortfolioContext, PositionContext } from '../types';
 /**
  * Provides run-time access to the Finance Plugin
  */
@@ -13,50 +13,58 @@ export interface FinanceApi {
      * Creates FDC3 Instrument Context
      * @param instrumentColumn Instrument Column to create Context For
      * @param rowNode Row Node to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3InstrumentContext(instrumentColumn: InstrumentColumn, rowNode: RowNode): InstrumentContext;
+    createFDC3InstrumentContext(instrumentColumn: InstrumentColumn, rowNode: RowNode, data?: ContextData): InstrumentContext;
     /**
      * Creates FDC3 Instrumentlist Context
      * @param instrumentColumn Instrument Column to create Context For
      * @param rowNode Row Nodes to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3InstrumentListContext(instrumentColumn: InstrumentColumn, rowNodes: RowNode[]): InstrumentListContext;
+    createFDC3InstrumentListContext(instrumentColumn: InstrumentColumn, rowNodes: RowNode[], data?: ContextData): InstrumentListContext;
     /**
      * Creates FDC3 Position Context
      * @param instrumentColumn Position Column to create Context For
      * @param rowNode Row Node to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3PositionContext(positionColumn: PositionColumn, rowNode: RowNode): PositionContext;
+    createFDC3PositionContext(positionColumn: PositionColumn, rowNode: RowNode, data?: ContextData): PositionContext;
     /**
      * Creates FDC3 Portfolio Context
      * @param instrumentColumn Position Column to create Context For
      * @param rowNode Row Nodes to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3PortfolioContext(positionColumn: PositionColumn, rowNodes: RowNode[]): PortfolioContext;
+    createFDC3PortfolioContext(positionColumn: PositionColumn, rowNodes: RowNode[], data?: ContextData): PortfolioContext;
     /**
      * Creates FDC3 Contact Context
      * @param instrumentColumn Contact Column to create Context For
      * @param rowNode Row Node to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3ContactContext(contactColumn: ContactColumn, rowNode: RowNode): ContactContext;
+    createFDC3ContactContext(contactColumn: ContactColumn, rowNode: RowNode, data?: ContextData): ContactContext;
     /**
      * Creates FDC3 Contact List Context
      * @param instrumentColumn Contact Column to create Context For
      * @param rowNode Row Nodes to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3ContactListContext(contactColumn: ContactColumn, rowNodes: RowNode[]): ContactListContext;
+    createFDC3ContactListContext(contactColumn: ContactColumn, rowNodes: RowNode[], data?: ContextData): ContactListContext;
     /**
      * Creates FDC3 Organization Context
      * @param instrumentColumn Organization Column to create Context For
      * @param rowNode Row Node to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3OrganizationContext(organizationColumn: OrganizationColumn, rowNode: RowNode): OrganizationContext;
+    createFDC3OrganizationContext(organizationColumn: OrganizationColumn, rowNode: RowNode, data?: ContextData): OrganizationContext;
     /**
      * Creates FDC3 Country Context
      * @param instrumentColumn Country Column to create Context For
      * @param rowNode Row Node to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3CountryContext(countryColumn: CountryColumn, rowNode: RowNode): CountryContext;
+    createFDC3CountryContext(countryColumn: CountryColumn, rowNode: RowNode, data?: ContextData): CountryContext;
     /**
      * Gets Instrument Column with given Id
      * @param instrumentColumnId Column to Look
@@ -88,6 +96,11 @@ export interface FinanceApi {
      * @param context context for Event
      */
     publishBroadcastFDC3MessageEvent(context: FDC3Context): void;
+    /**
+     * Publishes an FDC3 Message Event of type `RaiseIntentForContext`
+     * @param context context for Event
+     */
+    publishRaiseFDC3IntentForContextEvent(context: FDC3Context): void;
     /**
      * Publishes an FDC3 Message Event of type `Raise Event`
      * @param context context for Event

package/src/Api/FinsembleApi.d.ts

@@ -0,0 +1,10 @@
+import { FinsemblePluginOptions } from '../AdaptableOptions/FinsemblePluginOptions';
+/**
+ * Provides run-time access to the Finsemble Plugin
+ */
+export interface FinsembleApi {
+    /**
+     * Retrieves the FinsemblePlugOptions provided in Finsemble Plugin
+     */
+    getPluginOptions(): FinsemblePluginOptions;
+}

package/src/Api/FinsembleApi.js

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