@openfin/core 35.78.11 → 35.78.14

package/out/mock-alpha.d.ts

@@ -5062,12 +5062,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
 } : never;
 
 declare interface Environment {
-    initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<{
-        singleInstance: any | undefined;
-        layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>;
-    }>;
+    initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
     createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
     destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
+    resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
     initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.Fin['Platform']['init']>;
     observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
     writeToken(path: string, token: string): Promise<string>;
@@ -8842,11 +8840,12 @@ declare type LayoutIdentity = Identity_5 & {
 };
 
 /**
- * Generated when a window and all of its layout's views have either finished or failed navigation.
+ * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
  * @interface
  */
 declare type LayoutInitializedEvent = BaseEvent_5 & {
     type: 'layout-initialized';
+    layoutIdentity: OpenFin_2.LayoutIdentity;
     ofViews: (OpenFin_2.Identity & {
         entityType: 'view';
     })[];
@@ -8879,7 +8878,7 @@ declare type LayoutItemConfig = {
  *
  * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
  *
- * Responsible for aggergating all layout snapshots and storing layout instances
+ * Responsible for aggregating all layout snapshots and storing layout instances
  */
 declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
@@ -9187,11 +9186,12 @@ declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 
 /**
- * Generated when a window and all of its layout's views have been created and can receive API calls.
+ * Generated when the layout and all of the its views have been created and can receive API calls.
  * @interface
  */
 declare type LayoutReadyEvent = BaseEvent_5 & {
     type: 'layout-ready';
+    layoutIdentity: OpenFin_2.LayoutIdentity;
     views: (OpenFin_2.Identity & {
         success: boolean;
     })[];
@@ -16409,7 +16409,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
  */
 declare type ViewDetachedEvent = BaseEvent_5 & {
     type: 'view-detached';
-    target: OpenFin_2.Identity;
+    target: OpenFin_2.Identity | null;
     previousTarget: OpenFin_2.Identity;
     viewIdentity: OpenFin_2.Identity;
 };

package/out/mock-beta.d.ts

@@ -5062,12 +5062,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
 } : never;
 
 declare interface Environment {
-    initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<{
-        singleInstance: any | undefined;
-        layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>;
-    }>;
+    initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
     createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
     destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
+    resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
     initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.Fin['Platform']['init']>;
     observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
     writeToken(path: string, token: string): Promise<string>;
@@ -8842,11 +8840,12 @@ declare type LayoutIdentity = Identity_5 & {
 };
 
 /**
- * Generated when a window and all of its layout's views have either finished or failed navigation.
+ * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
  * @interface
  */
 declare type LayoutInitializedEvent = BaseEvent_5 & {
     type: 'layout-initialized';
+    layoutIdentity: OpenFin_2.LayoutIdentity;
     ofViews: (OpenFin_2.Identity & {
         entityType: 'view';
     })[];
@@ -8879,7 +8878,7 @@ declare type LayoutItemConfig = {
  *
  * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
  *
- * Responsible for aggergating all layout snapshots and storing layout instances
+ * Responsible for aggregating all layout snapshots and storing layout instances
  */
 declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
@@ -9187,11 +9186,12 @@ declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 
 /**
- * Generated when a window and all of its layout's views have been created and can receive API calls.
+ * Generated when the layout and all of the its views have been created and can receive API calls.
  * @interface
  */
 declare type LayoutReadyEvent = BaseEvent_5 & {
     type: 'layout-ready';
+    layoutIdentity: OpenFin_2.LayoutIdentity;
     views: (OpenFin_2.Identity & {
         success: boolean;
     })[];
@@ -16409,7 +16409,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
  */
 declare type ViewDetachedEvent = BaseEvent_5 & {
     type: 'view-detached';
-    target: OpenFin_2.Identity;
+    target: OpenFin_2.Identity | null;
     previousTarget: OpenFin_2.Identity;
     viewIdentity: OpenFin_2.Identity;
 };

package/out/mock-public.d.ts

@@ -5062,12 +5062,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
 } : never;
 
 declare interface Environment {
-    initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<{
-        singleInstance: any | undefined;
-        layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>;
-    }>;
+    initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
     createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
     destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
+    resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
     initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.Fin['Platform']['init']>;
     observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
     writeToken(path: string, token: string): Promise<string>;
@@ -8842,11 +8840,12 @@ declare type LayoutIdentity = Identity_5 & {
 };
 
 /**
- * Generated when a window and all of its layout's views have either finished or failed navigation.
+ * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
  * @interface
  */
 declare type LayoutInitializedEvent = BaseEvent_5 & {
     type: 'layout-initialized';
+    layoutIdentity: OpenFin_2.LayoutIdentity;
     ofViews: (OpenFin_2.Identity & {
         entityType: 'view';
     })[];
@@ -8879,7 +8878,7 @@ declare type LayoutItemConfig = {
  *
  * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
  *
- * Responsible for aggergating all layout snapshots and storing layout instances
+ * Responsible for aggregating all layout snapshots and storing layout instances
  */
 declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
@@ -9187,11 +9186,12 @@ declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 
 /**
- * Generated when a window and all of its layout's views have been created and can receive API calls.
+ * Generated when the layout and all of the its views have been created and can receive API calls.
  * @interface
  */
 declare type LayoutReadyEvent = BaseEvent_5 & {
     type: 'layout-ready';
+    layoutIdentity: OpenFin_2.LayoutIdentity;
     views: (OpenFin_2.Identity & {
         success: boolean;
     })[];
@@ -16409,7 +16409,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
  */
 declare type ViewDetachedEvent = BaseEvent_5 & {
     type: 'view-detached';
-    target: OpenFin_2.Identity;
+    target: OpenFin_2.Identity | null;
     previousTarget: OpenFin_2.Identity;
     viewIdentity: OpenFin_2.Identity;
 };

package/out/mock.d.ts

@@ -5161,12 +5161,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
 } : never;
 
 declare interface Environment {
-    initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<{
-        singleInstance: any | undefined;
-        layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>;
-    }>;
+    initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
     createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
     destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
+    resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
     initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.Fin['Platform']['init']>;
     observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
     writeToken(path: string, token: string): Promise<string>;
@@ -8995,11 +8993,12 @@ declare type LayoutIdentity = Identity_5 & {
 };
 
 /**
- * Generated when a window and all of its layout's views have either finished or failed navigation.
+ * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
  * @interface
  */
 declare type LayoutInitializedEvent = BaseEvent_5 & {
     type: 'layout-initialized';
+    layoutIdentity: OpenFin_2.LayoutIdentity;
     ofViews: (OpenFin_2.Identity & {
         entityType: 'view';
     })[];
@@ -9032,7 +9031,7 @@ declare type LayoutItemConfig = {
  *
  * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
  *
- * Responsible for aggergating all layout snapshots and storing layout instances
+ * Responsible for aggregating all layout snapshots and storing layout instances
  */
 declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
@@ -9497,11 +9496,12 @@ declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 
 /**
- * Generated when a window and all of its layout's views have been created and can receive API calls.
+ * Generated when the layout and all of the its views have been created and can receive API calls.
  * @interface
  */
 declare type LayoutReadyEvent = BaseEvent_5 & {
     type: 'layout-ready';
+    layoutIdentity: OpenFin_2.LayoutIdentity;
     views: (OpenFin_2.Identity & {
         success: boolean;
     })[];
@@ -16930,7 +16930,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
  */
 declare type ViewDetachedEvent = BaseEvent_5 & {
     type: 'view-detached';
-    target: OpenFin_2.Identity;
+    target: OpenFin_2.Identity | null;
     previousTarget: OpenFin_2.Identity;
     viewIdentity: OpenFin_2.Identity;
 };

package/out/mock.js

@@ -13079,7 +13079,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;
@@ -13142,38 +13142,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");
-            const result = await this.wire.environment.initLayout(this.fin, this.wire, options);
-            __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, result.layoutManager, "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 layout = this.wrapSync(result.singleInstance.identity);
-                // Backward compat - undocumented / not typed openfin-layout as layoutManager
-                return Object.assign(layout, { layoutManager: result.singleInstance });
+                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(() => {
                 if (__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").size() === 0) {
-                    console.warn(`[Layout.init] Layout.init was called but no layouts have been created yet. Make sure you ` +
+                    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);
         };
     }
@@ -13272,9 +13287,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}`);
     }
 };
 
@@ -17210,7 +17225,7 @@ class MockEnvironment {
     getRtcPeer() {
         throw new Error(me_1.environmentUnsupportedMessage);
     }
-    initLayout() {
+    initLayoutManager() {
         throw new Error(me_1.environmentUnsupportedMessage);
     }
     async createLayout() {
@@ -17219,6 +17234,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": "35.78.11",
+    "version": "35.78.14",
     "description": "The core renderer entry point of OpenFin",
     "license": "SEE LICENSE IN LICENSE.md",
     "main": "out/mock.js",