@openfin/core 30.73.23 → 30.73.24

package/src/api/interop/fdc3/overrideCheck.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.overrideCheck = exports.getDefaultViewFdc3VersionFromAppInfo = void 0;
+const InteropBroker_1 = require("../InteropBroker");
+function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }) {
+    var _a, _b, _c, _d;
+    const setVersion = (_c = (_b = (_a = manifest.platform) === null || _a === void 0 ? void 0 : _a.defaultViewOptions) === null || _b === void 0 ? void 0 : _b.fdc3InteropApi) !== null && _c !== void 0 ? _c : (_d = initialOptions.defaultViewOptions) === null || _d === void 0 ? void 0 : _d.fdc3InteropApi;
+    return ['1.2', '2.0'].includes(setVersion !== null && setVersion !== void 0 ? setVersion : '') ? setVersion : undefined;
+}
+exports.getDefaultViewFdc3VersionFromAppInfo = getDefaultViewFdc3VersionFromAppInfo;
+// TODO: Unit test this
+function overrideCheck(overriddenBroker, fdc3InteropApi) {
+    if (fdc3InteropApi && fdc3InteropApi === '2.0') {
+        const mustOverrideAPIs = [
+            'fdc3HandleFindInstances',
+            'handleInfoForIntent',
+            'handleInfoForIntentsByContext',
+            'fdc3HandleGetAppMetadata',
+            'fdc3HandleGetInfo',
+            'fdc3HandleOpen',
+            'handleFiredIntent',
+            'handleFiredIntentForContext'
+        ];
+        const notOverridden = mustOverrideAPIs.filter((api) => {
+            return overriddenBroker[api] === InteropBroker_1.InteropBroker.prototype[api];
+        });
+        if (notOverridden.length > 0) {
+            console.warn(`WARNING: FDC3 2.0 has been set as a default option for Views in this Platform, but the required InteropBroker APIs for FDC3 2.0 compliance have not all been overridden.\nThe following APIs need to be overridden:\n${notOverridden.join('\n')}`);
+        }
+    }
+}
+exports.overrideCheck = overrideCheck;

package/src/api/interop/fdc3/versions.d.ts

@@ -0,0 +1 @@
+export declare type Fdc3Version = '1.2' | '2.0';

package/src/api/interop/fdc3/versions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/api/platform/Factory.d.ts

