@openfin/fdc3-api 45.102.1 → 45.200.1

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

@@ -1997,6 +1997,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.
  *
@@ -5336,6 +5338,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;

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

@@ -1997,6 +1997,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.
  *
@@ -5336,6 +5338,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;

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

@@ -1997,6 +1997,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.
  *
@@ -5336,6 +5338,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;

package/out/fdc3-api.d.ts

@@ -2029,6 +2029,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.
  *
@@ -5447,6 +5449,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;

package/package.json

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