@openfin/core 27.71.5 → 27.71.6

package/OpenFin.d.ts

@@ -254,6 +254,19 @@ declare namespace OpenFin {
 
     export type WindowOptions = MutableWindowOptions & ConstWindowOptions;
 
+    export interface ShowViewOnWindowResizeOptions {
+        enabled?: boolean;
+        paintIntervalMs?: number;
+    }
+
+    export interface ShowViewOnSplitterDragOptions {
+        enabled?: boolean;
+    }
+    export type ViewVisibilityOptions = {
+        showViewsOnWindowResize?: ShowViewOnWindowResizeOptions;
+        showViewsOnSplitterDrag?: ShowViewOnSplitterDragOptions;
+    };
+
     export type WindowState = 'maximized' | 'minimized' | 'normal';
 
     export type ConstWindowOptions = {
@@ -294,6 +307,8 @@ declare namespace OpenFin {
         y: number;
         experimental?: any;
         fdc3InteropApi?: string;
+        // Platform only
+        viewVisibility?: ViewVisibilityOptions;
     };
 
     export type MutableWindowOptions = {
@@ -301,7 +316,9 @@ declare namespace OpenFin {
         alwaysOnTop: boolean;
         aspectRatio: number;
         contextMenu: boolean;
+        // DEPRECATED
         contextMenuSettings: ContextMenuSettings;
+        contextMenuOptions: ContextMenuOptions;
         cornerRounding: Partial<CornerRounding>;
         customContext: any;
         customData: any;
@@ -401,6 +418,7 @@ declare namespace OpenFin {
         green: number;
     };
 
+    // DEPRECATED
     export type ContextMenuSettings = {
         enable: boolean;
         devtools?: boolean;
@@ -469,7 +487,10 @@ declare namespace OpenFin {
 
     export type MutableViewOptions = {
         autoResize: AutoResizeOptions;
+        contextMenu: boolean;
+        // DEPRECATED
         contextMenuSettings: ContextMenuSettings;
+        contextMenuOptions: ContextMenuOptions;
         backgroundColor: string;
         customData: any;
         customContext: any;
@@ -1108,6 +1129,7 @@ declare namespace OpenFin {
     export type RvmLaunchOptions = {
         noUi?: boolean;
         userAppConfigArgs?: object;
+        timeToLive?: number;
     };
 
     export type ShortCutConfig = {
@@ -1324,6 +1346,7 @@ declare namespace OpenFin {
          * Defaults to 'normal' unless a 'submenu' key exists
          */
         type?: 'normal' | 'separator' | 'submenu' | 'checkbox';
+        role?: 'cut' | 'copy' | 'paste' | 'toggleDevTools' | 'reload';
         label?: string;
         /**
          * If false, the menu item will be greyed out and unclickable.
@@ -1348,7 +1371,7 @@ declare namespace OpenFin {
         /**
          * Data to be returned if the user selects the element. Must be serializable
          */
-        data: any;
+        data?: any;
 
         /**
          * Image Data URI with image dimensions inferred from the encoded string
@@ -1668,4 +1691,21 @@ declare namespace OpenFin {
     export type PlatformEvents = import('./src/api/events/platform').PlatformEvents;
 
     export type ExternalApplicationEvents = import('./src/api/events/externalApplication').ExternalApplicationEvents;
+
+    export type ContextMenuOptions = {
+        template: Array<PrebuiltContextMenuItems>;
+        enabled?: boolean;
+    };
+
+    export type PrebuiltContextMenuItems =
+        | 'separator'
+        | 'cut'
+        | 'copy'
+        | 'paste'
+        | 'spellCheck'
+        | 'inspect'
+        | 'reload'
+        | 'navigateForward'
+        | 'navigateBack'
+        | 'print';
 }

package/package.json

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

package/src/api/application/Factory.d.ts

@@ -111,12 +111,13 @@ export default class ApplicationModule extends Base {
      * Asynchronously starts a batch of applications given an array of application identifiers and manifestUrls.
      * Returns once the RVM is finished attempting to launch the applications.
      * @param { Array.<ManifestInfo> } applications
+     * @param {RvmLaunchOptions} [opts] - Parameters that the RVM will use.
      * @return {Promise.<void>}
      * @static
      * @tutorial Application.startManyManifests
      * @experimental
      */
-    startManyManifests(applications: Array<OpenFin.ManifestInfo>): Promise<void>;
+    startManyManifests(applications: Array<OpenFin.ManifestInfo>, opts?: OpenFin.RvmLaunchOptions): Promise<void>;
     /**
      * Asynchronously returns an Application object that represents the current application
      * @return {Promise.<Application>}

package/src/api/application/Factory.js

@@ -156,13 +156,14 @@ class ApplicationModule extends base_1.Base {
      * Asynchronously starts a batch of applications given an array of application identifiers and manifestUrls.
      * Returns once the RVM is finished attempting to launch the applications.
      * @param { Array.<ManifestInfo> } applications
+     * @param {RvmLaunchOptions} [opts] - Parameters that the RVM will use.
      * @return {Promise.<void>}
      * @static
      * @tutorial Application.startManyManifests
      * @experimental
      */
-    async startManyManifests(applications) {
-        return this.wire.sendAction('run-applications', { applications }).then(() => undefined);
+    async startManyManifests(applications, opts) {
+        return this.wire.sendAction('run-applications', { applications, opts }).then(() => undefined);
     }
     /**
      * Asynchronously returns an Application object that represents the current application

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

@@ -18,6 +18,8 @@ exports.LayoutModule = void 0;
 /* eslint-disable no-undef, import/prefer-default-export */
 const Instance_1 = require("./Instance");
 const base_1 = require("../../base");
+const SplitterController_1 = require("./SplitterController");
+const view_overlay_1 = require("./SplitterController/view-overlay");
 /**
  * InitLayoutOptions interface
  * @typedef { object } InitLayoutOptions
@@ -105,7 +107,9 @@ class LayoutModule extends base_1.Base {
             }
             // We need to go through environment to make sure it is only imported/bundled in OpenFin.
             const ManagerConstructor = await this.wire.environment.getManagerConstructor();
-            __classPrivateFieldSet(this, _layoutManager, new ManagerConstructor());
+            const viewOverlay = new view_overlay_1.ViewOverlay(this.wire);
+            const splitterController = new SplitterController_1.SplitterController(viewOverlay);
+            __classPrivateFieldSet(this, _layoutManager, new ManagerConstructor(splitterController));
             // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
             // @ts-ignore - layout warning here for backwards compatibility, can remove layout check in .52
             let { layout, containerId } = options;

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

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+export declare const observeBounds: (element: Element, onChange: (bounds: DOMRect) => void) => () => void;

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

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.observeBounds = void 0;
+/**
+ * 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.
+ */
+exports.observeBounds = (element, onChange) => {
+    let lastBounds;
+    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;
+    };
+    const checkBounds = () => {
+        const currentBounds = element.getBoundingClientRect();
+        if (!lastBounds || !isDomRectEqual(lastBounds, currentBounds)) {
+            lastBounds = currentBounds;
+            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();
+    };
+};

package/src/api/platform/layout/SplitterController/index.d.ts

@@ -0,0 +1,29 @@
+import { ViewOverlay } from './view-overlay';
+export declare type SplitterItem = GoldenLayout.ContentItem & {
+    viewEventsAdded: boolean;
+    isVertical: boolean;
+};
+/**
+ * Utility class for managing Golden Layout splitter drag interactions.
+ */
+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/SplitterController/index.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SplitterController = void 0;
+const bounds_observer_1 = require("./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.
+ */
+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({ bounds: offsetBounds, backgroundColor });
+                };
+                const teardownBoundsObserver = 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/SplitterController/view-overlay.d.ts

@@ -0,0 +1,23 @@
+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.
+ */
+export declare class ViewOverlay {
+    private wire;
+    constructor(wire: Transport);
+    /**
+     * Renders the overlay at the specified position relative to the calling window.
+     * @param options Bounds and background color to display in the overlay.
+     */
+    renderOverlay: (options: {
+        bounds: OpenFin.Bounds;
+        backgroundColor: string;
+    }) => Promise<void>;
+    /**
+     * Removes the overlay from the current window.
+     */
+    detachOverlay: () => Promise<void>;
+}

package/src/api/platform/layout/SplitterController/view-overlay.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewOverlay = void 0;
+/**
+ * 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.
+ */
+class ViewOverlay {
+    // eslint-disable-next-line
+    constructor(wire) {
+        this.wire = wire;
+        /**
+         * Renders the overlay at the specified position relative to the calling window.
+         * @param options Bounds and background color to display in the overlay.
+         */
+        this.renderOverlay = async (options) => {
+            const { bounds, backgroundColor } = options;
+            await this.wire.sendAction('render-overlay', { bounds, backgroundColor });
+        };
+        /**
+         * Removes the overlay from the current window.
+         */
+        this.detachOverlay = async () => {
+            await this.wire.sendAction('detach-overlay');
+        };
+    }
+}
+exports.ViewOverlay = ViewOverlay;

package/src/api/system/index.d.ts

@@ -397,6 +397,7 @@ import ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
  * @typedef { object } RvmLaunchOptions
  * @property { boolean } [noUi] true if no UI when launching
  * @property { object } [userAppConfigArgs] The user app configuration args
+ * @property { number } [timeToLive] Timeout in seconds until RVM launch request expires
  */
 /**
  * ServiceIdentifier interface

package/src/api/system/index.js

@@ -387,6 +387,7 @@ const window_1 = require("../window");
  * @typedef { object } RvmLaunchOptions
  * @property { boolean } [noUi] true if no UI when launching
  * @property { object } [userAppConfigArgs] The user app configuration args
+ * @property { number } [timeToLive] Timeout in seconds until RVM launch request expires
  */
 /**
  * ServiceIdentifier interface

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

@@ -57,11 +57,14 @@ import UpdatableViewOptions = OpenFin.UpdatableViewOptions;
  * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
  *
  * @property {any} [customData=""] - _Updatable._
- * A field that the user can attach serializable data to to be ferried around with the view options.
+ * A field that the user can attach serializable data to be ferried around with the view options.
  * _When omitted, the default value of this property is the empty string (`""`)._
  *
+ * @property {any} [customContext=""] - _Updatable._
+ * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
+ * is called.
  * When omitted, the default value of this property is the empty string (`""`).
- * As opposed to customData this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
+ * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
  *
  * @property {object[]} [hotkeys=[]] - _Updatable._
  * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.

package/src/api/view/Instance.js

@@ -60,11 +60,14 @@ const window_1 = require("../window");
  * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
  *
  * @property {any} [customData=""] - _Updatable._
- * A field that the user can attach serializable data to to be ferried around with the view options.
+ * A field that the user can attach serializable data to be ferried around with the view options.
  * _When omitted, the default value of this property is the empty string (`""`)._
  *
+ * @property {any} [customContext=""] - _Updatable._
+ * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
+ * is called.
  * When omitted, the default value of this property is the empty string (`""`).
- * As opposed to customData this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
+ * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
  *
  * @property {object[]} [hotkeys=[]] - _Updatable._
  * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.

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

@@ -171,16 +171,16 @@ import WindowEvents = OpenFin.WindowEvents;
  * @property {number} [cornerRounding.height=0] The height in pixels.
  * @property {number} [cornerRounding.width=0] The width in pixels.
  *
- * @property {any} [customContext=""] - _Updatable._
+ * @property {any} [customContext=""] - _Updatable. Inheritable._
  * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
  * is called.  If a window in a Platform is trying to update or retrieve its own context, it can use the
  * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
- * When omitted, the default value of this property is the empty string (`""`).
- * As opposed to customData this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
+ * _When omitted, _inherits_ from the parent application._
+ * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
  *
- * @property {any} [customData=""] - _Updatable._
- * A field that the user can attach serializable data to to be ferried around with the window options.
- * _When omitted, the default value of this property is the empty string (`""`)._
+ * @property {any} [customData=""] - _Updatable. Inheritable._
+ * A field that the user can attach serializable data to be ferried around with the window options.
+ * _When omitted, _inherits_ from the parent application._
  *
  * @property {object[]} [customRequestHeaders]
  * Defines list of custom headers for requests sent by the window.
@@ -235,7 +235,7 @@ import WindowEvents = OpenFin.WindowEvents;
  *
  * @property {string} [icon] - _Updatable. Inheritable._
  * A URL for the icon to be shown in the window title bar and the taskbar.
- * _When omitted, inherits from the parent application._
+ * When omitted, inherits from the parent application._
  *  note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
  *
  * @property {number} [maxHeight=-1] - _Updatable._
@@ -333,6 +333,23 @@ import WindowEvents = OpenFin.WindowEvents;
  * @property {boolean} [waitForPageLoad=false]
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
+ *
+ * @property {ViewVisibility} [viewVisibility]
+ * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
+ */
+/**
+ * @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.
+ */
+/**
+ * @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.
+ */
+/**
+ * @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.
  */
 /**
  * @typedef {object} CapturePageOptions

package/src/api/window/Instance.js

@@ -178,16 +178,16 @@ const view_1 = require("../view");
  * @property {number} [cornerRounding.height=0] The height in pixels.
  * @property {number} [cornerRounding.width=0] The width in pixels.
  *
- * @property {any} [customContext=""] - _Updatable._
+ * @property {any} [customContext=""] - _Updatable. Inheritable._
  * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
  * is called.  If a window in a Platform is trying to update or retrieve its own context, it can use the
  * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
- * When omitted, the default value of this property is the empty string (`""`).
- * As opposed to customData this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
+ * _When omitted, _inherits_ from the parent application._
+ * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
  *
- * @property {any} [customData=""] - _Updatable._
- * A field that the user can attach serializable data to to be ferried around with the window options.
- * _When omitted, the default value of this property is the empty string (`""`)._
+ * @property {any} [customData=""] - _Updatable. Inheritable._
+ * A field that the user can attach serializable data to be ferried around with the window options.
+ * _When omitted, _inherits_ from the parent application._
  *
  * @property {object[]} [customRequestHeaders]
  * Defines list of custom headers for requests sent by the window.
@@ -242,7 +242,7 @@ const view_1 = require("../view");
  *
  * @property {string} [icon] - _Updatable. Inheritable._
  * A URL for the icon to be shown in the window title bar and the taskbar.
- * _When omitted, inherits from the parent application._
+ * When omitted, inherits from the parent application._
  *  note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
  *
  * @property {number} [maxHeight=-1] - _Updatable._
@@ -340,6 +340,23 @@ const view_1 = require("../view");
  * @property {boolean} [waitForPageLoad=false]
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
+ *
+ * @property {ViewVisibility} [viewVisibility]
+ * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
+ */
+/**
+ * @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.
+ */
+/**
+ * @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.
+ */
+/**
+ * @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.
  */
 /**
  * @typedef {object} CapturePageOptions

package/src/shapes/protocol.d.ts

@@ -68,98 +68,29 @@ export interface ProtocolMap extends ProtocolMapBase {
         request: OpenFin.Identity;
         response: void;
     };
-    'fdc3-add-context-listener': {
-        request: void;
-        response: void;
-    };
-    'fdc3-broadcast': {
-        request: void;
-        response: void;
-    };
-    'fdc3-get-system-channels': {
-        request: void;
-        response: void;
-    };
-    'fdc3-join-channel': {
-        request: void;
-        response: void;
-    };
-    'fdc3-leave-current-channel': {
-        request: void;
-        response: void;
-    };
-    'interop-connect-sync': {
-        request: void;
-        response: void;
-    };
-    'interop-client-set-context': {
-        request: void;
-        response: void;
-    };
-    'interop-client-add-context-handler': {
-        request: void;
-        response: void;
-    };
-    'interop-client-get-context-groups': {
-        request: void;
-        response: void;
-    };
-    'interop-client-join-context-group': {
-        request: void;
-        response: void;
-    };
-    'interop-client-remove-from-context-group': {
-        request: void;
-        response: void;
-    };
-    'interop-client-get-all-clients-in-context-group': {
-        request: void;
-        response: void;
-    };
-    'interop-client-get-info-for-context-group': {
-        request: void;
-        response: void;
-    };
-    'interop-broker-add-client-to-context-group': {
-        request: void;
-        response: void;
-    };
-    'interop-broker-get-all-clients-in-context-group': {
-        request: void;
-        response: void;
-    };
-    'interop-broker-get-context-groups': {
-        request: void;
-        response: void;
-    };
-    'interop-broker-get-info-for-context-group': {
-        request: void;
-        response: void;
-    };
-    'interop-broker-is-action-authorized': {
-        request: void;
-        response: void;
-    };
-    'interop-broker-is-connection-authorized': {
-        request: void;
-        response: void;
-    };
-    'interop-broker-join-context-group': {
-        request: void;
-        response: void;
-    };
-    'interop-broker-remove-client-from-context-group': {
-        request: void;
-        response: void;
-    };
-    'interop-broker-remove-from-context-group': {
-        request: void;
-        response: void;
-    };
-    'interop-broker-set-context': {
-        request: void;
-        response: void;
-    };
+    'fdc3-add-context-listener': VoidCall;
+    'fdc3-broadcast': VoidCall;
+    'fdc3-get-system-channels': VoidCall;
+    'fdc3-join-channel': VoidCall;
+    'fdc3-leave-current-channel': VoidCall;
+    'interop-connect-sync': VoidCall;
+    'interop-client-set-context': VoidCall;
+    'interop-client-add-context-handler': VoidCall;
+    'interop-client-get-context-groups': VoidCall;
+    'interop-client-join-context-group': VoidCall;
+    'interop-client-remove-from-context-group': VoidCall;
+    'interop-client-get-all-clients-in-context-group': VoidCall;
+    'interop-client-get-info-for-context-group': VoidCall;
+    'interop-broker-add-client-to-context-group': VoidCall;
+    'interop-broker-get-all-clients-in-context-group': VoidCall;
+    'interop-broker-get-context-groups': VoidCall;
+    'interop-broker-get-info-for-context-group': VoidCall;
+    'interop-broker-is-action-authorized': VoidCall;
+    'interop-broker-is-connection-authorized': VoidCall;
+    'interop-broker-join-context-group': VoidCall;
+    'interop-broker-remove-client-from-context-group': VoidCall;
+    'interop-broker-remove-from-context-group': VoidCall;
+    'interop-broker-set-context': VoidCall;
     'query-permission-for-current-context': {
         request: {
             apiName: string;
@@ -188,7 +119,23 @@ export interface ProtocolMap extends ProtocolMapBase {
         };
         response: void;
     };
+    'render-overlay': {
+        request: {
+            bounds: OpenFin.Bounds;
+            backgroundColor: string;
+        };
+        response: void;
+    };
+    'detach-overlay': VoidCall;
+    'system-get-printers': {
+        request: void;
+        response: OpenFin.PrinterInfo[];
+    };
 }
+declare type VoidCall = {
+    request: void;
+    response: void;
+};
 interface ProtocolMapBase {
     [action: string]: {
         request: any;