@adaptabletools/adaptable 16.0.0-canary.3 → 16.0.0-canary.4

package/src/AdaptableOptions/FinancePluginOptions.d.ts

@@ -1,5 +1,5 @@
-import { AdaptableApi, AdaptableIcon, ContextMenuContext, FDC3Context, GridCell } from '../../types';
-import { CustomFDC3Context } from '../PredefinedConfig/Common/FDC3Context';
+import { AdaptableApi, AdaptableIcon, ContextMenuContext, FDC3Context_DEPR, GridCell } from '../../types';
+import { CustomFDC3Context } from '../PredefinedConfig/Common/FDC3Context_DEPR';
 /**
  * Options required for when using the Finance plugin
  */
@@ -50,11 +50,11 @@ export interface FinancePluginOptions {
     /**
      * Called when an intent from `availableIntents` is raised.
      */
-    onFDC3Intent?: (intent: FDC3Intent | CustomFDC3Intent, context: FDC3Context, adaptableApi: AdaptableApi) => void;
+    onFDC3Intent?: (intent: FDC3Intent | CustomFDC3Intent, context: FDC3Context_DEPR, adaptableApi: AdaptableApi) => void;
     /**
      * Called when a context changes.
      */
-    onFDC3Context?: (context: FDC3Context, adaptableApi: AdaptableApi) => void;
+    onFDC3Context?: (context: FDC3Context_DEPR, adaptableApi: AdaptableApi) => void;
 }
 /**
  * An FDC3 Column - will raise FDC3 intents and broadcast FDC3 messages
@@ -280,7 +280,7 @@ export interface RaiseFDC3IntentContext extends ContextMenuContext {
 /**
  * Function that handles FDC3 Context
  */
-export declare type FDC3ContextHandler = (context: FDC3Context) => void;
+export declare type FDC3ContextHandler = (context: FDC3Context_DEPR) => void;
 /**
  * Defines a Desktop Agent which supports FDC3
  */
