@openfin/core 30.73.1 → 30.73.3

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "30.73.1",
+    "version": "30.73.3",
     "license": "Apache-2.0",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

package/src/api/interop/fdc3/PrivateChannelClient.js

@@ -9,7 +9,7 @@ class PrivateChannelClient {
         this.listeners = new Map();
     }
     async broadcast(context) {
-        this.client.dispatch('broadcast', { context });
+        return this.client.dispatch('broadcast', { context });
     }
     async getCurrentContext(contextType) {
         return this.client.dispatch('getCurrentContext', { contextType });
@@ -70,12 +70,10 @@ class PrivateChannelClient {
         return listener;
     }
     async disconnect() {
-        const promises = [];
         const listenerUnsubscribers = Array.from(this.listeners.values());
-        for (let i = 0; i < listenerUnsubscribers.length; i++) {
-            const listener = listenerUnsubscribers[i];
-            promises.push(listener.unsubscribe());
-        }
+        const promises = listenerUnsubscribers.map(async (listenerUnsubscriber) => {
+            await listenerUnsubscriber.unsubscribe();
+        });
         await Promise.all(promises);
         await this.client.dispatch('clientDisconnecting');
         await this.client.disconnect();

package/src/api/interop/fdc3/fdc3-1.2.d.ts

@@ -204,5 +204,4 @@ export default class Fdc3Module extends Base implements FDC3.DesktopAgent {
     open(app: FDC3.TargetApp, context?: OpenFin.Context): Promise<void>;
     private getCurrentContextGroupInfo;
     private buildChannelObject;
-    private buildAppChannelObject;
 }

package/src/api/interop/fdc3/fdc3-1.2.js

@@ -329,7 +329,7 @@ class Fdc3Module extends base_1.Base {
             // we do not want to expose this error, just continue if this analytics-only call fails
         });
         const sessionContextGroup = await this.fin.me.interop.joinSessionContextGroup(channelId);
-        return this.buildAppChannelObject(sessionContextGroup);
+        return utils_1.buildAppChannelObject(sessionContextGroup);
     }
     /**
      * Returns metadata relating to the FDC3 object and its provider, including the supported version of the FDC3 specification and the name of the provider of the implementation.
@@ -397,31 +397,5 @@ class Fdc3Module extends base_1.Base {
             }
         };
     }
-    // eslint-disable-next-line class-methods-use-this
-    buildAppChannelObject(sessionContextGroup) {
-        return {
-            id: sessionContextGroup.id,
-            type: 'app',
-            broadcast: sessionContextGroup.setContext,
-            getCurrentContext: async (contextType) => {
-                const context = await sessionContextGroup.getCurrentContext(contextType);
-                return context === undefined ? null : context;
-            },
-            addContextListener: (contextType, handler) => {
-                let listener;
-                if (typeof contextType === 'function') {
-                    console.warn('addContextListener(handler) has been deprecated. Please use addContextListener(null, handler)');
-                    listener = sessionContextGroup.addContextHandler(contextType);
-                }
-                else {
-                    listener = sessionContextGroup.addContextHandler(handler, contextType === null ? undefined : contextType);
-                }
-                return {
-                    ...listener,
-                    unsubscribe: () => listener.then((l) => l.unsubscribe())
-                };
-            }
-        };
-    }
 }
 exports.default = Fdc3Module;

package/src/api/interop/fdc3/fdc3-2.0.d.ts

@@ -249,8 +249,6 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * @tutorial fdc3v2.createPrivateChannel
      */
     createPrivateChannel(): Promise<FDC3v2.PrivateChannel>;
