@openfin/core 31.74.30 → 31.75.1

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,8 +1,8 @@
 import type * as OpenFin from '../../OpenFin';
 import { Transport } from '../../transport/transport';
-import { ViewEvent } from '../events/view';
 import { WebContents } from '../webcontents/main';
 type UpdatableViewOptions = OpenFin.UpdatableViewOptions;
+type ViewEvent = OpenFin.ViewEvent;
 /**
  * @PORTED
  * @typedef {object} View~options
@@ -144,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.
  *
@@ -447,10 +450,10 @@ export declare class View extends WebContents<ViewEvent> {
     getCurrentWindow: () => Promise<OpenFin.Window>;
     /**
      * Retrieves the current {@link TabStack} of the view if it belongs to one.
-     * @return {Promise<TabStack | undefined>} The {@link TabStack} this view belongs to.
+     * @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 | undefined>;
+    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.

package/src/api/view/Instance.js

@@ -155,6 +155,9 @@ const window_1 = require("../window");
  * @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.
  *
@@ -459,23 +462,22 @@ class View extends main_1.WebContents {
         };
         /**
          * Retrieves the current {@link TabStack} of the view if it belongs to one.
-         * @return {Promise<TabStack | undefined>} The {@link TabStack} this view belongs to.
+         * @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.
          */
         this.getCurrentStack = async () => {
+            this.wire.sendAction('view-get-current-stack').catch(() => {
+                // don't expose
+            });
             try {
                 const layoutWindow = await this.getCurrentWindow();
                 const providerChannelClient = await __classPrivateFieldGet(this, _View_providerChannelClient, "f").getValue();
                 const client = await layout_entities_1.LayoutNode.newLayoutEntitiesClient(providerChannelClient, layout_constants_1.LAYOUT_CONTROLLER_ID, layoutWindow.identity);
-                const stackDefinition = await client.getStackByView(this.identity);
+                const stackDefinition = (await client.getStackByView(this.identity));
                 return layout_entities_1.LayoutNode.getEntity(stackDefinition, client);
             }
             catch (error) {
-                const e = new transport_errors_1.RuntimeError({ reason: 'This view does not belong to a stack.' });
-                // TODO: @pierre to fix
-                // @ts-expect-error pending PR !3459 to fix runtime errors
-                e.cause = error;
-                throw e;
+                throw new transport_errors_1.RuntimeError({ reason: 'This view does not belong to a stack.', error });
             }
         };
         /**

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

@@ -2,31 +2,11 @@ import type * as OpenFin from '../../OpenFin';
 import { EmitterBase } from '../base';
 import { Transport } from '../../transport/transport';
 import { BaseEvent } from '../events/base';
-/**
- * Configuration for page capture.
- */
-export interface CapturePageOptions {
-    /**
-     * The area of the window to be captured.
-     */
-    area?: OpenFin.Rectangle;
-    /**
-     * @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 BaseEvent> extends EmitterBase<T> {
+    identity: OpenFin.Identity;
     entityType: string;
     constructor(wire: Transport, identity: OpenFin.Identity, entityType: string);
-    capturePage(options?: CapturePageOptions): Promise<string>;
+    capturePage(options?: OpenFin.CapturePageOptions): Promise<string>;
     executeJavaScript(code: string): Promise<void>;
     getZoomLevel(): Promise<number>;
     setZoomLevel(level: number): Promise<void>;

package/src/api/webcontents/main.js

@@ -5,6 +5,7 @@ const base_1 = require("../base");
 class WebContents extends base_1.EmitterBase {
     constructor(wire, identity, entityType) {
         super(wire, entityType, identity.uuid, identity.name);
+        this.identity = identity;
         this.entityType = entityType;
     }
     capturePage(options) {
@@ -41,7 +42,7 @@ class WebContents extends base_1.EmitterBase {
         })
             .then(() => undefined);
     }
-    print(options) {
+    print(options = {}) {
         return this.wire.sendAction('print', { ...this.identity, options }).then(() => undefined);
     }
     findInPage(searchTerm, options) {

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

@@ -334,6 +334,9 @@ import { WebContents } from '../webcontents/main';
  * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
  *
+ * @property {boolean} [spellCheck=false]
+ * Enable spell check in input text fields for the window.
+ *
  * @property {string} [state="normal"]
  * The visible state of the window on creation.
  * One of:
@@ -1071,4 +1074,11 @@ export declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * @tutorial Window.dispatchPopupResult
      */
     dispatchPopupResult(data: any): Promise<void>;
+    /**
+     * Prints the contents of the window.
+     *
+     * @param options Configuration for the print task.
+     * @tutorial Window.print
+     */
+    print(options?: OpenFin.WindowPrintOptions): Promise<void>;
 }

package/src/api/window/Instance.js

