@openfin/fdc3-api 41.100.73 → 41.100.79

package/out/fdc3-api-alpha.d.ts

@@ -4673,6 +4673,15 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
     eventNames: () => (string | symbol)[];
     /* Excluded from this release type: emit */
     private hasEmitter;
+    /**
+     * 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.
+     */
+    private cleanUpRemovedListener;
     private getOrCreateEmitter;
     listeners: (type: string | symbol) => Function[];
     listenerCount: (type: string | symbol) => number;
@@ -6096,6 +6105,30 @@ declare type FrameProcessDetails = ProcessDetails & {
     entityType: string;
 };
 
+/**
+ * @interface
+ * Options for the {@link Window._Window.getBounds} method.
+ */
+declare interface GetBoundsOptions {
+    /**
+     * Specifies the state of the window for which to retrieve the bounds.
+     *
+     * - `'normal'`: Returns the bounds of the window in its 'normal' state (not maximized or minimized).
+     * - `'current'`: Returns the bounds of the window in its current state. For a minimized window, this returns the bounds from its previous state before being minimized.
+     *
+     *  If a window is in `normal` state, `current` and `normal` will return the same bounds.
+     *
+     * If a window is `maximized`, `current` will return the dimensions of the screen while `normal` will return the bounds the window will be restored to.
+     *
+     * If a window is `minimized`, both `current` and `normal` will return the bounds of the window prior to it being minimized.
+     *
+     * **Edge case:** On MacOS, if a window is maximized, then minimized, calling `getBounds` with `boundsType: 'current'` will return the bounds of the window when it was maximized while `normal` will return the normal bounds.
+     *
+     * @default 'normal'
+     */
+    boundsType?: 'normal' | 'current';
+}
+
 /**
  * @interface
  */
@@ -9747,6 +9780,7 @@ declare namespace OpenFin {
         ScreenCapturePermission,
         Bounds,
         WindowBounds,
+        GetBoundsOptions,
         Rectangle,
         ApplicationCreationOptions,
         TimeZones,
@@ -12467,7 +12501,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
         options: OpenFin.TransitionOptions;
     }>;
     'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
-    'get-window-bounds': IdentityCall<{}, OpenFin.WindowBounds>;
+    'get-window-bounds': IdentityCall<{
+        options?: OpenFin.GetBoundsOptions;
+    }, OpenFin.WindowBounds>;
     'center-window': IdentityCall;
     'blur-window': IdentityCall;
     'bring-window-to-front': IdentityCall;
@@ -18102,7 +18138,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
      * ```
      */
-    getBounds(): Promise<OpenFin.WindowBounds>;
+    getBounds(options?: OpenFin.GetBoundsOptions): Promise<OpenFin.WindowBounds>;
     /**
      * Centers the window on its current screen.
      *

package/out/fdc3-api-beta.d.ts

@@ -4673,6 +4673,15 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
     eventNames: () => (string | symbol)[];
     /* Excluded from this release type: emit */
     private hasEmitter;
+    /**
+     * 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.
+     */
+    private cleanUpRemovedListener;
     private getOrCreateEmitter;
     listeners: (type: string | symbol) => Function[];
     listenerCount: (type: string | symbol) => number;
@@ -6096,6 +6105,30 @@ declare type FrameProcessDetails = ProcessDetails & {
     entityType: string;
 };
 
+/**
+ * @interface
+ * Options for the {@link Window._Window.getBounds} method.
+ */
+declare interface GetBoundsOptions {
+    /**
+     * Specifies the state of the window for which to retrieve the bounds.
+     *
+     * - `'normal'`: Returns the bounds of the window in its 'normal' state (not maximized or minimized).
+     * - `'current'`: Returns the bounds of the window in its current state. For a minimized window, this returns the bounds from its previous state before being minimized.
+     *
+     *  If a window is in `normal` state, `current` and `normal` will return the same bounds.
+     *
+     * If a window is `maximized`, `current` will return the dimensions of the screen while `normal` will return the bounds the window will be restored to.
+     *
+     * If a window is `minimized`, both `current` and `normal` will return the bounds of the window prior to it being minimized.
+     *
+     * **Edge case:** On MacOS, if a window is maximized, then minimized, calling `getBounds` with `boundsType: 'current'` will return the bounds of the window when it was maximized while `normal` will return the normal bounds.
+     *
+     * @default 'normal'
+     */
+    boundsType?: 'normal' | 'current';
+}
+
 /**
  * @interface
  */
@@ -9747,6 +9780,7 @@ declare namespace OpenFin {
         ScreenCapturePermission,
         Bounds,
         WindowBounds,
+        GetBoundsOptions,
         Rectangle,
         ApplicationCreationOptions,
         TimeZones,
@@ -12467,7 +12501,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
         options: OpenFin.TransitionOptions;
     }>;
     'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
-    'get-window-bounds': IdentityCall<{}, OpenFin.WindowBounds>;
+    'get-window-bounds': IdentityCall<{
+        options?: OpenFin.GetBoundsOptions;
+    }, OpenFin.WindowBounds>;
     'center-window': IdentityCall;
     'blur-window': IdentityCall;
     'bring-window-to-front': IdentityCall;
@@ -18102,7 +18138,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
      * ```
      */
