@openfin/core 34.78.69 → 34.78.74

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5089,6 +5089,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5089
5089
 
5090
5090
  declare interface Environment {
5091
5091
  initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
5092
+ applyLayoutSnapshot(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.InitLayoutOptions): Promise<void>;
5092
5093
  createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
5093
5094
  destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
5094
5095
  resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
@@ -8863,16 +8864,17 @@ declare type LayoutIdentity = Identity_5 & {
8863
8864
  };
8864
8865
 
8865
8866
  /**
8866
- * Generated when the window is created, and all of its layout's views have either finished or failed
8867
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8867
+ * Generated after a layout is created and all of its views have either finished or failed navigation
8868
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
8868
8869
  * @interface
8869
8870
  */
8870
8871
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8871
8872
  type: 'layout-initialized';
8872
8873
  layoutIdentity: OpenFin_2.LayoutIdentity;
8873
- ofViews: (OpenFin_2.Identity & {
8874
+ ofViews: {
8875
+ identity: OpenFin_2.Identity;
8874
8876
  entityType: 'view';
8875
- })[];
8877
+ }[];
8876
8878
  };
8877
8879
 
8878
8880
  /**
@@ -9240,9 +9242,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9240
9242
  declare type LayoutReadyEvent = BaseEvent_5 & {
9241
9243
  type: 'layout-ready';
9242
9244
  layoutIdentity: OpenFin_2.LayoutIdentity;
9243
- views: (OpenFin_2.Identity & {
9245
+ views: {
9246
+ identity: OpenFin_2.Identity;
9244
9247
  success: boolean;
9245
- })[];
9248
+ error?: Error;
9249
+ }[];
9246
9250
  };
9247
9251
 
9248
9252
  /**
@@ -5089,6 +5089,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5089
5089
 
5090
5090
  declare interface Environment {
5091
5091
  initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
5092
+ applyLayoutSnapshot(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.InitLayoutOptions): Promise<void>;
5092
5093
  createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
5093
5094
  destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
5094
5095
  resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
@@ -8863,16 +8864,17 @@ declare type LayoutIdentity = Identity_5 & {
8863
8864
  };
8864
8865
 
8865
8866
  /**
8866
- * Generated when the window is created, and all of its layout's views have either finished or failed
8867
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8867
+ * Generated after a layout is created and all of its views have either finished or failed navigation
8868
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
8868
8869
  * @interface
8869
8870
  */
8870
8871
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8871
8872
  type: 'layout-initialized';
8872
8873
  layoutIdentity: OpenFin_2.LayoutIdentity;
8873
- ofViews: (OpenFin_2.Identity & {
8874
+ ofViews: {
8875
+ identity: OpenFin_2.Identity;
8874
8876
  entityType: 'view';
8875
- })[];
8877
+ }[];
8876
8878
  };
8877
8879
 
8878
8880
  /**
@@ -9240,9 +9242,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9240
9242
  declare type LayoutReadyEvent = BaseEvent_5 & {
9241
9243
  type: 'layout-ready';
9242
9244
  layoutIdentity: OpenFin_2.LayoutIdentity;
9243
- views: (OpenFin_2.Identity & {
9245
+ views: {
9246
+ identity: OpenFin_2.Identity;
9244
9247
  success: boolean;
9245
- })[];
9248
+ error?: Error;
9249
+ }[];
9246
9250
  };
9247
9251
 
9248
9252
  /**
@@ -5089,6 +5089,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5089
5089
 
5090
5090
  declare interface Environment {
5091
5091
  initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
5092
+ applyLayoutSnapshot(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.InitLayoutOptions): Promise<void>;
5092
5093
  createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
5093
5094
  destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
5094
5095
  resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
@@ -8863,16 +8864,17 @@ declare type LayoutIdentity = Identity_5 & {
8863
8864
  };
8864
8865
 
8865
8866
  /**
8866
- * Generated when the window is created, and all of its layout's views have either finished or failed
8867
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8867
+ * Generated after a layout is created and all of its views have either finished or failed navigation
8868
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
8868
8869
  * @interface
8869
8870
  */
