@openfin/node-adapter 40.101.1 → 40.102.2

package/out/node-adapter.js

@@ -84,7 +84,7 @@ var __classPrivateFieldGet$e = (commonjsGlobal && commonjsGlobal.__classPrivateF
     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 _EmitterBase_emitterAccessor;
+var _EmitterBase_emitterAccessor, _EmitterBase_deregisterOnceListeners;
 Object.defineProperty(base, "__esModule", { value: true });
 base.Reply = base.EmitterBase = base.Base = void 0;
 const promises_1 = promises;
@@ -156,6 +156,7 @@ class EmitterBase extends Base {
         super(wire);
         this.topic = topic;
         _EmitterBase_emitterAccessor.set(this, void 0);
+        _EmitterBase_deregisterOnceListeners.set(this, void 0);
         this.eventNames = () => (this.hasEmitter() ? this.getOrCreateEmitter().eventNames() : []);
         /**
          * @internal
@@ -164,7 +165,28 @@ class EmitterBase extends Base {
             return this.hasEmitter() ? this.getOrCreateEmitter().emit(eventType, payload, ...args) : false;
         };
         this.hasEmitter = () => this.wire.eventAggregator.has(__classPrivateFieldGet$e(this, _EmitterBase_emitterAccessor, "f"));
-        this.getOrCreateEmitter = () => this.wire.eventAggregator.getOrCreate(__classPrivateFieldGet$e(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$e(this, _EmitterBase_deregisterOnceListeners, "f").get(listener);
+            if (deregister) {
+                const emitter = this.wire.eventAggregator.getOrCreate(__classPrivateFieldGet$e(this, _EmitterBase_emitterAccessor, "f"));
+                emitter.removeListener(eventType, deregister);
+            }
+        };
+        this.getOrCreateEmitter = () => {
+            const emitter = this.wire.eventAggregator.getOrCreate(__classPrivateFieldGet$e(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;
         this.registerEventListener = async (eventType, options = {}, applySubscription, undoSubscription) => {
@@ -196,13 +218,13 @@ class EmitterBase extends Base {
                     type: eventType
                 };
                 await this.wire.sendAction('unsubscribe-to-desktop-event', runtimeEvent).catch(() => null);
-                const emitter = this.getOrCreateEmitter();
-                return emitter;
+                return this.getOrCreateEmitter();
             }
             // This will only be reached if unsubscribe from event that does not exist but do not want to error here
             return Promise.resolve();
         };
         __classPrivateFieldSet$d(this, _EmitterBase_emitterAccessor, [topic, ...additionalAccessors], "f");
+        __classPrivateFieldSet$d(this, _EmitterBase_deregisterOnceListeners, new WeakMap(), "f");
         this.listeners = (event) => this.hasEmitter() ? this.getOrCreateEmitter().listeners(event) : [];
     }
     /**
@@ -231,6 +253,7 @@ class EmitterBase extends Base {
      */
     async once(eventType, listener, options) {
         const deregister = () => this.deregisterEventListener(eventType);
+        __classPrivateFieldGet$e(this, _EmitterBase_deregisterOnceListeners, "f").set(listener, deregister);
         await this.registerEventListener(eventType, options, (emitter) => {
             emitter.once(eventType, deregister);
             emitter.once(eventType, listener);
@@ -261,6 +284,7 @@ class EmitterBase extends Base {
      */
     async prependOnceListener(eventType, listener, options) {
         const deregister = () => this.deregisterEventListener(eventType);
+        __classPrivateFieldGet$e(this, _EmitterBase_deregisterOnceListeners, "f").set(listener, deregister);
         await this.registerEventListener(eventType, options, (emitter) => {
             emitter.prependOnceListener(eventType, listener);
             emitter.once(eventType, deregister);
@@ -319,13 +343,13 @@ class EmitterBase extends Base {
         return this;
     }
     deleteEmitterIfNothingRegistered(emitter) {
-        if (emitter.eventNames().length === 0) {
+        if (emitter.eventNames().every((type) => type === 'removeListener')) {
             this.wire.eventAggregator.delete(__classPrivateFieldGet$e(this, _EmitterBase_emitterAccessor, "f"));
         }
     }
 }
 base.EmitterBase = EmitterBase;
-_EmitterBase_emitterAccessor = new WeakMap();
+_EmitterBase_emitterAccessor = new WeakMap(), _EmitterBase_deregisterOnceListeners = new WeakMap();
 class Reply {
 }
 base.Reply = Reply;
@@ -3736,9 +3760,9 @@ function requireInstance () {
 	     * getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
 	     * ```
 	     */
-	    getBounds() {
+	    getBounds(options) {
 	        return this.wire
-	            .sendAction('get-window-bounds', this.identity)
+	            .sendAction('get-window-bounds', { ...this.identity, options })
 	            .then(({ payload }) => payload.data);
 	    }
 	    /**
@@ -11688,7 +11712,7 @@ const layout_constants_1$1 = layout_constants;
  *
  * @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
  *
- * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
+ * #### [addEventListener(type, listener [, options]);](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener)
  * Adds a listener to the end of the listeners array for the specified event.
  * @example
  * ```js
@@ -11705,7 +11729,7 @@ const layout_constants_1$1 = layout_constants;
  * });
  * ```
  *
- * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
+ * #### [removeEventListener(type, listener [, options]);](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener)
  * Adds a listener to the end of the listeners array for the specified event.
  * @example
  * ```js
@@ -12056,7 +12080,7 @@ class Layout extends base_1$5.Base {
         return layout_entities_1.LayoutNode.getEntity(stack, client);
     }
     /**
-     * Adds a view to the platform layout. Behaves like @link{Platform#createView} with the current layout as the target.
+     * Adds a view to the platform layout. Behaves like {@link Platform#createView Platform.createView} with the current layout as the target.
      *
      * @param viewOptions - The options for creating the view.
      * @param options - Optional parameters for adding the view.
@@ -12077,7 +12101,7 @@ class Layout extends base_1$5.Base {
     }
     /**
      * Closes a view by its identity. Throws an error if the view does not belong to the current layout.
-     * Behaves like @link{Platform#closeView} but only closes the view if it belongs the current layout.
+     * Behaves like {@link Platform#closeView Platform.closeView} but only closes the view if it belongs the current layout.
      *
      * @param viewIdentity - The identity of the view to close.
      * @returns A promise that resolves when the view is closed.
@@ -14449,31 +14473,6 @@ function requireInteropBroker () {
 	        if (!context.type) {
 	            return { isValid: false, reason: 'Context must have a type property' };
 	        }
-	        if (context.id && typeof context.id !== 'object') {
-	            return {
-	                isValid: false,
-	                reason: 'Context id must be an Object populated with key-value identifiers (if set)'
-	            };
-	        }
-	        if (context.id) {
-	            const { id } = context;
-	            const keys = Object.keys(id);
-	            let foundBadIdentifier = false;
-	            if (!keys.length) {
-	                return { isValid: false, reason: 'Context id must have at least one key-value identifier' };
-	            }
-	            keys.forEach((key) => {
-	                if (typeof key !== 'string' || typeof id[key] !== 'string') {
-	                    foundBadIdentifier = true;
-	                }
-	            });
-	            if (foundBadIdentifier) {
-	                return { isValid: false, reason: 'Context id key-value identifiers must be of type string' };
-	            }
-	        }
-	        if (context.name && typeof context.name !== 'string') {
-	            return { isValid: false, reason: 'Context name must be of string type (if set)' };
-	        }
 	        return { isValid: true };
 	    }
 	    // Util to check a client identity.
@@ -17787,7 +17786,7 @@ class NodeEnvironment extends BaseEnvironment_1 {
         };
     }
     getAdapterVersionSync() {
-        return "40.101.1";
+        return "40.102.2";
     }
     observeBounds(element, onChange) {
         throw new Error('Method not implemented.');

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/node-adapter",
-    "version": "40.101.1",
+    "version": "40.102.2",
     "description": "See README.md",
     "main": "out/node-adapter.js",
     "types": "out/node-adapter.d.ts",
@@ -24,7 +24,7 @@
     "author": "OpenFin",
     "dependencies": {
         "@types/node": "^20.14.2",
-        "@openfin/core": "40.101.1",
+        "@openfin/core": "40.102.2",
         "lodash": "^4.17.21",
         "ws": "^7.3.0"
     }