@openfin/core 34.78.51 → 35.78.2

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,
@@ -921,7 +924,9 @@ declare namespace ApplicationEvents {
921
924
  WindowRespondingEvent,
922
925
  WindowStartLoadEvent,
923
926
  ApplicationWindowEvent,
927
+ ApplicationWindowEventTypes,
924
928
  ClosedEvent,
929
+ ConnectedEvent_2 as ConnectedEvent,
925
930
  ApplicationConnectedEvent,
926
931
  InitializedEvent,
927
932
  ManifestChangedEvent,
@@ -929,19 +934,23 @@ declare namespace ApplicationEvents {
929
934
  RespondingEvent,
930
935
  StartedEvent,
931
936
  ApplicationSourcedEvent,
937
+ Event_3 as Event,
932
938
  ApplicationEvent,
939
+ EventType_3 as EventType,
933
940
  ApplicationEventType,
941
+ PropagatedEvent_4 as PropagatedEvent,
934
942
  PropagatedApplicationEvent,
943
+ PropagatedEventType_3 as PropagatedEventType,
935
944
  PropagatedApplicationEventType,
936
- Payload_2 as Payload,
937
- ByType
945
+ Payload_4 as Payload,
946
+ ByType_3 as ByType
938
947
  }
939
948
  }
940
949
 
941
950
  /**
942
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
951
+ * @deprecated Renamed to {@link EventType}.
943
952
  */
944
- declare type ApplicationEventType = ApplicationEvent['type'];
953
+ declare type ApplicationEventType = EventType_3;
945
954
 
946
955
  declare type ApplicationIdentity = OpenFin_2.ApplicationIdentity;
947
956
 
