@openfin/node-adapter 34.78.21 → 34.78.23

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

@@ -1700,7 +1700,9 @@ declare type BaseConfig = {
 };
 
 /**
- * A base event.
+ * A base OpenFin event.  All OpenFin event payloads extend this type.
+ *
+ * @interface
  */
 declare type BaseEvent = {
     topic: string;
@@ -3313,6 +3315,15 @@ declare type ConstViewOptions = {
      * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
      */
     autoplayPolicy: AutoplayPolicyOptions;
+    /**
+     * **Platforms Only.**
+     * Determines what happens when a view is closed in a platform window.
+     * Supersedes `detachOnClose`, but has no default value.
+     * 'hide' hides the view on the platform window that closed it.
+     * 'detach' behaves like 'detachOnClose': true.
+     * 'destroy' is the default behavior as long as 'detachOnClose' is not set.
+     */
+    closeBehavior?: 'hide' | 'detach' | 'destroy';
 };
 
 /**
@@ -3379,9 +3390,16 @@ declare type ConstWindowOptions = {
      * 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.
+     * **NOTE:** - This option is ignored in non-Platforms apps.
      */
     closeOnLastViewRemoved: boolean;
+    /**
+     * @defaultValue 'all'
+     *
+     * Determines which views prevent close if `closeOnLastViewRemoved` is set to true. Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
+     * **NOTE:** - This option is ignored in non-Platforms apps.
+     */
+    viewsPreventingClose: 'all' | 'layout';
     /**
      * 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.
@@ -6085,7 +6103,8 @@ declare type Identity_5 = {
 declare type IdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<AdditionalPayload & OpenFin.Identity, Response>;
 
 /**
- * An Identity event.
+ * An event that contains the `uuid` property of an {@link OpenFin.Identity}.
+ *
  * @interface
  */
 declare type IdentityEvent = BaseEvent & {
@@ -9262,7 +9281,7 @@ declare type MutableWindowOptions = {
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
 
 /**
- * A Name event.
+ * An event that contains an entire {@link OpenFin.Identity}.
  * @interface
  */
 declare type NamedEvent = IdentityEvent & {

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

@@ -1700,7 +1700,9 @@ declare type BaseConfig = {
 };
 
 /**
- * A base event.
+ * A base OpenFin event.  All OpenFin event payloads extend this type.
+ *
+ * @interface
  */
 declare type BaseEvent = {
     topic: string;
@@ -3313,6 +3315,15 @@ declare type ConstViewOptions = {
      * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
      */
     autoplayPolicy: AutoplayPolicyOptions;
+    /**
+     * **Platforms Only.**
+     * Determines what happens when a view is closed in a platform window.
+     * Supersedes `detachOnClose`, but has no default value.
+     * 'hide' hides the view on the platform window that closed it.
+     * 'detach' behaves like 'detachOnClose': true.
+     * 'destroy' is the default behavior as long as 'detachOnClose' is not set.
+     */
+    closeBehavior?: 'hide' | 'detach' | 'destroy';
 };
 
 /**
@@ -3379,9 +3390,16 @@ declare type ConstWindowOptions = {
      * 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.
+     * **NOTE:** - This option is ignored in non-Platforms apps.
      */
     closeOnLastViewRemoved: boolean;
+    /**
+     * @defaultValue 'all'
+     *
+     * Determines which views prevent close if `closeOnLastViewRemoved` is set to true. Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
+     * **NOTE:** - This option is ignored in non-Platforms apps.
+     */
+    viewsPreventingClose: 'all' | 'layout';
     /**
      * 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.
@@ -6085,7 +6103,8 @@ declare type Identity_5 = {
 declare type IdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<AdditionalPayload & OpenFin.Identity, Response>;
 
 /**
- * An Identity event.
+ * An event that contains the `uuid` property of an {@link OpenFin.Identity}.
+ *
  * @interface
  */
 declare type IdentityEvent = BaseEvent & {
@@ -9262,7 +9281,7 @@ declare type MutableWindowOptions = {
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
 
 /**
- * A Name event.
+ * An event that contains an entire {@link OpenFin.Identity}.
  * @interface
  */
 declare type NamedEvent = IdentityEvent & {

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

@@ -1700,7 +1700,9 @@ declare type BaseConfig = {
 };
 
 /**
- * A base event.
+ * A base OpenFin event.  All OpenFin event payloads extend this type.
+ *
+ * @interface
  */
 declare type BaseEvent = {
     topic: string;
@@ -3313,6 +3315,15 @@ declare type ConstViewOptions = {
      * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
      */
     autoplayPolicy: AutoplayPolicyOptions;
+    /**
+     * **Platforms Only.**
+     * Determines what happens when a view is closed in a platform window.
+     * Supersedes `detachOnClose`, but has no default value.
+     * 'hide' hides the view on the platform window that closed it.
+     * 'detach' behaves like 'detachOnClose': true.
+     * 'destroy' is the default behavior as long as 'detachOnClose' is not set.
+     */
+    closeBehavior?: 'hide' | 'detach' | 'destroy';
 };
 
 /**
@@ -3379,9 +3390,16 @@ declare type ConstWindowOptions = {
      * 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.
+     * **NOTE:** - This option is ignored in non-Platforms apps.
      */
     closeOnLastViewRemoved: boolean;
+    /**
+     * @defaultValue 'all'
+     *
+     * Determines which views prevent close if `closeOnLastViewRemoved` is set to true. Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
+     * **NOTE:** - This option is ignored in non-Platforms apps.
+     */
+    viewsPreventingClose: 'all' | 'layout';
     /**
      * 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.
@@ -6085,7 +6103,8 @@ declare type Identity_5 = {
 declare type IdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<AdditionalPayload & OpenFin.Identity, Response>;
 
 /**
- * An Identity event.
+ * An event that contains the `uuid` property of an {@link OpenFin.Identity}.
+ *
  * @interface
  */
 declare type IdentityEvent = BaseEvent & {
@@ -9262,7 +9281,7 @@ declare type MutableWindowOptions = {
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
 
 /**
- * A Name event.
+ * An event that contains an entire {@link OpenFin.Identity}.
  * @interface
  */
 declare type NamedEvent = IdentityEvent & {

package/out/node-adapter.d.ts

@@ -1720,7 +1720,9 @@ declare type BaseConfig = {
 };
 
 /**
- * A base event.
+ * A base OpenFin event.  All OpenFin event payloads extend this type.
+ *
+ * @interface
  */
 declare type BaseEvent = {
     topic: string;
@@ -3407,6 +3409,15 @@ declare type ConstViewOptions = {
      * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
      */
     autoplayPolicy: AutoplayPolicyOptions;
+    /**
+     * **Platforms Only.**
+     * Determines what happens when a view is closed in a platform window.
+     * Supersedes `detachOnClose`, but has no default value.
+     * 'hide' hides the view on the platform window that closed it.
+     * 'detach' behaves like 'detachOnClose': true.
+     * 'destroy' is the default behavior as long as 'detachOnClose' is not set.
+     */
+    closeBehavior?: 'hide' | 'detach' | 'destroy';
 };
 
 /**
@@ -3473,9 +3484,16 @@ declare type ConstWindowOptions = {
      * 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.
+     * **NOTE:** - This option is ignored in non-Platforms apps.
      */
     closeOnLastViewRemoved: boolean;
+    /**
+     * @defaultValue 'all'
+     *
+     * Determines which views prevent close if `closeOnLastViewRemoved` is set to true. Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
+     * **NOTE:** - This option is ignored in non-Platforms apps.
+     */
+    viewsPreventingClose: 'all' | 'layout';
     /**
      * 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.
@@ -6231,7 +6249,8 @@ declare type Identity_5 = {
 declare type IdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<AdditionalPayload & OpenFin.Identity, Response>;
 
 /**
- * An Identity event.
+ * An event that contains the `uuid` property of an {@link OpenFin.Identity}.
+ *
  * @interface
  */
 declare type IdentityEvent = BaseEvent & {
@@ -9718,7 +9737,7 @@ declare type MutableWindowOptions = {
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
 
 /**
- * A Name event.
+ * An event that contains an entire {@link OpenFin.Identity}.
  * @interface
  */
 declare type NamedEvent = IdentityEvent & {

package/out/node-adapter.js

@@ -17820,6 +17820,11 @@ Object.defineProperty(application, "__esModule", { value: true });
 
 var base = {};
 
+/**
+ * Namespace for shared event payloads and utility types common to all event emitters.
+ *
+ * @packageDocumentation
+ */
 Object.defineProperty(base, "__esModule", { value: true });
 
 var externalApplication = {};

package/package.json

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