-    connectPrivateChannel(channelId: string): Promise<FDC3v2.PrivateChannel>;
-    private buildPrivateChannelObject;
     /**
      * Retrieves a list of the User Channels available for the app to join.
      * @returns { Promise<Channel[]>}

package/src/api/interop/fdc3/fdc3-2.0.js

@@ -393,69 +393,7 @@ class Fdc3Module2 extends base_1.Base {
         const newPrivateChannelProvider = new PrivateChannelProvider_1.PrivateChannelProvider(channelProvider, channelId);
         const channelClient = await this.fin.InterApplicationBus.Channel.connect(channelId);
         const newPrivateChannelClient = new PrivateChannelClient_1.PrivateChannelClient(channelClient, channelId);
-        return this.buildPrivateChannelObject(newPrivateChannelClient);
-    }
-    // TODO: need to remove this method and not expose it. Added temporarily for the purposes of testing.
-    // eslint-disable-next-line class-methods-use-this
-    async connectPrivateChannel(channelId) {
-        try {
-            const channelClient = await fin.InterApplicationBus.Channel.connect(channelId);
-            const privateChannelClient = new PrivateChannelClient_1.PrivateChannelClient(channelClient, channelId);
-            return this.buildPrivateChannelObject(privateChannelClient);
-        }
-        catch (error) {
-            throw new Error(`Private Channel with id: ${channelId} doesn't exist`);
-        }
-    }
-    // eslint-disable-next-line class-methods-use-this
-    buildPrivateChannelObject(privateChannelClient) {
-        let clientDisconnected = false;
-        const checkIfClientDisconnected = () => {
-            if (clientDisconnected) {
-                throw new Error('Private Channel Client has been disconnected from the Private Channel');
-            }
-        };
-        return {
-            id: privateChannelClient.id,
-            type: 'private',
-            broadcast: async (context) => {
-                checkIfClientDisconnected();
-                return privateChannelClient.broadcast(context);
-            },
-            getCurrentContext: async (contextType) => {
-                checkIfClientDisconnected();
-                return privateChannelClient.getCurrentContext(contextType);
-            },
-            addContextListener: async (contextType, handler) => {
-                checkIfClientDisconnected();
-                let handlerInUse = handler;
-                let contextTypeInUse = contextType;
-                if (typeof contextType === 'function') {
-                    console.warn('addContextListener(handler) has been deprecated. Please use addContextListener(null, handler)');
-                    handlerInUse = contextType;
-                    contextTypeInUse = null;
-                }
-                const listener = privateChannelClient.addContextListener(contextTypeInUse, handlerInUse);
-                return listener;
-            },
-            onAddContextListener: (handler) => {
-                checkIfClientDisconnected();
-                return privateChannelClient.onAddContextListener(handler);
-            },
-            disconnect: async () => {
-                checkIfClientDisconnected();
-                clientDisconnected = true;
-                return privateChannelClient.disconnect();
-            },
-            onDisconnect: (handler) => {
-                checkIfClientDisconnected();
-                return privateChannelClient.onDisconnect(handler);
-            },
-            onUnsubscribe: (handler) => {
-                checkIfClientDisconnected();
-                return privateChannelClient.onUnsubscribe(handler);
-            }
-        };
+        return utils_2.buildPrivateChannelObject(newPrivateChannelClient);
     }
     /**
      * Retrieves a list of the User Channels available for the app to join.

package/src/api/interop/fdc3/utils.d.ts

@@ -1,3 +1,4 @@
+import { PrivateChannelClient } from './PrivateChannelClient';
 export declare class UnsupportedChannelApiError extends Error {
     constructor(apiName: string);
 }
@@ -11,4 +12,7 @@ export declare enum ResultError {
      */
     IntentHandlerRejected = "IntentHandlerRejected"
 }
+export declare const buildPrivateChannelObject: (privateChannelClient: PrivateChannelClient) => FDC3v2.PrivateChannel;
+export declare const buildAppChannelObject: (sessionContextGroup: OpenFin.SessionContextGroup) => FDC3.Channel;
+export declare const connectPrivateChannel: (channelId: string) => Promise<FDC3v2.PrivateChannel>;
 export declare const getIntentResolution: (interopModule: OpenFin.InteropClient, context: OpenFin.Context, app?: FDC3v2.AppIdentifier | FDC3.TargetApp, intent?: string) => Promise<FDC3v2.IntentResolution>;

package/src/api/interop/fdc3/utils.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIntentResolution = exports.ResultError = exports.UnsupportedChannelApiError = void 0;
+exports.getIntentResolution = exports.connectPrivateChannel = exports.buildAppChannelObject = exports.buildPrivateChannelObject = exports.ResultError = exports.UnsupportedChannelApiError = void 0;
 const utils_1 = require("../utils");
+const PrivateChannelClient_1 = require("./PrivateChannelClient");
 class UnsupportedChannelApiError extends Error {
     constructor(apiName) {
         super(apiName);
@@ -20,6 +21,90 @@ var ResultError;
      */
     ResultError["IntentHandlerRejected"] = "IntentHandlerRejected";
 })(ResultError = exports.ResultError || (exports.ResultError = {}));