@@ -341,6 +341,9 @@ const view_1 = require("../view");
  * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
  *
+ * @property {boolean} [spellCheck=false]
+ * Enable spell check in input text fields for the window.
+ *
  * @property {string} [state="normal"]
  * The visible state of the window on creation.
  * One of:
@@ -1317,5 +1320,24 @@ class _Window extends main_1.WebContents {
         });
         await this.wire.sendAction('dispatch-popup-result', { data, ...this.identity });
     }
+    /**
+     * Prints the contents of the window.
+     *
+     * @param options Configuration for the print task.
+     * @tutorial Window.print
+     */
+    async print(options = { content: 'self' }) {
+        switch (options.content) {
+            case undefined:
+            case 'self':
+                return super.print(options);
+            case 'screenshot':
+                return this.wire.sendAction('print-screenshot', this.identity).then(() => undefined);
+            case 'views':
+                return this.wire.sendAction('print-views', { ...this.identity, options }).then(() => undefined);
+            default:
+                return undefined;
+        }
+    }
 }
 exports._Window = _Window;

package/src/environment/mockEnvironment.d.ts

@@ -0,0 +1,27 @@
+import { Environment } from './environment';
+import type * as OpenFin from '../OpenFin';
+import { NewConnectConfig } from '../transport/wire';
+import { EntityType } from '../OpenFin';
+export declare class MockEnvironment implements Environment {
+    getDefaultChannelOptions(): {
+        create: OpenFin.ChannelCreateOptions;
+        connect: OpenFin.ChannelConnectOptions;
+    };
+    getRtcPeer(): RTCPeerConnection;
+    getManagerConstructor(): Promise<any>;
+    getProviderInitializer(): Promise<any>;
+    observeBounds(): never;
+    writeToken(path: string, token: string): Promise<string>;
+    retrievePort(config: NewConnectConfig): Promise<number>;
+    getNextMessageId(): string;
+    getRandomId(): string;
+    createChildContent(options: any): Promise<any>;
+    getWebWindow(identity: OpenFin.Identity): globalThis.Window;
+    getCurrentEntityIdentity(): OpenFin.EntityInfo;
+    getCurrentEntityType(): EntityType;
+    raiseEvent(eventName: string, eventArgs: any): void;
+    getUrl(): string;
+    whenReady(): Promise<void>;
+    childViews: boolean;
+    getWsConstructor(): any;
+}

