@openfin/node-adapter 35.78.12 → 35.78.15

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

@@ -43,6 +43,8 @@ declare type Accelerator = {
 };
 
 /**
+ * Options to use when adding a view to a {@link TabStack}.
+ *
  * @interface
  */
 declare type AddViewOptions = CreateViewTarget & {
@@ -927,6 +929,7 @@ declare namespace ApplicationEvents {
         RespondingEvent,
         StartedEvent,
         ApplicationSourcedEvent,
+        ApplicationSourcedEventType,
         Event_3 as Event,
         ApplicationEvent,
         EventType_3 as EventType,
@@ -1299,6 +1302,11 @@ declare type ApplicationPermissions = {
  */
 declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
 
+/**
+ * Union of possible type values for an {@link ApplicationSourcedEvent}.
+ */
+declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
+
 declare type ApplicationState = OpenFin.ApplicationState;
 
 /**
@@ -4458,7 +4466,7 @@ declare type CreateViewPayload = {
 /**
  * @interface
  */
-declare type CreateViewTarget = LayoutIdentity & {
+declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
     /**
      * If specified, view creation will not attach to a window and caller must
      * insert the view into the layout explicitly
@@ -5291,7 +5299,7 @@ declare type EventType_7 = Event_10['type'];
 /**
  * Union of possible `type` values for a {@link SystemEvent}.
  */
-declare type EventType_8 = SystemEvent['type'];
+declare type EventType_8 = Event_11['type'];
 
 /* Excluded from this release type: EventWithId */
 
@@ -8627,7 +8635,7 @@ declare type LaunchIntoPlatformPayload = {
 declare class Layout extends Base {
     #private;
     /* Excluded from this release type: init */
-    identity: OpenFin.LayoutIdentity;
+    identity: OpenFin.Identity | OpenFin.LayoutIdentity;
     private platform;
     wire: Transport;
     /* Excluded from this release type: __constructor */
@@ -8843,18 +8851,18 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
  */
 declare type LayoutIdentity = Identity_5 & {
     /**
-     * The name of the layout an action should be targeted to. When not provided,
-     * OpenFin attempts to resolve the instance via visibility checks.
+     * The name of the layout in a given window.
      */
-    layoutName?: string;
+    layoutName: string;
 };
 
 /**
- * Generated when a window and all of its layout's views have either finished or failed navigation.
+ * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
  * @interface
  */
 declare type LayoutInitializedEvent = BaseEvent_5 & {
     type: 'layout-initialized';
+    layoutIdentity: OpenFin.LayoutIdentity;
     ofViews: (OpenFin.Identity & {
         entityType: 'view';
     })[];
@@ -8928,6 +8936,27 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
      * @returns T
      */
     getLayoutSnapshot(): Promise<T>;
+    /**
+     * @experimental
+     *
+     * A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
+     * this method to control the target layout for Layout API calls.
+     *
+     * Example use case: You have hidden all the layouts and are showing a dialog that will
+     * execute an API call (ex: Layout.replace()) - override this method and save the
+     * "last visible" layout identity and return it.
+     *
+     * By default, OpenFin will use a series of checks to determine which Layout the API
+     * call must route to in this order of precedence:
+     * - try to resolve the layout from the layoutIdentity, throws if missing
+     * - if there is only 1 layout, resolves that one
+     * - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
+     * - returns undefined
+     *
+     * @param identity
+     * @returns LayoutIdentity | undefined
+     */
+    resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
     /**
      * @experimental
      *
@@ -8999,7 +9028,7 @@ declare class LayoutModule extends Base {
      * const layoutConfig = await layout.getConfig();
      * ```
      */
-    wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
+    wrap(identity: OpenFin.Identity | OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
     /**
      * Synchronously returns a Layout object that represents a Window's layout.
      *
@@ -9019,7 +9048,7 @@ declare class LayoutModule extends Base {
      * const layoutConfig = await layout.getConfig();
      * ```
      */
-    wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
+    wrapSync(identity: OpenFin.Identity | OpenFin.LayoutIdentity): OpenFin.Layout;
     /**
      * Asynchronously returns a Layout object that represents a Window's layout.
      *
@@ -9187,6 +9216,9 @@ declare type LayoutOptions = {
     };
 };
 
+/**
+ * Represents the position of an item in a layout relative to another.
+ */
 declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 
 /**
@@ -12828,7 +12860,7 @@ declare type ReplaceLayoutPayload = {
     /**
      * Identity of the window whose layout will be replaced.
      */
-    target: LayoutIdentity;
+    target: Identity_5 | LayoutIdentity;
 };
 
 /**
@@ -15319,20 +15351,6 @@ declare interface TabDragListener extends EventEmitter_2 {
     contentItem: ContentItem;
 }
 
-/**
- * @typedef {string} LayoutPosition
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
- */
-/**
- * @typedef {object} StackCreationOptions
- * @summary Stack creation options.
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
- */
-/**
- * @typedef {object} TabStack~AddViewOptions
- * @summary Options to use when adding a view to a {@link TabStack}
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
- */
 /**
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
  */
@@ -16418,7 +16436,7 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
  */
 declare type ViewDetachedEvent = BaseEvent_5 & {
     type: 'view-detached';
-    target: OpenFin.Identity;
+    target: OpenFin.Identity | null;
     previousTarget: OpenFin.Identity;
     viewIdentity: OpenFin.Identity;
 };

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

@@ -43,6 +43,8 @@ declare type Accelerator = {
 };
 
 /**
+ * Options to use when adding a view to a {@link TabStack}.
+ *
  * @interface
  */
 declare type AddViewOptions = CreateViewTarget & {
@@ -927,6 +929,7 @@ declare namespace ApplicationEvents {
         RespondingEvent,
         StartedEvent,
         ApplicationSourcedEvent,
+        ApplicationSourcedEventType,
         Event_3 as Event,
         ApplicationEvent,
         EventType_3 as EventType,
@@ -1299,6 +1302,11 @@ declare type ApplicationPermissions = {
  */
 declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
 
+/**
+ * Union of possible type values for an {@link ApplicationSourcedEvent}.
+ */
+declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
+
 declare type ApplicationState = OpenFin.ApplicationState;
 
 /**
@@ -4458,7 +4466,7 @@ declare type CreateViewPayload = {
 /**
  * @interface
  */
-declare type CreateViewTarget = LayoutIdentity & {
+declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
     /**
      * If specified, view creation will not attach to a window and caller must
      * insert the view into the layout explicitly
@@ -5291,7 +5299,7 @@ declare type EventType_7 = Event_10['type'];
 /**
  * Union of possible `type` values for a {@link SystemEvent}.
  */
-declare type EventType_8 = SystemEvent['type'];
+declare type EventType_8 = Event_11['type'];
 
 /* Excluded from this release type: EventWithId */
 
@@ -8627,7 +8635,7 @@ declare type LaunchIntoPlatformPayload = {
 declare class Layout extends Base {
     #private;
     /* Excluded from this release type: init */
-    identity: OpenFin.LayoutIdentity;
+    identity: OpenFin.Identity | OpenFin.LayoutIdentity;
     private platform;
     wire: Transport;
     /* Excluded from this release type: __constructor */
@@ -8843,18 +8851,18 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
  */
 declare type LayoutIdentity = Identity_5 & {
     /**
-     * The name of the layout an action should be targeted to. When not provided,
-     * OpenFin attempts to resolve the instance via visibility checks.
+     * The name of the layout in a given window.
      */
-    layoutName?: string;
+    layoutName: string;
 };
 
 /**
- * Generated when a window and all of its layout's views have either finished or failed navigation.
+ * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
  * @interface
  */
 declare type LayoutInitializedEvent = BaseEvent_5 & {
     type: 'layout-initialized';
+    layoutIdentity: OpenFin.LayoutIdentity;
     ofViews: (OpenFin.Identity & {
         entityType: 'view';
     })[];
@@ -8928,6 +8936,27 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
      * @returns T
      */
     getLayoutSnapshot(): Promise<T>;
+    /**
+     * @experimental
+     *
+     * A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
+     * this method to control the target layout for Layout API calls.
+     *
+     * Example use case: You have hidden all the layouts and are showing a dialog that will
+     * execute an API call (ex: Layout.replace()) - override this method and save the
+     * "last visible" layout identity and return it.
+     *
+     * By default, OpenFin will use a series of checks to determine which Layout the API
+     * call must route to in this order of precedence:
+     * - try to resolve the layout from the layoutIdentity, throws if missing
+     * - if there is only 1 layout, resolves that one
+     * - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
+     * - returns undefined
+     *
+     * @param identity
+     * @returns LayoutIdentity | undefined
+     */
+    resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
     /**
      * @experimental
      *
@@ -8999,7 +9028,7 @@ declare class LayoutModule extends Base {
      * const layoutConfig = await layout.getConfig();
      * ```
      */
-    wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
+    wrap(identity: OpenFin.Identity | OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
     /**
      * Synchronously returns a Layout object that represents a Window's layout.
      *
@@ -9019,7 +9048,7 @@ declare class LayoutModule extends Base {
      * const layoutConfig = await layout.getConfig();
      * ```
      */
-    wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
+    wrapSync(identity: OpenFin.Identity | OpenFin.LayoutIdentity): OpenFin.Layout;
     /**
      * Asynchronously returns a Layout object that represents a Window's layout.
      *
@@ -9187,6 +9216,9 @@ declare type LayoutOptions = {
     };
 };
 
+/**
+ * Represents the position of an item in a layout relative to another.
+ */
 declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 
 /**
@@ -12828,7 +12860,7 @@ declare type ReplaceLayoutPayload = {
     /**
      * Identity of the window whose layout will be replaced.
      */
-    target: LayoutIdentity;
+    target: Identity_5 | LayoutIdentity;
 };
 
 /**
@@ -15319,20 +15351,6 @@ declare interface TabDragListener extends EventEmitter_2 {
     contentItem: ContentItem;
 }
 
-/**
- * @typedef {string} LayoutPosition
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
- */
-/**
- * @typedef {object} StackCreationOptions
- * @summary Stack creation options.
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
- */
-/**
- * @typedef {object} TabStack~AddViewOptions
- * @summary Options to use when adding a view to a {@link TabStack}
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
- */
 /**
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
  */
@@ -16418,7 +16436,7 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
  */
 declare type ViewDetachedEvent = BaseEvent_5 & {
     type: 'view-detached';
-    target: OpenFin.Identity;
+    target: OpenFin.Identity | null;
     previousTarget: OpenFin.Identity;
     viewIdentity: OpenFin.Identity;
 };

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

@@ -43,6 +43,8 @@ declare type Accelerator = {
 };
 
 /**
+ * Options to use when adding a view to a {@link TabStack}.
+ *
  * @interface
  */
 declare type AddViewOptions = CreateViewTarget & {
@@ -927,6 +929,7 @@ declare namespace ApplicationEvents {
         RespondingEvent,
         StartedEvent,
         ApplicationSourcedEvent,
+        ApplicationSourcedEventType,
         Event_3 as Event,
         ApplicationEvent,
         EventType_3 as EventType,
@@ -1299,6 +1302,11 @@ declare type ApplicationPermissions = {
  */
 declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
 
+/**
+ * Union of possible type values for an {@link ApplicationSourcedEvent}.
+ */
+declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
+
 declare type ApplicationState = OpenFin.ApplicationState;
 
 /**
@@ -4458,7 +4466,7 @@ declare type CreateViewPayload = {
 /**
  * @interface
  */
-declare type CreateViewTarget = LayoutIdentity & {
+declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
     /**
      * If specified, view creation will not attach to a window and caller must
      * insert the view into the layout explicitly
@@ -5291,7 +5299,7 @@ declare type EventType_7 = Event_10['type'];
 /**
  * Union of possible `type` values for a {@link SystemEvent}.
  */
-declare type EventType_8 = SystemEvent['type'];
+declare type EventType_8 = Event_11['type'];
 
 /* Excluded from this release type: EventWithId */
 
@@ -8627,7 +8635,7 @@ declare type LaunchIntoPlatformPayload = {
 declare class Layout extends Base {
     #private;
     /* Excluded from this release type: init */
-    identity: OpenFin.LayoutIdentity;
+    identity: OpenFin.Identity | OpenFin.LayoutIdentity;
     private platform;
     wire: Transport;
     /* Excluded from this release type: __constructor */
@@ -8843,18 +8851,18 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
  */
 declare type LayoutIdentity = Identity_5 & {
     /**
-     * The name of the layout an action should be targeted to. When not provided,
-     * OpenFin attempts to resolve the instance via visibility checks.
+     * The name of the layout in a given window.
      */
-    layoutName?: string;
+    layoutName: string;
 };
 
 /**
- * Generated when a window and all of its layout's views have either finished or failed navigation.
+ * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
  * @interface
  */
 declare type LayoutInitializedEvent = BaseEvent_5 & {
     type: 'layout-initialized';
+    layoutIdentity: OpenFin.LayoutIdentity;
     ofViews: (OpenFin.Identity & {
         entityType: 'view';
     })[];
@@ -8928,6 +8936,27 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
      * @returns T
      */
     getLayoutSnapshot(): Promise<T>;
+    /**
+     * @experimental
+     *
+     * A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
+     * this method to control the target layout for Layout API calls.
+     *
+     * Example use case: You have hidden all the layouts and are showing a dialog that will
+     * execute an API call (ex: Layout.replace()) - override this method and save the
+     * "last visible" layout identity and return it.
+     *
+     * By default, OpenFin will use a series of checks to determine which Layout the API
+     * call must route to in this order of precedence:
+     * - try to resolve the layout from the layoutIdentity, throws if missing
+     * - if there is only 1 layout, resolves that one
+     * - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
+     * - returns undefined
+     *
+     * @param identity
+     * @returns LayoutIdentity | undefined
+     */
+    resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
     /**
      * @experimental
      *
@@ -8999,7 +9028,7 @@ declare class LayoutModule extends Base {
      * const layoutConfig = await layout.getConfig();
      * ```
      */
-    wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
+    wrap(identity: OpenFin.Identity | OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
     /**
      * Synchronously returns a Layout object that represents a Window's layout.
      *
@@ -9019,7 +9048,7 @@ declare class LayoutModule extends Base {
      * const layoutConfig = await layout.getConfig();
      * ```
      */
-    wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
+    wrapSync(identity: OpenFin.Identity | OpenFin.LayoutIdentity): OpenFin.Layout;
     /**
      * Asynchronously returns a Layout object that represents a Window's layout.
      *
@@ -9187,6 +9216,9 @@ declare type LayoutOptions = {
     };
 };
 
+/**
+ * Represents the position of an item in a layout relative to another.
+ */
 declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 
 /**
@@ -12828,7 +12860,7 @@ declare type ReplaceLayoutPayload = {
     /**
      * Identity of the window whose layout will be replaced.
      */
-    target: LayoutIdentity;
+    target: Identity_5 | LayoutIdentity;
 };
 
 /**
@@ -15319,20 +15351,6 @@ declare interface TabDragListener extends EventEmitter_2 {
     contentItem: ContentItem;
 }
 
-/**
- * @typedef {string} LayoutPosition
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
- */
-/**
- * @typedef {object} StackCreationOptions
- * @summary Stack creation options.
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
- */
-/**
- * @typedef {object} TabStack~AddViewOptions
- * @summary Options to use when adding a view to a {@link TabStack}
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
- */
 /**
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
  */
@@ -16418,7 +16436,7 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
  */
 declare type ViewDetachedEvent = BaseEvent_5 & {
     type: 'view-detached';
-    target: OpenFin.Identity;
+    target: OpenFin.Identity | null;
     previousTarget: OpenFin.Identity;
     viewIdentity: OpenFin.Identity;
 };

package/out/node-adapter.d.ts

@@ -43,6 +43,8 @@ declare type Accelerator = {
 };
 
 /**
+ * Options to use when adding a view to a {@link TabStack}.
+ *
  * @interface
  */
 declare type AddViewOptions = CreateViewTarget & {
@@ -933,6 +935,7 @@ declare namespace ApplicationEvents {
         RespondingEvent,
         StartedEvent,
         ApplicationSourcedEvent,
+        ApplicationSourcedEventType,
         Event_3 as Event,
         ApplicationEvent,
         EventType_3 as EventType,
@@ -1305,6 +1308,11 @@ declare type ApplicationPermissions = {
  */
 declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
 
+/**
+ * Union of possible type values for an {@link ApplicationSourcedEvent}.
+ */
+declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
+
 declare type ApplicationState = OpenFin.ApplicationState;
 
 /**
@@ -3411,57 +3419,6 @@ declare type ClosingEvent = BaseEvent_5 & {
  */
 declare class ColumnOrRow extends LayoutNode {
     #private;
-    /**
-     * Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
-     * @function isRoot
-     * @memberof ColumnOrRow
-     * @instance
-     * @tutorial ColumnOrRow.isRoot
-     * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
-     */
-    /**
-     * Determines if this  {@link ColumnOrRow} exists.
-     * @function exists
-     * @instance
-     * @memberof ColumnOrRow
-     * @tutorial ColumnOrRow.exists
-     * @returns Resolves true if the TabStack exists, or false if it has been destroyed.
-     */
-    /**
-     * Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
-     * @function getParent
-     * @instance
-     * @memberof ColumnOrRow
-     * @tutorial ColumnOrRow.getParent
-     * @returns Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if
-     * this {@link ColumnOrRow}does not exist or is the root content item.
-     */
-    /**
-     * Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
-     * @function getAdjacentStacks
-     * @instance
-     * @memberof ColumnOrRow
-     * @param  {LayoutPosition} edge - Edge to check for any adjacent stacks.
-     *
-     * @tutorial ColumnOrRow.getAdjacentStacks
-     */
-    /**
-     * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
-     *
-     * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
-     * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
-     * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
-     * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
-     *
-     * @function createAdjacentStack
-     * @instance
-     * @memberof ColumnOrRow
-     * @param views - List of identities or view creation options of the views to include in the stack
-     * @param options - Creation options.
-     * @returns The created TabStack
-     * @tutorial ColumnOrRow.createAdjacentStack
-     * @experimental
-     */
     /**
      * @internal
      */
@@ -4552,7 +4509,7 @@ declare type CreateViewPayload = {
 /**
  * @interface
  */
-declare type CreateViewTarget = LayoutIdentity & {
+declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
     /**
      * If specified, view creation will not attach to a window and caller must
      * insert the view into the layout explicitly
@@ -5390,7 +5347,7 @@ declare type EventType_7 = Event_10['type'];
 /**
  * Union of possible `type` values for a {@link SystemEvent}.
  */
-declare type EventType_8 = SystemEvent['type'];
+declare type EventType_8 = Event_11['type'];
 
 /**
  * @internal
@@ -8799,7 +8756,7 @@ declare class Layout extends Base {
      * @internal
      */
     init: (options?: OpenFin.InitLayoutOptions) => Promise<Layout>;
-    identity: OpenFin.LayoutIdentity;
+    identity: OpenFin.Identity | OpenFin.LayoutIdentity;
     private platform;
     wire: Transport;
     /**
@@ -9018,18 +8975,18 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
  */
 declare type LayoutIdentity = Identity_5 & {
     /**
-     * The name of the layout an action should be targeted to. When not provided,
-     * OpenFin attempts to resolve the instance via visibility checks.
+     * The name of the layout in a given window.
      */
-    layoutName?: string;
+    layoutName: string;
 };
 
 /**
- * Generated when a window and all of its layout's views have either finished or failed navigation.
+ * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
  * @interface
  */
 declare type LayoutInitializedEvent = BaseEvent_5 & {
     type: 'layout-initialized';
+    layoutIdentity: OpenFin.LayoutIdentity;
     ofViews: (OpenFin.Identity & {
         entityType: 'view';
     })[];
@@ -9103,6 +9060,27 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
      * @returns T
      */
     getLayoutSnapshot(): Promise<T>;
+    /**
+     * @experimental
+     *
+     * A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
+     * this method to control the target layout for Layout API calls.
+     *
+     * Example use case: You have hidden all the layouts and are showing a dialog that will
+     * execute an API call (ex: Layout.replace()) - override this method and save the
+     * "last visible" layout identity and return it.
+     *
+     * By default, OpenFin will use a series of checks to determine which Layout the API
+     * call must route to in this order of precedence:
+     * - try to resolve the layout from the layoutIdentity, throws if missing
+     * - if there is only 1 layout, resolves that one
+     * - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
+     * - returns undefined
+     *
+     * @param identity
+     * @returns LayoutIdentity | undefined
+     */
+    resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
     /**
      * @experimental
      *
@@ -9174,7 +9152,7 @@ declare class LayoutModule extends Base {
      * const layoutConfig = await layout.getConfig();
      * ```
      */
-    wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
+    wrap(identity: OpenFin.Identity | OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
     /**
      * Synchronously returns a Layout object that represents a Window's layout.
      *
@@ -9194,7 +9172,7 @@ declare class LayoutModule extends Base {
      * const layoutConfig = await layout.getConfig();
      * ```
      */
-    wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
+    wrapSync(identity: OpenFin.Identity | OpenFin.LayoutIdentity): OpenFin.Layout;
     /**
      * Asynchronously returns a Layout object that represents a Window's layout.
      *
@@ -9366,6 +9344,15 @@ declare abstract class LayoutNode {
     /**
      * Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
      *
+     * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
+     * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
+     * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
+     * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
+     *
+     * @param views The views that will populate the new TabStack.
+     * @param options Additional options that control new TabStack creation.
+     * @returns The newly-created TabStack.
+     *
      * @example
      * ```js
      * if (!fin.me.isView) {
@@ -9400,12 +9387,15 @@ declare abstract class LayoutNode {
      * console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
      *
      * ```
+     * @experimental
      */
     createAdjacentStack: (views: OpenFin.PlatformViewCreationOptions[], options: {
         position?: OpenFin.LayoutPosition;
     }) => Promise<TabStack>;
     /**
-     * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
+     * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow.
+     *
+     * @param edge Edge whose adjacent TabStacks will be returned.
      *
      * @example
      * ```js
@@ -9425,6 +9415,7 @@ declare abstract class LayoutNode {
      * console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
      *
      * ```
+     * @experimental
      */
     getAdjacentStacks: (edge: OpenFin.LayoutPosition) => Promise<TabStack[]>;
 }
@@ -9519,6 +9510,9 @@ declare type LayoutOptions = {
     };
 };
 
+/**
+ * Represents the position of an item in a layout relative to another.
+ */
 declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 
 /**
@@ -10331,7 +10325,7 @@ declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'c
  *
  * Ensures that an event type key doesn't include any `-requested` events.  Distributes over unions.
  */
-declare type NotRequested<EventType extends String> = EventType extends `${infer U}-requested` ? never : EventType;
+declare type NotRequested<EventType extends String> = EventType extends `${string}-requested` ? never : EventType;
 
 /**
  * Generated when an application is not responding.
@@ -13271,7 +13265,7 @@ declare type ReplaceLayoutPayload = {
     /**
      * Identity of the window whose layout will be replaced.
      */
-    target: LayoutIdentity;
+    target: Identity_5 | LayoutIdentity;
 };
 
 /**
@@ -15774,75 +15768,11 @@ declare interface TabDragListener extends EventEmitter_2 {
     contentItem: ContentItem;
 }
 
-/**
- * @typedef {string} LayoutPosition
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
- */
-/**
- * @typedef {object} StackCreationOptions
- * @summary Stack creation options.
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
- */
-/**
- * @typedef {object} TabStack~AddViewOptions
- * @summary Options to use when adding a view to a {@link TabStack}
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
- */
 /**
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
  */
 declare class TabStack extends LayoutNode {
     #private;
-    /**
-     * Determines if this {@link TabStack} is the top level content item in the current layout.
-     * @function isRoot
-     * @memberof TabStack
-     * @instance
-     * @tutorial TabStack.isRoot
-     * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
-     */
-    /**
-     * Determines if this  {@link TabStack} exists.
-     * @function exists
-     * @instance
-     * @memberof TabStack
-     * @tutorial TabStack.exists
-     * @returns Resolves true if this is the TabStack exists, or false if it has been destroyed.
-     */
-    /**
-     * Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
-     * @function getParent
-     * @instance
-     * @memberof TabStack
-     * @tutorial TabStack.getParent
-     * @returns is the root content item or does not exist.
-     */
-    /**
-     * Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
-     * @function getAdjacentStacks
-     * @instance
-     * @memberof TabStack
-     * @param  {LayoutPosition} edge - Edge to check for any adjacent stacks.
-     *
-     * @tutorial TabStack.getAdjacentStacks
-     */
-    /**
-     * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
-     *
-     * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
-     * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
-     * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
-     * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
-     *
-     * @function createAdjacentStack
-     * @instance
-     * @memberof TabStack
-     * @param views - List of identities or view creation options of the views to include in the stack
-     * @param options - Creation options.
-     * @returns The created TabStack.
-     * @tutorial TabStack.createAdjacentStack
-     * @experimental
-     */
     /** @internal */
     constructor(client: LayoutEntitiesClient, entityId: string);
     /**
@@ -16961,7 +16891,7 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
  */
 declare type ViewDetachedEvent = BaseEvent_5 & {
     type: 'view-detached';
-    target: OpenFin.Identity;
+    target: OpenFin.Identity | null;
     previousTarget: OpenFin.Identity;
     viewIdentity: OpenFin.Identity;
 };

package/out/node-adapter.js

@@ -1012,6 +1012,15 @@ class LayoutNode {
         /**
          * Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
          *
+         * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
+         * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
+         * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
+         * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
+         *
+         * @param views The views that will populate the new TabStack.
+         * @param options Additional options that control new TabStack creation.
+         * @returns The newly-created TabStack.
+         *
          * @example
          * ```js
          * if (!fin.me.isView) {
@@ -1046,13 +1055,16 @@ class LayoutNode {
          * console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
          *
          * ```
+         * @experimental
          */
         this.createAdjacentStack = async (views, options) => {
             const entityId = await __classPrivateFieldGet$e(this, _LayoutNode_client, "f").createAdjacentStack(this.entityId, views, options);
             return LayoutNode.getEntity({ entityId, type: 'stack' }, __classPrivateFieldGet$e(this, _LayoutNode_client, "f"));
         };
         /**
-         * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
+         * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow.
+         *
+         * @param edge Edge whose adjacent TabStacks will be returned.
          *
          * @example
          * ```js
@@ -1072,6 +1084,7 @@ class LayoutNode {
          * console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
          *
          * ```
+         * @experimental
          */
         this.getAdjacentStacks = async (edge) => {
             const adjacentStacks = await __classPrivateFieldGet$e(this, _LayoutNode_client, "f").getAdjacentStacks({
@@ -1115,74 +1128,10 @@ LayoutNode.getEntity = (definition, client) => {
             throw new Error(`Unrecognised Layout Entity encountered ('${JSON.stringify(definition)})`);
     }
 };
-/**
- * @typedef {string} LayoutPosition
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
- */
-/**
- * @typedef {object} StackCreationOptions
- * @summary Stack creation options.
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
- */
-/**
- * @typedef {object} TabStack~AddViewOptions
- * @summary Options to use when adding a view to a {@link TabStack}
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
- */
 /**
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
  */
 class TabStack extends LayoutNode {
-    /**
-     * Determines if this {@link TabStack} is the top level content item in the current layout.
-     * @function isRoot
-     * @memberof TabStack
-     * @instance
-     * @tutorial TabStack.isRoot
-     * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
-     */
-    /**
-     * Determines if this  {@link TabStack} exists.
-     * @function exists
-     * @instance
-     * @memberof TabStack
-     * @tutorial TabStack.exists
-     * @returns Resolves true if this is the TabStack exists, or false if it has been destroyed.
-     */
-    /**
-     * Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
-     * @function getParent
-     * @instance
-     * @memberof TabStack
-     * @tutorial TabStack.getParent
-     * @returns is the root content item or does not exist.
-     */
-    /**
-     * Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
-     * @function getAdjacentStacks
-     * @instance
-     * @memberof TabStack
-     * @param  {LayoutPosition} edge - Edge to check for any adjacent stacks.
-     *
-     * @tutorial TabStack.getAdjacentStacks
-     */
-    /**
-     * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
-     *
-     * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
-     * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
-     * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
-     * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
-     *
-     * @function createAdjacentStack
-     * @instance
-     * @memberof TabStack
-     * @param views - List of identities or view creation options of the views to include in the stack
-     * @param options - Creation options.
-     * @returns The created TabStack.
-     * @tutorial TabStack.createAdjacentStack
-     * @experimental
-     */
     /** @internal */
     constructor(client, entityId) {
         super(client, entityId);
@@ -1315,57 +1264,6 @@ _TabStack_client = new WeakMap();
  * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
  */
 class ColumnOrRow extends LayoutNode {
-    /**
-     * Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
-     * @function isRoot
-     * @memberof ColumnOrRow
-     * @instance
-     * @tutorial ColumnOrRow.isRoot
-     * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
-     */
-    /**
-     * Determines if this  {@link ColumnOrRow} exists.
-     * @function exists
-     * @instance
-     * @memberof ColumnOrRow
-     * @tutorial ColumnOrRow.exists
-     * @returns Resolves true if the TabStack exists, or false if it has been destroyed.
-     */
-    /**
-     * Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
-     * @function getParent
-     * @instance
-     * @memberof ColumnOrRow
-     * @tutorial ColumnOrRow.getParent
-     * @returns Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if
-     * this {@link ColumnOrRow}does not exist or is the root content item.
-     */
-    /**
-     * Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
-     * @function getAdjacentStacks
-     * @instance
-     * @memberof ColumnOrRow
-     * @param  {LayoutPosition} edge - Edge to check for any adjacent stacks.
-     *
-     * @tutorial ColumnOrRow.getAdjacentStacks
-     */
-    /**
-     * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
-     *
-     * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
-     * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
-     * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
-     * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
-     *
-     * @function createAdjacentStack
-     * @instance
-     * @memberof ColumnOrRow
-     * @param views - List of identities or view creation options of the views to include in the stack
-     * @param options - Creation options.
-     * @returns The created TabStack
-     * @tutorial ColumnOrRow.createAdjacentStack
-     * @experimental
-     */
     /**
      * @internal
      */
@@ -12841,7 +12739,7 @@ class Layout extends base_1$6.Base {
             // don't expose
         });
         const client = await __classPrivateFieldGet$5(this, _Layout_layoutClient, "f").getValue();
-        const root = await client.getRoot(this.identity);
+        const root = await client.getRoot('layoutName' in this.identity ? this.identity : undefined);
         return layout_entities_1.LayoutNode.getEntity(root, client);
     }
 }

package/package.json

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