@@ -288,19 +288,19 @@ export interface FDC3DesktopAgent {
     /**
      * Raises an Intent
      */
-    raiseIntent: (intent: FDC3Intent, context: FDC3Context) => void;
+    raiseIntent: (intent: FDC3Intent, context: FDC3Context_DEPR) => void;
     /**
      * Broadcasts an FDC3 Message
      */
-    broadcast: (context: FDC3Context) => void;
+    broadcast: (context: FDC3Context_DEPR) => void;
     /**
      * Raises an FDC3 Intent for a given Context
      */
-    raiseIntentForContext: (context: FDC3Context) => void;
+    raiseIntentForContext: (context: FDC3Context_DEPR) => void;
     /**
      * Adds an FDC3 Intent Listener
      */
-    addIntentListener: (intent: FDC3Intent | CustomFDC3Intent, listener: (context: FDC3Context) => void) => void;
+    addIntentListener: (intent: FDC3Intent | CustomFDC3Intent, listener: (context: FDC3Context_DEPR) => void) => void;
     /**
     * Adds an FDC3 Context Listener
     */

package/src/AdaptableOptions/GroupingOptions.d.ts

@@ -21,6 +21,14 @@ export interface GroupingOptions<TData = any> {
      * @noCodeItem
      */
     restoreUngroupedColumns?: boolean;
+    /**
+     * Order Row Grouped Columns automatically, using Adaptable State if available (Custom or Column Sort)
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    autoOrderGroupedColumns?: boolean;
 }
 /**
  * Context used when setting a value for Unbalanced Row Groups

package/src/AdaptableOptions/OpenFinPluginOptions.d.ts

@@ -1,5 +1,5 @@
 import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
-import { AdaptableFDC3EventInfo } from '../PredefinedConfig/Common/FDC3Context';
+import { AdaptableFDC3EventInfo } from '../PredefinedConfig/Common/FDC3Context_DEPR';
 /**
  * Options required for when using the OpenFin plugin
  */

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -31,23 +31,23 @@ export interface UserInterfaceOptions<TData = any> {
      */
     dateInputOptions?: DateInputOptions;
     /**
-     * List of values which are permitted (e.g. to show in Filter, Custom Sort etc.)
+     * List of Column values to display (e.g. in Filter, Custom Sort etc.)
      */
     permittedValues?: PermittedValues<TData>[];
     /**
-     * Dropdown values displayed when column is being edited; when not defined defaults to permittedValues
+     * Dropdown values displayed when column is being edited
      */
     editLookUpItems?: EditLookUpPermittedValues<TData>[];
     /**
-     * Custom column values for 'IN' filter; when not defined defaults to permittedValues
+     * Custom column values for Values ('IN') Filter
      */
     filterPermittedValues?: FilterPermittedValues<TData>[];
     /**
-     * Custom column values for defining Custom Sort; when not defined defaults to permittedValues
+     * Custom column values for defining Custom Sort
      */
     customSortPermittedValues?: CustomSortPermittedValues<TData>[];
     /**
-     * Custom column values for editing via bulk-update; when not defined defaults to permittedValues
+     * Custom column values for editing via bulk-update
      */
     bulkUpdatePermittedValues?: BulkUpdatePermittedValues<TData>[];
     /**
@@ -92,7 +92,7 @@ export interface UserInterfaceOptions<TData = any> {
      */
     showAdapTableVersion?: boolean;
     /**
-     * English variant to use in UI labels
+     * English variant to use in AdapTable UI
      *
      * @defaultValue 'GB'
      * @gridInfoItem

package/src/Api/AdaptableApi.d.ts

@@ -41,6 +41,7 @@ import { StyledColumnApi } from './StyledColumnApi';
 import { OptionsApi } from './OptionsApi';
 import { ActionColumnApi } from './ActionColumnApi';
 import { ActionRowApi } from './ActionRowApi';
+import { Fdc3Api } from './Fdc3Api';
 /**
  *
  * The `AdaptableApi` provides developers with run-time access to AdapTable.
@@ -53,8 +54,8 @@ export interface AdaptableApi {
      */
     actionColumnApi: ActionColumnApi;
     /**
-   * Provides access to Action Rows
-   */
+     * Provides access to Action Rows
+     */
     actionRowApi: ActionRowApi;
     /**
      * Provides access to the Alert Module
@@ -220,6 +221,10 @@ export interface AdaptableApi {
      * Manages User Interface Options where colours, styles and permitted values are configured
      */
     userInterfaceApi: UserInterfaceApi;
+    /**
+     * Manages the FDC3 capabilities of AdapTable
+     */
+    fdc3Api: Fdc3Api;
     /**
      * 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.

package/src/Api/EventApi.d.ts

@@ -106,7 +106,7 @@ export interface EventApi {
      */
     off(eventName: 'SelectionChanged', callback: (selectionChangedInfo: SelectionChangedInfo) => void): void;
     /**
-     * Event fired whenever the **selected theme of AdapTable is changed**.
+     * Event fired whenever the selected theme of AdapTable is changed
      * @param eventName ThemeChanged
      * @param callback ThemeChangedInfo which just contains the name of the current Theme
      * @returns the unsubscribe function
@@ -117,9 +117,9 @@ export interface EventApi {
      */
     off(eventName: 'ThemeChanged', callback: (themeChangedInfo: ThemeChangedInfo) => void): void;
     /**
-     * Event fired whenever the a theme has been edited
+     * Event fired whenever a theme has been edited
      * @param eventName ThemeEdited
-     * @param callback ThemeChangedInfo which just contains the name of the current Theme
+     * @param callback ThemeEditedInfo which just contains the name of the current Theme
      * @returns the unsubscribe function
      */
     on(eventName: 'ThemeEdited', callback: (themeEditedInfo: ThemeEditedInfo) => void): VoidFunction;

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

@@ -9,9 +9,3 @@ export interface ThemeChangedInfo extends BaseEventInfo {
      */
     theme: AdaptableTheme | string;
 }
-export interface ThemeEditedInfo extends BaseEventInfo {
-    /**
-     * The has been edited
-     */
-    theme: AdaptableTheme;
-}

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

@@ -0,0 +1,11 @@
+import { AdaptableTheme } from '../../PredefinedConfig/ThemeState';
+import { BaseEventInfo } from './BaseEventInfo';
+/**
+ * Object returned by the `ThemeEdited` event
+ */
+export interface ThemeEditedInfo extends BaseEventInfo {
+    /**
+     * Theme which has been edited
+     */
+    theme: AdaptableTheme;
+}

package/src/Api/Fdc3Api.d.ts

@@ -0,0 +1,83 @@
+import { Fdc3Context, Fdc3ContextType } from '../PredefinedConfig/Common/Fdc3Context';
+import { IRowNode } from '@ag-grid-community/core';
+import { DesktopAgent, IntentResolution, AppIdentifier } from '@finos/fdc3';
+import { Fdc3IntentType } from '../PredefinedConfig/Common/Fdc3Intent';
+/**
+ * Provides run-time access to Alert function and associated State
+ */
+export interface Fdc3Api {
+    /**
+     * Returns the FDC3 Desktop Agent
+     */
+    getDesktopAgent(): DesktopAgent;
+    /**
+     * Returns the human-friendly label for the given Context Type
+     * @param contextType - The FDC3 Context Type
+     */
+    getContextLabel(contextType: Fdc3ContextType): string;
+    /**
+     * Builds FDC3 Context Data based on the given Context Type and Row Node
+     * @param contextType - The FDC3 Context Type
+     * @param rowNode - The Row Node
+     */
+    buildContextDataFromRow(contextType: Fdc3ContextType, rowNode: IRowNode): Fdc3Context;
+    /**
+     * Builds FDC3 Context Data based on the given Context Type and the Row Node with the given Primary Key Value
+     * @param contextType - The FDC3 Context Type
+     * @param primaryKeyValue - The Primary Key Value
+     */
+    buildContextDataForPrimaryKey(contextType: Fdc3ContextType, primaryKeyValue: string | number): Fdc3Context | undefined;
+    /**
+     * Returns the FDC3 Context Type for the given Intent
+     * @param intent - The FDC3 Intent
+     */
+    getPossibleContextTypes(intent: Fdc3IntentType): Fdc3ContextType[];
+    /**
+     * Checks if the given Context Type is compatible with the given Intent
+     * @param contextType - The FDC3 Context Type
+     * @param intent - The FDC3 Intent
+     */
+    isContextCompatibleWithIntent(contextType: Fdc3ContextType, intent: Fdc3IntentType): boolean;
+    /**
+     * Raises an Intent with the given Context from the given Row Node
+     * @param rowNode - The Row Node
+     * @param intent - The FDC3 Intent
+     * @param contextType - The FDC3 Context Type
+     * @param appIdentifier - The App Identifier
+     */
+    raiseIntentFromRow(rowNode: IRowNode, intent: Fdc3IntentType, contextType: Fdc3ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
+    /**
+     * Raises an Intent with the given Context from the given Row Node with the given Primary Key Value
+     * @param primaryKeyValue - The Primary Key Value
+     * @param intent - The FDC3 Intent
+     * @param contextType - The FDC3 Context Type
+     * @param appIdentifier - The App Identifier
+     */
+    raiseIntentFromPrimaryKey(primaryKeyValue: string | number, intent: Fdc3IntentType, contextType: Fdc3ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;
+    /**
+     * Finds and raises an Intent based on the given Context from the given Row Node
+     * @param rowNode - The Row Node
+     * @param contextType - The FDC3 Context Type
+     * @param appIdentifier - The App Identifier
+     */
+    raiseIntentForContextFromRow(rowNode: IRowNode, contextType: Fdc3ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
+    /**
+     * Finds and raises an Intent based on the given Context from the given Row Node with the given Primary Key Value
+     * @param primaryKeyValue - The Primary Key Value
+     * @param contextType - The FDC3 Context Type
+     * @param appIdentifier - The App Identifier
+     */
+    raiseIntentForContextFromPrimaryKey(primaryKeyValue: string | number, contextType: Fdc3ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;
+    /**
+     * Broadcasts the given Context from the given Row Node
+     * @param rowNode - The Row Node
+     * @param contextType - The FDC3 Context Type
+     */
+    broadcastFromRow(rowNode: IRowNode, contextType: Fdc3ContextType): Promise<void>;
+    /**
+     * Broadcasts the given Context from the given Row Node with the given Primary Key Value
+     * @param primaryKeyValue - The Primary Key Value
+     * @param contextType - The FDC3 Context Type
+     */
+    broadcastFromPrimaryKey(primaryKeyValue: string | number, contextType: Fdc3ContextType): Promise<void> | undefined;
+}

package/src/Api/Fdc3Api.js

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

package/src/Api/FinanceApi.d.ts

@@ -1,6 +1,6 @@
 import { IRowNode } from '@ag-grid-community/core';
 import { ContactColumn, ContactIntent, CountryColumn, CustomFDC3Column, CustomFDC3Intent, FDC3Intent, FinancePluginOptions, InstrumentColumn, InstrumentIntent, OrganizationColumn, PositionColumn, PositionIntent } from '../AdaptableOptions/FinancePluginOptions';
-import { ContactContext, ContactListContext, ContextData, CountryContext, FDC3Context, InstrumentContext, InstrumentListContext, OrganizationContext, PortfolioContext, PositionContext } from '../types';
+import { ContactContextDepr, ContactListContextDepr, ContextDataDepr, CountryContextDepr, FDC3Context_DEPR, InstrumentContextDepr, InstrumentListContextDepr, OrganizationContextDepr, PortfolioContextDepr, PositionContextDepr } from '../types';
 /**
  * Provides run-time access to the Finance Plugin
  */
@@ -15,56 +15,56 @@ export interface FinanceApi {
      * @param rowNode Row Node to use for Context Data
      * @param data custom Context Data
      */
-    createFDC3InstrumentContext(instrumentColumn: InstrumentColumn, rowNode: IRowNode, data?: ContextData): InstrumentContext;
+    createFDC3InstrumentContext(instrumentColumn: InstrumentColumn, rowNode: IRowNode, data?: ContextDataDepr): InstrumentContextDepr;
     /**
      * 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: IRowNode[], data?: ContextData): InstrumentListContext;
+    createFDC3InstrumentListContext(instrumentColumn: InstrumentColumn, rowNodes: IRowNode[], data?: ContextDataDepr): InstrumentListContextDepr;
     /**
      * 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: IRowNode, data?: ContextData): PositionContext;
+    createFDC3PositionContext(positionColumn: PositionColumn, rowNode: IRowNode, data?: ContextDataDepr): PositionContextDepr;
     /**
      * 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: IRowNode[], data?: ContextData): PortfolioContext;
+    createFDC3PortfolioContext(positionColumn: PositionColumn, rowNodes: IRowNode[], data?: ContextDataDepr): PortfolioContextDepr;
     /**
      * 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: IRowNode, data?: ContextData): ContactContext;
+    createFDC3ContactContext(contactColumn: ContactColumn, rowNode: IRowNode, data?: ContextDataDepr): ContactContextDepr;
     /**
      * 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: IRowNode[], data?: ContextData): ContactListContext;
+    createFDC3ContactListContext(contactColumn: ContactColumn, rowNodes: IRowNode[], data?: ContextDataDepr): ContactListContextDepr;
     /**
      * 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: IRowNode, data?: ContextData): OrganizationContext;
+    createFDC3OrganizationContext(organizationColumn: OrganizationColumn, rowNode: IRowNode, data?: ContextDataDepr): OrganizationContextDepr;
     /**
      * 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: IRowNode, data?: ContextData): CountryContext;
+    createFDC3CountryContext(countryColumn: CountryColumn, rowNode: IRowNode, data?: ContextDataDepr): CountryContextDepr;
     /**
      * Gets Instrument Column with given Id
      * @param instrumentColumnId Column to Look
@@ -95,18 +95,18 @@ export interface FinanceApi {
      * Publishes an FDC3 Message Event of type `Broadcast`
      * @param context context for Event
      */
-    publishBroadcastFDC3MessageEvent(context: FDC3Context): void;
+    publishBroadcastFDC3MessageEvent(context: FDC3Context_DEPR): void;
     /**
      * Publishes an FDC3 Message Event of type `RaiseIntentForContext`
      * @param context context for Event
      */
-    publishRaiseFDC3IntentForContextEvent(context: FDC3Context): void;
+    publishRaiseFDC3IntentForContextEvent(context: FDC3Context_DEPR): 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 | CustomFDC3Intent): void;
+    publishRaiseFDC3IntentEvent(context: FDC3Context_DEPR, intent: FDC3Intent | CustomFDC3Intent): void;
     /**
      * Checks whether the Instrument Intent is valid for Instrument Lists
      * @param intent FDC3 Intent to check

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

@@ -42,6 +42,7 @@ import { StatusBarApi } from '../StatusBarApi';
 import { StyledColumnApi } from '../StyledColumnApi';
 import { ActionColumnApi } from '../ActionColumnApi';
 import { ActionRowApi } from '../ActionRowApi';
+import { Fdc3Api } from '../Fdc3Api';
 export declare class AdaptableApiImpl implements AdaptableApi {
     protected adaptable: IAdaptable;
     internalApi: AdaptableInternalApi;
@@ -88,6 +89,7 @@ export declare class AdaptableApiImpl implements AdaptableApi {
     dataChangeHistoryApi: DataChangeHistoryApi;
     chartingApi: ChartingApi;
     statusBarApi: StatusBarApi;
+    fdc3Api: Fdc3Api;
     private destroyed;
     constructor(adaptable: IAdaptable);
     /**

package/src/Api/Implementation/AdaptableApiImpl.js

@@ -45,6 +45,7 @@ const StyledColumnApiImpl_1 = require("./StyledColumnApiImpl");
 const CalendarApiImpl_1 = require("./CalendarApiImpl");
 const EntitlementApiImpl_1 = require("./EntitlementApiImpl");
 const OptionsApiImpl_1 = require("./OptionsApiImpl");
+const Fdc3ApiImpl_1 = require("./Fdc3ApiImpl");
 class AdaptableApiImpl {
     constructor(adaptable) {
         this.adaptable = adaptable;
@@ -93,6 +94,7 @@ class AdaptableApiImpl {
         this.dataChangeHistoryApi = new DataChangeHistoryApiImpl_1.DataChangeHistoryApiImpl(adaptable);
         this.chartingApi = new ChartingApiImpl_1.ChartingApiImpl(adaptable);
         this.statusBarApi = new StatusBarApiImpl_1.StatusBarApiImpl(adaptable);
+        this.fdc3Api = new Fdc3ApiImpl_1.Fdc3ApiImpl(adaptable);
         // adaptable internal api
         this.internalApi = new AdaptableInternalApi_1.AdaptableInternalApi(adaptable);
     }
@@ -144,6 +146,7 @@ class AdaptableApiImpl {
         this.themeApi = null;
         this.toolPanelApi = null;
         this.userInterfaceApi = null;
+        this.fdc3Api = null;
     }
     destroy(config) {
         this.adaptable.destroy(config);

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

@@ -19,6 +19,8 @@ import { GroupingOptions } from '../../AdaptableOptions/GroupingOptions';
 import { CustomSortOptions } from '../../AdaptableOptions/CustomSortOptions';
 import { ExpressionApi } from '../ExpressionApi';
 import { CalendarOptions } from '../../AdaptableOptions/CalendarOptions';
+import { Fdc3Api } from '../Fdc3Api';
+import { Fdc3Options } from '../../AdaptableOptions/Fdc3Options';
 export declare abstract class ApiBase {
     protected adaptable: IAdaptable;
     /**
@@ -89,6 +91,7 @@ export declare abstract class ApiBase {
     protected getEntitlementOptions(): EntitlementOptions;
     protected getFlashingCellOptions(): FlashingCellOptions;
     protected getSettingsPanelOptions(): SettingsPanelOptions;
+    protected getFdc3Options(): Fdc3Options;
     protected getAdaptableApi(): AdaptableApi;
     protected getActionColumnApi(): ActionColumnApi;
     protected getActionRowApi(): ActionRowApi;
@@ -132,6 +135,7 @@ export declare abstract class ApiBase {
     protected getDataChangeHistoryApi(): DataChangeHistoryApi;
     protected getChartingApi(): ChartingApi;
     protected getStatusBarApi(): StatusBarApi;
+    protected getFdc3Api(): Fdc3Api;
     destroy(): void;
 }
 /**

package/src/Api/Implementation/ApiBase.js

@@ -183,6 +183,9 @@ class ApiBase {
     getSettingsPanelOptions() {
         return this.adaptable.adaptableOptions.settingsPanelOptions;
     }
+    getFdc3Options() {
+        return this.adaptable.adaptableOptions.fdc3Options;
+    }
     getAdaptableApi() {
         return this.adaptable.api;
     }
@@ -312,6 +315,9 @@ class ApiBase {
     getStatusBarApi() {
         return this.getAdaptableApi().statusBarApi;
     }
+    getFdc3Api() {
+        return this.getAdaptableApi().fdc3Api;
+    }
     destroy() {
         delete this.adaptable;
     }

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

@@ -0,0 +1,26 @@
+import { IRowNode } from '@ag-grid-community/core';
+import { DesktopAgent, IntentResolution } from '@finos/fdc3';
+import { ApiBase } from './ApiBase';
+import { Fdc3Api } from '../Fdc3Api';
+import { Fdc3InternalApi } from '../Internal/Fdc3InternalApi';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { Fdc3Context, Fdc3ContextType } from '../../PredefinedConfig/Common/Fdc3Context';
+import { Fdc3IntentType } from '../../PredefinedConfig/Common/Fdc3Intent';
+import { AppIdentifier } from '@finos/fdc3/dist/api/AppIdentifier';
+export declare class Fdc3ApiImpl extends ApiBase implements Fdc3Api {
+    internalApi: Fdc3InternalApi;
+    constructor(adaptable: IAdaptable);
+    getDesktopAgent(): DesktopAgent;
+    buildContextDataFromRow(contextType: Fdc3ContextType, rowNode: IRowNode): Fdc3Context;
+    buildContextDataForPrimaryKey(contextType: Fdc3ContextType, primaryKeyValue: string | number): Fdc3Context | undefined;
+    getPossibleContextTypes(intent: Fdc3IntentType): Fdc3ContextType[];
+    isContextCompatibleWithIntent(contextType: Fdc3ContextType, intent: Fdc3IntentType): boolean;
+    raiseIntentFromPrimaryKey(primaryKeyValue: string | number, intent: Fdc3IntentType, contextType: Fdc3ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;
+    raiseIntentFromRow(rowNode: IRowNode, intent: Fdc3IntentType, contextType: Fdc3ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
+    raiseIntentForContextFromRow(rowNode: IRowNode, contextType: Fdc3ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
+    raiseIntentForContextFromPrimaryKey(primaryKeyValue: string | number, contextType: Fdc3ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;
+    broadcastFromRow(rowNode: IRowNode, contextType: Fdc3ContextType): Promise<void>;
+    broadcastFromPrimaryKey(primaryKeyValue: string | number, contextType: Fdc3ContextType): Promise<void> | undefined;
+    getContextLabel(contextType: Fdc3ContextType): string;
+    private getFdc3Service;
+}

package/src/Api/Implementation/Fdc3ApiImpl.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Fdc3ApiImpl = void 0;
+const ApiBase_1 = require("./ApiBase");
+const Fdc3InternalApi_1 = require("../Internal/Fdc3InternalApi");
+const Fdc3Context_1 = require("../../PredefinedConfig/Common/Fdc3Context");
+const Fdc3Intent_1 = require("../../PredefinedConfig/Common/Fdc3Intent");
+class Fdc3ApiImpl extends ApiBase_1.ApiBase {
+    constructor(adaptable) {
+        super(adaptable);
+        this.internalApi = new Fdc3InternalApi_1.Fdc3InternalApi(adaptable);
+    }
+    getDesktopAgent() {
+        return this.getFdc3Service().getDesktopAgent();
+    }
+    buildContextDataFromRow(contextType, rowNode) {
+        return this.internalApi.mapRowToContextData(contextType, rowNode);
+    }
+    buildContextDataForPrimaryKey(contextType, primaryKeyValue) {
+        const rowNode = this.getGridApi().getRowNodeForPrimaryKey(primaryKeyValue);
+        if (!rowNode) {
+            this.logWarn(`No row found for primary key value '${primaryKeyValue}'`);
+            return undefined;
+        }
+        return this.buildContextDataFromRow(contextType, rowNode);
+    }
+    getPossibleContextTypes(intent) {
+        var _a;
+        const compatibleContexts = (_a = Fdc3Intent_1.Fdc3IntentConfiguration[intent]) === null || _a === void 0 ? void 0 : _a.contexts;
+        return compatibleContexts ? [...compatibleContexts] : [];
+    }
+    isContextCompatibleWithIntent(contextType, intent) {
+        return this.getPossibleContextTypes(intent).includes(contextType);
+    }
+    raiseIntentFromPrimaryKey(primaryKeyValue, intent, contextType, appIdentifier) {
+        const rowNode = this.getGridApi().getRowNodeForPrimaryKey(primaryKeyValue);
+        if (!rowNode) {
+            this.logWarn(`No row found for primary key value '${primaryKeyValue}'`);
+            return undefined;
+        }
+        return this.raiseIntentFromRow(rowNode, intent, contextType, appIdentifier);
+    }
+    raiseIntentFromRow(rowNode, intent, contextType, appIdentifier) {
+        const contextData = this.buildContextDataFromRow(contextType, rowNode);
+        return this.getFdc3Service().raiseIntent(intent, contextData, appIdentifier);
+    }
+    raiseIntentForContextFromRow(rowNode, contextType, appIdentifier) {
+        const contextData = this.buildContextDataFromRow(contextType, rowNode);
+        return this.getFdc3Service().raiseIntentForContext(contextData, appIdentifier);
+    }
+    raiseIntentForContextFromPrimaryKey(primaryKeyValue, contextType, appIdentifier) {
+        const rowNode = this.getGridApi().getRowNodeForPrimaryKey(primaryKeyValue);
+        if (!rowNode) {
+            this.logWarn(`No row found for primary key value '${primaryKeyValue}'`);
+            return undefined;
+        }
+        return this.raiseIntentForContextFromRow(rowNode, contextType, appIdentifier);
+    }
+    broadcastFromRow(rowNode, contextType) {
+        const contextData = this.buildContextDataFromRow(contextType, rowNode);
+        return this.getFdc3Service().broadcast(contextData);
+    }
+    broadcastFromPrimaryKey(primaryKeyValue, contextType) {
+        const rowNode = this.getGridApi().getRowNodeForPrimaryKey(primaryKeyValue);
+        if (!rowNode) {
+            this.logWarn(`No row found for primary key value '${primaryKeyValue}'`);
+            return undefined;
+        }
+        return this.broadcastFromRow(rowNode, contextType);
+    }
+    getContextLabel(contextType) {
+        var _a;
+        return (_a = Fdc3Context_1.ContextLabels[contextType]) !== null && _a !== void 0 ? _a : contextType;
+    }
+    getFdc3Service() {
+        return this.adaptable.api.internalApi.getFdc3Service();
+    }
+}
+exports.Fdc3ApiImpl = Fdc3ApiImpl;

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

@@ -2,6 +2,7 @@ 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 { GroupingOptions } from '../../AdaptableOptions/GroupingOptions';
 import { CustomSortOptions } from '../../AdaptableOptions/CustomSortOptions';
+import { Fdc3Options } from '../../AdaptableOptions/Fdc3Options';
 export declare class OptionsApiImpl extends ApiBase implements OptionsApi {
     getAdaptableId(): string;
     getAdaptableStateKey(): string;
@@ -39,4 +40,5 @@ export declare class OptionsApiImpl extends ApiBase implements OptionsApi {
     getEntitlementOptions(): EntitlementOptions;
     getFlashingCellOptions(): FlashingCellOptions;
     getSettingsPanelOptions(): SettingsPanelOptions;
+    getFdc3Options(): Fdc3Options;
 }

package/src/Api/Implementation/OptionsApiImpl.js

@@ -111,5 +111,8 @@ class OptionsApiImpl extends ApiBase_1.ApiBase {
     getSettingsPanelOptions() {
         return this.getOptions().settingsPanelOptions;
     }
+    getFdc3Options() {
+        return this.adaptable.adaptableOptions.fdc3Options;
+    }
 }
 exports.OptionsApiImpl = OptionsApiImpl;

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

@@ -10,4 +10,6 @@ export declare class QuickSearchApiImpl extends ApiBase implements QuickSearchAp
     getQuickSearchStyle(): AdaptableStyle;
     setQuickSearchStyle(style: AdaptableStyle): void;
     openQuickSearchSettingsPanel(): void;
+    showFloatingQuickSearch(): void;
+    hideFloatingQuickSearch(): void;
 }

package/src/Api/Implementation/QuickSearchApiImpl.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.QuickSearchApiImpl = void 0;
 const tslib_1 = require("tslib");
 const QuickSearchRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/QuickSearchRedux"));
+const SystemRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/SystemRedux"));
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 const ApiBase_1 = require("./ApiBase");
 class QuickSearchApiImpl extends ApiBase_1.ApiBase {
@@ -27,5 +28,11 @@ class QuickSearchApiImpl extends ApiBase_1.ApiBase {
     openQuickSearchSettingsPanel() {
         this.showModulePopup(ModuleConstants.QuickSearchModuleId);
     }
+    showFloatingQuickSearch() {
+        this.dispatchAction(SystemRedux.SystemQuickSearchFloatingVisibility(true));
+    }
+    hideFloatingQuickSearch() {
+        this.dispatchAction(SystemRedux.SystemQuickSearchFloatingVisibility(false));
+    }
 }
 exports.QuickSearchApiImpl = QuickSearchApiImpl;