@openfin/core 39.81.18 → 39.82.2

package/out/mock-alpha.d.ts

@@ -3477,6 +3477,16 @@ declare type ConstWindowOptions = {
      * Default is white.
      */
     backgroundColor: string;
+    /**
+     * @defaultValue false
+     *
+     * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
+     * This also affects the Page Visibility API.
+     *
+     * When `true`, the page is throttled whether it is hidden or not.
+     *
+     */
+    backgroundThrottling: boolean;
     /**
      * Configures how new content (e,g, from `window.open` or a link) is opened.
      */
@@ -8586,6 +8596,12 @@ declare type MutableViewOptions = {
     preventDragOut: boolean;
     interop?: InteropConfig;
     /* Excluded from this release type: _internalWorkspaceData */
+    /**
+     * {@inheritDoc ViewThrottling}
+     *
+     * @defaultValue 'enabled'
+     */
+    throttling: ViewThrottling;
 };
 
 /**
@@ -8829,6 +8845,14 @@ declare type MutableWindowOptions = {
     interop: InteropConfig;
     /* Excluded from this release type: _internalWorkspaceData */
     /* Excluded from this release type: workspacePlatform */
+    /**
+     * {@inheritDoc WindowThrottling}
+     *
+     * @defaultValue 'enabled'
+     *
+     * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
+     */
+    throttling: WindowThrottling;
 };
 
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -9032,6 +9056,8 @@ declare namespace OpenFin_2 {
         AutoResizeOptions,
         InteropConfig,
         ViewInfo,
+        WindowThrottling,
+        ViewThrottling,
         UpdatableViewOptions,
         ViewCreationOptions,
         MutableViewOptions,
@@ -9279,6 +9305,7 @@ declare namespace OpenFin_2 {
         ChannelProviderDisconnectionListener,
         RoutingInfo,
         DownloadShelfOptions,
+        ViewShowAtOptions,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -11408,6 +11435,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
     'get-view-options': IdentityCall<{}, OpenFin_2.ViewOptions>;
     'hide-view': IdentityCall;
     'show-view': IdentityCall;
+    'show-view-at': IdentityCall<{
+        bounds: OpenFin_2.Bounds;
+        options?: OpenFin_2.ViewShowAtOptions;
+    }>;
+    'bring-view-to-front': IdentityCall;
     'update-view-options': IdentityCall<{
         options: OpenFin_2.UpdatableViewOptions;
     }>;
@@ -14636,6 +14668,8 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
      *         left: 100,
      *         width: 300,
      *         height: 300
+     *     }, {
+     *       bringToFront : true
      *     });
      * }
      *
