@openfin/node-adapter 34.78.10 → 34.78.11

package/out/node-adapter.d.ts

@@ -1483,6 +1483,9 @@ declare type AutoResizeOptions = {
 };
 
 declare class Base {
+    /**
+     * @internal
+     */
     wire: Transport;
     /**
      * @internal
@@ -1920,7 +1923,7 @@ declare type Channel_3 = OpenFin.Fin['InterApplicationBus']['Channel'];
 
 declare type ChannelAction = OpenFin.ChannelAction;
 
-declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_7 | ClientIdentity_2) => unknown;
+declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_7 | ClientIdentity) => unknown;
 
 declare class ChannelBase {
     protected subscriptions: Map<string, ChannelAction>;
@@ -2233,7 +2236,7 @@ declare class ChannelClient extends ChannelBase {
     /**
      * @internal
      */
-    constructor(routingInfo: RoutingInfo, wire: Transport, strategy: AnyStrategy);
+    constructor(routingInfo: OpenFin.RoutingInfo, wire: Transport, strategy: AnyStrategy);
     protected processAction: (action: string, payload: any, senderIdentity: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<any>;
     /**
      * a read-only provider identity
@@ -2283,7 +2286,7 @@ declare class ChannelClient extends ChannelBase {
      * })();
      * ```
      */
-    onDisconnection(listener: DisconnectionListener): void;
+    onDisconnection(listener: OpenFin.ChannelProviderDisconnectionListener): void;
     /**
      * Disconnects the client from the channel.
      *
@@ -2303,6 +2306,10 @@ declare class ChannelClient extends ChannelBase {
 
 declare type ChannelClient_2 = OpenFin.ChannelClient;
 
+declare type ChannelClientConnectionListener = (identity: ClientIdentity, connectionMessage?: any) => Promise<any> | any;
+
+declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
+
 /**
  * Generated when a Channel client is connected.
  * @interface
@@ -2354,28 +2361,9 @@ declare type ChannelEvent = {
     topic: 'channel';
 } & (ChannelConnectedEvent | ChannelDisconnectedEvent);
 
-declare type ChannelEvent_2 = ChannelEvents.ChannelEvent;
-
-declare namespace ChannelEvents {
-    export {
-        BaseChannelEvent,
-        ChannelConnectedEvent,
-        ChannelDisconnectedEvent,
-        ChannelEvent,
-        ChannelEventType
-    }
-}
-
-/**
- *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}.  Events are
- *  discriminated by {@link ChannelEvent.type | their type}.  Event payloads unique to `Channel` can be found
- *  under the {@link OpenFin.ChannelEvents} namespace.
- */
-declare type ChannelEventType = ChannelEvent['type'];
-
 declare type ChannelMiddleware = OpenFin.ChannelMiddleware;
 
-declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity: ProviderIdentity_7 | ClientIdentity_2) => Promise<unknown> | unknown;
+declare type ChannelMiddleware_2 = (topic: string, payload: unknown, senderIdentity: ProviderIdentity_7 | ClientIdentity) => Promise<unknown> | unknown;
 
 /**
  * Instance created to enable use of a channel as a provider. Allows for communication with the {@link ChannelClient ChannelClients} by invoking an action on
@@ -2501,7 +2489,7 @@ declare class ChannelProvider extends ChannelBase {
      * ```
      * @param listener
      */
-    onConnection(listener: ConnectionListener): void;
+    onConnection(listener: OpenFin.ChannelClientConnectionListener): void;
     /**
      * Register a listener that is called on client disconnection. It is passed the disconnection event of the disconnecting
      * client.
@@ -2520,7 +2508,7 @@ declare class ChannelProvider extends ChannelBase {
      * })();
      * ```
      */
-    onDisconnection(listener: DisconnectionListener_2): void;
+    onDisconnection(listener: OpenFin.ChannelClientDisconnectionListener): void;
     /**
      * Destroy the channel, raises `disconnected` events on all connected channel clients.
      *
@@ -2575,6 +2563,8 @@ declare class ChannelProvider extends ChannelBase {
     private static clientIsMultiRuntime;
 }
 
+declare type ChannelProviderDisconnectionListener = (identity: ProviderIdentity_7) => any;
+
 declare interface ChannelStrategy<T extends unknown> {
     onEndpointDisconnect(endpointId: string, listener: () => void): void;
     receive(listener: (action: string, payload: any, identity: any) => Promise<any>): void;
@@ -2604,7 +2594,7 @@ declare type ChildContentOpenedInBrowserEvent = ContentCreationRulesEvent & {
 
 declare interface ChildContentOptions {
     options: any;
-    entityType: EntityType_5;
+    entityType: EntityType_4;
 }
 
 /**
@@ -2684,15 +2674,13 @@ declare type ClickedMenuResult<T extends unknown = unknown> = {
 /**
  * @interface
  */
-declare type ClientConnectionPayload = ClientIdentity_2 & ClientInfo;
-
-declare type ClientIdentity = OpenFin.ClientIdentity;
+declare type ClientConnectionPayload = ClientIdentity & ClientInfo;
 
 /**
  * Identity of a channel client
  * @interface
  */
-declare type ClientIdentity_2 = Identity_5 & {
+declare type ClientIdentity = Identity_5 & {
     /**
      * Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
      */
@@ -2703,7 +2691,7 @@ declare type ClientIdentity_2 = Identity_5 & {
 /**
  * @interface
  */
-declare type ClientIdentityMultiRuntime = ClientIdentity_2 & {
+declare type ClientIdentityMultiRuntime = ClientIdentity & {
     runtimeUuid: string;
 };
 
@@ -2711,11 +2699,11 @@ declare type ClientIdentityMultiRuntime = ClientIdentity_2 & {
  * Extended channel client information
  * @interface
  */
-declare type ClientInfo = Omit<ClientIdentity_2, 'isLocalEndpointId'> & {
+declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
     /**
      * Indicates if the client belongs to a Window, View or IFrame
      */
-    entityType: EntityType_2;
+    entityType: EntityType_5;
     /**
      * URL of the Window, View or IFrame at the time of connection to the Channel Provider.
      */
@@ -3049,8 +3037,6 @@ export declare function connect(config: ConnectConfig): Promise<Fin<'external co
 
 declare type ConnectConfig = ExistingConnectConfig | NewConnectConfig | ExternalConfig;
 
-declare type ConnectionListener = (identity: ClientIdentity, connectionMessage?: any) => Promise<any> | any;
-
 declare type Constructor<T = {}> = new () => T;
 
 declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
@@ -3687,10 +3673,6 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
     type: 'disabled-movement-bounds-changing';
 };
 
-declare type DisconnectionListener = (providerIdentity: OpenFin.ProviderIdentity) => any;
-
-declare type DisconnectionListener_2 = (identity: ClientIdentity) => any;
-
 /**
  * The display data for a context group.
  */
@@ -3898,7 +3880,7 @@ declare type EntityInfo = OpenFin.EntityInfo;
 declare type EntityInfo_2 = {
     uuid: string;
     name: string;
-    entityType: EntityType_2;
+    entityType: EntityType_5;
 };
 
 /**
@@ -3912,15 +3894,15 @@ declare type EntityProcessDetails = FrameProcessDetails & {
 
 declare type EntityType = OpenFin.EntityType;
 
-declare type EntityType_2 = 'window' | 'iframe' | 'external connection' | 'view' | 'unknown';
+declare type EntityType_2 = OpenFin.EntityType;
 
 declare type EntityType_3 = OpenFin.EntityType;
 
 declare type EntityType_4 = OpenFin.EntityType;
 
-declare type EntityType_5 = OpenFin.EntityType;
+declare type EntityType_5 = 'window' | 'iframe' | 'external connection' | 'view' | 'unknown';
 
-declare type EntityTypeHelpers<T extends EntityType_4> = T extends 'view' ? {
+declare type EntityTypeHelpers<T extends EntityType_3> = T extends 'view' ? {
     isView: true;
     isWindow: false;
     isExternal: false;
@@ -3958,7 +3940,7 @@ declare interface Environment {
     createChildContent(options: ChildContentOptions): Promise<any>;
     getWebWindow(identity: OpenFin.Identity): globalThis.Window;
     getCurrentEntityIdentity(): OpenFin.EntityInfo;
-    getCurrentEntityType(): EntityType_5;
+    getCurrentEntityType(): EntityType_4;
     raiseEvent(eventName: string, eventArgs: any): void;
     childViews: boolean;
     getUrl(): string;
@@ -3973,7 +3955,7 @@ declare interface Environment {
 
 declare type ErrorMiddleware = OpenFin.ErrorMiddleware;
 
-declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity_2) => unknown;
+declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity) => unknown;
 
 /**
  * This function converts JS errors into plain objects
@@ -4382,6 +4364,9 @@ declare type FileDownloadStartedEvent = FileDownloadEvent & {
     state: 'started';
 };
 
+/**
+ * @internal
+ */
 declare class Fin<MeType extends EntityType = EntityType> extends EventEmitter implements FinApi<MeType> {
     private wire;
     System: System;
@@ -4403,8 +4388,11 @@ declare class Fin<MeType extends EntityType = EntityType> extends EventEmitter i
     constructor(wire: Transport<MeType>);
 }
 
-declare type Fin_2<MeType extends EntityType_2 = 'window' | 'view'> = FinApi<MeType>;
+declare type Fin_2<MeType extends EntityType_5 = 'window' | 'view'> = FinApi<MeType>;
 
+/**
+ * Type of the global `fin` entry point for the OpenFin API.
+ */
 declare interface FinApi<MeType extends EntityType> {
     readonly System: System;
     readonly Window: _WindowModule;
@@ -4676,7 +4664,7 @@ declare type FrameInfo = {
     name: string;
     uuid: string;
     url: string;
-    entityType: EntityType_2;
+    entityType: EntityType_5;
     parent: Identity_5;
 };
 
@@ -4769,7 +4757,7 @@ declare type GetWindowContextPayload = {
     /**
      * Entity type of the target of the context update ('view' or 'window').
      */
-    entityType: EntityType_2;
+    entityType: EntityType_5;
     /**
      * Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
      */
@@ -7700,7 +7688,7 @@ declare type MaximizedEvent = NamedEvent & {
     type: 'maximized';
 };
 
-declare type Me<MeType extends EntityType_4> = OpenFin.EntityInfo & (MeType extends 'view' ? EntityTypeHelpers<'view'> & OpenFin.View & WithInterop : MeType extends 'window' ? EntityTypeHelpers<'window'> & OpenFin.Window & WithInterop : MeType extends 'iframe' ? EntityTypeHelpers<'iframe'> & OpenFin.Frame & WithInterop : MeType extends 'external connection' ? EntityTypeHelpers<'external connection'> & OpenFin.ExternalApplication & WithInterop : EntityTypeHelpers<MeType> & WithInterop) & {
+declare type Me<MeType extends EntityType_3> = OpenFin.EntityInfo & (MeType extends 'view' ? EntityTypeHelpers<'view'> & OpenFin.View & WithInterop : MeType extends 'window' ? EntityTypeHelpers<'window'> & OpenFin.Window & WithInterop : MeType extends 'iframe' ? EntityTypeHelpers<'iframe'> & OpenFin.Frame & WithInterop : MeType extends 'external connection' ? EntityTypeHelpers<'external connection'> & OpenFin.ExternalApplication & WithInterop : EntityTypeHelpers<MeType> & WithInterop) & {
     isOpenFin: boolean;
 };
 
@@ -8251,21 +8239,32 @@ declare type Opacity = TransitionBase & {
 
 declare namespace OpenFin {
     export {
+        FinApi,
         Fin_2 as Fin,
         Application,
+        ApplicationModule,
         ExternalApplication,
+        ExternalApplicationModule,
         _Frame as Frame,
+        _FrameModule,
+        Channel,
         ChannelClient,
         ChannelProvider,
         Platform,
+        PlatformModule,
         Layout,
+        LayoutModule,
         View_2 as View,
+        ViewModule,
         ColumnOrRow,
         TabStack,
         _Window as Window,
+        _WindowModule,
         InteropClient,
         InteropBroker,
+        InteropModule,
         SnapshotSource,
+        SnapshotSourceModule,
         LayoutEntityDefinition,
         LayoutEntityTypes,
         LayoutPosition,
@@ -8273,12 +8272,12 @@ declare namespace OpenFin {
         PlatformProvider,
         ApplicationIdentity_2 as ApplicationIdentity,
         Identity_5 as Identity,
-        ClientIdentity_2 as ClientIdentity,
+        ClientIdentity,
         ClientInfo,
         ClientIdentityMultiRuntime,
         ClientConnectionPayload,
         EntityInfo_2 as EntityInfo,
-        EntityType_2 as EntityType,
+        EntityType_5 as EntityType,
         Bounds,
         WindowBounds,
         Rectangle,
@@ -8518,7 +8517,6 @@ declare namespace OpenFin {
         AppVersionCompleteEvent,
         AppVersionRuntimeStatusEvent,
         BaseEvents,
-        ChannelEvents,
         WebContentsEvents,
         SystemEvents,
         ApplicationEvents,
@@ -8529,7 +8527,6 @@ declare namespace OpenFin {
         PlatformEvents,
         ExternalApplicationEvents,
         BaseEvent_2 as BaseEvent,
-        ChannelEvent_2 as ChannelEvent,
         WebContentsEvent_2 as WebContentsEvent,
         SystemEvent_2 as SystemEvent,
         ApplicationEvent_2 as ApplicationEvent,
@@ -8549,7 +8546,11 @@ declare namespace OpenFin {
         Me,
         CapturePageOptions,
         ProcessLoggingOptions,
-        PositioningOptions
+        PositioningOptions,
+        ChannelClientConnectionListener,
+        ChannelClientDisconnectionListener,
+        ChannelProviderDisconnectionListener,
+        RoutingInfo
     }
 }
 export default OpenFin;
@@ -10951,7 +10952,7 @@ declare type RGB = {
 /**
  * @interface
  */
-declare type RoutingInfo = OpenFin.ProviderIdentity & {
+declare type RoutingInfo = ProviderIdentity_7 & {
     endpointId: string;
 };
 
@@ -11173,7 +11174,7 @@ declare type SetWindowContextPayload = {
     /**
      * Entity type of the target of the context update ('view' or 'window').
      */
-    entityType: EntityType_2;
+    entityType: EntityType_5;
     /**
      * Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
      */
@@ -11266,16 +11267,18 @@ declare type Snapshot = {
     };
 };
 
-declare type SnapshotProvider<T> = {
-    getSnapshot: () => Promise<T>;
-    applySnapshot: (snapshot: T) => Promise<void>;
+declare type SnapshotProvider<Snapshot = unknown> = {
+    getSnapshot: () => Promise<Snapshot>;
+    applySnapshot: (snapshot: Snapshot) => Promise<void>;
 };
 
 /**
  * Enables configuring a SnapshotSource with custom getSnapshot and applySnapshot methods.
  *
+ * @typeParam Snapshot Implementation-defined shape of an application snapshot.  Allows
+ * custom snapshot implementations for legacy applications to define their own snapshot format.
  */
-declare class SnapshotSource<T = any> extends Base {
+declare class SnapshotSource<Snapshot = unknown> extends Base {
     #private;
     /**
      * @internal
@@ -11314,12 +11317,12 @@ declare class SnapshotSource<T = any> extends Base {
      * Call the SnapshotSource's getSnapshot method defined by {@link SnapshotSource.SnapshotSourceModule#init init}.
      *
      */
-    getSnapshot(): Promise<T>;
+    getSnapshot(): Promise<Snapshot>;
     /**
      * Call the SnapshotSource's applySnapshot method defined by {@link SnapshotSource.SnapshotSourceModule#init init}.
      *
      */
-    applySnapshot(snapshot: T): Promise<void>;
+    applySnapshot(snapshot: Snapshot): Promise<void>;
 }
 
 /**
@@ -11329,6 +11332,9 @@ declare class SnapshotSourceModule extends Base {
     /**
      * Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
      *
+     * @typeParam Snapshot Implementation-defined shape of an application snapshot.  Allows
+     * custom snapshot implementations for legacy applications to define their own snapshot format.
+     *
      * @example
      * ```js
      * const snapshotProvider = {
@@ -11344,8 +11350,9 @@ declare class SnapshotSourceModule extends Base {
      *
      * await fin.SnapshotSource.init(snapshotProvider);
      * ```
+     *
      */
-    init<T = any>(provider: OpenFin.SnapshotProvider<T>): Promise<void>;
+    init<Snapshot = unknown>(provider: OpenFin.SnapshotProvider<Snapshot>): Promise<void>;
     /**
      * Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
      *
@@ -13293,7 +13300,7 @@ declare type TransitionOptions = {
     tween?: tween;
 };
 
-declare class Transport<MeType extends EntityType_3 = EntityType_3> extends EventEmitter {
+declare class Transport<MeType extends EntityType_2 = EntityType_2> extends EventEmitter {
     #private;
     protected wireListeners: Map<number, {
         resolve: Function;