package/src/environment/mockEnvironment.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockEnvironment = void 0;
+const me_1 = require("../api/me");
+class MockEnvironment {
+    constructor() {
+        this.childViews = true;
+    }
+    getDefaultChannelOptions() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getRtcPeer() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    async getManagerConstructor() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    async getProviderInitializer() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    observeBounds() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    writeToken(path, token) {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    retrievePort(config) {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getNextMessageId() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getRandomId() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    createChildContent(options) {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getWebWindow(identity) {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getCurrentEntityIdentity() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getCurrentEntityType() {
+        return 'unknown';
+    }
+    raiseEvent(eventName, eventArgs) {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getUrl() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    whenReady() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getWsConstructor() {
+        throw new Error('Method not implemented.');
+    }
+}
+exports.MockEnvironment = MockEnvironment;

package/src/mock.js

@@ -1,94 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fin = void 0;
-/* eslint-disable import/prefer-default-export */
-/* eslint-disable spaced-comment */
-/* eslint-disable @typescript-eslint/triple-slash-reference */
-/* eslint-disable @typescript-eslint/explicit-function-return-type */
-/* eslint-disable class-methods-use-this */
-const events_1 = require("events");
 const OpenFin = require("./OpenFin");
 const fin_1 = require("./api/fin");
 const transport_1 = require("./transport/transport");
-const me_1 = require("./api/me");
-class MockWire extends events_1.EventEmitter {
-    connect(address) {
-        throw new Error('You are not running in OpenFin.');
-    }
-    connectSync() {
-        throw new Error('You are not running in OpenFin.');
-    }
-    send(data) {
-        throw new Error('You are not running in OpenFin.');
-    }
-    shutdown() {
-        throw new Error('You are not running in OpenFin.');
-    }
-    getPort() {
-        throw new Error('This transport has no port');
-    }
-    // eslint-disable-next-line no-useless-constructor
-    constructor() {
-        super();
-    }
-}
-class MockEnvironment {
-    constructor() {
-        this.childViews = true;
-    }
-    getDefaultChannelOptions() {
-        throw new Error(me_1.environmentUnsupportedMessage);
-    }
-    getRtcPeer() {
-        throw new Error(me_1.environmentUnsupportedMessage);
-    }
-    getManagerConstructor() {
-        throw new Error(me_1.environmentUnsupportedMessage);
-    }
-    getProviderInitializer() {
-        throw new Error(me_1.environmentUnsupportedMessage);
-    }
-    writeToken(path, token) {
-        throw new Error(me_1.environmentUnsupportedMessage);
-    }
-    retrievePort(config) {
-        throw new Error(me_1.environmentUnsupportedMessage);
-    }
-    getNextMessageId() {
-        throw new Error(me_1.environmentUnsupportedMessage);
-    }
-    getRandomId() {
-        throw new Error(me_1.environmentUnsupportedMessage);
-    }
-    createChildContent(options) {
-        throw new Error(me_1.environmentUnsupportedMessage);
-    }
-    getWebWindow(identity) {
-        throw new Error(me_1.environmentUnsupportedMessage);
-    }
-    getCurrentEntityIdentity() {
-        throw new Error(me_1.environmentUnsupportedMessage);
-    }
-    getCurrentEntityType() {
-        return 'unknown';
-    }
-    raiseEvent(eventName, eventArgs) {
-        throw new Error(me_1.environmentUnsupportedMessage);
-    }
-    getUrl() {
-        throw new Error(me_1.environmentUnsupportedMessage);
-    }
-    whenReady() {
-        throw new Error(me_1.environmentUnsupportedMessage);
-    }
-    getWsConstructor() {
-        throw new Error('Method not implemented.');
-    }
-}
+const mockEnvironment_1 = require("./environment/mockEnvironment");
+const mockWire_1 = require("./transport/mockWire");
 exports.fin = ((typeof window !== 'undefined' && (window === null || window === void 0 ? void 0 : window.fin)) ||
     (() => {
-        const environment = new MockEnvironment();
-        const transport = new transport_1.Transport(MockWire, environment, {
+        const environment = new mockEnvironment_1.MockEnvironment();
+        const transport = new transport_1.Transport(mockWire_1.MockWire, environment, {
             uuid: '',
             name: ''
         });

package/src/shapes/protocol.d.ts

@@ -37,6 +37,22 @@ export interface ProtocolMap extends ProtocolMapBase {
     }>;
     'trigger-before-unload': IdentityCall<{}, boolean>;
     'window-get-views': IdentityCall<{}, OpenFin.Identity[]>;
+    'print': {
+        request: OpenFin.Identity & {
+            options: OpenFin.PrintOptions;
+        };
+        response: void;
+    };
+    'print-screenshot': {
+        request: OpenFin.Identity;
+        response: void;
+    };
+    'print-views': {
+        request: OpenFin.Identity & {
+            options: OpenFin.WindowViewsPrintOptions;
+        };
+        response: void;
+    };
     'launch-manifest': {
         request: {
             manifestUrl: string;
@@ -148,6 +164,7 @@ export interface ProtocolMap extends ProtocolMapBase {
         request: void;
         response: OpenFin.PrinterInfo[];
     };
+    'system-register-shutdown-handler': VoidCall;
 }
 type ApiCall<Request, Response> = {
     request: Request;

package/src/transport/mockWire.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { Wire } from './wire';
+export declare class MockWire extends EventEmitter implements Wire {
+    connect(address: string): Promise<any>;
+    connectSync(): any;
+    send(data: any): Promise<any>;
+    shutdown(): Promise<void>;
+    getPort(): string;
+    constructor();
+}

package/src/transport/mockWire.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockWire = void 0;
+const events_1 = require("events");
+class MockWire extends events_1.EventEmitter {
+    connect(address) {
+        throw new Error('You are not running in OpenFin.');
+    }
+    connectSync() {
+        throw new Error('You are not running in OpenFin.');
+    }
+    send(data) {
+        throw new Error('You are not running in OpenFin.');
+    }
+    shutdown() {
+        throw new Error('You are not running in OpenFin.');
+    }
+    getPort() {
+        throw new Error('This transport has no port');
+    }
+    // eslint-disable-next-line no-useless-constructor
+    constructor() {
+        super();
+    }
+}
+exports.MockWire = MockWire;

package/src/transport/transport-errors.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { ErrorPlainObject } from '../util/errors';
 export type ReadyState = 'CONNECTING' | 'OPEN' | 'CLOSING' | 'CLOSED';
 export declare class DisconnectedError extends Error {
@@ -18,6 +19,13 @@ export type RuntimeErrorPayload = {
     reason: string;
     error?: ErrorPlainObject;
 };
+declare class InternalError<T extends ErrorPlainObject = ErrorPlainObject> extends Error {
+    constructor(err: T);
+}
 export declare class RuntimeError extends Error {
-    constructor(payload: RuntimeErrorPayload);
+    cause?: InternalError;
+    static getCallSite(callsToRemove?: number): NodeJS.CallSite[];
+    static prepareStackTrace(err: Error, callSites: NodeJS.CallSite[]): string;
+    constructor(payload: RuntimeErrorPayload, callSites?: NodeJS.CallSite[]);
 }
+export {};