@openfin/core 35.79.1 → 35.79.2

package/out/mock-alpha.d.ts

@@ -5014,6 +5014,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
 
 declare interface Environment {
     initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
+    applyLayoutSnapshot(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.InitLayoutOptions): Promise<void>;
     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>;
@@ -8495,16 +8496,17 @@ declare type LayoutIdentity = Identity_5 & {
 };
 
 /**
- * Generated when the window is created, and all of its layout's views have either finished or failed
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
+ * Generated after a layout is created and all of its views have either finished or failed navigation
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
  * @interface
  */
 declare type LayoutInitializedEvent = BaseEvent_5 & {
     type: 'layout-initialized';
     layoutIdentity: OpenFin_2.LayoutIdentity;
-    ofViews: (OpenFin_2.Identity & {
+    ofViews: {
+        identity: OpenFin_2.Identity;
         entityType: 'view';
-    })[];
+    }[];
 };
 
 /**
@@ -8872,9 +8874,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 declare type LayoutReadyEvent = BaseEvent_5 & {
     type: 'layout-ready';
     layoutIdentity: OpenFin_2.LayoutIdentity;
-    views: (OpenFin_2.Identity & {
+    views: {
+        identity: OpenFin_2.Identity;
         success: boolean;
-    })[];
+        error?: Error;
+    }[];
 };
 
 /**

package/out/mock-beta.d.ts

@@ -5014,6 +5014,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
 
 declare interface Environment {
     initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
+    applyLayoutSnapshot(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.InitLayoutOptions): Promise<void>;
     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>;
@@ -8495,16 +8496,17 @@ declare type LayoutIdentity = Identity_5 & {
 };
 
 /**
- * Generated when the window is created, and all of its layout's views have either finished or failed
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
+ * Generated after a layout is created and all of its views have either finished or failed navigation
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
  * @interface
  */
 declare type LayoutInitializedEvent = BaseEvent_5 & {
     type: 'layout-initialized';
     layoutIdentity: OpenFin_2.LayoutIdentity;
-    ofViews: (OpenFin_2.Identity & {
+    ofViews: {
+        identity: OpenFin_2.Identity;
         entityType: 'view';
-    })[];
+    }[];
 };
 
 /**
@@ -8872,9 +8874,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 declare type LayoutReadyEvent = BaseEvent_5 & {
     type: 'layout-ready';
     layoutIdentity: OpenFin_2.LayoutIdentity;
-    views: (OpenFin_2.Identity & {
+    views: {
+        identity: OpenFin_2.Identity;
         success: boolean;
-    })[];
+        error?: Error;
+    }[];
 };
 
 /**

package/out/mock-public.d.ts

@@ -5014,6 +5014,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
 
 declare interface Environment {
     initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
+    applyLayoutSnapshot(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.InitLayoutOptions): Promise<void>;
     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>;
@@ -8495,16 +8496,17 @@ declare type LayoutIdentity = Identity_5 & {
 };
 
 /**
- * Generated when the window is created, and all of its layout's views have either finished or failed
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
+ * Generated after a layout is created and all of its views have either finished or failed navigation
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
  * @interface
  */
 declare type LayoutInitializedEvent = BaseEvent_5 & {
     type: 'layout-initialized';
     layoutIdentity: OpenFin_2.LayoutIdentity;
-    ofViews: (OpenFin_2.Identity & {
+    ofViews: {
+        identity: OpenFin_2.Identity;
         entityType: 'view';
-    })[];
+    }[];
 };
 
 /**
@@ -8872,9 +8874,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 declare type LayoutReadyEvent = BaseEvent_5 & {
     type: 'layout-ready';
     layoutIdentity: OpenFin_2.LayoutIdentity;
-    views: (OpenFin_2.Identity & {
+    views: {
+        identity: OpenFin_2.Identity;
         success: boolean;
-    })[];
+        error?: Error;
+    }[];
 };
 
 /**

package/out/mock.d.ts

@@ -5062,6 +5062,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
 
 declare interface Environment {
     initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
+    applyLayoutSnapshot(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.InitLayoutOptions): Promise<void>;
     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>;
@@ -8602,16 +8603,17 @@ declare type LayoutIdentity = Identity_5 & {
 };
 
 /**
- * Generated when the window is created, and all of its layout's views have either finished or failed
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
+ * Generated after a layout is created and all of its views have either finished or failed navigation
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
  * @interface
  */
 declare type LayoutInitializedEvent = BaseEvent_5 & {
     type: 'layout-initialized';
     layoutIdentity: OpenFin_2.LayoutIdentity;
-    ofViews: (OpenFin_2.Identity & {
+    ofViews: {
+        identity: OpenFin_2.Identity;
         entityType: 'view';
-    })[];
+    }[];
 };
 
 /**
@@ -9149,9 +9151,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 declare type LayoutReadyEvent = BaseEvent_5 & {
     type: 'layout-ready';
     layoutIdentity: OpenFin_2.LayoutIdentity;
-    views: (OpenFin_2.Identity & {
+    views: {
+        identity: OpenFin_2.Identity;
         success: boolean;
-    })[];
+        error?: Error;
+    }[];
 };
 
 /**

package/out/mock.js

@@ -11507,7 +11507,7 @@ const validate_1 = validate;
 const base_1$6 = base;
 const common_utils_1 = commonUtils;
 const layout_entities_1 = layoutEntities;
-const layout_constants_1 = layout_constants;
+const layout_constants_1$1 = layout_constants;
 /**
  *
  * Layouts give app providers the ability to embed multiple views in a single window. The Layout namespace
@@ -11652,7 +11652,7 @@ class Layout extends base_1$6.Base {
          * 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)));
+        _Layout_layoutClient.set(this, new lazy_1.Lazy(async () => layout_entities_1.LayoutNode.newLayoutEntitiesClient(await this.platform.getClient(), layout_constants_1$1.LAYOUT_CONTROLLER_ID, this.identity)));
         /**
          * Replaces a Platform window's layout with a new layout.
          *
@@ -11880,11 +11880,12 @@ 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_waitForBackCompatLayoutManager, _LayoutModule_getSafeLayoutManager;
+var _LayoutModule_instances, _LayoutModule_layoutInitializationAttempted, _LayoutModule_layoutManager, _LayoutModule_getSafeLayoutManager;
 Object.defineProperty(Factory$2, "__esModule", { value: true });
 Factory$2.LayoutModule = void 0;
 const base_1$5 = base;
 const Instance_1$2 = Instance$1;
+const layout_constants_1 = layout_constants;
 /**
  * Static namespace for OpenFin API methods that interact with the {@link Layout} class, available under `fin.Platform.Layout`.
  */
@@ -11943,45 +11944,18 @@ 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");
+            // preload the client
+            await this.fin.Platform.getCurrentSync().getClient();
             __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayoutManager(this.fin, this.wire, options), "f");
