@openfin/fdc3-api 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 {
@@ -4583,7 +4608,7 @@ declare interface DesktopAgent_2 {
4583
4608
  * Generated when the desktop icon is clicked while it's already running.
4584
4609
  * @interface
4585
4610
  */
4586
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4611
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4587
4612
  type: 'desktop-icon-clicked';
4588
4613
  };
4589
4614
 
@@ -5127,6 +5152,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5127
5152
 
5128
5153
  declare interface Environment {
5129
5154
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5155
+ applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
5130
5156
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5131
5157
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
5132
5158
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
@@ -5168,14 +5194,14 @@ declare type ErrorPlainObject = {
5168
5194
 
5169
5195
  /**
5170
5196
  * [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
5171
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5197
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5172
5198
  * under the {@link OpenFin.PlatformEvents} namespace.
5173
5199
  */
5174
5200
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5175
5201
 
5176
5202
  /**
5177
5203
  * [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
5178
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5204
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5179
5205
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5180
5206
  * from which they propagate).
5181
5207
  */
@@ -5183,7 +5209,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5183
5209
 
5184
5210
  /**
5185
5211
  * [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
5186
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5212
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5187
5213
  * under the {@link OpenFin.ChannelEvents} namespace.
5188
5214
  */
5189
5215
  declare type Event_2 = {
@@ -5192,7 +5218,7 @@ declare type Event_2 = {
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 an {@link Application}. Events are
5195
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5221
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5196
5222
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5197
5223
  * from which they propagate).
5198
5224
  */
@@ -5200,7 +5226,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5200
5226
 
5201
5227
  /**
5202
5228
  * [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
5203
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5229
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5204
5230
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5205
5231
  */
5206
5232
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5217,21 +5243,21 @@ declare type Event_5<Topic extends string> = {
5217
5243
 
5218
5244
  /**
5219
5245
  * [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
5220
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5246
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5221
5247
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5222
5248
  */
5223
5249
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
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 an {@link ExternalApplication}. Events are
5227
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5253
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5228
5254
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5229
5255
  */
5230
5256
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5231
5257
 
5232
5258
  /**
5233
5259
  * [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
5234
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5260
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5235
5261
  * under the {@link OpenFin.FrameEvents} namespace.
5236
5262
  */
5237
5263
  declare type Event_8 = {
@@ -5240,13 +5266,10 @@ declare type Event_8 = {
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 {@link GlobalHotkey}. Events are
5243
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5269
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5244
5270
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5245
5271
  */
5246
- declare type Event_9 = {
5247
- topic: 'global-hotkey';
5248
- hotkey: 'string';
5249
- } & (RegisteredEvent | UnregisteredEvent);
5272
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5250
5273
 
5251
5274
  declare class EventAggregator extends EmitterMap {
5252
5275
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6433,6 +6456,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6433
6456
 
6434
6457
  declare namespace GlobalHotkeyEvents {
6435
6458
  export {
6459
+ BaseEvent_8 as BaseEvent,
6436
6460
  RegisteredEvent,
6437
6461
  UnregisteredEvent,
6438
6462
  Event_9 as Event,
@@ -6920,7 +6944,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6920
6944
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6921
6945
  * @interface
6922
6946
  */
6923
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6947
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6924
6948
  type: 'idle-state-changed';
6925
6949
  elapsedTime: number;
6926
6950
  isIdle: boolean;
@@ -8951,16 +8975,17 @@ declare type LayoutIdentity = Identity_5 & {
8951
8975
  };
8952
8976
 
8953
8977
  /**
8954
- * Generated when the window is created, and all of its layout's views have either finished or failed
8955
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8978
+ * Generated after a layout is created and all of its views have either finished or failed navigation
8979
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
8956
8980
  * @interface
8957
8981
  */
8958
8982
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8959
8983
  type: 'layout-initialized';
8960
8984
  layoutIdentity: OpenFin.LayoutIdentity;
8961
- ofViews: (OpenFin.Identity & {
8985
+ ofViews: {
8986
+ identity: OpenFin.Identity;
8962
8987
  entityType: 'view';
8963
- })[];
8988
+ }[];
8964
8989
  };
8965
8990
 
8966
8991
  /**
@@ -9328,9 +9353,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9328
9353
  declare type LayoutReadyEvent = BaseEvent_5 & {
9329
9354
  type: 'layout-ready';
9330
9355
  layoutIdentity: OpenFin.LayoutIdentity;
9331
- views: (OpenFin.Identity & {
9356
+ views: {
9357
+ identity: OpenFin.Identity;
9332
9358
  success: boolean;
9333
- })[];
9359
+ error?: Error;
9360
+ }[];
9334
9361
  };
9335
9362
 
9336
9363
  /**
@@ -9706,7 +9733,7 @@ declare type MonitorInfo = {
9706
9733
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9707
9734
  * @interface
9708
9735
  */
9709
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9736
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9710
9737
  type: 'monitor-info-changed';
9711
9738
  };
9712
9739
 
@@ -10445,7 +10472,7 @@ declare namespace OpenFin {
10445
10472
  AppVersionCompleteEvent,
10446
10473
  AppVersionRuntimeStatusEvent,
10447
10474
  Events,
10448
- BaseEvent_9 as BaseEvent,
10475
+ BaseEvent_10 as BaseEvent,
10449
10476
  WebContentsEvent_2 as WebContentsEvent,
10450
10477
  SystemEvent_2 as SystemEvent,
10451
10478
  ApplicationEvent_2 as ApplicationEvent,
@@ -12903,7 +12930,7 @@ declare type RectangleByEdgePositions = {
12903
12930
  * Generated when a hotkey has been registered with the operating system.
12904
12931
  * @interface
12905
12932
  */
12906
- declare type RegisteredEvent = BaseEvent & {
12933
+ declare type RegisteredEvent = BaseEvent_8 & {
12907
12934
  type: 'registered';
12908
12935
  };
12909
12936
 
@@ -13325,7 +13352,7 @@ declare type ServiceIdentifier = {
13325
13352
  * Generated on changes to a user’s local computer session.
13326
13353
  * @interface
13327
13354
  */
13328
- declare type SessionChangedEvent = BaseEvent_8 & {
13355
+ declare type SessionChangedEvent = BaseEvent_9 & {
13329
13356
  type: 'session-changed';
13330
13357
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13331
13358
  };
@@ -15259,7 +15286,7 @@ declare namespace SystemEvents {
15259
15286
  export {
15260
15287
  NotRequested,
15261
15288
  ExcludeRequested,
15262
- BaseEvent_8 as BaseEvent,
15289
+ BaseEvent_9 as BaseEvent,
15263
15290
  IdleStateChangedEvent,
15264
15291
  IdleEvent,
15265
15292
  MonitorInfoChangedEvent,
@@ -15737,7 +15764,7 @@ declare interface TypedEventEmitter<Event extends {
15737
15764
  * Generated when a hotkey has been unregistered with the operating system.
15738
15765
  * @interface
15739
15766
  */
15740
- declare type UnregisteredEvent = BaseEvent & {
15767
+ declare type UnregisteredEvent = BaseEvent_8 & {
15741
15768
  type: 'unregistered';
15742
15769
  };
15743
15770
 
@@ -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 {
@@ -4583,7 +4608,7 @@ declare interface DesktopAgent_2 {
4583
4608
  * Generated when the desktop icon is clicked while it's already running.
4584
4609
  * @interface
4585
4610
  */
4586
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4611
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4587
4612
  type: 'desktop-icon-clicked';
4588
4613
  };
4589
4614
 
@@ -5127,6 +5152,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5127
5152
 
5128
5153
  declare interface Environment {
5129
5154
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5155
+ applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
5130
5156
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5131
5157
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
5132
5158
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
@@ -5168,14 +5194,14 @@ declare type ErrorPlainObject = {
5168
5194
 
5169
5195
  /**
5170
5196
  * [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
5171
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5197
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5172
5198
  * under the {@link OpenFin.PlatformEvents} namespace.
5173
5199
  */
5174
5200
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5175
5201
 
5176
5202
  /**
5177
5203
  * [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
5178
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5204
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5179
5205
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5180
5206
  * from which they propagate).
5181
5207
  */
@@ -5183,7 +5209,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5183
5209
 
5184
5210
  /**
5185
5211
  * [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
5186
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5212
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5187
5213
  * under the {@link OpenFin.ChannelEvents} namespace.
5188
5214
  */
5189
5215
  declare type Event_2 = {
@@ -5192,7 +5218,7 @@ declare type Event_2 = {
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 an {@link Application}. Events are
5195
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5221
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5196
5222
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5197
5223
  * from which they propagate).
5198
5224
  */
@@ -5200,7 +5226,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5200
5226
 
5201
5227
  /**
5202
5228
  * [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
5203
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5229
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5204
5230
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5205
5231
  */
5206
5232
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5217,21 +5243,21 @@ declare type Event_5<Topic extends string> = {
5217
5243
 
5218
5244
  /**
5219
5245
  * [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
5220
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5246
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5221
5247
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5222
5248
  */
5223
5249
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
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 an {@link ExternalApplication}. Events are
5227
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5253
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5228
5254
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5229
5255
  */
5230
5256
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5231
5257
 
5232
5258
  /**
5233
5259
  * [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
5234
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5260
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5235
5261
  * under the {@link OpenFin.FrameEvents} namespace.
5236
5262
  */
5237
5263
  declare type Event_8 = {
@@ -5240,13 +5266,10 @@ declare type Event_8 = {
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 {@link GlobalHotkey}. Events are
5243
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5269
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5244
5270
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5245
5271
  */
5246
- declare type Event_9 = {
5247
- topic: 'global-hotkey';
5248
- hotkey: 'string';
5249
- } & (RegisteredEvent | UnregisteredEvent);
5272
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5250
5273
 
5251
5274
  declare class EventAggregator extends EmitterMap {
5252
5275
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6433,6 +6456,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6433
6456
 
6434
6457
  declare namespace GlobalHotkeyEvents {
6435
6458
  export {
6459
+ BaseEvent_8 as BaseEvent,
6436
6460
  RegisteredEvent,
6437
6461
  UnregisteredEvent,
6438
6462
  Event_9 as Event,
@@ -6920,7 +6944,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6920
6944
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6921
6945
  * @interface
6922
6946
  */
6923
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6947
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6924
6948
  type: 'idle-state-changed';
6925
6949
  elapsedTime: number;
6926
6950
  isIdle: boolean;
@@ -8951,16 +8975,17 @@ declare type LayoutIdentity = Identity_5 & {
8951
8975
  };
8952
8976
 
8953
8977
  /**
8954
- * Generated when the window is created, and all of its layout's views have either finished or failed
8955
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8978
+ * Generated after a layout is created and all of its views have either finished or failed navigation
8979
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
8956
8980
  * @interface
8957
8981
  */
8958
8982
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8959
8983
  type: 'layout-initialized';
8960
8984
  layoutIdentity: OpenFin.LayoutIdentity;
8961
- ofViews: (OpenFin.Identity & {
8985
+ ofViews: {
8986
+ identity: OpenFin.Identity;
8962
8987
  entityType: 'view';
8963
- })[];
8988
+ }[];
8964
8989
  };
8965
8990
 
8966
8991
  /**
@@ -9328,9 +9353,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9328
9353
  declare type LayoutReadyEvent = BaseEvent_5 & {
9329
9354
  type: 'layout-ready';
9330
9355
  layoutIdentity: OpenFin.LayoutIdentity;
9331
- views: (OpenFin.Identity & {
9356
+ views: {
9357
+ identity: OpenFin.Identity;
9332
9358
  success: boolean;
9333
- })[];
9359
+ error?: Error;
9360
+ }[];
9334
9361
  };
9335
9362
 
9336
9363
  /**
@@ -9706,7 +9733,7 @@ declare type MonitorInfo = {
9706
9733
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9707
9734
  * @interface
9708
9735
  */
9709
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9736
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9710
9737
  type: 'monitor-info-changed';
9711
9738
  };
9712
9739
 
@@ -10445,7 +10472,7 @@ declare namespace OpenFin {
10445
10472
  AppVersionCompleteEvent,
10446
10473
  AppVersionRuntimeStatusEvent,
10447
10474
  Events,
10448
- BaseEvent_9 as BaseEvent,
10475
+ BaseEvent_10 as BaseEvent,
10449
10476
  WebContentsEvent_2 as WebContentsEvent,
10450
10477
  SystemEvent_2 as SystemEvent,
10451
10478
  ApplicationEvent_2 as ApplicationEvent,
@@ -12903,7 +12930,7 @@ declare type RectangleByEdgePositions = {
12903
12930
  * Generated when a hotkey has been registered with the operating system.
12904
12931
  * @interface
12905
12932
  */
12906
- declare type RegisteredEvent = BaseEvent & {
12933
+ declare type RegisteredEvent = BaseEvent_8 & {
12907
12934
  type: 'registered';
12908
12935
  };
12909
12936
 
@@ -13325,7 +13352,7 @@ declare type ServiceIdentifier = {
13325
13352
  * Generated on changes to a user’s local computer session.
13326
13353
  * @interface
13327
13354
  */
13328
- declare type SessionChangedEvent = BaseEvent_8 & {
13355
+ declare type SessionChangedEvent = BaseEvent_9 & {
13329
13356
  type: 'session-changed';
13330
13357
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13331
13358
  };
@@ -15259,7 +15286,7 @@ declare namespace SystemEvents {
15259
15286
  export {
15260
15287
  NotRequested,
15261
15288
  ExcludeRequested,
15262
- BaseEvent_8 as BaseEvent,
15289
+ BaseEvent_9 as BaseEvent,
15263
15290
  IdleStateChangedEvent,
15264
15291
  IdleEvent,
15265
15292
  MonitorInfoChangedEvent,
@@ -15737,7 +15764,7 @@ declare interface TypedEventEmitter<Event extends {
15737
15764
  * Generated when a hotkey has been unregistered with the operating system.
15738
15765
  * @interface
15739
15766
  */
15740
- declare type UnregisteredEvent = BaseEvent & {
15767
+ declare type UnregisteredEvent = BaseEvent_8 & {
15741
15768
  type: 'unregistered';
15742
15769
  };
15743
15770
 
@@ -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 {
@@ -4583,7 +4608,7 @@ declare interface DesktopAgent_2 {
4583
4608
  * Generated when the desktop icon is clicked while it's already running.
4584
4609
  * @interface
4585
4610
  */
4586
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4611
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4587
4612
  type: 'desktop-icon-clicked';
4588
4613
  };
4589
4614
 
@@ -5127,6 +5152,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5127
5152
 
5128
5153
  declare interface Environment {
5129
5154
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5155
+ applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
5130
5156
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5131
5157
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
5132
5158
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
@@ -5168,14 +5194,14 @@ declare type ErrorPlainObject = {
5168
5194
 
5169
5195
  /**
5170
5196
  * [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
5171
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5197
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5172
5198
  * under the {@link OpenFin.PlatformEvents} namespace.
5173
5199
  */
5174
5200
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5175
5201
 
5176
5202
  /**
5177
5203
  * [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
5178
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5204
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5179
5205
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5180
5206
  * from which they propagate).
5181
5207
  */
@@ -5183,7 +5209,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5183
5209
 
5184
5210
  /**
5185
5211
  * [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
5186
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5212
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5187
5213
  * under the {@link OpenFin.ChannelEvents} namespace.
5188
5214
  */
5189
5215
  declare type Event_2 = {
@@ -5192,7 +5218,7 @@ declare type Event_2 = {
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 an {@link Application}. Events are
5195
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5221
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5196
5222
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5197
5223
  * from which they propagate).
5198
5224
  */
@@ -5200,7 +5226,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5200
5226
 
5201
5227
  /**
5202
5228
  * [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
5203
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5229
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5204
5230
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5205
5231
  */
5206
5232
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5217,21 +5243,21 @@ declare type Event_5<Topic extends string> = {
5217
5243
 
5218
5244
  /**
5219
5245
  * [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
5220
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5246
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5221
5247
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5222
5248
  */
5223
5249
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
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 an {@link ExternalApplication}. Events are
5227
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5253
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5228
5254
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5229
5255
  */
5230
5256
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5231
5257
 
5232
5258
  /**
5233
5259
  * [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
5234
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5260
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5235
5261
  * under the {@link OpenFin.FrameEvents} namespace.
5236
5262
  */
5237
5263
  declare type Event_8 = {
@@ -5240,13 +5266,10 @@ declare type Event_8 = {
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 {@link GlobalHotkey}. Events are
5243
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5269
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5244
5270
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5245
5271
  */
5246
- declare type Event_9 = {
5247
- topic: 'global-hotkey';
5248
- hotkey: 'string';
5249
- } & (RegisteredEvent | UnregisteredEvent);
5272
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5250
5273
 
5251
5274
  declare class EventAggregator extends EmitterMap {
5252
5275
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6433,6 +6456,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6433
6456
 
6434
6457
  declare namespace GlobalHotkeyEvents {
6435
6458
  export {
6459
+ BaseEvent_8 as BaseEvent,
6436
6460
  RegisteredEvent,
6437
6461
  UnregisteredEvent,
6438
6462
  Event_9 as Event,
@@ -6920,7 +6944,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6920
6944
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6921
6945
  * @interface
6922
6946
  */
6923
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6947
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6924
6948
  type: 'idle-state-changed';
6925
6949
  elapsedTime: number;
6926
6950
  isIdle: boolean;
@@ -8951,16 +8975,17 @@ declare type LayoutIdentity = Identity_5 & {
8951
8975
  };
8952
8976
 
8953
8977
  /**
8954
- * Generated when the window is created, and all of its layout's views have either finished or failed
8955
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8978
+ * Generated after a layout is created and all of its views have either finished or failed navigation
8979
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
8956
8980
  * @interface
8957
8981
  */
8958
8982
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8959
8983
  type: 'layout-initialized';
8960
8984
  layoutIdentity: OpenFin.LayoutIdentity;
8961
- ofViews: (OpenFin.Identity & {
8985
+ ofViews: {
8986
+ identity: OpenFin.Identity;
8962
8987
  entityType: 'view';
8963
- })[];
8988
+ }[];
8964
8989
  };
8965
8990
 
8966
8991
  /**
@@ -9328,9 +9353,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9328
9353
  declare type LayoutReadyEvent = BaseEvent_5 & {
9329
9354
  type: 'layout-ready';
9330
9355
  layoutIdentity: OpenFin.LayoutIdentity;
9331
- views: (OpenFin.Identity & {
9356
+ views: {
9357
+ identity: OpenFin.Identity;
9332
9358
  success: boolean;
9333
- })[];
9359
+ error?: Error;
9360
+ }[];
9334
9361
  };
9335
9362
 
9336
9363
  /**
@@ -9706,7 +9733,7 @@ declare type MonitorInfo = {
9706
9733
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9707
9734
  * @interface
9708
9735
  */
9709
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9736
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9710
9737
  type: 'monitor-info-changed';
9711
9738
  };
9712
9739
 
@@ -10445,7 +10472,7 @@ declare namespace OpenFin {
10445
10472
  AppVersionCompleteEvent,
10446
10473
  AppVersionRuntimeStatusEvent,
10447
10474
  Events,
10448
- BaseEvent_9 as BaseEvent,
10475
+ BaseEvent_10 as BaseEvent,
10449
10476
  WebContentsEvent_2 as WebContentsEvent,
10450
10477
  SystemEvent_2 as SystemEvent,
10451
10478
  ApplicationEvent_2 as ApplicationEvent,
@@ -12903,7 +12930,7 @@ declare type RectangleByEdgePositions = {
12903
12930
  * Generated when a hotkey has been registered with the operating system.
12904
12931
  * @interface
12905
12932
  */
12906
- declare type RegisteredEvent = BaseEvent & {
12933
+ declare type RegisteredEvent = BaseEvent_8 & {
12907
12934
  type: 'registered';
12908
12935
  };
12909
12936
 
@@ -13325,7 +13352,7 @@ declare type ServiceIdentifier = {
13325
13352
  * Generated on changes to a user’s local computer session.
13326
13353
  * @interface
13327
13354
  */
13328
- declare type SessionChangedEvent = BaseEvent_8 & {
13355
+ declare type SessionChangedEvent = BaseEvent_9 & {
13329
13356
  type: 'session-changed';
13330
13357
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13331
13358
  };
@@ -15259,7 +15286,7 @@ declare namespace SystemEvents {
15259
15286
  export {
15260
15287
  NotRequested,
15261
15288
  ExcludeRequested,
15262
- BaseEvent_8 as BaseEvent,
15289
+ BaseEvent_9 as BaseEvent,
15263
15290
  IdleStateChangedEvent,
15264
15291
  IdleEvent,
15265
15292
  MonitorInfoChangedEvent,
@@ -15737,7 +15764,7 @@ declare interface TypedEventEmitter<Event extends {
15737
15764
  * Generated when a hotkey has been unregistered with the operating system.
15738
15765
  * @interface
15739
15766
  */
15740
- declare type UnregisteredEvent = BaseEvent & {
15767
+ declare type UnregisteredEvent = BaseEvent_8 & {
15741
15768
  type: 'unregistered';
15742
15769
  };
15743
15770
 
package/out/fdc3-api.d.ts CHANGED
@@ -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 {
@@ -4626,7 +4651,7 @@ declare interface DesktopAgent_2 {
4626
4651
  * Generated when the desktop icon is clicked while it's already running.
4627
4652
  * @interface
4628
4653
  */
4629
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4654
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4630
4655
  type: 'desktop-icon-clicked';
4631
4656
  };
4632
4657
 
@@ -5175,6 +5200,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5175
5200
 
5176
5201
  declare interface Environment {
5177
5202
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5203
+ applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
5178
5204
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5179
5205
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
5180
5206
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
@@ -5216,14 +5242,14 @@ declare type ErrorPlainObject = {
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 a {@link Platform}. Events are
5219
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5245
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5220
5246
  * under the {@link OpenFin.PlatformEvents} namespace.
5221
5247
  */
5222
5248
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5223
5249
 
5224
5250
  /**
5225
5251
  * [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
5226
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5252
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5227
5253
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5228
5254
  * from which they propagate).
5229
5255
  */
@@ -5231,7 +5257,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5231
5257
 
5232
5258
  /**
5233
5259
  * [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
5234
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5260
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5235
5261
  * under the {@link OpenFin.ChannelEvents} namespace.
5236
5262
  */
5237
5263
  declare type Event_2 = {
@@ -5240,7 +5266,7 @@ declare type Event_2 = {
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 an {@link Application}. Events are
5243
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5269
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5244
5270
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5245
5271
  * from which they propagate).
5246
5272
  */
@@ -5248,7 +5274,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
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 a {@link View}. Events are
5251
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5277
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5252
5278
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5253
5279
  */
5254
5280
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5265,21 +5291,21 @@ declare type Event_5<Topic extends string> = {
5265
5291
 
5266
5292
  /**
5267
5293
  * [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
5268
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5294
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5269
5295
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5270
5296
  */
5271
5297
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
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 an {@link ExternalApplication}. Events are
5275
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5301
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5276
5302
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5277
5303
  */
5278
5304
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5279
5305
 
5280
5306
  /**
5281
5307
  * [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
5282
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5308
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5283
5309
  * under the {@link OpenFin.FrameEvents} namespace.
5284
5310
  */
5285
5311
  declare type Event_8 = {
@@ -5288,13 +5314,10 @@ declare type Event_8 = {
5288
5314
 
5289
5315
  /**
5290
5316
  * [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
5291
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5317
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5292
5318
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5293
5319
  */
5294
- declare type Event_9 = {
5295
- topic: 'global-hotkey';
5296
- hotkey: 'string';
5297
- } & (RegisteredEvent | UnregisteredEvent);
5320
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5298
5321
 
5299
5322
  declare class EventAggregator extends EmitterMap {
5300
5323
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6508,6 +6531,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6508
6531
 
6509
6532
  declare namespace GlobalHotkeyEvents {
6510
6533
  export {
6534
+ BaseEvent_8 as BaseEvent,
6511
6535
  RegisteredEvent,
6512
6536
  UnregisteredEvent,
6513
6537
  Event_9 as Event,
@@ -6998,7 +7022,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6998
7022
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6999
7023
  * @interface
7000
7024
  */
7001
- declare type IdleStateChangedEvent = BaseEvent_8 & {
7025
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
7002
7026
  type: 'idle-state-changed';
7003
7027
  elapsedTime: number;
7004
7028
  isIdle: boolean;
@@ -9058,16 +9082,17 @@ declare type LayoutIdentity = Identity_5 & {
9058
9082
  };
9059
9083
 
9060
9084
  /**
9061
- * Generated when the window is created, and all of its layout's views have either finished or failed
9062
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
9085
+ * Generated after a layout is created and all of its views have either finished or failed navigation
9086
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
9063
9087
  * @interface
9064
9088
  */
9065
9089
  declare type LayoutInitializedEvent = BaseEvent_5 & {
9066
9090
  type: 'layout-initialized';
9067
9091
  layoutIdentity: OpenFin.LayoutIdentity;
9068
- ofViews: (OpenFin.Identity & {
9092
+ ofViews: {
9093
+ identity: OpenFin.Identity;
9069
9094
  entityType: 'view';
9070
- })[];
9095
+ }[];
9071
9096
  };
9072
9097
 
9073
9098
  /**
@@ -9605,9 +9630,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9605
9630
  declare type LayoutReadyEvent = BaseEvent_5 & {
9606
9631
  type: 'layout-ready';
9607
9632
  layoutIdentity: OpenFin.LayoutIdentity;
9608
- views: (OpenFin.Identity & {
9633
+ views: {
9634
+ identity: OpenFin.Identity;
9609
9635
  success: boolean;
9610
- })[];
9636
+ error?: Error;
9637
+ }[];
9611
9638
  };
9612
9639
 
9613
9640
  /**
@@ -9983,7 +10010,7 @@ declare type MonitorInfo = {
9983
10010
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9984
10011
  * @interface
9985
10012
  */
9986
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
10013
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9987
10014
  type: 'monitor-info-changed';
9988
10015
  };
9989
10016
 
@@ -10744,7 +10771,7 @@ declare namespace OpenFin {
10744
10771
  AppVersionCompleteEvent,
10745
10772
  AppVersionRuntimeStatusEvent,
10746
10773
  Events,
10747
- BaseEvent_9 as BaseEvent,
10774
+ BaseEvent_10 as BaseEvent,
10748
10775
  WebContentsEvent_2 as WebContentsEvent,
10749
10776
  SystemEvent_2 as SystemEvent,
10750
10777
  ApplicationEvent_2 as ApplicationEvent,
@@ -13280,7 +13307,7 @@ declare type RectangleByEdgePositions = {
13280
13307
  * Generated when a hotkey has been registered with the operating system.
13281
13308
  * @interface
13282
13309
  */
13283
- declare type RegisteredEvent = BaseEvent & {
13310
+ declare type RegisteredEvent = BaseEvent_8 & {
13284
13311
  type: 'registered';
13285
13312
  };
13286
13313
 
@@ -13702,7 +13729,7 @@ declare type ServiceIdentifier = {
13702
13729
  * Generated on changes to a user’s local computer session.
13703
13730
  * @interface
13704
13731
  */
13705
- declare type SessionChangedEvent = BaseEvent_8 & {
13732
+ declare type SessionChangedEvent = BaseEvent_9 & {
13706
13733
  type: 'session-changed';
13707
13734
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13708
13735
  };
@@ -15642,7 +15669,7 @@ declare namespace SystemEvents {
15642
15669
  export {
15643
15670
  NotRequested,
15644
15671
  ExcludeRequested,
15645
- BaseEvent_8 as BaseEvent,
15672
+ BaseEvent_9 as BaseEvent,
15646
15673
  IdleStateChangedEvent,
15647
15674
  IdleEvent,
15648
15675
  MonitorInfoChangedEvent,
@@ -15728,7 +15755,7 @@ declare type SystemProcessInfo = {
15728
15755
  * Generated when system shutdown or log off.
15729
15756
  * @internal
15730
15757
  */
15731
- declare type SystemShutdownEvent = BaseEvent_8 & {
15758
+ declare type SystemShutdownEvent = BaseEvent_9 & {
15732
15759
  type: 'system-shutdown';
15733
15760
  };
15734
15761
 
@@ -16127,7 +16154,7 @@ declare interface TypedEventEmitter<Event extends {
16127
16154
  * Generated when a hotkey has been unregistered with the operating system.
16128
16155
  * @interface
16129
16156
  */
16130
- declare type UnregisteredEvent = BaseEvent & {
16157
+ declare type UnregisteredEvent = BaseEvent_8 & {
16131
16158
  type: 'unregistered';
16132
16159
  };
16133
16160
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "36.79.9",
3
+ "version": "36.79.10",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.MD",
6
6
  "private": false,