@openfin/node-adapter 34.78.34 → 34.78.38

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.
@@ -57,7 +57,7 @@ declare type AddViewToStackOptions = {
57
57
  * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
58
58
  * @interface
59
59
  */
60
- declare type AlertRequestedEvent = NamedEvent & {
60
+ declare type AlertRequestedEvent = BaseWindowEvent & {
61
61
  type: 'alert-requested';
62
62
  message: string;
63
63
  url: string;
@@ -853,6 +853,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
853
853
  * @interface
854
854
  */
855
855
  declare type ApplicationConnectedEvent = IdentityEvent & {
856
+ topic: 'application';
856
857
  type: 'connected';
857
858
  };
858
859
 
@@ -860,7 +861,7 @@ declare type ApplicationConnectedEvent = IdentityEvent & {
860
861
  * Generated when an application is created.
861
862
  * @interface
862
863
  */
863
- declare type ApplicationCreatedEvent = IdentityEvent & {
864
+ declare type ApplicationCreatedEvent = BaseSystemEvent & IdentityEvent & {
864
865
  type: 'application-created';
865
866
  };
866
867
 
@@ -889,14 +890,13 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
889
890
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
890
891
  * from which they propagate).
891
892
  */
892
- declare type ApplicationEvent = {
893
- topic: 'application';
894
- } & (PropagatedViewEvent | PropagatedWindowEvent | ApplicationWindowEvent | WillPropagateApplicationEvent);
893
+ declare type ApplicationEvent = PropagatedViewEvent<'application'> | PropagatedWindowEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
895
894
 
896
895
  declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
897
896
 
898
897
  declare namespace ApplicationEvents {
899
898
  export {
899
+ BaseApplicationEvent,
900
900
  CrashedEvent,
901
901
  FileDownloadLocationChangedEvent,
902
902
  RunRequestedEvent_2 as RunRequestedEvent,
@@ -915,16 +915,18 @@ declare namespace ApplicationEvents {
915
915
  NotRespondingEvent,
916
916
  RespondingEvent,
917
917
  StartedEvent,
918
- WillPropagateApplicationEvent,
918
+ ApplicationSourcedEvent,
919
919
  ApplicationEvent,
920
920
  ApplicationEventType,
921
921
  PropagatedApplicationEvent,
922
- PropagatedApplicationEventType
922
+ PropagatedApplicationEventType,
923
+ Payload_2 as Payload,
924
+ ByType
923
925
  }
924
926
  }
925
927
 
926
928
  /**
927
- * An Application event type.
929
+ * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
928
930
  */
929
931
  declare type ApplicationEventType = ApplicationEvent['type'];
930
932
 
@@ -1275,6 +1277,14 @@ declare type ApplicationPermissions = {
1275
1277
  getFileDownloadLocation: boolean;
1276
1278
  };
1277
1279
 
1280
+ /**
1281
+ * A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
1282
+ * from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
1283
+ * does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
1284
+ *
1285
+ */
1286
+ declare type ApplicationSourcedEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1287
+
1278
1288
  declare type ApplicationState = OpenFin.ApplicationState;
1279
1289
 
1280
1290
  /**
@@ -1512,14 +1522,6 @@ declare type AppVersionRuntimeStatusEvent = {
1512
1522
 
1513
1523
  /* Excluded from this release type: AppVersionTypeFromIdEvent */
1514
1524
 
1515
- /**
1516
- * Generated when a View is attached to a window.
1517
- * @interface
1518
- */
1519
- declare type AttachedEvent = BaseViewEvent & {
1520
- type: 'attached';
1521
- };
1522
-
1523
1525
  declare interface AuthorizationPayload {
1524
1526
  token: string;
1525
1527
  file: string;
@@ -1589,7 +1591,7 @@ declare interface AuthorizationPayload {
1589
1591
  * ```
1590
1592
  * @interface
1591
1593
  */
1592
- declare type AuthRequestedEvent = NamedEvent & {
1594
+ declare type AuthRequestedEvent = BaseWindowEvent & {
1593
1595
  type: 'auth-requested';
1594
1596
  authInfo: {
1595
1597
  host: string;
@@ -1650,6 +1652,14 @@ declare class Base {
1650
1652
  protected isBrowserEnvironment: () => boolean;
1651
1653
  }
1652
1654
 
1655
+ /**
1656
+ * Base type for events emitting on the `application` topic
1657
+ * @interface
1658
+ */
1659
+ declare type BaseApplicationEvent = NamedEvent & {
1660
+ topic: `application`;
1661
+ };
1662
+
1653
1663
  /**
1654
1664
  * A base Channel event.
1655
1665
  * @interface
@@ -1722,6 +1732,14 @@ declare namespace BaseEvents {
1722
1732
  }
1723
1733
  }
1724
1734
 
1735
+ /**
1736
+ * Base type for events emitting on the `externalapplication` topic
1737
+ * @interface
1738
+ */
1739
+ declare type BaseExternalApplicationEvent = BaseEvent & {
1740
+ topic: 'externalapplication';
1741
+ };
1742
+
1725
1743
  /**
1726
1744
  * The base frame event.
1727
1745
  * @interface
@@ -1738,18 +1756,34 @@ declare type BaseLoadFailedEvent = NamedEvent & {
1738
1756
  isMainFrame: boolean;
1739
1757
  };
1740
1758
 
1759
+ /**
1760
+ * Base type for events emitting on the `system` topic
1761
+ * @interface
1762
+ */
1763
+ declare type BaseSystemEvent = BaseEvent & {
1764
+ topic: 'system';
1765
+ };
1766
+
1741
1767
  declare type BaseUrlEvent = NamedEvent & {
1742
1768
  type: 'url-changed';
1743
1769
  url: string;
1744
1770
  };
1745
1771
 
1746
1772
  /**
1747
- * A base View event.
1773
+ * Base type for events emitting on the `view` topic
1748
1774
  * @interface
1749
1775
  */
1750
1776
  declare type BaseViewEvent = NamedEvent & {
1777
+ topic: 'view';
1751
1778
  target: OpenFin.Identity;
1752
- viewIdentity: OpenFin.Identity;
1779
+ };
1780
+
1781
+ /**
1782
+ * Base type for events emitting on the `window` topic
1783
+ * @interface
1784
+ */
1785
+ declare type BaseWindowEvent = NamedEvent & {
1786
+ topic: 'window';
1753
1787
  };
1754
1788
 
1755
1789
  /**
@@ -1805,7 +1839,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
1805
1839
  * A general bounds change event without event type.
1806
1840
  * @interface
1807
1841
  */
1808
- declare type BoundsChangeEvent = NamedEvent & {
1842
+ declare type BoundsChangeEvent = BaseWindowEvent & {
1809
1843
  changeType: 0 | 1 | 2;
1810
1844
  deferred: boolean;
1811
1845
  height: number;
@@ -1864,6 +1898,78 @@ declare interface BrowserWindow {
1864
1898
  popIn(): void;
1865
1899
  }
1866
1900
 
1901
+ /**
1902
+ * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
1903
+ *
1904
+ * Alias for {@link Payload}, which may read better in source.
1905
+ *
1906
+ * @typeParam Type String key specifying the event to extract
1907
+ */
1908
+ declare type ByType<Type extends ApplicationEventType> = Payload_2<Type>;
1909
+
1910
+ /**
1911
+ * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
1912
+ *
1913
+ * Alias for {@link Payload}, which may read better in source.
1914
+ *
1915
+ * @typeParam Type String key specifying the event to extract
1916
+ */
1917
+ declare type ByType_2<Type extends ExternalApplicationEventType> = Payload_3<Type>;
1918
+
1919
+ /**
1920
+ * Extracts a single event type matching the given key from the {@link FrameEvent} union.
1921
+ *
1922
+ * Alias for {@link Payload}, which may read better in source.
1923
+ *
1924
+ * @typeParam Type String key specifying the event to extract
1925
+ */
1926
+ declare type ByType_3<Type extends FrameEventType> = Payload_4<Type>;
1927
+
1928
+ /**
1929
+ * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
1930
+ *
1931
+ * Alias for {@link Payload}, which may read better in source.
1932
+ *
1933
+ * @typeParam Type String key specifying the event to extract
1934
+ */
1935
+ declare type ByType_4<Type extends GlobalHotkeyEventType> = Payload_5<Type>;
1936
+
1937
+ /**
1938
+ * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
1939
+ *
1940
+ * Alias for {@link Payload}, which may read better in source.
1941
+ *
1942
+ * @typeParam Type String key specifying the event to extract
1943
+ */
1944
+ declare type ByType_5<Type extends PlatformEventType> = Payload_6<Type>;
1945
+
1946
+ /**
1947
+ * Extracts a single event type matching the given key from the {@link SystemEvent} union.
1948
+ *
1949
+ * Alias for {@link Payload}, which may read better in source.
1950
+ *
1951
+ * @typeParam Type String key specifying the event to extract
1952
+ */
1953
+ declare type ByType_6<Type extends SystemEventType> = Payload_7<Type>;
1954
+
1955
+ /**
1956
+ * Extracts a single event type matching the given key from the {@link ViewEvent} union.
1957
+ *
1958
+ * Alias for {@link Payload}, which may read better in source.
1959
+ *
1960
+ * @typeParam Type String key specifying the event to extract
1961
+ */
1962
+ declare type ByType_7<Type extends ViewEventType> = Payload_8<Type>;
1963
+
1964
+ /**
1965
+ * Extracts a single event type matching the given key from the {@link WindowEvent} union.
1966
+ *
1967
+ * Alias for {@link Payload}, which may read better in source.
1968
+ *
1969
+ * @typeParam Type String key specifying the event to extract
1970
+ */
1971
+ declare type ByType_8<Type extends WindowEventType> = Payload_9<Type>;
1972
+
1867
1973
  /**
1868
1974
  * Configuration for page capture.
1869
1975
  *
@@ -2575,7 +2681,9 @@ declare type ChannelDisconnectedEvent = BaseChannelEvent & {
2575
2681
  };
2576
2682
 
2577
2683
  /**
2578
- * A Channel event.
2684
+ * [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
2685
+ * discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
2686
+ * under the {@link OpenFin.ChannelEvents} namespace.
2579
2687
  */
2580
2688
  declare type ChannelEvent = {
2581
2689
  topic: 'channel';
@@ -3115,6 +3223,7 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
3115
3223
  * @interface
3116
3224
  */
3117
3225
  declare type ClosedEvent = IdentityEvent & {
3226
+ topic: 'application';
3118
3227
  type: 'closed';
3119
3228
  };
3120
3229
 
@@ -4117,7 +4226,22 @@ declare type CpuInfo = {
4117
4226
  * Generated when an application has crashed.
4118
4227
  * @interface
4119
4228
  */
4120
- declare type CrashedEvent = NamedEvent & {
4229
+ declare type CrashedEvent = IdentityEvent & {
4230
+ topic: 'application';
4231
+ type: 'crashed';
4232
+ reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
4233
+ exitCode: number;
4234
+ details: {
4235
+ reason: string;
4236
+ exitCode: number;
4237
+ };
4238
+ };
4239
+
4240
+ /**
4241
+ * Generated when a WebContents has crashed.
4242
+ * @interface
4243
+ */
4244
+ declare type CrashedEvent_2 = NamedEvent & {
4121
4245
  type: 'crashed';
4122
4246
  reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
4123
4247
  exitCode: number;
@@ -4263,7 +4387,7 @@ declare interface DesktopAgent_2 {
4263
4387
  * Generated when the desktop icon is clicked while it's already running.
4264
4388
  * @interface
4265
4389
  */
4266
- declare type DesktopIconClickedEvent = BaseEvent & {
4390
+ declare type DesktopIconClickedEvent = BaseSystemEvent & {
4267
4391
  type: 'desktop-icon-clicked';
4268
4392
  };
4269
4393
 
@@ -4493,7 +4617,7 @@ declare interface DragSource {}
4493
4617
  * Generated when a window has been embedded.
4494
4618
  * @interface
4495
4619
  */
4496
- declare type EmbeddedEvent = NamedEvent & {
4620
+ declare type EmbeddedEvent = BaseWindowEvent & {
4497
4621
  type: 'embedded';
4498
4622
  };
4499
4623
 
@@ -4592,7 +4716,7 @@ declare class EmitterMap {
4592
4716
  * Generated when a window ends loading.
4593
4717
  * @interface
4594
4718
  */
4595
- declare type EndLoadEvent = NamedEvent & {
4719
+ declare type EndLoadEvent = BaseWindowEvent & {
4596
4720
  type: 'end-load';
4597
4721
  documentName: string;
4598
4722
  isMain: boolean;
@@ -4898,7 +5022,7 @@ declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicatio
4898
5022
  * Generated when an external application has authenticated and is connected.
4899
5023
  * @interface
4900
5024
  */
4901
- declare type ExternalApplicationConnectedEvent = BaseEvent & {
5025
+ declare type ExternalApplicationConnectedEvent = BaseExternalApplicationEvent & {
4902
5026
  type: 'connected';
4903
5027
  };
4904
5028
 
@@ -4906,7 +5030,7 @@ declare type ExternalApplicationConnectedEvent = BaseEvent & {
4906
5030
  * Generated when an external application has disconnected.
4907
5031
  * @interface
4908
5032
  */
4909
- declare type ExternalApplicationDisconnectedEvent = BaseEvent & {
5033
+ declare type ExternalApplicationDisconnectedEvent = BaseExternalApplicationEvent & {
4910
5034
  type: 'disconnected';
4911
5035
  };
4912
5036
 
@@ -4915,20 +5039,27 @@ declare type ExternalApplicationDisconnectedEvent = BaseEvent & {
4915
5039
  * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
4916
5040
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
4917
5041
  */
4918
- declare type ExternalApplicationEvent = {
4919
- topic: 'externalapplication';
4920
- } & (ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent);
5042
+ declare type ExternalApplicationEvent = ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent;
4921
5043
 
4922
5044
  declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
4923
5045
 
4924
5046
  declare namespace ExternalApplicationEvents {
4925
5047
  export {
5048
+ BaseExternalApplicationEvent,
4926
5049
  ExternalApplicationConnectedEvent,
4927
5050
  ExternalApplicationDisconnectedEvent,
4928
- ExternalApplicationEvent
5051
+ ExternalApplicationEvent,
5052
+ ExternalApplicationEventType,
5053
+ Payload_3 as Payload,
5054
+ ByType_2 as ByType
4929
5055
  }
4930
5056
  }
4931
5057
 
5058
+ /**
5059
+ * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
5060
+ */
5061
+ declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
5062
+
4932
5063
  /**
4933
5064
  * @interface
4934
5065
  */
@@ -4992,7 +5123,7 @@ declare type ExternalConnection = {
4992
5123
  * Generated when an external process has exited.
4993
5124
  * @interface
4994
5125
  */
4995
- declare type ExternalProcessExitedEvent = NamedEvent & {
5126
+ declare type ExternalProcessExitedEvent = BaseWindowEvent & {
4996
5127
  type: 'external-process-exited';
4997
5128
  processUuid: string;
4998
5129
  exitCode: number;
@@ -5037,7 +5168,7 @@ declare type ExternalProcessRequestType = {
5037
5168
  * Generated when an external process has started.
5038
5169
  * @interface
5039
5170
  */
5040
- declare type ExternalProcessStartedEvent = NamedEvent & {
5171
+ declare type ExternalProcessStartedEvent = BaseWindowEvent & {
5041
5172
  type: 'external-process-started';
5042
5173
  processUuid: string;
5043
5174
  };
@@ -5136,7 +5267,7 @@ declare type FileDownloadEvent = {
5136
5267
  *
5137
5268
  * @interface
5138
5269
  */
5139
- declare type FileDownloadLocationChangedEvent = NamedEvent & {
5270
+ declare type FileDownloadLocationChangedEvent = BaseApplicationEvent & {
5140
5271
  type: 'file-download-location-changed';
5141
5272
  };
5142
5273
 
@@ -5419,7 +5550,9 @@ declare type FrameDisconnectedEvent = BaseFrameEvent & {
5419
5550
  };
5420
5551
 
5421
5552
  /**
5422
- * A Frame event.
5553
+ * [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
5554
+ * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5555
+ * under the {@link OpenFin.FrameEvents} namespace.
5423
5556
  */
5424
5557
  declare type FrameEvent = {
5425
5558
  topic: 'frame';
@@ -5433,14 +5566,14 @@ declare namespace FrameEvents {
5433
5566
  FrameConnectedEvent,
5434
5567
  FrameDisconnectedEvent,
5435
5568
  FrameEvent,
5436
- FrameEventType
5569
+ FrameEventType,
5570
+ Payload_4 as Payload,
5571
+ ByType_3 as ByType
5437
5572
  }
5438
5573
  }
5439
5574
 
5440
5575
  /**
5441
- * [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
5442
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5443
- * under the {@link OpenFin.FrameEvents} namespace.
5576
+ * Union of possible `type` values for a {@link FrameEvent}.
5444
5577
  */
5445
5578
  declare type FrameEventType = FrameEvent['type'];
5446
5579
 
@@ -5674,10 +5807,18 @@ declare namespace GlobalHotkeyEvents {
5674
5807
  export {
5675
5808
  RegisteredEvent,
5676
5809
  UnregisteredEvent,
5677
- GlobalHotkeyEvent
5810
+ GlobalHotkeyEvent,
5811
+ GlobalHotkeyEventType,
5812
+ Payload_5 as Payload,
5813
+ ByType_4 as ByType
5678
5814
  }
5679
5815
  }
5680
5816
 
5817
+ /**
5818
+ * Union of possible `type` values for a {@link GlobalHotkeyEvent}
5819
+ */
5820
+ declare type GlobalHotkeyEventType = GlobalHotkeyEvent['type'];
5821
+
5681
5822
  declare namespace GoldenLayout {
5682
5823
  export {
5683
5824
  GoldenLayout_2 as GoldenLayout,
@@ -6120,7 +6261,7 @@ declare type IdentityEvent = BaseEvent & {
6120
6261
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6121
6262
  * @interface
6122
6263
  */
6123
- declare type IdleEvent = {
6264
+ declare type IdleEvent = BaseSystemEvent & {
6124
6265
  type: 'idle-state-changed';
6125
6266
  elapsedTime: number;
6126
6267
  isIdle: boolean;
@@ -6206,6 +6347,7 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6206
6347
  * @interface
6207
6348
  */
6208
6349
  declare type InitializedEvent = IdentityEvent & {
6350
+ topic: 'application';
6209
6351
  type: 'initialized';
6210
6352
  };
6211
6353
 
@@ -8255,7 +8397,7 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
8255
8397
  * Generated when a window and all of its layout's views have either finished or failed navigation.
8256
8398
  * @interface
8257
8399
  */
8258
- declare type LayoutInitializedEvent = NamedEvent & {
8400
+ declare type LayoutInitializedEvent = BaseWindowEvent & {
8259
8401
  type: 'layout-initialized';
8260
8402
  ofViews: (OpenFin.Identity & {
8261
8403
  entityType: 'view';
@@ -8593,7 +8735,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
8593
8735
  * Generated when a window and all of its layout's views have been created and can receive API calls.
8594
8736
  * @interface
8595
8737
  */
8596
- declare type LayoutReadyEvent = NamedEvent & {
8738
+ declare type LayoutReadyEvent = BaseWindowEvent & {
8597
8739
  type: 'layout-ready';
8598
8740
  views: (OpenFin.Identity & {
8599
8741
  success: boolean;
@@ -8728,6 +8870,7 @@ declare type Manifest = {
8728
8870
  * @interface
8729
8871
  */
8730
8872
  declare type ManifestChangedEvent = IdentityEvent & {
8873
+ topic: 'application';
8731
8874
  type: 'manifest-changed';
8732
8875
  };
8733
8876
 
@@ -8779,7 +8922,7 @@ declare type MatchPattern = string;
8779
8922
  * Generated when a window is maximized.
8780
8923
  * @interface
8781
8924
  */
8782
- declare type MaximizedEvent = NamedEvent & {
8925
+ declare type MaximizedEvent = BaseWindowEvent & {
8783
8926
  type: 'maximized';
8784
8927
  };
8785
8928
 
@@ -8879,7 +9022,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
8879
9022
  * Generated when a window is minimized.
8880
9023
  * @interface
8881
9024
  */
8882
- declare type MinimizedEvent = NamedEvent & {
9025
+ declare type MinimizedEvent = BaseWindowEvent & {
8883
9026
  type: 'minimized';
8884
9027
  };
8885
9028
 
@@ -8928,7 +9071,7 @@ declare type MonitorDetails = {
8928
9071
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
8929
9072
  * @interface
8930
9073
  */
8931
- declare type MonitorEvent = OpenFin.MonitorInfo & {
9074
+ declare type MonitorEvent = BaseSystemEvent & OpenFin.MonitorInfo & {
8932
9075
  type: 'monitor-info-changed';
8933
9076
  };
8934
9077
 
@@ -9330,19 +9473,25 @@ declare type NonAppProcessDetails = ProcessDetails & {
9330
9473
  };
9331
9474
 
9332
9475
  /**
9333
- * A View event that does not propagate to (republish on) parent topics.
9476
+ * @DEPRECATED All view events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
9477
+ *
9478
+ * A view event that does not propagate to (republish on) parent topics.
9334
9479
  */
9335
- declare type NonPropagatedViewEvent = BaseViewEvent & NonPropagatedWebContentsEvent;
9480
+ declare type NonPropagatedViewEvent = never;
9336
9481
 
9337
9482
  /**
9483
+ * @DEPRECATED all webcontents events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
9484
+ *
9338
9485
  * A WebContents event that does not propagate to (republish on) parent topics.
9339
9486
  */
9340
- declare type NonPropagatedWebContentsEvent = FoundInPageEvent | CertificateErrorEvent;
9487
+ declare type NonPropagatedWebContentsEvent = never;
9341
9488
 
9342
9489
  /**
9343
- * A Window event that does not propagate to (republish on) parent topics.
9490
+ * @DEPRECATED All window events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
9491
+ *
9492
+ * A window event that does not propagate to (republish on) parent topics.
9344
9493
  */
9345
- declare type NonPropagatedWindowEvent = NonPropagatedWebContentsEvent;
9494
+ declare type NonPropagatedWindowEvent = never;
9346
9495
 
9347
9496
  /* Excluded from this release type: NotRequested */
9348
9497
 
@@ -9351,6 +9500,7 @@ declare type NonPropagatedWindowEvent = NonPropagatedWebContentsEvent;
9351
9500
  * @interface
9352
9501
  */
9353
9502
  declare type NotRespondingEvent = IdentityEvent & {
9503
+ topic: 'application';
9354
9504
  type: 'not-responding';
9355
9505
  };
9356
9506
 
@@ -9718,13 +9868,85 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
9718
9868
  error?: Success extends false ? ErrorPlainObject | undefined : never;
9719
9869
  };
9720
9870
 
9871
+ /**
9872
+ * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
9873
+ *
9874
+ * @typeParam Type String key specifying the event to extract
9875
+ */
9876
+ declare type Payload_2<Type extends ApplicationEventType> = Extract<ApplicationEvent, {
9877
+ type: Type;
9878
+ }>;
9879
+
9880
+ /**
9881
+ * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
9882
+ *
9883
+ * @typeParam Type String key specifying the event to extract
9884
+ */
9885
+ declare type Payload_3<Type extends ExternalApplicationEventType> = Extract<ExternalApplicationEvent, {
9886
+ type: Type;
9887
+ }>;
9888
+
9889
+ /**
9890
+ * Extracts a single event type matching the given key from the {@link FrameEvent} union.
9891
+ *
9892
+ * @typeParam Type String key specifying the event to extract
9893
+ */
9894
+ declare type Payload_4<Type extends FrameEventType> = Extract<FrameEvent, {
9895
+ type: Type;
9896
+ }>;
9897
+
9898
+ /**
9899
+ * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
9900
+ *
9901
+ * @typeParam Type String key specifying the event to extract
9902
+ */
9903
+ declare type Payload_5<Type extends GlobalHotkeyEventType> = Extract<GlobalHotkeyEvent, {
9904
+ type: Type;
9905
+ }>;
9906
+
9907
+ /**
9908
+ * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
9909
+ *
9910
+ * @typeParam Type String key specifying the event to extract
9911
+ */
9912
+ declare type Payload_6<Type extends PlatformEventType> = Extract<PlatformEvent, {
9913
+ type: Type;
9914
+ }>;
9915
+
9916
+ /**
9917
+ * Extracts a single event type matching the given key from the {@link SystemEvent} union.
9918
+ *
9919
+ * @typeParam Type String key specifying the event to extract
9920
+ */
9921
+ declare type Payload_7<Type extends SystemEventType> = Extract<SystemEvent, {
9922
+ type: Type;
9923
+ }>;
9924
+
9925
+ /**
9926
+ * Extracts a single event type matching the given key from the {@link ViewEvent} union.
9927
+ *
9928
+ * @typeParam Type String key specifying the event to extract
9929
+ */
9930
+ declare type Payload_8<Type extends ViewEventType> = Extract<ViewEvent, {
9931
+ type: Type;
9932
+ }>;
9933
+
9934
+ /**
9935
+ * Extracts a single event type matching the given key from the {@link WindowEvent} union.
9936
+ *
9937
+ * @typeParam Type String key specifying the event to extract
9938
+ */
9939
+ declare type Payload_9<Type extends WindowEventType> = Extract<WindowEvent, {
9940
+ type: Type;
9941
+ }>;
9942
+
9721
9943
  declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T extends ChannelStrategy<infer U> ? U : never;
9722
9944
 
9723
9945
  /**
9724
9946
  * Generated when window finishes loading. Provides performance and navigation data.
9725
9947
  * @interface
9726
9948
  */
9727
- declare type PerformanceReportEvent = Performance & NamedEvent & {
9949
+ declare type PerformanceReportEvent = Performance & BaseWindowEvent & {
9728
9950
  type: 'performance-report';
9729
9951
  };
9730
9952
 
@@ -10381,10 +10603,18 @@ declare namespace PlatformEvents {
10381
10603
  export {
10382
10604
  PlatformApiReadyEvent,
10383
10605
  PlatformSnapshotAppliedEvent,
10384
- PlatformEvent
10606
+ PlatformEvent,
10607
+ PlatformEventType,
10608
+ Payload_6 as Payload,
10609
+ ByType_5 as ByType
10385
10610
  }
10386
10611
  }
10387
10612
 
10613
+ /**
10614
+ * Union of possible `type` values for a {@link PlatformEvent}.
10615
+ */
10616
+ declare type PlatformEventType = PlatformEvent['type'];
10617
+
10388
10618
  /**
10389
10619
  * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
10390
10620
  */
@@ -11326,7 +11556,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
11326
11556
  * A general preload scripts state change event without event type.
11327
11557
  * @interface
11328
11558
  */
11329
- declare type PreloadScriptsStateChangeEvent = NamedEvent & {
11559
+ declare type PreloadScriptsStateChangeEvent = BaseWindowEvent & {
11330
11560
  preloadScripts: (PreloadScriptInfoRunning & any)[];
11331
11561
  };
11332
11562
 
@@ -11535,25 +11765,30 @@ declare type ProcessLoggingOptions = {
11535
11765
  };
11536
11766
 
11537
11767
  /**
11538
- * A propagated Application event.
11768
+ * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
11769
+ * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
11770
+ * are propagated to `System` without any type string prefixing.
11771
+ *
11772
+ * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
11539
11773
  */
11540
- declare type PropagatedApplicationEvent = PropagatedEvent<'application', WillPropagateApplicationEvent> | ApplicationWindowEvent;
11774
+ declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
11541
11775
 
11542
11776
  /**
11543
- * A propagated Application event type.
11777
+ * Union of possible 'type' values for a {@link OpenFin.ApplicationEvents.PropagatedApplicationEvent}.
11544
11778
  */
11545
- declare type PropagatedApplicationEventType = PropagatedApplicationEvent['type'];
11779
+ declare type PropagatedApplicationEventType = PropagatedApplicationEvent<string>['type'];
11546
11780
 
11547
11781
  /**
11548
11782
  * Modifies an event shape to reflect propagation to a parent topic.
11549
11783
  * @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
11550
11784
  */
11551
- declare type PropagatedEvent<Topic extends string, Event extends {
11785
+ declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
11552
11786
  type: string;
11553
11787
  }> = Event extends infer E extends {
11554
11788
  type: string;
11555
- } ? Omit<E, 'type'> & {
11556
- type: PropagatedEventType<Topic, E['type']>;
11789
+ } ? Omit<E, 'type' | 'topic'> & {
11790
+ type: PropagatedEventType<SourceTopic, E['type']>;
11791
+ topic: TargetTopic;
11557
11792
  } : never;
11558
11793
 
11559
11794
  /**
@@ -11562,29 +11797,33 @@ declare type PropagatedEvent<Topic extends string, Event extends {
11562
11797
  declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
11563
11798
 
11564
11799
  /**
11565
- * A propagated View event that is re-propagated from window.
11566
- */
11567
- declare type PropagatedViewAttachedEvent = PropagatedEvent<'view', AttachedEvent>;
11568
-
11569
- /**
11570
- * A propagated View event.
11800
+ * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
11801
+ * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
11802
+ * event type key with `'view-'`.
11571
11803
  */
11572
- declare type PropagatedViewEvent = PropagatedEvent<'view', WillPropagateViewEvent>;
11804
+ declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
11805
+ viewIdentity: OpenFin.Identity;
11806
+ };
11573
11807
 
11574
11808
  /**
11575
- * A propagated View event type.
11809
+ * Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
11576
11810
  */
11577
- declare type PropagatedViewEventType = PropagatedViewEvent['type'];
11811
+ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
11578
11812
 
11579
11813
  /**
11580
- * A propagated Window event.
11814
+ * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
11815
+ * prefixing the type string with `'window-'`. Only {@link NativeWindowEvent native window events} will propagate
11816
+ * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
11817
+ * will *not* re-propagate.
11818
+ *
11819
+ * "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
11581
11820
  */
11582
- declare type PropagatedWindowEvent = PropagatedEvent<'window', Exclude<WillPropagateWindowEvent, WindowCloseRequestedEvent>>;
11821
+ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent<'window', TargetTopic, Exclude<WindowSourcedEvent, WindowCloseRequestedEvent>>;
11583
11822
 
11584
11823
  /**
11585
- * A propagated Window event type.
11824
+ * Union of possible `type` values for a {@link OpenFin.WindowEvents.PropagatedWindowEvent}.
11586
11825
  */
11587
- declare type PropagatedWindowEventType = PropagatedWindowEvent['type'];
11826
+ declare type PropagatedWindowEventType = PropagatedWindowEvent<string>['type'];
11588
11827
 
11589
11828
  declare interface ProtocolMap extends ProtocolMapBase {
11590
11829
  'request-external-authorization': {
@@ -11991,7 +12230,7 @@ declare type RegistryInfo_2 = {
11991
12230
  * Generated when a window has been reloaded.
11992
12231
  * @interface
11993
12232
  */
11994
- declare type ReloadedEvent = NamedEvent & {
12233
+ declare type ReloadedEvent = BaseWindowEvent & {
11995
12234
  type: 'reloaded';
11996
12235
  url: string;
11997
12236
  };
@@ -12113,6 +12352,7 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
12113
12352
  * @interface
12114
12353
  */
12115
12354
  declare type RespondingEvent = IdentityEvent & {
12355
+ topic: 'application';
12116
12356
  type: 'responding';
12117
12357
  };
12118
12358
 
@@ -12179,6 +12419,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
12179
12419
  * @interface
12180
12420
  */
12181
12421
  declare type RunRequestedEvent_2 = IdentityEvent & {
12422
+ topic: 'application';
12182
12423
  type: 'run-requested';
12183
12424
  userAppConfigArgs: Record<string, any>;
12184
12425
  manifest: OpenFin.Manifest;
@@ -12359,7 +12600,7 @@ declare type ServiceIdentifier = {
12359
12600
  * Generated on changes to a user’s local computer session.
12360
12601
  * @interface
12361
12602
  */
12362
- declare type SessionChangedEvent = {
12603
+ declare type SessionChangedEvent = BaseSystemEvent & {
12363
12604
  type: 'session-changed';
12364
12605
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
12365
12606
  };
@@ -12767,6 +13008,7 @@ declare type SplitterItem = GoldenLayout.ContentItem & {
12767
13008
  * @interface
12768
13009
  */
12769
13010
  declare type StartedEvent = IdentityEvent & {
13011
+ topic: 'application';
12770
13012
  type: 'started';
12771
13013
  };
12772
13014
 
@@ -14239,9 +14481,7 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
14239
14481
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
14240
14482
  * from which they propagate).
14241
14483
  */
14242
- declare type SystemEvent = {
14243
- topic: 'system';
14244
- } & (ExcludeRequested<PropagatedWindowEvent> | PropagatedViewEvent | PropagatedApplicationEvent | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent);
14484
+ declare type SystemEvent = ExcludeRequested<PropagatedWindowEvent<'system'>> | PropagatedViewEvent<'system'> | PropagatedApplicationEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
14245
14485
 
14246
14486
  declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
14247
14487
 
@@ -14249,6 +14489,7 @@ declare namespace SystemEvents {
14249
14489
  export {
14250
14490
  NotRequested,
14251
14491
  ExcludeRequested,
14492
+ BaseSystemEvent,
14252
14493
  IdleEvent,
14253
14494
  MonitorEvent,
14254
14495
  SessionChangedEvent,
@@ -14264,12 +14505,14 @@ declare namespace SystemEvents {
14264
14505
  DesktopIconClickedEvent,
14265
14506
  SystemShutdownEvent,
14266
14507
  SystemEvent,
14267
- SystemEventType
14508
+ SystemEventType,
14509
+ Payload_7 as Payload,
14510
+ ByType_6 as ByType
14268
14511
  }
14269
14512
  }
14270
14513
 
14271
14514
  /**
14272
- * A system event type.
14515
+ * Union of possible `type` values for a {@link SystemEvent}.
14273
14516
  */
14274
14517
  declare type SystemEventType = SystemEvent['type'];
14275
14518
 
@@ -14716,6 +14959,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
14716
14959
  * @interface
14717
14960
  */
14718
14961
  declare type TrayIconClickedEvent = IdentityEvent & {
14962
+ topic: 'application';
14719
14963
  type: 'tray-icon-clicked';
14720
14964
  button: 0 | 1 | 2;
14721
14965
  bounds: OpenFin.Rectangle;
@@ -14804,7 +15048,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
14804
15048
  * A general user bounds change event without event type.
14805
15049
  * @interface
14806
15050
  */
14807
- declare type UserBoundsChangeEvent = NamedEvent & {
15051
+ declare type UserBoundsChangeEvent = BaseWindowEvent & {
14808
15052
  height: number;
14809
15053
  left: number;
14810
15054
  top: number;
@@ -14816,7 +15060,7 @@ declare type UserBoundsChangeEvent = NamedEvent & {
14816
15060
  * Generated when a window's user movement becomes disabled.
14817
15061
  * @interface
14818
15062
  */
14819
- declare type UserMovementDisabledEvent = NamedEvent & {
15063
+ declare type UserMovementDisabledEvent = BaseWindowEvent & {
14820
15064
  type: 'user-movement-disabled';
14821
15065
  };
14822
15066
 
@@ -14824,7 +15068,7 @@ declare type UserMovementDisabledEvent = NamedEvent & {
14824
15068
  * Generated when a window's user movement becomes enabled.
14825
15069
  * @interface
14826
15070
  */
14827
- declare type UserMovementEnabledEvent = NamedEvent & {
15071
+ declare type UserMovementEnabledEvent = BaseWindowEvent & {
14828
15072
  type: 'user-movement-enabled';
14829
15073
  };
14830
15074
 
@@ -15474,6 +15718,16 @@ declare type View_3 = OpenFin.View;
15474
15718
 
15475
15719
  declare type View_4 = OpenFin.View;
15476
15720
 
15721
+ /**
15722
+ * Generated when a View is attached to a window.
15723
+ * @interface
15724
+ */
15725
+ declare type ViewAttachedEvent = BaseWindowEvent & {
15726
+ type: 'view-attached';
15727
+ target: OpenFin.Identity;
15728
+ viewIdentity: OpenFin.Identity;
15729
+ };
15730
+
15477
15731
  declare interface ViewComponent extends GoldenLayout.ContentItem {
15478
15732
  componentState: OpenFin.ViewState;
15479
15733
  }
@@ -15498,9 +15752,11 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
15498
15752
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
15499
15753
  * @interface
15500
15754
  */
15501
- declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
15755
+ declare type ViewDetachedEvent = BaseWindowEvent & {
15502
15756
  type: 'view-detached';
15757
+ target: OpenFin.Identity;
15503
15758
  previousTarget: OpenFin.Identity;
15759
+ viewIdentity: OpenFin.Identity;
15504
15760
  };
15505
15761
 
15506
15762
  /**
@@ -15508,9 +15764,9 @@ declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
15508
15764
  * discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
15509
15765
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
15510
15766
  */
15511
- declare type ViewEvent = {
15512
- topic: 'view';
15513
- } & (NonPropagatedViewEvent | WillPropagateViewEvent);
15767
+ declare type ViewEvent = (WebContentsEvent<'view'> & {
15768
+ target: OpenFin.Identity;
15769
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent;
15514
15770
 
15515
15771
  declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
15516
15772
 
@@ -15519,22 +15775,23 @@ declare namespace ViewEvents {
15519
15775
  BaseViewEvent,
15520
15776
  TargetChangedEvent,
15521
15777
  NonPropagatedViewEvent,
15522
- AttachedEvent,
15523
15778
  CreatedEvent,
15524
15779
  DestroyedEvent,
15525
15780
  HiddenEvent,
15526
15781
  HotkeyEvent,
15527
15782
  ShownEvent,
15528
- WillPropagateViewEvent,
15529
15783
  ViewEvent,
15784
+ WillPropagateViewEvent,
15530
15785
  ViewEventType,
15531
15786
  PropagatedViewEvent,
15532
- PropagatedViewEventType
15787
+ PropagatedViewEventType,
15788
+ Payload_8 as Payload,
15789
+ ByType_7 as ByType
15533
15790
  }
15534
15791
  }
15535
15792
 
15536
15793
  /**
15537
- * A View event type.
15794
+ * Union of possible `type` values for a {@link OpenFin.ViewEvents.ViewEvent}.
15538
15795
  */
15539
15796
  declare type ViewEventType = ViewEvent['type'];
15540
15797
 
@@ -16709,17 +16966,21 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
16709
16966
  }
16710
16967
 
16711
16968
  /**
16712
- * A WebContents event.
16969
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
16970
+ * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
16713
16971
  */
16714
- declare type WebContentsEvent = NonPropagatedWebContentsEvent | WillPropagateWebContentsEvent;
16972
+ declare type WebContentsEvent<Topic extends string> = {
16973
+ topic: Topic;
16974
+ } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
16715
16975
 
16716
- declare type WebContentsEvent_2 = Events.WebContentsEvents.WebContentsEvent;
16976
+ declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
16717
16977
 
16718
16978
  declare namespace WebContentsEvents {
16719
16979
  export {
16720
16980
  ResourceLoadFailedEvent,
16721
16981
  ResourceResponseReceivedEvent,
16722
16982
  PageTitleUpdatedEvent,
16983
+ CrashedEvent_2 as CrashedEvent,
16723
16984
  CertificateErrorEvent,
16724
16985
  CertificateSelectionShownEvent,
16725
16986
  FaviconUpdatedEvent,
@@ -16740,9 +17001,9 @@ declare namespace WebContentsEvents {
16740
17001
  FileDownloadStartedEvent,
16741
17002
  FileDownloadProgressEvent,
16742
17003
  FileDownloadCompletedEvent,
17004
+ WebContentsEvent,
16743
17005
  WillPropagateWebContentsEvent,
16744
- NonPropagatedWebContentsEvent,
16745
- WebContentsEvent
17006
+ NonPropagatedWebContentsEvent
16746
17007
  }
16747
17008
  }
16748
17009
 
@@ -16785,7 +17046,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
16785
17046
  * A general will-move or will-resize event without event type.
16786
17047
  * @interface
16787
17048
  */
16788
- declare type WillMoveOrResizeEvent = NamedEvent & {
17049
+ declare type WillMoveOrResizeEvent = BaseWindowEvent & {
16789
17050
  height: number;
16790
17051
  left: number;
16791
17052
  top: number;
@@ -16794,30 +17055,34 @@ declare type WillMoveOrResizeEvent = NamedEvent & {
16794
17055
  };
16795
17056
 
16796
17057
  /**
16797
- * An Application event that does propagate to (republish on) parent topics.
16798
- */
16799
- declare type WillPropagateApplicationEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
16800
-
16801
- /**
17058
+ * @DEPRECATED all View events propagate, so this is redundant - left as a convenience shim to avoid breaking
17059
+ * user code
17060
+ *
16802
17061
  * A View event that does propagate to (republish on) parent topics.
16803
17062
  */
16804
- declare type WillPropagateViewEvent = (WillPropagateWebContentsEvent & BaseViewEvent) | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent;
17063
+ declare type WillPropagateViewEvent = ViewEvent;
16805
17064
 
16806
17065
  /**
17066
+ * @DEPRECATED all webcontents events propagate, so this is redundant - left as a convenience shim to avoid breaking
17067
+ * user code
17068
+ *
16807
17069
  * A WebContents event that does propagate to (republish on) parent topics.
16808
17070
  */
16809
- declare type WillPropagateWebContentsEvent = BlurredEvent | CertificateSelectionShownEvent | CrashedEvent | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent;
17071
+ declare type WillPropagateWebContentsEvent = WebContentsEvent<string>;
16810
17072
 
16811
17073
  /**
17074
+ * @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
17075
+ * user code
17076
+ *
16812
17077
  * A Window event that does propagate to (republish on) parent topics.
16813
17078
  */
16814
- declare type WillPropagateWindowEvent = WillPropagateWebContentsEvent | PropagatedViewAttachedEvent | ViewDetachedEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | 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;
17079
+ declare type WillPropagateWindowEvent = WindowSourcedEvent;
16815
17080
 
16816
17081
  /**
16817
17082
  * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
16818
17083
  * @interface
16819
17084
  */
16820
- declare type WillRedirectEvent = NamedEvent & {
17085
+ declare type WillRedirectEvent = BaseWindowEvent & {
16821
17086
  type: 'will-redirect';
16822
17087
  blocked: boolean;
16823
17088
  isInPlace: boolean;
@@ -18358,7 +18623,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18358
18623
  * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
18359
18624
  * @interface
18360
18625
  */
18361
- declare type WindowAlertRequestedEvent = NamedEvent & {
18626
+ declare type WindowAlertRequestedEvent = BaseApplicationEvent & {
18362
18627
  type: 'window-alert-requested';
18363
18628
  };
18364
18629
 
@@ -18375,7 +18640,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18375
18640
  * Generated when a window has closed.
18376
18641
  * @interface
18377
18642
  */
18378
- declare type WindowClosedEvent = NamedEvent & {
18643
+ declare type WindowClosedEvent = BaseWindowEvent & {
18379
18644
  type: 'closed';
18380
18645
  };
18381
18646
 
@@ -18384,7 +18649,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18384
18649
  * @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.
18385
18650
  * @interface
18386
18651
  */
18387
- declare type WindowCloseRequestedEvent = NamedEvent & {
18652
+ declare type WindowCloseRequestedEvent = BaseWindowEvent & {
18388
18653
  type: 'close-requested';
18389
18654
  };
18390
18655
 
@@ -18392,7 +18657,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18392
18657
  * Generated when a window has initiated the closing routine.
18393
18658
  * @interface
18394
18659
  */
18395
- declare type WindowClosingEvent = NamedEvent & {
18660
+ declare type WindowClosingEvent = BaseWindowEvent & {
18396
18661
  type: 'closing';
18397
18662
  };
18398
18663
 
@@ -18400,7 +18665,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18400
18665
  * Generated when a child window is created.
18401
18666
  * @interface
18402
18667
  */
18403
- declare type WindowCreatedEvent = NamedEvent & {
18668
+ declare type WindowCreatedEvent = BaseApplicationEvent & {
18404
18669
  type: 'window-created';
18405
18670
  };
18406
18671
 
@@ -18457,7 +18722,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18457
18722
  * Generated when a child window ends loading.
18458
18723
  * @interface
18459
18724
  */
18460
- declare type WindowEndLoadEvent = NamedEvent & {
18725
+ declare type WindowEndLoadEvent = BaseApplicationEvent & {
18461
18726
  type: 'window-end-load';
18462
18727
  };
18463
18728
 
@@ -18466,14 +18731,16 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18466
18731
  * discriminated by {@link WindowEvent.type | their type}. Event payloads unique to `Window` can be found
18467
18732
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
18468
18733
  */
18469
- declare type WindowEvent = {
18470
- topic: 'window';
18471
- } & (WillPropagateWindowEvent | NonPropagatedWindowEvent | PropagatedViewEvent);
18734
+ declare type WindowEvent = WindowSourcedEvent | PropagatedViewEvent<'window'>;
18472
18735
 
18473
18736
  declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
18474
18737
 
18475
18738
  declare namespace WindowEvents {
18476
18739
  export {
18740
+ BaseWindowEvent,
18741
+ ViewAttachedEvent,
18742
+ ViewDetachedEvent,
18743
+ WindowViewEvent,
18477
18744
  AlertRequestedEvent,
18478
18745
  AuthRequestedEvent,
18479
18746
  EndLoadEvent,
@@ -18490,11 +18757,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18490
18757
  BoundsChangeEvent,
18491
18758
  WillMoveOrResizeEvent,
18492
18759
  PerformanceReportEvent,
18493
- ViewDetachedEvent,
18494
18760
  InputEvent_2 as InputEvent,
18495
18761
  LayoutInitializedEvent,
18496
18762
  LayoutReadyEvent,
18497
- NonPropagatedWindowEvent,
18498
18763
  BeginUserBoundsChangingEvent,
18499
18764
  BoundsChangedEvent,
18500
18765
  BoundsChangingEvent,
@@ -18518,17 +18783,20 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18518
18783
  UserMovementDisabledEvent,
18519
18784
  WillMoveEvent,
18520
18785
  WillResizeEvent,
18521
- PropagatedViewAttachedEvent,
18786
+ NonPropagatedWindowEvent,
18787
+ WindowSourcedEvent,
18522
18788
  WillPropagateWindowEvent,
18523
18789
  WindowEvent,
18524
18790
  WindowEventType,
18525
18791
  PropagatedWindowEvent,
18526
- PropagatedWindowEventType
18792
+ PropagatedWindowEventType,
18793
+ Payload_9 as Payload,
18794
+ ByType_8 as ByType
18527
18795
  }
18528
18796
  }
18529
18797
 
18530
18798
  /**
18531
- * A Window event type.
18799
+ * Union of possible `type` values for a {@link OpenFin.WindowEvents.WindowEvent}.
18532
18800
  */
18533
18801
  declare type WindowEventType = WindowEvent['type'];
18534
18802
 
@@ -18536,7 +18804,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18536
18804
  * Generated when a window has been hidden.
18537
18805
  * @interface
18538
18806
  */
18539
- declare type WindowHiddenEvent = NamedEvent & {
18807
+ declare type WindowHiddenEvent = BaseWindowEvent & {
18540
18808
  type: 'hidden';
18541
18809
  reason: 'closing' | 'hide' | 'hide-on-close';
18542
18810
  };
@@ -18546,7 +18814,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18546
18814
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
18547
18815
  * @interface
18548
18816
  */
18549
- declare type WindowHotkeyEvent = InputEvent_2 & NamedEvent & {
18817
+ declare type WindowHotkeyEvent = InputEvent_2 & BaseWindowEvent & {
18550
18818
  type: 'hotkey';
18551
18819
  };
18552
18820
 
@@ -18565,7 +18833,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18565
18833
  * Generated when a window is initialized.
18566
18834
  * @interface
18567
18835
  */
18568
- declare type WindowInitializedEvent = NamedEvent & {
18836
+ declare type WindowInitializedEvent = BaseWindowEvent & {
18569
18837
  type: 'initialized';
18570
18838
  };
18571
18839
 
@@ -18664,7 +18932,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18664
18932
  * Generated when a child window is not responding.
18665
18933
  * @interface
18666
18934
  */
18667
- declare type WindowNotRespondingEvent = NamedEvent & {
18935
+ declare type WindowNotRespondingEvent = BaseApplicationEvent & {
18668
18936
  type: 'window-not-responding';
18669
18937
  };
18670
18938
 
@@ -18690,7 +18958,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18690
18958
  * @remarks Will not fire if the diff object is empty.
18691
18959
  * @interface
18692
18960
  */
18693
- declare type WindowOptionsChangedEvent_2 = NamedEvent & {
18961
+ declare type WindowOptionsChangedEvent_2 = BaseWindowEvent & {
18694
18962
  type: 'options-changed';
18695
18963
  options: OpenFin.WindowOptions;
18696
18964
  diff: OpenFin.WindowOptionDiff;
@@ -18702,7 +18970,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18702
18970
  * Generated when a child window is responding.
18703
18971
  * @interface
18704
18972
  */
18705
- declare type WindowRespondingEvent = NamedEvent & {
18973
+ declare type WindowRespondingEvent = BaseApplicationEvent & {
18706
18974
  type: 'window-responding';
18707
18975
  };
18708
18976
 
@@ -18710,7 +18978,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18710
18978
  * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
18711
18979
  * @interface
18712
18980
  */
18713
- declare type WindowRestoredEvent = NamedEvent & {
18981
+ declare type WindowRestoredEvent = BaseWindowEvent & {
18714
18982
  type: 'restored';
18715
18983
  };
18716
18984
 
@@ -18718,7 +18986,7 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18718
18986
  * Generated when a hidden window has been shown.
18719
18987
  * @interface
18720
18988
  */
18721
- declare type WindowShownEvent = NamedEvent & {
18989
+ declare type WindowShownEvent = BaseWindowEvent & {
18722
18990
  type: 'shown';
18723
18991
  };
18724
18992
 
@@ -18727,15 +18995,21 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18727
18995
  * @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.
18728
18996
  * @interface
18729
18997
  */
18730
- declare type WindowShowRequestedEvent = NamedEvent & {
18998
+ declare type WindowShowRequestedEvent = BaseWindowEvent & {
18731
18999
  type: 'show-requested';
18732
19000
  };
18733
19001
 
19002
+ /**
19003
+ * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19004
+ * from {@link OpenFin.ViewEvents}.
19005
+ */
19006
+ declare type WindowSourcedEvent = WebContentsEvent<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | 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;
19007
+
18734
19008
  /**
18735
19009
  * Generated when a child window starts loading.
18736
19010
  * @interface
18737
19011
  */
18738
- declare type WindowStartLoadEvent = NamedEvent & {
19012
+ declare type WindowStartLoadEvent = BaseApplicationEvent & {
18739
19013
  type: 'window-start-load';
18740
19014
  };
18741
19015
 
@@ -18744,6 +19018,14 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18744
19018
  */
18745
19019
  declare type WindowState = 'maximized' | 'minimized' | 'normal';
18746
19020
 
19021
+ /**
19022
+ * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
19023
+ * to the `Application` level, with the name pattern `window-view-eventname`.
19024
+ */
19025
+ declare type WindowViewEvent = {
19026
+ viewIdentity: OpenFin.Identity;
19027
+ } & (ViewAttachedEvent | ViewDetachedEvent);
19028
+
18747
19029
  /**
18748
19030
  * @interface
18749
19031
  */