@@ -14645,7 +14679,15 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
      * ```
      * @experimental
      */
-    showAt: (bounds: OpenFin_2.Bounds) => Promise<void>;
+    showAt: (bounds: OpenFin_2.Bounds, options?: OpenFin_2.ViewShowAtOptions) => Promise<void>;
+    /**
+     * Brings the specified view to the front of its current window. This ensures the view will be visible on top of any other views
+     * which have overlapping bounds with it.
+     *
+     * Please note, this is not a permanent action - when a new view is created or attached to the window, it will display on top of all other views
+     * in the window that share bounds with it.
+     */
+    bringToFront: () => Promise<void>;
     /**
      * Hides the current view if it is currently visible.
      *
@@ -15117,6 +15159,14 @@ declare class ViewModule extends Base {
  */
 declare type ViewOptions = ConstViewOptions & MutableViewOptions;
 
+declare type ViewShowAtOptions = {
+    /**
+     * Sets the view as the top level view. See {@link OpenFin.View.bringToFront} for more information.
+     * @default false
+     */
+    bringToFront?: true;
+};
+
 /**
  * Represents the payload shape for Views that are trying to prevent an unload.
  * @interface
@@ -15148,7 +15198,6 @@ declare interface ViewsPreventingUnloadPayload {
  * @interface
  */
 declare type ViewState = ViewCreationOptions & {
-    backgroundThrottling: boolean;
     componentName: 'view';
     initialUrl: string;
     minWidth?: number;
@@ -15170,6 +15219,14 @@ declare interface ViewStatuses {
     viewsNotPreventingUnload: Identity_5[];
 }
 
+/**
+ * View throttling state.
+ *
+ * * `enabled`: Both background throttling and scheduler throttling are true. It's fully throttled.
+ * * `scheduler-disabled`: background throttling is true, but scheduler throttling is disabled.
+ */
+declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
+
 /**
  * Configuration for view visibility settings
  *
@@ -17713,6 +17770,16 @@ declare type WindowStartLoadEvent = BaseEvent_3 & {
  */
 declare type WindowState = 'maximized' | 'minimized' | 'normal';
 
+/**
+ *
+ * Window throttling state.
+ *
+ * * `enabled`: Both background throttling and scheduler throttling are true. It's fully throttled.
+ * * `scheduler-disabled`: The background throttling is true, but scheduler throttling is disabled.
+ * * `disabled`: The background throttling is false. The throttling is fully disabled.
+ */
+declare type WindowThrottling = 'enabled' | 'scheduler-disabled' | 'disabled';
+
 /**
  * A view-related event that fires natively on the `Window` topic.  This means that these events *do* propagate
  * to the `Application` level, with the name pattern `window-view-eventname`.

package/out/mock-beta.d.ts

@@ -3477,6 +3477,16 @@ declare type ConstWindowOptions = {
      * Default is white.
      */
     backgroundColor: string;
+    /**
+     * @defaultValue false
+     *
+     * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
+     * This also affects the Page Visibility API.
+     *
+     * When `true`, the page is throttled whether it is hidden or not.
+     *
+     */
+    backgroundThrottling: boolean;
     /**
      * Configures how new content (e,g, from `window.open` or a link) is opened.
      */
@@ -8586,6 +8596,12 @@ declare type MutableViewOptions = {
     preventDragOut: boolean;
     interop?: InteropConfig;
     /* Excluded from this release type: _internalWorkspaceData */
+    /**
+     * {@inheritDoc ViewThrottling}
+     *
+     * @defaultValue 'enabled'
+     */
+    throttling: ViewThrottling;
 };
 
 /**
@@ -8829,6 +8845,14 @@ declare type MutableWindowOptions = {
     interop: InteropConfig;
     /* Excluded from this release type: _internalWorkspaceData */
     /* Excluded from this release type: workspacePlatform */
+    /**
+     * {@inheritDoc WindowThrottling}
+     *
+     * @defaultValue 'enabled'
+     *
+     * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
+     */
+    throttling: WindowThrottling;
 };
 
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -9032,6 +9056,8 @@ declare namespace OpenFin_2 {
         AutoResizeOptions,
         InteropConfig,
         ViewInfo,
+        WindowThrottling,
+        ViewThrottling,
         UpdatableViewOptions,
         ViewCreationOptions,
         MutableViewOptions,
@@ -9279,6 +9305,7 @@ declare namespace OpenFin_2 {
         ChannelProviderDisconnectionListener,
         RoutingInfo,
         DownloadShelfOptions,
+        ViewShowAtOptions,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -11408,6 +11435,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
     'get-view-options': IdentityCall<{}, OpenFin_2.ViewOptions>;
     'hide-view': IdentityCall;
     'show-view': IdentityCall;
+    'show-view-at': IdentityCall<{
+        bounds: OpenFin_2.Bounds;
+        options?: OpenFin_2.ViewShowAtOptions;
+    }>;
+    'bring-view-to-front': IdentityCall;
     'update-view-options': IdentityCall<{
         options: OpenFin_2.UpdatableViewOptions;
     }>;
@@ -14636,6 +14668,8 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
      *         left: 100,
      *         width: 300,
      *         height: 300
+     *     }, {
+     *       bringToFront : true
      *     });
      * }
      *
@@ -14645,7 +14679,15 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
      * ```
      * @experimental
      */
-    showAt: (bounds: OpenFin_2.Bounds) => Promise<void>;
+    showAt: (bounds: OpenFin_2.Bounds, options?: OpenFin_2.ViewShowAtOptions) => Promise<void>;
+    /**
+     * Brings the specified view to the front of its current window. This ensures the view will be visible on top of any other views
+     * which have overlapping bounds with it.
+     *
+     * Please note, this is not a permanent action - when a new view is created or attached to the window, it will display on top of all other views
+     * in the window that share bounds with it.
+     */
+    bringToFront: () => Promise<void>;
     /**
      * Hides the current view if it is currently visible.
      *
@@ -15117,6 +15159,14 @@ declare class ViewModule extends Base {
  */
 declare type ViewOptions = ConstViewOptions & MutableViewOptions;
 
