@openfin/core 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.
package/out/mock.d.ts CHANGED
@@ -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_2.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_2.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_2.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_2.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_2.Identity;
1791
+ };
1792
+
1793
+ /**
1794
+ * Base type for events emitting on the `window` topic
1795
+ * @interface
1796
+ */
1797
+ declare type BaseEvent_5 = BaseEvents.NamedEvent & {
1798
+ topic: 'window';
1799
+ };
1800
+
1801
+ /**
1802
+ * Base type for events emitting on the `externalapplication` topic
1803
+ * @interface
1804
+ */
1805
+ declare type BaseEvent_6 = BaseEvents.BaseEvent & {
1806
+ topic: 'externalapplication';
1807
+ };
1808
+
1809
+ /**
1810
+ * The base frame event.
1811
+ * @interface
1812
+ */
1813
+ declare type BaseEvent_7 = NamedEvent & {
1814
+ entityType: 'iframe';
1815
+ frameName: string;
1816
+ };
1817
+
1818
+ /**
1819
+ * Base type for events emitting on the `system` topic
1820
+ * @interface
1821
+ */
1822
+ declare type BaseEvent_8 = BaseEvents.BaseEvent & {
1823
+ topic: 'system';
1824
+ };
1825
+
1826
+ declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
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_2.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_2.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_2.ClientIdentity | OpenFin_2.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
  */
@@ -3455,6 +3545,39 @@ declare type ConfigWithUuid = BaseConfig & {
3455
3545
  uuid: string;
3456
3546
  };
3457
3547
 
3548
+ /**
3549
+ * Generated when a Channel client is connected.
3550
+ * @interface
3551
+ */
3552
+ declare type ConnectedEvent = BaseEvent_2 & {
3553
+ type: 'connected';
3554
+ };
3555
+
3556
+ /**
3557
+ * Generated when an application has authenticated and is connected.
3558
+ * @interface
3559
+ */
3560
+ declare type ConnectedEvent_2 = BaseEvents.IdentityEvent & {
3561
+ topic: 'application';
3562
+ type: 'connected';
3563
+ };
3564
+
3565
+ /**
3566
+ * Generated when an external application has authenticated and is connected.
3567
+ * @interface
3568
+ */
3569
+ declare type ConnectedEvent_3 = BaseExternalApplicationEvent & {
3570
+ type: 'connected';
3571
+ };
3572
+
3573
+ /**
3574
+ * Generated when a frame is connected.
3575
+ * @interface
3576
+ */
3577
+ declare type ConnectedEvent_4 = BaseFrameEvent & {
3578
+ type: 'connected';
3579
+ };
3580
+
3458
3581
  declare type Constructor<T = {}> = new () => T;
3459
3582
 
3460
3583
  declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
@@ -3534,12 +3657,23 @@ declare type ConstViewOptions = {
3534
3657
  /**
3535
3658
  * **Platforms Only.**
3536
3659
  * Determines what happens when a view is closed in a platform window.
3537
- * Supersedes `detachOnClose`, but has no default value.
3660
+ * Supersedes the deprecated `detachOnClose`.
3661
+ * If not set, detaults to `destroy` if `detachOnClose` is false (default), or `detach` if `detachOnClose` is true.
3662
+ * While this option is not updateable, it may change at runtime if `detachOnClose` is updated.
3538
3663
  * 'hide' hides the view on the platform window that closed it.
3539
- * 'detach' behaves like 'detachOnClose': true.
3540
- * 'destroy' is the default behavior as long as 'detachOnClose' is not set.
3664
+ * 'detach' behaves like 'detachOnClose': true. It attaches the closed view to the platform provider.
3665
+ * 'destroy' is the default behavior as long as 'detachOnClose' is not set. It destroys the view.
3541
3666
  */
3542
- closeBehavior?: 'hide' | 'detach' | 'destroy';
3667
+ closeBehavior: 'hide' | 'detach' | 'destroy';
3668
+ /**
3669
+ * Controls interaction of the view with its parent window's download shelf.
3670
+ */
3671
+ downloadShelf?: {
3672
+ /**
3673
+ * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
3674
+ */
3675
+ enabled: boolean;
3676
+ };
3543
3677
  };
3544
3678
 
3545
3679
  /**
@@ -3651,8 +3785,16 @@ declare type ConstWindowOptions = {
3651
3785
  * launches in favor of the cached value.
3652
3786
  */
3653
3787
  defaultWidth: number;
3788
+ downloadShelf: DownloadShelfOptions;
3654
3789
  height: number;
3655
3790
  layout: any;
3791
+ /**
3792
+ * @experimental
3793
+ *
3794
+ * The collection of layouts to load when the window is created. When launching multiple layouts, manage
3795
+ * the lifecycle via fin.Platform.Layout.create()/destroy() methods.
3796
+ */
3797
+ layoutSnapshot: LayoutSnapshot;
3656
3798
  /**
3657
3799
  * Parent identity of a modal window. It will create a modal child window when this option is set.
3658
3800
  */
@@ -3868,28 +4010,15 @@ declare type ContentCreationOptions = {
3868
4010
  * A rule for creating content in OpenFin; maps a content type to the way in which
3869
4011
  * newly-opened content of that type will be handled.
3870
4012
  *
4013
+ * @remarks This is effectively just a union type discriminated by the `behavior` key. The generic
4014
+ * parameter is a legacy feature that is included for backwards-compatibility reasons.
3871
4015
  *
3872
- * @interface
4016
+ * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
4017
+ * the specified `behavior` key.
3873
4018
  */
3874
- declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
3875
- /**
3876
- * Behavior to use when opening matched content. The value could be 'view' | 'window' | 'browser' | 'block'.
3877
- */
3878
- behavior: T;
3879
- /**
3880
- * List of [match patterns](https://developer.chrome.com/extensions/match_patterns) that indicate the specified
3881
- * behavior should be used
3882
- */
3883
- match: MatchPattern[];
3884
- /**
3885
- * Options for newly-created view or window (if applicable).
3886
- */
3887
- options?: T extends 'window' ? Partial<WindowOptions> : T extends 'view' ? Partial<ViewOptions> : never;
3888
- /**
3889
- * custom property
3890
- */
3891
- data?: unknown;
3892
- };
4019
+ declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
4020
+ behavior: Behavior;
4021
+ }>;
3893
4022
 
3894
4023
  /**
3895
4024
  * @interface
@@ -4190,7 +4319,7 @@ declare type Context_3 = {
4190
4319
  * Generated when a window's context is updated via {@link Platform#setWindowContext Platform.setWindowContext}. Only available on windows in a Platform.
4191
4320
  * @interface
4192
4321
  */
