@openfin/core 31.74.10 → 31.74.14

package/package.json

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

package/src/OpenFin.d.ts

@@ -2199,6 +2199,22 @@ export type FindInPageOptions = {
      */
     medialCapitalAsWordStart?: boolean;
 };
+export type FindInPageResult = {
+    requestId: number;
+    /**
+     * Position of the active match.
+     */
+    activeMatchOrdinal: number;
+    /**
+     * Number of Matches.
+     */
+    matches: number;
+    /**
+     * Coordinates of first match region.
+     */
+    selectionArea: Rectangle;
+    finalUpdate: boolean;
+};
 export type FrameInfo = {
     name: string;
     uuid: string;

package/src/api/application/Factory.js

@@ -204,7 +204,7 @@ class ApplicationModule extends base_1.Base {
         });
         const app = await this._createFromManifest(manifestUrl);
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore using private method without warning.
+        // @ts-expect-error using private method without warning.
         await app._run(opts); // eslint-disable-line no-underscore-dangle
         return app;
     }

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

@@ -1,4 +1,3 @@
-import type * as OpenFin from '../../OpenFin';
 /**
  * Modifies an event key to reflect propagation by prefixing with the topic.
  */
@@ -13,8 +12,6 @@ export type PropagatedEvent<Topic extends string, Event extends {
     type: string;
 } ? Omit<E, 'type'> & {
     type: PropagatedEventType<Topic, E['type']>;
-} & {
-    [topic in `${Topic}Identity`]: OpenFin.Identity;
 } : never;
 /**
  * Handler for an event on an EventEmitter; selects the correct type for the event

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

@@ -1,15 +1,18 @@
 import type * as OpenFin from '../../OpenFin';
 import { NonPropagatedWebContentsEvent, WillPropagateWebContentsEvent } from './webcontents';
 import { NamedEvent, PropagatedEvent } from './base';
+export type BaseViewEvent = {
+    target: OpenFin.Identity;
+    viewIdentity: OpenFin.Identity;
+};
 export type TargetChangedEvent = NamedEvent & {
     type: 'target-changed';
     previousTarget: OpenFin.Identity;
-    target: OpenFin.Identity;
 };
 /**
  * A View event that does not propagate to (republish on) parent topics.
  */
-export type NonPropagatedViewEvent = NonPropagatedWebContentsEvent;
+export type NonPropagatedViewEvent = BaseViewEvent & NonPropagatedWebContentsEvent;
 export type AttachedEvent = NamedEvent & {
     type: 'attached';
 };
