@openfin/core 31.74.31 → 32.75.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "31.74.31",
+    "version": "32.75.1",
     "license": "SEE LICENSE IN LICENSE.MD",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

package/src/OpenFin.d.ts

@@ -1,20 +1,20 @@
-import type { Application } from './api/application';
+import type { Application } from './api/application/index';
 import { AppVersionEvent } from './api/events/system';
 import { TypedEventEmitter } from './api/events/typedEventEmitter';
-import type { ExternalApplication } from './api/external-application';
+import type { ExternalApplication } from './api/external-application/index';
 import { FinApi } from './api/fin';
-import type { _Frame } from './api/frame';
+import type { _Frame } from './api/frame/index';
 import type ChannelClient from './api/interappbus/channel/client';
-import { MessagingProtocols } from './api/interappbus/channel/protocols';
+import { MessagingProtocols } from './api/interappbus/channel/protocols/index';
 import type { ChannelProvider } from './api/interappbus/channel/provider';
-import type { InteropBroker, InteropClient } from './api/interop';
-import type { Platform } from './api/platform';
-import type { Layout } from './api/platform/layout';
-import type { ColumnOrRow, TabStack } from './api/platform/layout/entities/layout-entities';
+import type { InteropBroker, InteropClient } from './api/interop/index';
+import type { Platform } from './api/platform/index';
+import type { Layout } from './api/platform/layout/index';
 import { PlatformProvider } from './api/platform/provider';
-import { SnapshotSource } from './api/snapshot-source';
-import type { View } from './api/view';
-import { _Window } from './api/window';
+import { SnapshotSource } from './api/snapshot-source/index';
+import type { View } from './api/view/index';
+import { _Window } from './api/window/index';
+import { ColumnOrRow, TabStack } from './api/platform/layout/entities/layout-entities';
 export type Fin<MeType extends EntityType = 'window' | 'view'> = FinApi<MeType>;
 export type { Application, ExternalApplication, _Frame as Frame, ChannelClient, ChannelProvider, Platform, Layout, View, ColumnOrRow, TabStack, _Window as Window, InteropClient, InteropBroker, SnapshotSource };
 export type { LayoutEntityDefinition, LayoutEntityTypes, LayoutPosition } from './api/platform/layout/entities/shapes';
@@ -246,7 +246,7 @@ export type DisplayMetadata = {
      */
     readonly glyph?: string;
 };