@@ -4,17 +4,20 @@ import { Channel } from '../interappbus/channel/index';
 import Transport from '../../transport/transport';
 import { LayoutModule } from './layout/index';
 /**
+ * @PORTED
  * InitPlatformOptions interface
  * @typedef { object } InitPlatformOptions
  * @property { OverrideCallback } [overrideCallback] a callback function that can be used to extend or replace default Provider behavior.
  */
 /**
+ * @PORTED
  * @typedef { same | different } ProcessAffinityStrategy
  * @summary Strategy to place views that share a domain into different process affinities or the same process affinity.
  * @property { string } same views in the same domain will have the same process affinity.
  * @property { string } different views in the same domain will have different process affinities.
  */
 /**
+ * @PORTED
  * @typedef { object } PlatformOptions
  * @summary The options object required by {@link Platform#start Platform.start}
  * Any {@link ApplicationOptions Application option} is also a valid platform option
@@ -25,6 +28,7 @@ import { LayoutModule } from './layout/index';
  * @property {ProcessAffinityStrategy} [viewProcessAffinityStrategy] 'same' | 'different'.
  */
 /**
+ * @PORTED
  * @typedef { object } DefaultWindowOptions
  * @summary Default window options apply to all platform windows.
  * Any {@link Window~options Window option} is also a valid Default Window option
@@ -36,6 +40,7 @@ import { LayoutModule } from './layout/index';
  * Windows with a specified url (Custom Windows) will not be affected by this option.
  */
 /**
+ * @DELETED
  * Snapshot interface
  * @typedef { object } Snapshot
  * @property { WindowOption[] } windows The array of window options objects

package/src/api/platform/Factory.js

@@ -5,17 +5,20 @@ const base_1 = require("../base");
 const index_1 = require("./layout/index");
 const Instance_1 = require("./Instance");
 /**
+ * @PORTED
  * InitPlatformOptions interface
  * @typedef { object } InitPlatformOptions
  * @property { OverrideCallback } [overrideCallback] a callback function that can be used to extend or replace default Provider behavior.
  */
 /**
+ * @PORTED
  * @typedef { same | different } ProcessAffinityStrategy
  * @summary Strategy to place views that share a domain into different process affinities or the same process affinity.
  * @property { string } same views in the same domain will have the same process affinity.
  * @property { string } different views in the same domain will have different process affinities.
  */
 /**
+ * @PORTED
  * @typedef { object } PlatformOptions
  * @summary The options object required by {@link Platform#start Platform.start}
  * Any {@link ApplicationOptions Application option} is also a valid platform option
@@ -26,6 +29,7 @@ const Instance_1 = require("./Instance");
  * @property {ProcessAffinityStrategy} [viewProcessAffinityStrategy] 'same' | 'different'.
  */
 /**
+ * @PORTED
  * @typedef { object } DefaultWindowOptions
  * @summary Default window options apply to all platform windows.
  * Any {@link Window~options Window option} is also a valid Default Window option
@@ -37,6 +41,7 @@ const Instance_1 = require("./Instance");
  * Windows with a specified url (Custom Windows) will not be affected by this option.
  */
 /**
+ * @DELETED
  * Snapshot interface
  * @typedef { object } Snapshot
  * @property { WindowOption[] } windows The array of window options objects
@@ -145,6 +150,8 @@ class PlatformModule extends base_1.Base {
                 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                 // @ts-ignore using private variable.
                 const app = await this.fin.Application._create({ ...platformOptions, isPlatformController: true });
+                // TODO: fix typing (internal)
+                // @ts-expect-error
                 app.once('platform-api-ready', () => resolve(this.wrapSync({ uuid })));
                 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                 // @ts-ignore using private variable.
@@ -174,6 +181,8 @@ class PlatformModule extends base_1.Base {
                 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                 // @ts-ignore using private variable.
                 const app = await this.fin.Application._createFromManifest(manifestUrl);
+                // TODO: fix typing (internal)
+                // @ts-expect-error
                 app.once('platform-api-ready', () => resolve(this.wrapSync({ uuid: app.identity.uuid })));
                 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                 // @ts-ignore using private method without warning.

package/src/api/platform/Instance.d.ts

@@ -4,14 +4,14 @@ import { EmitterBase } from '../base';
 import { Channel } from '../interappbus/channel/index';
 import ChannelClient from '../interappbus/channel/client';
 import { LayoutModule } from './layout';
-declare type PlatformEvents = OpenFin.PlatformEvents;
 /** Manages the life cycle of windows and views in the application.
  *
- * Enables taking snapshots of itself and applying them to restore a previous configuration
+ * Enables taking snapshots of itself and applyi
+ * ng them to restore a previous configuration
  * as well as listen to <a href="tutorial-Platform.EventEmitter.html">platform events</a>.
  * @namespace
  */
-export declare class Platform extends EmitterBase<PlatformEvents> {
+export declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
     #private;
     Layout: LayoutModule;
     private _channel;
@@ -66,14 +66,16 @@ export declare class Platform extends EmitterBase<PlatformEvents> {
      */
     getSnapshot(): Promise<OpenFin.Snapshot>;
     /**
+     * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
+     *
      * Returns a snapshot of a single view's options in its current state.
      *
      * Can be used to restore a view to a previous state.
      *
-     * NOTE: this method is meant for advanced usage only, it is not recommended to manage the state of individual views.
-     *
      * @param { Identity } viewIdentity View identity
      * @returns { Promise<ViewState> }
+     * @internal
+     * @experimental
      * @tutorial Platform.getViewSnapshot
      */
     getViewSnapshot(viewIdentity: OpenFin.Identity): Promise<OpenFin.ViewState>;
@@ -145,4 +147,3 @@ export declare class Platform extends EmitterBase<PlatformEvents> {
         skipBeforeUnload: boolean;
     }): Promise<void>;
 }
