@openfin/core 34.78.34 → 34.78.37

package/out/mock.js

@@ -26,10 +26,12 @@ var application$1 = {};
  * 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.
+ * {@link NativeApplicationEvent Native application events} (i.e. those that have not propagated from {@link OpenFin.ViewEvents Views}
+ * or {@link OpenFin.WindowEvents Windows} re-propagate to {@link OpenFin.SystemEvents System} with their type string prefixed with `application-`.
+ * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
+ * are propagated to `System` without any type string prefixing.
+ *
+ * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
  *
  * @packageDocumentation
  */
@@ -114,10 +116,8 @@ var view$1 = {};
  * (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.
+ * View events propagate to their parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
+ * and {@link OpenFin.SystemEvents System} with an added `viewIdentity` property and their event types prefixed with `'view-'`.
  *
  * @packageDocumentation
  */
@@ -142,7 +142,6 @@ 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.
@@ -152,10 +151,12 @@ var window$2 = {};
  * 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.
+ * {@link OpenFin.WindowEvents.NativeWindowEvent Native window events} (i.e. those that are not propagated from a
+ * {@link OpenFin.ViewEvents View}) propagate to their parent {@link OpenFin.ApplicationEvents Application} and
+ * {@link OpenFin.SystemEvents System} with their event types prefixed with `'window-'`).
+ *
+ * "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.  The {@link OpenFin.WindowEvents.WindowCloseRequestedEvent}
+ * does not propagate at all.
  *
  * @packageDocumentation
  */
@@ -195,6 +196,11 @@ Object.defineProperty(window$2, "__esModule", { value: true });
  * 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.
  *
+ * If you need the payload type for a specific type of event (especially propagated events), use the emitting topic's `EventPayload`
+ * (e.g. {@link WindowEvents.WindowEventPayload}) generic with the event's `type` string.  For example, the payload of
+ * a {@link ViewEvents.CreatedEvent} after it has propagated to its parent {@link WindowEvents Window} can be found with
+ * `WindowEventPayload<'view-created'>`.
+ *
  * @packageDocumentation
  */
 Object.defineProperty(events, "__esModule", { value: true });

package/package.json

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