@openfin/fdc3-api 39.81.18 → 39.82.2

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

@@ -3474,6 +3474,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.
      */
@@ -8928,6 +8938,12 @@ declare type MutableViewOptions = {
     preventDragOut: boolean;
     interop?: InteropConfig;
     /* Excluded from this release type: _internalWorkspaceData */
+    /**
+     * {@inheritDoc ViewThrottling}
+     *
+     * @defaultValue 'enabled'
+     */
+    throttling: ViewThrottling;
 };
 
 /**
@@ -9171,6 +9187,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;
@@ -9374,6 +9398,8 @@ declare namespace OpenFin {
         AutoResizeOptions,
         InteropConfig,
         ViewInfo,
+        WindowThrottling,
+        ViewThrottling,
         UpdatableViewOptions,
         ViewCreationOptions,
         MutableViewOptions,
@@ -9621,6 +9647,7 @@ declare namespace OpenFin {
         ChannelProviderDisconnectionListener,
         RoutingInfo,
         DownloadShelfOptions,
+        ViewShowAtOptions,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -11748,6 +11775,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
     'get-view-options': IdentityCall<{}, OpenFin.ViewOptions>;
     'hide-view': IdentityCall;
     'show-view': IdentityCall;
+    'show-view-at': IdentityCall<{
+        bounds: OpenFin.Bounds;
+        options?: OpenFin.ViewShowAtOptions;
+    }>;
+    'bring-view-to-front': IdentityCall;
     'update-view-options': IdentityCall<{
         options: OpenFin.UpdatableViewOptions;
     }>;
@@ -15082,6 +15114,8 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      *         left: 100,
      *         width: 300,
      *         height: 300
+     *     }, {
+     *       bringToFront : true
      *     });
      * }
      *
@@ -15091,7 +15125,15 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      * ```
      * @experimental
      */
