@openfin/node-adapter 34.78.9 → 34.78.11

package/out/node-adapter-alpha.d.ts

@@ -845,7 +845,10 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
 };
 
 /**
- *  An Application event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}.  Events are
+ *  discriminated by {@link ApplicationEvent.type | their type}.  Event payloads unique to `Application` can be found
+ *  under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
+ *  from which they propagate).
  */
 declare type ApplicationEvent = {
     topic: 'application';
@@ -1466,7 +1469,7 @@ declare type AutoResizeOptions = {
 };
 
 declare class Base {
-    wire: Transport;
+    /* Excluded from this release type: wire */
     /* Excluded from this release type: __constructor */
     protected get fin(): OpenFin.Fin<OpenFin.EntityType>;
     get me(): Identity;
@@ -1572,6 +1575,9 @@ declare type BaseViewEvent = NamedEvent & {
     viewIdentity: OpenFin.Identity;
 };
 
+/**
+ * User decision of whether a Window or specific View should close when trying to prevent an unload.
+ */
 declare interface BeforeUnloadUserDecision {
     /**
      * Specifies if the Window should close.
@@ -1890,7 +1896,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>;
@@ -2243,7 +2249,7 @@ declare class ChannelClient extends ChannelBase {
      * })();
      * ```
      */
-    onDisconnection(listener: DisconnectionListener): void;
+    onDisconnection(listener: OpenFin.ChannelProviderDisconnectionListener): void;
     /**
      * Disconnects the client from the channel.
      *
@@ -2263,6 +2269,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
@@ -2314,26 +2324,9 @@ declare type ChannelEvent = {
     topic: 'channel';
 } & (ChannelConnectedEvent | ChannelDisconnectedEvent);
 
-declare type ChannelEvent_2 = ChannelEvents.ChannelEvent;
-
-declare namespace ChannelEvents {
-    export {
-        BaseChannelEvent,
-        ChannelConnectedEvent,
-        ChannelDisconnectedEvent,
-        ChannelEvent,
-        ChannelEventType
-    }
-}
-
-/**
- * A Channel event type.
- */
-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
@@ -2456,7 +2449,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.
@@ -2475,7 +2468,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.
      *
@@ -2530,6 +2523,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;
@@ -2559,7 +2554,7 @@ declare type ChildContentOpenedInBrowserEvent = ContentCreationRulesEvent & {
 
 declare interface ChildContentOptions {
     options: any;
-    entityType: EntityType_5;
+    entityType: EntityType_4;
 }
 
 /**
@@ -2639,15 +2634,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.
      */
@@ -2658,7 +2651,7 @@ declare type ClientIdentity_2 = Identity_5 & {
 /**
  * @interface
  */
-declare type ClientIdentityMultiRuntime = ClientIdentity_2 & {
+declare type ClientIdentityMultiRuntime = ClientIdentity & {
     runtimeUuid: string;
 };
 
@@ -2666,11 +2659,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.
      */
@@ -2873,6 +2866,9 @@ declare type CloseViewPayload = {
     view: Identity_5;
 };
 
+/**
+ * Represents the shape of payload that contains the Window Identity and related options.
+ */
 declare interface CloseWindowPayload {
     /**
      *
@@ -2947,8 +2943,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>;
@@ -3585,10 +3579,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.
  */
@@ -3796,7 +3786,7 @@ declare type EntityInfo = OpenFin.EntityInfo;
 declare type EntityInfo_2 = {
     uuid: string;
     name: string;
-    entityType: EntityType_2;
+    entityType: EntityType_5;
 };
 
 /**
@@ -3810,15 +3800,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;
@@ -3856,7 +3846,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;
@@ -3871,7 +3861,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
@@ -4032,7 +4022,9 @@ declare type ExternalApplicationDisconnectedEvent = BaseEvent & {
 };
 
 /**
- * An external application event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}.  Events are
+ *  discriminated by {@link ExternalApplicationEvent.type | their type}.  Event payloads unique to `ExternalApplication` can be found
+ *  under the {@link OpenFin.ExternalApplicationEvents} namespace.
  */
 declare type ExternalApplicationEvent = {
     topic: 'externalapplication';
@@ -4259,26 +4251,13 @@ declare type FileDownloadStartedEvent = FileDownloadEvent & {
     state: 'started';
 };
 
-declare class Fin<MeType extends EntityType = EntityType> extends EventEmitter implements FinApi<MeType> {
-    private wire;
-    System: System;
-    Window: _WindowModule;
-    Application: ApplicationModule;
-    InterApplicationBus: InterApplicationBus;
-    Clipboard: Clipboard_2;
-    ExternalApplication: ExternalApplicationModule;
-    Frame: _FrameModule;
-    GlobalHotkey: GlobalHotkey;
-    View: ViewModule;
-    Platform: PlatformModule;
-    Interop: InteropModule;
-    SnapshotSource: SnapshotSourceModule;
-    readonly me: Me<MeType>;
-    /* Excluded from this release type: __constructor */
-}
+/* Excluded from this release type: Fin */
 
-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;
@@ -4537,7 +4516,9 @@ declare namespace FrameEvents {
 }
 
 /**
- * A Frame event type.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}.  Events are
+ *  discriminated by {@link _Frame.type | their type}.  Event payloads unique to `Frame` can be found
+ *  under the {@link OpenFin.FrameEvents} namespace.
  */
 declare type FrameEventType = FrameEvent['type'];
 
@@ -4545,7 +4526,7 @@ declare type FrameInfo = {
     name: string;
     uuid: string;
     url: string;
-    entityType: EntityType_2;
+    entityType: EntityType_5;
     parent: Identity_5;
 };
 
@@ -4638,7 +4619,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}.
      */
@@ -4747,7 +4728,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
 }
 
 /**
- * A global hotkey event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}.  Events are
+ *  discriminated by {@link GlobalHotkeyEvent.type | their type}.  Event payloads unique to `GlobalHotkey` can be found
+ *  under the {@link OpenFin.GlobalHotkeyEvents} namespace.
  */
 declare type GlobalHotkeyEvent = {
     topic: 'global-hotkey';
@@ -5101,6 +5084,9 @@ declare class InterApplicationBus extends Base {
 
 declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
 
+/**
+ * Define whether to enable interop action logging.
+ */
 declare interface InteropActionLoggingOption {
     enabled: boolean;
 }
@@ -7259,7 +7245,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;
 };
 
@@ -7799,21 +7785,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,
@@ -7821,12 +7818,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,
@@ -8066,7 +8063,6 @@ declare namespace OpenFin {
         AppVersionCompleteEvent,
         AppVersionRuntimeStatusEvent,
         BaseEvents,
-        ChannelEvents,
         WebContentsEvents,
         SystemEvents,
         ApplicationEvents,
@@ -8077,7 +8073,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,
@@ -8097,7 +8092,11 @@ declare namespace OpenFin {
         Me,
         CapturePageOptions,
         ProcessLoggingOptions,
-        PositioningOptions
+        PositioningOptions,
+        ChannelClientConnectionListener,
+        ChannelClientDisconnectionListener,
+        ChannelProviderDisconnectionListener,
+        RoutingInfo
     }
 }
 export default OpenFin;
@@ -8425,12 +8424,11 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
      */
     closeView(viewIdentity: OpenFin.Identity): Promise<void>;
     /**
-     * ***DEPRECATED - please use Platform.createView.***
+     * ***DEPRECATED - please use {@link Platform.createView Platform.createView}.***
      * Reparents a specified view in a new target window.
      * @param viewIdentity View identity
      * @param target new owner window identity
      *
-     * @tutorial Platform.createView
      */
     reparentView(viewIdentity: OpenFin.Identity, target: OpenFin.Identity): Promise<View>;
     /**
@@ -8778,7 +8776,9 @@ declare type PlatformApiReadyEvent = BaseEvent & {
 };
 
 /**
- * A Platform event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}.  Events are
+ *  discriminated by {@link PlatformEvent.type | their type}.  Event payloads unique to `Platform` can be found
+ *  under the {@link OpenFin.PlatformEvents} namespace.
  */
 declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
 
@@ -9521,30 +9521,109 @@ declare type PopupBlurBehavior = 'modal' | PopupBaseBehavior;
 
 declare type PopupInteraction = 'clicked' | 'dismissed';
 
+/**
+ * Popup window options.
+ */
 declare interface PopupOptions {
+    /**
+     * Window creation options when using `showPopupWindow` to create a new window.
+     */
     initialOptions?: Optional<WindowCreationOptions, 'name'>;
+    /**
+     * Updatable window options applied to new and existing windows when shown as popups.
+     */
     additionalOptions?: UpdatableWindowOptions;
+    /**
+     * If a window with this `name` exists, it will be shown as a popup.
+     * Otherwise, a new window with this `name` will be created. If this `name` is undefined, `initialOptions.name` will be used. If this `name` and `intialOptions.name` are both undefined, a `name` will be generated.
+     */
     name?: string;
+    /**
+     * Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
+     */
     url?: string;
+    /**
+     * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
+     * @defaultValue 300
+     */
     height?: number;
+    /**
+     * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
+     * @defaultValue 300
+     */
     width?: number;
+    /**
+     * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
+     * @defaultValue 0
+     */
     x?: number;
+    /**
+     * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
+     * @defaultValue 0
+     */
     y?: number;
+    /**
+     * Determines what happens if the popup window is blurred.
+     * * 'modal' restricts resizing and positioning in the caller.
+     * * 'hide' hides the popup window on blur.
+     * * 'close' closes the popup window on blur.
+     * @defaultValue 'close'
+     */
     blurBehavior?: PopupBlurBehavior;
+    /**
+     * Determines what happens when the popup window calls `dispatchPopupResult`.
+     * * 'none' will do nothing.
+     * * 'hide' hides the popup window on `dispatchPopupResult`.
+     * * 'close' closes the popup window on `dispatchPopupResult`.
+     * @defaultValue 'close'
+     */
     resultDispatchBehavior?: PopupResultBehavior;
+    /**
+     * Hide the popup window instead of closing when `close` is called on it.
+     * <br>Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
+     * @defaultValue false
+     */
     hideOnClose?: boolean;
+    /**
+     * Determines if the popup window should or should not be focused when it is shown.
+     * @defaultValue true
+     */
     focus?: boolean;
+    /**
+     * Executed when the popup window is shown. Provides the popup window to the provided function, and allows for easy access the popup window for additional behavior customization.
+     */
     onPopupReady?: (popupWindow: _Window) => any;
+    /**
+     * Executed when this window's popup calls `dispatchPopupResult`.
+     * <br>Note: If this is defined, `showPopupWindow` will not return a `PopupResult`.
+     */
     onPopupResult?: (payload: PopupResult) => any;
 }
 
+/**
+ * The Popup result.
+ *
+ * @typeParam T - Type of data the Popup result contains
+ */
 declare interface PopupResult<T = any> {
+    /**
+     * `name` and `uuid` of the popup window that called dispatched this result.
+     */
     identity: {
         name: string;
         uuid: string;
     };
+    /**
+     * Result of the user interaction with the popup window.
+     */
     result: PopupInteraction;
+    /**
+     * Data passed to `dispatchPopupResult`.
+     */
     data?: T;
+    /**
+     * The last dispatch result.
+     */
     lastDispatchResult?: PopupResult;
 }
 
@@ -9780,10 +9859,25 @@ declare type ProcessDetails = {
     pid: number;
 };
 
+/**
+ * Process logging options
+ */
 declare interface ProcessLoggingOptions {
+    /**
+     * Periodic Logging Interval (in seconds)
+     */
     interval?: number;
+    /**
+     * Outlier Detection options
+     */
     outlierDetection?: {
+        /**
+         * Outlier Interval (in seconds)
+         */
         interval?: number;
+        /**
+         * Number of Process Info entries to collect for outlier analysis
+         */
         entries?: number;
     };
 }
@@ -10335,7 +10429,7 @@ declare type RGB = {
 /**
  * @interface
  */
-declare type RoutingInfo = OpenFin.ProviderIdentity & {
+declare type RoutingInfo = ProviderIdentity_7 & {
     endpointId: string;
 };
 
@@ -10557,7 +10651,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}.
      */
@@ -10650,16 +10744,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;
     /* Excluded from this release type: __constructor */
     get identity(): OpenFin.ApplicationIdentity;
@@ -10695,12 +10791,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>;
 }
 
 /**
@@ -10710,6 +10806,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 = {
@@ -10725,8 +10824,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.
      *
@@ -12243,7 +12343,10 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
 }
 
 /**
- * A system event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}.  Events are
+ *  discriminated by {@link SystemEvent.type | their type}.  Event payloads unique to `System` can be found
+ *  under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
+ *  from which they propagate).
  */
 declare type SystemEvent = {
     topic: 'system';
@@ -12611,7 +12714,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;
@@ -13340,7 +13443,9 @@ declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
 };
 
 /**
- * A View event.
+ *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}.  Events are
+ *  discriminated by {@link ViewEvent.type | their type}.  Event payloads unique to `View` can be found
+ *  under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
  */
 declare type ViewEvent = {
     topic: 'view';
@@ -13504,6 +13609,9 @@ declare class ViewOverlay {
     setIgnoreViewMouseEvents(enabled: boolean): Promise<void>;
 }
 
+/**
+ * Represents the payload shape for Views that are trying to prevent an unload.
+ */
 declare interface ViewsPreventingUnloadPayload {
     /**
      * Specifies if the Window should close.
@@ -13537,6 +13645,9 @@ declare type ViewState = ViewCreationOptions & {
     minWidth?: number;
 };
 
+/**
+ * The statuses of views specifying which of them are trying to prevent an unload and which are not.
+ */
 declare interface ViewStatuses {
     /**
      * Identities of the Views that are preventing an unload.
@@ -15994,6 +16105,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      */
     closePopupMenu(): Promise<void>;
     /**
+     * @PORTED
      * @typedef {object} PopupOptions@typedef {object} PopupOptions
      * @property {string} [name] - If a window with this `name` exists, it will be shown as a popup. Otherwise, a new window with this `name` will be created. If this `name` is undefined, `initialOptions.name` will be used. If this `name` and `intialOptions.name` are both undefined, a `name` will be generated.
      * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
@@ -16011,6 +16123,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
              * @property {boolean} [hideOnClose] - Hide the popup window instead of closing whenever `close` is called on it. Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
              */
          /**
+          * @PORTED
           * @typedef {object} PopupResult@typedef {object} PopupResult
           * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
           * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
@@ -16156,7 +16269,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
           */
          name: string;
          /**
-          * The right-most coordinate of the window
+          * The right-most coordinate of the window.
           */
          right: number;
          state: string;
@@ -16179,7 +16292,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      };
 
      /**
-      * A Window event.
+      *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}.  Events are
+      *  discriminated by {@link WindowEvent.type | their type}.  Event payloads unique to `Window` can be found
+      *  under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
       */
      declare type WindowEvent = {
          topic: 'window';