@openfin/core 31.74.6 → 31.74.8

package/src/api/interop/fdc3/fdc3-2.0.js

@@ -6,7 +6,6 @@ const InteropClient_1 = require("../InteropClient");
 const utils_2 = require("./utils");
 const fdc3_1_2_1 = require("./fdc3-1.2");
 const PrivateChannelClient_1 = require("./PrivateChannelClient");
-const PrivateChannelProvider_1 = require("./PrivateChannelProvider");
 /**
  * @typedef { object } AppIdentifier
  * @summary Identifies an application, or instance of an application, and is used to target FDC3 API calls at specific applications.
@@ -181,7 +180,7 @@ class Fdc3Module2 extends base_1.Base {
      * Find all the available instances for a particular application.
      * @param { AppIdentifier } app
      * @returns { Promise<Array<AppIdentifier>> }
-     * @tutorial findInstances
+     * @tutorial fdc3v2.findInstances
      */
     async findInstances(app) {
         this.wire.sendAction('fdc3-find-instances').catch((e) => {
@@ -199,7 +198,7 @@ class Fdc3Module2 extends base_1.Base {
      * Retrieves the AppMetadata for an AppIdentifier, which provides additional metadata (such as icons, a title and description) from the App Directory record for the application, that may be used for display purposes.
      * @param { AppIdentifier } app
      * @returns { Promise<AppMetadata(2)> }
-     * @tutorial getAppMetadata
+     * @tutorial fdc3v2.getAppMetadata
      */
     async getAppMetadata(app) {
         this.wire.sendAction('fdc3-get-app-metadata').catch((e) => {
@@ -277,7 +276,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context
      * @param { string } [resultType] The type of result returned for any intent specified during resolution.
      * @returns { Promise<Array<AppIntent(2)>> }
-     * @tutorial findIntentsByContext
+     * @tutorial fdc3v2.findIntentsByContext
      */
     async findIntentsByContext(context, resultType) {
         this.wire.sendAction('fdc3-find-intents-by-context').catch((e) => {
@@ -298,7 +297,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial raiseIntent
+     * @tutorial fdc3v2.raiseIntent
      */
     async raiseIntent(intent, context, app) {
         this.wire.sendAction('fdc3-raise-intent').catch((e) => {
@@ -317,7 +316,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial raiseIntentForContext
+     * @tutorial fdc3v2.raiseIntentForContext
      */
     async raiseIntentForContext(context, app) {
         // TODO: We have to do the same thing we do for raiseIntent here as well.
@@ -349,27 +348,27 @@ class Fdc3Module2 extends base_1.Base {
         // The FDC3 Intenter handler only expects the context and contextMetadata to be passed to the handler,
         // so we wrap it here and only pass those paramaters.
         const contextHandler = async (raisedIntent) => {
+            let intentResult;
+            let intentResultToSend;
             const { context, metadata: intentMetadata } = raisedIntent;
             const { contextMetadata, metadata, ...rest } = context;
-            let intentResult;
+            const intentResolutionResultId = (intentMetadata === null || intentMetadata === void 0 ? void 0 : intentMetadata.intentResolutionResultId) || (metadata === null || metadata === void 0 ? void 0 : metadata.intentResolutionResultId);
             try {
                 const newContext = metadata ? { metadata, ...rest } : { ...rest };
                 intentResult = await handler(newContext, contextMetadata);
+                intentResultToSend = intentResult;
             }
             catch (error) {
                 intentResult = error;
+                intentResultToSend = { error: true };
             }
-            const intentResolutionResultId = (intentMetadata === null || intentMetadata === void 0 ? void 0 : intentMetadata.intentResolutionResultId) || (metadata === null || metadata === void 0 ? void 0 : metadata.intentResolutionResultId);
             if (intentResolutionResultId) {
-                // Send whatever the result is.
-                this.fin.InterApplicationBus.publish(intentResolutionResultId, intentResult);
+                this.fin.InterApplicationBus.publish(intentResolutionResultId, intentResultToSend);
             }
             if (intentResult instanceof Error) {
                 throw new Error(intentResult.message);
             }
-            else {
-                return intentResult;
-            }
+            return intentResult;
         };
         return this.fin.me.interop.registerIntentHandler(contextHandler, intent, { fdc3Version: '2.0' });
     }
@@ -385,12 +384,11 @@ class Fdc3Module2 extends base_1.Base {
     /**
      * Returns a Channel with an auto-generated identity that is intended for private communication between applications. Primarily used to create channels that will be returned to other applications via an IntentResolution for a raised intent.
      * @returns { Promise<PrivateChannel> }
-     * @tutorial createPrivateChannel
+     * @tutorial fdc3v2.createPrivateChannel
      */
     async createPrivateChannel() {
         const channelId = (0, utils_1.generateId)();
-        const channelProvider = await this.fin.InterApplicationBus.Channel.create(channelId);
-        const newPrivateChannelProvider = new PrivateChannelProvider_1.PrivateChannelProvider(channelProvider, channelId);
+        await InteropClient_1.InteropClient.ferryFdc3Call(this.fin.me.interop, 'createPrivateChannelProvider', { channelId });
         const channelClient = await this.fin.InterApplicationBus.Channel.connect(channelId);
         const newPrivateChannelClient = new PrivateChannelClient_1.PrivateChannelClient(channelClient, channelId);
         return (0, utils_2.buildPrivateChannelObject)(newPrivateChannelClient);
@@ -398,7 +396,7 @@ class Fdc3Module2 extends base_1.Base {
     /**
      * Retrieves a list of the User Channels available for the app to join.
      * @returns { Promise<Channel[]>}
-     * @tutorial getUserChannels
+     * @tutorial fdc3v2.getUserChannels
      */
     async getUserChannels() {
         const channels = await this.fin.me.interop.getContextGroups();
@@ -422,7 +420,7 @@ class Fdc3Module2 extends base_1.Base {
      * Join an app to a specified User channel.
      * @param { string } channelId Channel name
      * @returns { Promise<void> }
-     * @tutorial joinUserChannel
+     * @tutorial fdc3v2.joinUserChannel
      */
     async joinUserChannel(channelId) {
         return this.fdc3Module.joinChannel(channelId);
@@ -441,6 +439,7 @@ class Fdc3Module2 extends base_1.Base {
     /**
      * Returns the Channel object for the current User channel membership
      * @returns { Promise<FDC3.Channel | null> }
+     * @tutorial fdc3.getCurrentChannel
      */
     async getCurrentChannel() {
         const currentChannel = await this.fdc3Module.getCurrentChannel();
@@ -465,7 +464,7 @@ class Fdc3Module2 extends base_1.Base {
      * Retrieves information about the FDC3 implementation, including the supported version of the FDC3 specification, the name of the provider of the implementation, its own version number, details of whether optional API features are implemented and the metadata of the calling application according to the desktop agent.
      * fdc3HandleGetInfo must be overridden in the InteropBroker so that the ImplementationMetadata will have the appMetadata info.
      * @returns { Promise<ImplementationMetadata(2)> }
-     * @tutorial getInfo
+     * @tutorial fdc3v2.getInfo
      */
     async getInfo() {
         return InteropClient_1.InteropClient.ferryFdc3Call(this.fin.me.interop, 'fdc3v2GetInfo', { fdc3Version: '2.0' });

package/src/api/interop/fdc3/shapes/fdc3v2.d.ts

@@ -64,7 +64,7 @@ export interface DesktopAgent {
     addContextListener(contextType: string | null, handler: ContextHandler): Promise<Listener>;
     getUserChannels(): Promise<Array<SystemChannel>>;
     joinUserChannel(channelId: string): Promise<void>;
-    getOrCreateChannel(channelId: string): Promise<ChannelV1>;
+    getOrCreateChannel(channelId: string): Promise<Channel>;
     createPrivateChannel(): Promise<PrivateChannel>;
     getCurrentChannel(): Promise<ChannelV1 | null>;
     leaveCurrentChannel(): Promise<void>;

package/src/api/interop/fdc3/utils.d.ts

@@ -21,8 +21,25 @@ export declare enum ResultError {
      */
     IntentHandlerRejected = "IntentHandlerRejected"
 }
+export declare enum ChannelError {
+    /** Returned if the specified channel is not found when attempting to join a
+     *  channel via the `joinUserChannel` function of the DesktopAgent (`fdc3`).
+     */
+    NoChannelFound = "NoChannelFound",
+    /** SHOULD be returned when a request to join a user channel or to a retrieve
+     *  a Channel object via the `joinUserChannel` or `getOrCreateChannel` methods
+     *  of the DesktopAgent (`fdc3`) object is denied.
+     */
+    AccessDenied = "AccessDenied",
+    /** SHOULD be returned when a channel cannot be created or retrieved via the
+     *  `getOrCreateChannel` method of the DesktopAgent (`fdc3`).
+     */
+    CreationFailed = "CreationFailed"
+}
 export declare const buildPrivateChannelObject: (privateChannelClient: PrivateChannelClient) => PrivateChannel;
 export declare const buildAppChannelObject: (sessionContextGroup: OpenFin.SessionContextGroup) => Channel;
 export declare const connectPrivateChannel: (channelId: string) => Promise<PrivateChannel>;
+export declare const isContext: (context: unknown) => context is Context;
+export declare const isChannel: (channel: unknown) => channel is Channel;
 export declare const getIntentResolution: (interopModule: OpenFin.InteropClient, context: Context, app?: AppIdentifier | TargetApp, intent?: string) => Promise<IntentResolution>;
 export {};

package/src/api/interop/fdc3/utils.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIntentResolution = exports.connectPrivateChannel = exports.buildAppChannelObject = exports.buildPrivateChannelObject = exports.ResultError = exports.UnsupportedChannelApiError = exports.getUnsupportedChannelApis = void 0;
+exports.getIntentResolution = exports.isChannel = exports.isContext = exports.connectPrivateChannel = exports.buildAppChannelObject = exports.buildPrivateChannelObject = exports.ChannelError = exports.ResultError = exports.UnsupportedChannelApiError = exports.getUnsupportedChannelApis = void 0;
 const utils_1 = require("../utils");
 const PrivateChannelClient_1 = require("./PrivateChannelClient");
+const lodash_1 = require("lodash");
 const getUnsupportedChannelApis = (channelType) => {
     return {
         addContextListener: () => {
@@ -35,6 +36,22 @@ var ResultError;
      */
     ResultError["IntentHandlerRejected"] = "IntentHandlerRejected";
 })(ResultError = exports.ResultError || (exports.ResultError = {}));
+var ChannelError;
+(function (ChannelError) {
+    /** Returned if the specified channel is not found when attempting to join a
+     *  channel via the `joinUserChannel` function of the DesktopAgent (`fdc3`).
+     */
+    ChannelError["NoChannelFound"] = "NoChannelFound";
+    /** SHOULD be returned when a request to join a user channel or to a retrieve
+     *  a Channel object via the `joinUserChannel` or `getOrCreateChannel` methods
+     *  of the DesktopAgent (`fdc3`) object is denied.
+     */
+    ChannelError["AccessDenied"] = "AccessDenied";
+    /** SHOULD be returned when a channel cannot be created or retrieved via the
+     *  `getOrCreateChannel` method of the DesktopAgent (`fdc3`).
+     */
+    ChannelError["CreationFailed"] = "CreationFailed";
+})(ChannelError = exports.ChannelError || (exports.ChannelError = {}));
 const buildPrivateChannelObject = (privateChannelClient) => {
     let clientDisconnected = false;
     const checkIfClientDisconnected = () => {
@@ -95,14 +112,33 @@ const buildAppChannelObject = (sessionContextGroup) => {
             return context === undefined ? null : context;
         },
         addContextListener: (contextType, handler) => {
-            let listener;
+            let realHandler;
+            let realType;
             if (typeof contextType === 'function') {
                 console.warn('addContextListener(handler) has been deprecated. Please use addContextListener(null, handler)');
-                listener = sessionContextGroup.addContextHandler(contextType);
+                realHandler = contextType;
             }
             else {
-                listener = sessionContextGroup.addContextHandler(handler, contextType === null ? undefined : contextType);
+                realHandler = handler;
+                if (typeof contextType === 'string') {
+                    realType = contextType;
+                }
             }
+            const listener = (async () => {
+                let first = true;
+                const currentContext = await sessionContextGroup.getCurrentContext(realType);
+                const wrappedHandler = (context, contextMetadata) => {
+                    if (first) {
+                        first = false;
+                        if ((0, lodash_1.isEqual)(currentContext, context)) {
+                            return;
+                        }
+                    }
+                    // eslint-disable-next-line consistent-return
+                    return realHandler(context, contextMetadata);
+                };
+                return sessionContextGroup.addContextHandler(wrappedHandler, realType);
+            })();
             return {
                 ...listener,
                 unsubscribe: () => listener.then((l) => l.unsubscribe())
@@ -122,6 +158,22 @@ const connectPrivateChannel = async (channelId) => {
     }
 };
 exports.connectPrivateChannel = connectPrivateChannel;
+const isContext = (context) => {
+    if (context && typeof context === 'object' && 'type' in context) {
+        const { type } = context;
+        return typeof type === 'string';
+    }
+    return false;
+};
+exports.isContext = isContext;
+const isChannel = (channel) => {
+    if (channel && typeof channel === 'object' && 'type' in channel && 'id' in channel) {
+        const { type, id } = channel;
+        return typeof type === 'string' && typeof id === 'string' && (type === 'app' || type === 'private');
+    }
+    return false;
+};
+exports.isChannel = isChannel;
 const getIntentResolution = async (interopModule, context, app, intent) => {
     // Generate an ID to make a session context group with. We will pass that ID to the Broker.
     // The broker will then setContext on that session context group later with our Intent Result,
@@ -138,31 +190,33 @@ const getIntentResolution = async (interopModule, context, app, intent) => {
     // Set up the getResult call.
     const getResult = async () => {
         let intentResult = await getResultPromise;
-        if (!intentResult) {
+        if (!intentResult || typeof intentResult !== 'object') {
             throw new Error(ResultError.NoResultReturned);
         }
-        if (intentResult instanceof Error) {
+        const { error } = intentResult;
+        if (error) {
             throw new Error(ResultError.IntentHandlerRejected);
         }
-        if (typeof intentResult === 'object') {
+        if ((0, exports.isChannel)(intentResult)) {
             const { id, type } = intentResult;
-            if (type && id && typeof id === 'string') {
-                switch (type) {
-                    case 'private': {
-                        intentResult = await (0, exports.connectPrivateChannel)(id);
-                        break;
-                    }
-                    case 'app': {
-                        const sessionContextGroup = await interopModule.joinSessionContextGroup(id);
-                        intentResult = (0, exports.buildAppChannelObject)(sessionContextGroup);
-                        break;
-                    }
-                    default: {
-                        break;
-                    }
+            switch (type) {
+                case 'private': {
+                    intentResult = await (0, exports.connectPrivateChannel)(id);
+                    break;
+                }
+                case 'app': {
+                    const sessionContextGroup = await interopModule.joinSessionContextGroup(id);
+                    intentResult = (0, exports.buildAppChannelObject)(sessionContextGroup);
+                    break;
+                }
+                default: {
+                    break;
                 }
             }
         }
+        else if (!(0, exports.isContext)(intentResult)) {
+            throw new Error(ResultError.NoResultReturned);
+        }
         return intentResult;
     };
     // Finally fire the intent.

package/src/api/interop/utils.d.ts

@@ -16,4 +16,3 @@ export declare const BROKER_ERRORS: {
     fdc3GetInfo: string;
 };
 export declare const wrapIntentHandler: (handler: OpenFin.IntentHandler, handlerId: string) => (intent: OpenFin.Intent) => Promise<void>;
-export declare const generateDefaultLoggingOptions: () => OpenFin.InteropLoggingOptions;

package/src/api/interop/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateDefaultLoggingOptions = exports.wrapIntentHandler = exports.BROKER_ERRORS = exports.generateOverrideWarning = exports.generateOverrideError = exports.wrapContextHandler = exports.wrapInTryCatch = exports.generateId = void 0;
+exports.wrapIntentHandler = exports.BROKER_ERRORS = exports.generateOverrideWarning = exports.generateOverrideError = exports.wrapContextHandler = exports.wrapInTryCatch = exports.generateId = void 0;
 const generateId = () => `${Math.random()}${Date.now()}`;
 exports.generateId = generateId;
 const wrapInTryCatch = (f, prefix) => (...args) => {
@@ -59,11 +59,3 @@ const wrapIntentHandler = (handler, handlerId) => {
     };
 };
 exports.wrapIntentHandler = wrapIntentHandler;
-const generateDefaultLoggingOptions = () => {
-    const loggingActions = ['beforeAction', 'afterAction'];
-    const options = loggingActions.reduce((accumulator, loggingOption) => {
-        return { ...accumulator, [loggingOption]: { enabled: true } };
-    }, {});
-    return options;
-};
-exports.generateDefaultLoggingOptions = generateDefaultLoggingOptions;

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

@@ -1,8 +1,8 @@
 import type * as OpenFin from '../../OpenFin';
 import { Base } from '../base';
-import { Channel } from '../interappbus/channel/index';
 import { Transport } from '../../transport/transport';
 import { LayoutModule } from './layout/index';
+type Channel = OpenFin.Fin['InterApplicationBus']['Channel'];
 /**
  * @PORTED
  * InitPlatformOptions interface
@@ -113,3 +113,4 @@ export default class PlatformModule extends Base {
      */
     startFromManifest(manifestUrl: string, opts?: OpenFin.RvmLaunchOptions): Promise<OpenFin.Platform>;
 }
+export {};

package/src/api/platform/Factory.js

@@ -77,7 +77,7 @@ class PlatformModule extends base_1.Base {
         const overrideCallback = options === null || options === void 0 ? void 0 : options.overrideCallback;
         const interopBroker = await this.fin.Interop.init(this.fin.me.uuid, options === null || options === void 0 ? void 0 : options.interopOverride);
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore debugging purposes
+        // @ts-expect-error debugging purposes
         window.interopBroker = interopBroker;
         return this._initializer(overrideCallback, interopBroker);
     }
@@ -147,14 +147,12 @@ class PlatformModule extends base_1.Base {
         return new Promise(async (resolve, reject) => {
             try {
                 const { uuid } = platformOptions;
-                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                // @ts-ignore using private variable.
+                // @ts-expect-error using private variable.
                 const app = await this.fin.Application._create({ ...platformOptions, isPlatformController: true });
                 // TODO: fix typing (internal)
                 // @ts-expect-error
                 app.once('platform-api-ready', () => resolve(this.wrapSync({ uuid })));
-                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                // @ts-ignore using private variable.
+                // @ts-expect-error using private variable.
                 app._run({ uuid });
             }
             catch (e) {
@@ -178,14 +176,12 @@ class PlatformModule extends base_1.Base {
         // eslint-disable-next-line no-async-promise-executor
         return new Promise(async (resolve, reject) => {
             try {
-                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                // @ts-ignore using private variable.
+                // @ts-expect-error using private variable.
                 const app = await this.fin.Application._createFromManifest(manifestUrl);
                 // TODO: fix typing (internal)
                 // @ts-expect-error
                 app.once('platform-api-ready', () => resolve(this.wrapSync({ uuid: app.identity.uuid })));
-                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                // @ts-ignore using private method without warning.
+                // @ts-expect-error using private method without warning.
                 app._run(opts);
             }
             catch (e) {

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

@@ -1,9 +1,9 @@
 import type * as OpenFin from '../../OpenFin';
-import { View } from '../view';
 import { EmitterBase } from '../base';
-import { Channel } from '../interappbus/channel/index';
-import ChannelClient from '../interappbus/channel/client';
-import { LayoutModule } from './layout';
+type View = OpenFin.View;
+type Channel = OpenFin.Fin['InterApplicationBus']['Channel'];
+type ChannelClient = OpenFin.ChannelClient;
+type LayoutModule = OpenFin.Fin['Platform']['Layout'];
 /** Manages the life cycle of windows and views in the application.
  *
  * Enables taking snapshots of itself and applyi
@@ -27,7 +27,7 @@ export declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
      * @return { Promise<View> }
      * @tutorial Platform.createView
      */
-    createView(viewOptions: OpenFin.PlatformViewCreationOptions, target?: OpenFin.Identity, targetView?: OpenFin.Identity): Promise<View>;
+    createView(viewOptions: OpenFin.PlatformViewCreationOptions, target?: OpenFin.CreateViewTarget, targetView?: OpenFin.Identity): Promise<View>;
     /**
      * Creates a new Window.
      * @param { Window~options } options Window creation options
@@ -147,3 +147,4 @@ export declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
         skipBeforeUnload: boolean;
     }): Promise<void>;
 }
+export {};

package/src/api/platform/Instance.js

@@ -7,6 +7,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _Platform_connectToProvider;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Platform = void 0;
+/* eslint-disable import/prefer-default-export, no-undef */
 const base_1 = require("../base");
 const validate_1 = require("../../util/validate");
 // Reuse clients to avoid overwriting already-registered client in provider

package/src/api/platform/layout/Factory.js

@@ -10,7 +10,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var _LayoutModule_layoutManager;
+var _LayoutModule_layoutManager, _LayoutModule_layoutInitializationAttempted;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LayoutModule = void 0;
 /* eslint-disable no-undef, import/prefer-default-export */
@@ -19,6 +19,10 @@ const Instance_1 = require("./Instance");
 const base_1 = require("../../base");
 const splitter_controller_1 = require("./controllers/splitter-controller");
 const view_overlay_1 = require("./utils/view-overlay");
+const api_exposer_1 = require("../../api-exposer");
+const layout_entities_controller_1 = require("./controllers/layout-entities-controller");
+const layout_constants_1 = require("./layout.constants");
+const layout_content_cache_1 = require("./controllers/layout-content-cache");
 /**
  * @PORTED
  * InitLayoutOptions interface
@@ -87,6 +91,7 @@ class LayoutModule extends base_1.Base {
     constructor() {
         super(...arguments);
         _LayoutModule_layoutManager.set(this, void 0);
+        _LayoutModule_layoutInitializationAttempted.set(this, false);
         /**
          * Initialize the window's Layout.  Must be called from a custom window that has a 'layout' option set upon creation of that window.
          * If a containerId is not provided, this method attempts to find an element with the id `layout-container`.
@@ -105,17 +110,18 @@ class LayoutModule extends base_1.Base {
             if (!this.fin.me.isWindow) {
                 throw new Error('Layout.init can only be called from a Window context.');
             }
-            else if (__classPrivateFieldGet(this, _LayoutModule_layoutManager, "f")) {
+            else if (__classPrivateFieldGet(this, _LayoutModule_layoutInitializationAttempted, "f")) {
                 throw new Error('Layout for this window already initialized, please use Layout.replace call to replace the layout.');
             }
+            __classPrivateFieldSet(this, _LayoutModule_layoutInitializationAttempted, true, "f");
             // We need to go through environment to make sure it is only imported/bundled in OpenFin.
             const ManagerConstructor = await this.wire.environment.getManagerConstructor();
             const viewOverlay = new view_overlay_1.ViewOverlay(this.wire);
             const splitterController = new splitter_controller_1.SplitterController(viewOverlay);
             const tabDragController = new tab_drag_controller_1.TabDragController(viewOverlay);
-            __classPrivateFieldSet(this, _LayoutModule_layoutManager, new ManagerConstructor(splitterController, tabDragController), "f");
-            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-            // @ts-ignore - layout warning here for backwards compatibility, can remove layout check in .52
+            const contentItemCache = new layout_content_cache_1.LayoutContentCache();
+            __classPrivateFieldSet(this, _LayoutModule_layoutManager, new ManagerConstructor(splitterController, tabDragController, contentItemCache), "f");
+            // @ts-expect-error - layout warning here for backwards compatibility, can remove layout check in .52
             let { layout, containerId } = options;
             if (layout) {
                 console.warn(`We recommend using a layout in window options.
@@ -129,6 +135,10 @@ class LayoutModule extends base_1.Base {
             // pull createChannelConnection out of LayoutManager and setup channel connections here using layoutmanager instance methods?
             await __classPrivateFieldGet(this, _LayoutModule_layoutManager, "f").initManager();
             await __classPrivateFieldGet(this, _LayoutModule_layoutManager, "f").createLayout(layout, container);
+            const { client, ofWindow } = ManagerConstructor.getClientAndWindow(__classPrivateFieldGet(this, _LayoutModule_layoutManager, "f"));
+            // expose LayoutEntitiesController instance for API consumption
+            const channelStrategy = new api_exposer_1.ChannelsExposer(client);
+            await new api_exposer_1.ApiExposer(channelStrategy).exposeInstance(new layout_entities_controller_1.LayoutEntitiesController(__classPrivateFieldGet(this, _LayoutModule_layoutManager, "f"), contentItemCache), { id: layout_constants_1.LAYOUT_CONTROLLER_ID });
             // Adding this to the returned instance undocumented/typed for Browser.
             return Object.assign(this.getCurrentSync(), { layoutManager: __classPrivateFieldGet(this, _LayoutModule_layoutManager, "f") });
         };
@@ -195,4 +205,4 @@ class LayoutModule extends base_1.Base {
     }
 }
 exports.LayoutModule = LayoutModule;
-_LayoutModule_layoutManager = new WeakMap();
+_LayoutModule_layoutManager = new WeakMap(), _LayoutModule_layoutInitializationAttempted = new WeakMap();

package/src/api/platform/layout/Instance.d.ts

@@ -8,6 +8,7 @@ type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
  * @lends Platform#Layout
  */
 export declare class Layout extends Base {
+    #private;
     init: (options?: InitLayoutOptions) => Promise<Layout>;
     identity: Identity;
     private platform;
@@ -19,6 +20,11 @@ export declare class Layout extends Base {
      * @tutorial Layout.getConfig
      */
     getConfig(): Promise<any>;
+    /**
+     * Retrieves the top level content item of the layout.
+     * @return {Promise<TabStack | ColumnOrRow>}
+     */
+    getRootItem(): Promise<OpenFin.ColumnOrRow | OpenFin.TabStack>;
     /**
      * Replaces a Platform window's layout with a new layout.  Any views that were in the old layout but not the new layout
      * will be destroyed.

package/src/api/platform/layout/Instance.js

@@ -1,9 +1,18 @@
 "use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _Layout_layoutClient;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Layout = void 0;
+const lazy_1 = require("../../../util/lazy");
 const validate_1 = require("../../../util/validate");
-const common_utils_1 = require("../common-utils");
 const base_1 = require("../../base");
+const common_utils_1 = require("../common-utils");
+const layout_entities_1 = require("./entities/layout-entities");
+const layout_constants_1 = require("./layout.constants");
 /**
  * @lends Platform#Layout
  */
@@ -11,6 +20,12 @@ class Layout extends base_1.Base {
     // eslint-disable-next-line no-shadow
     constructor(identity, wire) {
         super(wire);
+        /**
+         * @internal
+         * Lazily constructed {@link LayoutEntitiesClient} bound to this platform's client and identity
+         * The client is for {@link LayoutEntitiesController}
+         */
+        _Layout_layoutClient.set(this, new lazy_1.Lazy(async () => layout_entities_1.LayoutNode.newLayoutEntitiesClient(await this.platform.getClient(), layout_constants_1.LAYOUT_CONTROLLER_ID, this.identity)));
         /**
          * Replaces a Platform window's layout with a new layout.  Any views that were in the old layout but not the new layout
          * will be destroyed.
@@ -94,5 +109,15 @@ class Layout extends base_1.Base {
             target: this.identity
         });
     }
+    /**
+     * Retrieves the top level content item of the layout.
+     * @return {Promise<TabStack | ColumnOrRow>}
+     */
+    async getRootItem() {
+        const client = await __classPrivateFieldGet(this, _Layout_layoutClient, "f").getValue();
+        const root = await client.getRoot();
+        return layout_entities_1.LayoutNode.getEntity(root, client);
+    }
 }
 exports.Layout = Layout;
+_Layout_layoutClient = new WeakMap();

package/src/api/platform/layout/controllers/layout-content-cache.d.ts

@@ -0,0 +1,9 @@
+export declare class LayoutContentCache {
+    private contentItemCache;
+    private contentItemCacheId;
+    private createCacheKey;
+    hasKey: (id: string) => boolean;
+    getItemOrUndefined: (id: string) => GoldenLayout.ContentItem | undefined;
+    getContentItemOrThrow: (id: string, expectedType?: string[]) => GoldenLayout.ContentItem;
+    getOrCreateEntityId: (contentItem: GoldenLayout.ContentItem) => string;
+}

package/src/api/platform/layout/controllers/layout-content-cache.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LayoutContentCache = void 0;
+const reversible_map_1 = require("../../../../util/reversible-map");
+class LayoutContentCache {
+    constructor() {
+        // ContentItems currently do not have a unique id, this helps us to lookup items by value
+        this.contentItemCache = new reversible_map_1.ReversibleMap();
+        this.contentItemCacheId = 0;
+        this.createCacheKey = () => {
+            const key = `entity-${this.contentItemCacheId.toString()}`;
+            this.contentItemCacheId += 1;
+            return key;
+        };
+        this.hasKey = (id) => {
+            return this.contentItemCache.hasKey(id);
+        };
+        this.getItemOrUndefined = (id) => {
+            try {
+                return this.getContentItemOrThrow(id);
+            }
+            catch (error) {
+                return undefined;
+            }
+        };
+        this.getContentItemOrThrow = (id, expectedType) => {
+            if (!this.contentItemCache.hasKey(id)) {
+                throw new Error('Layout component has been destroyed or detached from the current layout.');
+            }
+            const contentItem = this.contentItemCache.getValue(id);
+            if (expectedType && !expectedType.includes(contentItem.type)) {
+                throw new Error(`Layout item is not the expected type. Expected ${expectedType.join(', ')}, got ${contentItem.type}.`);
+            }
+            return contentItem;
+        };
+        this.getOrCreateEntityId = (contentItem) => {
+            if (this.contentItemCache.hasValue(contentItem)) {
+                return this.contentItemCache.getKey(contentItem);
+            }
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            const onItemDestroyed = ({ origin, ...rest }) => {
+                if (origin === contentItem) {
+                    this.contentItemCache.deleteValue(contentItem);
+                    contentItem.unbind('itemDestroyed', onItemDestroyed);
+                }
+            };
+            contentItem.on('itemDestroyed', onItemDestroyed);
+            const key = this.createCacheKey();
+            this.contentItemCache.setUnique(key, contentItem);
+            return key;
+        };
+    }
+}
+exports.LayoutContentCache = LayoutContentCache;