@openfin/core 30.73.27 → 31.74.1

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

@@ -1,7 +1,8 @@
 import type * as OpenFin from '../../OpenFin';
-import Transport from '../../transport/transport';
+import { Transport } from '../../transport/transport';
 import { WebContents } from '../webcontents/main';
 /**
+ * @PORTED
  * @typedef { object } Margins
  * @property { string } [marginType]
  * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
@@ -13,11 +14,13 @@ import { WebContents } from '../webcontents/main';
  * @property { number } [right] The right margin of the printed web page, in pixels.
  */
 /**
+ * @PORTED
  * @typedef { object } Dpi
  * @property { number } [horizontal] The horizontal dpi
  * @property { number } [vertical] The vertical dpi
  */
 /**
+ * @PORTED
  * @typedef { object } PrintOptions
  * @property { boolean } [silent=false] Don't ask user for print settings.
  * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
@@ -34,6 +37,7 @@ import { WebContents } from '../webcontents/main';
  * @property { Dpi } [dpi] Set dpi for the printed web page
  */
 /**
+ * @REMOVED
  * PrinterInfo interface
  * @typedef { object } PrinterInfo
  * @property { string } name Printer Name
@@ -42,12 +46,14 @@ import { WebContents } from '../webcontents/main';
  * @property { boolean } isDefault Indicates that system's default printer
  */
 /**
+ * @REMOVED
  * SharedWorkerInfo interface
  * @typedef { object } SharedWorkerInfo
  * @property { string } id The unique id of the shared worker.
  * @property { string } url The url of the shared worker.
  */
 /**
+ * @PORTED
  * ContentCreationRule interface
  * @typedef { object } ContentCreationRule
  * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
@@ -55,6 +61,7 @@ import { WebContents } from '../webcontents/main';
  * @property { object } options Window creation options or View creation options.
  */
 /**
+ * @PORTED
  * @typedef {object} Window~options
  * @summary Window creation options.
  * @desc This is the options object required by {@link Window.create Window.create}.
@@ -358,31 +365,37 @@ import { WebContents } from '../webcontents/main';
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
  */
 /**
+ * @PORTED
  * @typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
  * @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
  * @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
  * @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
  */
 /**
+ * @PORTED
  * @typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
  * @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
  * @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
  */
 /**
+ * @REMOVED
  * @typedef {Object} ShowViewsOnSplitterDrag _Platform Windows Only_. Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
  * @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
  */
 /**
+ * @REMOVED
  * @typedef {Object} ShowViewsOnTabDrag _Platform Windows Only_. Allows views to be shown when the user is manipulating the layout by repositioning a tab.
  * @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
  */
 /**
+ * @PORTED
  * @typedef {object} CapturePageOptions
  * @property { Area } [area] The area of the window to be captured.
  * @property { string } [format='png'] The format of the captured image.  Can be 'png', 'jpg', or 'bmp'.
  * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
  */
 /**
+ * @PORTED
  * @typedef { object } Area
  * @property { number } height Area's height
  * @property { number } width Area's width
@@ -390,6 +403,7 @@ import { WebContents } from '../webcontents/main';
  * @property { number } y Y coordinate of area's starting point
  */
 /**
+ * @PORTED
  * @typedef {object} FindInPageOptions
  * @property {boolean} [forward=true] Whether to search forward or backward.
  * @property {boolean} [findNext=false] Whether to begin a new text finding session. Should be true for first requests, and false for subsequent requests. Defaults to false.
@@ -400,18 +414,21 @@ import { WebContents } from '../webcontents/main';
  * lowercase or non-letter. Accepts several other intra-word matches.
  */
 /**
+ * @REMOVED
  * @typedef {object} Transition
  * @property {Opacity} opacity - The Opacity transition
  * @property {Position} position - The Position transition
  * @property {Size} size - The Size transition
  */
 /**
+ * @PORTED
  * @typedef {object} TransitionOptions
  * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
 this animation onto the end of the animation queue.
  * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
  */
 /**
+ * @PORTED
  * @typedef {object} Size
  * @property {number} duration - The total time in milliseconds this transition should take.
  * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
@@ -419,6 +436,7 @@ this animation onto the end of the animation queue.
  * @property {number} height - Optional if width is present. Defaults to the window's current height.
  */
 /**
+ * @PORTED
  * @typedef {object} Position
  * @property {number} duration - The total time in milliseconds this transition should take.
  * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
@@ -426,12 +444,14 @@ this animation onto the end of the animation queue.
  * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
  */
 /**
+ * @PORTED
  * @typedef {object} Opacity
  * @property {number} duration - The total time in milliseconds this transition should take.
  * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
  * @property {number} opacity - This value is clamped from 0.0 to 1.0.
  */
 /**
+ * @REMOVED
  * Bounds is a interface that has the properties of height,
  * width, left, top which are all numbers
  * @typedef { object } Bounds

package/src/api/window/Instance.js

@@ -9,6 +9,7 @@ const application_1 = require("../application");
 const main_1 = require("../webcontents/main");
 const view_1 = require("../view");
 /**
+ * @PORTED
  * @typedef { object } Margins
  * @property { string } [marginType]
  * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
@@ -20,11 +21,13 @@ const view_1 = require("../view");
  * @property { number } [right] The right margin of the printed web page, in pixels.
  */
 /**
+ * @PORTED
  * @typedef { object } Dpi
  * @property { number } [horizontal] The horizontal dpi
  * @property { number } [vertical] The vertical dpi
  */
 /**
+ * @PORTED
  * @typedef { object } PrintOptions
  * @property { boolean } [silent=false] Don't ask user for print settings.
  * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
@@ -41,6 +44,7 @@ const view_1 = require("../view");
  * @property { Dpi } [dpi] Set dpi for the printed web page
  */
 /**
+ * @REMOVED
  * PrinterInfo interface
  * @typedef { object } PrinterInfo
  * @property { string } name Printer Name
@@ -49,12 +53,14 @@ const view_1 = require("../view");
  * @property { boolean } isDefault Indicates that system's default printer
  */
 /**
+ * @REMOVED
  * SharedWorkerInfo interface
  * @typedef { object } SharedWorkerInfo
  * @property { string } id The unique id of the shared worker.
  * @property { string } url The url of the shared worker.
  */
 /**
+ * @PORTED
  * ContentCreationRule interface
  * @typedef { object } ContentCreationRule
  * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
@@ -62,6 +68,7 @@ const view_1 = require("../view");
  * @property { object } options Window creation options or View creation options.
  */
 /**
+ * @PORTED
  * @typedef {object} Window~options
  * @summary Window creation options.
  * @desc This is the options object required by {@link Window.create Window.create}.
@@ -365,31 +372,37 @@ const view_1 = require("../view");
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
  */
 /**
+ * @PORTED
  * @typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
  * @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
  * @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
  * @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
  */
 /**
+ * @PORTED
  * @typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
  * @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
  * @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
  */
 /**
+ * @REMOVED
  * @typedef {Object} ShowViewsOnSplitterDrag _Platform Windows Only_. Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
  * @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
  */
 /**
+ * @REMOVED
  * @typedef {Object} ShowViewsOnTabDrag _Platform Windows Only_. Allows views to be shown when the user is manipulating the layout by repositioning a tab.
  * @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
  */
 /**
+ * @PORTED
  * @typedef {object} CapturePageOptions
  * @property { Area } [area] The area of the window to be captured.
  * @property { string } [format='png'] The format of the captured image.  Can be 'png', 'jpg', or 'bmp'.
  * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
  */
 /**
+ * @PORTED
  * @typedef { object } Area
  * @property { number } height Area's height
  * @property { number } width Area's width
@@ -397,6 +410,7 @@ const view_1 = require("../view");
  * @property { number } y Y coordinate of area's starting point
  */
 /**
+ * @PORTED
  * @typedef {object} FindInPageOptions
  * @property {boolean} [forward=true] Whether to search forward or backward.
  * @property {boolean} [findNext=false] Whether to begin a new text finding session. Should be true for first requests, and false for subsequent requests. Defaults to false.
@@ -407,18 +421,21 @@ const view_1 = require("../view");
  * lowercase or non-letter. Accepts several other intra-word matches.
  */
 /**
+ * @REMOVED
  * @typedef {object} Transition
  * @property {Opacity} opacity - The Opacity transition
  * @property {Position} position - The Position transition
  * @property {Size} size - The Size transition
  */
 /**
+ * @PORTED
  * @typedef {object} TransitionOptions
  * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
 this animation onto the end of the animation queue.
  * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
  */
 /**
+ * @PORTED
  * @typedef {object} Size
  * @property {number} duration - The total time in milliseconds this transition should take.
  * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
@@ -426,6 +443,7 @@ this animation onto the end of the animation queue.
  * @property {number} height - Optional if width is present. Defaults to the window's current height.
  */
 /**
+ * @PORTED
  * @typedef {object} Position
  * @property {number} duration - The total time in milliseconds this transition should take.
  * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
@@ -433,12 +451,14 @@ this animation onto the end of the animation queue.
  * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
  */
 /**
+ * @PORTED
  * @typedef {object} Opacity
  * @property {number} duration - The total time in milliseconds this transition should take.
  * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
  * @property {number} opacity - This value is clamped from 0.0 to 1.0.
  */
 /**
+ * @REMOVED
  * Bounds is a interface that has the properties of height,
  * width, left, top which are all numbers
  * @typedef { object } Bounds

package/src/browser.js

@@ -16,7 +16,7 @@ async function getRemoteConnectionPayload(fin, uuid = `browser-connection-${Math
 }
 exports.getRemoteConnectionPayload = getRemoteConnectionPayload;
 async function remoteConnect({ uuid, token, address, interopProviderId, withInterop }) {
-    const wire = new transport_1.default(websocket_1.default, new browser_1.BrowserEnvironment(), {
+    const wire = new transport_1.Transport(websocket_1.default, new browser_1.BrowserEnvironment(), {
         uuid,
         name: uuid
     });

package/src/mock.js

@@ -85,7 +85,7 @@ class MockEnvironment {
 exports.fin = ((typeof window !== 'undefined' && (window === null || window === void 0 ? void 0 : window.fin)) ||
     (() => {
         const environment = new MockEnvironment();
-        const transport = new transport_1.default(MockWire, environment, {
+        const transport = new transport_1.Transport(MockWire, environment, {
             uuid: '',
             name: ''
         });

package/src/namespaces.d.ts

@@ -0,0 +1,21 @@
+export * as OpenFin from './OpenFin';
+export * as Application from './api/application';
+export * as ExternalApplication from './api/external-application';
+export * as Frame from './api/frame';
+export * as Interop from './api/interop';
+export * as InteropBroker from './api/interop/InteropBroker';
+export * as InteropClient from './api/interop/InteropClient';
+export * as InterApplicationBus from './api/interappbus';
+export * as Channel from './api/interappbus/channel';
+export * as ChannelProvider from './api/interappbus/channel/provider';
+export * as ChannelClient from './api/interappbus/channel/client';
+export * as Platform from './api/platform';
+export * as PlatformProvider from './api/platform/provider';
+export * as Layout from './api/platform/layout';
+export * as View from './api/view';
+export * as Window from './api/window';
+export * as SnapshotSource from './api/snapshot-source';
+export * as GlobalHotkey from './api/global-hotkey';
+export * as Clipboard from './api/clipboard';
+export * as Fin from './api/fin';
+export * as System from './api/system';

package/src/namespaces.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.System = exports.Fin = exports.Clipboard = exports.GlobalHotkey = exports.SnapshotSource = exports.Window = exports.View = exports.Layout = exports.PlatformProvider = exports.Platform = exports.ChannelClient = exports.ChannelProvider = exports.Channel = exports.InterApplicationBus = exports.InteropClient = exports.InteropBroker = exports.Interop = exports.Frame = exports.ExternalApplication = exports.Application = exports.OpenFin = void 0;
+exports.OpenFin = require("./OpenFin");
+exports.Application = require("./api/application");
+exports.ExternalApplication = require("./api/external-application");
+exports.Frame = require("./api/frame");
+exports.Interop = require("./api/interop");
+exports.InteropBroker = require("./api/interop/InteropBroker");
+exports.InteropClient = require("./api/interop/InteropClient");
+exports.InterApplicationBus = require("./api/interappbus");
+exports.Channel = require("./api/interappbus/channel");
+exports.ChannelProvider = require("./api/interappbus/channel/provider");
+exports.ChannelClient = require("./api/interappbus/channel/client");
+exports.Platform = require("./api/platform");
+exports.PlatformProvider = require("./api/platform/provider");
+exports.Layout = require("./api/platform/layout");
+exports.View = require("./api/view");
+exports.Window = require("./api/window");
+exports.SnapshotSource = require("./api/snapshot-source");
+exports.GlobalHotkey = require("./api/global-hotkey");
+exports.Clipboard = require("./api/clipboard");
+exports.Fin = require("./api/fin");
+exports.System = require("./api/system");

package/src/transport/fin_store.d.ts

@@ -1,4 +1,4 @@
 import Fin from '../api/fin';
-import Transport from './transport';
+import { Transport } from './transport';
 export declare function registerFin(wire: Transport, fin: Fin): void;
 export declare function getFin(wire: Transport): Fin;

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

@@ -1,3 +1,4 @@
+import { ErrorPlainObject } from '../util/errors';
 export declare type ReadyState = 'CONNECTING' | 'OPEN' | 'CLOSING' | 'CLOSED';
 export declare class DisconnectedError extends Error {
     constructor(readyState: ReadyState);
@@ -13,6 +14,10 @@ export declare class NotImplementedError extends Error {
 }
 export declare class NotSupportedError extends Error {
 }
+export declare type RuntimeErrorPayload = {
+    reason: string;
+    error?: ErrorPlainObject;
+};
 export declare class RuntimeError extends Error {
-    constructor(data: any);
+    constructor(payload: RuntimeErrorPayload);
 }

package/src/transport/transport-errors.js

@@ -24,8 +24,7 @@ class NotSupportedError extends Error {
 }
 exports.NotSupportedError = NotSupportedError;
 class RuntimeError extends Error {
-    constructor(data) {
-        const payload = data.payload || data;
+    constructor(payload) {
         const { reason, error } = payload;
         super(reason);
         this.name = 'RuntimeError';

package/src/transport/transport.d.ts

@@ -7,9 +7,10 @@ import EventAggregator from '../api/events/eventAggregator';
 import { EntityTypeHelpers } from '../api/me';
 import { ProtocolMap } from '../shapes/protocol';
 import { NamedEvent } from '../api/events/base';
+import { ErrorPlainObject } from '../util/errors';
 declare type EntityType = OpenFin.EntityType;
 export declare type MessageHandler = (data: any) => boolean;
-declare class Transport<MeType extends EntityType = EntityType> extends EventEmitter {
+export declare class Transport<MeType extends EntityType = EntityType> extends EventEmitter {
     #private;
     protected wireListeners: Map<number, {
         resolve: Function;
@@ -39,7 +40,6 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
     protected onmessage(data: Message<Payload>): void;
     protected handleMessage(data: Message<Payload>): boolean;
 }
-export default Transport;
 export interface Message<T> {
     action: string;
     payload: T;
@@ -49,11 +49,14 @@ export interface EventMessage extends Message<NamedEvent> {
     action: 'process-desktop-event';
     payload: NamedEvent;
 }
-export interface Payload {
-    success: boolean;
-    data: any;
-}
+export declare type Payload<Success extends boolean = boolean, Data = any> = {
+    success: Success;
+    data: Success extends true ? Data : never;
+    reason: Success extends false ? string : never;
+    error?: Success extends false ? ErrorPlainObject | undefined : never;
+};
 export interface AuthorizationPayload {
     token: string;
     file: string;
 }
+export {};

package/src/transport/transport.js

@@ -12,6 +12,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _Transport_wire;
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Transport = void 0;
 const events_1 = require("events");
 const wire_1 = require("./wire");
 const transport_errors_1 = require("./transport-errors");
@@ -168,7 +169,15 @@ class Transport extends events_1.EventEmitter {
                 reject(new transport_errors_1.NoAckError(data.action));
             }
             else if (!('payload' in data)) {
-                reject(new transport_errors_1.RuntimeError(data));
+                // I'm not sure when this code would actually run, but passing in something that doeesn't have a reason to the runtimeerror constructor will not end well.
+                // @ts-expect-error
+                if (typeof data.reason === 'string') {
+                    reject(new transport_errors_1.RuntimeError(data));
+                }
+                else {
+                    console.warn('Received invalid response from core', data);
+                    reject(new Error('Invalid response'));
+                }
             }
             else if (!data.payload.success) {
                 reject(new transport_errors_1.RuntimeError(data.payload));
@@ -181,5 +190,5 @@ class Transport extends events_1.EventEmitter {
         return true;
     }
 }
+exports.Transport = Transport;
 _Transport_wire = new WeakMap();
-exports.default = Transport;

package/src/util/inaccessibleObject.d.ts

@@ -0,0 +1,2 @@
+export declare function createUnusableObject(message: string): Record<any, never>;
+export declare function createWarningObject<T extends {}>(message: string, obj: T): T;

package/src/util/inaccessibleObject.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createWarningObject = exports.createUnusableObject = void 0;
+function createUnusableObject(message) {
+    const handle = () => {
+        throw new Error(message);
+    };
+    return new Proxy({}, {
+        apply: handle,
+        construct: handle,
+        defineProperty: handle,
+        deleteProperty: handle,
+        get: handle,
+        getOwnPropertyDescriptor: handle,
+        getPrototypeOf: handle,
+        has: handle,
+        isExtensible: handle,
+        ownKeys: handle,
+        preventExtensions: handle,
+        set: handle,
+        setPrototypeOf: handle
+    });
+}
+exports.createUnusableObject = createUnusableObject;
+function createWarningObject(message, obj) {
+    return new Proxy(obj, {
+        get: (...args) => {
+            // eslint-disable-next-line no-console
+            console.warn(message);
+            return Reflect.get(...args);
+        },
+        set: (...args) => {
+            // eslint-disable-next-line no-console
+            console.warn(message);
+            return Reflect.set(...args);
+        },
+        getOwnPropertyDescriptor: (...args) => {
+            // eslint-disable-next-line no-console
+            console.warn(message);
+            return Reflect.getOwnPropertyDescriptor(...args);
+        },
+        ownKeys: (...args) => {
+            // eslint-disable-next-line no-console
+            console.warn(message);
+            return Reflect.ownKeys(...args);
+        }
+    });
+}
+exports.createWarningObject = createWarningObject;