@adaptabletools/adaptable 11.1.7 → 11.1.10

package/src/Api/Implementation/ConfigApiImpl.js

@@ -71,39 +71,15 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
     getAllState() {
         return this.getAdaptableState();
     }
-    // im sure we can do this better
-    getUserStateKeys() {
-        return [
-            'Alert',
-            'Application',
-            'CalculatedColumn',
-            'ConditionalStyle',
-            'CustomSort',
-            'Dashboard',
-            'DataSource',
-            'Entitlement',
-            'Export',
-            'Filter',
-            'FormatColumn',
-            'FreeTextColumn',
-            'Layout',
-            'PlusMinus',
-            'Query',
-            'QuickSearch',
-            'Shortcut',
-            'Theme',
-            'ToolPanel',
-        ];
+    getPersistedState() {
+        // no assertion should be required here as soon as we make order in our state typings
+        return this.adaptable.adaptableStore.getCurrentStorageState();
     }
     getAllUserState() {
-        const userStateKeys = this.getUserStateKeys();
-        const allState = this.getAllState();
-        return userStateKeys.map((k) => allState[k]);
+        return Object.values(this.getPersistedState());
     }
     loadUserState(state) {
-        const userStateKeys = this.getUserStateKeys();
-        const userState = Object.keys(state).reduce((xs, x) => (userStateKeys.indexOf(x) !== -1 ? Object.assign(Object.assign({}, xs), { [x]: state[x] }) : xs), {});
-        this.dispatchAction(AdaptableStore_1.LoadState(userState));
+        this.dispatchAction(AdaptableStore_1.LoadState(state));
     }
     getAdaptableSearchState() {
         const currentQuery = this.adaptable.api.queryApi.getCurrentQuery();
@@ -374,6 +350,9 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
             case 'ToolPanel':
                 this.dispatchAction(ToolPanelRedux.ToolPanelReady(this.getToolPanelState()));
                 break;
+            case 'StatusBar':
+                this.dispatchAction(ToolPanelRedux.ToolPanelReady(this.getToolPanelState()));
+                break;
         }
     }
 }

package/src/Api/Implementation/GridApiImpl.js

@@ -58,10 +58,6 @@ class GridApiImpl extends ApiBase_1.ApiBase {
             LoggingHelper_1.LogAdaptableWarning(`setCellValue() - rowNode not found for primaryKeyValue: ${primaryKeyValue}`);
             return;
         }