-export {};

package/src/api/platform/Instance.js

@@ -13,7 +13,8 @@ const validate_1 = require("../../util/validate");
 const clientMap = new Map();
 /** Manages the life cycle of windows and views in the application.
  *
- * Enables taking snapshots of itself and applying them to restore a previous configuration
+ * Enables taking snapshots of itself and applyi
+ * ng them to restore a previous configuration
  * as well as listen to <a href="tutorial-Platform.EventEmitter.html">platform events</a>.
  * @namespace
  */
@@ -174,14 +175,16 @@ class Platform extends base_1.EmitterBase {
         return client.dispatch('get-snapshot');
     }
     /**
+     * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
+     *
      * Returns a snapshot of a single view's options in its current state.
      *
      * Can be used to restore a view to a previous state.
      *
-     * NOTE: this method is meant for advanced usage only, it is not recommended to manage the state of individual views.
-     *
      * @param { Identity } viewIdentity View identity
      * @returns { Promise<ViewState> }
+     * @internal
+     * @experimental
      * @tutorial Platform.getViewSnapshot
      */
     async getViewSnapshot(viewIdentity) {

package/src/api/platform/layout/Factory.d.ts

@@ -3,12 +3,14 @@ import { Layout } from './Instance';
 import { Base } from '../../base';
 declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
 /**
+ * @PORTED
  * InitLayoutOptions interface
  * @typedef { object } InitLayoutOptions
  * @property { string } [containerId] The id attribute of the container where the window's Layout should be initialized.  If not provided
  * then an element with id `layout-container` is used. We recommend using a div element.
  */
 /**
+ * @PORTED
  * PresetLayoutOptions interface
  * @typedef { object } PresetLayoutOptions
  * @property { LayoutPresetTypes } presetType Which preset layout arrangement to use.
@@ -23,6 +25,7 @@ declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
  * @property { LayoutSettings } settings Configuration for certain Layout behaviors. See the LayoutSettings interface.
  */
 /**
+ * @PORTED
  * LayoutItem Interface
  * @typedef { object } LayoutItem 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
@@ -34,6 +37,7 @@ declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
  * options of a given component.
  */
 /**
+ * @PORTED
  * LayoutSettings Interface
  * @typedef { object } LayoutSettings Represents a potential ways to customize behavior of your Layout
  * @property { boolean } [constrainDragToHeaders=false] Limits the area to which tabs can be dragged.

package/src/api/platform/layout/Factory.js

@@ -20,12 +20,14 @@ const base_1 = require("../../base");
 const splitter_controller_1 = require("./controllers/splitter-controller");
 const view_overlay_1 = require("./utils/view-overlay");
 /**
+ * @PORTED
  * InitLayoutOptions interface
  * @typedef { object } InitLayoutOptions
  * @property { string } [containerId] The id attribute of the container where the window's Layout should be initialized.  If not provided
  * then an element with id `layout-container` is used. We recommend using a div element.
  */
 /**
+ * @PORTED
  * PresetLayoutOptions interface
  * @typedef { object } PresetLayoutOptions
  * @property { LayoutPresetTypes } presetType Which preset layout arrangement to use.
@@ -40,6 +42,7 @@ const view_overlay_1 = require("./utils/view-overlay");
  * @property { LayoutSettings } settings Configuration for certain Layout behaviors. See the LayoutSettings interface.
  */
 /**
+ * @PORTED
  * LayoutItem Interface
  * @typedef { object } LayoutItem 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
@@ -51,6 +54,7 @@ const view_overlay_1 = require("./utils/view-overlay");
  * options of a given component.
  */
 /**
+ * @PORTED
  * LayoutSettings Interface
  * @typedef { object } LayoutSettings Represents a potential ways to customize behavior of your Layout
  * @property { boolean } [constrainDragToHeaders=false] Limits the area to which tabs can be dragged.

package/src/api/platform/provider.d.ts

@@ -0,0 +1,162 @@
+import { WindowOptionsChangedEvent } from '../events/window';
+import * as OpenFin from '../../OpenFin';
+/**
+ * This class handles Platform actions. It does not need to be used directly by developers.
+ * However, its methods can be overriden by passing an `overrideCallback` to {@link Platform#init Platform.init}
+ * in order to implement custom Platform behavior. (See {@tutorial Platform.init})
+ *
+ * For an overview of Provider customization, see
+ * {@link https://developers.openfin.co/docs/platform-customization#section-customizing-platform-behavior}.
+ */
+export interface PlatformProvider {
+    /**
+     * Handles requests to create a window in the current platform.
+     * @param { WindowOption } payload Window options for the window to be created.
+     * @param { Identity } [identity] If {@link Platform#createWindow Platform.createWindow} was called, the identity of the caller will be here.
+     * If `createWindow` was called as part of applying a snapshot or creating a view without a target window, `identity` will be undefined.
+     */
+    createWindow(options: OpenFin.PlatformWindowCreationOptions, identity?: OpenFin.Identity): Promise<OpenFin.Window>;
+    /**
+     * Gets the current state of windows and their views and returns a snapshot object containing that info.
+     * @param { undefined } payload Undefined unless you've defined a custom `getSnapshot` protocol.
+     * @param { Identity } identity Identity of the entity that called {@link Platform#getSnapshot Platform.getSnapshot}.
+     * @return { Promise<Snapshot> } Snapshot of current platform state.
+     */
+    getSnapshot(payload: undefined, identity: OpenFin.Identity): Promise<OpenFin.Snapshot>;
+    /**
+     * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
+     * Gets the current state of a single view and returns an object with the options needed to restore that view as part of a snapshot.
+     * @param { Identity } payload Identity of the view.
+     * @return { Promise<ViewState> }
+     * @internal
+     * @experimental
+     */
+    getViewSnapshot(payload: {
+        viewIdentity: OpenFin.Identity;
+    }): Promise<OpenFin.ViewState>;
+    /**
+     * Called when a snapshot is being applied and some windows in that snapshot would be fully or partially off-screen.
+     * Returns an array of windows with modified positions, such that any off-screen windows are positioned in the top left
+     * corner of the main monitor.
+     * @param { Snapshot } snapshot The snapshot to be applied.
+     * @param { WindowOptions[] } outOfBoundsWindows An array of WindowOptions for any windows that would be off-screen.
+     * @return { Promise<WindowOptions[]> } An array of WindowOptions with their position modified to fit on screen.
+     */
+    positionOutOfBoundsWindows(snapshot: OpenFin.Snapshot, outOfBoundsWindows: OpenFin.WindowCreationOptions[]): Promise<OpenFin.WindowCreationOptions[]>;
+    /**
+     * Handles requests to apply a snapshot to the current Platform.
+     * @param { ApplySnapshotPayload } payload Payload containing the snapshot to be applied, as well as any options.
+     * @param { Identity } [identity] Identity of the entity that called {@link Platform#applySnapshot Platform.applySnapshot}.
+     * Undefined if called internally (e.g. when opening the initial snapshot).
+     * @return { Promise<void> }
+     */
+    applySnapshot(payload: OpenFin.ApplySnapshotPayload, identity?: OpenFin.Identity): Promise<void>;
+    /**
+     * Closes the current Platform and all child windows and views.
+     * @param { undefined } payload Undefined unless you have implemented a custom quite protocol.
+     * @param { Identity } identity Identity of the entity that called {@link Platform#quit Platform.quit}.
+     * @return { Promise<void> }
+     */
+    quit(payload: undefined, identity: OpenFin.Identity): Promise<void>;
+    /**
+     * Closes a view
+     * @param { CloseViewPayload } payload Specifies the `target` view to be closed.
+     * @param { Identity } identity Identity of the entity that called {@link Platform#closeView Platform.closeView}.
+     */
+    closeView(payload: OpenFin.CloseViewPayload, identity?: OpenFin.Identity): Promise<any>;
+    /**
+     * Creates a new view and attaches it to a specified target window.
+     * @param { CreateViewPayload } payload Creation options for the new view.
+     * @param { Identity } identity Identity of the entity that called {@link Platform#createView Platform.createView}.
+     * @return { Promise<void> }
+     */
+    createView(payload: OpenFin.CreateViewPayload, identity: OpenFin.Identity): Promise<OpenFin.View>;
+    /** Handles requests to fetch manifests in the current platform.
+     * @param { FetchManifestPayload } payload Payload containing the manifestUrl to be fetched.
+     * @param { Identity } callerIdentity If {@link Platform#fetchManifest Platform.fetchManifest}
+     * was called, the identity of the caller will be here.
+     * If `fetchManifest` was called internally, `callerIdentity` will be the provider's identity.
+     */
+    fetchManifest(payload: OpenFin.FetchManifestPayload, callerIdentity: OpenFin.Identity): Promise<any>;
+    /**
+     * Replaces a Platform window's layout with a new layout. Any views that were in the old layout but not the new layout will be destroyed.
+     * @param { ReplaceLayoutPayload } payload Contains the `target` window and an `opts` object with a `layout` property to apply.
+     * @param { Identity } [identity] Identity of the entity that called {@link Platform#replaceLayout Platform.replaceLayout}.
+     * Undefined if `replaceLayout` is called internally (e.g. while applying a snapshot).
+     * @return { Promise<void> }
+     */
+    replaceLayout(payload: OpenFin.ReplaceLayoutPayload, identity?: OpenFin.Identity): Promise<void>;
+    replaceView(payload: OpenFin.ReplaceViewPayload, identity?: OpenFin.Identity): Promise<void>;
+    launchIntoPlatform(payload: OpenFin.LaunchIntoPlatformPayload): Promise<void>;
+    /**
+     * Handles requests to set a window's context. `target` may be a window or a view.
+     * If it is a window, that window's `customContext` will be updated.
+     * If it is a view, the `customContext` of that view's current host window will be updated.
+     * @param { SetWindowContextPayload } payload Object containing the requested `context` update,
+     * the `target`'s identity, and the target's `entityType`.
+     * @param { Identity } [identity] Identity of the entity that called {@link Platform#setWindowContext Platform.setWindowContext}.
+     * Undefined if `setWindowContext` is called internally (e.g. while applying a snapshot).
+     * @return { Promise<any> } The new context.
+     */
+    setWindowContext(payload: OpenFin.SetWindowContextPayload, identity?: OpenFin.Identity): Promise<any>;
+    /**
+     * Handles requests to get a window's context. `target` may be a window or a view.
+     * If it is a window, that window's `customContext` will be returned.
+     * If it is a view, the `customContext` of that view's current host window will be returned.
+     * @param { GetWindowContextPayload } payload Object containing the requested `context` update,
+     * the `target`'s identity, and the target's `entityType`.
+     * @param { Identity } [identity] Identity of the entity that called {@link Platform#getWindowContext Platform.getWindowContext}.
+     * Undefined when `getWindowContext` is called internally
+     * (e.g. when getting a window's context for the purpose of raising a "host-context-changed" event on a reparented view).
+     * @return { Promise<any> } The new context.
+     */
+    getWindowContext(payload: OpenFin.GetWindowContextPayload, identity?: OpenFin.Identity): Promise<any>;
+    /**
+     * Called when a window's `customContext` is updated. Responsible for raising the `host-context-updated` event on that window's child views.
+     * @param { WindowOptionsChangedEvent<'window', 'options-changed'> } payload The event payload for the window whose context has changed.
+     * The new context will be contained as `payload.diff.customContext.newVal`.
+     * @return { Promise<HostContextChangedPayload> } The event that it raised.
+     */
+    onWindowContextUpdated(payload: WindowOptionsChangedEvent): Promise<OpenFin.HostContextChangedPayload | undefined>;
+    /**
+     * Closes a Window.
+     * By default it will fire any before unload handler set by a View in the Window.
+     * This can be disabled by setting skipBeforeUnload in the options object of the payload.
+     * This method is called by {@link Platform#closeWindow Platform.closeWindow}.
+     * @param {CloseWindowPayload} payload Object that contains the Window Identity and related options.
+     * @param {Identity} callerIdentity
+     * @returns {Promise<void>}
+     */
+    closeWindow(payload: OpenFin.CloseWindowPayload, callerIdentity: OpenFin.Identity): Promise<void>;
+    /**
+     * Gets all the Views attached to a Window that should close along with it. This is meant to be overridable
+     * in the case where you want to return other Views that may not be attached to the Window that is closing.
+     * @param winId Identity of the Window that is closing
+     * @returns { Promise<View> }
+     */
+    getViewsForWindowClose(windowId: OpenFin.Identity): Promise<OpenFin.View[]>;
+    /**
+     * It takes in an array of Views and returns an object specifying which of them are trying to prevent an unload and which are not.
+     * @param {View[]} views Array of Views
+     * @returns { Promise<ViewStatuses> }
+     */
+    checkViewsForPreventUnload(views: OpenFin.View[]): Promise<OpenFin.ViewStatuses>;
+    /**
+     * Handle the decision of whether a Window or specific View should close when trying to prevent an unload. This is meant to be overridden.
+     * Called in {@link PlatformProvider#closeWindow PlatformProvider.closeWindow}.
+     * Normally you would use this method to show a dialog indicating that there are Views that are trying to prevent an unload.
+     * By default it will always return all Views passed into it as meaning to close.
+     * @param {ViewsPreventingUnloadPayload} payload
+     * @tutorial PlatformProvider.getUserDecisionForBeforeUnload
+     * @returns {Promise<BeforeUnloadUserDecision>}
+     */
+    getUserDecisionForBeforeUnload(payload: OpenFin.ViewsPreventingUnloadPayload): Promise<OpenFin.BeforeUnloadUserDecision>;
+    /**
+     * Handles the closing of a Window and/or its Views. Called in {@link PlatformProvider#closeWindow PlatformProvider.closeWindow}.
+     * The return of {@link PlatformProvider#getUserDecisionForBeforeUnload PlatformProvider.getUserDecisionForBeforeUnload} is passed into this method.
+     * @param {Identity} winId Identity of the Window
+     * @param {BeforeUnloadUserDecision} userDecision Decision object
+     * @returns {Promise<void>}
+     */
+    handleViewsAndWindowClose(windowId: OpenFin.Identity, userDecision: OpenFin.BeforeUnloadUserDecision): Promise<void>;
+}

package/src/api/platform/provider.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/api/snapshot-source/Factory.d.ts

@@ -2,6 +2,7 @@ import type * as OpenFin from '../../OpenFin';
 import { Base } from '../base';
 import { SnapshotSource } from './Instance';
 /**
+ * @REMOVED
  * @typedef { object } SnapshotProvider
  * @property {getSnapshot} [getSnapshot]
  * @property {applySnapshot} [applySnapshot]

package/src/api/snapshot-source/Factory.js

@@ -4,6 +4,7 @@ const base_1 = require("../base");
 const Instance_1 = require("./Instance");
 const utils_1 = require("./utils");
 /**
+ * @REMOVED
  * @typedef { object } SnapshotProvider
  * @property {getSnapshot} [getSnapshot]
  * @property {applySnapshot} [applySnapshot]

package/src/api/system/index.d.ts

@@ -4,7 +4,6 @@ import Transport from '../../transport/transport';
 declare type Identity = OpenFin.Identity;
 declare type ProxyInfo = OpenFin.ProxyInfo;
 declare type ProxyConfig = OpenFin.ProxyConfig;
-declare type SystemEvents = OpenFin.SystemEvents;
 declare type InstalledApps = OpenFin.InstalledApps;
 declare type LogInfo = OpenFin.LogInfo;
 declare type LogLevel = OpenFin.LogLevel;
@@ -21,7 +20,7 @@ declare type PrinterInfo = OpenFin.PrinterInfo;
  * clearing the cache and exiting the runtime as well as listen to <a href="tutorial-System.EventEmitter.html">system events</a>.
  * @namespace
  */
-export default class System extends EmitterBase<SystemEvents> {
+export default class System extends EmitterBase<OpenFin.SystemEvent> {
     constructor(wire: Transport);
     private sendExternalProcessRequest;
     /**

package/src/api/system/index.js

@@ -531,19 +531,27 @@ class System extends base_1.EmitterBase {
                 progressListener(p);
             };
             const cleanListeners = () => {
+                // TODO: fix internal types
+                // @ts-expect-error
                 this.removeListener(dlProgressKey, dlProgress);
             };
-            const dlError = (r, err) => {
-                const error = err || r;
+            const dlError = (payload) => {
                 cleanListeners();
-                reject(new transport_errors_1.RuntimeError(error));
+                const { reason, err: error } = payload;
+                reject(new transport_errors_1.RuntimeError({ reason, error }));
             };
             const dlComplete = () => {
                 cleanListeners();
                 resolve();
             };
+            // TODO: fix internal types
+            // @ts-expect-error
             this.on(dlProgressKey, dlProgress);
+            // TODO: fix internal types
+            // @ts-expect-error
             this.once(dlErrorKey, dlError);
+            // TODO: fix internal types
+            // @ts-expect-error
             this.once(dlCompleteKey, dlComplete);
             const downloadOptions = Object.assign(appAsset, { downloadId });
             this.wire.sendAction('download-asset', downloadOptions).catch((err) => {
@@ -578,19 +586,27 @@ class System extends base_1.EmitterBase {
                 progressListener(p);
             };
             const cleanListeners = () => {
+                // TODO: fix internal types
+                // @ts-expect-error
                 this.removeListener(dlProgressKey, dlProgress);
             };
-            const dlError = (r, err) => {
-                const error = err || r;
+            const dlError = (payload) => {
                 cleanListeners();
-                reject(new transport_errors_1.RuntimeError(error));
+                const { reason, err: error } = payload;
+                reject(new transport_errors_1.RuntimeError({ reason, error }));
             };
             const dlComplete = () => {
                 cleanListeners();
                 resolve();
             };
+            // TODO: fix internal types
+            // @ts-expect-error
             this.on(dlProgressKey, dlProgress);
+            // TODO: fix internal types
+            // @ts-expect-error
             this.once(dlErrorKey, dlError);
+            // TODO: fix internal types
+            // @ts-expect-error
             this.once(dlCompleteKey, dlComplete);
             const downloadOptions = Object.assign(options, { downloadId });
             this.wire.sendAction('download-runtime', downloadOptions).catch((err) => {

package/src/api/view/Instance.d.ts

@@ -2,9 +2,10 @@ import type * as OpenFin from '../../OpenFin';
 import { WebContents } from '../webcontents/main';
 import Transport from '../../transport/transport';
 import { Layout } from '../platform/layout';
-declare type ViewEvents = OpenFin.ViewEvents;
+import { ViewEvent } from '../events/view';
 declare type UpdatableViewOptions = OpenFin.UpdatableViewOptions;
 /**
+ * @PORTED
  * @typedef {object} View~options
  * @summary View creation options.
  * @desc This is the options object required by {@link View.create View.create}.
@@ -170,7 +171,7 @@ declare type UpdatableViewOptions = OpenFin.UpdatableViewOptions;
  * @alias View
  * @hideconstructor
  */
-export declare class View extends WebContents<ViewEvents> {
+export declare class View extends WebContents<ViewEvent> {
     identity: OpenFin.Identity;
     constructor(wire: Transport, identity: OpenFin.Identity);
     /**
@@ -453,12 +454,15 @@ export declare class View extends WebContents<ViewEvents> {
      */
     triggerBeforeUnload: () => Promise<boolean>;
     /**
+     * **NOTE**: Internal use only.
      * Attaches this view to an HTML element in the current context. The view will resize responsively when the element bounds change.
-     * @param { string } elementId - id of the HTML element to attach the view to.
+     *
+     * @param {HTMLElement} element - HTML element to attach the view to.
      * @return {Function} - Cleanup function that will disconnect the element resize observer.
+     * @internal
      * @experimental
      * @tutorial View.bindToElement
      */
-    bindToElement: (elementId: string) => Promise<() => void>;
+    bindToElement: (element: HTMLElement) => Promise<() => void>;
 }
 export {};

package/src/api/view/Instance.js

@@ -8,6 +8,7 @@ const main_1 = require("../webcontents/main");
 const window_1 = require("../window");
 const bounds_observer_1 = require("../platform/layout/utils/bounds-observer");
 /**
+ * @PORTED
  * @typedef {object} View~options
  * @summary View creation options.
  * @desc This is the options object required by {@link View.create View.create}.
@@ -457,16 +458,18 @@ class View extends main_1.WebContents {
             return message.payload.data;
         };
         /**
+         * **NOTE**: Internal use only.
          * Attaches this view to an HTML element in the current context. The view will resize responsively when the element bounds change.
-         * @param { string } elementId - id of the HTML element to attach the view to.
+         *
+         * @param {HTMLElement} element - HTML element to attach the view to.
          * @return {Function} - Cleanup function that will disconnect the element resize observer.
+         * @internal
          * @experimental
          * @tutorial View.bindToElement
          */
-        this.bindToElement = async (elementId) => {
-            const element = document.getElementById(elementId);
+        this.bindToElement = async (element) => {
             if (!element) {
-                throw new Error(`Element matching id: ${elementId} not found.`);
+                throw new Error('Element not found.');
             }
             const onChange = async (bounds) => this.setBounds(bounds);
             return (0, bounds_observer_1.observeBounds)(element, onChange);

package/src/api/webcontents/main.d.ts

@@ -1,14 +1,29 @@
 import type * as OpenFin from '../../OpenFin';
 import { EmitterBase } from '../base';
 import Transport from '../../transport/transport';
-import { WebContentsEventMapping } from '../events/webcontents';
-declare type ImageFormat = 'bmp' | 'jpg' | 'png';
+import { BaseEvent } from '../events/base';
+/**
+ * Configuration for page capture.
+ */
 export interface CapturePageOptions {
+    /**
+     * The area of the window to be captured.
+     */
     area?: OpenFin.Rectangle;
-    format?: ImageFormat;
+    /**
+     * @defaultValue 'png'
+     *
+     * The format of the captured image.  Can be 'png', 'jpg', or 'bmp'.
+     */
+    format?: 'bmp' | 'jpg' | 'png';
+    /**
+     * @defaultValue 100
+     *
+     * Quality of JPEG image. Between 0 - 100.
+     */
     quality?: number;
 }
-export declare class WebContents<T extends WebContentsEventMapping> extends EmitterBase<T> {
+export declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
     entityType: string;
     constructor(wire: Transport, identity: OpenFin.Identity, entityType: string);
     capturePage(options?: CapturePageOptions): Promise<string>;
@@ -35,4 +50,3 @@ export declare class WebContents<T extends WebContentsEventMapping> extends Emit
     inspectServiceWorker(): Promise<void>;
     showPopupWindow(options: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
 }
-export {};