@openfin/core 30.73.23 → 30.73.24

package/src/api/webcontents/main.js

@@ -92,6 +92,8 @@ class WebContents extends base_1.EmitterBase {
                     throw new Error(`Something went wrong during onPopupReady execution: ${error}`);
                 }
             };
+            // TODO: fix typing (internal)
+            // @ts-expect-error
             await this.once('popup-ready', readyListener);
         }
         const { payload: tryCreatePayload } = await this.wire.sendAction('try-create-popup-window', {
@@ -130,9 +132,17 @@ class WebContents extends base_1.EmitterBase {
                 await options.onPopupResult(normalizePopupResult(payload));
             };
             const teardownListener = async () => {
+                // TODO: fix typing (internal)
+                // @ts-expect-error
                 await this.removeListener('popup-result', dispatchResultListener);
             };
+            // TODO: fix typing (internal)
+            // @ts-expect-error
             await this.on('popup-result', dispatchResultListener);
+            // TODO: fix typing (internal)
+            // hilariously this does not need a ts-expect-error - this is gap in type soundness
+            // should investigate - probably due to `teardownListener` taking a void argument
+            // which might play nicely with the `never` type?  huh...
             await this.once('popup-teardown', teardownListener);
         }
         const { payload } = await this.wire.sendAction('show-popup-window', {

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

@@ -1,8 +1,8 @@
 import type * as OpenFin from '../../OpenFin';
 import Transport from '../../transport/transport';
 import { WebContents } from '../webcontents/main';
-declare type WindowEvents = OpenFin.WindowEvents;
 /**
+ * @PORTED
  * @typedef { object } Margins
  * @property { string } [marginType]
  * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
@@ -14,11 +14,13 @@ declare type WindowEvents = OpenFin.WindowEvents;
  * @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.
@@ -35,6 +37,7 @@ declare type WindowEvents = OpenFin.WindowEvents;
  * @property { Dpi } [dpi] Set dpi for the printed web page
  */
 /**
+ * @REMOVED
  * PrinterInfo interface
  * @typedef { object } PrinterInfo
  * @property { string } name Printer Name
@@ -43,12 +46,14 @@ declare type WindowEvents = OpenFin.WindowEvents;
  * @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'
@@ -56,6 +61,7 @@ declare type WindowEvents = OpenFin.WindowEvents;
  * @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}.
@@ -359,31 +365,37 @@ declare type WindowEvents = OpenFin.WindowEvents;
  * _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
@@ -391,6 +403,7 @@ declare type WindowEvents = OpenFin.WindowEvents;
  * @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.
@@ -401,18 +414,21 @@ declare type WindowEvents = OpenFin.WindowEvents;
  * 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.
@@ -420,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.
@@ -427,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
@@ -453,7 +472,7 @@ this animation onto the end of the animation queue.
  * @alias Window
  * @hideconstructor
  */
-export declare class _Window extends WebContents<WindowEvents> {
+export declare class _Window extends WebContents<OpenFin.WindowEvent> {
     identity: OpenFin.Identity;
     constructor(wire: Transport, identity: OpenFin.Identity);
     /**
@@ -1053,4 +1072,3 @@ export declare class _Window extends WebContents<WindowEvents> {
      */
     dispatchPopupResult(data: any): Promise<void>;
 }
-export {};

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
@@ -719,6 +739,8 @@ class _Window extends main_1.WebContents {
             const CONSTRUCTOR_CB_TOPIC = 'fire-constructor-callback';
             // need to call pageResponse, otherwise when a child window is created, page is not loaded
             const pageResponse = new Promise((resolve) => {
+                // TODO: fix typing (internal)
+                // @ts-expect-error
                 this.on(CONSTRUCTOR_CB_TOPIC, function fireConstructor(response) {
                     let cbPayload;
                     const { success } = response;

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/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

@@ -3,10 +3,11 @@ import { EventEmitter } from 'events';
 import type * as OpenFin from '../OpenFin';
 import { ExistingConnectConfig, InternalConnectConfig, RemoteConfig, Wire, WireConstructor } from './wire';
 import { Environment } from '../environment/environment';
-import { RuntimeEvent } from '../api/events/base';
 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 {
@@ -45,14 +46,16 @@ export interface Message<T> {
     payload: T;
     correlationId?: number;
 }
-export interface EventMessage extends Message<RuntimeEvent> {
+export interface EventMessage extends Message<NamedEvent> {
     action: 'process-desktop-event';
-    payload: RuntimeEvent;
-}
-export interface Payload {
-    success: boolean;
-    data: any;
+    payload: NamedEvent;
 }
+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;

package/src/transport/transport.js

@@ -168,7 +168,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));

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;