-    showAt: (bounds: OpenFin.Bounds) => Promise<void>;
+    showAt: (bounds: OpenFin.Bounds, options?: OpenFin.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.
      *
@@ -15563,6 +15605,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
@@ -15594,7 +15644,6 @@ declare interface ViewsPreventingUnloadPayload {
  * @interface
  */
 declare type ViewState = ViewCreationOptions & {
-    backgroundThrottling: boolean;
     componentName: 'view';
     initialUrl: string;
     minWidth?: number;
@@ -15616,6 +15665,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/fdc3-api-beta.d.ts

@@ -3474,6 +3474,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.
      */
@@ -8928,6 +8938,12 @@ declare type MutableViewOptions = {
     preventDragOut: boolean;
     interop?: InteropConfig;
     /* Excluded from this release type: _internalWorkspaceData */
+    /**
+     * {@inheritDoc ViewThrottling}
+     *
+     * @defaultValue 'enabled'
+     */
+    throttling: ViewThrottling;
 };
 
 /**
@@ -9171,6 +9187,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;
@@ -9374,6 +9398,8 @@ declare namespace OpenFin {
         AutoResizeOptions,
         InteropConfig,
         ViewInfo,
+        WindowThrottling,
+        ViewThrottling,
         UpdatableViewOptions,
         ViewCreationOptions,
         MutableViewOptions,
@@ -9621,6 +9647,7 @@ declare namespace OpenFin {
         ChannelProviderDisconnectionListener,
         RoutingInfo,
         DownloadShelfOptions,
+        ViewShowAtOptions,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -11748,6 +11775,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
     'get-view-options': IdentityCall<{}, OpenFin.ViewOptions>;
     'hide-view': IdentityCall;
     'show-view': IdentityCall;
+    'show-view-at': IdentityCall<{
+        bounds: OpenFin.Bounds;
+        options?: OpenFin.ViewShowAtOptions;
+    }>;
+    'bring-view-to-front': IdentityCall;
     'update-view-options': IdentityCall<{
         options: OpenFin.UpdatableViewOptions;
     }>;
@@ -15082,6 +15114,8 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      *         left: 100,
      *         width: 300,
      *         height: 300
+     *     }, {
+     *       bringToFront : true
      *     });
      * }
      *
@@ -15091,7 +15125,15 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      * ```
      * @experimental
      */
-    showAt: (bounds: OpenFin.Bounds) => Promise<void>;
+    showAt: (bounds: OpenFin.Bounds, options?: OpenFin.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.
      *
@@ -15563,6 +15605,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
@@ -15594,7 +15644,6 @@ declare interface ViewsPreventingUnloadPayload {
  * @interface
  */
 declare type ViewState = ViewCreationOptions & {
-    backgroundThrottling: boolean;
     componentName: 'view';
     initialUrl: string;
     minWidth?: number;
@@ -15616,6 +15665,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/fdc3-api-public.d.ts

@@ -3474,6 +3474,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.
      */
@@ -8928,6 +8938,12 @@ declare type MutableViewOptions = {
     preventDragOut: boolean;
     interop?: InteropConfig;
     /* Excluded from this release type: _internalWorkspaceData */
+    /**
+     * {@inheritDoc ViewThrottling}
+     *
+     * @defaultValue 'enabled'
+     */
+    throttling: ViewThrottling;
 };
 
 /**
@@ -9171,6 +9187,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;
@@ -9374,6 +9398,8 @@ declare namespace OpenFin {
         AutoResizeOptions,
         InteropConfig,
         ViewInfo,
+        WindowThrottling,
+        ViewThrottling,
         UpdatableViewOptions,
         ViewCreationOptions,
         MutableViewOptions,
@@ -9621,6 +9647,7 @@ declare namespace OpenFin {
         ChannelProviderDisconnectionListener,
         RoutingInfo,
         DownloadShelfOptions,
+        ViewShowAtOptions,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -11748,6 +11775,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
     'get-view-options': IdentityCall<{}, OpenFin.ViewOptions>;
     'hide-view': IdentityCall;
     'show-view': IdentityCall;
+    'show-view-at': IdentityCall<{
+        bounds: OpenFin.Bounds;
+        options?: OpenFin.ViewShowAtOptions;
+    }>;
+    'bring-view-to-front': IdentityCall;
     'update-view-options': IdentityCall<{
         options: OpenFin.UpdatableViewOptions;
     }>;
@@ -15082,6 +15114,8 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      *         left: 100,
      *         width: 300,
      *         height: 300
+     *     }, {
+     *       bringToFront : true
      *     });
      * }
      *
@@ -15091,7 +15125,15 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      * ```
      * @experimental
      */
-    showAt: (bounds: OpenFin.Bounds) => Promise<void>;
+    showAt: (bounds: OpenFin.Bounds, options?: OpenFin.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.
      *
@@ -15563,6 +15605,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
@@ -15594,7 +15644,6 @@ declare interface ViewsPreventingUnloadPayload {
  * @interface
  */
 declare type ViewState = ViewCreationOptions & {
-    backgroundThrottling: boolean;
     componentName: 'view';
     initialUrl: string;
     minWidth?: number;
@@ -15616,6 +15665,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/fdc3-api.d.ts

@@ -3533,6 +3533,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.
      */
@@ -9225,6 +9235,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;
 };
 
 /**
@@ -9476,6 +9492,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;
@@ -9689,6 +9713,8 @@ declare namespace OpenFin {
         AutoResizeOptions,
         InteropConfig,
         ViewInfo,
+        WindowThrottling,
+        ViewThrottling,
         UpdatableViewOptions,
         ViewCreationOptions,
         MutableViewOptions,
@@ -9936,6 +9962,7 @@ declare namespace OpenFin {
         ChannelProviderDisconnectionListener,
         RoutingInfo,
         DownloadShelfOptions,
+        ViewShowAtOptions,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -12141,6 +12168,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
     'get-view-options': IdentityCall<{}, OpenFin.ViewOptions>;
     'hide-view': IdentityCall;
     'show-view': IdentityCall;
+    'show-view-at': IdentityCall<{
+        bounds: OpenFin.Bounds;
+        options?: OpenFin.ViewShowAtOptions;
+    }>;
+    'bring-view-to-front': IdentityCall;
     'update-view-options': IdentityCall<{
         options: OpenFin.UpdatableViewOptions;
     }>;
@@ -15491,6 +15523,8 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      *         left: 100,
      *         width: 300,
      *         height: 300
+     *     }, {
+     *       bringToFront : true
      *     });
      * }
      *
@@ -15500,7 +15534,15 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      * ```
      * @experimental
      */
-    showAt: (bounds: OpenFin.Bounds) => Promise<void>;
+    showAt: (bounds: OpenFin.Bounds, options?: OpenFin.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.
      *
@@ -16006,6 +16048,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
@@ -16037,7 +16087,6 @@ declare interface ViewsPreventingUnloadPayload {
  * @interface
  */
 declare type ViewState = ViewCreationOptions & {
-    backgroundThrottling: boolean;
     componentName: 'view';
     initialUrl: string;
     minWidth?: number;
@@ -16059,6 +16108,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
  *
@@ -18605,6 +18662,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/package.json

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