+declare type ViewShowAtOptions = {
+    /**
+     * Sets the view as the top level view. See {@link OpenFin.View.bringToFront} for more information.
+     * @default false
+     */
+    bringToFront?: true;
+};
+
 /**
  * Represents the payload shape for Views that are trying to prevent an unload.
  * @interface
@@ -15148,7 +15198,6 @@ declare interface ViewsPreventingUnloadPayload {
  * @interface
  */
 declare type ViewState = ViewCreationOptions & {
-    backgroundThrottling: boolean;
     componentName: 'view';
     initialUrl: string;
     minWidth?: number;
@@ -15170,6 +15219,14 @@ declare interface ViewStatuses {
     viewsNotPreventingUnload: Identity_5[];
 }
 
+/**
+ * View throttling state.
+ *
+ * * `enabled`: Both background throttling and scheduler throttling are true. It's fully throttled.
+ * * `scheduler-disabled`: background throttling is true, but scheduler throttling is disabled.
+ */
+declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
+
 /**
  * Configuration for view visibility settings
  *
@@ -17713,6 +17770,16 @@ declare type WindowStartLoadEvent = BaseEvent_3 & {
  */
 declare type WindowState = 'maximized' | 'minimized' | 'normal';
 
+/**
+ *
+ * Window throttling state.
+ *
+ * * `enabled`: Both background throttling and scheduler throttling are true. It's fully throttled.
+ * * `scheduler-disabled`: The background throttling is true, but scheduler throttling is disabled.
+ * * `disabled`: The background throttling is false. The throttling is fully disabled.
+ */
+declare type WindowThrottling = 'enabled' | 'scheduler-disabled' | 'disabled';
+
 /**
  * A view-related event that fires natively on the `Window` topic.  This means that these events *do* propagate
  * to the `Application` level, with the name pattern `window-view-eventname`.

package/out/mock-public.d.ts

@@ -3477,6 +3477,16 @@ declare type ConstWindowOptions = {
      * Default is white.
      */
     backgroundColor: string;
+    /**
+     * @defaultValue false
+     *
+     * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
+     * This also affects the Page Visibility API.
+     *
+     * When `true`, the page is throttled whether it is hidden or not.
+     *
+     */
+    backgroundThrottling: boolean;
     /**
      * Configures how new content (e,g, from `window.open` or a link) is opened.
      */
@@ -8586,6 +8596,12 @@ declare type MutableViewOptions = {
     preventDragOut: boolean;
     interop?: InteropConfig;
     /* Excluded from this release type: _internalWorkspaceData */
+    /**
+     * {@inheritDoc ViewThrottling}
+     *
+     * @defaultValue 'enabled'
+     */
+    throttling: ViewThrottling;
 };
 
 /**
@@ -8829,6 +8845,14 @@ declare type MutableWindowOptions = {
     interop: InteropConfig;
     /* Excluded from this release type: _internalWorkspaceData */
     /* Excluded from this release type: workspacePlatform */
+    /**
+     * {@inheritDoc WindowThrottling}
+     *
+     * @defaultValue 'enabled'
+     *
+     * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
+     */
+    throttling: WindowThrottling;
 };
 
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -9032,6 +9056,8 @@ declare namespace OpenFin_2 {
         AutoResizeOptions,
         InteropConfig,
         ViewInfo,
+        WindowThrottling,
+        ViewThrottling,
         UpdatableViewOptions,
         ViewCreationOptions,
         MutableViewOptions,
@@ -9279,6 +9305,7 @@ declare namespace OpenFin_2 {
         ChannelProviderDisconnectionListener,
         RoutingInfo,
         DownloadShelfOptions,
+        ViewShowAtOptions,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -11408,6 +11435,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
     'get-view-options': IdentityCall<{}, OpenFin_2.ViewOptions>;
     'hide-view': IdentityCall;
     'show-view': IdentityCall;
+    'show-view-at': IdentityCall<{
+        bounds: OpenFin_2.Bounds;
+        options?: OpenFin_2.ViewShowAtOptions;
+    }>;
+    'bring-view-to-front': IdentityCall;
     'update-view-options': IdentityCall<{
         options: OpenFin_2.UpdatableViewOptions;
     }>;
@@ -14636,6 +14668,8 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
      *         left: 100,
      *         width: 300,
      *         height: 300
+     *     }, {
+     *       bringToFront : true
      *     });
      * }
      *
