@openfin/fdc3-api 42.103.4 → 43.100.5

package/out/fdc3-api.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var require$$0 = require('lodash/isEqual');
+var require$$2 = require('lodash/isEqual');
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -203,86 +203,15 @@ class PrivateChannelClient {
 }
 PrivateChannelClient$1.PrivateChannelClient = PrivateChannelClient;
 
-var fdc3Channels2_0 = {};
-
-var fdc3Channels1_2 = {};
-
-var __importDefault$2 = (commonjsGlobal && commonjsGlobal.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(fdc3Channels1_2, "__esModule", { value: true });
-fdc3Channels1_2.createV1Channel = void 0;
-const isEqual_1$1 = __importDefault$2(require$$0);
-const createV1Channel = (sessionContextGroup) => {
-    return {
-        id: sessionContextGroup.id,
-        type: 'app',
-        broadcast: sessionContextGroup.setContext,
-        getCurrentContext: async (contextType) => {
-            const context = await sessionContextGroup.getCurrentContext(contextType);
-            return context === undefined ? null : context;
-        },
-        // @ts-expect-error TODO [CORE-1524]
-        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 sessionContextGroup.getCurrentContext(realType);
-                const wrappedHandler = (context, contextMetadata) => {
-                    if (first) {
-                        first = false;
-                        if ((0, isEqual_1$1.default)(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())
-            };
-        }
-    };
-};
-fdc3Channels1_2.createV1Channel = createV1Channel;
-
-Object.defineProperty(fdc3Channels2_0, "__esModule", { value: true });
-fdc3Channels2_0.createV2Channel = void 0;
-const fdc3_channels_1_2_1$1 = fdc3Channels1_2;
-const createV2Channel = (sessionContextGroup) => {
-    const channel = (0, fdc3_channels_1_2_1$1.createV1Channel)(sessionContextGroup);
-    return {
-        ...channel,
-        // @ts-expect-error Type incompatibility on signature.
-        addContextListener: async (...args) => channel.addContextListener(...args)
-    };
-};
-fdc3Channels2_0.createV2Channel = createV2Channel;
-
 (function (exports) {
 	var __importDefault = (commonjsGlobal && commonjsGlobal.__importDefault) || function (mod) {
 	    return (mod && mod.__esModule) ? mod : { "default": mod };
 	};
 	Object.defineProperty(exports, "__esModule", { value: true });
-	exports.getIntentResolution = exports.isChannel = exports.isContext = exports.connectPrivateChannel = exports.buildPrivateChannelObject = exports.ChannelError = exports.ResultError = exports.UnsupportedChannelApiError = exports.getUnsupportedChannelApis = void 0;
+	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 = utils$2;
 	const PrivateChannelClient_1 = PrivateChannelClient$1;
-	__importDefault(require$$0);
-	const fdc3_channels_2_0_1 = fdc3Channels2_0;
+	const isEqual_1 = __importDefault(require$$2);
 	const getUnsupportedChannelApis = (channelType) => {
 	    return {
 	        addContextListener: () => {
@@ -381,6 +310,52 @@ fdc3Channels2_0.createV2Channel = createV2Channel;
 	    };
 	};
 	exports.buildPrivateChannelObject = buildPrivateChannelObject;
+	const buildAppChannelObject = (sessionContextGroup) => {
+	    return {
+	        id: sessionContextGroup.id,
+	        type: 'app',
+	        broadcast: sessionContextGroup.setContext,
+	        getCurrentContext: async (contextType) => {
+	            const context = await sessionContextGroup.getCurrentContext(contextType);
+	            return context === undefined ? null : context;
+	        },
+	        // @ts-expect-error TODO [CORE-1524]
+	        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 sessionContextGroup.getCurrentContext(realType);
+	                const wrappedHandler = (context, contextMetadata) => {
+	                    if (first) {
+	                        first = false;
+	                        if ((0, isEqual_1.default)(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())
+	            };
+	        }
+	    };
+	};
+	exports.buildAppChannelObject = buildAppChannelObject;
 	const connectPrivateChannel = async (channelId) => {
 	    try {
 	        const channelClient = await fin.InterApplicationBus.Channel.connect(channelId);
@@ -412,10 +387,6 @@ fdc3Channels2_0.createV2Channel = createV2Channel;
 	    // Generate an ID to make a session context group with. We will pass that ID to the Broker.
 	    // The broker will then setContext on that session context group later with our Intent Result,
 	    const guid = (0, utils_1.generateId)(); // TODO make this undefined in web
-	    let isPromiseSettled = false;
-	    // Adding the intentResolutionResultId to the intentObj. Because fireIntent only accepts a single arg, we have to slap it in here.
-	    const metadata = app ? { target: app, intentResolutionResultId: guid } : { intentResolutionResultId: guid };
-	    const intentObj = intent ? { name: intent, context, metadata } : { ...context, metadata };
 	    // Promise we'll use in getResult
 	    const getResultPromise = new Promise((resolve, reject) => {
 	        fin.InterApplicationBus.subscribe({ uuid: '*' }, guid, (intentResult) => {
@@ -428,24 +399,13 @@ fdc3Channels2_0.createV2Channel = createV2Channel;
 	            reject(new Error('getResult is not supported in this environment'));
 	        });
 	    });
-	    getResultPromise
-	        .then(() => {
-	        isPromiseSettled = true;
-	    })
-	        .catch(() => {
-	        isPromiseSettled = true;
-	    });
+	    // Adding the intentResolutionResultId to the intentObj. Because fireIntent only accepts a single arg, we have to slap it in here.
+	    const metadata = app ? { target: app, intentResolutionResultId: guid } : { intentResolutionResultId: guid };
+	    const intentObj = intent ? { name: intent, context, metadata } : { ...context, metadata };
 	    // Set up the getResult call.
 	    const getResult = async () => {
-	        // All this mumbo jumbo is needed to make sure that getResult resolves correctly and conforms to the FDC3 spec.
-	        if (!isPromiseSettled) {
-	            return undefined;
-	        }
 	        let intentResult = await getResultPromise;
-	        if (isPromiseSettled && !intentResult) {
-	            return undefined;
-	        }
-	        if (typeof intentResult !== 'object') {
+	        if (!intentResult || typeof intentResult !== 'object') {
 	            throw new Error(ResultError.NoResultReturned);
 	        }
 	        const { error } = intentResult;
@@ -461,7 +421,7 @@ fdc3Channels2_0.createV2Channel = createV2Channel;
 	                }
 	                case 'app': {
 	                    const sessionContextGroup = await interopModule.joinSessionContextGroup(id);
-	                    intentResult = (0, fdc3_channels_2_0_1.createV2Channel)(sessionContextGroup);
+	                    intentResult = (0, exports.buildAppChannelObject)(sessionContextGroup);
 	                    break;
 	                }
 	            }
@@ -495,6 +455,35 @@ var InteropClient$1 = {};
 
 var base = {};
 
+var promises = {};
+
+Object.defineProperty(promises, "__esModule", { value: true });
+promises.promiseMapSerial = promises.serial = promises.promiseMap = promises.promisify = void 0;
+function promisify(func) {
+    return (...args) => new Promise((resolve, reject) => {
+        func(...args, (err, val) => (err ? reject(err) : resolve(val)));
+    });
+}
+promises.promisify = promisify;
+async function promiseMap(arr, asyncF) {
+    return Promise.all(arr.map(asyncF));
+}
+promises.promiseMap = promiseMap;
+async function serial(arr) {
+    const ret = [];
+    for (const func of arr) {
+        // eslint-disable-next-line no-await-in-loop
+        const next = await func();
+        ret.push(next);
+    }
+    return ret;
+}
+promises.serial = serial;
+async function promiseMapSerial(arr, func) {
+    return serial(arr.map((value, index, array) => () => func(value, index, array)));
+}
+promises.promiseMapSerial = promiseMapSerial;
+
 var __classPrivateFieldSet$3 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
     if (kind === "m") throw new TypeError("Private method is not writable");
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
@@ -509,6 +498,7 @@ var __classPrivateFieldGet$3 = (commonjsGlobal && commonjsGlobal.__classPrivateF
 var _EmitterBase_emitterAccessor, _EmitterBase_deregisterOnceListeners;
 Object.defineProperty(base, "__esModule", { value: true });
 base.Reply = base.EmitterBase = base.Base = void 0;
+const promises_1 = promises;
 class Base {
     /**
      * @internal
@@ -586,8 +576,27 @@ class EmitterBase extends Base {
             return this.hasEmitter() ? this.getOrCreateEmitter().emit(eventType, payload, ...args) : false;
         };
         this.hasEmitter = () => this.wire.eventAggregator.has(__classPrivateFieldGet$3(this, _EmitterBase_emitterAccessor, "f"));
+        /**
+         * Cleans up after removal of a listener, e.g. deleting any lingering deregistration handlers for a
+         * `once` subscription.
+         *
+         * @remarks Implementing this as a `removeListener` handler ensures that direct removal of a listener
+         * on the base emitter will not leak additional core handlers.  We could do this in the forwarding method,
+         * which would involve less "magic," but would be more-vulnerable to accidental re-introduction of a leak.
+         */
+        this.cleanUpRemovedListener = (eventType, listener) => {
+            const deregister = __classPrivateFieldGet$3(this, _EmitterBase_deregisterOnceListeners, "f").get(listener);
+            if (deregister) {
+                const emitter = this.wire.eventAggregator.getOrCreate(__classPrivateFieldGet$3(this, _EmitterBase_emitterAccessor, "f"));
+                emitter.removeListener(eventType, deregister);
+            }
+        };
         this.getOrCreateEmitter = () => {
-            return this.wire.eventAggregator.getOrCreate(__classPrivateFieldGet$3(this, _EmitterBase_emitterAccessor, "f"));
+            const emitter = this.wire.eventAggregator.getOrCreate(__classPrivateFieldGet$3(this, _EmitterBase_emitterAccessor, "f"));
+            if (!emitter.listeners('removeListener').includes(this.cleanUpRemovedListener)) {
+                emitter.on('removeListener', this.cleanUpRemovedListener);
+            }
+            return emitter;
         };
         this.listeners = (type) => this.hasEmitter() ? this.getOrCreateEmitter().listeners(type) : [];
         this.listenerCount = (type) => this.hasEmitter() ? this.getOrCreateEmitter().listenerCount(type) : 0;
@@ -627,6 +636,7 @@ class EmitterBase extends Base {
         };
         __classPrivateFieldSet$3(this, _EmitterBase_emitterAccessor, [topic, ...additionalAccessors], "f");
         __classPrivateFieldSet$3(this, _EmitterBase_deregisterOnceListeners, new WeakMap(), "f");
+        this.listeners = (event) => this.hasEmitter() ? this.getOrCreateEmitter().listeners(event) : [];
     }
     /**
      * Adds a listener to the end of the listeners array for the specified event.
@@ -704,10 +714,6 @@ class EmitterBase extends Base {
         const emitter = await this.deregisterEventListener(eventType, options);
         if (emitter) {
             emitter.removeListener(eventType, listener);
-            const deregister = __classPrivateFieldGet$3(this, _EmitterBase_deregisterOnceListeners, "f").get(listener);
-            if (deregister) {
-                emitter.removeListener(eventType, deregister);
-            }
             this.deleteEmitterIfNothingRegistered(emitter);
         }
         return this;
@@ -743,13 +749,12 @@ class EmitterBase extends Base {
         }
         else if (this.hasEmitter()) {
             const events = this.getOrCreateEmitter().eventNames();
-            await Promise.all(events.map(removeByEvent));
+            await (0, promises_1.promiseMap)(events, removeByEvent);
         }
         return this;
     }
     deleteEmitterIfNothingRegistered(emitter) {
-        // TODO: maybe emitterMap should clean up itself..
-        if (emitter.eventNames().length === 0) {
+        if (emitter.eventNames().every((type) => type === 'removeListener')) {
             this.wire.eventAggregator.delete(__classPrivateFieldGet$3(this, _EmitterBase_emitterAccessor, "f"));
         }
     }
@@ -1468,7 +1473,7 @@ fdc3Common.FDC3ModuleBase = void 0;
 const utils_1$2 = utils$1;
 const utils_2$1 = utils$2;
 const InteropClient_1$1 = InteropClient$1;
-const isEqual_1 = __importDefault(require$$0);
+const isEqual_1 = __importDefault(require$$2);
 class FDC3ModuleBase {
     get client() {
         return __classPrivateFieldGet(this, _FDC3ModuleBase_producer, "f").call(this);
@@ -1528,16 +1533,10 @@ class FDC3ModuleBase {
      *
      * @tutorial fdc3.getOrCreateChannel
      */
-    async getOrCreateChannel(channelId, fdc3Factory) {
+    async getOrCreateChannel(channelId) {
         this.wire.sendAction('fdc3-get-or-create-channel').catch((e) => {
             // we do not want to expose this error, just continue if this analytics-only call fails
         });
-        const hasChannelIdBeenUsed = await InteropClient_1$1.InteropClient.ferryFdc3Call(this.client, 'isIdUsedByPrivateChannel', {
-            channelId
-        });
-        if (hasChannelIdBeenUsed) {
-            throw new Error(utils_1$2.ChannelError.AccessDenied);
-        }
         const systemChannels = await this._getChannels();
         const userChannel = systemChannels.find((channel) => channel.id === channelId);
         if (userChannel) {
@@ -1545,7 +1544,7 @@ class FDC3ModuleBase {
         }
         try {
             const sessionContextGroup = await this.client.joinSessionContextGroup(channelId);
-            return fdc3Factory(sessionContextGroup);
+            return (0, utils_1$2.buildAppChannelObject)(sessionContextGroup);
         }
         catch (error) {
             console.error(error.message);
@@ -1695,7 +1694,6 @@ Object.defineProperty(fdc31_2, "__esModule", { value: true });
 exports.Fdc3Module = fdc31_2.Fdc3Module = void 0;
 const utils_1$1 = utils$2;
 const fdc3_common_1$1 = fdc3Common;
-const fdc3_channels_1_2_1 = fdc3Channels1_2;
 /**
  * @version 1.2
  * The FDC3 Client Library provides a set APIs to be used for FDC3 compliance,
@@ -1878,7 +1876,7 @@ class Fdc3Module extends fdc3_common_1$1.FDC3ModuleBase {
      * @tutorial fdc3.getOrCreateChannel
      */
     async getOrCreateChannel(channelId) {
-        return super.getOrCreateChannel(channelId, fdc3_channels_1_2_1.createV1Channel);
+        return super.getOrCreateChannel(channelId);
     }
     /**
      * Returns metadata relating to the FDC3 object and its provider, including the supported version of the FDC3 specification and the name of the provider of the implementation.
@@ -1910,7 +1908,6 @@ const utils_1 = utils$2;
 const InteropClient_1 = InteropClient$1;
 const utils_2 = utils$1;
 const PrivateChannelClient_1 = PrivateChannelClient$1;
-const fdc3_channels_2_0_1 = fdc3Channels2_0;
 /**
  * @version 2.0
  * The FDC3 Client Library provides a set APIs to be used for FDC3 compliance,
@@ -2162,7 +2159,7 @@ class Fdc3Module2 extends fdc3_common_1.FDC3ModuleBase {
      * @tutorial fdc3.getOrCreateChannel
      */
     async getOrCreateChannel(channelId) {
-        return super.getOrCreateChannel(channelId, fdc3_channels_2_0_1.createV2Channel);
+        return super.getOrCreateChannel(channelId);
     }
     /**
      * 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.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/fdc3-api",
-    "version": "42.103.4",
+    "version": "43.100.5",
     "description": "OpenFin fdc3 module utilities and types.",
     "license": "SEE LICENSE IN LICENSE.md",
     "private": false,