@openfin/fdc3-api 46.100.84 → 46.100.87

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,3 @@
1
- /// <reference types="node" />
2
-
3
1
  import { EventEmitter } from 'events';
4
2
 
5
3
  /**
@@ -1930,7 +1928,6 @@ declare type BaseEvent_9 = BaseEvents.BaseEvent & {
1930
1928
 
1931
1929
  declare namespace BaseEvents {
1932
1930
  export {
1933
- NotCloseRequested,
1934
1931
  PropagatedEventType,
1935
1932
  PropagatedEvent,
1936
1933
  Payload_2 as Payload,
@@ -1997,6 +1994,8 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
1997
1994
  type: 'begin-user-bounds-changing';
1998
1995
  };
1999
1996
 
1997
+ declare type BFCacheRestoreListener = () => void | Promise<void>;
1998
+
2000
1999
  /**
2001
2000
  * A rule prescribing content creation that should be blocked.
2002
2001
  *
@@ -5336,6 +5335,16 @@ declare interface Environment {
5336
5335
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
5337
5336
  initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
5338
5337
  observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
5338
+ /**
5339
+ * Registers a listener invoked when the current page has been restored from the
5340
+ * browser's back/forward cache. Stateful APIs (e.g. channels) use this to re-establish
5341
+ * connections that were torn down while the page was cached.
5342
+ *
5343
+ * No-op in environments that cannot be bfcached.
5344
+ *
5345
+ * @returns a function that unregisters the listener.
5346
+ */
5347
+ onBFCacheRestore(listener: BFCacheRestoreListener): () => void;
5339
5348
  writeToken(path: string, token: string): Promise<string>;
5340
5349
  retrievePort(config: NewConnectConfig): Promise<number>;
5341
5350
  getNextMessageId(): any;
