@openfin/node-adapter 34.78.50 → 34.78.52

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.
@@ -1,4 +1,3 @@
1
- /// <reference types="jquery" />
2
1
  /// <reference types="node" />
3
2
 
4
3
  import { EventEmitter } from 'events';
@@ -43,15 +42,6 @@ declare type Accelerator = {
43
42
  zoom: boolean;
44
43
  };
45
44
 
46
- /**
47
- * @interface
48
- */
49
- declare type AddLayoutInstanceOptions = {
50
- container: HTMLDivElement;
51
- layoutName: string;
52
- layout: LayoutOptions;
53
- };
54
-
55
45
  /**
56
46
  * @interface
57
47
  */
@@ -74,7 +64,7 @@ declare type AddViewToStackOptions = {
74
64
  * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
75
65
  * @interface
76
66
  */
77
- declare type AlertRequestedEvent = BaseWindowEvent & {
67
+ declare type AlertRequestedEvent = BaseEvent_5 & {
78
68
  type: 'alert-requested';
79
69
  message: string;
80
70
  url: string;
@@ -115,6 +105,15 @@ declare type ApiClient<T extends Record<any, any>> = {
115
105
  [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
116
106
  };
117
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
+
118
117
  /**
119
118
  * @interface
120
119
  */
@@ -872,19 +871,15 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
872
871
  }
873
872
 
874
873
  /**
875
- * Generated when an application has authenticated and is connected.
876
- * @interface
874
+ * @deprecated Renamed to {@link ConnectedEvent}.
877
875
  */
878
- declare type ApplicationConnectedEvent = IdentityEvent & {
879
- topic: 'application';
880
- type: 'connected';
881
- };
876
+ declare type ApplicationConnectedEvent = ConnectedEvent_2;
882
877
 
883
878
  /**
884
879
  * Generated when an application is created.
885
880
  * @interface
886
881
  */
887
- declare type ApplicationCreatedEvent = BaseSystemEvent & IdentityEvent & {
882
+ declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
888
883
  type: 'application-created';
889
884
  };
890
885
 
@@ -908,17 +903,15 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
908
903
  };
909
904
 
910
905
  /**
911
- * [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
912
- * discriminated by {@link ApplicationEvent.type | their type}. Event payloads unique to `Application` can be found
913
- * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
914
- * from which they propagate).
906
+ * @deprecated Renamed to {@link Event}.
915
907
  */
916
- declare type ApplicationEvent = PropagatedViewEvent<'application'> | PropagatedWindowEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
908
+ declare type ApplicationEvent = Event_3;
917
909
 
918
910
  declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
919
911
 
920
912
  declare namespace ApplicationEvents {
921
913
  export {
914
+ BaseEvent_3 as BaseEvent,
922
915
  BaseApplicationEvent,
923
916
  CrashedEvent,
924
917
  FileDownloadLocationChangedEvent,
@@ -931,7 +924,9 @@ declare namespace ApplicationEvents {
931
924
  WindowRespondingEvent,
932
925
  WindowStartLoadEvent,
933
926
  ApplicationWindowEvent,
927
+ ApplicationWindowEventTypes,
934
928
  ClosedEvent,
929
+ ConnectedEvent_2 as ConnectedEvent,
935
930
  ApplicationConnectedEvent,
936
931
  InitializedEvent,
937
932
  ManifestChangedEvent,
@@ -939,19 +934,23 @@ declare namespace ApplicationEvents {
939
934
  RespondingEvent,
940
935
  StartedEvent,
941
936
  ApplicationSourcedEvent,
937
+ Event_3 as Event,
942
938
  ApplicationEvent,
939
+ EventType_3 as EventType,
943
940
  ApplicationEventType,
941
+ PropagatedEvent_4 as PropagatedEvent,
944
942
  PropagatedApplicationEvent,
943
+ PropagatedEventType_3 as PropagatedEventType,
945
944
  PropagatedApplicationEventType,
946
- Payload_2 as Payload,
947
- ByType
945
+ Payload_4 as Payload,
946
+ ByType_3 as ByType
948
947
  }
949
948
  }
950
949
 
951
950
  /**
952
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
951
+ * @deprecated Renamed to {@link EventType}.
953
952
  */
954
- declare type ApplicationEventType = ApplicationEvent['type'];
953
+ declare type ApplicationEventType = EventType_3;
955
954
 
956
955
  declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
957
956
 
@@ -1304,9 +1303,8 @@ declare type ApplicationPermissions = {
1304
1303
  * A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
1305
1304
  * from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
1306
1305
  * does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
1307
- *
1308
1306
  */
1309
- 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;
1310
1308
 
1311
1309
  declare type ApplicationState = OpenFin.ApplicationState;
1312
1310
 
@@ -1345,6 +1343,11 @@ declare type ApplicationType = {
1345
1343
  */
1346
1344
  declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedEvent | WindowEndLoadEvent | WindowNotRespondingEvent | WindowRespondingEvent | WindowStartLoadEvent;
1347
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
+
1348
1351
  declare type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
1349
1352
 
1350
1353
  /**
@@ -1622,7 +1625,7 @@ declare interface AuthorizationPayload {
1622
1625
  * ```
1623
1626
  * @interface
1624
1627
  */
1625
- declare type AuthRequestedEvent = BaseWindowEvent & {
1628
+ declare type AuthRequestedEvent = BaseEvent_5 & {
1626
1629
  type: 'auth-requested';
1627
1630
  authInfo: {
1628
1631
  host: string;
@@ -1690,21 +1693,9 @@ declare class Base {
1690
1693
  }
1691
1694
 
1692
1695
  /**
1693
- * Base type for events emitting on the `application` topic
1694
- * @interface
1696
+ * @deprecated Renamed to {@link BaseEvent}.
1695
1697
  */
1696
- declare type BaseApplicationEvent = NamedEvent & {
1697
- topic: `application`;
1698
- };
1699
-
1700
- /**
1701
- * A base Channel event.
1702
- * @interface
1703
- */
1704
- declare type BaseChannelEvent = NamedEvent & {
1705
- channelName: string;
1706
- channelId: string;
1707
- };
1698
+ declare type BaseApplicationEvent = BaseEvent_3;
1708
1699
 
1709
1700
  /**
1710
1701
  * @interface
@@ -1746,6 +1737,23 @@ declare type BaseConfig = {
1746
1737
  timeout?: number;
1747
1738
  };
1748
1739
 
1740
+ /**
1741
+ * Properties shared by all content creation rules, regardless of context.
1742
+ *
1743
+ * @interface
1744
+ */
1745
+ declare type BaseContentCreationRule = {
1746
+ /**
1747
+ * List of [match patterns](https://developer.chrome.com/extensions/match_patterns) that indicate the specified
1748
+ * behavior should be used
1749
+ */
1750
+ match: MatchPattern[];
1751
+ /**
1752
+ * custom property
1753
+ */
1754
+ data?: unknown;
1755
+ };
1756
+
1749
1757
  /**
1750
1758
  * A base OpenFin event. All OpenFin event payloads extend this type.
1751
1759
  *
@@ -1756,10 +1764,70 @@ declare type BaseEvent = {
1756
1764
  type: string;
1757
1765
  };
1758
1766
 
1759
- 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.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;
1760
1827
 
1761
1828
  declare namespace BaseEvents {
1762
1829
  export {
1830
+ NotCloseRequested,
1763
1831
  PropagatedEventType,
1764
1832
  PropagatedEvent,
1765
1833
  EventHandler,
@@ -1770,21 +1838,14 @@ declare namespace BaseEvents {
1770
1838
  }
1771
1839
 
1772
1840
  /**
1773
- * Base type for events emitting on the `externalapplication` topic
1774
- * @interface
1841
+ * @deprecated Renamed to {@link BaseEvent}.
1775
1842
  */
1776
- declare type BaseExternalApplicationEvent = BaseEvent & {
1777
- topic: 'externalapplication';
1778
- };
1843
+ declare type BaseExternalApplicationEvent = BaseEvent_6;
1779
1844
 
1780
1845
  /**
1781
- * The base frame event.
1782
- * @interface
1846
+ * @deprecated Renamed to {@link BaseEvent}.
1783
1847
  */
1784
- declare type BaseFrameEvent = NamedEvent & {
1785
- entityType: 'iframe';
1786
- frameName: string;
1787
- };
1848
+ declare type BaseFrameEvent = BaseEvent_7;
1788
1849
 
1789
1850
  declare type BaseLoadFailedEvent = NamedEvent & {
1790
1851
  errorCode: number;
@@ -1793,35 +1854,20 @@ declare type BaseLoadFailedEvent = NamedEvent & {
1793
1854
  isMainFrame: boolean;
1794
1855
  };
1795
1856
 
1796
- /**
1797
- * Base type for events emitting on the `system` topic
1798
- * @interface
1799
- */
1800
- declare type BaseSystemEvent = BaseEvent & {
1801
- topic: 'system';
1802
- };
1803
-
1804
1857
  declare type BaseUrlEvent = NamedEvent & {
1805
1858
  type: 'url-changed';
1806
1859
  url: string;
1807
1860
  };
1808
1861
 
1809
1862
  /**
1810
- * Base type for events emitting on the `view` topic
1811
- * @interface
1863
+ * @deprecated Renamed to {@link BaseEvent}.
1812
1864
  */
1813
- declare type BaseViewEvent = NamedEvent & {
1814
- topic: 'view';
1815
- target: OpenFin.Identity;
1816
- };
1865
+ declare type BaseViewEvent = BaseEvent_4;
1817
1866
 
1818
1867
  /**
1819
- * Base type for events emitting on the `window` topic
1820
- * @interface
1868
+ * @deprecated Renamed to {@link BaseEvent}.
1821
1869
  */
1822
- declare type BaseWindowEvent = NamedEvent & {
1823
- topic: 'window';
1824
- };
1870
+ declare type BaseWindowEvent = BaseEvent_5;
1825
1871
 
1826
1872
  /**
1827
1873
  * User decision of whether a Window or specific View should close when trying to prevent an unload.
@@ -1846,6 +1892,18 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
1846
1892
  type: 'begin-user-bounds-changing';
1847
1893
  };
1848
1894
 
1895
+ /**
1896
+ * A rule prescribing content creation that should be blocked.
1897
+ *
1898
+ * @interface
1899
+ */
1900
+ declare type BlockedContentCreationRule = BaseContentCreationRule & {
1901
+ /**
1902
+ * Behavior to use when opening matched content.
1903
+ */
1904
+ behavior: 'block';
1905
+ };
1906
+
1849
1907
  /**
1850
1908
  * Generated when a WebContents loses focus.
1851
1909
  * @interface
@@ -1876,7 +1934,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
1876
1934
  * A general bounds change event without event type.
1877
1935
  * @interface
1878
1936
  */
1879
- declare type BoundsChangeEvent = BaseWindowEvent & {
1937
+ declare type BoundsChangeEvent = BaseEvent_5 & {
1880
1938
  changeType: 0 | 1 | 2;
1881
1939
  deferred: boolean;
1882
1940
  height: number;
@@ -1893,6 +1951,18 @@ declare type BoundsChangingEvent = BoundsChangeEvent & {
1893
1951
  type: 'bounds-changing';
1894
1952
  };
1895
1953
 
1954
+ /**
1955
+ * A rule prescribing content creation in the browser.
1956
+ *
1957
+ * @interface
1958
+ */
1959
+ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1960
+ /**
1961
+ * Behavior to use when opening matched content.
1962
+ */
1963
+ behavior: 'browser';
1964
+ };
1965
+
1896
1966
  declare interface BrowserWindow {
1897
1967
  /**
1898
1968
  * True if the window has been opened and its GoldenLayout instance initialised.
@@ -1936,76 +2006,76 @@ declare interface BrowserWindow {
1936
2006
  }
1937
2007
 
1938
2008
  /**
1939
- * 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.
1940
2010
  *
1941
2011
  * Alias for {@link Payload}, which may read better in source.
1942
2012
  *
1943
2013
  * @typeParam Type String key specifying the event to extract
1944
2014
  */
1945
- declare type ByType<Type extends ApplicationEventType> = Payload_2<Type>;
2015
+ declare type ByType<Type extends EventType> = Payload_2<Type>;
1946
2016
 
1947
2017
  /**
1948
- * 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.
1949
2019
  *
1950
2020
  * Alias for {@link Payload}, which may read better in source.
1951
2021
  *
1952
2022
  * @typeParam Type String key specifying the event to extract
1953
2023
  */
1954
- declare type ByType_2<Type extends ExternalApplicationEventType> = Payload_3<Type>;
2024
+ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
1955
2025
 
1956
2026
  /**
1957
- * 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.
1958
2028
  *
1959
2029
  * Alias for {@link Payload}, which may read better in source.
1960
2030
  *
1961
2031
  * @typeParam Type String key specifying the event to extract
1962
2032
  */
1963
- declare type ByType_3<Type extends FrameEventType> = Payload_4<Type>;
2033
+ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
1964
2034
 
1965
2035
  /**
1966
- * 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.
1967
2037
  *
1968
2038
  * Alias for {@link Payload}, which may read better in source.
1969
2039
  *
1970
2040
  * @typeParam Type String key specifying the event to extract
1971
2041
  */
1972
- declare type ByType_4<Type extends GlobalHotkeyEventType> = Payload_5<Type>;
2042
+ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
1973
2043
 
1974
2044
  /**
1975
- * 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.
1976
2046
  *
1977
2047
  * Alias for {@link Payload}, which may read better in source.
1978
2048
  *
1979
2049
  * @typeParam Type String key specifying the event to extract
1980
2050
  */
1981
- declare type ByType_5<Type extends PlatformEventType> = Payload_6<Type>;
2051
+ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
1982
2052
 
1983
2053
  /**
1984
- * 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.
1985
2055
  *
1986
2056
  * Alias for {@link Payload}, which may read better in source.
1987
2057
  *
1988
2058
  * @typeParam Type String key specifying the event to extract
1989
2059
  */
1990
- declare type ByType_6<Type extends SystemEventType> = Payload_7<Type>;
2060
+ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
1991
2061
 
1992
2062
  /**
1993
- * 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.
1994
2064
  *
1995
2065
  * Alias for {@link Payload}, which may read better in source.
1996
2066
  *
1997
2067
  * @typeParam Type String key specifying the event to extract
1998
2068
  */
1999
- declare type ByType_7<Type extends ViewEventType> = Payload_8<Type>;
2069
+ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
2000
2070
 
2001
2071
  /**
2002
- * 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.
2003
2073
  *
2004
2074
  * Alias for {@link Payload}, which may read better in source.
2005
2075
  *
2006
2076
  * @typeParam Type String key specifying the event to extract
2007
2077
  */
2008
- declare type ByType_8<Type extends WindowEventType> = Payload_9<Type>;
2078
+ declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
2009
2079
 
2010
2080
  /**
2011
2081
  * Configuration for page capture.
@@ -2688,14 +2758,6 @@ declare type ChannelClientConnectionListener = (identity: ClientIdentity, connec
2688
2758
 
2689
2759
  declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
2690
2760
 
2691
- /**
2692
- * Generated when a Channel client is connected.
2693
- * @interface
2694
- */
2695
- declare type ChannelConnectedEvent = BaseChannelEvent & {
2696
- type: 'connected';
2697
- };
2698
-
2699
2761
  /**
2700
2762
  * Options provided on a client connection to a channel.
2701
2763
  *
@@ -2727,21 +2789,9 @@ declare type ChannelCreateOptions = {
2727
2789
  };
2728
2790
 
2729
2791
  /**
2730
- * Generated when a Channel client has disconnected.
2731
- * @interface
2792
+ * @deprecated Renamed to {@link Event}.
2732
2793
  */
2733
- declare type ChannelDisconnectedEvent = BaseChannelEvent & {
2734
- type: 'disconnected';
2735
- };
2736
-
2737
- /**
2738
- * [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
2739
- * discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
2740
- * under the {@link OpenFin.ChannelEvents} namespace.
2741
- */
2742
- declare type ChannelEvent = {
2743
- topic: 'channel';
2744
- } & (ChannelConnectedEvent | ChannelDisconnectedEvent);
2794
+ declare type ChannelEvent = Event_2;
2745
2795
 
2746
2796
  declare type ChannelMiddleware = OpenFin.ChannelMiddleware;
2747
2797
 
@@ -3012,7 +3062,7 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
3012
3062
  private messageReceiver;
3013
3063
  private endpointId;
3014
3064
  private providerIdentity;
3015
- constructor(wire: Transport, messageReceiver: MessageReceiver, endpointId: string, // Provider endpointId is channelId
3065
+ constructor(wire: Transport, messageReceiver: MessageReceiver_2, endpointId: string, // Provider endpointId is channelId
3016
3066
  providerIdentity: ProviderIdentity_4);
3017
3067
  onEndpointDisconnect(endpointId: string, listener: () => void): void;
3018
3068
  receive(listener: (action: string, payload: any, identity: OpenFin.ClientIdentity | OpenFin.ClientIdentityMultiRuntime | ProviderIdentity_4) => Promise<any>): void;
@@ -3279,11 +3329,19 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
3279
3329
  * Generated when an application is closed.
3280
3330
  * @interface
3281
3331
  */
3282
- declare type ClosedEvent = IdentityEvent & {
3332
+ declare type ClosedEvent = BaseEvents.IdentityEvent & {
3283
3333
  topic: 'application';
3284
3334
  type: 'closed';
3285
3335
  };
3286
3336
 
3337
+ /**
3338
+ * Generated when a window has closed.
3339
+ * @interface
3340
+ */
3341
+ declare type ClosedEvent_2 = BaseEvent_5 & {
3342
+ type: 'closed';
3343
+ };
3344
+
3287
3345
  /**
3288
3346
  * @interface
3289
3347
  */
@@ -3291,6 +3349,25 @@ declare type ClosedMenuResult = {
3291
3349
  result: 'closed';
3292
3350
  };
3293
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
+
3361
+ /**
3362
+ * @interface
3363
+ */
3364
+ declare type CloseViewOptions = {
3365
+ /**
3366
+ *View to be closed.
3367
+ */
3368
+ viewIdentity: Identity_5;
3369
+ };
3370
+
3294
3371
  /**
3295
3372
  * @interface
3296
3373
  */
@@ -3299,6 +3376,11 @@ declare type CloseViewPayload = {
3299
3376
  *View to be closed.
3300
3377
  */
3301
3378
  view: Identity_5;
3379
+ /**
3380
+ * The target layout identity where this view should be closed. If not provided, will resolve to the
3381
+ * visible layout.
3382
+ */
3383
+ target?: LayoutIdentity;
3302
3384
  };
3303
3385
 
3304
3386
  /**
@@ -3322,6 +3404,14 @@ declare interface CloseWindowPayload {
3322
3404
  };
3323
3405
  }
3324
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
+
3325
3415
  /**
3326
3416
  * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
3327
3417
  */
@@ -3459,6 +3549,39 @@ export declare function connect(config: ConnectConfig): Promise<Fin<'external co
3459
3549
 
3460
3550
  declare type ConnectConfig = ExistingConnectConfig | NewConnectConfig | ExternalConfig;
3461
3551
 
3552
+ /**
3553
+ * Generated when a Channel client is connected.
3554
+ * @interface
3555
+ */
3556
+ declare type ConnectedEvent = BaseEvent_2 & {
3557
+ type: 'connected';
3558
+ };
3559
+
3560
+ /**
3561
+ * Generated when an application has authenticated and is connected.
3562
+ * @interface
3563
+ */
3564
+ declare type ConnectedEvent_2 = BaseEvents.IdentityEvent & {
3565
+ topic: 'application';
3566
+ type: 'connected';
3567
+ };
3568
+
3569
+ /**
3570
+ * Generated when an external application has authenticated and is connected.
3571
+ * @interface
3572
+ */
3573
+ declare type ConnectedEvent_3 = BaseExternalApplicationEvent & {
3574
+ type: 'connected';
3575
+ };
3576
+
3577
+ /**
3578
+ * Generated when a frame is connected.
3579
+ * @interface
3580
+ */
3581
+ declare type ConnectedEvent_4 = BaseFrameEvent & {
3582
+ type: 'connected';
3583
+ };
3584
+
3462
3585
  declare type Constructor<T = {}> = new () => T;
3463
3586
 
3464
3587
  declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
@@ -3538,12 +3661,23 @@ declare type ConstViewOptions = {
3538
3661
  /**
3539
3662
  * **Platforms Only.**
3540
3663
  * Determines what happens when a view is closed in a platform window.
3541
- * Supersedes `detachOnClose`, but has no default value.
3664
+ * Supersedes the deprecated `detachOnClose`.
3665
+ * If not set, detaults to `destroy` if `detachOnClose` is false (default), or `detach` if `detachOnClose` is true.
3666
+ * While this option is not updateable, it may change at runtime if `detachOnClose` is updated.
3542
3667
  * 'hide' hides the view on the platform window that closed it.
3543
- * 'detach' behaves like 'detachOnClose': true.
3544
- * 'destroy' is the default behavior as long as 'detachOnClose' is not set.
3668
+ * 'detach' behaves like 'detachOnClose': true. It attaches the closed view to the platform provider.
3669
+ * 'destroy' is the default behavior as long as 'detachOnClose' is not set. It destroys the view.
3545
3670
  */
3546
- closeBehavior?: 'hide' | 'detach' | 'destroy';
3671
+ closeBehavior: 'hide' | 'detach' | 'destroy';
3672
+ /**
3673
+ * Controls interaction of the view with its parent window's download shelf.
3674
+ */
3675
+ downloadShelf?: {
3676
+ /**
3677
+ * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
3678
+ */
3679
+ enabled: boolean;
3680
+ };
3547
3681
  };
3548
3682
 
3549
3683
  /**
@@ -3655,8 +3789,16 @@ declare type ConstWindowOptions = {
3655
3789
  * launches in favor of the cached value.
3656
3790
  */
3657
3791
  defaultWidth: number;
3792
+ downloadShelf: DownloadShelfOptions;
3658
3793
  height: number;
3659
3794
  layout: any;
3795
+ /**
3796
+ * @experimental
3797
+ *
3798
+ * The collection of layouts to load when the window is created. When launching multiple layouts, manage
3799
+ * the lifecycle via fin.Platform.Layout.create()/destroy() methods.
3800
+ */
3801
+ layoutSnapshot: LayoutSnapshot;
3660
3802
  /**
3661
3803
  * Parent identity of a modal window. It will create a modal child window when this option is set.
3662
3804
  */
@@ -3872,28 +4014,15 @@ declare type ContentCreationOptions = {
3872
4014
  * A rule for creating content in OpenFin; maps a content type to the way in which
3873
4015
  * newly-opened content of that type will be handled.
3874
4016
  *
4017
+ * @remarks This is effectively just a union type discriminated by the `behavior` key. The generic
4018
+ * parameter is a legacy feature that is included for backwards-compatibility reasons.
3875
4019
  *
3876
- * @interface
4020
+ * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
4021
+ * the specified `behavior` key.
3877
4022
  */
3878
- declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
3879
- /**
3880
- * Behavior to use when opening matched content. The value could be 'view' | 'window' | 'browser' | 'block'.
3881
- */
3882
- behavior: T;
3883
- /**
3884
- * List of [match patterns](https://developer.chrome.com/extensions/match_patterns) that indicate the specified
3885
- * behavior should be used
3886
- */
3887
- match: MatchPattern[];
3888
- /**
3889
- * Options for newly-created view or window (if applicable).
3890
- */
3891
- options?: T extends 'window' ? Partial<WindowOptions> : T extends 'view' ? Partial<ViewOptions> : never;
3892
- /**
3893
- * custom property
3894
- */
3895
- data?: unknown;
3896
- };
4023
+ declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
4024
+ behavior: Behavior;
4025
+ }>;
3897
4026
 
3898
4027
  /**
3899
4028
  * @interface
@@ -4194,7 +4323,7 @@ declare type Context_3 = {
4194
4323
  * Generated when a window's context is updated via {@link Platform#setWindowContext Platform.setWindowContext}. Only available on windows in a Platform.
4195
4324
  * @interface
4196
4325
  */
4197
- declare type ContextChangedEvent = BaseWindowEvent & {
4326
+ declare type ContextChangedEvent = BaseEvent_5 & {
4198
4327
  type: 'context-changed';
4199
4328
  context: any;
4200
4329
  };
@@ -4346,7 +4475,7 @@ declare type CpuInfo = {
4346
4475
  * Generated when an application has crashed.
4347
4476
  * @interface
4348
4477
  */
4349
- declare type CrashedEvent = IdentityEvent & {
4478
+ declare type CrashedEvent = BaseEvents.IdentityEvent & {
4350
4479
  topic: 'application';
4351
4480
  type: 'crashed';
4352
4481
  reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
@@ -4397,20 +4526,17 @@ declare type CrashReporterState = CrashReporterOptions & {
4397
4526
  * Generated when a View is created.
4398
4527
  * @interface
4399
4528
  */
4400
- declare type CreatedEvent = BaseViewEvent & {
4529
+ declare type CreatedEvent = BaseEvent_4 & {
4401
4530
  type: 'created';
4402
4531
  };
4403
4532
 
4404
4533
  /**
4405
- * @interface
4534
+ * @interface @experimental
4406
4535
  */
4407
4536
  declare type CreateLayoutOptions = {
4408
- /**
4409
- * @experimental
4410
- *
4411
- * @returns
4412
- */
4413
- layoutManagerOverride: () => any;
4537
+ container: HTMLElement;
4538
+ layoutName: string;
4539
+ layout: LayoutOptions;
4414
4540
  };
4415
4541
 
4416
4542
  /**
@@ -4431,7 +4557,7 @@ declare type CreateViewPayload = {
4431
4557
  /**
4432
4558
  * @interface
4433
4559
  */
4434
- declare type CreateViewTarget = Identity_5 & {
4560
+ declare type CreateViewTarget = LayoutIdentity & {
4435
4561
  /**
4436
4562
  * If specified, view creation will not attach to a window and caller must
4437
4563
  * insert the view into the layout explicitly
@@ -4442,6 +4568,44 @@ declare type CreateViewTarget = Identity_5 & {
4442
4568
  };
4443
4569
  };
4444
4570
 
4571
+ /**
4572
+ * The registry entry for a given protocol exists but can't be parsed.
4573
+ * @interface
4574
+ */
4575
+ declare type CustomProtocolMalformedState = {
4576
+ state: 'Malformed';
4577
+ };
4578
+
4579
+ /**
4580
+ * The registry entry is missing for a given custom protocol.
4581
+ * @interface
4582
+ */
4583
+ declare type CustomProtocolMissingState = {
4584
+ state: 'Missing';
4585
+ };
4586
+
4587
+ /**
4588
+ * Define possible options for Custom protocol.
4589
+ * @interface
4590
+ */
4591
+ declare type CustomProtocolOptions = {
4592
+ protocolName: string;
4593
+ };
4594
+
4595
+ /**
4596
+ * The registry rentry for a given protocol exists and can be parsed successfully.
4597
+ * @interface
4598
+ */
4599
+ declare type CustomProtocolRegisteredState = {
4600
+ state: 'Registered';
4601
+ handlerManifestUrl: string;
4602
+ };
4603
+
4604
+ /**
4605
+ * Define possible registration states for a given custom protocol.
4606
+ */
4607
+ declare type CustomProtocolState = CustomProtocolMissingState | CustomProtocolMalformedState | CustomProtocolRegisteredState;
4608
+
4445
4609
  /**
4446
4610
  * Custom headers for requests sent by the window.
4447
4611
  *
@@ -4459,6 +4623,8 @@ declare type CustomRequestHeaders = {
4459
4623
  headers: WebRequestHeader[];
4460
4624
  };
4461
4625
 
4626
+ declare type DataChannelReadyState = RTCDataChannel['readyState'];
4627
+
4462
4628
  /**
4463
4629
  * @interface
4464
4630
  */
@@ -4519,7 +4685,7 @@ declare interface DesktopAgent_2 {
4519
4685
  * Generated when the desktop icon is clicked while it's already running.
4520
4686
  * @interface
4521
4687
  */
4522
- declare type DesktopIconClickedEvent = BaseSystemEvent & {
4688
+ declare type DesktopIconClickedEvent = BaseEvent_8 & {
4523
4689
  type: 'desktop-icon-clicked';
4524
4690
  };
4525
4691
 
@@ -4527,17 +4693,10 @@ declare type DesktopIconClickedEvent = BaseSystemEvent & {
4527
4693
  * Generated when a View is destroyed.
4528
4694
  * @interface
4529
4695
  */
4530
- declare type DestroyedEvent = BaseViewEvent & {
4696
+ declare type DestroyedEvent = BaseEvent_4 & {
4531
4697
  type: 'destroyed';
4532
4698
  };
4533
4699
 
4534
- /**
4535
- * @interface
4536
- */
4537
- declare type DestroyLayoutOptions = {
4538
- layoutName: string;
4539
- };
4540
-
4541
4700
  /**
4542
4701
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
4543
4702
  * @interface
@@ -4634,6 +4793,30 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
4634
4793
  type: 'disabled-movement-bounds-changing';
4635
4794
  };
4636
4795
 
4796
+ /**
4797
+ * Generated when a Channel client has disconnected.
4798
+ * @interface
4799
+ */
4800
+ declare type DisconnectedEvent = BaseEvent_2 & {
4801
+ type: 'disconnected';
4802
+ };
4803
+
4804
+ /**
4805
+ * Generated when an external application has disconnected.
4806
+ * @interface
4807
+ */
4808
+ declare type DisconnectedEvent_2 = BaseExternalApplicationEvent & {
4809
+ type: 'disconnected';
4810
+ };
4811
+
4812
+ /**
4813
+ * Generated when a frame has disconnected.
4814
+ * @interface
4815
+ */
4816
+ declare type DisconnectedEvent_3 = BaseFrameEvent & {
4817
+ type: 'disconnected';
4818
+ };
4819
+
4637
4820
  /**
4638
4821
  * A system channel will be global enough to have a presence across many apps. This gives us some hints
4639
4822
  * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
@@ -4734,6 +4917,47 @@ declare type DownloadRule = {
4734
4917
  match: string[];
4735
4918
  };
4736
4919
 
4920
+ /**
4921
+ * @interface
4922
+ *
4923
+ * Controls the styling and behavior of the window download shelf.
4924
+ */
4925
+ declare type DownloadShelfOptions = {
4926
+ /**
4927
+ * Whether downloads in this window trigger opening the download shelf.
4928
+ */
4929
+ enabled: boolean;
4930
+ /**
4931
+ * Styling options for the download shelf border.
4932
+ */
4933
+ border?: {
4934
+ /**
4935
+ * Thickness of the border in pixels. Default 1 pixel. Used only for frameless windows.
4936
+ *
4937
+ * @remarks The top border is fixed to 1 pixel regardless of this setting.
4938
+ */
4939
+ size?: number;
4940
+ /**
4941
+ * Color of the border, either a string name or a hex code. Defaults to chromium theme
4942
+ * if absent.
4943
+ */
4944
+ color?: string;
4945
+ };
4946
+ };
4947
+
4948
+ /**
4949
+ * Generated when the visibility of the window's download shelf changes.
4950
+ *
4951
+ * @interface
4952
+ */
4953
+ declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
4954
+ type: 'download-shelf-visibility-changed';
4955
+ /**
4956
+ * True if the download shelf was just opened; false if it was just closed.
4957
+ */
4958
+ visible: boolean;
4959
+ };
4960
+
4737
4961
  /**
4738
4962
  * DPI (dots per inch) configuration for printing.
4739
4963
  *
@@ -4756,7 +4980,7 @@ declare interface DragSource {}
4756
4980
  * Generated when a window has been embedded.
4757
4981
  * @interface
4758
4982
  */
4759
- declare type EmbeddedEvent = BaseWindowEvent & {
4983
+ declare type EmbeddedEvent = BaseEvent_5 & {
4760
4984
  type: 'embedded';
4761
4985
  };
4762
4986
 
@@ -4860,7 +5084,7 @@ declare class EmitterMap {
4860
5084
  * Generated when a window ends loading.
4861
5085
  * @interface
4862
5086
  */
4863
- declare type EndLoadEvent = BaseWindowEvent & {
5087
+ declare type EndLoadEvent = BaseEvent_5 & {
4864
5088
  type: 'end-load';
4865
5089
  documentName: string;
4866
5090
  isMain: boolean;
@@ -4938,9 +5162,11 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
4938
5162
  } : never;
4939
5163
 
4940
5164
  declare interface Environment {
4941
- initLayout(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, ...args: Parameters<OpenFin.Fin['Platform']['Layout']['init']>): ReturnType<OpenFin.Fin['Platform']['Layout']['init']>;
5165
+ initLayout(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5166
+ createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5167
+ destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
4942
5168
  initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
4943
- observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): (() => void);
5169
+ observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
4944
5170
  writeToken(path: string, token: string): Promise<string>;
4945
5171
  retrievePort(config: NewConnectConfig): Promise<number>;
4946
5172
  getNextMessageId(): any;
@@ -4966,14 +5192,96 @@ declare type ErrorMiddleware = OpenFin.ErrorMiddleware;
4966
5192
  declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity) => unknown;
4967
5193
 
4968
5194
  /**
4969
- * This function converts JS errors into plain objects
5195
+ * This function converts JS errors into plain objects
5196
+ */
5197
+ declare type ErrorPlainObject = {
5198
+ stack?: string;
5199
+ message: string;
5200
+ name?: string;
5201
+ toString(): string;
5202
+ };
5203
+
5204
+ /**
5205
+ * [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
5206
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5207
+ * under the {@link OpenFin.PlatformEvents} namespace.
5208
+ */
5209
+ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5210
+
5211
+ /**
5212
+ * [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
5213
+ * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5214
+ * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5215
+ * from which they propagate).
5216
+ */
5217
+ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ViewEvents.PropagatedEvent<'system'> | ApplicationEvents.PropagatedEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
5218
+
5219
+ /**
5220
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
5221
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5222
+ * under the {@link OpenFin.ChannelEvents} namespace.
5223
+ */
5224
+ declare type Event_2 = {
5225
+ topic: 'channel';
5226
+ } & (ConnectedEvent | DisconnectedEvent);
5227
+
5228
+ /**
5229
+ * [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
5230
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5231
+ * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5232
+ * from which they propagate).
5233
+ */
5234
+ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.PropagatedEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
5235
+
5236
+ /**
5237
+ * [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
5238
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5239
+ * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5240
+ */
5241
+ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
5242
+ target: OpenFin.Identity;
5243
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
5244
+
5245
+ /**
5246
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
5247
+ * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
5248
+ */
5249
+ declare type Event_5<Topic extends string> = {
5250
+ topic: Topic;
5251
+ } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
5252
+
5253
+ /**
5254
+ * [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
5255
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5256
+ * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5257
+ */
5258
+ declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5259
+
5260
+ /**
5261
+ * [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
5262
+ * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5263
+ * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5264
+ */
5265
+ declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5266
+
5267
+ /**
5268
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}. Events are
5269
+ * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5270
+ * under the {@link OpenFin.FrameEvents} namespace.
5271
+ */
5272
+ declare type Event_8 = {
5273
+ topic: 'frame';
5274
+ } & (ConnectedEvent_4 | DisconnectedEvent_3);
5275
+
5276
+ /**
5277
+ * [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
5278
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5279
+ * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
4970
5280
  */
4971
- declare type ErrorPlainObject = {
4972
- stack?: string;
4973
- message: string;
4974
- name?: string;
4975
- toString(): string;
4976
- };
5281
+ declare type Event_9 = {
5282
+ topic: 'global-hotkey';
5283
+ hotkey: 'string';
5284
+ } & (RegisteredEvent | UnregisteredEvent);
4977
5285
 
4978
5286
  declare class EventAggregator extends EmitterMap {
4979
5287
  dispatchEvent: (message: Message<any>) => boolean;
@@ -5040,6 +5348,46 @@ declare namespace Events {
5040
5348
  }
5041
5349
  }
5042
5350
 
5351
+ /**
5352
+ * Union of possible `type` values for a view {@link Event}.
5353
+ */
5354
+ declare type EventType = Event_4['type'];
5355
+
5356
+ /**
5357
+ * Union of possible `type` values for a Window {@link Event}.
5358
+ */
5359
+ declare type EventType_2 = Event_6['type'];
5360
+
5361
+ /**
5362
+ * Union of possible `type` values for an Application {@link Event}.
5363
+ */
5364
+ declare type EventType_3 = Event_3['type'];
5365
+
5366
+ /**
5367
+ * Union of possible `type` values for an ExternalApplication {@link Event}.
5368
+ */
5369
+ declare type EventType_4 = Event_7['type'];
5370
+
5371
+ /**
5372
+ * Union of possible `type` values for a {@link FrameEvent}.
5373
+ */
5374
+ declare type EventType_5 = Event_8['type'];
5375
+
5376
+ /**
5377
+ * Union of possible `type` values for a {@link GlobalHotkeyEvent}
5378
+ */
5379
+ declare type EventType_6 = Event_9['type'];
5380
+
5381
+ /**
5382
+ * Union of possible `type` values for a {@link PlatformEvent}.
5383
+ */
5384
+ declare type EventType_7 = Event_10['type'];
5385
+
5386
+ /**
5387
+ * Union of possible `type` values for a {@link SystemEvent}.
5388
+ */
5389
+ declare type EventType_8 = SystemEvent['type'];
5390
+
5043
5391
  /**
5044
5392
  * @internal
5045
5393
  */
@@ -5053,6 +5401,8 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
5053
5401
 
5054
5402
  /**
5055
5403
  * @internal
5404
+ *
5405
+ * Ensures that an event payload type does not include any `-requested` events. Distributes over unions.
5056
5406
  */
5057
5407
  declare type ExcludeRequested<Event extends {
5058
5408
  type: string;
@@ -5182,46 +5532,43 @@ declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicatio
5182
5532
  }
5183
5533
 
5184
5534
  /**
5185
- * Generated when an external application has authenticated and is connected.
5186
- * @interface
5535
+ * @deprecated Renamed to {@link ConnectedEvent}.
5187
5536
  */
5188
- declare type ExternalApplicationConnectedEvent = BaseExternalApplicationEvent & {
5189
- type: 'connected';
5190
- };
5537
+ declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
5191
5538
 
5192
5539
  /**
5193
- * Generated when an external application has disconnected.
5194
- * @interface
5540
+ * @deprecated Renamed to {@link DisconnectedEvent}.
5195
5541
  */
5196
- declare type ExternalApplicationDisconnectedEvent = BaseExternalApplicationEvent & {
5197
- type: 'disconnected';
5198
- };
5542
+ declare type ExternalApplicationDisconnectedEvent = DisconnectedEvent_2;
5199
5543
 
5200
5544
  /**
5201
- * [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
5202
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5203
- * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5545
+ * @deprecated Renamed to {@link Event}.
5204
5546
  */
5205
- declare type ExternalApplicationEvent = ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent;
5547
+ declare type ExternalApplicationEvent = Event_7;
5206
5548
 
5207
5549
  declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
5208
5550
 
5209
5551
  declare namespace ExternalApplicationEvents {
5210
5552
  export {
5553
+ BaseEvent_6 as BaseEvent,
5211
5554
  BaseExternalApplicationEvent,
5555
+ ConnectedEvent_3 as ConnectedEvent,
5212
5556
  ExternalApplicationConnectedEvent,
5557
+ DisconnectedEvent_2 as DisconnectedEvent,
5213
5558
  ExternalApplicationDisconnectedEvent,
5559
+ Event_7 as Event,
5214
5560
  ExternalApplicationEvent,
5561
+ EventType_4 as EventType,
5215
5562
  ExternalApplicationEventType,
5216
- Payload_3 as Payload,
5217
- ByType_2 as ByType
5563
+ Payload_5 as Payload,
5564
+ ByType_4 as ByType
5218
5565
  }
5219
5566
  }
5220
5567
 
5221
5568
  /**
5222
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
5569
+ * @deprecated Renamed to {@link Event}.
5223
5570
  */
5224
- declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
5571
+ declare type ExternalApplicationEventType = EventType_4;
5225
5572
 
5226
5573
  /**
5227
5574
  * @interface
@@ -5286,7 +5633,7 @@ declare type ExternalConnection = {
5286
5633
  * Generated when an external process has exited.
5287
5634
  * @interface
5288
5635
  */
5289
- declare type ExternalProcessExitedEvent = BaseWindowEvent & {
5636
+ declare type ExternalProcessExitedEvent = BaseEvent_5 & {
5290
5637
  type: 'external-process-exited';
5291
5638
  processUuid: string;
5292
5639
  exitCode: number;
@@ -5331,19 +5678,15 @@ declare type ExternalProcessRequestType = {
5331
5678
  * Generated when an external process has started.
5332
5679
  * @interface
5333
5680
  */
5334
- declare type ExternalProcessStartedEvent = BaseWindowEvent & {
5681
+ declare type ExternalProcessStartedEvent = BaseEvent_5 & {
5335
5682
  type: 'external-process-started';
5336
5683
  processUuid: string;
5337
5684
  };
5338
5685
 
5339
5686
  /**
5340
- * Generated when page receives favicon urls.
5341
- * @interface
5687
+ * @deprecated, use {@link PageFaviconUpdatedEvent}.
5342
5688
  */
5343
- declare type FaviconUpdatedEvent = NamedEvent & {
5344
- type: 'page-favicon-updated';
5345
- favicons: string[];
5346
- };
5689
+ declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
5347
5690
 
5348
5691
  declare namespace FDC3 {
5349
5692
  export {
@@ -5571,6 +5914,8 @@ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata_3> = {
5571
5914
  metadata?: MetadataType;
5572
5915
  };
5573
5916
 
5917
+ declare type FlexReadyState = WebSocketReadyState | DataChannelReadyState;
5918
+
5574
5919
  /**
5575
5920
  * Generated when a WebContents gains focus.
5576
5921
  * @interface
@@ -5722,48 +6067,43 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5722
6067
  }
5723
6068
 
5724
6069
  /**
5725
- * Generated when a frame is connected.
5726
- * @interface
6070
+ * @deprecated Renamed to {@link ConnectedEvent}.
5727
6071
  */
5728
- declare type FrameConnectedEvent = BaseFrameEvent & {
5729
- type: 'connected';
5730
- };
6072
+ declare type FrameConnectedEvent = ConnectedEvent_4;
5731
6073
 
5732
6074
  /**
5733
- * Generated when a frame has disconnected.
5734
- * @interface
6075
+ * @deprecated Renamed to {@link DisconnectedEvent}.
5735
6076
  */
5736
- declare type FrameDisconnectedEvent = BaseFrameEvent & {
5737
- type: 'disconnected';
5738
- };
6077
+ declare type FrameDisconnectedEvent = DisconnectedEvent_3;
5739
6078
 
5740
6079
  /**
5741
- * [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
5742
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5743
- * under the {@link OpenFin.FrameEvents} namespace.
6080
+ * @deprecated Renamed to {@link Event}.
5744
6081
  */
5745
- declare type FrameEvent = {
5746
- topic: 'frame';
5747
- } & (FrameConnectedEvent | FrameDisconnectedEvent);
6082
+ declare type FrameEvent = Event_8;
5748
6083
 
5749
6084
  declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
5750
6085
 
5751
6086
  declare namespace FrameEvents {
5752
6087
  export {
6088
+ BaseEvent_7 as BaseEvent,
5753
6089
  BaseFrameEvent,
6090
+ ConnectedEvent_4 as ConnectedEvent,
5754
6091
  FrameConnectedEvent,
6092
+ DisconnectedEvent_3 as DisconnectedEvent,
5755
6093
  FrameDisconnectedEvent,
6094
+ Event_8 as Event,
5756
6095
  FrameEvent,
6096
+ EventType_5 as EventType,
5757
6097
  FrameEventType,
5758
- Payload_4 as Payload,
5759
- ByType_3 as ByType
6098
+ Payload_6 as Payload,
6099
+ ByType_5 as ByType
5760
6100
  }
5761
6101
  }
5762
6102
 
5763
6103
  /**
5764
- * Union of possible `type` values for a {@link FrameEvent}.
6104
+ * @deprecated Renamed to {@link EventType}.
5765
6105
  */
5766
- declare type FrameEventType = FrameEvent['type'];
6106
+ declare type FrameEventType = EventType_5;
5767
6107
 
5768
6108
  /**
5769
6109
  * @interface
@@ -5891,6 +6231,8 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
5891
6231
  * Registers a global hotkey with the operating system.
5892
6232
  * @param hotkey a hotkey string
5893
6233
  * @param listener called when the registered hotkey is pressed by the user.
6234
+ * @throws If the `hotkey` is reserved, see list below.
6235
+ * @throws if the `hotkey` is already registered by another application.
5894
6236
  *
5895
6237
  * @remarks The `hotkey` parameter expects an electron compatible [accelerator](https://github.com/electron/electron/blob/master/docs/api/accelerator.md) and the `listener` will be called if the `hotkey` is pressed by the user.
5896
6238
  * If successfull, the hotkey will be 'claimed' by the application, meaning that this register call can be called multiple times from within the same application but will fail if another application has registered the hotkey.
@@ -5963,7 +6305,7 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
5963
6305
  */
5964
6306
  unregisterAll(): Promise<void>;
5965
6307
  /**
5966
- * Checks if a given hotkey has been registered
6308
+ * Checks if a given hotkey has been registered by an application within the current runtime.
5967
6309
  * @param hotkey a hotkey string
5968
6310
  *
5969
6311
  * @example
@@ -5983,14 +6325,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
5983
6325
  }
5984
6326
 
5985
6327
  /**
5986
- * [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
5987
- * discriminated by {@link GlobalHotkeyEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5988
- * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
6328
+ * @deprecated Renamed to {@link Event}.
5989
6329
  */
5990
- declare type GlobalHotkeyEvent = {
5991
- topic: 'global-hotkey';
5992
- hotkey: 'string';
5993
- } & (RegisteredEvent | UnregisteredEvent);
6330
+ declare type GlobalHotkeyEvent = Event_9;
5994
6331
 
5995
6332
  declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
5996
6333
 
@@ -5998,17 +6335,19 @@ declare namespace GlobalHotkeyEvents {
5998
6335
  export {
5999
6336
  RegisteredEvent,
6000
6337
  UnregisteredEvent,
6338
+ Event_9 as Event,
6001
6339
  GlobalHotkeyEvent,
6340
+ EventType_6 as EventType,
6002
6341
  GlobalHotkeyEventType,
6003
- Payload_5 as Payload,
6004
- ByType_4 as ByType
6342
+ Payload_7 as Payload,
6343
+ ByType_6 as ByType
6005
6344
  }
6006
6345
  }
6007
6346
 
6008
6347
  /**
6009
- * Union of possible `type` values for a {@link GlobalHotkeyEvent}
6348
+ * @deprecated Renamed to {@link EventType}.
6010
6349
  */
6011
- declare type GlobalHotkeyEventType = GlobalHotkeyEvent['type'];
6350
+ declare type GlobalHotkeyEventType = EventType_6;
6012
6351
 
6013
6352
  declare namespace GoldenLayout {
6014
6353
  export {
@@ -6027,6 +6366,7 @@ declare namespace GoldenLayout {
6027
6366
  DragSource,
6028
6367
  BrowserWindow,
6029
6368
  Header,
6369
+ TabDragListener,
6030
6370
  Tab,
6031
6371
  EventEmitter_2 as EventEmitter
6032
6372
  }
@@ -6141,10 +6481,7 @@ declare class GoldenLayout_2 implements EventEmitter_2 {
6141
6481
  * @param itemConfiguration An item configuration (can be an entire tree of items)
6142
6482
  * @param parent A parent item
6143
6483
  */
6144
- createContentItem(
6145
- itemConfiguration?: ItemConfigType,
6146
- parent?: ContentItem
6147
- ): ContentItem;
6484
+ createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6148
6485
 
6149
6486
  /**
6150
6487
  * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
@@ -6177,10 +6514,7 @@ declare class GoldenLayout_2 implements EventEmitter_2 {
6177
6514
  * @return the dragSource that was created. This can be used to remove the
6178
6515
  * dragSource from the layout later.
6179
6516
  */
6180
- createDragSource(
6181
- element: HTMLElement | JQuery,
6182
- itemConfiguration: ItemConfigType
6183
- ): DragSource;
6517
+ createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6184
6518
 
6185
6519
  /**
6186
6520
  * Removes a dragSource from the layout.
@@ -6315,8 +6649,17 @@ declare interface Header {
6315
6649
  * Generated when a View is hidden.
6316
6650
  * @interface
6317
6651
  */
6318
- declare type HiddenEvent = BaseViewEvent & {
6652
+ declare type HiddenEvent = BaseEvent_4 & {
6653
+ type: 'hidden';
6654
+ };
6655
+
6656
+ /**
6657
+ * Generated when a window has been hidden.
6658
+ * @interface
6659
+ */
6660
+ declare type HiddenEvent_2 = BaseEvent_5 & {
6319
6661
  type: 'hidden';
6662
+ reason: 'closing' | 'hide' | 'hide-on-close';
6320
6663
  };
6321
6664
 
6322
6665
  /**
@@ -6324,7 +6667,7 @@ declare type HiddenEvent = BaseViewEvent & {
6324
6667
  * or because the View has moved to a new window. Only available on Views in a Platform.
6325
6668
  * @interface
6326
6669
  */
6327
- declare type HostContextChangedEvent = BaseViewEvent & {
6670
+ declare type HostContextChangedEvent = BaseEvent_4 & {
6328
6671
  type: 'host-context-changed';
6329
6672
  context: any;
6330
6673
  reason: 'reparented' | 'updated';
@@ -6403,7 +6746,16 @@ declare type Hotkey = {
6403
6746
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
6404
6747
  * @interface
6405
6748
  */
6406
- declare type HotkeyEvent = BaseViewEvent & {
6749
+ declare type HotkeyEvent = BaseEvent_4 & {
6750
+ type: 'hotkey';
6751
+ };
6752
+
6753
+ /**
6754
+ * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
6755
+ * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
6756
+ * @interface
6757
+ */
6758
+ declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
6407
6759
  type: 'hotkey';
6408
6760
  };
6409
6761
 
@@ -6466,7 +6818,7 @@ declare type IdEventType = WithId<AppVersionEventType>;
6466
6818
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6467
6819
  * @interface
6468
6820
  */
6469
- declare type IdleEvent = BaseSystemEvent & {
6821
+ declare type IdleEvent = BaseEvent_8 & {
6470
6822
  type: 'idle-state-changed';
6471
6823
  elapsedTime: number;
6472
6824
  isIdle: boolean;
@@ -6551,24 +6903,43 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6551
6903
  * Generated when an application has initialized.
6552
6904
  * @interface
6553
6905
  */
6554
- declare type InitializedEvent = IdentityEvent & {
6906
+ declare type InitializedEvent = BaseEvents.IdentityEvent & {
6555
6907
  topic: 'application';
6556
6908
  type: 'initialized';
6557
6909
  };
6558
6910
 
6559
- declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
6560
-
6561
- declare type InitLayoutOptions_2 = OpenFin.InitLayoutOptions;
6911
+ /**
6912
+ * Generated when a window is initialized.
6913
+ * @interface
6914
+ */
6915
+ declare type InitializedEvent_2 = BaseEvent_5 & {
6916
+ type: 'initialized';
6917
+ };
6562
6918
 
6563
6919
  /**
6564
6920
  * @interface
6565
6921
  */
6566
- declare type InitLayoutOptions_3 = {
6922
+ declare type InitLayoutOptions = {
6567
6923
  /**
6924
+ * @deprecated use container HTMLElement instead
6925
+ *
6568
6926
  * The id attribute of the container where the window's Layout should be initialized. If not provided
6569
6927
  * then an element with id `layout-container` is used. We recommend using a div element.
6570
6928
  */
6571
6929
  containerId?: string;
6930
+ /**
6931
+ * The HTMLElement where the window's Layout should be initialized. We recommend using a div element.
6932
+ */
6933
+ container?: HTMLElement;
6934
+ /**
6935
+ * An override callback used to instantiate a custom LayoutManager. When present, will enable
6936
+ * Multiple Layouts. The callback should return a class.
6937
+ *
6938
+ * @remarks
6939
+ * **NOTE**: Unlike the Platform Provider overrideCallback and interopOverride, this override should
6940
+ * return a class, not an instance
6941
+ */
6942
+ layoutManagerOverride?: LayoutManagerOverride<LayoutSnapshot>;
6572
6943
  };
6573
6944
 
6574
6945
  /**
@@ -8418,8 +8789,8 @@ declare class Layout extends Base {
8418
8789
  /**
8419
8790
  * @internal
8420
8791
  */
8421
- init: (options?: InitLayoutOptions_2) => Promise<Layout>;
8422
- identity: Identity_4;
8792
+ init: (options?: OpenFin.InitLayoutOptions) => Promise<Layout>;
8793
+ identity: OpenFin.LayoutIdentity;
8423
8794
  private platform;
8424
8795
  wire: Transport;
8425
8796
  /**
@@ -8598,133 +8969,30 @@ declare type LayoutComponent = LayoutItemConfig & {
8598
8969
 
8599
8970
  declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
8600
8971
 
8601
- declare class LayoutContentCache {
8602
- private contentItemCache;
8603
- private contentItemCacheId;
8604
- private createCacheKey;
8605
- hasKey: (id: string) => boolean;
8606
- getItemOrUndefined: (id: string) => GoldenLayout.ContentItem | undefined;
8607
- getContentItemOrThrow: (id: string, expectedType?: string[]) => GoldenLayout.ContentItem;
8608
- getOrCreateEntityId: (contentItem: GoldenLayout.ContentItem) => string;
8609
- }
8610
-
8611
8972
  declare type LayoutEntitiesClient = ApiClient<LayoutEntitiesController>;
8612
8973
 
8613
- /**
8614
- * @internal
8615
- * Controller for the layout entities apis, allowing alterations to be applied
8616
- * to an instance of layout manager in a structured manner.
8617
- */
8618
- declare class LayoutEntitiesController {
8619
- private layoutInstance;
8620
- private layoutContentCache;
8621
- private wire;
8622
- constructor(layoutInstance: OpenFinLayout, layoutContentCache: LayoutContentCache);
8623
- private analytics;
8624
- /**
8625
- * @internal
8626
- * @returns the root contentItem of the layout.
8627
- */
8628
- getRoot: () => OpenFin.LayoutEntityDefinition;
8629
- /**
8630
- * @internal
8631
- * Retrieves the containing stack of a given view identity.
8632
- * @param view Identity of the view to retrieve the stack of.
8633
- * @returns Stack containing the given view.
8634
- * @throws If the view does not belong to a stack within the layout manager.
8635
- */
8636
- getStackByView: (view: OpenFin.Identity) => Promise<OpenFin.LayoutEntityDefinition | undefined>;
8637
- /**
8638
- * @internal
8639
- * Returns all views belonging to a given stack
8640
- *
8641
- * NOTE: Due to (TODO: ticket) Golden Layouts has an issue which changes the order of tabs
8642
- * when the amount of new views to add overflows the width of the container. This results
8643
- * in tabs being re-ordered in the UI, while the underlying content item array remains in the
8644
- * original order specified. So calling getStackViews() will return this underlying array order,
8645
- * with indexes that will not match up to the render-order of the tabs.
8646
- *
8647
- * @param id - Entity id of the stack.
8648
- * @returns A list of view identities in order of appearance.
8649
- * @throws if the content item associated with the entity id does not exist or is not a stack.
8650
- */
8974
+ declare type LayoutEntitiesController = {
8975
+ getLayoutIdentityForViewOrThrow: (viewIdentity?: OpenFin.Identity) => Promise<OpenFin.LayoutIdentity>;
8976
+ getRoot: (layoutIdentity?: OpenFin.LayoutIdentity) => Promise<OpenFin.LayoutEntityDefinition>;
8977
+ getStackByView: (viewIdentity: OpenFin.Identity) => Promise<OpenFin.LayoutEntityDefinition | undefined>;
8651
8978
  getStackViews: (id: string) => OpenFin.Identity[];
8652
- /**
8653
- * @internal
8654
- * Retrieves the content of a column or row and adds each to the
8655
- * entity cache to allow them to be addressed externally.
8656
- * @param id Entity id of the Column Or Row to retrieve the content of.
8657
- * @returns Array of layout entity definitions
8658
- * @throws if the entity associated with {@link id} is not in the entity cache, does not belogn to a layout, or is not a column/row.
8659
- */
8660
- getContent(id: string): OpenFin.LayoutEntityDefinition[];
8661
- /**
8662
- * @internal
8663
- * Retrieves the parent content item of the given entity, and adds it to the entity cache
8664
- * so it can be addressed externally.
8665
- * @param id Entity id associated with a layout content item.
8666
- * @returns An entity definition for the given entity's parent, or undefined if the entity is the top level
8667
- * content item or has been removed from the layout entirely.
8668
- */
8669
- getParent(id: string): OpenFin.LayoutEntityDefinition | undefined;
8670
- /**
8671
- * @internal
8672
- * @param id Entity id associated with a layout content item.
8673
- * @returns true if the given entity is the root content item, false otherwise.
8674
- */
8979
+ getContent: (id: string) => OpenFin.LayoutEntityDefinition[];
8980
+ getParent: (id: string) => OpenFin.LayoutEntityDefinition | undefined;
8675
8981
  isRoot: (id: string) => boolean;
8676
- /**
8677
- * @internal
8678
- * Checks whether the given entity exists.
8679
- * @param entityId Id of a content item within the layout
8680
- * @returns True if the content item exists and belongs to the layout.
8681
- */
8682
8982
  exists: (entityId: string) => boolean;
8683
- /**
8684
- * @internal
8685
- * Adds an existing view to the stack, or creates and adds a view to the given stack.
8686
- *
8687
- * NOTE: Due to (TODO: ticket) Golden Layouts has an issue which changes the order of tabs
8688
- * when the amount of new views to add overflows the width of the container. This results
8689
- * in tabs being re-ordered in the UI, while the underlying content item array remains in the
8690
- * original order specified. So calling getStackViews() will return this underlying array order,
8691
- * with indexes that will not match up to the render-order of the tabs.
8692
- *
8693
- * @param stackEntityId Entity id of the stack content item within the layout.
8694
- * @param viewCreationOrReference View identity or creation options
8695
- * @param options Optional view options: index number used to insert the view into the stack at that index. Defaults to 0 (front of the stack)
8696
- * @returns Promise resolving with the identity of the newly added view.
8697
- * @throws If the view does not exist, fails to create, or the stack does not exist.
8698
- */
8699
- addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, { index }?: OpenFin.AddViewToStackOptions) => Promise<OpenFin.Identity>;
8700
- private findViewInStack;
8701
- /**
8702
- * @internal
8703
- * Removes a view from the given stack. If it's the only view, the stack will be destroyed, unless window creation
8704
- * option closeOnLastViewRemoved is set to false.
8705
- *
8706
- * @param stackEntityId Entity id of a stack content item to remove the view from.
8707
- * @param view Identity of the view to remove.
8708
- * @throws If the stack does not exist or the view does not exist or belong to the stack.
8709
- */
8983
+ addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: {
8984
+ index?: number;
8985
+ }) => Promise<OpenFin.Identity>;
8710
8986
  removeViewFromStack: (stackEntityId: string, view: OpenFin.Identity) => Promise<void>;
8711
- /**
8712
- * @internal
8713
- * Creates a new adjacent 'stack' and adds the views to it at the specified position
8714
- * @param targetId Entity id of the content item to add a stack adjacent to it
8715
- * @param views List of identities or view creation options of the views to include in the stack
8716
- * @param options Creation options, defaults to { position: 'right' }
8717
- * @returns the Entity Id of the new stack
8718
- */
8719
- createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], { position }?: {
8987
+ createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], stackCreationOptions?: {
8720
8988
  position?: OpenFin.LayoutPosition;
8721
8989
  }) => Promise<string>;
8722
- getAdjacentStacks: ({ targetId, edge }: {
8990
+ getAdjacentStacks: (stackTarget: {
8723
8991
  targetId: string;
8724
8992
  edge: OpenFin.LayoutPosition;
8725
8993
  }) => Promise<Pick<OpenFin.LayoutEntityDefinition, 'entityId'>[]>;
8726
8994
  setStackActiveView: (stackEntityId: string, viewIdentity: OpenFin.Identity) => Promise<void>;
8727
- }
8995
+ };
8728
8996
 
8729
8997
  /**
8730
8998
  * @interface
@@ -8751,7 +9019,7 @@ declare type LayoutIdentity = Identity_5 & {
8751
9019
  * Generated when a window and all of its layout's views have either finished or failed navigation.
8752
9020
  * @interface
8753
9021
  */
8754
- declare type LayoutInitializedEvent = BaseWindowEvent & {
9022
+ declare type LayoutInitializedEvent = BaseEvent_5 & {
8755
9023
  type: 'layout-initialized';
8756
9024
  ofViews: (OpenFin.Identity & {
8757
9025
  entityType: 'view';
@@ -8759,11 +9027,14 @@ declare type LayoutInitializedEvent = BaseWindowEvent & {
8759
9027
  };
8760
9028
 
8761
9029
  /**
8762
- * @interface @experimental
9030
+ * @interface @experimental @internal
9031
+ *
9032
+ * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
8763
9033
  *
8764
9034
  * Responsible for handling all layout management and renderering
8765
9035
  */
8766
9036
  declare type LayoutInstance = {
9037
+ identity: LayoutIdentity;
8767
9038
  getFrameSnapshot: () => Promise<LayoutOptions>;
8768
9039
  addView: (payload: AddViewOptions) => Promise<View_2>;
8769
9040
  closeView: (viewIdentity: Identity_5) => Promise<void>;
@@ -8772,15 +9043,14 @@ declare type LayoutInstance = {
8772
9043
  getViews: () => LayoutComponent[];
8773
9044
  getCurrentViews: () => Identity_5[];
8774
9045
  startReplaceLayout: (payload: ReplaceLayoutOptions) => Promise<void>;
8775
- applyPreset: (payload: PresetLayoutOptions_3) => void;
9046
+ applyPreset: (payload: PresetLayoutOptions_2) => void;
8776
9047
  isVisible: () => boolean;
8777
- destroy: () => void;
9048
+ destroy: () => Promise<void>;
8778
9049
  };
8779
9050
 
8780
9051
  /**
8781
9052
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
8782
- * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
8783
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
9053
+ * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
8784
9054
  *
8785
9055
  * @interface
8786
9056
  */
@@ -8802,25 +9072,43 @@ declare type LayoutItemConfig = {
8802
9072
 
8803
9073
  /**
8804
9074
  * @interface @experimental
9075
+ *
9076
+ * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
9077
+ *
9078
+ * Responsible for aggergating all layout snapshots and storing LayoutInstances
8805
9079
  */
8806
- declare interface LayoutManager<T extends LayoutSnapshot = LayoutSnapshot> {
9080
+ declare interface LayoutManager<T extends LayoutSnapshot> {
8807
9081
  /**
8808
9082
  * @experimental
8809
9083
  *
8810
- * Must be overridden when working with multiple layouts
9084
+ * To enable multiple layouts, override this method and do not call super.applyLayoutSnapshot()
9085
+ *
9086
+ * This hook is called by OpenFin during fin.Platform.Layout.init() call, to pass a snapshot to derived
9087
+ * classes which will be used launch a platform window. Use this hook to set your local UI state and
9088
+ * begin rendering the containers for your layouts UI.
8811
9089
  *
8812
- * Hook called during fin.Platform.Layout.init() call, to inform derived classes
8813
- * when a snapshot is being applied to launch a platform window. Use this hook to set the
8814
- * local state and ensure you call fin.Platform.Layout.create() on every layout in snapshot.layouts
9090
+ * Ensure you call fin.Platform.Layout.create() on every layout in snapshot.layouts when that layout is
9091
+ * ready to be created in your application.
8815
9092
  *
8816
- * When using custom data to the app manifest snapshot.windows.layoutSnapshot key, this data will
8817
- * be included in the snapshot type T and should align with your component state T.
9093
+ * If you add custom data to the app manifest snapshot.windows.layoutSnapshot key, this data will
9094
+ * be included in the snapshot type.
9095
+ *
9096
+ * The default implementation throws if it is called with a snapshot containing more than one layout.
8818
9097
  *
8819
- * TODO: detect if layoutManager override was set and this was not overridden somehow to warn?
8820
9098
  * @param snapshot
8821
- * @returns
9099
+ * @throws if Object.keys(snapshot).length > 1
9100
+ */
9101
+ applyLayoutSnapshot(snapshot: T): Promise<void>;
9102
+ /**
9103
+ * Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
9104
+ * contains a single layout.
9105
+ *
9106
+ * Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
9107
+ * fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
9108
+ *
9109
+ * @param snapshot
9110
+ * @throws if Object.keys(snapshot).length > 1
8822
9111
  */
8823
- applyLayoutSnapshot: (snapshot: T) => Promise<void>;
8824
9112
  /**
8825
9113
  * @experimental
8826
9114
  *
@@ -8831,35 +9119,63 @@ declare interface LayoutManager<T extends LayoutSnapshot = LayoutSnapshot> {
8831
9119
  * @param layoutIdentity
8832
9120
  * @returns
8833
9121
  */
8834
- showLayout: ({ layoutName }: LayoutIdentity) => Promise<void>;
9122
+ showLayout({ layoutName }: LayoutIdentity): Promise<void>;
8835
9123
  /**
8836
9124
  * @experimental
8837
9125
  *
8838
9126
  * @returns T
8839
9127
  */
8840
- getLayoutSnapshot: () => Promise<T>;
9128
+ getLayoutSnapshot(): Promise<T>;
8841
9129
  /**
8842
9130
  * @experimental
8843
9131
  *
8844
- * @param param0
9132
+ * @param layoutIdentity
8845
9133
  * @returns
8846
9134
  */
8847
- resolveLayout: ({ layoutName }: LayoutIdentity) => LayoutInstance;
9135
+ resolveLayout(layoutIdentity?: LayoutIdentity): Promise<LayoutInstance>;
8848
9136
  /**
8849
9137
  * @experimental
8850
9138
  *
8851
9139
  * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
8852
9140
  * Throws if it does not exist.
8853
- * @param layoutIdentity
9141
+ * @param layoutName
8854
9142
  * @returns
8855
9143
  */
8856
- getLayoutByName: (layoutName: string) => LayoutInstance;
9144
+ getLayoutByName(layoutName: string): LayoutInstance;
8857
9145
  /**
8858
9146
  * @experimental
8859
9147
  */
8860
9148
  getLayouts(): Record<string, LayoutInstance>;
9149
+ /**
9150
+ * @experimental
9151
+ */
9152
+ getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
9153
+ /**
9154
+ * @experimental
9155
+ */
9156
+ isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
8861
9157
  }
8862
9158
 
9159
+ /**
9160
+ * @experimental
9161
+ *
9162
+ * Constructor type for LayoutManager to be used with multiple layouts
9163
+ */
9164
+ declare type LayoutManagerConstructor<T extends LayoutSnapshot> = {
9165
+ new (): LayoutManager<T>;
9166
+ };
9167
+
9168
+ /**
9169
+ * @experimental
9170
+ *
9171
+ * Override callback used to init and configure multiple layouts. Implement by passing
9172
+ * a lambda and returning a class that OpenFin will new up for you.
9173
+ * @remarks
9174
+ * **NOTE**: Unlike the Platform Provider overrideCallback and interopOverride, this override should
9175
+ * return a class, not an instance
9176
+ */
9177
+ declare type LayoutManagerOverride<T extends LayoutSnapshot> = (Base: LayoutManagerConstructor<LayoutSnapshot>) => LayoutManagerConstructor<T>;
9178
+
8863
9179
  /**
8864
9180
  * Static namespace for OpenFin API methods that interact with the {@link Layout} class, available under `fin.Platform.Layout`.
8865
9181
  */
@@ -8884,7 +9200,7 @@ declare class LayoutModule extends Base {
8884
9200
  * const layoutConfig = await layout.getConfig();
8885
9201
  * ```
8886
9202
  */
8887
- wrap(identity: OpenFin.Identity): Promise<OpenFin.Layout>;
9203
+ wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
8888
9204
  /**
8889
9205
  * Synchronously returns a Layout object that represents a Window's layout.
8890
9206
  *
@@ -8904,7 +9220,7 @@ declare class LayoutModule extends Base {
8904
9220
  * const layoutConfig = await layout.getConfig();
8905
9221
  * ```
8906
9222
  */
8907
- wrapSync(identity: OpenFin.Identity): OpenFin.Layout;
9223
+ wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
8908
9224
  /**
8909
9225
  * Asynchronously returns a Layout object that represents a Window's layout.
8910
9226
  *
@@ -8968,7 +9284,14 @@ declare class LayoutModule extends Base {
8968
9284
  * const layout = await fin.Platform.Layout.init({ containerId });
8969
9285
  * ```
8970
9286
  */
8971
- init: (options?: InitLayoutOptions) => Promise<OpenFin.Layout>;
9287
+ init: (options?: OpenFin.InitLayoutOptions) => Promise<OpenFin.Layout>;
9288
+ /**
9289
+ * Returns the layout manager for the current window
9290
+ * @returns
9291
+ */
9292
+ getCurrentLayoutManagerSync: <UserSnapshotType extends OpenFin.LayoutSnapshot>() => OpenFin.LayoutManager<UserSnapshotType>;
9293
+ create: (options: OpenFin.CreateLayoutOptions) => Promise<void>;
9294
+ destroy: (layoutIdentity: OpenFin.LayoutIdentity) => Promise<void>;
8972
9295
  }
8973
9296
 
8974
9297
  declare type LayoutModule_2 = OpenFin.Fin['Platform']['Layout'];
@@ -8996,7 +9319,7 @@ declare abstract class LayoutNode {
8996
9319
  /**
8997
9320
  * @ignore
8998
9321
  * @internal
8999
- * Encapsulates Api consumption of {@link LayoutEntitiesController} with a relayed dispatch
9322
+ * Encapsulates Api consumption of {@link LayoutEntitiesClient} with a relayed dispatch
9000
9323
  * @param client
9001
9324
  * @param controllerId
9002
9325
  * @param identity
@@ -9211,8 +9534,7 @@ declare type LayoutOptions = {
9211
9534
  };
9212
9535
  /**
9213
9536
  * Content of the layout. There can only be one top-level LayoutItem in the content array.
9214
- * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
9215
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
9537
+ * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
9216
9538
  */
9217
9539
  content?: LayoutContent;
9218
9540
  dimensions?: {
@@ -9234,7 +9556,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9234
9556
  * Generated when a window and all of its layout's views have been created and can receive API calls.
9235
9557
  * @interface
9236
9558
  */
9237
- declare type LayoutReadyEvent = BaseWindowEvent & {
9559
+ declare type LayoutReadyEvent = BaseEvent_5 & {
9238
9560
  type: 'layout-ready';
9239
9561
  views: (OpenFin.Identity & {
9240
9562
  success: boolean;
@@ -9375,7 +9697,7 @@ declare type Manifest = {
9375
9697
  * Generated when the RVM notifies an application that the manifest has changed.
9376
9698
  * @interface
9377
9699
  */
9378
- declare type ManifestChangedEvent = IdentityEvent & {
9700
+ declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
9379
9701
  topic: 'application';
9380
9702
  type: 'manifest-changed';
9381
9703
  };
@@ -9428,7 +9750,7 @@ declare type MatchPattern = string;
9428
9750
  * Generated when a window is maximized.
9429
9751
  * @interface
9430
9752
  */
9431
- declare type MaximizedEvent = BaseWindowEvent & {
9753
+ declare type MaximizedEvent = BaseEvent_5 & {
9432
9754
  type: 'maximized';
9433
9755
  };
9434
9756
 
@@ -9508,7 +9830,17 @@ declare interface Message<T> {
9508
9830
 
9509
9831
  declare type MessageHandler = (data: any) => boolean;
9510
9832
 
9511
- declare class MessageReceiver extends Base {
9833
+ declare interface MessageReceiver {
9834
+ addEventListener(e: 'open', listener: (ev: Event) => void): void;
9835
+ addEventListener(e: 'error', listener: (ev: Event) => void): void;
9836
+ addEventListener(e: 'message', listener: (ev: MessageEvent) => void): void;
9837
+ addEventListener(e: 'close', listener: (ev: Event) => void): void;
9838
+ send(data: unknown): void;
9839
+ close(): void;
9840
+ readyState: FlexReadyState;
9841
+ }
9842
+
9843
+ declare class MessageReceiver_2 extends Base {
9512
9844
  private endpointMap;
9513
9845
  private latestEndpointIdByChannelId;
9514
9846
  constructor(wire: Transport);
@@ -9528,7 +9860,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
9528
9860
  * Generated when a window is minimized.
9529
9861
  * @interface
9530
9862
  */
9531
- declare type MinimizedEvent = BaseWindowEvent & {
9863
+ declare type MinimizedEvent = BaseEvent_5 & {
9532
9864
  type: 'minimized';
9533
9865
  };
9534
9866
 
@@ -9577,7 +9909,7 @@ declare type MonitorDetails = {
9577
9909
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9578
9910
  * @interface
9579
9911
  */
9580
- declare type MonitorEvent = BaseSystemEvent & OpenFin.MonitorInfo & {
9912
+ declare type MonitorEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9581
9913
  type: 'monitor-info-changed';
9582
9914
  };
9583
9915
 
@@ -9662,7 +9994,7 @@ declare type MutableViewOptions = {
9662
9994
  contentRedirect: ContentRedirect;
9663
9995
  /**
9664
9996
  * @defaultValue false
9665
- *
9997
+ * @deprecated
9666
9998
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9667
9999
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9668
10000
  */
@@ -10009,14 +10341,23 @@ declare type NonPropagatedWindowEvent = never;
10009
10341
 
10010
10342
  /**
10011
10343
  * @internal
10344
+ *
10345
+ * Ensures that an event type key does not include any `close-requested` events. Distributes over unions.
10346
+ */
10347
+ declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'close-requested'>;
10348
+
10349
+ /**
10350
+ * @internal
10351
+ *
10352
+ * Ensures that an event type key doesn't include any `-requested` events. Distributes over unions.
10012
10353
  */
10013
- declare type NotRequested<EventType> = EventType extends `${infer U}-requested` ? never : EventType;
10354
+ declare type NotRequested<EventType extends String> = EventType extends `${infer U}-requested` ? never : EventType;
10014
10355
 
10015
10356
  /**
10016
10357
  * Generated when an application is not responding.
10017
10358
  * @interface
10018
10359
  */
10019
- declare type NotRespondingEvent = IdentityEvent & {
10360
+ declare type NotRespondingEvent = BaseEvents.IdentityEvent & {
10020
10361
  topic: 'application';
10021
10362
  type: 'not-responding';
10022
10363
  };
@@ -10085,6 +10426,11 @@ declare namespace OpenFin {
10085
10426
  Rectangle,
10086
10427
  ApplicationCreationOptions,
10087
10428
  ApplicationOptions,
10429
+ CustomProtocolMissingState,
10430
+ CustomProtocolMalformedState,
10431
+ CustomProtocolRegisteredState,
10432
+ CustomProtocolState,
10433
+ CustomProtocolOptions,
10088
10434
  InteropBrokerOptions,
10089
10435
  ContextGroupInfo,
10090
10436
  DisplayMetadata_3 as DisplayMetadata,
@@ -10148,6 +10494,7 @@ declare namespace OpenFin {
10148
10494
  ReplaceViewPayload,
10149
10495
  ReplaceViewOptions,
10150
10496
  CloseViewPayload,
10497
+ CloseViewOptions,
10151
10498
  FetchManifestPayload,
10152
10499
  ReplaceLayoutOpts,
10153
10500
  ReplaceLayoutPayload,
@@ -10271,6 +10618,11 @@ declare namespace OpenFin {
10271
10618
  IntentHandler_2 as IntentHandler,
10272
10619
  ContentCreationBehaviorNames,
10273
10620
  MatchPattern,
10621
+ BaseContentCreationRule,
10622
+ WindowContentCreationRule,
10623
+ ViewContentCreationRule,
10624
+ BrowserContentCreationRule,
10625
+ BlockedContentCreationRule,
10274
10626
  ContentCreationRule,
10275
10627
  ContentCreationOptions,
10276
10628
  SnapshotProvider,
@@ -10310,13 +10662,13 @@ declare namespace OpenFin {
10310
10662
  LayoutPresetType,
10311
10663
  LayoutIdentity,
10312
10664
  LayoutSnapshot,
10313
- InitLayoutOptions_3 as InitLayoutOptions,
10665
+ InitLayoutOptions,
10666
+ LayoutManagerConstructor,
10667
+ LayoutManagerOverride,
10314
10668
  LayoutInstance,
10315
10669
  LayoutManager,
10316
- AddLayoutInstanceOptions,
10317
10670
  CreateLayoutOptions,
10318
- DestroyLayoutOptions,
10319
- PresetLayoutOptions_3 as PresetLayoutOptions,
10671
+ PresetLayoutOptions_2 as PresetLayoutOptions,
10320
10672
  ResultBehavior,
10321
10673
  PopupBaseBehavior,
10322
10674
  PopupResultBehavior,
@@ -10331,7 +10683,7 @@ declare namespace OpenFin {
10331
10683
  AppVersionCompleteEvent,
10332
10684
  AppVersionRuntimeStatusEvent,
10333
10685
  Events,
10334
- BaseEvent_2 as BaseEvent,
10686
+ BaseEvent_9 as BaseEvent,
10335
10687
  WebContentsEvent_2 as WebContentsEvent,
10336
10688
  SystemEvent_2 as SystemEvent,
10337
10689
  ApplicationEvent_2 as ApplicationEvent,
@@ -10356,6 +10708,7 @@ declare namespace OpenFin {
10356
10708
  ChannelClientDisconnectionListener,
10357
10709
  ChannelProviderDisconnectionListener,
10358
10710
  RoutingInfo,
10711
+ DownloadShelfOptions,
10359
10712
  ApplicationEvents,
10360
10713
  BaseEvents,
10361
10714
  ExternalApplicationEvents,
@@ -10370,113 +10723,34 @@ declare namespace OpenFin {
10370
10723
  }
10371
10724
  export default OpenFin;
10372
10725
 
10373
- declare class OpenFinLayout implements OpenFin.LayoutInstance {
10374
- #private;
10375
- private readonly splitterController;
10376
- private readonly tabDragController;
10377
- private readonly layoutContentCache;
10378
- private get defaultFaviconUrl();
10379
- private get isDragging();
10380
- private get resizing();
10381
- private get showBackgroundImages();
10382
- private get showFavicons();
10383
- private get showViewsOnSplitterDrag();
10384
- private get showViewsOnTabDrag();
10385
- private get showViewsOnWindowResize();
10386
- private get container();
10387
- get layout(): GoldenLayout.GoldenLayout;
10388
- private get layoutConfigToRestore();
10389
- private client;
10390
- private containerResizeObserver;
10391
- private viewsResizeObserver;
10392
- readonly ofWindow: OpenFin.Window;
10393
- readonly platform: Platform_2;
10394
- private lastItemDestroyed?;
10395
- private viewsSubscribedTo;
10396
- constructor(splitterController: SplitterController, tabDragController: TabDragController, layoutContentCache: LayoutContentCache, container: HTMLElement);
10397
- getViews: () => OpenFin.LayoutComponent[];
10398
- startReplaceLayout: ({ layout }: {
10399
- layout: GoldenLayout.Config;
10400
- }) => Promise<void>;
10401
- applyPreset: (payload: PresetLayoutOptions_2) => void;
10402
- isVisible: () => boolean;
10403
- destroy: () => void;
10404
- /**
10405
- * @internal
10406
- * Needed by init-layout util to wire up {@link LayoutEntitiesController}
10407
- */
10408
- static getClient: (instance: OpenFinLayout) => OpenFin.ChannelClient;
10409
- initManager: () => Promise<void>;
10410
- createLayout: (layout: GoldenLayout.Config, container: HTMLElement) => Promise<void>;
10411
- private setContainer;
10412
- private setupDragDropRegions;
10413
- private replaceLayout;
10414
- private onViewDetached;
10415
- private setupLayoutListeners;
10416
- private onLayoutInit;
10417
- private registerViewComponent;
10418
- private setupWindowListeners;
10419
- private setupResizeObservers;
10420
- /**
10421
- * Shows/hides a view depending on use case (used by browser)
10422
- * @ignore
10423
- */
10424
- private updateViewVisibility;
10425
- private onStackCreated;
10426
- private onTabCreated;
10427
- private onTabMouseUp;
10428
- private replaceCloseTabButton;
10429
- onCloseTabButtonClick: (tab: GoldenLayout.Tab) => Promise<void>;
10430
- addFaviconToTab: (tab: GoldenLayout.Tab, eventIcons: string[]) => void;
10431
- onPopoutClick: (stack: GoldenLayout.ContentItem) => void;
10432
- onStackCloseClick: (stack: GoldenLayout.ContentItem) => void;
10433
- private updateButtonDisplay;
10434
- private onItemCreated;
10435
- private observeSplitters;
10436
- handleOutOfWindowDrop: (e: {
10437
- screenY: number;
10438
- screenX: number;
10439
- }, parentTab: GoldenLayout.Tab, dimensions: {
10440
- width: any;
10441
- height: any;
10442
- }) => Promise<void>;
10443
- private onTabDragStart;
10444
- private setBackgroundImage;
10445
- private setBackgroundImages;
10446
- getFrameSnapshot: () => Promise<GoldenLayout.Config>;
10447
- getCurrentViews: () => OpenFin.Identity[];
10448
- addView: ({ options: viewConfig, targetView, location }: OpenFin.AddViewOptions) => Promise<View_4>;
10449
- replaceView: ({ viewToReplace, newView }: OpenFin.ReplaceViewOptions) => Promise<View_4>;
10450
- removeView: (viewConfig: OpenFin.Identity | OpenFin.ViewState) => Promise<View_4>;
10451
- closeView: (viewIdentity: OpenFin.Identity) => Promise<void>;
10452
- private createChannelConnections;
10453
- getViewComponent: ({ name }: {
10454
- name: string;
10455
- }) => ViewComponent | undefined;
10456
- getViewComponents: () => ViewComponent[];
10457
- private hideHighlight;
10458
- getOfViewFromComponentState: ({ name }: {
10459
- name: string;
10460
- }) => View_4;
10461
- private hideAllViews;
10462
- private showViews;
10463
- private initializeLayoutViews;
10464
- private createResizableView;
10465
- private attachView;
10466
- private createAndAttachView;
10467
- private setupViewEvents;
10468
- private dispatchLayoutEvent;
10469
- private setComponentState;
10470
- }
10471
-
10472
10726
  declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
10473
10727
 
10728
+ /**
10729
+ * Generated after window options are changed using the window.updateOptions method.
10730
+ * @remarks Will not fire if the diff object is empty.
10731
+ * @interface
10732
+ */
10733
+ declare type OptionsChangedEvent = BaseEvent_5 & {
10734
+ type: 'options-changed';
10735
+ options: OpenFin.WindowOptions;
10736
+ diff: OpenFin.WindowOptionDiff;
10737
+ };
10738
+
10474
10739
  declare type OverlapsOnlyIfMatching<T, U> = {
10475
10740
  [K in Extract<keyof T, keyof U>]: U[K] extends T[K] ? U[K] : T[K] extends U[K] ? T[K] : never;
10476
10741
  };
10477
10742
 
10478
10743
  declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
10479
10744
 
10745
+ /**
10746
+ * Generated when page receives favicon urls.
10747
+ * @interface
10748
+ */
10749
+ declare type PageFaviconUpdatedEvent = NamedEvent & {
10750
+ type: 'page-favicon-updated';
10751
+ favicons: string[];
10752
+ };
10753
+
10480
10754
  /**
10481
10755
  * Generated when page title is set during navigation.
10482
10756
  * @remarks explicitSet is false when title is synthesized from file url.
@@ -10495,74 +10769,74 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
10495
10769
  };
10496
10770
 
10497
10771
  /**
10498
- * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
10772
+ * Extracts a single event type matching the given key from the View {@link Event} union.
10499
10773
  *
10500
10774
  * @typeParam Type String key specifying the event to extract
10501
10775
  */
10502
- declare type Payload_2<Type extends ApplicationEventType> = Extract<ApplicationEvent, {
10776
+ declare type Payload_2<Type extends EventType> = Extract<Event_4, {
10503
10777
  type: Type;
10504
10778
  }>;
10505
10779
 
10506
10780
  /**
10507
- * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
10781
+ * Extracts a single event type matching the given key from the Window {@link Event} union.
10508
10782
  *
10509
10783
  * @typeParam Type String key specifying the event to extract
10510
10784
  */
10511
- declare type Payload_3<Type extends ExternalApplicationEventType> = Extract<ExternalApplicationEvent, {
10785
+ declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
10512
10786
  type: Type;
10513
10787
  }>;
10514
10788
 
10515
10789
  /**
10516
- * Extracts a single event type matching the given key from the {@link FrameEvent} union.
10790
+ * Extracts a single event type matching the given key from the Application {@link Event} union.
10517
10791
  *
10518
10792
  * @typeParam Type String key specifying the event to extract
10519
10793
  */
10520
- declare type Payload_4<Type extends FrameEventType> = Extract<FrameEvent, {
10794
+ declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
10521
10795
  type: Type;
10522
10796
  }>;
10523
10797
 
10524
10798
  /**
10525
- * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
10799
+ * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
10526
10800
  *
10527
10801
  * @typeParam Type String key specifying the event to extract
10528
10802
  */
10529
- declare type Payload_5<Type extends GlobalHotkeyEventType> = Extract<GlobalHotkeyEvent, {
10803
+ declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
10530
10804
  type: Type;
10531
10805
  }>;
10532
10806
 
10533
10807
  /**
10534
- * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
10808
+ * Extracts a single event type matching the given key from the Frame {@link Event} union.
10535
10809
  *
10536
10810
  * @typeParam Type String key specifying the event to extract
10537
10811
  */
10538
- declare type Payload_6<Type extends PlatformEventType> = Extract<PlatformEvent, {
10812
+ declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
10539
10813
  type: Type;
10540
10814
  }>;
10541
10815
 
10542
10816
  /**
10543
- * Extracts a single event type matching the given key from the {@link SystemEvent} union.
10817
+ * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
10544
10818
  *
10545
10819
  * @typeParam Type String key specifying the event to extract
10546
10820
  */
10547
- declare type Payload_7<Type extends SystemEventType> = Extract<SystemEvent, {
10821
+ declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
10548
10822
  type: Type;
10549
10823
  }>;
10550
10824
 
10551
10825
  /**
10552
- * Extracts a single event type matching the given key from the {@link ViewEvent} union.
10826
+ * Extracts a single event type matching the given key from the Platform {@link Event} union.
10553
10827
  *
10554
10828
  * @typeParam Type String key specifying the event to extract
10555
10829
  */
10556
- declare type Payload_8<Type extends ViewEventType> = Extract<ViewEvent, {
10830
+ declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
10557
10831
  type: Type;
10558
10832
  }>;
10559
10833
 
10560
10834
  /**
10561
- * Extracts a single event type matching the given key from the {@link WindowEvent} union.
10835
+ * Extracts a single event type matching the given key from the System {@link Event} union.
10562
10836
  *
10563
10837
  * @typeParam Type String key specifying the event to extract
10564
10838
  */
10565
- declare type Payload_9<Type extends WindowEventType> = Extract<WindowEvent, {
10839
+ declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10566
10840
  type: Type;
10567
10841
  }>;
10568
10842
 
@@ -10572,7 +10846,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
10572
10846
  * Generated when window finishes loading. Provides performance and navigation data.
10573
10847
  * @interface
10574
10848
  */
10575
- declare type PerformanceReportEvent = Performance & BaseWindowEvent & {
10849
+ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
10576
10850
  type: 'performance-report';
10577
10851
  };
10578
10852
 
@@ -11235,41 +11509,37 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
11235
11509
  }): Promise<void>;
11236
11510
  }
11237
11511
 
11238
- declare type Platform_2 = OpenFin.Platform;
11239
-
11240
11512
  /**
11241
- * Generated when a new Platform's API becomes responsive.
11242
- * @interface
11513
+ * @deprecated Renamed to {@link ApiReadyEvent}.
11243
11514
  */
11244
- declare type PlatformApiReadyEvent = BaseEvent & {
11245
- topic: 'application';
11246
- type: 'platform-api-ready';
11247
- };
11515
+ declare type PlatformApiReadyEvent = ApiReadyEvent;
11248
11516
 
11249
11517
  /**
11250
- * [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
11251
- * discriminated by {@link PlatformEvent.type | their type}. Event payloads unique to `Platform` can be found
11252
- * under the {@link OpenFin.PlatformEvents} namespace.
11518
+ * @deprecated Renamed to {@link Event}.
11253
11519
  */
11254
- declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
11520
+ declare type PlatformEvent = Event_10;
11255
11521
 
11256
11522
  declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
11257
11523
 
11258
11524
  declare namespace PlatformEvents {
11259
11525
  export {
11526
+ ApiReadyEvent,
11260
11527
  PlatformApiReadyEvent,
11528
+ SnapshotAppliedEvent,
11261
11529
  PlatformSnapshotAppliedEvent,
11530
+ Event_10 as Event,
11262
11531
  PlatformEvent,
11532
+ EventType_7 as EventType,
11263
11533
  PlatformEventType,
11264
- Payload_6 as Payload,
11265
- ByType_5 as ByType
11534
+ Payload_8 as Payload,
11535
+ ByType_7 as ByType
11266
11536
  }
11267
11537
  }
11268
11538
 
11269
11539
  /**
11270
- * Union of possible `type` values for a {@link PlatformEvent}.
11540
+ * @deprecated Renamed to {@link }.
11271
11541
  */
11272
- declare type PlatformEventType = PlatformEvent['type'];
11542
+ declare type PlatformEventType = EventType_7;
11273
11543
 
11274
11544
  /**
11275
11545
  * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
@@ -11531,6 +11801,32 @@ declare interface PlatformProvider {
11531
11801
  * ```
11532
11802
  */
11533
11803
  getSnapshot(payload: undefined, identity: OpenFin.Identity): Promise<OpenFin.Snapshot>;
11804
+ /**
11805
+ * @experimental @internal
11806
+ *
11807
+ * **NOTE**: Internal use only. This method is reserved for Workspace Browser implementation.
11808
+ *
11809
+ * Returns the window options value for `layoutSnapshot` which has already been normalized.
11810
+ * @param payload
11811
+ * @param callerIdentity
11812
+ */
11813
+ getInitialLayoutSnapshot(payload: undefined, callerIdentity: OpenFin.Identity): Promise<OpenFin.LayoutSnapshot | undefined>;
11814
+ /**
11815
+ * @experimental @internal
11816
+ *
11817
+ * **NOTE**: Internal use only. This method is reserved for Workspace Browser implementation.
11818
+ *
11819
+ * Calls platform.createView for every view in the given layout. Returns an array of promises
11820
+ * one promise for each view create call
11821
+ *
11822
+ * @param payload
11823
+ * @param callerIdentity
11824
+ * @returns an array of promises
11825
+ */
11826
+ createViewsForLayout(payload: {
11827
+ layout: GoldenLayout.Config;
11828
+ target?: OpenFin.Identity;
11829
+ }, callerIdentity: OpenFin.Identity): Promise<OpenFin.View>[];
11534
11830
  /**
11535
11831
  * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
11536
11832
  * 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.
@@ -11971,19 +12267,9 @@ declare interface PlatformProvider {
11971
12267
  }
11972
12268
 
11973
12269
  /**
11974
- * Generated when a platform.ApplySnapshot call is resolved.
11975
- * @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
11976
- * 1. The window has been created
11977
- * 2. The window has a responsive API
11978
- * 3. If a window has a layout property, the 'layout-ready' event has fired
11979
- *
11980
- * _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.
11981
- * @interface
12270
+ * @deprecated Renamed to {@link SnapshotAppliedEvent}.
11982
12271
  */
11983
- declare type PlatformSnapshotAppliedEvent = BaseEvent & {
11984
- topic: 'application';
11985
- type: 'platform-snapshot-applied';
11986
- };
12272
+ declare type PlatformSnapshotAppliedEvent = SnapshotAppliedEvent;
11987
12273
 
11988
12274
  /**
11989
12275
  * @interface
@@ -12251,7 +12537,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
12251
12537
  * A general preload scripts state change event without event type.
12252
12538
  * @interface
12253
12539
  */
12254
- declare type PreloadScriptsStateChangeEvent = BaseWindowEvent & {
12540
+ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12255
12541
  preloadScripts: (PreloadScriptInfoRunning & any)[];
12256
12542
  };
12257
12543
 
@@ -12266,12 +12552,10 @@ declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent &
12266
12552
 
12267
12553
  declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
12268
12554
 
12269
- declare type PresetLayoutOptions_2 = OpenFin.PresetLayoutOptions;
12270
-
12271
12555
  /**
12272
12556
  * @interface
12273
12557
  */
12274
- declare type PresetLayoutOptions_3 = {
12558
+ declare type PresetLayoutOptions_2 = {
12275
12559
  /**
12276
12560
  * Which preset layout arrangement to use.
12277
12561
  * The preset options are `columns`, `grid`, `rows`, and `tabs`.
@@ -12462,65 +12746,96 @@ declare type ProcessLoggingOptions = {
12462
12746
  };
12463
12747
 
12464
12748
  /**
12465
- * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
12466
- * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
12467
- * are propagated to `System` without any type string prefixing.
12468
- *
12469
- * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
12749
+ * @deprecated Renamed to {@link PropagatedEvent}.
12470
12750
  */
12471
- declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
12751
+ declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent_4<TargetTopic>;
12472
12752
 
12473
12753
  /**
12474
- * Union of possible 'type' values for a {@link OpenFin.ApplicationEvents.PropagatedApplicationEvent}.
12754
+ * @deprecated Renamed to {@link PropagatedEventType}.
12475
12755
  */
12476
- declare type PropagatedApplicationEventType = PropagatedApplicationEvent<string>['type'];
12756
+ declare type PropagatedApplicationEventType = PropagatedEventType_3;
12477
12757
 
12478
12758
  /**
12479
- * Modifies an event shape to reflect propagation to a parent topic.
12759
+ * Modifies an event shape to reflect propagation to a parent topic. Excludes `close-requested` events, as
12760
+ * these do not propagate.
12761
+ *
12480
12762
  * @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
12763
+ *
12764
+ * @typeParam SourceTopic The topic the event shape is propagating from.
12765
+ * @typeParam TargetTopic The topic the event shape is propagating to.
12766
+ * @typeParam Event The shape of the event being propagated.
12481
12767
  */
12482
12768
  declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
12483
12769
  type: string;
12484
12770
  }> = Event extends infer E extends {
12485
12771
  type: string;
12486
- } ? Omit<E, 'type' | 'topic'> & {
12772
+ } ? E['type'] extends 'close-requested' ? never : Omit<E, 'type' | 'topic'> & {
12487
12773
  type: PropagatedEventType<SourceTopic, E['type']>;
12488
12774
  topic: TargetTopic;
12489
12775
  } : never;
12490
12776
 
12491
- /**
12492
- * Modifies an event key to reflect propagation by prefixing with the topic.
12493
- */
12494
- declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
12495
-
12496
12777
  /**
12497
12778
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
12498
- * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
12779
+ * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
12499
12780
  * event type key with `'view-'`.
12500
12781
  */
12501
- declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
12782
+ declare type PropagatedEvent_2<TargetTopic extends string> = BaseEvents.PropagatedEvent<'view', TargetTopic, ViewEvent> & {
12502
12783
  viewIdentity: OpenFin.Identity;
12503
12784
  };
12504
12785
 
12505
- /**
12506
- * Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
12507
- */
12508
- declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
12509
-
12510
12786
  /**
12511
12787
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
12512
- * prefixing the type string with `'window-'`. Only {@link NativeWindowEvent native window events} will propagate
12788
+ * prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
12513
12789
  * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
12514
12790
  * will *not* re-propagate.
12515
12791
  *
12516
12792
  * "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
12517
12793
  */
12518
- declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent<'window', TargetTopic, Exclude<WindowSourcedEvent, WindowCloseRequestedEvent>>;
12794
+ declare type PropagatedEvent_3<TargetTopic extends string> = BaseEvents.PropagatedEvent<'window', TargetTopic, WindowSourcedEvent>;
12795
+
12796
+ /**
12797
+ * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
12798
+ * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
12799
+ * are propagated to `System` without any type string prefixing.
12800
+ *
12801
+ * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
12802
+ */
12803
+ declare type PropagatedEvent_4<TargetTopic extends string> = BaseEvents.PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
12804
+
12805
+ /**
12806
+ * Modifies an event type key to reflect propagation by prefixing with the topic.
12807
+ */
12808
+ declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${NotCloseRequested<Type>}`;
12809
+
12810
+ /**
12811
+ * Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.View}.
12812
+ */
12813
+ declare type PropagatedEventType_2 = PropagatedEvent_2<string>['type'];
12814
+
12815
+ /**
12816
+ * Union of possible 'type' values for an {@link PropagatedEvent} sourced from an {@link Application}.
12817
+ */
12818
+ declare type PropagatedEventType_3 = PropagatedEvent_4<string>['type'];
12819
+
12820
+ /**
12821
+ * @deprecated Renamed to {@link PropagatedEvent}.
12822
+ */
12823
+ declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent_2<TargetTopic>;
12824
+
12825
+ /**
12826
+ * @deprecated Renamed to {@link PropagatedEventType}.
12827
+ */
12828
+ declare type PropagatedViewEventType = PropagatedEventType_2;
12829
+
12830
+ /**
12831
+ * @deprecated Renamed to {@link PropagatedEvent}.
12832
+ */
12833
+ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent_3<TargetTopic>;
12519
12834
 
12520
12835
  /**
12521
- * Union of possible `type` values for a {@link OpenFin.WindowEvents.PropagatedWindowEvent}.
12836
+ * Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.Window}.
12522
12837
  */
12523
- declare type PropagatedWindowEventType = PropagatedWindowEvent<string>['type'];
12838
+ declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
12524
12839
 
12525
12840
  declare interface ProtocolMap extends ProtocolMapBase {
12526
12841
  'request-external-authorization': {
@@ -12727,6 +13042,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
12727
13042
  anchor: OpenFin.AnchorType;
12728
13043
  }>>;
12729
13044
  'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin.Bounds>>>;
13045
+ 'register-custom-protocol': ApiCall<OpenFin.CustomProtocolOptions, void>;
13046
+ 'unregister-custom-protocol': ApiCall<{
13047
+ protocolName: string;
13048
+ }, void>;
13049
+ 'get-custom-protocol-state': ApiCall<{
13050
+ protocolName: string;
13051
+ }, OpenFin.CustomProtocolState>;
12730
13052
  }
12731
13053
 
12732
13054
  declare interface ProtocolMapBase {
@@ -12858,6 +13180,10 @@ declare interface ReactComponentConfig extends ItemConfig {
12858
13180
  */
12859
13181
  declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptions;
12860
13182
 
13183
+ declare interface ReceiverConfig extends Omit<RemoteConfig, 'address'> {
13184
+ receiver: MessageReceiver;
13185
+ }
13186
+
12861
13187
  /**
12862
13188
  * A rectangular area on the screen.
12863
13189
  *
@@ -12927,7 +13253,7 @@ declare type RegistryInfo_2 = {
12927
13253
  * Generated when a window has been reloaded.
12928
13254
  * @interface
12929
13255
  */
12930
- declare type ReloadedEvent = BaseWindowEvent & {
13256
+ declare type ReloadedEvent = BaseEvent_5 & {
12931
13257
  type: 'reloaded';
12932
13258
  url: string;
12933
13259
  };
@@ -12939,19 +13265,19 @@ declare interface RemoteConfig extends ExistingConnectConfig {
12939
13265
  /**
12940
13266
  * @interface
12941
13267
  */
12942
- declare type ReplaceLayoutOptions = ReplaceLayoutOpts;
13268
+ declare type ReplaceLayoutOptions = {
13269
+ /**
13270
+ * Layout config to be applied.
13271
+ */
13272
+ layout: LayoutOptions;
13273
+ };
12943
13274
 
12944
13275
  /**
12945
13276
  * @interface
12946
13277
  *
12947
13278
  * @deprecated use ReplaceLayoutOptions instead
12948
13279
  */
12949
- declare type ReplaceLayoutOpts = {
12950
- /**
12951
- * Layout config to be applied.
12952
- */
12953
- layout: LayoutOptions;
12954
- };
13280
+ declare type ReplaceLayoutOpts = ReplaceLayoutOptions;
12955
13281
 
12956
13282
  /**
12957
13283
  * @interface
@@ -12962,9 +13288,9 @@ declare type ReplaceLayoutPayload = {
12962
13288
  */
12963
13289
  opts: ReplaceLayoutOptions;
12964
13290
  /**
12965
- * Identity of the window whose layout will be replace.
13291
+ * Identity of the window whose layout will be replaced.
12966
13292
  */
12967
- target: Identity_5;
13293
+ target: LayoutIdentity;
12968
13294
  };
12969
13295
 
12970
13296
  /**
@@ -12983,7 +13309,7 @@ declare type ReplaceViewPayload = {
12983
13309
  viewToReplace: Identity_5;
12984
13310
  newView: Partial<ViewOptions>;
12985
13311
  };
12986
- target: Identity_5;
13312
+ target: LayoutIdentity;
12987
13313
  };
12988
13314
 
12989
13315
  /**
@@ -13063,11 +13389,19 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
13063
13389
  * Generated when an application is responding.
13064
13390
  * @interface
13065
13391
  */
13066
- declare type RespondingEvent = IdentityEvent & {
13392
+ declare type RespondingEvent = BaseEvents.IdentityEvent & {
13067
13393
  topic: 'application';
13068
13394
  type: 'responding';
13069
13395
  };
13070
13396
 
13397
+ /**
13398
+ * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
13399
+ * @interface
13400
+ */
13401
+ declare type RestoredEvent = BaseEvent_5 & {
13402
+ type: 'restored';
13403
+ };
13404
+
13071
13405
  declare type ResultBehavior = 'close' | 'hide' | 'none';
13072
13406
 
13073
13407
  /**
@@ -13130,7 +13464,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
13130
13464
  * Generated when Application.run() is called for an already running application.
13131
13465
  * @interface
13132
13466
  */
13133
- declare type RunRequestedEvent_2 = IdentityEvent & {
13467
+ declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
13134
13468
  topic: 'application';
13135
13469
  type: 'run-requested';
13136
13470
  userAppConfigArgs: Record<string, any>;
@@ -13312,7 +13646,7 @@ declare type ServiceIdentifier = {
13312
13646
  * Generated on changes to a user’s local computer session.
13313
13647
  * @interface
13314
13648
  */
13315
- declare type SessionChangedEvent = BaseSystemEvent & {
13649
+ declare type SessionChangedEvent = BaseEvent_8 & {
13316
13650
  type: 'session-changed';
13317
13651
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13318
13652
  };
@@ -13495,11 +13829,62 @@ declare type ShortcutOverride = Hotkey & {
13495
13829
  command: string;
13496
13830
  };
13497
13831
 
13832
+ /**
13833
+ * Generated when the Download Shelf 'Show All' button is clicked.
13834
+ *
13835
+ * @remarks By default, OpenFin does not handle the clicking of the `Show All` button on the download
13836
+ * shelf. Instead, it fires this event, which leaves rendering a download manager to the user. For a simple
13837
+ * implementation, the `chrome://downloads` page can be used (see the example below):
13838
+ *
13839
+ * @example
13840
+ *
13841
+ * ```typescript
13842
+ * const platform = await fin.Platform.getCurrentSync();
13843
+ * // Listen to the propagated event at the Platform level, so that we only need one listener for a click from any window
13844
+ * platform.on('window-show-all-downloads', () => {
13845
+ * // Render the `chrome://downloads` window when a user clicks on the download shelf `Show All` button
13846
+ * platform.createWindow({
13847
+ * name: 'show-download-window',
13848
+ * layout: {
13849
+ * content: [
13850
+ * {
13851
+ * type: 'stack',
13852
+ * content: [
13853
+ * {
13854
+ * type: 'component',
13855
+ * componentName: 'view',
13856
+ * componentState: {
13857
+ * name: 'show-download-view',
13858
+ * url: 'chrome://downloads'
13859
+ * }
13860
+ * }
13861
+ * ]
13862
+ * }
13863
+ * ]
13864
+ * }
13865
+ * });
13866
+ * })
13867
+ * ```
13868
+ *
13869
+ * @interface
13870
+ */
13871
+ declare type ShowAllDownloadsEvent = BaseEvent_5 & {
13872
+ type: 'show-all-downloads';
13873
+ };
13874
+
13498
13875
  /**
13499
13876
  * Generated when a View is shown. This event will fire during creation of a View.
13500
13877
  * @interface
13501
13878
  */
13502
- declare type ShownEvent = BaseViewEvent & {
13879
+ declare type ShownEvent = BaseEvent_4 & {
13880
+ type: 'shown';
13881
+ };
13882
+
13883
+ /**
13884
+ * Generated when a hidden window has been shown.
13885
+ * @interface
13886
+ */
13887
+ declare type ShownEvent_2 = BaseEvent_5 & {
13503
13888
  type: 'shown';
13504
13889
  };
13505
13890
 
@@ -13528,6 +13913,15 @@ declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
13528
13913
  y?: number;
13529
13914
  };
13530
13915
 
13916
+ /**
13917
+ * Generated when a window has been prevented from showing.
13918
+ * @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.
13919
+ * @interface
13920
+ */
13921
+ declare type ShowRequestedEvent = BaseEvent_5 & {
13922
+ type: 'show-requested';
13923
+ };
13924
+
13531
13925
  /**
13532
13926
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
13533
13927
  *
@@ -13574,6 +13968,21 @@ declare type Snapshot = {
13574
13968
  };
13575
13969
  };
13576
13970
 
13971
+ /**
13972
+ * Generated when a platform.ApplySnapshot call is resolved.
13973
+ * @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
13974
+ * 1. The window has been created
13975
+ * 2. The window has a responsive API
13976
+ * 3. If a window has a layout property, the 'layout-ready' event has fired
13977
+ *
13978
+ * _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.
13979
+ * @interface
13980
+ */
13981
+ declare type SnapshotAppliedEvent = BaseEvent & {
13982
+ topic: 'application';
13983
+ type: 'platform-snapshot-applied';
13984
+ };
13985
+
13577
13986
  /**
13578
13987
  * @interface
13579
13988
  */
@@ -13687,42 +14096,11 @@ declare class SnapshotSourceModule extends Base {
13687
14096
  wrap(identity: OpenFin.ApplicationIdentity): Promise<SnapshotSource>;
13688
14097
  }
13689
14098
 
13690
- /**
13691
- * Utility class for managing Golden Layout splitter drag interactions.
13692
- * @ignore
13693
- */
13694
- declare class SplitterController {
13695
- private readonly viewOverlay;
13696
- constructor(viewOverlay: ViewOverlay);
13697
- private teardown?;
13698
- private tryTeardown;
13699
- /**
13700
- * Disables the pointer events on the splitters, preventing them from being dragged.
13701
- */
13702
- preventSplitterResize: () => void;
13703
- /**
13704
- * Ends a splitter drag move, if one is in progress.
13705
- */
13706
- endMove: () => Promise<void>;
13707
- /**
13708
- * Initialises a splitter drag move, rendering a view on top of the splitter
13709
- * to allow it to render on top of the views within a layout (as they will always
13710
- * have a higher z-index to the platform window itself).
13711
- * @param splitterItem The Golden Layout splitter item that is currently being dragged.
13712
- */
13713
- startMove: (splitterItem: SplitterItem) => Promise<void>;
13714
- }
13715
-
13716
- declare type SplitterItem = GoldenLayout.ContentItem & {
13717
- viewEventsAdded: boolean;
13718
- isVertical: boolean;
13719
- };
13720
-
13721
14099
  /**
13722
14100
  * Generated when an application has started.
13723
14101
  * @interface
13724
14102
  */
13725
- declare type StartedEvent = IdentityEvent & {
14103
+ declare type StartedEvent = BaseEvents.IdentityEvent & {
13726
14104
  topic: 'application';
13727
14105
  type: 'started';
13728
14106
  };
@@ -14566,6 +14944,70 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
14566
14944
  * ```
14567
14945
  */
14568
14946
  openUrlWithBrowser(url: string): Promise<void>;
14947
+ /**
14948
+ * Creates a new registry entry under the HKCU root Windows registry key if the given custom protocol name doesn't exist or
14949
+ * overwrites the existing registry entry if the given custom protocol name already exists.
14950
+ *
14951
+ * Note: This method is restricted by default and must be enabled via
14952
+ * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
14953
+ *
14954
+ *
14955
+ * @remarks These protocols are reserved and cannot be registered:
14956
+ * - fin
14957
+ * - fins
14958
+ * - openfin
14959
+ * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
14960
+ *
14961
+ * @throws if a given custom protocol failed to be registered.
14962
+ * @throws if a manifest URL contains the '%1' string.
14963
+ * @throws if a manifest URL contains a query string parameter which name equals to the Protocol Launch Request Parameter Name.
14964
+ * @throws if the full length of the command string that is to be written to the registry exceeds 2048 bytes.
14965
+ *
14966
+ * @example
14967
+ * ```js
14968
+ * fin.System.registerCustomProtocol({protocolName:'protocol1'}).then(console.log).catch(console.error);
14969
+ * ```
14970
+ */
14971
+ registerCustomProtocol(options: OpenFin.CustomProtocolOptions): Promise<void>;
14972
+ /**
14973
+ * Removes the registry entry for a given custom protocol.
14974
+ *
14975
+ * Note: This method is restricted by default and must be enabled via
14976
+ * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
14977
+ *
14978
+ *
14979
+ * @remarks These protocols are reserved and cannot be unregistered:
14980
+ * - fin
14981
+ * - fins
14982
+ * - openfin
14983
+ * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
14984
+ *
14985
+ * @throws if a protocol entry failed to be removed in registry.
14986
+ *
14987
+ * @example
14988
+ * ```js
14989
+ * await fin.System.unregisterCustomProtocol('protocol1');
14990
+ * ```
14991
+ */
14992
+ unregisterCustomProtocol(protocolName: string): Promise<void>;
14993
+ /**
14994
+ * Retrieves the registration state for a given custom protocol.
14995
+ *
14996
+ * Note: This method is restricted by default and must be enabled via
14997
+ * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
14998
+ *
14999
+ * @remarks These protocols are reserved and cannot get states for them:
15000
+ * - fin
15001
+ * - fins
15002
+ * - openfin
15003
+ * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
15004
+ *
15005
+ *
15006
+ * @example
15007
+ * ```js
15008
+ * const protocolState = await fin.System.getCustomProtocolState('protocol1');
15009
+ */
15010
+ getCustomProtocolState(protocolName: string): Promise<OpenFin.CustomProtocolState>;
14569
15011
  /**
14570
15012
  * Removes the process entry for the passed UUID obtained from a prior call
14571
15013
  * of fin.System.launchExternalProcess().
@@ -15194,12 +15636,9 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
15194
15636
  };
15195
15637
 
15196
15638
  /**
15197
- * [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
15198
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
15199
- * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
15200
- * from which they propagate).
15639
+ * @deprecated Renamed to {@link Event}.
15201
15640
  */
15202
- declare type SystemEvent = ExcludeRequested<PropagatedWindowEvent<'system'>> | PropagatedViewEvent<'system'> | PropagatedApplicationEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
15641
+ declare type SystemEvent = Event_11;
15203
15642
 
15204
15643
  declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
15205
15644
 
@@ -15207,7 +15646,7 @@ declare namespace SystemEvents {
15207
15646
  export {
15208
15647
  NotRequested,
15209
15648
  ExcludeRequested,
15210
- BaseSystemEvent,
15649
+ BaseEvent_8 as BaseEvent,
15211
15650
  IdleEvent,
15212
15651
  MonitorEvent,
15213
15652
  SessionChangedEvent,
@@ -15222,17 +15661,19 @@ declare namespace SystemEvents {
15222
15661
  ApplicationCreatedEvent,
15223
15662
  DesktopIconClickedEvent,
15224
15663
  SystemShutdownEvent,
15664
+ Event_11 as Event,
15225
15665
  SystemEvent,
15666
+ EventType_8 as EventType,
15226
15667
  SystemEventType,
15227
- Payload_7 as Payload,
15228
- ByType_6 as ByType
15668
+ Payload_9 as Payload,
15669
+ ByType_8 as ByType
15229
15670
  }
15230
15671
  }
15231
15672
 
15232
15673
  /**
15233
- * Union of possible `type` values for a {@link SystemEvent}.
15674
+ * @deprecated Renamed to {@link EventType}.
15234
15675
  */
15235
- declare type SystemEventType = SystemEvent['type'];
15676
+ declare type SystemEventType = EventType_8;
15236
15677
 
15237
15678
  /**
15238
15679
  * @interface
@@ -15262,6 +15703,18 @@ declare type SystemPermissions = {
15262
15703
  enabled: boolean;
15263
15704
  protocols: string[];
15264
15705
  };
15706
+ registerCustomProtocol: boolean | {
15707
+ enabled: boolean;
15708
+ protocols: string[];
15709
+ };
15710
+ unregisterCustomProtocol: boolean | {
15711
+ enabled: boolean;
15712
+ protocols: string[];
15713
+ };
15714
+ getCustomProtocolState: boolean | {
15715
+ enabled: boolean;
15716
+ protocols: string[];
15717
+ };
15265
15718
  };
15266
15719
 
15267
15720
  /**
@@ -15277,7 +15730,7 @@ declare type SystemProcessInfo = {
15277
15730
  * Generated when system shutdown or log off.
15278
15731
  * @internal
15279
15732
  */
15280
- declare type SystemShutdownEvent = BaseSystemEvent & {
15733
+ declare type SystemShutdownEvent = BaseEvent_8 & {
15281
15734
  type: 'system-shutdown';
15282
15735
  };
15283
15736
 
@@ -15286,7 +15739,7 @@ declare type SystemShutdownHandler = (shutdownEvent: {
15286
15739
  }) => void;
15287
15740
 
15288
15741
  declare interface Tab {
15289
- _dragListener: EventEmitter_2;
15742
+ _dragListener: TabDragListener;
15290
15743
 
15291
15744
  /**
15292
15745
  * True if this tab is the selected tab
@@ -15331,60 +15784,11 @@ declare interface Tab {
15331
15784
  setActive(isActive: boolean): void;
15332
15785
  }
15333
15786
 
15334
- /**
15335
- * Set of apis used to facilitate tab drag interactions without needing to hide views.
15336
- * @ignore
15337
- */
15338
- declare class TabDragController {
15339
- private readonly viewOverlay;
15340
- constructor(viewOverlay: ViewOverlay);
15341
- private dropZonePreview?;
15342
- /**
15343
- *
15344
- * When a tab is dragged out of a stack, it will need to be hidden from the stack.
15345
- *
15346
- * Additionally, if there is a new view to show in the stack, it will be shown at the position specified by
15347
- * containerBounds
15348
- *
15349
- * As drag interactions can under extreme circumstances complete before this chain of promises has completed,
15350
- * we need to pass in a isDragging() function which returns whether the drag is in progress.
15351
- * This allows us to cancel any layout affecting operations.
15352
- *
15353
- * @param draggingView The view which is currently being dragged
15354
- * @param isLastViewInWindow Whether the draggin view is the last view in a window or not. If false, the dragging view will not hide.
15355
- * @param isDragging A function which returns true if the drag is still in progress. As we chain some async calls here, we want to avoid
15356
- * modifying any views if the drag has completed (as the post drag procedure will have taken care of it.)
15357
- * @param containerBounds The bounds of the container of the view to be shown in the stack
15358
- * @param nextView The view which has become active after dragging the draggingView out.
15359
- */
15360
- handleTabStackActiveView: (draggingView: View_3, isLastViewInWindow: boolean, isDragging: () => boolean, containerBounds?: OpenFin.Bounds, nextView?: View_3) => Promise<void>;
15361
- /**
15362
- * Extracts the border and backgroundColor css values from the drop zone preview,
15363
- * and sets the viewOverlay to match them.
15364
- */
15365
- inheritStyles: () => Promise<void>;
15366
- /**
15367
- * Called when a tab drag interaction is started from the current window (not when it enters the window).
15368
- *
15369
- * Sets all views in the platform to ignore mouse events so that they can pass through to the golden-layout
15370
- * document whilst remaining visible.
15371
- */
15372
- startDrag: () => Promise<void>;
15373
- /**
15374
- * Called when a tab drag interaction which was started from the current window ends.
15375
- *
15376
- * Disables the click through setting on every view in the platform.
15377
- */
15378
- endDrag: () => Promise<void>;
15379
- private disposeObserve?;
15380
- disposeOverlayObserver: () => void;
15787
+ declare interface TabDragListener extends EventEmitter_2 {
15381
15788
  /**
15382
- * Observes a golden-layout drop zone preview in order to render a BrowserView
15383
- * overlay whenever a tab is dragged over a droppable region.
15384
- * @param dropZonePreview The drop zone preview element created by Golden Layout in order to highlight
15385
- * droppable regions of the UI.
15789
+ * A reference to the content item this tab relates to
15386
15790
  */
15387
- observeOverlay: (dropZonePreview: HTMLElement) => Promise<void>;
15791
+ contentItem: ContentItem;
15388
15792
  }
15389
15793
 
15390
15794
  /**
@@ -15579,7 +15983,7 @@ declare type TargetApp = string | AppMetadata;
15579
15983
  * In that case, previousTarget identity will be the same as target identity.
15580
15984
  * @interface
15581
15985
  */
15582
- declare type TargetChangedEvent = BaseViewEvent & {
15986
+ declare type TargetChangedEvent = BaseEvent_4 & {
15583
15987
  type: 'target-changed';
15584
15988
  previousTarget: OpenFin.Identity;
15585
15989
  };
@@ -15716,7 +16120,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
15716
16120
  connectSync: () => void;
15717
16121
  getPort: () => string;
15718
16122
  shutdown(): Promise<void>;
15719
- connect(config: InternalConnectConfig | RemoteConfig): Promise<string | void>;
16123
+ connect(config: InternalConnectConfig | RemoteConfig | ReceiverConfig): Promise<string | void>;
15720
16124
  private connectRemote;
15721
16125
  connectByPort(config: ExistingConnectConfig): Promise<void>;
15722
16126
  private authorize;
@@ -15733,7 +16137,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
15733
16137
  * Generated when the tray icon is clicked.
15734
16138
  * @interface
15735
16139
  */
15736
- declare type TrayIconClickedEvent = IdentityEvent & {
16140
+ declare type TrayIconClickedEvent = BaseEvents.IdentityEvent & {
15737
16141
  topic: 'application';
15738
16142
  type: 'tray-icon-clicked';
15739
16143
  button: 0 | 1 | 2;
@@ -15823,7 +16227,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15823
16227
  * A general user bounds change event without event type.
15824
16228
  * @interface
15825
16229
  */
15826
- declare type UserBoundsChangeEvent = BaseWindowEvent & {
16230
+ declare type UserBoundsChangeEvent = BaseEvent_5 & {
15827
16231
  height: number;
15828
16232
  left: number;
15829
16233
  top: number;
@@ -15835,7 +16239,7 @@ declare type UserBoundsChangeEvent = BaseWindowEvent & {
15835
16239
  * Generated when a window's user movement becomes disabled.
15836
16240
  * @interface
15837
16241
  */
15838
- declare type UserMovementDisabledEvent = BaseWindowEvent & {
16242
+ declare type UserMovementDisabledEvent = BaseEvent_5 & {
15839
16243
  type: 'user-movement-disabled';
15840
16244
  };
15841
16245
 
@@ -15843,7 +16247,7 @@ declare type UserMovementDisabledEvent = BaseWindowEvent & {
15843
16247
  * Generated when a window's user movement becomes enabled.
15844
16248
  * @interface
15845
16249
  */
15846
- declare type UserMovementEnabledEvent = BaseWindowEvent & {
16250
+ declare type UserMovementEnabledEvent = BaseEvent_5 & {
15847
16251
  type: 'user-movement-enabled';
15848
16252
  };
15849
16253
 
@@ -16526,23 +16930,31 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
16526
16930
  bindToElement: (element: HTMLElement) => Promise<() => void>;
16527
16931
  }
16528
16932
 
16529
- declare type View_3 = OpenFin.View;
16530
-
16531
- declare type View_4 = OpenFin.View;
16532
-
16533
16933
  /**
16534
16934
  * Generated when a View is attached to a window.
16535
16935
  * @interface
16536
16936
  */
16537
- declare type ViewAttachedEvent = BaseWindowEvent & {
16937
+ declare type ViewAttachedEvent = BaseEvent_5 & {
16538
16938
  type: 'view-attached';
16539
16939
  target: OpenFin.Identity;
16540
16940
  viewIdentity: OpenFin.Identity;
16541
16941
  };
16542
16942
 
16543
- declare interface ViewComponent extends GoldenLayout.ContentItem {
16544
- componentState: OpenFin.ViewState;
16545
- }
16943
+ /**
16944
+ * A rule prescribing content creation in a {@link OpenFin.View}.
16945
+ *
16946
+ * @interface
16947
+ */
16948
+ declare type ViewContentCreationRule = BaseContentCreationRule & {
16949
+ /**
16950
+ * Behavior to use when opening matched content.
16951
+ */
16952
+ behavior: 'view';
16953
+ /**
16954
+ * Options for newly-created view.
16955
+ */
16956
+ options?: Partial<ViewOptions>;
16957
+ };
16546
16958
 
16547
16959
  /**
16548
16960
  * The options object required by {@link View.ViewModule.create View.create}.
@@ -16564,7 +16976,7 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
16564
16976
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
16565
16977
  * @interface
16566
16978
  */
16567
- declare type ViewDetachedEvent = BaseWindowEvent & {
16979
+ declare type ViewDetachedEvent = BaseEvent_5 & {
16568
16980
  type: 'view-detached';
16569
16981
  target: OpenFin.Identity;
16570
16982
  previousTarget: OpenFin.Identity;
@@ -16572,18 +16984,15 @@ declare type ViewDetachedEvent = BaseWindowEvent & {
16572
16984
  };
16573
16985
 
16574
16986
  /**
16575
- * [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
16576
- * discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
16577
- * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
16987
+ * @deprecated Renamed to {@link Event}.
16578
16988
  */
16579
- declare type ViewEvent = (WebContentsEvent<'view'> & {
16580
- target: OpenFin.Identity;
16581
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
16989
+ declare type ViewEvent = Event_4;
16582
16990
 
16583
16991
  declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
16584
16992
 
16585
16993
  declare namespace ViewEvents {
16586
16994
  export {
16995
+ BaseEvent_4 as BaseEvent,
16587
16996
  BaseViewEvent,
16588
16997
  TargetChangedEvent,
16589
16998
  NonPropagatedViewEvent,
@@ -16593,20 +17002,24 @@ declare namespace ViewEvents {
16593
17002
  HotkeyEvent,
16594
17003
  ShownEvent,
16595
17004
  HostContextChangedEvent,
17005
+ Event_4 as Event,
16596
17006
  ViewEvent,
16597
17007
  WillPropagateViewEvent,
17008
+ EventType,
16598
17009
  ViewEventType,
17010
+ PropagatedEvent_2 as PropagatedEvent,
16599
17011
  PropagatedViewEvent,
17012
+ PropagatedEventType_2 as PropagatedEventType,
16600
17013
  PropagatedViewEventType,
16601
- Payload_8 as Payload,
16602
- ByType_7 as ByType
17014
+ Payload_2 as Payload,
17015
+ ByType
16603
17016
  }
16604
17017
  }
16605
17018
 
16606
17019
  /**
16607
- * Union of possible `type` values for a {@link OpenFin.ViewEvents.ViewEvent}.
17020
+ * @deprecated Renamed to {@link EventType}.
16608
17021
  */
16609
- declare type ViewEventType = ViewEvent['type'];
17022
+ declare type ViewEventType = EventType;
16610
17023
 
16611
17024
  /**
16612
17025
  * @interface
@@ -16709,40 +17122,6 @@ declare class ViewModule extends Base {
16709
17122
  */
16710
17123
  declare type ViewOptions = ConstViewOptions & MutableViewOptions;
16711
17124
 
16712
- /**
16713
- * Api client allowing an empty electron BrowserView to be rendered
16714
- * in the current window with the specified bounds.
16715
- *
16716
- * Please note, only one view based overlay can be rendered at a time per runtime.
16717
- * @ignore
16718
- */
16719
- declare class ViewOverlay {
16720
- private wire;
16721
- constructor(wire: Transport);
16722
- /**
16723
- * Sets the style of the root <html> element of the view overlay webcontent.
16724
- * @param style A partial collection of Css style declarations to set.
16725
- */
16726
- setStyle: (style: Partial<CSSStyleDeclaration>) => Promise<void>;
16727
- /**
16728
- * Renders the overlay at the specified position relative to the calling window.
16729
- * @param options Bounds and background color to display in the overlay.
16730
- */
16731
- renderOverlay: (bounds: OpenFin.Bounds) => Promise<void>;
16732
- /**
16733
- * Removes the overlay from the current window.
16734
- */
16735
- detachOverlay: () => Promise<void>;
16736
- /**
16737
- * Allows setting all OpenFin views to ignore or consume mouse events.
16738
- *
16739
- * This can help with the rendering of view overlays that depend on OpenFin views not consuming mouse events.
16740
- *
16741
- * @param enabled If true, all mouse events are ignored by openfin views. If false, all OpenFin views will consume mouse events.
16742
- */
16743
- setIgnoreViewMouseEvents(enabled: boolean): Promise<void>;
16744
- }
16745
-
16746
17125
  /**
16747
17126
  * Represents the payload shape for Views that are trying to prevent an unload.
16748
17127
  * @interface
@@ -17779,12 +18158,9 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17779
18158
  }
17780
18159
 
17781
18160
  /**
17782
- * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
17783
- * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
18161
+ * @deprecated Renamed to {@link Event}.
17784
18162
  */
17785
- declare type WebContentsEvent<Topic extends string> = {
17786
- topic: Topic;
17787
- } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
18163
+ declare type WebContentsEvent<Topic extends string> = Event_5<Topic>;
17788
18164
 
17789
18165
  declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
17790
18166
 
@@ -17796,6 +18172,7 @@ declare namespace WebContentsEvents {
17796
18172
  CrashedEvent_2 as CrashedEvent,
17797
18173
  CertificateErrorEvent,
17798
18174
  CertificateSelectionShownEvent,
18175
+ PageFaviconUpdatedEvent,
17799
18176
  FaviconUpdatedEvent,
17800
18177
  NavigationRejectedEvent,
17801
18178
  UrlChangedEvent,
@@ -17814,6 +18191,7 @@ declare namespace WebContentsEvents {
17814
18191
  FileDownloadStartedEvent,
17815
18192
  FileDownloadProgressEvent,
17816
18193
  FileDownloadCompletedEvent,
18194
+ Event_5 as Event,
17817
18195
  WebContentsEvent,
17818
18196
  WillPropagateWebContentsEvent,
17819
18197
  NonPropagatedWebContentsEvent
@@ -17846,6 +18224,8 @@ declare type WebRequestHeader = {
17846
18224
  [key: string]: string;
17847
18225
  };
17848
18226
 
18227
+ declare type WebSocketReadyState = WebSocket['readyState'];
18228
+
17849
18229
  /**
17850
18230
  * Generated when a window is being moved by the user.
17851
18231
  * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
@@ -17859,7 +18239,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
17859
18239
  * A general will-move or will-resize event without event type.
17860
18240
  * @interface
17861
18241
  */
17862
- declare type WillMoveOrResizeEvent = BaseWindowEvent & {
18242
+ declare type WillMoveOrResizeEvent = BaseEvent_5 & {
17863
18243
  height: number;
17864
18244
  left: number;
17865
18245
  top: number;
@@ -17881,7 +18261,7 @@ declare type WillPropagateViewEvent = ViewEvent;
17881
18261
  *
17882
18262
  * A WebContents event that does propagate to (republish on) parent topics.
17883
18263
  */
17884
- declare type WillPropagateWebContentsEvent = WebContentsEvent<string>;
18264
+ declare type WillPropagateWebContentsEvent = Event_5<string>;
17885
18265
 
17886
18266
  /**
17887
18267
  * @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
@@ -17895,7 +18275,7 @@ declare type WillPropagateWindowEvent = WindowSourcedEvent;
17895
18275
  * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
17896
18276
  * @interface
17897
18277
  */
17898
- declare type WillRedirectEvent = BaseWindowEvent & {
18278
+ declare type WillRedirectEvent = BaseEvent_5 & {
17899
18279
  type: 'will-redirect';
17900
18280
  blocked: boolean;
17901
18281
  isInPlace: boolean;
@@ -18816,7 +19196,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18816
19196
  * ```
18817
19197
  * @experimental
18818
19198
  */
18819
- getLayout(): Promise<OpenFin.Layout>;
19199
+ getLayout(layoutIdentity?: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
18820
19200
  /**
18821
19201
  * Gets the current settings of the window.
18822
19202
  *
@@ -19534,28 +19914,34 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19534
19914
  };
19535
19915
 
19536
19916
  /**
19537
- * Generated when a window has closed.
19538
- * @interface
19917
+ * @deprecated Renamed to {@link ClosedEvent}.
19539
19918
  */
19540
- declare type WindowClosedEvent = BaseWindowEvent & {
19541
- type: 'closed';
19542
- };
19919
+ declare type WindowClosedEvent = ClosedEvent_2;
19543
19920
 
19544
19921
  /**
19545
- * Generated when a window has been prevented from closing.
19546
- * @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.
19547
- * @interface
19922
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
19548
19923
  */
19549
- declare type WindowCloseRequestedEvent = BaseWindowEvent & {
19550
- type: 'close-requested';
19551
- };
19924
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
19925
+
19926
+ /**
19927
+ * @deprecated Renamed to {@link ClosingEvent}.
19928
+ */
19929
+ declare type WindowClosingEvent = ClosingEvent;
19552
19930
 
19553
19931
  /**
19554
- * Generated when a window has initiated the closing routine.
19932
+ * A rule prescribing content creation in a {@link OpenFin.Window}.
19933
+ *
19555
19934
  * @interface
19556
19935
  */
19557
- declare type WindowClosingEvent = BaseWindowEvent & {
19558
- type: 'closing';
19936
+ declare type WindowContentCreationRule = BaseContentCreationRule & {
19937
+ /**
19938
+ * Behavior to use when opening matched content.
19939
+ */
19940
+ behavior: 'window';
19941
+ /**
19942
+ * Options for newly-created window.
19943
+ */
19944
+ options?: Partial<WindowOptions>;
19559
19945
  };
19560
19946
 
19561
19947
  /**
@@ -19624,16 +20010,15 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19624
20010
  };
19625
20011
 
19626
20012
  /**
19627
- * [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
19628
- * discriminated by {@link WindowEvent.type | their type}. Event payloads unique to `Window` can be found
19629
- * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
20013
+ * @deprecated, Renamed to {@link Event}.
19630
20014
  */
19631
- declare type WindowEvent = WindowSourcedEvent | PropagatedViewEvent<'window'>;
20015
+ declare type WindowEvent = Event_6;
19632
20016
 
19633
20017
  declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
19634
20018
 
19635
20019
  declare namespace WindowEvents {
19636
20020
  export {
20021
+ BaseEvent_5 as BaseEvent,
19637
20022
  BaseWindowEvent,
19638
20023
  ViewAttachedEvent,
19639
20024
  ViewDetachedEvent,
@@ -19643,9 +20028,11 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19643
20028
  EndLoadEvent,
19644
20029
  WillRedirectEvent,
19645
20030
  ReloadedEvent,
20031
+ OptionsChangedEvent,
19646
20032
  WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
19647
20033
  ExternalProcessExitedEvent,
19648
20034
  ExternalProcessStartedEvent,
20035
+ HiddenEvent_2 as HiddenEvent,
19649
20036
  WindowHiddenEvent,
19650
20037
  PreloadScriptInfoRunning,
19651
20038
  PreloadScriptInfo,
@@ -19660,61 +20047,66 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19660
20047
  BeginUserBoundsChangingEvent,
19661
20048
  BoundsChangedEvent,
19662
20049
  BoundsChangingEvent,
20050
+ CloseRequestedEvent,
19663
20051
  WindowCloseRequestedEvent,
19664
20052
  ContextChangedEvent,
20053
+ ClosedEvent_2 as ClosedEvent,
19665
20054
  WindowClosedEvent,
20055
+ ClosingEvent,
19666
20056
  WindowClosingEvent,
19667
20057
  DisabledMovementBoundsChangedEvent,
19668
20058
  DisabledMovementBoundsChangingEvent,
19669
20059
  EmbeddedEvent,
19670
20060
  EndUserBoundsChangingEvent,
20061
+ HotkeyEvent_2 as HotkeyEvent,
19671
20062
  WindowHotkeyEvent,
20063
+ InitializedEvent_2 as InitializedEvent,
19672
20064
  WindowInitializedEvent,
19673
20065
  MaximizedEvent,
19674
20066
  MinimizedEvent,
19675
20067
  PreloadScriptsStateChangedEvent,
19676
20068
  PreloadScriptsStateChangingEvent,
20069
+ RestoredEvent,
19677
20070
  WindowRestoredEvent,
20071
+ ShowRequestedEvent,
19678
20072
  WindowShowRequestedEvent,
20073
+ ShownEvent_2 as ShownEvent,
19679
20074
  WindowShownEvent,
19680
20075
  UserMovementEnabledEvent,
19681
20076
  UserMovementDisabledEvent,
19682
20077
  WillMoveEvent,
19683
20078
  WillResizeEvent,
19684
20079
  NonPropagatedWindowEvent,
20080
+ ShowAllDownloadsEvent,
20081
+ DownloadShelfVisibilityChangedEvent,
19685
20082
  WindowSourcedEvent,
19686
20083
  WillPropagateWindowEvent,
20084
+ Event_6 as Event,
19687
20085
  WindowEvent,
20086
+ EventType_2 as EventType,
19688
20087
  WindowEventType,
20088
+ PropagatedEvent_3 as PropagatedEvent,
19689
20089
  PropagatedWindowEvent,
19690
20090
  PropagatedWindowEventType,
19691
- Payload_9 as Payload,
19692
- ByType_8 as ByType
20091
+ Payload_3 as Payload,
20092
+ ByType_2 as ByType
19693
20093
  }
19694
20094
  }
19695
20095
 
19696
20096
  /**
19697
- * Union of possible `type` values for a {@link OpenFin.WindowEvents.WindowEvent}.
20097
+ * @deprecated Renamed to {@link EventType}.
19698
20098
  */
19699
20099
  declare type WindowEventType = WindowEvent['type'];
19700
20100
 
19701
20101
  /**
19702
- * Generated when a window has been hidden.
19703
- * @interface
20102
+ * @deprecated Renamed to {@link HiddenEvent}.
19704
20103
  */
19705
- declare type WindowHiddenEvent = BaseWindowEvent & {
19706
- type: 'hidden';
19707
- reason: 'closing' | 'hide' | 'hide-on-close';
19708
- };
20104
+ declare type WindowHiddenEvent = HiddenEvent_2;
19709
20105
 
19710
20106
  /**
19711
- * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
19712
- * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
19713
- * @interface
20107
+ * @deprecated Renamed to {@link HotkeyEvent}.
19714
20108
  */
19715
- declare type WindowHotkeyEvent = InputEvent_2 & BaseWindowEvent & {
19716
- type: 'hotkey';
19717
- };
20109
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
19718
20110
 
19719
20111
  /**
19720
20112
  * @interface
@@ -19728,12 +20120,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19728
20120
  };
19729
20121
 
19730
20122
  /**
19731
- * Generated when a window is initialized.
19732
- * @interface
20123
+ * @deprecated Renamed to {@link InitializedEvent}.
19733
20124
  */
19734
- declare type WindowInitializedEvent = BaseWindowEvent & {
19735
- type: 'initialized';
19736
- };
20125
+ declare type WindowInitializedEvent = InitializedEvent_2;
19737
20126
 
19738
20127
  /**
19739
20128
  * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
@@ -19852,15 +20241,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19852
20241
  declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
19853
20242
 
19854
20243
  /**
19855
- * Generated after window options are changed using the window.updateOptions method.
19856
- * @remarks Will not fire if the diff object is empty.
19857
- * @interface
20244
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
19858
20245
  */
19859
- declare type WindowOptionsChangedEvent_2 = BaseWindowEvent & {
19860
- type: 'options-changed';
19861
- options: OpenFin.WindowOptions;
19862
- diff: OpenFin.WindowOptionDiff;
19863
- };
20246
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
19864
20247
 
19865
20248
  declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
19866
20249
 
@@ -19873,35 +20256,25 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19873
20256
  };
19874
20257
 
19875
20258
  /**
19876
- * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
19877
- * @interface
20259
+ * @deprecated Renamed to {@link RestoredEvent}.
19878
20260
  */
19879
- declare type WindowRestoredEvent = BaseWindowEvent & {
19880
- type: 'restored';
19881
- };
20261
+ declare type WindowRestoredEvent = RestoredEvent;
19882
20262
 
19883
20263
  /**
19884
- * Generated when a hidden window has been shown.
19885
- * @interface
20264
+ * @deprecated Renamed to {@link ShownEvent}.
19886
20265
  */
19887
- declare type WindowShownEvent = BaseWindowEvent & {
19888
- type: 'shown';
19889
- };
20266
+ declare type WindowShownEvent = ShownEvent_2;
19890
20267
 
19891
20268
  /**
19892
- * Generated when a window has been prevented from showing.
19893
- * @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.
19894
- * @interface
20269
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
19895
20270
  */
19896
- declare type WindowShowRequestedEvent = BaseWindowEvent & {
19897
- type: 'show-requested';
19898
- };
20271
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
19899
20272
 
19900
20273
  /**
19901
20274
  * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19902
20275
  * from {@link OpenFin.ViewEvents}.
19903
20276
  */
19904
- 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;
20277
+ 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;
19905
20278
 
19906
20279
  /**
19907
20280
  * Generated when a child window starts loading.
@@ -19933,7 +20306,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19933
20306
  };
19934
20307
 
19935
20308
  declare type Wire = EventEmitter & {
19936
- connect(address: string, WsConstructor: typeof WebSocket): Promise<any>;
20309
+ connect(messageReciever: MessageReceiver): Promise<any>;
19937
20310
  connectSync(): any;
19938
20311
  send(data: any): Promise<any>;
19939
20312
  shutdown(): Promise<void>;