@@ -1294,9 +1303,8 @@ declare type ApplicationPermissions = {
1294
1303
  * A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
1295
1304
  * from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
1296
1305
  * does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
1297
- *
1298
1306
  */
1299
- declare type ApplicationSourcedEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1307
+ declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1300
1308
 
1301
1309
  declare type ApplicationState = OpenFin_2.ApplicationState;
1302
1310
 
@@ -1335,6 +1343,11 @@ declare type ApplicationType = {
1335
1343
  */
1336
1344
  declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedEvent | WindowEndLoadEvent | WindowNotRespondingEvent | WindowRespondingEvent | WindowStartLoadEvent;
1337
1345
 
1346
+ /**
1347
+ * Array of valid `type` values for an {@link ApplicationWindowEvent}.
1348
+ */
1349
+ declare const ApplicationWindowEventTypes: readonly ["window-alert-requested", "window-created", "window-end-load", "window-not-responding", "window-responding", "window-start-load"];
1350
+
1338
1351
  declare type ApplicationWindowInfo = OpenFin_2.ApplicationWindowInfo;
1339
1352
 
1340
1353
  /**
@@ -1612,7 +1625,7 @@ declare interface AuthorizationPayload {
1612
1625
  * ```
1613
1626
  * @interface
1614
1627
  */
1615
- declare type AuthRequestedEvent = BaseWindowEvent & {
1628
+ declare type AuthRequestedEvent = BaseEvent_5 & {
1616
1629
  type: 'auth-requested';
1617
1630
  authInfo: {
1618
1631
  host: string;
@@ -1680,21 +1693,9 @@ declare class Base {
1680
1693
  }
1681
1694
 
1682
1695
  /**
1683
- * Base type for events emitting on the `application` topic
1684
- * @interface
1696
+ * @deprecated Renamed to {@link BaseEvent}.
1685
1697
  */
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
- };
1698
+ declare type BaseApplicationEvent = BaseEvent_3;
1698
1699
 
1699
1700
  /**
1700
1701
  * @interface
@@ -1763,10 +1764,70 @@ declare type BaseEvent = {
1763
1764
  type: string;
1764
1765
  };
1765
1766
 
1766
- declare type BaseEvent_2 = Events.BaseEvents.BaseEvent;
1767
+ /**
1768
+ * A base Channel event.
1769
+ * @interface
1770
+ */
1771
+ declare type BaseEvent_2 = NamedEvent & {
1772
+ channelName: string;
1773
+ channelId: string;
1774
+ };
1775
+
1776
+ /**
1777
+ * Base type for events emitting on the `application` topic
1778
+ * @interface
1779
+ */
1780
+ declare type BaseEvent_3 = BaseEvents.NamedEvent & {
1781
+ topic: `application`;
1782
+ };
1783
+
1784
+ /**
1785
+ * Base type for events emitting on the `view` topic
1786
+ * @interface
1787
+ */
1788
+ declare type BaseEvent_4 = BaseEvents.NamedEvent & {
1789
+ topic: 'view';
1790
+ target: OpenFin_2.Identity;
1791
+ };
1792
+
1793
+ /**
1794
+ * Base type for events emitting on the `window` topic
1795
+ * @interface
1796
+ */
1797
+ declare type BaseEvent_5 = BaseEvents.NamedEvent & {
1798
+ topic: 'window';
1799
+ };
1800
+
1801
+ /**
1802
+ * Base type for events emitting on the `externalapplication` topic
1803
+ * @interface
1804
+ */
1805
+ declare type BaseEvent_6 = BaseEvents.BaseEvent & {
1806
+ topic: 'externalapplication';
1807
+ };
1808
+
1809
+ /**
1810
+ * The base frame event.
1811
+ * @interface
1812
+ */
1813
+ declare type BaseEvent_7 = NamedEvent & {
1814
+ entityType: 'iframe';
1815
+ frameName: string;
1816
+ };
1817
+
1818
+ /**
1819
+ * Base type for events emitting on the `system` topic
1820
+ * @interface
1821
+ */
1822
+ declare type BaseEvent_8 = BaseEvents.BaseEvent & {
1823
+ topic: 'system';
1824
+ };
1825
+
1826
+ declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
1767
1827
 
1768
1828
  declare namespace BaseEvents {
1769
1829
  export {
1830
+ NotCloseRequested,
1770
1831
  PropagatedEventType,
1771
1832
  PropagatedEvent,
1772
1833
  EventHandler,
@@ -1777,21 +1838,14 @@ declare namespace BaseEvents {
1777
1838
  }
1778
1839
 
1779
1840
  /**
1780
- * Base type for events emitting on the `externalapplication` topic
1781
- * @interface
1841
+ * @deprecated Renamed to {@link BaseEvent}.
1782
1842
  */
1783
- declare type BaseExternalApplicationEvent = BaseEvent & {
1784
- topic: 'externalapplication';
1785
- };
1843
+ declare type BaseExternalApplicationEvent = BaseEvent_6;
1786
1844
 
1787
1845
  /**
1788
- * The base frame event.
1789
- * @interface
1846
+ * @deprecated Renamed to {@link BaseEvent}.
1790
1847
  */
1791
- declare type BaseFrameEvent = NamedEvent & {
1792
- entityType: 'iframe';
1793
- frameName: string;
1794
- };
1848
+ declare type BaseFrameEvent = BaseEvent_7;
1795
1849
 
1796
1850
  declare type BaseLoadFailedEvent = NamedEvent & {
1797
1851
  errorCode: number;
@@ -1800,35 +1854,20 @@ declare type BaseLoadFailedEvent = NamedEvent & {
1800
1854
  isMainFrame: boolean;
1801
1855
  };
1802
1856
 
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
1857
  declare type BaseUrlEvent = NamedEvent & {
1812
1858
  type: 'url-changed';
1813
1859
  url: string;
1814
1860
  };
1815
1861
 
1816
1862
  /**
1817
- * Base type for events emitting on the `view` topic
1818
- * @interface
1863
+ * @deprecated Renamed to {@link BaseEvent}.
1819
1864
  */
1820
- declare type BaseViewEvent = NamedEvent & {
1821
- topic: 'view';
1822
- target: OpenFin_2.Identity;
1823
- };
1865
+ declare type BaseViewEvent = BaseEvent_4;
1824
1866
 
1825
1867
  /**
1826
- * Base type for events emitting on the `window` topic
1827
- * @interface
1868
+ * @deprecated Renamed to {@link BaseEvent}.
1828
1869
  */
1829
- declare type BaseWindowEvent = NamedEvent & {
1830
- topic: 'window';
1831
- };
1870
+ declare type BaseWindowEvent = BaseEvent_5;
1832
1871
 
1833
1872
  /**
1834
1873
  * User decision of whether a Window or specific View should close when trying to prevent an unload.
@@ -1895,7 +1934,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
1895
1934
  * A general bounds change event without event type.
1896
1935
  * @interface
1897
1936
  */
1898
- declare type BoundsChangeEvent = BaseWindowEvent & {
1937
+ declare type BoundsChangeEvent = BaseEvent_5 & {
1899
1938
  changeType: 0 | 1 | 2;
1900
1939
  deferred: boolean;
1901
1940
  height: number;
@@ -1967,76 +2006,76 @@ declare interface BrowserWindow {
1967
2006
  }
1968
2007
 
1969
2008
  /**
1970
- * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
2009
+ * Extracts a single event type matching the given key from the View {@link Event} union.
1971
2010
  *
1972
2011
  * Alias for {@link Payload}, which may read better in source.
1973
2012
  *
1974
2013
  * @typeParam Type String key specifying the event to extract
1975
2014
  */
1976
- declare type ByType<Type extends ApplicationEventType> = Payload_2<Type>;
2015
+ declare type ByType<Type extends EventType> = Payload_2<Type>;
1977
2016
 
1978
2017
  /**
1979
- * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
2018
+ * Extracts a single event type matching the given key from the Window {@link Event} union.
1980
2019
  *
1981
2020
  * Alias for {@link Payload}, which may read better in source.
1982
2021
  *
1983
2022
  * @typeParam Type String key specifying the event to extract
1984
2023
  */
1985
- declare type ByType_2<Type extends ExternalApplicationEventType> = Payload_3<Type>;
2024
+ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
1986
2025
 
1987
2026
  /**
1988
- * Extracts a single event type matching the given key from the {@link FrameEvent} union.
2027
+ * Extracts a single event type matching the given key from the Application {@link Event} union.
1989
2028
  *
1990
2029
  * Alias for {@link Payload}, which may read better in source.
1991
2030
  *
1992
2031
  * @typeParam Type String key specifying the event to extract
1993
2032
  */
1994
- declare type ByType_3<Type extends FrameEventType> = Payload_4<Type>;
2033
+ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
1995
2034
 
1996
2035
  /**
1997
- * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
2036
+ * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
1998
2037
  *
1999
2038
  * Alias for {@link Payload}, which may read better in source.
2000
2039
  *
2001
2040
  * @typeParam Type String key specifying the event to extract
2002
2041
  */
2003
- declare type ByType_4<Type extends GlobalHotkeyEventType> = Payload_5<Type>;
2042
+ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
2004
2043
 
2005
2044
  /**
2006
- * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
2045
+ * Extracts a single event type matching the given key from the Frame {@link Event} union.
2007
2046
  *
2008
2047
  * Alias for {@link Payload}, which may read better in source.
2009
2048
  *
2010
2049
  * @typeParam Type String key specifying the event to extract
2011
2050
  */
2012
- declare type ByType_5<Type extends PlatformEventType> = Payload_6<Type>;
2051
+ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
2013
2052
 
2014
2053
  /**
2015
- * Extracts a single event type matching the given key from the {@link SystemEvent} union.
2054
+ * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
2016
2055
  *
2017
2056
  * Alias for {@link Payload}, which may read better in source.
2018
2057
  *
2019
2058
  * @typeParam Type String key specifying the event to extract
2020
2059
  */
2021
- declare type ByType_6<Type extends SystemEventType> = Payload_7<Type>;
2060
+ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
2022
2061
 
2023
2062
  /**
2024
- * Extracts a single event type matching the given key from the {@link ViewEvent} union.
2063
+ * Extracts a single event type matching the given key from the Platform {@link Event} union.
2025
2064
  *
2026
2065
  * Alias for {@link Payload}, which may read better in source.
2027
2066
  *
2028
2067
  * @typeParam Type String key specifying the event to extract
2029
2068
  */
2030
- declare type ByType_7<Type extends ViewEventType> = Payload_8<Type>;
2069
+ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
2031
2070
 
2032
2071
  /**
2033
- * Extracts a single event type matching the given key from the {@link WindowEvent} union.
2072
+ * Extracts a single event type matching the given key from the System {@link Event} union.
2034
2073
  *
2035
2074
  * Alias for {@link Payload}, which may read better in source.
2036
2075
  *
2037
2076
  * @typeParam Type String key specifying the event to extract
2038
2077
  */
2039
- declare type ByType_8<Type extends WindowEventType> = Payload_9<Type>;
2078
+ declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
2040
2079
 
2041
2080
  /**
2042
2081
  * Configuration for page capture.
@@ -2719,14 +2758,6 @@ declare type ChannelClientConnectionListener = (identity: ClientIdentity, connec
2719
2758
 
2720
2759
  declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
2721
2760
 
2722
- /**
2723
- * Generated when a Channel client is connected.
2724
- * @interface
2725
- */
2726
- declare type ChannelConnectedEvent = BaseChannelEvent & {
2727
- type: 'connected';
2728
- };
2729
-
2730
2761
  /**
2731
2762
  * Options provided on a client connection to a channel.
2732
2763
  *
@@ -2758,21 +2789,9 @@ declare type ChannelCreateOptions = {
2758
2789
  };
2759
2790
 
2760
2791
  /**
2761
- * Generated when a Channel client has disconnected.
2762
- * @interface
2792
+ * @deprecated Renamed to {@link Event}.
2763
2793
  */
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);
2794
+ declare type ChannelEvent = Event_2;
2776
2795
 
2777
2796
  declare type ChannelMiddleware = OpenFin_2.ChannelMiddleware;
2778
2797
 
@@ -3310,11 +3329,19 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
3310
3329
  * Generated when an application is closed.
3311
3330
  * @interface
3312
3331
  */
3313
- declare type ClosedEvent = IdentityEvent & {
3332
+ declare type ClosedEvent = BaseEvents.IdentityEvent & {
3314
3333
  topic: 'application';
3315
3334
  type: 'closed';
3316
3335
  };
3317
3336
 
3337
+ /**
3338
+ * Generated when a window has closed.
3339
+ * @interface
3340
+ */
3341
+ declare type ClosedEvent_2 = BaseEvent_5 & {
3342
+ type: 'closed';
3343
+ };
3344
+
3318
3345
  /**
3319
3346
  * @interface
3320
3347
  */
@@ -3322,6 +3349,15 @@ declare type ClosedMenuResult = {
3322
3349
  result: 'closed';
3323
3350
  };
3324
3351
 
3352
+ /**
3353
+ * Generated when a window has been prevented from closing.
3354
+ * @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.
3355
+ * @interface
3356
+ */
3357
+ declare type CloseRequestedEvent = BaseEvent_5 & {
3358
+ type: 'close-requested';
3359
+ };
3360
+
3325
3361
  /**
3326
3362
  * @interface
3327
3363
  */
@@ -3368,6 +3404,14 @@ declare interface CloseWindowPayload {
3368
3404
  };
3369
3405
  }
3370
3406
 
3407
+ /**
3408
+ * Generated when a window has initiated the closing routine.
3409
+ * @interface
3410
+ */
3411
+ declare type ClosingEvent = BaseEvent_5 & {
3412
+ type: 'closing';
3413
+ };
3414
+
3371
3415
  /**
3372
3416
  * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
3373
3417
  */
@@ -3501,6 +3545,39 @@ declare type ConfigWithUuid = BaseConfig & {
3501
3545
  uuid: string;
3502
3546
  };
3503
3547
 
3548
+ /**
3549
+ * Generated when a Channel client is connected.
3550
+ * @interface
3551
+ */
3552
+ declare type ConnectedEvent = BaseEvent_2 & {
3553
+ type: 'connected';
3554
+ };
3555
+
3556
+ /**
3557
+ * Generated when an application has authenticated and is connected.
3558
+ * @interface
3559
+ */
3560
+ declare type ConnectedEvent_2 = BaseEvents.IdentityEvent & {
3561
+ topic: 'application';
3562
+ type: 'connected';
3563
+ };
3564
+
3565
+ /**
3566
+ * Generated when an external application has authenticated and is connected.
3567
+ * @interface
3568
+ */
3569
+ declare type ConnectedEvent_3 = BaseExternalApplicationEvent & {
3570
+ type: 'connected';
3571
+ };
3572
+
3573
+ /**
3574
+ * Generated when a frame is connected.
3575
+ * @interface
3576
+ */
3577
+ declare type ConnectedEvent_4 = BaseFrameEvent & {
3578
+ type: 'connected';
3579
+ };
3580
+
3504
3581
  declare type Constructor<T = {}> = new () => T;
3505
3582
 
3506
3583
  declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
@@ -4242,7 +4319,7 @@ declare type Context_3 = {
4242
4319
  * Generated when a window's context is updated via {@link Platform#setWindowContext Platform.setWindowContext}. Only available on windows in a Platform.
4243
4320
  * @interface
4244
4321
  */
4245
- declare type ContextChangedEvent = BaseWindowEvent & {
4322
+ declare type ContextChangedEvent = BaseEvent_5 & {
4246
4323
  type: 'context-changed';
4247
4324
  context: any;
4248
4325
  };
@@ -4394,7 +4471,7 @@ declare type CpuInfo = {
4394
4471
  * Generated when an application has crashed.
4395
4472
  * @interface
4396
4473
  */
4397
- declare type CrashedEvent = IdentityEvent & {
4474
+ declare type CrashedEvent = BaseEvents.IdentityEvent & {
4398
4475
  topic: 'application';
4399
4476
  type: 'crashed';
4400
4477
  reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
@@ -4445,7 +4522,7 @@ declare type CrashReporterState = CrashReporterOptions & {
4445
4522
  * Generated when a View is created.
4446
4523
  * @interface
4447
4524
  */
4448
- declare type CreatedEvent = BaseViewEvent & {
4525
+ declare type CreatedEvent = BaseEvent_4 & {
4449
4526
  type: 'created';
4450
4527
  };
4451
4528
 
@@ -4604,7 +4681,7 @@ declare interface DesktopAgent_2 {
4604
4681
  * Generated when the desktop icon is clicked while it's already running.
4605
4682
  * @interface
4606
4683
  */
4607
- declare type DesktopIconClickedEvent = BaseSystemEvent & {
4684
+ declare type DesktopIconClickedEvent = BaseEvent_8 & {
4608
4685
  type: 'desktop-icon-clicked';
4609
4686
  };
4610
4687
 
@@ -4612,7 +4689,7 @@ declare type DesktopIconClickedEvent = BaseSystemEvent & {
4612
4689
  * Generated when a View is destroyed.
4613
4690
  * @interface
4614
4691
  */
4615
- declare type DestroyedEvent = BaseViewEvent & {
4692
+ declare type DestroyedEvent = BaseEvent_4 & {
4616
4693
  type: 'destroyed';
4617
4694
  };
4618
4695
 
@@ -4712,6 +4789,30 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
4712
4789
  type: 'disabled-movement-bounds-changing';
4713
4790
  };
4714
4791
 
4792
+ /**
4793
+ * Generated when a Channel client has disconnected.
4794
+ * @interface
4795
+ */
4796
+ declare type DisconnectedEvent = BaseEvent_2 & {
4797
+ type: 'disconnected';
4798
+ };
4799
+
4800
+ /**
4801
+ * Generated when an external application has disconnected.
4802
+ * @interface
4803
+ */
4804
+ declare type DisconnectedEvent_2 = BaseExternalApplicationEvent & {
4805
+ type: 'disconnected';
4806
+ };
4807
+
4808
+ /**
4809
+ * Generated when a frame has disconnected.
4810
+ * @interface
4811
+ */
4812
+ declare type DisconnectedEvent_3 = BaseFrameEvent & {
4813
+ type: 'disconnected';
4814
+ };
4815
+
4715
4816
  /**
4716
4817
  * A system channel will be global enough to have a presence across many apps. This gives us some hints
4717
4818
  * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
@@ -4845,7 +4946,7 @@ declare type DownloadShelfOptions = {
4845
4946
  *
4846
4947
  * @interface
4847
4948
  */
4848
- declare type DownloadShelfVisibilityChangedEvent = BaseWindowEvent & {
4949
+ declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
4849
4950
  type: 'download-shelf-visibility-changed';
4850
4951
  /**
4851
4952
  * True if the download shelf was just opened; false if it was just closed.
@@ -4875,7 +4976,7 @@ declare interface DragSource {}
4875
4976
  * Generated when a window has been embedded.
4876
4977
  * @interface
4877
4978
  */
4878
- declare type EmbeddedEvent = BaseWindowEvent & {
4979
+ declare type EmbeddedEvent = BaseEvent_5 & {
4879
4980
  type: 'embedded';
4880
4981
  };
4881
4982
 
@@ -4979,7 +5080,7 @@ declare class EmitterMap {
4979
5080
  * Generated when a window ends loading.
4980
5081
  * @interface
4981
5082
  */
4982
- declare type EndLoadEvent = BaseWindowEvent & {
5083
+ declare type EndLoadEvent = BaseEvent_5 & {
4983
5084
  type: 'end-load';
4984
5085
  documentName: string;
4985
5086
  isMain: boolean;
@@ -5096,6 +5197,88 @@ declare type ErrorPlainObject = {
5096
5197
  toString(): string;
5097
5198
  };
5098
5199
 
5200
+ /**
5201
+ * [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
5202
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5203
+ * under the {@link OpenFin.PlatformEvents} namespace.
5204
+ */
5205
+ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5206
+
5207
+ /**
5208
+ * [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
5209
+ * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5210
+ * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5211
+ * from which they propagate).
5212
+ */
5213
+ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ViewEvents.PropagatedEvent<'system'> | ApplicationEvents.PropagatedEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
5214
+
5215
+ /**
5216
+ * [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
5217
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5218
+ * under the {@link OpenFin.ChannelEvents} namespace.
5219
+ */
5220
+ declare type Event_2 = {
5221
+ topic: 'channel';
5222
+ } & (ConnectedEvent | DisconnectedEvent);
5223
+
5224
+ /**
5225
+ * [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
5226
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5227
+ * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5228
+ * from which they propagate).
5229
+ */
5230
+ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.PropagatedEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
5231
+
5232
+ /**
5233
+ * [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
5234
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5235
+ * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5236
+ */
5237
+ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
5238
+ target: OpenFin_2.Identity;
5239
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
5240
+
5241
+ /**
5242
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
5243
+ * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
5244
+ */
5245
+ declare type Event_5<Topic extends string> = {
5246
+ topic: Topic;
5247
+ } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
5248
+
5249
+ /**
5250
+ * [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
5251
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5252
+ * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5253
+ */
5254
+ declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5255
+
5256
+ /**
5257
+ * [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
5258
+ * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5259
+ * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5260
+ */
5261
+ declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5262
+
5263
+ /**
5264
+ * [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
5265
+ * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5266
+ * under the {@link OpenFin.FrameEvents} namespace.
5267
+ */
5268
+ declare type Event_8 = {
5269
+ topic: 'frame';
5270
+ } & (ConnectedEvent_4 | DisconnectedEvent_3);
5271
+
5272
+ /**
5273
+ * [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
5274
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5275
+ * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5276
+ */
5277
+ declare type Event_9 = {
5278
+ topic: 'global-hotkey';
5279
+ hotkey: 'string';
5280
+ } & (RegisteredEvent | UnregisteredEvent);
5281
+
5099
5282
  declare class EventAggregator extends EmitterMap {
5100
5283
  dispatchEvent: (message: Message<any>) => boolean;
5101
5284
  }
@@ -5161,6 +5344,46 @@ declare namespace Events {
5161
5344
  }
5162
5345
  }
5163
5346
 
5347
+ /**
5348
+ * Union of possible `type` values for a view {@link Event}.
5349
+ */
5350
+ declare type EventType = Event_4['type'];
5351
+
5352
+ /**
5353
+ * Union of possible `type` values for a Window {@link Event}.
5354
+ */
5355
+ declare type EventType_2 = Event_6['type'];
5356
+
5357
+ /**
5358
+ * Union of possible `type` values for an Application {@link Event}.
5359
+ */
5360
+ declare type EventType_3 = Event_3['type'];
5361
+
5362
+ /**
5363
+ * Union of possible `type` values for an ExternalApplication {@link Event}.
5364
+ */
5365
+ declare type EventType_4 = Event_7['type'];
5366
+
5367
+ /**
5368
+ * Union of possible `type` values for a {@link FrameEvent}.
5369
+ */
5370
+ declare type EventType_5 = Event_8['type'];
5371
+
5372
+ /**
5373
+ * Union of possible `type` values for a {@link GlobalHotkeyEvent}
5374
+ */
5375
+ declare type EventType_6 = Event_9['type'];
5376
+
5377
+ /**
5378
+ * Union of possible `type` values for a {@link PlatformEvent}.
5379
+ */
5380
+ declare type EventType_7 = Event_10['type'];
5381
+
5382
+ /**
5383
+ * Union of possible `type` values for a {@link SystemEvent}.
5384
+ */
5385
+ declare type EventType_8 = SystemEvent['type'];
5386
+
5164
5387
  /**
5165
5388
  * @internal
5166
5389
  */
@@ -5174,6 +5397,8 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
5174
5397
 
5175
5398
  /**
5176
5399
  * @internal
5400
+ *
5401
+ * Ensures that an event payload type does not include any `-requested` events. Distributes over unions.
5177
5402
  */
5178
5403
  declare type ExcludeRequested<Event extends {
5179
5404
  type: string;
@@ -5303,46 +5528,43 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
5303
5528
  }
5304
5529
 
5305
5530
  /**
5306
- * Generated when an external application has authenticated and is connected.
5307
- * @interface
5531
+ * @deprecated Renamed to {@link ConnectedEvent}.
5308
5532
  */
5309
- declare type ExternalApplicationConnectedEvent = BaseExternalApplicationEvent & {
5310
- type: 'connected';
5311
- };
5533
+ declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
5312
5534
 
5313
5535
  /**
5314
- * Generated when an external application has disconnected.
5315
- * @interface
5536
+ * @deprecated Renamed to {@link DisconnectedEvent}.
5316
5537
  */
5317
- declare type ExternalApplicationDisconnectedEvent = BaseExternalApplicationEvent & {
5318
- type: 'disconnected';
5319
- };
5538
+ declare type ExternalApplicationDisconnectedEvent = DisconnectedEvent_2;
5320
5539
 
5321
5540
  /**
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.
5541
+ * @deprecated Renamed to {@link Event}.
5325
5542
  */
5326
- declare type ExternalApplicationEvent = ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent;
5543
+ declare type ExternalApplicationEvent = Event_7;
5327
5544
 
5328
5545
  declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
5329
5546
 
5330
5547
  declare namespace ExternalApplicationEvents {
5331
5548
  export {
5549
+ BaseEvent_6 as BaseEvent,
5332
5550
  BaseExternalApplicationEvent,
5551
+ ConnectedEvent_3 as ConnectedEvent,
5333
5552
  ExternalApplicationConnectedEvent,
5553
+ DisconnectedEvent_2 as DisconnectedEvent,
5334
5554
  ExternalApplicationDisconnectedEvent,
5555
+ Event_7 as Event,
5335
5556
  ExternalApplicationEvent,
5557
+ EventType_4 as EventType,
5336
5558
  ExternalApplicationEventType,
5337
- Payload_3 as Payload,
5338
- ByType_2 as ByType
5559
+ Payload_5 as Payload,
5560
+ ByType_4 as ByType
5339
5561
  }
5340
5562
  }
5341
5563
 
5342
5564
  /**
5343
- * Union of possible `type` values for a {@link ApplicationEvent}.
5565
+ * @deprecated Renamed to {@link Event}.
5344
5566
  */
5345
- declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
5567
+ declare type ExternalApplicationEventType = EventType_4;
5346
5568
 
5347
5569
  /**
5348
5570
  * @interface
@@ -5403,7 +5625,7 @@ declare type ExternalConnection = {
5403
5625
  * Generated when an external process has exited.
5404
5626
  * @interface
5405
5627
  */
5406
- declare type ExternalProcessExitedEvent = BaseWindowEvent & {
5628
+ declare type ExternalProcessExitedEvent = BaseEvent_5 & {
5407
5629
  type: 'external-process-exited';
5408
5630
  processUuid: string;
5409
5631
  exitCode: number;
@@ -5448,19 +5670,15 @@ declare type ExternalProcessRequestType = {
5448
5670
  * Generated when an external process has started.
5449
5671
  * @interface
5450
5672
  */
5451
- declare type ExternalProcessStartedEvent = BaseWindowEvent & {
5673
+ declare type ExternalProcessStartedEvent = BaseEvent_5 & {
5452
5674
  type: 'external-process-started';
5453
5675
  processUuid: string;
5454
5676
  };
5455
5677
 
5456
5678
  /**
5457
- * Generated when page receives favicon urls.
5458
- * @interface
5679
+ * @deprecated, use {@link PageFaviconUpdatedEvent}.
5459
5680
  */
5460
- declare type FaviconUpdatedEvent = NamedEvent & {
5461
- type: 'page-favicon-updated';
5462
- favicons: string[];
5463
- };
5681
+ declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
5464
5682
 
5465
5683
  declare namespace FDC3 {
5466
5684
  export {
@@ -5819,48 +6037,43 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5819
6037
  }
5820
6038
 
5821
6039
  /**
5822
- * Generated when a frame is connected.
5823
- * @interface
6040
+ * @deprecated Renamed to {@link ConnectedEvent}.
5824
6041
  */
5825
- declare type FrameConnectedEvent = BaseFrameEvent & {
5826
- type: 'connected';
5827
- };
6042
+ declare type FrameConnectedEvent = ConnectedEvent_4;
5828
6043
 
5829
6044
  /**
5830
- * Generated when a frame has disconnected.
5831
- * @interface
6045
+ * @deprecated Renamed to {@link DisconnectedEvent}.
5832
6046
  */
5833
- declare type FrameDisconnectedEvent = BaseFrameEvent & {
5834
- type: 'disconnected';
5835
- };
6047
+ declare type FrameDisconnectedEvent = DisconnectedEvent_3;
5836
6048
 
5837
6049
  /**
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.
6050
+ * @deprecated Renamed to {@link Event}.
5841
6051
  */
5842
- declare type FrameEvent = {
5843
- topic: 'frame';
5844
- } & (FrameConnectedEvent | FrameDisconnectedEvent);
6052
+ declare type FrameEvent = Event_8;
5845
6053
 
5846
6054
  declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
5847
6055
 
5848
6056
  declare namespace FrameEvents {
5849
6057
  export {
6058
+ BaseEvent_7 as BaseEvent,
5850
6059
  BaseFrameEvent,
6060
+ ConnectedEvent_4 as ConnectedEvent,
5851
6061
  FrameConnectedEvent,
6062
+ DisconnectedEvent_3 as DisconnectedEvent,
5852
6063
  FrameDisconnectedEvent,
6064
+ Event_8 as Event,
5853
6065
  FrameEvent,
6066
+ EventType_5 as EventType,
5854
6067
  FrameEventType,
5855
- Payload_4 as Payload,
5856
- ByType_3 as ByType
6068
+ Payload_6 as Payload,
6069
+ ByType_5 as ByType
5857
6070
  }
5858
6071
  }
5859
6072
 
5860
6073
  /**
5861
- * Union of possible `type` values for a {@link FrameEvent}.
6074
+ * @deprecated Renamed to {@link EventType}.
5862
6075
  */
5863
- declare type FrameEventType = FrameEvent['type'];
6076
+ declare type FrameEventType = EventType_5;
5864
6077
 
5865
6078
  /**
5866
6079
  * @interface
@@ -6082,14 +6295,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin_2.GlobalHotkeyEvent> {
6082
6295
  }
6083
6296
 
6084
6297
  /**
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.
6298
+ * @deprecated Renamed to {@link Event}.
6088
6299
  */
6089
- declare type GlobalHotkeyEvent = {
6090
- topic: 'global-hotkey';
6091
- hotkey: 'string';
6092
- } & (RegisteredEvent | UnregisteredEvent);
6300
+ declare type GlobalHotkeyEvent = Event_9;
6093
6301
 
6094
6302
  declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6095
6303
 
@@ -6097,17 +6305,19 @@ declare namespace GlobalHotkeyEvents {
6097
6305
  export {
6098
6306
  RegisteredEvent,
6099
6307
  UnregisteredEvent,
6308
+ Event_9 as Event,
6100
6309
  GlobalHotkeyEvent,
6310
+ EventType_6 as EventType,
6101
6311
  GlobalHotkeyEventType,
6102
- Payload_5 as Payload,
6103
- ByType_4 as ByType
6312
+ Payload_7 as Payload,
6313
+ ByType_6 as ByType
6104
6314
  }
6105
6315
  }
6106
6316
 
6107
6317
  /**
6108
- * Union of possible `type` values for a {@link GlobalHotkeyEvent}
6318
+ * @deprecated Renamed to {@link EventType}.
6109
6319
  */
6110
- declare type GlobalHotkeyEventType = GlobalHotkeyEvent['type'];
6320
+ declare type GlobalHotkeyEventType = EventType_6;
6111
6321
 
6112
6322
  declare namespace GoldenLayout {
6113
6323
  export {
@@ -6409,8 +6619,17 @@ declare interface Header {
6409
6619
  * Generated when a View is hidden.
6410
6620
  * @interface
6411
6621
  */
6412
- declare type HiddenEvent = BaseViewEvent & {
6622
+ declare type HiddenEvent = BaseEvent_4 & {
6623
+ type: 'hidden';
6624
+ };
6625
+
6626
+ /**
6627
+ * Generated when a window has been hidden.
6628
+ * @interface
6629
+ */
6630
+ declare type HiddenEvent_2 = BaseEvent_5 & {
6413
6631
  type: 'hidden';
6632
+ reason: 'closing' | 'hide' | 'hide-on-close';
6414
6633
  };
6415
6634
 
6416
6635
  /**
@@ -6418,7 +6637,7 @@ declare type HiddenEvent = BaseViewEvent & {
6418
6637
  * or because the View has moved to a new window. Only available on Views in a Platform.
6419
6638
  * @interface
6420
6639
  */
6421
- declare type HostContextChangedEvent = BaseViewEvent & {
6640
+ declare type HostContextChangedEvent = BaseEvent_4 & {
6422
6641
  type: 'host-context-changed';
6423
6642
  context: any;
6424
6643
  reason: 'reparented' | 'updated';
@@ -6497,7 +6716,16 @@ declare type Hotkey = {
6497
6716
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
6498
6717
  * @interface
6499
6718
  */
6500
- declare type HotkeyEvent = BaseViewEvent & {
6719
+ declare type HotkeyEvent = BaseEvent_4 & {
6720
+ type: 'hotkey';
6721
+ };
6722
+
6723
+ /**
6724
+ * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
6725
+ * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
6726
+ * @interface
6727
+ */
6728
+ declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
6501
6729
  type: 'hotkey';
6502
6730
  };
6503
6731
 
@@ -6560,7 +6788,7 @@ declare type IdEventType = WithId<AppVersionEventType>;
6560
6788
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6561
6789
  * @interface
6562
6790
  */
6563
- declare type IdleEvent = BaseSystemEvent & {
6791
+ declare type IdleEvent = BaseEvent_8 & {
6564
6792
  type: 'idle-state-changed';
6565
6793
  elapsedTime: number;
6566
6794
  isIdle: boolean;
@@ -6645,11 +6873,19 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6645
6873
  * Generated when an application has initialized.
6646
6874
  * @interface
6647
6875
  */
6648
- declare type InitializedEvent = IdentityEvent & {
6876
+ declare type InitializedEvent = BaseEvents.IdentityEvent & {
6649
6877
  topic: 'application';
6650
6878
  type: 'initialized';
6651
6879
  };
6652
6880
 
6881
+ /**
6882
+ * Generated when a window is initialized.
6883
+ * @interface
6884
+ */
6885
+ declare type InitializedEvent_2 = BaseEvent_5 & {
6886
+ type: 'initialized';
6887
+ };
6888
+
6653
6889
  /**
6654
6890
  * @interface
6655
6891
  */
@@ -8751,7 +8987,7 @@ declare type LayoutIdentity = Identity_5 & {
8751
8987
  * Generated when a window and all of its layout's views have either finished or failed navigation.
8752
8988
  * @interface
8753
8989
  */
8754
- declare type LayoutInitializedEvent = BaseWindowEvent & {
8990
+ declare type LayoutInitializedEvent = BaseEvent_5 & {
8755
8991
  type: 'layout-initialized';
8756
8992
  ofViews: (OpenFin_2.Identity & {
8757
8993
  entityType: 'view';
@@ -9288,7 +9524,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9288
9524
  * Generated when a window and all of its layout's views have been created and can receive API calls.
9289
9525
  * @interface
9290
9526
  */
9291
- declare type LayoutReadyEvent = BaseWindowEvent & {
9527
+ declare type LayoutReadyEvent = BaseEvent_5 & {
9292
9528
  type: 'layout-ready';
9293
9529
  views: (OpenFin_2.Identity & {
9294
9530
  success: boolean;
@@ -9429,7 +9665,7 @@ declare type Manifest = {
9429
9665
  * Generated when the RVM notifies an application that the manifest has changed.
9430
9666
  * @interface
9431
9667
  */
9432
- declare type ManifestChangedEvent = IdentityEvent & {
9668
+ declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
9433
9669
  topic: 'application';
9434
9670
  type: 'manifest-changed';
9435
9671
  };
@@ -9482,7 +9718,7 @@ declare type MatchPattern = string;
9482
9718
  * Generated when a window is maximized.
9483
9719
  * @interface
9484
9720
  */
9485
- declare type MaximizedEvent = BaseWindowEvent & {
9721
+ declare type MaximizedEvent = BaseEvent_5 & {
9486
9722
  type: 'maximized';
9487
9723
  };
9488
9724
 
@@ -9592,7 +9828,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
9592
9828
  * Generated when a window is minimized.
9593
9829
  * @interface
9594
9830
  */
9595
- declare type MinimizedEvent = BaseWindowEvent & {
9831
+ declare type MinimizedEvent = BaseEvent_5 & {
9596
9832
  type: 'minimized';
9597
9833
  };
9598
9834
 
@@ -9641,7 +9877,7 @@ declare type MonitorDetails = {
9641
9877
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9642
9878
  * @interface
9643
9879
  */
9644
- declare type MonitorEvent = BaseSystemEvent & OpenFin_2.MonitorInfo & {
9880
+ declare type MonitorEvent = BaseEvent_8 & OpenFin_2.MonitorInfo & {
9645
9881
  type: 'monitor-info-changed';
9646
9882
  };
9647
9883
 
@@ -10073,14 +10309,23 @@ declare type NonPropagatedWindowEvent = never;
10073
10309
 
10074
10310
  /**
10075
10311
  * @internal
10312
+ *
10313
+ * Ensures that an event type key does not include any `close-requested` events. Distributes over unions.
10314
+ */
10315
+ declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'close-requested'>;
10316
+
10317
+ /**
10318
+ * @internal
10319
+ *
10320
+ * Ensures that an event type key doesn't include any `-requested` events. Distributes over unions.
10076
10321
  */
10077
- declare type NotRequested<EventType> = EventType extends `${infer U}-requested` ? never : EventType;
10322
+ declare type NotRequested<EventType extends String> = EventType extends `${infer U}-requested` ? never : EventType;
10078
10323
 
10079
10324
  /**
10080
10325
  * Generated when an application is not responding.
10081
10326
  * @interface
10082
10327
  */
10083
- declare type NotRespondingEvent = IdentityEvent & {
10328
+ declare type NotRespondingEvent = BaseEvents.IdentityEvent & {
10084
10329
  topic: 'application';
10085
10330
  type: 'not-responding';
10086
10331
  };
@@ -10406,7 +10651,7 @@ declare namespace OpenFin_2 {
10406
10651
  AppVersionCompleteEvent,
10407
10652
  AppVersionRuntimeStatusEvent,
10408
10653
  Events,
10409
- BaseEvent_2 as BaseEvent,
10654
+ BaseEvent_9 as BaseEvent,
10410
10655
  WebContentsEvent_2 as WebContentsEvent,
10411
10656
  SystemEvent_2 as SystemEvent,
10412
10657
  ApplicationEvent_2 as ApplicationEvent,
@@ -10448,12 +10693,32 @@ export default OpenFin_2;
10448
10693
 
10449
10694
  declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
10450
10695
 
10696
+ /**
10697
+ * Generated after window options are changed using the window.updateOptions method.
10698
+ * @remarks Will not fire if the diff object is empty.
10699
+ * @interface
10700
+ */
10701
+ declare type OptionsChangedEvent = BaseEvent_5 & {
10702
+ type: 'options-changed';
10703
+ options: OpenFin_2.WindowOptions;
10704
+ diff: OpenFin_2.WindowOptionDiff;
10705
+ };
10706
+
10451
10707
  declare type OverlapsOnlyIfMatching<T, U> = {
10452
10708
  [K in Extract<keyof T, keyof U>]: U[K] extends T[K] ? U[K] : T[K] extends U[K] ? T[K] : never;
10453
10709
  };
10454
10710
 
10455
10711
  declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
10456
10712
 
10713
+ /**
10714
+ * Generated when page receives favicon urls.
10715
+ * @interface
10716
+ */
10717
+ declare type PageFaviconUpdatedEvent = NamedEvent & {
10718
+ type: 'page-favicon-updated';
10719
+ favicons: string[];
10720
+ };
10721
+
10457
10722
  /**
10458
10723
  * Generated when page title is set during navigation.
10459
10724
  * @remarks explicitSet is false when title is synthesized from file url.
@@ -10472,74 +10737,74 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
10472
10737
  };
10473
10738
 
10474
10739
  /**
10475
- * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
10740
+ * Extracts a single event type matching the given key from the View {@link Event} union.
10476
10741
  *
10477
10742
  * @typeParam Type String key specifying the event to extract
10478
10743
  */
10479
- declare type Payload_2<Type extends ApplicationEventType> = Extract<ApplicationEvent, {
10744
+ declare type Payload_2<Type extends EventType> = Extract<Event_4, {
10480
10745
  type: Type;
10481
10746
  }>;
10482
10747
 
10483
10748
  /**
10484
- * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
10749
+ * Extracts a single event type matching the given key from the Window {@link Event} union.
10485
10750
  *
10486
10751
  * @typeParam Type String key specifying the event to extract
10487
10752
  */
10488
- declare type Payload_3<Type extends ExternalApplicationEventType> = Extract<ExternalApplicationEvent, {
10753
+ declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
10489
10754
  type: Type;
10490
10755
  }>;
10491
10756
 
10492
10757
  /**
10493
- * Extracts a single event type matching the given key from the {@link FrameEvent} union.
10758
+ * Extracts a single event type matching the given key from the Application {@link Event} union.
10494
10759
  *
10495
10760
  * @typeParam Type String key specifying the event to extract
10496
10761
  */
10497
- declare type Payload_4<Type extends FrameEventType> = Extract<FrameEvent, {
10762
+ declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
10498
10763
  type: Type;
10499
10764
  }>;
10500
10765
 
10501
10766
  /**
10502
- * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
10767
+ * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
10503
10768
  *
10504
10769
  * @typeParam Type String key specifying the event to extract
10505
10770
  */
10506
- declare type Payload_5<Type extends GlobalHotkeyEventType> = Extract<GlobalHotkeyEvent, {
10771
+ declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
10507
10772
  type: Type;
10508
10773
  }>;
10509
10774
 
10510
10775
  /**
10511
- * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
10776
+ * Extracts a single event type matching the given key from the Frame {@link Event} union.
10512
10777
  *
10513
10778
  * @typeParam Type String key specifying the event to extract
10514
10779
  */
10515
- declare type Payload_6<Type extends PlatformEventType> = Extract<PlatformEvent, {
10780
+ declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
10516
10781
  type: Type;
10517
10782
  }>;
10518
10783
 
10519
10784
  /**
10520
- * Extracts a single event type matching the given key from the {@link SystemEvent} union.
10785
+ * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
10521
10786
  *
10522
10787
  * @typeParam Type String key specifying the event to extract
10523
10788
  */
10524
- declare type Payload_7<Type extends SystemEventType> = Extract<SystemEvent, {
10789
+ declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
10525
10790
  type: Type;
10526
10791
  }>;
10527
10792
 
10528
10793
  /**
10529
- * Extracts a single event type matching the given key from the {@link ViewEvent} union.
10794
+ * Extracts a single event type matching the given key from the Platform {@link Event} union.
10530
10795
  *
10531
10796
  * @typeParam Type String key specifying the event to extract
10532
10797
  */
10533
- declare type Payload_8<Type extends ViewEventType> = Extract<ViewEvent, {
10798
+ declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
10534
10799
  type: Type;
10535
10800
  }>;
10536
10801
 
10537
10802
  /**
10538
- * Extracts a single event type matching the given key from the {@link WindowEvent} union.
10803
+ * Extracts a single event type matching the given key from the System {@link Event} union.
10539
10804
  *
10540
10805
  * @typeParam Type String key specifying the event to extract
10541
10806
  */
10542
- declare type Payload_9<Type extends WindowEventType> = Extract<WindowEvent, {
10807
+ declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10543
10808
  type: Type;
10544
10809
  }>;
10545
10810
 
@@ -10549,7 +10814,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
10549
10814
  * Generated when window finishes loading. Provides performance and navigation data.
10550
10815
  * @interface
10551
10816
  */
10552
- declare type PerformanceReportEvent = Performance & BaseWindowEvent & {
10817
+ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
10553
10818
  type: 'performance-report';
10554
10819
  };
10555
10820
 
@@ -11213,38 +11478,36 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
11213
11478
  }
11214
11479
 
11215
11480
  /**
11216
- * Generated when a new Platform's API becomes responsive.
11217
- * @interface
11481
+ * @deprecated Renamed to {@link ApiReadyEvent}.
11218
11482
  */
11219
- declare type PlatformApiReadyEvent = BaseEvent & {
11220
- topic: 'application';
11221
- type: 'platform-api-ready';
11222
- };
11483
+ declare type PlatformApiReadyEvent = ApiReadyEvent;
11223
11484
 
11224
11485
  /**
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.
11486
+ * @deprecated Renamed to {@link Event}.
11228
11487
  */
11229
- declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
11488
+ declare type PlatformEvent = Event_10;
11230
11489
 
11231
11490
  declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
11232
11491
 
11233
11492
  declare namespace PlatformEvents {
11234
11493
  export {
11494
+ ApiReadyEvent,
11235
11495
  PlatformApiReadyEvent,
11496
+ SnapshotAppliedEvent,
11236
11497
  PlatformSnapshotAppliedEvent,
11498
+ Event_10 as Event,
11237
11499
  PlatformEvent,
11500
+ EventType_7 as EventType,
11238
11501
  PlatformEventType,
11239
- Payload_6 as Payload,
11240
- ByType_5 as ByType
11502
+ Payload_8 as Payload,
11503
+ ByType_7 as ByType
11241
11504
  }
11242
11505
  }
11243
11506
 
11244
11507
  /**
11245
- * Union of possible `type` values for a {@link PlatformEvent}.
11508
+ * @deprecated Renamed to {@link }.
11246
11509
  */
11247
- declare type PlatformEventType = PlatformEvent['type'];
11510
+ declare type PlatformEventType = EventType_7;
11248
11511
 
11249
11512
  /**
11250
11513
  * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
@@ -11524,11 +11787,14 @@ declare interface PlatformProvider {
11524
11787
  * Calls platform.createView for every view in the given layout. Returns an array of promises
11525
11788
  * one promise for each view create call
11526
11789
  *
11527
- * @param layout
11528
- * @param target
11790
+ * @param payload
11791
+ * @param callerIdentity
11529
11792
  * @returns an array of promises
11530
11793
  */
11531
- createViewsForLayout(layout: GoldenLayout.Config, target: OpenFin_2.Identity): Promise<OpenFin_2.View>[];
11794
+ createViewsForLayout(payload: {
11795
+ layout: GoldenLayout.Config;
11796
+ target?: OpenFin_2.Identity;
11797
+ }, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.View>[];
11532
11798
  /**
11533
11799
  * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
11534
11800
  * 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 +12235,9 @@ declare interface PlatformProvider {
11969
12235
  }
11970
12236
 
11971
12237
  /**
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
12238
+ * @deprecated Renamed to {@link SnapshotAppliedEvent}.
11980
12239
  */
11981
- declare type PlatformSnapshotAppliedEvent = BaseEvent & {
11982
- topic: 'application';
11983
- type: 'platform-snapshot-applied';
11984
- };
12240
+ declare type PlatformSnapshotAppliedEvent = SnapshotAppliedEvent;
11985
12241
 
11986
12242
  /**
11987
12243
  * @interface
@@ -12249,7 +12505,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
12249
12505
  * A general preload scripts state change event without event type.
12250
12506
  * @interface
12251
12507
  */
12252
- declare type PreloadScriptsStateChangeEvent = BaseWindowEvent & {
12508
+ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12253
12509
  preloadScripts: (PreloadScriptInfoRunning & any)[];
12254
12510
  };
12255
12511
 
@@ -12458,51 +12714,43 @@ declare type ProcessLoggingOptions = {
12458
12714
  };
12459
12715
 
12460
12716
  /**
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.
12717
+ * @deprecated Renamed to {@link PropagatedEvent}.
12466
12718
  */
12467
- declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
12719
+ declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent_4<TargetTopic>;
12468
12720
 
12469
12721
  /**
12470
- * Union of possible 'type' values for a {@link OpenFin.ApplicationEvents.PropagatedApplicationEvent}.
12722
+ * @deprecated Renamed to {@link PropagatedEventType}.
12471
12723
  */
12472
- declare type PropagatedApplicationEventType = PropagatedApplicationEvent<string>['type'];
12724
+ declare type PropagatedApplicationEventType = PropagatedEventType_3;
12473
12725
 
12474
12726
  /**
12475
- * Modifies an event shape to reflect propagation to a parent topic.
12727
+ * Modifies an event shape to reflect propagation to a parent topic. Excludes `close-requested` events, as
12728
+ * these do not propagate.
12729
+ *
12476
12730
  * @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
12731
+ *
12732
+ * @typeParam SourceTopic The topic the event shape is propagating from.
12733
+ * @typeParam TargetTopic The topic the event shape is propagating to.
12734
+ * @typeParam Event The shape of the event being propagated.
12477
12735
  */
12478
12736
  declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
12479
12737
  type: string;
12480
12738
  }> = Event extends infer E extends {
12481
12739
  type: string;
12482
- } ? Omit<E, 'type' | 'topic'> & {
12740
+ } ? E['type'] extends 'close-requested' ? never : Omit<E, 'type' | 'topic'> & {
12483
12741
  type: PropagatedEventType<SourceTopic, E['type']>;
12484
12742
  topic: TargetTopic;
12485
12743
  } : never;
12486
12744
 
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
12745
  /**
12493
12746
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
12494
12747
  * 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
12748
  * event type key with `'view-'`.
12496
12749
  */
12497
- declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
12750
+ declare type PropagatedEvent_2<TargetTopic extends string> = BaseEvents.PropagatedEvent<'view', TargetTopic, ViewEvent> & {
12498
12751
  viewIdentity: OpenFin_2.Identity;
12499
12752
  };
12500
12753
 
12501
- /**
12502
- * Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
12503
- */
12504
- declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
12505
-
12506
12754
  /**
12507
12755
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
12508
12756
  * prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
@@ -12511,12 +12759,51 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
12511
12759
  *
12512
12760
  * "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
12513
12761
  */
12514
- declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent<'window', TargetTopic, Exclude<WindowSourcedEvent, WindowCloseRequestedEvent>>;
12762
+ declare type PropagatedEvent_3<TargetTopic extends string> = BaseEvents.PropagatedEvent<'window', TargetTopic, WindowSourcedEvent>;
12515
12763
 
12516
12764
  /**
12517
- * Union of possible `type` values for a {@link OpenFin.WindowEvents.PropagatedWindowEvent}.
12765
+ * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
12766
+ * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
12767
+ * are propagated to `System` without any type string prefixing.
12768
+ *
12769
+ * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
12770
+ */
12771
+ declare type PropagatedEvent_4<TargetTopic extends string> = BaseEvents.PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
12772
+
12773
+ /**
12774
+ * Modifies an event type key to reflect propagation by prefixing with the topic.
12775
+ */
12776
+ declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${NotCloseRequested<Type>}`;
12777
+
12778
+ /**
12779
+ * Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.View}.
12780
+ */
12781
+ declare type PropagatedEventType_2 = PropagatedEvent_2<string>['type'];
12782
+
12783
+ /**
12784
+ * Union of possible 'type' values for an {@link PropagatedEvent} sourced from an {@link Application}.
12785
+ */
12786
+ declare type PropagatedEventType_3 = PropagatedEvent_4<string>['type'];
12787
+
12788
+ /**
12789
+ * @deprecated Renamed to {@link PropagatedEvent}.
12518
12790
  */
12519
- declare type PropagatedWindowEventType = PropagatedWindowEvent<string>['type'];
12791
+ declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent_2<TargetTopic>;
12792
+
12793
+ /**
12794
+ * @deprecated Renamed to {@link PropagatedEventType}.
12795
+ */
12796
+ declare type PropagatedViewEventType = PropagatedEventType_2;
12797
+
12798
+ /**
12799
+ * @deprecated Renamed to {@link PropagatedEvent}.
12800
+ */
12801
+ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent_3<TargetTopic>;
12802
+
12803
+ /**
12804
+ * Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.Window}.
12805
+ */
12806
+ declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
12520
12807
 
12521
12808
  declare interface ProtocolMap extends ProtocolMapBase {
12522
12809
  'request-external-authorization': {
@@ -12934,7 +13221,7 @@ declare type RegistryInfo_2 = {
12934
13221
  * Generated when a window has been reloaded.
12935
13222
  * @interface
12936
13223
  */
12937
- declare type ReloadedEvent = BaseWindowEvent & {
13224
+ declare type ReloadedEvent = BaseEvent_5 & {
12938
13225
  type: 'reloaded';
12939
13226
  url: string;
12940
13227
  };
@@ -13070,11 +13357,19 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
13070
13357
  * Generated when an application is responding.
13071
13358
  * @interface
13072
13359
  */
13073
- declare type RespondingEvent = IdentityEvent & {
13360
+ declare type RespondingEvent = BaseEvents.IdentityEvent & {
13074
13361
  topic: 'application';
13075
13362
  type: 'responding';
13076
13363
  };
13077
13364
 
13365
+ /**
13366
+ * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
13367
+ * @interface
13368
+ */
13369
+ declare type RestoredEvent = BaseEvent_5 & {
13370
+ type: 'restored';
13371
+ };
13372
+
13078
13373
  declare type ResultBehavior = 'close' | 'hide' | 'none';
13079
13374
 
13080
13375
  /**
@@ -13137,7 +13432,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
13137
13432
  * Generated when Application.run() is called for an already running application.
13138
13433
  * @interface
13139
13434
  */
13140
- declare type RunRequestedEvent_2 = IdentityEvent & {
13435
+ declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
13141
13436
  topic: 'application';
13142
13437
  type: 'run-requested';
13143
13438
  userAppConfigArgs: Record<string, any>;
@@ -13319,7 +13614,7 @@ declare type ServiceIdentifier = {
13319
13614
  * Generated on changes to a user’s local computer session.
13320
13615
  * @interface
13321
13616
  */
13322
- declare type SessionChangedEvent = BaseSystemEvent & {
13617
+ declare type SessionChangedEvent = BaseEvent_8 & {
13323
13618
  type: 'session-changed';
13324
13619
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13325
13620
  };
@@ -13541,7 +13836,7 @@ declare type ShortcutOverride = Hotkey & {
13541
13836
  *
13542
13837
  * @interface
13543
13838
  */
13544
- declare type ShowAllDownloadsEvent = BaseWindowEvent & {
13839
+ declare type ShowAllDownloadsEvent = BaseEvent_5 & {
13545
13840
  type: 'show-all-downloads';
13546
13841
  };
13547
13842
 
@@ -13549,7 +13844,15 @@ declare type ShowAllDownloadsEvent = BaseWindowEvent & {
13549
13844
  * Generated when a View is shown. This event will fire during creation of a View.
13550
13845
  * @interface
13551
13846
  */
13552
- declare type ShownEvent = BaseViewEvent & {
13847
+ declare type ShownEvent = BaseEvent_4 & {
13848
+ type: 'shown';
13849
+ };
13850
+
13851
+ /**
13852
+ * Generated when a hidden window has been shown.
13853
+ * @interface
13854
+ */
13855
+ declare type ShownEvent_2 = BaseEvent_5 & {
13553
13856
  type: 'shown';
13554
13857
  };
13555
13858
 
@@ -13578,6 +13881,15 @@ declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
13578
13881
  y?: number;
13579
13882
  };
13580
13883
 
13884
+ /**
13885
+ * Generated when a window has been prevented from showing.
13886
+ * @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.
13887
+ * @interface
13888
+ */
13889
+ declare type ShowRequestedEvent = BaseEvent_5 & {
13890
+ type: 'show-requested';
13891
+ };
13892
+
13581
13893
  /**
13582
13894
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
13583
13895
  *
@@ -13624,6 +13936,21 @@ declare type Snapshot = {
13624
13936
  };
13625
13937
  };
13626
13938
 
13939
+ /**
13940
+ * Generated when a platform.ApplySnapshot call is resolved.
13941
+ * @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
13942
+ * 1. The window has been created
13943
+ * 2. The window has a responsive API
13944
+ * 3. If a window has a layout property, the 'layout-ready' event has fired
13945
+ *
13946
+ * _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.
13947
+ * @interface
13948
+ */
13949
+ declare type SnapshotAppliedEvent = BaseEvent & {
13950
+ topic: 'application';
13951
+ type: 'platform-snapshot-applied';
13952
+ };
13953
+
13627
13954
  /**
13628
13955
  * @interface
13629
13956
  */
@@ -13741,7 +14068,7 @@ declare class SnapshotSourceModule extends Base {
13741
14068
  * Generated when an application has started.
13742
14069
  * @interface
13743
14070
  */
13744
- declare type StartedEvent = IdentityEvent & {
14071
+ declare type StartedEvent = BaseEvents.IdentityEvent & {
13745
14072
  topic: 'application';
13746
14073
  type: 'started';
13747
14074
  };
@@ -15277,12 +15604,9 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
15277
15604
  };
15278
15605
 
15279
15606
  /**
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).
15607
+ * @deprecated Renamed to {@link Event}.
15284
15608
  */
15285
- declare type SystemEvent = ExcludeRequested<PropagatedWindowEvent<'system'>> | PropagatedViewEvent<'system'> | PropagatedApplicationEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
15609
+ declare type SystemEvent = Event_11;
15286
15610
 
15287
15611
  declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
15288
15612
 
@@ -15290,7 +15614,7 @@ declare namespace SystemEvents {
15290
15614
  export {
15291
15615
  NotRequested,
15292
15616
  ExcludeRequested,
15293
- BaseSystemEvent,
15617
+ BaseEvent_8 as BaseEvent,
15294
15618
  IdleEvent,
15295
15619
  MonitorEvent,
15296
15620
  SessionChangedEvent,
@@ -15305,17 +15629,19 @@ declare namespace SystemEvents {
15305
15629
  ApplicationCreatedEvent,
15306
15630
  DesktopIconClickedEvent,
15307
15631
  SystemShutdownEvent,
15632
+ Event_11 as Event,
15308
15633
  SystemEvent,
15634
+ EventType_8 as EventType,
15309
15635
  SystemEventType,
15310
- Payload_7 as Payload,
15311
- ByType_6 as ByType
15636
+ Payload_9 as Payload,
15637
+ ByType_8 as ByType
15312
15638
  }
15313
15639
  }
15314
15640
 
15315
15641
  /**
15316
- * Union of possible `type` values for a {@link SystemEvent}.
15642
+ * @deprecated Renamed to {@link EventType}.
15317
15643
  */
15318
- declare type SystemEventType = SystemEvent['type'];
15644
+ declare type SystemEventType = EventType_8;
15319
15645
 
15320
15646
  /**
15321
15647
  * @interface
@@ -15372,7 +15698,7 @@ declare type SystemProcessInfo = {
15372
15698
  * Generated when system shutdown or log off.
15373
15699
  * @internal
15374
15700
  */
15375
- declare type SystemShutdownEvent = BaseSystemEvent & {
15701
+ declare type SystemShutdownEvent = BaseEvent_8 & {
15376
15702
  type: 'system-shutdown';
15377
15703
  };
15378
15704
 
@@ -15625,7 +15951,7 @@ declare type TargetApp = string | AppMetadata;
15625
15951
  * In that case, previousTarget identity will be the same as target identity.
15626
15952
  * @interface
15627
15953
  */
15628
- declare type TargetChangedEvent = BaseViewEvent & {
15954
+ declare type TargetChangedEvent = BaseEvent_4 & {
15629
15955
  type: 'target-changed';
15630
15956
  previousTarget: OpenFin_2.Identity;
15631
15957
  };
@@ -15779,7 +16105,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
15779
16105
  * Generated when the tray icon is clicked.
15780
16106
  * @interface
15781
16107
  */
15782
- declare type TrayIconClickedEvent = IdentityEvent & {
16108
+ declare type TrayIconClickedEvent = BaseEvents.IdentityEvent & {
15783
16109
  topic: 'application';
15784
16110
  type: 'tray-icon-clicked';
15785
16111
  button: 0 | 1 | 2;
@@ -15869,7 +16195,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15869
16195
  * A general user bounds change event without event type.
15870
16196
  * @interface
15871
16197
  */
15872
- declare type UserBoundsChangeEvent = BaseWindowEvent & {
16198
+ declare type UserBoundsChangeEvent = BaseEvent_5 & {
15873
16199
  height: number;
15874
16200
  left: number;
15875
16201
  top: number;
@@ -15881,7 +16207,7 @@ declare type UserBoundsChangeEvent = BaseWindowEvent & {
15881
16207
  * Generated when a window's user movement becomes disabled.
15882
16208
  * @interface
15883
16209
  */
15884
- declare type UserMovementDisabledEvent = BaseWindowEvent & {
16210
+ declare type UserMovementDisabledEvent = BaseEvent_5 & {
15885
16211
  type: 'user-movement-disabled';
15886
16212
  };
15887
16213
 
@@ -15889,7 +16215,7 @@ declare type UserMovementDisabledEvent = BaseWindowEvent & {
15889
16215
  * Generated when a window's user movement becomes enabled.
15890
16216
  * @interface
15891
16217
  */
15892
- declare type UserMovementEnabledEvent = BaseWindowEvent & {
16218
+ declare type UserMovementEnabledEvent = BaseEvent_5 & {
15893
16219
  type: 'user-movement-enabled';
15894
16220
  };
15895
16221
 
@@ -16576,7 +16902,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
16576
16902
  * Generated when a View is attached to a window.
16577
16903
  * @interface
16578
16904
  */
16579
- declare type ViewAttachedEvent = BaseWindowEvent & {
16905
+ declare type ViewAttachedEvent = BaseEvent_5 & {
16580
16906
  type: 'view-attached';
16581
16907
  target: OpenFin_2.Identity;
16582
16908
  viewIdentity: OpenFin_2.Identity;
@@ -16618,7 +16944,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
16618
16944
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
16619
16945
  * @interface
16620
16946
  */
16621
- declare type ViewDetachedEvent = BaseWindowEvent & {
16947
+ declare type ViewDetachedEvent = BaseEvent_5 & {
16622
16948
  type: 'view-detached';
16623
16949
  target: OpenFin_2.Identity;
16624
16950
  previousTarget: OpenFin_2.Identity;
@@ -16626,18 +16952,15 @@ declare type ViewDetachedEvent = BaseWindowEvent & {
16626
16952
  };
16627
16953
 
16628
16954
  /**
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}).
16955
+ * @deprecated Renamed to {@link Event}.
16632
16956
  */
16633
- declare type ViewEvent = (WebContentsEvent<'view'> & {
16634
- target: OpenFin_2.Identity;
16635
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
16957
+ declare type ViewEvent = Event_4;
16636
16958
 
16637
16959
  declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
16638
16960
 
16639
16961
  declare namespace ViewEvents {
16640
16962
  export {
16963
+ BaseEvent_4 as BaseEvent,
16641
16964
  BaseViewEvent,
16642
16965
  TargetChangedEvent,
16643
16966
  NonPropagatedViewEvent,
@@ -16647,20 +16970,24 @@ declare namespace ViewEvents {
16647
16970
  HotkeyEvent,
16648
16971
  ShownEvent,
16649
16972
  HostContextChangedEvent,
16973
+ Event_4 as Event,
16650
16974
  ViewEvent,
16651
16975
  WillPropagateViewEvent,
16976
+ EventType,
16652
16977
  ViewEventType,
16978
+ PropagatedEvent_2 as PropagatedEvent,
16653
16979
  PropagatedViewEvent,
16980
+ PropagatedEventType_2 as PropagatedEventType,
16654
16981
  PropagatedViewEventType,
16655
- Payload_8 as Payload,
16656
- ByType_7 as ByType
16982
+ Payload_2 as Payload,
16983
+ ByType
16657
16984
  }
16658
16985
  }
16659
16986
 
16660
16987
  /**
16661
- * Union of possible `type` values for a {@link OpenFin.ViewEvents.ViewEvent}.
16988
+ * @deprecated Renamed to {@link EventType}.
16662
16989
  */
16663
- declare type ViewEventType = ViewEvent['type'];
16990
+ declare type ViewEventType = EventType;
16664
16991
 
16665
16992
  /**
16666
16993
  * @interface
@@ -17799,12 +18126,9 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17799
18126
  }
17800
18127
 
17801
18128
  /**
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}).
18129
+ * @deprecated Renamed to {@link Event}.
17804
18130
  */
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);
18131
+ declare type WebContentsEvent<Topic extends string> = Event_5<Topic>;
17808
18132
 
17809
18133
  declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
17810
18134
 
@@ -17816,6 +18140,7 @@ declare namespace WebContentsEvents {
17816
18140
  CrashedEvent_2 as CrashedEvent,
17817
18141
  CertificateErrorEvent,
17818
18142
  CertificateSelectionShownEvent,
18143
+ PageFaviconUpdatedEvent,
17819
18144
  FaviconUpdatedEvent,
17820
18145
  NavigationRejectedEvent,
17821
18146
  UrlChangedEvent,
@@ -17834,6 +18159,7 @@ declare namespace WebContentsEvents {
17834
18159
  FileDownloadStartedEvent,
17835
18160
  FileDownloadProgressEvent,
17836
18161
  FileDownloadCompletedEvent,
18162
+ Event_5 as Event,
17837
18163
  WebContentsEvent,
17838
18164
  WillPropagateWebContentsEvent,
17839
18165
  NonPropagatedWebContentsEvent
@@ -17881,7 +18207,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
17881
18207
  * A general will-move or will-resize event without event type.
17882
18208
  * @interface
17883
18209
  */
17884
- declare type WillMoveOrResizeEvent = BaseWindowEvent & {
18210
+ declare type WillMoveOrResizeEvent = BaseEvent_5 & {
17885
18211
  height: number;
17886
18212
  left: number;
17887
18213
  top: number;
@@ -17903,7 +18229,7 @@ declare type WillPropagateViewEvent = ViewEvent;
17903
18229
  *
17904
18230
  * A WebContents event that does propagate to (republish on) parent topics.
17905
18231
  */
17906
- declare type WillPropagateWebContentsEvent = WebContentsEvent<string>;
18232
+ declare type WillPropagateWebContentsEvent = Event_5<string>;
17907
18233
 
17908
18234
  /**
17909
18235
  * @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
@@ -17917,7 +18243,7 @@ declare type WillPropagateWindowEvent = WindowSourcedEvent;
17917
18243
  * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
17918
18244
  * @interface
17919
18245
  */
17920
- declare type WillRedirectEvent = BaseWindowEvent & {
18246
+ declare type WillRedirectEvent = BaseEvent_5 & {
17921
18247
  type: 'will-redirect';
17922
18248
  blocked: boolean;
17923
18249
  isInPlace: boolean;
@@ -19556,29 +19882,19 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19556
19882
  };
19557
19883
 
19558
19884
  /**
19559
- * Generated when a window has closed.
19560
- * @interface
19885
+ * @deprecated Renamed to {@link ClosedEvent}.
19561
19886
  */
19562
- declare type WindowClosedEvent = BaseWindowEvent & {
19563
- type: 'closed';
19564
- };
19887
+ declare type WindowClosedEvent = ClosedEvent_2;
19565
19888
 
19566
19889
  /**
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
19890
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
19570
19891
  */
19571
- declare type WindowCloseRequestedEvent = BaseWindowEvent & {
19572
- type: 'close-requested';
19573
- };
19892
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
19574
19893
 
19575
19894
  /**
19576
- * Generated when a window has initiated the closing routine.
19577
- * @interface
19895
+ * @deprecated Renamed to {@link ClosingEvent}.
19578
19896
  */
19579
- declare type WindowClosingEvent = BaseWindowEvent & {
19580
- type: 'closing';
19581
- };
19897
+ declare type WindowClosingEvent = ClosingEvent;
19582
19898
 
19583
19899
  /**
19584
19900
  * A rule prescribing content creation in a {@link OpenFin.Window}.
@@ -19662,16 +19978,15 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19662
19978
  };
19663
19979
 
19664
19980
  /**
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}).
19981
+ * @deprecated, Renamed to {@link Event}.
19668
19982
  */
19669
- declare type WindowEvent = WindowSourcedEvent | PropagatedViewEvent<'window'>;
19983
+ declare type WindowEvent = Event_6;
19670
19984
 
19671
19985
  declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
19672
19986
 
19673
19987
  declare namespace WindowEvents {
19674
19988
  export {
19989
+ BaseEvent_5 as BaseEvent,
19675
19990
  BaseWindowEvent,
19676
19991
  ViewAttachedEvent,
19677
19992
  ViewDetachedEvent,
@@ -19681,9 +19996,11 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19681
19996
  EndLoadEvent,
19682
19997
  WillRedirectEvent,
19683
19998
  ReloadedEvent,
19999
+ OptionsChangedEvent,
19684
20000
  WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
19685
20001
  ExternalProcessExitedEvent,
19686
20002
  ExternalProcessStartedEvent,
20003
+ HiddenEvent_2 as HiddenEvent,
19687
20004
  WindowHiddenEvent,
19688
20005
  PreloadScriptInfoRunning,
19689
20006
  PreloadScriptInfo,
@@ -19698,22 +20015,30 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19698
20015
  BeginUserBoundsChangingEvent,
19699
20016
  BoundsChangedEvent,
19700
20017
  BoundsChangingEvent,
20018
+ CloseRequestedEvent,
19701
20019
  WindowCloseRequestedEvent,
19702
20020
  ContextChangedEvent,
20021
+ ClosedEvent_2 as ClosedEvent,
19703
20022
  WindowClosedEvent,
20023
+ ClosingEvent,
19704
20024
  WindowClosingEvent,
19705
20025
  DisabledMovementBoundsChangedEvent,
19706
20026
  DisabledMovementBoundsChangingEvent,
19707
20027
  EmbeddedEvent,
19708
20028
  EndUserBoundsChangingEvent,
20029
+ HotkeyEvent_2 as HotkeyEvent,
19709
20030
  WindowHotkeyEvent,
20031
+ InitializedEvent_2 as InitializedEvent,
19710
20032
  WindowInitializedEvent,
19711
20033
  MaximizedEvent,
19712
20034
  MinimizedEvent,
19713
20035
  PreloadScriptsStateChangedEvent,
19714
20036
  PreloadScriptsStateChangingEvent,
20037
+ RestoredEvent,
19715
20038
  WindowRestoredEvent,
20039
+ ShowRequestedEvent,
19716
20040
  WindowShowRequestedEvent,
20041
+ ShownEvent_2 as ShownEvent,
19717
20042
  WindowShownEvent,
19718
20043
  UserMovementEnabledEvent,
19719
20044
  UserMovementDisabledEvent,
@@ -19724,37 +20049,32 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19724
20049
  DownloadShelfVisibilityChangedEvent,
19725
20050
  WindowSourcedEvent,
19726
20051
  WillPropagateWindowEvent,
20052
+ Event_6 as Event,
19727
20053
  WindowEvent,
20054
+ EventType_2 as EventType,
19728
20055
  WindowEventType,
20056
+ PropagatedEvent_3 as PropagatedEvent,
19729
20057
  PropagatedWindowEvent,
19730
20058
  PropagatedWindowEventType,
19731
- Payload_9 as Payload,
19732
- ByType_8 as ByType
20059
+ Payload_3 as Payload,
20060
+ ByType_2 as ByType
19733
20061
  }
19734
20062
  }
19735
20063
 
19736
20064
  /**
19737
- * Union of possible `type` values for a {@link OpenFin.WindowEvents.WindowEvent}.
20065
+ * @deprecated Renamed to {@link EventType}.
19738
20066
  */
19739
20067
  declare type WindowEventType = WindowEvent['type'];
19740
20068
 
19741
20069
  /**
19742
- * Generated when a window has been hidden.
19743
- * @interface
20070
+ * @deprecated Renamed to {@link HiddenEvent}.
19744
20071
  */
19745
- declare type WindowHiddenEvent = BaseWindowEvent & {
19746
- type: 'hidden';
19747
- reason: 'closing' | 'hide' | 'hide-on-close';
19748
- };
20072
+ declare type WindowHiddenEvent = HiddenEvent_2;
19749
20073
 
19750
20074
  /**
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
20075
+ * @deprecated Renamed to {@link HotkeyEvent}.
19754
20076
  */
19755
- declare type WindowHotkeyEvent = InputEvent_2 & BaseWindowEvent & {
19756
- type: 'hotkey';
19757
- };
20077
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
19758
20078
 
19759
20079
  /**
19760
20080
  * @interface
@@ -19768,12 +20088,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19768
20088
  };
19769
20089
 
19770
20090
  /**
19771
- * Generated when a window is initialized.
19772
- * @interface
20091
+ * @deprecated Renamed to {@link InitializedEvent}.
19773
20092
  */
19774
- declare type WindowInitializedEvent = BaseWindowEvent & {
19775
- type: 'initialized';
19776
- };
20093
+ declare type WindowInitializedEvent = InitializedEvent_2;
19777
20094
 
19778
20095
  /**
19779
20096
  * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
@@ -19892,15 +20209,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19892
20209
  declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
19893
20210
 
19894
20211
  /**
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
20212
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
19898
20213
  */
19899
- declare type WindowOptionsChangedEvent_2 = BaseWindowEvent & {
19900
- type: 'options-changed';
19901
- options: OpenFin_2.WindowOptions;
19902
- diff: OpenFin_2.WindowOptionDiff;
19903
- };
20214
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
19904
20215
 
19905
20216
  declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
19906
20217
 
@@ -19913,35 +20224,25 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19913
20224
  };
19914
20225
 
19915
20226
  /**
19916
- * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
19917
- * @interface
20227
+ * @deprecated Renamed to {@link RestoredEvent}.
19918
20228
  */
19919
- declare type WindowRestoredEvent = BaseWindowEvent & {
19920
- type: 'restored';
19921
- };
20229
+ declare type WindowRestoredEvent = RestoredEvent;
19922
20230
 
19923
20231
  /**
19924
- * Generated when a hidden window has been shown.
19925
- * @interface
20232
+ * @deprecated Renamed to {@link ShownEvent}.
19926
20233
  */
19927
- declare type WindowShownEvent = BaseWindowEvent & {
19928
- type: 'shown';
19929
- };
20234
+ declare type WindowShownEvent = ShownEvent_2;
19930
20235
 
19931
20236
  /**
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
20237
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
19935
20238
  */
19936
- declare type WindowShowRequestedEvent = BaseWindowEvent & {
19937
- type: 'show-requested';
19938
- };
20239
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
19939
20240
 
19940
20241
  /**
19941
20242
  * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19942
20243
  * from {@link OpenFin.ViewEvents}.
19943
20244
  */
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;
20245
+ 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
20246
 
19946
20247
  /**
19947
20248
  * Generated when a child window starts loading.