@openfin/core 34.78.54 → 34.78.57

package/out/mock.js

@@ -1232,6 +1232,15 @@ class LayoutNode {
         /**
          * Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
          *
+         * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
+         * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
+         * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
+         * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
+         *
+         * @param views The views that will populate the new TabStack.
+         * @param options Additional options that control new TabStack creation.
+         * @returns The newly-created TabStack.
+         *
          * @example
          * ```js
          * if (!fin.me.isView) {
@@ -1266,13 +1275,16 @@ class LayoutNode {
          * console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
          *
          * ```
+         * @experimental
          */
         this.createAdjacentStack = async (views, options) => {
             const entityId = await __classPrivateFieldGet$e(this, _LayoutNode_client, "f").createAdjacentStack(this.entityId, views, options);
             return LayoutNode.getEntity({ entityId, type: 'stack' }, __classPrivateFieldGet$e(this, _LayoutNode_client, "f"));
         };
         /**
-         * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
+         * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow.
+         *
+         * @param edge Edge whose adjacent TabStacks will be returned.
          *
          * @example
          * ```js
@@ -1292,6 +1304,7 @@ class LayoutNode {
          * console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
          *
          * ```
+         * @experimental
          */
         this.getAdjacentStacks = async (edge) => {
             const adjacentStacks = await __classPrivateFieldGet$e(this, _LayoutNode_client, "f").getAdjacentStacks({
@@ -1335,74 +1348,10 @@ LayoutNode.getEntity = (definition, client) => {
             throw new Error(`Unrecognised Layout Entity encountered ('${JSON.stringify(definition)})`);
     }
 };
-/**
- * @typedef {string} LayoutPosition
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
- */
-/**
- * @typedef {object} StackCreationOptions
- * @summary Stack creation options.
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
- */
-/**
- * @typedef {object} TabStack~AddViewOptions
- * @summary Options to use when adding a view to a {@link TabStack}
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
- */
 /**
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
  */
 class TabStack extends LayoutNode {
-    /**
-     * Determines if this {@link TabStack} is the top level content item in the current layout.
-     * @function isRoot
-     * @memberof TabStack
-     * @instance
-     * @tutorial TabStack.isRoot
-     * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
-     */
-    /**
-     * Determines if this  {@link TabStack} exists.
-     * @function exists
-     * @instance
-     * @memberof TabStack
-     * @tutorial TabStack.exists
-     * @returns Resolves true if this is the TabStack exists, or false if it has been destroyed.
-     */
-    /**
-     * Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
-     * @function getParent
-     * @instance
-     * @memberof TabStack
-     * @tutorial TabStack.getParent
-     * @returns is the root content item or does not exist.
-     */
-    /**
-     * Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
-     * @function getAdjacentStacks
-     * @instance
-     * @memberof TabStack
-     * @param  {LayoutPosition} edge - Edge to check for any adjacent stacks.
-     *
-     * @tutorial TabStack.getAdjacentStacks
-     */
-    /**
-     * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
-     *
-     * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
-     * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
-     * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
-     * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
-     *
-     * @function createAdjacentStack
-     * @instance
-     * @memberof TabStack
-     * @param views - List of identities or view creation options of the views to include in the stack
-     * @param options - Creation options.
-     * @returns The created TabStack.
-     * @tutorial TabStack.createAdjacentStack
-     * @experimental
-     */
     /** @internal */
     constructor(client, entityId) {
         super(client, entityId);
@@ -1535,57 +1484,6 @@ _TabStack_client = new WeakMap();
  * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
  */
 class ColumnOrRow extends LayoutNode {
-    /**
-     * Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
-     * @function isRoot
-     * @memberof ColumnOrRow
-     * @instance
-     * @tutorial ColumnOrRow.isRoot
-     * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
-     */
-    /**
-     * Determines if this  {@link ColumnOrRow} exists.
-     * @function exists
-     * @instance
-     * @memberof ColumnOrRow
-     * @tutorial ColumnOrRow.exists
-     * @returns Resolves true if the TabStack exists, or false if it has been destroyed.
-     */
-    /**
-     * Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
-     * @function getParent
-     * @instance
-     * @memberof ColumnOrRow
-     * @tutorial ColumnOrRow.getParent
-     * @returns Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if
-     * this {@link ColumnOrRow}does not exist or is the root content item.
-     */
-    /**
-     * Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
-     * @function getAdjacentStacks
-     * @instance
-     * @memberof ColumnOrRow
-     * @param  {LayoutPosition} edge - Edge to check for any adjacent stacks.
-     *
-     * @tutorial ColumnOrRow.getAdjacentStacks
-     */
-    /**
-     * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
-     *
-     * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
-     * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
-     * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
-     * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
-     *
-     * @function createAdjacentStack
-     * @instance
-     * @memberof ColumnOrRow
-     * @param views - List of identities or view creation options of the views to include in the stack
-     * @param options - Creation options.
-     * @returns The created TabStack
-     * @tutorial ColumnOrRow.createAdjacentStack
-     * @experimental
-     */
     /**
      * @internal
      */
@@ -1631,7 +1529,8 @@ var layout_constants = {};
 Object.defineProperty(layout_constants, "__esModule", { value: true });
 layout_constants.DEFAULT_LAYOUT_KEY = layout_constants.LAYOUT_CONTROLLER_ID = void 0;
 layout_constants.LAYOUT_CONTROLLER_ID = 'layout-entities';
-layout_constants.DEFAULT_LAYOUT_KEY = 'default';
+// TODO: eventually export this somehow
+layout_constants.DEFAULT_LAYOUT_KEY = '__default__';
 
 var main = {};
 
@@ -3463,7 +3362,7 @@ function requireView () {
 		 * * {@link ViewModule} contains static members of the `View` API, accessible through `fin.View`.
 		 * * {@link View} describes an instance of an OpenFin View, e.g. as returned by `fin.View.getCurrent`.
 		 *
-		 * These are separate code entities, and are documented separately.  In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
+		 * These are separate code entities, and are documented separately.  In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
 		 * both of these were documented on the same page.
 		 *
 		 * @packageDocumentation
@@ -4604,7 +4503,7 @@ function requireApplication () {
 		 * * {@link ApplicationModule} contains static members of the `Application` API, accessible through `fin.Application`.
 		 * * {@link Application} describes an instance of an OpenFin Application, e.g. as returned by `fin.Application.getCurrent`.
 		 *
-		 * These are separate code entities, and are documented separately.  In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
+		 * These are separate code entities, and are documented separately.  In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
 		 * both of these were documented on the same page.
 		 *
 		 * @packageDocumentation
@@ -6661,7 +6560,7 @@ function requireWindow () {
 		 * * {@link _WindowModule} contains static members of the `Window` API, accessible through `fin.Window`.
 		 * * {@link _Window} describes an instance of an OpenFin Window, e.g. as returned by `fin.Window.getCurrent`.
 		 *
-		 * These are separate code entities, and are documented separately.  In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
+		 * These are separate code entities, and are documented separately.  In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
 		 * both of these were documented on the same page.
 		 *
 		 * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
@@ -11415,7 +11314,7 @@ Factory$5.ExternalApplicationModule = ExternalApplicationModule;
 	 * * {@link ExternalApplicationModule} contains static members of the `ExternalApplication` type, accessible through `fin.ExternalApplication`.
 	 * * {@link ExternalApplication} describes an instance of an OpenFin ExternalApplication, e.g. as returned by `fin.ExternalApplication.getCurrent`.
 	 *
-	 * These are separate code entities, and are documented separately.  In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
+	 * These are separate code entities, and are documented separately.  In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
 	 * both of these were documented on the same page.
 	 *
 	 * @packageDocumentation
@@ -11666,7 +11565,7 @@ Factory$4._FrameModule = _FrameModule;
 	 * * {@link _FrameModule} contains static members of the `Frame` API, accessible through `fin.Frame`.
 	 * * {@link _Frame} describes an instance of an OpenFin Frame, e.g. as returned by `fin.Frame.getCurrent`.
 	 *
-	 * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
+	 * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
 	 * both of these were documented on the same page.
 	 *
 	 * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
@@ -13012,7 +12911,6 @@ class Layout extends base_1$6.Base {
             // don't expose
         });
         const client = await this.platform.getClient();
-        console.log(`Layout::toConfig() called!`);
         return client.dispatch('get-frame-snapshot', {
             target: this.identity
         });
@@ -13062,7 +12960,7 @@ class Layout extends base_1$6.Base {
             // don't expose
         });
         const client = await __classPrivateFieldGet$5(this, _Layout_layoutClient, "f").getValue();
-        const root = await client.getRoot(this.identity);
+        const root = await client.getRoot('layoutName' in this.identity ? this.identity : undefined);
         return layout_entities_1.LayoutNode.getEntity(root, client);
     }
 }
@@ -13080,7 +12978,7 @@ var __classPrivateFieldSet$4 = (commonjsGlobal && commonjsGlobal.__classPrivateF
     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_instances, _LayoutModule_layoutInitializationAttempted, _LayoutModule_layoutManager, _LayoutModule_throwIfLayoutManagerNotInitialized;
+var _LayoutModule_instances, _LayoutModule_layoutInitializationAttempted, _LayoutModule_layoutManager, _LayoutModule_getBackCompatLayoutManager, _LayoutModule_throwIfLayoutManagerNotInitialized;
 Object.defineProperty(Factory$2, "__esModule", { value: true });
 Factory$2.LayoutModule = void 0;
 const base_1$5 = base;
@@ -13143,39 +13041,53 @@ class LayoutModule extends base_1$5.Base {
                 throw new Error('Layout.init was already called, please use Layout.create to add additional layouts.');
             }
             __classPrivateFieldSet$4(this, _LayoutModule_layoutInitializationAttempted, true, "f");
-            __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayout(this.fin, this.wire, options), "f");
-            // back-compat ONLY if layoutManagerOverride not provided
+            __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayoutManager(this.fin, this.wire, options), "f");
+            // apply the initial snapshot which in turn will call fin.Platform.Layout.create()
+            const platformClient = await this.fin.Platform.getCurrentSync().getClient();
+            const snapshot = await platformClient.dispatch('get-initial-layout-snapshot');
+            await __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").applyLayoutSnapshot(snapshot);
             if (!options.layoutManagerOverride) {
-                const layoutInstance = await __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").resolveLayout();
-                const layout = this.wrapSync(layoutInstance.identity);
-                // Backward compat - undocumented / not typed layoutInstance as layoutManager
-                return Object.assign(layout, { layoutManager: layoutInstance });
+                return __classPrivateFieldGet$4(this, _LayoutModule_getBackCompatLayoutManager, "f").call(this, this.fin);
             }
-            // Warn user if they do not create any layouts in the next 10 seconds
+            // warn user if they do not call create() in the next 30 seconds
             setTimeout(() => {
-                const layoutSize = Object.keys(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").getLayouts()).length;
-                if (layoutSize === 0) {
-                    console.warn(`[Layout.init] Layout.init was called but no layouts have been created yet. Make sure you ` +
+                if (__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").size() === 0) {
+                    console.warn(`[Layout.init] Layout.init was called 30s ago, but no layouts have been created yet. Make sure you ` +
                         `override LayoutManager.applyLayoutSnapshot, and then call fin.Platform.Layout.create()`);
                 }
-            }, 10000);
+            }, 30000);
             return this.wrapSync(this.fin.me.identity);
         };
+        _LayoutModule_getBackCompatLayoutManager.set(this, async (fin) => {
+            let layoutManager;
+            let resolve;
+            const layoutResolved = new Promise((r) => {
+                resolve = r;
+            });
+            // wait for a layout to be created
+            await fin.me.once('layout-ready', async ({ layoutIdentity }) => {
+                layoutManager = await this.wire.environment.resolveLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
+                // Backward compat - undocumented / not typed openfin-layout as layoutManager
+                // TODO: eventually deprecate this
+                resolve(Object.assign(this.wrapSync(layoutIdentity), { layoutManager }));
+            });
+            return layoutResolved;
+        });
         /**
          * Returns the layout manager for the current window
          * @returns
          */
         this.getCurrentLayoutManagerSync = () => {
-            __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this);
+            __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this, `fin.Platform.Layout.getCurrentLayoutManagerSync()`);
             // @ts-expect-error User may have implemented their own snapshot type when overriding LayoutManager
             return __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f");
         };
         this.create = async (options) => {
-            __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this);
+            __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this, `fin.Platform.Layout.create()`);
             return this.wire.environment.createLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), options);
         };
         this.destroy = async (layoutIdentity) => {
-            __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this);
+            __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this, `fin.Platform.Layout.destroy()`);
             return this.wire.environment.destroyLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
         };
     }
