@openfin/node-adapter 36.79.9 → 36.79.10

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 {
@@ -4587,7 +4612,7 @@ declare interface DesktopAgent_2 {
4587
4612
  * Generated when the desktop icon is clicked while it's already running.
4588
4613
  * @interface
4589
4614
  */
4590
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4615
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4591
4616
  type: 'desktop-icon-clicked';
4592
4617
  };
4593
4618
 
@@ -5131,6 +5156,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5131
5156
 
5132
5157
  declare interface Environment {
5133
5158
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5159
+ applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
5134
5160
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5135
5161
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
5136
5162
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
@@ -5172,14 +5198,14 @@ declare type ErrorPlainObject = {
5172
5198
 
5173
5199
  /**
5174
5200
  * [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
5175
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5201
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5176
5202
  * under the {@link OpenFin.PlatformEvents} namespace.
5177
5203
  */
5178
5204
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5179
5205
 
5180
5206
  /**
5181
5207
  * [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
5182
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5208
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5183
5209
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5184
5210
  * from which they propagate).
5185
5211
  */
@@ -5187,7 +5213,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5187
5213
 
5188
5214
  /**
5189
5215
  * [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
5190
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5216
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5191
5217
  * under the {@link OpenFin.ChannelEvents} namespace.
5192
5218
  */
5193
5219
  declare type Event_2 = {
@@ -5196,7 +5222,7 @@ declare type Event_2 = {
5196
5222
 
5197
5223
  /**
5198
5224
  * [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
5199
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5225
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5200
5226
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5201
5227
  * from which they propagate).
5202
5228
  */
@@ -5204,7 +5230,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5204
5230
 
5205
5231
  /**
5206
5232
  * [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
5207
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5233
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5208
5234
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5209
5235
  */
5210
5236
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5221,21 +5247,21 @@ declare type Event_5<Topic extends string> = {
5221
5247
 
5222
5248
  /**
5223
5249
  * [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
5224
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5250
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5225
5251
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5226
5252
  */
5227
5253
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5228
5254
 
5229
5255
  /**
5230
5256
  * [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
5231
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5257
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5232
5258
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5233
5259
  */
5234
5260
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5235
5261
 
5236
5262
  /**
5237
5263
  * [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
5238
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5264
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5239
5265
  * under the {@link OpenFin.FrameEvents} namespace.
5240
5266
  */
5241
5267
  declare type Event_8 = {
@@ -5244,13 +5270,10 @@ declare type Event_8 = {
5244
5270
 
5245
5271
  /**
5246
5272
  * [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
5247
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5273
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5248
5274
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5249
5275
  */
5250
- declare type Event_9 = {
5251
- topic: 'global-hotkey';
5252
- hotkey: 'string';
5253
- } & (RegisteredEvent | UnregisteredEvent);
5276
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5254
5277
 
5255
5278
  declare class EventAggregator extends EmitterMap {
5256
5279
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6107,6 +6130,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6107
6130
 
6108
6131
  declare namespace GlobalHotkeyEvents {
6109
6132
  export {
6133
+ BaseEvent_8 as BaseEvent,
6110
6134
  RegisteredEvent,
6111
6135
  UnregisteredEvent,
6112
6136
  Event_9 as Event,
@@ -6594,7 +6618,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6594
6618
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6595
6619
  * @interface
6596
6620
  */
6597
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6621
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6598
6622
  type: 'idle-state-changed';
6599
6623
  elapsedTime: number;
6600
6624
  isIdle: boolean;
@@ -8627,16 +8651,17 @@ declare type LayoutIdentity = Identity_5 & {
8627
8651
  };
8628
8652
 
8629
8653
  /**
8630
- * Generated when the window is created, and all of its layout's views have either finished or failed
8631
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8654
+ * Generated after a layout is created and all of its views have either finished or failed navigation
8655
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
8632
8656
  * @interface
8633
8657
  */
8634
8658
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8635
8659
  type: 'layout-initialized';
8636
8660
  layoutIdentity: OpenFin.LayoutIdentity;
8637
- ofViews: (OpenFin.Identity & {
8661
+ ofViews: {
8662
+ identity: OpenFin.Identity;
8638
8663
  entityType: 'view';
8639
- })[];
8664
+ }[];
8640
8665
  };
8641
8666
 
8642
8667
  /**
@@ -9004,9 +9029,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9004
9029
  declare type LayoutReadyEvent = BaseEvent_5 & {
9005
9030
  type: 'layout-ready';
9006
9031
  layoutIdentity: OpenFin.LayoutIdentity;
9007
- views: (OpenFin.Identity & {
9032
+ views: {
9033
+ identity: OpenFin.Identity;
9008
9034
  success: boolean;
9009
- })[];
9035
+ error?: Error;
9036
+ }[];
9010
9037
  };
9011
9038
 
9012
9039
  /**
@@ -9382,7 +9409,7 @@ declare type MonitorInfo = {
9382
9409
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9383
9410
  * @interface
9384
9411
  */
9385
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9412
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9386
9413
  type: 'monitor-info-changed';
9387
9414
  };
9388
9415
 
@@ -10121,7 +10148,7 @@ declare namespace OpenFin {
10121
10148
  AppVersionCompleteEvent,
10122
10149
  AppVersionRuntimeStatusEvent,
10123
10150
  Events,
10124
- BaseEvent_9 as BaseEvent,
10151
+ BaseEvent_10 as BaseEvent,
10125
10152
  WebContentsEvent_2 as WebContentsEvent,
10126
10153
  SystemEvent_2 as SystemEvent,
10127
10154
  ApplicationEvent_2 as ApplicationEvent,
@@ -12580,7 +12607,7 @@ declare type RectangleByEdgePositions = {
12580
12607
  * Generated when a hotkey has been registered with the operating system.
12581
12608
  * @interface
12582
12609
  */
12583
- declare type RegisteredEvent = BaseEvent & {
12610
+ declare type RegisteredEvent = BaseEvent_8 & {
12584
12611
  type: 'registered';
12585
12612
  };
12586
12613
 
@@ -13002,7 +13029,7 @@ declare type ServiceIdentifier = {
13002
13029
  * Generated on changes to a user’s local computer session.
13003
13030
  * @interface
13004
13031
  */
13005
- declare type SessionChangedEvent = BaseEvent_8 & {
13032
+ declare type SessionChangedEvent = BaseEvent_9 & {
13006
13033
  type: 'session-changed';
13007
13034
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13008
13035
  };
@@ -14936,7 +14963,7 @@ declare namespace SystemEvents {
14936
14963
  export {
14937
14964
  NotRequested,
14938
14965
  ExcludeRequested,
14939
- BaseEvent_8 as BaseEvent,
14966
+ BaseEvent_9 as BaseEvent,
14940
14967
  IdleStateChangedEvent,
14941
14968
  IdleEvent,
14942
14969
  MonitorInfoChangedEvent,
@@ -15414,7 +15441,7 @@ declare interface TypedEventEmitter<Event extends {
15414
15441
  * Generated when a hotkey has been unregistered with the operating system.
15415
15442
  * @interface
15416
15443
  */
15417
- declare type UnregisteredEvent = BaseEvent & {
15444
+ declare type UnregisteredEvent = BaseEvent_8 & {
15418
15445
  type: 'unregistered';
15419
15446
  };
15420
15447
 
@@ -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 {
@@ -4587,7 +4612,7 @@ declare interface DesktopAgent_2 {
4587
4612
  * Generated when the desktop icon is clicked while it's already running.
4588
4613
  * @interface
4589
4614
  */
4590
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4615
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4591
4616
  type: 'desktop-icon-clicked';
4592
4617
  };
4593
4618
 
@@ -5131,6 +5156,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5131
5156
 
5132
5157
  declare interface Environment {
5133
5158
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5159
+ applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
5134
5160
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5135
5161
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
5136
5162
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
@@ -5172,14 +5198,14 @@ declare type ErrorPlainObject = {
5172
5198
 
5173
5199
  /**
5174
5200
  * [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
5175
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5201
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5176
5202
  * under the {@link OpenFin.PlatformEvents} namespace.
5177
5203
  */
5178
5204
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5179
5205
 
5180
5206
  /**
5181
5207
  * [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
5182
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5208
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5183
5209
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5184
5210
  * from which they propagate).
5185
5211
  */
@@ -5187,7 +5213,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5187
5213
 
5188
5214
  /**
5189
5215
  * [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
5190
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5216
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5191
5217
  * under the {@link OpenFin.ChannelEvents} namespace.
5192
5218
  */
5193
5219
  declare type Event_2 = {
@@ -5196,7 +5222,7 @@ declare type Event_2 = {
5196
5222
 
5197
5223
  /**
5198
5224
  * [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
5199
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5225
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5200
5226
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5201
5227
  * from which they propagate).
5202
5228
  */
@@ -5204,7 +5230,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5204
5230
 
5205
5231
  /**
5206
5232
  * [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
5207
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5233
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5208
5234
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5209
5235
  */
5210
5236
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5221,21 +5247,21 @@ declare type Event_5<Topic extends string> = {
5221
5247
 
5222
5248
  /**
5223
5249
  * [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
5224
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5250
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5225
5251
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5226
5252
  */
5227
5253
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5228
5254
 
5229
5255
  /**
5230
5256
  * [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
5231
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5257
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5232
5258
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5233
5259
  */
5234
5260
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5235
5261
 
5236
5262
  /**
5237
5263
  * [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
5238
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5264
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5239
5265
  * under the {@link OpenFin.FrameEvents} namespace.
5240
5266
  */
5241
5267
  declare type Event_8 = {
@@ -5244,13 +5270,10 @@ declare type Event_8 = {
5244
5270
 
5245
5271
  /**
5246
5272
  * [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
5247
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5273
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5248
5274
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5249
5275
  */
5250
- declare type Event_9 = {
5251
- topic: 'global-hotkey';
5252
- hotkey: 'string';
5253
- } & (RegisteredEvent | UnregisteredEvent);
5276
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5254
5277
 
5255
5278
  declare class EventAggregator extends EmitterMap {
5256
5279
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6107,6 +6130,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6107
6130
 
6108
6131
  declare namespace GlobalHotkeyEvents {
6109
6132
  export {
6133
+ BaseEvent_8 as BaseEvent,
6110
6134
  RegisteredEvent,
6111
6135
  UnregisteredEvent,
6112
6136
  Event_9 as Event,
@@ -6594,7 +6618,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6594
6618
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6595
6619
  * @interface
6596
6620
  */
6597
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6621
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6598
6622
  type: 'idle-state-changed';
6599
6623
  elapsedTime: number;
6600
6624
  isIdle: boolean;
@@ -8627,16 +8651,17 @@ declare type LayoutIdentity = Identity_5 & {
8627
8651
  };
8628
8652
 
8629
8653
  /**
8630
- * Generated when the window is created, and all of its layout's views have either finished or failed
8631
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8654
+ * Generated after a layout is created and all of its views have either finished or failed navigation
8655
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
8632
8656
  * @interface
8633
8657
  */
8634
8658
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8635
8659
  type: 'layout-initialized';
8636
8660
  layoutIdentity: OpenFin.LayoutIdentity;
8637
- ofViews: (OpenFin.Identity & {
8661
+ ofViews: {
8662
+ identity: OpenFin.Identity;
8638
8663
  entityType: 'view';
8639
- })[];
8664
+ }[];
8640
8665
  };
8641
8666
 
8642
8667
  /**
@@ -9004,9 +9029,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9004
9029
  declare type LayoutReadyEvent = BaseEvent_5 & {
9005
9030
  type: 'layout-ready';
9006
9031
  layoutIdentity: OpenFin.LayoutIdentity;
9007
- views: (OpenFin.Identity & {
9032
+ views: {
9033
+ identity: OpenFin.Identity;
9008
9034
  success: boolean;
9009
- })[];
9035
+ error?: Error;
9036
+ }[];
9010
9037
  };
9011
9038
 
9012
9039
  /**
@@ -9382,7 +9409,7 @@ declare type MonitorInfo = {
9382
9409
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9383
9410
  * @interface
9384
9411
  */
9385
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9412
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9386
9413
  type: 'monitor-info-changed';
9387
9414
  };
9388
9415
 
@@ -10121,7 +10148,7 @@ declare namespace OpenFin {
10121
10148
  AppVersionCompleteEvent,
10122
10149
  AppVersionRuntimeStatusEvent,
10123
10150
  Events,
10124
- BaseEvent_9 as BaseEvent,
10151
+ BaseEvent_10 as BaseEvent,
10125
10152
  WebContentsEvent_2 as WebContentsEvent,
10126
10153
  SystemEvent_2 as SystemEvent,
10127
10154
  ApplicationEvent_2 as ApplicationEvent,
@@ -12580,7 +12607,7 @@ declare type RectangleByEdgePositions = {
12580
12607
  * Generated when a hotkey has been registered with the operating system.
12581
12608
  * @interface
12582
12609
  */
12583
- declare type RegisteredEvent = BaseEvent & {
12610
+ declare type RegisteredEvent = BaseEvent_8 & {
12584
12611
  type: 'registered';
12585
12612
  };
12586
12613
 
@@ -13002,7 +13029,7 @@ declare type ServiceIdentifier = {
13002
13029
  * Generated on changes to a user’s local computer session.
13003
13030
  * @interface
13004
13031
  */
13005
- declare type SessionChangedEvent = BaseEvent_8 & {
13032
+ declare type SessionChangedEvent = BaseEvent_9 & {
13006
13033
  type: 'session-changed';
13007
13034
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13008
13035
  };
@@ -14936,7 +14963,7 @@ declare namespace SystemEvents {
14936
14963
  export {
14937
14964
  NotRequested,
14938
14965
  ExcludeRequested,
14939
- BaseEvent_8 as BaseEvent,
14966
+ BaseEvent_9 as BaseEvent,
14940
14967
  IdleStateChangedEvent,
14941
14968
  IdleEvent,
14942
14969
  MonitorInfoChangedEvent,
@@ -15414,7 +15441,7 @@ declare interface TypedEventEmitter<Event extends {
15414
15441
  * Generated when a hotkey has been unregistered with the operating system.
15415
15442
  * @interface
15416
15443
  */
15417
- declare type UnregisteredEvent = BaseEvent & {
15444
+ declare type UnregisteredEvent = BaseEvent_8 & {
15418
15445
  type: 'unregistered';
15419
15446
  };
15420
15447
 
@@ -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 {
@@ -4587,7 +4612,7 @@ declare interface DesktopAgent_2 {
4587
4612
  * Generated when the desktop icon is clicked while it's already running.
4588
4613
  * @interface
4589
4614
  */
4590
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4615
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4591
4616
  type: 'desktop-icon-clicked';
4592
4617
  };
4593
4618
 
@@ -5131,6 +5156,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5131
5156
 
5132
5157
  declare interface Environment {
5133
5158
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5159
+ applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
5134
5160
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5135
5161
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
5136
5162
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
@@ -5172,14 +5198,14 @@ declare type ErrorPlainObject = {
5172
5198
 
5173
5199
  /**
5174
5200
  * [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
5175
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5201
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5176
5202
  * under the {@link OpenFin.PlatformEvents} namespace.
5177
5203
  */
5178
5204
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5179
5205
 
5180
5206
  /**
5181
5207
  * [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
5182
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5208
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5183
5209
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5184
5210
  * from which they propagate).
5185
5211
  */
@@ -5187,7 +5213,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5187
5213
 
5188
5214
  /**
5189
5215
  * [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
5190
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5216
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5191
5217
  * under the {@link OpenFin.ChannelEvents} namespace.
5192
5218
  */
5193
5219
  declare type Event_2 = {
@@ -5196,7 +5222,7 @@ declare type Event_2 = {
5196
5222
 
5197
5223
  /**
5198
5224
  * [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
5199
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5225
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5200
5226
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5201
5227
  * from which they propagate).
5202
5228
  */
@@ -5204,7 +5230,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5204
5230
 
5205
5231
  /**
5206
5232
  * [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
5207
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5233
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5208
5234
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5209
5235
  */
5210
5236
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5221,21 +5247,21 @@ declare type Event_5<Topic extends string> = {
5221
5247
 
5222
5248
  /**
5223
5249
  * [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
5224
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5250
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5225
5251
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5226
5252
  */
5227
5253
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5228
5254
 
5229
5255
  /**
5230
5256
  * [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
5231
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5257
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5232
5258
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5233
5259
  */
5234
5260
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5235
5261
 
5236
5262
  /**
5237
5263
  * [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
5238
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5264
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5239
5265
  * under the {@link OpenFin.FrameEvents} namespace.
5240
5266
  */
5241
5267
  declare type Event_8 = {
@@ -5244,13 +5270,10 @@ declare type Event_8 = {
5244
5270
 
5245
5271
  /**
5246
5272
  * [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
5247
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5273
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5248
5274
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5249
5275
  */
5250
- declare type Event_9 = {
5251
- topic: 'global-hotkey';
5252
- hotkey: 'string';
5253
- } & (RegisteredEvent | UnregisteredEvent);
5276
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5254
5277
 
5255
5278
  declare class EventAggregator extends EmitterMap {
5256
5279
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6107,6 +6130,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6107
6130
 
6108
6131
  declare namespace GlobalHotkeyEvents {
6109
6132
  export {
6133
+ BaseEvent_8 as BaseEvent,
6110
6134
  RegisteredEvent,
6111
6135
  UnregisteredEvent,
6112
6136
  Event_9 as Event,
@@ -6594,7 +6618,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6594
6618
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6595
6619
  * @interface
6596
6620
  */
6597
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6621
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6598
6622
  type: 'idle-state-changed';
6599
6623
  elapsedTime: number;
6600
6624
  isIdle: boolean;
@@ -8627,16 +8651,17 @@ declare type LayoutIdentity = Identity_5 & {
8627
8651
  };
8628
8652
 
8629
8653
  /**
8630
- * Generated when the window is created, and all of its layout's views have either finished or failed
8631
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8654
+ * Generated after a layout is created and all of its views have either finished or failed navigation
8655
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
8632
8656
  * @interface
8633
8657
  */
8634
8658
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8635
8659
  type: 'layout-initialized';
8636
8660
  layoutIdentity: OpenFin.LayoutIdentity;
8637
- ofViews: (OpenFin.Identity & {
8661
+ ofViews: {
8662
+ identity: OpenFin.Identity;
8638
8663
  entityType: 'view';
8639
- })[];
8664
+ }[];
8640
8665
  };
8641
8666
 
8642
8667
  /**
@@ -9004,9 +9029,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9004
9029
  declare type LayoutReadyEvent = BaseEvent_5 & {
9005
9030
  type: 'layout-ready';
9006
9031
  layoutIdentity: OpenFin.LayoutIdentity;
9007
- views: (OpenFin.Identity & {
9032
+ views: {
9033
+ identity: OpenFin.Identity;
9008
9034
  success: boolean;
9009
- })[];
9035
+ error?: Error;
9036
+ }[];
9010
9037
  };
9011
9038
 
9012
9039
  /**
@@ -9382,7 +9409,7 @@ declare type MonitorInfo = {
9382
9409
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9383
9410
  * @interface
9384
9411
  */
9385
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9412
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9386
9413
  type: 'monitor-info-changed';
9387
9414
  };
9388
9415
 
@@ -10121,7 +10148,7 @@ declare namespace OpenFin {
10121
10148
  AppVersionCompleteEvent,
10122
10149
  AppVersionRuntimeStatusEvent,
10123
10150
  Events,
10124
- BaseEvent_9 as BaseEvent,
10151
+ BaseEvent_10 as BaseEvent,
10125
10152
  WebContentsEvent_2 as WebContentsEvent,
10126
10153
  SystemEvent_2 as SystemEvent,
10127
10154
  ApplicationEvent_2 as ApplicationEvent,
@@ -12580,7 +12607,7 @@ declare type RectangleByEdgePositions = {
12580
12607
  * Generated when a hotkey has been registered with the operating system.
12581
12608
  * @interface
12582
12609
  */
12583
- declare type RegisteredEvent = BaseEvent & {
12610
+ declare type RegisteredEvent = BaseEvent_8 & {
12584
12611
  type: 'registered';
12585
12612
  };
12586
12613
 
@@ -13002,7 +13029,7 @@ declare type ServiceIdentifier = {
13002
13029
  * Generated on changes to a user’s local computer session.
13003
13030
  * @interface
13004
13031
  */
13005
- declare type SessionChangedEvent = BaseEvent_8 & {
13032
+ declare type SessionChangedEvent = BaseEvent_9 & {
13006
13033
  type: 'session-changed';
13007
13034
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13008
13035
  };
@@ -14936,7 +14963,7 @@ declare namespace SystemEvents {
14936
14963
  export {
14937
14964
  NotRequested,
14938
14965
  ExcludeRequested,
14939
- BaseEvent_8 as BaseEvent,
14966
+ BaseEvent_9 as BaseEvent,
14940
14967
  IdleStateChangedEvent,
14941
14968
  IdleEvent,
14942
14969
  MonitorInfoChangedEvent,
@@ -15414,7 +15441,7 @@ declare interface TypedEventEmitter<Event extends {
15414
15441
  * Generated when a hotkey has been unregistered with the operating system.
15415
15442
  * @interface
15416
15443
  */
15417
- declare type UnregisteredEvent = BaseEvent & {
15444
+ declare type UnregisteredEvent = BaseEvent_8 & {
15418
15445
  type: 'unregistered';
15419
15446
  };
15420
15447
 
@@ -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 {
@@ -4630,7 +4655,7 @@ declare interface DesktopAgent_2 {
4630
4655
  * Generated when the desktop icon is clicked while it's already running.
4631
4656
  * @interface
4632
4657
  */
4633
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4658
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4634
4659
  type: 'desktop-icon-clicked';
4635
4660
  };
4636
4661
 
@@ -5179,6 +5204,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5179
5204
 
5180
5205
  declare interface Environment {
5181
5206
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5207
+ applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
5182
5208
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5183
5209
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
5184
5210
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
@@ -5220,14 +5246,14 @@ declare type ErrorPlainObject = {
5220
5246
 
5221
5247
  /**
5222
5248
  * [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
5223
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5249
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5224
5250
  * under the {@link OpenFin.PlatformEvents} namespace.
5225
5251
  */
5226
5252
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5227
5253
 
5228
5254
  /**
5229
5255
  * [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
5230
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5256
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5231
5257
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5232
5258
  * from which they propagate).
5233
5259
  */
@@ -5235,7 +5261,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5235
5261
 
5236
5262
  /**
5237
5263
  * [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
5238
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5264
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5239
5265
  * under the {@link OpenFin.ChannelEvents} namespace.
5240
5266
  */
5241
5267
  declare type Event_2 = {
@@ -5244,7 +5270,7 @@ declare type Event_2 = {
5244
5270
 
5245
5271
  /**
5246
5272
  * [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
5247
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5273
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5248
5274
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5249
5275
  * from which they propagate).
5250
5276
  */
@@ -5252,7 +5278,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5252
5278
 
5253
5279
  /**
5254
5280
  * [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
5255
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5281
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5256
5282
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5257
5283
  */
5258
5284
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5269,21 +5295,21 @@ declare type Event_5<Topic extends string> = {
5269
5295
 
5270
5296
  /**
5271
5297
  * [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
5272
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5298
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5273
5299
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5274
5300
  */
5275
5301
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5276
5302
 
5277
5303
  /**
5278
5304
  * [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
5279
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5305
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5280
5306
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5281
5307
  */
5282
5308
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5283
5309
 
5284
5310
  /**
5285
5311
  * [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
5286
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5312
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5287
5313
  * under the {@link OpenFin.FrameEvents} namespace.
5288
5314
  */
5289
5315
  declare type Event_8 = {
@@ -5292,13 +5318,10 @@ declare type Event_8 = {
5292
5318
 
5293
5319
  /**
5294
5320
  * [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
5295
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5321
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5296
5322
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5297
5323
  */
5298
- declare type Event_9 = {
5299
- topic: 'global-hotkey';
5300
- hotkey: 'string';
5301
- } & (RegisteredEvent | UnregisteredEvent);
5324
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5302
5325
 
5303
5326
  declare class EventAggregator extends EmitterMap {
5304
5327
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6204,6 +6227,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6204
6227
 
6205
6228
  declare namespace GlobalHotkeyEvents {
6206
6229
  export {
6230
+ BaseEvent_8 as BaseEvent,
6207
6231
  RegisteredEvent,
6208
6232
  UnregisteredEvent,
6209
6233
  Event_9 as Event,
@@ -6694,7 +6718,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6694
6718
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6695
6719
  * @interface
6696
6720
  */
6697
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6721
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6698
6722
  type: 'idle-state-changed';
6699
6723
  elapsedTime: number;
6700
6724
  isIdle: boolean;
@@ -8756,16 +8780,17 @@ declare type LayoutIdentity = Identity_5 & {
8756
8780
  };
8757
8781
 
8758
8782
  /**
8759
- * Generated when the window is created, and all of its layout's views have either finished or failed
8760
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8783
+ * Generated after a layout is created and all of its views have either finished or failed navigation
8784
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
8761
8785
  * @interface
8762
8786
  */
8763
8787
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8764
8788
  type: 'layout-initialized';
8765
8789
  layoutIdentity: OpenFin.LayoutIdentity;
8766
- ofViews: (OpenFin.Identity & {
8790
+ ofViews: {
8791
+ identity: OpenFin.Identity;
8767
8792
  entityType: 'view';
8768
- })[];
8793
+ }[];
8769
8794
  };
8770
8795
 
8771
8796
  /**
@@ -9303,9 +9328,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9303
9328
  declare type LayoutReadyEvent = BaseEvent_5 & {
9304
9329
  type: 'layout-ready';
9305
9330
  layoutIdentity: OpenFin.LayoutIdentity;
9306
- views: (OpenFin.Identity & {
9331
+ views: {
9332
+ identity: OpenFin.Identity;
9307
9333
  success: boolean;
9308
- })[];
9334
+ error?: Error;
9335
+ }[];
9309
9336
  };
9310
9337
 
9311
9338
  /**
@@ -9681,7 +9708,7 @@ declare type MonitorInfo = {
9681
9708
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9682
9709
  * @interface
9683
9710
  */
9684
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9711
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9685
9712
  type: 'monitor-info-changed';
9686
9713
  };
9687
9714
 
@@ -10442,7 +10469,7 @@ declare namespace OpenFin {
10442
10469
  AppVersionCompleteEvent,
10443
10470
  AppVersionRuntimeStatusEvent,
10444
10471
  Events,
10445
- BaseEvent_9 as BaseEvent,
10472
+ BaseEvent_10 as BaseEvent,
10446
10473
  WebContentsEvent_2 as WebContentsEvent,
10447
10474
  SystemEvent_2 as SystemEvent,
10448
10475
  ApplicationEvent_2 as ApplicationEvent,
@@ -12979,7 +13006,7 @@ declare type RectangleByEdgePositions = {
12979
13006
  * Generated when a hotkey has been registered with the operating system.
12980
13007
  * @interface
12981
13008
  */
12982
- declare type RegisteredEvent = BaseEvent & {
13009
+ declare type RegisteredEvent = BaseEvent_8 & {
12983
13010
  type: 'registered';
12984
13011
  };
12985
13012
 
@@ -13401,7 +13428,7 @@ declare type ServiceIdentifier = {
13401
13428
  * Generated on changes to a user’s local computer session.
13402
13429
  * @interface
13403
13430
  */
13404
- declare type SessionChangedEvent = BaseEvent_8 & {
13431
+ declare type SessionChangedEvent = BaseEvent_9 & {
13405
13432
  type: 'session-changed';
13406
13433
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13407
13434
  };
@@ -15341,7 +15368,7 @@ declare namespace SystemEvents {
15341
15368
  export {
15342
15369
  NotRequested,
15343
15370
  ExcludeRequested,
15344
- BaseEvent_8 as BaseEvent,
15371
+ BaseEvent_9 as BaseEvent,
15345
15372
  IdleStateChangedEvent,
15346
15373
  IdleEvent,
15347
15374
  MonitorInfoChangedEvent,
@@ -15427,7 +15454,7 @@ declare type SystemProcessInfo = {
15427
15454
  * Generated when system shutdown or log off.
15428
15455
  * @internal
15429
15456
  */
15430
- declare type SystemShutdownEvent = BaseEvent_8 & {
15457
+ declare type SystemShutdownEvent = BaseEvent_9 & {
15431
15458
  type: 'system-shutdown';
15432
15459
  };
15433
15460
 
@@ -15826,7 +15853,7 @@ declare interface TypedEventEmitter<Event extends {
15826
15853
  * Generated when a hotkey has been unregistered with the operating system.
15827
15854
  * @interface
15828
15855
  */
15829
- declare type UnregisteredEvent = BaseEvent & {
15856
+ declare type UnregisteredEvent = BaseEvent_8 & {
15830
15857
  type: 'unregistered';
15831
15858
  };
15832
15859
 
@@ -11799,24 +11799,16 @@ class LayoutModule extends base_1$5.Base {
11799
11799
  throw new Error('Layout.init was already called, please use Layout.create to add additional layouts.');
11800
11800
  }
11801
11801
  __classPrivateFieldSet$4(this, _LayoutModule_layoutInitializationAttempted, true, "f");
11802
+ // preload the client
11803
+ await this.fin.Platform.getCurrentSync().getClient();
11802
11804
  __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayoutManager(this.fin, this.wire, options), "f");
11803
- // apply the initial snapshot which in turn will call fin.Platform.Layout.create()
11804
- const platformClient = await this.fin.Platform.getCurrentSync().getClient();
11805
- const snapshot = await platformClient.dispatch('get-initial-layout-snapshot');
11806
- await __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").applyLayoutSnapshot(snapshot);
11805
+ await this.wire.environment.applyLayoutSnapshot(this.fin, __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), options);
11807
11806
  if (!options.layoutManagerOverride) {
11808
11807
  // in single-layout case, we return the undocumented layoutManager type (deprecate with CORE-1081)
11809
11808
  const layoutIdentity = { layoutName: layout_constants_1.DEFAULT_LAYOUT_KEY, ...this.fin.me.identity };
11810
11809
  const layoutManager = await this.wire.environment.resolveLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
11811
11810
  return Object.assign(this.wrapSync(layoutIdentity), { layoutManager });
11812
11811
  }
11813
- // warn user if they do not call create() in the next 30 seconds
11814
- setTimeout(() => {
11815
- if (__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f")?.size() === 0) {
11816
- console.warn(`[Layout.init] Layout.init was called 30s ago, but no layouts have been created yet. Make sure you ` +
11817
- `override LayoutManager.applyLayoutSnapshot, and then call fin.Platform.Layout.create()`);
11818
- }
11819
- }, 30000);
11820
11812
  return this.wrapSync(this.fin.me.identity);
11821
11813
  };
11822
11814
  /**
@@ -16253,6 +16245,9 @@ function requireNodeEnv () {
16253
16245
  async initLayoutManager() {
16254
16246
  throw new Error('Method not implemented.');
16255
16247
  }
16248
+ async applyLayoutSnapshot() {
16249
+ throw new Error('Method not implemented.');
16250
+ }
16256
16251
  async createLayout() {
16257
16252
  throw new Error('Method not implemented.');
16258
16253
  }
@@ -16824,6 +16819,16 @@ Object.defineProperty(frame, "__esModule", { value: true });
16824
16819
 
16825
16820
  var globalHotkey = {};
16826
16821
 
16822
+ /**
16823
+ *
16824
+ * Namespace for events that can be transmitted by {@link GlobalHotkey.GlobalHotkey}.
16825
+ *
16826
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
16827
+ *
16828
+ * For a list of valid string keys for global hotkey events, see {@link GlobalHotkey.GlobalHotkey.on GlobalHotkey.on}.
16829
+ *
16830
+ * @packageDocumentation
16831
+ */
16827
16832
  Object.defineProperty(globalHotkey, "__esModule", { value: true });
16828
16833
 
16829
16834
  var platform = {};
@@ -16888,12 +16893,9 @@ var webcontents = {};
16888
16893
  * Namespace for events shared by all OpenFin WebContents elements (i.e. {@link OpenFin.Window},
16889
16894
  * {@link OpenFin.View}).
16890
16895
  *
16891
- * WebContents events are divided into two groups: {@link WillPropagateWebContentsEvent} and {@link NonPropagatedWebContentsEvent}. Propagating events
16892
- * will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
16896
+ * WebContents events will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
16893
16897
  * parent window, and propagating events in a window will also be emitted on the window's parent {@link OpenFin.Application}.
16894
16898
  *
16895
- * Non-propagating events will not re-emit on parent entities.
16896
- *
16897
16899
  * @packageDocumentation
16898
16900
  */
16899
16901
  Object.defineProperty(webcontents, "__esModule", { value: true });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/node-adapter",
3
- "version": "36.79.9",
3
+ "version": "36.79.10",
4
4
  "description": "See README.md",
5
5
  "main": "out/node-adapter.js",
6
6
  "types": "out/node-adapter.d.ts",