@openfin/core 28.71.19 → 28.71.22

package/OpenFin.d.ts

@@ -524,6 +524,7 @@ declare namespace OpenFin {
         experimental: any;
         fdc3InteropApi?: string;
         enableBeforeUnload: boolean;
+        accelerator?: Partial<OpenFin.Accelerator>;
     };
 
     export type Certificate = {
@@ -1429,6 +1430,7 @@ declare namespace OpenFin {
 
     export type IntentMetadata<TargetType = any> = {
         target?: TargetType;
+        resultType?: string;
     };
 
     export type IntentHandler = (intent: OpenFin.Intent) => void;
@@ -1482,9 +1484,15 @@ declare namespace OpenFin {
         metadata?: MetadataType;
     };
 
-    export type InfoForIntentOptions = {
+    export type InfoForIntentOptions<MetadataType = IntentMetadata> = {
         name: string;
         context?: OpenFin.Context;
+        metadata?: MetadataType;
+    };
+
+    export type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
+        context: OpenFin.Context;
+        metadata?: MetadataType;
     };
 
     export type ProviderIdentity = Identity & {
@@ -1693,11 +1701,11 @@ declare namespace OpenFin {
     export type ExternalApplicationEvents = import('./src/api/events/externalApplication').ExternalApplicationEvents;
 
     export type ContextMenuOptions = {
-        template: Array<PrebuiltContextMenuItems>;
+        template?: Array<PrebuiltContextMenuItem>;
         enabled?: boolean;
     };
 
-    export type PrebuiltContextMenuItems =
+    export type PrebuiltContextMenuItem =
         | 'separator'
         | 'cut'
         | 'copy'

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "28.71.19",
+    "version": "28.71.22",
     "license": "Apache-2.0",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

package/src/api/interop/InteropBroker.d.ts

@@ -304,7 +304,7 @@ export declare class InteropBroker extends Base {
      * @tutorial interop.handleInfoForIntentsByContext
      * @experimental
      */
-    handleInfoForIntentsByContext(context: OpenFin.Context, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
+    handleInfoForIntentsByContext(context: OpenFin.Context | OpenFin.FindIntentsByContextOptions, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
     /**
      * Responsible for resolving an Intent based on a specific Context.
      * Must be overridden.
@@ -322,6 +322,18 @@ export declare class InteropBroker extends Base {
      * @tutorial interop.clientDisconnected
      */
     clientDisconnected(clientIdentity: OpenFin.ClientIdentity): Promise<void>;
+    /**
+     * Responsible for resolving an fdc3.open call.
+     * Must be overridden.
+     * @param { Fdc3OpenOptions } fdc3OpenOptions fdc3.open options
+     * @param { clientIdentity } clientIdentity Identity of the Client making the request.
+     */
+    fdc3HandleOpen({ app, context }: {
+        app: FDC3.TargetApp;
+        context: OpenFin.Context;
+    }, clientIdentity: OpenFin.ClientIdentity): Promise<void>;
+    fdc3HandleFindInstances(app: FDC3v2.AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
+    fdc3HandleGetAppMetadata(app: FDC3v2.AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
     decorateSnapshot(snapshot: OpenFin.Snapshot): OpenFin.Snapshot;
     applySnapshot(snapshot: OpenFin.Snapshot, options: OpenFin.ApplySnapshotOptions): void;
     updateExistingClients(contextGroupStates: OpenFin.ContextGroupStates): void;

package/src/api/interop/InteropBroker.js

@@ -513,7 +513,7 @@ class InteropBroker extends base_1.Base {
      */
     // eslint-disable-next-line class-methods-use-this
     async handleFiredIntent(intent, clientIdentity) {
-        const warning = utils_1.generateOverrideWarning('interopClient.fireIntent', 'fdc3.raiseIntent', 'InteropBroker.handleFiredIntent', clientIdentity);
+        const warning = utils_1.generateOverrideWarning('fdc3.raiseIntent', 'InteropBroker.handleFiredIntent', clientIdentity, 'interopClient.fireIntent');
         console.warn(warning);
         throw new Error(utils_1.BROKER_ERRORS.fireIntent);
     }
@@ -571,7 +571,7 @@ class InteropBroker extends base_1.Base {
      */
     // eslint-disable-next-line class-methods-use-this
     async handleInfoForIntent(options, clientIdentity) {
-        const warning = utils_1.generateOverrideWarning('interopClient.getInfoForIntent', 'fdc3.findIntent', 'InteropBroker.handleInfoForIntent', clientIdentity);
+        const warning = utils_1.generateOverrideWarning('fdc3.findIntent', 'InteropBroker.handleInfoForIntent', clientIdentity, 'interopClient.getInfoForIntent');
         console.warn(warning);
         throw new Error(utils_1.BROKER_ERRORS.getInfoForIntent);
     }
@@ -586,7 +586,7 @@ class InteropBroker extends base_1.Base {
      */
     // eslint-disable-next-line class-methods-use-this
     async handleInfoForIntentsByContext(context, clientIdentity) {
-        const warning = utils_1.generateOverrideWarning('interopClient.getInfoForIntentsByContext', 'fdc3.findIntentsByContext', 'InteropBroker.handleInfoForIntentsByContext', clientIdentity);
+        const warning = utils_1.generateOverrideWarning('fdc3.findIntentsByContext', 'InteropBroker.handleInfoForIntentsByContext', clientIdentity, 'interopClient.getInfoForIntentsByContext');
         console.warn(warning);
         throw new Error(utils_1.BROKER_ERRORS.getInfoForIntentsByContext);
     }
@@ -601,7 +601,7 @@ class InteropBroker extends base_1.Base {
      */
     // eslint-disable-next-line class-methods-use-this
     async handleFiredIntentForContext(contextForIntent, clientIdentity) {
-        const warning = utils_1.generateOverrideWarning('interopClient.fireIntentForContext', 'fdc3.raiseIntentForContext', 'InteropBroker.handleFiredIntentForContext', clientIdentity);
+        const warning = utils_1.generateOverrideWarning('fdc3.raiseIntentForContext', 'InteropBroker.handleFiredIntentForContext', clientIdentity, 'interopClient.fireIntentForContext');
         console.warn(warning);
         throw new Error(utils_1.BROKER_ERRORS.fireIntentForContext);
     }
@@ -616,6 +616,30 @@ class InteropBroker extends base_1.Base {
         // This function is called in channel.onDisconnection.
         // It is meant to be overridden to inform when an Interop Client has been disconnected.
     }
+    /**
+     * Responsible for resolving an fdc3.open call.
+     * Must be overridden.
+     * @param { Fdc3OpenOptions } fdc3OpenOptions fdc3.open options
+     * @param { clientIdentity } clientIdentity Identity of the Client making the request.
+     */
+    // eslint-disable-next-line class-methods-use-this
+    async fdc3HandleOpen({ app, context }, clientIdentity) {
+        const warning = utils_1.generateOverrideWarning('fdc3.open', 'InteropBroker.fdc3HandleOpen', clientIdentity);
+        console.warn(warning);
+        throw new Error(utils_1.BROKER_ERRORS.fdc3Open);
+    }
+    // eslint-disable-next-line class-methods-use-this
+    async fdc3HandleFindInstances(app, clientIdentity) {
+        const warning = utils_1.generateOverrideWarning('fdc3.open', 'InteropBroker.fdc3HandleFindInstances', clientIdentity);
+        console.warn(warning);
+        throw new Error(utils_1.BROKER_ERRORS.fdc3FindInstances);
+    }
+    // eslint-disable-next-line class-methods-use-this
+    async fdc3HandleGetAppMetadata(app, clientIdentity) {
+        const warning = utils_1.generateOverrideWarning('fdc3.getAppMetadata', 'InteropBroker.fdc3HandleGetAppMetadata', clientIdentity);
+        console.warn(warning);
+        throw new Error(utils_1.BROKER_ERRORS.fdc3FindInstances);
+    }
     /*
     Snapshot APIs
     */
@@ -922,6 +946,11 @@ class InteropBroker extends base_1.Base {
         channel.register('intentHandlerRegistered', this.intentHandlerRegistered.bind(this));
         channel.register('removeContextHandler', this.removeContextHandler.bind(this));
         channel.register('sessionContextGroup:createIfNeeded', this.handleJoinSessionContextGroup.bind(this));
+        // fdc3 only methods
+        channel.register('fdc3Open', this.fdc3HandleOpen.bind(this));
+        channel.register('fdc3v2FindIntentsByContext', this.handleInfoForIntentsByContext.bind(this));
+        channel.register('fdc3FindInstances', this.fdc3HandleFindInstances.bind(this));
+        channel.register('fdc3GetAppMetadata', this.fdc3HandleGetAppMetadata.bind(this));
     }
     /**
      * Can be used to completely prevent a connection. Return false to prevent connections. Allows all connections by default.

package/src/api/interop/InteropClient.d.ts

@@ -217,7 +217,7 @@ export declare class InteropClient extends Base {
      * @tutorial interop.registerIntentHandler
      * @experimental
      */
-    registerIntentHandler(handler: OpenFin.IntentHandler, intentName: string): Promise<{
+    registerIntentHandler(handler: OpenFin.IntentHandler, intentName: string, options?: any): Promise<{
         unsubscribe: () => Promise<void>;
     }>;
     /**
@@ -272,4 +272,5 @@ export declare class InteropClient extends Base {
      * @tutorial interop.onDisconnection
      */
     onDisconnection(listener: OpenFin.InteropClientOnDisconnectionListener): Promise<void>;
+    static ferryFdc3Call(interopClient: OpenFin.InteropClient, action: string, payload: any): Promise<any>;
 }

package/src/api/interop/InteropClient.js

@@ -324,7 +324,7 @@ class InteropClient extends base_1.Base {
      * @tutorial interop.registerIntentHandler
      * @experimental
      */
-    async registerIntentHandler(handler, intentName) {
+    async registerIntentHandler(handler, intentName, options) {
         this.wire.sendAction('interop-client-register-intent-handler').catch((e) => {
             // don't expose, this is only for api analytics purposes
         });
@@ -333,7 +333,7 @@ class InteropClient extends base_1.Base {
         const wrappedHandler = utils_1.wrapIntentHandler(handler, handlerId);
         try {
             await client.register(handlerId, wrappedHandler);
-            await client.dispatch('intentHandlerRegistered', { handlerId });
+            await client.dispatch('intentHandlerRegistered', { handlerId, ...options });
         }
         catch (error) {
             throw new Error('Unable to register intent handler');
@@ -450,6 +450,11 @@ class InteropClient extends base_1.Base {
             listener({ type: 'interop-broker', topic: 'disconnected', brokerName: uuid });
         });
     }
+    // used to ferry fdc3-only calls from the fdc3 shim to the Interop Broker
+    static async ferryFdc3Call(interopClient, action, payload) {
+        const client = await __classPrivateFieldGet(interopClient, _clientPromise);
+        return client.dispatch(action, payload);
+    }
 }
 exports.InteropClient = InteropClient;
 _clientPromise = new WeakMap(), _sessionContextGroups = new WeakMap();

package/src/api/interop/fdc3/fdc3-1.2.d.ts

@@ -70,6 +70,20 @@ import { Base } from '../../base';
  *
  * If using a {@link Platform Platform } application, you can set this property in defaultWindowOptions and defaultViewOptions.
  *
+ * In order to ensure that the FDC3 Api is ready before use, you can use the 'fdc3Ready' event fired on the DOM Window object:
+ *
+ * ```js
+ * function fdc3Action() {
+ *     // Make some fdc3 API calls here
+ * }
+ *
+ * if (window.fdc3) {
+ *    fdc3Action();
+ * } else {
+ *    window.addEventListener('fdc3Ready', fdc3Action);
+ * }
+ * ```
+ *
  * @class
  * @alias Fdc3
  * @hideconstructor
@@ -180,7 +194,14 @@ export default class Fdc3Module extends Base implements FDC3.DesktopAgent {
      * @tutorial fdc3.getInfo
      */
     getInfo(): FDC3.ImplementationMetadata;
-    open(): void;
+    /**
+     * Launches an app with target information, which can either be a string or an AppMetadata object.
+     * @param { TargetApp } app
+     * @param { Context } [context]
+     * @return { Promise<void> }
+     * @tutorial fdc3.open
+     */
+    open(app: FDC3.TargetApp, context?: OpenFin.Context): Promise<void>;
     private getCurrentContextGroupInfo;
     private buildChannelObject;
     private buildAppChannelObject;

package/src/api/interop/fdc3/fdc3-1.2.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const base_1 = require("../../base");
 const utils_1 = require("./utils");
 const utils_2 = require("../utils");
+const InteropClient_1 = require("../InteropClient");
 /**
  * @typedef { object } Listener
  * @summary Listener object returned by addContextListener and addIntentListener
@@ -74,6 +75,20 @@ const utils_2 = require("../utils");
  *
  * If using a {@link Platform Platform } application, you can set this property in defaultWindowOptions and defaultViewOptions.
  *
+ * In order to ensure that the FDC3 Api is ready before use, you can use the 'fdc3Ready' event fired on the DOM Window object:
+ *
+ * ```js
+ * function fdc3Action() {
+ *     // Make some fdc3 API calls here
+ * }
+ *
+ * if (window.fdc3) {
+ *    fdc3Action();
+ * } else {
+ *    window.addEventListener('fdc3Ready', fdc3Action);
+ * }
+ * ```
+ *
  * @class
  * @alias Fdc3
  * @hideconstructor
@@ -200,7 +215,9 @@ class Fdc3Module extends base_1.Base {
         const contextHandler = (raisedIntent) => {
             handler(raisedIntent.context);
         };
-        const listener = this.fin.me.interop.registerIntentHandler(contextHandler, intent);
+        const listener = this.fin.me.interop.registerIntentHandler(contextHandler, intent, {
+            fdc3Version: '1.2'
+        });
         return {
             ...listener,
             unsubscribe: () => listener.then((l) => l.unsubscribe())
@@ -333,9 +350,24 @@ class Fdc3Module extends base_1.Base {
             providerVersion: runtimeVersion
         };
     }
-    // eslint-disable-next-line class-methods-use-this
-    open() {
-        throw new utils_1.UnsupportedError('open');
+    /**
+     * Launches an app with target information, which can either be a string or an AppMetadata object.
+     * @param { TargetApp } app
+     * @param { Context } [context]
+     * @return { Promise<void> }
+     * @tutorial fdc3.open
+     */
+    async open(app, context) {
+        this.wire.sendAction('fdc3-open').catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        try {
+            return await InteropClient_1.InteropClient.ferryFdc3Call(fin.me.interop, 'fdc3Open', { app, context });
+        }
+        catch (error) {
+            const errorToThrow = error.message === utils_2.BROKER_ERRORS.fdc3Open ? 'ResolverUnavailable' : error;
+            throw new Error(errorToThrow);
+        }
     }
     // utils
     // eslint-disable-next-line class-methods-use-this

package/src/api/interop/fdc3/fdc3-2.0.d.ts

@@ -0,0 +1,24 @@
+import { Base } from '../../base';
+import Transport from '../../../transport/transport';
+export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
+    private fdc3Module;
+    constructor(wire: Transport);
+    open(app: FDC3v2.AppIdentifier | FDC3.TargetApp, context?: OpenFin.Context): Promise<FDC3v2.AppIdentifier | void>;
+    findInstances(app: FDC3v2.AppIdentifier): Promise<Array<FDC3v2.AppIdentifier>>;
+    getAppMetadata(app: FDC3v2.AppIdentifier): Promise<FDC3.AppMetadata>;
+    broadcast(context: OpenFin.Context): Promise<void>;
+    addContextListener(contextType: string | null, handler: OpenFin.ContextHandler): Promise<FDC3.Listener>;
+    findIntent(intent: string, context?: OpenFin.Context, resultType?: string): Promise<FDC3.AppIntent>;
+    findIntentsByContext(context: OpenFin.Context, resultType?: string): Promise<Array<FDC3.AppIntent>>;
+    raiseIntent(intent: string, context: OpenFin.Context, app?: FDC3v2.AppIdentifier | FDC3.TargetApp): Promise<FDC3.IntentResolution>;
+    raiseIntentForContext(context: OpenFin.Context, app?: FDC3v2.AppIdentifier | FDC3.TargetApp): Promise<FDC3.IntentResolution>;
+    addIntentListener(intent: string, handler: FDC3v2.IntentHandler): Promise<FDC3.Listener>;
+    getOrCreateChannel(channelId: string): Promise<FDC3.Channel>;
+    createPrivateChannel(): Promise<FDC3v2.PrivateChannel | void>;
+    getUserChannels(): Promise<Array<OpenFin.ContextGroupInfo>>;
+    getSystemChannels(): Promise<Array<OpenFin.ContextGroupInfo>>;
+    joinUserChannel(channelId: string): Promise<void>;
+    getCurrentChannel(): Promise<FDC3.Channel | null>;
+    leaveCurrentChannel(): Promise<void>;
+    getInfo(): Promise<FDC3.ImplementationMetadata>;
+}

package/src/api/interop/fdc3/fdc3-2.0.js

@@ -0,0 +1,126 @@
+"use strict";
+// THIS IS NOT PRODUCTION-READY. Until we implement the missing features: getResult, Private Channels and Instance Management we should not document this.
+Object.defineProperty(exports, "__esModule", { value: true });
+const base_1 = require("../../base");
+const utils_1 = require("../utils");
+const InteropClient_1 = require("../InteropClient");
+const fdc3_1_2_1 = require("./fdc3-1.2");
+class Fdc3Module2 extends base_1.Base {
+    constructor(wire) {
+        super(wire);
+        // we get the module for fdc 1.2 here so we can reuse it wherever we can
+        this.fdc3Module = new fdc3_1_2_1.default(this.wire);
+    }
+    async open(app, context) {
+        return this.fdc3Module.open(app, context);
+    }
+    async findInstances(app) {
+        this.wire.sendAction('fdc3-find-instances').catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        try {
+            return await InteropClient_1.InteropClient.ferryFdc3Call(fin.me.interop, 'fdc3FindInstances', app);
+        }
+        catch (error) {
+            const errorToThrow = error.message === utils_1.BROKER_ERRORS.fdc3FindInstances ? 'ResolverUnavailable' : error;
+            throw new Error(errorToThrow);
+        }
+    }
+    async getAppMetadata(app) {
+        this.wire.sendAction('fdc3-get-app-metadata').catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        try {
+            return await InteropClient_1.InteropClient.ferryFdc3Call(fin.me.interop, 'fdc3GetAppMetadata', app);
+        }
+        catch (error) {
+            const errorToThrow = error.message === utils_1.BROKER_ERRORS.fdc3GetAppMetadata ? 'ResolverUnavailable' : error;
+            throw new Error(errorToThrow);
+        }
+    }
+    async broadcast(context) {
+        return this.fdc3Module.broadcast(context);
+    }
+    async addContextListener(contextType, handler) {
+        this.wire.sendAction('fdc3-add-context-listener').catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        let listener;
+        if (typeof contextType === 'function') {
+            console.warn('addContextListener(handler) has been deprecated. Please use addContextListener(null, handler)');
+            listener = await this.fin.me.interop.addContextHandler(contextType);
+        }
+        else {
+            listener = await this.fin.me.interop.addContextHandler(handler, contextType === null ? undefined : contextType);
+        }
+        return listener;
+    }
+    async findIntent(intent, context, resultType) {
+        this.wire.sendAction('fdc3-find-intent').catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        try {
+            return await this.fin.me.interop.getInfoForIntent({ name: intent, context, metadata: { resultType } });
+        }
+        catch (error) {
+            const errorToThrow = error.message === utils_1.BROKER_ERRORS.getInfoForIntent ? 'ResolverUnavailable' : error;
+            throw new Error(errorToThrow);
+        }
+    }
+    async findIntentsByContext(context, resultType) {
+        this.wire.sendAction('fdc3-find-intents-by-context').catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        try {
+            return await InteropClient_1.InteropClient.ferryFdc3Call(fin.me.interop, 'fdc3v2FindIntentsByContext', {
+                context,
+                resultType
+            });
+        }
+        catch (error) {
+            const errorToThrow = error.message === utils_1.BROKER_ERRORS.getInfoForIntentsByContext ? 'ResolverUnavailable' : error;
+            throw new Error(errorToThrow);
+        }
+    }
+    async raiseIntent(intent, context, app) {
+        return this.fdc3Module.raiseIntent(intent, context, app);
+    }
+    async raiseIntentForContext(context, app) {
+        return this.fdc3Module.raiseIntentForContext(context, app);
+    }
+    async addIntentListener(intent, handler) {
+        this.wire.sendAction('fdc3-add-intent-listener').catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        const contextHandler = (raisedIntent) => {
+            handler(raisedIntent.context);
+        };
+        return this.fin.me.interop.registerIntentHandler(contextHandler, intent, { fdc3Version: '2.0' });
+    }
+    async getOrCreateChannel(channelId) {
+        return this.fdc3Module.getOrCreateChannel(channelId);
+    }
+    // eslint-disable-next-line class-methods-use-this
+    async createPrivateChannel() {
+        // private channels will be implemented in another PR
+    }
+    async getUserChannels() {
+        return this.fdc3Module.getSystemChannels();
+    }
+    async getSystemChannels() {
+        return this.fdc3Module.getSystemChannels();
+    }
+    async joinUserChannel(channelId) {
+        return this.fdc3Module.joinChannel(channelId);
+    }
+    async getCurrentChannel() {
+        return this.fdc3Module.getCurrentChannel();
+    }
+    async leaveCurrentChannel() {
+        return this.leaveCurrentChannel();
+    }
+    async getInfo() {
+        return this.fdc3Module.getInfo();
+    }
+}
+exports.default = Fdc3Module2;

package/src/api/interop/fdc3/fdc3.js

@@ -2,13 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerFdc3Shim = exports.versionMap = void 0;
 const fdc3_1_2_1 = require("./fdc3-1.2");
+const fdc3_2_0_1 = require("./fdc3-2.0");
 exports.versionMap = {
-    '1.2': fdc3_1_2_1.default
+    '1.2': fdc3_1_2_1.default,
+    '2.0': fdc3_2_0_1.default
 };
 function registerFdc3Shim(version, transport) {
     if (Object.keys(exports.versionMap).includes(version)) {
         const Api = exports.versionMap[version];
         window.fdc3 = new Api(transport);
+        window.dispatchEvent(new CustomEvent('fdc3Ready'));
     }
     else {
         console.error(`FDC3 API version ${version} is not supported`);

package/src/api/interop/fdc3/utils.d.ts

@@ -1,6 +1,3 @@
-export declare class UnsupportedError extends Error {
-    constructor(apiName: string);
-}
 export declare class UnsupportedChannelApiError extends Error {
     constructor(apiName: string);
 }

package/src/api/interop/fdc3/utils.js

@@ -1,13 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnsupportedChannelApiError = exports.UnsupportedError = void 0;
-class UnsupportedError extends Error {
-    constructor(apiName) {
-        super(apiName);
-        this.message = `${apiName} is not a supported API`;
-    }
-}
-exports.UnsupportedError = UnsupportedError;
+exports.UnsupportedChannelApiError = void 0;
 class UnsupportedChannelApiError extends Error {
     constructor(apiName) {
         super(apiName);

package/src/api/interop/utils.d.ts

@@ -2,12 +2,15 @@ export declare const generateId: () => string;
 export declare const wrapInTryCatch: <T>(f: (...args: any[]) => T, prefix?: string) => (...args: any[]) => T;
 export declare const wrapContextHandler: (handler: OpenFin.ContextHandler, handlerId: string) => (context: OpenFin.Context) => Promise<void>;
 export declare const generateOverrideError: (clientApi: string, brokerApi: string) => string;
-export declare const generateOverrideWarning: (interopClientApi: string, fdc3ClientApi: string, brokerApi: string, identity: OpenFin.ClientIdentity) => string;
+export declare const generateOverrideWarning: (fdc3ClientApi: string, brokerApi: string, identity: OpenFin.ClientIdentity, interopClientApi?: string) => string;
 export declare const BROKER_ERRORS: {
     fireIntent: string;
     fireIntentForContext: string;
     getInfoForIntent: string;
     getInfoForIntentsByContext: string;
     joinSessionContextGroupWithJoinContextGroup: string;
+    fdc3Open: string;
+    fdc3FindInstances: string;
+    fdc3GetAppMetadata: string;
 };
 export declare const wrapIntentHandler: (handler: OpenFin.IntentHandler, handlerId: string) => (intent: OpenFin.Intent) => Promise<void>;

package/src/api/interop/utils.js

@@ -24,16 +24,22 @@ exports.wrapContextHandler = (handler, handlerId) => {
 exports.generateOverrideError = (clientApi, brokerApi) => {
     return `You have tried to to use ${clientApi} but ${brokerApi} has not been overridden in the Interop Broker. Please override this function. Refer to our documentation for more info.`;
 };
-exports.generateOverrideWarning = (interopClientApi, fdc3ClientApi, brokerApi, identity) => {
+exports.generateOverrideWarning = (fdc3ClientApi, brokerApi, identity, interopClientApi) => {
     const { uuid, name } = identity;
-    return `Entity with identity: ${uuid}/${name} has called ${interopClientApi} or ${fdc3ClientApi} but ${brokerApi} has not been overridden.`;
+    const message = interopClientApi
+        ? `Entity with identity: ${uuid}/${name} has called ${interopClientApi} or ${fdc3ClientApi} but ${brokerApi} has not been overridden.`
+        : `Entity with identity: ${uuid}/${name} has called ${fdc3ClientApi} but ${brokerApi} has not been overridden.`;
+    return message;
 };
 exports.BROKER_ERRORS = {
     fireIntent: exports.generateOverrideError('fireIntent', 'handleFiredIntent'),
     fireIntentForContext: exports.generateOverrideError('fireIntentForContext', 'handleFiredIntentForContext'),
     getInfoForIntent: exports.generateOverrideError('getInfoForIntent', 'handleInfoForIntent'),
     getInfoForIntentsByContext: exports.generateOverrideError('getInfoForIntentsByContext', 'handleInfoForIntentsByContext'),
-    joinSessionContextGroupWithJoinContextGroup: 'The Context Group you have tried to join is a Session Context Group. Custom Context Groups can only be defined by the Interop Broker through code or manifest configuration. Please use joinSessionContextGroup.'
+    joinSessionContextGroupWithJoinContextGroup: 'The Context Group you have tried to join is a Session Context Group. Custom Context Groups can only be defined by the Interop Broker through code or manifest configuration. Please use joinSessionContextGroup.',
+    fdc3Open: exports.generateOverrideError('fdc3.open', 'fdc3HandleOpen'),
+    fdc3FindInstances: exports.generateOverrideError('fdc3.findInstances', 'fdc3HandleFindInstances'),
+    fdc3GetAppMetadata: exports.generateOverrideError('fdc3.getAppMetadata', 'fdc3HandleGetAppMetadata')
 };
 exports.wrapIntentHandler = (handler, handlerId) => {
     return async (intent) => {

package/src/api/view/Instance.d.ts

@@ -51,11 +51,27 @@ import UpdatableViewOptions = OpenFin.UpdatableViewOptions;
  * @property {string[]} [contentRedirect.blacklist=[]] List of blacklisted URLs.
  *
  * @property {object} [contextMenuSettings] - _Updatable._
+ * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
  * Configure the context menu when right-clicking on a view.
  * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
  * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
  * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
  *
+ * @property {object} [contextMenuOptions] - _Updatable._
+ * Configure the context menu when right-clicking on a view. Supported menu items:
+ * 'separator'
+ * 'cut'
+ * 'copy'
+ * 'paste'
+ * 'spellCheck'
+ * 'inspect'
+ * 'reload'
+ * 'navigateForward'
+ * 'navigateBack'
+ * 'print'
+ * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
+ * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
+ *
  * @property {any} [customData=""] - _Updatable._
  * A field that the user can attach serializable data to be ferried around with the view options.
  * _When omitted, the default value of this property is the empty string (`""`)._

package/src/api/view/Instance.js

@@ -54,11 +54,27 @@ const window_1 = require("../window");
  * @property {string[]} [contentRedirect.blacklist=[]] List of blacklisted URLs.
  *
  * @property {object} [contextMenuSettings] - _Updatable._
+ * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
  * Configure the context menu when right-clicking on a view.
  * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
  * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
  * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
  *
+ * @property {object} [contextMenuOptions] - _Updatable._
+ * Configure the context menu when right-clicking on a view. Supported menu items:
+ * 'separator'
+ * 'cut'
+ * 'copy'
+ * 'paste'
+ * 'spellCheck'
+ * 'inspect'
+ * 'reload'
+ * 'navigateForward'
+ * 'navigateBack'
+ * 'print'
+ * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
+ * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
+ *
  * @property {any} [customData=""] - _Updatable._
  * A field that the user can attach serializable data to be ferried around with the view options.
  * _When omitted, the default value of this property is the empty string (`""`)._

package/src/api/window/Instance.d.ts

@@ -84,6 +84,7 @@ import WindowEvents = OpenFin.WindowEvents;
  * `Command` + `Shift` + `R` _(Mac)_
  *
  * @property {boolean} [accelerator.zoom=false]
+ * NOTE: It is not recommended to set this value to true for Windows in Platforms as that may lead to unexpected visual shifts in layout.
  * If `true`, enables the zoom keyboard shortcuts:<br>
  * `Ctrl` + `+` _(Zoom In)_<br>
  * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
@@ -160,11 +161,27 @@ import WindowEvents = OpenFin.WindowEvents;
  * Gives access to the devtools for the window.
  *
  * @property {object} [contextMenuSettings] - _Updatable._
+ * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
  * Configure the context menu when right-clicking on a window.
  * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
  * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
  * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
  *
+ * @property {object} [contextMenuOptions] - _Updatable._
+ * Configure the context menu when right-clicking on a window. Supported menu items:
+ * 'separator'
+ * 'cut'
+ * 'copy'
+ * 'paste'
+ * 'spellCheck'
+ * 'inspect'
+ * 'reload'
+ * 'navigateForward'
+ * 'navigateBack'
+ * 'print'
+ * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
+ * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
+ *
  * @property {object} [cornerRounding] - _Updatable._
  * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
  *  average of _height_ and _width_.

package/src/api/window/Instance.js

@@ -91,6 +91,7 @@ const view_1 = require("../view");
  * `Command` + `Shift` + `R` _(Mac)_
  *
  * @property {boolean} [accelerator.zoom=false]
+ * NOTE: It is not recommended to set this value to true for Windows in Platforms as that may lead to unexpected visual shifts in layout.
  * If `true`, enables the zoom keyboard shortcuts:<br>
  * `Ctrl` + `+` _(Zoom In)_<br>
  * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
@@ -167,11 +168,27 @@ const view_1 = require("../view");
  * Gives access to the devtools for the window.
  *
  * @property {object} [contextMenuSettings] - _Updatable._
+ * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
  * Configure the context menu when right-clicking on a window.
  * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
  * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
  * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
  *
+ * @property {object} [contextMenuOptions] - _Updatable._
+ * Configure the context menu when right-clicking on a window. Supported menu items:
+ * 'separator'
+ * 'cut'
+ * 'copy'
+ * 'paste'
+ * 'spellCheck'
+ * 'inspect'
+ * 'reload'
+ * 'navigateForward'
+ * 'navigateBack'
+ * 'print'
+ * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
+ * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
+ *
  * @property {object} [cornerRounding] - _Updatable._
  * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
  *  average of _height_ and _width_.