@openfin/core 34.78.16 → 34.78.18

package/out/mock.js

@@ -11,18 +11,240 @@ var mock = {};
 
 var OpenFin$1 = {};
 
+var events = {};
+
+var application$1 = {};
+
+/**
+ * Namespace for events that can be emitted by an {@link OpenFin.Application}.  Includes events
+ * re-propagated from the {@link OpenFin.Window} (and, transitively, {@link OpenFin.View}) level, prefixed with `window-` (and also, if applicable, `view-`).
+ * For example, a view's "attached" event will fire as 'window-view-attached' at the application level.
+ *
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
+ *
+ * This namespace contains only payload shapes for events that are unique to `Application`.  Events that propagate to `Application` from
+ * child {@link OpenFin.Window windows} and {@link OpenFin.View views} are defined in the {@link OpenFin.WindowEvents} and
+ * {@link OpenFin.ViewEvents} namespaces.  For a list of valid string keys for *all* application events, see {@link Application.on Application.on}.
+ *
+ * {@link WillPropagateApplicationEvent Bespoke application events} re-propagate to the system level, prefixed with `application-`.  For example,
+ * the `closed` event will fire as `application-closed` at the system level.  Propagated events from {@link PropagatedWindowEvent windows}
+ * and {@link PropagatedViewEvent views} within an application will *not* transitively re-propagate to the system level, because they are already
+ * visible at the system level and contain the identity of the application.
+ *
+ * @packageDocumentation
+ */
+Object.defineProperty(application$1, "__esModule", { value: true });
+
+var base$1 = {};
+
+Object.defineProperty(base$1, "__esModule", { value: true });
+
+var externalApplication$1 = {};
+
+/**
+ * Namespace for events that can be transmitted by an {@link OpenFin.ExternalApplication}.
+ *
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
+ *
+ * For a list of valid string keys for external application events, see {@link ExternalApplication.on ExternalApplication.on}.
+ *
+ * @packageDocumentation
+ */
+Object.defineProperty(externalApplication$1, "__esModule", { value: true });
+
+var frame$1 = {};
+
+Object.defineProperty(frame$1, "__esModule", { value: true });
+
+var globalHotkey$1 = {};
+
+Object.defineProperty(globalHotkey$1, "__esModule", { value: true });
+
+var platform$1 = {};
+
+/**
+ *
+ * Namespace for events that can emitted by a {@link OpenFin.Platform}.
+ *
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
+ *
+ * The Platform `EventEmitter` is a superset of the {@link OpenFin.Application} `EventEmitter`,
+ * meaning it can listen to all {@link OpenFin.ApplicationEvents Application events} in addition to the
+ * Platform-specific events listed here.  For a list of valid string keys for *all* platform events, see
+ * {@link Platform.on Platform.on}.
+ *
+ * @packageDocumentation
+ */
+Object.defineProperty(platform$1, "__esModule", { value: true });
+
+var system$1 = {};
+
+/**
+ * Namespace for runtime-wide OpenFin events emitted by {@link System.System}.  Includes events
+ * re-propagated from {@link OpenFin.Application}, {@link OpenFin.Window}, and {@link OpenFin.View} (prefixed with `application-`, `window-`, and `view-`).  All
+ * event propagations are visible at the System level. Propagated events from WebContents (windows, views, frames) to the Application level will *not*
+ * transitively re-propagate to the System level, because they are already visible at the system level and contain the identity
+ * of the application.  For example, an application's "closed" event will fire as 'application-closed' at the system level.  A view's 'shown' event
+ * will be visible as 'view-shown' at the system level, but *not* as `application-window-view-shown`.
+ *
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
+ *
+ * This namespace contains only payload shapes for events that are unique to `System`.  Events that propagate to `System` from
+ * child {@link OpenFin.Application applications}, {@link OpenFin.Window windows}, and {@link OpenFin.View views} are defined in the
+ * {@link OpenFin.ApplicationEvents}, {@link OpenFin.WindowEvents}, and {@link OpenFin.ViewEvents} namespaces.  For a list of valid string keys for *all*
+ * system events, see {@link System.on System.on}.
+ *
+ * @packageDocumentation
+ */
+Object.defineProperty(system$1, "__esModule", { value: true });
+
+var view$1 = {};
+
+/**
+ * Namespace for events that can be emitted by a {@link OpenFin.View}.
+ *
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
+ *
+ * This namespace contains only payload shapes for events that are unique to `View`.  Events that are shared between all `WebContents`
+ * (i.e. {@link OpenFin.Window}, {@link OpenFin.View}) are defined in {@link OpenFin.WebContentsEvents}.  For a list
+ * of valid string keys for *all* View events, see {@link View.on View.on}.
+ *
+ * View events fall into two categories: {@link WillPropagateViewEvent} and {@link NonPropagatedViewEvent}.  Propagated events will
+ * be re-emitted on the parent {@link OpenFin.Window} of the target view, prefixed with "view-".  For example,
+ * the "shown" event will be re-emitted on the parent window as "view-shown".  Non-propagated events
+ * will not be re-emitted on the parent window.
+ *
+ * @packageDocumentation
+ */
+Object.defineProperty(view$1, "__esModule", { value: true });
+
+var webcontents = {};
+
+/**
+ * Namespace for events shared by all OpenFin WebContents elements (i.e. {@link OpenFin.Window},
+ * {@link OpenFin.View}).
+ *
+ * WebContents events are divided into two groups: {@link WillPropagateWebContentsEvent} and {@link NonPropagatedWebContentsEvent}.  Propagating events
+ * will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
+ * parent window, and propagating events in a window will also be emitted on the window's parent {@link OpenFin.Application}.
+ *
+ * Non-propagating events will not re-emit on parent entities.
+ *
+ * @packageDocumentation
+ */
+Object.defineProperty(webcontents, "__esModule", { value: true });
+
+var window$2 = {};
+
+/**
+ *
+ * Namespace for events that can be emitted by a {@link OpenFin.Window}.
+ *
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
+ *
+ * This namespace contains only payload shapes for events that are unique to `Window`.  Events that are shared between all `WebContents`
+ * (i.e. {@link OpenFin.Window}, {@link OpenFin.View}) are defined in {@link OpenFin.WebContentsEvents}. Events that
+ * propagate from `View` are defined in {@link OpenFin.ViewEvents}. For a list of valid string keys for *all* Window events, see
+ * {@link Window.on Window.on}
+ *
+ * Window events fall into two categories: {@link WillPropagateWindowEvent} and {@link NonPropagatedWindowEvent}.
+ * Propagated events will be re-emitted on the parent {@link OpenFin.Application} of the target window, prefixed with "window-".  For example,
+ * a window's "reloaded" event will be re-emitted on the parent application as "window-reloaded".  Non-propagated
+ * events will not be re-emitted on the parent application.
+ *
+ * @packageDocumentation
+ */
+Object.defineProperty(window$2, "__esModule", { value: true });
+
 /**
- * Top-level namespace for types referenced by the OpenFin API.  Contains:
+ * Namespace for OpenFin event types. Each entity that emits OpenFin events has its own sub-namespace. Event payloads
+ * themselves are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
+ *
+ * #### Event emitters
+ *
+ * The following entities emit OpenFin events, and have corresponding sub-namespaces:
  *
- * * The type of the global `fin` entry point ({@link FinApi})
- * * Classes that act as static namespaces returned from the `fin` global (e.g. {@link ApplicationModule}, accessible via `fin.Application`)
- * * Instance classes that are returned from API calls (e.g. {@link Application}, accessible via `fin.Application.getCurrentSync()`)
- * * Parameter shapes for API methods (e.g. {@link ApplicationOptions}, used in `fin.Application.start()`)
- * * Event namespaces and payload union types (e.g. {@link ApplicationEvents} and {@link ApplicationEvent})
+ * * {@link OpenFin.Application}: {@link OpenFin.ApplicationEvents}
+ * * {@link OpenFin.ExternalApplication}: {@link OpenFin.ExternalApplicationEvents}
+ * * {@link OpenFin.Frame}: {@link OpenFin.FrameEvents}
+ * * {@link OpenFin.GlobalHotkey}: {@link OpenFin.GlobalHotkeyEvents}
+ * * {@link OpenFin.Platform}: {@link OpenFin.PlatformEvents}
+ * * {@link OpenFin.System}: {@link OpenFin.SystemEvents}
+ * * {@link OpenFin.View}: {@link OpenFin.ViewEvents}
+ * * {@link OpenFin.Window}: {@link OpenFin.WindowEvents}
+ *
+ * These `EventEmitter` entities share a common set of methods for interacting with the OpenFin event bus, which can be
+ * seen on the individual documentation pages for each entity type.
+ *
+ * Registering event handlers is an asynchronous operation. It is important to ensure that the returned Promises are awaited to reduce the
+ * risk of race conditions.
+ *
+ * When the `EventEmitter` receives an event from the browser process and emits on the renderer, all of the functions attached to that
+ * specific event are called synchronously. Any values returned by the called listeners are ignored and will be discarded.  If the window document
+ * is destroyed by page navigation or reload, its registered event listeners will be removed.
+ *
+ * We recommend using Arrow Functions for event listeners to ensure the this scope is consistent with the original function context.
+ *
+ * Events re-propagate from smaller/more-local scopes to larger/more-global scopes.  For example, an event emitted on a specific
+ * view will propagate to the window in which the view is embedded, and then to the application in which the window is running, and
+ * finally to the OpenFin runtime itself at the "system" level.  For details on propagation semantics, see the namespace for
+ * the propagating (or propagated-to) entity.
  *
  * @packageDocumentation
  */
