@openfin/node-adapter 34.78.50 → 34.78.52

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,3 @@
1
- /// <reference types="jquery" />
2
1
  /// <reference types="node" />
3
2
 
4
3
  import { EventEmitter } from 'events';
@@ -43,15 +42,6 @@ declare type Accelerator = {
43
42
  zoom: boolean;
44
43
  };
45
44
 
46
- /**
47
- * @interface
48
- */
49
- declare type AddLayoutInstanceOptions = {
50
- container: HTMLDivElement;
51
- layoutName: string;
52
- layout: LayoutOptions;
53
- };
54
-
55
45
  /**
56
46
  * @interface
57
47
  */
@@ -74,7 +64,7 @@ declare type AddViewToStackOptions = {
74
64
  * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
75
65
  * @interface
76
66
  */
77
- declare type AlertRequestedEvent = BaseWindowEvent & {
67
+ declare type AlertRequestedEvent = BaseEvent_5 & {
78
68
  type: 'alert-requested';
79
69
  message: string;
80
70
  url: string;
@@ -115,6 +105,15 @@ declare type ApiClient<T extends Record<any, any>> = {
115
105
  [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
116
106
  };
117
107
 
108
+ /**
109
+ * Generated when a new Platform's API becomes responsive.
110
+ * @interface
111
+ */
112
+ declare type ApiReadyEvent = BaseEvent & {
113
+ topic: 'application';
114
+ type: 'platform-api-ready';
115
+ };
116
+
118
117
  /**
119
118
  * @interface
120
119
  */
@@ -866,19 +865,15 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
866
865
  }
867
866
 
868
867
  /**
869
- * Generated when an application has authenticated and is connected.
870
- * @interface
868
+ * @deprecated Renamed to {@link ConnectedEvent}.
871
869
  */
872
- declare type ApplicationConnectedEvent = IdentityEvent & {
873
- topic: 'application';
874
- type: 'connected';
875
- };
870
+ declare type ApplicationConnectedEvent = ConnectedEvent_2;
876
871
 
877
872
  /**
878
873
  * Generated when an application is created.
879
874
  * @interface
880
875
  */
881
- declare type ApplicationCreatedEvent = BaseSystemEvent & IdentityEvent & {
876
+ declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
882
877
  type: 'application-created';
883
878
  };
884
879
 
@@ -902,17 +897,15 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
902
897
  };
903
898
 
904
899
  /**
905
- * [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
906
- * discriminated by {@link ApplicationEvent.type | their type}. Event payloads unique to `Application` can be found
907
- * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
908
- * from which they propagate).
900
+ * @deprecated Renamed to {@link Event}.
909
901
  */
910
- declare type ApplicationEvent = PropagatedViewEvent<'application'> | PropagatedWindowEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
902
+ declare type ApplicationEvent = Event_3;
911
903
 
912
904
  declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
913
905
 
914
906
  declare namespace ApplicationEvents {
915
907
  export {
908
+ BaseEvent_3 as BaseEvent,
916
909
  BaseApplicationEvent,
917
910
  CrashedEvent,
918
911
  FileDownloadLocationChangedEvent,
@@ -925,7 +918,9 @@ declare namespace ApplicationEvents {
925
918
  WindowRespondingEvent,
926
919
  WindowStartLoadEvent,
927
920
  ApplicationWindowEvent,
921
+ ApplicationWindowEventTypes,
928
922
  ClosedEvent,
923
+ ConnectedEvent_2 as ConnectedEvent,
929
924
  ApplicationConnectedEvent,
930
925
  InitializedEvent,
931
926
  ManifestChangedEvent,
@@ -933,19 +928,23 @@ declare namespace ApplicationEvents {
933
928
  RespondingEvent,
934
929
  StartedEvent,
935
930
  ApplicationSourcedEvent,
931
+ Event_3 as Event,
936
932
  ApplicationEvent,
933
+ EventType_3 as EventType,
937
934
  ApplicationEventType,
935
+ PropagatedEvent_4 as PropagatedEvent,
938
936
  PropagatedApplicationEvent,
937
+ PropagatedEventType_3 as PropagatedEventType,
939
938
  PropagatedApplicationEventType,
940
- Payload_2 as Payload,
941
- ByType
939
+ Payload_4 as Payload,
940
+ ByType_3 as ByType
942
941
  }
943
942
  }
944
943
 
945
944
  /**
946
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
945
+ * @deprecated Renamed to {@link EventType}.
947
946
  */
948
- declare type ApplicationEventType = ApplicationEvent['type'];
947
+ declare type ApplicationEventType = EventType_3;
949
948
 
950
949
  declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
951
950
 
@@ -1298,9 +1297,8 @@ declare type ApplicationPermissions = {
1298
1297
  * A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
1299
1298
  * from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
1300
1299
  * does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
1301
- *
1302
1300
  */
1303
- declare type ApplicationSourcedEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1301
+ declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1304
1302
 
1305
1303
  declare type ApplicationState = OpenFin.ApplicationState;
1306
1304
 
@@ -1339,6 +1337,11 @@ declare type ApplicationType = {
1339
1337
  */
1340
1338
  declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedEvent | WindowEndLoadEvent | WindowNotRespondingEvent | WindowRespondingEvent | WindowStartLoadEvent;
1341
1339
 
1340
+ /**
1341
+ * Array of valid `type` values for an {@link ApplicationWindowEvent}.
1342
+ */
1343
+ declare const ApplicationWindowEventTypes: readonly ["window-alert-requested", "window-created", "window-end-load", "window-not-responding", "window-responding", "window-start-load"];
1344
+
1342
1345
  declare type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
1343
1346
 
1344
1347
  /**
@@ -1608,7 +1611,7 @@ declare interface AuthorizationPayload {
1608
1611
  * ```
1609
1612
  * @interface
1610
1613
  */
1611
- declare type AuthRequestedEvent = BaseWindowEvent & {
1614
+ declare type AuthRequestedEvent = BaseEvent_5 & {
1612
1615
  type: 'auth-requested';
1613
1616
  authInfo: {
1614
1617
  host: string;
@@ -1670,21 +1673,9 @@ declare class Base {
1670
1673
  }
1671
1674
 
1672
1675
  /**
1673
- * Base type for events emitting on the `application` topic
1674
- * @interface
1675
- */
1676
- declare type BaseApplicationEvent = NamedEvent & {
1677
- topic: `application`;
1678
- };
1679
-
1680
- /**
1681
- * A base Channel event.
1682
- * @interface
1676
+ * @deprecated Renamed to {@link BaseEvent}.
1683
1677
  */
1684
- declare type BaseChannelEvent = NamedEvent & {
1685
- channelName: string;
1686
- channelId: string;
1687
- };
1678
+ declare type BaseApplicationEvent = BaseEvent_3;
1688
1679
 
1689
1680
  /**
1690
1681
  * @interface
@@ -1726,6 +1717,23 @@ declare type BaseConfig = {
1726
1717
  timeout?: number;
1727
1718
  };
1728
1719
 
1720
+ /**
1721
+ * Properties shared by all content creation rules, regardless of context.
1722
+ *
1723
+ * @interface
1724
+ */
1725
+ declare type BaseContentCreationRule = {
1726
+ /**
1727
+ * List of [match patterns](https://developer.chrome.com/extensions/match_patterns) that indicate the specified
1728
+ * behavior should be used
1729
+ */
1730
+ match: MatchPattern[];
1731
+ /**
1732
+ * custom property
1733
+ */
1734
+ data?: unknown;
1735
+ };
1736
+
1729
1737
  /**
1730
1738
  * A base OpenFin event. All OpenFin event payloads extend this type.
1731
1739
  *
@@ -1736,10 +1744,70 @@ declare type BaseEvent = {
1736
1744
  type: string;
1737
1745
  };
1738
1746
 
1739
- declare type BaseEvent_2 = Events.BaseEvents.BaseEvent;
1747
+ /**
1748
+ * A base Channel event.
1749
+ * @interface
1750
+ */
1751
+ declare type BaseEvent_2 = NamedEvent & {
1752
+ channelName: string;
1753
+ channelId: string;
1754
+ };
1755
+
1756
+ /**
1757
+ * Base type for events emitting on the `application` topic
1758
+ * @interface
1759
+ */
1760
+ declare type BaseEvent_3 = BaseEvents.NamedEvent & {
1761
+ topic: `application`;
1762
+ };
1763
+
1764
+ /**
1765
+ * Base type for events emitting on the `view` topic
1766
+ * @interface
1767
+ */
1768
+ declare type BaseEvent_4 = BaseEvents.NamedEvent & {
1769
+ topic: 'view';
1770
+ target: OpenFin.Identity;
1771
+ };
1772
+
1773
+ /**
1774
+ * Base type for events emitting on the `window` topic
1775
+ * @interface
1776
+ */
1777
+ declare type BaseEvent_5 = BaseEvents.NamedEvent & {
1778
+ topic: 'window';
1779
+ };
1780
+
1781
+ /**
1782
+ * Base type for events emitting on the `externalapplication` topic
1783
+ * @interface
1784
+ */
1785
+ declare type BaseEvent_6 = BaseEvents.BaseEvent & {
1786
+ topic: 'externalapplication';
1787
+ };
1788
+
1789
+ /**
1790
+ * The base frame event.
1791
+ * @interface
1792
+ */
1793
+ declare type BaseEvent_7 = NamedEvent & {
1794
+ entityType: 'iframe';
1795
+ frameName: string;
1796
+ };
1797
+
1798
+ /**
1799
+ * Base type for events emitting on the `system` topic
1800
+ * @interface
1801
+ */
1802
+ declare type BaseEvent_8 = BaseEvents.BaseEvent & {
1803
+ topic: 'system';
1804
+ };
1805
+
1806
+ declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
1740
1807
 
1741
1808
  declare namespace BaseEvents {
1742
1809
  export {
1810
+ NotCloseRequested,
1743
1811
  PropagatedEventType,
1744
1812
  PropagatedEvent,
1745
1813
  EventHandler,
@@ -1750,21 +1818,14 @@ declare namespace BaseEvents {
1750
1818
  }
1751
1819
 
1752
1820
  /**
1753
- * Base type for events emitting on the `externalapplication` topic
1754
- * @interface
1821
+ * @deprecated Renamed to {@link BaseEvent}.
1755
1822
  */
1756
- declare type BaseExternalApplicationEvent = BaseEvent & {
1757
- topic: 'externalapplication';
1758
- };
1823
+ declare type BaseExternalApplicationEvent = BaseEvent_6;
1759
1824
 
1760
1825
  /**
1761
- * The base frame event.
1762
- * @interface
1826
+ * @deprecated Renamed to {@link BaseEvent}.
1763
1827
  */
1764
- declare type BaseFrameEvent = NamedEvent & {
1765
- entityType: 'iframe';
1766
- frameName: string;
1767
- };
1828
+ declare type BaseFrameEvent = BaseEvent_7;
1768
1829
 
1769
1830
  declare type BaseLoadFailedEvent = NamedEvent & {
1770
1831
  errorCode: number;
@@ -1773,35 +1834,20 @@ declare type BaseLoadFailedEvent = NamedEvent & {
1773
1834
  isMainFrame: boolean;
1774
1835
  };
1775
1836
 
1776
- /**
1777
- * Base type for events emitting on the `system` topic
1778
- * @interface
1779
- */
1780
- declare type BaseSystemEvent = BaseEvent & {
1781
- topic: 'system';
1782
- };
1783
-
1784
1837
  declare type BaseUrlEvent = NamedEvent & {
1785
1838
  type: 'url-changed';
1786
1839
  url: string;
1787
1840
  };
1788
1841
 
1789
1842
  /**
1790
- * Base type for events emitting on the `view` topic
1791
- * @interface
1843
+ * @deprecated Renamed to {@link BaseEvent}.
1792
1844
  */
1793
- declare type BaseViewEvent = NamedEvent & {
1794
- topic: 'view';
1795
- target: OpenFin.Identity;
1796
- };
1845
+ declare type BaseViewEvent = BaseEvent_4;
1797
1846
 
1798
1847
  /**
1799
- * Base type for events emitting on the `window` topic
1800
- * @interface
1848
+ * @deprecated Renamed to {@link BaseEvent}.
1801
1849
  */
1802
- declare type BaseWindowEvent = NamedEvent & {
1803
- topic: 'window';
1804
- };
1850
+ declare type BaseWindowEvent = BaseEvent_5;
1805
1851
 
1806
1852
  /**
1807
1853
  * User decision of whether a Window or specific View should close when trying to prevent an unload.
@@ -1826,6 +1872,18 @@ declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
1826
1872
  type: 'begin-user-bounds-changing';
1827
1873
  };
1828
1874
 
1875
+ /**
1876
+ * A rule prescribing content creation that should be blocked.
1877
+ *
1878
+ * @interface
1879
+ */
1880
+ declare type BlockedContentCreationRule = BaseContentCreationRule & {
1881
+ /**
1882
+ * Behavior to use when opening matched content.
1883
+ */
1884
+ behavior: 'block';
1885
+ };
1886
+
1829
1887
  /**
1830
1888
  * Generated when a WebContents loses focus.
1831
1889
  * @interface
@@ -1856,7 +1914,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
1856
1914
  * A general bounds change event without event type.
1857
1915
  * @interface
1858
1916
  */
1859
- declare type BoundsChangeEvent = BaseWindowEvent & {
1917
+ declare type BoundsChangeEvent = BaseEvent_5 & {
1860
1918
  changeType: 0 | 1 | 2;
1861
1919
  deferred: boolean;
1862
1920
  height: number;
@@ -1873,6 +1931,18 @@ declare type BoundsChangingEvent = BoundsChangeEvent & {
1873
1931
  type: 'bounds-changing';
1874
1932
  };
1875
1933
 
1934
+ /**
1935
+ * A rule prescribing content creation in the browser.
1936
+ *
1937
+ * @interface
1938
+ */
1939
+ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1940
+ /**
1941
+ * Behavior to use when opening matched content.
1942
+ */
1943
+ behavior: 'browser';
1944
+ };
1945
+
1876
1946
  declare interface BrowserWindow {
1877
1947
  /**
1878
1948
  * True if the window has been opened and its GoldenLayout instance initialised.
@@ -1916,76 +1986,76 @@ declare interface BrowserWindow {
1916
1986
  }
1917
1987
 
1918
1988
  /**
1919
- * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
1989
+ * Extracts a single event type matching the given key from the View {@link Event} union.
1920
1990
  *
1921
1991
  * Alias for {@link Payload}, which may read better in source.
1922
1992
  *
1923
1993
  * @typeParam Type String key specifying the event to extract
1924
1994
  */
1925
- declare type ByType<Type extends ApplicationEventType> = Payload_2<Type>;
1995
+ declare type ByType<Type extends EventType> = Payload_2<Type>;
1926
1996
 
1927
1997
  /**
1928
- * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
1998
+ * Extracts a single event type matching the given key from the Window {@link Event} union.
1929
1999
  *
1930
2000
  * Alias for {@link Payload}, which may read better in source.
1931
2001
  *
1932
2002
  * @typeParam Type String key specifying the event to extract
1933
2003
  */
1934
- declare type ByType_2<Type extends ExternalApplicationEventType> = Payload_3<Type>;
2004
+ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
1935
2005
 
1936
2006
  /**
1937
- * Extracts a single event type matching the given key from the {@link FrameEvent} union.
2007
+ * Extracts a single event type matching the given key from the Application {@link Event} union.
1938
2008
  *
1939
2009
  * Alias for {@link Payload}, which may read better in source.
1940
2010
  *
1941
2011
  * @typeParam Type String key specifying the event to extract
1942
2012
  */
1943
- declare type ByType_3<Type extends FrameEventType> = Payload_4<Type>;
2013
+ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
1944
2014
 
1945
2015
  /**
1946
- * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
2016
+ * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
1947
2017
  *
1948
2018
  * Alias for {@link Payload}, which may read better in source.
1949
2019
  *
1950
2020
  * @typeParam Type String key specifying the event to extract
1951
2021
  */
1952
- declare type ByType_4<Type extends GlobalHotkeyEventType> = Payload_5<Type>;
2022
+ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
1953
2023
 
1954
2024
  /**
1955
- * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
2025
+ * Extracts a single event type matching the given key from the Frame {@link Event} union.
1956
2026
  *
1957
2027
  * Alias for {@link Payload}, which may read better in source.
1958
2028
  *
1959
2029
  * @typeParam Type String key specifying the event to extract
1960
2030
  */
1961
- declare type ByType_5<Type extends PlatformEventType> = Payload_6<Type>;
2031
+ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
1962
2032
 
1963
2033
  /**
1964
- * Extracts a single event type matching the given key from the {@link SystemEvent} union.
2034
+ * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
1965
2035
  *
1966
2036
  * Alias for {@link Payload}, which may read better in source.
1967
2037
  *
1968
2038
  * @typeParam Type String key specifying the event to extract
1969
2039
  */
1970
- declare type ByType_6<Type extends SystemEventType> = Payload_7<Type>;
2040
+ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
1971
2041
 
1972
2042
  /**
1973
- * Extracts a single event type matching the given key from the {@link ViewEvent} union.
2043
+ * Extracts a single event type matching the given key from the Platform {@link Event} union.
1974
2044
  *
1975
2045
  * Alias for {@link Payload}, which may read better in source.
1976
2046
  *
1977
2047
  * @typeParam Type String key specifying the event to extract
1978
2048
  */
1979
- declare type ByType_7<Type extends ViewEventType> = Payload_8<Type>;
2049
+ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
1980
2050
 
1981
2051
  /**
1982
- * Extracts a single event type matching the given key from the {@link WindowEvent} union.
2052
+ * Extracts a single event type matching the given key from the System {@link Event} union.
1983
2053
  *
1984
2054
  * Alias for {@link Payload}, which may read better in source.
1985
2055
  *
1986
2056
  * @typeParam Type String key specifying the event to extract
1987
2057
  */
1988
- declare type ByType_8<Type extends WindowEventType> = Payload_9<Type>;
2058
+ declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
1989
2059
 
1990
2060
  /**
1991
2061
  * Configuration for page capture.
@@ -2651,14 +2721,6 @@ declare type ChannelClientConnectionListener = (identity: ClientIdentity, connec
2651
2721
 
2652
2722
  declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
2653
2723
 
2654
- /**
2655
- * Generated when a Channel client is connected.
2656
- * @interface
2657
- */
2658
- declare type ChannelConnectedEvent = BaseChannelEvent & {
2659
- type: 'connected';
2660
- };
2661
-
2662
2724
  /**
2663
2725
  * Options provided on a client connection to a channel.
2664
2726
  *
@@ -2690,21 +2752,9 @@ declare type ChannelCreateOptions = {
2690
2752
  };
2691
2753
 
2692
2754
  /**
2693
- * Generated when a Channel client has disconnected.
2694
- * @interface
2695
- */
2696
- declare type ChannelDisconnectedEvent = BaseChannelEvent & {
2697
- type: 'disconnected';
2698
- };
2699
-
2700
- /**
2701
- * [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
2702
- * discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
2703
- * under the {@link OpenFin.ChannelEvents} namespace.
2755
+ * @deprecated Renamed to {@link Event}.
2704
2756
  */
2705
- declare type ChannelEvent = {
2706
- topic: 'channel';
2707
- } & (ChannelConnectedEvent | ChannelDisconnectedEvent);
2757
+ declare type ChannelEvent = Event_2;
2708
2758
 
2709
2759
  declare type ChannelMiddleware = OpenFin.ChannelMiddleware;
2710
2760
 
@@ -2972,7 +3022,7 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
2972
3022
  private messageReceiver;
2973
3023
  private endpointId;
2974
3024
  private providerIdentity;
2975
- constructor(wire: Transport, messageReceiver: MessageReceiver, endpointId: string, // Provider endpointId is channelId
3025
+ constructor(wire: Transport, messageReceiver: MessageReceiver_2, endpointId: string, // Provider endpointId is channelId
2976
3026
  providerIdentity: ProviderIdentity_4);
2977
3027
  onEndpointDisconnect(endpointId: string, listener: () => void): void;
2978
3028
  receive(listener: (action: string, payload: any, identity: OpenFin.ClientIdentity | OpenFin.ClientIdentityMultiRuntime | ProviderIdentity_4) => Promise<any>): void;
@@ -3239,11 +3289,19 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
3239
3289
  * Generated when an application is closed.
3240
3290
  * @interface
3241
3291
  */
3242
- declare type ClosedEvent = IdentityEvent & {
3292
+ declare type ClosedEvent = BaseEvents.IdentityEvent & {
3243
3293
  topic: 'application';
3244
3294
  type: 'closed';
3245
3295
  };
3246
3296
 
3297
+ /**
3298
+ * Generated when a window has closed.
3299
+ * @interface
3300
+ */
3301
+ declare type ClosedEvent_2 = BaseEvent_5 & {
3302
+ type: 'closed';
3303
+ };
3304
+
3247
3305
  /**
3248
3306
  * @interface
3249
3307
  */
@@ -3251,6 +3309,25 @@ declare type ClosedMenuResult = {
3251
3309
  result: 'closed';
3252
3310
  };
3253
3311
 
3312
+ /**
3313
+ * Generated when a window has been prevented from closing.
3314
+ * @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.
3315
+ * @interface
3316
+ */
3317
+ declare type CloseRequestedEvent = BaseEvent_5 & {
3318
+ type: 'close-requested';
3319
+ };
3320
+
3321
+ /**
3322
+ * @interface
3323
+ */
3324
+ declare type CloseViewOptions = {
3325
+ /**
3326
+ *View to be closed.
3327
+ */
3328
+ viewIdentity: Identity_5;
3329
+ };
3330
+
3254
3331
  /**
3255
3332
  * @interface
3256
3333
  */
@@ -3259,6 +3336,11 @@ declare type CloseViewPayload = {
3259
3336
  *View to be closed.
3260
3337
  */
3261
3338
  view: Identity_5;
3339
+ /**
3340
+ * The target layout identity where this view should be closed. If not provided, will resolve to the
3341
+ * visible layout.
3342
+ */
3343
+ target?: LayoutIdentity;
3262
3344
  };
3263
3345
 
3264
3346
  /**
@@ -3282,6 +3364,14 @@ declare interface CloseWindowPayload {
3282
3364
  };
3283
3365
  }
3284
3366
 
3367
+ /**
3368
+ * Generated when a window has initiated the closing routine.
3369
+ * @interface
3370
+ */
3371
+ declare type ClosingEvent = BaseEvent_5 & {
3372
+ type: 'closing';
3373
+ };
3374
+
3285
3375
  /**
3286
3376
  * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
3287
3377
  */
@@ -3365,6 +3455,39 @@ export declare function connect(config: ConnectConfig): Promise<Fin<'external co
3365
3455
 
3366
3456
  declare type ConnectConfig = ExistingConnectConfig | NewConnectConfig | ExternalConfig;
3367
3457
 
3458
+ /**
3459
+ * Generated when a Channel client is connected.
3460
+ * @interface
3461
+ */
3462
+ declare type ConnectedEvent = BaseEvent_2 & {
3463
+ type: 'connected';
3464
+ };
3465
+
3466
+ /**
3467
+ * Generated when an application has authenticated and is connected.
3468
+ * @interface
3469
+ */
3470
+ declare type ConnectedEvent_2 = BaseEvents.IdentityEvent & {
3471
+ topic: 'application';
3472
+ type: 'connected';
3473
+ };
3474
+
3475
+ /**
3476
+ * Generated when an external application has authenticated and is connected.
3477
+ * @interface
3478
+ */
3479
+ declare type ConnectedEvent_3 = BaseExternalApplicationEvent & {
3480
+ type: 'connected';
3481
+ };
3482
+
3483
+ /**
3484
+ * Generated when a frame is connected.
3485
+ * @interface
3486
+ */
3487
+ declare type ConnectedEvent_4 = BaseFrameEvent & {
3488
+ type: 'connected';
3489
+ };
3490
+
3368
3491
  declare type Constructor<T = {}> = new () => T;
3369
3492
 
3370
3493
  declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
@@ -3444,12 +3567,23 @@ declare type ConstViewOptions = {
3444
3567
  /**
3445
3568
  * **Platforms Only.**
3446
3569
  * Determines what happens when a view is closed in a platform window.
3447
- * Supersedes `detachOnClose`, but has no default value.
3570
+ * Supersedes the deprecated `detachOnClose`.
3571
+ * If not set, detaults to `destroy` if `detachOnClose` is false (default), or `detach` if `detachOnClose` is true.
3572
+ * While this option is not updateable, it may change at runtime if `detachOnClose` is updated.
3448
3573
  * 'hide' hides the view on the platform window that closed it.
3449
- * 'detach' behaves like 'detachOnClose': true.
3450
- * 'destroy' is the default behavior as long as 'detachOnClose' is not set.
3574
+ * 'detach' behaves like 'detachOnClose': true. It attaches the closed view to the platform provider.
3575
+ * 'destroy' is the default behavior as long as 'detachOnClose' is not set. It destroys the view.
3451
3576
  */
3452
- closeBehavior?: 'hide' | 'detach' | 'destroy';
3577
+ closeBehavior: 'hide' | 'detach' | 'destroy';
3578
+ /**
3579
+ * Controls interaction of the view with its parent window's download shelf.
3580
+ */
3581
+ downloadShelf?: {
3582
+ /**
3583
+ * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
3584
+ */
3585
+ enabled: boolean;
3586
+ };
3453
3587
  };
3454
3588
 
3455
3589
  /**
@@ -3561,8 +3695,16 @@ declare type ConstWindowOptions = {
3561
3695
  * launches in favor of the cached value.
3562
3696
  */
3563
3697
  defaultWidth: number;
3698
+ downloadShelf: DownloadShelfOptions;
3564
3699
  height: number;
3565
3700
  layout: any;
3701
+ /**
3702
+ * @experimental
3703
+ *
3704
+ * The collection of layouts to load when the window is created. When launching multiple layouts, manage
3705
+ * the lifecycle via fin.Platform.Layout.create()/destroy() methods.
3706
+ */
3707
+ layoutSnapshot: LayoutSnapshot;
3566
3708
  /**
3567
3709
  * Parent identity of a modal window. It will create a modal child window when this option is set.
3568
3710
  */
@@ -3778,28 +3920,15 @@ declare type ContentCreationOptions = {
3778
3920
  * A rule for creating content in OpenFin; maps a content type to the way in which
3779
3921
  * newly-opened content of that type will be handled.
3780
3922
  *
3923
+ * @remarks This is effectively just a union type discriminated by the `behavior` key. The generic
3924
+ * parameter is a legacy feature that is included for backwards-compatibility reasons.
3781
3925
  *
3782
- * @interface
3926
+ * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3927
+ * the specified `behavior` key.
3783
3928
  */
3784
- declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
3785
- /**
3786
- * Behavior to use when opening matched content. The value could be 'view' | 'window' | 'browser' | 'block'.
3787
- */
3788
- behavior: T;
3789
- /**
3790
- * List of [match patterns](https://developer.chrome.com/extensions/match_patterns) that indicate the specified
3791
- * behavior should be used
3792
- */
3793
- match: MatchPattern[];
3794
- /**
3795
- * Options for newly-created view or window (if applicable).
3796
- */
3797
- options?: T extends 'window' ? Partial<WindowOptions> : T extends 'view' ? Partial<ViewOptions> : never;
3798
- /**
3799
- * custom property
3800
- */
3801
- data?: unknown;
3802
- };
3929
+ declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3930
+ behavior: Behavior;
3931
+ }>;
3803
3932
 
3804
3933
  /**
3805
3934
  * @interface
@@ -4100,7 +4229,7 @@ declare type Context_3 = {
4100
4229
  * Generated when a window's context is updated via {@link Platform#setWindowContext Platform.setWindowContext}. Only available on windows in a Platform.
4101
4230
  * @interface
4102
4231
  */
4103
- declare type ContextChangedEvent = BaseWindowEvent & {
4232
+ declare type ContextChangedEvent = BaseEvent_5 & {
4104
4233
  type: 'context-changed';
4105
4234
  context: any;
4106
4235
  };
@@ -4252,7 +4381,7 @@ declare type CpuInfo = {
4252
4381
  * Generated when an application has crashed.
4253
4382
  * @interface
4254
4383
  */
4255
- declare type CrashedEvent = IdentityEvent & {
4384
+ declare type CrashedEvent = BaseEvents.IdentityEvent & {
4256
4385
  topic: 'application';
4257
4386
  type: 'crashed';
4258
4387
  reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
@@ -4303,20 +4432,17 @@ declare type CrashReporterState = CrashReporterOptions & {
4303
4432
  * Generated when a View is created.
4304
4433
  * @interface
4305
4434
  */
4306
- declare type CreatedEvent = BaseViewEvent & {
4435
+ declare type CreatedEvent = BaseEvent_4 & {
4307
4436
  type: 'created';
4308
4437
  };
4309
4438
 
4310
4439
  /**
4311
- * @interface
4440
+ * @interface @experimental
4312
4441
  */
4313
4442
  declare type CreateLayoutOptions = {
4314
- /**
4315
- * @experimental
4316
- *
4317
- * @returns
4318
- */
4319
- layoutManagerOverride: () => any;
4443
+ container: HTMLElement;
4444
+ layoutName: string;
4445
+ layout: LayoutOptions;
4320
4446
  };
4321
4447
 
4322
4448
  /**
@@ -4337,7 +4463,7 @@ declare type CreateViewPayload = {
4337
4463
  /**
4338
4464
  * @interface
4339
4465
  */
4340
- declare type CreateViewTarget = Identity_5 & {
4466
+ declare type CreateViewTarget = LayoutIdentity & {
4341
4467
  /**
4342
4468
  * If specified, view creation will not attach to a window and caller must
4343
4469
  * insert the view into the layout explicitly
@@ -4348,6 +4474,44 @@ declare type CreateViewTarget = Identity_5 & {
4348
4474
  };
4349
4475
  };
4350
4476
 
4477
+ /**
4478
+ * The registry entry for a given protocol exists but can't be parsed.
4479
+ * @interface
4480
+ */
4481
+ declare type CustomProtocolMalformedState = {
4482
+ state: 'Malformed';
4483
+ };
4484
+
4485
+ /**
4486
+ * The registry entry is missing for a given custom protocol.
4487
+ * @interface
4488
+ */
4489
+ declare type CustomProtocolMissingState = {
4490
+ state: 'Missing';
4491
+ };
4492
+
4493
+ /**
4494
+ * Define possible options for Custom protocol.
4495
+ * @interface
4496
+ */
4497
+ declare type CustomProtocolOptions = {
4498
+ protocolName: string;
4499
+ };
4500
+
4501
+ /**
4502
+ * The registry rentry for a given protocol exists and can be parsed successfully.
4503
+ * @interface
4504
+ */
4505
+ declare type CustomProtocolRegisteredState = {
4506
+ state: 'Registered';
4507
+ handlerManifestUrl: string;
4508
+ };
4509
+
4510
+ /**
4511
+ * Define possible registration states for a given custom protocol.
4512
+ */
4513
+ declare type CustomProtocolState = CustomProtocolMissingState | CustomProtocolMalformedState | CustomProtocolRegisteredState;
4514
+
4351
4515
  /**
4352
4516
  * Custom headers for requests sent by the window.
4353
4517
  *
@@ -4365,6 +4529,8 @@ declare type CustomRequestHeaders = {
4365
4529
  headers: WebRequestHeader[];
4366
4530
  };
4367
4531
 
4532
+ declare type DataChannelReadyState = RTCDataChannel['readyState'];
4533
+
4368
4534
  /**
4369
4535
  * @interface
4370
4536
  */
@@ -4425,7 +4591,7 @@ declare interface DesktopAgent_2 {
4425
4591
  * Generated when the desktop icon is clicked while it's already running.
4426
4592
  * @interface
4427
4593
  */
4428
- declare type DesktopIconClickedEvent = BaseSystemEvent & {
4594
+ declare type DesktopIconClickedEvent = BaseEvent_8 & {
4429
4595
  type: 'desktop-icon-clicked';
4430
4596
  };
4431
4597
 
@@ -4433,17 +4599,10 @@ declare type DesktopIconClickedEvent = BaseSystemEvent & {
4433
4599
  * Generated when a View is destroyed.
4434
4600
  * @interface
4435
4601
  */
4436
- declare type DestroyedEvent = BaseViewEvent & {
4602
+ declare type DestroyedEvent = BaseEvent_4 & {
4437
4603
  type: 'destroyed';
4438
4604
  };
4439
4605
 
4440
- /**
4441
- * @interface
4442
- */
4443
- declare type DestroyLayoutOptions = {
4444
- layoutName: string;
4445
- };
4446
-
4447
4606
  /**
4448
4607
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
4449
4608
  * @interface
@@ -4540,6 +4699,30 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
4540
4699
  type: 'disabled-movement-bounds-changing';
4541
4700
  };
4542
4701
 
4702
+ /**
4703
+ * Generated when a Channel client has disconnected.
4704
+ * @interface
4705
+ */
4706
+ declare type DisconnectedEvent = BaseEvent_2 & {
4707
+ type: 'disconnected';
4708
+ };
4709
+
4710
+ /**
4711
+ * Generated when an external application has disconnected.
4712
+ * @interface
4713
+ */
4714
+ declare type DisconnectedEvent_2 = BaseExternalApplicationEvent & {
4715
+ type: 'disconnected';
4716
+ };
4717
+
4718
+ /**
4719
+ * Generated when a frame has disconnected.
4720
+ * @interface
4721
+ */
4722
+ declare type DisconnectedEvent_3 = BaseFrameEvent & {
4723
+ type: 'disconnected';
4724
+ };
4725
+
4543
4726
  /**
4544
4727
  * A system channel will be global enough to have a presence across many apps. This gives us some hints
4545
4728
  * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
@@ -4621,23 +4804,64 @@ declare type DownloadPreloadInfo = {
4621
4804
  };
4622
4805
 
4623
4806
  /**
4624
- * Options for downloading a preload script.
4625
- *
4807
+ * Options for downloading a preload script.
4808
+ *
4809
+ * @interface
4810
+ */
4811
+ declare type DownloadPreloadOption = {
4812
+ /**
4813
+ * URL from which to download the preload script.
4814
+ */
4815
+ url: string;
4816
+ };
4817
+
4818
+ /**
4819
+ * @interface
4820
+ */
4821
+ declare type DownloadRule = {
4822
+ behavior: FileDownloadBehaviorNames;
4823
+ match: string[];
4824
+ };
4825
+
4826
+ /**
4626
4827
  * @interface
4828
+ *
4829
+ * Controls the styling and behavior of the window download shelf.
4627
4830
  */
4628
- declare type DownloadPreloadOption = {
4831
+ declare type DownloadShelfOptions = {
4629
4832
  /**
4630
- * URL from which to download the preload script.
4833
+ * Whether downloads in this window trigger opening the download shelf.
4631
4834
  */
4632
- url: string;
4835
+ enabled: boolean;
4836
+ /**
4837
+ * Styling options for the download shelf border.
4838
+ */
4839
+ border?: {
4840
+ /**
4841
+ * Thickness of the border in pixels. Default 1 pixel. Used only for frameless windows.
4842
+ *
4843
+ * @remarks The top border is fixed to 1 pixel regardless of this setting.
4844
+ */
4845
+ size?: number;
4846
+ /**
4847
+ * Color of the border, either a string name or a hex code. Defaults to chromium theme
4848
+ * if absent.
4849
+ */
4850
+ color?: string;
4851
+ };
4633
4852
  };
4634
4853
 
4635
4854
  /**
4855
+ * Generated when the visibility of the window's download shelf changes.
4856
+ *
4636
4857
  * @interface
4637
4858
  */
4638
- declare type DownloadRule = {
4639
- behavior: FileDownloadBehaviorNames;
4640
- match: string[];
4859
+ declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
4860
+ type: 'download-shelf-visibility-changed';
4861
+ /**
4862
+ * True if the download shelf was just opened; false if it was just closed.
4863
+ */
4864
+ visible: boolean;
4641
4865
  };
4642
4866
 
4643
4867
  /**
@@ -4662,7 +4886,7 @@ declare interface DragSource {}
4662
4886
  * Generated when a window has been embedded.
4663
4887
  * @interface
4664
4888
  */
4665
- declare type EmbeddedEvent = BaseWindowEvent & {
4889
+ declare type EmbeddedEvent = BaseEvent_5 & {
4666
4890
  type: 'embedded';
4667
4891
  };
4668
4892
 
@@ -4761,7 +4985,7 @@ declare class EmitterMap {
4761
4985
  * Generated when a window ends loading.
4762
4986
  * @interface
4763
4987
  */
4764
- declare type EndLoadEvent = BaseWindowEvent & {
4988
+ declare type EndLoadEvent = BaseEvent_5 & {
4765
4989
  type: 'end-load';
4766
4990
  documentName: string;
4767
4991
  isMain: boolean;
@@ -4839,9 +5063,11 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
4839
5063
  } : never;
4840
5064
 
4841
5065
  declare interface Environment {
4842
- initLayout(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, ...args: Parameters<OpenFin.Fin['Platform']['Layout']['init']>): ReturnType<OpenFin.Fin['Platform']['Layout']['init']>;
5066
+ initLayout(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5067
+ createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5068
+ destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
4843
5069
  initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
4844
- observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): (() => void);
5070
+ observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
4845
5071
  writeToken(path: string, token: string): Promise<string>;
4846
5072
  retrievePort(config: NewConnectConfig): Promise<number>;
4847
5073
  getNextMessageId(): any;
@@ -4876,6 +5102,88 @@ declare type ErrorPlainObject = {
4876
5102
  toString(): string;
4877
5103
  };
4878
5104
 
5105
+ /**
5106
+ * [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
5107
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5108
+ * under the {@link OpenFin.PlatformEvents} namespace.
5109
+ */
5110
+ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5111
+
5112
+ /**
5113
+ * [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
5114
+ * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5115
+ * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5116
+ * from which they propagate).
5117
+ */
5118
+ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ViewEvents.PropagatedEvent<'system'> | ApplicationEvents.PropagatedEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
5119
+
5120
+ /**
5121
+ * [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
5122
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5123
+ * under the {@link OpenFin.ChannelEvents} namespace.
5124
+ */
5125
+ declare type Event_2 = {
5126
+ topic: 'channel';
5127
+ } & (ConnectedEvent | DisconnectedEvent);
5128
+
5129
+ /**
5130
+ * [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
5131
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5132
+ * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5133
+ * from which they propagate).
5134
+ */
5135
+ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.PropagatedEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
5136
+
5137
+ /**
5138
+ * [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
5139
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5140
+ * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5141
+ */
5142
+ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
5143
+ target: OpenFin.Identity;
5144
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
5145
+
5146
+ /**
5147
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
5148
+ * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
5149
+ */
5150
+ declare type Event_5<Topic extends string> = {
5151
+ topic: Topic;
5152
+ } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
5153
+
5154
+ /**
5155
+ * [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
5156
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5157
+ * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5158
+ */
5159
+ declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5160
+
5161
+ /**
5162
+ * [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
5163
+ * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5164
+ * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5165
+ */
5166
+ declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5167
+
5168
+ /**
5169
+ * [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
5170
+ * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5171
+ * under the {@link OpenFin.FrameEvents} namespace.
5172
+ */
5173
+ declare type Event_8 = {
5174
+ topic: 'frame';
5175
+ } & (ConnectedEvent_4 | DisconnectedEvent_3);
5176
+
5177
+ /**
5178
+ * [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
5179
+ * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5180
+ * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5181
+ */
5182
+ declare type Event_9 = {
5183
+ topic: 'global-hotkey';
5184
+ hotkey: 'string';
5185
+ } & (RegisteredEvent | UnregisteredEvent);
5186
+
4879
5187
  declare class EventAggregator extends EmitterMap {
4880
5188
  dispatchEvent: (message: Message<any>) => boolean;
4881
5189
  }
@@ -4941,6 +5249,46 @@ declare namespace Events {
4941
5249
  }
4942
5250
  }
4943
5251
 
5252
+ /**
5253
+ * Union of possible `type` values for a view {@link Event}.
5254
+ */
5255
+ declare type EventType = Event_4['type'];
5256
+
5257
+ /**
5258
+ * Union of possible `type` values for a Window {@link Event}.
5259
+ */
5260
+ declare type EventType_2 = Event_6['type'];
5261
+
5262
+ /**
5263
+ * Union of possible `type` values for an Application {@link Event}.
5264
+ */
5265
+ declare type EventType_3 = Event_3['type'];
5266
+
5267
+ /**
5268
+ * Union of possible `type` values for an ExternalApplication {@link Event}.
5269
+ */
5270
+ declare type EventType_4 = Event_7['type'];
5271
+
5272
+ /**
5273
+ * Union of possible `type` values for a {@link FrameEvent}.
5274
+ */
5275
+ declare type EventType_5 = Event_8['type'];
5276
+
5277
+ /**
5278
+ * Union of possible `type` values for a {@link GlobalHotkeyEvent}
5279
+ */
5280
+ declare type EventType_6 = Event_9['type'];
5281
+
5282
+ /**
5283
+ * Union of possible `type` values for a {@link PlatformEvent}.
5284
+ */
5285
+ declare type EventType_7 = Event_10['type'];
5286
+
5287
+ /**
5288
+ * Union of possible `type` values for a {@link SystemEvent}.
5289
+ */
5290
+ declare type EventType_8 = SystemEvent['type'];
5291
+
4944
5292
  /* Excluded from this release type: EventWithId */
4945
5293
 
4946
5294
  /* Excluded from this release type: ExcludeRequested */
@@ -5064,46 +5412,43 @@ declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicatio
5064
5412
  }
5065
5413
 
5066
5414
  /**
5067
- * Generated when an external application has authenticated and is connected.
5068
- * @interface
5415
+ * @deprecated Renamed to {@link ConnectedEvent}.
5069
5416
  */
5070
- declare type ExternalApplicationConnectedEvent = BaseExternalApplicationEvent & {
5071
- type: 'connected';
5072
- };
5417
+ declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
5073
5418
 
5074
5419
  /**
5075
- * Generated when an external application has disconnected.
5076
- * @interface
5420
+ * @deprecated Renamed to {@link DisconnectedEvent}.
5077
5421
  */
5078
- declare type ExternalApplicationDisconnectedEvent = BaseExternalApplicationEvent & {
5079
- type: 'disconnected';
5080
- };
5422
+ declare type ExternalApplicationDisconnectedEvent = DisconnectedEvent_2;
5081
5423
 
5082
5424
  /**
5083
- * [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
5084
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5085
- * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5425
+ * @deprecated Renamed to {@link Event}.
5086
5426
  */
5087
- declare type ExternalApplicationEvent = ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent;
5427
+ declare type ExternalApplicationEvent = Event_7;
5088
5428
 
5089
5429
  declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
5090
5430
 
5091
5431
  declare namespace ExternalApplicationEvents {
5092
5432
  export {
5433
+ BaseEvent_6 as BaseEvent,
5093
5434
  BaseExternalApplicationEvent,
5435
+ ConnectedEvent_3 as ConnectedEvent,
5094
5436
  ExternalApplicationConnectedEvent,
5437
+ DisconnectedEvent_2 as DisconnectedEvent,
5095
5438
  ExternalApplicationDisconnectedEvent,
5439
+ Event_7 as Event,
5096
5440
  ExternalApplicationEvent,
5441
+ EventType_4 as EventType,
5097
5442
  ExternalApplicationEventType,
5098
- Payload_3 as Payload,
5099
- ByType_2 as ByType
5443
+ Payload_5 as Payload,
5444
+ ByType_4 as ByType
5100
5445
  }
5101
5446
  }
5102
5447
 
5103
5448
  /**
5104
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
5449
+ * @deprecated Renamed to {@link Event}.
5105
5450
  */
5106
- declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
5451
+ declare type ExternalApplicationEventType = EventType_4;
5107
5452
 
5108
5453
  /**
5109
5454
  * @interface
@@ -5168,7 +5513,7 @@ declare type ExternalConnection = {
5168
5513
  * Generated when an external process has exited.
5169
5514
  * @interface
5170
5515
  */
5171
- declare type ExternalProcessExitedEvent = BaseWindowEvent & {
5516
+ declare type ExternalProcessExitedEvent = BaseEvent_5 & {
5172
5517
  type: 'external-process-exited';
5173
5518
  processUuid: string;
5174
5519
  exitCode: number;
@@ -5213,19 +5558,15 @@ declare type ExternalProcessRequestType = {
5213
5558
  * Generated when an external process has started.
5214
5559
  * @interface
5215
5560
  */
5216
- declare type ExternalProcessStartedEvent = BaseWindowEvent & {
5561
+ declare type ExternalProcessStartedEvent = BaseEvent_5 & {
5217
5562
  type: 'external-process-started';
5218
5563
  processUuid: string;
5219
5564
  };
5220
5565
 
5221
5566
  /**
5222
- * Generated when page receives favicon urls.
5223
- * @interface
5567
+ * @deprecated, use {@link PageFaviconUpdatedEvent}.
5224
5568
  */
5225
- declare type FaviconUpdatedEvent = NamedEvent & {
5226
- type: 'page-favicon-updated';
5227
- favicons: string[];
5228
- };
5569
+ declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
5229
5570
 
5230
5571
  declare namespace FDC3 {
5231
5572
  export {
@@ -5431,6 +5772,8 @@ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata_3> = {
5431
5772
  metadata?: MetadataType;
5432
5773
  };
5433
5774
 
5775
+ declare type FlexReadyState = WebSocketReadyState | DataChannelReadyState;
5776
+
5434
5777
  /**
5435
5778
  * Generated when a WebContents gains focus.
5436
5779
  * @interface
@@ -5579,48 +5922,43 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5579
5922
  }
5580
5923
 
5581
5924
  /**
5582
- * Generated when a frame is connected.
5583
- * @interface
5925
+ * @deprecated Renamed to {@link ConnectedEvent}.
5584
5926
  */
5585
- declare type FrameConnectedEvent = BaseFrameEvent & {
5586
- type: 'connected';
5587
- };
5927
+ declare type FrameConnectedEvent = ConnectedEvent_4;
5588
5928
 
5589
5929
  /**
5590
- * Generated when a frame has disconnected.
5591
- * @interface
5930
+ * @deprecated Renamed to {@link DisconnectedEvent}.
5592
5931
  */
5593
- declare type FrameDisconnectedEvent = BaseFrameEvent & {
5594
- type: 'disconnected';
5595
- };
5932
+ declare type FrameDisconnectedEvent = DisconnectedEvent_3;
5596
5933
 
5597
5934
  /**
5598
- * [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
5599
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5600
- * under the {@link OpenFin.FrameEvents} namespace.
5935
+ * @deprecated Renamed to {@link Event}.
5601
5936
  */
5602
- declare type FrameEvent = {
5603
- topic: 'frame';
5604
- } & (FrameConnectedEvent | FrameDisconnectedEvent);
5937
+ declare type FrameEvent = Event_8;
5605
5938
 
5606
5939
  declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
5607
5940
 
5608
5941
  declare namespace FrameEvents {
5609
5942
  export {
5943
+ BaseEvent_7 as BaseEvent,
5610
5944
  BaseFrameEvent,
5945
+ ConnectedEvent_4 as ConnectedEvent,
5611
5946
  FrameConnectedEvent,
5947
+ DisconnectedEvent_3 as DisconnectedEvent,
5612
5948
  FrameDisconnectedEvent,
5949
+ Event_8 as Event,
5613
5950
  FrameEvent,
5951
+ EventType_5 as EventType,
5614
5952
  FrameEventType,
5615
- Payload_4 as Payload,
5616
- ByType_3 as ByType
5953
+ Payload_6 as Payload,
5954
+ ByType_5 as ByType
5617
5955
  }
5618
5956
  }
5619
5957
 
5620
5958
  /**
5621
- * Union of possible `type` values for a {@link FrameEvent}.
5959
+ * @deprecated Renamed to {@link EventType}.
5622
5960
  */
5623
- declare type FrameEventType = FrameEvent['type'];
5961
+ declare type FrameEventType = EventType_5;
5624
5962
 
5625
5963
  /**
5626
5964
  * @interface
@@ -5745,6 +6083,8 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
5745
6083
  * Registers a global hotkey with the operating system.
5746
6084
  * @param hotkey a hotkey string
5747
6085
  * @param listener called when the registered hotkey is pressed by the user.
6086
+ * @throws If the `hotkey` is reserved, see list below.
6087
+ * @throws if the `hotkey` is already registered by another application.
5748
6088
  *
5749
6089
  * @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.
5750
6090
  * 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.
@@ -5817,7 +6157,7 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
5817
6157
  */
5818
6158
  unregisterAll(): Promise<void>;
5819
6159
  /**
5820
- * Checks if a given hotkey has been registered
6160
+ * Checks if a given hotkey has been registered by an application within the current runtime.
5821
6161
  * @param hotkey a hotkey string
5822
6162
  *
5823
6163
  * @example
@@ -5837,14 +6177,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
5837
6177
  }
5838
6178
 
5839
6179
  /**
5840
- * [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
5841
- * discriminated by {@link GlobalHotkeyEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5842
- * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
6180
+ * @deprecated Renamed to {@link Event}.
5843
6181
  */
5844
- declare type GlobalHotkeyEvent = {
5845
- topic: 'global-hotkey';
5846
- hotkey: 'string';
5847
- } & (RegisteredEvent | UnregisteredEvent);
6182
+ declare type GlobalHotkeyEvent = Event_9;
5848
6183
 
5849
6184
  declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
5850
6185
 
@@ -5852,17 +6187,19 @@ declare namespace GlobalHotkeyEvents {
5852
6187
  export {
5853
6188
  RegisteredEvent,
5854
6189
  UnregisteredEvent,
6190
+ Event_9 as Event,
5855
6191
  GlobalHotkeyEvent,
6192
+ EventType_6 as EventType,
5856
6193
  GlobalHotkeyEventType,
5857
- Payload_5 as Payload,
5858
- ByType_4 as ByType
6194
+ Payload_7 as Payload,
6195
+ ByType_6 as ByType
5859
6196
  }
5860
6197
  }
5861
6198
 
5862
6199
  /**
5863
- * Union of possible `type` values for a {@link GlobalHotkeyEvent}
6200
+ * @deprecated Renamed to {@link EventType}.
5864
6201
  */
5865
- declare type GlobalHotkeyEventType = GlobalHotkeyEvent['type'];
6202
+ declare type GlobalHotkeyEventType = EventType_6;
5866
6203
 
5867
6204
  declare namespace GoldenLayout {
5868
6205
  export {
@@ -5881,6 +6218,7 @@ declare namespace GoldenLayout {
5881
6218
  DragSource,
5882
6219
  BrowserWindow,
5883
6220
  Header,
6221
+ TabDragListener,
5884
6222
  Tab,
5885
6223
  EventEmitter_2 as EventEmitter
5886
6224
  }
@@ -5995,10 +6333,7 @@ declare class GoldenLayout_2 implements EventEmitter_2 {
5995
6333
  * @param itemConfiguration An item configuration (can be an entire tree of items)
5996
6334
  * @param parent A parent item
5997
6335
  */
5998
- createContentItem(
5999
- itemConfiguration?: ItemConfigType,
6000
- parent?: ContentItem
6001
- ): ContentItem;
6336
+ createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6002
6337
 
6003
6338
  /**
6004
6339
  * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
@@ -6031,10 +6366,7 @@ declare class GoldenLayout_2 implements EventEmitter_2 {
6031
6366
  * @return the dragSource that was created. This can be used to remove the
6032
6367
  * dragSource from the layout later.
6033
6368
  */
6034
- createDragSource(
6035
- element: HTMLElement | JQuery,
6036
- itemConfiguration: ItemConfigType
6037
- ): DragSource;
6369
+ createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6038
6370
 
6039
6371
  /**
6040
6372
  * Removes a dragSource from the layout.
@@ -6169,8 +6501,17 @@ declare interface Header {
6169
6501
  * Generated when a View is hidden.
6170
6502
  * @interface
6171
6503
  */
6172
- declare type HiddenEvent = BaseViewEvent & {
6504
+ declare type HiddenEvent = BaseEvent_4 & {
6505
+ type: 'hidden';
6506
+ };
6507
+
6508
+ /**
6509
+ * Generated when a window has been hidden.
6510
+ * @interface
6511
+ */
6512
+ declare type HiddenEvent_2 = BaseEvent_5 & {
6173
6513
  type: 'hidden';
6514
+ reason: 'closing' | 'hide' | 'hide-on-close';
6174
6515
  };
6175
6516
 
6176
6517
  /**
@@ -6178,7 +6519,7 @@ declare type HiddenEvent = BaseViewEvent & {
6178
6519
  * or because the View has moved to a new window. Only available on Views in a Platform.
6179
6520
  * @interface
6180
6521
  */
6181
- declare type HostContextChangedEvent = BaseViewEvent & {
6522
+ declare type HostContextChangedEvent = BaseEvent_4 & {
6182
6523
  type: 'host-context-changed';
6183
6524
  context: any;
6184
6525
  reason: 'reparented' | 'updated';
@@ -6257,7 +6598,16 @@ declare type Hotkey = {
6257
6598
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
6258
6599
  * @interface
6259
6600
  */
6260
- declare type HotkeyEvent = BaseViewEvent & {
6601
+ declare type HotkeyEvent = BaseEvent_4 & {
6602
+ type: 'hotkey';
6603
+ };
6604
+
6605
+ /**
6606
+ * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
6607
+ * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
6608
+ * @interface
6609
+ */
6610
+ declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
6261
6611
  type: 'hotkey';
6262
6612
  };
6263
6613
 
@@ -6317,7 +6667,7 @@ declare type IdentityEvent = BaseEvent & {
6317
6667
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6318
6668
  * @interface
6319
6669
  */
6320
- declare type IdleEvent = BaseSystemEvent & {
6670
+ declare type IdleEvent = BaseEvent_8 & {
6321
6671
  type: 'idle-state-changed';
6322
6672
  elapsedTime: number;
6323
6673
  isIdle: boolean;
@@ -6402,24 +6752,43 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6402
6752
  * Generated when an application has initialized.
6403
6753
  * @interface
6404
6754
  */
6405
- declare type InitializedEvent = IdentityEvent & {
6755
+ declare type InitializedEvent = BaseEvents.IdentityEvent & {
6406
6756
  topic: 'application';
6407
6757
  type: 'initialized';
6408
6758
  };
6409
6759
 
6410
- declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
6411
-
6412
- declare type InitLayoutOptions_2 = OpenFin.InitLayoutOptions;
6760
+ /**
6761
+ * Generated when a window is initialized.
6762
+ * @interface
6763
+ */
6764
+ declare type InitializedEvent_2 = BaseEvent_5 & {
6765
+ type: 'initialized';
6766
+ };
6413
6767
 
6414
6768
  /**
6415
6769
  * @interface
6416
6770
  */
6417
- declare type InitLayoutOptions_3 = {
6771
+ declare type InitLayoutOptions = {
6418
6772
  /**
6773
+ * @deprecated use container HTMLElement instead
6774
+ *
6419
6775
  * The id attribute of the container where the window's Layout should be initialized. If not provided
6420
6776
  * then an element with id `layout-container` is used. We recommend using a div element.
6421
6777
  */
6422
6778
  containerId?: string;
6779
+ /**
6780
+ * The HTMLElement where the window's Layout should be initialized. We recommend using a div element.
6781
+ */
6782
+ container?: HTMLElement;
6783
+ /**
6784
+ * An override callback used to instantiate a custom LayoutManager. When present, will enable
6785
+ * Multiple Layouts. The callback should return a class.
6786
+ *
6787
+ * @remarks
6788
+ * **NOTE**: Unlike the Platform Provider overrideCallback and interopOverride, this override should
6789
+ * return a class, not an instance
6790
+ */
6791
+ layoutManagerOverride?: LayoutManagerOverride<LayoutSnapshot>;
6423
6792
  };
6424
6793
 
6425
6794
  /**
@@ -8249,7 +8618,7 @@ declare type LaunchIntoPlatformPayload = {
8249
8618
  declare class Layout extends Base {
8250
8619
  #private;
8251
8620
  /* Excluded from this release type: init */
8252
- identity: Identity_4;
8621
+ identity: OpenFin.LayoutIdentity;
8253
8622
  private platform;
8254
8623
  wire: Transport;
8255
8624
  /* Excluded from this release type: __constructor */
@@ -8425,19 +8794,30 @@ declare type LayoutComponent = LayoutItemConfig & {
8425
8794
 
8426
8795
  declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
8427
8796
 
8428
- declare class LayoutContentCache {
8429
- private contentItemCache;
8430
- private contentItemCacheId;
8431
- private createCacheKey;
8432
- hasKey: (id: string) => boolean;
8433
- getItemOrUndefined: (id: string) => GoldenLayout.ContentItem | undefined;
8434
- getContentItemOrThrow: (id: string, expectedType?: string[]) => GoldenLayout.ContentItem;
8435
- getOrCreateEntityId: (contentItem: GoldenLayout.ContentItem) => string;
8436
- }
8437
-
8438
8797
  declare type LayoutEntitiesClient = ApiClient<LayoutEntitiesController>;
8439
8798
 
8440
- /* Excluded from this release type: LayoutEntitiesController */
8799
+ declare type LayoutEntitiesController = {
8800
+ getLayoutIdentityForViewOrThrow: (viewIdentity?: OpenFin.Identity) => Promise<OpenFin.LayoutIdentity>;
8801
+ getRoot: (layoutIdentity?: OpenFin.LayoutIdentity) => Promise<OpenFin.LayoutEntityDefinition>;
8802
+ getStackByView: (viewIdentity: OpenFin.Identity) => Promise<OpenFin.LayoutEntityDefinition | undefined>;
8803
+ getStackViews: (id: string) => OpenFin.Identity[];
8804
+ getContent: (id: string) => OpenFin.LayoutEntityDefinition[];
8805
+ getParent: (id: string) => OpenFin.LayoutEntityDefinition | undefined;
8806
+ isRoot: (id: string) => boolean;
8807
+ exists: (entityId: string) => boolean;
8808
+ addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: {
8809
+ index?: number;
8810
+ }) => Promise<OpenFin.Identity>;
8811
+ removeViewFromStack: (stackEntityId: string, view: OpenFin.Identity) => Promise<void>;
8812
+ createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], stackCreationOptions?: {
8813
+ position?: OpenFin.LayoutPosition;
8814
+ }) => Promise<string>;
8815
+ getAdjacentStacks: (stackTarget: {
8816
+ targetId: string;
8817
+ edge: OpenFin.LayoutPosition;
8818
+ }) => Promise<Pick<OpenFin.LayoutEntityDefinition, 'entityId'>[]>;
8819
+ setStackActiveView: (stackEntityId: string, viewIdentity: OpenFin.Identity) => Promise<void>;
8820
+ };
8441
8821
 
8442
8822
  /**
8443
8823
  * @interface
@@ -8464,36 +8844,18 @@ declare type LayoutIdentity = Identity_5 & {
8464
8844
  * Generated when a window and all of its layout's views have either finished or failed navigation.
8465
8845
  * @interface
8466
8846
  */
8467
- declare type LayoutInitializedEvent = BaseWindowEvent & {
8847
+ declare type LayoutInitializedEvent = BaseEvent_5 & {
8468
8848
  type: 'layout-initialized';
8469
8849
  ofViews: (OpenFin.Identity & {
8470
8850
  entityType: 'view';
8471
8851
  })[];
8472
8852
  };
8473
8853
 
8474
- /**
8475
- * @interface @experimental
8476
- *
8477
- * Responsible for handling all layout management and renderering
8478
- */
8479
- declare type LayoutInstance = {
8480
- getFrameSnapshot: () => Promise<LayoutOptions>;
8481
- addView: (payload: AddViewOptions) => Promise<View_2>;
8482
- closeView: (viewIdentity: Identity_5) => Promise<void>;
8483
- removeView: (viewConfig: Identity_5 | ViewState) => Promise<View_2>;
8484
- replaceView: (payload: ReplaceViewOptions) => Promise<View_2>;
8485
- getViews: () => LayoutComponent[];
8486
- getCurrentViews: () => Identity_5[];
8487
- startReplaceLayout: (payload: ReplaceLayoutOptions) => Promise<void>;
8488
- applyPreset: (payload: PresetLayoutOptions_3) => void;
8489
- isVisible: () => boolean;
8490
- destroy: () => void;
8491
- };
8854
+ /* Excluded from this release type: LayoutInstance */
8492
8855
 
8493
8856
  /**
8494
8857
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
8495
- * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
8496
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
8858
+ * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
8497
8859
  *
8498
8860
  * @interface
8499
8861
  */
@@ -8515,25 +8877,43 @@ declare type LayoutItemConfig = {
8515
8877
 
8516
8878
  /**
8517
8879
  * @interface @experimental
8880
+ *
8881
+ * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
8882
+ *
8883
+ * Responsible for aggergating all layout snapshots and storing LayoutInstances
8518
8884
  */
8519
- declare interface LayoutManager<T extends LayoutSnapshot = LayoutSnapshot> {
8885
+ declare interface LayoutManager<T extends LayoutSnapshot> {
8520
8886
  /**
8521
8887
  * @experimental
8522
8888
  *
8523
- * Must be overridden when working with multiple layouts
8889
+ * To enable multiple layouts, override this method and do not call super.applyLayoutSnapshot()
8890
+ *
8891
+ * This hook is called by OpenFin during fin.Platform.Layout.init() call, to pass a snapshot to derived
8892
+ * classes which will be used launch a platform window. Use this hook to set your local UI state and
8893
+ * begin rendering the containers for your layouts UI.
8524
8894
  *
8525
- * Hook called during fin.Platform.Layout.init() call, to inform derived classes
8526
- * when a snapshot is being applied to launch a platform window. Use this hook to set the
8527
- * local state and ensure you call fin.Platform.Layout.create() on every layout in snapshot.layouts
8895
+ * Ensure you call fin.Platform.Layout.create() on every layout in snapshot.layouts when that layout is
8896
+ * ready to be created in your application.
8528
8897
  *
8529
- * When using custom data to the app manifest snapshot.windows.layoutSnapshot key, this data will
8530
- * be included in the snapshot type T and should align with your component state T.
8898
+ * If you add custom data to the app manifest snapshot.windows.layoutSnapshot key, this data will
8899
+ * be included in the snapshot type.
8900
+ *
8901
+ * The default implementation throws if it is called with a snapshot containing more than one layout.
8531
8902
  *
8532
- * TODO: detect if layoutManager override was set and this was not overridden somehow to warn?
8533
8903
  * @param snapshot
8534
- * @returns
8904
+ * @throws if Object.keys(snapshot).length > 1
8905
+ */
8906
+ applyLayoutSnapshot(snapshot: T): Promise<void>;
8907
+ /**
8908
+ * Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
8909
+ * contains a single layout.
8910
+ *
8911
+ * Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
8912
+ * fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
8913
+ *
8914
+ * @param snapshot
8915
+ * @throws if Object.keys(snapshot).length > 1
8535
8916
  */
8536
- applyLayoutSnapshot: (snapshot: T) => Promise<void>;
8537
8917
  /**
8538
8918
  * @experimental
8539
8919
  *
@@ -8544,35 +8924,63 @@ declare interface LayoutManager<T extends LayoutSnapshot = LayoutSnapshot> {
8544
8924
  * @param layoutIdentity
8545
8925
  * @returns
8546
8926
  */
8547
- showLayout: ({ layoutName }: LayoutIdentity) => Promise<void>;
8927
+ showLayout({ layoutName }: LayoutIdentity): Promise<void>;
8548
8928
  /**
8549
8929
  * @experimental
8550
8930
  *
8551
8931
  * @returns T
8552
8932
  */
8553
- getLayoutSnapshot: () => Promise<T>;
8933
+ getLayoutSnapshot(): Promise<T>;
8554
8934
  /**
8555
8935
  * @experimental
8556
8936
  *
8557
- * @param param0
8937
+ * @param layoutIdentity
8558
8938
  * @returns
8559
8939
  */
8560
- resolveLayout: ({ layoutName }: LayoutIdentity) => LayoutInstance;
8940
+ resolveLayout(layoutIdentity?: LayoutIdentity): Promise<LayoutInstance>;
8561
8941
  /**
8562
8942
  * @experimental
8563
8943
  *
8564
8944
  * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
8565
8945
  * Throws if it does not exist.
8566
- * @param layoutIdentity
8946
+ * @param layoutName
8567
8947
  * @returns
8568
8948
  */
8569
- getLayoutByName: (layoutName: string) => LayoutInstance;
8949
+ getLayoutByName(layoutName: string): LayoutInstance;
8570
8950
  /**
8571
8951
  * @experimental
8572
8952
  */
8573
8953
  getLayouts(): Record<string, LayoutInstance>;
8954
+ /**
8955
+ * @experimental
8956
+ */
8957
+ getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
8958
+ /**
8959
+ * @experimental
8960
+ */
8961
+ isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
8574
8962
  }
8575
8963
 
8964
+ /**
8965
+ * @experimental
8966
+ *
8967
+ * Constructor type for LayoutManager to be used with multiple layouts
8968
+ */
8969
+ declare type LayoutManagerConstructor<T extends LayoutSnapshot> = {
8970
+ new (): LayoutManager<T>;
8971
+ };
8972
+
8973
+ /**
8974
+ * @experimental
8975
+ *
8976
+ * Override callback used to init and configure multiple layouts. Implement by passing
8977
+ * a lambda and returning a class that OpenFin will new up for you.
8978
+ * @remarks
8979
+ * **NOTE**: Unlike the Platform Provider overrideCallback and interopOverride, this override should
8980
+ * return a class, not an instance
8981
+ */
8982
+ declare type LayoutManagerOverride<T extends LayoutSnapshot> = (Base: LayoutManagerConstructor<LayoutSnapshot>) => LayoutManagerConstructor<T>;
8983
+
8576
8984
  /**
8577
8985
  * Static namespace for OpenFin API methods that interact with the {@link Layout} class, available under `fin.Platform.Layout`.
8578
8986
  */
@@ -8597,7 +9005,7 @@ declare class LayoutModule extends Base {
8597
9005
  * const layoutConfig = await layout.getConfig();
8598
9006
  * ```
8599
9007
  */
8600
- wrap(identity: OpenFin.Identity): Promise<OpenFin.Layout>;
9008
+ wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
8601
9009
  /**
8602
9010
  * Synchronously returns a Layout object that represents a Window's layout.
8603
9011
  *
@@ -8617,7 +9025,7 @@ declare class LayoutModule extends Base {
8617
9025
  * const layoutConfig = await layout.getConfig();
8618
9026
  * ```
8619
9027
  */
8620
- wrapSync(identity: OpenFin.Identity): OpenFin.Layout;
9028
+ wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
8621
9029
  /**
8622
9030
  * Asynchronously returns a Layout object that represents a Window's layout.
8623
9031
  *
@@ -8681,7 +9089,14 @@ declare class LayoutModule extends Base {
8681
9089
  * const layout = await fin.Platform.Layout.init({ containerId });
8682
9090
  * ```
8683
9091
  */
8684
- init: (options?: InitLayoutOptions) => Promise<OpenFin.Layout>;
9092
+ init: (options?: OpenFin.InitLayoutOptions) => Promise<OpenFin.Layout>;
9093
+ /**
9094
+ * Returns the layout manager for the current window
9095
+ * @returns
9096
+ */
9097
+ getCurrentLayoutManagerSync: <UserSnapshotType extends OpenFin.LayoutSnapshot>() => OpenFin.LayoutManager<UserSnapshotType>;
9098
+ create: (options: OpenFin.CreateLayoutOptions) => Promise<void>;
9099
+ destroy: (layoutIdentity: OpenFin.LayoutIdentity) => Promise<void>;
8685
9100
  }
8686
9101
 
8687
9102
  declare type LayoutModule_2 = OpenFin.Fin['Platform']['Layout'];
@@ -8767,8 +9182,7 @@ declare type LayoutOptions = {
8767
9182
  };
8768
9183
  /**
8769
9184
  * Content of the layout. There can only be one top-level LayoutItem in the content array.
8770
- * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
8771
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
9185
+ * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
8772
9186
  */
8773
9187
  content?: LayoutContent;
8774
9188
  dimensions?: {
@@ -8790,7 +9204,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
8790
9204
  * Generated when a window and all of its layout's views have been created and can receive API calls.
8791
9205
  * @interface
8792
9206
  */
8793
- declare type LayoutReadyEvent = BaseWindowEvent & {
9207
+ declare type LayoutReadyEvent = BaseEvent_5 & {
8794
9208
  type: 'layout-ready';
8795
9209
  views: (OpenFin.Identity & {
8796
9210
  success: boolean;
@@ -8931,7 +9345,7 @@ declare type Manifest = {
8931
9345
  * Generated when the RVM notifies an application that the manifest has changed.
8932
9346
  * @interface
8933
9347
  */
8934
- declare type ManifestChangedEvent = IdentityEvent & {
9348
+ declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
8935
9349
  topic: 'application';
8936
9350
  type: 'manifest-changed';
8937
9351
  };
@@ -8984,7 +9398,7 @@ declare type MatchPattern = string;
8984
9398
  * Generated when a window is maximized.
8985
9399
  * @interface
8986
9400
  */
8987
- declare type MaximizedEvent = BaseWindowEvent & {
9401
+ declare type MaximizedEvent = BaseEvent_5 & {
8988
9402
  type: 'maximized';
8989
9403
  };
8990
9404
 
@@ -9064,7 +9478,17 @@ declare interface Message<T> {
9064
9478
 
9065
9479
  declare type MessageHandler = (data: any) => boolean;
9066
9480
 
9067
- declare class MessageReceiver extends Base {
9481
+ declare interface MessageReceiver {
9482
+ addEventListener(e: 'open', listener: (ev: Event) => void): void;
9483
+ addEventListener(e: 'error', listener: (ev: Event) => void): void;
9484
+ addEventListener(e: 'message', listener: (ev: MessageEvent) => void): void;
9485
+ addEventListener(e: 'close', listener: (ev: Event) => void): void;
9486
+ send(data: unknown): void;
9487
+ close(): void;
9488
+ readyState: FlexReadyState;
9489
+ }
9490
+
9491
+ declare class MessageReceiver_2 extends Base {
9068
9492
  private endpointMap;
9069
9493
  private latestEndpointIdByChannelId;
9070
9494
  constructor(wire: Transport);
@@ -9084,7 +9508,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
9084
9508
  * Generated when a window is minimized.
9085
9509
  * @interface
9086
9510
  */
9087
- declare type MinimizedEvent = BaseWindowEvent & {
9511
+ declare type MinimizedEvent = BaseEvent_5 & {
9088
9512
  type: 'minimized';
9089
9513
  };
9090
9514
 
@@ -9133,7 +9557,7 @@ declare type MonitorDetails = {
9133
9557
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9134
9558
  * @interface
9135
9559
  */
9136
- declare type MonitorEvent = BaseSystemEvent & OpenFin.MonitorInfo & {
9560
+ declare type MonitorEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9137
9561
  type: 'monitor-info-changed';
9138
9562
  };
9139
9563
 
@@ -9218,7 +9642,7 @@ declare type MutableViewOptions = {
9218
9642
  contentRedirect: ContentRedirect;
9219
9643
  /**
9220
9644
  * @defaultValue false
9221
- *
9645
+ * @deprecated
9222
9646
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9223
9647
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9224
9648
  */
@@ -9555,13 +9979,15 @@ declare type NonPropagatedWebContentsEvent = never;
9555
9979
  */
9556
9980
  declare type NonPropagatedWindowEvent = never;
9557
9981
 
9982
+ /* Excluded from this release type: NotCloseRequested */
9983
+
9558
9984
  /* Excluded from this release type: NotRequested */
9559
9985
 
9560
9986
  /**
9561
9987
  * Generated when an application is not responding.
9562
9988
  * @interface
9563
9989
  */
9564
- declare type NotRespondingEvent = IdentityEvent & {
9990
+ declare type NotRespondingEvent = BaseEvents.IdentityEvent & {
9565
9991
  topic: 'application';
9566
9992
  type: 'not-responding';
9567
9993
  };
@@ -9630,6 +10056,11 @@ declare namespace OpenFin {
9630
10056
  Rectangle,
9631
10057
  ApplicationCreationOptions,
9632
10058
  ApplicationOptions,
10059
+ CustomProtocolMissingState,
10060
+ CustomProtocolMalformedState,
10061
+ CustomProtocolRegisteredState,
10062
+ CustomProtocolState,
10063
+ CustomProtocolOptions,
9633
10064
  InteropBrokerOptions,
9634
10065
  ContextGroupInfo,
9635
10066
  DisplayMetadata_3 as DisplayMetadata,
@@ -9693,6 +10124,7 @@ declare namespace OpenFin {
9693
10124
  ReplaceViewPayload,
9694
10125
  ReplaceViewOptions,
9695
10126
  CloseViewPayload,
10127
+ CloseViewOptions,
9696
10128
  FetchManifestPayload,
9697
10129
  ReplaceLayoutOpts,
9698
10130
  ReplaceLayoutPayload,
@@ -9816,6 +10248,11 @@ declare namespace OpenFin {
9816
10248
  IntentHandler_2 as IntentHandler,
9817
10249
  ContentCreationBehaviorNames,
9818
10250
  MatchPattern,
10251
+ BaseContentCreationRule,
10252
+ WindowContentCreationRule,
10253
+ ViewContentCreationRule,
10254
+ BrowserContentCreationRule,
10255
+ BlockedContentCreationRule,
9819
10256
  ContentCreationRule,
9820
10257
  ContentCreationOptions,
9821
10258
  SnapshotProvider,
@@ -9855,13 +10292,13 @@ declare namespace OpenFin {
9855
10292
  LayoutPresetType,
9856
10293
  LayoutIdentity,
9857
10294
  LayoutSnapshot,
9858
- InitLayoutOptions_3 as InitLayoutOptions,
10295
+ InitLayoutOptions,
10296
+ LayoutManagerConstructor,
10297
+ LayoutManagerOverride,
9859
10298
  LayoutInstance,
9860
10299
  LayoutManager,
9861
- AddLayoutInstanceOptions,
9862
10300
  CreateLayoutOptions,
9863
- DestroyLayoutOptions,
9864
- PresetLayoutOptions_3 as PresetLayoutOptions,
10301
+ PresetLayoutOptions_2 as PresetLayoutOptions,
9865
10302
  ResultBehavior,
9866
10303
  PopupBaseBehavior,
9867
10304
  PopupResultBehavior,
@@ -9876,7 +10313,7 @@ declare namespace OpenFin {
9876
10313
  AppVersionCompleteEvent,
9877
10314
  AppVersionRuntimeStatusEvent,
9878
10315
  Events,
9879
- BaseEvent_2 as BaseEvent,
10316
+ BaseEvent_9 as BaseEvent,
9880
10317
  WebContentsEvent_2 as WebContentsEvent,
9881
10318
  SystemEvent_2 as SystemEvent,
9882
10319
  ApplicationEvent_2 as ApplicationEvent,
@@ -9901,6 +10338,7 @@ declare namespace OpenFin {
9901
10338
  ChannelClientDisconnectionListener,
9902
10339
  ChannelProviderDisconnectionListener,
9903
10340
  RoutingInfo,
10341
+ DownloadShelfOptions,
9904
10342
  ApplicationEvents,
9905
10343
  BaseEvents,
9906
10344
  ExternalApplicationEvents,
@@ -9915,109 +10353,34 @@ declare namespace OpenFin {
9915
10353
  }
9916
10354
  export default OpenFin;
9917
10355
 
9918
- declare class OpenFinLayout implements OpenFin.LayoutInstance {
9919
- #private;
9920
- private readonly splitterController;
9921
- private readonly tabDragController;
9922
- private readonly layoutContentCache;
9923
- private get defaultFaviconUrl();
9924
- private get isDragging();
9925
- private get resizing();
9926
- private get showBackgroundImages();
9927
- private get showFavicons();
9928
- private get showViewsOnSplitterDrag();
9929
- private get showViewsOnTabDrag();
9930
- private get showViewsOnWindowResize();
9931
- private get container();
9932
- get layout(): GoldenLayout.GoldenLayout;
9933
- private get layoutConfigToRestore();
9934
- private client;
9935
- private containerResizeObserver;
9936
- private viewsResizeObserver;
9937
- readonly ofWindow: OpenFin.Window;
9938
- readonly platform: Platform_2;
9939
- private lastItemDestroyed?;
9940
- private viewsSubscribedTo;
9941
- constructor(splitterController: SplitterController, tabDragController: TabDragController, layoutContentCache: LayoutContentCache, container: HTMLElement);
9942
- getViews: () => OpenFin.LayoutComponent[];
9943
- startReplaceLayout: ({ layout }: {
9944
- layout: GoldenLayout.Config;
9945
- }) => Promise<void>;
9946
- applyPreset: (payload: PresetLayoutOptions_2) => void;
9947
- isVisible: () => boolean;
9948
- destroy: () => void;
9949
- /* Excluded from this release type: getClient */
9950
- initManager: () => Promise<void>;
9951
- createLayout: (layout: GoldenLayout.Config, container: HTMLElement) => Promise<void>;
9952
- private setContainer;
9953
- private setupDragDropRegions;
9954
- private replaceLayout;
9955
- private onViewDetached;
9956
- private setupLayoutListeners;
9957
- private onLayoutInit;
9958
- private registerViewComponent;
9959
- private setupWindowListeners;
9960
- private setupResizeObservers;
9961
- /**
9962
- * Shows/hides a view depending on use case (used by browser)
9963
- * @ignore
9964
- */
9965
- private updateViewVisibility;
9966
- private onStackCreated;
9967
- private onTabCreated;
9968
- private onTabMouseUp;
9969
- private replaceCloseTabButton;
9970
- onCloseTabButtonClick: (tab: GoldenLayout.Tab) => Promise<void>;
9971
- addFaviconToTab: (tab: GoldenLayout.Tab, eventIcons: string[]) => void;
9972
- onPopoutClick: (stack: GoldenLayout.ContentItem) => void;
9973
- onStackCloseClick: (stack: GoldenLayout.ContentItem) => void;
9974
- private updateButtonDisplay;
9975
- private onItemCreated;
9976
- private observeSplitters;
9977
- handleOutOfWindowDrop: (e: {
9978
- screenY: number;
9979
- screenX: number;
9980
- }, parentTab: GoldenLayout.Tab, dimensions: {
9981
- width: any;
9982
- height: any;
9983
- }) => Promise<void>;
9984
- private onTabDragStart;
9985
- private setBackgroundImage;
9986
- private setBackgroundImages;
9987
- getFrameSnapshot: () => Promise<GoldenLayout.Config>;
9988
- getCurrentViews: () => OpenFin.Identity[];
9989
- addView: ({ options: viewConfig, targetView, location }: OpenFin.AddViewOptions) => Promise<View_4>;
9990
- replaceView: ({ viewToReplace, newView }: OpenFin.ReplaceViewOptions) => Promise<View_4>;
9991
- removeView: (viewConfig: OpenFin.Identity | OpenFin.ViewState) => Promise<View_4>;
9992
- closeView: (viewIdentity: OpenFin.Identity) => Promise<void>;
9993
- private createChannelConnections;
9994
- getViewComponent: ({ name }: {
9995
- name: string;
9996
- }) => ViewComponent | undefined;
9997
- getViewComponents: () => ViewComponent[];
9998
- private hideHighlight;
9999
- getOfViewFromComponentState: ({ name }: {
10000
- name: string;
10001
- }) => View_4;
10002
- private hideAllViews;
10003
- private showViews;
10004
- private initializeLayoutViews;
10005
- private createResizableView;
10006
- private attachView;
10007
- private createAndAttachView;
10008
- private setupViewEvents;
10009
- private dispatchLayoutEvent;
10010
- private setComponentState;
10011
- }
10012
-
10013
10356
  declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
10014
10357
 
10358
+ /**
10359
+ * Generated after window options are changed using the window.updateOptions method.
10360
+ * @remarks Will not fire if the diff object is empty.
10361
+ * @interface
10362
+ */
10363
+ declare type OptionsChangedEvent = BaseEvent_5 & {
10364
+ type: 'options-changed';
10365
+ options: OpenFin.WindowOptions;
10366
+ diff: OpenFin.WindowOptionDiff;
10367
+ };
10368
+
10015
10369
  declare type OverlapsOnlyIfMatching<T, U> = {
10016
10370
  [K in Extract<keyof T, keyof U>]: U[K] extends T[K] ? U[K] : T[K] extends U[K] ? T[K] : never;
10017
10371
  };
10018
10372
 
10019
10373
  declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
10020
10374
 
10375
+ /**
10376
+ * Generated when page receives favicon urls.
10377
+ * @interface
10378
+ */
10379
+ declare type PageFaviconUpdatedEvent = NamedEvent & {
10380
+ type: 'page-favicon-updated';
10381
+ favicons: string[];
10382
+ };
10383
+
10021
10384
  /**
10022
10385
  * Generated when page title is set during navigation.
10023
10386
  * @remarks explicitSet is false when title is synthesized from file url.
@@ -10036,74 +10399,74 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
10036
10399
  };
10037
10400
 
10038
10401
  /**
10039
- * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
10402
+ * Extracts a single event type matching the given key from the View {@link Event} union.
10040
10403
  *
10041
10404
  * @typeParam Type String key specifying the event to extract
10042
10405
  */
10043
- declare type Payload_2<Type extends ApplicationEventType> = Extract<ApplicationEvent, {
10406
+ declare type Payload_2<Type extends EventType> = Extract<Event_4, {
10044
10407
  type: Type;
10045
10408
  }>;
10046
10409
 
10047
10410
  /**
10048
- * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
10411
+ * Extracts a single event type matching the given key from the Window {@link Event} union.
10049
10412
  *
10050
10413
  * @typeParam Type String key specifying the event to extract
10051
10414
  */
10052
- declare type Payload_3<Type extends ExternalApplicationEventType> = Extract<ExternalApplicationEvent, {
10415
+ declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
10053
10416
  type: Type;
10054
10417
  }>;
10055
10418
 
10056
10419
  /**
10057
- * Extracts a single event type matching the given key from the {@link FrameEvent} union.
10420
+ * Extracts a single event type matching the given key from the Application {@link Event} union.
10058
10421
  *
10059
10422
  * @typeParam Type String key specifying the event to extract
10060
10423
  */
10061
- declare type Payload_4<Type extends FrameEventType> = Extract<FrameEvent, {
10424
+ declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
10062
10425
  type: Type;
10063
10426
  }>;
10064
10427
 
10065
10428
  /**
10066
- * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
10429
+ * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
10067
10430
  *
10068
10431
  * @typeParam Type String key specifying the event to extract
10069
10432
  */
10070
- declare type Payload_5<Type extends GlobalHotkeyEventType> = Extract<GlobalHotkeyEvent, {
10433
+ declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
10071
10434
  type: Type;
10072
10435
  }>;
10073
10436
 
10074
10437
  /**
10075
- * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
10438
+ * Extracts a single event type matching the given key from the Frame {@link Event} union.
10076
10439
  *
10077
10440
  * @typeParam Type String key specifying the event to extract
10078
10441
  */
10079
- declare type Payload_6<Type extends PlatformEventType> = Extract<PlatformEvent, {
10442
+ declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
10080
10443
  type: Type;
10081
10444
  }>;
10082
10445
 
10083
10446
  /**
10084
- * Extracts a single event type matching the given key from the {@link SystemEvent} union.
10447
+ * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
10085
10448
  *
10086
10449
  * @typeParam Type String key specifying the event to extract
10087
10450
  */
10088
- declare type Payload_7<Type extends SystemEventType> = Extract<SystemEvent, {
10451
+ declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
10089
10452
  type: Type;
10090
10453
  }>;
10091
10454
 
10092
10455
  /**
10093
- * Extracts a single event type matching the given key from the {@link ViewEvent} union.
10456
+ * Extracts a single event type matching the given key from the Platform {@link Event} union.
10094
10457
  *
10095
10458
  * @typeParam Type String key specifying the event to extract
10096
10459
  */
10097
- declare type Payload_8<Type extends ViewEventType> = Extract<ViewEvent, {
10460
+ declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
10098
10461
  type: Type;
10099
10462
  }>;
10100
10463
 
10101
10464
  /**
10102
- * Extracts a single event type matching the given key from the {@link WindowEvent} union.
10465
+ * Extracts a single event type matching the given key from the System {@link Event} union.
10103
10466
  *
10104
10467
  * @typeParam Type String key specifying the event to extract
10105
10468
  */
10106
- declare type Payload_9<Type extends WindowEventType> = Extract<WindowEvent, {
10469
+ declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10107
10470
  type: Type;
10108
10471
  }>;
10109
10472
 
@@ -10113,7 +10476,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
10113
10476
  * Generated when window finishes loading. Provides performance and navigation data.
10114
10477
  * @interface
10115
10478
  */
10116
- declare type PerformanceReportEvent = Performance & BaseWindowEvent & {
10479
+ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
10117
10480
  type: 'performance-report';
10118
10481
  };
10119
10482
 
@@ -10746,41 +11109,37 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
10746
11109
  }): Promise<void>;
10747
11110
  }
10748
11111
 
10749
- declare type Platform_2 = OpenFin.Platform;
10750
-
10751
11112
  /**
10752
- * Generated when a new Platform's API becomes responsive.
10753
- * @interface
11113
+ * @deprecated Renamed to {@link ApiReadyEvent}.
10754
11114
  */
10755
- declare type PlatformApiReadyEvent = BaseEvent & {
10756
- topic: 'application';
10757
- type: 'platform-api-ready';
10758
- };
11115
+ declare type PlatformApiReadyEvent = ApiReadyEvent;
10759
11116
 
10760
11117
  /**
10761
- * [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
10762
- * discriminated by {@link PlatformEvent.type | their type}. Event payloads unique to `Platform` can be found
10763
- * under the {@link OpenFin.PlatformEvents} namespace.
11118
+ * @deprecated Renamed to {@link Event}.
10764
11119
  */
10765
- declare type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;
11120
+ declare type PlatformEvent = Event_10;
10766
11121
 
10767
11122
  declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
10768
11123
 
10769
11124
  declare namespace PlatformEvents {
10770
11125
  export {
11126
+ ApiReadyEvent,
10771
11127
  PlatformApiReadyEvent,
11128
+ SnapshotAppliedEvent,
10772
11129
  PlatformSnapshotAppliedEvent,
11130
+ Event_10 as Event,
10773
11131
  PlatformEvent,
11132
+ EventType_7 as EventType,
10774
11133
  PlatformEventType,
10775
- Payload_6 as Payload,
10776
- ByType_5 as ByType
11134
+ Payload_8 as Payload,
11135
+ ByType_7 as ByType
10777
11136
  }
10778
11137
  }
10779
11138
 
10780
11139
  /**
10781
- * Union of possible `type` values for a {@link PlatformEvent}.
11140
+ * @deprecated Renamed to {@link }.
10782
11141
  */
10783
- declare type PlatformEventType = PlatformEvent['type'];
11142
+ declare type PlatformEventType = EventType_7;
10784
11143
 
10785
11144
  /**
10786
11145
  * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
@@ -11039,6 +11398,8 @@ declare interface PlatformProvider {
11039
11398
  * ```
11040
11399
  */
11041
11400
  getSnapshot(payload: undefined, identity: OpenFin.Identity): Promise<OpenFin.Snapshot>;
11401
+ /* Excluded from this release type: getInitialLayoutSnapshot */
11402
+ /* Excluded from this release type: createViewsForLayout */
11042
11403
  /* Excluded from this release type: getViewSnapshot */
11043
11404
  /**
11044
11405
  * Called when a snapshot is being applied and some windows in that snapshot would be fully or partially off-screen.
@@ -11443,19 +11804,9 @@ declare interface PlatformProvider {
11443
11804
  }
11444
11805
 
11445
11806
  /**
11446
- * Generated when a platform.ApplySnapshot call is resolved.
11447
- * @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
11448
- * 1. The window has been created
11449
- * 2. The window has a responsive API
11450
- * 3. If a window has a layout property, the 'layout-ready' event has fired
11451
- *
11452
- * _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.
11453
- * @interface
11807
+ * @deprecated Renamed to {@link SnapshotAppliedEvent}.
11454
11808
  */
11455
- declare type PlatformSnapshotAppliedEvent = BaseEvent & {
11456
- topic: 'application';
11457
- type: 'platform-snapshot-applied';
11458
- };
11809
+ declare type PlatformSnapshotAppliedEvent = SnapshotAppliedEvent;
11459
11810
 
11460
11811
  /**
11461
11812
  * @interface
@@ -11723,7 +12074,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
11723
12074
  * A general preload scripts state change event without event type.
11724
12075
  * @interface
11725
12076
  */
11726
- declare type PreloadScriptsStateChangeEvent = BaseWindowEvent & {
12077
+ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
11727
12078
  preloadScripts: (PreloadScriptInfoRunning & any)[];
11728
12079
  };
11729
12080
 
@@ -11738,12 +12089,10 @@ declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent &
11738
12089
 
11739
12090
  declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
11740
12091
 
11741
- declare type PresetLayoutOptions_2 = OpenFin.PresetLayoutOptions;
11742
-
11743
12092
  /**
11744
12093
  * @interface
11745
12094
  */
11746
- declare type PresetLayoutOptions_3 = {
12095
+ declare type PresetLayoutOptions_2 = {
11747
12096
  /**
11748
12097
  * Which preset layout arrangement to use.
11749
12098
  * The preset options are `columns`, `grid`, `rows`, and `tabs`.
@@ -11934,65 +12283,96 @@ declare type ProcessLoggingOptions = {
11934
12283
  };
11935
12284
 
11936
12285
  /**
11937
- * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
11938
- * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
11939
- * are propagated to `System` without any type string prefixing.
11940
- *
11941
- * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
12286
+ * @deprecated Renamed to {@link PropagatedEvent}.
11942
12287
  */
11943
- declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
12288
+ declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent_4<TargetTopic>;
11944
12289
 
11945
12290
  /**
11946
- * Union of possible 'type' values for a {@link OpenFin.ApplicationEvents.PropagatedApplicationEvent}.
12291
+ * @deprecated Renamed to {@link PropagatedEventType}.
11947
12292
  */
11948
- declare type PropagatedApplicationEventType = PropagatedApplicationEvent<string>['type'];
12293
+ declare type PropagatedApplicationEventType = PropagatedEventType_3;
11949
12294
 
11950
12295
  /**
11951
- * Modifies an event shape to reflect propagation to a parent topic.
12296
+ * Modifies an event shape to reflect propagation to a parent topic. Excludes `close-requested` events, as
12297
+ * these do not propagate.
12298
+ *
11952
12299
  * @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
12300
+ *
12301
+ * @typeParam SourceTopic The topic the event shape is propagating from.
12302
+ * @typeParam TargetTopic The topic the event shape is propagating to.
12303
+ * @typeParam Event The shape of the event being propagated.
11953
12304
  */
11954
12305
  declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
11955
12306
  type: string;
11956
12307
  }> = Event extends infer E extends {
11957
12308
  type: string;
11958
- } ? Omit<E, 'type' | 'topic'> & {
12309
+ } ? E['type'] extends 'close-requested' ? never : Omit<E, 'type' | 'topic'> & {
11959
12310
  type: PropagatedEventType<SourceTopic, E['type']>;
11960
12311
  topic: TargetTopic;
11961
12312
  } : never;
11962
12313
 
11963
- /**
11964
- * Modifies an event key to reflect propagation by prefixing with the topic.
11965
- */
11966
- declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
11967
-
11968
12314
  /**
11969
12315
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
11970
- * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
12316
+ * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
11971
12317
  * event type key with `'view-'`.
11972
12318
  */
11973
- declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
12319
+ declare type PropagatedEvent_2<TargetTopic extends string> = BaseEvents.PropagatedEvent<'view', TargetTopic, ViewEvent> & {
11974
12320
  viewIdentity: OpenFin.Identity;
11975
12321
  };
11976
12322
 
11977
- /**
11978
- * Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
11979
- */
11980
- declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
11981
-
11982
12323
  /**
11983
12324
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
11984
- * prefixing the type string with `'window-'`. Only {@link NativeWindowEvent native window events} will propagate
12325
+ * prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
11985
12326
  * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
11986
12327
  * will *not* re-propagate.
11987
12328
  *
11988
12329
  * "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
11989
12330
  */
11990
- declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent<'window', TargetTopic, Exclude<WindowSourcedEvent, WindowCloseRequestedEvent>>;
12331
+ declare type PropagatedEvent_3<TargetTopic extends string> = BaseEvents.PropagatedEvent<'window', TargetTopic, WindowSourcedEvent>;
12332
+
12333
+ /**
12334
+ * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
12335
+ * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
12336
+ * are propagated to `System` without any type string prefixing.
12337
+ *
12338
+ * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
12339
+ */
12340
+ declare type PropagatedEvent_4<TargetTopic extends string> = BaseEvents.PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
12341
+
12342
+ /**
12343
+ * Modifies an event type key to reflect propagation by prefixing with the topic.
12344
+ */
12345
+ declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${NotCloseRequested<Type>}`;
12346
+
12347
+ /**
12348
+ * Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.View}.
12349
+ */
12350
+ declare type PropagatedEventType_2 = PropagatedEvent_2<string>['type'];
12351
+
12352
+ /**
12353
+ * Union of possible 'type' values for an {@link PropagatedEvent} sourced from an {@link Application}.
12354
+ */
12355
+ declare type PropagatedEventType_3 = PropagatedEvent_4<string>['type'];
12356
+
12357
+ /**
12358
+ * @deprecated Renamed to {@link PropagatedEvent}.
12359
+ */
12360
+ declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent_2<TargetTopic>;
12361
+
12362
+ /**
12363
+ * @deprecated Renamed to {@link PropagatedEventType}.
12364
+ */
12365
+ declare type PropagatedViewEventType = PropagatedEventType_2;
12366
+
12367
+ /**
12368
+ * @deprecated Renamed to {@link PropagatedEvent}.
12369
+ */
12370
+ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent_3<TargetTopic>;
11991
12371
 
11992
12372
  /**
11993
- * Union of possible `type` values for a {@link OpenFin.WindowEvents.PropagatedWindowEvent}.
12373
+ * Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.Window}.
11994
12374
  */
11995
- declare type PropagatedWindowEventType = PropagatedWindowEvent<string>['type'];
12375
+ declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
11996
12376
 
11997
12377
  declare interface ProtocolMap extends ProtocolMapBase {
11998
12378
  'request-external-authorization': {
@@ -12199,6 +12579,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
12199
12579
  anchor: OpenFin.AnchorType;
12200
12580
  }>>;
12201
12581
  'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin.Bounds>>>;
12582
+ 'register-custom-protocol': ApiCall<OpenFin.CustomProtocolOptions, void>;
12583
+ 'unregister-custom-protocol': ApiCall<{
12584
+ protocolName: string;
12585
+ }, void>;
12586
+ 'get-custom-protocol-state': ApiCall<{
12587
+ protocolName: string;
12588
+ }, OpenFin.CustomProtocolState>;
12202
12589
  }
12203
12590
 
12204
12591
  declare interface ProtocolMapBase {
@@ -12330,6 +12717,10 @@ declare interface ReactComponentConfig extends ItemConfig {
12330
12717
  */
12331
12718
  declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptions;
12332
12719
 
12720
+ declare interface ReceiverConfig extends Omit<RemoteConfig, 'address'> {
12721
+ receiver: MessageReceiver;
12722
+ }
12723
+
12333
12724
  /**
12334
12725
  * A rectangular area on the screen.
12335
12726
  *
@@ -12399,7 +12790,7 @@ declare type RegistryInfo_2 = {
12399
12790
  * Generated when a window has been reloaded.
12400
12791
  * @interface
12401
12792
  */
12402
- declare type ReloadedEvent = BaseWindowEvent & {
12793
+ declare type ReloadedEvent = BaseEvent_5 & {
12403
12794
  type: 'reloaded';
12404
12795
  url: string;
12405
12796
  };
@@ -12411,19 +12802,19 @@ declare interface RemoteConfig extends ExistingConnectConfig {
12411
12802
  /**
12412
12803
  * @interface
12413
12804
  */
12414
- declare type ReplaceLayoutOptions = ReplaceLayoutOpts;
12805
+ declare type ReplaceLayoutOptions = {
12806
+ /**
12807
+ * Layout config to be applied.
12808
+ */
12809
+ layout: LayoutOptions;
12810
+ };
12415
12811
 
12416
12812
  /**
12417
12813
  * @interface
12418
12814
  *
12419
12815
  * @deprecated use ReplaceLayoutOptions instead
12420
12816
  */
12421
- declare type ReplaceLayoutOpts = {
12422
- /**
12423
- * Layout config to be applied.
12424
- */
12425
- layout: LayoutOptions;
12426
- };
12817
+ declare type ReplaceLayoutOpts = ReplaceLayoutOptions;
12427
12818
 
12428
12819
  /**
12429
12820
  * @interface
@@ -12434,9 +12825,9 @@ declare type ReplaceLayoutPayload = {
12434
12825
  */
12435
12826
  opts: ReplaceLayoutOptions;
12436
12827
  /**
12437
- * Identity of the window whose layout will be replace.
12828
+ * Identity of the window whose layout will be replaced.
12438
12829
  */
12439
- target: Identity_5;
12830
+ target: LayoutIdentity;
12440
12831
  };
12441
12832
 
12442
12833
  /**
@@ -12455,7 +12846,7 @@ declare type ReplaceViewPayload = {
12455
12846
  viewToReplace: Identity_5;
12456
12847
  newView: Partial<ViewOptions>;
12457
12848
  };
12458
- target: Identity_5;
12849
+ target: LayoutIdentity;
12459
12850
  };
12460
12851
 
12461
12852
  /**
@@ -12535,11 +12926,19 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
12535
12926
  * Generated when an application is responding.
12536
12927
  * @interface
12537
12928
  */
12538
- declare type RespondingEvent = IdentityEvent & {
12929
+ declare type RespondingEvent = BaseEvents.IdentityEvent & {
12539
12930
  topic: 'application';
12540
12931
  type: 'responding';
12541
12932
  };
12542
12933
 
12934
+ /**
12935
+ * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
12936
+ * @interface
12937
+ */
12938
+ declare type RestoredEvent = BaseEvent_5 & {
12939
+ type: 'restored';
12940
+ };
12941
+
12543
12942
  declare type ResultBehavior = 'close' | 'hide' | 'none';
12544
12943
 
12545
12944
  /**
@@ -12602,7 +13001,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
12602
13001
  * Generated when Application.run() is called for an already running application.
12603
13002
  * @interface
12604
13003
  */
12605
- declare type RunRequestedEvent_2 = IdentityEvent & {
13004
+ declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12606
13005
  topic: 'application';
12607
13006
  type: 'run-requested';
12608
13007
  userAppConfigArgs: Record<string, any>;
@@ -12784,7 +13183,7 @@ declare type ServiceIdentifier = {
12784
13183
  * Generated on changes to a user’s local computer session.
12785
13184
  * @interface
12786
13185
  */
12787
- declare type SessionChangedEvent = BaseSystemEvent & {
13186
+ declare type SessionChangedEvent = BaseEvent_8 & {
12788
13187
  type: 'session-changed';
12789
13188
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
12790
13189
  };
@@ -12967,11 +13366,62 @@ declare type ShortcutOverride = Hotkey & {
12967
13366
  command: string;
12968
13367
  };
12969
13368
 
13369
+ /**
13370
+ * Generated when the Download Shelf 'Show All' button is clicked.
13371
+ *
13372
+ * @remarks By default, OpenFin does not handle the clicking of the `Show All` button on the download
13373
+ * shelf. Instead, it fires this event, which leaves rendering a download manager to the user. For a simple
13374
+ * implementation, the `chrome://downloads` page can be used (see the example below):
13375
+ *
13376
+ * @example
13377
+ *
13378
+ * ```typescript
13379
+ * const platform = await fin.Platform.getCurrentSync();
13380
+ * // Listen to the propagated event at the Platform level, so that we only need one listener for a click from any window
13381
+ * platform.on('window-show-all-downloads', () => {
13382
+ * // Render the `chrome://downloads` window when a user clicks on the download shelf `Show All` button
13383
+ * platform.createWindow({
13384
+ * name: 'show-download-window',
13385
+ * layout: {
13386
+ * content: [
13387
+ * {
13388
+ * type: 'stack',
13389
+ * content: [
13390
+ * {
13391
+ * type: 'component',
13392
+ * componentName: 'view',
13393
+ * componentState: {
13394
+ * name: 'show-download-view',
13395
+ * url: 'chrome://downloads'
13396
+ * }
13397
+ * }
13398
+ * ]
13399
+ * }
13400
+ * ]
13401
+ * }
13402
+ * });
13403
+ * })
13404
+ * ```
13405
+ *
13406
+ * @interface
13407
+ */
13408
+ declare type ShowAllDownloadsEvent = BaseEvent_5 & {
13409
+ type: 'show-all-downloads';
13410
+ };
13411
+
12970
13412
  /**
12971
13413
  * Generated when a View is shown. This event will fire during creation of a View.
12972
13414
  * @interface
12973
13415
  */
12974
- declare type ShownEvent = BaseViewEvent & {
13416
+ declare type ShownEvent = BaseEvent_4 & {
13417
+ type: 'shown';
13418
+ };
13419
+
13420
+ /**
13421
+ * Generated when a hidden window has been shown.
13422
+ * @interface
13423
+ */
13424
+ declare type ShownEvent_2 = BaseEvent_5 & {
12975
13425
  type: 'shown';
12976
13426
  };
12977
13427
 
@@ -13000,6 +13450,15 @@ declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
13000
13450
  y?: number;
13001
13451
  };
13002
13452
 
13453
+ /**
13454
+ * Generated when a window has been prevented from showing.
13455
+ * @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.
13456
+ * @interface
13457
+ */
13458
+ declare type ShowRequestedEvent = BaseEvent_5 & {
13459
+ type: 'show-requested';
13460
+ };
13461
+
13003
13462
  /**
13004
13463
  * _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
13005
13464
  *
@@ -13046,6 +13505,21 @@ declare type Snapshot = {
13046
13505
  };
13047
13506
  };
13048
13507
 
13508
+ /**
13509
+ * Generated when a platform.ApplySnapshot call is resolved.
13510
+ * @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
13511
+ * 1. The window has been created
13512
+ * 2. The window has a responsive API
13513
+ * 3. If a window has a layout property, the 'layout-ready' event has fired
13514
+ *
13515
+ * _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.
13516
+ * @interface
13517
+ */
13518
+ declare type SnapshotAppliedEvent = BaseEvent & {
13519
+ topic: 'application';
13520
+ type: 'platform-snapshot-applied';
13521
+ };
13522
+
13049
13523
  /**
13050
13524
  * @interface
13051
13525
  */
@@ -13156,42 +13630,11 @@ declare class SnapshotSourceModule extends Base {
13156
13630
  wrap(identity: OpenFin.ApplicationIdentity): Promise<SnapshotSource>;
13157
13631
  }
13158
13632
 
13159
- /**
13160
- * Utility class for managing Golden Layout splitter drag interactions.
13161
- * @ignore
13162
- */
13163
- declare class SplitterController {
13164
- private readonly viewOverlay;
13165
- constructor(viewOverlay: ViewOverlay);
13166
- private teardown?;
13167
- private tryTeardown;
13168
- /**
13169
- * Disables the pointer events on the splitters, preventing them from being dragged.
13170
- */
13171
- preventSplitterResize: () => void;
13172
- /**
13173
- * Ends a splitter drag move, if one is in progress.
13174
- */
13175
- endMove: () => Promise<void>;
13176
- /**
13177
- * Initialises a splitter drag move, rendering a view on top of the splitter
13178
- * to allow it to render on top of the views within a layout (as they will always
13179
- * have a higher z-index to the platform window itself).
13180
- * @param splitterItem The Golden Layout splitter item that is currently being dragged.
13181
- */
13182
- startMove: (splitterItem: SplitterItem) => Promise<void>;
13183
- }
13184
-
13185
- declare type SplitterItem = GoldenLayout.ContentItem & {
13186
- viewEventsAdded: boolean;
13187
- isVertical: boolean;
13188
- };
13189
-
13190
13633
  /**
13191
13634
  * Generated when an application has started.
13192
13635
  * @interface
13193
13636
  */
13194
- declare type StartedEvent = IdentityEvent & {
13637
+ declare type StartedEvent = BaseEvents.IdentityEvent & {
13195
13638
  topic: 'application';
13196
13639
  type: 'started';
13197
13640
  };
@@ -14032,6 +14475,70 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
14032
14475
  * ```
14033
14476
  */
14034
14477
  openUrlWithBrowser(url: string): Promise<void>;
14478
+ /**
14479
+ * Creates a new registry entry under the HKCU root Windows registry key if the given custom protocol name doesn't exist or
14480
+ * overwrites the existing registry entry if the given custom protocol name already exists.
14481
+ *
14482
+ * Note: This method is restricted by default and must be enabled via
14483
+ * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
14484
+ *
14485
+ *
14486
+ * @remarks These protocols are reserved and cannot be registered:
14487
+ * - fin
14488
+ * - fins
14489
+ * - openfin
14490
+ * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
14491
+ *
14492
+ * @throws if a given custom protocol failed to be registered.
14493
+ * @throws if a manifest URL contains the '%1' string.
14494
+ * @throws if a manifest URL contains a query string parameter which name equals to the Protocol Launch Request Parameter Name.
14495
+ * @throws if the full length of the command string that is to be written to the registry exceeds 2048 bytes.
14496
+ *
14497
+ * @example
14498
+ * ```js
14499
+ * fin.System.registerCustomProtocol({protocolName:'protocol1'}).then(console.log).catch(console.error);
14500
+ * ```
14501
+ */
14502
+ registerCustomProtocol(options: OpenFin.CustomProtocolOptions): Promise<void>;
14503
+ /**
14504
+ * Removes the registry entry for a given custom protocol.
14505
+ *
14506
+ * Note: This method is restricted by default and must be enabled via
14507
+ * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
14508
+ *
14509
+ *
14510
+ * @remarks These protocols are reserved and cannot be unregistered:
14511
+ * - fin
14512
+ * - fins
14513
+ * - openfin
14514
+ * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
14515
+ *
14516
+ * @throws if a protocol entry failed to be removed in registry.
14517
+ *
14518
+ * @example
14519
+ * ```js
14520
+ * await fin.System.unregisterCustomProtocol('protocol1');
14521
+ * ```
14522
+ */
14523
+ unregisterCustomProtocol(protocolName: string): Promise<void>;
14524
+ /**
14525
+ * Retrieves the registration state for a given custom protocol.
14526
+ *
14527
+ * Note: This method is restricted by default and must be enabled via
14528
+ * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
14529
+ *
14530
+ * @remarks These protocols are reserved and cannot get states for them:
14531
+ * - fin
14532
+ * - fins
14533
+ * - openfin
14534
+ * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
14535
+ *
14536
+ *
14537
+ * @example
14538
+ * ```js
14539
+ * const protocolState = await fin.System.getCustomProtocolState('protocol1');
14540
+ */
14541
+ getCustomProtocolState(protocolName: string): Promise<OpenFin.CustomProtocolState>;
14035
14542
  /**
14036
14543
  * Removes the process entry for the passed UUID obtained from a prior call
14037
14544
  * of fin.System.launchExternalProcess().
@@ -14660,12 +15167,9 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
14660
15167
  };
14661
15168
 
14662
15169
  /**
14663
- * [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
14664
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
14665
- * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
14666
- * from which they propagate).
15170
+ * @deprecated Renamed to {@link Event}.
14667
15171
  */
14668
- declare type SystemEvent = ExcludeRequested<PropagatedWindowEvent<'system'>> | PropagatedViewEvent<'system'> | PropagatedApplicationEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
15172
+ declare type SystemEvent = Event_11;
14669
15173
 
14670
15174
  declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
14671
15175
 
@@ -14673,7 +15177,7 @@ declare namespace SystemEvents {
14673
15177
  export {
14674
15178
  NotRequested,
14675
15179
  ExcludeRequested,
14676
- BaseSystemEvent,
15180
+ BaseEvent_8 as BaseEvent,
14677
15181
  IdleEvent,
14678
15182
  MonitorEvent,
14679
15183
  SessionChangedEvent,
@@ -14688,17 +15192,19 @@ declare namespace SystemEvents {
14688
15192
  ApplicationCreatedEvent,
14689
15193
  DesktopIconClickedEvent,
14690
15194
  SystemShutdownEvent,
15195
+ Event_11 as Event,
14691
15196
  SystemEvent,
15197
+ EventType_8 as EventType,
14692
15198
  SystemEventType,
14693
- Payload_7 as Payload,
14694
- ByType_6 as ByType
15199
+ Payload_9 as Payload,
15200
+ ByType_8 as ByType
14695
15201
  }
14696
15202
  }
14697
15203
 
14698
15204
  /**
14699
- * Union of possible `type` values for a {@link SystemEvent}.
15205
+ * @deprecated Renamed to {@link EventType}.
14700
15206
  */
14701
- declare type SystemEventType = SystemEvent['type'];
15207
+ declare type SystemEventType = EventType_8;
14702
15208
 
14703
15209
  /**
14704
15210
  * @interface
@@ -14728,6 +15234,18 @@ declare type SystemPermissions = {
14728
15234
  enabled: boolean;
14729
15235
  protocols: string[];
14730
15236
  };
15237
+ registerCustomProtocol: boolean | {
15238
+ enabled: boolean;
15239
+ protocols: string[];
15240
+ };
15241
+ unregisterCustomProtocol: boolean | {
15242
+ enabled: boolean;
15243
+ protocols: string[];
15244
+ };
15245
+ getCustomProtocolState: boolean | {
15246
+ enabled: boolean;
15247
+ protocols: string[];
15248
+ };
14731
15249
  };
14732
15250
 
14733
15251
  /**
@@ -14746,7 +15264,7 @@ declare type SystemShutdownHandler = (shutdownEvent: {
14746
15264
  }) => void;
14747
15265
 
14748
15266
  declare interface Tab {
14749
- _dragListener: EventEmitter_2;
15267
+ _dragListener: TabDragListener;
14750
15268
 
14751
15269
  /**
14752
15270
  * True if this tab is the selected tab
@@ -14791,60 +15309,11 @@ declare interface Tab {
14791
15309
  setActive(isActive: boolean): void;
14792
15310
  }
14793
15311
 
14794
- /**
14795
- * Set of apis used to facilitate tab drag interactions without needing to hide views.
14796
- * @ignore
14797
- */
14798
- declare class TabDragController {
14799
- private readonly viewOverlay;
14800
- constructor(viewOverlay: ViewOverlay);
14801
- private dropZonePreview?;
14802
- /**
14803
- *
14804
- * When a tab is dragged out of a stack, it will need to be hidden from the stack.
14805
- *
14806
- * Additionally, if there is a new view to show in the stack, it will be shown at the position specified by
14807
- * containerBounds
14808
- *
14809
- * As drag interactions can under extreme circumstances complete before this chain of promises has completed,
14810
- * we need to pass in a isDragging() function which returns whether the drag is in progress.
14811
- * This allows us to cancel any layout affecting operations.
14812
- *
14813
- * @param draggingView The view which is currently being dragged
14814
- * @param isLastViewInWindow Whether the draggin view is the last view in a window or not. If false, the dragging view will not hide.
14815
- * @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
14816
- * modifying any views if the drag has completed (as the post drag procedure will have taken care of it.)
14817
- * @param containerBounds The bounds of the container of the view to be shown in the stack
14818
- * @param nextView The view which has become active after dragging the draggingView out.
14819
- */
14820
- handleTabStackActiveView: (draggingView: View_3, isLastViewInWindow: boolean, isDragging: () => boolean, containerBounds?: OpenFin.Bounds, nextView?: View_3) => Promise<void>;
14821
- /**
14822
- * Extracts the border and backgroundColor css values from the drop zone preview,
14823
- * and sets the viewOverlay to match them.
14824
- */
14825
- inheritStyles: () => Promise<void>;
14826
- /**
14827
- * Called when a tab drag interaction is started from the current window (not when it enters the window).
14828
- *
14829
- * Sets all views in the platform to ignore mouse events so that they can pass through to the golden-layout
14830
- * document whilst remaining visible.
14831
- */
14832
- startDrag: () => Promise<void>;
14833
- /**
14834
- * Called when a tab drag interaction which was started from the current window ends.
14835
- *
14836
- * Disables the click through setting on every view in the platform.
14837
- */
14838
- endDrag: () => Promise<void>;
14839
- private disposeObserve?;
14840
- disposeOverlayObserver: () => void;
15312
+ declare interface TabDragListener extends EventEmitter_2 {
14841
15313
  /**
14842
- * Observes a golden-layout drop zone preview in order to render a BrowserView
14843
- * overlay whenever a tab is dragged over a droppable region.
14844
- * @param dropZonePreview The drop zone preview element created by Golden Layout in order to highlight
14845
- * droppable regions of the UI.
15314
+ * A reference to the content item this tab relates to
14846
15315
  */
14847
- observeOverlay: (dropZonePreview: HTMLElement) => Promise<void>;
15316
+ contentItem: ContentItem;
14848
15317
  }
14849
15318
 
14850
15319
  /**
@@ -14988,7 +15457,7 @@ declare type TargetApp = string | AppMetadata;
14988
15457
  * In that case, previousTarget identity will be the same as target identity.
14989
15458
  * @interface
14990
15459
  */
14991
- declare type TargetChangedEvent = BaseViewEvent & {
15460
+ declare type TargetChangedEvent = BaseEvent_4 & {
14992
15461
  type: 'target-changed';
14993
15462
  previousTarget: OpenFin.Identity;
14994
15463
  };
@@ -15125,7 +15594,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
15125
15594
  connectSync: () => void;
15126
15595
  getPort: () => string;
15127
15596
  shutdown(): Promise<void>;
15128
- connect(config: InternalConnectConfig | RemoteConfig): Promise<string | void>;
15597
+ connect(config: InternalConnectConfig | RemoteConfig | ReceiverConfig): Promise<string | void>;
15129
15598
  private connectRemote;
15130
15599
  connectByPort(config: ExistingConnectConfig): Promise<void>;
15131
15600
  private authorize;
@@ -15142,7 +15611,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
15142
15611
  * Generated when the tray icon is clicked.
15143
15612
  * @interface
15144
15613
  */
15145
- declare type TrayIconClickedEvent = IdentityEvent & {
15614
+ declare type TrayIconClickedEvent = BaseEvents.IdentityEvent & {
15146
15615
  topic: 'application';
15147
15616
  type: 'tray-icon-clicked';
15148
15617
  button: 0 | 1 | 2;
@@ -15232,7 +15701,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15232
15701
  * A general user bounds change event without event type.
15233
15702
  * @interface
15234
15703
  */
15235
- declare type UserBoundsChangeEvent = BaseWindowEvent & {
15704
+ declare type UserBoundsChangeEvent = BaseEvent_5 & {
15236
15705
  height: number;
15237
15706
  left: number;
15238
15707
  top: number;
@@ -15244,7 +15713,7 @@ declare type UserBoundsChangeEvent = BaseWindowEvent & {
15244
15713
  * Generated when a window's user movement becomes disabled.
15245
15714
  * @interface
15246
15715
  */
15247
- declare type UserMovementDisabledEvent = BaseWindowEvent & {
15716
+ declare type UserMovementDisabledEvent = BaseEvent_5 & {
15248
15717
  type: 'user-movement-disabled';
15249
15718
  };
15250
15719
 
@@ -15252,7 +15721,7 @@ declare type UserMovementDisabledEvent = BaseWindowEvent & {
15252
15721
  * Generated when a window's user movement becomes enabled.
15253
15722
  * @interface
15254
15723
  */
15255
- declare type UserMovementEnabledEvent = BaseWindowEvent & {
15724
+ declare type UserMovementEnabledEvent = BaseEvent_5 & {
15256
15725
  type: 'user-movement-enabled';
15257
15726
  };
15258
15727
 
@@ -15898,23 +16367,31 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
15898
16367
  /* Excluded from this release type: bindToElement */
15899
16368
  }
15900
16369
 
15901
- declare type View_3 = OpenFin.View;
15902
-
15903
- declare type View_4 = OpenFin.View;
15904
-
15905
16370
  /**
15906
16371
  * Generated when a View is attached to a window.
15907
16372
  * @interface
15908
16373
  */
15909
- declare type ViewAttachedEvent = BaseWindowEvent & {
16374
+ declare type ViewAttachedEvent = BaseEvent_5 & {
15910
16375
  type: 'view-attached';
15911
16376
  target: OpenFin.Identity;
15912
16377
  viewIdentity: OpenFin.Identity;
15913
16378
  };
15914
16379
 
15915
- declare interface ViewComponent extends GoldenLayout.ContentItem {
15916
- componentState: OpenFin.ViewState;
15917
- }
16380
+ /**
16381
+ * A rule prescribing content creation in a {@link OpenFin.View}.
16382
+ *
16383
+ * @interface
16384
+ */
16385
+ declare type ViewContentCreationRule = BaseContentCreationRule & {
16386
+ /**
16387
+ * Behavior to use when opening matched content.
16388
+ */
16389
+ behavior: 'view';
16390
+ /**
16391
+ * Options for newly-created view.
16392
+ */
16393
+ options?: Partial<ViewOptions>;
16394
+ };
15918
16395
 
15919
16396
  /**
15920
16397
  * The options object required by {@link View.ViewModule.create View.create}.
@@ -15936,7 +16413,7 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
15936
16413
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
15937
16414
  * @interface
15938
16415
  */
15939
- declare type ViewDetachedEvent = BaseWindowEvent & {
16416
+ declare type ViewDetachedEvent = BaseEvent_5 & {
15940
16417
  type: 'view-detached';
15941
16418
  target: OpenFin.Identity;
15942
16419
  previousTarget: OpenFin.Identity;
@@ -15944,18 +16421,15 @@ declare type ViewDetachedEvent = BaseWindowEvent & {
15944
16421
  };
15945
16422
 
15946
16423
  /**
15947
- * [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
15948
- * discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
15949
- * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
16424
+ * @deprecated Renamed to {@link Event}.
15950
16425
  */
15951
- declare type ViewEvent = (WebContentsEvent<'view'> & {
15952
- target: OpenFin.Identity;
15953
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
16426
+ declare type ViewEvent = Event_4;
15954
16427
 
15955
16428
  declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
15956
16429
 
15957
16430
  declare namespace ViewEvents {
15958
16431
  export {
16432
+ BaseEvent_4 as BaseEvent,
15959
16433
  BaseViewEvent,
15960
16434
  TargetChangedEvent,
15961
16435
  NonPropagatedViewEvent,
@@ -15965,20 +16439,24 @@ declare namespace ViewEvents {
15965
16439
  HotkeyEvent,
15966
16440
  ShownEvent,
15967
16441
  HostContextChangedEvent,
16442
+ Event_4 as Event,
15968
16443
  ViewEvent,
15969
16444
  WillPropagateViewEvent,
16445
+ EventType,
15970
16446
  ViewEventType,
16447
+ PropagatedEvent_2 as PropagatedEvent,
15971
16448
  PropagatedViewEvent,
16449
+ PropagatedEventType_2 as PropagatedEventType,
15972
16450
  PropagatedViewEventType,
15973
- Payload_8 as Payload,
15974
- ByType_7 as ByType
16451
+ Payload_2 as Payload,
16452
+ ByType
15975
16453
  }
15976
16454
  }
15977
16455
 
15978
16456
  /**
15979
- * Union of possible `type` values for a {@link OpenFin.ViewEvents.ViewEvent}.
16457
+ * @deprecated Renamed to {@link EventType}.
15980
16458
  */
15981
- declare type ViewEventType = ViewEvent['type'];
16459
+ declare type ViewEventType = EventType;
15982
16460
 
15983
16461
  /**
15984
16462
  * @interface
@@ -16081,40 +16559,6 @@ declare class ViewModule extends Base {
16081
16559
  */
16082
16560
  declare type ViewOptions = ConstViewOptions & MutableViewOptions;
16083
16561
 
16084
- /**
16085
- * Api client allowing an empty electron BrowserView to be rendered
16086
- * in the current window with the specified bounds.
16087
- *
16088
- * Please note, only one view based overlay can be rendered at a time per runtime.
16089
- * @ignore
16090
- */
16091
- declare class ViewOverlay {
16092
- private wire;
16093
- constructor(wire: Transport);
16094
- /**
16095
- * Sets the style of the root <html> element of the view overlay webcontent.
16096
- * @param style A partial collection of Css style declarations to set.
16097
- */
16098
- setStyle: (style: Partial<CSSStyleDeclaration>) => Promise<void>;
16099
- /**
16100
- * Renders the overlay at the specified position relative to the calling window.
16101
- * @param options Bounds and background color to display in the overlay.
16102
- */
16103
- renderOverlay: (bounds: OpenFin.Bounds) => Promise<void>;
16104
- /**
16105
- * Removes the overlay from the current window.
16106
- */
16107
- detachOverlay: () => Promise<void>;
16108
- /**
16109
- * Allows setting all OpenFin views to ignore or consume mouse events.
16110
- *
16111
- * This can help with the rendering of view overlays that depend on OpenFin views not consuming mouse events.
16112
- *
16113
- * @param enabled If true, all mouse events are ignored by openfin views. If false, all OpenFin views will consume mouse events.
16114
- */
16115
- setIgnoreViewMouseEvents(enabled: boolean): Promise<void>;
16116
- }
16117
-
16118
16562
  /**
16119
16563
  * Represents the payload shape for Views that are trying to prevent an unload.
16120
16564
  * @interface
@@ -17151,12 +17595,9 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17151
17595
  }
17152
17596
 
17153
17597
  /**
17154
- * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
17155
- * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
17598
+ * @deprecated Renamed to {@link Event}.
17156
17599
  */
17157
- declare type WebContentsEvent<Topic extends string> = {
17158
- topic: Topic;
17159
- } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
17600
+ declare type WebContentsEvent<Topic extends string> = Event_5<Topic>;
17160
17601
 
17161
17602
  declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
17162
17603
 
@@ -17168,6 +17609,7 @@ declare namespace WebContentsEvents {
17168
17609
  CrashedEvent_2 as CrashedEvent,
17169
17610
  CertificateErrorEvent,
17170
17611
  CertificateSelectionShownEvent,
17612
+ PageFaviconUpdatedEvent,
17171
17613
  FaviconUpdatedEvent,
17172
17614
  NavigationRejectedEvent,
17173
17615
  UrlChangedEvent,
@@ -17186,6 +17628,7 @@ declare namespace WebContentsEvents {
17186
17628
  FileDownloadStartedEvent,
17187
17629
  FileDownloadProgressEvent,
17188
17630
  FileDownloadCompletedEvent,
17631
+ Event_5 as Event,
17189
17632
  WebContentsEvent,
17190
17633
  WillPropagateWebContentsEvent,
17191
17634
  NonPropagatedWebContentsEvent
@@ -17218,6 +17661,8 @@ declare type WebRequestHeader = {
17218
17661
  [key: string]: string;
17219
17662
  };
17220
17663
 
17664
+ declare type WebSocketReadyState = WebSocket['readyState'];
17665
+
17221
17666
  /**
17222
17667
  * Generated when a window is being moved by the user.
17223
17668
  * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
@@ -17231,7 +17676,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
17231
17676
  * A general will-move or will-resize event without event type.
17232
17677
  * @interface
17233
17678
  */
17234
- declare type WillMoveOrResizeEvent = BaseWindowEvent & {
17679
+ declare type WillMoveOrResizeEvent = BaseEvent_5 & {
17235
17680
  height: number;
17236
17681
  left: number;
17237
17682
  top: number;
@@ -17253,7 +17698,7 @@ declare type WillPropagateViewEvent = ViewEvent;
17253
17698
  *
17254
17699
  * A WebContents event that does propagate to (republish on) parent topics.
17255
17700
  */
17256
- declare type WillPropagateWebContentsEvent = WebContentsEvent<string>;
17701
+ declare type WillPropagateWebContentsEvent = Event_5<string>;
17257
17702
 
17258
17703
  /**
17259
17704
  * @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
@@ -17267,7 +17712,7 @@ declare type WillPropagateWindowEvent = WindowSourcedEvent;
17267
17712
  * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
17268
17713
  * @interface
17269
17714
  */
17270
- declare type WillRedirectEvent = BaseWindowEvent & {
17715
+ declare type WillRedirectEvent = BaseEvent_5 & {
17271
17716
  type: 'will-redirect';
17272
17717
  blocked: boolean;
17273
17718
  isInPlace: boolean;
@@ -18104,7 +18549,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18104
18549
  * ```
18105
18550
  * @experimental
18106
18551
  */
18107
- getLayout(): Promise<OpenFin.Layout>;
18552
+ getLayout(layoutIdentity?: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
18108
18553
  /**
18109
18554
  * Gets the current settings of the window.
18110
18555
  *
@@ -18822,28 +19267,34 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18822
19267
  };
18823
19268
 
18824
19269
  /**
18825
- * Generated when a window has closed.
18826
- * @interface
19270
+ * @deprecated Renamed to {@link ClosedEvent}.
18827
19271
  */
18828
- declare type WindowClosedEvent = BaseWindowEvent & {
18829
- type: 'closed';
18830
- };
19272
+ declare type WindowClosedEvent = ClosedEvent_2;
18831
19273
 
18832
19274
  /**
18833
- * Generated when a window has been prevented from closing.
18834
- * @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.
18835
- * @interface
19275
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
18836
19276
  */
18837
- declare type WindowCloseRequestedEvent = BaseWindowEvent & {
18838
- type: 'close-requested';
18839
- };
19277
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
19278
+
19279
+ /**
19280
+ * @deprecated Renamed to {@link ClosingEvent}.
19281
+ */
19282
+ declare type WindowClosingEvent = ClosingEvent;
18840
19283
 
18841
19284
  /**
18842
- * Generated when a window has initiated the closing routine.
19285
+ * A rule prescribing content creation in a {@link OpenFin.Window}.
19286
+ *
18843
19287
  * @interface
18844
19288
  */
18845
- declare type WindowClosingEvent = BaseWindowEvent & {
18846
- type: 'closing';
19289
+ declare type WindowContentCreationRule = BaseContentCreationRule & {
19290
+ /**
19291
+ * Behavior to use when opening matched content.
19292
+ */
19293
+ behavior: 'window';
19294
+ /**
19295
+ * Options for newly-created window.
19296
+ */
19297
+ options?: Partial<WindowOptions>;
18847
19298
  };
18848
19299
 
18849
19300
  /**
@@ -18912,16 +19363,15 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18912
19363
  };
18913
19364
 
18914
19365
  /**
18915
- * [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
18916
- * discriminated by {@link WindowEvent.type | their type}. Event payloads unique to `Window` can be found
18917
- * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
19366
+ * @deprecated, Renamed to {@link Event}.
18918
19367
  */
18919
- declare type WindowEvent = WindowSourcedEvent | PropagatedViewEvent<'window'>;
19368
+ declare type WindowEvent = Event_6;
18920
19369
 
18921
19370
  declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
18922
19371
 
18923
19372
  declare namespace WindowEvents {
18924
19373
  export {
19374
+ BaseEvent_5 as BaseEvent,
18925
19375
  BaseWindowEvent,
18926
19376
  ViewAttachedEvent,
18927
19377
  ViewDetachedEvent,
@@ -18931,9 +19381,11 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18931
19381
  EndLoadEvent,
18932
19382
  WillRedirectEvent,
18933
19383
  ReloadedEvent,
19384
+ OptionsChangedEvent,
18934
19385
  WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
18935
19386
  ExternalProcessExitedEvent,
18936
19387
  ExternalProcessStartedEvent,
19388
+ HiddenEvent_2 as HiddenEvent,
18937
19389
  WindowHiddenEvent,
18938
19390
  PreloadScriptInfoRunning,
18939
19391
  PreloadScriptInfo,
@@ -18948,61 +19400,66 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18948
19400
  BeginUserBoundsChangingEvent,
18949
19401
  BoundsChangedEvent,
18950
19402
  BoundsChangingEvent,
19403
+ CloseRequestedEvent,
18951
19404
  WindowCloseRequestedEvent,
18952
19405
  ContextChangedEvent,
19406
+ ClosedEvent_2 as ClosedEvent,
18953
19407
  WindowClosedEvent,
19408
+ ClosingEvent,
18954
19409
  WindowClosingEvent,
18955
19410
  DisabledMovementBoundsChangedEvent,
18956
19411
  DisabledMovementBoundsChangingEvent,
18957
19412
  EmbeddedEvent,
18958
19413
  EndUserBoundsChangingEvent,
19414
+ HotkeyEvent_2 as HotkeyEvent,
18959
19415
  WindowHotkeyEvent,
19416
+ InitializedEvent_2 as InitializedEvent,
18960
19417
  WindowInitializedEvent,
18961
19418
  MaximizedEvent,
18962
19419
  MinimizedEvent,
18963
19420
  PreloadScriptsStateChangedEvent,
18964
19421
  PreloadScriptsStateChangingEvent,
19422
+ RestoredEvent,
18965
19423
  WindowRestoredEvent,
19424
+ ShowRequestedEvent,
18966
19425
  WindowShowRequestedEvent,
19426
+ ShownEvent_2 as ShownEvent,
18967
19427
  WindowShownEvent,
18968
19428
  UserMovementEnabledEvent,
18969
19429
  UserMovementDisabledEvent,
18970
19430
  WillMoveEvent,
18971
19431
  WillResizeEvent,
18972
19432
  NonPropagatedWindowEvent,
19433
+ ShowAllDownloadsEvent,
19434
+ DownloadShelfVisibilityChangedEvent,
18973
19435
  WindowSourcedEvent,
18974
19436
  WillPropagateWindowEvent,
19437
+ Event_6 as Event,
18975
19438
  WindowEvent,
19439
+ EventType_2 as EventType,
18976
19440
  WindowEventType,
19441
+ PropagatedEvent_3 as PropagatedEvent,
18977
19442
  PropagatedWindowEvent,
18978
19443
  PropagatedWindowEventType,
18979
- Payload_9 as Payload,
18980
- ByType_8 as ByType
19444
+ Payload_3 as Payload,
19445
+ ByType_2 as ByType
18981
19446
  }
18982
19447
  }
18983
19448
 
18984
19449
  /**
18985
- * Union of possible `type` values for a {@link OpenFin.WindowEvents.WindowEvent}.
19450
+ * @deprecated Renamed to {@link EventType}.
18986
19451
  */
18987
19452
  declare type WindowEventType = WindowEvent['type'];
18988
19453
 
18989
19454
  /**
18990
- * Generated when a window has been hidden.
18991
- * @interface
19455
+ * @deprecated Renamed to {@link HiddenEvent}.
18992
19456
  */
18993
- declare type WindowHiddenEvent = BaseWindowEvent & {
18994
- type: 'hidden';
18995
- reason: 'closing' | 'hide' | 'hide-on-close';
18996
- };
19457
+ declare type WindowHiddenEvent = HiddenEvent_2;
18997
19458
 
18998
19459
  /**
18999
- * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
19000
- * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
19001
- * @interface
19460
+ * @deprecated Renamed to {@link HotkeyEvent}.
19002
19461
  */
19003
- declare type WindowHotkeyEvent = InputEvent_2 & BaseWindowEvent & {
19004
- type: 'hotkey';
19005
- };
19462
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
19006
19463
 
19007
19464
  /**
19008
19465
  * @interface
@@ -19016,12 +19473,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19016
19473
  };
19017
19474
 
19018
19475
  /**
19019
- * Generated when a window is initialized.
19020
- * @interface
19476
+ * @deprecated Renamed to {@link InitializedEvent}.
19021
19477
  */
19022
- declare type WindowInitializedEvent = BaseWindowEvent & {
19023
- type: 'initialized';
19024
- };
19478
+ declare type WindowInitializedEvent = InitializedEvent_2;
19025
19479
 
19026
19480
  /**
19027
19481
  * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
@@ -19140,15 +19594,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19140
19594
  declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
19141
19595
 
19142
19596
  /**
19143
- * Generated after window options are changed using the window.updateOptions method.
19144
- * @remarks Will not fire if the diff object is empty.
19145
- * @interface
19597
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
19146
19598
  */
19147
- declare type WindowOptionsChangedEvent_2 = BaseWindowEvent & {
19148
- type: 'options-changed';
19149
- options: OpenFin.WindowOptions;
19150
- diff: OpenFin.WindowOptionDiff;
19151
- };
19599
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
19152
19600
 
19153
19601
  declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
19154
19602
 
@@ -19161,35 +19609,25 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19161
19609
  };
19162
19610
 
19163
19611
  /**
19164
- * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
19165
- * @interface
19612
+ * @deprecated Renamed to {@link RestoredEvent}.
19166
19613
  */
19167
- declare type WindowRestoredEvent = BaseWindowEvent & {
19168
- type: 'restored';
19169
- };
19614
+ declare type WindowRestoredEvent = RestoredEvent;
19170
19615
 
19171
19616
  /**
19172
- * Generated when a hidden window has been shown.
19173
- * @interface
19617
+ * @deprecated Renamed to {@link ShownEvent}.
19174
19618
  */
19175
- declare type WindowShownEvent = BaseWindowEvent & {
19176
- type: 'shown';
19177
- };
19619
+ declare type WindowShownEvent = ShownEvent_2;
19178
19620
 
19179
19621
  /**
19180
- * Generated when a window has been prevented from showing.
19181
- * @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.
19182
- * @interface
19622
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
19183
19623
  */
19184
- declare type WindowShowRequestedEvent = BaseWindowEvent & {
19185
- type: 'show-requested';
19186
- };
19624
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
19187
19625
 
19188
19626
  /**
19189
19627
  * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19190
19628
  * from {@link OpenFin.ViewEvents}.
19191
19629
  */
19192
- 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;
19630
+ 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;
19193
19631
 
19194
19632
  /**
19195
19633
  * Generated when a child window starts loading.
@@ -19221,7 +19659,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19221
19659
  };
19222
19660
 
19223
19661
  declare type Wire = EventEmitter & {
19224
- connect(address: string, WsConstructor: typeof WebSocket): Promise<any>;
19662
+ connect(messageReciever: MessageReceiver): Promise<any>;
19225
19663
  connectSync(): any;
19226
19664
  send(data: any): Promise<any>;
19227
19665
  shutdown(): Promise<void>;