@openfin/core 31.74.21 → 31.74.23

package/src/api/interappbus/channel/index.js

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _Channel_connectionManager;
+var _Channel_connectionManager, _Channel_internalEmitter, _Channel_readyToConnect;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Channel = void 0;
 /* eslint-disable no-console */
@@ -18,16 +18,29 @@ const client_1 = require("./client");
 const provider_1 = require("./provider");
 const base_1 = require("../../base");
 const connection_manager_1 = require("./connection-manager");
-// eslint-disable-next-line @typescript-eslint/no-empty-function
-const noop = () => { };
+const events_1 = require("events");
+const lazy_1 = require("../../../util/lazy");
 class Channel extends base_1.EmitterBase {
     constructor(wire) {
         super(wire, 'channel');
         _Channel_connectionManager.set(this, void 0);
+        _Channel_internalEmitter.set(this, new events_1.EventEmitter());
+        // OpenFin API has not been injected at construction time, *must* wait for API to be ready.
+        _Channel_readyToConnect.set(this, new lazy_1.AsyncRetryableLazy(async () => {
+            await Promise.all([
+                this.on('disconnected', (eventPayload) => {
+                    client_1.default.handleProviderDisconnect(eventPayload);
+                }),
+                this.on('connected', (...args) => {
+                    __classPrivateFieldGet(this, _Channel_internalEmitter, "f").emit('connected', ...args);
+                })
+            ]).catch(() => new Error('error setting up channel connection listeners'));
+        }));
         __classPrivateFieldSet(this, _Channel_connectionManager, new connection_manager_1.ConnectionManager(wire), "f");
-        this.on('disconnected', (eventPayload) => {
-            client_1.default.handleProviderDisconnect(eventPayload);
-        }).catch((e) => console.error('Error setting up a disconnected listener:', e));
+    }
+    async channelExists(channelName) {
+        const channels = await this.getAllChannels();
+        return channels.some((providerIdentity) => providerIdentity.channelName === channelName);
     }
     async getAllChannels() {
         return this.wire.sendAction('get-all-channels').then(({ payload }) => payload.data);
@@ -38,47 +51,39 @@ class Channel extends base_1.EmitterBase {
     async onChannelDisconnect(listener) {
         await this.on('disconnected', listener);
     }
-    async connect(channelName, options) {
+    async connect(channelName, options = {}) {
+        // Make sure we don't connect before listeners are set up
+        // This also errors if we're not in OpenFin, ensuring we don't run unnecessary code
+        await __classPrivateFieldGet(this, _Channel_readyToConnect, "f").getValue();
         if (!channelName || typeof channelName !== 'string') {
             throw new Error('Please provide a channelName string to connect to a channel.');
         }
-        const opts = Object.assign(this.wire.environment.getDefaultChannelOptions().connect, options || {});
-        let resolver = noop;
-        let listener = noop;
-        const waitResponse = new Promise((resolve) => {
-            resolver = resolve;
-            listener = (payload) => {
-                if (channelName === payload.channelName) {
-                    this.removeListener('connected', listener);
-                    resolve(this.connect(channelName, opts));
-                }
-            };
-            this.on('connected', listener);
-        });
+        const opts = { wait: true, ...this.wire.environment.getDefaultChannelOptions().connect, ...options };
+        const shouldWait = opts.wait;
+        if (shouldWait) {
+            const channelExists = await this.channelExists(channelName);
+            if (!channelExists) {
+                console.warn(`Channel not found for channelName: ${channelName}, waiting for channel connection.`);
+                await new Promise((resolve) => {
+                    const connectedListener = (payload) => {
+                        if (channelName === payload.channelName) {
+                            __classPrivateFieldGet(this, _Channel_internalEmitter, "f").removeListener('connected', connectedListener);
+                            resolve();
+                        }
+                    };
+                    __classPrivateFieldGet(this, _Channel_internalEmitter, "f").on('connected', connectedListener);
+                });
+            }
+        }
         try {
             const { offer, rtc: rtcPacket } = await __classPrivateFieldGet(this, _Channel_connectionManager, "f").createClientOffer(opts);
-            let connectionUrl;
-            const entityType = this.wire.environment.getCurrentEntityType();
-            if (entityType === 'iframe') {
-                // @ts-expect-error
-                // TODO: type this correctly (frame types are broken)
-                connectionUrl = (await this.fin.me.getInfo()).url;
-            }
-            else if (entityType === 'window' || entityType === 'view') {
-                connectionUrl = (await this.fin.me.getInfo()).url;
-            }
-            const res = await this.wire.sendAction('connect-to-channel', {
+            const connectionUrl = (await this.fin.me.getInfo()).url;
+            const { payload: { data: routingInfo } } = await this.wire.sendAction('connect-to-channel', {
                 channelName,
                 ...opts,
                 offer,
                 connectionUrl
             });
-            const { payload: { data: routingInfo } } = res;
-            // If there isn't a matching channel, the above sendAction call will error out and go to catch, skipping the logic below.
-            if (resolver) {
-                resolver();
-            }
-            this.removeListener('connected', listener);
             const strategy = await __classPrivateFieldGet(this, _Channel_connectionManager, "f").createClientStrategy(rtcPacket, routingInfo);
             const channel = new client_1.default(routingInfo, this.wire, strategy);
             // It is the client's responsibility to handle endpoint disconnection to the provider.
@@ -97,18 +102,13 @@ class Channel extends base_1.EmitterBase {
             });
             return channel;
         }
-        catch (e) {
-            const shouldWait = { wait: true, ...opts }.wait;
+        catch (error) {
             const internalNackMessage = 'internal-nack';
-            if (shouldWait && e.message && e.message.includes(internalNackMessage)) {
-                console.warn(`Channel not found for channelName: ${channelName}, waiting for channel connection.`);
-                return waitResponse;
-            }
-            if (e.message === internalNackMessage) {
-                throw new Error(`No channel found for channelName: ${channelName}`);
+            if (error.message.includes(internalNackMessage)) {
+                throw new Error(`No channel found for channelName: ${channelName}.`);
             }
             else {
-                throw new Error(e);
+                throw new Error(error);
             }
         }
     }
@@ -129,4 +129,4 @@ class Channel extends base_1.EmitterBase {
     }
 }
 exports.Channel = Channel;
-_Channel_connectionManager = new WeakMap();
+_Channel_connectionManager = new WeakMap(), _Channel_internalEmitter = new WeakMap(), _Channel_readyToConnect = new WeakMap();

package/src/api/interappbus/channel/protocols/classic/strategy.js

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _ClassicStrategy_wire, _ClassicStrategy_endpointIdentityMap;
+var _ClassicStrategy_wire, _ClassicStrategy_endpointIdentityMap, _ClassicStrategy_pendingMessagesByEndpointId;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClassicInfo = exports.ClassicStrategy = void 0;
 /*
@@ -26,7 +26,11 @@ class ClassicStrategy {
         // Store full endpointIdentity by endpointId of all known endpoints for this strategy instance.
         // (clients will only have 1: the provider, the provider will have all clients)
         _ClassicStrategy_endpointIdentityMap.set(this, new Map());
+        // Store a set of cancellable promises to be able to reject them when client
+        // connection problems occur
+        _ClassicStrategy_pendingMessagesByEndpointId.set(this, new Map);
         this.send = async (endpointId, action, payload) => {
+            var _a;
             const to = __classPrivateFieldGet(this, _ClassicStrategy_endpointIdentityMap, "f").get(endpointId);
             if (!to) {
                 throw new Error(`Could not locate routing info for endpoint ${endpointId}`);
@@ -38,20 +42,27 @@ class ClassicStrategy {
                 delete cleanId.endpointId;
             }
             delete cleanId.isLocalEndpointId;
-            const raw = await __classPrivateFieldGet(this, _ClassicStrategy_wire, "f")
+            // grab the promise before awaiting it to save in our pending messages map
+            const p = __classPrivateFieldGet(this, _ClassicStrategy_wire, "f")
                 .sendAction('send-channel-message', {
                 ...cleanId,
                 providerIdentity: this.providerIdentity,
                 action,
                 payload
-            })
-                .catch((reason) => {
-                throw new Error(reason.message);
+            });
+            (_a = __classPrivateFieldGet(this, _ClassicStrategy_pendingMessagesByEndpointId, "f").get(endpointId)) === null || _a === void 0 ? void 0 : _a.add(p);
+            const raw = await p.catch((error) => {
+                throw new Error(error.message);
+            }).finally(() => {
+                var _a;
+                // clean up the pending promise
+                (_a = __classPrivateFieldGet(this, _ClassicStrategy_pendingMessagesByEndpointId, "f").get(endpointId)) === null || _a === void 0 ? void 0 : _a.delete(p);
             });
             return raw.payload.data.result;
         };
         this.close = async () => {
             this.messageReceiver.removeEndpoint(this.providerIdentity.channelId, this.endpointId);
+            [...__classPrivateFieldGet(this, _ClassicStrategy_endpointIdentityMap, "f").keys()].forEach((id) => this.closeEndpoint(id));
             __classPrivateFieldSet(this, _ClassicStrategy_endpointIdentityMap, new Map(), "f");
         };
         __classPrivateFieldSet(this, _ClassicStrategy_wire, wire, "f");
@@ -63,13 +74,20 @@ class ClassicStrategy {
         this.messageReceiver.addEndpoint(listener, this.providerIdentity.channelId, this.endpointId);
     }
     async closeEndpoint(endpointId) {
+        const id = __classPrivateFieldGet(this, _ClassicStrategy_endpointIdentityMap, "f").get(endpointId);
         __classPrivateFieldGet(this, _ClassicStrategy_endpointIdentityMap, "f").delete(endpointId);
+        const pendingSet = __classPrivateFieldGet(this, _ClassicStrategy_pendingMessagesByEndpointId, "f").get(endpointId);
+        pendingSet === null || pendingSet === void 0 ? void 0 : pendingSet.forEach((p) => {
+            const errorMsg = `Channel connection with identity uuid: ${id === null || id === void 0 ? void 0 : id.uuid} / name: ${id === null || id === void 0 ? void 0 : id.name} / endpointId: ${endpointId} no longer connected.`;
+            p.cancel(new Error(errorMsg));
+        });
     }
     isEndpointConnected(endpointId) {
         return __classPrivateFieldGet(this, _ClassicStrategy_endpointIdentityMap, "f").has(endpointId);
     }
     addEndpoint(endpointId, payload) {
         __classPrivateFieldGet(this, _ClassicStrategy_endpointIdentityMap, "f").set(endpointId, payload.endpointIdentity);
+        __classPrivateFieldGet(this, _ClassicStrategy_pendingMessagesByEndpointId, "f").set(endpointId, new Set());
     }
     isValidEndpointPayload(payload) {
         var _a, _b;
@@ -78,6 +96,6 @@ class ClassicStrategy {
     }
 }
 exports.ClassicStrategy = ClassicStrategy;
-_ClassicStrategy_wire = new WeakMap(), _ClassicStrategy_endpointIdentityMap = new WeakMap();
+_ClassicStrategy_wire = new WeakMap(), _ClassicStrategy_endpointIdentityMap = new WeakMap(), _ClassicStrategy_pendingMessagesByEndpointId = new WeakMap();
 // Arbitrarily starting at 5 to leave the door open to backfilling pre endpointId etc.
 exports.ClassicInfo = { version: 5, minimumVersion: 0, type: 'classic' };

package/src/api/interappbus/index.js

@@ -17,7 +17,7 @@ class InterApplicationBus extends base_1.Base {
             subscriberAdded: 'subscriber-added',
             subscriberRemoved: 'subscriber-removed'
         };
-        this.refCounter = new ref_counter_1.default();
+        this.refCounter = new ref_counter_1.RefCounter();
         this.Channel = new index_1.Channel(wire);
         this.emitter = new events_1.EventEmitter();
         wire.registerMessageHandler(this.onmessage.bind(this));

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

@@ -88,7 +88,7 @@ import { Base } from '../base';
  * @summary A SessionContextGroup instance method for adding a handler for context change.
  * @param {ContextHandler} contextHandler The callback to be invoked. Is invoked when (a) the context changes or (b) immediately after getting created if the context is already set.
  * @param {string} [contextType] The context type this handler should listen to. If not specified, a global handler for all context types will get created. Only one global handler is allowed per SessionContextGroup.
- * @return {Promise<void>}
+ * @return {Promise<Subscription>}
  */
 /**
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}

package/src/api/interop/InteropClient.js

@@ -103,7 +103,7 @@ const utils_1 = require("./utils");
  * @summary A SessionContextGroup instance method for adding a handler for context change.
  * @param {ContextHandler} contextHandler The callback to be invoked. Is invoked when (a) the context changes or (b) immediately after getting created if the context is already set.
  * @param {string} [contextType] The context type this handler should listen to. If not specified, a global handler for all context types will get created. Only one global handler is allowed per SessionContextGroup.
- * @return {Promise<void>}
+ * @return {Promise<Subscription>}
  */
 /**
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}

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

@@ -18,7 +18,7 @@ export default class SessionContextGroupBroker {
     handlerAdded(payload: {
         handlerId: string;
         contextType?: string;
-    }, clientIdentity: OpenFin.ClientIdentity): void;
+    }, clientIdentity: OpenFin.ClientIdentity): Promise<void>;
     handlerRemoved(payload: {
         handlerId: string;
     }, clientIdentity: OpenFin.ClientIdentity): void;

package/src/api/interop/SessionContextGroupBroker.js

@@ -48,7 +48,7 @@ class SessionContextGroupBroker {
     getClientState(id) {
         return this.clients.get(id.endpointId);
     }
-    handlerAdded(payload, clientIdentity) {
+    async handlerAdded(payload, clientIdentity) {
         const { handlerId, contextType } = payload;
         const clientSubscriptionState = this.getClientState(clientIdentity);
         if (!clientSubscriptionState) {
@@ -59,17 +59,18 @@ class SessionContextGroupBroker {
             clientSubscriptionState.contextHandlers.set(contextType, [...currentHandlerList, handlerId]);
             const currentContext = this.contextGroupMap.get(contextType);
             if (currentContext) {
-                this.provider.dispatch(clientIdentity, handlerId, currentContext);
+                await this.provider.dispatch(clientIdentity, handlerId, currentContext);
             }
         }
         else {
             clientSubscriptionState.globalHandler = handlerId;
-            [...this.contextGroupMap.keys()].forEach((currentContextType) => {
+            const globalDispatchPromises = [...this.contextGroupMap.keys()].map(async (currentContextType) => {
                 const currentContext = this.contextGroupMap.get(currentContextType);
                 if (currentContext) {
-                    this.provider.dispatch(clientIdentity, handlerId, currentContext);
+                    await this.provider.dispatch(clientIdentity, handlerId, currentContext);
                 }
             });
+            await Promise.all(globalDispatchPromises);
         }
     }
     handlerRemoved(payload, clientIdentity) {

package/src/api/interop/SessionContextGroupClient.js

@@ -63,7 +63,7 @@ class SessionContextGroupClient extends base_1.Base {
             handlerId = `sessionContextHandler:invoke-${this.id}`;
         }
         client.register(handlerId, (0, utils_1.wrapContextHandler)(contextHandler, handlerId));
-        client.dispatch(`sessionContextGroup:handlerAdded-${this.id}`, { handlerId, contextType });
+        await client.dispatch(`sessionContextGroup:handlerAdded-${this.id}`, { handlerId, contextType });
         return { unsubscribe: await this.createUnsubscribeCb(handlerId) };
     }
     async createUnsubscribeCb(handlerId) {

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

@@ -1,5 +1,5 @@
 import type * as OpenFin from '../../../OpenFin';
-import { ChannelProvider } from '../../interappbus/channel/provider';
+type ChannelProvider = OpenFin.ChannelProvider;
 type HandlerId = string;
 type ContextType = string;
 interface PrivateChannelClientState {

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

@@ -84,16 +84,9 @@ class PrivateChannelProvider {
         if (contextType) {
             const currentHandlersList = senderClientState.handlerIdsByContextTypes.get(contextType) || [];
             senderClientState.handlerIdsByContextTypes.set(contextType, [...currentHandlersList, handlerId]);
-            const currContext = this.contextByContextType.get(contextType);
-            if (currContext) {
-                this.provider.dispatch(senderClientIdentity, handlerId, currContext);
-            }
         }
         else {
             senderClientState.globalHandler = handlerId;
-            if (this.lastContext) {
-                this.provider.dispatch(senderClientIdentity, handlerId, this.lastContext);
-            }
         }
         Array.from(this.clients.values()).forEach((currClientState) => {
             if (currClientState.clientIdentity.endpointId !== senderClientIdentity.endpointId &&
@@ -271,7 +264,7 @@ class PrivateChannelProvider {
         const allClientInfo = await this.provider.getAllClientInfo();
         return Array.from(this.clients.values()).filter((clientState) => {
             const { uuid, name } = clientState.clientIdentity;
-            return allClientInfo.some(clientInfo => {
+            return allClientInfo.some((clientInfo) => {
                 return name === clientInfo.name && uuid === clientInfo.uuid;
             });
         });

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

@@ -4,6 +4,7 @@ const base_1 = require("../../base");
 const utils_1 = require("./utils");
 const utils_2 = require("../utils");
 const InteropClient_1 = require("../InteropClient");
+const lodash_1 = require("lodash");
 /**
  * @typedef { object } Listener
  * @summary Listener object returned by addContextListener and addIntentListener
@@ -393,7 +394,39 @@ class Fdc3Module extends base_1.Base {
         return {
             ...currentContextGroupInfo,
             type: 'system',
-            addContextListener: this.addContextListener.bind(this),
+            addContextListener: (contextType, handler) => {
+                let realHandler;
+                let realType;
+                if (typeof contextType === 'function') {
+                    console.warn('addContextListener(handler) has been deprecated. Please use addContextListener(null, handler)');
+                    realHandler = contextType;
+                }
+                else {
+                    realHandler = handler;
+                    if (typeof contextType === 'string') {
+                        realType = contextType;
+                    }
+                }
+                const listener = (async () => {
+                    let first = true;
+                    const currentContext = await this.fin.me.interop.getCurrentContext(realType);
+                    const wrappedHandler = (context, contextMetadata) => {
+                        if (first) {
+                            first = false;
+                            if ((0, lodash_1.isEqual)(currentContext, context)) {
+                                return;
+                            }
+                        }
+                        // eslint-disable-next-line consistent-return
+                        return realHandler(context, contextMetadata);
+                    };
+                    return this.fin.me.interop.addContextHandler(wrappedHandler, realType);
+                })();
+                return {
+                    ...listener,
+                    unsubscribe: () => listener.then((l) => l.unsubscribe())
+                };
+            },
             broadcast: this.broadcast.bind(this),
             getCurrentContext: async (contextType) => {
                 const context = await this.fin.me.interop.getCurrentContext(contextType);

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

@@ -171,14 +171,14 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * Find all the available instances for a particular application.
      * @param { AppIdentifier } app
      * @returns { Promise<Array<AppIdentifier>> }
-     * @tutorial findInstances
+     * @tutorial fdc3v2.findInstances
      */
     findInstances(app: FDC3v2.AppIdentifier): Promise<Array<FDC3v2.AppIdentifier>>;
     /**
      * Retrieves the AppMetadata for an AppIdentifier, which provides additional metadata (such as icons, a title and description) from the App Directory record for the application, that may be used for display purposes.
      * @param { AppIdentifier } app
      * @returns { Promise<AppMetadata(2)> }
-     * @tutorial getAppMetadata
+     * @tutorial fdc3v2.getAppMetadata
      */
     getAppMetadata(app: FDC3v2.AppIdentifier): Promise<FDC3v2.AppMetadata>;
     /**
@@ -210,7 +210,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * @param { Context } context
      * @param { string } [resultType] The type of result returned for any intent specified during resolution.
      * @returns { Promise<Array<AppIntent(2)>> }
-     * @tutorial findIntentsByContext
+     * @tutorial fdc3v2.findIntentsByContext
      */
     findIntentsByContext(context: FDC3v2.Context, resultType?: string): Promise<Array<FDC3v2.AppIntent>>;
     /**
@@ -219,7 +219,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial raiseIntent
+     * @tutorial fdc3v2.raiseIntent
      */
     raiseIntent(intent: string, context: FDC3v2.Context, app?: FDC3v2.AppIdentifier | FDC3v1.TargetApp): Promise<FDC3v2.IntentResolution>;
     /**
@@ -227,7 +227,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial raiseIntentForContext
+     * @tutorial fdc3v2.raiseIntentForContext
      */
     raiseIntentForContext(context: FDC3v2.Context, app?: FDC3v2.AppIdentifier | FDC3v1.TargetApp): Promise<FDC3v2.IntentResolution>;
     /**
@@ -244,17 +244,17 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * @returns { Promise<Channel> }
      * @tutorial fdc3.getOrCreateChannel
      */
-    getOrCreateChannel(channelId: string): Promise<FDC3v1.Channel>;
+    getOrCreateChannel(channelId: string): Promise<FDC3v2.Channel>;
     /**
      * Returns a Channel with an auto-generated identity that is intended for private communication between applications. Primarily used to create channels that will be returned to other applications via an IntentResolution for a raised intent.
      * @returns { Promise<PrivateChannel> }
-     * @tutorial createPrivateChannel
+     * @tutorial fdc3v2.createPrivateChannel
      */
     createPrivateChannel(): Promise<FDC3v2.PrivateChannel>;
     /**
      * Retrieves a list of the User Channels available for the app to join.
      * @returns { Promise<Channel[]>}
-     * @tutorial getUserChannels
+     * @tutorial fdc3v2.getUserChannels
      */
     getUserChannels(): Promise<Array<FDC3v1.SystemChannel>>;
     /**
@@ -268,7 +268,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * Join an app to a specified User channel.
      * @param { string } channelId Channel name
      * @returns { Promise<void> }
-     * @tutorial joinUserChannel
+     * @tutorial fdc3v2.joinUserChannel
      */
     joinUserChannel(channelId: string): Promise<void>;
     /**
@@ -282,6 +282,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
     /**
      * Returns the Channel object for the current User channel membership
      * @returns { Promise<FDC3.Channel | null> }
+     * @tutorial fdc3.getCurrentChannel
      */
     getCurrentChannel(): Promise<FDC3v2.Channel | null>;
     /**
@@ -294,7 +295,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * Retrieves information about the FDC3 implementation, including the supported version of the FDC3 specification, the name of the provider of the implementation, its own version number, details of whether optional API features are implemented and the metadata of the calling application according to the desktop agent.
      * fdc3HandleGetInfo must be overridden in the InteropBroker so that the ImplementationMetadata will have the appMetadata info.
      * @returns { Promise<ImplementationMetadata(2)> }
-     * @tutorial getInfo
+     * @tutorial fdc3v2.getInfo
      */
     getInfo(): Promise<FDC3v2.ImplementationMetadata>;
 }

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

@@ -180,7 +180,7 @@ class Fdc3Module2 extends base_1.Base {
      * Find all the available instances for a particular application.
      * @param { AppIdentifier } app
      * @returns { Promise<Array<AppIdentifier>> }
-     * @tutorial findInstances
+     * @tutorial fdc3v2.findInstances
      */
     async findInstances(app) {
         this.wire.sendAction('fdc3-find-instances').catch((e) => {
@@ -198,7 +198,7 @@ class Fdc3Module2 extends base_1.Base {
      * Retrieves the AppMetadata for an AppIdentifier, which provides additional metadata (such as icons, a title and description) from the App Directory record for the application, that may be used for display purposes.
      * @param { AppIdentifier } app
      * @returns { Promise<AppMetadata(2)> }
-     * @tutorial getAppMetadata
+     * @tutorial fdc3v2.getAppMetadata
      */
     async getAppMetadata(app) {
         this.wire.sendAction('fdc3-get-app-metadata').catch((e) => {
@@ -276,7 +276,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context
      * @param { string } [resultType] The type of result returned for any intent specified during resolution.
      * @returns { Promise<Array<AppIntent(2)>> }
-     * @tutorial findIntentsByContext
+     * @tutorial fdc3v2.findIntentsByContext
      */
     async findIntentsByContext(context, resultType) {
         this.wire.sendAction('fdc3-find-intents-by-context').catch((e) => {
@@ -297,7 +297,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial raiseIntent
+     * @tutorial fdc3v2.raiseIntent
      */
     async raiseIntent(intent, context, app) {
         this.wire.sendAction('fdc3-raise-intent').catch((e) => {
@@ -316,7 +316,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial raiseIntentForContext
+     * @tutorial fdc3v2.raiseIntentForContext
      */
     async raiseIntentForContext(context, app) {
         // TODO: We have to do the same thing we do for raiseIntent here as well.
@@ -384,7 +384,7 @@ class Fdc3Module2 extends base_1.Base {
     /**
      * Returns a Channel with an auto-generated identity that is intended for private communication between applications. Primarily used to create channels that will be returned to other applications via an IntentResolution for a raised intent.
      * @returns { Promise<PrivateChannel> }
-     * @tutorial createPrivateChannel
+     * @tutorial fdc3v2.createPrivateChannel
      */
     async createPrivateChannel() {
         const channelId = (0, utils_1.generateId)();
@@ -396,7 +396,7 @@ class Fdc3Module2 extends base_1.Base {
     /**
      * Retrieves a list of the User Channels available for the app to join.
      * @returns { Promise<Channel[]>}
-     * @tutorial getUserChannels
+     * @tutorial fdc3v2.getUserChannels
      */
     async getUserChannels() {
         const channels = await this.fin.me.interop.getContextGroups();
@@ -420,7 +420,7 @@ class Fdc3Module2 extends base_1.Base {
      * Join an app to a specified User channel.
      * @param { string } channelId Channel name
      * @returns { Promise<void> }
-     * @tutorial joinUserChannel
+     * @tutorial fdc3v2.joinUserChannel
      */
     async joinUserChannel(channelId) {
         return this.fdc3Module.joinChannel(channelId);
@@ -439,6 +439,7 @@ class Fdc3Module2 extends base_1.Base {
     /**
      * Returns the Channel object for the current User channel membership
      * @returns { Promise<FDC3.Channel | null> }
+     * @tutorial fdc3.getCurrentChannel
      */
     async getCurrentChannel() {
         const currentChannel = await this.fdc3Module.getCurrentChannel();
@@ -463,7 +464,7 @@ class Fdc3Module2 extends base_1.Base {
      * Retrieves information about the FDC3 implementation, including the supported version of the FDC3 specification, the name of the provider of the implementation, its own version number, details of whether optional API features are implemented and the metadata of the calling application according to the desktop agent.
      * fdc3HandleGetInfo must be overridden in the InteropBroker so that the ImplementationMetadata will have the appMetadata info.
      * @returns { Promise<ImplementationMetadata(2)> }
-     * @tutorial getInfo
+     * @tutorial fdc3v2.getInfo
      */
     async getInfo() {
         return InteropClient_1.InteropClient.ferryFdc3Call(this.fin.me.interop, 'fdc3v2GetInfo', { fdc3Version: '2.0' });

package/src/api/interop/fdc3/shapes/fdc3v2.d.ts

@@ -64,7 +64,7 @@ export interface DesktopAgent {
     addContextListener(contextType: string | null, handler: ContextHandler): Promise<Listener>;
     getUserChannels(): Promise<Array<SystemChannel>>;
     joinUserChannel(channelId: string): Promise<void>;
-    getOrCreateChannel(channelId: string): Promise<ChannelV1>;
+    getOrCreateChannel(channelId: string): Promise<Channel>;
     createPrivateChannel(): Promise<PrivateChannel>;
     getCurrentChannel(): Promise<ChannelV1 | null>;
     leaveCurrentChannel(): Promise<void>;

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getIntentResolution = exports.isChannel = exports.isContext = exports.connectPrivateChannel = exports.buildAppChannelObject = exports.buildPrivateChannelObject = exports.ChannelError = exports.ResultError = exports.UnsupportedChannelApiError = exports.getUnsupportedChannelApis = void 0;
 const utils_1 = require("../utils");
 const PrivateChannelClient_1 = require("./PrivateChannelClient");
+const lodash_1 = require("lodash");
 const getUnsupportedChannelApis = (channelType) => {
     return {
         addContextListener: () => {
@@ -111,14 +112,33 @@ const buildAppChannelObject = (sessionContextGroup) => {
             return context === undefined ? null : context;
         },
         addContextListener: (contextType, handler) => {
-            let listener;
+            let realHandler;
+            let realType;
             if (typeof contextType === 'function') {
                 console.warn('addContextListener(handler) has been deprecated. Please use addContextListener(null, handler)');
-                listener = sessionContextGroup.addContextHandler(contextType);
+                realHandler = contextType;
             }
             else {
-                listener = sessionContextGroup.addContextHandler(handler, contextType === null ? undefined : contextType);
+                realHandler = handler;
+                if (typeof contextType === 'string') {
+                    realType = contextType;
+                }
             }
+            const listener = (async () => {
+                let first = true;
+                const currentContext = await sessionContextGroup.getCurrentContext(realType);
+                const wrappedHandler = (context, contextMetadata) => {
+                    if (first) {
+                        first = false;
+                        if ((0, lodash_1.isEqual)(currentContext, context)) {
+                            return;
+                        }
+                    }
+                    // eslint-disable-next-line consistent-return
+                    return realHandler(context, contextMetadata);
+                };
+                return sessionContextGroup.addContextHandler(wrappedHandler, realType);
+            })();
             return {
                 ...listener,
                 unsubscribe: () => listener.then((l) => l.unsubscribe())
@@ -149,7 +169,7 @@ exports.isContext = isContext;
 const isChannel = (channel) => {
     if (channel && typeof channel === 'object' && 'type' in channel && 'id' in channel) {
         const { type, id } = channel;
-        return (typeof type === 'string' && typeof id === 'string' && (type === 'app' || type === 'private'));
+        return typeof type === 'string' && typeof id === 'string' && (type === 'app' || type === 'private');
     }
     return false;
 };