@openfin/core 25.68.26

package/src/api/window/Instance.js

@@ -0,0 +1,1202 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._Window = void 0;
+/* eslint-disable import/prefer-default-export */
+const application_1 = require("../application");
+const main_1 = require("../webcontents/main");
+const view_1 = require("../view");
+/**
+ * @typedef { object } Margins
+ * @property { string } [marginType]
+ * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
+ * you will also need to specify `top`, `bottom`, `left`, and `right`.
+ *
+ * @property { number } [top] The top margin of the printed web page, in pixels.
+ * @property { number } [bottom] The bottom margin of the printed web page, in pixels.
+ * @property { number } [left] The left margin of the printed web page, in pixels.
+ * @property { number } [right] The right margin of the printed web page, in pixels.
+ */
+/**
+ * @typedef { object } Dpi
+ * @property { number } [horizontal] The horizontal dpi
+ * @property { number } [vertical] The vertical dpi
+ */
+/**
+ * @typedef { object } PrintOptions
+ * @property { boolean } [silent=false] Don't ask user for print settings.
+ * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
+ * @property { string } [deviceName=''] Set the printer device name to use.
+ * @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
+ * @property { Margins } [margins] Set margins for the printed web page
+ * @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
+ * @property { number } [scaleFactor] The scale factor of the web page.
+ * @property { number } [pagesPerSheet] The number of pages to print per page sheet.
+ * @property { boolean } [collate] Whether the web page should be collated.
+ * @property { number } [copies] The number of copies of the web page to print.
+ * @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
+ * @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
+ * @property { Dpi } [dpi] Set dpi for the printed web page
+ */
+/**
+ * PrinterInfo interface
+ * @typedef { object } PrinterInfo
+ * @property { string } name Printer Name
+ * @property { string } description Printer Description
+ * @property { number } status Printer Status
+ * @property { boolean } isDefault Indicates that system's default printer
+ */
+/**
+ * SharedWorkerInfo interface
+ * @typedef { object } SharedWorkerInfo
+ * @property { string } id The unique id of the shared worker.
+ * @property { string } url The url of the shared worker.
+ */
+/**
+ * ContentCreationRule interface
+ * @typedef { object } ContentCreationRule
+ * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
+ * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
+ * @property { object } options Window creation options or View creation options.
+ */
+/**
+ * @typedef {object} Window~options
+ * @summary Window creation options.
+ * @desc This is the options object required by {@link Window.create Window.create}.
+ *
+ * Note that `name` is the only required property — albeit the `url` property is usually provided as well
+ * (defaults to `"about:blank"` when omitted).
+ *
+ * _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
+ *
+ * @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} [alphaMask] - _Experimental._  _Updatable._
+ * <br>
+ * alphaMask turns anything of matching RGB value transparent.
+ * <br>
+ * Caveats:
+ * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
+ * * User cannot click-through transparent regions
+ * * Not supported on Mac
+ * * Windows Aero must be enabled
+ * * Won't make visual sense on Pixel-pushed environments such as Citrix
+ * * Not supported on rounded corner windows
+ * @property {number} [alphaMask.red=-1] 0-255
+ * @property {number} [alphaMask.green=-1] 0-255
+ * @property {number} [alphaMask.blue=-1] 0-255
+ *
+ * @property {boolean} [alwaysOnTop=false] - _Updatable._
+ * A flag to always position the window at the top of the window stack.
+ *
+ * @property {object} [api]
+ * Configurations for API injection.
+ *
+ * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
+ *
+ * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
+ * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
+ *
+ * @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
+ *
+ * @property {number} [aspectRatio=0] - _Updatable._
+ * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
+ * an aspect ratio will not be enforced.
+ *
+ * @property {boolean} [autoShow=true]
+ * A flag to automatically show the window when it is created.
+ *
+ * @property {string} [backgroundColor="#FFF"]
+ * The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
+ * (`document.body.style.backgroundColor`),
+ * this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
+ * areas when growing a window. Setting
+ * this value to the anticipated content background color can help improve user experience.
+ * Default is white.
+ *
+ * @property {object} [contentCreation]
+ * Apply rules that determine how user interaction (`window.open` and links) creates content.
+ * @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
+ *
+ * @property {object} [contentNavigation]
+ * Restrict navigation to URLs that match a whitelisted pattern.
+ * In the lack of a whitelist, navigation to URLs that match a blacklisted pattern would be prohibited.
+ * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
+ * @property {string[]} [contentNavigation.whitelist=[]] List of whitelisted URLs.
+ * @property {string[]} [contentNavigation.blacklist=[]] List of blacklisted URLs.
+
+ * @property {boolean} [contextMenu=true] - _Updatable._
+ * A flag to show the context menu when right-clicking on a window.
+ * Gives access to the devtools for the window.
+ *
+ * @property {object} [contextMenuSettings] - _Updatable._
+ * Configure the context menu when right-clicking on a window.
+ * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
+ * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
+ * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
+ *
+ * @property {object} [cornerRounding] - _Updatable._
+ * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
+ *  average of _height_ and _width_.
+ * @property {number} [cornerRounding.height=0] The height in pixels.
+ * @property {number} [cornerRounding.width=0] The width in pixels.
+ *
+ * @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.  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}
+ *
+ * @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 {object[]} [customRequestHeaders]
+ * Defines list of custom headers for requests sent by the window.
+ * @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
+ * @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
+ * where the object key is the name of header and value at key is the value of the header
+ *
+ * @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._  _Updatable._
+ * Toggling off would keep the Window alive even if all its Views were closed.
+ * This is meant for advanced users and should be used with caution.
+ * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
+ * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
+ * ** note ** - This option is ignored in non-Platforms apps.
+ *
+ * @property {boolean} [defaultCentered=false]
+ * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
+ * this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
+ * somewhat above center vertically.
+ *
+ * @property {number} [defaultHeight=500]
+ * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
+ * in favor of the cached value.
+ *
+ * @property {number} [defaultLeft=100]
+ * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
+ * launches in favor of the cached value.
+ *
+ * @property {number} [defaultTop=100]
+ * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
+ * launches in favor of the cached value.
+ *
+ * @property {number} [defaultWidth=800]
+ * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
+ * launches in favor of the cached value.
+ *
+ * @property {boolean} [includeInSnapshots=true] - _Updatable._
+ * When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
+ * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
+ *
+ * @property {boolean} [frame=true] - _Updatable._
+ * A flag to show the frame.
+ *
+ * @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
+ *
+ * @property {object[]} [hotkeys=[]] - _Updatable._
+ * Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
+ * Within Platform, OpenFin also implements a set of pre-defined actions called
+ * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
+ * that can be assigned to a specific hotkey in the platform manifest.
+ * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
+ * @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
+ *
+ * @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._
+ *  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._
+ * The maximum height of a window. Will default to the OS defined value if set to -1.
+ *
+ * @property {boolean} [maximizable=true] - _Updatable._
+ * A flag that lets the window be maximized.
+ *
+ * @property {number} [maxWidth=-1] - _Updatable._
+ * The maximum width of a window. Will default to the OS defined value if set to -1.
+ *
+ * @property {number} [minHeight=0] - _Updatable._
+ * The minimum height of a window.
+ *
+ * @property {boolean} [minimizable=true] - _Updatable._
+ * A flag that lets the window be minimized.
+ *
+ * @property {number} [minWidth=0] - _Updatable._
+ * The minimum width of a window.
+ *
+ * @property {Identity} [modalParentIdentity]
+ * Parent identity of a modal window. It will create a modal child window when this option is set.
+ *
+ * @property {string} name
+ * The name of the window.
+ *
+ * @property {number} [opacity=1.0] - _Updatable._
+ * A flag that specifies how transparent the window will be.
+ * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
+ * This value is clamped between `0.0` and `1.0`.
+ *
+ * @property {preloadScript[]} [preloadScripts] - _Inheritable_
+ * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
+ * from the parent application.
+ *
+ * @property {string} [processAffinity]
+ * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
+ *
+ * @property {boolean} [resizable=true] - _Updatable._
+ * A flag to allow the user to resize the window.
+ *
+ * @property {object} [resizeRegion] - _Updatable._
+ * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
+ * @property {number} [resizeRegion.bottomRightCorner=9]
+ * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
+ * @property {number} [resizeRegion.size=7]
+ * The size in pixels.
+ * @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
+ * Sides that a window can be resized from.
+ *
+ * @property {boolean} [saveWindowState=true]
+ * A flag to cache the location of the window.
+ * ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
+ *
+ * @property {boolean} [shadow=false]
+ * A flag to display a shadow on frameless windows.
+ * `shadow` and `cornerRounding` are mutually exclusive.
+ * On Windows 7, Aero theme is required.
+ *
+ * @property {boolean} [showBackgroundImages=false] - _Updatable._
+ * Platforms Only.  If true, will show background images in the layout when the Views are hidden.
+ * This occurs when the window is resizing or a tab is being dragged within the layout.
+ *
+ * @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
+ * A flag to show the window's icon in the taskbar.
+ *
+ * @property {boolean} [smallWindow=false]
+ * A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
+ * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
+ * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
+ *
+ * @property {string} [state="normal"]
+ * The visible state of the window on creation.
+ * One of:
+ * * `"maximized"`
+ * * `"minimized"`
+ * * `"normal"`
+ *
+ * @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
+ *
+ * @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
+ * Specify a taskbar group for the window.
+ * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
+ *
+ * @property {string} [url="about:blank"]
+ * The URL of the window.
+ *
+ * @property {string} [uuid=<application uuid>]
+ * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
+ * If omitted, defaults to the `uuid` of the application spawning the window.
+ * If given, must match the `uuid` of the  application spawning the window.
+ * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
+ * really no need to provide it.
+ *
+ * @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.
+ */
+/**
+ * @typedef {object} CapturePageOptions
+ * @property { Area } [area] The area of the window to be captured.
+ * @property { string } [format='png'] The format of the captured image.  Can be 'png', 'jpg', or 'bmp'.
+ * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
+ */
+/**
+ * @typedef { object } Area
+ * @property { number } height Area's height
+ * @property { number } width Area's width
+ * @property { number } x X coordinate of area's starting point
+ * @property { number } y Y coordinate of area's starting point
+ */
+/**
+ * @typedef {object} FindInPageOptions
+ * @property {boolean} [forward=true] Whether to search forward or backward.
+ * @property {boolean} [findNext=false] Whether to begin a new text finding session. Should be true for first requests, and false for subsequent requests. Defaults to false.
+ * @property {boolean} [matchCase=false] Whether search should be case-sensitive.
+ * @property {boolean} [wordStart=false] Whether to look only at the start of words.
+ * @property {boolean} [medialCapitalAsWordStart=false]
+ * When combined with wordStart, accepts a match in the middle of a word if the match begins with an uppercase letter followed by a<br>
+ * lowercase or non-letter. Accepts several other intra-word matches.
+ */
+/**
+ * @typedef {object} Transition
+ * @property {Opacity} opacity - The Opacity transition
+ * @property {Position} position - The Position transition
+ * @property {Size} size - The Size transition
+ */
+/**
+ * @typedef {object} TransitionOptions
+ * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
+this animation onto the end of the animation queue.
+ * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
+ */
+/**
+ * @typedef {object} Size
+ * @property {number} duration - The total time in milliseconds this transition should take.
+ * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
+ * @property {number} width - Optional if height is present. Defaults to the window's current width.
+ * @property {number} height - Optional if width is present. Defaults to the window's current height.
+ */
+/**
+ * @typedef {object} Position
+ * @property {number} duration - The total time in milliseconds this transition should take.
+ * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
+ * @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
+ * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
+ */
+/**
+ * @typedef {object} Opacity
+ * @property {number} duration - The total time in milliseconds this transition should take.
+ * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
+ * @property {number} opacity - This value is clamped from 0.0 to 1.0.
+ */
+/**
+ * Bounds is a interface that has the properties of height,
+ * width, left, top which are all numbers
+ * @typedef { object } Bounds
+ * @property { number } height Get the application height bound
+ * @property { number } width Get the application width bound
+ * @property { number } top Get the application top bound
+ * @property { number } left Get the application left bound
+ * @property { number } right Get the application right bound
+ * @property { number } bottom Get the application bottom bound
+ */
+/**
+ * @classdesc A basic window that wraps a native HTML window. Provides more fine-grained
+ * control over the window state such as the ability to minimize, maximize, restore, etc.
+ * By default a window does not show upon instantiation; instead the window's show() method
+ * must be invoked manually. The new window appears in the same process as the parent window.
+ * It has the ability to listen for <a href="tutorial-Window.EventEmitter.html">window specific events</a>.
+ * @class
+ * @alias Window
+ * @hideconstructor
+ */
+// The window.Window name is taken
+class _Window extends main_1.WebContents {
+    constructor(wire, identity) {
+        super(wire, identity, 'window');
+        this.identity = identity;
+    }
+    /**
+     * Adds a listener to the end of the listeners array for the specified event.
+     * @param { string | symbol } eventType  - The type of the event.
+     * @param { Function } listener - Called whenever an event of the specified type occurs.
+     * @param { SubOptions } [options] - Option to support event timestamps.
+     * @return {Promise.<this>}
+     * @function addListener
+     * @memberof Window
+     * @instance
+     * @tutorial Window.EventEmitter
+     */
+    /**
+     * Adds a listener to the end of the listeners array for the specified event.
+     * @param { string | symbol } eventType  - The type of the event.
+     * @param { Function } listener - Called whenever an event of the specified type occurs.
+     * @param { SubOptions } [options] - Option to support event timestamps.
+     * @return {Promise.<this>}
+     * @function on
+     * @memberof Window
+     * @instance
+     * @tutorial Window.EventEmitter
+     */
+    /**
+     * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
+     * @param { string | symbol } eventType  - The type of the event.
+     * @param { Function } listener - The callback function.
+     * @param { SubOptions } [options] - Option to support event timestamps.
+     * @return {Promise.<this>}
+     * @function once
+     * @memberof Window
+     * @instance
+     * @tutorial Window.EventEmitter
+     */
+    /**
+     * Adds a listener to the beginning of the listeners array for the specified event.
+     * @param { string | symbol } eventType  - The type of the event.
+     * @param { Function } listener - The callback function.
+     * @param { SubOptions } [options] - Option to support event timestamps.
+     * @return {Promise.<this>}
+     * @function prependListener
+     * @memberof Window
+     * @instance
+     * @tutorial Window.EventEmitter
+     */
+    /**
+     * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
+     * The listener is added to the beginning of the listeners array.
+     * @param { string | symbol } eventType  - The type of the event.
+     * @param { Function } listener - The callback function.
+     * @param { SubOptions } [options] - Option to support event timestamps.
+     * @return {Promise.<this>}
+     * @function prependOnceListener
+     * @memberof Window
+     * @instance
+     * @tutorial Window.EventEmitter
+     */
+    /**
+     * Remove a listener from the listener array for the specified event.
+     * Caution: Calling this method changes the array indices in the listener array behind the listener.
+     * @param { string | symbol } eventType  - The type of the event.
+     * @param { Function } listener - The callback function.
+     * @param { SubOptions } [options] - Option to support event timestamps.
+     * @return {Promise.<this>}
+     * @function removeListener
+     * @memberof Window
+     * @instance
+     * @tutorial Window.EventEmitter
+     */
+    /**
+     * Removes all listeners, or those of the specified event.
+     * @param { string | symbol } [eventType]  - The type of the event.
+     * @return {Promise.<this>}
+     * @function removeAllListeners
+     * @memberof Window
+     * @instance
+     * @tutorial Window.EventEmitter
+     */
+    /**
+     * Gets a base64 encoded image of the window or a part of it.
+     * @function capturePage
+     * @param { CapturePageOptions } [options] options for capturePage call.
+     * @return {Promise.<string>}
+     * @memberof Window
+     * @instance
+     * @tutorial Window.capturePage
+     */
+    /**
+     * Executes Javascript on the window, restricted to windows you own or windows owned by
+     * applications you have created.
+     * @param { string } code JavaScript code to be executed on the window.
+     * @function executeJavaScript
+     * @memberOf Window
+     * @instance
+     * @return {Promise.<void>}
+     * @tutorial Window.executeJavaScript
+     */
+    /**
+     * Gives focus to the window.
+     * @return {Promise.<void>}
+     * @function focus
+     * @emits focused
+     * @memberOf Window
+     * @instance
+     * @tutorial Window.focus
+     */
+    /**
+     * Returns the zoom level of the window.
+     * @function getZoomLevel
+     * @memberOf Window
+     * @instance
+     * @return {Promise.<number>}
+     * @tutorial Window.getZoomLevel
+     */
+    /**
+     * Sets the zoom level of the window.
+     * @param { number } level The zoom level
+     * @function setZoomLevel
+     * @memberOf Window
+     * @instance
+     * @return {Promise.<void>}
+     * @tutorial Window.setZoomLevel
+     */
+    /**
+     * Find and highlight text on a page.
+     * @param { string } searchTerm Term to find in page
+     * @param { FindInPageOptions } options Search options
+     * @function findInPage
+     * @memberOf Window
+     * @instance
+     * @return {Promise.<number>}
+     * @tutorial Window.findInPage
+     */
+    /**
+     * Stops any findInPage call with the provided action.
+     * @param {string} action
+     * Action to execute when stopping a find in page:<br>
+     * "clearSelection" - Clear the selection.<br>
+     * "keepSelection" - Translate the selection into a normal selection.<br>
+     * "activateSelection" - Focus and click the selection node.<br>
+     * @function stopFindInPage
+     * @memberOf Window
+     * @instance
+     * @return {Promise.<void>}
+     * @tutorial Window.stopFindInPage
+     */
+    /**
+     * Navigates the window to a specified URL. The url must contain the protocol prefix such as http:// or https://.
+     * @param {string} url - The URL to navigate the window to.
+     * @function navigate
+     * @memberOf Window
+     * @instance
+     * @return {Promise.<void>}
+     * @tutorial Window.navigate
+     */
+    /**
+     * Navigates the window back one page.
+     * @function navigateBack
+     * @memberOf Window
+     * @instance
+     * @return {Promise.<void>}
+     * @tutorial Window.navigateBack
+     */
+    /**
+     * Navigates the window forward one page.
+     * @function navigateForward
+     * @memberOf Window
+     * @instance
+     * @return {Promise.<void>}
+     * @tutorial Window.navigateForward
+     */
+    /**
+     * Stops any current navigation the window is performing.
+     * @function stopNavigation
+     * @memberOf Window
+     * @instance
+     * @return {Promise.<void>}
+     * @tutorial Window.stopNavigation
+     */
+    /**
+     * Reloads the window current page
+     * @function reload
+     * @memberOf Window
+     * @instance
+     * @return {Promise.<void>}
+     * @tutorial Window.reload
+     */
+    /**
+     * Prints the window's web page
+     * @param { PrintOptions } [options] Printer Options
+     * @function print
+     * @memberOf Window
+     * @instance
+     * @return {Promise.<void>}
+     * @tutorial Window.print
+     */
+    /**
+     * Returns an array with all system printers
+     * @function getPrinters
+     * @memberOf Window
+     * @instance
+     * @return { Promise.Array.<PrinterInfo> }
+     * @tutorial Window.getPrinters
+     */
+    /**
+     * Retrieves the process information associated with a window.
+     * @function getProcessInfo
+     * @memberOf Window
+     * @instance
+     * @return {Promise.<EntityProcessDetails>}
+     * @tutorial Window.getProcessInfo
+     */
+    /**
+     * Retrieves information on all Shared Workers.
+     * @function getSharedWorkers
+     * @memberOf Window
+     * @instance
+     * @return {Promise.Array.<SharedWorkerInfo>}
+     * @tutorial Window.getSharedWorkers
+     */
+    /**
+     * Opens the developer tools for the shared worker context.
+     * @function inspectSharedWorker
+     * @memberOf Window
+     * @instance
+     * @return {Promise.<void>}
+     * @tutorial Window.inspectSharedWorker
+     */
+    /**
+     * Inspects the shared worker based on its ID.
+     * @param { string } workerId - The id of the shared worker.
+     * @function inspectSharedWorkerById
+     * @memberOf Window
+     * @instance
+     * @return {Promise.<void>}
+     * @tutorial Window.inspectSharedWorkerById
+     */
+    /**
+     * Opens the developer tools for the service worker context.
+     * @function inspectServiceWorker
+     * @memberOf Window
+     * @instance
+     * @return {Promise.<void>}
+     * @tutorial Window.inspectServiceWorker
+     */
+    // create a new window
+    createWindow(options) {
+        this.wire.sendAction('window-create-window', this.identity).catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        return new Promise((resolve, reject) => {
+            const CONSTRUCTOR_CB_TOPIC = 'fire-constructor-callback';
+            // need to call pageResponse, otherwise when a child window is created, page is not loaded
+            const pageResponse = new Promise((resolve) => {
+                this.on(CONSTRUCTOR_CB_TOPIC, function fireConstructor(response) {
+                    let cbPayload;
+                    const { success } = response;
+                    const responseData = response.data;
+                    const { message } = responseData;
+                    if (success) {
+                        cbPayload = {
+                            httpResponseCode: responseData.httpResponseCode,
+                            apiInjected: responseData.apiInjected
+                        };
+                    }
+                    else {
+                        cbPayload = {
+                            message: responseData.message,
+                            networkErrorCode: responseData.networkErrorCode,
+                            stack: responseData.stack
+                        };
+                    }
+                    this.removeListener(CONSTRUCTOR_CB_TOPIC, fireConstructor);
+                    resolve({
+                        message,
+                        cbPayload,
+                        success
+                    });
+                });
+            });
+            // set defaults:
+            if (options.waitForPageLoad === undefined) {
+                options.waitForPageLoad = false;
+            }
+            if (options.autoShow === undefined) {
+                options.autoShow = true;
+            }
+            const windowCreation = this.wire.environment.createChildContent({ entityType: 'window', options });
+            Promise.all([pageResponse, windowCreation])
+                .then((resolvedArr) => {
+                const pageResolve = resolvedArr[0];
+                if (pageResolve.success) {
+                    resolve(this);
+                }
+                else {
+                    reject(pageResolve);
+                }
+                try {
+                    // this is to enforce a 5.0 contract that the child's main function
+                    // will not fire before the parent's success callback on creation.
+                    // if the child window is not accessible (CORS) this contract does
+                    // not hold.
+                    const webWindow = this.getWebWindow();
+                    webWindow.fin.__internal_.openerSuccessCBCalled();
+                }
+                catch (e) {
+                    // common for main windows, we do not want to expose this error. here just to have a debug target.
+                    // console.error(e);
+                }
+            })
+                .catch(reject);
+        });
+    }
+    /**
+     * Retrieves an array of frame info objects representing the main frame and any
+     * iframes that are currently on the page.
+     * @return {Promise.<Array<FrameInfo>>}
+     * @tutorial Window.getAllFrames
+     */
+    getAllFrames() {
+        return this.wire.sendAction('get-all-frames', this.identity).then(({ payload }) => payload.data);
+    }
+    /**
+     * Gets the current bounds (top, bottom, right, left, width, height) of the window.
+     * @return {Promise.<Bounds>}
+     * @tutorial Window.getBounds
+     */
+    getBounds() {
+        return this.wire
+            .sendAction('get-window-bounds', this.identity)
+            .then(({ payload }) => payload.data);
+    }
+    /**
+     * Centers the window on its current screen.
+     * @return {Promise.<void>}
+     * @tutorial Window.center
+     */
+    center() {
+        return this.wire.sendAction('center-window', this.identity).then(() => undefined);
+    }
+    /**
+     * Removes focus from the window.
+     * @return {Promise.<void>}
+     * @tutorial Window.blur
+     */
+    blur() {
+        return this.wire.sendAction('blur-window', this.identity).then(() => undefined);
+    }
+    /**
+     * Brings the window to the front of the window stack.
+     * @return {Promise.<void>}
+     * @tutorial Window.bringToFront
+     */
+    bringToFront() {
+        return this.wire.sendAction('bring-window-to-front', this.identity).then(() => undefined);
+    }
+    /**
+     * Performs the specified window transitions.
+     * @param {Transition} transitions - Describes the animations to perform. See the tutorial.
+     * @param {TransitionOptions} options - Options for the animation. See the tutorial.
+     * @return {Promise.<void>}
+     * @tutorial Window.animate
+     */
+    animate(transitions, options) {
+        return this.wire
+            .sendAction('animate-window', {
+            transitions,
+            options,
+            ...this.identity
+        })
+            .then(() => undefined);
+    }
+    /**
+     * Hides the window.
+     * @return {Promise.<void>}
+     * @tutorial Window.hide
+     */
+    hide() {
+        return this.wire.sendAction('hide-window', this.identity).then(() => undefined);
+    }
+    /**
+     * closes the window application
+     * @param { boolean } [force = false] Close will be prevented from closing when force is false and
+     *  ‘close-requested’ has been subscribed to for application’s main window.
+     * @return {Promise.<void>}
+     * @tutorial Window.close
+     */
+    close(force = false) {
+        return this.wire.sendAction('close-window', { force, ...this.identity }).then(() => {
+            Object.setPrototypeOf(this, null);
+            return undefined;
+        });
+    }
+    focusedWebViewWasChanged() {
+        return this.wire.sendAction('focused-webview-changed', this.identity).then(() => undefined);
+    }
+    /**
+     * Returns the native OS level Id.
+     * In Windows, it will return the Windows [handle](https://docs.microsoft.com/en-us/windows/desktop/WinProg/windows-data-types#HWND).
+     * @return {Promise.<string>}
+     * @tutorial Window.getNativeId
+     */
+    getNativeId() {
+        return this.wire.sendAction('get-window-native-id', this.identity).then(({ payload }) => payload.data);
+    }
+    /**
+     * Retrieves window's attached views.
+     * @experimental
+     * @return {Promise.Array.<View>}
+     * @tutorial Window.getCurrentViews
+     */
+    async getCurrentViews() {
+        const { payload } = await this.wire.sendAction('window-get-views', this.identity);
+        return payload.data.map((id) => new view_1.View(this.wire, id));
+    }
+    /*
+     * @deprecated Use {@link Window.disableUserMovement} instead.
+     */
+    disableFrame() {
+        console.warn('Function is deprecated; use disableUserMovement instead.');
+        return this.wire.sendAction('disable-window-frame', this.identity).then(() => undefined);
+    }
+    /**
+     * Prevents a user from changing a window's size/position when using the window's frame.
+     * @return {Promise.<void>}
+     * @tutorial Window.disableUserMovement
+     */
+    disableUserMovement() {
+        return this.wire.sendAction('disable-window-frame', this.identity).then(() => undefined);
+    }
+    /*
+     * @deprecated Use {@link Window.enableUserMovement} instead.
+     */
+    enableFrame() {
+        console.warn('Function is deprecated; use enableUserMovement instead.');
+        return this.wire.sendAction('enable-window-frame', this.identity).then(() => undefined);
+    }
+    /**
+     * Re-enables user changes to a window's size/position when using the window's frame.
+     * @return {Promise.<void>}
+     * @tutorial Window.enableUserMovement
+     */
+    enableUserMovement() {
+        return this.wire.sendAction('enable-window-frame', this.identity).then(() => undefined);
+    }
+    /**
+     * Flashes the window’s frame and taskbar icon until stopFlashing is called or until a focus event is fired.
+     * @return {Promise.<void>}
+     * @tutorial Window.flash
+     */
+    flash() {
+        return this.wire.sendAction('flash-window', this.identity).then(() => undefined);
+    }
+    /**
+     * Stops the taskbar icon from flashing.
+     * @return {Promise.<void>}
+     * @tutorial Window.stopFlashing
+     */
+    stopFlashing() {
+        return this.wire.sendAction('stop-flash-window', this.identity).then(() => undefined);
+    }
+    /**
+     * Gets an information object for the window.
+     * @return {Promise.<WindowInfo>}
+     * @tutorial Window.getInfo
+     */
+    getInfo() {
+        return this.wire.sendAction('get-window-info', this.identity).then(({ payload }) => payload.data);
+    }
+    /**
+     * Retrieves the window's Layout
+     * @return {Promise.<Layout>}
+     * @tutorial Window.getLayout
+     * @experimental
+     */
+    async getLayout() {
+        this.wire.sendAction('window-get-layout', this.identity).catch((e) => {
+            // don't expose
+        });
+        const opts = await this.getOptions();
+        if (!opts.layout) {
+            throw new Error('Window does not have a Layout');
+        }
+        return this.fin.Platform.Layout.wrap(this.identity);
+    }
+    /**
+     * Gets the current settings of the window.
+     * @return {Promise.<any>}
+     * @tutorial Window.getOptions
+     */
+    getOptions() {
+        return this.wire.sendAction('get-window-options', this.identity).then(({ payload }) => payload.data);
+    }
+    /**
+     * Gets the parent application.
+     * @return {Promise.<Application>}
+     * @tutorial Window.getParentApplication
+     */
+    getParentApplication() {
+        this.wire.sendAction('window-get-parent-application', this.identity).catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        return Promise.resolve(new application_1.Application(this.wire, this.identity));
+    }
+    /**
+     * Gets the parent window.
+     * @return {Promise.<_Window>}
+     * @tutorial Window.getParentWindow
+     */
+    getParentWindow() {
+        this.wire.sendAction('window-get-parent-window', this.identity).catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        return Promise.resolve(new application_1.Application(this.wire, this.identity)).then((app) => app.getWindow());
+    }
+    /**
+     * ***DEPRECATED - please use Window.capturePage.***
+     * Gets a base64 encoded PNG image of the window or just part a of it.
+     * @param { Area } [area] The area of the window to be captured.
+     * Omitting it will capture the whole visible window.
+     * @return {Promise.<string>}
+     * @tutorial Window.capturePage
+     */
+    async getSnapshot(area) {
+        const req = { area, ...this.identity };
+        console.warn('Window.getSnapshot has been deprecated, please use Window.capturePage');
+        const res = await this.wire.sendAction('get-window-snapshot', req);
+        return res.payload.data;
+    }
+    /**
+     * Gets the current state ("minimized", "maximized", or "restored") of the window.
+     * @return {Promise.<string>}
+     * @tutorial Window.getState
+     */
+    getState() {
+        return this.wire.sendAction('get-window-state', this.identity).then(({ payload }) => payload.data);
+    }
+    /**
+     * Previously called getNativeWindow.
+     * Returns the [Window Object](https://developer.mozilla.org/en-US/docs/Web/API/Window)
+     * that represents the web context of the target window. This is the same object that
+     * you would get from calling [window.open()](https://developer.mozilla.org/en-US/docs/Web/API/Window/open) in a standard web context.
+     * The target window needs to be in the same application as the requesting window
+     * as well as comply with [same-origin](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy) policy requirements.
+     * @return {object}
+     * @tutorial Window.getWebWindow
+     */
+    getWebWindow() {
+        this.wire.sendAction('window-get-web-window', this.identity).catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        return this.wire.environment.getWebWindow(this.identity);
+    }
+    /**
+     * Determines if the window is a main window.
+     * @return {boolean}
+     * @tutorial Window.isMainWindow
+     */
+    isMainWindow() {
+        this.wire.sendAction('window-is-main-window', this.identity).catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        return this.me.uuid === this.me.name;
+    }
+    /**
+     * Determines if the window is currently showing.
+     * @return {Promise.<boolean>}
+     * @tutorial Window.isShowing
+     */
+    isShowing() {
+        return this.wire.sendAction('is-window-showing', this.identity).then(({ payload }) => payload.data);
+    }
+    /**
+     * Maximizes the window
+     * @return {Promise.<void>}
+     * @tutorial Window.maximize
+     */
+    maximize() {
+        return this.wire.sendAction('maximize-window', this.identity).then(() => undefined);
+    }
+    /**
+     * Minimizes the window.
+     * @return {Promise.<void>}
+     * @tutorial Window.minimize
+     */
+    minimize() {
+        return this.wire.sendAction('minimize-window', this.identity).then(() => undefined);
+    }
+    /**
+     * Moves the window by a specified amount.
+     * @param { number } deltaLeft The change in the left position of the window
+     * @param { number } deltaTop The change in the top position of the window
+     * @return {Promise.<void>}
+     * @tutorial Window.moveBy
+     */
+    moveBy(deltaLeft, deltaTop) {
+        return this.wire
+            .sendAction('move-window-by', {
+            deltaLeft,
+            deltaTop,
+            ...this.identity
+        })
+            .then(() => undefined);
+    }
+    /**
+     * Moves the window to a specified location.
+     * @param { number } left The left position of the window
+     * @param { number } top The top position of the window
+     * @return {Promise.<void>}
+     * @tutorial Window.moveTo
+     */
+    moveTo(left, top) {
+        return this.wire
+            .sendAction('move-window', {
+            left,
+            top,
+            ...this.identity
+        })
+            .then(() => undefined);
+    }
+    /**
+     * Resizes the window by a specified amount.
+     * @param { number } deltaWidth The change in the width of the window
+     * @param { number } deltaHeight The change in the height of the window
+     * @param { AnchorType } anchor Specifies a corner to remain fixed during the resize.
+     * Can take the values: "top-left", "top-right", "bottom-left", or "bottom-right".
+     * If undefined, the default is "top-left"
+     * @return {Promise.<void>}
+     * @tutorial Window.resizeBy
+     */
+    resizeBy(deltaWidth, deltaHeight, anchor) {
+        return this.wire
+            .sendAction('resize-window-by', {
+            deltaWidth: Math.floor(deltaWidth),
+            deltaHeight: Math.floor(deltaHeight),
+            anchor,
+            ...this.identity
+        })
+            .then(() => undefined);
+    }
+    /**
+     * Resizes the window to the specified dimensions.
+     * @param { number } width The change in the width of the window
+     * @param { number } height The change in the height of the window
+     * @param { AnchorType } anchor Specifies a corner to remain fixed during the resize.
+     * Can take the values: "top-left", "top-right", "bottom-left", or "bottom-right".
+     * If undefined, the default is "top-left"
+     * @return {Promise.<void>}
+     * @tutorial Window.resizeTo
+     */
+    resizeTo(width, height, anchor) {
+        return this.wire
+            .sendAction('resize-window', {
+            width: Math.floor(width),
+            height: Math.floor(height),
+            anchor,
+            ...this.identity
+        })
+            .then(() => undefined);
+    }
+    /**
+     * Restores the window to its normal state (i.e., unminimized, unmaximized).
+     * @return {Promise.<void>}
+     * @tutorial Window.restore
+     */
+    restore() {
+        return this.wire.sendAction('restore-window', this.identity).then(() => undefined);
+    }
+    /**
+     * Will bring the window to the front of the entire stack and give it focus.
+     * @return {Promise.<void>}
+     * @tutorial Window.setAsForeground
+     */
+    setAsForeground() {
+        return this.wire.sendAction('set-foreground-window', this.identity).then(() => undefined);
+    }
+    /**
+     * Sets the window's size and position.
+     * @property { Bounds } bounds This is a * @type {string} name - name of the window.object that holds the propertys of
+     * @return {Promise.<void>}
+     * @tutorial Window.setBounds
+     */
+    setBounds(bounds) {
+        return this.wire.sendAction('set-window-bounds', { ...bounds, ...this.identity }).then(() => undefined);
+    }
+    /**
+     * Shows the window if it is hidden.
+     * @param { boolean } [force = false] Show will be prevented from showing when force is false and
+     *  ‘show-requested’ has been subscribed to for application’s main window.
+     * @return {Promise.<void>}
+     * @tutorial Window.show
+     */
+    show(force = false) {
+        return this.wire.sendAction('show-window', { force, ...this.identity }).then(() => undefined);
+    }
+    /**
+     * Shows the window if it is hidden at the specified location.
+     * If the toggle parameter is set to true, the window will
+     * alternate between showing and hiding.
+     * @param { number } left The left position of the window
+     * @param { number } top The right position of the window
+     * @param { boolean } force Show will be prevented from closing when force is false and
+     * ‘show-requested’ has been subscribed to for application’s main window
+     * @return {Promise.<void>}
+     * @tutorial Window.showAt
+     */
+    showAt(left, top, force = false) {
+        return this.wire
+            .sendAction('show-at-window', {
+            force,
+            left: Math.floor(left),
+            top: Math.floor(top),
+            ...this.identity
+        })
+            .then(() => undefined);
+    }
+    /**
+     * Shows the Chromium Developer Tools
+     * @return {Promise.<void>}
+     * @tutorial Window.showDeveloperTools
+     */
+    /**
+     * Updates the window using the passed options.
+     * Values that are objects are deep-merged, overwriting only the values that are provided.
+     * @param {*} options Changes a window's options that were defined upon creation. See tutorial
+     * @return {Promise.<void>}
+     * @tutorial Window.updateOptions
+     */
+    updateOptions(options) {
+        return this.wire.sendAction('update-window-options', { options, ...this.identity }).then(() => undefined);
+    }
+    /**
+     * Provides credentials to authentication requests
+     * @param { string } userName userName to provide to the authentication challenge
+     * @param { string } password password to provide to the authentication challenge
+     * @return {Promise.<void>}
+     * @tutorial Window.authenticate
+     */
+    authenticate(userName, password) {
+        return this.wire
+            .sendAction('window-authenticate', { userName, password, ...this.identity })
+            .then(() => undefined);
+    }
+    /**
+     * @typedef {object} ShowPopupMenuOptions
+     * @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
+     * @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
+     * @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
+     */
+    /**
+     * @typedef {object} MenuItemTemplate
+     * @property {*} data Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
+     * @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
+     * @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
+     * @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
+     * @property {boolean} [visible] - If false, the menu item will be entirely hidden.
+     * @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
+     * @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
+     */
+    /**
+     * @typedef {object} MenuResult
+     * @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
+     * @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
+     */
+    /**
+     * Shows a menu on the window. Returns a promise that resolves when the user has either selected an item or closed the menu. (This may take longer than other apis).
+     * Resolves to an object with `{result: 'clicked', data }` where data is the data field on the menu item clicked, or `{result 'closed'}` when the user doesn't select anything.
+     * Calling this method will close previously opened menus.
+     * @experimental
+     * @param {ShowPopupMenuOptions} options
+     * @return {Promise<MenuResult>}
+     * @tutorial Window.showPopupMenu
+     */
+    async showPopupMenu(options) {
+        const { payload } = await this.wire.sendAction('show-popup-menu', { options, ...this.identity });
+        return payload.data;
+    }
+    /**
+     * Closes the window's popup menu, if one exists.
+     * @experimental
+     * @return {Promise<void>}
+     * @tutorial Window.closePopupMenu
+     */
+    async closePopupMenu() {
+        return this.wire.sendAction('close-popup-menu', { ...this.identity }).then(() => undefined);
+    }
+}
+exports._Window = _Window;