-Object.defineProperty(OpenFin$1, "__esModule", { value: true });
+Object.defineProperty(events, "__esModule", { value: true });
+events.WindowEvents = events.WebContentsEvents = events.ViewEvents = events.SystemEvents = events.PlatformEvents = events.GlobalHotkeyEvents = events.FrameEvents = events.ExternalApplicationEvents = events.BaseEvents = events.ApplicationEvents = void 0;
+const ApplicationEvents = application$1;
+events.ApplicationEvents = ApplicationEvents;
+const BaseEvents = base$1;
+events.BaseEvents = BaseEvents;
+const ExternalApplicationEvents = externalApplication$1;
+events.ExternalApplicationEvents = ExternalApplicationEvents;
+const FrameEvents = frame$1;
+events.FrameEvents = FrameEvents;
+const GlobalHotkeyEvents = globalHotkey$1;
+events.GlobalHotkeyEvents = GlobalHotkeyEvents;
+const PlatformEvents = platform$1;
+events.PlatformEvents = PlatformEvents;
+const SystemEvents = system$1;
+events.SystemEvents = SystemEvents;
+const ViewEvents = view$1;
+events.ViewEvents = ViewEvents;
+const WebContentsEvents = webcontents;
+events.WebContentsEvents = WebContentsEvents;
+const WindowEvents = window$2;
+events.WindowEvents = WindowEvents;
+
+(function (exports) {
+	/**
+	 * Top-level namespace for types referenced by the OpenFin API.  Contains:
+	 *
+	 * * The type of the global `fin` entry point ({@link FinApi})
+	 * * Classes that act as static namespaces returned from the `fin` global (e.g. {@link ApplicationModule}, accessible via `fin.Application`)
+	 * * Instance classes that are returned from API calls (e.g. {@link Application}, accessible via `fin.Application.getCurrentSync()`)
+	 * * Parameter shapes for API methods (e.g. {@link ApplicationOptions}, used in `fin.Application.start()`)
+	 * * Event namespaces and payload union types (e.g. {@link ApplicationEvents} and {@link ApplicationEvent})
+	 *
+	 * @packageDocumentation
+	 */
+	var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+	    if (k2 === undefined) k2 = k;
+	    var desc = Object.getOwnPropertyDescriptor(m, k);
+	    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+	      desc = { enumerable: true, get: function() { return m[k]; } };
+	    }
+	    Object.defineProperty(o, k2, desc);
+	}) : (function(o, m, k, k2) {
+	    if (k2 === undefined) k2 = k;
+	    o[k2] = m[k];
+	}));
+	var __exportStar = (commonjsGlobal && commonjsGlobal.__exportStar) || function(m, exports) {
+	    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+	};
+	Object.defineProperty(exports, "__esModule", { value: true });
+	// Deprecated shim to preserve v30 namespace names
+	__exportStar(events, exports); 
+} (OpenFin$1));
 
 var fin = {};
 
