@openfin/node-adapter 34.78.12 → 34.78.14

package/out/node-adapter.d.ts

@@ -1160,11 +1160,13 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
     plugins: boolean;
     /**
      * @defaultValue false
+     *
      * Enable spell check at the application level.
      */
     spellCheck: boolean;
     /**
      * @defaultValue 'about:blank'
+     *
      * The url to the application (specifically the application's main window).
      */
     url: string;
@@ -1181,35 +1183,66 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      * When set to `false` it will disable the same-origin policy for the app.
      */
     webSecurity: boolean;
+    /**
+     * Configuration for keyboard commands.
+     * For details and usage, see {@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands Using Keyboard Commands}.
+     */
     commands: ShortcutOverride[];
     isPlatformController: boolean;
     /**
      * @defaultValue 1000
      *
-     * Platforms Only.  The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
+     * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
      * If you do not wish for views to be pooled on your platform, set this property to zero.
      */
     maxViewPoolSize: number;
-    defaultWindowOptions: Partial<WindowOptions>;
+    /**
+     * **Platforms Only.** Default window options apply to all platform windows.
+     */
+    defaultWindowOptions: Partial<PlatformWindowOptions>;
+    /**
+     * **Platforms Only.** Default view options apply to all platform views.
+     */
     defaultViewOptions: Partial<ViewOptions>;
+    /**
+     * **Platforms Only.** The snapshot to be applied.
+     */
     snapshot: Snapshot;
     /**
      * @defaultValue false
      *
-     * Platforms Only. Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
+     * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
      * Note: if the Platform Provider is showing, it won't close automatically.
      * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
      */
     preventQuitOnLastWindowClosed: boolean;
+    /**
+     * Configuration for interop broker.
+     */
     interopBrokerConfiguration: InteropBrokerOptions;
+    /**
+     * @defaultValue true
+     *
+     * When set to `false` it will disable OpenFin Diagnostics for the app.
+     */
     apiDiagnostics: boolean;
+    /**
+     * Define the file download rules.
+     * See [here](https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads) for more details.
+     */
     defaultDomainSettings: DefaultDomainSettings;
     /**
      * @defaultValue false
+     *
      * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
      * Only relevant in Windows.
      */
     enableJumpList: boolean;
+    /**
+     * @defaultValue false
+     *
+     * When set to `true`, any `beforeunload` handler set on the app will fire.
+     */
     enableBeforeUnload: boolean;
 };
 
@@ -1267,7 +1300,7 @@ declare type ApplicationWindowInfo_2 = {
     childWindows: Array<WindowDetail>;
     mainWindow: WindowDetail;
     /**
-     * @property { string } uuid The uuid of the application
+     * The uuid of the application.
      */
     uuid: string;
 };