@@ -13274,9 +13186,9 @@ class LayoutModule extends base_1$5.Base {
     }
 }
 Factory$2.LayoutModule = LayoutModule;
-_LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layoutManager = new WeakMap(), _LayoutModule_instances = new WeakSet(), _LayoutModule_throwIfLayoutManagerNotInitialized = function _LayoutModule_throwIfLayoutManagerNotInitialized() {
+_LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layoutManager = new WeakMap(), _LayoutModule_getBackCompatLayoutManager = new WeakMap(), _LayoutModule_instances = new WeakSet(), _LayoutModule_throwIfLayoutManagerNotInitialized = function _LayoutModule_throwIfLayoutManagerNotInitialized(method) {
     if (!__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f")) {
-        throw new Error('You must call init before using this API');
+        throw new Error(`You must call init before using the API ${method}`);
     }
 };
 
@@ -13287,7 +13199,7 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layou
 	 * * {@link LayoutModule} contains static members of the `Layout` API, accessible through `fin.Platform.Layout`.
 	 * * {@link Layout} describes an instance of an OpenFin Layout, e.g. as returned by `fin.Platform.Layout.getCurrent`.
 	 *
-	 * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
+	 * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
 	 * both of these were documented on the same page.
 	 *
 	 * @packageDocumentation
@@ -13568,7 +13480,7 @@ Factory$3.PlatformModule = PlatformModule;
 	 * * {@link PlatformModule} contains static members of the `Platform` API, accessible through `fin.Platform`.
 	 * * {@link Platform} describes an instance of an OpenFin Platform, e.g. as returned by `fin.Platform.getCurrent`.
 	 *
-	 * These are separate code entities, and are documented separately.  In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
+	 * These are separate code entities, and are documented separately.  In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
 	 * both of these were documented on the same page.
 	 *
 	 * @packageDocumentation
@@ -14975,7 +14887,7 @@ function requireInteropBroker () {
 	     * // }
 	     * ```
 	     *
-	     * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
+	     * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
 	     *
 	     * @param contextForIntent Data passed between entities and applications.
 	     * @param clientIdentity Identity of the Client making the request.
@@ -16778,7 +16690,7 @@ Factory.SnapshotSourceModule = SnapshotSourceModule;
 	 * * {@link SnapshotSourceModule} contains static members of the `SnapshotSource` API, accessible through `fin.SnapshotSource`.
 	 * * {@link SnapshotSource} describes an instance of an OpenFin SnapshotSource, e.g. as returned by `fin.SnapshotSource.wrap`.
 	 *
-	 * These are separate code entities, and are documented separately.  In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
+	 * These are separate code entities, and are documented separately.  In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
 	 * both of these were documented on the same page.
 	 *
 	 * @packageDocumentation
@@ -17212,7 +17124,7 @@ class MockEnvironment {
     getRtcPeer() {
         throw new Error(me_1.environmentUnsupportedMessage);
     }
-    initLayout() {
+    initLayoutManager() {
         throw new Error(me_1.environmentUnsupportedMessage);
     }
     async createLayout() {
@@ -17221,6 +17133,9 @@ class MockEnvironment {
     async destroyLayout() {
         throw new Error(me_1.environmentUnsupportedMessage);
     }
+    async resolveLayout() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
     initPlatform() {
         throw new Error(me_1.environmentUnsupportedMessage);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "34.78.54",
+    "version": "34.78.57",
     "description": "The core renderer entry point of OpenFin",
     "license": "SEE LICENSE IN LICENSE.MD",
     "main": "out/mock.js",