+exports.buildPrivateChannelObject = (privateChannelClient) => {
+    let clientDisconnected = false;
+    const checkIfClientDisconnected = () => {
+        if (clientDisconnected) {
+            throw new Error('Private Channel Client has been disconnected from the Private Channel');
+        }
+    };
+    return {
+        id: privateChannelClient.id,
+        type: 'private',
+        broadcast: async (context) => {
+            checkIfClientDisconnected();
+            return privateChannelClient.broadcast(context);
+        },
+        getCurrentContext: async (contextType) => {
+            checkIfClientDisconnected();
+            return privateChannelClient.getCurrentContext(contextType);
+        },
+        addContextListener: async (contextType, handler) => {
+            checkIfClientDisconnected();
+            let handlerInUse = handler;
+            let contextTypeInUse = contextType;
+            if (typeof contextType === 'function') {
+                console.warn('addContextListener(handler) has been deprecated. Please use addContextListener(null, handler)');
+                handlerInUse = contextType;
+                contextTypeInUse = null;
+            }
+            const listener = privateChannelClient.addContextListener(contextTypeInUse, handlerInUse);
+            return listener;
+        },
+        onAddContextListener: (handler) => {
+            checkIfClientDisconnected();
+            return privateChannelClient.onAddContextListener(handler);
+        },
+        disconnect: async () => {
+            checkIfClientDisconnected();
+            clientDisconnected = true;
+            return privateChannelClient.disconnect();
+        },
+        onDisconnect: (handler) => {
+            checkIfClientDisconnected();
+            return privateChannelClient.onDisconnect(handler);
+        },
+        onUnsubscribe: (handler) => {
+            checkIfClientDisconnected();
+            return privateChannelClient.onUnsubscribe(handler);
+        }
+    };
+};
+exports.buildAppChannelObject = (sessionContextGroup) => {
+    return {
+        id: sessionContextGroup.id,
+        type: 'app',
+        broadcast: sessionContextGroup.setContext,
+        getCurrentContext: async (contextType) => {
+            const context = await sessionContextGroup.getCurrentContext(contextType);
+            return context === undefined ? null : context;
+        },
+        addContextListener: (contextType, handler) => {
+            let listener;
+            if (typeof contextType === 'function') {
+                console.warn('addContextListener(handler) has been deprecated. Please use addContextListener(null, handler)');
+                listener = sessionContextGroup.addContextHandler(contextType);
+            }
+            else {
+                listener = sessionContextGroup.addContextHandler(handler, contextType === null ? undefined : contextType);
+            }
+            return {
+                ...listener,
+                unsubscribe: () => listener.then((l) => l.unsubscribe())
+            };
+        }
+    };
+};
+exports.connectPrivateChannel = async (channelId) => {
+    try {
+        const channelClient = await fin.InterApplicationBus.Channel.connect(channelId);
+        const privateChannelClient = new PrivateChannelClient_1.PrivateChannelClient(channelClient, channelId);
+        return exports.buildPrivateChannelObject(privateChannelClient);
+    }
+    catch (error) {
+        throw new Error(`Private Channel with id: ${channelId} doesn't exist`);
+    }
+};
 exports.getIntentResolution = async (interopModule, context, app, intent) => {
     // Generate an ID to make a session context group with. We will pass that ID to the Broker.
     // The broker will then setContext on that session context group later with our Intent Result,
@@ -35,13 +120,32 @@ exports.getIntentResolution = async (interopModule, context, app, intent) => {
     const intentObj = intent ? { name: intent, context, metadata } : { ...context, metadata };
     // Set up the getResult call.
     const getResult = async () => {
-        const intentResult = await getResultPromise;
+        let intentResult = await getResultPromise;
         if (!intentResult) {
             throw new Error(ResultError.NoResultReturned);
         }
         if (intentResult instanceof Error) {
             throw new Error(ResultError.IntentHandlerRejected);
         }
+        if (typeof intentResult === 'object') {
+            const { id, type } = intentResult;
+            if (type && id && typeof id === 'string') {
+                switch (type) {
+                    case 'private': {
+                        intentResult = await exports.connectPrivateChannel(id);
+                        break;
+                    }
+                    case 'app': {
+                        const sessionContextGroup = await interopModule.joinSessionContextGroup(id);
+                        intentResult = exports.buildAppChannelObject(sessionContextGroup);
+                        break;
+                    }
+                    default: {
+                        break;
+                    }
+                }
+            }
+        }
         return intentResult;
     };
     // Finally fire the intent.

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

@@ -9,17 +9,17 @@ export declare class TabDragController {
     constructor(viewOverlay: ViewOverlay);
     private dropZonePreview?;
     /**
-     * When a tab is dragged from a stack greater than one, it's view will need to be hidden and the
-     * view next in the stack shown.
      *
-     * Conversely, when a view is the last view in a window, it will need to remain visible.
+     * When a tab is dragged out of a stack, it will need to be hidden from the stack.
      *
-     * This function implements this logic accordingly
-     * @param movingView The view which is currently being dragged
-     * @param currentView The current active view of the tabstack
-     * @param isOnlyViewInWindow Indicates whether the moving view is the only in the platform window.
+     * Additionally, if there is a new view to show in the stack, it will be shown at the position specified by
+     * containerBounds
+     *
+     * @param draggingView The view which is currently being dragged
+     * @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: (movingView: View, currentView: View, isOnlyViewInWindow: boolean) => Promise<void>;
+    handleTabStackActiveView: (draggingView: View, 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.
@@ -38,6 +38,8 @@ export declare class TabDragController {
      * 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.

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

@@ -11,29 +11,28 @@ class TabDragController {
     constructor(viewOverlay) {
         this.viewOverlay = viewOverlay;
         /**
-         * When a tab is dragged from a stack greater than one, it's view will need to be hidden and the
-         * view next in the stack shown.
          *
-         * Conversely, when a view is the last view in a window, it will need to remain visible.
+         * When a tab is dragged out of a stack, it will need to be hidden from the stack.
          *
-         * This function implements this logic accordingly
-         * @param movingView The view which is currently being dragged
-         * @param currentView The current active view of the tabstack
-         * @param isOnlyViewInWindow Indicates whether the moving view is the only in the platform window.
+         * Additionally, if there is a new view to show in the stack, it will be shown at the position specified by
+         * containerBounds
+         *
+         * @param draggingView The view which is currently being dragged
+         * @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 (movingView, currentView, isOnlyViewInWindow) => {
+        this.handleTabStackActiveView = async (draggingView, containerBounds, nextView) => {
             if (this.dropZonePreview) {
-                const hideMovingViewIfPossible = async () => {
-                    if (!isOnlyViewInWindow) {
-                        await movingView.hide();
-                    }
-                };
-                const showCurrentView = async () => {
-                    if (currentView.identity.name !== movingView.identity.name) {
-                        await currentView.show();
-                    }
-                };
-                await Promise.all([hideMovingViewIfPossible(), showCurrentView()]);
+                if (nextView && containerBounds) {
+                    // Due to https://github.com/electron/electron/issues/20064, 
+                    // setBounds does not work in certain scenarios.
+                    // Therefore we call it twice before and after showing to ensure as much 
+                    // visual fidelity as possible (although flicker can still occur).
+                    await (nextView === null || nextView === void 0 ? void 0 : nextView.setBounds(containerBounds));
+                    await (nextView === null || nextView === void 0 ? void 0 : nextView.show());
+                    await (nextView === null || nextView === void 0 ? void 0 : nextView.setBounds(containerBounds));
+                }
+                await draggingView.hide();
             }
         };
         /**
@@ -63,6 +62,12 @@ class TabDragController {
         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.
@@ -74,7 +79,7 @@ class TabDragController {
                 this.dropZonePreview = dropZonePreview;
                 let lastBounds;
                 dropZonePreview.style.visibility = 'hidden';
-                dropZonePreview.addEventListener('drop-area-highlighted', async (e) => {
+                const onDropAreaHighlighted = async (e) => {
                     try {
                         const { bounds } = e.detail;
                         if (!lastBounds || !bounds_observer_1.isDomRectEqual(lastBounds, bounds)) {
@@ -85,8 +90,8 @@ class TabDragController {
                     catch (error) {
                         console.warn('Unexpected error encountered rendering tab drag preview.', error);
                     }
-                });
-                dropZonePreview.addEventListener('drop-area-hidden', async () => {
+                };
+                const onDropAreaHidden = async () => {
                     try {
                         lastBounds = undefined;
                         await this.viewOverlay.detachOverlay();
@@ -94,7 +99,16 @@ class TabDragController {
                     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.');
             }
         };
     }

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

@@ -16,6 +16,36 @@ import UpdatableViewOptions = OpenFin.UpdatableViewOptions;
  *
  * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
  *
+ * @property {object} [accelerator]
+ * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
+ *
+ * @property {boolean} [accelerator.devtools=false]
+ * If `true`, enables the devtools keyboard shortcut:<br>
+ * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
+ *
+ * @property {boolean} [accelerator.reload=false]
+ * If `true`, enables the reload keyboard shortcuts:<br>
+ * `Ctrl` + `R` _(Windows)_<br>
+ * `F5` _(Windows)_<br>
+ * `Command` + `R` _(Mac)_
+ *
+ * @property {boolean} [accelerator.reloadIgnoringCache=false]
+ * If `true`, enables the reload-from-source keyboard shortcuts:<br>
+ * `Ctrl` + `Shift` + `R` _(Windows)_<br>
+ * `Shift` + `F5` _(Windows)_<br>
+ * `Command` + `Shift` + `R` _(Mac)_
+ *
+ * @property {boolean} [accelerator.zoom=false]
+ * If `true`, enables the zoom keyboard shortcuts:<br>
+ * `Ctrl` + `+` _(Zoom In)_<br>
+ * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
+ * `Ctrl` + `NumPad+` _(Zoom In)_<br>
+ * `Ctrl` + `-` _(Zoom Out)_<br>
+ * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
+ * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
+ * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
+ * `Ctrl` + `0` _(Restore to 100%)_
+ *
  * @property {object} [api]
  * Configurations for API injection.
  *
@@ -127,7 +157,7 @@ import UpdatableViewOptions = OpenFin.UpdatableViewOptions;
  * really no need to provide it.
  */
 /**
- * @classdesc a View can be used to embed additional web content into a Window.
+ * @classdesc A View can be used to embed additional web content into a Window.
  * It is like a child window, except it is positioned relative to its owning window.
  * It has the ability to listen for <a href="tutorial-View.EventEmitter.html">View-specific events</a>.
  *

package/src/api/view/Instance.js

@@ -19,6 +19,36 @@ const window_1 = require("../window");
  *
  * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
  *
+ * @property {object} [accelerator]
+ * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
+ *
+ * @property {boolean} [accelerator.devtools=false]
+ * If `true`, enables the devtools keyboard shortcut:<br>
+ * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
+ *
+ * @property {boolean} [accelerator.reload=false]
+ * If `true`, enables the reload keyboard shortcuts:<br>
+ * `Ctrl` + `R` _(Windows)_<br>
+ * `F5` _(Windows)_<br>
+ * `Command` + `R` _(Mac)_
+ *
+ * @property {boolean} [accelerator.reloadIgnoringCache=false]
+ * If `true`, enables the reload-from-source keyboard shortcuts:<br>
+ * `Ctrl` + `Shift` + `R` _(Windows)_<br>
+ * `Shift` + `F5` _(Windows)_<br>
+ * `Command` + `Shift` + `R` _(Mac)_
+ *
+ * @property {boolean} [accelerator.zoom=false]
+ * If `true`, enables the zoom keyboard shortcuts:<br>
+ * `Ctrl` + `+` _(Zoom In)_<br>
+ * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
+ * `Ctrl` + `NumPad+` _(Zoom In)_<br>
+ * `Ctrl` + `-` _(Zoom Out)_<br>
+ * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
+ * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
+ * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
+ * `Ctrl` + `0` _(Restore to 100%)_
+ *
  * @property {object} [api]
  * Configurations for API injection.
  *
@@ -130,7 +160,7 @@ const window_1 = require("../window");
  * really no need to provide it.
  */
 /**
- * @classdesc a View can be used to embed additional web content into a Window.
+ * @classdesc A View can be used to embed additional web content into a Window.
  * It is like a child window, except it is positioned relative to its owning window.
  * It has the ability to listen for <a href="tutorial-View.EventEmitter.html">View-specific events</a>.
  *