@openfin/node-adapter 33.77.6 → 33.77.8

package/README.md

@@ -1,8 +1,8 @@
 # OpenFin Node.js adapter
 
-Allows the use of the OpenFin API from node.js. Please note the launch and connect methods are specific to a node environment.
+Allows the use of the OpenFin API from node.js. Please note that the `launch` and `connect` methods are specific to a node environment.
 
-## Requirements
+## Prerequisites
 
 -   Node.js 16 or greater
 
@@ -12,11 +12,11 @@ Allows the use of the OpenFin API from node.js. Please note the launch and conne
 
 `connect` can be used to establish a connection to an OpenFin runtime from node.
 
-A uuid must be provided to identify the connection. Multiple connections will require distinct uuids.
+A `uuid` value must be provided to identify the connection. Multiple connections require distinct `uuid` values.
 
-A runtime version or manifest url must also be specified.
+A Runtime version or manifest URL must also be specified.
 
-Note - `connect` will instantiate a runtime instance if one does not exist for the given configuration. If the runtime is already running, connect will simply establish a new connection.
+> Note:  `connect` instantiates a Runtime instance if one does not exist for the given configuration. If a Runtime is already running, `connect` simply establishes a new connection.
 
 ### Connecting via Runtime Version
 
@@ -34,7 +34,7 @@ import { connect } from '@openfin/node-adapter';
 })();
 ```
 
-### Connecting via Manifest Url
+### Connecting via Manifest URL 
 
 ```javascript
 import { connect } from '@openfin/node-adapter';
@@ -53,9 +53,9 @@ import { connect } from '@openfin/node-adapter';
 
 Unlike `connect`, `launch` starts an OpenFin application if not running and returns a port number instead of a `fin` object.
 
-This can be provided to connect to create a `fin` object for the runtime that has been created on the specific port.
+This port number can be provided to connect to create a `fin` object for the Runtime that has been created on the specific port.
 