@@ -14645,7 +14679,15 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
      * ```
      * @experimental
      */
-    showAt: (bounds: OpenFin_2.Bounds) => Promise<void>;
+    showAt: (bounds: OpenFin_2.Bounds, options?: OpenFin_2.ViewShowAtOptions) => Promise<void>;
+    /**
+     * Brings the specified view to the front of its current window. This ensures the view will be visible on top of any other views
+     * which have overlapping bounds with it.
+     *
+     * Please note, this is not a permanent action - when a new view is created or attached to the window, it will display on top of all other views
+     * in the window that share bounds with it.
+     */
+    bringToFront: () => Promise<void>;
     /**
      * Hides the current view if it is currently visible.
      *
@@ -15117,6 +15159,14 @@ declare class ViewModule extends Base {
  */
 declare type ViewOptions = ConstViewOptions & MutableViewOptions;
 
+declare type ViewShowAtOptions = {
+    /**
+     * Sets the view as the top level view. See {@link OpenFin.View.bringToFront} for more information.
+     * @default false
+     */
+    bringToFront?: true;
+};
+
 /**
  * Represents the payload shape for Views that are trying to prevent an unload.
  * @interface
@@ -15148,7 +15198,6 @@ declare interface ViewsPreventingUnloadPayload {
  * @interface
  */
 declare type ViewState = ViewCreationOptions & {
-    backgroundThrottling: boolean;
     componentName: 'view';
     initialUrl: string;
     minWidth?: number;
@@ -15170,6 +15219,14 @@ declare interface ViewStatuses {
     viewsNotPreventingUnload: Identity_5[];
 }
 
+/**
+ * View throttling state.
+ *
+ * * `enabled`: Both background throttling and scheduler throttling are true. It's fully throttled.
+ * * `scheduler-disabled`: background throttling is true, but scheduler throttling is disabled.
+ */
+declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
+
 /**
  * Configuration for view visibility settings
  *
@@ -17713,6 +17770,16 @@ declare type WindowStartLoadEvent = BaseEvent_3 & {
  */
 declare type WindowState = 'maximized' | 'minimized' | 'normal';
 
+/**
+ *
+ * Window throttling state.
+ *
+ * * `enabled`: Both background throttling and scheduler throttling are true. It's fully throttled.
+ * * `scheduler-disabled`: The background throttling is true, but scheduler throttling is disabled.
+ * * `disabled`: The background throttling is false. The throttling is fully disabled.
+ */
+declare type WindowThrottling = 'enabled' | 'scheduler-disabled' | 'disabled';
+
 /**
  * A view-related event that fires natively on the `Window` topic.  This means that these events *do* propagate
  * to the `Application` level, with the name pattern `window-view-eventname`.

package/out/mock.d.ts

@@ -3536,6 +3536,16 @@ declare type ConstWindowOptions = {
      * Default is white.
      */
     backgroundColor: string;
+    /**
+     * @defaultValue false
+     *
+     * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
+     * This also affects the Page Visibility API.
+     *
+     * When `true`, the page is throttled whether it is hidden or not.
+     *
+     */
+    backgroundThrottling: boolean;
     /**
      * Configures how new content (e,g, from `window.open` or a link) is opened.
      */
@@ -8883,6 +8893,12 @@ declare type MutableViewOptions = {
      * Used by Workspace to store custom data. Overwriting or modifying this field may impact the functionality of Workspace
      */
     _internalWorkspaceData: any;
+    /**
+     * {@inheritDoc ViewThrottling}
+     *
+     * @defaultValue 'enabled'
+     */
+    throttling: ViewThrottling;
 };
 
 /**
@@ -9134,6 +9150,14 @@ declare type MutableWindowOptions = {
      * Used by workspace to stork platform specific options. Overwriting or modifying this field may impact the functionality of Workspace
      */
     workspacePlatform: WorkspacePlatformOptions;
+    /**
+     * {@inheritDoc WindowThrottling}
+     *
+     * @defaultValue 'enabled'
+     *
+     * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
+     */
+    throttling: WindowThrottling;
 };
 
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -9347,6 +9371,8 @@ declare namespace OpenFin_2 {
         AutoResizeOptions,
         InteropConfig,
         ViewInfo,
+        WindowThrottling,
+        ViewThrottling,
         UpdatableViewOptions,
         ViewCreationOptions,
         MutableViewOptions,
@@ -9594,6 +9620,7 @@ declare namespace OpenFin_2 {
         ChannelProviderDisconnectionListener,
         RoutingInfo,
         DownloadShelfOptions,
+        ViewShowAtOptions,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -11801,6 +11828,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
     'get-view-options': IdentityCall<{}, OpenFin_2.ViewOptions>;
     'hide-view': IdentityCall;
     'show-view': IdentityCall;
+    'show-view-at': IdentityCall<{
+        bounds: OpenFin_2.Bounds;
+        options?: OpenFin_2.ViewShowAtOptions;
+    }>;
+    'bring-view-to-front': IdentityCall;
     'update-view-options': IdentityCall<{
         options: OpenFin_2.UpdatableViewOptions;
     }>;
@@ -15045,6 +15077,8 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
      *         left: 100,
      *         width: 300,
      *         height: 300
+     *     }, {
+     *       bringToFront : true
      *     });
      * }
      *
@@ -15054,7 +15088,15 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
      * ```
      * @experimental
      */