-        if (!this.adaptable.isCellEditable(rowNode, this.adaptable.getAgGridColumnForColumnId(columnId))) {
-            LoggingHelper_1.LogAdaptableInfo(`setCellValue() - cell is not editable (primaryKeyValue: ${primaryKeyValue},columnId: ${columnId},value: ${newValue})`);
-            return;
-        }
         this.adaptable.setDataValue(newValue, abColumn, primaryKeyValue, rowNode);
     }
     setCellsValue(gridCells) {

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

@@ -60,7 +60,7 @@ export declare class InternalApiImpl extends ApiBase implements InternalApi {
     hidePopupScreen(): void;
     hidePopupAlert(): void;
     setColumns(columns: AdaptableColumn[]): void;
-    setModuleDropdownMenuItems(menuItems: AdaptableMenuItem[]): void;
+    setSettingPanelModuleMenuItems(menuItems: AdaptableMenuItem[]): void;
     setModuleButtonMenuItems(menuItems: AdaptableMenuItem[]): void;
     setSelectedCells(selectedCellInfo: SelectedCellInfo): void;
     setSelectedRows(selectedRowInfo: SelectedRowInfo): void;
@@ -120,5 +120,6 @@ export declare class InternalApiImpl extends ApiBase implements InternalApi {
     isTextComparisonCaseSensitive(): boolean;
     executeWithProgressIndicator(label: string, executeFn: () => void): void;
     hideProgressIndicator(): void;
+    getCorrectEnglishVariant(wordToSpell: string): string;
     dispatchReduxAction(action: Action): void;
 }

package/src/Api/Implementation/InternalApiImpl.js

@@ -80,13 +80,27 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
         });
     }
     getAdaptableAlertWithHighlightRow(rowNode) {
-        // only alerts triggered by row changes are relevant for HighlightRow actions
-        return this.getAdaptableRowChangedAlerts().find((alert) => {
-            var _a;
-            if (((_a = alert.alertDefinition.AlertProperties) === null || _a === void 0 ? void 0 : _a.HighlightRow) && alert.gridDataChangedInfo) {
-                return alert.gridDataChangedInfo.rowNodes.map((rowNode) => rowNode.id).includes(rowNode.id);
+        let alertWithRowHighlight;
+        alertWithRowHighlight = this.getAdaptableRowChangedAlerts().find((alert) => {
+            var _a, _b;
+            if ((_a = alert.alertDefinition.AlertProperties) === null || _a === void 0 ? void 0 : _a.HighlightRow) {
+                if ((_b = alert.gridDataChangedInfo) === null || _b === void 0 ? void 0 : _b.rowNodes.map((rowNode) => rowNode.id).includes(rowNode.id)) {
+                    return alert;
+                }
             }
         });
+        if (alertWithRowHighlight) {
+            return alertWithRowHighlight;
+        }
+        alertWithRowHighlight = this.getAdaptableCellChangedAlerts().find((alert) => {
+            var _a, _b;
+            if ((_a = alert.alertDefinition.AlertProperties) === null || _a === void 0 ? void 0 : _a.HighlightRow) {
+                if (((_b = alert.cellDataChangedInfo) === null || _b === void 0 ? void 0 : _b.rowNode.id) == rowNode.id) {
+                    return alert;
+                }
+            }
+        });
+        return alertWithRowHighlight;
     }
     isAlertDefinitionForAddedRowChangeEvent(alertDefinition) {
         var _a, _b;
@@ -137,8 +151,8 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
     setColumns(columns) {
         this.dispatchAction(GridRedux.GridSetColumns(columns));
     }
-    setModuleDropdownMenuItems(menuItems) {
-        this.dispatchAction(GridRedux.SetModuleDropdownMenuItems(menuItems));
+    setSettingPanelModuleMenuItems(menuItems) {
+        this.dispatchAction(GridRedux.SetSettingPanelModuleMenuItems(menuItems));
     }
     setModuleButtonMenuItems(menuItems) {
         this.dispatchAction(GridRedux.SetModuleButtonMenuItems(menuItems));
@@ -443,6 +457,14 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
     hideProgressIndicator() {
         this.dispatchReduxAction(SystemRedux_1.SystemProgressIndicatorHide());
     }
+    getCorrectEnglishVariant(wordToSpell) {
+        if (wordToSpell.includes('our')) {
+            return this.getGeneralOptions().englishVariant == 'GB'
+                ? wordToSpell
+                : wordToSpell.replace('our', 'or');
+        }
+        return wordToSpell;
+    }
     // General way to get to store from inside Adaptable...
     dispatchReduxAction(action) {
         this.dispatchAction(action);

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

@@ -20,12 +20,13 @@ export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     getLayoutById(id: Layout['Uuid']): Layout;
     saveCurrentLayout(): void;
     doesLayoutExist(layout: Layout): boolean;
-    createAndSetLayout(layoutToCreate: Layout): Layout;
-    createLayout(layoutToCreate: Layout): Layout | undefined;
-    cloneAndSetLayout(layoutToClone: Layout, layoutName: string): Layout;
-    cloneLayout(layoutToClone: Layout, layoutName: string): Layout;
+    createAndSetLayout(layoutToCreate: Layout): Layout | false;
+    createLayout(layoutToCreate: Layout): Layout | false;
+    cloneAndSetLayout(layoutToClone: Layout, layoutName: string): Layout | false;
+    cloneLayout(layoutToClone: Layout, layoutName: string): Layout | false;
     setColumnCaption(columnId: string, caption: string): void;
     saveLayout(layoutToSave: Layout): void;
+    createOrUpdateLayout(layout: Layout): void;
     areLayoutsEqual(layout1: Layout, layout2: Layout): boolean;
     getLayoutDescription(layout: Layout): string;
     private getColumnSort;

package/src/Api/Implementation/LayoutApiImpl.js

@@ -121,7 +121,7 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
     createLayout(layoutToCreate) {
         if (this.doesLayoutExist(layoutToCreate)) {
             LoggingHelper_1.LogAdaptableError("Cannot create layout with the Name: '" + layoutToCreate.Name + "' as it already exists");
-            return;
+            return false;
         }
         const newLayout = ObjectFactory_1.default.CreateEmptyLayout(Object.assign({}, layoutToCreate));
         this.addUidToAdaptableObject(newLayout);
@@ -129,18 +129,16 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
         return newLayout;
     }
     cloneAndSetLayout(layoutToClone, layoutName) {
-        if (!this.doesLayoutExist(layoutToClone)) {
-            LoggingHelper_1.LogAdaptableError("Cannot clone layout with Name: '" + layoutName + "' as other Layout does not exist");
-            return;
-        }
         const newLayout = this.cloneLayout(layoutToClone, layoutName);
-        this.setLayout(layoutName);
+        if (newLayout) {
+            this.setLayout(layoutName);
+        }
         return newLayout;
     }
     cloneLayout(layoutToClone, layoutName) {
         if (!this.doesLayoutExist(layoutToClone)) {
             LoggingHelper_1.LogAdaptableError("Cannot clone layout with Name: '" + layoutName + "' as other Layout does not exist");
-            return;
+            return false;
         }
         const newLayout = Helper_1.default.cloneObject(layoutToClone);
         newLayout.Uuid = Uuid_1.createUuid();
@@ -165,6 +163,14 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
             this.dispatchAction(LayoutRedux.LayoutSave(layoutToSave));
         }
     }
+    createOrUpdateLayout(layout) {
+        if (!this.doesLayoutExist(layout)) {
+            this.createLayout(layout);
+        }
+        else {
+            this.dispatchAction(LayoutRedux.LayoutSave(layout));
+        }
+    }
     areLayoutsEqual(layout1, layout2) {
         if (!layout1 && !layout2) {
             return true;

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

@@ -16,4 +16,5 @@ export declare class QueryApiImpl extends ApiBase implements QueryApi {
     getCurrentQuery(): string | undefined;
     getReferencedNamedQueryNames(expression?: string): string[];
     getNamedQueryModuleReferences(namedQueryName: string): string[];
+    expandCurrentQuery(query?: string): void;
 }

package/src/Api/Implementation/QueryApiImpl.js

@@ -8,6 +8,7 @@ const StringExtensions_1 = require("../../Utilities/Extensions/StringExtensions"
 const QueryRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/QueryRedux"));
 const PopupRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/PopupRedux"));
 const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
+const windowFactory_1 = require("../../View/Components/Popups/WindowPopups/windowFactory");
 class QueryApiImpl extends ApiBase_1.ApiBase {
     getQueryState() {
         return this.getAdaptableState().Query;
@@ -76,5 +77,16 @@ class QueryApiImpl extends ApiBase_1.ApiBase {
         });
         return references;
     }
+    expandCurrentQuery(query) {
+        const preparedQuery = query !== null && query !== void 0 ? query : this.getCurrentQuery();
+        this.adaptable.api.internalApi.dispatchReduxAction(PopupRedux.PopupShowWindow({
+            Id: windowFactory_1.WINDOW_QUERY_EDITOR,
+            Title: 'Current Query',
+            Icon: 'query',
+            PopupProps: {
+                value: preparedQuery,
+            },
+        }));
+    }
 }
 exports.QueryApiImpl = QueryApiImpl;

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

@@ -0,0 +1,8 @@
+import { AdaptableStatusBar } from '../../PredefinedConfig/StatusBarState';
+import { StatusBarApi } from '../StatusBarApi';
+import { ApiBase } from './ApiBase';
+export declare class StatusBarApiImpl extends ApiBase implements StatusBarApi {
+    getStatusPanels(): AdaptableStatusBar[];
+    getAgGridStatusPanels(): import("@ag-grid-community/core").StatusPanelDef[];
+    setStatusPanels(statusPanels: AdaptableStatusBar[]): void;
+}

package/src/Api/Implementation/StatusBarApiImpl.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatusBarApiImpl = void 0;
+const StatusBarRedux_1 = require("../../Redux/ActionsReducers/StatusBarRedux");
+const ApiBase_1 = require("./ApiBase");
+class StatusBarApiImpl extends ApiBase_1.ApiBase {
+    getStatusPanels() {
+        return StatusBarRedux_1.getStatusPanelsSelector(this.getAdaptableState());
+    }
+    getAgGridStatusPanels() {
+        return this.adaptable.getAgGridStatusPanels();
+    }
+    setStatusPanels(statusPanels) {
+        this.getAdaptableApi().internalApi.dispatchReduxAction(StatusBarRedux_1.StatusBarSetPanels(statusPanels));
+    }
+}
+exports.StatusBarApiImpl = StatusBarApiImpl;

package/src/Api/InternalApi.d.ts

@@ -65,7 +65,7 @@ export interface InternalApi {
     hidePopupScreen(): void;
     hidePopupAlert(): void;
     setColumns(columns: AdaptableColumn[]): void;
-    setModuleDropdownMenuItems(menuItems: AdaptableMenuItem[]): void;
+    setSettingPanelModuleMenuItems(menuItems: AdaptableMenuItem[]): void;
     setModuleButtonMenuItems(menuItems: AdaptableMenuItem[]): void;
     setSelectedCells(selectedCellInfo: SelectedCellInfo): void;
     setSelectedRows(selectedRowInfo: SelectedRowInfo): void;
@@ -123,4 +123,5 @@ export interface InternalApi {
     isTextComparisonCaseSensitive(): boolean;
     executeWithProgressIndicator(label: string, executeFn: () => unknown): void;
     hideProgressIndicator(): void;
+    getCorrectEnglishVariant(wordToSpell: string): string;
 }

package/src/Api/LayoutApi.d.ts

@@ -65,36 +65,43 @@ export interface LayoutApi {
      */
     saveCurrentLayout(): void;
     /**
-     * Saves given Layout into Adaptable State
+     * Saves given Layout into Adaptable State (creates new Layout if it doesn't exist)
      * @param layoutToSave the Layout to save
+     *
+     * @deprecated use {@link createOrUpdateLayout} instead
      */
     saveLayout(layoutToSave: Layout): void;
+    /**
+     * Creates new Layout into Adaptable State or updates an existing Layout (with same name or id)
+     * @param layout the Layout to create or update
+     */
+    createOrUpdateLayout(layout: Layout): void;
     /**
      * Creates new Layout in the state
      * @param layoutToCreate Layout to create
-     * @returns layout
+     * @returns created Layout object or `false` if Layout with the same name/Uuid already exists
      */
-    createLayout(layoutToCreate: Layout): Layout | undefined;
+    createLayout(layoutToCreate: Layout): Layout | false;
     /**
      * Creates new Layout in the state and then loads it into Grid
      * @param layoutToCreate Layout to create
-     * @returns layout
+     * @returns created Layout object or `false` if creation failed
      */
-    createAndSetLayout(layoutToCreate: Layout): Layout;
+    createAndSetLayout(layoutToCreate: Layout): Layout | false;
     /**
      * Creates new Layout based on given Layout but with name provided
      * @param layoutToClone Layout to clone
      * @param layoutName name to use for new Layout
-     * @returns layout
+     * @returns created Layout object or `false` if creation failed
      */
-    cloneLayout(layoutToClone: Layout, layoutName: string): Layout;
+    cloneLayout(layoutToClone: Layout, layoutName: string): Layout | false;
     /**
      * Creates new Layout based on given Layout but with name provided and then loads it into Grid
      * @param layoutToClone Layout to clone
      * @param layoutName name to use for new Layout
-     * @returns layout
+     * @returns created Layout object or `false` if creation failed
      */
-    cloneAndSetLayout(layoutToClone: Layout, layoutName: string): Layout;
+    cloneAndSetLayout(layoutToClone: Layout, layoutName: string): Layout | false;
     /**
      * Checks whether this Layout exists in the Adaptable State (by comparing Uuid property)
      * @param layout Layout to check

package/src/Api/QueryApi.d.ts

@@ -56,4 +56,10 @@ export interface QueryApi {
      * Returns the Current Query
      */
     getCurrentQuery(): string | undefined;
+    /**
+     * Opens current query editor
+     *
+     * @param query - query to edit
+     */
+    expandCurrentQuery(query?: string): void;
 }

package/src/Api/StatusBarApi.d.ts

@@ -0,0 +1,10 @@
+import { GridOptions } from '@ag-grid-community/all-modules';
+import { AdaptableStatusBar } from '../PredefinedConfig/StatusBarState';
+export interface StatusBarApi {
+    /**
+     * Retrieves the current AG Grid Status Bar Panels
+     */
+    getAgGridStatusPanels: () => GridOptions['statusBar']['statusPanels'];
+    getStatusPanels: () => AdaptableStatusBar[];
+    setStatusPanels: (statusPanels: AdaptableStatusBar[]) => void;
+}

package/src/Api/StatusBarApi.js

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

package/src/PredefinedConfig/AdaptableState.d.ts

@@ -23,17 +23,17 @@ import { ApplicationState } from './ApplicationState';
 import { ToolPanelState } from './ToolPanelState';
 import { QueryState } from './QueryState';
 import { FlashingCellState } from './FlashingCellState';
+import { StatusBarState } from './StatusBarState';
 /**
- * The main state object that Adaptable persists
+ * The main state object of Adaptable
  */
-export interface AdaptableState {
+export interface AdaptableState extends AdaptablePersistentState, AdaptableTransientState {
     [s: string]: ConfigState;
-    Popup: PopupState;
-    Grid: GridState;
-    System: SystemState;
-    Plugins: {
-        [key: string]: any;
-    };
+}
+/**
+ * The state object of Adaptable which is persisted
+ */
+export interface AdaptablePersistentState {
     Application: ApplicationState;
     Alert: AlertState;
     FlashingCell: FlashingCellState;
@@ -52,7 +52,19 @@ export interface AdaptableState {
     QuickSearch: QuickSearchState;
     Schedule: ScheduleState;
     Shortcut: ShortcutState;
+    StatusBar: StatusBarState;
     TeamSharing: TeamSharingState;
     Theme: ThemeState;
     ToolPanel: ToolPanelState;
 }
+/**
+ * The state which is available in the internal Redux store but never persisted
+ */
+export interface AdaptableTransientState {
+    Popup: PopupState;
+    Grid: GridState;
+    System: SystemState;
+    Plugins: {
+        [key: string]: any;
+    };
+}

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

@@ -8,17 +8,15 @@ import { FDC3Intent } from '../../types';
  */
 export interface FDC3Context {
     /**
-     * The type of the context that uniquely identifies it, e.g. "instrument".
-     * This is used to refer to the accepted context(s) when declaring intents. See [[AppDirIntent]].
+     * Type of context that uniquely identifies it, e.g. "instrument"; used to refer to the accepted context(s) when declaring intents
      */
-    type: string;
+    type: ContextType;
     /**
-     * The name of the context data (optional). This is a text string that describes the data being sent.
-     * Implementors of context may choose to make the name mandatory.
+     * Name of the context data (optional) - a text string that describes the data being sent
      */
     name?: string;
     /**
-     * An optional map of any equivalent identifiers for the context type, e.g. ISIN, CUSIP, etc. for an instrument.
+     * Optional map of any equivalent identifiers for the context type, e.g. ISIN, CUSIP, etc. for Instrument
      */
     id?: {
         [key: string]: string | undefined;
@@ -30,19 +28,19 @@ export interface FDC3Context {
     [key: string]: unknown;
 }
 /**
- * Built-in context to define a financial Instrument
+ * FDC3 Context to define a financial Instrument
  */
 export interface InstrumentContext extends FDC3Context {
     /**
-     * Context type is always 'instrument'
+     * Context type is always `instrument`
      */
     type: 'instrument';
     /**
-     * Free text name of instrument
+     * Free text name of the Instrument
      */
     name?: string;
     /**
-     * The instrument data
+     * Instrument data: ticker, ISIN, CUSIP, SEDOL, RIC, BBG, PERMID, FIGI
      */
     id?: {
         [key: string]: string;
@@ -57,13 +55,16 @@ export interface InstrumentContext extends FDC3Context {
         FIGI?: string;
     };
 }
+/**
+ * FDC3 Context to define an array of financial Instruments
+ */
 export interface InstrumentListContext extends FDC3Context {
     /**
-     * Context type is always 'instrumentList'
+     * Context type is always `instrumentList`
      */
     type: 'instrumentList';
     /**
-     * Free text name of instrument list
+     * Free text name of  list of Instruments (not set by AdapTable)
      */
     name?: string;
     /**
@@ -76,13 +77,16 @@ export interface InstrumentListContext extends FDC3Context {
     instruments?: InstrumentContext[];
 }
 /**
- * Built-in context to define a financial position
+ * FDC3 Context to define a financial Position (requires an Instrument)
  */
 export interface PositionContext extends FDC3Context {
     /**
-     * Context type is always 'position'
+     * Context type is always `position`
      */
     type: 'position';
+    /**
+     * The `InstrumentContext` of the relevant Instrument
+     */
     instrument: InstrumentContext;
     /**
      * Free text name of Position
@@ -93,13 +97,16 @@ export interface PositionContext extends FDC3Context {
      */
     id?: any;
     /**
-     * Holding in the Position
+     * Holding in the Position (mandatory)
      */
     holding: number;
 }
+/**
+ * FDC3 Context to define a financial Portfolio (array of Positions)
+ */
 export interface PortfolioContext extends FDC3Context {
     /**
-     * Context type is always 'portfolio'
+     * Context type is always `portfolio`
      */
     type: 'portfolio';
     /**
@@ -115,17 +122,20 @@ export interface PortfolioContext extends FDC3Context {
      */
     positions?: PositionContext[];
 }
+/**
+ * FDC3 Context to define a Contact
+ */
 export interface ContactContext extends FDC3Context {
     /**
-     * Context type is always 'contact'
+     * Context type is always `contact`
      */
     type: 'contact';
     /**
-     * Free text name of contact
+     * Free text name of Contact
      */
     name?: string;
     /**
-     * The contact data
+     * The Contact data: email, FDS_ID
      */
     id?: {
         [key: string]: string;
@@ -134,13 +144,16 @@ export interface ContactContext extends FDC3Context {
         FDS_ID?: string;
     };
 }
+/**
+ * FDC3 Context to define a list of Contacts
+ */
 export interface ContactListContext extends FDC3Context {
     /**
-     * Context type is always 'contactList'
+     * Context type is always `contactList`
      */
     type: 'contactList';
     /**
-     * Free text name of contact list
+     * Free text name of Contact list
      */
     name?: string;
     /**
@@ -148,21 +161,24 @@ export interface ContactListContext extends FDC3Context {
      */
     id?: any;
     /**
-     * The contact data
+     * The array of Contacts
      */
     contacts?: ContactContext[];
 }
+/**
+ * FDC3 Context to define an Organization
+ */
 export interface OrganizationContext extends FDC3Context {
     /**
-     * Context type is always 'organization'
+     * Context type is always `organization`
      */
     type: 'organization';
     /**
-     * Free text name of organization
+     * Free text name of Organization
      */
     name?: string;
     /**
-     * The organization data
+     * The Organization data: LEI, PERMID, FDS_ID
      */
     id?: {
         [key: string]: string;
@@ -172,17 +188,20 @@ export interface OrganizationContext extends FDC3Context {
         FDS_ID?: string;
     };
 }
+/**
+ * FDC3 Context to define a Country
+ */
 export interface CountryContext extends FDC3Context {
     /**
-     * Context type is always 'country'
+     * Context type is always `country`
      */
     type: 'country';
     /**
-     * Free text name of country
+     * Free text name of Country
      */
     name?: string;
     /**
-     * The country data
+     * The Country data: ISOALPHA2, ISOALPHA3
      */
     id?: {
         [key: string]: string;
@@ -191,8 +210,21 @@ export interface CountryContext extends FDC3Context {
         ISOALPHA3?: string;
     };
 }
+/**
+ * EventInfo returned by `FDC3MessageSent` event
+ */
 export interface AdaptableFDC3EventInfo extends BaseEventInfo {
-    type: 'RaiseIntent' | 'BroadcastMessage';
+    /**
+     * Type of Event: `RaiseIntent` or `BroadcastMessage`
+     */
+    eventType: 'RaiseIntent' | 'BroadcastMessage';
+    /**
+     * The FDC3 Intent which caused Event to fire (if type is `RaiseIntent`)
+     */
     intent?: FDC3Intent;
+    /**
+     * Full FDC3 Context for the object related to the event
+     */
     context: FDC3Context;
 }
+export declare type ContextType = 'instrument' | 'instrumentList' | 'position' | 'portfolio' | 'contact' | 'contactList' | 'organization' | 'country';