@openfin/fdc3-api 46.100.85 → 46.100.88

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

@@ -1994,6 +1994,8 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
     type: 'begin-user-bounds-changing';
 };
 
+declare type BFCacheRestoreListener = () => void | Promise<void>;
+
 /**
  * A rule prescribing content creation that should be blocked.
  *
@@ -5333,6 +5335,16 @@ declare interface Environment {
     resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
     initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
     observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
+    /**
+     * Registers a listener invoked when the current page has been restored from the
+     * browser's back/forward cache. Stateful APIs (e.g. channels) use this to re-establish
+     * connections that were torn down while the page was cached.
+     *
+     * No-op in environments that cannot be bfcached.
+     *
+     * @returns a function that unregisters the listener.
+     */
+    onBFCacheRestore(listener: BFCacheRestoreListener): () => void;
     writeToken(path: string, token: string): Promise<string>;
     retrievePort(config: NewConnectConfig): Promise<number>;
     getNextMessageId(): any;
@@ -5787,7 +5799,7 @@ declare type ExtensionWindowCreatedEvent = BaseEvent_5 & {
  * these api calls are not implemented in the javscript api, only in the external adapter
  * If they don't exist in the external adapter they should be removed.
  */
-declare type ExternalAdapterOnlyCalls = 'subscriber-added' | 'subscriber-removed' | 'clipboard-clear' | 'create-proxy-socket' | 'authenticate-proxy-socket' | 'convert-options' | 'generate-guid' | 'get-config' | 'get-remote-config' | 'get-nearest-display-root' | 'get-preload-scripts' | 'raise-event' | 'set-window-preload-state' | 'dock-window' | 'get-current-window-options' | 'redirect-window-to-url' | 'request-new-content' | 'raise-many-events' | 'show-menu' | 'resolve-proxy' | 'undock-window' | 'window-embedded' | 'window-get-cached-bounds' | 'resource-fetch-authenticate' | 'set-cookie';
+declare type ExternalAdapterOnlyCalls = 'subscriber-added' | 'subscriber-removed' | 'clipboard-clear' | 'convert-options' | 'generate-guid' | 'get-config' | 'get-remote-config' | 'get-nearest-display-root' | 'get-preload-scripts' | 'raise-event' | 'set-window-preload-state' | 'dock-window' | 'get-current-window-options' | 'redirect-window-to-url' | 'request-new-content' | 'raise-many-events' | 'show-menu' | 'resolve-proxy' | 'undock-window' | 'window-embedded' | 'window-get-cached-bounds' | 'resource-fetch-authenticate' | 'set-cookie';
 
 declare type ExternalAdapterOnlyCallsMap = {
     [k in ExternalAdapterOnlyCalls]: {
@@ -7396,16 +7408,21 @@ declare class InterApplicationBus extends Base {
      * Subscribes to messages from the specified application on the specified topic.
      * @param source This object is described in the Identity in the typedef
      * @param topic The topic on which the message is sent
-     * @param listener A function that is called when a message has
-     * been received. It is passed the message, uuid and name of the sending application.
+     * @param listener A function that is called when a message has been received. It is passed
+     * two arguments: the message, and the identity (`{ uuid, name }`) of the sender.
      * The message can be either a primitive data type (string, number, or boolean) or
      * composite data type (object, array) that is composed of other primitive or composite
      * data types
      *
+     * @remarks This differs from the legacy `fin.desktop.InterApplicationBus.subscribe` API,
+     * which passes `(message, uuid, name)` as separate arguments.
+     *
      * @example
      * ```js
      * // subscribe to a specified application
-     * fin.InterApplicationBus.subscribe(fin.me, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
+     * fin.InterApplicationBus.subscribe(fin.me, 'topic', (message, sender) => {
+     *     console.log(`Received from ${sender.uuid}/${sender.name}:`, message);
+     * }).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
      *
      * // subscribe to wildcard
      * fin.InterApplicationBus.subscribe({ uuid: '*' }, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to *')).catch(err => console.log(err));
@@ -20526,6 +20543,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
     /**
      * Removes focus from the window.
      *
+     * @remarks On macOS, a modal window (created with `modalParentIdentity`) is hidden instead, because
+     * moving a modal sheet behind its parent would leave the parent unable to show other dialogs.
+     *
      * @example
      * ```js
      * async function blurWindow() {

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

@@ -1994,6 +1994,8 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
     type: 'begin-user-bounds-changing';
 };
 
+declare type BFCacheRestoreListener = () => void | Promise<void>;
+
 /**
  * A rule prescribing content creation that should be blocked.
  *
@@ -5333,6 +5335,16 @@ declare interface Environment {
     resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
     initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
     observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
+    /**
+     * Registers a listener invoked when the current page has been restored from the
+     * browser's back/forward cache. Stateful APIs (e.g. channels) use this to re-establish
+     * connections that were torn down while the page was cached.
+     *
+     * No-op in environments that cannot be bfcached.
+     *
+     * @returns a function that unregisters the listener.
+     */
+    onBFCacheRestore(listener: BFCacheRestoreListener): () => void;
     writeToken(path: string, token: string): Promise<string>;
     retrievePort(config: NewConnectConfig): Promise<number>;
     getNextMessageId(): any;
@@ -5787,7 +5799,7 @@ declare type ExtensionWindowCreatedEvent = BaseEvent_5 & {
  * these api calls are not implemented in the javscript api, only in the external adapter
  * If they don't exist in the external adapter they should be removed.
  */
-declare type ExternalAdapterOnlyCalls = 'subscriber-added' | 'subscriber-removed' | 'clipboard-clear' | 'create-proxy-socket' | 'authenticate-proxy-socket' | 'convert-options' | 'generate-guid' | 'get-config' | 'get-remote-config' | 'get-nearest-display-root' | 'get-preload-scripts' | 'raise-event' | 'set-window-preload-state' | 'dock-window' | 'get-current-window-options' | 'redirect-window-to-url' | 'request-new-content' | 'raise-many-events' | 'show-menu' | 'resolve-proxy' | 'undock-window' | 'window-embedded' | 'window-get-cached-bounds' | 'resource-fetch-authenticate' | 'set-cookie';
+declare type ExternalAdapterOnlyCalls = 'subscriber-added' | 'subscriber-removed' | 'clipboard-clear' | 'convert-options' | 'generate-guid' | 'get-config' | 'get-remote-config' | 'get-nearest-display-root' | 'get-preload-scripts' | 'raise-event' | 'set-window-preload-state' | 'dock-window' | 'get-current-window-options' | 'redirect-window-to-url' | 'request-new-content' | 'raise-many-events' | 'show-menu' | 'resolve-proxy' | 'undock-window' | 'window-embedded' | 'window-get-cached-bounds' | 'resource-fetch-authenticate' | 'set-cookie';
 
 declare type ExternalAdapterOnlyCallsMap = {
     [k in ExternalAdapterOnlyCalls]: {
@@ -7396,16 +7408,21 @@ declare class InterApplicationBus extends Base {
      * Subscribes to messages from the specified application on the specified topic.
      * @param source This object is described in the Identity in the typedef
      * @param topic The topic on which the message is sent
-     * @param listener A function that is called when a message has
-     * been received. It is passed the message, uuid and name of the sending application.
+     * @param listener A function that is called when a message has been received. It is passed
+     * two arguments: the message, and the identity (`{ uuid, name }`) of the sender.
      * The message can be either a primitive data type (string, number, or boolean) or
      * composite data type (object, array) that is composed of other primitive or composite
      * data types
      *
+     * @remarks This differs from the legacy `fin.desktop.InterApplicationBus.subscribe` API,
+     * which passes `(message, uuid, name)` as separate arguments.
+     *
      * @example
      * ```js
      * // subscribe to a specified application
-     * fin.InterApplicationBus.subscribe(fin.me, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
+     * fin.InterApplicationBus.subscribe(fin.me, 'topic', (message, sender) => {
+     *     console.log(`Received from ${sender.uuid}/${sender.name}:`, message);
+     * }).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
      *
      * // subscribe to wildcard
      * fin.InterApplicationBus.subscribe({ uuid: '*' }, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to *')).catch(err => console.log(err));
@@ -20526,6 +20543,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
     /**
      * Removes focus from the window.
      *
+     * @remarks On macOS, a modal window (created with `modalParentIdentity`) is hidden instead, because
+     * moving a modal sheet behind its parent would leave the parent unable to show other dialogs.
+     *
      * @example
      * ```js
      * async function blurWindow() {

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

@@ -1994,6 +1994,8 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
     type: 'begin-user-bounds-changing';
 };
 
+declare type BFCacheRestoreListener = () => void | Promise<void>;
+
 /**
  * A rule prescribing content creation that should be blocked.
  *
@@ -5333,6 +5335,16 @@ declare interface Environment {
     resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
     initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
     observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
+    /**
+     * Registers a listener invoked when the current page has been restored from the
+     * browser's back/forward cache. Stateful APIs (e.g. channels) use this to re-establish
+     * connections that were torn down while the page was cached.
+     *
+     * No-op in environments that cannot be bfcached.
+     *
+     * @returns a function that unregisters the listener.
+     */
+    onBFCacheRestore(listener: BFCacheRestoreListener): () => void;
     writeToken(path: string, token: string): Promise<string>;
     retrievePort(config: NewConnectConfig): Promise<number>;
     getNextMessageId(): any;
@@ -5787,7 +5799,7 @@ declare type ExtensionWindowCreatedEvent = BaseEvent_5 & {
  * these api calls are not implemented in the javscript api, only in the external adapter
  * If they don't exist in the external adapter they should be removed.
  */
-declare type ExternalAdapterOnlyCalls = 'subscriber-added' | 'subscriber-removed' | 'clipboard-clear' | 'create-proxy-socket' | 'authenticate-proxy-socket' | 'convert-options' | 'generate-guid' | 'get-config' | 'get-remote-config' | 'get-nearest-display-root' | 'get-preload-scripts' | 'raise-event' | 'set-window-preload-state' | 'dock-window' | 'get-current-window-options' | 'redirect-window-to-url' | 'request-new-content' | 'raise-many-events' | 'show-menu' | 'resolve-proxy' | 'undock-window' | 'window-embedded' | 'window-get-cached-bounds' | 'resource-fetch-authenticate' | 'set-cookie';
+declare type ExternalAdapterOnlyCalls = 'subscriber-added' | 'subscriber-removed' | 'clipboard-clear' | 'convert-options' | 'generate-guid' | 'get-config' | 'get-remote-config' | 'get-nearest-display-root' | 'get-preload-scripts' | 'raise-event' | 'set-window-preload-state' | 'dock-window' | 'get-current-window-options' | 'redirect-window-to-url' | 'request-new-content' | 'raise-many-events' | 'show-menu' | 'resolve-proxy' | 'undock-window' | 'window-embedded' | 'window-get-cached-bounds' | 'resource-fetch-authenticate' | 'set-cookie';
 
 declare type ExternalAdapterOnlyCallsMap = {
     [k in ExternalAdapterOnlyCalls]: {
@@ -7396,16 +7408,21 @@ declare class InterApplicationBus extends Base {
      * Subscribes to messages from the specified application on the specified topic.
      * @param source This object is described in the Identity in the typedef
      * @param topic The topic on which the message is sent
-     * @param listener A function that is called when a message has
-     * been received. It is passed the message, uuid and name of the sending application.
+     * @param listener A function that is called when a message has been received. It is passed
+     * two arguments: the message, and the identity (`{ uuid, name }`) of the sender.
      * The message can be either a primitive data type (string, number, or boolean) or
      * composite data type (object, array) that is composed of other primitive or composite
      * data types
      *
+     * @remarks This differs from the legacy `fin.desktop.InterApplicationBus.subscribe` API,
+     * which passes `(message, uuid, name)` as separate arguments.
+     *
      * @example
      * ```js
      * // subscribe to a specified application
-     * fin.InterApplicationBus.subscribe(fin.me, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
+     * fin.InterApplicationBus.subscribe(fin.me, 'topic', (message, sender) => {
+     *     console.log(`Received from ${sender.uuid}/${sender.name}:`, message);
+     * }).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
      *
      * // subscribe to wildcard
      * fin.InterApplicationBus.subscribe({ uuid: '*' }, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to *')).catch(err => console.log(err));
@@ -20526,6 +20543,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
     /**
      * Removes focus from the window.
      *
+     * @remarks On macOS, a modal window (created with `modalParentIdentity`) is hidden instead, because
+     * moving a modal sheet behind its parent would leave the parent unable to show other dialogs.
+     *
      * @example
      * ```js
      * async function blurWindow() {

package/out/fdc3-api.d.ts

@@ -2027,6 +2027,8 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
     type: 'begin-user-bounds-changing';
 };
 
+declare type BFCacheRestoreListener = () => void | Promise<void>;
+
 /**
  * A rule prescribing content creation that should be blocked.
  *
@@ -5445,6 +5447,16 @@ declare interface Environment {
     resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
     initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
     observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
+    /**
+     * Registers a listener invoked when the current page has been restored from the
+     * browser's back/forward cache. Stateful APIs (e.g. channels) use this to re-establish
+     * connections that were torn down while the page was cached.
+     *
+     * No-op in environments that cannot be bfcached.
+     *
+     * @returns a function that unregisters the listener.
+     */
+    onBFCacheRestore(listener: BFCacheRestoreListener): () => void;
     writeToken(path: string, token: string): Promise<string>;
     retrievePort(config: NewConnectConfig): Promise<number>;
     getNextMessageId(): any;
@@ -5917,7 +5929,7 @@ declare type ExtensionWindowCreatedEvent = BaseEvent_5 & {
  * these api calls are not implemented in the javscript api, only in the external adapter
  * If they don't exist in the external adapter they should be removed.
  */
-declare type ExternalAdapterOnlyCalls = 'subscriber-added' | 'subscriber-removed' | 'clipboard-clear' | 'create-proxy-socket' | 'authenticate-proxy-socket' | 'convert-options' | 'generate-guid' | 'get-config' | 'get-remote-config' | 'get-nearest-display-root' | 'get-preload-scripts' | 'raise-event' | 'set-window-preload-state' | 'dock-window' | 'get-current-window-options' | 'redirect-window-to-url' | 'request-new-content' | 'raise-many-events' | 'show-menu' | 'resolve-proxy' | 'undock-window' | 'window-embedded' | 'window-get-cached-bounds' | 'resource-fetch-authenticate' | 'set-cookie';
+declare type ExternalAdapterOnlyCalls = 'subscriber-added' | 'subscriber-removed' | 'clipboard-clear' | 'convert-options' | 'generate-guid' | 'get-config' | 'get-remote-config' | 'get-nearest-display-root' | 'get-preload-scripts' | 'raise-event' | 'set-window-preload-state' | 'dock-window' | 'get-current-window-options' | 'redirect-window-to-url' | 'request-new-content' | 'raise-many-events' | 'show-menu' | 'resolve-proxy' | 'undock-window' | 'window-embedded' | 'window-get-cached-bounds' | 'resource-fetch-authenticate' | 'set-cookie';
 
 declare type ExternalAdapterOnlyCallsMap = {
     [k in ExternalAdapterOnlyCalls]: {
@@ -7547,16 +7559,21 @@ declare class InterApplicationBus extends Base {
      * Subscribes to messages from the specified application on the specified topic.
      * @param source This object is described in the Identity in the typedef
      * @param topic The topic on which the message is sent
-     * @param listener A function that is called when a message has
-     * been received. It is passed the message, uuid and name of the sending application.
+     * @param listener A function that is called when a message has been received. It is passed
+     * two arguments: the message, and the identity (`{ uuid, name }`) of the sender.
      * The message can be either a primitive data type (string, number, or boolean) or
      * composite data type (object, array) that is composed of other primitive or composite
      * data types
      *
+     * @remarks This differs from the legacy `fin.desktop.InterApplicationBus.subscribe` API,
+     * which passes `(message, uuid, name)` as separate arguments.
+     *
      * @example
      * ```js
      * // subscribe to a specified application
-     * fin.InterApplicationBus.subscribe(fin.me, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
+     * fin.InterApplicationBus.subscribe(fin.me, 'topic', (message, sender) => {
+     *     console.log(`Received from ${sender.uuid}/${sender.name}:`, message);
+     * }).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
      *
      * // subscribe to wildcard
      * fin.InterApplicationBus.subscribe({ uuid: '*' }, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to *')).catch(err => console.log(err));
@@ -21065,6 +21082,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
     /**
      * Removes focus from the window.
      *
+     * @remarks On macOS, a modal window (created with `modalParentIdentity`) is hidden instead, because
+     * moving a modal sheet behind its parent would leave the parent unable to show other dialogs.
+     *
      * @example
      * ```js
      * async function blurWindow() {

package/package.json

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