@openfin/fdc3-api 47.100.26 → 47.100.29

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

@@ -2755,12 +2755,9 @@ declare class ChannelBase {
  */
 declare class ChannelClient extends ChannelBase {
     #private;
-    private disconnectListener;
-    private endpointId;
-    /* Excluded from this release type: closeChannelByEndpointId */
-    /* Excluded from this release type: handleProviderDisconnect */
     /* Excluded from this release type: __constructor */
     protected processAction: (action: string, payload: any, senderIdentity: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<any>;
+    /* Excluded from this release type: [teardown] */
     /**
      * a read-only provider identity
      */
@@ -2792,8 +2789,8 @@ declare class ChannelClient extends ChannelBase {
      */
     dispatch(action: string, payload?: any): Promise<any>;
     /**
-     * Register a listener that is called on provider disconnection. It is passed the disconnection event of the
-     * disconnecting provider.
+     * Register a listener that is called when this client loses its channel: the provider disconnects, the
+     * endpoint drops, or a self-heal fails. It is passed the provider identity.
      *
      * @param listener
      *
@@ -2810,6 +2807,43 @@ declare class ChannelClient extends ChannelBase {
      * ```
      */
     onDisconnection(listener: OpenFin.ChannelProviderDisconnectionListener): void;
+    /**
+     * Register a listener that is called each time this client transparently self-heals its connection to the
+     * provider.
+     *
+     * @remarks
+     * A channel client's underlying endpoint is torn down while its document sits in the back/forward cache
+     * (bfcache). If the back/forward cache is supported and the document is restored from it, the client
+     * automatically re-handshakes with the provider and swaps in a fresh endpoint; all of this client's
+     * `register`/middleware handlers are preserved, so no re-registration is required.
+     *
+     * A restore is not guaranteed: Chromium may evict a cached document at any time, in which case navigating
+     * back reloads the page and a new client must connect.
+     *
+     * This listener fires once per successful reconnect, after the new endpoint is live, and can fire multiple
+     * times over the client's lifetime. It is triggered when the document is restored from the back/forward
+     * cache (a bfcache `pageshow`). It does not fire for the initial connection, nor after
+     * {@link ChannelClient#disconnect disconnect}. {@link ChannelClient#onDisconnection onDisconnection} fires
+     * when the provider or endpoint goes away.
+     *
+     * The info provides the reconnected {@link OpenFin.ProviderIdentity provider identity} along with
+     * the previous and new endpoint ids.
+     *
+     * @param listener
+     *
+     * @example
+     *
+     * ```js
+     * (async () => {
+     *     const client = await fin.InterApplicationBus.Channel.connect('channelName');
+     *
+     *     client.onReconnection(({ providerIdentity, previousEndpointId, endpointId }) => {
+     *         console.log(`Reconnected to ${providerIdentity.channelName}: ${previousEndpointId} -> ${endpointId}`);
+     *     });
+     * })();
+     * ```
+     */
+    onReconnection(listener: OpenFin.ChannelClientReconnectionListener): void;
     /**
      * Disconnects the client from the channel.
      *
@@ -2824,16 +2858,42 @@ declare class ChannelClient extends ChannelBase {
      * ```
      */
     disconnect(): Promise<void>;
-    sendDisconnectAction(): Promise<void>;
-    /* Excluded from this release type: wireClose */
+    /* Excluded from this release type: sendDisconnectAction */
 }
 
 declare type ChannelClient_2 = OpenFin.ChannelClient;
 
+/* Excluded from this release type: ChannelClientConfig */
+
 declare type ChannelClientConnectionListener = (identity: ClientIdentity, connectionMessage?: any) => Promise<any> | any;
 
 declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
 
+/**
+ * Info passed to a {@link ChannelClient.onReconnection} listener when a channel client
+ * re-establishes its connection to the provider after its endpoint was torn down.
+ */
+declare type ChannelClientReconnectionInfo = {
+    /** Identity of the provider this client re-established its connection to. */
+    providerIdentity: ProviderIdentity_4;
+    /** The client's endpoint id before the reconnect (now torn down). */
+    previousEndpointId: string;
+    /** The client's endpoint id after the reconnect. */
+    endpointId: string;
+};
+
+/**
+ * Listener registered via {@link ChannelClient.onReconnection}, called once each time the client self-heals its
+ * connection to the provider.
+ *
+ * Currently, this will only occur during a [bfcache](https://developer.mozilla.org/en-US/docs/Glossary/bfcache) Restore.
+ *
+ * For example, if the Channel Client belongs to a Window / View that is compatible with the bfcache, and
+ * the Window / View is navigated away from and then back to using the history API, the Channel Client will re-establish its connection to the provider if it still
+ * exists.
+ */
+declare type ChannelClientReconnectionListener = (info: ChannelClientReconnectionInfo) => void;
+
 /**
  * Options provided on a client connection to a channel.
  *
@@ -5253,6 +5313,8 @@ declare type EndLoadEvent = BaseEvent_5 & {
     isMain: boolean;
 };
 
+/* Excluded from this release type: EndpointConnectionInstance */
+
 /**
  * Generated at the end of a user-driven change to a window's size or position.
  *
@@ -7364,6 +7426,11 @@ declare class InterApplicationBus extends Base {
         subscriberRemoved: string;
     };
     private refCounter;
+    /**
+     * One entry per subscription the runtime knows about, keyed by the same subscription key the
+     * emitter and the ref counter use. Listeners sharing a key share a single entry.
+     */
+    private activeSubscriptions;
     protected emitter: EventEmitter;
     on: any;
     removeAllListeners: any;
@@ -7403,16 +7470,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));
@@ -11399,6 +11471,8 @@ declare namespace OpenFin {
         ChannelClientConnectionListener,
         ChannelClientDisconnectionListener,
         ChannelProviderDisconnectionListener,
+        ChannelClientReconnectionInfo,
+        ChannelClientReconnectionListener,
         RoutingInfo,
         DownloadShelfOptions,
         SnapZoneOptions,
@@ -17806,6 +17880,8 @@ declare type TaskBar = DipScaleRects & {
     rect: RectangleByEdgePositions;
 };
 
+declare const teardown: unique symbol;
+
 /**
  * @interface
  */

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

@@ -2755,12 +2755,9 @@ declare class ChannelBase {
  */
 declare class ChannelClient extends ChannelBase {
     #private;
-    private disconnectListener;
-    private endpointId;
-    /* Excluded from this release type: closeChannelByEndpointId */
-    /* Excluded from this release type: handleProviderDisconnect */
     /* Excluded from this release type: __constructor */
     protected processAction: (action: string, payload: any, senderIdentity: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<any>;
+    /* Excluded from this release type: [teardown] */
     /**
      * a read-only provider identity
      */
@@ -2792,8 +2789,8 @@ declare class ChannelClient extends ChannelBase {
      */
     dispatch(action: string, payload?: any): Promise<any>;
     /**
-     * Register a listener that is called on provider disconnection. It is passed the disconnection event of the
-     * disconnecting provider.
+     * Register a listener that is called when this client loses its channel: the provider disconnects, the
+     * endpoint drops, or a self-heal fails. It is passed the provider identity.
      *
      * @param listener
      *
@@ -2810,6 +2807,43 @@ declare class ChannelClient extends ChannelBase {
      * ```
      */
     onDisconnection(listener: OpenFin.ChannelProviderDisconnectionListener): void;
+    /**
+     * Register a listener that is called each time this client transparently self-heals its connection to the
+     * provider.
+     *
+     * @remarks
+     * A channel client's underlying endpoint is torn down while its document sits in the back/forward cache
+     * (bfcache). If the back/forward cache is supported and the document is restored from it, the client
+     * automatically re-handshakes with the provider and swaps in a fresh endpoint; all of this client's
+     * `register`/middleware handlers are preserved, so no re-registration is required.
+     *
+     * A restore is not guaranteed: Chromium may evict a cached document at any time, in which case navigating
+     * back reloads the page and a new client must connect.
+     *
+     * This listener fires once per successful reconnect, after the new endpoint is live, and can fire multiple
+     * times over the client's lifetime. It is triggered when the document is restored from the back/forward
+     * cache (a bfcache `pageshow`). It does not fire for the initial connection, nor after
+     * {@link ChannelClient#disconnect disconnect}. {@link ChannelClient#onDisconnection onDisconnection} fires
+     * when the provider or endpoint goes away.
+     *
+     * The info provides the reconnected {@link OpenFin.ProviderIdentity provider identity} along with
+     * the previous and new endpoint ids.
+     *
+     * @param listener
+     *
+     * @example
+     *
+     * ```js
+     * (async () => {
+     *     const client = await fin.InterApplicationBus.Channel.connect('channelName');
+     *
+     *     client.onReconnection(({ providerIdentity, previousEndpointId, endpointId }) => {
+     *         console.log(`Reconnected to ${providerIdentity.channelName}: ${previousEndpointId} -> ${endpointId}`);
+     *     });
+     * })();
+     * ```
+     */
+    onReconnection(listener: OpenFin.ChannelClientReconnectionListener): void;
     /**
      * Disconnects the client from the channel.
      *
@@ -2824,16 +2858,42 @@ declare class ChannelClient extends ChannelBase {
      * ```
      */
     disconnect(): Promise<void>;
-    sendDisconnectAction(): Promise<void>;
-    /* Excluded from this release type: wireClose */
+    /* Excluded from this release type: sendDisconnectAction */
 }
 
 declare type ChannelClient_2 = OpenFin.ChannelClient;
 
+/* Excluded from this release type: ChannelClientConfig */
+
 declare type ChannelClientConnectionListener = (identity: ClientIdentity, connectionMessage?: any) => Promise<any> | any;
 
 declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
 
+/**
+ * Info passed to a {@link ChannelClient.onReconnection} listener when a channel client
+ * re-establishes its connection to the provider after its endpoint was torn down.
+ */
+declare type ChannelClientReconnectionInfo = {
+    /** Identity of the provider this client re-established its connection to. */
+    providerIdentity: ProviderIdentity_4;
+    /** The client's endpoint id before the reconnect (now torn down). */
+    previousEndpointId: string;
+    /** The client's endpoint id after the reconnect. */
+    endpointId: string;
+};
+
+/**
+ * Listener registered via {@link ChannelClient.onReconnection}, called once each time the client self-heals its
+ * connection to the provider.
+ *
+ * Currently, this will only occur during a [bfcache](https://developer.mozilla.org/en-US/docs/Glossary/bfcache) Restore.
+ *
+ * For example, if the Channel Client belongs to a Window / View that is compatible with the bfcache, and
+ * the Window / View is navigated away from and then back to using the history API, the Channel Client will re-establish its connection to the provider if it still
+ * exists.
+ */
+declare type ChannelClientReconnectionListener = (info: ChannelClientReconnectionInfo) => void;
+
 /**
  * Options provided on a client connection to a channel.
  *
@@ -5253,6 +5313,8 @@ declare type EndLoadEvent = BaseEvent_5 & {
     isMain: boolean;
 };
 
+/* Excluded from this release type: EndpointConnectionInstance */
+
 /**
  * Generated at the end of a user-driven change to a window's size or position.
  *
@@ -7364,6 +7426,11 @@ declare class InterApplicationBus extends Base {
         subscriberRemoved: string;
     };
     private refCounter;
+    /**
+     * One entry per subscription the runtime knows about, keyed by the same subscription key the
+     * emitter and the ref counter use. Listeners sharing a key share a single entry.
+     */
+    private activeSubscriptions;
     protected emitter: EventEmitter;
     on: any;
     removeAllListeners: any;
@@ -7403,16 +7470,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));
@@ -11399,6 +11471,8 @@ declare namespace OpenFin {
         ChannelClientConnectionListener,
         ChannelClientDisconnectionListener,
         ChannelProviderDisconnectionListener,
+        ChannelClientReconnectionInfo,
+        ChannelClientReconnectionListener,
         RoutingInfo,
         DownloadShelfOptions,
         SnapZoneOptions,
@@ -17806,6 +17880,8 @@ declare type TaskBar = DipScaleRects & {
     rect: RectangleByEdgePositions;
 };
 
+declare const teardown: unique symbol;
+
 /**
  * @interface
  */

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

@@ -2755,12 +2755,9 @@ declare class ChannelBase {
  */
 declare class ChannelClient extends ChannelBase {
     #private;
-    private disconnectListener;
-    private endpointId;
-    /* Excluded from this release type: closeChannelByEndpointId */
-    /* Excluded from this release type: handleProviderDisconnect */
     /* Excluded from this release type: __constructor */
     protected processAction: (action: string, payload: any, senderIdentity: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<any>;
+    /* Excluded from this release type: [teardown] */
     /**
      * a read-only provider identity
      */
@@ -2792,8 +2789,8 @@ declare class ChannelClient extends ChannelBase {
      */
     dispatch(action: string, payload?: any): Promise<any>;
     /**
-     * Register a listener that is called on provider disconnection. It is passed the disconnection event of the
-     * disconnecting provider.
+     * Register a listener that is called when this client loses its channel: the provider disconnects, the
+     * endpoint drops, or a self-heal fails. It is passed the provider identity.
      *
      * @param listener
      *
@@ -2810,6 +2807,43 @@ declare class ChannelClient extends ChannelBase {
      * ```
      */
     onDisconnection(listener: OpenFin.ChannelProviderDisconnectionListener): void;
+    /**
+     * Register a listener that is called each time this client transparently self-heals its connection to the
+     * provider.
+     *
+     * @remarks
+     * A channel client's underlying endpoint is torn down while its document sits in the back/forward cache
+     * (bfcache). If the back/forward cache is supported and the document is restored from it, the client
+     * automatically re-handshakes with the provider and swaps in a fresh endpoint; all of this client's
+     * `register`/middleware handlers are preserved, so no re-registration is required.
+     *
+     * A restore is not guaranteed: Chromium may evict a cached document at any time, in which case navigating
+     * back reloads the page and a new client must connect.
+     *
+     * This listener fires once per successful reconnect, after the new endpoint is live, and can fire multiple
+     * times over the client's lifetime. It is triggered when the document is restored from the back/forward
+     * cache (a bfcache `pageshow`). It does not fire for the initial connection, nor after
+     * {@link ChannelClient#disconnect disconnect}. {@link ChannelClient#onDisconnection onDisconnection} fires
+     * when the provider or endpoint goes away.
+     *
+     * The info provides the reconnected {@link OpenFin.ProviderIdentity provider identity} along with
+     * the previous and new endpoint ids.
+     *
+     * @param listener
+     *
+     * @example
+     *
+     * ```js
+     * (async () => {
+     *     const client = await fin.InterApplicationBus.Channel.connect('channelName');
+     *
+     *     client.onReconnection(({ providerIdentity, previousEndpointId, endpointId }) => {
+     *         console.log(`Reconnected to ${providerIdentity.channelName}: ${previousEndpointId} -> ${endpointId}`);
+     *     });
+     * })();
+     * ```
+     */
+    onReconnection(listener: OpenFin.ChannelClientReconnectionListener): void;
     /**
      * Disconnects the client from the channel.
      *
@@ -2824,16 +2858,42 @@ declare class ChannelClient extends ChannelBase {
      * ```
      */
     disconnect(): Promise<void>;
-    sendDisconnectAction(): Promise<void>;
-    /* Excluded from this release type: wireClose */
+    /* Excluded from this release type: sendDisconnectAction */
 }
 
 declare type ChannelClient_2 = OpenFin.ChannelClient;
 
+/* Excluded from this release type: ChannelClientConfig */
+
 declare type ChannelClientConnectionListener = (identity: ClientIdentity, connectionMessage?: any) => Promise<any> | any;
 
 declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
 
+/**
+ * Info passed to a {@link ChannelClient.onReconnection} listener when a channel client
+ * re-establishes its connection to the provider after its endpoint was torn down.
+ */
+declare type ChannelClientReconnectionInfo = {
+    /** Identity of the provider this client re-established its connection to. */
+    providerIdentity: ProviderIdentity_4;
+    /** The client's endpoint id before the reconnect (now torn down). */
+    previousEndpointId: string;
+    /** The client's endpoint id after the reconnect. */
+    endpointId: string;
+};
+
+/**
+ * Listener registered via {@link ChannelClient.onReconnection}, called once each time the client self-heals its
+ * connection to the provider.
+ *
+ * Currently, this will only occur during a [bfcache](https://developer.mozilla.org/en-US/docs/Glossary/bfcache) Restore.
+ *
+ * For example, if the Channel Client belongs to a Window / View that is compatible with the bfcache, and
+ * the Window / View is navigated away from and then back to using the history API, the Channel Client will re-establish its connection to the provider if it still
+ * exists.
+ */
+declare type ChannelClientReconnectionListener = (info: ChannelClientReconnectionInfo) => void;
+
 /**
  * Options provided on a client connection to a channel.
  *
@@ -5253,6 +5313,8 @@ declare type EndLoadEvent = BaseEvent_5 & {
     isMain: boolean;
 };
 
+/* Excluded from this release type: EndpointConnectionInstance */
+
 /**
  * Generated at the end of a user-driven change to a window's size or position.
  *
@@ -7364,6 +7426,11 @@ declare class InterApplicationBus extends Base {
         subscriberRemoved: string;
     };
     private refCounter;
+    /**
+     * One entry per subscription the runtime knows about, keyed by the same subscription key the
+     * emitter and the ref counter use. Listeners sharing a key share a single entry.
+     */
+    private activeSubscriptions;
     protected emitter: EventEmitter;
     on: any;
     removeAllListeners: any;
@@ -7403,16 +7470,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));
@@ -11399,6 +11471,8 @@ declare namespace OpenFin {
         ChannelClientConnectionListener,
         ChannelClientDisconnectionListener,
         ChannelProviderDisconnectionListener,
+        ChannelClientReconnectionInfo,
+        ChannelClientReconnectionListener,
         RoutingInfo,
         DownloadShelfOptions,
         SnapZoneOptions,
@@ -17806,6 +17880,8 @@ declare type TaskBar = DipScaleRects & {
     rect: RectangleByEdgePositions;
 };
 
+declare const teardown: unique symbol;
+
 /**
  * @interface
  */

package/out/fdc3-api.d.ts

@@ -2795,22 +2795,17 @@ declare class ChannelBase {
  */
 declare class ChannelClient extends ChannelBase {
     #private;
-    private disconnectListener;
-    private endpointId;
-    /**
-     * @internal
-     */
-    static closeChannelByEndpointId(id: string): void;
     /**
      * @internal
-     * closes the corresponding channel and invokes the disconnect listener if an event payload is passed.
      */
-    static handleProviderDisconnect(eventPayload: OpenFin.ProviderIdentity): void;
+    constructor(config: ChannelClientConfig);
+    protected processAction: (action: string, payload: any, senderIdentity: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<any>;
     /**
      * @internal
+     * Closes the client. `notifyRuntime` sends `disconnect-from-channel` for the current endpoint; `emitEvent` then
+     * fires the onDisconnection listener, even if notifying the runtime failed.
      */
-    constructor(routingInfo: OpenFin.RoutingInfo, close: () => Promise<void>, strategy: AnyStrategy);
-    protected processAction: (action: string, payload: any, senderIdentity: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<any>;
+    [teardown](emitEvent?: boolean, notifyRuntime?: boolean): Promise<void>;
     /**
      * a read-only provider identity
      */
@@ -2842,8 +2837,8 @@ declare class ChannelClient extends ChannelBase {
      */
     dispatch(action: string, payload?: any): Promise<any>;
     /**
-     * Register a listener that is called on provider disconnection. It is passed the disconnection event of the
-     * disconnecting provider.
+     * Register a listener that is called when this client loses its channel: the provider disconnects, the
+     * endpoint drops, or a self-heal fails. It is passed the provider identity.
      *
      * @param listener
      *
@@ -2860,6 +2855,43 @@ declare class ChannelClient extends ChannelBase {
      * ```
      */
     onDisconnection(listener: OpenFin.ChannelProviderDisconnectionListener): void;
+    /**
+     * Register a listener that is called each time this client transparently self-heals its connection to the
+     * provider.
+     *
+     * @remarks
+     * A channel client's underlying endpoint is torn down while its document sits in the back/forward cache
+     * (bfcache). If the back/forward cache is supported and the document is restored from it, the client
+     * automatically re-handshakes with the provider and swaps in a fresh endpoint; all of this client's
+     * `register`/middleware handlers are preserved, so no re-registration is required.
+     *
+     * A restore is not guaranteed: Chromium may evict a cached document at any time, in which case navigating
+     * back reloads the page and a new client must connect.
+     *
+     * This listener fires once per successful reconnect, after the new endpoint is live, and can fire multiple
+     * times over the client's lifetime. It is triggered when the document is restored from the back/forward
+     * cache (a bfcache `pageshow`). It does not fire for the initial connection, nor after
+     * {@link ChannelClient#disconnect disconnect}. {@link ChannelClient#onDisconnection onDisconnection} fires
+     * when the provider or endpoint goes away.
+     *
+     * The info provides the reconnected {@link OpenFin.ProviderIdentity provider identity} along with
+     * the previous and new endpoint ids.
+     *
+     * @param listener
+     *
+     * @example
+     *
+     * ```js
+     * (async () => {
+     *     const client = await fin.InterApplicationBus.Channel.connect('channelName');
+     *
+     *     client.onReconnection(({ providerIdentity, previousEndpointId, endpointId }) => {
+     *         console.log(`Reconnected to ${providerIdentity.channelName}: ${previousEndpointId} -> ${endpointId}`);
+     *     });
+     * })();
+     * ```
+     */
+    onReconnection(listener: OpenFin.ChannelClientReconnectionListener): void;
     /**
      * Disconnects the client from the channel.
      *
@@ -2874,20 +2906,57 @@ declare class ChannelClient extends ChannelBase {
      * ```
      */
     disconnect(): Promise<void>;
-    sendDisconnectAction(): Promise<void>;
     /**
      * @internal
-     * Writing this as a static to keep code together, but in environments with a wire, this will be DI'd into the protectedObject class as close.
+     * Notify the runtime that the current endpoint has disconnected.
      */
-    static wireClose(wire: Transport, providerIdentity: OpenFin.ProviderIdentity, endpointId: string): Promise<void>;
+    sendDisconnectAction(): Promise<void>;
 }
 
 declare type ChannelClient_2 = OpenFin.ChannelClient;
 
+/**
+ * @internal
+ * `wire` and `reestablish` let the client notify the runtime on disconnect and self-heal after a BF-Cache restore.
+ * The in-memory transport has no runtime and passes no-ops.
+ */
+declare type ChannelClientConfig = {
+    initialConnection: EndpointConnectionInstance;
+    wire: Pick<Transport, 'sendAction'> & {
+        environment: Pick<Transport['environment'], 'onBFCacheRestore'>;
+    };
+    reestablish: () => Promise<EndpointConnectionInstance>;
+};
+
 declare type ChannelClientConnectionListener = (identity: ClientIdentity, connectionMessage?: any) => Promise<any> | any;
 
 declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
 
+/**
+ * Info passed to a {@link ChannelClient.onReconnection} listener when a channel client
+ * re-establishes its connection to the provider after its endpoint was torn down.
+ */
+declare type ChannelClientReconnectionInfo = {
+    /** Identity of the provider this client re-established its connection to. */
+    providerIdentity: ProviderIdentity_4;
+    /** The client's endpoint id before the reconnect (now torn down). */
+    previousEndpointId: string;
+    /** The client's endpoint id after the reconnect. */
+    endpointId: string;
+};
+
+/**
+ * Listener registered via {@link ChannelClient.onReconnection}, called once each time the client self-heals its
+ * connection to the provider.
+ *
+ * Currently, this will only occur during a [bfcache](https://developer.mozilla.org/en-US/docs/Glossary/bfcache) Restore.
+ *
+ * For example, if the Channel Client belongs to a Window / View that is compatible with the bfcache, and
+ * the Window / View is navigated away from and then back to using the history API, the Channel Client will re-establish its connection to the provider if it still
+ * exists.
+ */
+declare type ChannelClientReconnectionListener = (info: ChannelClientReconnectionInfo) => void;
+
 /**
  * Options provided on a client connection to a channel.
  *
@@ -5365,6 +5434,14 @@ declare type EndLoadEvent = BaseEvent_5 & {
     isMain: boolean;
 };
 
+/**
+ * @internal
+ */
+declare type EndpointConnectionInstance = {
+    routingInfo: OpenFin.RoutingInfo;
+    strategy: AnyStrategy;
+};
+
 /**
  * Generated at the end of a user-driven change to a window's size or position.
  *
@@ -7512,6 +7589,11 @@ declare class InterApplicationBus extends Base {
         subscriberRemoved: string;
     };
     private refCounter;
+    /**
+     * One entry per subscription the runtime knows about, keyed by the same subscription key the
+     * emitter and the ref counter use. Listeners sharing a key share a single entry.
+     */
+    private activeSubscriptions;
     protected emitter: EventEmitter;
     on: any;
     removeAllListeners: any;
@@ -7554,16 +7636,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));
@@ -11793,6 +11880,8 @@ declare namespace OpenFin {
         ChannelClientConnectionListener,
         ChannelClientDisconnectionListener,
         ChannelProviderDisconnectionListener,
+        ChannelClientReconnectionInfo,
+        ChannelClientReconnectionListener,
         RoutingInfo,
         DownloadShelfOptions,
         SnapZoneOptions,
@@ -18305,6 +18394,8 @@ declare type TaskBar = DipScaleRects & {
     rect: RectangleByEdgePositions;
 };
 
+declare const teardown: unique symbol;
+
 /**
  * @interface
  */

package/package.json

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