@openfin/remote-adapter 36.79.9 → 36.79.11

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.
@@ -871,7 +871,7 @@ declare type ApplicationConnectedEvent = ConnectedEvent_2;
871
871
  * Generated when an application is created.
872
872
  * @interface
873
873
  */
874
- declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
874
+ declare type ApplicationCreatedEvent = BaseEvent_9 & BaseEvents.IdentityEvent & {
875
875
  type: 'application-created';
876
876
  };
877
877
 
@@ -1738,13 +1738,30 @@ declare type BaseContentCreationRule = {
1738
1738
  /**
1739
1739
  * A base OpenFin event. All OpenFin event payloads extend this type.
1740
1740
  *
1741
+ * OpenFin events are jointly discriminated by their {@link topic} and {@link type} keys. Within each
1742
+ * `topic`, the `type` key is unique.
1743
+ *
1741
1744
  * @interface
1742
1745
  */
1743
1746
  declare type BaseEvent = {
1747
+ /**
1748
+ * The "kebab-case" classname of the {@link OpenFin.Events emitter} that raised the event.
1749
+ *
1750
+ * @remarks {@link OpenFin.Frame} is represented as `iframe`.
1751
+ */
1744
1752
  topic: string;
1753
+ /**
1754
+ * The type of event that was raised. Equal to the typename of the event payload in "kebab case".
1755
+ *
1756
+ * @remarks Guaranteed to be unique within each {@link topic}, but can be repeated
1757
+ * between topics (e.g. {@link OpenFin.WebContentsEvents.CrashedEvent WebContentsEvents.CrashedEvent} and
1758
+ * {@link OpenFin.ApplicationEvents.CrashedEvent ApplicationEvents.CrashedEvent}).
1759
+ */
1745
1760
  type: string;
1746
1761
  };
1747
1762
 
1763
+ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1764
+
1748
1765
  /**
1749
1766
  * A base Channel event.
1750
1767
  * @interface
@@ -1797,14 +1814,22 @@ declare type BaseEvent_7 = NamedEvent & {
1797
1814
  };
1798
1815
 
1799
1816
  /**
1800
- * Base type for events emitting on the `system` topic
1817
+ * Base type for events emitting on the `global-hotkey` topic.
1818
+ *
1801
1819
  * @interface
1802
1820
  */
1803
1821
  declare type BaseEvent_8 = BaseEvents.BaseEvent & {
1804
- topic: 'system';
1822
+ topic: 'global-hotkey';
1823
+ hotkey: string;
1805
1824
  };
1806
1825
 
1807
- declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
1826
+ /**
1827
+ * Base type for events emitting on the `system` topic
1828
+ * @interface
1829
+ */
1830
+ declare type BaseEvent_9 = BaseEvents.BaseEvent & {
1831
+ topic: 'system';
1832
+ };
1808
1833
 
1809
1834
  declare namespace BaseEvents {
1810
1835
  export {
@@ -4607,7 +4632,7 @@ declare interface DesktopAgent_2 {
4607
4632
  * Generated when the desktop icon is clicked while it's already running.
4608
4633
  * @interface
4609
4634
  */
4610
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4635
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4611
4636
  type: 'desktop-icon-clicked';
4612
4637
  };
4613
4638
 
@@ -5151,6 +5176,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5151
5176
 
5152
5177
  declare interface Environment {
5153
5178
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5179
+ applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
5154
5180
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5155
5181
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
5156
5182
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
@@ -5192,14 +5218,14 @@ declare type ErrorPlainObject = {
5192
5218
 
5193
5219
  /**
5194
5220
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}. Events are
5195
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5221
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5196
5222
  * under the {@link OpenFin.PlatformEvents} namespace.
5197
5223
  */
5198
5224
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5199
5225
 
5200
5226
  /**
5201
5227
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}. Events are
5202
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5228
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5203
5229
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5204
5230
  * from which they propagate).
5205
5231
  */
@@ -5207,7 +5233,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5207
5233
 
5208
5234
  /**
5209
5235
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
5210
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5236
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5211
5237
  * under the {@link OpenFin.ChannelEvents} namespace.
5212
5238
  */
5213
5239
  declare type Event_2 = {
@@ -5216,7 +5242,7 @@ declare type Event_2 = {
5216
5242
 
5217
5243
  /**
5218
5244
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}. Events are
5219
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5245
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5220
5246
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5221
5247
  * from which they propagate).
5222
5248
  */
@@ -5224,7 +5250,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5224
5250
 
5225
5251
  /**
5226
5252
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}. Events are
5227
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5253
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5228
5254
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5229
5255
  */
5230
5256
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5241,21 +5267,21 @@ declare type Event_5<Topic extends string> = {
5241
5267
 
5242
5268
  /**
5243
5269
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
5244
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5270
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5245
5271
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5246
5272
  */
5247
5273
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5248
5274
 
5249
5275
  /**
5250
5276
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}. Events are
5251
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5277
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5252
5278
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5253
5279
  */
5254
5280
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5255
5281
 
5256
5282
  /**
5257
5283
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}. Events are
5258
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5284
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5259
5285
  * under the {@link OpenFin.FrameEvents} namespace.
5260
5286
  */
5261
5287
  declare type Event_8 = {
@@ -5264,13 +5290,10 @@ declare type Event_8 = {
5264
5290
 
5265
5291
  /**
5266
5292
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}. Events are
5267
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5293
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5268
5294
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5269
5295
  */
5270
- declare type Event_9 = {
5271
- topic: 'global-hotkey';
5272
- hotkey: 'string';
5273
- } & (RegisteredEvent | UnregisteredEvent);
5296
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5274
5297
 
5275
5298
  declare class EventAggregator extends EmitterMap {
5276
5299
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6121,6 +6144,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6121
6144
 
6122
6145
  declare namespace GlobalHotkeyEvents {
6123
6146
  export {
6147
+ BaseEvent_8 as BaseEvent,
6124
6148
  RegisteredEvent,
6125
6149
  UnregisteredEvent,
6126
6150
  Event_9 as Event,
@@ -6608,7 +6632,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6608
6632
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6609
6633
  * @interface
6610
6634
  */
6611
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6635
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6612
6636
  type: 'idle-state-changed';
6613
6637
  elapsedTime: number;
6614
6638
  isIdle: boolean;
@@ -8660,16 +8684,17 @@ declare type LayoutIdentity = Identity_5 & {
8660
8684
  };
8661
8685
 
8662
8686
  /**
8663
- * Generated when the window is created, and all of its layout's views have either finished or failed
8664
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8687
+ * Generated after a layout is created and all of its views have either finished or failed navigation
8688
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
8665
8689
  * @interface
8666
8690
  */
8667
8691
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8668
8692
  type: 'layout-initialized';
8669
8693
  layoutIdentity: OpenFin.LayoutIdentity;
8670
- ofViews: (OpenFin.Identity & {
8694
+ ofViews: {
8695
+ identity: OpenFin.Identity;
8671
8696
  entityType: 'view';
8672
- })[];
8697
+ }[];
8673
8698
  };
8674
8699
 
8675
8700
  /**
@@ -9037,9 +9062,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9037
9062
  declare type LayoutReadyEvent = BaseEvent_5 & {
9038
9063
  type: 'layout-ready';
9039
9064
  layoutIdentity: OpenFin.LayoutIdentity;
9040
- views: (OpenFin.Identity & {
9065
+ views: {
9066
+ identity: OpenFin.Identity;
9041
9067
  success: boolean;
9042
- })[];
9068
+ error?: Error;
9069
+ }[];
9043
9070
  };
9044
9071
 
9045
9072
  /**
@@ -9415,7 +9442,7 @@ declare type MonitorInfo = {
9415
9442
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9416
9443
  * @interface
9417
9444
  */
9418
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9445
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9419
9446
  type: 'monitor-info-changed';
9420
9447
  };
9421
9448
 
@@ -10154,7 +10181,7 @@ declare namespace OpenFin {
10154
10181
  AppVersionCompleteEvent,
10155
10182
  AppVersionRuntimeStatusEvent,
10156
10183
  Events,
10157
- BaseEvent_9 as BaseEvent,
10184
+ BaseEvent_10 as BaseEvent,
10158
10185
  WebContentsEvent_2 as WebContentsEvent,
10159
10186
  SystemEvent_2 as SystemEvent,
10160
10187
  ApplicationEvent_2 as ApplicationEvent,
@@ -12612,7 +12639,7 @@ declare type RectangleByEdgePositions = {
12612
12639
  * Generated when a hotkey has been registered with the operating system.
12613
12640
  * @interface
12614
12641
  */
12615
- declare type RegisteredEvent = BaseEvent & {
12642
+ declare type RegisteredEvent = BaseEvent_8 & {
12616
12643
  type: 'registered';
12617
12644
  };
12618
12645
 
@@ -13034,7 +13061,7 @@ declare type ServiceIdentifier = {
13034
13061
  * Generated on changes to a user’s local computer session.
13035
13062
  * @interface
13036
13063
  */
13037
- declare type SessionChangedEvent = BaseEvent_8 & {
13064
+ declare type SessionChangedEvent = BaseEvent_9 & {
13038
13065
  type: 'session-changed';
13039
13066
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13040
13067
  };
@@ -14968,7 +14995,7 @@ declare namespace SystemEvents {
14968
14995
  export {
14969
14996
  NotRequested,
14970
14997
  ExcludeRequested,
14971
- BaseEvent_8 as BaseEvent,
14998
+ BaseEvent_9 as BaseEvent,
14972
14999
  IdleStateChangedEvent,
14973
15000
  IdleEvent,
14974
15001
  MonitorInfoChangedEvent,
@@ -15446,7 +15473,7 @@ declare interface TypedEventEmitter<Event extends {
15446
15473
  * Generated when a hotkey has been unregistered with the operating system.
15447
15474
  * @interface
15448
15475
  */
15449
- declare type UnregisteredEvent = BaseEvent & {
15476
+ declare type UnregisteredEvent = BaseEvent_8 & {
15450
15477
  type: 'unregistered';
15451
15478
  };
15452
15479
 
@@ -871,7 +871,7 @@ declare type ApplicationConnectedEvent = ConnectedEvent_2;
871
871
  * Generated when an application is created.
872
872
  * @interface
873
873
  */
874
- declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
874
+ declare type ApplicationCreatedEvent = BaseEvent_9 & BaseEvents.IdentityEvent & {
875
875
  type: 'application-created';
876
876
  };
877
877
 
@@ -1738,13 +1738,30 @@ declare type BaseContentCreationRule = {
1738
1738
  /**
1739
1739
  * A base OpenFin event. All OpenFin event payloads extend this type.
1740
1740
  *
1741
+ * OpenFin events are jointly discriminated by their {@link topic} and {@link type} keys. Within each
1742
+ * `topic`, the `type` key is unique.
1743
+ *
1741
1744
  * @interface
1742
1745
  */
1743
1746
  declare type BaseEvent = {
1747
+ /**
1748
+ * The "kebab-case" classname of the {@link OpenFin.Events emitter} that raised the event.
1749
+ *
1750
+ * @remarks {@link OpenFin.Frame} is represented as `iframe`.
1751
+ */
1744
1752
  topic: string;
1753
+ /**
1754
+ * The type of event that was raised. Equal to the typename of the event payload in "kebab case".
1755
+ *
1756
+ * @remarks Guaranteed to be unique within each {@link topic}, but can be repeated
1757
+ * between topics (e.g. {@link OpenFin.WebContentsEvents.CrashedEvent WebContentsEvents.CrashedEvent} and
1758
+ * {@link OpenFin.ApplicationEvents.CrashedEvent ApplicationEvents.CrashedEvent}).
1759
+ */
1745
1760
  type: string;
1746
1761
  };
1747
1762
 
1763
+ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1764
+
1748
1765
  /**
1749
1766
  * A base Channel event.
1750
1767
  * @interface
@@ -1797,14 +1814,22 @@ declare type BaseEvent_7 = NamedEvent & {
1797
1814
  };
1798
1815
 
1799
1816
  /**
1800
- * Base type for events emitting on the `system` topic
1817
+ * Base type for events emitting on the `global-hotkey` topic.
1818
+ *
1801
1819
  * @interface
1802
1820
  */
1803
1821
  declare type BaseEvent_8 = BaseEvents.BaseEvent & {
1804
- topic: 'system';
1822
+ topic: 'global-hotkey';
1823
+ hotkey: string;
1805
1824
  };
1806
1825
 
1807
- declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
1826
+ /**
1827
+ * Base type for events emitting on the `system` topic
1828
+ * @interface
1829
+ */
1830
+ declare type BaseEvent_9 = BaseEvents.BaseEvent & {
1831
+ topic: 'system';
1832
+ };
1808
1833
 
1809
1834
  declare namespace BaseEvents {
1810
1835
  export {
@@ -4607,7 +4632,7 @@ declare interface DesktopAgent_2 {
4607
4632
  * Generated when the desktop icon is clicked while it's already running.
4608
4633
  * @interface
4609
4634
  */
4610
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4635
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4611
4636
  type: 'desktop-icon-clicked';
4612
4637
  };
4613
4638
 
@@ -5151,6 +5176,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5151
5176
 
5152
5177
  declare interface Environment {
5153
5178
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5179
+ applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
5154
5180
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5155
5181
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
5156
5182
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
@@ -5192,14 +5218,14 @@ declare type ErrorPlainObject = {
5192
5218
 
5193
5219
  /**
5194
5220
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}. Events are
5195
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5221
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5196
5222
  * under the {@link OpenFin.PlatformEvents} namespace.
5197
5223
  */
5198
5224
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5199
5225
 
5200
5226
  /**
5201
5227
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}. Events are
5202
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5228
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5203
5229
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5204
5230
  * from which they propagate).
5205
5231
  */
@@ -5207,7 +5233,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5207
5233
 
5208
5234
  /**
5209
5235
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
5210
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5236
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5211
5237
  * under the {@link OpenFin.ChannelEvents} namespace.
5212
5238
  */
5213
5239
  declare type Event_2 = {
@@ -5216,7 +5242,7 @@ declare type Event_2 = {
5216
5242
 
5217
5243
  /**
5218
5244
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}. Events are
5219
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5245
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5220
5246
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5221
5247
  * from which they propagate).
5222
5248
  */
@@ -5224,7 +5250,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5224
5250
 
5225
5251
  /**
5226
5252
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}. Events are
5227
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5253
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5228
5254
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5229
5255
  */
5230
5256
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5241,21 +5267,21 @@ declare type Event_5<Topic extends string> = {
5241
5267
 
5242
5268
  /**
5243
5269
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
5244
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5270
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5245
5271
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5246
5272
  */
5247
5273
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5248
5274
 
5249
5275
  /**
5250
5276
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}. Events are
5251
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5277
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5252
5278
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5253
5279
  */
5254
5280
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5255
5281
 
5256
5282
  /**
5257
5283
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}. Events are
5258
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5284
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5259
5285
  * under the {@link OpenFin.FrameEvents} namespace.
5260
5286
  */
5261
5287
  declare type Event_8 = {
@@ -5264,13 +5290,10 @@ declare type Event_8 = {
5264
5290
 
5265
5291
  /**
5266
5292
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}. Events are
5267
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5293
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5268
5294
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5269
5295
  */
5270
- declare type Event_9 = {
5271
- topic: 'global-hotkey';
5272
- hotkey: 'string';
5273
- } & (RegisteredEvent | UnregisteredEvent);
5296
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5274
5297
 
5275
5298
  declare class EventAggregator extends EmitterMap {
5276
5299
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6121,6 +6144,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6121
6144
 
6122
6145
  declare namespace GlobalHotkeyEvents {
6123
6146
  export {
6147
+ BaseEvent_8 as BaseEvent,
6124
6148
  RegisteredEvent,
6125
6149
  UnregisteredEvent,
6126
6150
  Event_9 as Event,
@@ -6608,7 +6632,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6608
6632
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6609
6633
  * @interface
6610
6634
  */
6611
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6635
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6612
6636
  type: 'idle-state-changed';
6613
6637
  elapsedTime: number;
6614
6638
  isIdle: boolean;
@@ -8660,16 +8684,17 @@ declare type LayoutIdentity = Identity_5 & {
8660
8684
  };
8661
8685
 
8662
8686
  /**
8663
- * Generated when the window is created, and all of its layout's views have either finished or failed
8664
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8687
+ * Generated after a layout is created and all of its views have either finished or failed navigation
8688
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
8665
8689
  * @interface
8666
8690
  */
8667
8691
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8668
8692
  type: 'layout-initialized';
8669
8693
  layoutIdentity: OpenFin.LayoutIdentity;
8670
- ofViews: (OpenFin.Identity & {
8694
+ ofViews: {
8695
+ identity: OpenFin.Identity;
8671
8696
  entityType: 'view';
8672
- })[];
8697
+ }[];
8673
8698
  };
8674
8699
 
8675
8700
  /**
@@ -9037,9 +9062,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9037
9062
  declare type LayoutReadyEvent = BaseEvent_5 & {
9038
9063
  type: 'layout-ready';
9039
9064
  layoutIdentity: OpenFin.LayoutIdentity;
9040
- views: (OpenFin.Identity & {
9065
+ views: {
9066
+ identity: OpenFin.Identity;
9041
9067
  success: boolean;
9042
- })[];
9068
+ error?: Error;
9069
+ }[];
9043
9070
  };
9044
9071
 
9045
9072
  /**
@@ -9415,7 +9442,7 @@ declare type MonitorInfo = {
9415
9442
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9416
9443
  * @interface
9417
9444
  */
9418
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9445
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9419
9446
  type: 'monitor-info-changed';
9420
9447
  };
9421
9448
 
@@ -10154,7 +10181,7 @@ declare namespace OpenFin {
10154
10181
  AppVersionCompleteEvent,
10155
10182
  AppVersionRuntimeStatusEvent,
10156
10183
  Events,
10157
- BaseEvent_9 as BaseEvent,
10184
+ BaseEvent_10 as BaseEvent,
10158
10185
  WebContentsEvent_2 as WebContentsEvent,
10159
10186
  SystemEvent_2 as SystemEvent,
10160
10187
  ApplicationEvent_2 as ApplicationEvent,
@@ -12612,7 +12639,7 @@ declare type RectangleByEdgePositions = {
12612
12639
  * Generated when a hotkey has been registered with the operating system.
12613
12640
  * @interface
12614
12641
  */
12615
- declare type RegisteredEvent = BaseEvent & {
12642
+ declare type RegisteredEvent = BaseEvent_8 & {
12616
12643
  type: 'registered';
12617
12644
  };
12618
12645
 
@@ -13034,7 +13061,7 @@ declare type ServiceIdentifier = {
13034
13061
  * Generated on changes to a user’s local computer session.
13035
13062
  * @interface
13036
13063
  */
13037
- declare type SessionChangedEvent = BaseEvent_8 & {
13064
+ declare type SessionChangedEvent = BaseEvent_9 & {
13038
13065
  type: 'session-changed';
13039
13066
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13040
13067
  };
@@ -14968,7 +14995,7 @@ declare namespace SystemEvents {
14968
14995
  export {
14969
14996
  NotRequested,
14970
14997
  ExcludeRequested,
14971
- BaseEvent_8 as BaseEvent,
14998
+ BaseEvent_9 as BaseEvent,
14972
14999
  IdleStateChangedEvent,
14973
15000
  IdleEvent,
14974
15001
  MonitorInfoChangedEvent,
@@ -15446,7 +15473,7 @@ declare interface TypedEventEmitter<Event extends {
15446
15473
  * Generated when a hotkey has been unregistered with the operating system.
15447
15474
  * @interface
15448
15475
  */
15449
- declare type UnregisteredEvent = BaseEvent & {
15476
+ declare type UnregisteredEvent = BaseEvent_8 & {
15450
15477
  type: 'unregistered';
15451
15478
  };
15452
15479
 
@@ -871,7 +871,7 @@ declare type ApplicationConnectedEvent = ConnectedEvent_2;
871
871
  * Generated when an application is created.
872
872
  * @interface
873
873
  */
874
- declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
874
+ declare type ApplicationCreatedEvent = BaseEvent_9 & BaseEvents.IdentityEvent & {
875
875
  type: 'application-created';
876
876
  };
877
877
 
@@ -1738,13 +1738,30 @@ declare type BaseContentCreationRule = {
1738
1738
  /**
1739
1739
  * A base OpenFin event. All OpenFin event payloads extend this type.
1740
1740
  *
1741
+ * OpenFin events are jointly discriminated by their {@link topic} and {@link type} keys. Within each
1742
+ * `topic`, the `type` key is unique.
1743
+ *
1741
1744
  * @interface
1742
1745
  */
1743
1746
  declare type BaseEvent = {
1747
+ /**
1748
+ * The "kebab-case" classname of the {@link OpenFin.Events emitter} that raised the event.
1749
+ *
1750
+ * @remarks {@link OpenFin.Frame} is represented as `iframe`.
1751
+ */
1744
1752
  topic: string;
1753
+ /**
1754
+ * The type of event that was raised. Equal to the typename of the event payload in "kebab case".
1755
+ *
1756
+ * @remarks Guaranteed to be unique within each {@link topic}, but can be repeated
1757
+ * between topics (e.g. {@link OpenFin.WebContentsEvents.CrashedEvent WebContentsEvents.CrashedEvent} and
1758
+ * {@link OpenFin.ApplicationEvents.CrashedEvent ApplicationEvents.CrashedEvent}).
1759
+ */
1745
1760
  type: string;
1746
1761
  };
1747
1762
 
1763
+ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1764
+
1748
1765
  /**
1749
1766
  * A base Channel event.
1750
1767
  * @interface
@@ -1797,14 +1814,22 @@ declare type BaseEvent_7 = NamedEvent & {
1797
1814
  };
1798
1815
 
1799
1816
  /**
1800
- * Base type for events emitting on the `system` topic
1817
+ * Base type for events emitting on the `global-hotkey` topic.
1818
+ *
1801
1819
  * @interface
1802
1820
  */
1803
1821
  declare type BaseEvent_8 = BaseEvents.BaseEvent & {
1804
- topic: 'system';
1822
+ topic: 'global-hotkey';
1823
+ hotkey: string;
1805
1824
  };
1806
1825
 
1807
- declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
1826
+ /**
1827
+ * Base type for events emitting on the `system` topic
1828
+ * @interface
1829
+ */
1830
+ declare type BaseEvent_9 = BaseEvents.BaseEvent & {
1831
+ topic: 'system';
1832
+ };
1808
1833
 
1809
1834
  declare namespace BaseEvents {
1810
1835
  export {
@@ -4607,7 +4632,7 @@ declare interface DesktopAgent_2 {
4607
4632
  * Generated when the desktop icon is clicked while it's already running.
4608
4633
  * @interface
4609
4634
  */
4610
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4635
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4611
4636
  type: 'desktop-icon-clicked';
4612
4637
  };
4613
4638
 
@@ -5151,6 +5176,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5151
5176
 
5152
5177
  declare interface Environment {
5153
5178
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5179
+ applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
5154
5180
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5155
5181
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
5156
5182
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
@@ -5192,14 +5218,14 @@ declare type ErrorPlainObject = {
5192
5218
 
5193
5219
  /**
5194
5220
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}. Events are
5195
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5221
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5196
5222
  * under the {@link OpenFin.PlatformEvents} namespace.
5197
5223
  */
5198
5224
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5199
5225
 
5200
5226
  /**
5201
5227
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}. Events are
5202
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5228
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5203
5229
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5204
5230
  * from which they propagate).
5205
5231
  */
@@ -5207,7 +5233,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5207
5233
 
5208
5234
  /**
5209
5235
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
5210
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5236
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5211
5237
  * under the {@link OpenFin.ChannelEvents} namespace.
5212
5238
  */
5213
5239
  declare type Event_2 = {
@@ -5216,7 +5242,7 @@ declare type Event_2 = {
5216
5242
 
5217
5243
  /**
5218
5244
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}. Events are
5219
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5245
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5220
5246
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5221
5247
  * from which they propagate).
5222
5248
  */
@@ -5224,7 +5250,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5224
5250
 
5225
5251
  /**
5226
5252
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}. Events are
5227
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5253
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5228
5254
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5229
5255
  */
5230
5256
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5241,21 +5267,21 @@ declare type Event_5<Topic extends string> = {
5241
5267
 
5242
5268
  /**
5243
5269
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
5244
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5270
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5245
5271
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5246
5272
  */
5247
5273
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5248
5274
 
5249
5275
  /**
5250
5276
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}. Events are
5251
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5277
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5252
5278
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5253
5279
  */
5254
5280
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5255
5281
 
5256
5282
  /**
5257
5283
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}. Events are
5258
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5284
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5259
5285
  * under the {@link OpenFin.FrameEvents} namespace.
5260
5286
  */
5261
5287
  declare type Event_8 = {
@@ -5264,13 +5290,10 @@ declare type Event_8 = {
5264
5290
 
5265
5291
  /**
5266
5292
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}. Events are
5267
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5293
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5268
5294
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5269
5295
  */
5270
- declare type Event_9 = {
5271
- topic: 'global-hotkey';
5272
- hotkey: 'string';
5273
- } & (RegisteredEvent | UnregisteredEvent);
5296
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5274
5297
 
5275
5298
  declare class EventAggregator extends EmitterMap {
5276
5299
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6121,6 +6144,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6121
6144
 
6122
6145
  declare namespace GlobalHotkeyEvents {
6123
6146
  export {
6147
+ BaseEvent_8 as BaseEvent,
6124
6148
  RegisteredEvent,
6125
6149
  UnregisteredEvent,
6126
6150
  Event_9 as Event,
@@ -6608,7 +6632,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6608
6632
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6609
6633
  * @interface
6610
6634
  */
6611
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6635
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6612
6636
  type: 'idle-state-changed';
6613
6637
  elapsedTime: number;
6614
6638
  isIdle: boolean;
@@ -8660,16 +8684,17 @@ declare type LayoutIdentity = Identity_5 & {
8660
8684
  };
8661
8685
 
8662
8686
  /**
8663
- * Generated when the window is created, and all of its layout's views have either finished or failed
8664
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8687
+ * Generated after a layout is created and all of its views have either finished or failed navigation
8688
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
8665
8689
  * @interface
8666
8690
  */
8667
8691
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8668
8692
  type: 'layout-initialized';
8669
8693
  layoutIdentity: OpenFin.LayoutIdentity;
8670
- ofViews: (OpenFin.Identity & {
8694
+ ofViews: {
8695
+ identity: OpenFin.Identity;
8671
8696
  entityType: 'view';
8672
- })[];
8697
+ }[];
8673
8698
  };
8674
8699
 
8675
8700
  /**
@@ -9037,9 +9062,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9037
9062
  declare type LayoutReadyEvent = BaseEvent_5 & {
9038
9063
  type: 'layout-ready';
9039
9064
  layoutIdentity: OpenFin.LayoutIdentity;
9040
- views: (OpenFin.Identity & {
9065
+ views: {
9066
+ identity: OpenFin.Identity;
9041
9067
  success: boolean;
9042
- })[];
9068
+ error?: Error;
9069
+ }[];
9043
9070
  };
9044
9071
 
9045
9072
  /**
@@ -9415,7 +9442,7 @@ declare type MonitorInfo = {
9415
9442
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9416
9443
  * @interface
9417
9444
  */
9418
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9445
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9419
9446
  type: 'monitor-info-changed';
9420
9447
  };
9421
9448
 
@@ -10154,7 +10181,7 @@ declare namespace OpenFin {
10154
10181
  AppVersionCompleteEvent,
10155
10182
  AppVersionRuntimeStatusEvent,
10156
10183
  Events,
10157
- BaseEvent_9 as BaseEvent,
10184
+ BaseEvent_10 as BaseEvent,
10158
10185
  WebContentsEvent_2 as WebContentsEvent,
10159
10186
  SystemEvent_2 as SystemEvent,
10160
10187
  ApplicationEvent_2 as ApplicationEvent,
@@ -12612,7 +12639,7 @@ declare type RectangleByEdgePositions = {
12612
12639
  * Generated when a hotkey has been registered with the operating system.
12613
12640
  * @interface
12614
12641
  */
12615
- declare type RegisteredEvent = BaseEvent & {
12642
+ declare type RegisteredEvent = BaseEvent_8 & {
12616
12643
  type: 'registered';
12617
12644
  };
12618
12645
 
@@ -13034,7 +13061,7 @@ declare type ServiceIdentifier = {
13034
13061
  * Generated on changes to a user’s local computer session.
13035
13062
  * @interface
13036
13063
  */
13037
- declare type SessionChangedEvent = BaseEvent_8 & {
13064
+ declare type SessionChangedEvent = BaseEvent_9 & {
13038
13065
  type: 'session-changed';
13039
13066
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13040
13067
  };
@@ -14968,7 +14995,7 @@ declare namespace SystemEvents {
14968
14995
  export {
14969
14996
  NotRequested,
14970
14997
  ExcludeRequested,
14971
- BaseEvent_8 as BaseEvent,
14998
+ BaseEvent_9 as BaseEvent,
14972
14999
  IdleStateChangedEvent,
14973
15000
  IdleEvent,
14974
15001
  MonitorInfoChangedEvent,
@@ -15446,7 +15473,7 @@ declare interface TypedEventEmitter<Event extends {
15446
15473
  * Generated when a hotkey has been unregistered with the operating system.
15447
15474
  * @interface
15448
15475
  */
15449
- declare type UnregisteredEvent = BaseEvent & {
15476
+ declare type UnregisteredEvent = BaseEvent_8 & {
15450
15477
  type: 'unregistered';
15451
15478
  };
15452
15479
 
@@ -877,7 +877,7 @@ declare type ApplicationConnectedEvent = ConnectedEvent_2;
877
877
  * Generated when an application is created.
878
878
  * @interface
879
879
  */
880
- declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
880
+ declare type ApplicationCreatedEvent = BaseEvent_9 & BaseEvents.IdentityEvent & {
881
881
  type: 'application-created';
882
882
  };
883
883
 
@@ -1758,13 +1758,30 @@ declare type BaseContentCreationRule = {
1758
1758
  /**
1759
1759
  * A base OpenFin event. All OpenFin event payloads extend this type.
1760
1760
  *
1761
+ * OpenFin events are jointly discriminated by their {@link topic} and {@link type} keys. Within each
1762
+ * `topic`, the `type` key is unique.
1763
+ *
1761
1764
  * @interface
1762
1765
  */
1763
1766
  declare type BaseEvent = {
1767
+ /**
1768
+ * The "kebab-case" classname of the {@link OpenFin.Events emitter} that raised the event.
1769
+ *
1770
+ * @remarks {@link OpenFin.Frame} is represented as `iframe`.
1771
+ */
1764
1772
  topic: string;
1773
+ /**
1774
+ * The type of event that was raised. Equal to the typename of the event payload in "kebab case".
1775
+ *
1776
+ * @remarks Guaranteed to be unique within each {@link topic}, but can be repeated
1777
+ * between topics (e.g. {@link OpenFin.WebContentsEvents.CrashedEvent WebContentsEvents.CrashedEvent} and
1778
+ * {@link OpenFin.ApplicationEvents.CrashedEvent ApplicationEvents.CrashedEvent}).
1779
+ */
1765
1780
  type: string;
1766
1781
  };
1767
1782
 
1783
+ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1784
+
1768
1785
  /**
1769
1786
  * A base Channel event.
1770
1787
  * @interface
@@ -1817,14 +1834,22 @@ declare type BaseEvent_7 = NamedEvent & {
1817
1834
  };
1818
1835
 
1819
1836
  /**
1820
- * Base type for events emitting on the `system` topic
1837
+ * Base type for events emitting on the `global-hotkey` topic.
1838
+ *
1821
1839
  * @interface
1822
1840
  */
1823
1841
  declare type BaseEvent_8 = BaseEvents.BaseEvent & {
1824
- topic: 'system';
1842
+ topic: 'global-hotkey';
1843
+ hotkey: string;
1825
1844
  };
1826
1845
 
1827
- declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
1846
+ /**
1847
+ * Base type for events emitting on the `system` topic
1848
+ * @interface
1849
+ */
1850
+ declare type BaseEvent_9 = BaseEvents.BaseEvent & {
1851
+ topic: 'system';
1852
+ };
1828
1853
 
1829
1854
  declare namespace BaseEvents {
1830
1855
  export {
@@ -4650,7 +4675,7 @@ declare interface DesktopAgent_2 {
4650
4675
  * Generated when the desktop icon is clicked while it's already running.
4651
4676
  * @interface
4652
4677
  */
4653
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4678
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4654
4679
  type: 'desktop-icon-clicked';
4655
4680
  };
4656
4681
 
@@ -5199,6 +5224,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5199
5224
 
5200
5225
  declare interface Environment {
5201
5226
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5227
+ applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
5202
5228
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5203
5229
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
5204
5230
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
@@ -5240,14 +5266,14 @@ declare type ErrorPlainObject = {
5240
5266
 
5241
5267
  /**
5242
5268
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}. Events are
5243
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5269
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5244
5270
  * under the {@link OpenFin.PlatformEvents} namespace.
5245
5271
  */
5246
5272
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5247
5273
 
5248
5274
  /**
5249
5275
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}. Events are
5250
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5276
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5251
5277
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5252
5278
  * from which they propagate).
5253
5279
  */
@@ -5255,7 +5281,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5255
5281
 
5256
5282
  /**
5257
5283
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
5258
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5284
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5259
5285
  * under the {@link OpenFin.ChannelEvents} namespace.
5260
5286
  */
5261
5287
  declare type Event_2 = {
@@ -5264,7 +5290,7 @@ declare type Event_2 = {
5264
5290
 
5265
5291
  /**
5266
5292
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}. Events are
5267
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5293
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5268
5294
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5269
5295
  * from which they propagate).
5270
5296
  */
@@ -5272,7 +5298,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5272
5298
 
5273
5299
  /**
5274
5300
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}. Events are
5275
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5301
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5276
5302
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5277
5303
  */
5278
5304
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5289,21 +5315,21 @@ declare type Event_5<Topic extends string> = {
5289
5315
 
5290
5316
  /**
5291
5317
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
5292
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5318
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5293
5319
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5294
5320
  */
5295
5321
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5296
5322
 
5297
5323
  /**
5298
5324
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}. Events are
5299
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5325
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5300
5326
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5301
5327
  */
5302
5328
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5303
5329
 
5304
5330
  /**
5305
5331
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}. Events are
5306
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5332
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5307
5333
  * under the {@link OpenFin.FrameEvents} namespace.
5308
5334
  */
5309
5335
  declare type Event_8 = {
@@ -5312,13 +5338,10 @@ declare type Event_8 = {
5312
5338
 
5313
5339
  /**
5314
5340
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}. Events are
5315
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5341
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5316
5342
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5317
5343
  */
5318
- declare type Event_9 = {
5319
- topic: 'global-hotkey';
5320
- hotkey: 'string';
5321
- } & (RegisteredEvent | UnregisteredEvent);
5344
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5322
5345
 
5323
5346
  declare class EventAggregator extends EmitterMap {
5324
5347
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6196,6 +6219,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6196
6219
 
6197
6220
  declare namespace GlobalHotkeyEvents {
6198
6221
  export {
6222
+ BaseEvent_8 as BaseEvent,
6199
6223
  RegisteredEvent,
6200
6224
  UnregisteredEvent,
6201
6225
  Event_9 as Event,
@@ -6686,7 +6710,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6686
6710
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6687
6711
  * @interface
6688
6712
  */
6689
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6713
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6690
6714
  type: 'idle-state-changed';
6691
6715
  elapsedTime: number;
6692
6716
  isIdle: boolean;
@@ -8767,16 +8791,17 @@ declare type LayoutIdentity = Identity_5 & {
8767
8791
  };
8768
8792
 
8769
8793
  /**
8770
- * Generated when the window is created, and all of its layout's views have either finished or failed
8771
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8794
+ * Generated after a layout is created and all of its views have either finished or failed navigation
8795
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
8772
8796
  * @interface
8773
8797
  */
8774
8798
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8775
8799
  type: 'layout-initialized';
8776
8800
  layoutIdentity: OpenFin.LayoutIdentity;
8777
- ofViews: (OpenFin.Identity & {
8801
+ ofViews: {
8802
+ identity: OpenFin.Identity;
8778
8803
  entityType: 'view';
8779
- })[];
8804
+ }[];
8780
8805
  };
8781
8806
 
8782
8807
  /**
@@ -9314,9 +9339,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9314
9339
  declare type LayoutReadyEvent = BaseEvent_5 & {
9315
9340
  type: 'layout-ready';
9316
9341
  layoutIdentity: OpenFin.LayoutIdentity;
9317
- views: (OpenFin.Identity & {
9342
+ views: {
9343
+ identity: OpenFin.Identity;
9318
9344
  success: boolean;
9319
- })[];
9345
+ error?: Error;
9346
+ }[];
9320
9347
  };
9321
9348
 
9322
9349
  /**
@@ -9692,7 +9719,7 @@ declare type MonitorInfo = {
9692
9719
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9693
9720
  * @interface
9694
9721
  */
9695
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9722
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9696
9723
  type: 'monitor-info-changed';
9697
9724
  };
9698
9725
 
@@ -10453,7 +10480,7 @@ declare namespace OpenFin {
10453
10480
  AppVersionCompleteEvent,
10454
10481
  AppVersionRuntimeStatusEvent,
10455
10482
  Events,
10456
- BaseEvent_9 as BaseEvent,
10483
+ BaseEvent_10 as BaseEvent,
10457
10484
  WebContentsEvent_2 as WebContentsEvent,
10458
10485
  SystemEvent_2 as SystemEvent,
10459
10486
  ApplicationEvent_2 as ApplicationEvent,
@@ -12989,7 +13016,7 @@ declare type RectangleByEdgePositions = {
12989
13016
  * Generated when a hotkey has been registered with the operating system.
12990
13017
  * @interface
12991
13018
  */
12992
- declare type RegisteredEvent = BaseEvent & {
13019
+ declare type RegisteredEvent = BaseEvent_8 & {
12993
13020
  type: 'registered';
12994
13021
  };
12995
13022
 
@@ -13411,7 +13438,7 @@ declare type ServiceIdentifier = {
13411
13438
  * Generated on changes to a user’s local computer session.
13412
13439
  * @interface
13413
13440
  */
13414
- declare type SessionChangedEvent = BaseEvent_8 & {
13441
+ declare type SessionChangedEvent = BaseEvent_9 & {
13415
13442
  type: 'session-changed';
13416
13443
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13417
13444
  };
@@ -15351,7 +15378,7 @@ declare namespace SystemEvents {
15351
15378
  export {
15352
15379
  NotRequested,
15353
15380
  ExcludeRequested,
15354
- BaseEvent_8 as BaseEvent,
15381
+ BaseEvent_9 as BaseEvent,
15355
15382
  IdleStateChangedEvent,
15356
15383
  IdleEvent,
15357
15384
  MonitorInfoChangedEvent,
@@ -15437,7 +15464,7 @@ declare type SystemProcessInfo = {
15437
15464
  * Generated when system shutdown or log off.
15438
15465
  * @internal
15439
15466
  */
15440
- declare type SystemShutdownEvent = BaseEvent_8 & {
15467
+ declare type SystemShutdownEvent = BaseEvent_9 & {
15441
15468
  type: 'system-shutdown';
15442
15469
  };
15443
15470
 
@@ -15836,7 +15863,7 @@ declare interface TypedEventEmitter<Event extends {
15836
15863
  * Generated when a hotkey has been unregistered with the operating system.
15837
15864
  * @interface
15838
15865
  */
15839
- declare type UnregisteredEvent = BaseEvent & {
15866
+ declare type UnregisteredEvent = BaseEvent_8 & {
15840
15867
  type: 'unregistered';
15841
15868
  };
15842
15869
 
@@ -26,6 +26,9 @@ class BrowserEnvironment {
26
26
  initLayoutManager(fin, wire, options) {
27
27
  throw new Error('Method not implemented.');
28
28
  }
29
+ applyLayoutSnapshot(fin, lm, options) {
30
+ throw new Error('Method not implemented.');
31
+ }
29
32
  createLayout(lm, opts) {
30
33
  throw new Error('Method not implemented.');
31
34
  }
@@ -12390,24 +12393,16 @@ class LayoutModule extends base_1$5.Base {
12390
12393
  throw new Error('Layout.init was already called, please use Layout.create to add additional layouts.');
12391
12394
  }
12392
12395
  __classPrivateFieldSet$3(this, _LayoutModule_layoutInitializationAttempted, true, "f");
12396
+ // preload the client
12397
+ await this.fin.Platform.getCurrentSync().getClient();
12393
12398
  __classPrivateFieldSet$3(this, _LayoutModule_layoutManager, await this.wire.environment.initLayoutManager(this.fin, this.wire, options), "f");
12394
- // apply the initial snapshot which in turn will call fin.Platform.Layout.create()
12395
- const platformClient = await this.fin.Platform.getCurrentSync().getClient();
12396
- const snapshot = await platformClient.dispatch('get-initial-layout-snapshot');
12397
- await __classPrivateFieldGet$3(this, _LayoutModule_layoutManager, "f").applyLayoutSnapshot(snapshot);
12399
+ await this.wire.environment.applyLayoutSnapshot(this.fin, __classPrivateFieldGet$3(this, _LayoutModule_layoutManager, "f"), options);
12398
12400
  if (!options.layoutManagerOverride) {
12399
12401
  // in single-layout case, we return the undocumented layoutManager type (deprecate with CORE-1081)
12400
12402
  const layoutIdentity = { layoutName: layout_constants_1.DEFAULT_LAYOUT_KEY, ...this.fin.me.identity };
12401
12403
  const layoutManager = await this.wire.environment.resolveLayout(__classPrivateFieldGet$3(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
12402
12404
  return Object.assign(this.wrapSync(layoutIdentity), { layoutManager });
12403
12405
  }
12404
- // warn user if they do not call create() in the next 30 seconds
12405
- setTimeout(() => {
12406
- if (__classPrivateFieldGet$3(this, _LayoutModule_layoutManager, "f")?.size() === 0) {
12407
- console.warn(`[Layout.init] Layout.init was called 30s ago, but no layouts have been created yet. Make sure you ` +
12408
- `override LayoutManager.applyLayoutSnapshot, and then call fin.Platform.Layout.create()`);
12409
- }
12410
- }, 30000);
12411
12406
  return this.wrapSync(this.fin.me.identity);
12412
12407
  };
12413
12408
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/remote-adapter",
3
- "version": "36.79.9",
3
+ "version": "36.79.11",
4
4
  "description": "Establish intermachine runtime connections using webRTC.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,