@@ -31,7 +34,7 @@ export type ShownEvent = NamedEvent & {
 /**
  * A View event that does propagate to (republish on) parent topics.
  */
-export type WillPropagateViewEvent = WillPropagateWebContentsEvent | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent;
+export type WillPropagateViewEvent = BaseViewEvent & (WillPropagateWebContentsEvent | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent);
 export type ViewEvent = {
     topic: 'view';
 } & (NonPropagatedViewEvent | WillPropagateViewEvent);

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

@@ -64,6 +64,8 @@ export type DidFailLoadEvent = BaseLoadFailedEvent & {
 };
 export type FoundInPageEvent = NamedEvent & {
     type: 'found-in-page';
+} & {
+    result: OpenFin.FindInPageResult;
 };
 /**
  * A WebContents event that does not propagate to (republish on) parent topics.

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

@@ -1,6 +1,6 @@
 import type * as OpenFin from '../../OpenFin';
 import { NamedEvent, PropagatedEvent } from './base';
-import { PropagatedViewEvent } from './view';
+import { BaseViewEvent, PropagatedViewEvent, AttachedEvent as ViewAttachedEvent } from './view';
 import { NonPropagatedWebContentsEvent, WillPropagateWebContentsEvent } from './webcontents';
 export type AlertRequestedEvent = NamedEvent & {
     type: 'alert-requested';
@@ -84,11 +84,9 @@ export type WillMoveOrResizeEvent = NamedEvent & {
 export type PerformanceReportEvent = Performance & NamedEvent & {
     type: 'performance-report';
 };
-export type ViewDetachedEvent = NamedEvent & {
+export type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
     type: 'view-detached';
     previousTarget: OpenFin.Identity;
-    target: OpenFin.Identity;
-    viewIdentity: OpenFin.Identity;
 };
 export type InputEvent = {
     inputType: 'keyUp' | 'keyDown';
@@ -101,6 +99,18 @@ export type InputEvent = {
     repeat: boolean;
     command?: string;
 };
+export type LayoutInitializedEvent = NamedEvent & {
+    type: 'layout-initialized';
+    ofViews: (OpenFin.Identity & {
+        entityType: 'view';
+    })[];
+};
+export type LayoutReadyEvent = NamedEvent & {
+    type: 'layout-ready';
+    views: (OpenFin.Identity & {
+        success: boolean;
+    })[];
+};
 /**
  * A Window event that does not propagate to (republish on) parent topics.
  */
@@ -141,12 +151,6 @@ export type WindowHotkeyEvent = InputEvent & NamedEvent & {
 export type WindowInitializedEvent = NamedEvent & {
     type: 'initialized';
 };
-export type LayoutInitializedEvent = NamedEvent & {
-    type: 'layout-initialized';
-};
-export type LayoutReadyEvent = NamedEvent & {
-    type: 'layout-ready';
-};
 export type MaximizedEvent = NamedEvent & {
     type: 'maximized';
 };
@@ -180,13 +184,17 @@ export type WillMoveEvent = WillMoveOrResizeEvent & {
 export type WillResizeEvent = WillMoveOrResizeEvent & {
     type: 'will-resize';
 };
+/**
+ * A propagated view event that is re-propagated from window.
+ */
+export type PropagatedViewAttachedEvent = PropagatedEvent<'view', ViewAttachedEvent>;
 /**
  * A Window event that does propagate to (republish on) parent topics.
  */
-export type WillPropagateWindowEvent = WillPropagateWebContentsEvent | PropagatedViewEvent | ViewDetachedEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | WindowCloseRequestedEvent | WindowClosedEvent | WindowClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent | WindowHotkeyEvent | WindowInitializedEvent | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | WindowOptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | WindowRestoredEvent | WindowShowRequestedEvent | WindowShownEvent | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillRedirectEvent | WillResizeEvent;
+export type WillPropagateWindowEvent = WillPropagateWebContentsEvent | PropagatedViewAttachedEvent | ViewDetachedEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | WindowCloseRequestedEvent | WindowClosedEvent | WindowClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent | WindowHotkeyEvent | WindowInitializedEvent | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | WindowOptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | WindowRestoredEvent | WindowShowRequestedEvent | WindowShownEvent | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillRedirectEvent | WillResizeEvent;
 export type WindowEvent = {
     topic: 'window';
-} & (WillPropagateWindowEvent | NonPropagatedWindowEvent);
+} & (WillPropagateWindowEvent | NonPropagatedWindowEvent | PropagatedViewEvent);
 export type WindowEventType = WindowEvent['type'];
-export type PropagatedWindowEvent = PropagatedEvent<'window', WillPropagateWindowEvent>;
+export type PropagatedWindowEvent = PropagatedEvent<'window', Exclude<WillPropagateWindowEvent, WindowCloseRequestedEvent>>;
 export type PropagatedWindowEventType = PropagatedWindowEvent['type'];

package/src/api/interop/InteropBroker.js

@@ -1009,8 +1009,6 @@ class InteropBroker extends base_1.Base {
             });
             this.clientDisconnected(clientIdentity);
         });
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
         channel.beforeAction(async (action, payload, clientIdentity) => {
             var _a, _b;
             if (!(await this.isActionAuthorized(action, payload, clientIdentity))) {

package/src/api/platform/Factory.js

@@ -77,7 +77,7 @@ class PlatformModule extends base_1.Base {
         const overrideCallback = options === null || options === void 0 ? void 0 : options.overrideCallback;
         const interopBroker = await this.fin.Interop.init(this.fin.me.uuid, options === null || options === void 0 ? void 0 : options.interopOverride);
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore debugging purposes
+        // @ts-expect-error debugging purposes
         window.interopBroker = interopBroker;
         return this._initializer(overrideCallback, interopBroker);
     }
@@ -147,8 +147,7 @@ class PlatformModule extends base_1.Base {
         return new Promise(async (resolve, reject) => {
             try {
                 const { uuid } = platformOptions;
-                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                // @ts-ignore using private variable.
+                // @ts-expect-error using private variable.
                 const app = await this.fin.Application._create({ ...platformOptions, isPlatformController: true });
                 // TODO: fix typing (internal)
                 // @ts-expect-error
@@ -179,13 +178,13 @@ class PlatformModule extends base_1.Base {
         return new Promise(async (resolve, reject) => {
             try {
                 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                // @ts-ignore using private variable.
+                // @ts-expect-error using private variable.
                 const app = await this.fin.Application._createFromManifest(manifestUrl);
                 // TODO: fix typing (internal)
                 // @ts-expect-error
                 app.once('platform-api-ready', () => resolve(this.wrapSync({ uuid: app.identity.uuid })));
                 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                // @ts-ignore using private method without warning.
+                // @ts-expect-error using private method without warning.
                 app._run(opts);
             }
             catch (e) {

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

@@ -114,8 +114,7 @@ class LayoutModule extends base_1.Base {
             const splitterController = new splitter_controller_1.SplitterController(viewOverlay);
             const tabDragController = new tab_drag_controller_1.TabDragController(viewOverlay);
             __classPrivateFieldSet(this, _LayoutModule_layoutManager, new ManagerConstructor(splitterController, tabDragController), "f");
-            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-            // @ts-ignore - layout warning here for backwards compatibility, can remove layout check in .52
+            // @ts-expect-error - layout warning here for backwards compatibility, can remove layout check in .52
             let { layout, containerId } = options;
             if (layout) {
                 console.warn(`We recommend using a layout in window options.