8870
8871
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8871
8872
  type: 'layout-initialized';
8872
8873
  layoutIdentity: OpenFin_2.LayoutIdentity;
8873
- ofViews: (OpenFin_2.Identity & {
8874
+ ofViews: {
8875
+ identity: OpenFin_2.Identity;
8874
8876
  entityType: 'view';
8875
- })[];
8877
+ }[];
8876
8878
  };
8877
8879
 
8878
8880
  /**
@@ -9240,9 +9242,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9240
9242
  declare type LayoutReadyEvent = BaseEvent_5 & {
9241
9243
  type: 'layout-ready';
9242
9244
  layoutIdentity: OpenFin_2.LayoutIdentity;
9243
- views: (OpenFin_2.Identity & {
9245
+ views: {
9246
+ identity: OpenFin_2.Identity;
9244
9247
  success: boolean;
9245
- })[];
9248
+ error?: Error;
9249
+ }[];
9246
9250
  };
9247
9251
 
9248
9252
  /**
package/out/mock.d.ts CHANGED
@@ -5137,6 +5137,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5137
5137
 
5138
5138
  declare interface Environment {
5139
5139
  initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
5140
+ applyLayoutSnapshot(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.InitLayoutOptions): Promise<void>;
5140
5141
  createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
5141
5142
  destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
5142
5143
  resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
@@ -8970,16 +8971,17 @@ declare type LayoutIdentity = Identity_5 & {
8970
8971
  };
8971
8972
 
8972
8973
  /**
8973
- * Generated when the window is created, and all of its layout's views have either finished or failed
8974
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8974
+ * Generated after a layout is created and all of its views have either finished or failed navigation
8975
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
8975
8976
  * @interface
8976
8977
  */
8977
8978
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8978
8979
  type: 'layout-initialized';
8979
8980
  layoutIdentity: OpenFin_2.LayoutIdentity;
8980
- ofViews: (OpenFin_2.Identity & {
8981
+ ofViews: {
8982
+ identity: OpenFin_2.Identity;
8981
8983
  entityType: 'view';
8982
- })[];
8984
+ }[];
8983
8985
  };
8984
8986
 
8985
8987
  /**
@@ -9517,9 +9519,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9517
9519
  declare type LayoutReadyEvent = BaseEvent_5 & {
9518
9520
  type: 'layout-ready';
9519
9521
  layoutIdentity: OpenFin_2.LayoutIdentity;
9520
- views: (OpenFin_2.Identity & {
9522
+ views: {
9523
+ identity: OpenFin_2.Identity;
9521
9524
  success: boolean;
9522
- })[];
9525
+ error?: Error;
9526
+ }[];
9523
9527
  };
9524
9528
 
9525
9529
  /**
package/out/mock.js CHANGED
@@ -257,7 +257,7 @@ events.WindowEvents = WindowEvents;
257
257
  __exportStar(events, exports);
258
258
  } (OpenFin$1));
259
259
 
260
- var fin = {};
260
+ var fin$1 = {};
261
261
 
262
262
  var system = {};
263
263
 
@@ -13039,24 +13039,16 @@ class LayoutModule extends base_1$5.Base {
13039
13039
  throw new Error('Layout.init was already called, please use Layout.create to add additional layouts.');
13040
13040
  }
13041
13041
  __classPrivateFieldSet$4(this, _LayoutModule_layoutInitializationAttempted, true, "f");
13042
+ // preload the client
13043
+ await this.fin.Platform.getCurrentSync().getClient();
13042
13044
  __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayoutManager(this.fin, this.wire, options), "f");
13043
- // apply the initial snapshot which in turn will call fin.Platform.Layout.create()
13044
- const platformClient = await this.fin.Platform.getCurrentSync().getClient();
13045
- const snapshot = await platformClient.dispatch('get-initial-layout-snapshot');
13046
- await __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").applyLayoutSnapshot(snapshot);
13045
+ await this.wire.environment.applyLayoutSnapshot(this.fin, __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), options);
13047
13046
  if (!options.layoutManagerOverride) {
13048
13047
  // in single-layout case, we return the undocumented layoutManager type (deprecate with CORE-1081)
13049
13048
  const layoutIdentity = { layoutName: layout_constants_1.DEFAULT_LAYOUT_KEY, ...this.fin.me.identity };
13050
13049
  const layoutManager = await this.wire.environment.resolveLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
13051
13050
  return Object.assign(this.wrapSync(layoutIdentity), { layoutManager });
13052
13051
  }
13053
- // warn user if they do not call create() in the next 30 seconds
13054
- setTimeout(() => {
13055
- if (__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").size() === 0) {
13056
- console.warn(`[Layout.init] Layout.init was called 30s ago, but no layouts have been created yet. Make sure you ` +
13057
- `override LayoutManager.applyLayoutSnapshot, and then call fin.Platform.Layout.create()`);
13058
- }
13059
- }, 30000);
13060
13052
  return this.wrapSync(this.fin.me.identity);
13061
13053
  };
13062
13054
  /**
@@ -13285,6 +13277,9 @@ class PlatformModule extends base_1$4.Base {
13285
13277
  * @experimental
13286
13278
  */
