@openfin/core 31.74.30 → 31.75.1

package/src/api/platform/layout/entities/layout-entities.d.ts

@@ -1,25 +1,27 @@
 import type * as OpenFin from '../../../../OpenFin';
 import { LayoutEntitiesClient } from '../shapes';
 /**
+ * @ignore
  * @internal
  * Supplies an ApiClient for {@link LayoutEntitiesController} and helper methods
  * for the entities {@link TabStack} AND {@link ColumnOrRow} to use.
  */
 export declare abstract class LayoutNode {
     #private;
-    /** @internal */
-    protected constructor(client: LayoutEntitiesClient, entityId: string);
     /**
      * @internal
-     * The type of this node, one of: 'row' | 'column' | 'stack';
+     * @ignore
      */
-    readonly abstract type: OpenFin.LayoutEntityTypes;
+    protected constructor(client: LayoutEntitiesClient, entityId: string);
+    abstract readonly type: OpenFin.LayoutEntityTypes;
     /**
      * @internal
+     * @ignore
      * This instance's unique id used when calling the layout-entities-controller api client
      */
     protected readonly entityId: string;
     /**
+     * @ignore
      * @internal
      * Encapsulates Api consumption of {@link LayoutEntitiesController} with a relayed dispatch
      * @param client
@@ -29,51 +31,83 @@ export declare abstract class LayoutNode {
      */
     static newLayoutEntitiesClient: (client: OpenFin.ChannelClient, controllerId: string, identity: OpenFin.Identity) => Promise<LayoutEntitiesClient>;
     static getEntity: (definition: OpenFin.LayoutEntityDefinition, client: LayoutEntitiesClient) => ColumnOrRow | TabStack;
+    isRoot: () => Promise<boolean>;
+    exists: () => Promise<boolean>;
+    getParent: () => Promise<ColumnOrRow | TabStack | undefined>;
+    createAdjacentStack: (views: OpenFin.PlatformViewCreationOptions[], options: {
+        position?: OpenFin.LayoutPosition;
+    }) => Promise<TabStack>;
+    getAdjacentStacks: (edge: OpenFin.LayoutPosition) => Promise<TabStack[]>;
+}
+/**
+ * @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.
+ */
+export declare class TabStack extends LayoutNode {
+    #private;
     /**
-     * Determines if this {@link ColumnOrRow} or {@link TabStack} is the top level content item in the current layout.
-     * @returns Promise resolving true if this is the root, or false otherwise.
+     * Determines if this {@link TabStack} is the top level content item in the current layout.
+     * @function isRoot
+     * @memberof TabStack
+     * @instance
+     * @tutorial TabStack.isRoot
+     * @return {Promise<boolean>} Resolves true if this TabStack is the top level content item, or false if it is not.
      */
-    isRoot: () => Promise<boolean>;
     /**
-     * Determines if this {@link ColumnOrRow} or {@link TabStack} is the top level
-     * content item in the current layout.
-     * @returns Promise resolving true if this is the root, or false otherwise.
+     * Determines if this  {@link TabStack} exists.
+     * @function exists
+     * @instance
+     * @memberof TabStack
+     * @tutorial TabStack.exists
+     * @return {Promise<boolean>} Resolves true if this is the TabStack exists, or false if it has been destroyed.
      */
-    exists: () => Promise<boolean>;
     /**
-     * Retrieves the parent {@link ColumnOrRow} or {@link TabStack} of this item, if one exists.
-     * @returns Promise resolving with the {@link ColumnOrRow} or {@link TabStack} that contains this item, or undefined if this is the root content item.
+     * Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
+     * @function getParent
+     * @instance
+     * @memberof TabStack
+     * @tutorial TabStack.getParent
+     * @return {Promise<ColumnOrRow | TabStack | undefined>} Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if this {@link TabStack} is the root content item or does not exist.
      */
-    getParent: () => Promise<ColumnOrRow | TabStack | undefined>;
     /**
-     * Given a list of view creation options or references and a layout position, creates an adjacent {@link TabStack}
+     * 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.
+     * @returns {Promise<TabStack[]>}
+     * @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.
      *
-     * @param views List of identities or view creation options of the views to include in the stack
-     * @param options Creation options, defaults to position: 'right'
-     * @returns an instance of {@link TabStack} containing the given views
+     * @function createAdjacentStack
+     * @instance
+     * @memberof TabStack
+     * @param {View~options} views - List of identities or view creation options of the views to include in the stack
+     * @param {StackCreationOptions} options - Creation options.
+     * @returns {Promise<TabStack>} The created TabStack.
+     * @tutorial TabStack.createAdjacentStack
      * @experimental
      */
-    createAdjacentStack: (views: OpenFin.PlatformViewCreationOptions[], options: {
-        position?: OpenFin.LayoutPosition;
-    }) => Promise<TabStack>;
-    /**
-     * Finds the immediate adjacent layout item given an edge Position
-     * @param edgePosition
-     * @returns either {@link TabStack} or {@link ColumnOrRow} that was found, or `undefined` if there is no item with that edgePosition
-     */
-    getAdjacentStacks: (edge: OpenFin.LayoutPosition) => Promise<TabStack[]>;
-}
-/**
- * A {@link TabStack} is used to manage the state of a TabStack within an OpenFin Layout and
- * traverse to its parent Content Item.
- */
-export declare class TabStack extends LayoutNode {
-    #private;
     /** @internal */
     constructor(client: LayoutEntitiesClient, entityId: string);
     /**
@@ -88,8 +122,9 @@ export declare class TabStack extends LayoutNode {
      * If that happens and then getViews() is called, it will return the identities in a different order than
      * than the currently rendered tab order.
      *
-     * @returns Resolves with a list containing the {@link OpenFin.Identity identities} of each view belonging to the {@link TabStack}.
+     * @returns {Promise<Identity[]>} Resolves with a list containing the {@link OpenFin.Identity identities} of each view belonging to the {@link TabStack}.
      * @throws If the {@link TabStack} has been destroyed.
+     * @tutorial TabStack.getViews
      * @experimental
      */
     getViews: () => Promise<OpenFin.Identity[]>;
@@ -99,28 +134,93 @@ export declare class TabStack extends LayoutNode {
      * Known Issue: If adding a view overflows the tab-container, the added view will be set as active
      * and rendered at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
      *
-     * @param view The identity of an existing view to add, or options to create a view.
-     * @param options Optional view options: index number used to insert the view into the stack at that index. Defaults to 0 (front of the stack)
-     * @returns Resolves with the {@link OpenFin.Identity identity} of the added view.
+     * @param {View~options} view The identity of an existing view to add, or options to create a view.
+     * @param {TabStack~AddViewOptions} options Optional view options: index number used to insert the view into the stack at that index. Defaults to 0 (front of the stack)
+     * @returns {Promise<identity>} Resolves with the {@link OpenFin.Identity identity} of the added view.
      * @throws If the view does not exist or fails to create.
      * @throws If the {@link TabStack} has been destroyed.
+     * @tutorial TabStack.addView
      * @experimental
      */
     addView: (view: OpenFin.Identity | OpenFin.PlatformViewCreationOptions, options?: OpenFin.AddViewToStackOptions) => Promise<OpenFin.Identity>;
     /**
      * Removes a view from this {@link TabStack}.
-     * @param view {@link OpenFin.Identiy Identity} of the view to remove.
+     * @param {Identity} view - Identity of the view to remove.
      * @throws If the view does not exist or does not belong to the stack.
      * @throws If the {@link TabStack} has been destroyed.
+     * @return {Promise<void>}
+     * @tutorial TabStack.removeView
      */
     removeView: (view: OpenFin.Identity) => Promise<void>;
+    /**
+     * Sets the active view of the {@link TabStack} without focusing it.
+     * @param {Identity} view - Identity of the view to activate.
+     * @returns {Promise<void>} Promise which resolves with void once the view has been activated.
+     * @throws If the {@link TabStack} has been destroyed.
+     * @throws If the view does not exist.
+     * @tutorial TabStack.setActiveView
+     * @experimental
+     */
+    setActiveView: (view: OpenFin.Identity) => Promise<void>;
 }
 /**
- * A {@link ColumnOrRow} is used to manage the state of a ColumnOrRow within an OpenFin Layout.
+ * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
  */
 export declare class ColumnOrRow extends LayoutNode {
     #private;
-    /** @internal */
+    /**
+     * Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
+     * @function isRoot
+     * @memberof ColumnOrRow
+     * @instance
+     * @tutorial ColumnOrRow.isRoot
+     * @return {Promise<boolean>} 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
+     * @return {Promise<boolean>} 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
+     * @return {Promise<ColumnOrRow | undefined>} 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.
+     * @returns {Promise<TabStack[]>}
+     * @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 {View~options} views - List of identities or view creation options of the views to include in the stack
+     * @param {StackCreationOptions} options - Creation options.
+     * @returns {Promise<TabStack>} The created TabStack
+     * @tutorial ColumnOrRow.createAdjacentStack
+     * @experimental
+     */
+    /**
+     * @internal
+     */
     constructor(client: LayoutEntitiesClient, entityId: string, type: 'row' | 'column');
     /**
      * The type of this {@link ColumnOrRow}. Either 'row' or 'column'.
@@ -128,7 +228,8 @@ export declare class ColumnOrRow extends LayoutNode {
     readonly type: 'column' | 'row';
     /**
      * Retrieves a list of all content items belonging to this {@link ColumnOrRow} in order of appearance.
-     * @returns Resolves with a list containing {@link ColumnOrRow} and {@link TabStack} items belonging to this {@link ColumnOrRow}.
+     * @returns {Promise<Array<ColumnOrRow | TabStack>>} Resolves with a list containing {@link ColumnOrRow} and {@link TabStack} items belonging to this {@link ColumnOrRow}.
+     * @tutorial ColumnOrRow.getContent
      */
     getContent: () => Promise<(ColumnOrRow | TabStack)[]>;
 }

package/src/api/platform/layout/entities/layout-entities.js

@@ -21,33 +21,25 @@ const channel_api_relay_1 = require("../../../../util/channel-api-relay");
     refs, we define and export all the classes here.
 */
 /**
+ * @ignore
  * @internal
  * Supplies an ApiClient for {@link LayoutEntitiesController} and helper methods
  * for the entities {@link TabStack} AND {@link ColumnOrRow} to use.
  */
 class LayoutNode {
-    /** @internal */
+    /**
+     * @internal
+     * @ignore
+     */
     constructor(client, entityId) {
         /**
+         * @ignore
          * @internal
          * ApiClient for {@link LayoutEntitiesController}
          */
         _LayoutNode_client.set(this, void 0);
-        /**
-         * Determines if this {@link ColumnOrRow} or {@link TabStack} is the top level content item in the current layout.
-         * @returns Promise resolving true if this is the root, or false otherwise.
-         */
         this.isRoot = () => __classPrivateFieldGet(this, _LayoutNode_client, "f").isRoot(this.entityId);
-        /**
-         * Determines if this {@link ColumnOrRow} or {@link TabStack} is the top level
-         * content item in the current layout.
-         * @returns Promise resolving true if this is the root, or false otherwise.
-         */
         this.exists = () => __classPrivateFieldGet(this, _LayoutNode_client, "f").exists(this.entityId);
-        /**
-         * Retrieves the parent {@link ColumnOrRow} or {@link TabStack} of this item, if one exists.
-         * @returns Promise resolving with the {@link ColumnOrRow} or {@link TabStack} that contains this item, or undefined if this is the root content item.
-         */
         this.getParent = async () => {
             const parent = await __classPrivateFieldGet(this, _LayoutNode_client, "f").getParent(this.entityId);
             if (!parent) {
@@ -55,34 +47,16 @@ class LayoutNode {
             }
             return LayoutNode.getEntity(parent, __classPrivateFieldGet(this, _LayoutNode_client, "f"));
         };
-        /**
-         * Given a list of view creation options or references and a layout position, creates an adjacent {@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.
-         *
-         * @param views List of identities or view creation options of the views to include in the stack
-         * @param options Creation options, defaults to position: 'right'
-         * @returns an instance of {@link TabStack} containing the given views
-         * @experimental
-         */
         this.createAdjacentStack = async (views, options) => {
             const entityId = await __classPrivateFieldGet(this, _LayoutNode_client, "f").createAdjacentStack(this.entityId, views, options);
             return LayoutNode.getEntity({ entityId, type: 'stack' }, __classPrivateFieldGet(this, _LayoutNode_client, "f"));
         };
-        /**
-         * Finds the immediate adjacent layout item given an edge Position
-         * @param edgePosition
-         * @returns either {@link TabStack} or {@link ColumnOrRow} that was found, or `undefined` if there is no item with that edgePosition
-         */
         this.getAdjacentStacks = async (edge) => {
             const adjacentStacks = await __classPrivateFieldGet(this, _LayoutNode_client, "f").getAdjacentStacks({
                 targetId: this.entityId,
                 edge
             });
-            return adjacentStacks.map(stack => LayoutNode.getEntity({
+            return adjacentStacks.map((stack) => LayoutNode.getEntity({
                 type: 'stack',
                 entityId: stack.entityId
             }, __classPrivateFieldGet(this, _LayoutNode_client, "f")));
@@ -94,6 +68,7 @@ class LayoutNode {
 exports.LayoutNode = LayoutNode;
 _a = LayoutNode, _LayoutNode_client = new WeakMap();
 /**
+ * @ignore
  * @internal
  * Encapsulates Api consumption of {@link LayoutEntitiesController} with a relayed dispatch
  * @param client
@@ -119,10 +94,73 @@ LayoutNode.getEntity = (definition, client) => {
     }
 };
 /**
- * A {@link TabStack} is used to manage the state of a TabStack within an OpenFin Layout and
- * traverse to its parent Content Item.
+ * @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
+     * @return {Promise<boolean>} 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
+     * @return {Promise<boolean>} 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
+     * @return {Promise<ColumnOrRow | TabStack | undefined>} Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if this {@link TabStack} 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.
+     * @returns {Promise<TabStack[]>}
+     * @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 {View~options} views - List of identities or view creation options of the views to include in the stack
+     * @param {StackCreationOptions} options - Creation options.
+     * @returns {Promise<TabStack>} The created TabStack.
+     * @tutorial TabStack.createAdjacentStack
+     * @experimental
+     */
     /** @internal */
     constructor(client, entityId) {
         super(client, entityId);
@@ -143,8 +181,9 @@ class TabStack extends LayoutNode {
          * If that happens and then getViews() is called, it will return the identities in a different order than
          * than the currently rendered tab order.
          *
-         * @returns Resolves with a list containing the {@link OpenFin.Identity identities} of each view belonging to the {@link TabStack}.
+         * @returns {Promise<Identity[]>} Resolves with a list containing the {@link OpenFin.Identity identities} of each view belonging to the {@link TabStack}.
          * @throws If the {@link TabStack} has been destroyed.
+         * @tutorial TabStack.getViews
          * @experimental
          */
         this.getViews = () => __classPrivateFieldGet(this, _TabStack_client, "f").getStackViews(this.entityId);
@@ -154,43 +193,112 @@ class TabStack extends LayoutNode {
          * Known Issue: If adding a view overflows the tab-container, the added view will be set as active
          * and rendered at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
          *
-         * @param view The identity of an existing view to add, or options to create a view.
-         * @param options Optional view options: index number used to insert the view into the stack at that index. Defaults to 0 (front of the stack)
-         * @returns Resolves with the {@link OpenFin.Identity identity} of the added view.
+         * @param {View~options} view The identity of an existing view to add, or options to create a view.
+         * @param {TabStack~AddViewOptions} options Optional view options: index number used to insert the view into the stack at that index. Defaults to 0 (front of the stack)
+         * @returns {Promise<identity>} Resolves with the {@link OpenFin.Identity identity} of the added view.
          * @throws If the view does not exist or fails to create.
          * @throws If the {@link TabStack} has been destroyed.
+         * @tutorial TabStack.addView
          * @experimental
          */
         this.addView = async (view, options = { index: 0 }) => __classPrivateFieldGet(this, _TabStack_client, "f").addViewToStack(this.entityId, view, options);
         /**
          * Removes a view from this {@link TabStack}.
-         * @param view {@link OpenFin.Identiy Identity} of the view to remove.
+         * @param {Identity} view - Identity of the view to remove.
          * @throws If the view does not exist or does not belong to the stack.
          * @throws If the {@link TabStack} has been destroyed.
+         * @return {Promise<void>}
+         * @tutorial TabStack.removeView
          */
         this.removeView = async (view) => {
             await __classPrivateFieldGet(this, _TabStack_client, "f").removeViewFromStack(this.entityId, view);
         };
+        /**
+         * Sets the active view of the {@link TabStack} without focusing it.
+         * @param {Identity} view - Identity of the view to activate.
+         * @returns {Promise<void>} Promise which resolves with void once the view has been activated.
+         * @throws If the {@link TabStack} has been destroyed.
+         * @throws If the view does not exist.
+         * @tutorial TabStack.setActiveView
+         * @experimental
+         */
+        this.setActiveView = async (view) => {
+            await __classPrivateFieldGet(this, _TabStack_client, "f").setStackActiveView(this.entityId, view);
+        };
         __classPrivateFieldSet(this, _TabStack_client, client, "f");
     }
 }
 exports.TabStack = TabStack;
 _TabStack_client = new WeakMap();
 /**
- * A {@link ColumnOrRow} is used to manage the state of a ColumnOrRow within an OpenFin Layout.
+ * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
  */
 class ColumnOrRow extends LayoutNode {
-    /** @internal */
+    /**
+     * Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
+     * @function isRoot
+     * @memberof ColumnOrRow
+     * @instance
+     * @tutorial ColumnOrRow.isRoot
+     * @return {Promise<boolean>} 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
+     * @return {Promise<boolean>} 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
+     * @return {Promise<ColumnOrRow | undefined>} 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.
+     * @returns {Promise<TabStack[]>}
+     * @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 {View~options} views - List of identities or view creation options of the views to include in the stack
+     * @param {StackCreationOptions} options - Creation options.
+     * @returns {Promise<TabStack>} The created TabStack
+     * @tutorial ColumnOrRow.createAdjacentStack
+     * @experimental
+     */
+    /**
+     * @internal
+     */
     constructor(client, entityId, type) {
         super(client, entityId);
         /**
+         * @ignore
          * @internal
          * ApiClient for {@link LayoutEntitiesController}
          */
         _ColumnOrRow_client.set(this, void 0);
         /**
          * Retrieves a list of all content items belonging to this {@link ColumnOrRow} in order of appearance.
-         * @returns Resolves with a list containing {@link ColumnOrRow} and {@link TabStack} items belonging to this {@link ColumnOrRow}.
+         * @returns {Promise<Array<ColumnOrRow | TabStack>>} Resolves with a list containing {@link ColumnOrRow} and {@link TabStack} items belonging to this {@link ColumnOrRow}.
+         * @tutorial ColumnOrRow.getContent
          */
         this.getContent = async () => {
             const contentItemEntities = await __classPrivateFieldGet(this, _ColumnOrRow_client, "f").getContent(this.entityId);

package/src/api/platform/layout/utils/layout-traversal.d.ts

@@ -1,3 +1,4 @@
 import type * as OpenFin from '../../../../OpenFin';
 export declare const getAdjacentItem: (component: GoldenLayout.ContentItem, edge: OpenFin.LayoutPosition) => GoldenLayout.ContentItem | undefined;
+export declare const doShareEdge: (from: GoldenLayout.ContentItem, to: GoldenLayout.ContentItem, edge: OpenFin.LayoutPosition) => boolean;
 export declare const getAdjacentStacks: (item: GoldenLayout.ContentItem, edge: OpenFin.LayoutPosition) => GoldenLayout.ContentItem[];

package/src/api/platform/layout/utils/layout-traversal.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAdjacentStacks = exports.getAdjacentItem = void 0;
+exports.getAdjacentStacks = exports.doShareEdge = exports.getAdjacentItem = void 0;
 const getAdjacentItem = (component, edge) => {
     const { parent } = component;
-    // need to handle the case where a stack is the parent content item
     if (parent.isRoot) {
         return undefined;
     }
@@ -19,25 +18,26 @@ const getAdjacentItem = (component, edge) => {
     return (0, exports.getAdjacentItem)(parent, edge);
 };
 exports.getAdjacentItem = getAdjacentItem;
-const doShareEdge = (a, b, edge) => {
+const doShareEdge = (from, to, edge) => {
     var _a, _b;
-    const boundsA = (_a = a.element.get(0)) === null || _a === void 0 ? void 0 : _a.getBoundingClientRect();
-    const boundsB = (_b = b.element.get(0)) === null || _b === void 0 ? void 0 : _b.getBoundingClientRect();
-    if (!boundsA || !boundsB) {
+    const boundsFrom = (_a = from.element.get(0)) === null || _a === void 0 ? void 0 : _a.getBoundingClientRect();
+    const boundsTo = (_b = to.element.get(0)) === null || _b === void 0 ? void 0 : _b.getBoundingClientRect();
+    if (!boundsFrom || !boundsTo) {
         return false;
     }
     if (['top', 'bottom'].includes(edge)) {
-        return ((boundsB.left >= boundsA.left && boundsB.left < boundsA.right) ||
-            (boundsB.right > boundsA.left && boundsB.right <= boundsA.right));
+        const horizontallyOutOfBounds = boundsFrom.right < boundsTo.left || boundsFrom.left > boundsTo.right;
+        return !horizontallyOutOfBounds;
     }
-    return ((boundsB.top >= boundsA.top && boundsB.top < boundsA.bottom) ||
-        (boundsB.bottom > boundsA.top && boundsB.bottom <= boundsA.bottom));
+    const verticallyOutOfBounds = boundsFrom.bottom < boundsTo.top || boundsFrom.top > boundsTo.bottom;
+    return !verticallyOutOfBounds;
 };
+exports.doShareEdge = doShareEdge;
 const getAdjacentStacks = (item, edge) => {
     const targetContainer = ['top', 'bottom'].includes(edge) ? 'row' : 'column';
     const findEdgeStacks = (component) => {
         if (component.type === 'stack') {
-            if (doShareEdge(item, component, edge)) {
+            if ((0, exports.doShareEdge)(item, component, edge)) {
                 return [component];
             }
             return [];

package/src/api/platform/provider.d.ts

@@ -1,5 +1,5 @@
-import { WindowOptionsChangedEvent } from '../events/window';
 import * as OpenFin from '../../OpenFin';
+type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
 /**
  * This class handles Platform actions. It does not need to be used directly by developers.
  * However, its methods can be overriden by passing an `overrideCallback` to {@link Platform#init Platform.init}
@@ -160,3 +160,4 @@ export interface PlatformProvider {
      */
     handleViewsAndWindowClose(windowId: OpenFin.Identity, userDecision: OpenFin.BeforeUnloadUserDecision): Promise<void>;
 }
+export {};

package/src/api/system/index.d.ts

@@ -460,6 +460,15 @@ export default class System extends EmitterBase<OpenFin.SystemEvent> {
      */
     getServiceConfiguration(serviceIdentifier: OpenFin.ServiceIdentifier): Promise<OpenFin.ServiceConfiguration>;
     protected getSystemAppConfig(name: string): Promise<any>;
+    /**
+     * Registers a system shutdown handler so user can do some cleanup before system is shutting down.
+     * Note: Once system shutdown starts, you are unable to cancel it.
+     * @param { SystemShutdownHandler } handler system shutdown handler
+     * @return {Promise.<void>}
+     * @tutorial System.registerShutdownHandler
+     * @experimental
+     */
+    registerShutdownHandler(handler: OpenFin.SystemShutdownHandler): Promise<void>;
     /**
      * Signals the RVM to perform a health check and returns the results as json.
      * @return {Promise.<string[]>}