-`launch` can be called multiple times for a given application, however launches for an application that is already running will result in a [run-requested](https://developer.openfin.co/jsdocs/stable/tutorial-application.addEventListener.html#run-requested) event being triggered instead of a relaunch. If the application is an OpenFin platform, this will result in the layout windows reloading.
+`launch` can be called multiple times for a given application; however launches for an application that is already running result in a [run-requested](https://developer.openfin.co/jsdocs/stable/tutorial-application.addEventListener.html#run-requested) event being triggered instead of a relaunch. If the application is an OpenFin platform, this scenario results in the layout windows reloading.
 
 ### Launching and Connecting via Port
 
@@ -80,9 +80,9 @@ import { launch, connect } from '@openfin/node-adapter';
 
 ## Types
 
-`@openfin/node-adapter` comes bundled with its own types types.
+`@openfin/node-adapter` comes bundled with its own types.
 
-If you wish to explicitly reference OpenFin types, the `OpenFin` namespace export may be used as follows:
+If you wish to explicitly reference OpenFin types, the `OpenFin` namespace export can be used as follows:
 
 ### Type Usage Example
 
@@ -105,7 +105,7 @@ import OpenFin, { connect } from '@openfin/node-adapter';
 
 For users of the `connect` and `launch` functions in `openfin-adapter`, no changes are necessary, other than updating the dependency name.
 
-If using the exported types from `openfin-adapter`, an `OpenFin` export has been created that encapsualates them.
+If you are using the exported types from `openfin-adapter`, you can now use the `OpenFin` export that encapsualates them.
 
 ### Before
 

package/out/node-adapter-alpha.d.ts

@@ -4391,7 +4391,7 @@ declare namespace ExternalApplicationEvents {
 }
 
 /**
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
+ * Union of possible `type` values for a {@link ApplicationEvent}.
  */
 declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
 
@@ -7271,8 +7271,7 @@ declare type LayoutInitializedEvent = BaseWindowEvent & {
 
 /**
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
- * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
+ * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
  *
  * @interface
  */
@@ -7574,8 +7573,7 @@ declare type LayoutOptions = {
     };
     /**
      * Content of the layout. There can only be one top-level LayoutItem in the content array.
-     * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
-     * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
+     * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
      */
     content?: LayoutContent;
     dimensions?: {
@@ -10623,7 +10621,7 @@ declare type PropagatedEventType<Topic extends string, Type extends string> = `$
 
 /**
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
- * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
+ * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
  * event type key with `'view-'`.
  */
 declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
@@ -10637,7 +10635,7 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
 
 /**
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
- * prefixing the type string with `'window-'`.  Only {@link NativeWindowEvent native window events} will propagate
+ * prefixing the type string with `'window-'`.  Only {@link WindowSourcedEvent window-sourced events} will propagate
  * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
  * will *not* re-propagate.
  *

package/out/node-adapter-beta.d.ts

@@ -4391,7 +4391,7 @@ declare namespace ExternalApplicationEvents {
 }
 
 /**
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
+ * Union of possible `type` values for a {@link ApplicationEvent}.
  */
 declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
 
@@ -7271,8 +7271,7 @@ declare type LayoutInitializedEvent = BaseWindowEvent & {
 
 /**
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
- * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
+ * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
  *
  * @interface
  */
@@ -7574,8 +7573,7 @@ declare type LayoutOptions = {
     };
     /**
      * Content of the layout. There can only be one top-level LayoutItem in the content array.
-     * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
-     * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
+     * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
      */
     content?: LayoutContent;
     dimensions?: {
@@ -10623,7 +10621,7 @@ declare type PropagatedEventType<Topic extends string, Type extends string> = `$
 
 /**
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
- * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
+ * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
  * event type key with `'view-'`.
  */
 declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
@@ -10637,7 +10635,7 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
 
 /**
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
- * prefixing the type string with `'window-'`.  Only {@link NativeWindowEvent native window events} will propagate
+ * prefixing the type string with `'window-'`.  Only {@link WindowSourcedEvent window-sourced events} will propagate
  * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
  * will *not* re-propagate.
  *

package/out/node-adapter-public.d.ts

@@ -4391,7 +4391,7 @@ declare namespace ExternalApplicationEvents {
 }
 
 /**
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
+ * Union of possible `type` values for a {@link ApplicationEvent}.
  */
 declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
 
@@ -7271,8 +7271,7 @@ declare type LayoutInitializedEvent = BaseWindowEvent & {
 
 /**
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
- * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
+ * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
  *
  * @interface
  */
@@ -7574,8 +7573,7 @@ declare type LayoutOptions = {
     };
     /**
      * Content of the layout. There can only be one top-level LayoutItem in the content array.
-     * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
-     * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
+     * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
      */
     content?: LayoutContent;
     dimensions?: {
@@ -10623,7 +10621,7 @@ declare type PropagatedEventType<Topic extends string, Type extends string> = `$
 
 /**
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
- * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
+ * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
  * event type key with `'view-'`.
  */
 declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
@@ -10637,7 +10635,7 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
 
 /**
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
- * prefixing the type string with `'window-'`.  Only {@link NativeWindowEvent native window events} will propagate
+ * prefixing the type string with `'window-'`.  Only {@link WindowSourcedEvent window-sourced events} will propagate
  * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
  * will *not* re-propagate.
  *

package/out/node-adapter.d.ts

@@ -4509,7 +4509,7 @@ declare namespace ExternalApplicationEvents {
 }
 
 /**
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
+ * Union of possible `type` values for a {@link ApplicationEvent}.
  */
 declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
 
@@ -7558,8 +7558,7 @@ declare type LayoutInitializedEvent = BaseWindowEvent & {
 
 /**
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
- * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
+ * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
  *
  * @interface
  */
@@ -8022,8 +8021,7 @@ declare type LayoutOptions = {
     };
     /**
      * Content of the layout. There can only be one top-level LayoutItem in the content array.
-     * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
-     * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
+     * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
      */
     content?: LayoutContent;
     dimensions?: {
@@ -11151,7 +11149,7 @@ declare type PropagatedEventType<Topic extends string, Type extends string> = `$
 
 /**
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
- * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
+ * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
  * event type key with `'view-'`.
  */
 declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
@@ -11165,7 +11163,7 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
 
 /**
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
- * prefixing the type string with `'window-'`.  Only {@link NativeWindowEvent native window events} will propagate
+ * prefixing the type string with `'window-'`.  Only {@link WindowSourcedEvent window-sourced events} will propagate
  * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
  * will *not* re-propagate.
  *

package/out/node-adapter.js

@@ -18304,9 +18304,9 @@ var application = {};
  * 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 NativeApplicationEvent Native application events} (i.e. those that have not propagated from {@link OpenFin.ViewEvents Views}
+ * {@link ApplicationSourcedEvent Application-sourced 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}
+ * {@link 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.
@@ -18429,7 +18429,7 @@ var window$1 = {};
  * 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}
  *
- * {@link OpenFin.WindowEvents.NativeWindowEvent Native window events} (i.e. those that are not propagated from a
+ * {@link OpenFin.WindowEvents.WindowSourcedEvent Window-sourced 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-'`).
  *
@@ -18474,10 +18474,10 @@ Object.defineProperty(window$1, "__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
+ * If you need the payload type for a specific type of event (especially propagated events), use the emitting topic's `Payload` generic
+ * (e.g. {@link WindowEvents.Payload}) 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'>`.
+ * `WindowEvents.Payload<'view-created'>`.
  *
  * @packageDocumentation
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/node-adapter",
-    "version": "33.77.6",
+    "version": "33.77.8",
     "description": "See README.md",
     "main": "out/node-adapter.js",
     "types": "out/node-adapter.d.ts",