@openfin/node-adapter 34.78.11 → 34.78.13

package/out/node-adapter.d.ts

@@ -7,6 +7,8 @@ import { EventEmitter } from 'events';
 
 /**
  * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
+ *
+ * @interface
  */
 declare type Accelerator = {
     /**
@@ -43,6 +45,9 @@ declare type Accelerator = {
     zoom: boolean;
 };
 
+/**
+ * @interface
+ */
 declare type AddViewToStackOptions = {
     /**
      * Optional index within the stack to insert the view. Defaults to 0
@@ -66,6 +71,8 @@ declare type AnyStrategy = ClassicStrategy | RTCStrategy | CombinedStrategy<Payl
 
 /**
  * Configurations for API injection.
+ *
+ * @interface
  */
 declare type Api = {
     /**
@@ -93,6 +100,9 @@ declare type ApiClient<T extends Record<any, any>> = {
     [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
 };
 
+/**
+ * @interface
+ */
 declare type AppAssetInfo = {
     /**
      * The URL to a zip file containing the package files (executables, dlls, etc…)
@@ -121,6 +131,9 @@ declare type AppAssetInfo = {
     mandatory?: boolean;
 };
 
+/**
+ * @interface
+ */
 declare type AppAssetRequest = {
     alias: string;
 };
@@ -897,10 +910,16 @@ declare type ApplicationEventType = ApplicationEvent['type'];
 
 declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
 
+/**
+ * @interface
+ */
 declare type ApplicationIdentity_2 = {
     uuid: string;
 };
 
+/**
+ * @interface
+ */
 declare type ApplicationInfo = {
     initialOptions: ApplicationCreationOptions;
     launchMode: string;
@@ -1162,17 +1181,30 @@ 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;
+    /**
+     * Platforms Only. Default window options apply to all platform windows.
+     */
     defaultWindowOptions: Partial<WindowOptions>;
+    /**
+     * Platforms Only. Default view options apply to all platform views.
+     */
     defaultViewOptions: Partial<ViewOptions>;
+    /**
+     * Platforms Only. The snapshot to be applied.
+     */
     snapshot: Snapshot;
     /**
      * @defaultValue false
@@ -1182,18 +1214,39 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      * 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;
 };
 
+/**
+ * @interface
+ */
 declare type ApplicationPermissions = {
     setFileDownloadLocation: boolean;
     getFileDownloadLocation: boolean;
@@ -1201,6 +1254,9 @@ declare type ApplicationPermissions = {
 
 declare type ApplicationState = OpenFin.ApplicationState;
 
+/**
+ * @interface
+ */
 declare type ApplicationState_2 = {
     /**
      * True when the application is a Platform controller
@@ -1220,6 +1276,9 @@ declare type ApplicationState_2 = {
     parentUuid?: string;
 };
 
+/**
+ * @interface
+ */
 declare type ApplicationType = {
     type: 'application' | 'external-app';
     uuid: string;
@@ -1232,6 +1291,9 @@ declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedE
 
 declare type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
 
+/**
+ * @interface
+ */
 declare type ApplicationWindowInfo_2 = {
     childWindows: Array<WindowDetail>;
     mainWindow: WindowDetail;
@@ -1241,6 +1303,9 @@ declare type ApplicationWindowInfo_2 = {
     uuid: string;
 };
 
+/**
+ * @interface
+ */
 declare type ApplySnapshotOptions = {
     /**
      * @defaultValue false
@@ -1268,10 +1333,12 @@ declare type ApplySnapshotOptions = {
 
 /**
  * Payload sent to Platform Provider when {@link Platform#applySnapshot Platform.applySnapshot} is called.
+ *
+ * @interface
  */
 declare type ApplySnapshotPayload = {
     /**
-     * TThe snapshot to be applied.
+     * The snapshot to be applied.
      */
     snapshot: Snapshot;
     /**
@@ -1280,6 +1347,9 @@ declare type ApplySnapshotPayload = {
     options?: ApplySnapshotOptions;
 };
 
+/**
+ * @interface
+ */
 declare type AppProcessInfo = {
     /**
      * The uuid of the application.
@@ -1299,6 +1369,9 @@ declare type AppVersionCompleteEvent = {
     type: 'app-version-complete';
 } & AppVersionProgress;
 
+/**
+ * @interface
+ */
 declare type AppVersionError = {
     error: string;
     srcManifest: string;
@@ -1327,6 +1400,9 @@ declare type AppVersionEventType = AppVersionEvent['type'];
  */
 declare type AppVersionEventWithId = EventWithId<AppVersionEvent>;
 
+/**
+ * @interface
+ */
 declare type AppVersionProgress = {
     manifest: string | null;
     srcManifest: string;
@@ -1340,6 +1416,9 @@ declare type AppVersionProgressEvent = {
     type: 'app-version-progress';
 } & AppVersionProgress;
 
+/**
+ * @interface
+ */
 declare type AppVersionRuntimeInfo = {
     version: string | null;
     exists: boolean | null;
@@ -1459,6 +1538,9 @@ declare type AuthRequestedEvent = NamedEvent & {
  */
 declare type AutoplayPolicyOptions = 'no-user-gesture-required' | 'user-gesture-required' | 'document-user-activation-required';
 
+/**
+ * @interface
+ */
 declare type AutoResizeOptions = {
     /**
      * If true, the view's width will grow and shrink together with the window. false
@@ -1492,6 +1574,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;
@@ -1507,6 +1596,9 @@ declare type BaseChannelEvent = NamedEvent & {
     channelId: string;
 };
 
+/**
+ * @interface
+ */
 declare type BaseClipboardRequest = {
     /**
      * The type of clipboard to write to, can be 'clipboard' or 'selection'.
@@ -1597,8 +1689,9 @@ declare type BaseViewEvent = NamedEvent & {
 
 /**
  * User decision of whether a Window or specific View should close when trying to prevent an unload.
+ * @interface
  */
-declare interface BeforeUnloadUserDecision {
+declare type BeforeUnloadUserDecision = {
     /**
      * Specifies if the Window should close.
      */
@@ -1607,7 +1700,7 @@ declare interface BeforeUnloadUserDecision {
      * Array of views that will close.
      */
     viewsToClose: Identity_5[];
-}
+};
 
 /**
  * Generated at the beginning of a user-driven change to a window's size or position.
@@ -1625,6 +1718,9 @@ declare type BlurredEvent = NamedEvent & {
     type: 'blurred';
 };
 
+/**
+ * @interface
+ */
 declare type Bounds = {
     top: number;
     left: number;
@@ -1663,8 +1759,10 @@ declare type BoundsChangingEvent = BoundsChangeEvent & {
 
 /**
  * Configuration for page capture.
+ *
+ * @interface
  */
-declare interface CapturePageOptions {
+declare type CapturePageOptions = {
     /**
      * The area of the window to be captured.
      */
@@ -1681,8 +1779,11 @@ declare interface CapturePageOptions {
      * Quality of JPEG image. Between 0 - 100.
      */
     quality?: number;
-}
+};
 
+/**
+ * @interface
+ */
 declare type Certificate = {
     data: string;
     fingerprint: string;
@@ -1707,6 +1808,9 @@ declare type CertificateErrorEvent = NamedEvent & {
     certificate: OpenFin.Certificate;
 };
 
+/**
+ * @interface
+ */
 declare type CertificatePrincipal = {
     commonName: string;
     country: string;
@@ -1726,6 +1830,9 @@ declare type CertificateSelectionShownEvent = NamedEvent & {
     certificates: OpenFin.Certificate[];
 };
 
+/**
+ * @interface
+ */
 declare type CertificationInfo = {
     serial?: string;
     subject?: string;
@@ -1734,6 +1841,9 @@ declare type CertificationInfo = {
     trusted?: boolean;
 };
 
+/**
+ * @interface
+ */
 declare type CertifiedAppInfo = {
     isRunning: boolean;
     isOptedIntoCertfiedApp?: boolean;
@@ -2338,6 +2448,8 @@ declare type ChannelConnectOptions = ChannelCreateOptions & {
 
 /**
  * Channel provider creation options.
+ *
+ * @interface
  */
 declare type ChannelCreateOptions = {
     /**
@@ -2647,6 +2759,9 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
     isValidEndpointPayload(payload: any): payload is EndpointPayload;
 }
 
+/**
+ * @interface
+ */
 declare type ClearCacheOption = {
     /**
      * html5 application cache
@@ -2666,9 +2781,17 @@ declare type ClearCacheOption = {
     localStorage?: boolean;
 };
 
-declare type ClickedMenuResult<T extends unknown = unknown> = {
+/**
+ * @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<Data extends unknown = unknown> = {
     result: 'clicked';
-    data: T;
+    data: Data;
 };
 
 /**
@@ -2677,7 +2800,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 & {
@@ -2895,10 +3018,16 @@ declare type ClosedEvent = IdentityEvent & {
     type: 'closed';
 };
 
+/**
+ * @interface
+ */
 declare type ClosedMenuResult = {
     result: 'closed';
 };
 
+/**
+ * @interface
+ */
 declare type CloseViewPayload = {
     /**
      *View to be closed.
@@ -2907,6 +3036,8 @@ declare type CloseViewPayload = {
 };
 
 /**
+ * @interface
+ *
  * Represents the shape of payload that contains the Window Identity and related options.
  */
 declare interface CloseWindowPayload {
@@ -3043,6 +3174,8 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
 
 /**
  * View options that cannot be updated after creation.
+ *
+ * @interface
  */
 declare type ConstViewOptions = {
     /**
@@ -3095,6 +3228,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.
@@ -3110,6 +3248,8 @@ declare type ConstViewOptions = {
 
 /**
  * Window options that cannot be changed after creation.
+ *
+ * @interface
  */
 declare type ConstWindowOptions = {
     /**
@@ -3311,6 +3451,8 @@ declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'brows
 
 /**
  * Configures how new content (e,g, from `window.open` or a link) is opened.
+ *
+ * @interface
  */
 declare type ContentCreationOptions = {
     /**
@@ -3323,13 +3465,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;
     /**
@@ -3378,6 +3519,8 @@ declare type ContentCreationRulesEvent = NamedEvent & {
  * Restrict navigation to URLs that match an allowed pattern.
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
  * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
+ *
+ * @interface
  */
 declare type ContentNavigation = NavigationRules;
 
@@ -3385,11 +3528,15 @@ declare type ContentNavigation = NavigationRules;
  * Restrict redirects to URLs that match an allowed pattern.
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
  * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
+ *
+ * @interface
  */
 declare type ContentRedirect = NavigationRules;
 
 /**
  * Data passed between entities and applications.
+ *
+ * @interface
  */
 declare type Context = {
     /**
@@ -3415,6 +3562,12 @@ declare type ContextForIntent<MetadataType = any> = Context & {
     metadata?: MetadataType;
 };
 
+/**
+ * Information for a Context Group. Contains metadata for displaying the group properly.
+ */
+/**
+ * @interface
+ */
 declare type ContextGroupInfo = {
     /**
      * Unique identifier of the context group.
@@ -3432,10 +3585,15 @@ declare type ContextGroupStates = {
     };
 };
 
+/**
+ * Subscription function for addContextHandler.
+ */
 declare type ContextHandler = (context: Context) => void;
 
 /**
  * Configure the context menu when right-clicking on a window.
+ *
+ * @interface
  */
 declare type ContextMenuOptions = {
     /**
@@ -3451,6 +3609,8 @@ declare type ContextMenuOptions = {
 /**
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
  * Configure the context menu when right-clicking on a window.
+ *
+ * @interface
  */
 declare type ContextMenuSettings = {
     /**
@@ -3467,12 +3627,18 @@ declare type ContextMenuSettings = {
     reload?: boolean;
 };
 
+/**
+ * @interface
+ */
 declare type CookieInfo = {
     name: string;
     domain: string;
     path: string;
 };
 
+/**
+ * @interface
+ */
 declare type CookieOption = {
     name: string;
 };
@@ -3480,6 +3646,8 @@ declare type CookieOption = {
 /**
  * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
  *  average of _height_ and _width_.
+ *
+ *  @interface
  */
 declare type CornerRounding = {
     /**
@@ -3496,6 +3664,9 @@ declare type CornerRounding = {
     width: number;
 };
 
+/**
+ * @interface
+ */
 declare type CpuInfo = {
     /**
      * The model of the cpu
@@ -3525,6 +3696,9 @@ declare type CrashedEvent = NamedEvent & {
     };
 };
 
+/**
+ * @interface
+ */
 declare type CrashReporterOptions = {
     /**
      * In diagnostics mode the crash reporter will send diagnostic logs to
@@ -3552,6 +3726,9 @@ declare type CreatedEvent = BaseViewEvent & {
     type: 'created';
 };
 
+/**
+ * @interface
+ */
 declare type CreateViewPayload = {
     /**
      * Options for the view to be added.
@@ -3580,6 +3757,8 @@ declare type CreateViewTarget = Identity_5 & {
 
 /**
  * Custom headers for requests sent by the window.
+ *
+ * @interface
  */
 declare type CustomRequestHeaders = {
     /**
@@ -3593,10 +3772,16 @@ declare type CustomRequestHeaders = {
     headers: WebRequestHeader[];
 };
 
+/**
+ * @interface
+ */
 declare type DefaultDomainSettings = {
     rules: DefaultDomainSettingsRule[];
 };
 
+/**
+ * @interface
+ */
 declare type DefaultDomainSettingsRule = {
     match: string[];
     options: {
@@ -3652,6 +3837,9 @@ declare type DipRect = RectangleByEdgePositions & {
     scaledRect: RectangleByEdgePositions;
 };
 
+/**
+ * @interface
+ */
 declare type DipScaleRects = {
     dipRect: RectangleByEdgePositions;
     scaledRect: RectangleByEdgePositions;
@@ -3675,6 +3863,8 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
 
 /**
  * The display data for a context group.
+ *
+ * @interface
  */
 declare type DisplayMetadata = {
     /**
@@ -3693,6 +3883,8 @@ declare type DisplayMetadata = {
 
 /**
  * Metadata returned from a preload script download request.
+ *
+ * @interface
  */
 declare type DownloadPreloadInfo = {
     /**
@@ -3711,6 +3903,8 @@ declare type DownloadPreloadInfo = {
 
 /**
  * Options for downloading a preload script.
+ *
+ * @interface
  */
 declare type DownloadPreloadOption = {
     /**
@@ -3719,6 +3913,9 @@ declare type DownloadPreloadOption = {
     url: string;
 };
 
+/**
+ * @interface
+ */
 declare type DownloadRule = {
     behavior: FileDownloadBehaviorNames;
     match: string[];
@@ -3726,6 +3923,8 @@ declare type DownloadRule = {
 
 /**
  * DPI (dots per inch) configuration for printing.
+ *
+ * @interface
  */
 declare type Dpi = {
     /**
@@ -3788,53 +3987,35 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
     protected deregisterEventListener: (eventType: EmitterEventType, options?: OpenFin.SubscriptionOptions) => Promise<void | EventEmitter>;
     /**
      * Adds a listener to the end of the listeners array for the specified event.
-     *
-     * @param eventType
-     * @param listener
-     * @param options
      */
     on<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
-    addListener: <EventType extends EmitterEventType>(eventType: EventType, listener: OpenFin.BaseEvents.EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions) => Promise<this>;
+    /**
+     * Adds a listener to the end of the listeners array for the specified event.
+     */
+    addListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
     /**
      * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
-     *
-     * @param eventType
-     * @param listener
-     * @param options
      */
     once<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
     /**
      * Adds a listener to the beginning of the listeners array for the specified event.
-     *
-     * @param eventType
-     * @param listener
-     * @param options
      */
     prependListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
     /**
      * Adds a one time listener for the event. The listener is invoked only the first time the event is fired,
      * after which it is removed. The listener is added to the beginning of the listeners array.
-     *
-     * @param eventType
-     * @param listener
-     * @param options
      */
     prependOnceListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
     /**
      * Remove a listener from the listener array for the specified event.
      *
      * @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
-     *
-     * @param eventType
-     * @param listener
-     * @param options
      */
     removeListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
     protected deregisterAllListeners(eventType: EmitterEventType): Promise<EventEmitter | void>;
     /**
      * Removes all listeners, or those of the specified event.
      *
-     * @param eventType
      */
     removeAllListeners(eventType?: EmitterEventType): Promise<this>;
     private deleteEmitterIfNothingRegistered;
@@ -3877,6 +4058,9 @@ declare type Entity = OpenFin.ApplicationType;
 
 declare type EntityInfo = OpenFin.EntityInfo;
 
+/**
+ * @interface
+ */
 declare type EntityInfo_2 = {
     uuid: string;
     name: string;
@@ -4004,6 +4188,9 @@ declare type ExistingConnectConfig = ConfigWithUuid & {
     address: string;
 };
 
+/**
+ * @interface
+ */
 declare type ExitCode = {
     topic: string;
     uuid: string;
@@ -4153,6 +4340,9 @@ declare namespace ExternalApplicationEvents {
     }
 }
 
+/**
+ * @interface
+ */
 declare type ExternalApplicationInfo = {
     parent: Identity_5;
 };
@@ -4195,6 +4385,9 @@ declare type ExternalConfig = BaseConfig & {
     manifestUrl: string;
 };
 
+/**
+ * @interface
+ */
 declare type ExternalConnection = {
     /**
      * The token to broker an external connection.
@@ -4216,11 +4409,17 @@ declare type ExternalProcessExitedEvent = NamedEvent & {
     exitCode: number;
 };
 
+/**
+ * @interface
+ */
 declare type ExternalProcessInfo = {
     pid: number;
     listener?: LaunchExternalProcessListener;
 };
 
+/**
+ * @interface
+ */
 declare type ExternalProcessRequestType = {
     /**
      * The file path to where the running application resides.
@@ -4263,6 +4462,9 @@ declare type FaviconUpdatedEvent = NamedEvent & {
     favicons: string[];
 };
 
+/**
+ * @interface
+ */
 declare type FetchManifestPayload = {
     /**
      * The URL of the manifest to fetch.
@@ -4351,6 +4553,9 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
     state: 'progressing' | 'interrupted';
 };
 
+/**
+ * @interface
+ */
 declare type FileDownloadSettings = {
     rules: DownloadRule[];
 };
@@ -4411,6 +4616,8 @@ declare interface FinApi<MeType extends EntityType> {
 
 /**
  * Configuration for find-in-page requests.
+ *
+ * @interface
  */
 declare type FindInPageOptions = {
     /**
@@ -4446,6 +4653,9 @@ declare type FindInPageOptions = {
     medialCapitalAsWordStart?: boolean;
 };
 
+/**
+ * @interface
+ */
 declare type FindInPageResult = {
     requestId: number;
     /**
@@ -4463,6 +4673,9 @@ declare type FindInPageResult = {
     finalUpdate: boolean;
 };
 
+/**
+ * @interface
+ */
 declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
     context: Context;
     metadata?: MetadataType;
@@ -4660,6 +4873,9 @@ declare namespace FrameEvents {
  */
 declare type FrameEventType = FrameEvent['type'];
 
+/**
+ * @interface
+ */
 declare type FrameInfo = {
     name: string;
     uuid: string;
@@ -4736,6 +4952,9 @@ declare type FrameProcessDetails = ProcessDetails & {
 
 declare type GetLogRequestType = OpenFin.GetLogRequestType;
 
+/**
+ * @interface
+ */
 declare type GetLogRequestType_2 = {
     /**
      * The name of the running application
@@ -4753,6 +4972,9 @@ declare type GetLogRequestType_2 = {
 
 declare type GetterCall<T> = ApiCall<void, T>;
 
+/**
+ * @interface
+ */
 declare type GetWindowContextPayload = {
     /**
      * Entity type of the target of the context update ('view' or 'window').
@@ -4888,6 +5110,9 @@ declare namespace GlobalHotkeyEvents {
     }
 }
 
+/**
+ * @interface
+ */
 declare type GpuInfo = {
     name: string;
 };
@@ -4900,6 +5125,9 @@ declare type HiddenEvent = BaseViewEvent & {
     type: 'hidden';
 };
 
+/**
+ * @interface
+ */
 declare type HostContextChangedPayload = {
     /**
      * The new context object
@@ -4913,6 +5141,9 @@ declare type HostContextChangedPayload = {
 
 declare type HostContextChangedReasons = 'updated' | 'reparented';
 
+/**
+ * @interface
+ */
 declare type HostSpecs = {
     /**
      * True if Aero Glass theme is supported on Windows platforms
@@ -4946,6 +5177,8 @@ declare type HostSpecs = {
 
 /**
  * A hotkey binding.
+ *
+ * @interface
  */
 declare type Hotkey = {
     /**
@@ -4982,6 +5215,8 @@ declare type Identity_4 = OpenFin.Identity;
  *
  * @remarks The `uuid` property refers the application that owns the entity, not to the entity itself.
  * The `name` property identifies the entity itself, and must be unique within the application.
+ *
+ * @interface
  */
 declare type Identity_5 = {
     /**
@@ -5032,6 +5267,9 @@ declare type ImageFormatOptions = {
     quality?: number;
 };
 
+/**
+ * @interface
+ */
 declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
     /**
      * Name of the intent to get info for.
@@ -5053,6 +5291,9 @@ declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
 
 declare type InitLayoutOptions_2 = OpenFin.InitLayoutOptions;
 
+/**
+ * @interface
+ */
 declare type InitLayoutOptions_3 = {
     /**
      * The id attribute of the container where the window's Layout should be initialized.  If not provided
@@ -5061,6 +5302,9 @@ declare type InitLayoutOptions_3 = {
     containerId?: string;
 };
 
+/**
+ * @interface
+ */
 declare type InitPlatformOptions = {
     /**
      * A callback function or an array of constructor callbacks that can be used to extend or replace default Provider behavior.
@@ -5088,12 +5332,18 @@ declare type InputEvent_2 = {
     command?: string;
 };
 
+/**
+ * @interface
+ */
 declare type InstallationInfo = {
     cachedManifest: any;
 };
 
 declare type InstalledApps = OpenFin.InstalledApps;
 
+/**
+ * @interface
+ */
 declare type InstalledApps_2 = {
     [key: string]: InstallationInfo;
 };
@@ -5113,8 +5363,17 @@ 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> = {
     target?: TargetType;
     resultType?: string;
@@ -5242,10 +5501,11 @@ declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
 
 /**
  * Define whether to enable interop action logging.
+ *
  */
-declare interface InteropActionLoggingOption {
+declare type InteropActionLoggingOption = {
     enabled: boolean;
-}
+};
 
 /**
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
@@ -5914,12 +6174,18 @@ declare class InteropBroker extends Base {
     isActionAuthorized(_action: string, _payload: any, _identity: OpenFin.ClientIdentity): Promise<boolean> | boolean;
 }
 
+/**
+ * @interface
+ */
 declare type InteropBrokerDisconnectionEvent = {
     type: string;
     topic: string;
     brokerName: string;
 };
 
+/**
+ * @interface
+ */
 declare type InteropBrokerOptions = {
     contextGroups?: ContextGroupInfo;
     logging?: InteropLoggingOptions;
@@ -6425,8 +6691,17 @@ declare class InteropClient extends Base {
     static ferryFdc3Call(interopClient: OpenFin.InteropClient, action: string, payload?: any): Promise<any>;
 }
 
+/**
+ * @interface
+ */
 declare type InteropClientOnDisconnectionListener = (InteropBrokerDisconnectionEvent: InteropBrokerDisconnectionEvent) => any;
 
+/**
+ * Information relevant to the Interop Broker.
+ */
+/**
+ * @interface
+ */
 declare type InteropConfig = {
     /**
      * Context Group for the client. (green, yellow, red, etc.).
@@ -6440,6 +6715,9 @@ declare type InteropConfig = {
 
 declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
 
+/**
+ * @interface
+ */
 declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
 
 /**
@@ -6494,6 +6772,9 @@ declare class InteropModule extends Base {
     connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
 }
 
+/**
+ * @interface
+ */
 declare type JumpListCategory = {
     /**
      * The display title for the category.
@@ -6510,10 +6791,16 @@ declare type JumpListCategory = {
 
 declare type JumpListItem = JumpListTask | JumpListSeparator;
 
+/**
+ * @interface
+ */
 declare type JumpListSeparator = {
     type: 'separator';
 };
 
+/**
+ * @interface
+ */
 declare type JumpListTask = {
     type: 'task';
     /**
@@ -6607,15 +6894,19 @@ export declare function launch(config: ConnectConfig): Promise<number>;
  */
 declare type LaunchEmitter = TypedEventEmitter<AppVersionEvent>;
 
-declare type LaunchExternalProcessListener = {
-    (code: ExitCode): void;
-};
+declare type LaunchExternalProcessListener = (code: ExitCode) => void;
 
+/**
+ * @interface
+ */
 declare type LaunchExternalProcessRule = {
     behavior: 'allow' | 'block';
     match: string[];
 };
 
+/**
+ * @interface
+ */
 declare type LaunchIntoPlatformPayload = {
     manifest: any;
 };
@@ -6904,14 +7195,26 @@ declare class Layout extends Base {
     applyPreset: (options: PresetLayoutOptions) => Promise<void>;
 }
 
-declare interface LayoutColumn extends LayoutItemConfig {
+/**
+ * @interface
+ */
+declare type LayoutColumn = LayoutItemConfig & {
     type: 'column';
-}
+};
 
-declare interface LayoutComponent extends 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>;
-}
+};
 
 declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
 
@@ -7043,6 +7346,9 @@ declare class LayoutEntitiesController {
     setStackActiveView: (stackEntityId: string, viewIdentity: OpenFin.Identity) => Promise<void>;
 }
 
+/**
+ * @interface
+ */
 declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes = LayoutEntityTypes> = {
     type: TLayoutEntityType;
     entityId: string;
@@ -7062,9 +7368,11 @@ 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 }.
+ *
+ * @interface
  */
 declare type LayoutItemConfig = {
     /**
@@ -7446,6 +7754,9 @@ declare abstract class LayoutNode {
     getAdjacentStacks: (edge: OpenFin.LayoutPosition) => Promise<TabStack[]>;
 }
 
+/**
+ * @interface
+ */
 declare type LayoutOptions = {
     /**
      * Represents a potential ways to customize behavior of your Layout
@@ -7487,6 +7798,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
@@ -7515,6 +7831,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;
@@ -7526,6 +7847,9 @@ declare type LayoutOptions = {
 
 declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 
+/**
+ * @interface
+ */
 declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 
 /**
@@ -7539,10 +7863,16 @@ declare type LayoutReadyEvent = NamedEvent & {
     })[];
 };
 
-declare interface LayoutRow extends LayoutItemConfig {
+/**
+ * @interface
+ */
+declare type LayoutRow = LayoutItemConfig & {
     type: 'row';
-}
+};
 
+/**
+ * @interface
+ */
 declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | 'frame' | 'hideOnClose' | 'icon' | 'maxHeight' | 'maximizable' | 'maxWidth' | 'minHeight' | 'minimizable' | 'minWidth' | 'opacity' | 'preloadScripts' | 'resizable' | 'resizeRegion' | 'saveWindowState' | 'ignoreSavedWindowState' | 'shadow' | 'showTaskbarIcon' | 'smallWindow' | 'state' | 'taskbarIconGroup' | 'waitForPageLoad' | '_internalWorkspaceData'>;
 
 declare type Listener<T extends {
@@ -7551,6 +7881,9 @@ declare type Listener<T extends {
 
 declare type LogInfo = OpenFin.LogInfo;
 
+/**
+ * @interface
+ */
 declare type LogInfo_2 = {
     /**
      * The filename of the log
@@ -7579,6 +7912,9 @@ declare type LogLevel = OpenFin.LogLevel;
  */
 declare type LogLevel_2 = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
 
+/**
+ * @interface
+ */
 declare type Manifest = {
     appAssets?: {
         alias: string;
@@ -7644,6 +7980,9 @@ declare type ManifestChangedEvent = IdentityEvent & {
     type: 'manifest-changed';
 };
 
+/**
+ * @interface
+ */
 declare type ManifestInfo = {
     /**
      * The uuid of the application.
@@ -7657,8 +7996,13 @@ declare type ManifestInfo = {
 
 /**
  * Margins configuration for printing.
+ *
+ * @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.
@@ -7688,17 +8032,36 @@ declare type MaximizedEvent = NamedEvent & {
     type: 'maximized';
 };
 
+/**
+ * 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_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;
 };
 
-declare type MenuItemTemplate<T extends unknown = unknown> = {
+/**
+ * @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<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.
@@ -7716,18 +8079,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;
@@ -7761,6 +8132,9 @@ declare type MinimizedEvent = NamedEvent & {
     type: 'minimized';
 };
 
+/**
+ * @interface
+ */
 declare type MonitorDetails = {
     /**
      * The available DIP scale coordinates.
@@ -7807,6 +8181,9 @@ declare type MonitorEvent = OpenFin.MonitorInfo & {
     type: 'monitor-info-changed';
 };
 
+/**
+ * @interface
+ */
 declare type MonitorInfo = {
     /**
      * The device scale factor.
@@ -7826,6 +8203,9 @@ declare type MonitorInfo = {
     virtualScreen: DipRect;
 };
 
+/**
+ * @interface
+ */
 declare type MutableViewOptions = {
     autoResize: AutoResizeOptions;
     /**
@@ -7911,6 +8291,8 @@ declare type MutableViewOptions = {
 
 /**
  * Window options that can be changed after window creation.
+ *
+ * @interface
  */
 declare type MutableWindowOptions = {
     /**
@@ -8163,6 +8545,9 @@ declare type NamedEvent = IdentityEvent & {
     name: string;
 };
 
+/**
+ * @interface
+ */
 declare type NativeWindowIntegrationProviderAuthorization = {
     authorizedUuid: string;
 };
@@ -8177,6 +8562,9 @@ declare type NavigationRejectedEvent = NamedEvent & {
     url: string;
 };
 
+/**
+ * @interface
+ */
 declare type NavigationRules = {
     /** @deprecated Use allowlist property instead. */
     whitelist?: string[];
@@ -8590,6 +8978,9 @@ declare type PerformanceReportEvent = Performance & NamedEvent & {
     type: 'performance-report';
 };
 
+/**
+ * @interface
+ */
 declare type Permissions_2 = {
     Application?: Partial<ApplicationPermissions>;
     System?: Partial<SystemPermissions>;
@@ -9452,9 +9843,17 @@ declare type PlatformOptions = ApplicationCreationOptions & {
     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>;
 };
 
@@ -9990,6 +10389,9 @@ declare type PlatformSnapshotAppliedEvent = BaseEvent & {
     type: 'platform-snapshot-applied';
 };
 
+/**
+ * @interface
+ */
 declare type PlatformViewCreationOptions = Partial<ViewOptions>;
 
 /**
@@ -10016,6 +10418,9 @@ declare type PlatformWindowOptions = WindowCreationOptions & {
     stylesheetUrl: string;
 };
 
+/**
+ * @interface
+ */
 declare type Point = {
     /**
      * The mouse x position
@@ -10027,6 +10432,9 @@ declare type Point = {
     y: number;
 };
 
+/**
+ * @interface
+ */
 declare type PointTopLeft = {
     /**
      * The mouse top position in virtual screen coordinates
@@ -10046,8 +10454,10 @@ declare type PopupInteraction = 'clicked' | 'dismissed';
 
 /**
  * Popup window options.
+ *
+ * @interface
  */
-declare interface PopupOptions {
+declare type PopupOptions = {
     /**
      * Window creation options when using `showPopupWindow` to create a new window.
      */
@@ -10121,14 +10531,15 @@ declare interface PopupOptions {
      * <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
+ * @interface
  */
-declare interface PopupResult<T = any> {
+declare type PopupResult<T = any> = {
     /**
      * `name` and `uuid` of the popup window that called dispatched this result.
      */
@@ -10148,7 +10559,7 @@ declare interface PopupResult<T = any> {
      * The last dispatch result.
      */
     lastDispatchResult?: PopupResult;
-}
+};
 
 declare type PopupResultBehavior = 'none' | PopupBaseBehavior;
 
@@ -10177,14 +10588,17 @@ declare type Position = TransitionBase & {
  fin.me.setBounds({top: 50, left: 50, width: 200, height: 200}, {skipRestore: true})
  ```
  */
-declare interface PositioningOptions {
+/**
+ * @interface
+ */
+declare type PositioningOptions = {
     /**
      * Windows Only.
      * If set to true, will not restore a maximized window before setting the bounds.
      * This will have the effect of the maximized window staying maximized and not immediately taking this new position.
      */
     skipRestore?: boolean;
-}
+};
 
 /**
  * Context menu item with an implementation provided by OpenFin.
@@ -10193,6 +10607,8 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
 
 /**
  * A script that is run before page load.
+ *
+ * @interface
  */
 declare type PreloadScript = {
     /**
@@ -10253,6 +10669,9 @@ declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent &
 
 declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
 
+/**
+ * @interface
+ */
 declare type PresetLayoutOptions_2 = {
     /**
      * Which preset layout arrangement to use.
@@ -10263,23 +10682,44 @@ declare type PresetLayoutOptions_2 = {
 
 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;
 };
 
 /**
  * Options for printing a webpage in OpenFin.
+ *
+ * @interface
  */
 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;
@@ -10288,6 +10728,8 @@ declare type PrintOptions = {
      */
     deviceName?: string;
     /**
+     * @defaultValue true
+     *
      * Prints in full color (greyscale otherwise).
      */
     color?: boolean;
@@ -10296,6 +10738,8 @@ declare type PrintOptions = {
      */
     margins?: Margins;
     /**
+     * @defaultValue true
+     *
      * Prints in landscape mode (portrait otherwise).
      */
     landscape?: boolean;
@@ -10337,6 +10781,9 @@ declare type PrintOptions = {
  */
 declare type ProcessAffinityStrategy = 'same' | 'different';
 
+/**
+ * @interface
+ */
 declare type ProcessDetails = {
     /**
      * The percentage of total CPU usage.
@@ -10384,8 +10831,10 @@ declare type ProcessDetails = {
 
 /**
  * Process logging options
+ *
+ * @interface
  */
-declare interface ProcessLoggingOptions {
+declare type ProcessLoggingOptions = {
     /**
      * Periodic Logging Interval (in seconds)
      */
@@ -10403,7 +10852,7 @@ declare interface ProcessLoggingOptions {
          */
         entries?: number;
     };
-}
+};
 
 /**
  * A propagated Application event.
@@ -10710,6 +11159,9 @@ declare type ProviderIdentity_7 = Identity_5 & {
 
 declare type ProxyConfig = OpenFin.ProxyConfig;
 
+/**
+ * @interface
+ */
 declare type ProxyConfig_2 = {
     /**
      * The configured proxy address.
@@ -10724,11 +11176,17 @@ declare type ProxyConfig_2 = {
 
 declare type ProxyInfo = OpenFin.ProxyInfo;
 
+/**
+ * @interface
+ */
 declare type ProxyInfo_2 = {
     config: ProxyConfig_2;
     system: ProxySystemInfo;
 };
 
+/**
+ * @interface
+ */
 declare type ProxySystemInfo = {
     /**
      * The auto configuration url.
@@ -10748,6 +11206,9 @@ declare type ProxySystemInfo = {
     proxy: string;
 };
 
+/**
+ * @interface
+ */
 declare type QueryPermissionResult = {
     /**
      * The full name of a secured API.
@@ -10773,6 +11234,8 @@ declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptio
  * A rectangular area on the screen.
  *
  * @remarks Origin is top-left.  All numbers are in pixels.
+ *
+ * @interface
  */
 declare type Rectangle = {
     /**
@@ -10793,6 +11256,9 @@ declare type Rectangle = {
     height: number;
 };
 
+/**
+ * @interface
+ */
 declare type RectangleByEdgePositions = {
     top: number;
     left: number;
@@ -10808,6 +11274,9 @@ declare type RegisteredEvent = BaseEvent & {
     type: 'registered';
 };
 
+/**
+ * @interface
+ */
 declare type RegisterUsageData = {
     data: unknown;
     type: string;
@@ -10815,6 +11284,9 @@ declare type RegisterUsageData = {
 
 declare type RegistryInfo = OpenFin.RegistryInfo;
 
+/**
+ * @interface
+ */
 declare type RegistryInfo_2 = {
     data: any;
     rootKey: string;
@@ -10836,6 +11308,9 @@ declare interface RemoteConfig extends ExistingConnectConfig {
     token: string;
 }
 
+/**
+ * @interface
+ */
 declare type ReplaceLayoutOpts = {
     /**
      * Layout config to be applied.
@@ -10843,6 +11318,9 @@ declare type ReplaceLayoutOpts = {
     layout: LayoutOptions;
 };
 
+/**
+ * @interface
+ */
 declare type ReplaceLayoutPayload = {
     /**
      * Object containing the layout to be applied.
@@ -10854,6 +11332,9 @@ declare type ReplaceLayoutPayload = {
     target: Identity_5;
 };
 
+/**
+ * @interface
+ */
 declare type ReplaceViewPayload = {
     opts: {
         viewToReplace: Identity_5;
@@ -10864,6 +11345,8 @@ declare type ReplaceViewPayload = {
 
 /**
  * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
+ *
+ * @interface
  */
 declare type ResizeRegion = {
     /**
@@ -10943,6 +11426,9 @@ declare type RespondingEvent = IdentityEvent & {
 
 declare type ResultBehavior = 'close' | 'hide' | 'none';
 
+/**
+ * @interface
+ */
 declare type RGB = {
     red: number;
     blue: number;
@@ -11017,6 +11503,8 @@ declare type RuntimeConfig = {
 
 /**
  * The options object required by the downloadRuntime function.
+ *
+ * @interface
  */
 declare type RuntimeDownloadOptions = {
     /**
@@ -11025,6 +11513,9 @@ declare type RuntimeDownloadOptions = {
     version: string;
 };
 
+/**
+ * @interface
+ */
 declare type RuntimeDownloadProgress = {
     /**
      * @property { string } alias The name of the asset
@@ -11038,6 +11529,9 @@ declare type RuntimeErrorPayload = {
     error?: ErrorPlainObject;
 };
 
+/**
+ * @interface
+ */
 declare type RuntimeInfo = {
     /**
      * The runtime build architecture.
@@ -11068,6 +11562,9 @@ declare type RuntimeInfo = {
     devtoolsPort?: number;
 };
 
+/**
+ * @interface
+ */
 declare type RVMInfo = {
     /**
      * The name of action: "get-rvm-info".
@@ -11095,6 +11592,9 @@ declare type RVMInfo = {
     'working-dir': string;
 };
 
+/**
+ * @interface
+ */
 declare type RvmLaunchOptions = {
     /**
      * True if no UI when launching
@@ -11111,6 +11611,9 @@ declare type RvmLaunchOptions = {
     subscribe?: (launch: LaunchEmitter) => void;
 };
 
+/**
+ * @interface
+ */
 declare type ScreenshotPrintOptions = {
     content: 'screenshot';
 };
@@ -11119,6 +11622,9 @@ declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
     data: ProtocolMap[T]['response'];
 } & ProtocolMap[T]['specialResponse']>;
 
+/**
+ * @interface
+ */
 declare type SendApplicationLogResponse = {
     logId: string;
 };
@@ -11133,6 +11639,9 @@ declare type ServiceConfig = {
     manifestUrl: string;
 };
 
+/**
+ * @interface
+ */
 declare type ServiceConfiguration = {
     config: object;
     /**
@@ -11141,6 +11650,9 @@ declare type ServiceConfiguration = {
     name: string;
 };
 
+/**
+ * @interface
+ */
 declare type ServiceIdentifier = {
     /**
      * The name of the service.
@@ -11157,15 +11669,41 @@ declare type SessionChangedEvent = {
     reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
 };
 
+/**
+ * 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;
     }>;
 };
 
+/**
+ * @interface
+ */
 declare type SetWindowContextPayload = {
     /**
      * The requested context update.
@@ -11181,11 +11719,23 @@ declare type SetWindowContextPayload = {
     target: Identity_5;
 };
 
+/**
+ * @interface
+ */
 declare type SharedWorkerInfo = {
+    /**
+     * The unique id of the shared worker.
+     */
     id: string;
+    /**
+     * The url of the shared worker.
+     */
     url: string;
 };
 
+/**
+ * @interface
+ */
 declare type ShortCutConfig = {
     /**
      * True if application has a shortcut on the desktop.
@@ -11216,14 +11766,34 @@ declare type ShownEvent = BaseViewEvent & {
     type: 'shown';
 };
 
-declare type ShowPopupMenuOptions<T extends unknown = unknown> = {
-    template: MenuItemTemplate<T>[];
+/**
+ * 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<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;
 };
 
 /**
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
+ *
  * @interface
  */
 declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
@@ -11255,7 +11825,13 @@ declare type Size = TransitionBase & {
     height: number;
 };
 
+/**
+ * @interface
+ */
 declare type Snapshot = {
+    /**
+     * The array of window options objects
+     */
     windows: WindowCreationOptions[];
     snapshotDetails?: {
         monitorInfo: MonitorInfo;
@@ -11267,6 +11843,9 @@ declare type Snapshot = {
     };
 };
 
+/**
+ * @interface
+ */
 declare type SnapshotProvider<Snapshot = unknown> = {
     getSnapshot: () => Promise<Snapshot>;
     applySnapshot: (snapshot: Snapshot) => Promise<void>;
@@ -11416,6 +11995,9 @@ declare type StartedEvent = IdentityEvent & {
     type: 'started';
 };
 
+/**
+ * @interface
+ */
 declare type SubscriptionOptions = {
     /**
      * The event timestamp.
@@ -12911,6 +13493,9 @@ declare namespace SystemEvents {
  */
 declare type SystemEventType = SystemEvent['type'];
 
+/**
+ * @interface
+ */
 declare type SystemPermissions = {
     getAllExternalWindows: boolean;
     launchExternalProcess: boolean | {
@@ -12938,6 +13523,9 @@ declare type SystemPermissions = {
     };
 };
 
+/**
+ * @interface
+ */
 declare type SystemProcessInfo = {
     apps: AppProcessInfo[];
     browserProcess: NonAppProcessDetails;
@@ -13223,6 +13811,9 @@ declare type TaskBar = DipScaleRects & {
     rect: RectangleByEdgePositions;
 };
 
+/**
+ * @interface
+ */
 declare type TerminateExternalRequestType = {
     /**
      * The uuid of the running application.
@@ -13238,6 +13829,9 @@ declare type TerminateExternalRequestType = {
     killTree: boolean;
 };
 
+/**
+ * @interface
+ */
 declare type Time = {
     /**
      * The number of milliseconds the CPU has spent in user mode.
@@ -13261,14 +13855,28 @@ declare type Time = {
     irq: number;
 };
 
+/**
+ * @interface
+ */
 declare type Transition = {
+    /**
+     * The Opacity transition
+     */
     opacity?: Opacity;
+    /**
+     * The Position transition
+     */
     position?: Position;
+    /**
+     * The Size transition
+     */
     size?: Size;
 };
 
 /**
  * Base configuration options needed for all types of transitions.
+ *
+ * @interface
  */
 declare type TransitionBase = {
     /**
@@ -13285,6 +13893,8 @@ declare type TransitionBase = {
 
 /**
  * Configuration for transition between windows.
+ *
+ * @interface
  */
 declare type TransitionOptions = {
     /**
@@ -13345,6 +13955,9 @@ declare type TrayIconClickedEvent = IdentityEvent & {
     monitorInfo: any;
 };
 
+/**
+ * @interface
+ */
 declare type TrayInfo = {
     /**
      * The bound of tray icon in virtual screen pixels.
@@ -13394,9 +14007,14 @@ declare type UnregisteredEvent = BaseEvent & {
 
 /**
  * View options that can be updated after creation.
+ *
+ * @interface
  */
 declare type UpdatableViewOptions = Partial<MutableViewOptions>;
 
+/**
+ * @interface
+ */
 declare type UpdatableWindowOptions = Partial<MutableWindowOptions>;
 
 /**
@@ -14100,6 +14718,9 @@ declare namespace ViewEvents {
  */
 declare type ViewEventType = ViewEvent['type'];
 
+/**
+ * @interface
+ */
 declare type ViewInfo = {
     canNavigateBack: boolean;
     canNavigateForward: boolean;
@@ -14234,6 +14855,7 @@ declare class ViewOverlay {
 
 /**
  * Represents the payload shape for Views that are trying to prevent an unload.
+ * @interface
  */
 declare interface ViewsPreventingUnloadPayload {
     /**
@@ -14269,6 +14891,8 @@ declare type ViewState = ViewCreationOptions & {
 };
 
 /**
+ * @interface
+ *
  * The statuses of views specifying which of them are trying to prevent an unload and which are not.
  */
 declare interface ViewStatuses {
@@ -14284,13 +14908,22 @@ declare interface ViewStatuses {
 
 /**
  * Configuration for view visibility settings
+ *
+ * @interface
  */
 declare type ViewVisibilityOption = {
+    /**
+     * @defaultValue false
+     *
+     * Enables or disables showing views when the layout splitter or a tab is being dragged.
+     */
     enabled?: boolean;
 };
 
 /**
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
+ *
+ * @interface
  */
 declare type ViewVisibilityOptions = {
     /**
@@ -14313,8 +14946,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.
@@ -16727,7 +17364,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
@@ -16794,7 +17434,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
@@ -16957,6 +17597,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
 
      declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
 
+     /**
+      * @interface
+      */
      declare type WindowDetail = {
          /**
           * The bottom-most coordinate of the window.
@@ -17087,6 +17730,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
          type: 'hotkey';
      };
 
+     /**
+      * @interface
+      */
      declare type WindowInfo = {
          canNavigateBack: boolean;
          canNavigateForward: boolean;
@@ -17202,6 +17848,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
          type: 'window-not-responding';
      };
 
+     /**
+      * @interface
+      */
      declare type WindowOptionDiff = {
          [key in keyof WindowOptions]: {
              oldVal: WindowOptions[key];
@@ -17275,6 +17924,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
       */
      declare type WindowState = 'maximized' | 'minimized' | 'normal';
 
+     /**
+      * @interface
+      */
      declare type WindowViewsPrintOptions = {
          content: 'views';
          includeSelf?: boolean;
@@ -17310,6 +17962,10 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
          positioningOptions?: OpenFin.PositioningOptions;
      };
 
+     /**
+      * @internal
+      * @interface
+      */
      declare type WorkspacePlatformOptions = {
          /** Leaving this as any for now until we figure out what the shape should look like in Workspace */
          [key: string]: any;
@@ -17320,6 +17976,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
       * @interface
       */
      declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
+         /**
+          * Data to be written
+          */
          data: {
              text?: string;
              html?: string;
@@ -17331,6 +17990,8 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
       * @deprecated - instead use WriteAnyClipboardRequest
       *
       * A generic request to write any supported data to the clipboard.
+      *
+      * @interface
       */
      declare type WriteAnyRequestType = WriteAnyClipboardRequest;
 
@@ -17361,6 +18022,8 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
       * @deprecated - instead use OpenFin.WriteClipboardRequest
       *
       * A request to write data to the clipboard.
+      *
+      * @interface
       */
      declare type WriteRequestType = WriteClipboardRequest;