-    showAt: (bounds: OpenFin_2.Bounds) => Promise<void>;
+    showAt: (bounds: OpenFin_2.Bounds, options?: OpenFin_2.ViewShowAtOptions) => Promise<void>;
+    /**
+     * Brings the specified view to the front of its current window. This ensures the view will be visible on top of any other views
+     * which have overlapping bounds with it.
+     *
+     * Please note, this is not a permanent action - when a new view is created or attached to the window, it will display on top of all other views
+     * in the window that share bounds with it.
+     */
+    bringToFront: () => Promise<void>;
     /**
      * Hides the current view if it is currently visible.
      *
@@ -15560,6 +15602,14 @@ declare class ViewModule extends Base {
  */
 declare type ViewOptions = ConstViewOptions & MutableViewOptions;
 
+declare type ViewShowAtOptions = {
+    /**
+     * Sets the view as the top level view. See {@link OpenFin.View.bringToFront} for more information.
+     * @default false
+     */
+    bringToFront?: true;
+};
+
 /**
  * Represents the payload shape for Views that are trying to prevent an unload.
  * @interface
@@ -15591,7 +15641,6 @@ declare interface ViewsPreventingUnloadPayload {
  * @interface
  */
 declare type ViewState = ViewCreationOptions & {
-    backgroundThrottling: boolean;
     componentName: 'view';
     initialUrl: string;
     minWidth?: number;
@@ -15613,6 +15662,14 @@ declare interface ViewStatuses {
     viewsNotPreventingUnload: Identity_5[];
 }
 
+/**
+ * View throttling state.
+ *
+ * * `enabled`: Both background throttling and scheduler throttling are true. It's fully throttled.
+ * * `scheduler-disabled`: background throttling is true, but scheduler throttling is disabled.
+ */
+declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
+
 /**
  * Configuration for view visibility settings
  *
@@ -18159,6 +18216,16 @@ declare type WindowStartLoadEvent = BaseEvent_3 & {
  */
 declare type WindowState = 'maximized' | 'minimized' | 'normal';
 
+/**
+ *
+ * Window throttling state.
+ *
+ * * `enabled`: Both background throttling and scheduler throttling are true. It's fully throttled.
+ * * `scheduler-disabled`: The background throttling is true, but scheduler throttling is disabled.
+ * * `disabled`: The background throttling is false. The throttling is fully disabled.
+ */
+declare type WindowThrottling = 'enabled' | 'scheduler-disabled' | 'disabled';
+
 /**
  * A view-related event that fires natively on the `Window` topic.  This means that these events *do* propagate
  * to the `Application` level, with the name pattern `window-view-eventname`.

package/out/mock.js

@@ -2818,6 +2818,8 @@ function requireInstance$2 () {
 	         *         left: 100,
 	         *         width: 300,
 	         *         height: 300
+	         *     }, {
+	         *       bringToFront : true
 	         *     });
 	         * }
 	         *
@@ -2827,8 +2829,18 @@ function requireInstance$2 () {
 	         * ```
 	         * @experimental
 	         */
-	        this.showAt = async (bounds) => {
-	            await this.wire.sendAction('show-view-at', { bounds, ...this.identity });
+	        this.showAt = async (bounds, options = {}) => {
+	            await this.wire.sendAction('show-view-at', { bounds, ...this.identity, options });
+	        };
+	        /**
+	         * Brings the specified view to the front of its current window. This ensures the view will be visible on top of any other views
+	         * which have overlapping bounds with it.
+	         *
+	         * Please note, this is not a permanent action - when a new view is created or attached to the window, it will display on top of all other views
+	         * in the window that share bounds with it.
+	         */
+	        this.bringToFront = async () => {
+	            await this.wire.sendAction('bring-view-to-front', { ...this.identity });
 	        };
 	        /**
 	         * Hides the current view if it is currently visible.

package/package.json

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