@openfin/core 34.78.12 → 34.78.14

package/out/mock.js

@@ -93,6 +93,13 @@ class Base {
     get fin() {
         return this.wire.getFin();
     }
+    /**
+     * Provides access to the OpenFin representation of the current code context (usually a document
+     * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
+     *
+     * Useful for debugging in the devtools console, where this will intelligently type itself based
+     * on the context in which the devtools panel was opened.
+     */
     get me() {
         return this.wire.me;
     }
@@ -1372,6 +1379,10 @@ Object.defineProperty(main, "__esModule", { value: true });
 main.WebContents = void 0;
 const base_1$k = base;
 class WebContents extends base_1$k.EmitterBase {
+    /**
+     * @param identity The identity of the {@link OpenFin.WebContentsEvents WebContents}.
+     * @param entityType The type of the {@link OpenFin.WebContentsEvents WebContents}.
+     */
     constructor(wire, identity, entityType) {
         super(wire, entityType, identity.uuid, identity.name);
         this.identity = identity;
@@ -1424,6 +1435,11 @@ class WebContents extends base_1$k.EmitterBase {
      * }
      * console.log(await wnd.capturePage(options));
      * ```
+     *
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     capturePage(options) {
         return this.wire.sendAction('capture-page', { options, ...this.identity }).then(({ payload }) => payload.data);
@@ -1459,6 +1475,10 @@ class WebContents extends base_1$k.EmitterBase {
      *
      * executeJavaScript(`console.log('Hello, Openfin')`).then(() => console.log('Javascript excuted')).catch(err => console.log(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     executeJavaScript(code) {
         return this.wire
@@ -1498,6 +1518,10 @@ class WebContents extends base_1$k.EmitterBase {
      *
      * getZoomLevel().then(zoomLevel => console.log(zoomLevel)).catch(err => console.log(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     getZoomLevel() {
         return this.wire.sendAction('get-zoom-level', this.identity).then(({ payload }) => payload.data);
@@ -1536,6 +1560,10 @@ class WebContents extends base_1$k.EmitterBase {
      *
      * setZoomLevel(4).then(() => console.log('Setting a  zoom level')).catch(err => console.log(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     setZoomLevel(level) {
         return this.wire.sendAction('set-zoom-level', { ...this.identity, level }).then(() => undefined);
@@ -1573,6 +1601,10 @@ class WebContents extends base_1$k.EmitterBase {
      * navigate().then(() => console.log('Navigate to tutorial')).catch(err => console.log(err));
      * ```
      * @experimental
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     navigate(url) {
         return this.wire.sendAction('navigate-window', { ...this.identity, url }).then(() => undefined);
@@ -1600,6 +1632,10 @@ class WebContents extends base_1$k.EmitterBase {
      * }
      * navigateBack().then(() => console.log('Navigated back')).catch(err => console.log(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     navigateBack() {
         return this.wire.sendAction('navigate-window-back', { ...this.identity }).then(() => undefined);
@@ -1629,6 +1665,10 @@ class WebContents extends base_1$k.EmitterBase {
      * }
      * navigateForward().then(() => console.log('Navigated forward')).catch(err => console.log(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     async navigateForward() {
         await this.wire.sendAction('navigate-window-forward', { ...this.identity });
@@ -1656,6 +1696,10 @@ class WebContents extends base_1$k.EmitterBase {
      * }
      * stopNavigation().then(() => console.log('you shall not navigate')).catch(err => console.log(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     stopNavigation() {
         return this.wire.sendAction('stop-window-navigation', { ...this.identity }).then(() => undefined);
@@ -1693,6 +1737,10 @@ class WebContents extends base_1$k.EmitterBase {
      * 		console.log('Reloaded window')
      * }).catch(err => console.log(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     reload(ignoreCache = false) {
         return this.wire
@@ -1719,6 +1767,10 @@ class WebContents extends base_1$k.EmitterBase {
      *     console.log('print call has been sent to the system');
      * });
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     print(options = {}) {
         return this.wire.sendAction('print', { ...this.identity, options }).then(() => undefined);
@@ -1763,6 +1815,10 @@ class WebContents extends base_1$k.EmitterBase {
      *     console.log(result)
      * });
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     findInPage(searchTerm, options) {
         return this.wire
@@ -1806,6 +1862,10 @@ class WebContents extends base_1$k.EmitterBase {
      *     console.log(results);
      * });
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     stopFindInPage(action) {
         return this.wire.sendAction('stop-find-in-page', { ...this.identity, action }).then(() => undefined);
@@ -1848,6 +1908,10 @@ class WebContents extends base_1$k.EmitterBase {
      *         console.log(err);
      *     });
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     getPrinters() {
         return this.wire.sendAction('get-printers', { ...this.identity }).then(({ payload }) => payload.data);
@@ -1870,6 +1934,10 @@ class WebContents extends base_1$k.EmitterBase {
      *
      * focusWindow().then(() => console.log('Window focused')).catch(err => console.log(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     async focus({ emitSynthFocused } = { emitSynthFocused: true }) {
         await this.wire.sendAction('focus-window', { emitSynthFocused, ...this.identity });
@@ -1901,6 +1969,10 @@ class WebContents extends base_1$k.EmitterBase {
      * .then(() => console.log('Showing dev tools'))
      * .catch(err => console.error(err));
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     async showDeveloperTools() {
         // Note this hits the system action map in core state for legacy reasons.
@@ -1923,6 +1995,10 @@ class WebContents extends base_1$k.EmitterBase {
      *     const win = await fin.Window.getCurrent();
      *     const processInfo = await win.getProcessInfo();
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     async getProcessInfo() {
         const { payload: { data } } = await this.wire.sendAction('get-process-info', this.identity);
@@ -1958,6 +2034,10 @@ class WebContents extends base_1$k.EmitterBase {
      *     const win = await fin.Window.create(winOption);
      *     const sharedWorkers = await win.getSharedWorkers();
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     async getSharedWorkers() {
         return this.wire.sendAction('get-shared-workers', this.identity).then(({ payload }) => payload.data);
@@ -1992,6 +2072,10 @@ class WebContents extends base_1$k.EmitterBase {
      *     const win = await fin.Window.create(winOption);
      *     await win.inspectSharedWorker();
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     async inspectSharedWorker() {
         await this.wire.sendAction('inspect-shared-worker', { ...this.identity });
@@ -2029,6 +2113,10 @@ class WebContents extends base_1$k.EmitterBase {
      *     const sharedWorkers = await win.getSharedWorkers();
      *     await win.inspectSharedWorkerById(sharedWorkers[0].id);
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     async inspectSharedWorkerById(workerId) {
         await this.wire.sendAction('inspect-shared-worker-by-id', { ...this.identity, workerId });
@@ -2063,6 +2151,10 @@ class WebContents extends base_1$k.EmitterBase {
      *     const win = await fin.Window.create(winOption);
      *     await win.inspectServiceWorker();
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     async inspectServiceWorker() {
         await this.wire.sendAction('inspect-service-worker', { ...this.identity });
@@ -2273,6 +2365,10 @@ class WebContents extends base_1$k.EmitterBase {
      *     onPopupReady: popupWindowCallback;
      * });
      * ```
+     * @remarks
+     * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
+     * We do not expose an explicit superclass for this functionality, but it does have its own
+     * {@link OpenFin.WebContentsEvents event namespace}.
      */
     async showPopupWindow(options) {
         this.wire.sendAction(`${this.entityType}-show-popup-window`, this.identity).catch(() => {
@@ -4695,7 +4791,6 @@ function requireInstance () {
 	     */
 	    constructor(wire, identity) {
 	        super(wire, identity, 'window');
-	        this.identity = identity;
 	    }
 	    /**
 	     * Adds a listener to the end of the listeners array for the specified event.
@@ -5874,7 +5969,10 @@ function requireInstance () {
 	     * Calling this method will close previously opened menus.
 	     * @experimental
 	     * @param options
-	     *
+	     * @typeParam Data User-defined shape for data returned upon menu item click.  Should be a
+	     * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
+	     * of all possible data shapes for the entire menu, and the click handler should process
+	     * these with a "reducer" pattern.
 	     * @example
 	     * This could be used to show a drop down menu over views in a platform window:
 	     * ```js

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "34.78.12",
+    "version": "34.78.14",
     "description": "The core renderer entry point of OpenFin",
     "license": "SEE LICENSE IN LICENSE.MD",
     "main": "out/mock.js",