@@ -5790,7 +5799,7 @@ declare type ExtensionWindowCreatedEvent = BaseEvent_5 & {
5790
5799
  * these api calls are not implemented in the javscript api, only in the external adapter
5791
5800
  * If they don't exist in the external adapter they should be removed.
5792
5801
  */
5793
- 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';
5802
+ 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';
5794
5803
 
5795
5804
  declare type ExternalAdapterOnlyCallsMap = {
5796
5805
  [k in ExternalAdapterOnlyCalls]: {
@@ -6003,7 +6012,7 @@ declare namespace FDC3 {
6003
6012
 
6004
6013
  declare type FDC3Factory = typeof fdc3Factory;
6005
6014
 
6006
- declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin.InteropClient, wire: Transport<'unknown'>) => OpenFin.FDC3.v2_0.DesktopAgent | OpenFin.FDC3.v1_2.DesktopAgent;
6015
+ declare const fdc3Factory: (version: "1.2" | "2.0", interopClient: OpenFin.InteropClient, wire: Transport<"unknown">) => OpenFin.FDC3.v2_0.DesktopAgent | OpenFin.FDC3.v1_2.DesktopAgent;
6007
6016
 
6008
6017
  export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, { fdc3Version }?: {
6009
6018
  fdc3Version?: Fdc3Version;
@@ -8177,14 +8186,14 @@ declare class InteropClient extends Base {
8177
8186
  * @param listener Callback invoked whenever the event occurs.
8178
8187
  * @returns Promise resolving with void once the listener is registered.
8179
8188
  */
8180
- addListener: (type: OpenFin.InteropClientEvents['type'], listener: (event: OpenFin.InteropClientEvents['event']) => void) => Promise<void>;
8189
+ addListener: (type: OpenFin.InteropClientEvents["type"], listener: (event: OpenFin.InteropClientEvents["event"]) => void) => Promise<void>;
8181
8190
  /**
8182
8191
  * `removeListener` removes a registered event listener.
8183
8192
  * @param type The event type to subscribe to.
8184
8193
  * @param listener Callback to be removed.
8185
8194
  * @returns Promise resolving with void even if no callback was found.
8186
8195
  */
8187
- removeListener: (type: OpenFin.InteropClientEvents['type'], listener: (event: OpenFin.InteropClientEvents['event']) => void) => Promise<void>;
8196
+ removeListener: (type: OpenFin.InteropClientEvents["type"], listener: (event: OpenFin.InteropClientEvents["event"]) => void) => Promise<void>;
8188
8197
  /**
8189
8198
  * Sets a context for the context group of the current entity.
8190
8199
  *
@@ -11066,7 +11075,6 @@ declare namespace OpenFin {
11066
11075
  LogPath,
11067
11076
  LogTarget,
11068
11077
  MutableWindowOptions,
11069
- WorkspacePlatformOptions,
11070
11078
  WebRequestHeader,
11071
11079
  CustomRequestHeaders,
11072
11080
  WindowOptionDiff,
@@ -17509,8 +17517,6 @@ declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
17509
17517
 
17510
17518
  declare namespace SystemEvents {
17511
17519
  export {
17512
- NotRequested,
17513
- ExcludeRequested,
17514
17520
  BaseEvent_9 as BaseEvent,
17515
17521
  IdleStateChangedEvent,
17516
17522
  IdleEvent,
@@ -17519,15 +17525,8 @@ declare namespace SystemEvents {
17519
17525
  SessionChangedEvent,
17520
17526
  AppVersionEvent,
17521
17527
  AppVersionEventType,
17522
- IdEventType,
17523
- WithId,
17524
- WithoutId,
17525
- AppVersionTypeFromIdEvent,
17526
- EventWithId,
17527
- AppVersionEventWithId,
17528
17528
  ApplicationCreatedEvent,
17529
17529
  DesktopIconClickedEvent,
17530
- SystemShutdownEvent,
17531
17530
  ExtensionsEnabledEvent,
17532
17531
  ExtensionsDisabledEvent,
17533
17532
  ExtensionsExcludedEvent,
@@ -18290,7 +18289,7 @@ declare type UserMovementEnabledEvent = BaseEvent_5 & {
18290
18289
  };
18291
18290
 
18292
18291
  declare namespace v1_2 {
18293
- {
18292
+ export {
18294
18293
  AppIntent,
18295
18294
  AppMetadata,
18296
18295
  DisplayMetadata,
@@ -18326,7 +18325,7 @@ declare namespace v1_2 {
18326
18325
  }
18327
18326
 
18328
18327
  declare namespace v2_0 {
18329
- {
18328
+ export {
18330
18329
  AppIdentifier,
18331
18330
  AppIntent_2 as AppIntent,
18332
18331
  AppMetadata_2 as AppMetadata,
@@ -1,5 +1,3 @@
1
- /// <reference types="node" />
2
-
3
1
  import { EventEmitter } from 'events';
4
2
 
5
3
  /**
@@ -1930,7 +1928,6 @@ declare type BaseEvent_9 = BaseEvents.BaseEvent & {
1930
1928
 
1931
1929
  declare namespace BaseEvents {
1932
1930
  export {
1933
- NotCloseRequested,
1934
1931
  PropagatedEventType,
1935
1932
  PropagatedEvent,
1936
1933
  Payload_2 as Payload,
@@ -1997,6 +1994,8 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
1997
1994
  type: 'begin-user-bounds-changing';
1998
1995
  };
1999
1996
 
1997
+ declare type BFCacheRestoreListener = () => void | Promise<void>;
1998
+
2000
1999
  /**
2001
2000
  * A rule prescribing content creation that should be blocked.
2002
2001
  *
@@ -5336,6 +5335,16 @@ declare interface Environment {
5336
5335
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
5337
5336
  initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
5338
5337
  observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
5338
+ /**
5339
+ * Registers a listener invoked when the current page has been restored from the
5340
+ * browser's back/forward cache. Stateful APIs (e.g. channels) use this to re-establish
5341
+ * connections that were torn down while the page was cached.
5342
+ *
5343
+ * No-op in environments that cannot be bfcached.
5344
+ *
5345
+ * @returns a function that unregisters the listener.
5346
+ */
5347
+ onBFCacheRestore(listener: BFCacheRestoreListener): () => void;
5339
5348
  writeToken(path: string, token: string): Promise<string>;
5340
5349
  retrievePort(config: NewConnectConfig): Promise<number>;
5341
5350
  getNextMessageId(): any;
@@ -5790,7 +5799,7 @@ declare type ExtensionWindowCreatedEvent = BaseEvent_5 & {
5790
5799
  * these api calls are not implemented in the javscript api, only in the external adapter
5791
5800
  * If they don't exist in the external adapter they should be removed.
5792
5801
  */
5793
- 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';
5802
+ 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';
5794
5803
 
5795
5804
  declare type ExternalAdapterOnlyCallsMap = {
5796
5805
  [k in ExternalAdapterOnlyCalls]: {
@@ -6003,7 +6012,7 @@ declare namespace FDC3 {
6003
6012
 
6004
6013
  declare type FDC3Factory = typeof fdc3Factory;
6005
6014
 
6006
- declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin.InteropClient, wire: Transport<'unknown'>) => OpenFin.FDC3.v2_0.DesktopAgent | OpenFin.FDC3.v1_2.DesktopAgent;
6015
+ declare const fdc3Factory: (version: "1.2" | "2.0", interopClient: OpenFin.InteropClient, wire: Transport<"unknown">) => OpenFin.FDC3.v2_0.DesktopAgent | OpenFin.FDC3.v1_2.DesktopAgent;
6007
6016
 
6008
6017
  export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, { fdc3Version }?: {
6009
6018
  fdc3Version?: Fdc3Version;
@@ -8177,14 +8186,14 @@ declare class InteropClient extends Base {
8177
8186
  * @param listener Callback invoked whenever the event occurs.
8178
8187
  * @returns Promise resolving with void once the listener is registered.
8179
8188
  */
8180
- addListener: (type: OpenFin.InteropClientEvents['type'], listener: (event: OpenFin.InteropClientEvents['event']) => void) => Promise<void>;
8189
+ addListener: (type: OpenFin.InteropClientEvents["type"], listener: (event: OpenFin.InteropClientEvents["event"]) => void) => Promise<void>;
8181
8190
  /**
8182
8191
  * `removeListener` removes a registered event listener.
8183
8192
  * @param type The event type to subscribe to.
8184
8193
  * @param listener Callback to be removed.
8185
8194
  * @returns Promise resolving with void even if no callback was found.
8186
8195
  */
8187
- removeListener: (type: OpenFin.InteropClientEvents['type'], listener: (event: OpenFin.InteropClientEvents['event']) => void) => Promise<void>;
8196
+ removeListener: (type: OpenFin.InteropClientEvents["type"], listener: (event: OpenFin.InteropClientEvents["event"]) => void) => Promise<void>;
8188
8197
  /**
8189
8198
  * Sets a context for the context group of the current entity.
8190
8199
  *
@@ -11066,7 +11075,6 @@ declare namespace OpenFin {
11066
11075
  LogPath,
11067
11076
  LogTarget,
11068
11077
  MutableWindowOptions,
11069
- WorkspacePlatformOptions,
11070
11078
  WebRequestHeader,
11071
11079
  CustomRequestHeaders,
11072
11080
  WindowOptionDiff,
@@ -17509,8 +17517,6 @@ declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
17509
17517
 
17510
17518
  declare namespace SystemEvents {
17511
17519
  export {
17512
- NotRequested,
17513
- ExcludeRequested,
17514
17520
  BaseEvent_9 as BaseEvent,
17515
17521
  IdleStateChangedEvent,
17516
17522
  IdleEvent,
@@ -17519,15 +17525,8 @@ declare namespace SystemEvents {
17519
17525
  SessionChangedEvent,
17520
17526
  AppVersionEvent,
17521
17527
  AppVersionEventType,
17522
- IdEventType,
17523
- WithId,
17524
- WithoutId,
17525
- AppVersionTypeFromIdEvent,
17526
- EventWithId,
17527
- AppVersionEventWithId,
17528
17528
  ApplicationCreatedEvent,
17529
17529
  DesktopIconClickedEvent,
17530
- SystemShutdownEvent,
17531
17530
  ExtensionsEnabledEvent,
17532
17531
  ExtensionsDisabledEvent,
17533
17532
  ExtensionsExcludedEvent,
@@ -18290,7 +18289,7 @@ declare type UserMovementEnabledEvent = BaseEvent_5 & {
18290
18289
  };
18291
18290
 
18292
18291
  declare namespace v1_2 {
18293
- {
18292
+ export {
18294
18293
  AppIntent,
18295
18294
  AppMetadata,
18296
18295
  DisplayMetadata,
@@ -18326,7 +18325,7 @@ declare namespace v1_2 {
18326
18325
  }
18327
18326
 
18328
18327
  declare namespace v2_0 {
18329
- {
18328
+ export {
18330
18329
  AppIdentifier,
18331
18330
  AppIntent_2 as AppIntent,
18332
18331
  AppMetadata_2 as AppMetadata,
@@ -1,5 +1,3 @@
1
- /// <reference types="node" />
2
-
3
1
  import { EventEmitter } from 'events';
4
2
 
5
3
  /**
@@ -1930,7 +1928,6 @@ declare type BaseEvent_9 = BaseEvents.BaseEvent & {
1930
1928
 
1931
1929
  declare namespace BaseEvents {
1932
1930
  export {
1933
- NotCloseRequested,
1934
1931
  PropagatedEventType,
1935
1932
  PropagatedEvent,
1936
1933
  Payload_2 as Payload,
@@ -1997,6 +1994,8 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
1997
1994
  type: 'begin-user-bounds-changing';
1998
1995
  };
1999
1996
 
1997
+ declare type BFCacheRestoreListener = () => void | Promise<void>;
1998
+
2000
1999
  /**
2001
2000
  * A rule prescribing content creation that should be blocked.
2002
2001
  *
@@ -5336,6 +5335,16 @@ declare interface Environment {
5336
5335
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
5337
5336
  initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
5338
5337
  observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
5338
+ /**
5339
+ * Registers a listener invoked when the current page has been restored from the
5340
+ * browser's back/forward cache. Stateful APIs (e.g. channels) use this to re-establish
5341
+ * connections that were torn down while the page was cached.
5342
+ *
5343
+ * No-op in environments that cannot be bfcached.
5344
+ *
5345
+ * @returns a function that unregisters the listener.
5346
+ */
5347
+ onBFCacheRestore(listener: BFCacheRestoreListener): () => void;
5339
5348
  writeToken(path: string, token: string): Promise<string>;
5340
5349
  retrievePort(config: NewConnectConfig): Promise<number>;
5341
5350
  getNextMessageId(): any;
@@ -5790,7 +5799,7 @@ declare type ExtensionWindowCreatedEvent = BaseEvent_5 & {
5790
5799
  * these api calls are not implemented in the javscript api, only in the external adapter
5791
5800
  * If they don't exist in the external adapter they should be removed.
5792
5801
  */
5793
- 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';
5802
+ 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';
5794
5803
 
5795
5804
  declare type ExternalAdapterOnlyCallsMap = {
5796
5805
  [k in ExternalAdapterOnlyCalls]: {
@@ -6003,7 +6012,7 @@ declare namespace FDC3 {
6003
6012
 
6004
6013
  declare type FDC3Factory = typeof fdc3Factory;
6005
6014
 
6006
- declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin.InteropClient, wire: Transport<'unknown'>) => OpenFin.FDC3.v2_0.DesktopAgent | OpenFin.FDC3.v1_2.DesktopAgent;
6015
+ declare const fdc3Factory: (version: "1.2" | "2.0", interopClient: OpenFin.InteropClient, wire: Transport<"unknown">) => OpenFin.FDC3.v2_0.DesktopAgent | OpenFin.FDC3.v1_2.DesktopAgent;
6007
6016
 
6008
6017
  export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, { fdc3Version }?: {
6009
6018
  fdc3Version?: Fdc3Version;
@@ -8177,14 +8186,14 @@ declare class InteropClient extends Base {
8177
8186
  * @param listener Callback invoked whenever the event occurs.
8178
8187
  * @returns Promise resolving with void once the listener is registered.
8179
8188
  */
8180
- addListener: (type: OpenFin.InteropClientEvents['type'], listener: (event: OpenFin.InteropClientEvents['event']) => void) => Promise<void>;
8189
+ addListener: (type: OpenFin.InteropClientEvents["type"], listener: (event: OpenFin.InteropClientEvents["event"]) => void) => Promise<void>;
8181
8190
  /**
8182
8191
  * `removeListener` removes a registered event listener.
8183
8192
  * @param type The event type to subscribe to.
8184
8193
  * @param listener Callback to be removed.
8185
8194
  * @returns Promise resolving with void even if no callback was found.
8186
8195
  */
8187
- removeListener: (type: OpenFin.InteropClientEvents['type'], listener: (event: OpenFin.InteropClientEvents['event']) => void) => Promise<void>;
8196
+ removeListener: (type: OpenFin.InteropClientEvents["type"], listener: (event: OpenFin.InteropClientEvents["event"]) => void) => Promise<void>;
8188
8197
  /**
8189
8198
  * Sets a context for the context group of the current entity.
8190
8199
  *
@@ -11066,7 +11075,6 @@ declare namespace OpenFin {
11066
11075
  LogPath,
11067
11076
  LogTarget,
11068
11077
  MutableWindowOptions,
11069
- WorkspacePlatformOptions,
11070
11078
  WebRequestHeader,
11071
11079
  CustomRequestHeaders,
11072
11080
  WindowOptionDiff,
@@ -17509,8 +17517,6 @@ declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
17509
17517
 
17510
17518
  declare namespace SystemEvents {
17511
17519
  export {
17512
- NotRequested,
17513
- ExcludeRequested,
17514
17520
  BaseEvent_9 as BaseEvent,
17515
17521
  IdleStateChangedEvent,
17516
17522
  IdleEvent,
@@ -17519,15 +17525,8 @@ declare namespace SystemEvents {
17519
17525
  SessionChangedEvent,
17520
17526
  AppVersionEvent,
17521
17527
  AppVersionEventType,
17522
- IdEventType,
17523
- WithId,
17524
- WithoutId,
17525
- AppVersionTypeFromIdEvent,
17526
- EventWithId,
17527
- AppVersionEventWithId,
17528
17528
  ApplicationCreatedEvent,
17529
17529
  DesktopIconClickedEvent,
17530
- SystemShutdownEvent,
17531
17530
  ExtensionsEnabledEvent,
17532
17531
  ExtensionsDisabledEvent,
17533
17532
  ExtensionsExcludedEvent,
@@ -18290,7 +18289,7 @@ declare type UserMovementEnabledEvent = BaseEvent_5 & {
18290
18289
  };
18291
18290
 
18292
18291
  declare namespace v1_2 {
18293
- {
18292
+ export {
18294
18293
  AppIntent,
18295
18294
  AppMetadata,
18296
18295
  DisplayMetadata,
@@ -18326,7 +18325,7 @@ declare namespace v1_2 {
18326
18325
  }
18327
18326
 
18328
18327
  declare namespace v2_0 {
18329
- {
18328
+ export {
18330
18329
  AppIdentifier,
18331
18330
  AppIntent_2 as AppIntent,
18332
18331
  AppMetadata_2 as AppMetadata,
package/out/fdc3-api.d.ts CHANGED
@@ -1,5 +1,3 @@
1
- /// <reference types="node" />
2
-
3
1
  import { EventEmitter } from 'events';
4
2
 
5
3
  /**
@@ -2029,6 +2027,8 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
2029
2027
  type: 'begin-user-bounds-changing';
2030
2028
  };
2031
2029
 
2030
+ declare type BFCacheRestoreListener = () => void | Promise<void>;
2031
+
2032
2032
  /**
2033
2033
  * A rule prescribing content creation that should be blocked.
2034
2034
  *
@@ -5447,6 +5447,16 @@ declare interface Environment {
5447
5447
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
5448
5448
  initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
5449
5449
  observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
5450
+ /**
5451
+ * Registers a listener invoked when the current page has been restored from the
5452
+ * browser's back/forward cache. Stateful APIs (e.g. channels) use this to re-establish
5453
+ * connections that were torn down while the page was cached.
5454
+ *
5455
+ * No-op in environments that cannot be bfcached.
5456
+ *
5457
+ * @returns a function that unregisters the listener.
5458
+ */
5459
+ onBFCacheRestore(listener: BFCacheRestoreListener): () => void;
5450
5460
  writeToken(path: string, token: string): Promise<string>;
5451
5461
  retrievePort(config: NewConnectConfig): Promise<number>;
5452
5462
  getNextMessageId(): any;
@@ -5919,7 +5929,7 @@ declare type ExtensionWindowCreatedEvent = BaseEvent_5 & {
5919
5929
  * these api calls are not implemented in the javscript api, only in the external adapter
5920
5930
  * If they don't exist in the external adapter they should be removed.
5921
5931
  */
5922
- 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';
5932
+ 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';
5923
5933
 
5924
5934
  declare type ExternalAdapterOnlyCallsMap = {
5925
5935
  [k in ExternalAdapterOnlyCalls]: {
@@ -6135,7 +6145,7 @@ declare namespace FDC3 {
6135
6145
 
6136
6146
  declare type FDC3Factory = typeof fdc3Factory;
6137
6147
 
6138
- declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin.InteropClient, wire: Transport<'unknown'>) => OpenFin.FDC3.v2_0.DesktopAgent | OpenFin.FDC3.v1_2.DesktopAgent;
6148
+ declare const fdc3Factory: (version: "1.2" | "2.0", interopClient: OpenFin.InteropClient, wire: Transport<"unknown">) => OpenFin.FDC3.v2_0.DesktopAgent | OpenFin.FDC3.v1_2.DesktopAgent;
6139
6149
 
6140
6150
  export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, { fdc3Version }?: {
6141
6151
  fdc3Version?: Fdc3Version;
@@ -8342,14 +8352,14 @@ declare class InteropClient extends Base {
8342
8352
  * @param listener Callback invoked whenever the event occurs.
8343
8353
  * @returns Promise resolving with void once the listener is registered.
8344
8354
  */
8345
- addListener: (type: OpenFin.InteropClientEvents['type'], listener: (event: OpenFin.InteropClientEvents['event']) => void) => Promise<void>;
8355
+ addListener: (type: OpenFin.InteropClientEvents["type"], listener: (event: OpenFin.InteropClientEvents["event"]) => void) => Promise<void>;
8346
8356
  /**
8347
8357
  * `removeListener` removes a registered event listener.
8348
8358
  * @param type The event type to subscribe to.
8349
8359
  * @param listener Callback to be removed.
8350
8360
  * @returns Promise resolving with void even if no callback was found.
8351
8361
  */
8352
- removeListener: (type: OpenFin.InteropClientEvents['type'], listener: (event: OpenFin.InteropClientEvents['event']) => void) => Promise<void>;
8362
+ removeListener: (type: OpenFin.InteropClientEvents["type"], listener: (event: OpenFin.InteropClientEvents["event"]) => void) => Promise<void>;
8353
8363
  /**
8354
8364
  * Sets a context for the context group of the current entity.
8355
8365
  *
@@ -18778,7 +18788,7 @@ declare type UserMovementEnabledEvent = BaseEvent_5 & {
18778
18788
  };
18779
18789
 
18780
18790
  declare namespace v1_2 {
18781
- {
18791
+ export {
18782
18792
  AppIntent,
18783
18793
  AppMetadata,
18784
18794
  DisplayMetadata,
@@ -18814,7 +18824,7 @@ declare namespace v1_2 {
18814
18824
  }
18815
18825
 
18816
18826
  declare namespace v2_0 {
18817
- {
18827
+ export {
18818
18828
  AppIdentifier,
18819
18829
  AppIntent_2 as AppIntent,
18820
18830
  AppMetadata_2 as AppMetadata,
package/out/fdc3-api.js CHANGED
@@ -511,6 +511,7 @@ class SessionContextGroupClient extends Base {
511
511
  }
512
512
  }
513
513
  _SessionContextGroupClient_clientPromise = new WeakMap();
514
+ var SessionContextGroupClient$1 = SessionContextGroupClient;
514
515
 
515
516
  var __classPrivateFieldSet$2 = (undefined && undefined.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
516
517
  if (kind === "m") throw new TypeError("Private method is not writable");
@@ -537,10 +538,10 @@ class ChannelEvents {
537
538
  _ChannelEvents_isChannelReady.set(this, false);
538
539
  _ChannelEvents_getActions.set(this, async () => {
539
540
  const channelClient = await __classPrivateFieldGet$2(this, _ChannelEvents_channelClient, "f");
540
- let actions = __classPrivateFieldGet$2(ChannelEvents, _a, "f", _ChannelEvents_actionsByClient).get(channelClient);
541
+ let actions = __classPrivateFieldGet$2(_a, _a, "f", _ChannelEvents_actionsByClient).get(channelClient);
541
542
  if (!actions) {
542
543
  actions = {};
543
- __classPrivateFieldGet$2(ChannelEvents, _a, "f", _ChannelEvents_actionsByClient).set(channelClient, actions);
544
+ __classPrivateFieldGet$2(_a, _a, "f", _ChannelEvents_actionsByClient).set(channelClient, actions);
544
545
  }
545
546
  return actions;
546
547
  });
@@ -1209,7 +1210,7 @@ class InteropClient extends Base {
1209
1210
  if (hasConflict) {
1210
1211
  console.warn(`A (non-session) context group with the name "${sessionContextGroupId}" already exists. If you are trying to join a Context Group, call joinContextGroup instead.`);
1211
1212
  }
1212
- const newSessionContextGroup = new SessionContextGroupClient(this.wire, __classPrivateFieldGet$1(this, _InteropClient_clientPromise, "f"), sessionContextGroupId);
1213
+ const newSessionContextGroup = new SessionContextGroupClient$1(this.wire, __classPrivateFieldGet$1(this, _InteropClient_clientPromise, "f"), sessionContextGroupId);
1213
1214
  __classPrivateFieldGet$1(this, _InteropClient_sessionContextGroups, "f").set(sessionContextGroupId, newSessionContextGroup);
1214
1215
  return newSessionContextGroup.getUserInstance();
1215
1216
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "46.100.84",
3
+ "version": "46.100.87",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,