@openfin/core 28.71.19 → 29.71.1

package/package.json

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

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

@@ -322,6 +322,16 @@ 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>;
     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,18 @@ 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);
+    }
     /*
     Snapshot APIs
     */
@@ -922,6 +934,8 @@ 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));
     }
     /**
      * 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

@@ -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

@@ -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
@@ -333,9 +348,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.js

@@ -9,6 +9,7 @@ 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,13 @@ 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;
 };
 export declare const wrapIntentHandler: (handler: OpenFin.IntentHandler, handlerId: string) => (intent: OpenFin.Intent) => Promise<void>;

package/src/api/interop/utils.js

@@ -24,16 +24,20 @@ 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')
 };
 exports.wrapIntentHandler = (handler, handlerId) => {
     return async (intent) => {