4193
- declare type ContextChangedEvent = BaseWindowEvent & {
4322
+ declare type ContextChangedEvent = BaseEvent_5 & {
4194
4323
  type: 'context-changed';
4195
4324
  context: any;
4196
4325
  };
@@ -4342,7 +4471,7 @@ declare type CpuInfo = {
4342
4471
  * Generated when an application has crashed.
4343
4472
  * @interface
4344
4473
  */
4345
- declare type CrashedEvent = IdentityEvent & {
4474
+ declare type CrashedEvent = BaseEvents.IdentityEvent & {
4346
4475
  topic: 'application';
4347
4476
  type: 'crashed';
4348
4477
  reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
@@ -4393,20 +4522,17 @@ declare type CrashReporterState = CrashReporterOptions & {
4393
4522
  * Generated when a View is created.
4394
4523
  * @interface
4395
4524
  */
4396
- declare type CreatedEvent = BaseViewEvent & {
4525
+ declare type CreatedEvent = BaseEvent_4 & {
4397
4526
  type: 'created';
4398
4527
  };
4399
4528
 
4400
4529
  /**
4401
- * @interface
4530
+ * @interface @experimental
4402
4531
  */
4403
4532
  declare type CreateLayoutOptions = {
4404
- /**
4405
- * @experimental
4406
- *
4407
- * @returns
4408
- */
4409
- layoutManagerOverride: () => any;
4533
+ container: HTMLElement;
4534
+ layoutName: string;
4535
+ layout: LayoutOptions;
4410
4536
  };
4411
4537
 
4412
4538
  /**
@@ -4427,7 +4553,7 @@ declare type CreateViewPayload = {
4427
4553
  /**
4428
4554
  * @interface
4429
4555
  */
4430
- declare type CreateViewTarget = Identity_5 & {
4556
+ declare type CreateViewTarget = LayoutIdentity & {
4431
4557
  /**
4432
4558
  * If specified, view creation will not attach to a window and caller must
4433
4559
  * insert the view into the layout explicitly
@@ -4438,6 +4564,44 @@ declare type CreateViewTarget = Identity_5 & {
4438
4564
  };
4439
4565
  };
4440
4566
 
4567
+ /**
4568
+ * The registry entry for a given protocol exists but can't be parsed.
4569
+ * @interface
4570
+ */
4571
+ declare type CustomProtocolMalformedState = {
4572
+ state: 'Malformed';
4573
+ };
4574
+
4575
+ /**
4576
+ * The registry entry is missing for a given custom protocol.
4577
+ * @interface
4578
+ */
4579
+ declare type CustomProtocolMissingState = {
4580
+ state: 'Missing';
4581
+ };
4582
+
4583
+ /**
4584
+ * Define possible options for Custom protocol.
4585
+ * @interface
4586
+ */
4587
+ declare type CustomProtocolOptions = {
4588
+ protocolName: string;
4589
+ };
4590
+
4591
+ /**
4592
+ * The registry rentry for a given protocol exists and can be parsed successfully.
4593
+ * @interface
4594
+ */
4595
+ declare type CustomProtocolRegisteredState = {
4596
+ state: 'Registered';
4597
+ handlerManifestUrl: string;
4598
+ };
4599
+
4600
+ /**
4601
+ * Define possible registration states for a given custom protocol.
4602
+ */
4603
+ declare type CustomProtocolState = CustomProtocolMissingState | CustomProtocolMalformedState | CustomProtocolRegisteredState;
4604
+
4441
4605
  /**
4442
4606
  * Custom headers for requests sent by the window.
4443
4607
  *
@@ -4455,6 +4619,8 @@ declare type CustomRequestHeaders = {
4455
4619
  headers: WebRequestHeader[];
4456
4620
  };
4457
4621
 
4622
+ declare type DataChannelReadyState = RTCDataChannel['readyState'];
4623
+
4458
4624
  /**
4459
4625
  * @interface
4460
4626
  */
@@ -4515,7 +4681,7 @@ declare interface DesktopAgent_2 {
4515
4681
  * Generated when the desktop icon is clicked while it's already running.
4516
4682
  * @interface
4517
4683
  */
4518
- declare type DesktopIconClickedEvent = BaseSystemEvent & {
4684
+ declare type DesktopIconClickedEvent = BaseEvent_8 & {
4519
4685
  type: 'desktop-icon-clicked';
4520
4686
  };
4521
4687
 
@@ -4523,17 +4689,10 @@ declare type DesktopIconClickedEvent = BaseSystemEvent & {
4523
4689
  * Generated when a View is destroyed.
4524
4690
  * @interface
4525
4691
  */
4526
- declare type DestroyedEvent = BaseViewEvent & {
4692
+ declare type DestroyedEvent = BaseEvent_4 & {
4527
4693
  type: 'destroyed';
4528
4694
  };
4529
4695
 
4530
- /**
4531
- * @interface
4532
- */
4533
- declare type DestroyLayoutOptions = {
4534
- layoutName: string;
4535
- };
4536
-
4537
4696
  /**
4538
4697
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
4539
4698
  * @interface
@@ -4630,6 +4789,30 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
4630
4789
  type: 'disabled-movement-bounds-changing';
4631
4790
  };
4632
4791
 
4792
+ /**
4793
+ * Generated when a Channel client has disconnected.
4794
+ * @interface
4795
+ */
4796
+ declare type DisconnectedEvent = BaseEvent_2 & {
4797
+ type: 'disconnected';
4798
+ };
4799
+
4800
+ /**
4801
+ * Generated when an external application has disconnected.
4802
+ * @interface
4803
+ */
4804
+ declare type DisconnectedEvent_2 = BaseExternalApplicationEvent & {
4805
+ type: 'disconnected';
4806
+ };
4807
+
4808
+ /**
4809
+ * Generated when a frame has disconnected.
4810
+ * @interface
4811
+ */
4812
+ declare type DisconnectedEvent_3 = BaseFrameEvent & {
4813
+ type: 'disconnected';
4814
+ };
4815
+
4633
4816
  /**
4634
4817
  * A system channel will be global enough to have a presence across many apps. This gives us some hints
4635
4818
  * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
@@ -4730,6 +4913,47 @@ declare type DownloadRule = {
4730
4913
  match: string[];
4731
4914
  };
4732
4915
 
4916
+ /**
4917
+ * @interface
4918
+ *
4919
+ * Controls the styling and behavior of the window download shelf.
4920
+ */
4921
+ declare type DownloadShelfOptions = {
4922
+ /**
4923
+ * Whether downloads in this window trigger opening the download shelf.
4924
+ */
4925
+ enabled: boolean;
4926
+ /**
4927
+ * Styling options for the download shelf border.
4928
+ */
4929
+ border?: {
4930
+ /**
4931
+ * Thickness of the border in pixels. Default 1 pixel. Used only for frameless windows.
4932
+ *
4933
+ * @remarks The top border is fixed to 1 pixel regardless of this setting.
4934
+ */
4935
+ size?: number;
4936
+ /**
4937
+ * Color of the border, either a string name or a hex code. Defaults to chromium theme
4938
+ * if absent.
4939
+ */
4940
+ color?: string;
4941
+ };
4942
+ };
4943
+
4944
+ /**
4945
+ * Generated when the visibility of the window's download shelf changes.
4946
+ *
4947
+ * @interface
4948
+ */
4949
+ declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
4950
+ type: 'download-shelf-visibility-changed';
4951
+ /**
4952
+ * True if the download shelf was just opened; false if it was just closed.
4953
+ */
4954
+ visible: boolean;
4955
+ };
4956
+
4733
4957
  /**
4734
4958
  * DPI (dots per inch) configuration for printing.
4735
4959
  *
@@ -4752,7 +4976,7 @@ declare interface DragSource {}
4752
4976
  * Generated when a window has been embedded.
4753
4977
  * @interface
4754
4978
  */
4755
- declare type EmbeddedEvent = BaseWindowEvent & {
4979
+ declare type EmbeddedEvent = BaseEvent_5 & {
4756
4980
  type: 'embedded';
4757
4981
  };
4758
4982
 
@@ -4856,7 +5080,7 @@ declare class EmitterMap {
4856
5080
  * Generated when a window ends loading.
4857
5081
  * @interface
4858
5082
  */
4859
- declare type EndLoadEvent = BaseWindowEvent & {
5083
+ declare type EndLoadEvent = BaseEvent_5 & {
4860
5084
  type: 'end-load';
4861
5085
  documentName: string;
4862
5086
  isMain: boolean;
@@ -4934,9 +5158,11 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
4934
5158
  } : never;
4935
5159
 
4936
5160
  declare interface Environment {
4937
- initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, ...args: Parameters<OpenFin_2.Fin['Platform']['Layout']['init']>): ReturnType<OpenFin_2.Fin['Platform']['Layout']['init']>;
5161
+ initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
5162
+ createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
5163
+ destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
4938
5164
  initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.Fin['Platform']['init']>;
4939
- observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): (() => void);
5165
+ observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
4940
5166
  writeToken(path: string, token: string): Promise<string>;
4941
5167
  retrievePort(config: NewConnectConfig): Promise<number>;
4942
5168
  getNextMessageId(): any;
@@ -4962,14 +5188,96 @@ declare type ErrorMiddleware = OpenFin_2.ErrorMiddleware;
4962
5188
  declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity) => unknown;
4963
5189
 
4964
5190
  /**
4965
- * This function converts JS errors into plain objects
5191
+ * This function converts JS errors into plain objects
5192
+ */
5193
+ declare type ErrorPlainObject = {
5194
+ stack?: string;
5195
+ message: string;
5196
+ name?: string;
5197
+ toString(): string;
5198
+ };
5199
+
5200
+ /**
5201
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}. Events are
5202
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5203
+ * under the {@link OpenFin.PlatformEvents} namespace.
5204
+ */
5205
+ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5206
+
5207
+ /**
5208
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}. Events are
5209
+ * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5210
+ * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5211
+ * from which they propagate).
5212
+ */
5213
+ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ViewEvents.PropagatedEvent<'system'> | ApplicationEvents.PropagatedEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
5214
+
5215
+ /**
5216
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
5217
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5218
+ * under the {@link OpenFin.ChannelEvents} namespace.
5219
+ */
5220
+ declare type Event_2 = {
5221
+ topic: 'channel';
5222
+ } & (ConnectedEvent | DisconnectedEvent);
5223
+
5224
+ /**
5225
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}. Events are
5226
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5227
+ * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5228
+ * from which they propagate).
5229
+ */
5230
+ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.PropagatedEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
5231
+
5232
+ /**
5233
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}. Events are
5234
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5235
+ * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5236
+ */
5237
+ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
5238
+ target: OpenFin_2.Identity;
5239
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
5240
+
5241
+ /**
5242
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
5243
+ * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
5244
+ */
5245
+ declare type Event_5<Topic extends string> = {
5246
+ topic: Topic;
5247
+ } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
5248
+
5249
+ /**
5250
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
5251
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5252
+ * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5253
+ */
5254
+ declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5255
+
5256
+ /**
5257
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}. Events are
5258
+ * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5259
+ * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5260
+ */
5261
+ declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5262
+
5263
+ /**
5264
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}. Events are
5265
+ * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5266
+ * under the {@link OpenFin.FrameEvents} namespace.
5267
+ */
5268
+ declare type Event_8 = {
5269
+ topic: 'frame';
5270
+ } & (ConnectedEvent_4 | DisconnectedEvent_3);
5271
+
5272
+ /**
5273
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}. Events are
5274
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5275
+ * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
4966
5276
  */
4967
- declare type ErrorPlainObject = {
4968
- stack?: string;
4969
- message: string;
4970
- name?: string;
4971
- toString(): string;
4972
- };
5277
+ declare type Event_9 = {
5278
+ topic: 'global-hotkey';
5279
+ hotkey: 'string';
5280
+ } & (RegisteredEvent | UnregisteredEvent);
4973
5281
 
4974
5282
  declare class EventAggregator extends EmitterMap {
4975
5283
  dispatchEvent: (message: Message<any>) => boolean;
@@ -5036,6 +5344,46 @@ declare namespace Events {
5036
5344
  }
5037
5345
  }
5038
5346
 
5347
+ /**
5348
+ * Union of possible `type` values for a view {@link Event}.
5349
+ */
5350
+ declare type EventType = Event_4['type'];
5351
+
5352
+ /**
5353
+ * Union of possible `type` values for a Window {@link Event}.
5354
+ */
5355
+ declare type EventType_2 = Event_6['type'];
5356
+
5357
+ /**
5358
+ * Union of possible `type` values for an Application {@link Event}.
5359
+ */
5360
+ declare type EventType_3 = Event_3['type'];
5361
+
5362
+ /**
5363
+ * Union of possible `type` values for an ExternalApplication {@link Event}.
5364
+ */
5365
+ declare type EventType_4 = Event_7['type'];
5366
+
5367
+ /**
5368
+ * Union of possible `type` values for a {@link FrameEvent}.
5369
+ */
5370
+ declare type EventType_5 = Event_8['type'];
5371
+
5372
+ /**
5373
+ * Union of possible `type` values for a {@link GlobalHotkeyEvent}
5374
+ */
5375
+ declare type EventType_6 = Event_9['type'];
5376
+
5377
+ /**
5378
+ * Union of possible `type` values for a {@link PlatformEvent}.
5379
+ */
5380
+ declare type EventType_7 = Event_10['type'];
5381
+
5382
+ /**
5383
+ * Union of possible `type` values for a {@link SystemEvent}.
5384
+ */
5385
+ declare type EventType_8 = SystemEvent['type'];
5386
+
5039
5387
  /**
5040
5388
  * @internal
5041
5389
  */
@@ -5049,6 +5397,8 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
5049
5397
 
5050
5398
  /**
5051
5399
  * @internal
5400
+ *
5401
+ * Ensures that an event payload type does not include any `-requested` events. Distributes over unions.
5052
5402
  */
5053
5403
  declare type ExcludeRequested<Event extends {
5054
5404
  type: string;
@@ -5178,46 +5528,43 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
5178
5528
  }
5179
5529
 
5180
5530
  /**
5181
- * Generated when an external application has authenticated and is connected.
5182
- * @interface
5531
+ * @deprecated Renamed to {@link ConnectedEvent}.
5183
5532
  */
5184
- declare type ExternalApplicationConnectedEvent = BaseExternalApplicationEvent & {
5185
- type: 'connected';
5186
- };
5533
+ declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
5187
5534
 
5188
5535
  /**
5189
- * Generated when an external application has disconnected.
5190
- * @interface
5536
+ * @deprecated Renamed to {@link DisconnectedEvent}.
5191
5537
  */
5192
- declare type ExternalApplicationDisconnectedEvent = BaseExternalApplicationEvent & {
5193
- type: 'disconnected';
5194
- };
5538
+ declare type ExternalApplicationDisconnectedEvent = DisconnectedEvent_2;
5195
5539
 
5196
5540
  /**
5197
- * [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
5198
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5199
- * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5541
+ * @deprecated Renamed to {@link Event}.
5200
5542
  */
5201
- declare type ExternalApplicationEvent = ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent;
5543
+ declare type ExternalApplicationEvent = Event_7;
5202
5544
 
5203
5545
  declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
5204
5546
 
5205
5547
  declare namespace ExternalApplicationEvents {
5206
5548
  export {
5549
+ BaseEvent_6 as BaseEvent,
5207
5550
  BaseExternalApplicationEvent,
5551
+ ConnectedEvent_3 as ConnectedEvent,
5208
5552
  ExternalApplicationConnectedEvent,
5553
+ DisconnectedEvent_2 as DisconnectedEvent,
5209
5554
  ExternalApplicationDisconnectedEvent,
5555
+ Event_7 as Event,
5210
5556
  ExternalApplicationEvent,
5557
+ EventType_4 as EventType,
5211
5558
  ExternalApplicationEventType,
5212
- Payload_3 as Payload,
5213
- ByType_2 as ByType
5559
+ Payload_5 as Payload,
5560
+ ByType_4 as ByType
5214
5561
  }
5215
5562
  }
5216
5563
 
5217
5564
  /**
5218
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
5565
+ * @deprecated Renamed to {@link Event}.
5219
5566
  */
5220
- declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
5567
+ declare type ExternalApplicationEventType = EventType_4;
5221
5568
 
5222
5569
  /**
5223
5570
  * @interface
@@ -5278,7 +5625,7 @@ declare type ExternalConnection = {
5278
5625
  * Generated when an external process has exited.
5279
5626
  * @interface
5280
5627
  */
5281
- declare type ExternalProcessExitedEvent = BaseWindowEvent & {
5628
+ declare type ExternalProcessExitedEvent = BaseEvent_5 & {
5282
5629
  type: 'external-process-exited';
5283
5630
  processUuid: string;
5284
5631
  exitCode: number;
@@ -5323,19 +5670,15 @@ declare type ExternalProcessRequestType = {
5323
5670
  * Generated when an external process has started.
5324
5671
  * @interface
5325
5672
  */
5326
- declare type ExternalProcessStartedEvent = BaseWindowEvent & {
5673
+ declare type ExternalProcessStartedEvent = BaseEvent_5 & {
5327
5674
  type: 'external-process-started';
5328
5675
  processUuid: string;
5329
5676
  };
5330
5677
 
5331
5678
  /**
5332
- * Generated when page receives favicon urls.
5333
- * @interface
5679
+ * @deprecated, use {@link PageFaviconUpdatedEvent}.
5334
5680
  */
5335
- declare type FaviconUpdatedEvent = NamedEvent & {
5336
- type: 'page-favicon-updated';
5337
- favicons: string[];
5338
- };
5681
+ declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
5339
5682
 
5340
5683
  declare namespace FDC3 {
5341
5684
  export {
@@ -5541,6 +5884,8 @@ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata_3> = {
5541
5884
  metadata?: MetadataType;
5542
5885
  };
5543
5886
 
5887
+ declare type FlexReadyState = WebSocketReadyState | DataChannelReadyState;
5888
+
5544
5889
  /**
5545
5890
  * Generated when a WebContents gains focus.
5546
5891
  * @interface
@@ -5692,48 +6037,43 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5692
6037
  }
5693
6038
 
5694
6039
  /**
5695
- * Generated when a frame is connected.
5696
- * @interface
6040
+ * @deprecated Renamed to {@link ConnectedEvent}.
5697
6041
  */
5698
- declare type FrameConnectedEvent = BaseFrameEvent & {
5699
- type: 'connected';
5700
- };
6042
+ declare type FrameConnectedEvent = ConnectedEvent_4;
5701
6043
 
5702
6044
  /**
5703
- * Generated when a frame has disconnected.
5704
- * @interface
6045
+ * @deprecated Renamed to {@link DisconnectedEvent}.
5705
6046
  */
5706
- declare type FrameDisconnectedEvent = BaseFrameEvent & {
5707
- type: 'disconnected';
5708
- };
6047
+ declare type FrameDisconnectedEvent = DisconnectedEvent_3;
5709
6048
 
5710
6049
  /**
5711
- * [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
5712
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5713
- * under the {@link OpenFin.FrameEvents} namespace.
6050
+ * @deprecated Renamed to {@link Event}.
5714
6051
  */
5715
- declare type FrameEvent = {
5716
- topic: 'frame';
5717
- } & (FrameConnectedEvent | FrameDisconnectedEvent);
6052
+ declare type FrameEvent = Event_8;
5718
6053
 
5719
6054
  declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
5720
6055
 
5721
6056
  declare namespace FrameEvents {
5722
6057
  export {
6058
+ BaseEvent_7 as BaseEvent,
5723
6059
  BaseFrameEvent,
6060
+ ConnectedEvent_4 as ConnectedEvent,
5724
6061
  FrameConnectedEvent,
6062
+ DisconnectedEvent_3 as DisconnectedEvent,
5725
6063
  FrameDisconnectedEvent,
6064
+ Event_8 as Event,
5726
6065
  FrameEvent,
6066
+ EventType_5 as EventType,
5727
6067
  FrameEventType,
5728
- Payload_4 as Payload,
5729
- ByType_3 as ByType
6068
+ Payload_6 as Payload,
6069
+ ByType_5 as ByType
5730
6070
  }
5731
6071
  }
5732
6072
 
5733
6073
  /**
5734
- * Union of possible `type` values for a {@link FrameEvent}.
6074
+ * @deprecated Renamed to {@link EventType}.
5735
6075
  */
5736
- declare type FrameEventType = FrameEvent['type'];
6076
+ declare type FrameEventType = EventType_5;
5737
6077
 
5738
6078
  /**
5739
6079
  * @interface
@@ -5861,6 +6201,8 @@ declare class GlobalHotkey extends EmitterBase<OpenFin_2.GlobalHotkeyEvent> {
5861
6201
  * Registers a global hotkey with the operating system.
5862
6202
  * @param hotkey a hotkey string
5863
6203
  * @param listener called when the registered hotkey is pressed by the user.
6204
+ * @throws If the `hotkey` is reserved, see list below.
6205
+ * @throws if the `hotkey` is already registered by another application.
5864
6206
  *
5865
6207
  * @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.
5866
6208
  * 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.
@@ -5933,7 +6275,7 @@ declare class GlobalHotkey extends EmitterBase<OpenFin_2.GlobalHotkeyEvent> {
5933
6275
  */
5934
6276
  unregisterAll(): Promise<void>;
5935
6277
  /**
5936
- * Checks if a given hotkey has been registered
6278
+ * Checks if a given hotkey has been registered by an application within the current runtime.
5937
6279
  * @param hotkey a hotkey string
5938
6280
  *
5939
6281
  * @example
@@ -5953,14 +6295,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin_2.GlobalHotkeyEvent> {
5953
6295
  }
5954
6296
 
5955
6297
  /**
5956
- * [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
5957
- * discriminated by {@link GlobalHotkeyEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5958
- * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
6298
+ * @deprecated Renamed to {@link Event}.
5959
6299
  */
5960
- declare type GlobalHotkeyEvent = {
5961
- topic: 'global-hotkey';
5962
- hotkey: 'string';
5963
- } & (RegisteredEvent | UnregisteredEvent);
6300
+ declare type GlobalHotkeyEvent = Event_9;
5964
6301
 
5965
6302
  declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
5966
6303
 
@@ -5968,17 +6305,19 @@ declare namespace GlobalHotkeyEvents {
5968
6305
  export {
5969
6306
  RegisteredEvent,
5970
6307
  UnregisteredEvent,
6308
+ Event_9 as Event,
5971
6309
  GlobalHotkeyEvent,
6310
+ EventType_6 as EventType,
5972
6311
  GlobalHotkeyEventType,
5973
- Payload_5 as Payload,
5974
- ByType_4 as ByType
6312
+ Payload_7 as Payload,
6313
+ ByType_6 as ByType
5975
6314
  }
5976
6315
  }
5977
6316
 
5978
6317
  /**
5979
- * Union of possible `type` values for a {@link GlobalHotkeyEvent}
6318
+ * @deprecated Renamed to {@link EventType}.
5980
6319
  */
5981
- declare type GlobalHotkeyEventType = GlobalHotkeyEvent['type'];
6320
+ declare type GlobalHotkeyEventType = EventType_6;
5982
6321
 
5983
6322
  declare namespace GoldenLayout {
5984
6323
  export {
@@ -5997,6 +6336,7 @@ declare namespace GoldenLayout {
5997
6336
  DragSource,
5998
6337
  BrowserWindow,
5999
6338
  Header,
6339
+ TabDragListener,
6000
6340
  Tab,
6001
6341
  EventEmitter_2 as EventEmitter
6002
6342
  }
@@ -6111,10 +6451,7 @@ declare class GoldenLayout_2 implements EventEmitter_2 {
6111
6451
  * @param itemConfiguration An item configuration (can be an entire tree of items)
6112
6452
  * @param parent A parent item
6113
6453
  */
6114
- createContentItem(
6115
- itemConfiguration?: ItemConfigType,
6116
- parent?: ContentItem
6117
- ): ContentItem;
6454
+ createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6118
6455
 
6119
6456
  /**
6120
6457
  * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
@@ -6147,10 +6484,7 @@ declare class GoldenLayout_2 implements EventEmitter_2 {
6147
6484
  * @return the dragSource that was created. This can be used to remove the
6148
6485
  * dragSource from the layout later.
6149
6486
  */
6150
- createDragSource(
6151
- element: HTMLElement | JQuery,
6152
- itemConfiguration: ItemConfigType
6153
- ): DragSource;
6487
+ createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6154
6488
 
6155
6489
  /**
6156
6490
  * Removes a dragSource from the layout.
@@ -6285,8 +6619,17 @@ declare interface Header {
6285
6619
  * Generated when a View is hidden.
6286
6620
  * @interface
6287
6621
  */
6288
- declare type HiddenEvent = BaseViewEvent & {
6622
+ declare type HiddenEvent = BaseEvent_4 & {
6623
+ type: 'hidden';
6624
+ };
6625
+
6626
+ /**
6627
+ * Generated when a window has been hidden.
6628
+ * @interface
6629
+ */
6630
+ declare type HiddenEvent_2 = BaseEvent_5 & {
6289
6631
  type: 'hidden';
6632
+ reason: 'closing' | 'hide' | 'hide-on-close';
6290
6633
  };
6291
6634
 
6292
6635
  /**
@@ -6294,7 +6637,7 @@ declare type HiddenEvent = BaseViewEvent & {
6294
6637
  * or because the View has moved to a new window. Only available on Views in a Platform.
6295
6638
  * @interface
6296
6639
  */
6297
- declare type HostContextChangedEvent = BaseViewEvent & {
6640
+ declare type HostContextChangedEvent = BaseEvent_4 & {
6298
6641
  type: 'host-context-changed';
6299
6642
  context: any;
6300
6643
  reason: 'reparented' | 'updated';
@@ -6373,7 +6716,16 @@ declare type Hotkey = {
6373
6716
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
6374
6717
  * @interface
6375
6718
  */
6376
- declare type HotkeyEvent = BaseViewEvent & {
6719
+ declare type HotkeyEvent = BaseEvent_4 & {
6720
+ type: 'hotkey';
6721
+ };
6722
+
6723
+ /**
6724
+ * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
6725
+ * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
6726
+ * @interface
6727
+ */
6728
+ declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
6377
6729
  type: 'hotkey';
6378
6730
  };
6379
6731
 
@@ -6436,7 +6788,7 @@ declare type IdEventType = WithId<AppVersionEventType>;
6436
6788
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6437
6789
  * @interface
6438
6790
  */
6439
- declare type IdleEvent = BaseSystemEvent & {
6791
+ declare type IdleEvent = BaseEvent_8 & {
6440
6792
  type: 'idle-state-changed';
6441
6793
  elapsedTime: number;
6442
6794
  isIdle: boolean;
@@ -6521,24 +6873,43 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6521
6873
  * Generated when an application has initialized.
6522
6874
  * @interface
6523
6875
  */
6524
- declare type InitializedEvent = IdentityEvent & {
6876
+ declare type InitializedEvent = BaseEvents.IdentityEvent & {
6525
6877
  topic: 'application';
6526
6878
  type: 'initialized';
6527
6879
  };
6528
6880
 
6529
- declare type InitLayoutOptions = OpenFin_2.InitLayoutOptions;
6530
-
6531
- declare type InitLayoutOptions_2 = OpenFin_2.InitLayoutOptions;
6881
+ /**
6882
+ * Generated when a window is initialized.
6883
+ * @interface
6884
+ */
6885
+ declare type InitializedEvent_2 = BaseEvent_5 & {
6886
+ type: 'initialized';
6887
+ };
6532
6888
 
6533
6889
  /**
6534
6890
  * @interface
6535
6891
  */
6536
- declare type InitLayoutOptions_3 = {
6892
+ declare type InitLayoutOptions = {
6537
6893
  /**
6894
+ * @deprecated use container HTMLElement instead
6895
+ *
6538
6896
  * The id attribute of the container where the window's Layout should be initialized. If not provided
6539
6897
  * then an element with id `layout-container` is used. We recommend using a div element.
6540
6898
  */
6541
6899
  containerId?: string;
6900
+ /**
6901
+ * The HTMLElement where the window's Layout should be initialized. We recommend using a div element.
6902
+ */
6903
+ container?: HTMLElement;
6904
+ /**
6905
+ * An override callback used to instantiate a custom LayoutManager. When present, will enable
6906
+ * Multiple Layouts. The callback should return a class.
6907
+ *
6908
+ * @remarks
6909
+ * **NOTE**: Unlike the Platform Provider overrideCallback and interopOverride, this override should
6910
+ * return a class, not an instance
6911
+ */
6912
+ layoutManagerOverride?: LayoutManagerOverride<LayoutSnapshot>;
6542
6913
  };
6543
6914
 
6544
6915
  /**
@@ -8386,8 +8757,8 @@ declare class Layout extends Base {
8386
8757
  /**
8387
8758
  * @internal
8388
8759
  */
8389
- init: (options?: InitLayoutOptions_2) => Promise<Layout>;
8390
- identity: Identity_4;
8760
+ init: (options?: OpenFin_2.InitLayoutOptions) => Promise<Layout>;
8761
+ identity: OpenFin_2.LayoutIdentity;
8391
8762
  private platform;
8392
8763
  wire: Transport;
8393
8764
  /**
@@ -8566,133 +8937,30 @@ declare type LayoutComponent = LayoutItemConfig & {
8566
8937
 
8567
8938
  declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
8568
8939
 
8569
- declare class LayoutContentCache {
8570
- private contentItemCache;
8571
- private contentItemCacheId;
8572
- private createCacheKey;
8573
- hasKey: (id: string) => boolean;
8574
- getItemOrUndefined: (id: string) => GoldenLayout.ContentItem | undefined;
8575
- getContentItemOrThrow: (id: string, expectedType?: string[]) => GoldenLayout.ContentItem;
8576
- getOrCreateEntityId: (contentItem: GoldenLayout.ContentItem) => string;
8577
- }
8578
-
8579
8940
  declare type LayoutEntitiesClient = ApiClient<LayoutEntitiesController>;
8580
8941
 
8581
- /**
8582
- * @internal
8583
- * Controller for the layout entities apis, allowing alterations to be applied
8584
- * to an instance of layout manager in a structured manner.
8585
- */
8586
- declare class LayoutEntitiesController {
8587
- private layoutInstance;
8588
- private layoutContentCache;
8589
- private wire;
8590
- constructor(layoutInstance: OpenFinLayout, layoutContentCache: LayoutContentCache);
8591
- private analytics;
8592
- /**
8593
- * @internal
8594
- * @returns the root contentItem of the layout.
8595
- */
8596
- getRoot: () => OpenFin_2.LayoutEntityDefinition;
8597
- /**
8598
- * @internal
8599
- * Retrieves the containing stack of a given view identity.
8600
- * @param view Identity of the view to retrieve the stack of.
8601
- * @returns Stack containing the given view.
8602
- * @throws If the view does not belong to a stack within the layout manager.
8603
- */
8604
- getStackByView: (view: OpenFin_2.Identity) => Promise<OpenFin_2.LayoutEntityDefinition | undefined>;
8605
- /**
8606
- * @internal
8607
- * Returns all views belonging to a given stack
8608
- *
8609
- * NOTE: Due to (TODO: ticket) Golden Layouts has an issue which changes the order of tabs
8610
- * when the amount of new views to add overflows the width of the container. This results
8611
- * in tabs being re-ordered in the UI, while the underlying content item array remains in the
8612
- * original order specified. So calling getStackViews() will return this underlying array order,
8613
- * with indexes that will not match up to the render-order of the tabs.
8614
- *
8615
- * @param id - Entity id of the stack.
8616
- * @returns A list of view identities in order of appearance.
8617
- * @throws if the content item associated with the entity id does not exist or is not a stack.
8618
- */
8942
+ declare type LayoutEntitiesController = {
8943
+ getLayoutIdentityForViewOrThrow: (viewIdentity?: OpenFin_2.Identity) => Promise<OpenFin_2.LayoutIdentity>;
8944
+ getRoot: (layoutIdentity?: OpenFin_2.LayoutIdentity) => Promise<OpenFin_2.LayoutEntityDefinition>;
8945
+ getStackByView: (viewIdentity: OpenFin_2.Identity) => Promise<OpenFin_2.LayoutEntityDefinition | undefined>;
8619
8946
  getStackViews: (id: string) => OpenFin_2.Identity[];
8620
- /**
8621
- * @internal
8622
- * Retrieves the content of a column or row and adds each to the
8623
- * entity cache to allow them to be addressed externally.
8624
- * @param id Entity id of the Column Or Row to retrieve the content of.
8625
- * @returns Array of layout entity definitions
8626
- * @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.
8627
- */
8628
- getContent(id: string): OpenFin_2.LayoutEntityDefinition[];
8629
- /**
8630
- * @internal
8631
- * Retrieves the parent content item of the given entity, and adds it to the entity cache
8632
- * so it can be addressed externally.
8633
- * @param id Entity id associated with a layout content item.
8634
- * @returns An entity definition for the given entity's parent, or undefined if the entity is the top level
8635
- * content item or has been removed from the layout entirely.
8636
- */
8637
- getParent(id: string): OpenFin_2.LayoutEntityDefinition | undefined;
8638
- /**
8639
- * @internal
8640
- * @param id Entity id associated with a layout content item.
8641
- * @returns true if the given entity is the root content item, false otherwise.
8642
- */
8947
+ getContent: (id: string) => OpenFin_2.LayoutEntityDefinition[];
8948
+ getParent: (id: string) => OpenFin_2.LayoutEntityDefinition | undefined;
8643
8949
  isRoot: (id: string) => boolean;
8644
- /**
8645
- * @internal
8646
- * Checks whether the given entity exists.
8647
- * @param entityId Id of a content item within the layout
8648
- * @returns True if the content item exists and belongs to the layout.
8649
- */
8650
8950
  exists: (entityId: string) => boolean;
8651
- /**
8652
- * @internal
8653
- * Adds an existing view to the stack, or creates and adds a view to the given stack.
8654
- *
8655
- * NOTE: Due to (TODO: ticket) Golden Layouts has an issue which changes the order of tabs
8656
- * when the amount of new views to add overflows the width of the container. This results
8657
- * in tabs being re-ordered in the UI, while the underlying content item array remains in the
8658
- * original order specified. So calling getStackViews() will return this underlying array order,
8659
- * with indexes that will not match up to the render-order of the tabs.
8660
- *
8661
- * @param stackEntityId Entity id of the stack content item within the layout.
8662
- * @param viewCreationOrReference View identity or creation options
8663
- * @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)
8664
- * @returns Promise resolving with the identity of the newly added view.
8665
- * @throws If the view does not exist, fails to create, or the stack does not exist.
8666
- */
8667
- addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, { index }?: OpenFin_2.AddViewToStackOptions) => Promise<OpenFin_2.Identity>;
8668
- private findViewInStack;
8669
- /**
8670
- * @internal
8671
- * Removes a view from the given stack. If it's the only view, the stack will be destroyed, unless window creation
8672
- * option closeOnLastViewRemoved is set to false.
8673
- *
8674
- * @param stackEntityId Entity id of a stack content item to remove the view from.
8675
- * @param view Identity of the view to remove.
8676
- * @throws If the stack does not exist or the view does not exist or belong to the stack.
8677
- */
8951
+ addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: {
8952
+ index?: number;
8953
+ }) => Promise<OpenFin_2.Identity>;
8678
8954
  removeViewFromStack: (stackEntityId: string, view: OpenFin_2.Identity) => Promise<void>;
8679
- /**
8680
- * @internal
8681
- * Creates a new adjacent 'stack' and adds the views to it at the specified position
8682
- * @param targetId Entity id of the content item to add a stack adjacent to it
8683
- * @param views List of identities or view creation options of the views to include in the stack
8684
- * @param options Creation options, defaults to { position: 'right' }
8685
- * @returns the Entity Id of the new stack
8686
- */
8687
- createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], { position }?: {
8955
+ createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], stackCreationOptions?: {
8688
8956
  position?: OpenFin_2.LayoutPosition;
8689
8957
  }) => Promise<string>;
8690
- getAdjacentStacks: ({ targetId, edge }: {
8958
+ getAdjacentStacks: (stackTarget: {
8691
8959
  targetId: string;
8692
8960
  edge: OpenFin_2.LayoutPosition;
8693
8961
  }) => Promise<Pick<OpenFin_2.LayoutEntityDefinition, 'entityId'>[]>;
8694
8962
  setStackActiveView: (stackEntityId: string, viewIdentity: OpenFin_2.Identity) => Promise<void>;
8695
- }
8963
+ };
8696
8964
 
8697
8965
  /**
8698
8966
  * @interface
@@ -8719,7 +8987,7 @@ declare type LayoutIdentity = Identity_5 & {
8719
8987
  * Generated when a window and all of its layout's views have either finished or failed navigation.
8720
8988
  * @interface
8721
8989
  */
8722
- declare type LayoutInitializedEvent = BaseWindowEvent & {
8990
+ declare type LayoutInitializedEvent = BaseEvent_5 & {
8723
8991
  type: 'layout-initialized';
8724
8992
  ofViews: (OpenFin_2.Identity & {
8725
8993
  entityType: 'view';
@@ -8727,11 +8995,14 @@ declare type LayoutInitializedEvent = BaseWindowEvent & {
8727
8995
  };
8728
8996
 
8729
8997
  /**
8730
- * @interface @experimental
8998
+ * @interface @experimental @internal
8999
+ *
9000
+ * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
8731
9001
  *
8732
9002
  * Responsible for handling all layout management and renderering
8733
9003
  */
8734
9004
  declare type LayoutInstance = {
9005
+ identity: LayoutIdentity;
8735
9006
  getFrameSnapshot: () => Promise<LayoutOptions>;
8736
9007
  addView: (payload: AddViewOptions) => Promise<View_2>;
8737
9008
  closeView: (viewIdentity: Identity_5) => Promise<void>;
@@ -8740,15 +9011,14 @@ declare type LayoutInstance = {
8740
9011
  getViews: () => LayoutComponent[];
8741
9012
  getCurrentViews: () => Identity_5[];
8742
9013
  startReplaceLayout: (payload: ReplaceLayoutOptions) => Promise<void>;
8743
- applyPreset: (payload: PresetLayoutOptions_3) => void;
9014
+ applyPreset: (payload: PresetLayoutOptions_2) => void;
8744
9015
  isVisible: () => boolean;
8745
- destroy: () => void;
9016
+ destroy: () => Promise<void>;
8746
9017
  };
8747
9018
 
8748
9019
  /**
8749
9020
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
8750
- * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
8751
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
9021
+ * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
8752
9022
  *
8753
9023
  * @interface
8754
9024
  */
@@ -8770,25 +9040,43 @@ declare type LayoutItemConfig = {
8770
9040
 
8771
9041
  /**
8772
9042
  * @interface @experimental
9043
+ *
9044
+ * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
9045
+ *
9046
+ * Responsible for aggergating all layout snapshots and storing LayoutInstances
8773
9047
  */
8774
- declare interface LayoutManager<T extends LayoutSnapshot = LayoutSnapshot> {
9048
+ declare interface LayoutManager<T extends LayoutSnapshot> {
8775
9049
  /**
8776
9050
  * @experimental
8777
9051
  *
8778
- * Must be overridden when working with multiple layouts
9052
+ * To enable multiple layouts, override this method and do not call super.applyLayoutSnapshot()
9053
+ *
9054
+ * This hook is called by OpenFin during fin.Platform.Layout.init() call, to pass a snapshot to derived
9055
+ * classes which will be used launch a platform window. Use this hook to set your local UI state and
9056
+ * begin rendering the containers for your layouts UI.
9057
+ *
9058
+ * Ensure you call fin.Platform.Layout.create() on every layout in snapshot.layouts when that layout is
9059
+ * ready to be created in your application.
8779
9060
  *
8780
- * Hook called during fin.Platform.Layout.init() call, to inform derived classes
8781
- * when a snapshot is being applied to launch a platform window. Use this hook to set the
8782
- * local state and ensure you call fin.Platform.Layout.create() on every layout in snapshot.layouts
9061
+ * If you add custom data to the app manifest snapshot.windows.layoutSnapshot key, this data will
9062
+ * be included in the snapshot type.
8783
9063
  *
8784
- * When using custom data to the app manifest snapshot.windows.layoutSnapshot key, this data will
8785
- * be included in the snapshot type T and should align with your component state T.
9064
+ * The default implementation throws if it is called with a snapshot containing more than one layout.
8786
9065
  *
8787
- * TODO: detect if layoutManager override was set and this was not overridden somehow to warn?
8788
9066
  * @param snapshot
8789
- * @returns
9067
+ * @throws if Object.keys(snapshot).length > 1
9068
+ */
9069
+ applyLayoutSnapshot(snapshot: T): Promise<void>;
9070
+ /**
9071
+ * Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
9072
+ * contains a single layout.
9073
+ *
9074
+ * Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
9075
+ * fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
9076
+ *
9077
+ * @param snapshot
9078
+ * @throws if Object.keys(snapshot).length > 1
8790
9079
  */
8791
- applyLayoutSnapshot: (snapshot: T) => Promise<void>;
8792
9080
  /**
8793
9081
  * @experimental
8794
9082
  *
@@ -8799,35 +9087,63 @@ declare interface LayoutManager<T extends LayoutSnapshot = LayoutSnapshot> {
8799
9087
  * @param layoutIdentity
8800
9088
  * @returns
8801
9089
  */
8802
- showLayout: ({ layoutName }: LayoutIdentity) => Promise<void>;
9090
+ showLayout({ layoutName }: LayoutIdentity): Promise<void>;
8803
9091
  /**
8804
9092
  * @experimental
8805
9093
  *
8806
9094
  * @returns T
8807
9095
  */
8808
- getLayoutSnapshot: () => Promise<T>;
9096
+ getLayoutSnapshot(): Promise<T>;
8809
9097
  /**
8810
9098
  * @experimental
8811
9099
  *
8812
- * @param param0
9100
+ * @param layoutIdentity
8813
9101
  * @returns
8814
9102
  */
8815
- resolveLayout: ({ layoutName }: LayoutIdentity) => LayoutInstance;
9103
+ resolveLayout(layoutIdentity?: LayoutIdentity): Promise<LayoutInstance>;
8816
9104
  /**
8817
9105
  * @experimental
8818
9106
  *
8819
9107
  * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
8820
9108
  * Throws if it does not exist.
8821
- * @param layoutIdentity
9109
+ * @param layoutName
8822
9110
  * @returns
8823
9111
  */
8824
- getLayoutByName: (layoutName: string) => LayoutInstance;
9112
+ getLayoutByName(layoutName: string): LayoutInstance;
8825
9113
  /**
8826
9114
  * @experimental
8827
9115
  */
8828
9116
  getLayouts(): Record<string, LayoutInstance>;
9117
+ /**
9118
+ * @experimental
9119
+ */
9120
+ getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
9121
+ /**
9122
+ * @experimental
9123
+ */
9124
+ isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
8829
9125
  }
8830
9126
 
9127
+ /**
9128
+ * @experimental
9129
+ *
9130
+ * Constructor type for LayoutManager to be used with multiple layouts
9131
+ */
9132
+ declare type LayoutManagerConstructor<T extends LayoutSnapshot> = {
9133
+ new (): LayoutManager<T>;
9134
+ };
9135
+
9136
+ /**
9137
+ * @experimental
9138
+ *
9139
+ * Override callback used to init and configure multiple layouts. Implement by passing
9140
+ * a lambda and returning a class that OpenFin will new up for you.
9141
+ * @remarks
9142
+ * **NOTE**: Unlike the Platform Provider overrideCallback and interopOverride, this override should
9143
+ * return a class, not an instance
9144
+ */
9145
+ declare type LayoutManagerOverride<T extends LayoutSnapshot> = (Base: LayoutManagerConstructor<LayoutSnapshot>) => LayoutManagerConstructor<T>;
9146
+
8831
9147
  /**
8832
9148
  * Static namespace for OpenFin API methods that interact with the {@link Layout} class, available under `fin.Platform.Layout`.
8833
9149
  */
@@ -8852,7 +9168,7 @@ declare class LayoutModule extends Base {
8852
9168
  * const layoutConfig = await layout.getConfig();
8853
9169
  * ```
8854
9170
  */
8855
- wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Layout>;
9171
+ wrap(identity: OpenFin_2.LayoutIdentity): Promise<OpenFin_2.Layout>;
8856
9172
  /**
8857
9173
  * Synchronously returns a Layout object that represents a Window's layout.
8858
9174
  *
@@ -8872,7 +9188,7 @@ declare class LayoutModule extends Base {
8872
9188
  * const layoutConfig = await layout.getConfig();
8873
9189
  * ```
8874
9190
  */
8875
- wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Layout;
9191
+ wrapSync(identity: OpenFin_2.LayoutIdentity): OpenFin_2.Layout;
8876
9192
  /**
8877
9193
  * Asynchronously returns a Layout object that represents a Window's layout.
8878
9194
  *
@@ -8936,7 +9252,14 @@ declare class LayoutModule extends Base {
8936
9252
  * const layout = await fin.Platform.Layout.init({ containerId });
8937
9253
  * ```
8938
9254
  */
8939
- init: (options?: InitLayoutOptions) => Promise<OpenFin_2.Layout>;
9255
+ init: (options?: OpenFin_2.InitLayoutOptions) => Promise<OpenFin_2.Layout>;
9256
+ /**
9257
+ * Returns the layout manager for the current window
9258
+ * @returns
9259
+ */
9260
+ getCurrentLayoutManagerSync: <UserSnapshotType extends OpenFin_2.LayoutSnapshot>() => OpenFin_2.LayoutManager<UserSnapshotType>;
9261
+ create: (options: OpenFin_2.CreateLayoutOptions) => Promise<void>;
9262
+ destroy: (layoutIdentity: OpenFin_2.LayoutIdentity) => Promise<void>;
8940
9263
  }
8941
9264
 
8942
9265
  declare type LayoutModule_2 = OpenFin_2.Fin['Platform']['Layout'];
@@ -8964,7 +9287,7 @@ declare abstract class LayoutNode {
8964
9287
  /**
8965
9288
  * @ignore
8966
9289
  * @internal
8967
- * Encapsulates Api consumption of {@link LayoutEntitiesController} with a relayed dispatch
9290
+ * Encapsulates Api consumption of {@link LayoutEntitiesClient} with a relayed dispatch
8968
9291
  * @param client
8969
9292
  * @param controllerId
8970
9293
  * @param identity
@@ -9179,8 +9502,7 @@ declare type LayoutOptions = {
9179
9502
  };
9180
9503
  /**
9181
9504
  * Content of the layout. There can only be one top-level LayoutItem in the content array.
9182
- * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
9183
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
9505
+ * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
9184
9506
  */
9185
9507
  content?: LayoutContent;
9186
9508
  dimensions?: {
@@ -9202,7 +9524,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9202
9524
  * Generated when a window and all of its layout's views have been created and can receive API calls.
9203
9525
  * @interface
9204
9526
  */
9205
- declare type LayoutReadyEvent = BaseWindowEvent & {
9527
+ declare type LayoutReadyEvent = BaseEvent_5 & {
9206
9528
  type: 'layout-ready';
9207
9529
  views: (OpenFin_2.Identity & {
9208
9530
  success: boolean;
@@ -9343,7 +9665,7 @@ declare type Manifest = {
9343
9665
  * Generated when the RVM notifies an application that the manifest has changed.
9344
9666
  * @interface
9345
9667
  */
9346
- declare type ManifestChangedEvent = IdentityEvent & {
9668
+ declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
9347
9669
  topic: 'application';
9348
9670
  type: 'manifest-changed';
9349
9671
  };
@@ -9396,7 +9718,7 @@ declare type MatchPattern = string;
9396
9718
  * Generated when a window is maximized.
9397
9719
  * @interface
9398
9720
  */
9399
- declare type MaximizedEvent = BaseWindowEvent & {
9721
+ declare type MaximizedEvent = BaseEvent_5 & {
9400
9722
  type: 'maximized';
9401
9723
  };
9402
9724
 
@@ -9476,7 +9798,17 @@ declare interface Message<T> {
9476
9798
 
9477
9799
  declare type MessageHandler = (data: any) => boolean;
9478
9800
 
9479
- declare class MessageReceiver extends Base {
9801
+ declare interface MessageReceiver {
9802
+ addEventListener(e: 'open', listener: (ev: Event) => void): void;
9803
+ addEventListener(e: 'error', listener: (ev: Event) => void): void;
9804
+ addEventListener(e: 'message', listener: (ev: MessageEvent) => void): void;
9805
+ addEventListener(e: 'close', listener: (ev: Event) => void): void;
9806
+ send(data: unknown): void;
9807
+ close(): void;
9808
+ readyState: FlexReadyState;
9809
+ }
9810
+
9811
+ declare class MessageReceiver_2 extends Base {
9480
9812
  private endpointMap;
9481
9813
  private latestEndpointIdByChannelId;
9482
9814
  constructor(wire: Transport);
@@ -9496,7 +9828,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
9496
9828
  * Generated when a window is minimized.
9497
9829
  * @interface
9498
9830
  */
9499
- declare type MinimizedEvent = BaseWindowEvent & {
9831
+ declare type MinimizedEvent = BaseEvent_5 & {
9500
9832
  type: 'minimized';
9501
9833
  };
9502
9834
 
@@ -9545,7 +9877,7 @@ declare type MonitorDetails = {
9545
9877
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9546
9878
  * @interface
9547
9879
  */
9548
- declare type MonitorEvent = BaseSystemEvent & OpenFin_2.MonitorInfo & {
9880
+ declare type MonitorEvent = BaseEvent_8 & OpenFin_2.MonitorInfo & {
9549
9881
  type: 'monitor-info-changed';
9550
9882
  };
9551
9883
 
@@ -9630,7 +9962,7 @@ declare type MutableViewOptions = {
9630
9962
  contentRedirect: ContentRedirect;
9631
9963
  /**
9632
9964
  * @defaultValue false
9633
- *
9965
+ * @deprecated
9634
9966
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9635
9967
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9636
9968
  */
@@ -9977,14 +10309,23 @@ declare type NonPropagatedWindowEvent = never;
9977
10309
 
9978
10310
  /**
9979
10311
  * @internal
10312
+ *
10313
+ * Ensures that an event type key does not include any `close-requested` events. Distributes over unions.
10314
+ */
10315
+ declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'close-requested'>;
10316
+
10317
+ /**
10318
+ * @internal
10319
+ *
10320
+ * Ensures that an event type key doesn't include any `-requested` events. Distributes over unions.
9980
10321
  */
9981
- declare type NotRequested<EventType> = EventType extends `${infer U}-requested` ? never : EventType;
10322
+ declare type NotRequested<EventType extends String> = EventType extends `${infer U}-requested` ? never : EventType;
9982
10323
 
9983
10324
  /**
9984
10325
  * Generated when an application is not responding.
9985
10326
  * @interface
9986
10327
  */
9987
- declare type NotRespondingEvent = IdentityEvent & {
10328
+ declare type NotRespondingEvent = BaseEvents.IdentityEvent & {
9988
10329
  topic: 'application';
9989
10330
  type: 'not-responding';
9990
10331
  };
@@ -10053,6 +10394,11 @@ declare namespace OpenFin_2 {
10053
10394
  Rectangle,
10054
10395
  ApplicationCreationOptions,
10055
10396
  ApplicationOptions,
10397
+ CustomProtocolMissingState,
10398
+ CustomProtocolMalformedState,
10399
+ CustomProtocolRegisteredState,
10400
+ CustomProtocolState,
10401
+ CustomProtocolOptions,
10056
10402
  InteropBrokerOptions,
10057
10403
  ContextGroupInfo,
10058
10404
  DisplayMetadata_3 as DisplayMetadata,
@@ -10116,6 +10462,7 @@ declare namespace OpenFin_2 {
10116
10462
  ReplaceViewPayload,
10117
10463
  ReplaceViewOptions,
10118
10464
  CloseViewPayload,
10465
+ CloseViewOptions,
10119
10466
  FetchManifestPayload,
10120
10467
  ReplaceLayoutOpts,
10121
10468
  ReplaceLayoutPayload,
@@ -10239,6 +10586,11 @@ declare namespace OpenFin_2 {
10239
10586
  IntentHandler_2 as IntentHandler,
10240
10587
  ContentCreationBehaviorNames,
10241
10588
  MatchPattern,
10589
+ BaseContentCreationRule,
10590
+ WindowContentCreationRule,
10591
+ ViewContentCreationRule,
10592
+ BrowserContentCreationRule,
10593
+ BlockedContentCreationRule,
10242
10594
  ContentCreationRule,
10243
10595
  ContentCreationOptions,
10244
10596
  SnapshotProvider,
@@ -10278,13 +10630,13 @@ declare namespace OpenFin_2 {
10278
10630
  LayoutPresetType,
10279
10631
  LayoutIdentity,
10280
10632
  LayoutSnapshot,
10281
- InitLayoutOptions_3 as InitLayoutOptions,
10633
+ InitLayoutOptions,
10634
+ LayoutManagerConstructor,
10635
+ LayoutManagerOverride,
10282
10636
  LayoutInstance,
10283
10637
  LayoutManager,
10284
- AddLayoutInstanceOptions,
10285
10638
  CreateLayoutOptions,
10286
- DestroyLayoutOptions,
10287
- PresetLayoutOptions_3 as PresetLayoutOptions,
10639
+ PresetLayoutOptions_2 as PresetLayoutOptions,
10288
10640
  ResultBehavior,
10289
10641
  PopupBaseBehavior,
10290
10642
  PopupResultBehavior,
@@ -10299,7 +10651,7 @@ declare namespace OpenFin_2 {
10299
10651
  AppVersionCompleteEvent,
10300
10652
  AppVersionRuntimeStatusEvent,
10301
10653
  Events,
10302
- BaseEvent_2 as BaseEvent,
10654
+ BaseEvent_9 as BaseEvent,
10303
10655
  WebContentsEvent_2 as WebContentsEvent,
10304
10656
  SystemEvent_2 as SystemEvent,
10305
10657
  ApplicationEvent_2 as ApplicationEvent,
@@ -10324,6 +10676,7 @@ declare namespace OpenFin_2 {
10324
10676
  ChannelClientDisconnectionListener,
10325
10677
  ChannelProviderDisconnectionListener,
10326
10678
  RoutingInfo,
10679
+ DownloadShelfOptions,
10327
10680
  ApplicationEvents,
10328
10681
  BaseEvents,
10329
10682
  ExternalApplicationEvents,
@@ -10338,113 +10691,34 @@ declare namespace OpenFin_2 {
10338
10691
  }
10339
10692
  export default OpenFin_2;
10340
10693
 
10341
- declare class OpenFinLayout implements OpenFin_2.LayoutInstance {
10342
- #private;
10343
- private readonly splitterController;
10344
- private readonly tabDragController;
10345
- private readonly layoutContentCache;
10346
- private get defaultFaviconUrl();
10347
- private get isDragging();
10348
- private get resizing();
10349
- private get showBackgroundImages();
10350
- private get showFavicons();
10351
- private get showViewsOnSplitterDrag();
10352
- private get showViewsOnTabDrag();
10353
- private get showViewsOnWindowResize();
10354
- private get container();
10355
- get layout(): GoldenLayout.GoldenLayout;
10356
- private get layoutConfigToRestore();
10357
- private client;
10358
- private containerResizeObserver;
10359
- private viewsResizeObserver;
10360
- readonly ofWindow: OpenFin_2.Window;
10361
- readonly platform: Platform_2;
10362
- private lastItemDestroyed?;
10363
- private viewsSubscribedTo;
10364
- constructor(splitterController: SplitterController, tabDragController: TabDragController, layoutContentCache: LayoutContentCache, container: HTMLElement);
10365
- getViews: () => OpenFin_2.LayoutComponent[];
10366
- startReplaceLayout: ({ layout }: {
10367
- layout: GoldenLayout.Config;
10368
- }) => Promise<void>;
10369
- applyPreset: (payload: PresetLayoutOptions_2) => void;
10370
- isVisible: () => boolean;
10371
- destroy: () => void;
10372
- /**
10373
- * @internal
10374
- * Needed by init-layout util to wire up {@link LayoutEntitiesController}
10375
- */
10376
- static getClient: (instance: OpenFinLayout) => OpenFin_2.ChannelClient;
10377
- initManager: () => Promise<void>;
10378
- createLayout: (layout: GoldenLayout.Config, container: HTMLElement) => Promise<void>;
10379
- private setContainer;
10380
- private setupDragDropRegions;
10381
- private replaceLayout;
10382
- private onViewDetached;
10383
- private setupLayoutListeners;
10384
- private onLayoutInit;
10385
- private registerViewComponent;
10386
- private setupWindowListeners;
10387
- private setupResizeObservers;
10388
- /**
10389
- * Shows/hides a view depending on use case (used by browser)
10390
- * @ignore
10391
- */
10392
- private updateViewVisibility;
10393
- private onStackCreated;
10394
- private onTabCreated;
10395
- private onTabMouseUp;
10396
- private replaceCloseTabButton;
10397
- onCloseTabButtonClick: (tab: GoldenLayout.Tab) => Promise<void>;
10398
- addFaviconToTab: (tab: GoldenLayout.Tab, eventIcons: string[]) => void;
10399
- onPopoutClick: (stack: GoldenLayout.ContentItem) => void;
10400
- onStackCloseClick: (stack: GoldenLayout.ContentItem) => void;
10401
- private updateButtonDisplay;
10402
- private onItemCreated;
10403
- private observeSplitters;
10404
- handleOutOfWindowDrop: (e: {
10405
- screenY: number;
10406
- screenX: number;
10407
- }, parentTab: GoldenLayout.Tab, dimensions: {
10408
- width: any;
10409
- height: any;
10410
- }) => Promise<void>;
10411
- private onTabDragStart;
10412
- private setBackgroundImage;
10413
- private setBackgroundImages;
10414
- getFrameSnapshot: () => Promise<GoldenLayout.Config>;
10415
- getCurrentViews: () => OpenFin_2.Identity[];
10416
- addView: ({ options: viewConfig, targetView, location }: OpenFin_2.AddViewOptions) => Promise<View_4>;
10417
- replaceView: ({ viewToReplace, newView }: OpenFin_2.ReplaceViewOptions) => Promise<View_4>;
10418
- removeView: (viewConfig: OpenFin_2.Identity | OpenFin_2.ViewState) => Promise<View_4>;
10419
- closeView: (viewIdentity: OpenFin_2.Identity) => Promise<void>;
10420
- private createChannelConnections;
10421
- getViewComponent: ({ name }: {
10422
- name: string;
10423
- }) => ViewComponent | undefined;
10424
- getViewComponents: () => ViewComponent[];
10425
- private hideHighlight;
10426
- getOfViewFromComponentState: ({ name }: {
10427
- name: string;
10428
- }) => View_4;
10429
- private hideAllViews;
10430
- private showViews;
10431
- private initializeLayoutViews;
10432
- private createResizableView;
10433
- private attachView;
10434
- private createAndAttachView;
10435
- private setupViewEvents;
10436
- private dispatchLayoutEvent;
10437
- private setComponentState;
10438
- }
10439
-
10440
10694
  declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
10441
10695
 
10696
+ /**
10697
+ * Generated after window options are changed using the window.updateOptions method.
10698
+ * @remarks Will not fire if the diff object is empty.
10699
+ * @interface
10700
+ */
10701
+ declare type OptionsChangedEvent = BaseEvent_5 & {
10702
+ type: 'options-changed';
10703
+ options: OpenFin_2.WindowOptions;
10704
+ diff: OpenFin_2.WindowOptionDiff;
10705
+ };
10706
+
10442
10707
  declare type OverlapsOnlyIfMatching<T, U> = {
10443
10708
  [K in Extract<keyof T, keyof U>]: U[K] extends T[K] ? U[K] : T[K] extends U[K] ? T[K] : never;
10444
10709
  };
10445
10710
 
10446
10711
  declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
10447
10712
 
10713
+ /**
10714
+ * Generated when page receives favicon urls.
10715
+ * @interface
10716
+ */
10717
+ declare type PageFaviconUpdatedEvent = NamedEvent & {
10718
+ type: 'page-favicon-updated';
10719
+ favicons: string[];
10720
+ };
10721
+
10448
10722
  /**
10449
10723
  * Generated when page title is set during navigation.
10450
10724
  * @remarks explicitSet is false when title is synthesized from file url.
@@ -10463,74 +10737,74 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
10463
10737
  };
10464
10738
 
10465
10739
  /**
10466
- * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
10740
+ * Extracts a single event type matching the given key from the View {@link Event} union.
10467
10741
  *
10468
10742
  * @typeParam Type String key specifying the event to extract
10469
10743
  */
10470
- declare type Payload_2<Type extends ApplicationEventType> = Extract<ApplicationEvent, {
10744
+ declare type Payload_2<Type extends EventType> = Extract<Event_4, {
10471
10745
  type: Type;
10472
10746
  }>;
10473
10747
 
10474
10748
  /**
10475
- * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
10749
+ * Extracts a single event type matching the given key from the Window {@link Event} union.
10476
10750
  *
10477
10751
  * @typeParam Type String key specifying the event to extract
10478
10752
  */
10479
- declare type Payload_3<Type extends ExternalApplicationEventType> = Extract<ExternalApplicationEvent, {
10753
+ declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
10480
10754
  type: Type;
10481
10755
  }>;
10482
10756
 
10483
10757
  /**
10484
- * Extracts a single event type matching the given key from the {@link FrameEvent} union.
10758
+ * Extracts a single event type matching the given key from the Application {@link Event} union.
10485
10759
  *
10486
10760
  * @typeParam Type String key specifying the event to extract
10487
10761
  */
10488
- declare type Payload_4<Type extends FrameEventType> = Extract<FrameEvent, {
10762
+ declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
10489
10763
  type: Type;
10490
10764
  }>;
10491
10765
 
10492
10766
  /**
10493
- * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
10767
+ * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
10494
10768
  *
10495
10769
  * @typeParam Type String key specifying the event to extract
10496
10770
  */
10497
- declare type Payload_5<Type extends GlobalHotkeyEventType> = Extract<GlobalHotkeyEvent, {
10771
+ declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
10498
10772
  type: Type;
10499
10773
  }>;
10500
10774
 
10501
10775
  /**
10502
- * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
10776
+ * Extracts a single event type matching the given key from the Frame {@link Event} union.
10503
10777
  *
10504
10778
  * @typeParam Type String key specifying the event to extract
10505
10779
  */
10506
- declare type Payload_6<Type extends PlatformEventType> = Extract<PlatformEvent, {
10780
+ declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
10507
10781
  type: Type;
10508
10782
  }>;
10509
10783
 
10510
10784
  /**
10511
- * Extracts a single event type matching the given key from the {@link SystemEvent} union.
10785
+ * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
10512
10786
  *
10513
10787
  * @typeParam Type String key specifying the event to extract
10514
10788
  */
10515
- declare type Payload_7<Type extends SystemEventType> = Extract<SystemEvent, {
10789
+ declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
10516
10790
  type: Type;
10517
10791
  }>;
10518
10792
 
10519
10793
  /**
10520
- * Extracts a single event type matching the given key from the {@link ViewEvent} union.
10794
+ * Extracts a single event type matching the given key from the Platform {@link Event} union.
10521
10795
  *
10522
10796
  * @typeParam Type String key specifying the event to extract
10523
10797
  */
10524
- declare type Payload_8<Type extends ViewEventType> = Extract<ViewEvent, {
10798
+ declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
10525
10799
  type: Type;
10526
10800
  }>;
10527
10801
 
10528
10802
  /**
10529
- * Extracts a single event type matching the given key from the {@link WindowEvent} union.
10803
+ * Extracts a single event type matching the given key from the System {@link Event} union.
10530
10804
  *
10531
10805
  * @typeParam Type String key specifying the event to extract
10532
10806
  */
10533
- declare type Payload_9<Type extends WindowEventType> = Extract<WindowEvent, {
10807
+ declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10534
10808
  type: Type;
10535
10809
  }>;
10536
10810
 
@@ -10540,7 +10814,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
10540
10814
  * Generated when window finishes loading. Provides performance and navigation data.
10541
10815
  * @interface
10542
10816
  */
10543
- declare type PerformanceReportEvent = Performance & BaseWindowEvent & {
10817
+ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
10544
10818
  type: 'performance-report';
10545
10819
  };
10546
10820
 
@@ -11203,41 +11477,37 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
11203
11477
  }): Promise<void>;
11204
11478
  }
11205
11479
 
11206
- declare type Platform_2 = OpenFin_2.Platform;
11207
-
11208
11480
  /**
11209
- * Generated when a new Platform's API becomes responsive.
11210
- * @interface
11481
+ * @deprecated Renamed to {@link ApiReadyEvent}.
11211
11482
  */
11212
- declare type PlatformApiReadyEvent = BaseEvent & {
11213
- topic: 'application';
11214
- type: 'platform-api-ready';
11215
- };
11483
+ declare type PlatformApiReadyEvent = ApiReadyEvent;
11216
11484
 
11217
11485
  /**
11218
- * [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
11219
- * discriminated by {@link PlatformEvent.type | their type}. Event payloads unique to `Platform` can be found
11220
- * under the {@link OpenFin.PlatformEvents} namespace.
11486
+ * @deprecated Renamed to {@link Event}.
11221
11487
  */
11222
- declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
11488
+ declare type PlatformEvent = Event_10;
11223
11489
 
11224
11490
  declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
11225
11491
 
11226
11492
  declare namespace PlatformEvents {
11227
11493
  export {
11494
+ ApiReadyEvent,
11228
11495
  PlatformApiReadyEvent,
11496
+ SnapshotAppliedEvent,
11229
11497
  PlatformSnapshotAppliedEvent,
11498
+ Event_10 as Event,
11230
11499
  PlatformEvent,
11500
+ EventType_7 as EventType,
11231
11501
  PlatformEventType,
11232
- Payload_6 as Payload,
11233
- ByType_5 as ByType
11502
+ Payload_8 as Payload,
11503
+ ByType_7 as ByType
11234
11504
  }
11235
11505
  }
11236
11506
 
11237
11507
  /**
11238
- * Union of possible `type` values for a {@link PlatformEvent}.
11508
+ * @deprecated Renamed to {@link }.
11239
11509
  */
11240
- declare type PlatformEventType = PlatformEvent['type'];
11510
+ declare type PlatformEventType = EventType_7;
11241
11511
 
11242
11512
  /**
11243
11513
  * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
@@ -11498,7 +11768,33 @@ declare interface PlatformProvider {
11498
11768
  * }
11499
11769
  * ```
11500
11770
  */
11501
- getSnapshot(payload: undefined, identity: OpenFin_2.Identity): Promise<OpenFin_2.Snapshot>;
11771
+ getSnapshot(payload: undefined, identity: OpenFin_2.Identity): Promise<OpenFin_2.Snapshot>;
11772
+ /**
11773
+ * @experimental @internal
11774
+ *
11775
+ * **NOTE**: Internal use only. This method is reserved for Workspace Browser implementation.
11776
+ *
11777
+ * Returns the window options value for `layoutSnapshot` which has already been normalized.
11778
+ * @param payload
11779
+ * @param callerIdentity
11780
+ */
11781
+ getInitialLayoutSnapshot(payload: undefined, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.LayoutSnapshot | undefined>;
11782
+ /**
11783
+ * @experimental @internal
11784
+ *
11785
+ * **NOTE**: Internal use only. This method is reserved for Workspace Browser implementation.
11786
+ *
11787
+ * Calls platform.createView for every view in the given layout. Returns an array of promises
11788
+ * one promise for each view create call
11789
+ *
11790
+ * @param payload
11791
+ * @param callerIdentity
11792
+ * @returns an array of promises
11793
+ */
11794
+ createViewsForLayout(payload: {
11795
+ layout: GoldenLayout.Config;
11796
+ target?: OpenFin_2.Identity;
11797
+ }, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.View>[];
11502
11798
  /**
11503
11799
  * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
11504
11800
  * Gets the current state of a single view and returns an object with the options needed to restore that view as part of a snapshot.
@@ -11939,19 +12235,9 @@ declare interface PlatformProvider {
11939
12235
  }
11940
12236
 
11941
12237
  /**
11942
- * Generated when a platform.ApplySnapshot call is resolved.
11943
- * @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
11944
- * 1. The window has been created
11945
- * 2. The window has a responsive API
11946
- * 3. If a window has a layout property, the 'layout-ready' event has fired
11947
- *
11948
- * _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.
11949
- * @interface
12238
+ * @deprecated Renamed to {@link SnapshotAppliedEvent}.
11950
12239
  */
11951
- declare type PlatformSnapshotAppliedEvent = BaseEvent & {
11952
- topic: 'application';
11953
- type: 'platform-snapshot-applied';
11954
- };
12240
+ declare type PlatformSnapshotAppliedEvent = SnapshotAppliedEvent;
11955
12241
 
11956
12242
  /**
11957
12243
  * @interface
@@ -12219,7 +12505,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
12219
12505
  * A general preload scripts state change event without event type.
12220
12506
  * @interface
12221
12507
  */
12222
- declare type PreloadScriptsStateChangeEvent = BaseWindowEvent & {
12508
+ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12223
12509
  preloadScripts: (PreloadScriptInfoRunning & any)[];
12224
12510
  };
12225
12511
 
@@ -12234,12 +12520,10 @@ declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent &
12234
12520
 
12235
12521
  declare type PresetLayoutOptions = OpenFin_2.PresetLayoutOptions;
12236
12522
 
12237
- declare type PresetLayoutOptions_2 = OpenFin_2.PresetLayoutOptions;
12238
-
12239
12523
  /**
12240
12524
  * @interface
12241
12525
  */
12242
- declare type PresetLayoutOptions_3 = {
12526
+ declare type PresetLayoutOptions_2 = {
12243
12527
  /**
12244
12528
  * Which preset layout arrangement to use.
12245
12529
  * The preset options are `columns`, `grid`, `rows`, and `tabs`.
@@ -12430,65 +12714,96 @@ declare type ProcessLoggingOptions = {
12430
12714
  };
12431
12715
 
12432
12716
  /**
12433
- * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
12434
- * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
12435
- * are propagated to `System` without any type string prefixing.
12436
- *
12437
- * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
12717
+ * @deprecated Renamed to {@link PropagatedEvent}.
12438
12718
  */
12439
- declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
12719
+ declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent_4<TargetTopic>;
12440
12720
 
12441
12721
  /**
12442
- * Union of possible 'type' values for a {@link OpenFin.ApplicationEvents.PropagatedApplicationEvent}.
12722
+ * @deprecated Renamed to {@link PropagatedEventType}.
12443
12723
  */
12444
- declare type PropagatedApplicationEventType = PropagatedApplicationEvent<string>['type'];
12724
+ declare type PropagatedApplicationEventType = PropagatedEventType_3;
12445
12725
 
12446
12726
  /**
12447
- * Modifies an event shape to reflect propagation to a parent topic.
12727
+ * Modifies an event shape to reflect propagation to a parent topic. Excludes `close-requested` events, as
12728
+ * these do not propagate.
12729
+ *
12448
12730
  * @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
12731
+ *
12732
+ * @typeParam SourceTopic The topic the event shape is propagating from.
12733
+ * @typeParam TargetTopic The topic the event shape is propagating to.
12734
+ * @typeParam Event The shape of the event being propagated.
12449
12735
  */
12450
12736
  declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
12451
12737
  type: string;
12452
12738
  }> = Event extends infer E extends {
12453
12739
  type: string;
12454
- } ? Omit<E, 'type' | 'topic'> & {
12740
+ } ? E['type'] extends 'close-requested' ? never : Omit<E, 'type' | 'topic'> & {
12455
12741
  type: PropagatedEventType<SourceTopic, E['type']>;
12456
12742
  topic: TargetTopic;
12457
12743
  } : never;
12458
12744
 
12459
- /**
12460
- * Modifies an event key to reflect propagation by prefixing with the topic.
12461
- */
12462
- declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
12463
-
12464
12745
  /**
12465
12746
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
12466
- * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
12747
+ * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
12467
12748
  * event type key with `'view-'`.
12468
12749
  */
12469
- declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
12750
+ declare type PropagatedEvent_2<TargetTopic extends string> = BaseEvents.PropagatedEvent<'view', TargetTopic, ViewEvent> & {
12470
12751
  viewIdentity: OpenFin_2.Identity;
12471
12752
  };
12472
12753
 
12473
- /**
12474
- * Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
12475
- */
12476
- declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
12477
-
12478
12754
  /**
12479
12755
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
12480
- * prefixing the type string with `'window-'`. Only {@link NativeWindowEvent native window events} will propagate
12756
+ * prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
12481
12757
  * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
12482
12758
  * will *not* re-propagate.
12483
12759
  *
12484
12760
  * "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
12485
12761
  */
12486
- declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent<'window', TargetTopic, Exclude<WindowSourcedEvent, WindowCloseRequestedEvent>>;
12762
+ declare type PropagatedEvent_3<TargetTopic extends string> = BaseEvents.PropagatedEvent<'window', TargetTopic, WindowSourcedEvent>;
12763
+
12764
+ /**
12765
+ * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
12766
+ * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
12767
+ * are propagated to `System` without any type string prefixing.
12768
+ *
12769
+ * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
12770
+ */
12771
+ declare type PropagatedEvent_4<TargetTopic extends string> = BaseEvents.PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
12772
+
12773
+ /**
12774
+ * Modifies an event type key to reflect propagation by prefixing with the topic.
12775
+ */
12776
+ declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${NotCloseRequested<Type>}`;
12777
+
12778
+ /**
12779
+ * Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.View}.
12780
+ */
12781
+ declare type PropagatedEventType_2 = PropagatedEvent_2<string>['type'];
12782
+
12783
+ /**
12784
+ * Union of possible 'type' values for an {@link PropagatedEvent} sourced from an {@link Application}.
12785
+ */
12786
+ declare type PropagatedEventType_3 = PropagatedEvent_4<string>['type'];
12787
+
12788
+ /**
12789
+ * @deprecated Renamed to {@link PropagatedEvent}.
12790
+ */
12791
+ declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent_2<TargetTopic>;
12792
+
12793
+ /**
12794
+ * @deprecated Renamed to {@link PropagatedEventType}.
12795
+ */
12796
+ declare type PropagatedViewEventType = PropagatedEventType_2;
12797
+
12798
+ /**
12799
+ * @deprecated Renamed to {@link PropagatedEvent}.
12800
+ */
12801
+ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent_3<TargetTopic>;
12487
12802
 
12488
12803
  /**
12489
- * Union of possible `type` values for a {@link OpenFin.WindowEvents.PropagatedWindowEvent}.
12804
+ * Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.Window}.
12490
12805
  */
12491
- declare type PropagatedWindowEventType = PropagatedWindowEvent<string>['type'];
12806
+ declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
12492
12807
 
12493
12808
  declare interface ProtocolMap extends ProtocolMapBase {
12494
12809
  'request-external-authorization': {
@@ -12695,6 +13010,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
12695
13010
  anchor: OpenFin_2.AnchorType;
12696
13011
  }>>;
12697
13012
  'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin_2.Bounds>>>;
13013
+ 'register-custom-protocol': ApiCall<OpenFin_2.CustomProtocolOptions, void>;
13014
+ 'unregister-custom-protocol': ApiCall<{
13015
+ protocolName: string;
13016
+ }, void>;
13017
+ 'get-custom-protocol-state': ApiCall<{
13018
+ protocolName: string;
13019
+ }, OpenFin_2.CustomProtocolState>;
12698
13020
  }
12699
13021
 
12700
13022
  declare interface ProtocolMapBase {
@@ -12826,6 +13148,10 @@ declare interface ReactComponentConfig extends ItemConfig {
12826
13148
  */
12827
13149
  declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptions;
12828
13150
 
13151
+ declare interface ReceiverConfig extends Omit<RemoteConfig, 'address'> {
13152
+ receiver: MessageReceiver;
13153
+ }
13154
+
12829
13155
  /**
12830
13156
  * A rectangular area on the screen.
12831
13157
  *
@@ -12895,7 +13221,7 @@ declare type RegistryInfo_2 = {
12895
13221
  * Generated when a window has been reloaded.
12896
13222
  * @interface
12897
13223
  */
12898
- declare type ReloadedEvent = BaseWindowEvent & {
13224
+ declare type ReloadedEvent = BaseEvent_5 & {
12899
13225
  type: 'reloaded';
12900
13226
  url: string;
12901
13227
  };
@@ -12907,19 +13233,19 @@ declare interface RemoteConfig extends ExistingConnectConfig {
12907
13233
  /**
12908
13234
  * @interface
12909
13235
  */
12910
- declare type ReplaceLayoutOptions = ReplaceLayoutOpts;
13236
+ declare type ReplaceLayoutOptions = {
13237
+ /**
13238
+ * Layout config to be applied.
13239
+ */
13240
+ layout: LayoutOptions;
13241
+ };
12911
13242
 
12912
13243
  /**
12913
13244
  * @interface
12914
13245
  *
12915
13246
  * @deprecated use ReplaceLayoutOptions instead
12916
13247
  */
12917
- declare type ReplaceLayoutOpts = {
12918
- /**
12919
- * Layout config to be applied.
12920
- */
12921
- layout: LayoutOptions;
12922
- };
13248
+ declare type ReplaceLayoutOpts = ReplaceLayoutOptions;
12923
13249
 
12924
13250
  /**
12925
13251
  * @interface
@@ -12930,9 +13256,9 @@ declare type ReplaceLayoutPayload = {
12930
13256
  */
12931
13257
  opts: ReplaceLayoutOptions;
12932
13258
  /**
12933
- * Identity of the window whose layout will be replace.
13259
+ * Identity of the window whose layout will be replaced.
12934
13260
  */
12935
- target: Identity_5;
13261
+ target: LayoutIdentity;
12936
13262
  };
12937
13263
 
12938
13264
  /**
@@ -12951,7 +13277,7 @@ declare type ReplaceViewPayload = {
12951
13277
  viewToReplace: Identity_5;
12952
13278
  newView: Partial<ViewOptions>;
12953
13279
  };
12954
- target: Identity_5;
13280
+ target: LayoutIdentity;
12955
13281
  };
12956
13282
 
12957
13283
  /**
@@ -13031,11 +13357,19 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
13031
13357
  * Generated when an application is responding.
13032
13358
  * @interface
13033
13359
  */
13034
- declare type RespondingEvent = IdentityEvent & {
13360
+ declare type RespondingEvent = BaseEvents.IdentityEvent & {
13035
13361
  topic: 'application';
13036
13362
  type: 'responding';
13037
13363
  };
13038
13364
 
13365
+ /**
13366
+ * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
13367
+ * @interface
13368
+ */
13369
+ declare type RestoredEvent = BaseEvent_5 & {
13370
+ type: 'restored';
13371
+ };
13372
+
13039
13373
  declare type ResultBehavior = 'close' | 'hide' | 'none';
13040
13374
 
13041
13375
  /**
@@ -13098,7 +13432,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
13098
13432
  * Generated when Application.run() is called for an already running application.
13099
13433
  * @interface
13100
13434
  */
13101
- declare type RunRequestedEvent_2 = IdentityEvent & {
13435
+ declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
13102
13436
  topic: 'application';
13103
13437
  type: 'run-requested';
13104
13438
  userAppConfigArgs: Record<string, any>;
@@ -13280,7 +13614,7 @@ declare type ServiceIdentifier = {
13280
13614
  * Generated on changes to a user’s local computer session.
13281
13615
  * @interface
13282
13616
  */
13283
- declare type SessionChangedEvent = BaseSystemEvent & {
13617
+ declare type SessionChangedEvent = BaseEvent_8 & {
13284
13618
  type: 'session-changed';
13285
13619
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13286
13620
  };
@@ -13463,11 +13797,62 @@ declare type ShortcutOverride = Hotkey & {
13463
13797
  command: string;
13464
13798
  };
13465
13799
 
13800
+ /**
13801
+ * Generated when the Download Shelf 'Show All' button is clicked.
13802
+ *
13803
+ * @remarks By default, OpenFin does not handle the clicking of the `Show All` button on the download
13804
+ * shelf. Instead, it fires this event, which leaves rendering a download manager to the user. For a simple
13805
+ * implementation, the `chrome://downloads` page can be used (see the example below):
13806
+ *
13807
+ * @example
13808
+ *
13809
+ * ```typescript
13810
+ * const platform = await fin.Platform.getCurrentSync();
13811
+ * // Listen to the propagated event at the Platform level, so that we only need one listener for a click from any window
13812
+ * platform.on('window-show-all-downloads', () => {
13813
+ * // Render the `chrome://downloads` window when a user clicks on the download shelf `Show All` button
13814
+ * platform.createWindow({
13815
+ * name: 'show-download-window',
13816
+ * layout: {
13817
+ * content: [
13818
+ * {
13819
+ * type: 'stack',
13820
+ * content: [
13821
+ * {
13822
+ * type: 'component',
13823
+ * componentName: 'view',
13824
+ * componentState: {
13825
+ * name: 'show-download-view',
13826
+ * url: 'chrome://downloads'
13827
+ * }
13828
+ * }
13829
+ * ]
13830
+ * }
13831
+ * ]
13832
+ * }
13833
+ * });
13834
+ * })
13835
+ * ```
13836
+ *
13837
+ * @interface
13838
+ */
13839
+ declare type ShowAllDownloadsEvent = BaseEvent_5 & {
13840
+ type: 'show-all-downloads';
13841
+ };
13842
+
13466
13843
  /**
13467
13844
  * Generated when a View is shown. This event will fire during creation of a View.
13468
13845
  * @interface
13469
13846
  */
13470
- declare type ShownEvent = BaseViewEvent & {
13847
+ declare type ShownEvent = BaseEvent_4 & {
13848
+ type: 'shown';
13849
+ };
13850
+
13851
+ /**
13852
+ * Generated when a hidden window has been shown.
13853
+ * @interface
13854
+ */
13855
+ declare type ShownEvent_2 = BaseEvent_5 & {
13471
13856
  type: 'shown';
13472
13857
  };
13473
13858
 
@@ -13496,6 +13881,15 @@ declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
13496
13881
  y?: number;
13497
13882
  };
13498
13883
 
13884
+ /**
13885
+ * Generated when a window has been prevented from showing.
13886
+ * @remarks A window will be prevented from showing by default, either through the API or by a user when ‘show-requested’ has been subscribed to on the window or 'window-show-requested' on the parent application and the Window.show(force) flag is false.
13887
+ * @interface
13888
+ */
13889
+ declare type ShowRequestedEvent = BaseEvent_5 & {
13890
+ type: 'show-requested';
13891
+ };
13892
+
13499
13893
  /**
13500
13894
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
13501
13895
  *
@@ -13542,6 +13936,21 @@ declare type Snapshot = {
13542
13936
  };
13543
13937
  };
13544
13938
 
13939
+ /**
13940
+ * Generated when a platform.ApplySnapshot call is resolved.
13941
+ * @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
13942
+ * 1. The window has been created
13943
+ * 2. The window has a responsive API
13944
+ * 3. If a window has a layout property, the 'layout-ready' event has fired
13945
+ *
13946
+ * _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
13947
+ * @interface
13948
+ */
13949
+ declare type SnapshotAppliedEvent = BaseEvent & {
13950
+ topic: 'application';
13951
+ type: 'platform-snapshot-applied';
13952
+ };
13953
+
13545
13954
  /**
13546
13955
  * @interface
13547
13956
  */
@@ -13655,42 +14064,11 @@ declare class SnapshotSourceModule extends Base {
13655
14064
  wrap(identity: OpenFin_2.ApplicationIdentity): Promise<SnapshotSource>;
13656
14065
  }
13657
14066
 
13658
- /**
13659
- * Utility class for managing Golden Layout splitter drag interactions.
13660
- * @ignore
13661
- */
13662
- declare class SplitterController {
13663
- private readonly viewOverlay;
13664
- constructor(viewOverlay: ViewOverlay);
13665
- private teardown?;
13666
- private tryTeardown;
13667
- /**
13668
- * Disables the pointer events on the splitters, preventing them from being dragged.
13669
- */
13670
- preventSplitterResize: () => void;
13671
- /**
13672
- * Ends a splitter drag move, if one is in progress.
13673
- */
13674
- endMove: () => Promise<void>;
13675
- /**
13676
- * Initialises a splitter drag move, rendering a view on top of the splitter
13677
- * to allow it to render on top of the views within a layout (as they will always
13678
- * have a higher z-index to the platform window itself).
13679
- * @param splitterItem The Golden Layout splitter item that is currently being dragged.
13680
- */
13681
- startMove: (splitterItem: SplitterItem) => Promise<void>;
13682
- }
13683
-
13684
- declare type SplitterItem = GoldenLayout.ContentItem & {
13685
- viewEventsAdded: boolean;
13686
- isVertical: boolean;
13687
- };
13688
-
13689
14067
  /**
13690
14068
  * Generated when an application has started.
13691
14069
  * @interface
13692
14070
  */
13693
- declare type StartedEvent = IdentityEvent & {
14071
+ declare type StartedEvent = BaseEvents.IdentityEvent & {
13694
14072
  topic: 'application';
13695
14073
  type: 'started';
13696
14074
  };
@@ -14534,6 +14912,70 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
14534
14912
  * ```
14535
14913
  */
14536
14914
  openUrlWithBrowser(url: string): Promise<void>;
14915
+ /**
14916
+ * Creates a new registry entry under the HKCU root Windows registry key if the given custom protocol name doesn't exist or
14917
+ * overwrites the existing registry entry if the given custom protocol name already exists.
14918
+ *
14919
+ * Note: This method is restricted by default and must be enabled via
14920
+ * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
14921
+ *
14922
+ *
14923
+ * @remarks These protocols are reserved and cannot be registered:
14924
+ * - fin
14925
+ * - fins
14926
+ * - openfin
14927
+ * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
14928
+ *
14929
+ * @throws if a given custom protocol failed to be registered.
14930
+ * @throws if a manifest URL contains the '%1' string.
14931
+ * @throws if a manifest URL contains a query string parameter which name equals to the Protocol Launch Request Parameter Name.
14932
+ * @throws if the full length of the command string that is to be written to the registry exceeds 2048 bytes.
14933
+ *
14934
+ * @example
14935
+ * ```js
14936
+ * fin.System.registerCustomProtocol({protocolName:'protocol1'}).then(console.log).catch(console.error);
14937
+ * ```
14938
+ */
14939
+ registerCustomProtocol(options: OpenFin_2.CustomProtocolOptions): Promise<void>;
14940
+ /**
14941
+ * Removes the registry entry for a given custom protocol.
14942
+ *
14943
+ * Note: This method is restricted by default and must be enabled via
14944
+ * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
14945
+ *
14946
+ *
14947
+ * @remarks These protocols are reserved and cannot be unregistered:
14948
+ * - fin
14949
+ * - fins
14950
+ * - openfin
14951
+ * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
14952
+ *
14953
+ * @throws if a protocol entry failed to be removed in registry.
14954
+ *
14955
+ * @example
14956
+ * ```js
14957
+ * await fin.System.unregisterCustomProtocol('protocol1');
14958
+ * ```
14959
+ */
14960
+ unregisterCustomProtocol(protocolName: string): Promise<void>;
14961
+ /**
14962
+ * Retrieves the registration state for a given custom protocol.
14963
+ *
14964
+ * Note: This method is restricted by default and must be enabled via
14965
+ * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
14966
+ *
14967
+ * @remarks These protocols are reserved and cannot get states for them:
14968
+ * - fin
14969
+ * - fins
14970
+ * - openfin
14971
+ * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
14972
+ *
14973
+ *
14974
+ * @example
14975
+ * ```js
14976
+ * const protocolState = await fin.System.getCustomProtocolState('protocol1');
14977
+ */
14978
+ getCustomProtocolState(protocolName: string): Promise<OpenFin_2.CustomProtocolState>;
14537
14979
  /**
14538
14980
  * Removes the process entry for the passed UUID obtained from a prior call
14539
14981
  * of fin.System.launchExternalProcess().
@@ -15162,12 +15604,9 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
15162
15604
  };
15163
15605
 
15164
15606
  /**
15165
- * [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
15166
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
15167
- * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
15168
- * from which they propagate).
15607
+ * @deprecated Renamed to {@link Event}.
15169
15608
  */
15170
- declare type SystemEvent = ExcludeRequested<PropagatedWindowEvent<'system'>> | PropagatedViewEvent<'system'> | PropagatedApplicationEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
15609
+ declare type SystemEvent = Event_11;
15171
15610
 
15172
15611
  declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
15173
15612
 
@@ -15175,7 +15614,7 @@ declare namespace SystemEvents {
15175
15614
  export {
15176
15615
  NotRequested,
15177
15616
  ExcludeRequested,
15178
- BaseSystemEvent,
15617
+ BaseEvent_8 as BaseEvent,
15179
15618
  IdleEvent,
15180
15619
  MonitorEvent,
15181
15620
  SessionChangedEvent,
@@ -15190,17 +15629,19 @@ declare namespace SystemEvents {
15190
15629
  ApplicationCreatedEvent,
15191
15630
  DesktopIconClickedEvent,
15192
15631
  SystemShutdownEvent,
15632
+ Event_11 as Event,
15193
15633
  SystemEvent,
15634
+ EventType_8 as EventType,
15194
15635
  SystemEventType,
15195
- Payload_7 as Payload,
15196
- ByType_6 as ByType
15636
+ Payload_9 as Payload,
15637
+ ByType_8 as ByType
15197
15638
  }
15198
15639
  }
15199
15640
 
15200
15641
  /**
15201
- * Union of possible `type` values for a {@link SystemEvent}.
15642
+ * @deprecated Renamed to {@link EventType}.
15202
15643
  */
15203
- declare type SystemEventType = SystemEvent['type'];
15644
+ declare type SystemEventType = EventType_8;
15204
15645
 
15205
15646
  /**
15206
15647
  * @interface
@@ -15230,6 +15671,18 @@ declare type SystemPermissions = {
15230
15671
  enabled: boolean;
15231
15672
  protocols: string[];
15232
15673
  };
15674
+ registerCustomProtocol: boolean | {
15675
+ enabled: boolean;
15676
+ protocols: string[];
15677
+ };
15678
+ unregisterCustomProtocol: boolean | {
15679
+ enabled: boolean;
15680
+ protocols: string[];
15681
+ };
15682
+ getCustomProtocolState: boolean | {
15683
+ enabled: boolean;
15684
+ protocols: string[];
15685
+ };
15233
15686
  };
15234
15687
 
15235
15688
  /**
@@ -15245,7 +15698,7 @@ declare type SystemProcessInfo = {
15245
15698
  * Generated when system shutdown or log off.
15246
15699
  * @internal
15247
15700
  */
15248
- declare type SystemShutdownEvent = BaseSystemEvent & {
15701
+ declare type SystemShutdownEvent = BaseEvent_8 & {
15249
15702
  type: 'system-shutdown';
15250
15703
  };
15251
15704
 
@@ -15254,7 +15707,7 @@ declare type SystemShutdownHandler = (shutdownEvent: {
15254
15707
  }) => void;
15255
15708
 
15256
15709
  declare interface Tab {
15257
- _dragListener: EventEmitter_2;
15710
+ _dragListener: TabDragListener;
15258
15711
 
15259
15712
  /**
15260
15713
  * True if this tab is the selected tab
@@ -15299,60 +15752,11 @@ declare interface Tab {
15299
15752
  setActive(isActive: boolean): void;
15300
15753
  }
15301
15754
 
15302
- /**
15303
- * Set of apis used to facilitate tab drag interactions without needing to hide views.
15304
- * @ignore
15305
- */
15306
- declare class TabDragController {
15307
- private readonly viewOverlay;
15308
- constructor(viewOverlay: ViewOverlay);
15309
- private dropZonePreview?;
15310
- /**
15311
- *
15312
- * When a tab is dragged out of a stack, it will need to be hidden from the stack.
15313
- *
15314
- * Additionally, if there is a new view to show in the stack, it will be shown at the position specified by
15315
- * containerBounds
15316
- *
15317
- * As drag interactions can under extreme circumstances complete before this chain of promises has completed,
15318
- * we need to pass in a isDragging() function which returns whether the drag is in progress.
15319
- * This allows us to cancel any layout affecting operations.
15320
- *
15321
- * @param draggingView The view which is currently being dragged
15322
- * @param isLastViewInWindow Whether the draggin view is the last view in a window or not. If false, the dragging view will not hide.
15323
- * @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
15324
- * modifying any views if the drag has completed (as the post drag procedure will have taken care of it.)
15325
- * @param containerBounds The bounds of the container of the view to be shown in the stack
15326
- * @param nextView The view which has become active after dragging the draggingView out.
15327
- */
15328
- handleTabStackActiveView: (draggingView: View_3, isLastViewInWindow: boolean, isDragging: () => boolean, containerBounds?: OpenFin_2.Bounds, nextView?: View_3) => Promise<void>;
15329
- /**
15330
- * Extracts the border and backgroundColor css values from the drop zone preview,
15331
- * and sets the viewOverlay to match them.
15332
- */
15333
- inheritStyles: () => Promise<void>;
15334
- /**
15335
- * Called when a tab drag interaction is started from the current window (not when it enters the window).
15336
- *
15337
- * Sets all views in the platform to ignore mouse events so that they can pass through to the golden-layout
15338
- * document whilst remaining visible.
15339
- */
15340
- startDrag: () => Promise<void>;
15755
+ declare interface TabDragListener extends EventEmitter_2 {
15341
15756
  /**
15342
- * Called when a tab drag interaction which was started from the current window ends.
15343
- *
15344
- * Disables the click through setting on every view in the platform.
15345
- */
15346
- endDrag: () => Promise<void>;
15347
- private disposeObserve?;
15348
- disposeOverlayObserver: () => void;
15349
- /**
15350
- * Observes a golden-layout drop zone preview in order to render a BrowserView
15351
- * overlay whenever a tab is dragged over a droppable region.
15352
- * @param dropZonePreview The drop zone preview element created by Golden Layout in order to highlight
15353
- * droppable regions of the UI.
15757
+ * A reference to the content item this tab relates to
15354
15758
  */
15355
- observeOverlay: (dropZonePreview: HTMLElement) => Promise<void>;
15759
+ contentItem: ContentItem;
15356
15760
  }
15357
15761
 
15358
15762
  /**
@@ -15547,7 +15951,7 @@ declare type TargetApp = string | AppMetadata;
15547
15951
  * In that case, previousTarget identity will be the same as target identity.
15548
15952
  * @interface
15549
15953
  */
15550
- declare type TargetChangedEvent = BaseViewEvent & {
15954
+ declare type TargetChangedEvent = BaseEvent_4 & {
15551
15955
  type: 'target-changed';
15552
15956
  previousTarget: OpenFin_2.Identity;
15553
15957
  };
@@ -15684,7 +16088,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
15684
16088
  connectSync: () => void;
15685
16089
  getPort: () => string;
15686
16090
  shutdown(): Promise<void>;
15687
- connect(config: InternalConnectConfig | RemoteConfig): Promise<string | void>;
16091
+ connect(config: InternalConnectConfig | RemoteConfig | ReceiverConfig): Promise<string | void>;
15688
16092
  private connectRemote;
15689
16093
  connectByPort(config: ExistingConnectConfig): Promise<void>;
15690
16094
  private authorize;
@@ -15701,7 +16105,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
15701
16105
  * Generated when the tray icon is clicked.
15702
16106
  * @interface
15703
16107
  */
15704
- declare type TrayIconClickedEvent = IdentityEvent & {
16108
+ declare type TrayIconClickedEvent = BaseEvents.IdentityEvent & {
15705
16109
  topic: 'application';
15706
16110
  type: 'tray-icon-clicked';
15707
16111
  button: 0 | 1 | 2;
@@ -15791,7 +16195,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15791
16195
  * A general user bounds change event without event type.
15792
16196
  * @interface
15793
16197
  */
15794
- declare type UserBoundsChangeEvent = BaseWindowEvent & {
16198
+ declare type UserBoundsChangeEvent = BaseEvent_5 & {
15795
16199
  height: number;
15796
16200
  left: number;
15797
16201
  top: number;
@@ -15803,7 +16207,7 @@ declare type UserBoundsChangeEvent = BaseWindowEvent & {
15803
16207
  * Generated when a window's user movement becomes disabled.
15804
16208
  * @interface
15805
16209
  */
15806
- declare type UserMovementDisabledEvent = BaseWindowEvent & {
16210
+ declare type UserMovementDisabledEvent = BaseEvent_5 & {
15807
16211
  type: 'user-movement-disabled';
15808
16212
  };
15809
16213
 
@@ -15811,7 +16215,7 @@ declare type UserMovementDisabledEvent = BaseWindowEvent & {
15811
16215
  * Generated when a window's user movement becomes enabled.
15812
16216
  * @interface
15813
16217
  */
15814
- declare type UserMovementEnabledEvent = BaseWindowEvent & {
16218
+ declare type UserMovementEnabledEvent = BaseEvent_5 & {
15815
16219
  type: 'user-movement-enabled';
15816
16220
  };
15817
16221
 
@@ -16494,23 +16898,31 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
16494
16898
  bindToElement: (element: HTMLElement) => Promise<() => void>;
16495
16899
  }
16496
16900
 
16497
- declare type View_3 = OpenFin_2.View;
16498
-
16499
- declare type View_4 = OpenFin_2.View;
16500
-
16501
16901
  /**
16502
16902
  * Generated when a View is attached to a window.
16503
16903
  * @interface
16504
16904
  */
16505
- declare type ViewAttachedEvent = BaseWindowEvent & {
16905
+ declare type ViewAttachedEvent = BaseEvent_5 & {
16506
16906
  type: 'view-attached';
16507
16907
  target: OpenFin_2.Identity;
16508
16908
  viewIdentity: OpenFin_2.Identity;
16509
16909
  };
16510
16910
 
16511
- declare interface ViewComponent extends GoldenLayout.ContentItem {
16512
- componentState: OpenFin_2.ViewState;
16513
- }
16911
+ /**
16912
+ * A rule prescribing content creation in a {@link OpenFin.View}.
16913
+ *
16914
+ * @interface
16915
+ */
16916
+ declare type ViewContentCreationRule = BaseContentCreationRule & {
16917
+ /**
16918
+ * Behavior to use when opening matched content.
16919
+ */
16920
+ behavior: 'view';
16921
+ /**
16922
+ * Options for newly-created view.
16923
+ */
16924
+ options?: Partial<ViewOptions>;
16925
+ };
16514
16926
 
16515
16927
  /**
16516
16928
  * The options object required by {@link View.ViewModule.create View.create}.
@@ -16532,7 +16944,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
16532
16944
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
16533
16945
  * @interface
16534
16946
  */
16535
- declare type ViewDetachedEvent = BaseWindowEvent & {
16947
+ declare type ViewDetachedEvent = BaseEvent_5 & {
16536
16948
  type: 'view-detached';
16537
16949
  target: OpenFin_2.Identity;
16538
16950
  previousTarget: OpenFin_2.Identity;
@@ -16540,18 +16952,15 @@ declare type ViewDetachedEvent = BaseWindowEvent & {
16540
16952
  };
16541
16953
 
16542
16954
  /**
16543
- * [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
16544
- * discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
16545
- * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
16955
+ * @deprecated Renamed to {@link Event}.
16546
16956
  */
16547
- declare type ViewEvent = (WebContentsEvent<'view'> & {
16548
- target: OpenFin_2.Identity;
16549
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
16957
+ declare type ViewEvent = Event_4;
16550
16958
 
16551
16959
  declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
16552
16960
 
16553
16961
  declare namespace ViewEvents {
16554
16962
  export {
16963
+ BaseEvent_4 as BaseEvent,
16555
16964
  BaseViewEvent,
16556
16965
  TargetChangedEvent,
16557
16966
  NonPropagatedViewEvent,
@@ -16561,20 +16970,24 @@ declare namespace ViewEvents {
16561
16970
  HotkeyEvent,
16562
16971
  ShownEvent,
16563
16972
  HostContextChangedEvent,
16973
+ Event_4 as Event,
16564
16974
  ViewEvent,
16565
16975
  WillPropagateViewEvent,
16976
+ EventType,
16566
16977
  ViewEventType,
16978
+ PropagatedEvent_2 as PropagatedEvent,
16567
16979
  PropagatedViewEvent,
16980
+ PropagatedEventType_2 as PropagatedEventType,
16568
16981
  PropagatedViewEventType,
16569
- Payload_8 as Payload,
16570
- ByType_7 as ByType
16982
+ Payload_2 as Payload,
16983
+ ByType
16571
16984
  }
16572
16985
  }
16573
16986
 
16574
16987
  /**
16575
- * Union of possible `type` values for a {@link OpenFin.ViewEvents.ViewEvent}.
16988
+ * @deprecated Renamed to {@link EventType}.
16576
16989
  */
16577
- declare type ViewEventType = ViewEvent['type'];
16990
+ declare type ViewEventType = EventType;
16578
16991
 
16579
16992
  /**
16580
16993
  * @interface
@@ -16677,40 +17090,6 @@ declare class ViewModule extends Base {
16677
17090
  */
16678
17091
  declare type ViewOptions = ConstViewOptions & MutableViewOptions;
16679
17092
 
16680
- /**
16681
- * Api client allowing an empty electron BrowserView to be rendered
16682
- * in the current window with the specified bounds.
16683
- *
16684
- * Please note, only one view based overlay can be rendered at a time per runtime.
16685
- * @ignore
16686
- */
16687
- declare class ViewOverlay {
16688
- private wire;
16689
- constructor(wire: Transport);
16690
- /**
16691
- * Sets the style of the root <html> element of the view overlay webcontent.
16692
- * @param style A partial collection of Css style declarations to set.
16693
- */
16694
- setStyle: (style: Partial<CSSStyleDeclaration>) => Promise<void>;
16695
- /**
16696
- * Renders the overlay at the specified position relative to the calling window.
16697
- * @param options Bounds and background color to display in the overlay.
16698
- */
16699
- renderOverlay: (bounds: OpenFin_2.Bounds) => Promise<void>;
16700
- /**
16701
- * Removes the overlay from the current window.
16702
- */
16703
- detachOverlay: () => Promise<void>;
16704
- /**
16705
- * Allows setting all OpenFin views to ignore or consume mouse events.
16706
- *
16707
- * This can help with the rendering of view overlays that depend on OpenFin views not consuming mouse events.
16708
- *
16709
- * @param enabled If true, all mouse events are ignored by openfin views. If false, all OpenFin views will consume mouse events.
16710
- */
16711
- setIgnoreViewMouseEvents(enabled: boolean): Promise<void>;
16712
- }
16713
-
16714
17093
  /**
16715
17094
  * Represents the payload shape for Views that are trying to prevent an unload.
16716
17095
  * @interface
@@ -17747,12 +18126,9 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17747
18126
  }
17748
18127
 
17749
18128
  /**
17750
- * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
17751
- * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
18129
+ * @deprecated Renamed to {@link Event}.
17752
18130
  */
17753
- declare type WebContentsEvent<Topic extends string> = {
17754
- topic: Topic;
17755
- } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
18131
+ declare type WebContentsEvent<Topic extends string> = Event_5<Topic>;
17756
18132
 
17757
18133
  declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
17758
18134
 
@@ -17764,6 +18140,7 @@ declare namespace WebContentsEvents {
17764
18140
  CrashedEvent_2 as CrashedEvent,
17765
18141
  CertificateErrorEvent,
17766
18142
  CertificateSelectionShownEvent,
18143
+ PageFaviconUpdatedEvent,
17767
18144
  FaviconUpdatedEvent,
17768
18145
  NavigationRejectedEvent,
17769
18146
  UrlChangedEvent,
@@ -17782,6 +18159,7 @@ declare namespace WebContentsEvents {
17782
18159
  FileDownloadStartedEvent,
17783
18160
  FileDownloadProgressEvent,
17784
18161
  FileDownloadCompletedEvent,
18162
+ Event_5 as Event,
17785
18163
  WebContentsEvent,
17786
18164
  WillPropagateWebContentsEvent,
17787
18165
  NonPropagatedWebContentsEvent
@@ -17814,6 +18192,8 @@ declare type WebRequestHeader = {
17814
18192
  [key: string]: string;
17815
18193
  };
17816
18194
 
18195
+ declare type WebSocketReadyState = WebSocket['readyState'];
18196
+
17817
18197
  /**
17818
18198
  * Generated when a window is being moved by the user.
17819
18199
  * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
@@ -17827,7 +18207,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
17827
18207
  * A general will-move or will-resize event without event type.
17828
18208
  * @interface
17829
18209
  */
17830
- declare type WillMoveOrResizeEvent = BaseWindowEvent & {
18210
+ declare type WillMoveOrResizeEvent = BaseEvent_5 & {
17831
18211
  height: number;
17832
18212
  left: number;
17833
18213
  top: number;
@@ -17849,7 +18229,7 @@ declare type WillPropagateViewEvent = ViewEvent;
17849
18229
  *
17850
18230
  * A WebContents event that does propagate to (republish on) parent topics.
17851
18231
  */
17852
- declare type WillPropagateWebContentsEvent = WebContentsEvent<string>;
18232
+ declare type WillPropagateWebContentsEvent = Event_5<string>;
17853
18233
 
17854
18234
  /**
17855
18235
  * @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
@@ -17863,7 +18243,7 @@ declare type WillPropagateWindowEvent = WindowSourcedEvent;
17863
18243
  * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
17864
18244
  * @interface
17865
18245
  */
17866
- declare type WillRedirectEvent = BaseWindowEvent & {
18246
+ declare type WillRedirectEvent = BaseEvent_5 & {
17867
18247
  type: 'will-redirect';
17868
18248
  blocked: boolean;
17869
18249
  isInPlace: boolean;
@@ -18784,7 +19164,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18784
19164
  * ```
18785
19165
  * @experimental
18786
19166
  */
18787
- getLayout(): Promise<OpenFin_2.Layout>;
19167
+ getLayout(layoutIdentity?: OpenFin_2.LayoutIdentity): Promise<OpenFin_2.Layout>;
18788
19168
  /**
18789
19169
  * Gets the current settings of the window.
18790
19170
  *
@@ -19502,28 +19882,34 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19502
19882
  };
19503
19883
 
19504
19884
  /**
19505
- * Generated when a window has closed.
19506
- * @interface
19885
+ * @deprecated Renamed to {@link ClosedEvent}.
19507
19886
  */
19508
- declare type WindowClosedEvent = BaseWindowEvent & {
19509
- type: 'closed';
19510
- };
19887
+ declare type WindowClosedEvent = ClosedEvent_2;
19511
19888
 
19512
19889
  /**
19513
- * Generated when a window has been prevented from closing.
19514
- * @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.
19515
- * @interface
19890
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
19516
19891
  */
19517
- declare type WindowCloseRequestedEvent = BaseWindowEvent & {
19518
- type: 'close-requested';
19519
- };
19892
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
19893
+
19894
+ /**
19895
+ * @deprecated Renamed to {@link ClosingEvent}.
19896
+ */
19897
+ declare type WindowClosingEvent = ClosingEvent;
19520
19898
 
19521
19899
  /**
19522
- * Generated when a window has initiated the closing routine.
19900
+ * A rule prescribing content creation in a {@link OpenFin.Window}.
19901
+ *
19523
19902
  * @interface
19524
19903
  */
19525
- declare type WindowClosingEvent = BaseWindowEvent & {
19526
- type: 'closing';
19904
+ declare type WindowContentCreationRule = BaseContentCreationRule & {
19905
+ /**
19906
+ * Behavior to use when opening matched content.
19907
+ */
19908
+ behavior: 'window';
19909
+ /**
19910
+ * Options for newly-created window.
19911
+ */
19912
+ options?: Partial<WindowOptions>;
19527
19913
  };
19528
19914
 
19529
19915
  /**
@@ -19592,16 +19978,15 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19592
19978
  };
19593
19979
 
19594
19980
  /**
19595
- * [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
19596
- * discriminated by {@link WindowEvent.type | their type}. Event payloads unique to `Window` can be found
19597
- * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
19981
+ * @deprecated, Renamed to {@link Event}.
19598
19982
  */
19599
- declare type WindowEvent = WindowSourcedEvent | PropagatedViewEvent<'window'>;
19983
+ declare type WindowEvent = Event_6;
19600
19984
 
19601
19985
  declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
19602
19986
 
19603
19987
  declare namespace WindowEvents {
19604
19988
  export {
19989
+ BaseEvent_5 as BaseEvent,
19605
19990
  BaseWindowEvent,
19606
19991
  ViewAttachedEvent,
19607
19992
  ViewDetachedEvent,
@@ -19611,9 +19996,11 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19611
19996
  EndLoadEvent,
19612
19997
  WillRedirectEvent,
19613
19998
  ReloadedEvent,
19999
+ OptionsChangedEvent,
19614
20000
  WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
19615
20001
  ExternalProcessExitedEvent,
19616
20002
  ExternalProcessStartedEvent,
20003
+ HiddenEvent_2 as HiddenEvent,
19617
20004
  WindowHiddenEvent,
19618
20005
  PreloadScriptInfoRunning,
19619
20006
  PreloadScriptInfo,
@@ -19628,61 +20015,66 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19628
20015
  BeginUserBoundsChangingEvent,
19629
20016
  BoundsChangedEvent,
19630
20017
  BoundsChangingEvent,
20018
+ CloseRequestedEvent,
19631
20019
  WindowCloseRequestedEvent,
19632
20020
  ContextChangedEvent,
20021
+ ClosedEvent_2 as ClosedEvent,
19633
20022
  WindowClosedEvent,
20023
+ ClosingEvent,
19634
20024
  WindowClosingEvent,
19635
20025
  DisabledMovementBoundsChangedEvent,
19636
20026
  DisabledMovementBoundsChangingEvent,
19637
20027
  EmbeddedEvent,
19638
20028
  EndUserBoundsChangingEvent,
20029
+ HotkeyEvent_2 as HotkeyEvent,
19639
20030
  WindowHotkeyEvent,
20031
+ InitializedEvent_2 as InitializedEvent,
19640
20032
  WindowInitializedEvent,
19641
20033
  MaximizedEvent,
19642
20034
  MinimizedEvent,
19643
20035
  PreloadScriptsStateChangedEvent,
19644
20036
  PreloadScriptsStateChangingEvent,
20037
+ RestoredEvent,
19645
20038
  WindowRestoredEvent,
20039
+ ShowRequestedEvent,
19646
20040
  WindowShowRequestedEvent,
20041
+ ShownEvent_2 as ShownEvent,
19647
20042
  WindowShownEvent,
19648
20043
  UserMovementEnabledEvent,
19649
20044
  UserMovementDisabledEvent,
19650
20045
  WillMoveEvent,
19651
20046
  WillResizeEvent,
19652
20047
  NonPropagatedWindowEvent,
20048
+ ShowAllDownloadsEvent,
20049
+ DownloadShelfVisibilityChangedEvent,
19653
20050
  WindowSourcedEvent,
19654
20051
  WillPropagateWindowEvent,
20052
+ Event_6 as Event,
19655
20053
  WindowEvent,
20054
+ EventType_2 as EventType,
19656
20055
  WindowEventType,
20056
+ PropagatedEvent_3 as PropagatedEvent,
19657
20057
  PropagatedWindowEvent,
19658
20058
  PropagatedWindowEventType,
19659
- Payload_9 as Payload,
19660
- ByType_8 as ByType
20059
+ Payload_3 as Payload,
20060
+ ByType_2 as ByType
19661
20061
  }
19662
20062
  }
19663
20063
 
19664
20064
  /**
19665
- * Union of possible `type` values for a {@link OpenFin.WindowEvents.WindowEvent}.
20065
+ * @deprecated Renamed to {@link EventType}.
19666
20066
  */
19667
20067
  declare type WindowEventType = WindowEvent['type'];
19668
20068
 
19669
20069
  /**
19670
- * Generated when a window has been hidden.
19671
- * @interface
20070
+ * @deprecated Renamed to {@link HiddenEvent}.
19672
20071
  */
19673
- declare type WindowHiddenEvent = BaseWindowEvent & {
19674
- type: 'hidden';
19675
- reason: 'closing' | 'hide' | 'hide-on-close';
19676
- };
20072
+ declare type WindowHiddenEvent = HiddenEvent_2;
19677
20073
 
19678
20074
  /**
19679
- * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
19680
- * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
19681
- * @interface
20075
+ * @deprecated Renamed to {@link HotkeyEvent}.
19682
20076
  */
19683
- declare type WindowHotkeyEvent = InputEvent_2 & BaseWindowEvent & {
19684
- type: 'hotkey';
19685
- };
20077
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
19686
20078
 
19687
20079
  /**
19688
20080
  * @interface
@@ -19696,12 +20088,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19696
20088
  };
19697
20089
 
19698
20090
  /**
19699
- * Generated when a window is initialized.
19700
- * @interface
20091
+ * @deprecated Renamed to {@link InitializedEvent}.
19701
20092
  */
19702
- declare type WindowInitializedEvent = BaseWindowEvent & {
19703
- type: 'initialized';
19704
- };
20093
+ declare type WindowInitializedEvent = InitializedEvent_2;
19705
20094
 
19706
20095
  /**
19707
20096
  * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
@@ -19820,15 +20209,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19820
20209
  declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
19821
20210
 
19822
20211
  /**
19823
- * Generated after window options are changed using the window.updateOptions method.
19824
- * @remarks Will not fire if the diff object is empty.
19825
- * @interface
20212
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
19826
20213
  */
19827
- declare type WindowOptionsChangedEvent_2 = BaseWindowEvent & {
19828
- type: 'options-changed';
19829
- options: OpenFin_2.WindowOptions;
19830
- diff: OpenFin_2.WindowOptionDiff;
19831
- };
20214
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
19832
20215
 
19833
20216
  declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
19834
20217
 
@@ -19841,35 +20224,25 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19841
20224
  };
19842
20225
 
19843
20226
  /**
19844
- * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
19845
- * @interface
20227
+ * @deprecated Renamed to {@link RestoredEvent}.
19846
20228
  */
19847
- declare type WindowRestoredEvent = BaseWindowEvent & {
19848
- type: 'restored';
19849
- };
20229
+ declare type WindowRestoredEvent = RestoredEvent;
19850
20230
 
19851
20231
  /**
19852
- * Generated when a hidden window has been shown.
19853
- * @interface
20232
+ * @deprecated Renamed to {@link ShownEvent}.
19854
20233
  */
19855
- declare type WindowShownEvent = BaseWindowEvent & {
19856
- type: 'shown';
19857
- };
20234
+ declare type WindowShownEvent = ShownEvent_2;
19858
20235
 
19859
20236
  /**
19860
- * Generated when a window has been prevented from showing.
19861
- * @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.
19862
- * @interface
20237
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
19863
20238
  */
19864
- declare type WindowShowRequestedEvent = BaseWindowEvent & {
19865
- type: 'show-requested';
19866
- };
20239
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
19867
20240
 
19868
20241
  /**
19869
20242
  * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19870
20243
  * from {@link OpenFin.ViewEvents}.
19871
20244
  */
19872
- 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;
20245
+ declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillRedirectEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
19873
20246
 
19874
20247
  /**
19875
20248
  * Generated when a child window starts loading.
@@ -19901,7 +20274,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19901
20274
  };
19902
20275
 
19903
20276
  declare type Wire = EventEmitter & {
19904
- connect(address: string, WsConstructor: typeof WebSocket): Promise<any>;
20277
+ connect(messageReciever: MessageReceiver): Promise<any>;
19905
20278
  connectSync(): any;
19906
20279
  send(data: any): Promise<any>;
19907
20280
  shutdown(): Promise<void>;