@openfin/core 28.71.16 → 28.71.19

package/OpenFin.d.ts

@@ -1708,4 +1708,14 @@ declare namespace OpenFin {
         | 'navigateForward'
         | 'navigateBack'
         | 'print';
+
+    export type InteropBrokerDisconnectionEvent = {
+        type: string;
+        topic: string;
+        brokerName: string;
+    };
+
+    export type InteropClientOnDisconnectionListener = (
+        InteropBrokerDisconnectionEvent: InteropBrokerDisconnectionEvent
+    ) => any;
 }

package/package.json

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

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

@@ -315,6 +315,13 @@ export declare class InteropBroker extends Base {
      * @experimental
      */
     handleFiredIntentForContext(contextForIntent: OpenFin.ContextForIntent, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
+    /**
+     * Provides the identity of any Interop Client that disconnects from the Interop Broker. It is meant to be overriden.
+     * @param clientIdentity
+     * @return { Promise<void> }
+     * @tutorial interop.clientDisconnected
+     */
+    clientDisconnected(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

@@ -315,6 +315,9 @@ class InteropBroker extends base_1.Base {
         this.wire.sendAction('interop-broker-join-context-group').catch((e) => {
             // don't expose, analytics-only call
         });
+        if (this.sessionContextGroupMap.has(contextGroupId)) {
+            throw new Error(utils_1.BROKER_ERRORS.joinSessionContextGroupWithJoinContextGroup);
+        }
         if (target) {
             // If an endpointId is provided, use that. This will likely be used by external adapters.
             if (InteropBroker.hasEndpointId(target)) {
@@ -602,6 +605,17 @@ class InteropBroker extends base_1.Base {
         console.warn(warning);
         throw new Error(utils_1.BROKER_ERRORS.fireIntentForContext);
     }
+    /**
+     * Provides the identity of any Interop Client that disconnects from the Interop Broker. It is meant to be overriden.
+     * @param clientIdentity
+     * @return { Promise<void> }
+     * @tutorial interop.clientDisconnected
+     */
+    // eslint-disable-next-line class-methods-use-this
+    async clientDisconnected(clientIdentity) {
+        // This function is called in channel.onDisconnection.
+        // It is meant to be overridden to inform when an Interop Client has been disconnected.
+    }
     /*
     Snapshot APIs
     */
@@ -879,6 +893,7 @@ class InteropBroker extends base_1.Base {
             this.sessionContextGroupMap.forEach((sessionContextGroup) => {
                 sessionContextGroup.onDisconnection(clientIdentity);
             });
+            this.clientDisconnected(clientIdentity);
         });
         // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
         // @ts-ignore

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

@@ -264,4 +264,12 @@ export declare class InteropClient extends Base {
      * @experimental
      */
     joinSessionContextGroup(sessionContextGroupId: string): Promise<OpenFin.SessionContextGroup>;
+    /**
+     * Register a listener that is called when the Interop Client has been disconnected from the Interop Broker.
+     * Only one listener per Interop Client can be set.
+     * @param listener
+     * @return { Promise<void> }
+     * @tutorial interop.onDisconnection
+     */
+    onDisconnection(listener: OpenFin.InteropClientOnDisconnectionListener): Promise<void>;
 }

package/src/api/interop/InteropClient.js

@@ -433,6 +433,23 @@ class InteropClient extends base_1.Base {
             throw error;
         }
     }
+    /**
+     * Register a listener that is called when the Interop Client has been disconnected from the Interop Broker.
+     * Only one listener per Interop Client can be set.
+     * @param listener
+     * @return { Promise<void> }
+     * @tutorial interop.onDisconnection
+     */
+    async onDisconnection(listener) {
+        this.wire.sendAction('interop-client-add-ondisconnection-listener').catch((e) => {
+            // don't expose, analytics-only call
+        });
+        const client = await __classPrivateFieldGet(this, _clientPromise);
+        return client.onDisconnection((event) => {
+            const { uuid } = event;
+            listener({ type: 'interop-broker', topic: 'disconnected', brokerName: uuid });
+        });
+    }
 }
 exports.InteropClient = InteropClient;
 _clientPromise = new WeakMap(), _sessionContextGroups = new WeakMap();

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

@@ -160,7 +160,17 @@ class Fdc3Module extends base_1.Base {
         this.wire.sendAction('fdc3-join-channel').catch((e) => {
             // we do not want to expose this error, just continue if this analytics-only call fails
         });
-        this.fin.me.interop.joinContextGroup(channelId);
+        try {
+            await this.fin.me.interop.joinContextGroup(channelId);
+        }
+        catch (error) {
+            if (error.message === utils_2.BROKER_ERRORS.joinSessionContextGroupWithJoinContextGroup) {
+                throw new Error('The Channel you have tried to join is an App Channel. Custom Channels can only be defined by the Interop Broker through code or manifest configuration. Please use getOrCreateChannel.');
+            }
+            else {
+                throw new Error(error.message);
+            }
+        }
     }
     /**
      * Removes the specified target from a context group.

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

@@ -8,5 +8,6 @@ export declare const BROKER_ERRORS: {
     fireIntentForContext: string;
     getInfoForIntent: string;
     getInfoForIntentsByContext: string;
+    joinSessionContextGroupWithJoinContextGroup: string;
 };
 export declare const wrapIntentHandler: (handler: OpenFin.IntentHandler, handlerId: string) => (intent: OpenFin.Intent) => Promise<void>;

package/src/api/interop/utils.js

@@ -32,7 +32,8 @@ exports.BROKER_ERRORS = {
     fireIntent: exports.generateOverrideError('fireIntent', 'handleFiredIntent'),
     fireIntentForContext: exports.generateOverrideError('fireIntentForContext', 'handleFiredIntentForContext'),
     getInfoForIntent: exports.generateOverrideError('getInfoForIntent', 'handleInfoForIntent'),
-    getInfoForIntentsByContext: exports.generateOverrideError('getInfoForIntentsByContext', 'handleInfoForIntentsByContext')
+    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.'
 };
 exports.wrapIntentHandler = (handler, handlerId) => {
     return async (intent) => {