@openfin/core 31.74.22 → 31.74.23

package/src/api/platform/layout/entities/layout-entities.js

@@ -0,0 +1,312 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _a, _LayoutNode_client, _TabStack_client, _ColumnOrRow_client;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ColumnOrRow = exports.TabStack = exports.LayoutNode = void 0;
+const api_exposer_1 = require("../../../api-exposer");
+const channel_api_relay_1 = require("../../../../util/channel-api-relay");
+/*
+    This file includes LayoutNode, ColumnOrRow and TabStack classes, which are all closely
+    intertwined, and share members via parent abstract class LayoutNode. To prevent circular
+    refs, we define and export all the classes here.
+*/
+/**
+ * @ignore
+ * @internal
+ * Supplies an ApiClient for {@link LayoutEntitiesController} and helper methods
+ * for the entities {@link TabStack} AND {@link ColumnOrRow} to use.
+ */
+class LayoutNode {
+    /**
+     * @internal
+     * @ignore
+     */
+    constructor(client, entityId) {
+        /**
+         * @ignore
+         * @internal
+         * ApiClient for {@link LayoutEntitiesController}
+         */
+        _LayoutNode_client.set(this, void 0);
+        this.isRoot = () => __classPrivateFieldGet(this, _LayoutNode_client, "f").isRoot(this.entityId);
+        this.exists = () => __classPrivateFieldGet(this, _LayoutNode_client, "f").exists(this.entityId);
+        this.getParent = async () => {
+            const parent = await __classPrivateFieldGet(this, _LayoutNode_client, "f").getParent(this.entityId);
+            if (!parent) {
+                return undefined;
+            }
+            return LayoutNode.getEntity(parent, __classPrivateFieldGet(this, _LayoutNode_client, "f"));
+        };
+        this.createAdjacentStack = async (views, options) => {
+            const entityId = await __classPrivateFieldGet(this, _LayoutNode_client, "f").createAdjacentStack(this.entityId, views, options);
+            return LayoutNode.getEntity({ entityId, type: 'stack' }, __classPrivateFieldGet(this, _LayoutNode_client, "f"));
+        };
+        this.getAdjacentStacks = async (edge) => {
+            const adjacentStacks = await __classPrivateFieldGet(this, _LayoutNode_client, "f").getAdjacentStacks({
+                targetId: this.entityId,
+                edge
+            });
+            return adjacentStacks.map((stack) => LayoutNode.getEntity({
+                type: 'stack',
+                entityId: stack.entityId
+            }, __classPrivateFieldGet(this, _LayoutNode_client, "f")));
+        };
+        __classPrivateFieldSet(this, _LayoutNode_client, client, "f");
+        this.entityId = entityId;
+    }
+}
+exports.LayoutNode = LayoutNode;
+_a = LayoutNode, _LayoutNode_client = new WeakMap();
+/**
+ * @ignore
+ * @internal
+ * Encapsulates Api consumption of {@link LayoutEntitiesController} with a relayed dispatch
+ * @param client
+ * @param controllerId
+ * @param identity
+ * @returns a new instance of {@link LayoutEntitiesClient} with bound to the controllerId
+ */
+LayoutNode.newLayoutEntitiesClient = async (client, controllerId, identity) => {
+    const dispatch = (0, channel_api_relay_1.createRelayedDispatch)(client, identity, 'layout-relay', 'You are trying to interact with a layout component on a window that has been destroyed.');
+    const consumer = new api_exposer_1.ApiConsumer(new api_exposer_1.ChannelsConsumer({ dispatch }));
+    return consumer.consume({ id: controllerId });
+};
+LayoutNode.getEntity = (definition, client) => {
+    const { entityId, type } = definition;
+    switch (type) {
+        case 'column':
+        case 'row':
+            return new ColumnOrRow(client, entityId, type);
+        case 'stack':
+            return new TabStack(client, entityId);
+        default:
+            throw new Error(`Unrecognised Layout Entity encountered ('${JSON.stringify(definition)})`);
+    }
+};
+/**
+ * @typedef {string} LayoutPosition
+ * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
+ */
+/**
+ * @typedef {object} StackCreationOptions
+ * @summary Stack creation options.
+ * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
+ */
+/**
+ * @typedef {object} TabStack~AddViewOptions
+ * @summary Options to use when adding a view to a {@link TabStack}
+ * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
+ */
+/**
+ * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
+ */
+class TabStack extends LayoutNode {
+    /**
+     * Determines if this {@link TabStack} is the top level content item in the current layout.
+     * @function isRoot
+     * @memberof TabStack
+     * @instance
+     * @tutorial TabStack.isRoot
+     * @return {Promise<boolean>} Resolves true if this TabStack is the top level content item, or false if it is not.
+     */
+    /**
+     * Determines if this  {@link TabStack} exists.
+     * @function exists
+     * @instance
+     * @memberof TabStack
+     * @tutorial TabStack.exists
+     * @return {Promise<boolean>} Resolves true if this is the TabStack exists, or false if it has been destroyed.
+     */
+    /**
+     * Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
+     * @function getParent
+     * @instance
+     * @memberof TabStack
+     * @tutorial TabStack.getParent
+     * @return {Promise<ColumnOrRow | TabStack | undefined>} Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if this {@link TabStack} is the root content item or does not exist.
+     */
+    /**
+     * Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
+     * @function getAdjacentStacks
+     * @instance
+     * @memberof TabStack
+     * @param  {LayoutPosition} edge - Edge to check for any adjacent stacks.
+     * @returns {Promise<TabStack[]>}
+     * @tutorial TabStack.getAdjacentStacks
+     */
+    /**
+     * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
+     *
+     * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
+     * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
+     * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
+     * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
+     *
+     * @function createAdjacentStack
+     * @instance
+     * @memberof TabStack
+     * @param {View~options} views - List of identities or view creation options of the views to include in the stack
+     * @param {StackCreationOptions} options - Creation options.
+     * @returns {Promise<TabStack>} The created TabStack.
+     * @tutorial TabStack.createAdjacentStack
+     * @experimental
+     */
+    /** @internal */
+    constructor(client, entityId) {
+        super(client, entityId);
+        /**
+         * @internal
+         * ApiClient for {@link LayoutEntitiesController}
+         */
+        _TabStack_client.set(this, void 0);
+        /**
+         * Type of the content item. Always stack, but useful for distinguishing between a {@link TabStack} and {@link ColumnOrRow}.
+         */
+        this.type = 'stack';
+        /**
+         * Retrieves a list of all views belonging to this {@link TabStack}.
+         *
+         * Known Issue: If adding a view overflows the tab-container width, the added view will be set as active
+         * and rendered at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
+         * If that happens and then getViews() is called, it will return the identities in a different order than
+         * than the currently rendered tab order.
+         *
+         * @returns {Promise<Identity[]>} Resolves with a list containing the {@link OpenFin.Identity identities} of each view belonging to the {@link TabStack}.
+         * @throws If the {@link TabStack} has been destroyed.
+         * @tutorial TabStack.getViews
+         * @experimental
+         */
+        this.getViews = () => __classPrivateFieldGet(this, _TabStack_client, "f").getStackViews(this.entityId);
+        /**
+         * Adds or creates a view in this {@link TabStack}.
+         *
+         * Known Issue: If adding a view overflows the tab-container, the added view will be set as active
+         * and rendered at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
+         *
+         * @param {View~options} view The identity of an existing view to add, or options to create a view.
+         * @param {TabStack~AddViewOptions} options Optional view options: index number used to insert the view into the stack at that index. Defaults to 0 (front of the stack)
+         * @returns {Promise<identity>} Resolves with the {@link OpenFin.Identity identity} of the added view.
+         * @throws If the view does not exist or fails to create.
+         * @throws If the {@link TabStack} has been destroyed.
+         * @tutorial TabStack.addView
+         * @experimental
+         */
+        this.addView = async (view, options = { index: 0 }) => __classPrivateFieldGet(this, _TabStack_client, "f").addViewToStack(this.entityId, view, options);
+        /**
+         * Removes a view from this {@link TabStack}.
+         * @param {Identity} view - Identity of the view to remove.
+         * @throws If the view does not exist or does not belong to the stack.
+         * @throws If the {@link TabStack} has been destroyed.
+         * @return {Promise<void>}
+         * @tutorial TabStack.removeView
+         */
+        this.removeView = async (view) => {
+            await __classPrivateFieldGet(this, _TabStack_client, "f").removeViewFromStack(this.entityId, view);
+        };
+        /**
+         * Sets the active view of the {@link TabStack} without focusing it.
+         * @param {Identity} view - Identity of the view to activate.
+         * @returns {Promise<void>} Promise which resolves with void once the view has been activated.
+         * @throws If the {@link TabStack} has been destroyed.
+         * @throws If the view does not exist.
+         * @tutorial TabStack.setActiveView
+         * @experimental
+         */
+        this.setActiveView = async (view) => {
+            await __classPrivateFieldGet(this, _TabStack_client, "f").setStackActiveView(this.entityId, view);
+        };
+        __classPrivateFieldSet(this, _TabStack_client, client, "f");
+    }
+}
+exports.TabStack = TabStack;
+_TabStack_client = new WeakMap();
+/**
+ * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
+ */
+class ColumnOrRow extends LayoutNode {
+    /**
+     * Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
+     * @function isRoot
+     * @memberof ColumnOrRow
+     * @instance
+     * @tutorial ColumnOrRow.isRoot
+     * @return {Promise<boolean>} Resolves true if this TabStack is the top level content item, or false if it is not.
+     */
+    /**
+     * Determines if this  {@link ColumnOrRow} exists.
+     * @function exists
+     * @instance
+     * @memberof ColumnOrRow
+     * @tutorial ColumnOrRow.exists
+     * @return {Promise<boolean>} Resolves true if the TabStack exists, or false if it has been destroyed.
+     */
+    /**
+     * Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
+     * @function getParent
+     * @instance
+     * @memberof ColumnOrRow
+     * @tutorial ColumnOrRow.getParent
+     * @return {Promise<ColumnOrRow | undefined>} Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if this {@link ColumnOrRow} does not exist or is the root content item.
+     */
+    /**
+     * Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
+     * @function getAdjacentStacks
+     * @instance
+     * @memberof ColumnOrRow
+     * @param  {LayoutPosition} edge - Edge to check for any adjacent stacks.
+     * @returns {Promise<TabStack[]>}
+     * @tutorial ColumnOrRow.getAdjacentStacks
+     */
+    /**
+     * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
+     *
+     * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
+     * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
+     * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
+     * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
+     *
+     * @function createAdjacentStack
+     * @instance
+     * @memberof ColumnOrRow
+     * @param {View~options} views - List of identities or view creation options of the views to include in the stack
+     * @param {StackCreationOptions} options - Creation options.
+     * @returns {Promise<TabStack>} The created TabStack
+     * @tutorial ColumnOrRow.createAdjacentStack
+     * @experimental
+     */
+    /**
+     * @internal
+     */
+    constructor(client, entityId, type) {
+        super(client, entityId);
+        /**
+         * @ignore
+         * @internal
+         * ApiClient for {@link LayoutEntitiesController}
+         */
+        _ColumnOrRow_client.set(this, void 0);
+        /**
+         * Retrieves a list of all content items belonging to this {@link ColumnOrRow} in order of appearance.
+         * @returns {Promise<Array<ColumnOrRow | TabStack>>} Resolves with a list containing {@link ColumnOrRow} and {@link TabStack} items belonging to this {@link ColumnOrRow}.
+         * @tutorial ColumnOrRow.getContent
+         */
+        this.getContent = async () => {
+            const contentItemEntities = await __classPrivateFieldGet(this, _ColumnOrRow_client, "f").getContent(this.entityId);
+            return contentItemEntities.map((entity) => LayoutNode.getEntity(entity, __classPrivateFieldGet(this, _ColumnOrRow_client, "f")));
+        };
+        __classPrivateFieldSet(this, _ColumnOrRow_client, client, "f");
+        this.type = type;
+    }
+}
+exports.ColumnOrRow = ColumnOrRow;
+_ColumnOrRow_client = new WeakMap();