-    getBounds(): Promise<OpenFin.WindowBounds>;
+    getBounds(options?: OpenFin.GetBoundsOptions): Promise<OpenFin.WindowBounds>;
     /**
      * Centers the window on its current screen.
      *

package/out/fdc3-api-public.d.ts

@@ -4673,6 +4673,15 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
     eventNames: () => (string | symbol)[];
     /* Excluded from this release type: emit */
     private hasEmitter;
+    /**
+     * 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.
+     */
+    private cleanUpRemovedListener;
     private getOrCreateEmitter;
     listeners: (type: string | symbol) => Function[];
     listenerCount: (type: string | symbol) => number;
@@ -6096,6 +6105,30 @@ declare type FrameProcessDetails = ProcessDetails & {
     entityType: string;
 };
 
+/**
+ * @interface
+ * Options for the {@link Window._Window.getBounds} method.
+ */
+declare interface GetBoundsOptions {
+    /**
+     * Specifies the state of the window for which to retrieve the bounds.
+     *
+     * - `'normal'`: Returns the bounds of the window in its 'normal' state (not maximized or minimized).
+     * - `'current'`: Returns the bounds of the window in its current state. For a minimized window, this returns the bounds from its previous state before being minimized.
+     *
+     *  If a window is in `normal` state, `current` and `normal` will return the same bounds.
+     *
+     * If a window is `maximized`, `current` will return the dimensions of the screen while `normal` will return the bounds the window will be restored to.
+     *
+     * If a window is `minimized`, both `current` and `normal` will return the bounds of the window prior to it being minimized.
+     *
+     * **Edge case:** On MacOS, if a window is maximized, then minimized, calling `getBounds` with `boundsType: 'current'` will return the bounds of the window when it was maximized while `normal` will return the normal bounds.
+     *
+     * @default 'normal'
+     */
+    boundsType?: 'normal' | 'current';
+}
+
 /**
  * @interface
  */
@@ -9747,6 +9780,7 @@ declare namespace OpenFin {
         ScreenCapturePermission,
         Bounds,
         WindowBounds,
+        GetBoundsOptions,
         Rectangle,
         ApplicationCreationOptions,
         TimeZones,
@@ -12467,7 +12501,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
         options: OpenFin.TransitionOptions;
     }>;
     'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
-    'get-window-bounds': IdentityCall<{}, OpenFin.WindowBounds>;
+    'get-window-bounds': IdentityCall<{
+        options?: OpenFin.GetBoundsOptions;
+    }, OpenFin.WindowBounds>;
     'center-window': IdentityCall;
     'blur-window': IdentityCall;
     'bring-window-to-front': IdentityCall;
