@openfin/core 31.75.1 → 32.75.2

package/src/environment/browser.js

@@ -8,10 +8,13 @@ class BrowserEnvironment {
             return window.crypto.getRandomValues(intArray)[0].toString(32);
         };
     }
-    getManagerConstructor() {
+    observeBounds(element, onChange) {
         throw new Error('Method not implemented.');
     }
-    getProviderInitializer() {
+    initLayout(_fin, wire, options) {
+        throw new Error('Method not implemented.');
+    }
+    initPlatform(...args) {
         throw new Error('Method not implemented.');
     }
     writeToken(path, token) {

package/src/environment/environment.d.ts

@@ -1,9 +1,11 @@
 import type * as OpenFin from '../OpenFin';
+import { Transport } from '../transport/transport';
 import { NewConnectConfig } from '../transport/wire';
 type EntityType = OpenFin.EntityType;
 export interface Environment {
-    getManagerConstructor(): Promise<any>;
-    getProviderInitializer(): Promise<any>;
+    initLayout(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, ...args: Parameters<OpenFin.Fin['Platform']['Layout']['init']>): ReturnType<OpenFin.Fin['Platform']['Layout']['init']>;
+    initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
+    observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): (() => void);
     writeToken(path: string, token: string): Promise<string>;
     retrievePort(config: NewConnectConfig): Promise<number>;
     getNextMessageId(): any;

package/src/environment/mockEnvironment.d.ts

@@ -8,8 +8,8 @@ export declare class MockEnvironment implements Environment {
         connect: OpenFin.ChannelConnectOptions;
     };
     getRtcPeer(): RTCPeerConnection;
-    getManagerConstructor(): Promise<any>;
-    getProviderInitializer(): Promise<any>;
+    initLayout(): Promise<never>;
+    initPlatform(): Promise<never>;
     observeBounds(): never;
     writeToken(path: string, token: string): Promise<string>;
     retrievePort(config: NewConnectConfig): Promise<number>;

package/src/environment/mockEnvironment.js

@@ -12,10 +12,10 @@ class MockEnvironment {
     getRtcPeer() {
         throw new Error(me_1.environmentUnsupportedMessage);
     }
-    async getManagerConstructor() {
+    initLayout() {
         throw new Error(me_1.environmentUnsupportedMessage);
     }
-    async getProviderInitializer() {
+    initPlatform() {
         throw new Error(me_1.environmentUnsupportedMessage);
     }
     observeBounds() {

package/src/environment/node-env.d.ts

@@ -3,6 +3,7 @@ import { Environment } from './environment';
 import { NewConnectConfig } from '../transport/wire';
 type EntityType = OpenFin.EntityType;
 export default class NodeEnvironment implements Environment {
+    observeBounds(element: Element, onChange: (bounds: DOMRect) => void | Promise<void>): () => void;
     getDefaultChannelOptions(): {
         create: OpenFin.ChannelCreateOptions;
         connect: OpenFin.ChannelConnectOptions;
@@ -10,8 +11,8 @@ export default class NodeEnvironment implements Environment {
     getRtcPeer(): RTCPeerConnection;
     private messageCounter;
     childViews: boolean;
-    getManagerConstructor(): Promise<any>;
-    getProviderInitializer(): Promise<any>;
+    initLayout(): Promise<never>;
+    initPlatform(): Promise<never>;
     whenReady(): Promise<void>;
     writeToken: (path: string, token: string) => Promise<string>;
     retrievePort: (config: NewConnectConfig) => Promise<number>;

package/src/environment/node-env.js

@@ -43,16 +43,19 @@ class NodeEnvironment {
             throw new transport_errors_1.NotImplementedError('Not Implemented');
         };
     }
+    observeBounds(element, onChange) {
+        throw new Error('Method not implemented.');
+    }
     getDefaultChannelOptions() {
         return { create: {}, connect: {} };
     }
     getRtcPeer() {
         throw new Error('Method not implemented.');
     }
-    async getManagerConstructor() {
+    async initLayout() {
         throw new Error('Method not implemented.');
     }
-    async getProviderInitializer() {
+    async initPlatform() {
         throw new Error('Method not implemented.');
     }
     whenReady() {

package/src/environment/openfin-env.d.ts

@@ -1,7 +1,8 @@
 import type * as OpenFin from '../OpenFin';
-import { ChildContentOptions, Environment } from './environment';
+import { Transport } from '../transport/transport';
 import { NewConnectConfig } from '../transport/wire';
 import { BrowserEnvironment } from './browser';
+import { ChildContentOptions, Environment } from './environment';
 type EntityType = OpenFin.EntityType;
 export default class OpenFinEnvironment extends BrowserEnvironment implements Environment {
     #private;
@@ -12,8 +13,9 @@ export default class OpenFinEnvironment extends BrowserEnvironment implements En
         create: OpenFin.ChannelCreateOptions;
         connect: OpenFin.ChannelConnectOptions;
     };
-    getManagerConstructor(): Promise<any>;
-    getProviderInitializer(): Promise<any>;
+    initLayout(_fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.Layout>;
+    initPlatform(_fin: OpenFin.Fin<OpenFin.EntityType>, options?: OpenFin.InitPlatformOptions): ReturnType<OpenFin.Fin['Platform']['init']>;
+    observeBounds(element: Element, onChange: (bounds: DOMRect) => void | Promise<void>): () => void;
     writeToken: (path: string, token: string) => Promise<string>;
     retrievePort: (config: NewConnectConfig) => Promise<number>;
     getNextMessageId: () => any;

package/src/environment/openfin-env.js

@@ -12,10 +12,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _OpenFinEnvironment_ready;
 Object.defineProperty(exports, "__esModule", { value: true });
-/* global window, location */
-/* eslint-disable class-methods-use-this */
 const transport_errors_1 = require("../transport/transport-errors");
 const browser_1 = require("./browser");
+const bounds_observer_1 = require("../api/platform/renderer/utils/bounds-observer");
 // Inherits the following BrowserEnvironment methods: getRtcPeer, getRandomId, getUrl, getWsConstructor.
 class OpenFinEnvironment extends browser_1.BrowserEnvironment {
     constructor() {
@@ -73,17 +72,20 @@ class OpenFinEnvironment extends browser_1.BrowserEnvironment {
             ...((_b = (_a = fin.__internal_.initialOptions.experimental) === null || _a === void 0 ? void 0 : _a.defaultChannelOptions) !== null && _b !== void 0 ? _b : {})
         };
     }
-    async getManagerConstructor() {
-        const ManagerConstructor = (await Promise.resolve().then(() => require(
+    async initLayout(_fin, wire, options) {
+        const { initLayout } = await Promise.resolve().then(() => require(
         /* webpackChunkName: 'layout' */
-        '../api/platform/renderer/openfin-layout'))).default;
-        return ManagerConstructor;
+        '../api/platform/renderer/init-layout'));
+        return initLayout(_fin, wire, options);
     }
-    async getProviderInitializer() {
-        const providerInitializer = (await Promise.resolve().then(() => require(
+    async initPlatform(_fin, options) {
+        const { initPlatformProvider } = await Promise.resolve().then(() => require(
         /* webpackChunkName: 'provider' */
-        '../api/platform/renderer/platform-provider'))).default;
-        return providerInitializer;
+        '../api/platform/renderer/init-platform-provider'));
+        return initPlatformProvider(this, _fin, options);
+    }
+    observeBounds(element, onChange) {
+        return (0, bounds_observer_1.observeBounds)(element, onChange);
     }
     // eslint-disable-next-line class-methods-use-this
     resolveUrl(url) {

package/src/shapes/protocol.d.ts

@@ -82,16 +82,18 @@ export interface ProtocolMap extends ProtocolMapBase {
         };
         response: OpenFin.NativeWindowIntegrationProviderAuthorization;
     };
-    'get-permissions': {
-        request: void;
-        response: any;
-    };
+    'get-permissions': GetterCall<any>;
+    'get-all-channels': GetterCall<OpenFin.ProviderIdentity[]>;
     'set-file-download-location': {
-        request: OpenFin.ApplicationIdentity & {
+        request: OpenFin.Identity & {
             downloadLocation: string;
         };
         response: void;
     };
+    'get-file-download-location': {
+        request: OpenFin.ApplicationIdentity;
+        response: string;
+    };
     'close-popup-menu': IdentityCall;
     'fdc3-add-context-listener': VoidCall;
     'fdc3-broadcast': VoidCall;
@@ -160,10 +162,7 @@ export interface ProtocolMap extends ProtocolMapBase {
         };
         response: void;
     };
-    'system-get-printers': {
-        request: void;
-        response: OpenFin.PrinterInfo[];
-    };
+    'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
     'system-register-shutdown-handler': VoidCall;
 }
 type ApiCall<Request, Response> = {
@@ -171,6 +170,7 @@ type ApiCall<Request, Response> = {
     response: Response;
 };
 type VoidCall = ApiCall<void, void>;
+type GetterCall<T> = ApiCall<void, T>;
 type IdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<AdditionalPayload & OpenFin.Identity, Response>;
 interface ProtocolMapBase {
     [action: string]: {

package/src/transport/transport.d.ts

@@ -15,8 +15,9 @@ type SendActionResponse<T extends keyof ProtocolMap> = Message<{
     data: ProtocolMap[T]['response'];
 } & ProtocolMap[T]['specialResponse']>;
 export type MessageHandler = (data: any) => boolean;
-export type CancellablePromise<T> = Promise<T> & {
+export type SentMessage<Value> = Promise<Value> & {
     cancel: (reason?: any) => void;
+    messageId: ReturnType<Environment['getNextMessageId']>;
 };
 type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
 export declare class Transport<MeType extends EntityType = EntityType> extends EventEmitter {
@@ -42,7 +43,7 @@ export declare class Transport<MeType extends EntityType = EntityType> extends E
     private connectRemote;
     connectByPort(config: ExistingConnectConfig): Promise<void>;
     private authorize;
-    sendAction<T extends keyof ProtocolMap = string>(action: T, payload?: ProtocolMap[T]['request'], uncorrelated?: boolean): CancellablePromise<SendActionResponse<T>>;
+    sendAction<T extends keyof ProtocolMap = string>(action: T, payload?: ProtocolMap[T]['request'], uncorrelated?: boolean): SentMessage<SendActionResponse<T>>;
     protected nackHandler(payloadOrMessage: RuntimeErrorPayload | string, reject: Function, callSites?: NodeJS.CallSite[]): void;
     ferryAction(origData: any): Promise<Message<any>>;
     registerMessageHandler(handler: MessageHandler): void;

package/src/transport/transport.js

@@ -115,9 +115,9 @@ class Transport extends events_1.EventEmitter {
         let cancel = () => { };
         // We want the callsite from the caller of this function, not from here.
         const callSites = transport_errors_1.RuntimeError.getCallSite(1);
+        const messageId = this.environment.getNextMessageId();
         const prom = new Promise((resolve, reject) => {
             cancel = reject;
-            const messageId = this.environment.getNextMessageId();
             const msg = {
                 action,
                 payload,
@@ -127,7 +127,7 @@ class Transport extends events_1.EventEmitter {
             this.addWireListener(messageId, resolve, (payload) => this.nackHandler(payload, reject, callSites), uncorrelated);
             return wire.send(msg).catch(reject);
         });
-        return Object.assign(prom, { cancel });
+        return Object.assign(prom, { cancel, messageId });
     }
     nackHandler(payloadOrMessage, reject, callSites) {
         if (typeof payloadOrMessage === 'string') {

package/src/api/platform/layout/controllers/splitter-controller.d.ts

@@ -1,30 +0,0 @@
-import { ViewOverlay } from '../utils/view-overlay';
-export type SplitterItem = GoldenLayout.ContentItem & {
-    viewEventsAdded: boolean;
-    isVertical: boolean;
-};
-/**
- * Utility class for managing Golden Layout splitter drag interactions.
- * @ignore
- */
-export declare class SplitterController {
-    private readonly viewOverlay;
-    constructor(viewOverlay: ViewOverlay);
-    private teardown?;
-    private tryTeardown;
-    /**
-     * Disables the pointer events on the splitters, preventing them from being dragged.
-     */
-    preventSplitterResize: () => void;
-    /**
-     * Ends a splitter drag move, if one is in progress.
-     */
-    endMove: () => Promise<void>;
-    /**
-     * Initialises a splitter drag move, rendering a view on top of the splitter
-     * to allow it to render on top of the views within a layout (as they will always
-     * have a higher z-index to the platform window itself).
-     * @param splitterItem The Golden Layout splitter item that is currently being dragged.
-     */
-    startMove: (splitterItem: SplitterItem) => Promise<void>;
-}

package/src/api/platform/layout/controllers/splitter-controller.js

@@ -1,83 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SplitterController = void 0;
-const bounds_observer_1 = require("../utils/bounds-observer");
-const applyBoundsOffset = (bounds, offsets = {}) => {
-    const sum = (bound, offset) => {
-        return bound + (offset || 0);
-    };
-    return {
-        left: sum(bounds.left, offsets.left),
-        top: sum(bounds.top, offsets.top),
-        width: sum(bounds.width, offsets.width),
-        height: sum(bounds.height, offsets.height)
-    };
-};
-/**
- * Utility class for managing Golden Layout splitter drag interactions.
- * @ignore
- */
-class SplitterController {
-    // eslint-disable-next-line
-    constructor(viewOverlay) {
-        this.viewOverlay = viewOverlay;
-        this.tryTeardown = () => {
-            if (this.teardown) {
-                this.teardown();
-                this.teardown = undefined;
-            }
-        };
-        /**
-         * Disables the pointer events on the splitters, preventing them from being dragged.
-         */
-        this.preventSplitterResize = () => {
-            document.querySelectorAll('.lm_splitter').forEach((splitter) => {
-                splitter.style.pointerEvents = 'none';
-            });
-        };
-        /**
-         * Ends a splitter drag move, if one is in progress.
-         */
-        this.endMove = async () => {
-            try {
-                this.viewOverlay.detachOverlay();
-                this.tryTeardown();
-            }
-            catch (error) {
-                throw new Error(`Failed to end splitter move: ${error.stack}`);
-            }
-        };
-        /**
-         * Initialises a splitter drag move, rendering a view on top of the splitter
-         * to allow it to render on top of the views within a layout (as they will always
-         * have a higher z-index to the platform window itself).
-         * @param splitterItem The Golden Layout splitter item that is currently being dragged.
-         */
-        this.startMove = async (splitterItem) => {
-            try {
-                if (this.teardown) {
-                    console.warn('Splitter move started before other move has been torn down.');
-                    this.tryTeardown();
-                }
-                const splitterDiv = splitterItem.element.get(0);
-                const { backgroundColor } = getComputedStyle(splitterDiv);
-                const initialVisibility = splitterDiv.style.visibility;
-                splitterDiv.style.visibility = 'hidden';
-                const onBoundsChange = (bounds) => {
-                    const offsetBounds = applyBoundsOffset(bounds, { height: splitterItem.isVertical ? 0 : 2 });
-                    this.viewOverlay.renderOverlay(offsetBounds);
-                };
-                await this.viewOverlay.setStyle({ backgroundColor });
-                const teardownBoundsObserver = (0, bounds_observer_1.observeBounds)(splitterDiv, onBoundsChange);
-                this.teardown = () => {
-                    teardownBoundsObserver();
-                    splitterDiv.style.visibility = initialVisibility;
-                };
-            }
-            catch (error) {
-                throw new Error(`Failed to start splitter move: ${error.stack}`);
-            }
-        };
-    }
-}
-exports.SplitterController = SplitterController;

package/src/api/platform/layout/controllers/tab-drag-controller.d.ts

@@ -1,59 +0,0 @@
-import type * as OpenFin from '../../../../OpenFin';
-import { ViewOverlay } from '../utils/view-overlay';
-type View = OpenFin.View;
-/**
- * Set of apis used to facilitate tab drag interactions without needing to hide views.
- * @ignore
- */
-export declare class TabDragController {
-    private readonly viewOverlay;
-    constructor(viewOverlay: ViewOverlay);
-    private dropZonePreview?;
-    /**
-     *
-     * When a tab is dragged out of a stack, it will need to be hidden from the stack.
-     *
-     * Additionally, if there is a new view to show in the stack, it will be shown at the position specified by
-     * containerBounds
-     *
-     * As drag interactions can under extreme circumstances complete before this chain of promises has completed,
-     * we need to pass in a isDragging() function which returns whether the drag is in progress.
-     * This allows us to cancel any layout affecting operations.
-     *
-     * @param draggingView The view which is currently being dragged
-     * @param isLastViewInWindow Whether the draggin view is the last view in a window or not. If false, the dragging view will not hide.
-     * @param isDragging A function which returns true if the drag is still in progress. As we chain some async calls here, we want to avoid
-     * modifying any views if the drag has completed (as the post drag procedure will have taken care of it.)
-     * @param containerBounds The bounds of the container of the view to be shown in the stack
-     * @param nextView The view which has become active after dragging the draggingView out.
-     */
-    handleTabStackActiveView: (draggingView: View, isLastViewInWindow: boolean, isDragging: () => boolean, containerBounds?: OpenFin.Bounds, nextView?: View) => Promise<void>;
-    /**
-     * Extracts the border and backgroundColor css values from the drop zone preview,
-     * and sets the viewOverlay to match them.
-     */
-    inheritStyles: () => Promise<void>;
-    /**
-     * Called when a tab drag interaction is started from the current window (not when it enters the window).
-     *
-     * Sets all views in the platform to ignore mouse events so that they can pass through to the golden-layout
-     * document whilst remaining visible.
-     */
-    startDrag: () => Promise<void>;
-    /**
-     * Called when a tab drag interaction which was started from the current window ends.
-     *
-     * Disables the click through setting on every view in the platform.
-     */
-    endDrag: () => Promise<void>;
-    private disposeObserve?;
-    disposeOverlayObserver: () => void;
-    /**
-     * Observes a golden-layout drop zone preview in order to render a BrowserView
-     * overlay whenever a tab is dragged over a droppable region.
-     * @param dropZonePreview The drop zone preview element created by Golden Layout in order to highlight
-     * droppable regions of the UI.
-     */
-    observeOverlay: (dropZonePreview: HTMLElement) => Promise<void>;
-}
-export {};

package/src/api/platform/layout/controllers/tab-drag-controller.js

@@ -1,124 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TabDragController = void 0;
-const bounds_observer_1 = require("../utils/bounds-observer");
-/**
- * Set of apis used to facilitate tab drag interactions without needing to hide views.
- * @ignore
- */
-class TabDragController {
-    // eslint-disable-next-line
-    constructor(viewOverlay) {
-        this.viewOverlay = viewOverlay;
-        /**
-         *
-         * When a tab is dragged out of a stack, it will need to be hidden from the stack.
-         *
-         * Additionally, if there is a new view to show in the stack, it will be shown at the position specified by
-         * containerBounds
-         *
-         * As drag interactions can under extreme circumstances complete before this chain of promises has completed,
-         * we need to pass in a isDragging() function which returns whether the drag is in progress.
-         * This allows us to cancel any layout affecting operations.
-         *
-         * @param draggingView The view which is currently being dragged
-         * @param isLastViewInWindow Whether the draggin view is the last view in a window or not. If false, the dragging view will not hide.
-         * @param isDragging A function which returns true if the drag is still in progress. As we chain some async calls here, we want to avoid
-         * modifying any views if the drag has completed (as the post drag procedure will have taken care of it.)
-         * @param containerBounds The bounds of the container of the view to be shown in the stack
-         * @param nextView The view which has become active after dragging the draggingView out.
-         */
-        this.handleTabStackActiveView = async (draggingView, isLastViewInWindow, isDragging, containerBounds, nextView) => {
-            if (this.dropZonePreview) {
-                if (nextView && containerBounds) {
-                    if (isDragging()) {
-                        await (nextView === null || nextView === void 0 ? void 0 : nextView.show());
-                    }
-                    if (isDragging()) {
-                        await (nextView === null || nextView === void 0 ? void 0 : nextView.setBounds(containerBounds));
-                    }
-                }
-                if (isDragging() && !isLastViewInWindow) {
-                    await draggingView.hide();
-                }
-            }
-        };
-        /**
-         * Extracts the border and backgroundColor css values from the drop zone preview,
-         * and sets the viewOverlay to match them.
-         */
-        this.inheritStyles = async () => {
-            if (this.dropZonePreview) {
-                const { border, backgroundColor } = getComputedStyle(this.dropZonePreview);
-                await this.viewOverlay.setStyle({ border, backgroundColor });
-            }
-        };
-        /**
-         * Called when a tab drag interaction is started from the current window (not when it enters the window).
-         *
-         * Sets all views in the platform to ignore mouse events so that they can pass through to the golden-layout
-         * document whilst remaining visible.
-         */
-        this.startDrag = async () => {
-            await this.viewOverlay.setIgnoreViewMouseEvents(true);
-        };
-        /**
-         * Called when a tab drag interaction which was started from the current window ends.
-         *
-         * Disables the click through setting on every view in the platform.
-         */
-        this.endDrag = async () => {
-            await this.viewOverlay.setIgnoreViewMouseEvents(false);
-        };
-        this.disposeOverlayObserver = () => {
-            if (this.disposeObserve) {
-                this.disposeObserve();
-            }
-            this.dropZonePreview = undefined;
-        };
-        /**
-         * Observes a golden-layout drop zone preview in order to render a BrowserView
-         * overlay whenever a tab is dragged over a droppable region.
-         * @param dropZonePreview The drop zone preview element created by Golden Layout in order to highlight
-         * droppable regions of the UI.
-         */
-        this.observeOverlay = async (dropZonePreview) => {
-            if (!this.dropZonePreview) {
-                this.dropZonePreview = dropZonePreview;
-                let lastBounds;
-                dropZonePreview.style.visibility = 'hidden';
-                const onDropAreaHighlighted = async (e) => {
-                    try {
-                        const { bounds } = e.detail;
-                        if (!lastBounds || !(0, bounds_observer_1.isDomRectEqual)(lastBounds, bounds)) {
-                            lastBounds = bounds;
-                            await this.viewOverlay.renderOverlay(bounds);
-                        }
-                    }
-                    catch (error) {
-                        console.warn('Unexpected error encountered rendering tab drag preview.', error);
-                    }
-                };
-                const onDropAreaHidden = async () => {
-                    try {
-                        lastBounds = undefined;
-                        await this.viewOverlay.detachOverlay();
-                    }
-                    catch (error) {
-                        console.warn('Unexpected error encountered hiding tab drag preview.', error);
-                    }
-                };
-                dropZonePreview.addEventListener('drop-area-highlighted', onDropAreaHighlighted);
-                dropZonePreview.addEventListener('drop-area-hidden', onDropAreaHidden);
-                this.disposeObserve = () => {
-                    dropZonePreview.removeEventListener('drop-area-highlighted', onDropAreaHighlighted);
-                    dropZonePreview.removeEventListener('drop-area-hidden', onDropAreaHidden);
-                };
-            }
-            else {
-                console.warn('Tried to observe a drop zone overlay without disposing the previous.');
-            }
-        };
-    }
-}
-exports.TabDragController = TabDragController;

package/src/api/platform/layout/utils/bounds-observer.d.ts

@@ -1,19 +0,0 @@
-export declare const isDomRectEqual: (a: DOMRect, b: DOMRect) => boolean;
-/**
- * Observes the bounding client box rectangle of the given element for changes.
- *
- * This solution only works for 2 scenarios, though could be updated to support more
- * (e.g. via polling).
- *
- * MutationObserver will only pick up changes to bounds if they are specified via fixed
- * style rules in the element's attribtues.
- *
- * ResizeObserver will pick up all changes to an element's width and height but will not capture
- * any changes to position.
- *
- * @param element The element to observe the bounding box for (i.e. position, width, height)
- * @param onChange Called every time the bounding box changes.
- * @returns Function which disposes the observers when invoked.
- * @ignore
- */
-export declare const observeBounds: (element: Element, onChange: (bounds: DOMRect) => Promise<void> | void) => (() => void);

package/src/api/platform/layout/utils/bounds-observer.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.observeBounds = exports.isDomRectEqual = void 0;
-const isDomRectEqual = (a, b) => {
-    if (a.top !== b.top ||
-        a.left !== b.left ||
-        a.width !== b.width ||
-        a.height !== b.height ||
-        a.x !== b.x ||
-        a.y !== b.y) {
-        return false;
-    }
-    return true;
-};
-exports.isDomRectEqual = isDomRectEqual;
-/**
- * Observes the bounding client box rectangle of the given element for changes.
- *
- * This solution only works for 2 scenarios, though could be updated to support more
- * (e.g. via polling).
- *
- * MutationObserver will only pick up changes to bounds if they are specified via fixed
- * style rules in the element's attribtues.
- *
- * ResizeObserver will pick up all changes to an element's width and height but will not capture
- * any changes to position.
- *
- * @param element The element to observe the bounding box for (i.e. position, width, height)
- * @param onChange Called every time the bounding box changes.
- * @returns Function which disposes the observers when invoked.
- * @ignore
- */
-const observeBounds = (element, onChange) => {
-    let lastBounds;
-    const checkBounds = async () => {
-        const currentBounds = element.getBoundingClientRect();
-        if (!lastBounds || !(0, exports.isDomRectEqual)(lastBounds, currentBounds)) {
-            lastBounds = currentBounds;
-            await onChange(element.getBoundingClientRect());
-        }
-    };
-    const resizeObserver = new ResizeObserver(() => checkBounds());
-    const mutationObserver = new MutationObserver(() => checkBounds());
-    resizeObserver.observe(element, { box: 'content-box' });
-    mutationObserver.observe(element, { attributes: true, attributeFilter: ['style'] });
-    checkBounds();
-    return () => {
-        resizeObserver.disconnect();
-        mutationObserver.disconnect();
-    };
-};
-exports.observeBounds = observeBounds;

package/src/api/platform/layout/utils/view-overlay.d.ts

@@ -1,35 +0,0 @@
-import type * as OpenFin from '../../../../OpenFin';
-import { Transport } from '../../../../transport/transport';
-/**
- * Api client allowing an empty electron BrowserView to be rendered
- * in the current window with the specified bounds.
- *
- * Please note, only one  view based overlay can be rendered at a time per runtime.
- * @ignore
- */
-export declare class ViewOverlay {
-    private wire;
-    constructor(wire: Transport);
-    /**
-     * Sets the style of the root <html> element of the view overlay webcontent.
-     * @param style A partial collection of Css style declarations to set.
-     */
-    setStyle: (style: Partial<CSSStyleDeclaration>) => Promise<void>;
-    /**
-     * Renders the overlay at the specified position relative to the calling window.
-     * @param options Bounds and background color to display in the overlay.
-     */
-    renderOverlay: (bounds: OpenFin.Bounds) => Promise<void>;
-    /**
-     * Removes the overlay from the current window.
-     */
-    detachOverlay: () => Promise<void>;
-    /**
-     * Allows setting all OpenFin views to ignore or consume mouse events.
-     *
-     * This can help with the rendering of view overlays that depend on OpenFin views not consuming mouse events.
-     *
-     * @param enabled If true, all mouse events are ignored by openfin views. If false, all OpenFin views will consume mouse events.
-     */
-    setIgnoreViewMouseEvents(enabled: boolean): Promise<void>;
-}