-            // in single-layout case, we return the undocumented layoutManager type (deprecate with CORE-1081)
-            let backCompatLayoutPromise;
+            await this.wire.environment.applyLayoutSnapshot(this.fin, __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), options);
             if (!options.layoutManagerOverride) {
-                backCompatLayoutPromise = __classPrivateFieldGet$4(this, _LayoutModule_waitForBackCompatLayoutManager, "f").call(this, this.fin);
-            }
-            // 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 (backCompatLayoutPromise) {
-                return backCompatLayoutPromise;
+                // in single-layout case, we return the undocumented layoutManager type (deprecate with CORE-1081)
+                const layoutIdentity = { layoutName: layout_constants_1.DEFAULT_LAYOUT_KEY, ...this.fin.me.identity };
+                const layoutManager = await this.wire.environment.resolveLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
+                return Object.assign(this.wrapSync(layoutIdentity), { layoutManager });
             }
-            // 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 30s ago, but no layouts have been created yet. Make sure you ` +
-                        `override LayoutManager.applyLayoutSnapshot, and then call fin.Platform.Layout.create()`);
-                }
-            }, 30000);
             return this.wrapSync(this.fin.me.identity);
         };
-        // deprecate with CORE-1081
-        _LayoutModule_waitForBackCompatLayoutManager.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 }) => {
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                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
@@ -12091,7 +12065,7 @@ class LayoutModule extends base_1$5.Base {
     }
 }
 Factory$2.LayoutModule = LayoutModule;
-_LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layoutManager = new WeakMap(), _LayoutModule_waitForBackCompatLayoutManager = new WeakMap(), _LayoutModule_instances = new WeakSet(), _LayoutModule_getSafeLayoutManager = function _LayoutModule_getSafeLayoutManager(method) {
+_LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layoutManager = new WeakMap(), _LayoutModule_instances = new WeakSet(), _LayoutModule_getSafeLayoutManager = function _LayoutModule_getSafeLayoutManager(method) {
     if (!__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f")) {
         throw new Error(`You must call init before using the API ${method}`);
     }
@@ -15892,6 +15866,9 @@ class MockEnvironment {
     initLayoutManager() {
         throw new Error(me_1.environmentUnsupportedMessage);
     }
+    applyLayoutSnapshot() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
     async createLayout() {
         throw new Error(me_1.environmentUnsupportedMessage);
     }

package/package.json

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