@adaptabletools/adaptable 11.1.15 → 11.2.0

package/index.css

@@ -3691,6 +3691,9 @@ html.ab--theme-dark .ab-ListBoxFilterForm--aggrid-style {
 .ab-Adaptable-Object-List__Item__label:hover .ab-Adaptable-Object-List__Item__edit-property {
         visibility: visible; }
 
+.ab-StatusBar {
+  display: flex; }
+
 .ab-StatusBar__SubPanel {
   padding: var(--ab-cmp-adaptable-statusbar-sub-panel__padding);
   border: 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "11.1.15",
+  "version": "11.2.0",
   "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
   "keywords": [
     "web-components",
@@ -56,6 +56,6 @@
     "uuid": "^3.3.2"
   },
   "peerDependencies": {
-    "@ag-grid-community/all-modules": ">=27.1.0"
+    "@ag-grid-community/all-modules": ">=27.2.0"
   }
 }

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1651496293230;
+declare const _default: 1652269439987;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1651496293230;
+exports.default = 1652269439987;

package/src/AdaptableOptions/AlertOptions.d.ts

@@ -1,6 +1,6 @@
+import { BaseContext } from '../../types';
 import { AlertButton, AlertDefinition } from '../PredefinedConfig/AlertState';
 import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
-import { ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
 import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
 import { CellDataChangedInfo } from '../types';
 /**
@@ -28,6 +28,12 @@ export interface AlertOptions {
      * @gridInfoItem
      */
     rowHighlightDuration?: number;
+    /**
+     * How long (in ms) the status-panel will be highlighted when an Alert Fires
+     *
+     * @defaultValue 2000
+     */
+    statusbarHighlightDuration?: number;
     /**
      * Custom onClick Handlers for Buttons (displayed in Alert Forms)
      */
@@ -77,7 +83,7 @@ export declare type AlertForm = {
 /**
  * Context required by functions when using an Alert Button
  */
-export interface AlertButtonContext extends ButtonContext {
+export interface AlertButtonContext extends BaseContext {
     /**
      * Alert that has been triggered
      */

package/src/AdaptableOptions/DashboardOptions.d.ts

@@ -1,7 +1,8 @@
 import { AdaptableApi } from '../Api/AdaptableApi';
-import { AdaptableButton, ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
+import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
 import { DashboardState } from '../PredefinedConfig/DashboardState';
+import { BaseContext } from '../types';
 import { AdaptableFrameworkComponent } from './AdaptableFrameworkComponent';
 /**
  * Options related to the Dashboard in Adaptable.
@@ -75,7 +76,7 @@ export interface CustomToolbar extends AdaptableObject {
 /**
  * Context required by functions when using a Dashboard Button
  */
-export interface DashboardButtonContext extends ButtonContext {
+export interface DashboardButtonContext extends BaseContext {
     /**
      * Current Dashboard State
      */
@@ -84,7 +85,7 @@ export interface DashboardButtonContext extends ButtonContext {
 /**
  * Context required by functions when using a Custom Toolbar Button
  */
-export interface CustomToolbarButtonContext extends ButtonContext {
+export interface CustomToolbarButtonContext extends BaseContext {
     /**
      * Custom Toolbar which hosts the Button
      */

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
 import { ReportData, Report, SystemReportNames } from '../PredefinedConfig/ExportState';
-import { ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
+import { BaseContext } from '../types';
 /**
  * Options regarding Exporting data from AdapTable
  */
@@ -86,7 +86,7 @@ export interface CustomDestination {
 /**
  * Context required by functions when using an Export Button
  */
-export interface ExportButtonContext extends ButtonContext {
+export interface ExportButtonContext extends BaseContext {
     /**
      * The exported report
      */

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -1,6 +1,7 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { FilterActionOnDataChange } from '../PredefinedConfig/Common/FilterActionOnDataChange';
-import { SystemFilterPredicateIds } from '../PredefinedConfig/FilterState';
+import { SystemFilterPredicateId, SystemFilterPredicateIds } from '../PredefinedConfig/FilterState';
+import { StrictExtract } from '../Utilities/Extensions/TypeExtensions';
 /**
  * Options for managing Filtering in AdapTable
  */
@@ -111,21 +112,21 @@ export interface FilterOptions {
      * @defaultValue Equals
      * @gridInfoItem
      */
-    defaultNumericColumnFilter?: 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | ((column: AdaptableColumn) => 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals');
+    defaultNumericColumnFilter?: StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'Values'> | ((column: AdaptableColumn) => StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'Values'>);
     /**
      * Default filter type for string Columns
      *
      * @defaultValue Contains
      * @gridInfoItem
      */
-    defaultStringColumnFilter?: 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | ((column: AdaptableColumn) => 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex');
+    defaultStringColumnFilter?: StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Values'> | ((column: AdaptableColumn) => StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Values'>);
     /**
      * Default filter type for date Columns
      *
      * @defaultValue On
      * @gridInfoItem
      */
-    defaultDateColumnFilter?: 'After' | 'Before' | 'On' | 'NotOn' | ((column: AdaptableColumn) => 'After' | 'Before' | 'On' | 'NotOn');
+    defaultDateColumnFilter?: StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'Values'> | ((column: AdaptableColumn) => StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'Values'>);
     /**
      * Whether to open the Filter Form on the Values or Predicates tab
      *

package/src/AdaptableOptions/LayoutOptions.d.ts

@@ -1,3 +1,16 @@
+import { AdaptableApi } from '../Api/AdaptableApi';
+import { AlertDefinition } from '../PredefinedConfig/AlertState';
+import { ConditionalStyle } from '../PredefinedConfig/ConditionalStyleState';
+import { CustomSort } from '../PredefinedConfig/CustomSortState';
+import { FlashingCellDefinition } from '../PredefinedConfig/FlashingCellState';
+import { FormatColumn } from '../PredefinedConfig/FormatColumnState';
+import { PlusMinusNudge } from '../PredefinedConfig/PlusMinusState';
+import { Shortcut } from '../PredefinedConfig/ShortcutState';
+import { BaseSchedule } from '../PredefinedConfig/Common/Schedule';
+import { Layout } from '../PredefinedConfig/LayoutState';
+import { AdaptableModule } from '../PredefinedConfig/Common/Types';
+import { AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
+import { BaseContext } from '../../types';
 /**
  * Options for configuring Layouts; these manage Column visibility, order, sorting, grouping and width
  *
@@ -11,7 +24,9 @@ export interface LayoutOptions {
      */
     includeExpandedRowGroups?: boolean;
     /**
-     * Whether RowGroups display all as expanded, all as closed or dynamically (i.e. saved in Layout)
+     * Whether Row Groups display all as expanded, all as closed or dynamically (i.e. saved in Layout)
+     * @defaultValue 'closed'
+     * @gridInfoItem
      */
     displayRowGroups?: 'dynamic' | 'expanded' | 'closed';
     /**
@@ -43,14 +58,45 @@ export interface LayoutOptions {
      */
     createDefaultLayout?: boolean;
     /**
-     * Options to customize how layout items are shown in Settings Panel
+     * Customize how Layouts are displayed in Settings Panel
+     */
+    viewOptions?: LayoutViewOptions;
+    /**
+     * Checks if the provided AdaptableObject is available in the given Layout
+     */
+    isObjectAvailableInLayout?: (context: IsObjectAvailableInLayoutContext) => boolean;
+    /**
+     * Automatically generate a tag for each existing layout
      */
-    view?: {
-        /**
-         * How many columns to display in the inline layout preview
-         *
-         * @defaultValue 10
-         */
-        maxColumnsToDisplay?: number;
-    };
+    autoGenerateTagsForLayouts?: boolean | ((context: AutoGenerateTagsForLayoutsContext) => AdaptableObjectTag[]);
+}
+/**
+ * Customize how Layouts are displayed in Settings Panel
+ */
+export interface LayoutViewOptions {
+    /**
+     * How many columns to display in inline Layout preview
+     *
+     * @defaultValue 10
+     */
+    maxColumnsToDisplay?: number;
+}
+/**
+ * Context for `LayoutOptions.isObjectAvailableInLayout` method
+ */
+export interface IsObjectAvailableInLayoutContext {
+    abObject: LayoutAssociatedObject;
+    module: AdaptableModule;
+    layout: Layout;
+    adaptableApi: AdaptableApi;
+}
+/**
+ * Types of objects that can be associated with a Layout
+ */
+export declare type LayoutAssociatedObject = AlertDefinition | ConditionalStyle | CustomSort | FlashingCellDefinition | FormatColumn | PlusMinusNudge | Shortcut | BaseSchedule;
+/**
+ * Context for `LayoutOptions.autoGenerateTagsForLayouts` method
+ */
+export interface AutoGenerateTagsForLayoutsContext extends BaseContext {
+    layouts: Layout[];
 }

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -1,8 +1,9 @@
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableFrameworkComponent } from './AdaptableFrameworkComponent';
-import { AdaptableButton, ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
+import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
 import { ToolPanelState } from '../PredefinedConfig/ToolPanelState';
+import { BaseContext } from '../types';
 /**
  * Options related to managing the AdapTable ToolPanel Component
  */
@@ -97,13 +98,13 @@ export interface CustomToolPanel extends AdaptableObject {
 /**
  * Context required by functions when using a ToolPanel Button
  */
-export interface ToolPanelButtonContext extends ButtonContext {
+export interface ToolPanelButtonContext extends BaseContext {
     /**
      * Current ToolPanel State
      */
     toolPanelState: ToolPanelState;
 }
-export interface CustomToolPanelButtonContext extends ButtonContext {
+export interface CustomToolPanelButtonContext extends BaseContext {
     /**
      *The Custom ToolPanel which contains the button
      */

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -2,11 +2,11 @@ import { AdaptableIcon } from '../PredefinedConfig/Common/AdaptableIcon';
 import { DateInputOptions } from './DateInputOptions';
 import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
-import { AdaptableButton, ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
+import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
 import { RowNode } from '@ag-grid-community/all-modules';
-import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
+import { AdaptableObject, AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
 import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
-import { AdaptableApi, GridCell } from '../../types';
+import { AdaptableApi, BaseContext, GridCell } from '../../types';
 /**
  * Options for managing the User Interface of AdapTable
  */
@@ -18,6 +18,7 @@ export interface UserInterfaceOptions {
      * @gridInfoItem
      */
     useCustomMacLikeScrollbars?: boolean;
+    testproperty?: any;
     /**
      * The application icon to appear in Dashboard and elsewhere (e.g. OpenFin notifications)
      *
@@ -70,6 +71,10 @@ export interface UserInterfaceOptions {
      * @gridInfoItem
      */
     styleClassNames?: string[];
+    /**
+     * Optional list of AdaptableObjectTags that can be associated with AdaptableObjects
+     */
+    objectTags?: AdaptableObjectTag[] | ((adaptableApi: AdaptableApi) => AdaptableObjectTag[]);
     /**
      * Optional list of Column Types - used primarily for special columns
      *
@@ -109,13 +114,13 @@ export interface PermittedValues extends BasePermittedValues {
     /**
      * Values to display: either hardcoded list or a function
      */
-    values?: any[] | ((params: PermittedValuesParams) => any[]);
+    values?: any[] | ((context: PermittedValuesContext) => any[]);
 }
 /**
  * Used to define permitted values for inline column editor
  */
 export interface EditLookUpPermittedValues extends BasePermittedValues {
-    values?: any[] | ((params: EditLookUpParams) => any[]);
+    values?: any[] | ((context: EditLookUpContext) => any[]);
 }
 /**
  * Used to define values inside the floating filter and floating filter (quick filter)
@@ -126,19 +131,19 @@ export interface FilterPermittedValues extends BasePermittedValues {
      * @defaultValue false
      */
     suppressFilterSearchBar?: boolean;
-    values: (params: FilterPermittedValuesParams) => any[] | Promise<any[]>;
+    values: (context: FilterPermittedValuesContext) => any[] | Promise<any[]>;
 }
 /**
  * Custom column values for custom sort.
  */
 export interface CustomSortPermittedValues extends BasePermittedValues {
-    values: (params: PermittedValuesParams) => any[] | Promise<any[]>;
+    values: (context: PermittedValuesContext) => any[] | Promise<any[]>;
 }
 /**
  * User to define permitted values when updating cells via bulk update
  */
 export interface BulkUpdatePermittedValues extends BasePermittedValues {
-    values: (params: BulkUpdatePermittedValuesParams) => any[] | Promise<any[]>;
+    values: (context: BulkUpdatePermittedValuesContext) => any[] | Promise<any[]>;
 }
 /**
  * Use PermittedValues instead
@@ -173,7 +178,7 @@ export interface ActionColumn extends AdaptableObject {
 /**
  * Context required by functions when using an Action Column Button
  */
-export interface ActionColumnButtonContext extends ButtonContext {
+export interface ActionColumnButtonContext extends BaseContext {
     /**
      * Action Column in question
      */
@@ -211,10 +216,7 @@ export interface ActionColumnSettings {
      */
     suppressMovable?: boolean;
 }
-export interface BaseParams {
-    adaptableApi: AdaptableApi;
-}
-export interface EditLookUpParams extends BaseParams {
+export interface EditLookUpContext extends BaseContext {
     /**
      * Column displaying the Edit LookUp
      */
@@ -224,13 +226,13 @@ export interface EditLookUpParams extends BaseParams {
      */
     gridCell: GridCell;
 }
-export interface PermittedValuesParams extends BaseParams {
+export interface PermittedValuesContext extends BaseContext {
     /**
      * Column whose values are being displayed
      */
     column: AdaptableColumn;
 }
-export interface FilterPermittedValuesParams extends BaseParams {
+export interface FilterPermittedValuesContext extends BaseContext {
     /**
      * Column hosting the filter form
      */
@@ -240,7 +242,7 @@ export interface FilterPermittedValuesParams extends BaseParams {
      */
     filter: string;
 }
-export interface BulkUpdatePermittedValuesParams extends BaseParams {
+export interface BulkUpdatePermittedValuesContext extends BaseContext {
     /**
      * Column being edited via Bulk Update
      */

package/src/Api/AdaptableApi.d.ts

@@ -203,9 +203,19 @@ export interface AdaptableApi {
     internalApi: InternalApi;
     /**
      * Cleanup method - should be called only when using the vanilla javascript component, as framework components cleanup is performed when the component is destroyed/unmounted.
+     * This destroys the Adaptable instance.
      */
     destroy: (config?: {
         unmount: boolean;
         destroyApi?: boolean;
     }) => void;
+    isDestroyed: () => boolean;
+    /**
+     * Cleanup method that only cleans up this api instance (clears event listeners and sets every property to null), but does not destroy the Adaptable instance.
+     *
+     */
+    internalDestroySelf: (config?: {
+        unmount: boolean;
+        destroyApi?: boolean;
+    }) => void;
 }

package/src/Api/AlertApi.d.ts

@@ -24,7 +24,9 @@ export interface AlertApi {
      * Retrieves all Alert Definitions in Alert State
      * @returns alert definitions
      */
-    getAlertDefinitions(): AlertDefinition[];
+    getAlertDefinitions(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): AlertDefinition[];
     /**
      * Retrieves alert definition by id
      * @param id alert definition id

package/src/Api/ConditionalStyleApi.d.ts

@@ -12,7 +12,9 @@ export interface ConditionalStyleApi {
     /**
      * Gets all Conditional Styles in Adaptable State
      */
-    getAllConditionalStyle(): ConditionalStyle[];
+    getAllConditionalStyle(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): ConditionalStyle[];
     /**
      * Get conditional style by id
      * @param id conditional style id

package/src/Api/ConfigApi.d.ts

@@ -54,7 +54,7 @@ export interface ConfigApi {
      */
     copyUserStateToClipboard(): void;
     /**
-     * Loads supplied user state, replacing (not merging) existing User State.
+     * Loads supplied user state, replacing (NOT merging) existing User(persisted) State.
      * @param state
      */
     loadUserState(state: {
@@ -67,11 +67,11 @@ export interface ConfigApi {
     /**
      * Retrieves the PERSISTED state in Adaptable
      *
-     * @deprecated use {@link getPersistedState} instead
+     * @deprecated use `getPersistedState()` instead
      */
     getAllUserState(): ConfigState[];
     /**
-     * Retrieves the PERSISTED state in Adaptable
+     * Retrieves the persisted state in Adaptable. This is the state that was last stored with the `StatusOptions.persistState()` function.
      */
     getPersistedState(): AdaptablePersistentState;
     /**

package/src/Api/CustomSortApi.d.ts

@@ -10,7 +10,9 @@ export interface CustomSortApi {
     /**
      * Retrieves all Custom Sorts in Adaptable State
      */
-    getAllCustomSort(): CustomSort[];
+    getAllCustomSort(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): CustomSort[];
     /**
      * Retrieves Custom Sort by id
      * @param id Custom Sort id

package/src/Api/EventApi.d.ts

@@ -205,11 +205,25 @@ export interface EventApi {
      * ```
      */
     on(eventName: 'AdaptableReady', callback: (adaptableReadyInfo: AdaptableReadyInfo) => void): VoidFunction;
+    /**
+     * Fired when Adaptable is destroyed
+     * @param eventName - AdaptableDestroy
+     * @param callback - A callback for listening to `AdaptableDestroy`
+     * @returns the unsubscribe function
+     *
+     * @example Use as
+     * ```
+     * adaptableApi.eventApi.on('AdaptableDestroy', () => { .....[do stuff]...})
+     * ```
+     */
+    on(eventName: 'AdaptableDestroy', callback: () => void): VoidFunction;
     /**
      * Unsubscribe from AdaptableReady
      */
     off(eventName: 'AdaptableReady', callback: (adaptableReadyInfo: AdaptableReadyInfo) => void): void;
     emitSync(eventName: 'DashboardChanged', data?: any): any[];
     emitSync(eventName: 'FlashingCellDisplayed', data?: any): any[];
+    emitSync(eventName: 'AdaptableDestroy'): any[];
     emit(eventName: 'AdaptableReady' | 'AlertFired' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'AdaptableStateChanged' | 'DashboardChanged' | 'CellChanged' | 'GridDataChanged' | 'LayoutChanged' | 'LiveDataChanged' | 'SearchChanged' | 'SelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'FDC3MessageSent', data?: any): Promise<any>;
+    destroy(): void;
 }

package/src/Api/Events/LayoutChanged.d.ts

@@ -11,7 +11,7 @@ export interface LayoutChangedInfo extends BaseEventInfo {
     /**
      * Previous Layout State
      */
-    oldLayoutState: LayoutState;
+    oldLayoutState: LayoutState | undefined;
     /**
      * Current Layout State
      */

package/src/Api/ExportApi.d.ts

@@ -34,6 +34,10 @@ export interface ExportApi {
      * @returns export destination
      */
     getDestinationByName(destinationName: ExportDestination | string): ExportDestination | CustomDestination | undefined;
+    /**
+     * Retrieves the current Export destination
+     */
+    getCurrentDestination(): ExportDestination | CustomDestination | undefined;
     /**
      * Retrieves name of currently selected Report
      */
@@ -64,6 +68,18 @@ export interface ExportApi {
      * @param destinationData any custom destination data
      */
     sendReport(reportName: string, destination: 'Excel' | 'CSV' | 'Clipboard' | 'JSON' | string): void;
+    /**
+     * Selects the report in the dashboard and statusbar UI
+     *
+     * @param reportName name of Report to select
+     */
+    selectReport(reportName: string): void;
+    /**
+     * Selects the report destination in the dashboard and statusbar UI
+     *
+     * @param destinationName name of Report to select
+     */
+    selectDestination(destinationName: string): void;
     /**
      * If this AdapTable instance can to export to Excel; if false, the Export to Excel option will not be visible
      */

package/src/Api/FinanceApi.d.ts

@@ -1,10 +1,111 @@
-import { FinancePluginOptions } from '../AdaptableOptions/FinancePluginOptions';
+import { RowNode } from '@ag-grid-community/all-modules';
+import { ContactColumn, ContactIntent, CountryColumn, FDC3Intent, FinancePluginOptions, InstrumentColumn, InstrumentIntent, OrganizationColumn, PositionColumn, PositionIntent } from '../AdaptableOptions/FinancePluginOptions';
+import { ContactContext, ContactListContext, CountryContext, FDC3Context, InstrumentContext, InstrumentListContext, OrganizationContext, PortfolioContext, PositionContext } from '../types';
 /**
- * Provides run-time access to the OpenFin Plugin
+ * Provides run-time access to the Finance Plugin
  */
 export interface FinanceApi {
     /**
-     * Retrieves the OpenFinPlugOptions provided in OpenFin Plugin
+     * Retrieves the FinancePlugOptions provided in the Finance Plugin
      */
     getPluginOptions(): FinancePluginOptions;
+    /**
+     * Creates Instrument Context
+     * @param instrumentColumn Instrument Column to create Context For
+     * @param rowNode Row Node to use for Context Data
+     */
+    createFDC3InstrumentContext(instrumentColumn: InstrumentColumn, rowNode: RowNode): InstrumentContext;
+    /**
+     * Creates Instrumentlist Context
+     * @param instrumentColumn Instrument Column to create Context For
+     * @param rowNode Row Nodes to use for Context Data
+     */
+    createFDC3InstrumentListContext(instrumentColumn: InstrumentColumn, rowNodes: RowNode[]): InstrumentListContext;
+    /**
+     * Creates Position Context
+     * @param instrumentColumn Position Column to create Context For
+     * @param rowNode Row Node to use for Context Data
+     */
+    createFDC3PositionContext(positionColumn: PositionColumn, rowNode: RowNode): PositionContext;
+    /**
+     * Creates Portfolio Context
+     * @param instrumentColumn Position Column to create Context For
+     * @param rowNode Row Nodes to use for Context Data
+     */
+    createFDC3PortfolioContext(positionColumn: PositionColumn, rowNodes: RowNode[]): PortfolioContext;
+    /**
+     * Creates Contact Context
+     * @param instrumentColumn Contact Column to create Context For
+     * @param rowNode Row Node to use for Context Data
+     */
+    createFDC3ContactContext(contactColumn: ContactColumn, rowNode: RowNode): ContactContext;
+    /**
+     * Creates Contact List Context
+     * @param instrumentColumn Contact Column to create Context For
+     * @param rowNode Row Nodes to use for Context Data
+     */
+    createFDC3ContactListContext(contactColumn: ContactColumn, rowNodes: RowNode[]): ContactListContext;
+    /**
+     * Creates Organization Context
+     * @param instrumentColumn Organization Column to create Context For
+     * @param rowNode Row Node to use for Context Data
+     */
+    createFDC3OrganizationContext(organizationColumn: OrganizationColumn, rowNode: RowNode): OrganizationContext;
+    /**
+     * Creates Country Context
+     * @param instrumentColumn Country Column to create Context For
+     * @param rowNode Row Node to use for Context Data
+     */
+    createFDC3CountryContext(countryColumn: CountryColumn, rowNode: RowNode): CountryContext;
+    /**
+     * Gets Instrument Column with given Id
+     * @param instrumentColumnId Column to Look
+     */
+    getInstrumentColumnById(instrumentColumnId: string): InstrumentColumn;
+    /**
+     * Gets Position Column with given Id
+     * @param instrumentColumnId Column to Look
+     */
+    getPositionColumnById(positionColumnId: string): PositionColumn;
+    /**
+     * Gets Contact Column with given Id
+     * @param instrumentColumnId Column to Look
+     */
+    getContactColumnById(contactColumnId: string): ContactColumn;
+    /**
+     * Gets Organization Column with given Id
+     * @param instrumentColumnId Column to Look
+     */
+    getOrganizationColumnById(organizationColumnId: string): OrganizationColumn;
+    /**
+     * Gets Country Column with given Id
+     * @param instrumentColumnId Column to Look
+     */
+    getCountryColumnById(countryColumnId: string): CountryColumn;
+    /**
+     * Publishes an FDC3 Message Event of type `Broadcast`
+     * @param context context for Event
+     */
+    publishBroadcastFDC3MessageEvent(context: FDC3Context): void;
+    /**
+     * Publishes an FDC3 Message Event of type `Raise Event`
+     * @param context context for Event
+     * @param intent FDC3 Intent to Raise
+     */
+    publishRaiseFDC3IntentEvent(context: FDC3Context, intent: FDC3Intent): void;
+    /**
+     * Checks whether the Instrument Intent is valid for Instrument Lists
+     * @param intent FDC3 Intent to check
+     */
+    isValidInstrumentlistIntent(intent: InstrumentIntent): boolean;
+    /**
+     * Checks whether the Contact Intent is valid for Contact Lists
+     * @param intent FDC3 Intent to check
+     */
+    isValidContactlistIntent(intent: ContactIntent): boolean;
+    /**
+     * Checks whether the Position Intent is valid for single Positions (and not Portfolios)
+     * @param intent FDC3 Intent to check
+     */
+    isValidPositionIntent(intent: PositionIntent): boolean;
 }

package/src/Api/FlashingCellApi.d.ts

@@ -14,7 +14,9 @@ export interface FlashingCellApi {
     /**
      * Retrieves all Flashing cell Definitions in Flashing Cell State
      */
-    getFlashingCellDefinitions(): FlashingCellDefinition[];
+    getFlashingCellDefinitions(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): FlashingCellDefinition[];
     /**
      * Retrieves Flashing cell Definition By Id
      * @param id Flashing Cell Definition Id