@@ -134,6 +356,9 @@ class EmitterBase extends Base {
         this.topic = topic;
         _EmitterBase_emitterAccessor.set(this, void 0);
         this.eventNames = () => (this.hasEmitter() ? this.getOrCreateEmitter().eventNames() : []);
+        /**
+         * @internal
+         */
         this.emit = (eventType, payload, ...args) => {
             return this.hasEmitter() ? this.getOrCreateEmitter().emit(eventType, payload, ...args) : false;
         };
@@ -181,6 +406,8 @@ class EmitterBase extends Base {
     }
     /**
      * Adds a listener to the end of the listeners array for the specified event.
+     *
+     * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
      */
     async on(eventType, listener, options) {
         await this.registerEventListener(eventType, options, (emitter) => {
@@ -198,6 +425,8 @@ class EmitterBase extends Base {
     }
     /**
      * 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.
+     *
+     * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
      */
     async once(eventType, listener, options) {
         const deregister = () => this.deregisterEventListener(eventType);
@@ -212,6 +441,8 @@ class EmitterBase extends Base {
     }
     /**
      * Adds a listener to the beginning of the listeners array for the specified event.
+     *
+     * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
      */
     async prependListener(eventType, listener, options) {
         await this.registerEventListener(eventType, options, (emitter) => {
@@ -224,6 +455,8 @@ class EmitterBase extends Base {
     /**
      * 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.
+     *
+     * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
      */
     async prependOnceListener(eventType, listener, options) {
         const deregister = () => this.deregisterEventListener(eventType);
@@ -1571,7 +1804,7 @@ class WebContents extends base_1$k.EmitterBase {
     /**
      * Navigates the WebContents to a specified URL.
      *
-     * @remarks The url must contain the protocol prefix such as http:// or https://.
+     * Note: The url must contain the protocol prefix such as http:// or https://.
      * @param url - The URL to navigate the WebContents to.
      *
      * @example
@@ -1754,7 +1987,7 @@ class WebContents extends base_1$k.EmitterBase {
      * Prints the WebContents.
      * @param options Printer Options
      *
-     * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName
+     * Note: When `silent` is set to `true`, the API will pick the system's default printer if deviceName
      * is empty and the default settings for printing.
      *
      * Use the CSS style `page-break-before: always;` to force print to a new page.
@@ -1780,7 +2013,7 @@ class WebContents extends base_1$k.EmitterBase {
      * @param searchTerm Term to find in page
      * @param options Search options
      *
-     * @remarks By default, each subsequent call will highlight the next text that matches the search term.
+     * Note: By default, each subsequent call will highlight the next text that matches the search term.
      *
      * Returns a promise with the results for the request. By subscribing to the
      * found-in-page event, you can get the results of this call as well.
@@ -1981,7 +2214,7 @@ class WebContents extends base_1$k.EmitterBase {
     /**
      * Retrieves the process information associated with a WebContents.
      *
-     * @remarks This includes any iframes associated with the WebContents
+     * Note: This includes any iframes associated with the WebContents
      *
      * @example
      * View:
@@ -2162,7 +2395,7 @@ class WebContents extends base_1$k.EmitterBase {
     /**
      * Shows a popup window.
      *
-     * @remarks If this WebContents is a view and its attached window has a popup open, this will close it.
+     * Note: If this WebContents is a view and its attached window has a popup open, this will close it.
      *
      * Shows a popup window. Including a `name` in `options` will attempt to show an existing window as a popup, if
      * that window doesn't exist or no `name` is included a window will be created. If the caller view or the caller
@@ -2170,7 +2403,7 @@ class WebContents extends base_1$k.EmitterBase {
      * open popup window before showing the new popup window. Also, if the caller view is destroyed or detached, the popup
      * will be dismissed.
      *
-     * NOTE: in the case where the window being shown as a popup needs to be created, it is a child of the caller view's parent window.
+     * Note: in the case where the window being shown as a popup needs to be created, it is a child of the caller view's parent window.
      *
      * @example
      *
@@ -3638,6 +3871,7 @@ function requireInstance$1 () {
 	    /**
 	     * Sets or removes a custom JumpList for the application. Only applicable in Windows OS.
 	     * If categories is null the previously set custom JumpList (if any) will be replaced by the standard JumpList for the app (managed by Windows).
+	     *
 	     * Note: If the "name" property is omitted it defaults to "tasks".
 	     * @param jumpListCategories An array of JumpList Categories to populate. If null, remove any existing JumpList configuration and set to Windows default.
 	     *
@@ -3938,6 +4172,7 @@ function requireInstance$1 () {
 	    }
 	    /**
 	     * Sets file auto download location. It's only allowed in the same application.
+	     *
 	     * Note: This method is restricted by default and must be enabled via
 	     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
 	     * @param downloadLocation file auto download location
@@ -3963,6 +4198,7 @@ function requireInstance$1 () {
 	    }
 	    /**
 	     * Gets file auto download location. It's only allowed in the same application. If file auto download location is not set, it will return the default location.
+	     *
 	     * Note: This method is restricted by default and must be enabled via
 	     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
 	     *
@@ -7364,7 +7600,8 @@ class System extends base_1$j.EmitterBase {
     }
     /**
      * Attempt to close an external process. The process will be terminated if it
-     * has not closed after the elapsed timeout in milliseconds.<br>
+     * has not closed after the elapsed timeout in milliseconds.
+     *
      * Note: This method is restricted by default and must be enabled via
      * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
      * @param options A object defined in the TerminateExternalRequestType interface
@@ -7400,7 +7637,8 @@ class System extends base_1$j.EmitterBase {
         return this.wire.sendAction('update-proxy', options).then(() => undefined);
     }
     /**
-     * Downloads the given application asset<br>
+     * Downloads the given application asset.
+     *
      * Note: This method is restricted by default and must be enabled via
      * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
      * @param appAsset App asset object
@@ -11460,10 +11698,8 @@ const validate_1$1 = validate;
 const clientMap = new Map();
 /** Manages the life cycle of windows and views in the application.
  *
- * Enables taking snapshots of itself and applyi
- * ng them to restore a previous configuration
+ * Enables taking snapshots of itself and applying them to restore a previous configuration
  * as well as listen to {@link OpenFin.PlatformEvents platform events}.
- *
  */
 class Platform extends base_1$7.EmitterBase {
     /**

package/package.json

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