@@ -1307,7 +1340,7 @@ declare type ApplySnapshotOptions = {
  */
 declare type ApplySnapshotPayload = {
     /**
-     * TThe snapshot to be applied.
+     * The snapshot to be applied.
      */
     snapshot: Snapshot;
     /**
@@ -1543,6 +1576,13 @@ declare class Base {
      */
     constructor(wire: Transport);
     protected get fin(): OpenFin.Fin<OpenFin.EntityType>;
+    /**
+     * Provides access to the OpenFin representation of the current code context (usually a document
+     * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
+     *
+     * Useful for debugging in the devtools console, where this will intelligently type itself based
+     * on the context in which the devtools panel was opened.
+     */
     get me(): Identity;
     protected isNodeEnvironment: () => boolean;
     protected isOpenFinEnvironment: () => boolean;
@@ -2668,7 +2708,7 @@ declare type ChildContentOpenedInBrowserEvent = ContentCreationRulesEvent & {
 
 declare interface ChildContentOptions {
     options: any;
-    entityType: EntityType_4;
+    entityType: EntityType_3;
 }
 
 /**
@@ -2693,11 +2733,6 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
      * The options the child Window was created with.
      */
     childOptions: OpenFin.WindowOptions;
-    /**
-     * On `child-window-created` rule may be undefined.
-     * It is only defined if the rules engine found a match for a user-supplied rule, not in the case of an api call or the default behavior.
-     */
-    rule?: OpenFin.ContentCreationRule;
 };
 
 declare interface ClassicProtocolOffer extends ProtocolPacketBase {
@@ -2744,11 +2779,16 @@ declare type ClearCacheOption = {
 };
 
 /**
+ * @typeParam Data User-defined shape for data returned upon menu item click.  Should be a
+ * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
+ * of all possible data shapes for the entire menu, and the click handler should process
+ * these with a "reducer" pattern.
+ *
  * @interface
  */
-declare type ClickedMenuResult<T extends unknown = unknown> = {
+declare type ClickedMenuResult<Data extends unknown = unknown> = {
     result: 'clicked';
-    data: T;
+    data: Data;
 };
 
 /**
@@ -2757,7 +2797,7 @@ declare type ClickedMenuResult<T extends unknown = unknown> = {
 declare type ClientConnectionPayload = ClientIdentity & ClientInfo;
 
 /**
- * Identity of a channel client
+ * Identity of a channel client. Includes endpointId to differentiate between different connections for an entity.
  * @interface
  */
 declare type ClientIdentity = Identity_5 & {
@@ -2783,7 +2823,7 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
     /**
      * Indicates if the client belongs to a Window, View or IFrame
      */
-    entityType: EntityType_5;
+    entityType: EntityType_4;
     /**
      * URL of the Window, View or IFrame at the time of connection to the Channel Provider.
      */
@@ -3185,6 +3225,11 @@ declare type ConstViewOptions = {
     zoomLevel: number;
     experimental: any;
     fdc3InteropApi?: string;
+    /**
+     * @defaultValue false
+     *
+     * When set to `true`, any `beforeunload` handler set on Views will fire.
+     */
     enableBeforeUnload: boolean;
     /**
      * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
@@ -3417,15 +3462,12 @@ declare type ContentCreationOptions = {
  * A rule for creating content in OpenFin; maps a content type to the way in which
  * newly-opened content of that type will be handled.
  *
- * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
- * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
- * @property { object } options Window creation options or View creation options.
  *
  * @interface
  */
 declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
     /**
-     * Behavior to use when opening matched content.
+     * Behavior to use when opening matched content. The value could be 'view' | 'window' | 'browser' | 'block'.
      */
     behavior: T;
     /**
@@ -3460,7 +3502,8 @@ declare type ContentCreationRulesEvent = NamedEvent & {
      */
     frameName: string;
     /**
-     * The rule which triggered this event. May be undefined on `child-window-created` where no rule corresponds to the child Window creation
+     * The rule which triggered this event. May be undefined on `child-window-created` where no rule corresponds to the child Window creation.
+     * <br>Note: It is only defined if the rules engine found a match for a user-supplied rule, not in the case of an api call or the default behavior.
      */
     rule: OpenFin.ContentCreationRule;
     /**
@@ -3518,6 +3561,7 @@ declare type ContextForIntent<MetadataType = any> = Context & {
 };
 
 /**
+ * Information for a Context Group. Contains metadata for displaying the group properly.
  * @interface
  */
 declare type ContextGroupInfo = {
@@ -3537,6 +3581,9 @@ declare type ContextGroupStates = {
     };
 };
 
+/**
+ * Subscription function for addContextHandler.
+ */
 declare type ContextHandler = (context: Context) => void;
 
 /**
@@ -4013,7 +4060,7 @@ declare type EntityInfo = OpenFin.EntityInfo;
 declare type EntityInfo_2 = {
     uuid: string;
     name: string;
-    entityType: EntityType_5;
+    entityType: EntityType_4;
 };
 
 /**
@@ -4031,11 +4078,9 @@ declare type EntityType_2 = OpenFin.EntityType;
 
 declare type EntityType_3 = OpenFin.EntityType;
 
-declare type EntityType_4 = OpenFin.EntityType;
-
-declare type EntityType_5 = 'window' | 'iframe' | 'external connection' | 'view' | 'unknown';
+declare type EntityType_4 = 'window' | 'iframe' | 'external connection' | 'view' | 'unknown';
 
-declare type EntityTypeHelpers<T extends EntityType_3> = T extends 'view' ? {
+declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
     isView: true;
     isWindow: false;
     isExternal: false;
@@ -4073,7 +4118,7 @@ declare interface Environment {
     createChildContent(options: ChildContentOptions): Promise<any>;
     getWebWindow(identity: OpenFin.Identity): globalThis.Window;
     getCurrentEntityIdentity(): OpenFin.EntityInfo;
-    getCurrentEntityType(): EntityType_4;
+    getCurrentEntityType(): EntityType_3;
     raiseEvent(eventName: string, eventArgs: any): void;
     childViews: boolean;
     getUrl(): string;
@@ -4521,7 +4566,7 @@ declare type FileDownloadStartedEvent = FileDownloadEvent & {
 /**
  * @internal
  */
-declare class Fin<MeType extends EntityType = EntityType> extends EventEmitter implements FinApi<MeType> {
+declare class Fin<MeType extends OpenFin.EntityType = OpenFin.EntityType> extends EventEmitter implements FinApi<MeType> {
     private wire;
     System: System;
     Window: _WindowModule;
@@ -4542,12 +4587,12 @@ declare class Fin<MeType extends EntityType = EntityType> extends EventEmitter i
     constructor(wire: Transport<MeType>);
 }
 
-declare type Fin_2<MeType extends EntityType_5 = 'window' | 'view'> = FinApi<MeType>;
+declare type Fin_2<MeType extends EntityType_4 = 'window' | 'view'> = FinApi<MeType>;
 
 /**
  * Type of the global `fin` entry point for the OpenFin API.
  */
-declare interface FinApi<MeType extends EntityType> {
+declare interface FinApi<MeType extends OpenFin.EntityType> {
     readonly System: System;
     readonly Window: _WindowModule;
     readonly Application: ApplicationModule;
@@ -4829,7 +4874,7 @@ declare type FrameInfo = {
     name: string;
     uuid: string;
     url: string;
-    entityType: EntityType_5;
+    entityType: EntityType_4;
     parent: Identity_5;
 };
 
@@ -4928,7 +4973,7 @@ declare type GetWindowContextPayload = {
     /**
      * Entity type of the target of the context update ('view' or 'window').
      */
-    entityType: EntityType_5;
+    entityType: EntityType_4;
     /**
      * Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
      */
@@ -5312,9 +5357,13 @@ declare type Intent<MetadataType = IntentMetadata> = {
     metadata?: MetadataType;
 };
 
+/**
+ * Subscription function for registerIntentHandler.
+ */
 declare type IntentHandler = (intent: Intent) => void;
 
 /**
+ * The type used to describe an intent within the platform.
  * @interface
  */
 declare type IntentMetadata<TargetType = any> = {
@@ -6640,6 +6689,7 @@ declare class InteropClient extends Base {
 declare type InteropClientOnDisconnectionListener = (InteropBrokerDisconnectionEvent: InteropBrokerDisconnectionEvent) => any;
 
 /**
+ * Information relevant to the Interop Broker.
  * @interface
  */
 declare type InteropConfig = {
@@ -6752,7 +6802,7 @@ declare type JumpListTask = {
      */
     description: string;
     /**
-     * @property Deep link to a manifest, i.e: fins://path.to/manifest.json?$$param1=value1.
+     * Deep link to a manifest, i.e: fins://path.to/manifest.json?$$param1=value1.
      * See {@link https://developers.openfin.co/docs/deep-linking deep-linking} for more information.
      */
     deepLink: string;
@@ -7146,7 +7196,13 @@ declare type LayoutColumn = LayoutItemConfig & {
  * @interface
  */
 declare type LayoutComponent = LayoutItemConfig & {
+    /**
+     * Only a component type will have this property and it should be set to view.
+     */
     componentName: 'view';
+    /**
+     * Only a component type will have this property and it represents the view options of a given component.
+     */
     componentState?: Partial<ViewCreationOptions>;
 };
 
@@ -7302,7 +7358,7 @@ declare type LayoutInitializedEvent = NamedEvent & {
 };
 
 /**
- * Represents the arrangement of Views within a Platform window's Layout.  We do not recommend trying
+ * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
  * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
  *
@@ -7732,6 +7788,11 @@ declare type LayoutOptions = {
          * (not to be confused with close button on every tab).
          */
         showCloseIcon?: boolean;
+        /**
+         * @defaultValue false
+         *
+         * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
+         */
         constrainDragToHeaders?: boolean;
         /**
          * @defaultValue true
@@ -7760,6 +7821,11 @@ declare type LayoutOptions = {
          */
         preventDragIn?: boolean;
     };
+    /**
+     * Content of the layout. There can only be one top-level LayoutItem in the content array.
+     * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
+     * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
+     */
     content?: LayoutContent;
     dimensions?: {
         borderWidth?: number;
@@ -7924,6 +7990,9 @@ declare type ManifestInfo = {
  * @interface
  */
 declare type Margins = {
+    /**
+     * The margin type. If `custom` is chosen, you will also need to specify top, bottom, left, and right.
+     */
     marginType?: 'default' | 'none' | 'printableArea' | 'custom';
     /**
      * The top margin of the printed webpage, in pixels.
@@ -7953,20 +8022,36 @@ declare type MaximizedEvent = NamedEvent & {
     type: 'maximized';
 };
 
-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) & {
+/**
+ * Type of the OpenFin `me` API handle, which provides access to the OpenFin representation of the current
+ * code context (usually a document such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as
+ * to the current `Interop` context.
+ *
+ * Useful for debugging in the devtools console, where this will intelligently type itself based
+ * on the context in which the devtools panel was opened.
+ */
+declare type Me<MeType extends EntityType_2> = 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;
 };
 
 /**
  * @interface
+ *
+ * @typeParam Data User-defined shape for data returned upon menu item click.  Should be a
+ * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
+ * of all possible data shapes for the entire menu, and the click handler should process
+ * these with a "reducer" pattern.
  */
-declare type MenuItemTemplate<T extends unknown = unknown> = {
+declare type MenuItemTemplate<Data extends unknown = unknown> = {
     /**
      * Can be `normal`, `separator`, `submenu`, or `checkbox`.
      * Defaults to 'normal' unless a 'submenu' key exists
      */
     type?: 'normal' | 'separator' | 'submenu' | 'checkbox';
     role?: 'cut' | 'copy' | 'paste' | 'toggleDevTools' | 'reload';
+    /**
+     * The text to show on the menu item. Should be left undefined for type: 'separator'
+     */
     label?: string;
     /**
      * If false, the menu item will be greyed out and unclickable.
@@ -7984,18 +8069,26 @@ declare type MenuItemTemplate<T extends unknown = unknown> = {
      * Should be specified for `submenu` type menu items. If `submenu` is specified,
      * the `type: 'submenu'` can be omitted.
      */
-    submenu?: MenuItemTemplate<T>[];
+    submenu?: MenuItemTemplate<Data>[];
     /**
      * Data to be returned if the user selects the element. Must be serializable
      */
-    data?: T;
+    data?: Data;
     /**
      * Image Data URI with image dimensions inferred from the encoded string
      */
     icon?: string;
 };
 
-declare type MenuResult<T extends unknown = unknown> = ClickedMenuResult<T> | ClosedMenuResult;
+/**
+ * Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
+ *
+ * @typeParam Data User-defined shape for data returned upon menu item click.  Should be a
+ * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
+ * of all possible data shapes for the entire menu, and the click handler should process
+ * these with a "reducer" pattern.
+ */
+declare type MenuResult<Data extends unknown = unknown> = ClickedMenuResult<Data> | ClosedMenuResult;
 
 declare interface Message<T> {
     action: string;
@@ -8160,7 +8253,7 @@ declare type MutableViewOptions = {
     /**
      * @defaultValue false
      *
-     * Platforms Only.  If true, will hide and detach the View from the window for later use instead of closing,
+     * **Platforms Only.**  If true, will hide and detach the View from the window for later use instead of closing,
      * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
      */
     detachOnClose: boolean;
@@ -8175,7 +8268,7 @@ declare type MutableViewOptions = {
     /**
      * @defaultValue false
      *
-     * @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
+     * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
      */
     preventDragOut: boolean;
     interop?: InteropConfig;
@@ -8413,7 +8506,7 @@ declare type MutableWindowOptions = {
     /**
      * @defaultValue false
      *
-     * Platforms Only.  If true, will show background images in the layout when the Views are hidden.
+     * **Platforms Only.**  If true, will show background images in the layout when the Views are hidden.
      * This occurs when the window is resizing or a tab is being dragged within the layout.
      */
     showBackgroundImages: boolean;
@@ -8562,7 +8655,7 @@ declare namespace OpenFin {
         ClientIdentityMultiRuntime,
         ClientConnectionPayload,
         EntityInfo_2 as EntityInfo,
-        EntityType_5 as EntityType,
+        EntityType_4 as EntityType,
         Bounds,
         WindowBounds,
         Rectangle,
@@ -9729,20 +9822,20 @@ declare class PlatformModule extends Base {
  * @interface
  */
 declare type PlatformOptions = ApplicationCreationOptions & {
-    /**
-     * Default window options apply to all platform windows.
-     */
-    defaultWindowOptions?: Partial<PlatformWindowOptions>;
-    /**
-     * Default view options apply to all platform views.
-     */
-    defaultViewOptions?: Partial<PlatformViewCreationOptions>;
     disableDefaultCommands?: boolean;
     /**
      * Strategy to assign views to process affinity by domain.
+     * * `same` - The views in the same domain will have same renderer processes.
+     * * `different` - The views in the same domain will have their own renderer processes.
      */
     viewProcessAffinityStrategy?: ProcessAffinityStrategy;
+    /**
+     * The provider url.
+     */
     providerUrl?: string;
+    /**
+     * The permissions for secured APIs.
+     */
     permissions?: Partial<Permissions_2>;
 };
 
@@ -10473,11 +10566,10 @@ declare type Position = TransitionBase & {
  * - {@link  OpenFin.Window.setBounds}
  * - {@link  OpenFin.Window.resizeBy}
  * - {@link  OpenFin.Window.resizeTo}
- * @example ```js
- fin.me.setBounds({top: 50, left: 50, width: 200, height: 200}, {skipRestore: true})
- ```
- */
-/**
+ * @example
+ * ```js
+ * fin.me.setBounds({top: 50, left: 50, width: 200, height: 200}, {skipRestore: true})
+ * ```
  * @interface
  */
 declare type PositioningOptions = {
@@ -10575,9 +10667,21 @@ declare type PrinterInfo = OpenFin.PrinterInfo;
  * @interface
  */
 declare type PrinterInfo_2 = {
+    /**
+     * Printer Name
+     */
     name: string;
+    /**
+     * Printer Description
+     */
     description: string;
+    /**
+     * Printer Status
+     */
     status: number;
+    /**
+     * Indicates that system's default printer.
+     */
     isDefault: boolean;
 };
 
@@ -10589,10 +10693,14 @@ declare type PrinterInfo_2 = {
 declare type PrintOptions = {
     content?: 'self';
     /**
+     * @defaultValue false
+     *
      * Disables prompting the user for print settings.
      */
     silent?: boolean;
     /**
+     * @defaultValue false
+     *
      * Includes the webpage background color and image when printing.
      */
     printBackground?: boolean;
@@ -10601,6 +10709,8 @@ declare type PrintOptions = {
      */
     deviceName?: string;
     /**
+     * @defaultValue true
+     *
      * Prints in full color (greyscale otherwise).
      */
     color?: boolean;
@@ -10609,6 +10719,8 @@ declare type PrintOptions = {
      */
     margins?: Margins;
     /**
+     * @defaultValue true
+     *
      * Prints in landscape mode (portrait otherwise).
      */
     landscape?: boolean;
@@ -11387,9 +11499,12 @@ declare type RuntimeDownloadOptions = {
  */
 declare type RuntimeDownloadProgress = {
     /**
-     * @property { string } alias The name of the asset
+     * The downloaded bytes of the download item.
      */
     downloadedBytes: number;
+    /**
+     * The total size in bytes of the file.
+     */
     totalBytes: number;
 };
 
@@ -11539,12 +11654,30 @@ declare type SessionChangedEvent = {
 };
 
 /**
+ * An instance of a SessionContextGroup
  * @interface
  */
 declare type SessionContextGroup = {
+    /**
+     * The SessionContextGroup's id.
+     */
     id: string;
+    /**
+     * A SessionContextGroup instance method for setting a context in the SessionContextGroup.
+     * @param context The Context to be set.
+     */
     setContext: (context: Context) => Promise<void>;
+    /**
+     * A SessionContextGroup instance method for getting the current context of a certain type.
+     * @param type The Context Type to get. If not specified the last contextType set would get used.
+     */
     getCurrentContext: (type?: string) => Promise<Context>;
+    /**
+     * A SessionContextGroup instance method for adding a handler for context change.
+     * @param handler The callback to be invoked. Is invoked when (a) the context changes or (b) immediately after getting created if the context is already set.
+     * @param contextType The context type this handler should listen to. If not specified, a global handler for all context types will get created. Only one global handler is allowed per SessionContextGroup.
+     *
+     */
     addContextHandler: (handler: ContextHandler, contextType?: string) => Promise<{
         unsubscribe: () => void;
     }>;
@@ -11561,7 +11694,7 @@ declare type SetWindowContextPayload = {
     /**
      * Entity type of the target of the context update ('view' or 'window').
      */
-    entityType: EntityType_5;
+    entityType: EntityType_4;
     /**
      * Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
      */
@@ -11572,7 +11705,13 @@ declare type SetWindowContextPayload = {
  * @interface
  */
 declare type SharedWorkerInfo = {
+    /**
+     * The unique id of the shared worker.
+     */
     id: string;
+    /**
+     * The url of the shared worker.
+     */
     url: string;
 };
 
@@ -11610,11 +11749,27 @@ declare type ShownEvent = BaseViewEvent & {
 };
 
 /**
+ * Options for showing a popup menu
+ *
+ * @typeParam Data User-defined shape for data returned upon menu item click.  Should be a
+ * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
+ * of all possible data shapes for the entire menu, and the click handler should process
+ * these with a "reducer" pattern.
+ *
  * @interface
  */
-declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
-    template: MenuItemTemplate<T>[];
+declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
+    /**
+     * An array describing the menu to show.
+     */
+    template: MenuItemTemplate<Data>[];
+    /**
+     * The window x coordinate where to show the menu. Defaults to mouse position. If using must also use y.
+     */
     x?: number;
+    /**
+     * The window y coordinate where to show the menu. Defaults to mouse position. If using must also use x
+     */
     y?: number;
 };
 
@@ -11624,12 +11779,6 @@ declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
  * @interface
  */
 declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
-    /**
-     * @defaultValue false
-     *
-     * Enables showing Views when a Platform Window is being resized.
-     */
-    enabled?: boolean;
     /**
      * @defaultValue 0
      *
@@ -11656,6 +11805,9 @@ declare type Size = TransitionBase & {
  * @interface
  */
 declare type Snapshot = {
+    /**
+     * The array of window options objects
+     */
     windows: WindowCreationOptions[];
     snapshotDetails?: {
         monitorInfo: MonitorInfo;
@@ -13683,8 +13835,17 @@ declare type Time = {
  * @interface
  */
 declare type Transition = {
+    /**
+     * The Opacity transition
+     */
     opacity?: Opacity;
+    /**
+     * The Position transition
+     */
     position?: Position;
+    /**
+     * The Size transition
+     */
     size?: Size;
 };
 
@@ -13725,7 +13886,7 @@ declare type TransitionOptions = {
     tween?: tween;
 };
 
-declare class Transport<MeType extends EntityType_2 = EntityType_2> extends EventEmitter {
+declare class Transport<MeType extends EntityType = EntityType> extends EventEmitter {
     #private;
     protected wireListeners: Map<number, {
         resolve: Function;
@@ -14727,6 +14888,11 @@ declare interface ViewStatuses {
  * @interface
  */
 declare type ViewVisibilityOption = {
+    /**
+     * @defaultValue false
+     *
+     * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
+     */
     enabled?: boolean;
 };
 
@@ -14756,8 +14922,12 @@ declare type WebContent = View_2 | _Window;
 
 declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
     identity: OpenFin.Identity;
-    entityType: string;
-    constructor(wire: Transport, identity: OpenFin.Identity, entityType: string);
+    entityType: 'window' | 'view';
+    /**
+     * @param identity The identity of the {@link OpenFin.WebContentsEvents WebContents}.
+     * @param entityType The type of the {@link OpenFin.WebContentsEvents WebContents}.
+     */
+    constructor(wire: Transport, identity: OpenFin.Identity, entityType: 'window' | 'view');
     /**
      * Gets a base64 encoded image of all or part of the WebContents.
      * @param options Options for the capturePage call.
@@ -14805,6 +14975,11 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * }
      * console.log(await wnd.capturePage(options));
      * ```
+     *
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     capturePage(options?: OpenFin.CapturePageOptions): Promise<string>;
     /**
@@ -14838,6 +15013,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      *
      * executeJavaScript(`console.log('Hello, Openfin')`).then(() => console.log('Javascript excuted')).catch(err => console.log(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     executeJavaScript(code: string): Promise<void>;
     /**
@@ -14873,6 +15052,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      *
      * getZoomLevel().then(zoomLevel => console.log(zoomLevel)).catch(err => console.log(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     getZoomLevel(): Promise<number>;
     /**
@@ -14909,6 +15092,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      *
      * setZoomLevel(4).then(() => console.log('Setting a  zoom level')).catch(err => console.log(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     setZoomLevel(level: number): Promise<void>;
     /**
@@ -14944,6 +15131,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * navigate().then(() => console.log('Navigate to tutorial')).catch(err => console.log(err));
      * ```
      * @experimental
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     navigate(url: string): Promise<void>;
     /**
@@ -14969,6 +15160,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * }
      * navigateBack().then(() => console.log('Navigated back')).catch(err => console.log(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     navigateBack(): Promise<void>;
     /**
@@ -14996,6 +15191,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * }
      * navigateForward().then(() => console.log('Navigated forward')).catch(err => console.log(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     navigateForward(): Promise<void>;
     /**
@@ -15021,6 +15220,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * }
      * stopNavigation().then(() => console.log('you shall not navigate')).catch(err => console.log(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     stopNavigation(): Promise<void>;
     /**
@@ -15056,6 +15259,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * 		console.log('Reloaded window')
      * }).catch(err => console.log(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     reload(ignoreCache?: boolean): Promise<void>;
     /**
@@ -15075,6 +15282,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      *     console.log('print call has been sent to the system');
      * });
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     print(options?: OpenFin.PrintOptions): Promise<void>;
     /**
@@ -15117,6 +15328,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      *     console.log(result)
      * });
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     findInPage(searchTerm: string, options?: OpenFin.FindInPageOptions): Promise<void>;
     /**
@@ -15156,6 +15371,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      *     console.log(results);
      * });
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     stopFindInPage(action: string): Promise<void>;
     /**
@@ -15196,6 +15415,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      *         console.log(err);
      *     });
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     getPrinters(): Promise<OpenFin.PrinterInfo>;
     /**
@@ -15216,6 +15439,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      *
      * focusWindow().then(() => console.log('Window focused')).catch(err => console.log(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     focus({ emitSynthFocused }?: {
         emitSynthFocused: boolean;
@@ -15247,6 +15474,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * .then(() => console.log('Showing dev tools'))
      * .catch(err => console.error(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     showDeveloperTools(): Promise<void>;
     /**
@@ -15266,6 +15497,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      *     const win = await fin.Window.getCurrent();
      *     const processInfo = await win.getProcessInfo();
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     getProcessInfo(): Promise<OpenFin.EntityProcessDetails>;
     /**
@@ -15298,6 +15533,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      *     const win = await fin.Window.create(winOption);
      *     const sharedWorkers = await win.getSharedWorkers();
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     getSharedWorkers(): Promise<OpenFin.SharedWorkerInfo[]>;
     /**
@@ -15330,6 +15569,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      *     const win = await fin.Window.create(winOption);
      *     await win.inspectSharedWorker();
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     inspectSharedWorker(): Promise<void>;
     /**
@@ -15365,6 +15608,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      *     const sharedWorkers = await win.getSharedWorkers();
      *     await win.inspectSharedWorkerById(sharedWorkers[0].id);
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     inspectSharedWorkerById(workerId: string): Promise<void>;
     /**
@@ -15397,6 +15644,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      *     const win = await fin.Window.create(winOption);
      *     await win.inspectServiceWorker();
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     inspectServiceWorker(): Promise<void>;
     /**
@@ -15605,6 +15856,10 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      *     onPopupReady: popupWindowCallback;
      * });
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     showPopupWindow(options: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
 }
@@ -16213,7 +16468,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
  * It has the ability to listen for {@link OpenFin.WindowEvents window specific events}.
  */
 declare class _Window extends WebContents<OpenFin.WindowEvent> {
-    identity: OpenFin.Identity;
     /**
      * @internal
      */
@@ -17170,7 +17424,10 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * Calling this method will close previously opened menus.
      * @experimental
      * @param options
-     *
+     * @typeParam Data User-defined shape for data returned upon menu item click.  Should be a
+     * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
+     * of all possible data shapes for the entire menu, and the click handler should process
+     * these with a "reducer" pattern.
      * @example
      * This could be used to show a drop down menu over views in a platform window:
      * ```js
@@ -17237,7 +17494,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * })
      * ```
      */
-    showPopupMenu<T>(options: OpenFin.ShowPopupMenuOptions<T>): Promise<OpenFin.MenuResult<T>>;
+    showPopupMenu<Data>(options: OpenFin.ShowPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
     /**
      * Closes the window's popup menu, if one exists.
      * @experimental
@@ -17779,6 +18036,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
       * @interface
       */
      declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
+         /**
+          * Data to be written
+          */
          data: {
              text?: string;
              html?: string;