-export 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'>;
+export 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'>;
 export type Snapshot = {
     windows: WindowCreationOptions[];
     snapshotDetails?: {
@@ -794,6 +794,11 @@ export type MutableWindowOptions = {
      */
     showTaskbarIcon: boolean;
     interop: InteropConfig;
+    /**
+     * @internal
+     * Used by Workspace to store custom data. Overwriting or modifying this field may impact the functionality of Workspace
+     */
+    _internalWorkspaceData: any;
     workspacePlatform: WorkspacePlatformOptions;
 };
 export type WorkspacePlatformOptions = {
@@ -1193,6 +1198,11 @@ export type MutableViewOptions = {
      */
     preventDragOut: boolean;
     interop?: InteropConfig;
+    /**
+     * @internal
+     * Used by Workspace to store custom data. Overwriting or modifying this field may impact the functionality of Workspace
+     */
+    _internalWorkspaceData: any;
 };
 /**
  * User-facing options for a view.
@@ -1423,6 +1433,7 @@ export type GetWindowContextPayload = {
 };
 export type ApplicationPermissions = {
     setFileDownloadLocation: boolean;
+    getFileDownloadLocation: boolean;
 };
 export type LaunchExternalProcessRule = {
     behavior: 'allow' | 'block';
@@ -1913,6 +1924,7 @@ export type Margins = {
  * Options for printing a webpage in OpenFin.
  */
 export type PrintOptions = {
+    content?: 'self';
     /**
      * Disables prompting the user for print settings.
      */
@@ -1956,7 +1968,7 @@ export type PrintOptions = {
     /**
      * Page range to print.
      */
-    pageRanges?: Record<'from' | 'to', number>;
+    pageRanges?: Array<Record<'from' | 'to', number>>;
     /**
      * Duplex mode of the printed webpage.
      */
@@ -1966,6 +1978,14 @@ export type PrintOptions = {
      */
     dpi?: Dpi;
 };
+export type ScreenshotPrintOptions = {
+    content: 'screenshot';
+};
+export type WindowViewsPrintOptions = {
+    content: 'views';
+    includeSelf?: boolean;
+};
+export type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
 /**
  * A request to write data to the clipboard.
  */
@@ -2233,6 +2253,7 @@ export type FindInPageResult = {
 export type FrameInfo = {
     name: string;
     uuid: string;
+    url: string;
     entityType: EntityType;
     parent: Identity;
 };
@@ -2909,6 +2930,9 @@ export interface PopupResult<T = any> {
     data?: T;
     lastDispatchResult?: PopupResult;
 }
+export type SystemShutdownHandler = (shutdownEvent: {
+    proceed: () => void;
+}) => void;
 export type AppVersionProgressEvent = {
     type: 'app-version-progress';
 } & AppVersionProgress;
@@ -2971,3 +2995,24 @@ export interface InteropActionLoggingOption {
 export type InteropLoggingActions = 'beforeAction' | 'afterAction';
 export type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
 export type { Me } from './api/me';
+/**
+ * Configuration for page capture.
+ */
+export interface CapturePageOptions {
+    /**
+     * The area of the window to be captured.
+     */
+    area?: 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;
+}

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

@@ -300,10 +300,22 @@ export declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
      */
     getProcessInfo(): Promise<OpenFin.AppProcessInfo>;
     /**
-     * Sets file auto download location.
+     * Sets file auto download location. It's only allowed in the same application.
+     * Note: This method is restricted by default and must be enabled via
+     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
      * @param { string } downloadLocation file auto download location
      * @return {Promise.<void>}
+     * @throws if setting file auto download location on different applications.
      * @tutorial Application.setFileDownloadLocation
      */
     setFileDownloadLocation(downloadLocation: string): Promise<void>;
+    /**
+     * Gets file auto download location. It's only allowed in the same application. If file auto download location is not set, it will return the default location.
+     * Note: This method is restricted by default and must be enabled via
+     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
+     * @return {Promise.<string>}
+     * @throws if getting file auto download location on different applications.
+     * @tutorial Application.getFileDownloadLocation
+     */
+    getFileDownloadLocation(): Promise<string>;
 }

package/src/api/application/Instance.js

@@ -141,11 +141,26 @@ class Application extends base_1.EmitterBase {
      * @tutorial Application.quit
      */
     async quit(force = false) {
-        await this._close(force);
-        await this.wire.sendAction('destroy-application', { force, ...this.identity });
-    }
-    _close(force = false) {
-        return this.wire.sendAction('close-application', { force, ...this.identity }).then(() => undefined);
+        try {
+            await this._close(force);
+            await this.wire.sendAction('destroy-application', { force, ...this.identity });
+        }
+        catch (error) {
+            const acceptableErrors = ['Remote connection has closed', 'Could not locate the requested application'];
+            if (!acceptableErrors.some((msg) => error.message.includes(msg))) {
+                throw error;
+            }
+        }
+    }
+    async _close(force = false) {
+        try {
+            await this.wire.sendAction('close-application', { force, ...this.identity });
+        }
+        catch (error) {
+            if (!error.message.includes('Remote connection has closed')) {
+                throw error;
+            }
+        }
     }
     close(force = false) {
         console.warn('Deprecation Warning: Application.close is deprecated Please use Application.quit');
@@ -409,13 +424,30 @@ class Application extends base_1.EmitterBase {
         return data;
     }
     /**
-     * Sets file auto download location.
+     * Sets file auto download location. It's only allowed in the same application.
+     * Note: This method is restricted by default and must be enabled via
+     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
      * @param { string } downloadLocation file auto download location
      * @return {Promise.<void>}
+     * @throws if setting file auto download location on different applications.
      * @tutorial Application.setFileDownloadLocation
      */
     async setFileDownloadLocation(downloadLocation) {
-        await this.wire.sendAction('set-file-download-location', { downloadLocation, ...this.identity });
+        const { name } = this.wire.me;
+        const entityIdentity = { uuid: this.identity.uuid, name };
+        await this.wire.sendAction('set-file-download-location', { ...entityIdentity, downloadLocation });
+    }
+    /**
+     * Gets file auto download location. It's only allowed in the same application. If file auto download location is not set, it will return the default location.
+     * Note: This method is restricted by default and must be enabled via
+     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
+     * @return {Promise.<string>}
+     * @throws if getting file auto download location on different applications.
+     * @tutorial Application.getFileDownloadLocation
+     */
+    async getFileDownloadLocation() {
+        const { payload: { data } } = await this.wire.sendAction('get-file-download-location', this.identity);
+        return data;
     }
 }
 exports.Application = Application;

package/src/api/base.d.ts

@@ -2,14 +2,13 @@
 import { EventEmitter } from 'events';
 import { Transport } from '../transport/transport';
 import type * as OpenFin from '../OpenFin';
-import Fin from './fin';
 import { BaseEvent, EventHandler } from './events/base';
 type ApplicationIdentity = OpenFin.ApplicationIdentity;
 type Identity = OpenFin.Identity;
 export declare class Base {
     wire: Transport;
     constructor(wire: Transport);
-    protected get fin(): Fin;
+    protected get fin(): OpenFin.Fin<OpenFin.EntityType>;
     get me(): Identity;
     protected isNodeEnvironment: () => boolean;
     protected isOpenFinEnvironment: () => boolean;

package/src/api/base.js

@@ -14,7 +14,6 @@ var _EmitterBase_emitterAccessor;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Reply = exports.EmitterBase = exports.Base = void 0;
 const promises_1 = require("../util/promises");
-const fin_store_1 = require("../transport/fin_store");
 class Base {
     constructor(wire) {
         this.isNodeEnvironment = () => {
@@ -29,7 +28,7 @@ class Base {
         this.wire = wire;
     }
     get fin() {
-        return (0, fin_store_1.getFin)(this.wire);
+        return this.wire.getFin();
     }
     get me() {
         return this.wire.me;

package/src/api/events/application.d.ts

@@ -11,6 +11,9 @@ export type CrashedEvent = NamedEvent & {
         exitCode: number;
     };
 };
+export type FileDownloadLocationChangedEvent = NamedEvent & {
+    type: 'file-download-location-changed';
+};
 export type RunRequestedEvent = IdentityEvent & {
     type: 'run-requested';
     userAppConfigArgs: Record<string, any>;
@@ -70,7 +73,7 @@ export type StartedEvent = IdentityEvent & {
 /**
  * An Application event that does propagate to (republish on) parent topics.
  */
-export type WillPropagateApplicationEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent | StartedEvent | TrayIconClickedEvent;
+export type WillPropagateApplicationEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
 export type ApplicationEvent = {
     topic: 'application';
 } & (PropagatedViewEvent | PropagatedWindowEvent | ApplicationWindowEvent | WillPropagateApplicationEvent);

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

@@ -1,6 +1,6 @@
 import type * as OpenFin from '../../OpenFin';
 import { PropagatedApplicationEvent } from './application';
-import { BaseEvent } from './base';
+import { BaseEvent, IdentityEvent } from './base';
 import { PropagatedViewEvent } from './view';
 import { PropagatedWindowEvent } from './window';
 import { AppVersionCompleteEvent, AppVersionErrorEvent, AppVersionProgressEvent, AppVersionRuntimeStatusEvent } from '../../OpenFin';
@@ -38,13 +38,16 @@ export type EventWithId<Event extends AppVersionEvent> = Event extends infer E e
     appVersionId: string;
 } : never;
 export type AppVersionEventWithId = EventWithId<AppVersionEvent>;
-export type ApplicationCreatedEvent = BaseEvent & {
+export type ApplicationCreatedEvent = IdentityEvent & {
     type: 'application-created';
 };
 export type DesktopIconClickedEvent = BaseEvent & {
     type: 'desktop-icon-clicked';
 };
+export type SystemShutdownEvent = BaseEvent & {
+    type: 'system-shutdown';
+};
 export type SystemEvent = {
     topic: 'system';
-} & (ExcludeRequested<PropagatedWindowEvent> | PropagatedViewEvent | PropagatedApplicationEvent | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId);
+} & (ExcludeRequested<PropagatedWindowEvent> | PropagatedViewEvent | PropagatedApplicationEvent | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent);
 export type SystemEventType = SystemEvent['type'];

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

@@ -67,10 +67,6 @@ export type FoundInPageEvent = NamedEvent & {
 } & {
     result: OpenFin.FindInPageResult;
 };
-/**
- * A WebContents event that does not propagate to (republish on) parent topics.
- */
-export type NonPropagatedWebContentsEvent = FoundInPageEvent | CertificateErrorEvent;
 export type BlurredEvent = NamedEvent & {
     type: 'blurred';
 };
@@ -89,9 +85,62 @@ export type ChildContentOpenedInBrowserEvent = NamedEvent & {
 export type ChildViewCreatedEvent = NamedEvent & {
     type: 'child-view-created';
 };
+export type FileDownloadEvent = NamedEvent & {
+    state: 'started' | 'progressing' | 'cancelled' | 'interrupted' | 'completed';
+    /**
+     * The url from which the file is being downloaded.
+     */
+    url: string;
+    mimeType: string;
+    /**
+     * Name used to save the file locally.
+     */
+    fileName: string;
+    /**
+     * Original name of the file.
+     */
+    originalFileName: string;
+    totalBytes: number;
+    /**
+     * The number of seconds since the UNIX epoch when the download was started.
+     */
+    startTime: number;
+    /**
+     * The value of the Content-Disposition field from the response header.
+     */
+    contentDisposition: string;
+    /**
+     * The value of the Last-Modified header.
+     */
+    lastModifiedTime: Date;
+    /**
+     * The value of the ETag header.
+     */
+    eTag: string;
+    /**
+     * The number of bytes of the item that have already been downloaded.
+     */
+    downloadedBytes: number;
+};
+export type FileDownloadStartedEvent = FileDownloadEvent & {
+    type: 'file-download-started';
+    state: 'started';
+};
+export type FileDownloadProgressEvent = FileDownloadEvent & {
+    type: 'file-download-progress';
+    state: 'progressing' | 'interrupted';
+};
+export type FileDownloadCompletedEvent = FileDownloadEvent & {
+    type: 'file-download-completed';
+    state: 'completed' | 'interrupted' | 'cancelled';
+};
 /**
  * A WebContents event that does propagate to (republish on) parent topics.
  */
-export type WillPropagateWebContentsEvent = BlurredEvent | CertificateSelectionShownEvent | CrashedEvent | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent;
+export type WillPropagateWebContentsEvent = BlurredEvent | CertificateSelectionShownEvent | CrashedEvent | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent;
+/**
+ * A WebContents event that does not propagate to (republish on) parent topics.
+ */
+export type NonPropagatedWebContentsEvent = FoundInPageEvent | CertificateErrorEvent;
 export type WebContentsEvent = NonPropagatedWebContentsEvent | WillPropagateWebContentsEvent;
 export {};

package/src/api/fin.js

@@ -13,13 +13,11 @@ const index_8 = require("./global-hotkey/index");
 const index_9 = require("./view/index");
 const index_10 = require("./platform/index");
 const me_1 = require("./me");
-const fin_store_1 = require("../transport/fin_store");
 const interop_1 = require("./interop");
 const snapshot_source_1 = require("./snapshot-source");
 class Fin extends events_1.EventEmitter {
     constructor(wire) {
         super();
-        (0, fin_store_1.registerFin)(wire, this);
         this.wire = wire;
         this.System = new index_1.default(wire);
         this.Window = new index_2.default(wire);
@@ -33,6 +31,7 @@ class Fin extends events_1.EventEmitter {
         this.View = new index_9.default(wire);
         this.Interop = new interop_1.default(wire);
         this.SnapshotSource = new snapshot_source_1.default(wire);
+        wire.registerFin(this);
         this.me = (0, me_1.getMe)(wire);
         // Handle disconnect events
         wire.on('disconnected', () => {

package/src/api/interappbus/channel/client.d.ts

@@ -4,9 +4,9 @@ import { Transport } from '../../../transport/transport';
 import { AnyStrategy } from './protocols/strategy-types';
 type ProviderIdentity = OpenFin.ProviderIdentity;
 type DisconnectionListener = (providerIdentity: ProviderIdentity) => any;
-interface RoutingInfo extends ProviderIdentity {
+export type RoutingInfo = ProviderIdentity & {
     endpointId: string;
-}
+};
 export default class ChannelClient extends ChannelBase {
     #private;
     private disconnectListener;

package/src/api/interappbus/channel/index.d.ts

@@ -1,9 +1,9 @@
 import type * as OpenFin from '../../../OpenFin';
-import ChannelClient from './client';
-import { ChannelProvider } from './provider';
+import { Message, Transport } from '../../../transport/transport';
 import { EmitterBase } from '../../base';
-import { Transport, Message } from '../../../transport/transport';
 import { ChannelEvent } from '../../events/channel';
+import ChannelClient from './client';
+import { ChannelProvider } from './provider';
 type ProviderIdentity = OpenFin.ProviderIdentity;
 type Identity = OpenFin.Identity;
 export interface ChannelMessage extends Message<any> {
@@ -18,6 +18,7 @@ export declare class Channel extends EmitterBase<ChannelEvent> {
     getAllChannels(): Promise<ProviderIdentity[]>;
     onChannelConnect(listener: (...args: any[]) => void): Promise<void>;
     onChannelDisconnect(listener: (...args: any[]) => void): Promise<void>;
+    private safeConnect;
     connect(channelName: string, options?: OpenFin.ChannelConnectOptions): Promise<ChannelClient>;
     create(channelName: string, options?: OpenFin.ChannelCreateOptions): Promise<ChannelProvider>;
 }