package/src/api/platform/layout/entities/shapes.d.ts

@@ -0,0 +1,6 @@
+export type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
+export type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
+export type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes = LayoutEntityTypes> = {
+    type: TLayoutEntityType;
+    entityId: string;
+};

package/src/api/platform/layout/entities/shapes.js

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

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

@@ -0,0 +1 @@
+export declare const LAYOUT_CONTROLLER_ID = "layout-entities";

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

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LAYOUT_CONTROLLER_ID = void 0;
+exports.LAYOUT_CONTROLLER_ID = 'layout-entities';

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

@@ -1,4 +1,6 @@
+import { ApiClient } from '../../api-exposer';
 import type * as OpenFin from '../../../OpenFin';
+import { LayoutEntitiesController } from './controllers/layout-entities-controller';
 type LayoutPresetType = OpenFin.LayoutPresetType;
 export interface InitLayoutOptions {
     containerId?: string;
@@ -10,4 +12,5 @@ export interface DragPayload {
     'view-config': OpenFin.ViewCreationOptions;
     'view-identity': [string, string, string];
 }
+export type LayoutEntitiesClient = ApiClient<LayoutEntitiesController>;
 export {};

package/src/api/platform/layout/utils/layout-traversal.d.ts

@@ -0,0 +1,4 @@
+import type * as OpenFin from '../../../../OpenFin';
+export declare const getAdjacentItem: (component: GoldenLayout.ContentItem, edge: OpenFin.LayoutPosition) => GoldenLayout.ContentItem | undefined;
+export declare const doShareEdge: (from: GoldenLayout.ContentItem, to: GoldenLayout.ContentItem, edge: OpenFin.LayoutPosition) => boolean;
+export declare const getAdjacentStacks: (item: GoldenLayout.ContentItem, edge: OpenFin.LayoutPosition) => GoldenLayout.ContentItem[];

package/src/api/platform/layout/utils/layout-traversal.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAdjacentStacks = exports.doShareEdge = exports.getAdjacentItem = void 0;
+const getAdjacentItem = (component, edge) => {
+    const { parent } = component;
+    if (parent.isRoot) {
+        return undefined;
+    }
+    const targetType = ['top', 'bottom'].includes(edge) ? 'column' : 'row';
+    const edgeSiblingOffset = ['top', 'left'].includes(edge) ? -1 : 1;
+    if (parent.type === targetType) {
+        const componentIndex = parent.contentItems.indexOf(component);
+        const targetIndex = componentIndex + edgeSiblingOffset;
+        if (targetIndex >= 0 && targetIndex < parent.contentItems.length) {
+            return parent.contentItems[targetIndex];
+        }
+    }
+    return (0, exports.getAdjacentItem)(parent, edge);
+};
+exports.getAdjacentItem = getAdjacentItem;
+const doShareEdge = (from, to, edge) => {
+    var _a, _b;
+    const boundsFrom = (_a = from.element.get(0)) === null || _a === void 0 ? void 0 : _a.getBoundingClientRect();
+    const boundsTo = (_b = to.element.get(0)) === null || _b === void 0 ? void 0 : _b.getBoundingClientRect();
+    if (!boundsFrom || !boundsTo) {
+        return false;
+    }
+    if (['top', 'bottom'].includes(edge)) {
+        const horizontallyOutOfBounds = boundsFrom.right < boundsTo.left || boundsFrom.left > boundsTo.right;
+        return !horizontallyOutOfBounds;
+    }
+    const verticallyOutOfBounds = boundsFrom.bottom < boundsTo.top || boundsFrom.top > boundsTo.bottom;
+    return !verticallyOutOfBounds;
+};
+exports.doShareEdge = doShareEdge;
+const getAdjacentStacks = (item, edge) => {
+    const targetContainer = ['top', 'bottom'].includes(edge) ? 'row' : 'column';
+    const findEdgeStacks = (component) => {
+        if (component.type === 'stack') {
+            if ((0, exports.doShareEdge)(item, component, edge)) {
+                return [component];
+            }
+            return [];
+        }
+        if (component.type === 'root') {
+            return [];
+        }
+        if (component.type === targetContainer) {
+            return component.contentItems.map((contentItem) => findEdgeStacks(contentItem)).flat();
+        }
+        if (component.type !== targetContainer) {
+            if (['top', 'right'].includes(edge)) {
+                return findEdgeStacks(component.contentItems[component.contentItems.length - 1]);
+            }
+            return findEdgeStacks(component.contentItems[0]);
+        }
+        return [];
+    };
+    const edgeItem = (0, exports.getAdjacentItem)(item, edge);
+    if (edgeItem) {
+        return findEdgeStacks(edgeItem);
+    }
+    return [];
+};
+exports.getAdjacentStacks = getAdjacentStacks;

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

@@ -1,5 +1,5 @@
-import { WindowOptionsChangedEvent } from '../events/window';
 import * as OpenFin from '../../OpenFin';
+type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
 /**
  * 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}
@@ -160,3 +160,4 @@ export interface PlatformProvider {
      */
     handleViewsAndWindowClose(windowId: OpenFin.Identity, userDecision: OpenFin.BeforeUnloadUserDecision): Promise<void>;
 }
