@openfin/fdc3-api 40.101.1 → 40.102.1

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

@@ -6020,6 +6020,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
  */
@@ -7927,7 +7951,7 @@ declare type LaunchIntoPlatformPayload = {
  *
  * @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
@@ -7944,7 +7968,7 @@ declare type LaunchIntoPlatformPayload = {
  * });
  * ```
  *
- * #### {@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
@@ -8208,7 +8232,7 @@ declare class Layout extends Base {
      */
     applyPreset: (options: PresetLayoutOptions) => Promise<void>;
     /**
-     * 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.
@@ -8224,7 +8248,7 @@ declare class Layout extends 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.
@@ -9638,6 +9662,7 @@ declare namespace OpenFin {
         EntityType_4 as EntityType,
         Bounds,
         WindowBounds,
+        GetBoundsOptions,
         Rectangle,
         ApplicationCreationOptions,
         TimeZones,
@@ -12321,7 +12346,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;
@@ -13699,6 +13726,7 @@ declare type Snapshot = {
 declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
     topic: 'application';
     type: 'platform-snapshot-applied';
+    snapshot: Snapshot;
 };
 
 /**
@@ -17911,7 +17939,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

@@ -6020,6 +6020,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
  */
@@ -7927,7 +7951,7 @@ declare type LaunchIntoPlatformPayload = {
  *
  * @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
@@ -7944,7 +7968,7 @@ declare type LaunchIntoPlatformPayload = {
  * });
  * ```
  *
- * #### {@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
@@ -8208,7 +8232,7 @@ declare class Layout extends Base {
      */
     applyPreset: (options: PresetLayoutOptions) => Promise<void>;
     /**
-     * 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.
@@ -8224,7 +8248,7 @@ declare class Layout extends 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.
@@ -9638,6 +9662,7 @@ declare namespace OpenFin {
         EntityType_4 as EntityType,
         Bounds,
         WindowBounds,
+        GetBoundsOptions,
         Rectangle,
         ApplicationCreationOptions,
         TimeZones,
@@ -12321,7 +12346,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;
@@ -13699,6 +13726,7 @@ declare type Snapshot = {
 declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
     topic: 'application';
     type: 'platform-snapshot-applied';
+    snapshot: Snapshot;
 };
 
 /**
@@ -17911,7 +17939,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

@@ -6020,6 +6020,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
  */
@@ -7927,7 +7951,7 @@ declare type LaunchIntoPlatformPayload = {
  *
  * @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
@@ -7944,7 +7968,7 @@ declare type LaunchIntoPlatformPayload = {
  * });
  * ```
  *
- * #### {@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
@@ -8208,7 +8232,7 @@ declare class Layout extends Base {
      */
     applyPreset: (options: PresetLayoutOptions) => Promise<void>;
     /**
-     * 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.
@@ -8224,7 +8248,7 @@ declare class Layout extends 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.
@@ -9638,6 +9662,7 @@ declare namespace OpenFin {
         EntityType_4 as EntityType,
         Bounds,
         WindowBounds,
+        GetBoundsOptions,
         Rectangle,
         ApplicationCreationOptions,
         TimeZones,
@@ -12321,7 +12346,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;
@@ -13699,6 +13726,7 @@ declare type Snapshot = {
 declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
     topic: 'application';
     type: 'platform-snapshot-applied';
+    snapshot: Snapshot;
 };
 
 /**
@@ -17911,7 +17939,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

@@ -6108,6 +6108,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
  */
@@ -8044,7 +8068,7 @@ declare type LaunchIntoPlatformPayload = {
  *
  * @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
@@ -8061,7 +8085,7 @@ declare type LaunchIntoPlatformPayload = {
  * });
  * ```
  *
- * #### {@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
@@ -8334,7 +8358,7 @@ declare class Layout extends Base {
      */
     applyPreset: (options: PresetLayoutOptions) => Promise<void>;
     /**
-     * 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.
@@ -8350,7 +8374,7 @@ declare class Layout extends 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.
@@ -9956,6 +9980,7 @@ declare namespace OpenFin {
         EntityType_4 as EntityType,
         Bounds,
         WindowBounds,
+        GetBoundsOptions,
         Rectangle,
         ApplicationCreationOptions,
         TimeZones,
@@ -12722,7 +12747,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;
@@ -14100,6 +14127,7 @@ declare type Snapshot = {
 declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
     topic: 'application';
     type: 'platform-snapshot-applied';
+    snapshot: Snapshot;
 };
 
 /**
@@ -18365,7 +18393,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/package.json

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