@openfin/core 30.73.28 → 30.74.7

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,6 +1,6 @@
 "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 getUnsupportedChannelApis = (channelType) => {
@@ -35,6 +35,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 = () => {
@@ -122,6 +138,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 +170,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/fdc3/versions.d.ts

@@ -0,0 +1 @@
+export declare type Fdc3Version = '1.2' | '2.0';

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/api/me.d.ts

@@ -1,5 +1,5 @@
 import type * as OpenFin from '../OpenFin';
-import type Transport from '../transport/transport';
+import type { Transport } from '../transport/transport';
 import type { InteropClient } from './interop';
 export declare const environmentUnsupportedMessage = "You are not running in OpenFin.";
 declare type EntityType = OpenFin.EntityType;

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

@@ -1,20 +1,23 @@
 import type * as OpenFin from '../../OpenFin';
 import { Base } from '../base';
 import { Channel } from '../interappbus/channel/index';
-import Transport from '../../transport/transport';
+import { Transport } from '../../transport/transport';
 import { LayoutModule } from './layout/index';
 /**
+ * @PORTED
  * InitPlatformOptions interface
  * @typedef { object } InitPlatformOptions
  * @property { OverrideCallback } [overrideCallback] a callback function that can be used to extend or replace default Provider behavior.
  */
 /**
+ * @PORTED
  * @typedef { same | different } ProcessAffinityStrategy
  * @summary Strategy to place views that share a domain into different process affinities or the same process affinity.
  * @property { string } same views in the same domain will have the same process affinity.
  * @property { string } different views in the same domain will have different process affinities.
  */
 /**
+ * @PORTED
  * @typedef { object } PlatformOptions
  * @summary The options object required by {@link Platform#start Platform.start}
  * Any {@link ApplicationOptions Application option} is also a valid platform option
@@ -25,6 +28,7 @@ import { LayoutModule } from './layout/index';
  * @property {ProcessAffinityStrategy} [viewProcessAffinityStrategy] 'same' | 'different'.
  */
 /**
+ * @PORTED
  * @typedef { object } DefaultWindowOptions
  * @summary Default window options apply to all platform windows.
  * Any {@link Window~options Window option} is also a valid Default Window option
@@ -36,6 +40,7 @@ import { LayoutModule } from './layout/index';
  * Windows with a specified url (Custom Windows) will not be affected by this option.
  */
 /**
+ * @DELETED
  * Snapshot interface
  * @typedef { object } Snapshot
  * @property { WindowOption[] } windows The array of window options objects

package/src/api/platform/Factory.js

@@ -5,17 +5,20 @@ const base_1 = require("../base");
 const index_1 = require("./layout/index");
 const Instance_1 = require("./Instance");
 /**
+ * @PORTED
  * InitPlatformOptions interface
  * @typedef { object } InitPlatformOptions
  * @property { OverrideCallback } [overrideCallback] a callback function that can be used to extend or replace default Provider behavior.
  */
 /**
+ * @PORTED
  * @typedef { same | different } ProcessAffinityStrategy
  * @summary Strategy to place views that share a domain into different process affinities or the same process affinity.
  * @property { string } same views in the same domain will have the same process affinity.
  * @property { string } different views in the same domain will have different process affinities.
  */
 /**
+ * @PORTED
  * @typedef { object } PlatformOptions
  * @summary The options object required by {@link Platform#start Platform.start}
  * Any {@link ApplicationOptions Application option} is also a valid platform option
@@ -26,6 +29,7 @@ const Instance_1 = require("./Instance");
  * @property {ProcessAffinityStrategy} [viewProcessAffinityStrategy] 'same' | 'different'.
  */
 /**
+ * @PORTED
  * @typedef { object } DefaultWindowOptions
  * @summary Default window options apply to all platform windows.
  * Any {@link Window~options Window option} is also a valid Default Window option
@@ -37,6 +41,7 @@ const Instance_1 = require("./Instance");
  * Windows with a specified url (Custom Windows) will not be affected by this option.
  */
 /**
+ * @DELETED
  * Snapshot interface
  * @typedef { object } Snapshot
  * @property { WindowOption[] } windows The array of window options objects

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

@@ -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
@@ -66,14 +66,16 @@ export declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
      */
     getSnapshot(): Promise<OpenFin.Snapshot>;
     /**
+     * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
+     *
      * Returns a snapshot of a single view's options in its current state.
      *
      * Can be used to restore a view to a previous state.
      *
-     * NOTE: this method is meant for advanced usage only, it is not recommended to manage the state of individual views.
-     *
      * @param { Identity } viewIdentity View identity
      * @returns { Promise<ViewState> }
+     * @internal
+     * @experimental
      * @tutorial Platform.getViewSnapshot
      */
     getViewSnapshot(viewIdentity: OpenFin.Identity): Promise<OpenFin.ViewState>;

package/src/api/platform/Instance.js

@@ -78,7 +78,7 @@ class Platform extends base_1.EmitterBase {
         const response = await client.dispatch('create-view', {
             target,
             opts: viewOptions,
-            targetView
+            targetView,
         });
         if (!response || (0, validate_1.validateIdentity)(response.identity)) {
             throw new Error(`When overwriting the createView call, please return an object that has a valid 'identity' property: ${JSON.stringify(response)}`);
@@ -175,14 +175,16 @@ class Platform extends base_1.EmitterBase {
         return client.dispatch('get-snapshot');
     }
     /**
+     * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
+     *
      * Returns a snapshot of a single view's options in its current state.
      *
      * Can be used to restore a view to a previous state.
      *
-     * NOTE: this method is meant for advanced usage only, it is not recommended to manage the state of individual views.
-     *
      * @param { Identity } viewIdentity View identity
      * @returns { Promise<ViewState> }
+     * @internal
+     * @experimental
      * @tutorial Platform.getViewSnapshot
      */
     async getViewSnapshot(viewIdentity) {

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

@@ -3,12 +3,14 @@ import { Layout } from './Instance';
 import { Base } from '../../base';
 declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
 /**
+ * @PORTED
  * InitLayoutOptions interface
  * @typedef { object } InitLayoutOptions
  * @property { string } [containerId] The id attribute of the container where the window's Layout should be initialized.  If not provided
  * then an element with id `layout-container` is used. We recommend using a div element.
  */
 /**
+ * @PORTED
  * PresetLayoutOptions interface
  * @typedef { object } PresetLayoutOptions
  * @property { LayoutPresetTypes } presetType Which preset layout arrangement to use.
@@ -23,6 +25,7 @@ declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
  * @property { LayoutSettings } settings Configuration for certain Layout behaviors. See the LayoutSettings interface.
  */
 /**
+ * @PORTED
  * LayoutItem Interface
  * @typedef { object } LayoutItem Represents the arrangement of Views within a Platform window's Layout.  We do not recommend trying
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
@@ -34,6 +37,7 @@ declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
  * options of a given component.
  */
 /**
+ * @PORTED
  * LayoutSettings Interface
  * @typedef { object } LayoutSettings Represents a potential ways to customize behavior of your Layout
  * @property { boolean } [constrainDragToHeaders=false] Limits the area to which tabs can be dragged.

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

@@ -19,13 +19,19 @@ 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
  * @typedef { object } InitLayoutOptions
  * @property { string } [containerId] The id attribute of the container where the window's Layout should be initialized.  If not provided
  * then an element with id `layout-container` is used. We recommend using a div element.
  */
 /**
+ * @PORTED
  * PresetLayoutOptions interface
  * @typedef { object } PresetLayoutOptions
  * @property { LayoutPresetTypes } presetType Which preset layout arrangement to use.
@@ -40,6 +46,7 @@ const view_overlay_1 = require("./utils/view-overlay");
  * @property { LayoutSettings } settings Configuration for certain Layout behaviors. See the LayoutSettings interface.
  */
 /**
+ * @PORTED
  * LayoutItem Interface
  * @typedef { object } LayoutItem Represents the arrangement of Views within a Platform window's Layout.  We do not recommend trying
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
@@ -51,6 +58,7 @@ const view_overlay_1 = require("./utils/view-overlay");
  * options of a given component.
  */
 /**
+ * @PORTED
  * LayoutSettings Interface
  * @typedef { object } LayoutSettings Represents a potential ways to customize behavior of your Layout
  * @property { boolean } [constrainDragToHeaders=false] Limits the area to which tabs can be dragged.
@@ -109,9 +117,9 @@ class LayoutModule extends base_1.Base {
             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.
@@ -125,6 +133,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") });
         };

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

@@ -1,5 +1,5 @@
 import type * as OpenFin from '../../../OpenFin';
-import Transport from '../../../transport/transport';
+import { Transport } from '../../../transport/transport';
 import { Base } from '../../base';
 declare type Identity = OpenFin.Identity;
 declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
@@ -8,6 +8,7 @@ declare 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;

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

@@ -0,0 +1,117 @@
+import type * as OpenFin from '../../../../OpenFin';
+import type { LayoutContentCache } from './layout-content-cache';
+declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;
+/**
+ * @internal
+ * Controller for the layout entities apis, allowing alterations to be applied
+ * to an instance of layout manager in a structured manner.
+ */
+export declare class LayoutEntitiesController {
+    private layoutManager;
+    private layoutContentCache;
+    constructor(layoutManager: any, layoutContentCache: LayoutContentCache);
+    /**
+     * @internal
+     * @returns the root contentItem of the layout.
+     */
+    getRoot: () => OpenFin.LayoutEntityDefinition;
+    /**
+     * @internal
+     * Retrieves the containing stack of a given view identity.
+     * @param view Identity of the view to retrieve the stack of.
+     * @returns Stack containing the given view.
+     * @throws If the view does not belong to a stack within the layout manager.
+     */
+    getStackByView: (view: OpenFin.Identity) => Promise<OpenFin.LayoutEntityDefinition | undefined>;
+    /**
+     * @internal
+     * Returns all views belonging to a given stack
+     *
+     * NOTE: Due to (TODO: ticket) Golden Layouts has an issue which changes the order of tabs
+     * when the amount of new views to add overflows the width of the container. This results
+     * in tabs being re-ordered in the UI, while the underlying content item array remains in the
+     * original order specified. So calling getStackViews() will return this underlying array order,
+     * with indexes that will not match up to the render-order of the tabs.
+     *
+     * @param id - Entity id of the stack.
+     * @returns A list of view identities in order of appearance.
+     * @throws if the content item associated with the entity id does not exist or is not a stack.
+     */
+    getStackViews: (id: string) => OpenFin.Identity[];
+    /**
+     * @internal
+     * Retrieves the content of a column or row and adds each to the
+     * entity cache to allow them to be addressed externally.
+     * @param id Entity id of the Column Or Row to retrieve the content of.
+     * @returns Array of layout entity definitions
+     * @throws if the entity associated with {@link id} is not in the entity cache, does not belogn to a layout, or is not a column/row.
+     */
+    getContent(id: string): OpenFin.LayoutEntityDefinition[];
+    /**
+     * @internal
+     * Retrieves the parent content item of the given entity, and adds it to the entity cache
+     * so it can be addressed externally.
+     * @param id Entity id associated with a layout content item.
+     * @returns An entity definition for the given entity's parent, or undefined if the entity is the top level
+     * content item or has been removed from the layout entirely.
+     */
+    getParent(id: string): OpenFin.LayoutEntityDefinition | undefined;
+    /**
+     * @internal
+     * @param id Entity id associated with a layout content item.
+     * @returns true if the given entity is the root content item, false otherwise.
+     */
+    isRoot: (id: string) => boolean;
+    /**
+     * @internal
+     * Checks whether the given entity exists.
+     * @param entityId Id of a content item within the layout
+     * @returns True if the content item exists and belongs to the layout.
+     */
+    exists: (entityId: string) => boolean;
+    /**
+     * @internal
+     * Adds an existing view to the stack, or creates and adds a view to the given stack.
+     *
+     * NOTE: Due to (TODO: ticket) Golden Layouts has an issue which changes the order of tabs
+     * when the amount of new views to add overflows the width of the container. This results
+     * in tabs being re-ordered in the UI, while the underlying content item array remains in the
+     * original order specified. So calling getStackViews() will return this underlying array order,
+     * with indexes that will not match up to the render-order of the tabs.
+     *
+     * @param stackEntityId Entity id of the stack content item within the layout.
+     * @param viewCreationOrReference View identity or creation options
+     * @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 Promise resolving with the identity of the newly added view.
+     * @throws If the view does not exist, fails to create, or the stack does not exist.
+     */
+    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, { index }?: OpenFin.AddViewToStackOptions) => Promise<OpenFin.Identity>;
+    private findViewInStack;
+    /**
+     * @internal
+     * Removes a view from the given stack. If it's the only view, the stack will be destroyed, unless window creation
+     * option closeOnLastViewRemoved is set to false.
+     *
+     * @param stackEntityId Entity id of a stack content item to remove the view from.
+     * @param view Identity of the view to remove.
+     * @throws If the stack does not exist or the view does not exist or belong to the stack.
+     */
+    removeViewFromStack: (stackEntityId: string, view: OpenFin.Identity) => Promise<void>;
+    /**
+     * @internal
+     * Creates a new adjacent 'stack' and adds the views to it at the specified position
+     * @param targetId Entity id of the content item to add a stack adjacent to it
+     * @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 the Entity Id of the new stack
+     */
+    createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], options: {
+        position?: OpenFin.LayoutPosition;
+    }) => Promise<string>;
+    getAdjacentStacks: ({ targetId, edge }: {
+        targetId: string;
+        edge: OpenFin.LayoutPosition;
+    }) => Promise<Pick<OpenFin.LayoutEntityDefinition, 'entityId'>[]>;
+    setStackActiveView: (stackEntityId: string, viewIdentity: OpenFin.Identity) => Promise<void>;
+}
+export {};