+export {};

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

@@ -460,6 +460,15 @@ export default class System extends EmitterBase<OpenFin.SystemEvent> {
      */
     getServiceConfiguration(serviceIdentifier: OpenFin.ServiceIdentifier): Promise<OpenFin.ServiceConfiguration>;
     protected getSystemAppConfig(name: string): Promise<any>;
+    /**
+     * Registers a system shutdown handler so user can do some cleanup before system is shutting down.
+     * Note: Once system shutdown starts, you are unable to cancel it.
+     * @param { SystemShutdownHandler } handler system shutdown handler
+     * @return {Promise.<void>}
+     * @tutorial System.registerShutdownHandler
+     * @experimental
+     */
+    registerShutdownHandler(handler: OpenFin.SystemShutdownHandler): Promise<void>;
     /**
      * Signals the RVM to perform a health check and returns the results as json.
      * @return {Promise.<string[]>}

package/src/api/system/index.js

@@ -512,53 +512,62 @@ class System extends base_1.EmitterBase {
      * @tutorial System.downloadAsset
      */
     // incompatible with standalone node process.
-    downloadAsset(appAsset, progressListener) {
-        return new Promise((resolve, reject) => {
-            // node.js environment not supported
-            if (this.wire.environment.constructor.name === 'NodeEnvironment') {
-                reject(new transport_errors_1.NotSupportedError('downloadAsset only supported in an OpenFin Render process'));
-                return;
-            }
-            const downloadId = this.wire.environment.getNextMessageId().toString();
-            const dlProgressKey = `asset-download-progress-${downloadId}`;
-            const dlErrorKey = `asset-download-error-${downloadId}`;
-            const dlCompleteKey = `asset-download-complete-${downloadId}`;
-            const dlProgress = (progress) => {
-                const p = {
-                    downloadedBytes: progress.downloadedBytes,
-                    totalBytes: progress.totalBytes
-                };
-                progressListener(p);
-            };
-            const cleanListeners = () => {
-                // TODO: fix internal types
-                // @ts-expect-error
-                this.removeListener(dlProgressKey, dlProgress);
-            };
-            const dlError = (payload) => {
-                cleanListeners();
-                const { reason, err: error } = payload;
-                reject(new transport_errors_1.RuntimeError({ reason, error }));
-            };
-            const dlComplete = () => {
-                cleanListeners();
-                resolve();
+    async downloadAsset(appAsset, progressListener) {
+        // eslint-disable-next-line @typescript-eslint/explicit-function-return-type, @typescript-eslint/no-empty-function
+        const noop = () => { };
+        let resolve = noop;
+        let reject = noop;
+        const downloadCompletePromise = new Promise((y, n) => {
+            resolve = y;
+            reject = n;
+        });
+        // node.js environment not supported
+        if (this.wire.environment.constructor.name === 'NodeEnvironment') {
+            throw new transport_errors_1.NotSupportedError('downloadAsset only supported in an OpenFin Render process');
+        }
+        const callSite = transport_errors_1.RuntimeError.getCallSite();
+        const downloadId = this.wire.environment.getNextMessageId().toString();
+        const dlProgressKey = `asset-download-progress-${downloadId}`;
+        const dlErrorKey = `asset-download-error-${downloadId}`;
+        const dlCompleteKey = `asset-download-complete-${downloadId}`;
+        const dlProgress = (progress) => {
+            const p = {
+                downloadedBytes: progress.downloadedBytes,
+                totalBytes: progress.totalBytes
             };
+            progressListener(p);
+        };
+        const cleanListeners = () => {
             // TODO: fix internal types
             // @ts-expect-error
-            this.on(dlProgressKey, dlProgress);
+            this.removeListener(dlProgressKey, dlProgress);
+        };
+        const dlError = (payload) => {
+            cleanListeners();
+            const { reason, err: error } = payload;
+            reject(new transport_errors_1.RuntimeError({ reason, error }, callSite));
+        };
+        const dlComplete = () => {
+            cleanListeners();
+            resolve();
+        };
+        await Promise.all([
             // TODO: fix internal types
             // @ts-expect-error
-            this.once(dlErrorKey, dlError);
+            this.on(dlProgressKey, dlProgress),
             // 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) => {
-                cleanListeners();
-                reject(err);
-            });
+            this.once(dlErrorKey, dlError),
+            // TODO: fix internal types
+            // @ts-expect-error
+            this.once(dlCompleteKey, dlComplete)
+        ]);
+        const downloadOptions = Object.assign(appAsset, { downloadId });
+        await this.wire.sendAction('download-asset', downloadOptions).catch((err) => {
+            cleanListeners();
+            throw err;
         });
+        return downloadCompletePromise;
     }
     /**
      * Downloads a version of the runtime.
@@ -568,6 +577,7 @@ class System extends base_1.EmitterBase {
      * @tutorial System.downloadRuntime
      */
     downloadRuntime(options, progressListener) {
+        const callsites = transport_errors_1.RuntimeError.getCallSite();
         return new Promise((resolve, reject) => {
             // node.js environment not supported
             if (this.wire.environment.constructor.name === 'NodeEnvironment') {
@@ -593,7 +603,7 @@ class System extends base_1.EmitterBase {
             const dlError = (payload) => {
                 cleanListeners();
                 const { reason, err: error } = payload;
-                reject(new transport_errors_1.RuntimeError({ reason, error }));
+                reject(new transport_errors_1.RuntimeError({ reason, error }, callsites));
             };
             const dlComplete = () => {
                 cleanListeners();
@@ -735,6 +745,34 @@ class System extends base_1.EmitterBase {
         }
         return this.wire.sendAction('get-system-app-configuration', { name }).then(({ payload }) => payload.data);
     }
+    /**
+     * Registers a system shutdown handler so user can do some cleanup before system is shutting down.
+     * Note: Once system shutdown starts, you are unable to cancel it.
+     * @param { SystemShutdownHandler } handler system shutdown handler
+     * @return {Promise.<void>}
+     * @tutorial System.registerShutdownHandler
+     * @experimental
+     */
+    async registerShutdownHandler(handler) {
+        this.wire.sendAction('system-register-shutdown-handler').catch((e) => {
+            // don't expose, analytics-only call
+        });
+        const SystemShutdownEventName = 'system-shutdown';
+        const SystemShutdownHandledEventName = 'system-shutdown-handled';
+        const { uuid, name } = this.wire.me;
+        const shutdownHandler = (payload) => {
+            const proceed = () => {
+                // notify core that the app is ready for shutdown
+                this.wire.environment.raiseEvent(`application/${SystemShutdownHandledEventName}`, {
+                    uuid,
+                    name,
+                    topic: 'application'
+                });
+            };
+            handler({ proceed });
+        };
+        this.on(SystemShutdownEventName, shutdownHandler);
+    }
     /**
      * Signals the RVM to perform a health check and returns the results as json.
      * @return {Promise.<string[]>}

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

@@ -1,9 +1,8 @@
 import type * as OpenFin from '../../OpenFin';
-import { WebContents } from '../webcontents/main';
 import { Transport } from '../../transport/transport';
-import { Layout } from '../platform/layout';
-import { ViewEvent } from '../events/view';
+import { WebContents } from '../webcontents/main';
 type UpdatableViewOptions = OpenFin.UpdatableViewOptions;
+type ViewEvent = OpenFin.ViewEvent;
 /**
  * @PORTED
  * @typedef {object} View~options
@@ -145,6 +144,9 @@ type UpdatableViewOptions = OpenFin.UpdatableViewOptions;
  * @property {string} [processAffinity=<application uuid>]
  * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
  *
+ * @property {boolean} [spellCheck=false]
+ * Enable spell check in input text fields for the view.
+ *
  * @property {Identity} [target]
  * The identity of the window this view should be attached to.
  *
@@ -172,6 +174,7 @@ type UpdatableViewOptions = OpenFin.UpdatableViewOptions;
  * @hideconstructor
  */
 export declare class View extends WebContents<ViewEvent> {
+    #private;
     identity: OpenFin.Identity;
     constructor(wire: Transport, identity: OpenFin.Identity);
     /**
@@ -445,6 +448,12 @@ export declare class View extends WebContents<ViewEvent> {
      * @experimental
      */
     getCurrentWindow: () => Promise<OpenFin.Window>;
+    /**
+     * Retrieves the current {@link TabStack} of the view if it belongs to one.
+     * @return {Promise<TabStack>} The {@link TabStack} this view belongs to.
+     * @throws if this view does not belong to a TabStack or if the window has been destroyed.
+     */
+    getCurrentStack: () => Promise<OpenFin.TabStack>;
     /**
      * Triggers the before-unload handler for the View, if one is set. Returns `true` if the handler is trying to prevent the View from unloading, and `false` if it isn't.
      * Only enabled when setting enableBeforeUnload: true in your View options. If this option is not enabled it will always return false.