@openfin/core 45.102.1 → 45.102.2

package/out/mock-alpha.d.ts

@@ -2000,6 +2000,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.
  *
@@ -5387,6 +5389,16 @@ declare interface Environment {
     resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
     initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.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/mock-beta.d.ts

@@ -2000,6 +2000,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.
  *
@@ -5387,6 +5389,16 @@ declare interface Environment {
     resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
     initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.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/mock-public.d.ts

@@ -2000,6 +2000,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.
  *
@@ -5387,6 +5389,16 @@ declare interface Environment {
     resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
     initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.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/stub.d.ts

@@ -2032,6 +2032,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.
  *
@@ -5498,6 +5500,16 @@ declare interface Environment {
     resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
     initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.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/stub.js

@@ -17134,6 +17134,15 @@ class Transport extends events.EventEmitter {
         const { uuid, name } = config;
         const entityType = this.environment.getCurrentEntityType();
         this.me = getBaseMe(entityType, uuid, name);
+        // Registered here rather than per-caller so that a restoration is logged exactly once,
+        // however many parts of the adapter go on to subscribe.
+        this.environment.onBFCacheRestore(async () => {
+            await this.sendAction('write-to-log', {
+                level: 'verbose',
+                message: `Page restored from the back/forward cache for ${uuid}/${name}`,
+                target: {}
+            });
+        });
     }
     getFin() {
         if (!__classPrivateFieldGet(this, _Transport_fin, "f")) {
@@ -17376,6 +17385,11 @@ class StubEnvironment {
     observeBounds() {
         throw new Error(environmentUnsupportedMessage);
     }
+    onBFCacheRestore(listener) {
+        // Deliberately not throwing: callers register unconditionally, including from the
+        // Transport constructor, which the stub environment has to survive.
+        return () => undefined;
+    }
     writeToken(path, token) {
         throw new Error(environmentUnsupportedMessage);
     }

package/out/stub.mjs

@@ -17092,6 +17092,15 @@ class Transport extends EventEmitter {
         const { uuid, name } = config;
         const entityType = this.environment.getCurrentEntityType();
         this.me = getBaseMe(entityType, uuid, name);
+        // Registered here rather than per-caller so that a restoration is logged exactly once,
+        // however many parts of the adapter go on to subscribe.
+        this.environment.onBFCacheRestore(async () => {
+            await this.sendAction('write-to-log', {
+                level: 'verbose',
+                message: `Page restored from the back/forward cache for ${uuid}/${name}`,
+                target: {}
+            });
+        });
     }
     getFin() {
         if (!__classPrivateFieldGet(this, _Transport_fin, "f")) {
@@ -17334,6 +17343,11 @@ class StubEnvironment {
     observeBounds() {
         throw new Error(environmentUnsupportedMessage);
     }
+    onBFCacheRestore(listener) {
+        // Deliberately not throwing: callers register unconditionally, including from the
+        // Transport constructor, which the stub environment has to survive.
+        return () => undefined;
+    }
     writeToken(path, token) {
         throw new Error(environmentUnsupportedMessage);
     }

package/package.json

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