@openfin/core 35.78.1 → 35.78.5

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.
package/out/mock.d.ts CHANGED
@@ -64,7 +64,7 @@ declare type AddViewToStackOptions = {
64
64
  * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
65
65
  * @interface
66
66
  */
67
- declare type AlertRequestedEvent = BaseWindowEvent & {
67
+ declare type AlertRequestedEvent = BaseEvent_5 & {
68
68
  type: 'alert-requested';
69
69
  message: string;
70
70
  url: string;
@@ -105,6 +105,15 @@ declare type ApiClient<T extends Record<any, any>> = {
105
105
  [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
106
106
  };
107
107
 
108
+ /**
109
+ * Generated when a new Platform's API becomes responsive.
110
+ * @interface
111
+ */
112
+ declare type ApiReadyEvent = BaseEvent & {
113
+ topic: 'application';
114
+ type: 'platform-api-ready';
115
+ };
116
+
108
117
  /**
109
118
  * @interface
110
119
  */
@@ -862,19 +871,15 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
862
871
  }
863
872
 
864
873
  /**
865
- * Generated when an application has authenticated and is connected.
866
- * @interface
874
+ * @deprecated Renamed to {@link ConnectedEvent}.
867
875
  */
868
- declare type ApplicationConnectedEvent = IdentityEvent & {
869
- topic: 'application';
870
- type: 'connected';
871
- };
876
+ declare type ApplicationConnectedEvent = ConnectedEvent_2;
872
877
 
873
878
  /**
874
879
  * Generated when an application is created.
875
880
  * @interface
876
881
  */
877
- declare type ApplicationCreatedEvent = BaseSystemEvent & IdentityEvent & {
882
+ declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
878
883
  type: 'application-created';
879
884
  };
880
885
 
@@ -898,17 +903,15 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
898
903
  };
899
904
 
900
905
  /**
901
- * [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
902
- * discriminated by {@link ApplicationEvent.type | their type}. Event payloads unique to `Application` can be found
903
- * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
904
- * from which they propagate).
906
+ * @deprecated Renamed to {@link Event}.
905
907
  */
906
- declare type ApplicationEvent = PropagatedViewEvent<'application'> | PropagatedWindowEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
908
+ declare type ApplicationEvent = Event_3;
907
909
 
908
910
  declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
909
911
 
910
912
  declare namespace ApplicationEvents {
911
913
  export {
914
+ BaseEvent_3 as BaseEvent,
912
915
  BaseApplicationEvent,
913
916
  CrashedEvent,
914
917
  FileDownloadLocationChangedEvent,
@@ -922,6 +925,7 @@ declare namespace ApplicationEvents {
922
925
  WindowStartLoadEvent,
923
926
  ApplicationWindowEvent,
924
927
  ClosedEvent,
928
+ ConnectedEvent_2 as ConnectedEvent,
925
929
  ApplicationConnectedEvent,
926
930
  InitializedEvent,
927
931
  ManifestChangedEvent,
@@ -929,19 +933,23 @@ declare namespace ApplicationEvents {
929
933
  RespondingEvent,
930
934
  StartedEvent,
931
935
  ApplicationSourcedEvent,
936
+ Event_3 as Event,
932
937
  ApplicationEvent,
938
+ EventType_3 as EventType,
933
939
  ApplicationEventType,
940
+ PropagatedEvent_4 as PropagatedEvent,
934
941
  PropagatedApplicationEvent,
942
+ PropagatedEventType_3 as PropagatedEventType,
935
943
  PropagatedApplicationEventType,
936
- Payload_2 as Payload,
937
- ByType
944
+ Payload_4 as Payload,
945
+ ByType_3 as ByType
938
946
  }
939
947
  }
940
948
 
941
949
  /**
942
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
950
+ * @deprecated Renamed to {@link EventType}.
943
951
  */
944
- declare type ApplicationEventType = ApplicationEvent['type'];
952
+ declare type ApplicationEventType = EventType_3;
945
953
 
946
954
  declare type ApplicationIdentity = OpenFin_2.ApplicationIdentity;
947
955
 
@@ -1294,9 +1302,8 @@ declare type ApplicationPermissions = {
1294
1302
  * A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
1295
1303
  * from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
1296
1304
  * does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
1297
- *
1298
1305
  */
1299
- declare type ApplicationSourcedEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1306
+ declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1300
1307
 
1301
1308
  declare type ApplicationState = OpenFin_2.ApplicationState;
1302
1309
 
@@ -1612,7 +1619,7 @@ declare interface AuthorizationPayload {
1612
1619
  * ```
1613
1620
  * @interface
1614
1621
  */
1615
- declare type AuthRequestedEvent = BaseWindowEvent & {
1622
+ declare type AuthRequestedEvent = BaseEvent_5 & {
1616
1623
  type: 'auth-requested';
1617
1624
  authInfo: {
1618
1625
  host: string;
@@ -1680,21 +1687,9 @@ declare class Base {
1680
1687
  }
1681
1688
 
1682
1689
  /**
1683
- * Base type for events emitting on the `application` topic
1684
- * @interface
1690
+ * @deprecated Renamed to {@link BaseEvent}.
1685
1691
  */
1686
- declare type BaseApplicationEvent = NamedEvent & {
1687
- topic: `application`;
1688
- };
1689
-
1690
- /**
1691
- * A base Channel event.
1692
- * @interface
1693
- */
1694
- declare type BaseChannelEvent = NamedEvent & {
1695
- channelName: string;
1696
- channelId: string;
1697
- };
1692
+ declare type BaseApplicationEvent = BaseEvent_3;
1698
1693
 
1699
1694
  /**
1700
1695
  * @interface
@@ -1763,10 +1758,70 @@ declare type BaseEvent = {
1763
1758
  type: string;
1764
1759
  };
1765
1760
 
1766
- declare type BaseEvent_2 = Events.BaseEvents.BaseEvent;
1761
+ /**
1762
+ * A base Channel event.
1763
+ * @interface
1764
+ */
1765
+ declare type BaseEvent_2 = NamedEvent & {
1766
+ channelName: string;
1767
+ channelId: string;
1768
+ };
1769
+
1770
+ /**
1771
+ * Base type for events emitting on the `application` topic
1772
+ * @interface
1773
+ */
1774
+ declare type BaseEvent_3 = BaseEvents.NamedEvent & {
1775
+ topic: `application`;
1776
+ };
1777
+
1778
+ /**
1779
+ * Base type for events emitting on the `view` topic
1780
+ * @interface
1781
+ */
1782
+ declare type BaseEvent_4 = BaseEvents.NamedEvent & {
1783
+ topic: 'view';
1784
+ target: OpenFin_2.Identity;
1785
+ };
1786
+
1787
+ /**
1788
+ * Base type for events emitting on the `window` topic
1789
+ * @interface
1790
+ */
1791
+ declare type BaseEvent_5 = BaseEvents.NamedEvent & {
1792
+ topic: 'window';
1793
+ };
1794
+
1795
+ /**
1796
+ * Base type for events emitting on the `externalapplication` topic
1797
+ * @interface
1798
+ */
1799
+ declare type BaseEvent_6 = BaseEvents.BaseEvent & {
1800
+ topic: 'externalapplication';
1801
+ };
1802
+
1803
+ /**
1804
+ * The base frame event.
1805
+ * @interface
1806
+ */
1807
+ declare type BaseEvent_7 = NamedEvent & {
1808
+ entityType: 'iframe';
1809
+ frameName: string;
1810
+ };
1811
+
1812
+ /**
1813
+ * Base type for events emitting on the `system` topic
1814
+ * @interface
1815
+ */
1816
+ declare type BaseEvent_8 = BaseEvents.BaseEvent & {
1817
+ topic: 'system';
1818
+ };
1819
+
1820
+ declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
1767
1821
 
1768
1822
  declare namespace BaseEvents {
1769
1823
  export {
1824
+ NotCloseRequested,
1770
1825
  PropagatedEventType,
1771
1826
  PropagatedEvent,
1772
1827
  EventHandler,
@@ -1777,21 +1832,14 @@ declare namespace BaseEvents {
1777
1832
  }
1778
1833
 
1779
1834
  /**
1780
- * Base type for events emitting on the `externalapplication` topic
1781
- * @interface
1835
+ * @deprecated Renamed to {@link BaseEvent}.
1782
1836
  */
1783
- declare type BaseExternalApplicationEvent = BaseEvent & {
1784
- topic: 'externalapplication';
1785
- };
1837
+ declare type BaseExternalApplicationEvent = BaseEvent_6;
1786
1838
 
1787
1839
  /**
1788
- * The base frame event.
1789
- * @interface
1840
+ * @deprecated Renamed to {@link BaseEvent}.
1790
1841
  */
1791
- declare type BaseFrameEvent = NamedEvent & {
1792
- entityType: 'iframe';
1793
- frameName: string;
1794
- };
1842
+ declare type BaseFrameEvent = BaseEvent_7;
1795
1843
 
1796
1844
  declare type BaseLoadFailedEvent = NamedEvent & {
1797
1845
  errorCode: number;
@@ -1800,35 +1848,20 @@ declare type BaseLoadFailedEvent = NamedEvent & {
1800
1848
  isMainFrame: boolean;
1801
1849
  };
1802
1850
 
1803
- /**
1804
- * Base type for events emitting on the `system` topic
1805
- * @interface
1806
- */
1807
- declare type BaseSystemEvent = BaseEvent & {
1808
- topic: 'system';
1809
- };
1810
-
1811
1851
  declare type BaseUrlEvent = NamedEvent & {
1812
1852
  type: 'url-changed';
1813
1853
  url: string;
1814
1854
  };
1815
1855
 
1816
1856
  /**
1817
- * Base type for events emitting on the `view` topic
1818
- * @interface
1857
+ * @deprecated Renamed to {@link BaseEvent}.
1819
1858
  */
1820
- declare type BaseViewEvent = NamedEvent & {
1821
- topic: 'view';
1822
- target: OpenFin_2.Identity;
1823
- };
1859
+ declare type BaseViewEvent = BaseEvent_4;
1824
1860
 
1825
1861
  /**
1826
- * Base type for events emitting on the `window` topic
1827
- * @interface
1862
+ * @deprecated Renamed to {@link BaseEvent}.
1828
1863
  */
1829
- declare type BaseWindowEvent = NamedEvent & {
1830
- topic: 'window';
1831
- };
1864
+ declare type BaseWindowEvent = BaseEvent_5;
1832
1865
 
1833
1866
  /**
1834
1867
  * User decision of whether a Window or specific View should close when trying to prevent an unload.
@@ -1895,7 +1928,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
1895
1928
  * A general bounds change event without event type.
1896
1929
  * @interface
1897
1930
  */
1898
- declare type BoundsChangeEvent = BaseWindowEvent & {
1931
+ declare type BoundsChangeEvent = BaseEvent_5 & {
1899
1932
  changeType: 0 | 1 | 2;
1900
1933
  deferred: boolean;
1901
1934
  height: number;
@@ -1967,76 +2000,76 @@ declare interface BrowserWindow {
1967
2000
  }
1968
2001
 
1969
2002
  /**
1970
- * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
2003
+ * Extracts a single event type matching the given key from the View {@link Event} union.
1971
2004
  *
1972
2005
  * Alias for {@link Payload}, which may read better in source.
1973
2006
  *
1974
2007
  * @typeParam Type String key specifying the event to extract
1975
2008
  */
1976
- declare type ByType<Type extends ApplicationEventType> = Payload_2<Type>;
2009
+ declare type ByType<Type extends EventType> = Payload_2<Type>;
1977
2010
 
1978
2011
  /**
1979
- * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
2012
+ * Extracts a single event type matching the given key from the Window {@link Event} union.
1980
2013
  *
1981
2014
  * Alias for {@link Payload}, which may read better in source.
1982
2015
  *
1983
2016
  * @typeParam Type String key specifying the event to extract
1984
2017
  */
1985
- declare type ByType_2<Type extends ExternalApplicationEventType> = Payload_3<Type>;
2018
+ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
1986
2019
 
1987
2020
  /**
1988
- * Extracts a single event type matching the given key from the {@link FrameEvent} union.
2021
+ * Extracts a single event type matching the given key from the Application {@link Event} union.
1989
2022
  *
1990
2023
  * Alias for {@link Payload}, which may read better in source.
1991
2024
  *
1992
2025
  * @typeParam Type String key specifying the event to extract
1993
2026
  */
1994
- declare type ByType_3<Type extends FrameEventType> = Payload_4<Type>;
2027
+ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
1995
2028
 
1996
2029
  /**
1997
- * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
2030
+ * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
1998
2031
  *
1999
2032
  * Alias for {@link Payload}, which may read better in source.
2000
2033
  *
2001
2034
  * @typeParam Type String key specifying the event to extract
2002
2035
  */
2003
- declare type ByType_4<Type extends GlobalHotkeyEventType> = Payload_5<Type>;
2036
+ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
2004
2037
 
2005
2038
  /**
2006
- * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
2039
+ * Extracts a single event type matching the given key from the Frame {@link Event} union.
2007
2040
  *
2008
2041
  * Alias for {@link Payload}, which may read better in source.
2009
2042
  *
2010
2043
  * @typeParam Type String key specifying the event to extract
2011
2044
  */
2012
- declare type ByType_5<Type extends PlatformEventType> = Payload_6<Type>;
2045
+ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
2013
2046
 
2014
2047
  /**
2015
- * Extracts a single event type matching the given key from the {@link SystemEvent} union.
2048
+ * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
2016
2049
  *
2017
2050
  * Alias for {@link Payload}, which may read better in source.
2018
2051
  *
2019
2052
  * @typeParam Type String key specifying the event to extract
2020
2053
  */
2021
- declare type ByType_6<Type extends SystemEventType> = Payload_7<Type>;
2054
+ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
2022
2055
 
2023
2056
  /**
2024
- * Extracts a single event type matching the given key from the {@link ViewEvent} union.
2057
+ * Extracts a single event type matching the given key from the Platform {@link Event} union.
2025
2058
  *
2026
2059
  * Alias for {@link Payload}, which may read better in source.
2027
2060
  *
2028
2061
  * @typeParam Type String key specifying the event to extract
2029
2062
  */
2030
- declare type ByType_7<Type extends ViewEventType> = Payload_8<Type>;
2063
+ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
2031
2064
 
2032
2065
  /**
2033
- * Extracts a single event type matching the given key from the {@link WindowEvent} union.
2066
+ * Extracts a single event type matching the given key from the System {@link Event} union.
2034
2067
  *
2035
2068
  * Alias for {@link Payload}, which may read better in source.
2036
2069
  *
2037
2070
  * @typeParam Type String key specifying the event to extract
2038
2071
  */
2039
- declare type ByType_8<Type extends WindowEventType> = Payload_9<Type>;
2072
+ declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
2040
2073
 
2041
2074
  /**
2042
2075
  * Configuration for page capture.
@@ -2719,14 +2752,6 @@ declare type ChannelClientConnectionListener = (identity: ClientIdentity, connec
2719
2752
 
2720
2753
  declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
2721
2754
 
2722
- /**
2723
- * Generated when a Channel client is connected.
2724
- * @interface
2725
- */
2726
- declare type ChannelConnectedEvent = BaseChannelEvent & {
2727
- type: 'connected';
2728
- };
2729
-
2730
2755
  /**
2731
2756
  * Options provided on a client connection to a channel.
2732
2757
  *
@@ -2758,21 +2783,9 @@ declare type ChannelCreateOptions = {
2758
2783
  };
2759
2784
 
2760
2785
  /**
2761
- * Generated when a Channel client has disconnected.
2762
- * @interface
2786
+ * @deprecated Renamed to {@link Event}.
2763
2787
  */
2764
- declare type ChannelDisconnectedEvent = BaseChannelEvent & {
2765
- type: 'disconnected';
2766
- };
2767
-
2768
- /**
2769
- * [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
2770
- * discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
2771
- * under the {@link OpenFin.ChannelEvents} namespace.
2772
- */
2773
- declare type ChannelEvent = {
2774
- topic: 'channel';
2775
- } & (ChannelConnectedEvent | ChannelDisconnectedEvent);
2788
+ declare type ChannelEvent = Event_2;
2776
2789
 
2777
2790
  declare type ChannelMiddleware = OpenFin_2.ChannelMiddleware;
2778
2791
 
@@ -3310,11 +3323,19 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
3310
3323
  * Generated when an application is closed.
3311
3324
  * @interface
3312
3325
  */
3313
- declare type ClosedEvent = IdentityEvent & {
3326
+ declare type ClosedEvent = BaseEvents.IdentityEvent & {
3314
3327
  topic: 'application';
3315
3328
  type: 'closed';
3316
3329
  };
3317
3330
 
3331
+ /**
3332
+ * Generated when a window has closed.
3333
+ * @interface
3334
+ */
3335
+ declare type ClosedEvent_2 = BaseEvent_5 & {
3336
+ type: 'closed';
3337
+ };
3338
+
3318
3339
  /**
3319
3340
  * @interface
3320
3341
  */
@@ -3322,6 +3343,15 @@ declare type ClosedMenuResult = {
3322
3343
  result: 'closed';
3323
3344
  };
3324
3345
 
3346
+ /**
3347
+ * Generated when a window has been prevented from closing.
3348
+ * @remarks A window will be prevented from closing by default, either through the API or by a user when ‘close-requested’ has been subscribed to and the Window.close(force) flag is false.
3349
+ * @interface
3350
+ */
3351
+ declare type CloseRequestedEvent = BaseEvent_5 & {
3352
+ type: 'close-requested';
3353
+ };
3354
+
3325
3355
  /**
3326
3356
  * @interface
3327
3357
  */
@@ -3368,6 +3398,14 @@ declare interface CloseWindowPayload {
3368
3398
  };
3369
3399
  }
3370
3400
 
3401
+ /**
3402
+ * Generated when a window has initiated the closing routine.
3403
+ * @interface
3404
+ */
3405
+ declare type ClosingEvent = BaseEvent_5 & {
3406
+ type: 'closing';
3407
+ };
3408
+
3371
3409
  /**
3372
3410
  * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
3373
3411
  */
@@ -3501,6 +3539,39 @@ declare type ConfigWithUuid = BaseConfig & {
3501
3539
  uuid: string;
3502
3540
  };
3503
3541
 
3542
+ /**
3543
+ * Generated when a Channel client is connected.
3544
+ * @interface
3545
+ */
3546
+ declare type ConnectedEvent = BaseEvent_2 & {
3547
+ type: 'connected';
3548
+ };
3549
+
3550
+ /**
3551
+ * Generated when an application has authenticated and is connected.
3552
+ * @interface
3553
+ */
3554
+ declare type ConnectedEvent_2 = BaseEvents.IdentityEvent & {
3555
+ topic: 'application';
3556
+ type: 'connected';
3557
+ };
3558
+
3559
+ /**
3560
+ * Generated when an external application has authenticated and is connected.
3561
+ * @interface
3562
+ */
3563
+ declare type ConnectedEvent_3 = BaseExternalApplicationEvent & {
3564
+ type: 'connected';
3565
+ };
3566
+
3567
+ /**
3568
+ * Generated when a frame is connected.
3569
+ * @interface
3570
+ */
3571
+ declare type ConnectedEvent_4 = BaseFrameEvent & {
3572
+ type: 'connected';
3573
+ };
3574
+
3504
3575
  declare type Constructor<T = {}> = new () => T;
3505
3576
 
3506
3577
  declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
@@ -4242,7 +4313,7 @@ declare type Context_3 = {
4242
4313
  * Generated when a window's context is updated via {@link Platform#setWindowContext Platform.setWindowContext}. Only available on windows in a Platform.
4243
4314
  * @interface
4244
4315
  */
4245
- declare type ContextChangedEvent = BaseWindowEvent & {
4316
+ declare type ContextChangedEvent = BaseEvent_5 & {
4246
4317
  type: 'context-changed';
4247
4318
  context: any;
4248
4319
  };
@@ -4394,7 +4465,7 @@ declare type CpuInfo = {
4394
4465
  * Generated when an application has crashed.
4395
4466
  * @interface
4396
4467
  */
4397
- declare type CrashedEvent = IdentityEvent & {
4468
+ declare type CrashedEvent = BaseEvents.IdentityEvent & {
4398
4469
  topic: 'application';
4399
4470
  type: 'crashed';
4400
4471
  reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
@@ -4445,7 +4516,7 @@ declare type CrashReporterState = CrashReporterOptions & {
4445
4516
  * Generated when a View is created.
4446
4517
  * @interface
4447
4518
  */
4448
- declare type CreatedEvent = BaseViewEvent & {
4519
+ declare type CreatedEvent = BaseEvent_4 & {
4449
4520
  type: 'created';
4450
4521
  };
4451
4522
 
@@ -4604,7 +4675,7 @@ declare interface DesktopAgent_2 {
4604
4675
  * Generated when the desktop icon is clicked while it's already running.
4605
4676
  * @interface
4606
4677
  */
4607
- declare type DesktopIconClickedEvent = BaseSystemEvent & {
4678
+ declare type DesktopIconClickedEvent = BaseEvent_8 & {
4608
4679
  type: 'desktop-icon-clicked';
4609
4680
  };
4610
4681
 
@@ -4612,7 +4683,7 @@ declare type DesktopIconClickedEvent = BaseSystemEvent & {
4612
4683
  * Generated when a View is destroyed.
4613
4684
  * @interface
4614
4685
  */
4615
- declare type DestroyedEvent = BaseViewEvent & {
4686
+ declare type DestroyedEvent = BaseEvent_4 & {
4616
4687
  type: 'destroyed';
4617
4688
  };
4618
4689
 
@@ -4712,6 +4783,30 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
4712
4783
  type: 'disabled-movement-bounds-changing';
4713
4784
  };
4714
4785
 
4786
+ /**
4787
+ * Generated when a Channel client has disconnected.
4788
+ * @interface
4789
+ */
4790
+ declare type DisconnectedEvent = BaseEvent_2 & {
4791
+ type: 'disconnected';
4792
+ };
4793
+
4794
+ /**
4795
+ * Generated when an external application has disconnected.
4796
+ * @interface
4797
+ */
4798
+ declare type DisconnectedEvent_2 = BaseExternalApplicationEvent & {
4799
+ type: 'disconnected';
4800
+ };
4801
+
4802
+ /**
4803
+ * Generated when a frame has disconnected.
4804
+ * @interface
4805
+ */
4806
+ declare type DisconnectedEvent_3 = BaseFrameEvent & {
4807
+ type: 'disconnected';
4808
+ };
4809
+
4715
4810
  /**
4716
4811
  * A system channel will be global enough to have a presence across many apps. This gives us some hints
4717
4812
  * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
@@ -4845,7 +4940,7 @@ declare type DownloadShelfOptions = {
4845
4940
  *
4846
4941
  * @interface
4847
4942
  */
4848
- declare type DownloadShelfVisibilityChangedEvent = BaseWindowEvent & {
4943
+ declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
4849
4944
  type: 'download-shelf-visibility-changed';
4850
4945
  /**
4851
4946
  * True if the download shelf was just opened; false if it was just closed.
@@ -4875,7 +4970,7 @@ declare interface DragSource {}
4875
4970
  * Generated when a window has been embedded.
4876
4971
  * @interface
4877
4972
  */
4878
- declare type EmbeddedEvent = BaseWindowEvent & {
4973
+ declare type EmbeddedEvent = BaseEvent_5 & {
4879
4974
  type: 'embedded';
4880
4975
  };
4881
4976
 
@@ -4979,7 +5074,7 @@ declare class EmitterMap {
4979
5074
  * Generated when a window ends loading.
4980
5075
  * @interface
4981
5076
  */
4982
- declare type EndLoadEvent = BaseWindowEvent & {
5077
+ declare type EndLoadEvent = BaseEvent_5 & {
4983
5078
  type: 'end-load';
4984
5079
  documentName: string;
4985
5080
  isMain: boolean;
@@ -5096,6 +5191,88 @@ declare type ErrorPlainObject = {
5096
5191
  toString(): string;
5097
5192
  };
5098
5193
 
5194
+ /**
5195
+ * [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
5196
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5197
+ * under the {@link OpenFin.PlatformEvents} namespace.
5198
+ */
5199
+ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5200
+
5201
+ /**
5202
+ * [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
5203
+ * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5204
+ * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5205
+ * from which they propagate).
5206
+ */
5207
+ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
5208
+
5209
+ /**
5210
+ * [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
5211
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5212
+ * under the {@link OpenFin.ChannelEvents} namespace.
5213
+ */
5214
+ declare type Event_2 = {
5215
+ topic: 'channel';
5216
+ } & (ConnectedEvent | DisconnectedEvent);
5217
+
5218
+ /**
5219
+ * [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
5220
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5221
+ * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5222
+ * from which they propagate).
5223
+ */
5224
+ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.PropagatedEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
5225
+
5226
+ /**
5227
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}. Events are
5228
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5229
+ * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5230
+ */
5231
+ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
5232
+ target: OpenFin_2.Identity;
5233
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
5234
+
5235
+ /**
5236
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
5237
+ * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
5238
+ */
5239
+ declare type Event_5<Topic extends string> = {
5240
+ topic: Topic;
5241
+ } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
5242
+
5243
+ /**
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 Window}. Events are
5245
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5246
+ * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5247
+ */
5248
+ declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5249
+
5250
+ /**
5251
+ * [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
5252
+ * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5253
+ * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5254
+ */
5255
+ declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5256
+
5257
+ /**
5258
+ * [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
5259
+ * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5260
+ * under the {@link OpenFin.FrameEvents} namespace.
5261
+ */
5262
+ declare type Event_8 = {
5263
+ topic: 'frame';
5264
+ } & (ConnectedEvent_4 | DisconnectedEvent_3);
5265
+
5266
+ /**
5267
+ * [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
5268
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5269
+ * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5270
+ */
5271
+ declare type Event_9 = {
5272
+ topic: 'global-hotkey';
5273
+ hotkey: 'string';
5274
+ } & (RegisteredEvent | UnregisteredEvent);
5275
+
5099
5276
  declare class EventAggregator extends EmitterMap {
5100
5277
  dispatchEvent: (message: Message<any>) => boolean;
5101
5278
  }
@@ -5138,28 +5315,68 @@ declare interface EventEmitter_2 {
5138
5315
  }
5139
5316
 
5140
5317
  /**
5141
- * Handler for an event on an EventEmitter.
5142
- * @remarks Selects the correct type for the event
5143
- * payload from the provided union based on the provided string literal type.
5318
+ * Handler for an event on an EventEmitter.
5319
+ * @remarks Selects the correct type for the event
5320
+ * payload from the provided union based on the provided string literal type.
5321
+ */
5322
+ declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
5323
+ type: EventType;
5324
+ }>, ...args: any[]) => void;
5325
+
5326
+ declare namespace Events {
5327
+ export {
5328
+ ApplicationEvents,
5329
+ BaseEvents,
5330
+ ExternalApplicationEvents,
5331
+ FrameEvents,
5332
+ GlobalHotkeyEvents,
5333
+ PlatformEvents,
5334
+ SystemEvents,
5335
+ ViewEvents,
5336
+ WebContentsEvents,
5337
+ WindowEvents
5338
+ }
5339
+ }
5340
+
5341
+ /**
5342
+ * Union of possible `type` values for a view {@link Event}.
5343
+ */
5344
+ declare type EventType = Event_4['type'];
5345
+
5346
+ /**
5347
+ * Union of possible `type` values for a Window {@link Event}.
5348
+ */
5349
+ declare type EventType_2 = Event_6['type'];
5350
+
5351
+ /**
5352
+ * Union of possible `type` values for an Application {@link Event}.
5353
+ */
5354
+ declare type EventType_3 = Event_3['type'];
5355
+
5356
+ /**
5357
+ * Union of possible `type` values for an ExternalApplication {@link Event}.
5358
+ */
5359
+ declare type EventType_4 = Event_7['type'];
5360
+
5361
+ /**
5362
+ * Union of possible `type` values for a {@link FrameEvent}.
5363
+ */
5364
+ declare type EventType_5 = Event_8['type'];
5365
+
5366
+ /**
5367
+ * Union of possible `type` values for a {@link GlobalHotkeyEvent}
5368
+ */
5369
+ declare type EventType_6 = Event_9['type'];
5370
+
5371
+ /**
5372
+ * Union of possible `type` values for a {@link PlatformEvent}.
5373
+ */
5374
+ declare type EventType_7 = Event_10['type'];
5375
+
5376
+ /**
5377
+ * Union of possible `type` values for a {@link SystemEvent}.
5144
5378
  */
5145
- declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
5146
- type: EventType;
5147
- }>, ...args: any[]) => void;
5148
-
5149
- declare namespace Events {
5150
- export {
5151
- ApplicationEvents,
5152
- BaseEvents,
5153
- ExternalApplicationEvents,
5154
- FrameEvents,
5155
- GlobalHotkeyEvents,
5156
- PlatformEvents,
5157
- SystemEvents,
5158
- ViewEvents,
5159
- WebContentsEvents,
5160
- WindowEvents
5161
- }
5162
- }
5379
+ declare type EventType_8 = SystemEvent['type'];
5163
5380
 
5164
5381
  /**
5165
5382
  * @internal
@@ -5174,6 +5391,8 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
5174
5391
 
5175
5392
  /**
5176
5393
  * @internal
5394
+ *
5395
+ * Ensures that an event payload type does not include any `-requested` events. Distributes over unions.
5177
5396
  */
5178
5397
  declare type ExcludeRequested<Event extends {
5179
5398
  type: string;
@@ -5303,46 +5522,43 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
5303
5522
  }
5304
5523
 
5305
5524
  /**
5306
- * Generated when an external application has authenticated and is connected.
5307
- * @interface
5525
+ * @deprecated Renamed to {@link ConnectedEvent}.
5308
5526
  */
5309
- declare type ExternalApplicationConnectedEvent = BaseExternalApplicationEvent & {
5310
- type: 'connected';
5311
- };
5527
+ declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
5312
5528
 
5313
5529
  /**
5314
- * Generated when an external application has disconnected.
5315
- * @interface
5530
+ * @deprecated Renamed to {@link DisconnectedEvent}.
5316
5531
  */
5317
- declare type ExternalApplicationDisconnectedEvent = BaseExternalApplicationEvent & {
5318
- type: 'disconnected';
5319
- };
5532
+ declare type ExternalApplicationDisconnectedEvent = DisconnectedEvent_2;
5320
5533
 
5321
5534
  /**
5322
- * [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
5323
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5324
- * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5535
+ * @deprecated Renamed to {@link Event}.
5325
5536
  */
5326
- declare type ExternalApplicationEvent = ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent;
5537
+ declare type ExternalApplicationEvent = Event_7;
5327
5538
 
5328
5539
  declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
5329
5540
 
5330
5541
  declare namespace ExternalApplicationEvents {
5331
5542
  export {
5543
+ BaseEvent_6 as BaseEvent,
5332
5544
  BaseExternalApplicationEvent,
5545
+ ConnectedEvent_3 as ConnectedEvent,
5333
5546
  ExternalApplicationConnectedEvent,
5547
+ DisconnectedEvent_2 as DisconnectedEvent,
5334
5548
  ExternalApplicationDisconnectedEvent,
5549
+ Event_7 as Event,
5335
5550
  ExternalApplicationEvent,
5551
+ EventType_4 as EventType,
5336
5552
  ExternalApplicationEventType,
5337
- Payload_3 as Payload,
5338
- ByType_2 as ByType
5553
+ Payload_5 as Payload,
5554
+ ByType_4 as ByType
5339
5555
  }
5340
5556
  }
5341
5557
 
5342
5558
  /**
5343
- * Union of possible `type` values for a {@link ApplicationEvent}.
5559
+ * @deprecated Renamed to {@link Event}.
5344
5560
  */
5345
- declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
5561
+ declare type ExternalApplicationEventType = EventType_4;
5346
5562
 
5347
5563
  /**
5348
5564
  * @interface
@@ -5403,7 +5619,7 @@ declare type ExternalConnection = {
5403
5619
  * Generated when an external process has exited.
5404
5620
  * @interface
5405
5621
  */
5406
- declare type ExternalProcessExitedEvent = BaseWindowEvent & {
5622
+ declare type ExternalProcessExitedEvent = BaseEvent_5 & {
5407
5623
  type: 'external-process-exited';
5408
5624
  processUuid: string;
5409
5625
  exitCode: number;
@@ -5448,19 +5664,15 @@ declare type ExternalProcessRequestType = {
5448
5664
  * Generated when an external process has started.
5449
5665
  * @interface
5450
5666
  */
5451
- declare type ExternalProcessStartedEvent = BaseWindowEvent & {
5667
+ declare type ExternalProcessStartedEvent = BaseEvent_5 & {
5452
5668
  type: 'external-process-started';
5453
5669
  processUuid: string;
5454
5670
  };
5455
5671
 
5456
5672
  /**
5457
- * Generated when page receives favicon urls.
5458
- * @interface
5673
+ * @deprecated, use {@link PageFaviconUpdatedEvent}.
5459
5674
  */
5460
- declare type FaviconUpdatedEvent = NamedEvent & {
5461
- type: 'page-favicon-updated';
5462
- favicons: string[];
5463
- };
5675
+ declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
5464
5676
 
5465
5677
  declare namespace FDC3 {
5466
5678
  export {
@@ -5547,7 +5759,7 @@ declare type FileDownloadEvent = {
5547
5759
  *
5548
5760
  * @interface
5549
5761
  */
5550
- declare type FileDownloadLocationChangedEvent = BaseApplicationEvent & {
5762
+ declare type FileDownloadLocationChangedEvent = BaseEvent_3 & {
5551
5763
  type: 'file-download-location-changed';
5552
5764
  };
5553
5765
 
@@ -5819,48 +6031,43 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5819
6031
  }
5820
6032
 
5821
6033
  /**
5822
- * Generated when a frame is connected.
5823
- * @interface
6034
+ * @deprecated Renamed to {@link ConnectedEvent}.
5824
6035
  */
5825
- declare type FrameConnectedEvent = BaseFrameEvent & {
5826
- type: 'connected';
5827
- };
6036
+ declare type FrameConnectedEvent = ConnectedEvent_4;
5828
6037
 
5829
6038
  /**
5830
- * Generated when a frame has disconnected.
5831
- * @interface
6039
+ * @deprecated Renamed to {@link DisconnectedEvent}.
5832
6040
  */
5833
- declare type FrameDisconnectedEvent = BaseFrameEvent & {
5834
- type: 'disconnected';
5835
- };
6041
+ declare type FrameDisconnectedEvent = DisconnectedEvent_3;
5836
6042
 
5837
6043
  /**
5838
- * [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
5839
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5840
- * under the {@link OpenFin.FrameEvents} namespace.
6044
+ * @deprecated Renamed to {@link Event}.
5841
6045
  */
5842
- declare type FrameEvent = {
5843
- topic: 'frame';
5844
- } & (FrameConnectedEvent | FrameDisconnectedEvent);
6046
+ declare type FrameEvent = Event_8;
5845
6047
 
5846
6048
  declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
5847
6049
 
5848
6050
  declare namespace FrameEvents {
5849
6051
  export {
6052
+ BaseEvent_7 as BaseEvent,
5850
6053
  BaseFrameEvent,
6054
+ ConnectedEvent_4 as ConnectedEvent,
5851
6055
  FrameConnectedEvent,
6056
+ DisconnectedEvent_3 as DisconnectedEvent,
5852
6057
  FrameDisconnectedEvent,
6058
+ Event_8 as Event,
5853
6059
  FrameEvent,
6060
+ EventType_5 as EventType,
5854
6061
  FrameEventType,
5855
- Payload_4 as Payload,
5856
- ByType_3 as ByType
6062
+ Payload_6 as Payload,
6063
+ ByType_5 as ByType
5857
6064
  }
5858
6065
  }
5859
6066
 
5860
6067
  /**
5861
- * Union of possible `type` values for a {@link FrameEvent}.
6068
+ * @deprecated Renamed to {@link EventType}.
5862
6069
  */
5863
- declare type FrameEventType = FrameEvent['type'];
6070
+ declare type FrameEventType = EventType_5;
5864
6071
 
5865
6072
  /**
5866
6073
  * @interface
@@ -6082,14 +6289,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin_2.GlobalHotkeyEvent> {
6082
6289
  }
6083
6290
 
6084
6291
  /**
6085
- * [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
6086
- * discriminated by {@link GlobalHotkeyEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
6087
- * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
6292
+ * @deprecated Renamed to {@link Event}.
6088
6293
  */
6089
- declare type GlobalHotkeyEvent = {
6090
- topic: 'global-hotkey';
6091
- hotkey: 'string';
6092
- } & (RegisteredEvent | UnregisteredEvent);
6294
+ declare type GlobalHotkeyEvent = Event_9;
6093
6295
 
6094
6296
  declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6095
6297
 
@@ -6097,17 +6299,19 @@ declare namespace GlobalHotkeyEvents {
6097
6299
  export {
6098
6300
  RegisteredEvent,
6099
6301
  UnregisteredEvent,
6302
+ Event_9 as Event,
6100
6303
  GlobalHotkeyEvent,
6304
+ EventType_6 as EventType,
6101
6305
  GlobalHotkeyEventType,
6102
- Payload_5 as Payload,
6103
- ByType_4 as ByType
6306
+ Payload_7 as Payload,
6307
+ ByType_6 as ByType
6104
6308
  }
6105
6309
  }
6106
6310
 
6107
6311
  /**
6108
- * Union of possible `type` values for a {@link GlobalHotkeyEvent}
6312
+ * @deprecated Renamed to {@link EventType}.
6109
6313
  */
6110
- declare type GlobalHotkeyEventType = GlobalHotkeyEvent['type'];
6314
+ declare type GlobalHotkeyEventType = EventType_6;
6111
6315
 
6112
6316
  declare namespace GoldenLayout {
6113
6317
  export {
@@ -6409,8 +6613,17 @@ declare interface Header {
6409
6613
  * Generated when a View is hidden.
6410
6614
  * @interface
6411
6615
  */
6412
- declare type HiddenEvent = BaseViewEvent & {
6616
+ declare type HiddenEvent = BaseEvent_4 & {
6617
+ type: 'hidden';
6618
+ };
6619
+
6620
+ /**
6621
+ * Generated when a window has been hidden.
6622
+ * @interface
6623
+ */
6624
+ declare type HiddenEvent_2 = BaseEvent_5 & {
6413
6625
  type: 'hidden';
6626
+ reason: 'closing' | 'hide' | 'hide-on-close';
6414
6627
  };
6415
6628
 
6416
6629
  /**
@@ -6418,7 +6631,7 @@ declare type HiddenEvent = BaseViewEvent & {
6418
6631
  * or because the View has moved to a new window. Only available on Views in a Platform.
6419
6632
  * @interface
6420
6633
  */
6421
- declare type HostContextChangedEvent = BaseViewEvent & {
6634
+ declare type HostContextChangedEvent = BaseEvent_4 & {
6422
6635
  type: 'host-context-changed';
6423
6636
  context: any;
6424
6637
  reason: 'reparented' | 'updated';
@@ -6497,7 +6710,16 @@ declare type Hotkey = {
6497
6710
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
6498
6711
  * @interface
6499
6712
  */
6500
- declare type HotkeyEvent = BaseViewEvent & {
6713
+ declare type HotkeyEvent = BaseEvent_4 & {
6714
+ type: 'hotkey';
6715
+ };
6716
+
6717
+ /**
6718
+ * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
6719
+ * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
6720
+ * @interface
6721
+ */
6722
+ declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
6501
6723
  type: 'hotkey';
6502
6724
  };
6503
6725
 
@@ -6553,6 +6775,11 @@ declare type IdentityEvent = BaseEvent & {
6553
6775
  */
6554
6776
  declare type IdEventType = WithId<AppVersionEventType>;
6555
6777
 
6778
+ /**
6779
+ * @deprecated Renamed to {@link IdleStateChangedEvent}.
6780
+ */
6781
+ declare type IdleEvent = IdleStateChangedEvent;
6782
+
6556
6783
  /**
6557
6784
  * Generated when a user enters or returns from idle state.
6558
6785
  * @remarks This method is continuously generated every minute while the user is in idle.
@@ -6560,7 +6787,7 @@ declare type IdEventType = WithId<AppVersionEventType>;
6560
6787
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6561
6788
  * @interface
6562
6789
  */
6563
- declare type IdleEvent = BaseSystemEvent & {
6790
+ declare type IdleStateChangedEvent = BaseEvent_8 & {
6564
6791
  type: 'idle-state-changed';
6565
6792
  elapsedTime: number;
6566
6793
  isIdle: boolean;
@@ -6645,11 +6872,19 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6645
6872
  * Generated when an application has initialized.
6646
6873
  * @interface
6647
6874
  */
6648
- declare type InitializedEvent = IdentityEvent & {
6875
+ declare type InitializedEvent = BaseEvents.IdentityEvent & {
6649
6876
  topic: 'application';
6650
6877
  type: 'initialized';
6651
6878
  };
6652
6879
 
6880
+ /**
6881
+ * Generated when a window is initialized.
6882
+ * @interface
6883
+ */
6884
+ declare type InitializedEvent_2 = BaseEvent_5 & {
6885
+ type: 'initialized';
6886
+ };
6887
+
6653
6888
  /**
6654
6889
  * @interface
6655
6890
  */
@@ -8751,7 +8986,7 @@ declare type LayoutIdentity = Identity_5 & {
8751
8986
  * Generated when a window and all of its layout's views have either finished or failed navigation.
8752
8987
  * @interface
8753
8988
  */
8754
- declare type LayoutInitializedEvent = BaseWindowEvent & {
8989
+ declare type LayoutInitializedEvent = BaseEvent_5 & {
8755
8990
  type: 'layout-initialized';
8756
8991
  ofViews: (OpenFin_2.Identity & {
8757
8992
  entityType: 'view';
@@ -9288,7 +9523,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9288
9523
  * Generated when a window and all of its layout's views have been created and can receive API calls.
9289
9524
  * @interface
9290
9525
  */
9291
- declare type LayoutReadyEvent = BaseWindowEvent & {
9526
+ declare type LayoutReadyEvent = BaseEvent_5 & {
9292
9527
  type: 'layout-ready';
9293
9528
  views: (OpenFin_2.Identity & {
9294
9529
  success: boolean;
@@ -9429,7 +9664,7 @@ declare type Manifest = {
9429
9664
  * Generated when the RVM notifies an application that the manifest has changed.
9430
9665
  * @interface
9431
9666
  */
9432
- declare type ManifestChangedEvent = IdentityEvent & {
9667
+ declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
9433
9668
  topic: 'application';
9434
9669
  type: 'manifest-changed';
9435
9670
  };
@@ -9482,7 +9717,7 @@ declare type MatchPattern = string;
9482
9717
  * Generated when a window is maximized.
9483
9718
  * @interface
9484
9719
  */
9485
- declare type MaximizedEvent = BaseWindowEvent & {
9720
+ declare type MaximizedEvent = BaseEvent_5 & {
9486
9721
  type: 'maximized';
9487
9722
  };
9488
9723
 
@@ -9592,7 +9827,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
9592
9827
  * Generated when a window is minimized.
9593
9828
  * @interface
9594
9829
  */
9595
- declare type MinimizedEvent = BaseWindowEvent & {
9830
+ declare type MinimizedEvent = BaseEvent_5 & {
9596
9831
  type: 'minimized';
9597
9832
  };
9598
9833
 
@@ -9636,14 +9871,9 @@ declare type MonitorDetails = {
9636
9871
  };
9637
9872
 
9638
9873
  /**
9639
- * Generated on changes of a monitor's size/location.
9640
- * @remarks A monitor's size changes when the taskbar is resized or relocated.
9641
- * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9642
- * @interface
9874
+ * @deprecated Renamed to {@link MonitorInfoChangedEvent}.
9643
9875
  */
9644
- declare type MonitorEvent = BaseSystemEvent & OpenFin_2.MonitorInfo & {
9645
- type: 'monitor-info-changed';
9646
- };
9876
+ declare type MonitorEvent = MonitorInfoChangedEvent;
9647
9877
 
9648
9878
  /**
9649
9879
  * @interface
@@ -9667,6 +9897,16 @@ declare type MonitorInfo = {
9667
9897
  virtualScreen: DipRect;
9668
9898
  };
9669
9899
 
9900
+ /**
9901
+ * Generated on changes of a monitor's size/location.
9902
+ * @remarks A monitor's size changes when the taskbar is resized or relocated.
9903
+ * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9904
+ * @interface
9905
+ */
9906
+ declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin_2.MonitorInfo & {
9907
+ type: 'monitor-info-changed';
9908
+ };
9909
+
9670
9910
  /**
9671
9911
  * @interface
9672
9912
  */
@@ -10073,14 +10313,23 @@ declare type NonPropagatedWindowEvent = never;
10073
10313
 
10074
10314
  /**
10075
10315
  * @internal
10316
+ *
10317
+ * Ensures that an event type key does not include any `close-requested` events. Distributes over unions.
10318
+ */
10319
+ declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'close-requested'>;
10320
+
10321
+ /**
10322
+ * @internal
10323
+ *
10324
+ * Ensures that an event type key doesn't include any `-requested` events. Distributes over unions.
10076
10325
  */
10077
- declare type NotRequested<EventType> = EventType extends `${infer U}-requested` ? never : EventType;
10326
+ declare type NotRequested<EventType extends String> = EventType extends `${infer U}-requested` ? never : EventType;
10078
10327
 
10079
10328
  /**
10080
10329
  * Generated when an application is not responding.
10081
10330
  * @interface
10082
10331
  */
10083
- declare type NotRespondingEvent = IdentityEvent & {
10332
+ declare type NotRespondingEvent = BaseEvents.IdentityEvent & {
10084
10333
  topic: 'application';
10085
10334
  type: 'not-responding';
10086
10335
  };
@@ -10406,7 +10655,7 @@ declare namespace OpenFin_2 {
10406
10655
  AppVersionCompleteEvent,
10407
10656
  AppVersionRuntimeStatusEvent,
10408
10657
  Events,
10409
- BaseEvent_2 as BaseEvent,
10658
+ BaseEvent_9 as BaseEvent,
10410
10659
  WebContentsEvent_2 as WebContentsEvent,
10411
10660
  SystemEvent_2 as SystemEvent,
10412
10661
  ApplicationEvent_2 as ApplicationEvent,
@@ -10448,12 +10697,32 @@ export default OpenFin_2;
10448
10697
 
10449
10698
  declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
10450
10699
 
10700
+ /**
10701
+ * Generated after window options are changed using the window.updateOptions method.
10702
+ * @remarks Will not fire if the diff object is empty.
10703
+ * @interface
10704
+ */
10705
+ declare type OptionsChangedEvent = BaseEvent_5 & {
10706
+ type: 'options-changed';
10707
+ options: OpenFin_2.WindowOptions;
10708
+ diff: OpenFin_2.WindowOptionDiff;
10709
+ };
10710
+
10451
10711
  declare type OverlapsOnlyIfMatching<T, U> = {
10452
10712
  [K in Extract<keyof T, keyof U>]: U[K] extends T[K] ? U[K] : T[K] extends U[K] ? T[K] : never;
10453
10713
  };
10454
10714
 
10455
10715
  declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
10456
10716
 
10717
+ /**
10718
+ * Generated when page receives favicon urls.
10719
+ * @interface
10720
+ */
10721
+ declare type PageFaviconUpdatedEvent = NamedEvent & {
10722
+ type: 'page-favicon-updated';
10723
+ favicons: string[];
10724
+ };
10725
+
10457
10726
  /**
10458
10727
  * Generated when page title is set during navigation.
10459
10728
  * @remarks explicitSet is false when title is synthesized from file url.
@@ -10472,74 +10741,74 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
10472
10741
  };
10473
10742
 
10474
10743
  /**
10475
- * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
10744
+ * Extracts a single event type matching the given key from the View {@link Event} union.
10476
10745
  *
10477
10746
  * @typeParam Type String key specifying the event to extract
10478
10747
  */
10479
- declare type Payload_2<Type extends ApplicationEventType> = Extract<ApplicationEvent, {
10748
+ declare type Payload_2<Type extends EventType> = Extract<Event_4, {
10480
10749
  type: Type;
10481
10750
  }>;
10482
10751
 
10483
10752
  /**
10484
- * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
10753
+ * Extracts a single event type matching the given key from the Window {@link Event} union.
10485
10754
  *
10486
10755
  * @typeParam Type String key specifying the event to extract
10487
10756
  */
10488
- declare type Payload_3<Type extends ExternalApplicationEventType> = Extract<ExternalApplicationEvent, {
10757
+ declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
10489
10758
  type: Type;
10490
10759
  }>;
10491
10760
 
10492
10761
  /**
10493
- * Extracts a single event type matching the given key from the {@link FrameEvent} union.
10762
+ * Extracts a single event type matching the given key from the Application {@link Event} union.
10494
10763
  *
10495
10764
  * @typeParam Type String key specifying the event to extract
10496
10765
  */
10497
- declare type Payload_4<Type extends FrameEventType> = Extract<FrameEvent, {
10766
+ declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
10498
10767
  type: Type;
10499
10768
  }>;
10500
10769
 
10501
10770
  /**
10502
- * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
10771
+ * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
10503
10772
  *
10504
10773
  * @typeParam Type String key specifying the event to extract
10505
10774
  */
10506
- declare type Payload_5<Type extends GlobalHotkeyEventType> = Extract<GlobalHotkeyEvent, {
10775
+ declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
10507
10776
  type: Type;
10508
10777
  }>;
10509
10778
 
10510
10779
  /**
10511
- * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
10780
+ * Extracts a single event type matching the given key from the Frame {@link Event} union.
10512
10781
  *
10513
10782
  * @typeParam Type String key specifying the event to extract
10514
10783
  */
10515
- declare type Payload_6<Type extends PlatformEventType> = Extract<PlatformEvent, {
10784
+ declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
10516
10785
  type: Type;
10517
10786
  }>;
10518
10787
 
10519
10788
  /**
10520
- * Extracts a single event type matching the given key from the {@link SystemEvent} union.
10789
+ * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
10521
10790
  *
10522
10791
  * @typeParam Type String key specifying the event to extract
10523
10792
  */
10524
- declare type Payload_7<Type extends SystemEventType> = Extract<SystemEvent, {
10793
+ declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
10525
10794
  type: Type;
10526
10795
  }>;
10527
10796
 
10528
10797
  /**
10529
- * Extracts a single event type matching the given key from the {@link ViewEvent} union.
10798
+ * Extracts a single event type matching the given key from the Platform {@link Event} union.
10530
10799
  *
10531
10800
  * @typeParam Type String key specifying the event to extract
10532
10801
  */
10533
- declare type Payload_8<Type extends ViewEventType> = Extract<ViewEvent, {
10802
+ declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
10534
10803
  type: Type;
10535
10804
  }>;
10536
10805
 
10537
10806
  /**
10538
- * Extracts a single event type matching the given key from the {@link WindowEvent} union.
10807
+ * Extracts a single event type matching the given key from the System {@link Event} union.
10539
10808
  *
10540
10809
  * @typeParam Type String key specifying the event to extract
10541
10810
  */
10542
- declare type Payload_9<Type extends WindowEventType> = Extract<WindowEvent, {
10811
+ declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10543
10812
  type: Type;
10544
10813
  }>;
10545
10814
 
@@ -10549,7 +10818,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
10549
10818
  * Generated when window finishes loading. Provides performance and navigation data.
10550
10819
  * @interface
10551
10820
  */
10552
- declare type PerformanceReportEvent = Performance & BaseWindowEvent & {
10821
+ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
10553
10822
  type: 'performance-report';
10554
10823
  };
10555
10824
 
@@ -11213,38 +11482,36 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
11213
11482
  }
11214
11483
 
11215
11484
  /**
11216
- * Generated when a new Platform's API becomes responsive.
11217
- * @interface
11485
+ * @deprecated Renamed to {@link ApiReadyEvent}.
11218
11486
  */
11219
- declare type PlatformApiReadyEvent = BaseEvent & {
11220
- topic: 'application';
11221
- type: 'platform-api-ready';
11222
- };
11487
+ declare type PlatformApiReadyEvent = ApiReadyEvent;
11223
11488
 
11224
11489
  /**
11225
- * [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
11226
- * discriminated by {@link PlatformEvent.type | their type}. Event payloads unique to `Platform` can be found
11227
- * under the {@link OpenFin.PlatformEvents} namespace.
11490
+ * @deprecated Renamed to {@link Event}.
11228
11491
  */
11229
- declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
11492
+ declare type PlatformEvent = Event_10;
11230
11493
 
11231
11494
  declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
11232
11495
 
11233
11496
  declare namespace PlatformEvents {
11234
11497
  export {
11498
+ ApiReadyEvent,
11235
11499
  PlatformApiReadyEvent,
11500
+ SnapshotAppliedEvent,
11236
11501
  PlatformSnapshotAppliedEvent,
11502
+ Event_10 as Event,
11237
11503
  PlatformEvent,
11504
+ EventType_7 as EventType,
11238
11505
  PlatformEventType,
11239
- Payload_6 as Payload,
11240
- ByType_5 as ByType
11506
+ Payload_8 as Payload,
11507
+ ByType_7 as ByType
11241
11508
  }
11242
11509
  }
11243
11510
 
11244
11511
  /**
11245
- * Union of possible `type` values for a {@link PlatformEvent}.
11512
+ * @deprecated Renamed to {@link }.
11246
11513
  */
11247
- declare type PlatformEventType = PlatformEvent['type'];
11514
+ declare type PlatformEventType = EventType_7;
11248
11515
 
11249
11516
  /**
11250
11517
  * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
@@ -11524,11 +11791,14 @@ declare interface PlatformProvider {
11524
11791
  * Calls platform.createView for every view in the given layout. Returns an array of promises
11525
11792
  * one promise for each view create call
11526
11793
  *
11527
- * @param layout
11528
- * @param target
11794
+ * @param payload
11795
+ * @param callerIdentity
11529
11796
  * @returns an array of promises
11530
11797
  */
11531
- createViewsForLayout(layout: GoldenLayout.Config, target: OpenFin_2.Identity): Promise<OpenFin_2.View>[];
11798
+ createViewsForLayout(payload: {
11799
+ layout: GoldenLayout.Config;
11800
+ target?: OpenFin_2.Identity;
11801
+ }, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.View>[];
11532
11802
  /**
11533
11803
  * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
11534
11804
  * Gets the current state of a single view and returns an object with the options needed to restore that view as part of a snapshot.
@@ -11969,19 +12239,9 @@ declare interface PlatformProvider {
11969
12239
  }
11970
12240
 
11971
12241
  /**
11972
- * Generated when a platform.ApplySnapshot call is resolved.
11973
- * @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
11974
- * 1. The window has been created
11975
- * 2. The window has a responsive API
11976
- * 3. If a window has a layout property, the 'layout-ready' event has fired
11977
- *
11978
- * _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
11979
- * @interface
12242
+ * @deprecated Renamed to {@link SnapshotAppliedEvent}.
11980
12243
  */
11981
- declare type PlatformSnapshotAppliedEvent = BaseEvent & {
11982
- topic: 'application';
11983
- type: 'platform-snapshot-applied';
11984
- };
12244
+ declare type PlatformSnapshotAppliedEvent = SnapshotAppliedEvent;
11985
12245
 
11986
12246
  /**
11987
12247
  * @interface
@@ -12249,7 +12509,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
12249
12509
  * A general preload scripts state change event without event type.
12250
12510
  * @interface
12251
12511
  */
12252
- declare type PreloadScriptsStateChangeEvent = BaseWindowEvent & {
12512
+ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12253
12513
  preloadScripts: (PreloadScriptInfoRunning & any)[];
12254
12514
  };
12255
12515
 
@@ -12458,51 +12718,43 @@ declare type ProcessLoggingOptions = {
12458
12718
  };
12459
12719
 
12460
12720
  /**
12461
- * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
12462
- * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
12463
- * are propagated to `System` without any type string prefixing.
12464
- *
12465
- * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
12721
+ * @deprecated Renamed to {@link PropagatedEvent}.
12466
12722
  */
12467
- declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
12723
+ declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent_4<TargetTopic>;
12468
12724
 
12469
12725
  /**
12470
- * Union of possible 'type' values for a {@link OpenFin.ApplicationEvents.PropagatedApplicationEvent}.
12726
+ * @deprecated Renamed to {@link PropagatedEventType}.
12471
12727
  */
12472
- declare type PropagatedApplicationEventType = PropagatedApplicationEvent<string>['type'];
12728
+ declare type PropagatedApplicationEventType = PropagatedEventType_3;
12473
12729
 
12474
12730
  /**
12475
- * Modifies an event shape to reflect propagation to a parent topic.
12731
+ * Modifies an event shape to reflect propagation to a parent topic. Excludes `close-requested` events, as
12732
+ * these do not propagate.
12733
+ *
12476
12734
  * @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
12735
+ *
12736
+ * @typeParam SourceTopic The topic the event shape is propagating from.
12737
+ * @typeParam TargetTopic The topic the event shape is propagating to.
12738
+ * @typeParam Event The shape of the event being propagated.
12477
12739
  */
12478
12740
  declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
12479
12741
  type: string;
12480
12742
  }> = Event extends infer E extends {
12481
12743
  type: string;
12482
- } ? Omit<E, 'type' | 'topic'> & {
12744
+ } ? E['type'] extends 'close-requested' ? never : Omit<E, 'type' | 'topic'> & {
12483
12745
  type: PropagatedEventType<SourceTopic, E['type']>;
12484
12746
  topic: TargetTopic;
12485
12747
  } : never;
12486
12748
 
12487
- /**
12488
- * Modifies an event key to reflect propagation by prefixing with the topic.
12489
- */
12490
- declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
12491
-
12492
12749
  /**
12493
12750
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
12494
12751
  * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
12495
12752
  * event type key with `'view-'`.
12496
12753
  */
12497
- declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
12754
+ declare type PropagatedEvent_2<TargetTopic extends string> = BaseEvents.PropagatedEvent<'view', TargetTopic, ViewEvent> & {
12498
12755
  viewIdentity: OpenFin_2.Identity;
12499
12756
  };
12500
12757
 
12501
- /**
12502
- * Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
12503
- */
12504
- declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
12505
-
12506
12758
  /**
12507
12759
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
12508
12760
  * prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
@@ -12511,12 +12763,51 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
12511
12763
  *
12512
12764
  * "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
12513
12765
  */
12514
- declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent<'window', TargetTopic, Exclude<WindowSourcedEvent, WindowCloseRequestedEvent>>;
12766
+ declare type PropagatedEvent_3<TargetTopic extends string> = BaseEvents.PropagatedEvent<'window', TargetTopic, WindowSourcedEvent>;
12767
+
12768
+ /**
12769
+ * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
12770
+ * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
12771
+ * are propagated to `System` without any type string prefixing.
12772
+ *
12773
+ * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
12774
+ */
12775
+ declare type PropagatedEvent_4<TargetTopic extends string> = BaseEvents.PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
12776
+
12777
+ /**
12778
+ * Modifies an event type key to reflect propagation by prefixing with the topic.
12779
+ */
12780
+ declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${NotCloseRequested<Type>}`;
12781
+
12782
+ /**
12783
+ * Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.View}.
12784
+ */
12785
+ declare type PropagatedEventType_2 = PropagatedEvent_2<string>['type'];
12515
12786
 
12516
12787
  /**
12517
- * Union of possible `type` values for a {@link OpenFin.WindowEvents.PropagatedWindowEvent}.
12788
+ * Union of possible 'type' values for an {@link PropagatedEvent} sourced from an {@link Application}.
12518
12789
  */
12519
- declare type PropagatedWindowEventType = PropagatedWindowEvent<string>['type'];
12790
+ declare type PropagatedEventType_3 = PropagatedEvent_4<string>['type'];
12791
+
12792
+ /**
12793
+ * @deprecated Renamed to {@link PropagatedEvent}.
12794
+ */
12795
+ declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent_2<TargetTopic>;
12796
+
12797
+ /**
12798
+ * @deprecated Renamed to {@link PropagatedEventType}.
12799
+ */
12800
+ declare type PropagatedViewEventType = PropagatedEventType_2;
12801
+
12802
+ /**
12803
+ * @deprecated Renamed to {@link PropagatedEvent}.
12804
+ */
12805
+ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent_3<TargetTopic>;
12806
+
12807
+ /**
12808
+ * Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.Window}.
12809
+ */
12810
+ declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
12520
12811
 
12521
12812
  declare interface ProtocolMap extends ProtocolMapBase {
12522
12813
  'request-external-authorization': {
@@ -12934,7 +13225,7 @@ declare type RegistryInfo_2 = {
12934
13225
  * Generated when a window has been reloaded.
12935
13226
  * @interface
12936
13227
  */
12937
- declare type ReloadedEvent = BaseWindowEvent & {
13228
+ declare type ReloadedEvent = BaseEvent_5 & {
12938
13229
  type: 'reloaded';
12939
13230
  url: string;
12940
13231
  };
@@ -13070,11 +13361,19 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
13070
13361
  * Generated when an application is responding.
13071
13362
  * @interface
13072
13363
  */
13073
- declare type RespondingEvent = IdentityEvent & {
13364
+ declare type RespondingEvent = BaseEvents.IdentityEvent & {
13074
13365
  topic: 'application';
13075
13366
  type: 'responding';
13076
13367
  };
13077
13368
 
13369
+ /**
13370
+ * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
13371
+ * @interface
13372
+ */
13373
+ declare type RestoredEvent = BaseEvent_5 & {
13374
+ type: 'restored';
13375
+ };
13376
+
13078
13377
  declare type ResultBehavior = 'close' | 'hide' | 'none';
13079
13378
 
13080
13379
  /**
@@ -13137,7 +13436,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
13137
13436
  * Generated when Application.run() is called for an already running application.
13138
13437
  * @interface
13139
13438
  */
13140
- declare type RunRequestedEvent_2 = IdentityEvent & {
13439
+ declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
13141
13440
  topic: 'application';
13142
13441
  type: 'run-requested';
13143
13442
  userAppConfigArgs: Record<string, any>;
@@ -13319,7 +13618,7 @@ declare type ServiceIdentifier = {
13319
13618
  * Generated on changes to a user’s local computer session.
13320
13619
  * @interface
13321
13620
  */
13322
- declare type SessionChangedEvent = BaseSystemEvent & {
13621
+ declare type SessionChangedEvent = BaseEvent_8 & {
13323
13622
  type: 'session-changed';
13324
13623
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13325
13624
  };
@@ -13541,7 +13840,7 @@ declare type ShortcutOverride = Hotkey & {
13541
13840
  *
13542
13841
  * @interface
13543
13842
  */
13544
- declare type ShowAllDownloadsEvent = BaseWindowEvent & {
13843
+ declare type ShowAllDownloadsEvent = BaseEvent_5 & {
13545
13844
  type: 'show-all-downloads';
13546
13845
  };
13547
13846
 
@@ -13549,7 +13848,15 @@ declare type ShowAllDownloadsEvent = BaseWindowEvent & {
13549
13848
  * Generated when a View is shown. This event will fire during creation of a View.
13550
13849
  * @interface
13551
13850
  */
13552
- declare type ShownEvent = BaseViewEvent & {
13851
+ declare type ShownEvent = BaseEvent_4 & {
13852
+ type: 'shown';
13853
+ };
13854
+
13855
+ /**
13856
+ * Generated when a hidden window has been shown.
13857
+ * @interface
13858
+ */
13859
+ declare type ShownEvent_2 = BaseEvent_5 & {
13553
13860
  type: 'shown';
13554
13861
  };
13555
13862
 
@@ -13578,6 +13885,15 @@ declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
13578
13885
  y?: number;
13579
13886
  };
13580
13887
 
13888
+ /**
13889
+ * Generated when a window has been prevented from showing.
13890
+ * @remarks A window will be prevented from showing by default, either through the API or by a user when ‘show-requested’ has been subscribed to on the window or 'window-show-requested' on the parent application and the Window.show(force) flag is false.
13891
+ * @interface
13892
+ */
13893
+ declare type ShowRequestedEvent = BaseEvent_5 & {
13894
+ type: 'show-requested';
13895
+ };
13896
+
13581
13897
  /**
13582
13898
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
13583
13899
  *
@@ -13624,6 +13940,21 @@ declare type Snapshot = {
13624
13940
  };
13625
13941
  };
13626
13942
 
13943
+ /**
13944
+ * Generated when a platform.ApplySnapshot call is resolved.
13945
+ * @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
13946
+ * 1. The window has been created
13947
+ * 2. The window has a responsive API
13948
+ * 3. If a window has a layout property, the 'layout-ready' event has fired
13949
+ *
13950
+ * _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
13951
+ * @interface
13952
+ */
13953
+ declare type SnapshotAppliedEvent = BaseEvent & {
13954
+ topic: 'application';
13955
+ type: 'platform-snapshot-applied';
13956
+ };
13957
+
13627
13958
  /**
13628
13959
  * @interface
13629
13960
  */
@@ -13741,7 +14072,7 @@ declare class SnapshotSourceModule extends Base {
13741
14072
  * Generated when an application has started.
13742
14073
  * @interface
13743
14074
  */
13744
- declare type StartedEvent = IdentityEvent & {
14075
+ declare type StartedEvent = BaseEvents.IdentityEvent & {
13745
14076
  topic: 'application';
13746
14077
  type: 'started';
13747
14078
  };
@@ -15277,12 +15608,9 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
15277
15608
  };
15278
15609
 
15279
15610
  /**
15280
- * [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
15281
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
15282
- * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
15283
- * from which they propagate).
15611
+ * @deprecated Renamed to {@link Event}.
15284
15612
  */
15285
- declare type SystemEvent = ExcludeRequested<PropagatedWindowEvent<'system'>> | PropagatedViewEvent<'system'> | PropagatedApplicationEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
15613
+ declare type SystemEvent = Event_11;
15286
15614
 
15287
15615
  declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
15288
15616
 
@@ -15290,8 +15618,10 @@ declare namespace SystemEvents {
15290
15618
  export {
15291
15619
  NotRequested,
15292
15620
  ExcludeRequested,
15293
- BaseSystemEvent,
15621
+ BaseEvent_8 as BaseEvent,
15622
+ IdleStateChangedEvent,
15294
15623
  IdleEvent,
15624
+ MonitorInfoChangedEvent,
15295
15625
  MonitorEvent,
15296
15626
  SessionChangedEvent,
15297
15627
  AppVersionEvent,
@@ -15305,17 +15635,19 @@ declare namespace SystemEvents {
15305
15635
  ApplicationCreatedEvent,
15306
15636
  DesktopIconClickedEvent,
15307
15637
  SystemShutdownEvent,
15638
+ Event_11 as Event,
15308
15639
  SystemEvent,
15640
+ EventType_8 as EventType,
15309
15641
  SystemEventType,
15310
- Payload_7 as Payload,
15311
- ByType_6 as ByType
15642
+ Payload_9 as Payload,
15643
+ ByType_8 as ByType
15312
15644
  }
15313
15645
  }
15314
15646
 
15315
15647
  /**
15316
- * Union of possible `type` values for a {@link SystemEvent}.
15648
+ * @deprecated Renamed to {@link EventType}.
15317
15649
  */
15318
- declare type SystemEventType = SystemEvent['type'];
15650
+ declare type SystemEventType = EventType_8;
15319
15651
 
15320
15652
  /**
15321
15653
  * @interface
@@ -15372,7 +15704,7 @@ declare type SystemProcessInfo = {
15372
15704
  * Generated when system shutdown or log off.
15373
15705
  * @internal
15374
15706
  */
15375
- declare type SystemShutdownEvent = BaseSystemEvent & {
15707
+ declare type SystemShutdownEvent = BaseEvent_8 & {
15376
15708
  type: 'system-shutdown';
15377
15709
  };
15378
15710
 
@@ -15625,7 +15957,7 @@ declare type TargetApp = string | AppMetadata;
15625
15957
  * In that case, previousTarget identity will be the same as target identity.
15626
15958
  * @interface
15627
15959
  */
15628
- declare type TargetChangedEvent = BaseViewEvent & {
15960
+ declare type TargetChangedEvent = BaseEvent_4 & {
15629
15961
  type: 'target-changed';
15630
15962
  previousTarget: OpenFin_2.Identity;
15631
15963
  };
@@ -15779,7 +16111,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
15779
16111
  * Generated when the tray icon is clicked.
15780
16112
  * @interface
15781
16113
  */
15782
- declare type TrayIconClickedEvent = IdentityEvent & {
16114
+ declare type TrayIconClickedEvent = BaseEvents.IdentityEvent & {
15783
16115
  topic: 'application';
15784
16116
  type: 'tray-icon-clicked';
15785
16117
  button: 0 | 1 | 2;
@@ -15869,7 +16201,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15869
16201
  * A general user bounds change event without event type.
15870
16202
  * @interface
15871
16203
  */
15872
- declare type UserBoundsChangeEvent = BaseWindowEvent & {
16204
+ declare type UserBoundsChangeEvent = BaseEvent_5 & {
15873
16205
  height: number;
15874
16206
  left: number;
15875
16207
  top: number;
@@ -15881,7 +16213,7 @@ declare type UserBoundsChangeEvent = BaseWindowEvent & {
15881
16213
  * Generated when a window's user movement becomes disabled.
15882
16214
  * @interface
15883
16215
  */
15884
- declare type UserMovementDisabledEvent = BaseWindowEvent & {
16216
+ declare type UserMovementDisabledEvent = BaseEvent_5 & {
15885
16217
  type: 'user-movement-disabled';
15886
16218
  };
15887
16219
 
@@ -15889,7 +16221,7 @@ declare type UserMovementDisabledEvent = BaseWindowEvent & {
15889
16221
  * Generated when a window's user movement becomes enabled.
15890
16222
  * @interface
15891
16223
  */
15892
- declare type UserMovementEnabledEvent = BaseWindowEvent & {
16224
+ declare type UserMovementEnabledEvent = BaseEvent_5 & {
15893
16225
  type: 'user-movement-enabled';
15894
16226
  };
15895
16227
 
@@ -16576,7 +16908,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
16576
16908
  * Generated when a View is attached to a window.
16577
16909
  * @interface
16578
16910
  */
16579
- declare type ViewAttachedEvent = BaseWindowEvent & {
16911
+ declare type ViewAttachedEvent = BaseEvent_5 & {
16580
16912
  type: 'view-attached';
16581
16913
  target: OpenFin_2.Identity;
16582
16914
  viewIdentity: OpenFin_2.Identity;
@@ -16618,7 +16950,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
16618
16950
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
16619
16951
  * @interface
16620
16952
  */
16621
- declare type ViewDetachedEvent = BaseWindowEvent & {
16953
+ declare type ViewDetachedEvent = BaseEvent_5 & {
16622
16954
  type: 'view-detached';
16623
16955
  target: OpenFin_2.Identity;
16624
16956
  previousTarget: OpenFin_2.Identity;
@@ -16626,18 +16958,15 @@ declare type ViewDetachedEvent = BaseWindowEvent & {
16626
16958
  };
16627
16959
 
16628
16960
  /**
16629
- * [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
16630
- * discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
16631
- * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
16961
+ * @deprecated Renamed to {@link Event}.
16632
16962
  */
16633
- declare type ViewEvent = (WebContentsEvent<'view'> & {
16634
- target: OpenFin_2.Identity;
16635
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
16963
+ declare type ViewEvent = Event_4;
16636
16964
 
16637
16965
  declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
16638
16966
 
16639
16967
  declare namespace ViewEvents {
16640
16968
  export {
16969
+ BaseEvent_4 as BaseEvent,
16641
16970
  BaseViewEvent,
16642
16971
  TargetChangedEvent,
16643
16972
  NonPropagatedViewEvent,
@@ -16647,20 +16976,24 @@ declare namespace ViewEvents {
16647
16976
  HotkeyEvent,
16648
16977
  ShownEvent,
16649
16978
  HostContextChangedEvent,
16979
+ Event_4 as Event,
16650
16980
  ViewEvent,
16651
16981
  WillPropagateViewEvent,
16982
+ EventType,
16652
16983
  ViewEventType,
16984
+ PropagatedEvent_2 as PropagatedEvent,
16653
16985
  PropagatedViewEvent,
16986
+ PropagatedEventType_2 as PropagatedEventType,
16654
16987
  PropagatedViewEventType,
16655
- Payload_8 as Payload,
16656
- ByType_7 as ByType
16988
+ Payload_2 as Payload,
16989
+ ByType
16657
16990
  }
16658
16991
  }
16659
16992
 
16660
16993
  /**
16661
- * Union of possible `type` values for a {@link OpenFin.ViewEvents.ViewEvent}.
16994
+ * @deprecated Renamed to {@link EventType}.
16662
16995
  */
16663
- declare type ViewEventType = ViewEvent['type'];
16996
+ declare type ViewEventType = EventType;
16664
16997
 
16665
16998
  /**
16666
16999
  * @interface
@@ -17799,12 +18132,9 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17799
18132
  }
17800
18133
 
17801
18134
  /**
17802
- * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
17803
- * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
18135
+ * @deprecated Renamed to {@link Event}.
17804
18136
  */
17805
- declare type WebContentsEvent<Topic extends string> = {
17806
- topic: Topic;
17807
- } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
18137
+ declare type WebContentsEvent<Topic extends string> = Event_5<Topic>;
17808
18138
 
17809
18139
  declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
17810
18140
 
@@ -17816,6 +18146,7 @@ declare namespace WebContentsEvents {
17816
18146
  CrashedEvent_2 as CrashedEvent,
17817
18147
  CertificateErrorEvent,
17818
18148
  CertificateSelectionShownEvent,
18149
+ PageFaviconUpdatedEvent,
17819
18150
  FaviconUpdatedEvent,
17820
18151
  NavigationRejectedEvent,
17821
18152
  UrlChangedEvent,
@@ -17834,6 +18165,7 @@ declare namespace WebContentsEvents {
17834
18165
  FileDownloadStartedEvent,
17835
18166
  FileDownloadProgressEvent,
17836
18167
  FileDownloadCompletedEvent,
18168
+ Event_5 as Event,
17837
18169
  WebContentsEvent,
17838
18170
  WillPropagateWebContentsEvent,
17839
18171
  NonPropagatedWebContentsEvent
@@ -17881,7 +18213,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
17881
18213
  * A general will-move or will-resize event without event type.
17882
18214
  * @interface
17883
18215
  */
17884
- declare type WillMoveOrResizeEvent = BaseWindowEvent & {
18216
+ declare type WillMoveOrResizeEvent = BaseEvent_5 & {
17885
18217
  height: number;
17886
18218
  left: number;
17887
18219
  top: number;
@@ -17903,7 +18235,7 @@ declare type WillPropagateViewEvent = ViewEvent;
17903
18235
  *
17904
18236
  * A WebContents event that does propagate to (republish on) parent topics.
17905
18237
  */
17906
- declare type WillPropagateWebContentsEvent = WebContentsEvent<string>;
18238
+ declare type WillPropagateWebContentsEvent = Event_5<string>;
17907
18239
 
17908
18240
  /**
17909
18241
  * @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
@@ -17917,7 +18249,7 @@ declare type WillPropagateWindowEvent = WindowSourcedEvent;
17917
18249
  * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
17918
18250
  * @interface
17919
18251
  */
17920
- declare type WillRedirectEvent = BaseWindowEvent & {
18252
+ declare type WillRedirectEvent = BaseEvent_5 & {
17921
18253
  type: 'will-redirect';
17922
18254
  blocked: boolean;
17923
18255
  isInPlace: boolean;
@@ -19542,7 +19874,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19542
19874
  * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
19543
19875
  * @interface
19544
19876
  */
19545
- declare type WindowAlertRequestedEvent = BaseApplicationEvent & {
19877
+ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
19546
19878
  type: 'window-alert-requested';
19547
19879
  };
19548
19880
 
@@ -19556,29 +19888,19 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19556
19888
  };
19557
19889
 
19558
19890
  /**
19559
- * Generated when a window has closed.
19560
- * @interface
19891
+ * @deprecated Renamed to {@link ClosedEvent}.
19561
19892
  */
19562
- declare type WindowClosedEvent = BaseWindowEvent & {
19563
- type: 'closed';
19564
- };
19893
+ declare type WindowClosedEvent = ClosedEvent_2;
19565
19894
 
19566
19895
  /**
19567
- * Generated when a window has been prevented from closing.
19568
- * @remarks A window will be prevented from closing by default, either through the API or by a user when ‘close-requested’ has been subscribed to and the Window.close(force) flag is false.
19569
- * @interface
19896
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
19570
19897
  */
19571
- declare type WindowCloseRequestedEvent = BaseWindowEvent & {
19572
- type: 'close-requested';
19573
- };
19898
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
19574
19899
 
19575
19900
  /**
19576
- * Generated when a window has initiated the closing routine.
19577
- * @interface
19901
+ * @deprecated Renamed to {@link ClosingEvent}.
19578
19902
  */
19579
- declare type WindowClosingEvent = BaseWindowEvent & {
19580
- type: 'closing';
19581
- };
19903
+ declare type WindowClosingEvent = ClosingEvent;
19582
19904
 
19583
19905
  /**
19584
19906
  * A rule prescribing content creation in a {@link OpenFin.Window}.
@@ -19600,7 +19922,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19600
19922
  * Generated when a child window is created.
19601
19923
  * @interface
19602
19924
  */
19603
- declare type WindowCreatedEvent = BaseApplicationEvent & {
19925
+ declare type WindowCreatedEvent = BaseEvent_3 & {
19604
19926
  type: 'window-created';
19605
19927
  };
19606
19928
 
@@ -19657,21 +19979,20 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19657
19979
  * Generated when a child window ends loading.
19658
19980
  * @interface
19659
19981
  */
19660
- declare type WindowEndLoadEvent = BaseApplicationEvent & {
19982
+ declare type WindowEndLoadEvent = BaseEvent_3 & {
19661
19983
  type: 'window-end-load';
19662
19984
  };
19663
19985
 
19664
19986
  /**
19665
- * [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
19666
- * discriminated by {@link WindowEvent.type | their type}. Event payloads unique to `Window` can be found
19667
- * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
19987
+ * @deprecated, Renamed to {@link Event}.
19668
19988
  */
19669
- declare type WindowEvent = WindowSourcedEvent | PropagatedViewEvent<'window'>;
19989
+ declare type WindowEvent = Event_6;
19670
19990
 
19671
19991
  declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
19672
19992
 
19673
19993
  declare namespace WindowEvents {
19674
19994
  export {
19995
+ BaseEvent_5 as BaseEvent,
19675
19996
  BaseWindowEvent,
19676
19997
  ViewAttachedEvent,
19677
19998
  ViewDetachedEvent,
@@ -19681,9 +20002,11 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19681
20002
  EndLoadEvent,
19682
20003
  WillRedirectEvent,
19683
20004
  ReloadedEvent,
20005
+ OptionsChangedEvent,
19684
20006
  WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
19685
20007
  ExternalProcessExitedEvent,
19686
20008
  ExternalProcessStartedEvent,
20009
+ HiddenEvent_2 as HiddenEvent,
19687
20010
  WindowHiddenEvent,
19688
20011
  PreloadScriptInfoRunning,
19689
20012
  PreloadScriptInfo,
@@ -19698,22 +20021,30 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19698
20021
  BeginUserBoundsChangingEvent,
19699
20022
  BoundsChangedEvent,
19700
20023
  BoundsChangingEvent,
20024
+ CloseRequestedEvent,
19701
20025
  WindowCloseRequestedEvent,
19702
20026
  ContextChangedEvent,
20027
+ ClosedEvent_2 as ClosedEvent,
19703
20028
  WindowClosedEvent,
20029
+ ClosingEvent,
19704
20030
  WindowClosingEvent,
19705
20031
  DisabledMovementBoundsChangedEvent,
19706
20032
  DisabledMovementBoundsChangingEvent,
19707
20033
  EmbeddedEvent,
19708
20034
  EndUserBoundsChangingEvent,
20035
+ HotkeyEvent_2 as HotkeyEvent,
19709
20036
  WindowHotkeyEvent,
20037
+ InitializedEvent_2 as InitializedEvent,
19710
20038
  WindowInitializedEvent,
19711
20039
  MaximizedEvent,
19712
20040
  MinimizedEvent,
19713
20041
  PreloadScriptsStateChangedEvent,
19714
20042
  PreloadScriptsStateChangingEvent,
20043
+ RestoredEvent,
19715
20044
  WindowRestoredEvent,
20045
+ ShowRequestedEvent,
19716
20046
  WindowShowRequestedEvent,
20047
+ ShownEvent_2 as ShownEvent,
19717
20048
  WindowShownEvent,
19718
20049
  UserMovementEnabledEvent,
19719
20050
  UserMovementDisabledEvent,
@@ -19724,37 +20055,32 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19724
20055
  DownloadShelfVisibilityChangedEvent,
19725
20056
  WindowSourcedEvent,
19726
20057
  WillPropagateWindowEvent,
20058
+ Event_6 as Event,
19727
20059
  WindowEvent,
20060
+ EventType_2 as EventType,
19728
20061
  WindowEventType,
20062
+ PropagatedEvent_3 as PropagatedEvent,
19729
20063
  PropagatedWindowEvent,
19730
20064
  PropagatedWindowEventType,
19731
- Payload_9 as Payload,
19732
- ByType_8 as ByType
20065
+ Payload_3 as Payload,
20066
+ ByType_2 as ByType
19733
20067
  }
19734
20068
  }
19735
20069
 
19736
20070
  /**
19737
- * Union of possible `type` values for a {@link OpenFin.WindowEvents.WindowEvent}.
20071
+ * @deprecated Renamed to {@link EventType}.
19738
20072
  */
19739
20073
  declare type WindowEventType = WindowEvent['type'];
19740
20074
 
19741
20075
  /**
19742
- * Generated when a window has been hidden.
19743
- * @interface
20076
+ * @deprecated Renamed to {@link HiddenEvent}.
19744
20077
  */
19745
- declare type WindowHiddenEvent = BaseWindowEvent & {
19746
- type: 'hidden';
19747
- reason: 'closing' | 'hide' | 'hide-on-close';
19748
- };
20078
+ declare type WindowHiddenEvent = HiddenEvent_2;
19749
20079
 
19750
20080
  /**
19751
- * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
19752
- * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
19753
- * @interface
20081
+ * @deprecated Renamed to {@link HotkeyEvent}.
19754
20082
  */
19755
- declare type WindowHotkeyEvent = InputEvent_2 & BaseWindowEvent & {
19756
- type: 'hotkey';
19757
- };
20083
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
19758
20084
 
19759
20085
  /**
19760
20086
  * @interface
@@ -19768,12 +20094,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19768
20094
  };
19769
20095
 
19770
20096
  /**
19771
- * Generated when a window is initialized.
19772
- * @interface
20097
+ * @deprecated Renamed to {@link InitializedEvent}.
19773
20098
  */
19774
- declare type WindowInitializedEvent = BaseWindowEvent & {
19775
- type: 'initialized';
19776
- };
20099
+ declare type WindowInitializedEvent = InitializedEvent_2;
19777
20100
 
19778
20101
  /**
19779
20102
  * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
@@ -19870,7 +20193,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19870
20193
  * Generated when a child window is not responding.
19871
20194
  * @interface
19872
20195
  */
19873
- declare type WindowNotRespondingEvent = BaseApplicationEvent & {
20196
+ declare type WindowNotRespondingEvent = BaseEvent_3 & {
19874
20197
  type: 'window-not-responding';
19875
20198
  };
19876
20199
 
@@ -19892,15 +20215,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19892
20215
  declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
19893
20216
 
19894
20217
  /**
19895
- * Generated after window options are changed using the window.updateOptions method.
19896
- * @remarks Will not fire if the diff object is empty.
19897
- * @interface
20218
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
19898
20219
  */
19899
- declare type WindowOptionsChangedEvent_2 = BaseWindowEvent & {
19900
- type: 'options-changed';
19901
- options: OpenFin_2.WindowOptions;
19902
- diff: OpenFin_2.WindowOptionDiff;
19903
- };
20220
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
19904
20221
 
19905
20222
  declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
19906
20223
 
@@ -19908,46 +20225,36 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19908
20225
  * Generated when a child window is responding.
19909
20226
  * @interface
19910
20227
  */
19911
- declare type WindowRespondingEvent = BaseApplicationEvent & {
20228
+ declare type WindowRespondingEvent = BaseEvent_3 & {
19912
20229
  type: 'window-responding';
19913
20230
  };
19914
20231
 
19915
20232
  /**
19916
- * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
19917
- * @interface
20233
+ * @deprecated Renamed to {@link RestoredEvent}.
19918
20234
  */
19919
- declare type WindowRestoredEvent = BaseWindowEvent & {
19920
- type: 'restored';
19921
- };
20235
+ declare type WindowRestoredEvent = RestoredEvent;
19922
20236
 
19923
20237
  /**
19924
- * Generated when a hidden window has been shown.
19925
- * @interface
20238
+ * @deprecated Renamed to {@link ShownEvent}.
19926
20239
  */
19927
- declare type WindowShownEvent = BaseWindowEvent & {
19928
- type: 'shown';
19929
- };
20240
+ declare type WindowShownEvent = ShownEvent_2;
19930
20241
 
19931
20242
  /**
19932
- * Generated when a window has been prevented from showing.
19933
- * @remarks A window will be prevented from showing by default, either through the API or by a user when ‘show-requested’ has been subscribed to on the window or 'window-show-requested' on the parent application and the Window.show(force) flag is false.
19934
- * @interface
20243
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
19935
20244
  */
19936
- declare type WindowShowRequestedEvent = BaseWindowEvent & {
19937
- type: 'show-requested';
19938
- };
20245
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
19939
20246
 
19940
20247
  /**
19941
20248
  * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19942
20249
  * from {@link OpenFin.ViewEvents}.
19943
20250
  */
19944
- declare type WindowSourcedEvent = WebContentsEvent<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | WindowCloseRequestedEvent | WindowClosedEvent | WindowClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | WindowHiddenEvent | WindowHotkeyEvent | WindowInitializedEvent | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | WindowOptionsChangedEvent_2 | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | WindowRestoredEvent | WindowShowRequestedEvent | WindowShownEvent | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillRedirectEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
20251
+ declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillRedirectEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
19945
20252
 
19946
20253
  /**
19947
20254
  * Generated when a child window starts loading.
19948
20255
  * @interface
19949
20256
  */
19950
- declare type WindowStartLoadEvent = BaseApplicationEvent & {
20257
+ declare type WindowStartLoadEvent = BaseEvent_3 & {
19951
20258
  type: 'window-start-load';
19952
20259
  };
19953
20260