@@ -18102,7 +18138,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
      * ```
      */
-    getBounds(): Promise<OpenFin.WindowBounds>;
+    getBounds(options?: OpenFin.GetBoundsOptions): Promise<OpenFin.WindowBounds>;
     /**
      * Centers the window on its current screen.
      *

package/out/fdc3-api.d.ts

@@ -4737,6 +4737,15 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
         type: EventType;
     }>, ...args: any[]) => boolean;
     private hasEmitter;
+    /**
+     * 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.
+     */
+    private cleanUpRemovedListener;
     private getOrCreateEmitter;
     listeners: (type: string | symbol) => Function[];
     listenerCount: (type: string | symbol) => number;
@@ -6184,6 +6193,30 @@ declare type FrameProcessDetails = ProcessDetails & {
     entityType: string;
 };
 
+/**
+ * @interface
+ * Options for the {@link Window._Window.getBounds} method.
+ */
+declare interface GetBoundsOptions {
+    /**
+     * Specifies the state of the window for which to retrieve the bounds.
+     *
+     * - `'normal'`: Returns the bounds of the window in its 'normal' state (not maximized or minimized).
+     * - `'current'`: Returns the bounds of the window in its current state. For a minimized window, this returns the bounds from its previous state before being minimized.
+     *
+     *  If a window is in `normal` state, `current` and `normal` will return the same bounds.
+     *
+     * If a window is `maximized`, `current` will return the dimensions of the screen while `normal` will return the bounds the window will be restored to.
+     *
+     * If a window is `minimized`, both `current` and `normal` will return the bounds of the window prior to it being minimized.
+     *
+     * **Edge case:** On MacOS, if a window is maximized, then minimized, calling `getBounds` with `boundsType: 'current'` will return the bounds of the window when it was maximized while `normal` will return the normal bounds.
+     *
+     * @default 'normal'
+     */
+    boundsType?: 'normal' | 'current';
+}
+
 /**
  * @interface
  */
@@ -10065,6 +10098,7 @@ declare namespace OpenFin {
         ScreenCapturePermission,
         Bounds,
         WindowBounds,
+        GetBoundsOptions,
         Rectangle,
         ApplicationCreationOptions,
         TimeZones,
@@ -12868,7 +12902,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
         options: OpenFin.TransitionOptions;
     }>;
     'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
-    'get-window-bounds': IdentityCall<{}, OpenFin.WindowBounds>;
+    'get-window-bounds': IdentityCall<{
+        options?: OpenFin.GetBoundsOptions;
+    }, OpenFin.WindowBounds>;
     'center-window': IdentityCall;
     'blur-window': IdentityCall;
     'bring-window-to-front': IdentityCall;
@@ -18556,7 +18592,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
      * ```
      */
-    getBounds(): Promise<OpenFin.WindowBounds>;
+    getBounds(options?: OpenFin.GetBoundsOptions): Promise<OpenFin.WindowBounds>;
     /**
      * Centers the window on its current screen.
      *

package/out/fdc3-api.js

@@ -489,7 +489,7 @@ var __classPrivateFieldGet$3 = (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;
@@ -561,6 +561,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
@@ -569,7 +570,28 @@ 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"));
-        this.getOrCreateEmitter = () => this.wire.eventAggregator.getOrCreate(__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 = () => {
+            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;
         this.registerEventListener = async (eventType, options = {}, applySubscription, undoSubscription) => {
@@ -601,13 +623,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$3(this, _EmitterBase_emitterAccessor, [topic, ...additionalAccessors], "f");
+        __classPrivateFieldSet$3(this, _EmitterBase_deregisterOnceListeners, new WeakMap(), "f");
         this.listeners = (event) => this.hasEmitter() ? this.getOrCreateEmitter().listeners(event) : [];
     }
     /**
@@ -636,6 +658,7 @@ class EmitterBase extends Base {
      */
     async once(eventType, listener, options) {
         const deregister = () => this.deregisterEventListener(eventType);
+        __classPrivateFieldGet$3(this, _EmitterBase_deregisterOnceListeners, "f").set(listener, deregister);
         await this.registerEventListener(eventType, options, (emitter) => {
             emitter.once(eventType, deregister);
             emitter.once(eventType, listener);
@@ -666,6 +689,7 @@ class EmitterBase extends Base {
      */
     async prependOnceListener(eventType, listener, options) {
         const deregister = () => this.deregisterEventListener(eventType);
+        __classPrivateFieldGet$3(this, _EmitterBase_deregisterOnceListeners, "f").set(listener, deregister);
         await this.registerEventListener(eventType, options, (emitter) => {
             emitter.prependOnceListener(eventType, listener);
             emitter.once(eventType, deregister);
@@ -724,13 +748,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$3(this, _EmitterBase_emitterAccessor, "f"));
         }
     }
 }
 base.EmitterBase = EmitterBase;
-_EmitterBase_emitterAccessor = new WeakMap();
+_EmitterBase_emitterAccessor = new WeakMap(), _EmitterBase_deregisterOnceListeners = new WeakMap();
 class Reply {
 }
 base.Reply = Reply;

package/package.json

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