13287
13279
  async init(options) {
13280
+ if (!fin.__internal_.isPlatform || fin.me.name !== fin.me.uuid) {
13281
+ throw new Error('fin.Platform.init should only be called from a custom platform provider running in the main window of the application.');
13282
+ }
13288
13283
  return this.wire.environment.initPlatform(this.fin, options);
13289
13284
  }
13290
13285
  /**
@@ -16706,8 +16701,8 @@ Factory.SnapshotSourceModule = SnapshotSourceModule;
16706
16701
  __exportStar(Instance, exports);
16707
16702
  } (snapshotSource));
16708
16703
 
16709
- Object.defineProperty(fin, "__esModule", { value: true });
16710
- fin.Fin = void 0;
16704
+ Object.defineProperty(fin$1, "__esModule", { value: true });
16705
+ fin$1.Fin = void 0;
16711
16706
  const events_1$3 = require$$0;
16712
16707
  // Import from the file rather than the directory in case someone consuming types is using module resolution other than "node"
16713
16708
  const index_1 = system;
@@ -16753,7 +16748,7 @@ class Fin extends events_1$3.EventEmitter {
16753
16748
  });
16754
16749
  }
16755
16750
  }
16756
- fin.Fin = Fin;
16751
+ fin$1.Fin = Fin;
16757
16752
 
16758
16753
  var transport = {};
16759
16754
 
@@ -17119,6 +17114,9 @@ class MockEnvironment {
17119
17114
  initLayoutManager() {
17120
17115
  throw new Error(me_1.environmentUnsupportedMessage);
17121
17116
  }
17117
+ applyLayoutSnapshot() {
17118
+ throw new Error(me_1.environmentUnsupportedMessage);
17119
+ }
17122
17120
  async createLayout() {
17123
17121
  throw new Error(me_1.environmentUnsupportedMessage);
17124
17122
  }
@@ -17205,7 +17203,7 @@ mockWire.MockWire = MockWire;
17205
17203
  Object.defineProperty(mock, "__esModule", { value: true });
17206
17204
  exports.fin = mock.fin = void 0;
17207
17205
  const OpenFin = OpenFin$1;
17208
- const fin_1 = fin;
17206
+ const fin_1 = fin$1;
17209
17207
  const transport_1 = transport;
17210
17208
  const mockEnvironment_1 = mockEnvironment;
17211
17209
  const mockWire_1 = mockWire;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "34.78.69",
3
+ "version": "34.78.74",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/mock.js",