@openfin/core 40.101.1 → 40.102.1

package/out/mock-alpha.d.ts

@@ -5678,6 +5678,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
  */
@@ -7585,7 +7609,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
@@ -7602,7 +7626,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
@@ -7866,7 +7890,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.
@@ -7882,7 +7906,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.
@@ -9296,6 +9320,7 @@ declare namespace OpenFin_2 {
         EntityType_4 as EntityType,
         Bounds,
         WindowBounds,
+        GetBoundsOptions,
         Rectangle,
         ApplicationCreationOptions,
         TimeZones,
@@ -11981,7 +12006,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
         options: OpenFin_2.TransitionOptions;
     }>;
     'get-all-frames': IdentityCall<{}, OpenFin_2.FrameInfo[]>;
-    'get-window-bounds': IdentityCall<{}, OpenFin_2.WindowBounds>;
+    'get-window-bounds': IdentityCall<{
+        options?: OpenFin_2.GetBoundsOptions;
+    }, OpenFin_2.WindowBounds>;
     'center-window': IdentityCall;
     'blur-window': IdentityCall;
     'bring-window-to-front': IdentityCall;
@@ -13359,6 +13386,7 @@ declare type Snapshot = {
 declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
     topic: 'application';
     type: 'platform-snapshot-applied';
+    snapshot: Snapshot;
 };
 
 /**
@@ -17465,7 +17493,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
      * getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
      * ```
      */
-    getBounds(): Promise<OpenFin_2.WindowBounds>;
+    getBounds(options?: OpenFin_2.GetBoundsOptions): Promise<OpenFin_2.WindowBounds>;
     /**
      * Centers the window on its current screen.
      *

package/out/mock-beta.d.ts

@@ -5678,6 +5678,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
  */
@@ -7585,7 +7609,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
@@ -7602,7 +7626,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
@@ -7866,7 +7890,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.
@@ -7882,7 +7906,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.
@@ -9296,6 +9320,7 @@ declare namespace OpenFin_2 {
         EntityType_4 as EntityType,
         Bounds,
         WindowBounds,
+        GetBoundsOptions,
         Rectangle,
         ApplicationCreationOptions,
         TimeZones,
@@ -11981,7 +12006,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
         options: OpenFin_2.TransitionOptions;
     }>;
     'get-all-frames': IdentityCall<{}, OpenFin_2.FrameInfo[]>;
-    'get-window-bounds': IdentityCall<{}, OpenFin_2.WindowBounds>;
+    'get-window-bounds': IdentityCall<{
+        options?: OpenFin_2.GetBoundsOptions;
+    }, OpenFin_2.WindowBounds>;
     'center-window': IdentityCall;
     'blur-window': IdentityCall;
     'bring-window-to-front': IdentityCall;
@@ -13359,6 +13386,7 @@ declare type Snapshot = {
 declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
     topic: 'application';
     type: 'platform-snapshot-applied';
+    snapshot: Snapshot;
 };
 
 /**
@@ -17465,7 +17493,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
      * getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
      * ```
      */
-    getBounds(): Promise<OpenFin_2.WindowBounds>;
+    getBounds(options?: OpenFin_2.GetBoundsOptions): Promise<OpenFin_2.WindowBounds>;
     /**
      * Centers the window on its current screen.
      *

package/out/mock-public.d.ts

@@ -5678,6 +5678,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
  */
@@ -7585,7 +7609,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
@@ -7602,7 +7626,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
@@ -7866,7 +7890,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.
@@ -7882,7 +7906,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.
@@ -9296,6 +9320,7 @@ declare namespace OpenFin_2 {
         EntityType_4 as EntityType,
         Bounds,
         WindowBounds,
+        GetBoundsOptions,
         Rectangle,
         ApplicationCreationOptions,
         TimeZones,
@@ -11981,7 +12006,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
         options: OpenFin_2.TransitionOptions;
     }>;
     'get-all-frames': IdentityCall<{}, OpenFin_2.FrameInfo[]>;
-    'get-window-bounds': IdentityCall<{}, OpenFin_2.WindowBounds>;
+    'get-window-bounds': IdentityCall<{
+        options?: OpenFin_2.GetBoundsOptions;
+    }, OpenFin_2.WindowBounds>;
     'center-window': IdentityCall;
     'blur-window': IdentityCall;
     'bring-window-to-front': IdentityCall;
@@ -13359,6 +13386,7 @@ declare type Snapshot = {
 declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
     topic: 'application';
     type: 'platform-snapshot-applied';
+    snapshot: Snapshot;
 };
 
 /**
@@ -17465,7 +17493,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
      * getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
      * ```
      */
-    getBounds(): Promise<OpenFin_2.WindowBounds>;
+    getBounds(options?: OpenFin_2.GetBoundsOptions): Promise<OpenFin_2.WindowBounds>;
     /**
      * Centers the window on its current screen.
      *

package/out/mock.d.ts

@@ -5766,6 +5766,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
  */
@@ -7702,7 +7726,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
@@ -7719,7 +7743,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
@@ -7992,7 +8016,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.
@@ -8008,7 +8032,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.
@@ -9614,6 +9638,7 @@ declare namespace OpenFin_2 {
         EntityType_4 as EntityType,
         Bounds,
         WindowBounds,
+        GetBoundsOptions,
         Rectangle,
         ApplicationCreationOptions,
         TimeZones,
@@ -12382,7 +12407,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
         options: OpenFin_2.TransitionOptions;
     }>;
     'get-all-frames': IdentityCall<{}, OpenFin_2.FrameInfo[]>;
-    'get-window-bounds': IdentityCall<{}, OpenFin_2.WindowBounds>;
+    'get-window-bounds': IdentityCall<{
+        options?: OpenFin_2.GetBoundsOptions;
+    }, OpenFin_2.WindowBounds>;
     'center-window': IdentityCall;
     'blur-window': IdentityCall;
     'bring-window-to-front': IdentityCall;
@@ -13760,6 +13787,7 @@ declare type Snapshot = {
 declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
     topic: 'application';
     type: 'platform-snapshot-applied';
+    snapshot: Snapshot;
 };
 
 /**
@@ -17919,7 +17947,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
      * getBounds().then(bounds => console.log(bounds)).catch(err => console.log(err));
      * ```
      */
-    getBounds(): Promise<OpenFin_2.WindowBounds>;
+    getBounds(options?: OpenFin_2.GetBoundsOptions): Promise<OpenFin_2.WindowBounds>;
     /**
      * Centers the window on its current screen.
      *

package/out/mock.js

@@ -4024,9 +4024,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);
 	    }
 	    /**
@@ -11976,7 +11976,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
@@ -11993,7 +11993,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
@@ -12344,7 +12344,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.
@@ -12365,7 +12365,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.
@@ -14737,31 +14737,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.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "40.101.1",
+    "version": "40.102.1",
     "description": "The core renderer entry point of OpenFin",
     "license": "SEE LICENSE IN LICENSE.md",
     "main": "out/mock.js",