@openfin/core 34.78.34 → 34.78.37

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_2.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_2.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_2.Identity;
1752
- viewIdentity: OpenFin_2.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
 
@@ -4113,7 +4222,22 @@ declare type CpuInfo = {
4113
4222
  * Generated when an application has crashed.
4114
4223
  * @interface
4115
4224
  */
4116
- declare type CrashedEvent = NamedEvent & {
4225
+ declare type CrashedEvent = IdentityEvent & {
4226
+ topic: 'application';
4227
+ type: 'crashed';
4228
+ reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
4229
+ exitCode: number;
4230
+ details: {
4231
+ reason: string;
4232
+ exitCode: number;
4233
+ };
4234
+ };
4235
+
4236
+ /**
4237
+ * Generated when a WebContents has crashed.
4238
+ * @interface
4239
+ */
4240
+ declare type CrashedEvent_2 = NamedEvent & {
4117
4241
  type: 'crashed';
4118
4242
  reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
4119
4243
  exitCode: number;
@@ -4259,7 +4383,7 @@ declare interface DesktopAgent_2 {
4259
4383
  * Generated when the desktop icon is clicked while it's already running.
4260
4384
  * @interface
4261
4385
  */
4262
- declare type DesktopIconClickedEvent = BaseEvent & {
4386
+ declare type DesktopIconClickedEvent = BaseSystemEvent & {
4263
4387
  type: 'desktop-icon-clicked';
4264
4388
  };
4265
4389
 
@@ -4489,7 +4613,7 @@ declare interface DragSource {}
4489
4613
  * Generated when a window has been embedded.
4490
4614
  * @interface
4491
4615
  */
4492
- declare type EmbeddedEvent = NamedEvent & {
4616
+ declare type EmbeddedEvent = BaseWindowEvent & {
4493
4617
  type: 'embedded';
4494
4618
  };
4495
4619
 
@@ -4588,7 +4712,7 @@ declare class EmitterMap {
4588
4712
  * Generated when a window ends loading.
4589
4713
  * @interface
4590
4714
  */
4591
- declare type EndLoadEvent = NamedEvent & {
4715
+ declare type EndLoadEvent = BaseWindowEvent & {
4592
4716
  type: 'end-load';
4593
4717
  documentName: string;
4594
4718
  isMain: boolean;
@@ -4894,7 +5018,7 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
4894
5018
  * Generated when an external application has authenticated and is connected.
4895
5019
  * @interface
4896
5020
  */
4897
- declare type ExternalApplicationConnectedEvent = BaseEvent & {
5021
+ declare type ExternalApplicationConnectedEvent = BaseExternalApplicationEvent & {
4898
5022
  type: 'connected';
4899
5023
  };
4900
5024
 
@@ -4902,7 +5026,7 @@ declare type ExternalApplicationConnectedEvent = BaseEvent & {
4902
5026
  * Generated when an external application has disconnected.
4903
5027
  * @interface
4904
5028
  */
4905
- declare type ExternalApplicationDisconnectedEvent = BaseEvent & {
5029
+ declare type ExternalApplicationDisconnectedEvent = BaseExternalApplicationEvent & {
4906
5030
  type: 'disconnected';
4907
5031
  };
4908
5032
 
@@ -4911,20 +5035,27 @@ declare type ExternalApplicationDisconnectedEvent = BaseEvent & {
4911
5035
  * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
4912
5036
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
4913
5037
  */
4914
- declare type ExternalApplicationEvent = {
4915
- topic: 'externalapplication';
4916
- } & (ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent);
5038
+ declare type ExternalApplicationEvent = ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent;
4917
5039
 
4918
5040
  declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
4919
5041
 
4920
5042
  declare namespace ExternalApplicationEvents {
4921
5043
  export {
5044
+ BaseExternalApplicationEvent,
4922
5045
  ExternalApplicationConnectedEvent,
4923
5046
  ExternalApplicationDisconnectedEvent,
4924
- ExternalApplicationEvent
5047
+ ExternalApplicationEvent,
5048
+ ExternalApplicationEventType,
5049
+ Payload_3 as Payload,
5050
+ ByType_2 as ByType
4925
5051
  }
4926
5052
  }
4927
5053
 
5054
+ /**
5055
+ * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
5056
+ */
5057
+ declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
5058
+
4928
5059
  /**
4929
5060
  * @interface
4930
5061
  */
@@ -4984,7 +5115,7 @@ declare type ExternalConnection = {
4984
5115
  * Generated when an external process has exited.
4985
5116
  * @interface
4986
5117
  */
4987
- declare type ExternalProcessExitedEvent = NamedEvent & {
5118
+ declare type ExternalProcessExitedEvent = BaseWindowEvent & {
4988
5119
  type: 'external-process-exited';
4989
5120
  processUuid: string;
4990
5121
  exitCode: number;
@@ -5029,7 +5160,7 @@ declare type ExternalProcessRequestType = {
5029
5160
  * Generated when an external process has started.
5030
5161
  * @interface
5031
5162
  */
5032
- declare type ExternalProcessStartedEvent = NamedEvent & {
5163
+ declare type ExternalProcessStartedEvent = BaseWindowEvent & {
5033
5164
  type: 'external-process-started';
5034
5165
  processUuid: string;
5035
5166
  };
@@ -5128,7 +5259,7 @@ declare type FileDownloadEvent = {
5128
5259
  *
5129
5260
  * @interface
5130
5261
  */
5131
- declare type FileDownloadLocationChangedEvent = NamedEvent & {
5262
+ declare type FileDownloadLocationChangedEvent = BaseApplicationEvent & {
5132
5263
  type: 'file-download-location-changed';
5133
5264
  };
5134
5265
 
@@ -5411,7 +5542,9 @@ declare type FrameDisconnectedEvent = BaseFrameEvent & {
5411
5542
  };
5412
5543
 
5413
5544
  /**
5414
- * A Frame event.
5545
+ * [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
5546
+ * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5547
+ * under the {@link OpenFin.FrameEvents} namespace.
5415
5548
  */
5416
5549
  declare type FrameEvent = {
5417
5550
  topic: 'frame';
@@ -5425,14 +5558,14 @@ declare namespace FrameEvents {
5425
5558
  FrameConnectedEvent,
5426
5559
  FrameDisconnectedEvent,
5427
5560
  FrameEvent,
5428
- FrameEventType
5561
+ FrameEventType,
5562
+ Payload_4 as Payload,
5563
+ ByType_3 as ByType
5429
5564
  }
5430
5565
  }
5431
5566
 
5432
5567
  /**
5433
- * [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
5434
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5435
- * under the {@link OpenFin.FrameEvents} namespace.
5568
+ * Union of possible `type` values for a {@link FrameEvent}.
5436
5569
  */
5437
5570
  declare type FrameEventType = FrameEvent['type'];
5438
5571
 
@@ -5666,10 +5799,18 @@ declare namespace GlobalHotkeyEvents {
5666
5799
  export {
5667
5800
  RegisteredEvent,
5668
5801
  UnregisteredEvent,
5669
- GlobalHotkeyEvent
5802
+ GlobalHotkeyEvent,
5803
+ GlobalHotkeyEventType,
5804
+ Payload_5 as Payload,
5805
+ ByType_4 as ByType
5670
5806
  }
5671
5807
  }
5672
5808
 
5809
+ /**
5810
+ * Union of possible `type` values for a {@link GlobalHotkeyEvent}
5811
+ */
5812
+ declare type GlobalHotkeyEventType = GlobalHotkeyEvent['type'];
5813
+
5673
5814
  declare namespace GoldenLayout {
5674
5815
  export {
5675
5816
  GoldenLayout_2 as GoldenLayout,
@@ -6112,7 +6253,7 @@ declare type IdentityEvent = BaseEvent & {
6112
6253
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6113
6254
  * @interface
6114
6255
  */
6115
- declare type IdleEvent = {
6256
+ declare type IdleEvent = BaseSystemEvent & {
6116
6257
  type: 'idle-state-changed';
6117
6258
  elapsedTime: number;
6118
6259
  isIdle: boolean;
@@ -6198,6 +6339,7 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6198
6339
  * @interface
6199
6340
  */
6200
6341
  declare type InitializedEvent = IdentityEvent & {
6342
+ topic: 'application';
6201
6343
  type: 'initialized';
6202
6344
  };
6203
6345
 
@@ -8245,7 +8387,7 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
8245
8387
  * Generated when a window and all of its layout's views have either finished or failed navigation.
8246
8388
  * @interface
8247
8389
  */
8248
- declare type LayoutInitializedEvent = NamedEvent & {
8390
+ declare type LayoutInitializedEvent = BaseWindowEvent & {
8249
8391
  type: 'layout-initialized';
8250
8392
  ofViews: (OpenFin_2.Identity & {
8251
8393
  entityType: 'view';
@@ -8583,7 +8725,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
8583
8725
  * Generated when a window and all of its layout's views have been created and can receive API calls.
8584
8726
  * @interface
8585
8727
  */
8586
- declare type LayoutReadyEvent = NamedEvent & {
8728
+ declare type LayoutReadyEvent = BaseWindowEvent & {
8587
8729
  type: 'layout-ready';
8588
8730
  views: (OpenFin_2.Identity & {
8589
8731
  success: boolean;
@@ -8718,6 +8860,7 @@ declare type Manifest = {
8718
8860
  * @interface
8719
8861
  */
8720
8862
  declare type ManifestChangedEvent = IdentityEvent & {
8863
+ topic: 'application';
8721
8864
  type: 'manifest-changed';
8722
8865
  };
8723
8866
 
@@ -8769,7 +8912,7 @@ declare type MatchPattern = string;
8769
8912
  * Generated when a window is maximized.
8770
8913
  * @interface
8771
8914
  */
8772
- declare type MaximizedEvent = NamedEvent & {
8915
+ declare type MaximizedEvent = BaseWindowEvent & {
8773
8916
  type: 'maximized';
8774
8917
  };
8775
8918
 
@@ -8869,7 +9012,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
8869
9012
  * Generated when a window is minimized.
8870
9013
  * @interface
8871
9014
  */
8872
- declare type MinimizedEvent = NamedEvent & {
9015
+ declare type MinimizedEvent = BaseWindowEvent & {
8873
9016
  type: 'minimized';
8874
9017
  };
8875
9018
 
@@ -8918,7 +9061,7 @@ declare type MonitorDetails = {
8918
9061
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
8919
9062
  * @interface
8920
9063
  */
8921
- declare type MonitorEvent = OpenFin_2.MonitorInfo & {
9064
+ declare type MonitorEvent = BaseSystemEvent & OpenFin_2.MonitorInfo & {
8922
9065
  type: 'monitor-info-changed';
8923
9066
  };
8924
9067
 
@@ -9320,19 +9463,25 @@ declare type NonAppProcessDetails = ProcessDetails & {
9320
9463
  };
9321
9464
 
9322
9465
  /**
9323
- * A View event that does not propagate to (republish on) parent topics.
9466
+ * @DEPRECATED All view events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
9467
+ *
9468
+ * A view event that does not propagate to (republish on) parent topics.
9324
9469
  */
9325
- declare type NonPropagatedViewEvent = BaseViewEvent & NonPropagatedWebContentsEvent;
9470
+ declare type NonPropagatedViewEvent = never;
9326
9471
 
9327
9472
  /**
9473
+ * @DEPRECATED all webcontents events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
9474
+ *
9328
9475
  * A WebContents event that does not propagate to (republish on) parent topics.
9329
9476
  */
9330
- declare type NonPropagatedWebContentsEvent = FoundInPageEvent | CertificateErrorEvent;
9477
+ declare type NonPropagatedWebContentsEvent = never;
9331
9478
 
9332
9479
  /**
9333
- * A Window event that does not propagate to (republish on) parent topics.
9480
+ * @DEPRECATED All window events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
9481
+ *
9482
+ * A window event that does not propagate to (republish on) parent topics.
9334
9483
  */
9335
- declare type NonPropagatedWindowEvent = NonPropagatedWebContentsEvent;
9484
+ declare type NonPropagatedWindowEvent = never;
9336
9485
 
9337
9486
  /* Excluded from this release type: NotRequested */
9338
9487
 
@@ -9341,6 +9490,7 @@ declare type NonPropagatedWindowEvent = NonPropagatedWebContentsEvent;
9341
9490
  * @interface
9342
9491
  */
9343
9492
  declare type NotRespondingEvent = IdentityEvent & {
9493
+ topic: 'application';
9344
9494
  type: 'not-responding';
9345
9495
  };
9346
9496
 
@@ -9708,13 +9858,85 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
9708
9858
  error?: Success extends false ? ErrorPlainObject | undefined : never;
9709
9859
  };
9710
9860
 
9861
+ /**
9862
+ * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
9863
+ *
9864
+ * @typeParam Type String key specifying the event to extract
9865
+ */
9866
+ declare type Payload_2<Type extends ApplicationEventType> = Extract<ApplicationEvent, {
9867
+ type: Type;
9868
+ }>;
9869
+
9870
+ /**
9871
+ * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
9872
+ *
9873
+ * @typeParam Type String key specifying the event to extract
9874
+ */
9875
+ declare type Payload_3<Type extends ExternalApplicationEventType> = Extract<ExternalApplicationEvent, {
9876
+ type: Type;
9877
+ }>;
9878
+
9879
+ /**
9880
+ * Extracts a single event type matching the given key from the {@link FrameEvent} union.
9881
+ *
9882
+ * @typeParam Type String key specifying the event to extract
9883
+ */
9884
+ declare type Payload_4<Type extends FrameEventType> = Extract<FrameEvent, {
9885
+ type: Type;
9886
+ }>;
9887
+
9888
+ /**
9889
+ * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
9890
+ *
9891
+ * @typeParam Type String key specifying the event to extract
9892
+ */
9893
+ declare type Payload_5<Type extends GlobalHotkeyEventType> = Extract<GlobalHotkeyEvent, {
9894
+ type: Type;
9895
+ }>;
9896
+
9897
+ /**
9898
+ * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
9899
+ *
9900
+ * @typeParam Type String key specifying the event to extract
9901
+ */
9902
+ declare type Payload_6<Type extends PlatformEventType> = Extract<PlatformEvent, {
9903
+ type: Type;
9904
+ }>;
9905
+
9906
+ /**
9907
+ * Extracts a single event type matching the given key from the {@link SystemEvent} union.
9908
+ *
9909
+ * @typeParam Type String key specifying the event to extract
9910
+ */
9911
+ declare type Payload_7<Type extends SystemEventType> = Extract<SystemEvent, {
9912
+ type: Type;
9913
+ }>;
9914
+
9915
+ /**
9916
+ * Extracts a single event type matching the given key from the {@link ViewEvent} union.
9917
+ *
9918
+ * @typeParam Type String key specifying the event to extract
9919
+ */
9920
+ declare type Payload_8<Type extends ViewEventType> = Extract<ViewEvent, {
9921
+ type: Type;
9922
+ }>;
9923
+
9924
+ /**
9925
+ * Extracts a single event type matching the given key from the {@link WindowEvent} union.
9926
+ *
9927
+ * @typeParam Type String key specifying the event to extract
9928
+ */
9929
+ declare type Payload_9<Type extends WindowEventType> = Extract<WindowEvent, {
9930
+ type: Type;
9931
+ }>;
9932
+
9711
9933
  declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T extends ChannelStrategy<infer U> ? U : never;
9712
9934
 
9713
9935
  /**
9714
9936
  * Generated when window finishes loading. Provides performance and navigation data.
9715
9937
  * @interface
9716
9938
  */
9717
- declare type PerformanceReportEvent = Performance & NamedEvent & {
9939
+ declare type PerformanceReportEvent = Performance & BaseWindowEvent & {
9718
9940
  type: 'performance-report';
9719
9941
  };
9720
9942
 
@@ -10371,10 +10593,18 @@ declare namespace PlatformEvents {
10371
10593
  export {
10372
10594
  PlatformApiReadyEvent,
10373
10595
  PlatformSnapshotAppliedEvent,
10374
- PlatformEvent
10596
+ PlatformEvent,
10597
+ PlatformEventType,
10598
+ Payload_6 as Payload,
10599
+ ByType_5 as ByType
10375
10600
  }
10376
10601
  }
10377
10602
 
10603
+ /**
10604
+ * Union of possible `type` values for a {@link PlatformEvent}.
10605
+ */
10606
+ declare type PlatformEventType = PlatformEvent['type'];
10607
+
10378
10608
  /**
10379
10609
  * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
10380
10610
  */
@@ -11316,7 +11546,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
11316
11546
  * A general preload scripts state change event without event type.
11317
11547
  * @interface
11318
11548
  */
11319
- declare type PreloadScriptsStateChangeEvent = NamedEvent & {
11549
+ declare type PreloadScriptsStateChangeEvent = BaseWindowEvent & {
11320
11550
  preloadScripts: (PreloadScriptInfoRunning & any)[];
11321
11551
  };
11322
11552
 
@@ -11525,25 +11755,30 @@ declare type ProcessLoggingOptions = {
11525
11755
  };
11526
11756
 
11527
11757
  /**
11528
- * A propagated Application event.
11758
+ * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
11759
+ * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
11760
+ * are propagated to `System` without any type string prefixing.
11761
+ *
11762
+ * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
11529
11763
  */
11530
- declare type PropagatedApplicationEvent = PropagatedEvent<'application', WillPropagateApplicationEvent> | ApplicationWindowEvent;
11764
+ declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
11531
11765
 
11532
11766
  /**
11533
- * A propagated Application event type.
11767
+ * Union of possible 'type' values for a {@link OpenFin.ApplicationEvents.PropagatedApplicationEvent}.
11534
11768
  */
11535
- declare type PropagatedApplicationEventType = PropagatedApplicationEvent['type'];
11769
+ declare type PropagatedApplicationEventType = PropagatedApplicationEvent<string>['type'];
11536
11770
 
11537
11771
  /**
11538
11772
  * Modifies an event shape to reflect propagation to a parent topic.
11539
11773
  * @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
11540
11774
  */
11541
- declare type PropagatedEvent<Topic extends string, Event extends {
11775
+ declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
11542
11776
  type: string;
11543
11777
  }> = Event extends infer E extends {
11544
11778
  type: string;
11545
- } ? Omit<E, 'type'> & {
11546
- type: PropagatedEventType<Topic, E['type']>;
11779
+ } ? Omit<E, 'type' | 'topic'> & {
11780
+ type: PropagatedEventType<SourceTopic, E['type']>;
11781
+ topic: TargetTopic;
11547
11782
  } : never;
11548
11783
 
11549
11784
  /**
@@ -11552,29 +11787,33 @@ declare type PropagatedEvent<Topic extends string, Event extends {
11552
11787
  declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
11553
11788
 
11554
11789
  /**
11555
- * A propagated View event that is re-propagated from window.
11556
- */
11557
- declare type PropagatedViewAttachedEvent = PropagatedEvent<'view', AttachedEvent>;
11558
-
11559
- /**
11560
- * A propagated View event.
11790
+ * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
11791
+ * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
11792
+ * event type key with `'view-'`.
11561
11793
  */
11562
- declare type PropagatedViewEvent = PropagatedEvent<'view', WillPropagateViewEvent>;
11794
+ declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
11795
+ viewIdentity: OpenFin_2.Identity;
11796
+ };
11563
11797
 
11564
11798
  /**
11565
- * A propagated View event type.
11799
+ * Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
11566
11800
  */
11567
- declare type PropagatedViewEventType = PropagatedViewEvent['type'];
11801
+ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
11568
11802
 
11569
11803
  /**
11570
- * A propagated Window event.
11804
+ * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
11805
+ * prefixing the type string with `'window-'`. Only {@link NativeWindowEvent native window events} will propagate
11806
+ * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
11807
+ * will *not* re-propagate.
11808
+ *
11809
+ * "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
11571
11810
  */
11572
- declare type PropagatedWindowEvent = PropagatedEvent<'window', Exclude<WillPropagateWindowEvent, WindowCloseRequestedEvent>>;
11811
+ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent<'window', TargetTopic, Exclude<WindowSourcedEvent, WindowCloseRequestedEvent>>;
11573
11812
 
11574
11813
  /**
11575
- * A propagated Window event type.
11814
+ * Union of possible `type` values for a {@link OpenFin.WindowEvents.PropagatedWindowEvent}.
11576
11815
  */
11577
- declare type PropagatedWindowEventType = PropagatedWindowEvent['type'];
11816
+ declare type PropagatedWindowEventType = PropagatedWindowEvent<string>['type'];
11578
11817
 
11579
11818
  declare interface ProtocolMap extends ProtocolMapBase {
11580
11819
  'request-external-authorization': {
@@ -11981,7 +12220,7 @@ declare type RegistryInfo_2 = {
11981
12220
  * Generated when a window has been reloaded.
11982
12221
  * @interface
11983
12222
  */
11984
- declare type ReloadedEvent = NamedEvent & {
12223
+ declare type ReloadedEvent = BaseWindowEvent & {
11985
12224
  type: 'reloaded';
11986
12225
  url: string;
11987
12226
  };
@@ -12103,6 +12342,7 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
12103
12342
  * @interface
12104
12343
  */
12105
12344
  declare type RespondingEvent = IdentityEvent & {
12345
+ topic: 'application';
12106
12346
  type: 'responding';
12107
12347
  };
12108
12348
 
@@ -12169,6 +12409,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
12169
12409
  * @interface
12170
12410
  */
12171
12411
  declare type RunRequestedEvent_2 = IdentityEvent & {
12412
+ topic: 'application';
12172
12413
  type: 'run-requested';
12173
12414
  userAppConfigArgs: Record<string, any>;
12174
12415
  manifest: OpenFin_2.Manifest;
@@ -12349,7 +12590,7 @@ declare type ServiceIdentifier = {
12349
12590
  * Generated on changes to a user’s local computer session.
12350
12591
  * @interface
12351
12592
  */
12352
- declare type SessionChangedEvent = {
12593
+ declare type SessionChangedEvent = BaseSystemEvent & {
12353
12594
  type: 'session-changed';
12354
12595
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
12355
12596
  };
@@ -12757,6 +12998,7 @@ declare type SplitterItem = GoldenLayout.ContentItem & {
12757
12998
  * @interface
12758
12999
  */
12759
13000
  declare type StartedEvent = IdentityEvent & {
13001
+ topic: 'application';
12760
13002
  type: 'started';
12761
13003
  };
12762
13004
 
@@ -14229,9 +14471,7 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
14229
14471
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
14230
14472
  * from which they propagate).
14231
14473
  */
14232
- declare type SystemEvent = {
14233
- topic: 'system';
14234
- } & (ExcludeRequested<PropagatedWindowEvent> | PropagatedViewEvent | PropagatedApplicationEvent | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent);
14474
+ declare type SystemEvent = ExcludeRequested<PropagatedWindowEvent<'system'>> | PropagatedViewEvent<'system'> | PropagatedApplicationEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
14235
14475
 
14236
14476
  declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
14237
14477
 
@@ -14239,6 +14479,7 @@ declare namespace SystemEvents {
14239
14479
  export {
14240
14480
  NotRequested,
14241
14481
  ExcludeRequested,
14482
+ BaseSystemEvent,
14242
14483
  IdleEvent,
14243
14484
  MonitorEvent,
14244
14485
  SessionChangedEvent,
@@ -14254,12 +14495,14 @@ declare namespace SystemEvents {
14254
14495
  DesktopIconClickedEvent,
14255
14496
  SystemShutdownEvent,
14256
14497
  SystemEvent,
14257
- SystemEventType
14498
+ SystemEventType,
14499
+ Payload_7 as Payload,
14500
+ ByType_6 as ByType
14258
14501
  }
14259
14502
  }
14260
14503
 
14261
14504
  /**
14262
- * A system event type.
14505
+ * Union of possible `type` values for a {@link SystemEvent}.
14263
14506
  */
14264
14507
  declare type SystemEventType = SystemEvent['type'];
14265
14508
 
@@ -14706,6 +14949,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
14706
14949
  * @interface
14707
14950
  */
14708
14951
  declare type TrayIconClickedEvent = IdentityEvent & {
14952
+ topic: 'application';
14709
14953
  type: 'tray-icon-clicked';
14710
14954
  button: 0 | 1 | 2;
14711
14955
  bounds: OpenFin_2.Rectangle;
@@ -14794,7 +15038,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
14794
15038
  * A general user bounds change event without event type.
14795
15039
  * @interface
14796
15040
  */
14797
- declare type UserBoundsChangeEvent = NamedEvent & {
15041
+ declare type UserBoundsChangeEvent = BaseWindowEvent & {
14798
15042
  height: number;
14799
15043
  left: number;
14800
15044
  top: number;
@@ -14806,7 +15050,7 @@ declare type UserBoundsChangeEvent = NamedEvent & {
14806
15050
  * Generated when a window's user movement becomes disabled.
14807
15051
  * @interface
14808
15052
  */
14809
- declare type UserMovementDisabledEvent = NamedEvent & {
15053
+ declare type UserMovementDisabledEvent = BaseWindowEvent & {
14810
15054
  type: 'user-movement-disabled';
14811
15055
  };
14812
15056
 
@@ -14814,7 +15058,7 @@ declare type UserMovementDisabledEvent = NamedEvent & {
14814
15058
  * Generated when a window's user movement becomes enabled.
14815
15059
  * @interface
14816
15060
  */
14817
- declare type UserMovementEnabledEvent = NamedEvent & {
15061
+ declare type UserMovementEnabledEvent = BaseWindowEvent & {
14818
15062
  type: 'user-movement-enabled';
14819
15063
  };
14820
15064
 
@@ -15464,6 +15708,16 @@ declare type View_3 = OpenFin_2.View;
15464
15708
 
15465
15709
  declare type View_4 = OpenFin_2.View;
15466
15710
 
15711
+ /**
15712
+ * Generated when a View is attached to a window.
15713
+ * @interface
15714
+ */
15715
+ declare type ViewAttachedEvent = BaseWindowEvent & {
15716
+ type: 'view-attached';
15717
+ target: OpenFin_2.Identity;
15718
+ viewIdentity: OpenFin_2.Identity;
15719
+ };
15720
+
15467
15721
  declare interface ViewComponent extends GoldenLayout.ContentItem {
15468
15722
  componentState: OpenFin_2.ViewState;
15469
15723
  }
@@ -15488,9 +15742,11 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
15488
15742
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
15489
15743
  * @interface
15490
15744
  */
15491
- declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
15745
+ declare type ViewDetachedEvent = BaseWindowEvent & {
15492
15746
  type: 'view-detached';
15747
+ target: OpenFin_2.Identity;
15493
15748
  previousTarget: OpenFin_2.Identity;
15749
+ viewIdentity: OpenFin_2.Identity;
15494
15750
  };
15495
15751
 
15496
15752
  /**
@@ -15498,9 +15754,9 @@ declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
15498
15754
  * discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
15499
15755
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
15500
15756
  */
15501
- declare type ViewEvent = {
15502
- topic: 'view';
15503
- } & (NonPropagatedViewEvent | WillPropagateViewEvent);
15757
+ declare type ViewEvent = (WebContentsEvent<'view'> & {
15758
+ target: OpenFin_2.Identity;
15759
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent;
15504
15760
 
15505
15761
  declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
15506
15762
 
@@ -15509,22 +15765,23 @@ declare namespace ViewEvents {
15509
15765
  BaseViewEvent,
15510
15766
  TargetChangedEvent,
15511
15767
  NonPropagatedViewEvent,
15512
- AttachedEvent,
15513
15768
  CreatedEvent,
15514
15769
  DestroyedEvent,
15515
15770
  HiddenEvent,
15516
15771
  HotkeyEvent,
15517
15772
  ShownEvent,
15518
- WillPropagateViewEvent,
15519
15773
  ViewEvent,
15774
+ WillPropagateViewEvent,
15520
15775
  ViewEventType,
15521
15776
  PropagatedViewEvent,
15522
- PropagatedViewEventType
15777
+ PropagatedViewEventType,
15778
+ Payload_8 as Payload,
15779
+ ByType_7 as ByType
15523
15780
  }
15524
15781
  }
15525
15782
 
15526
15783
  /**
15527
- * A View event type.
15784
+ * Union of possible `type` values for a {@link OpenFin.ViewEvents.ViewEvent}.
15528
15785
  */
15529
15786
  declare type ViewEventType = ViewEvent['type'];
15530
15787
 
@@ -16699,17 +16956,21 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
16699
16956
  }
16700
16957
 
16701
16958
  /**
16702
- * A WebContents event.
16959
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
16960
+ * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
16703
16961
  */
16704
- declare type WebContentsEvent = NonPropagatedWebContentsEvent | WillPropagateWebContentsEvent;
16962
+ declare type WebContentsEvent<Topic extends string> = {
16963
+ topic: Topic;
16964
+ } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
16705
16965
 
16706
- declare type WebContentsEvent_2 = Events.WebContentsEvents.WebContentsEvent;
16966
+ declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
16707
16967
 
16708
16968
  declare namespace WebContentsEvents {
16709
16969
  export {
16710
16970
  ResourceLoadFailedEvent,
16711
16971
  ResourceResponseReceivedEvent,
16712
16972
  PageTitleUpdatedEvent,
16973
+ CrashedEvent_2 as CrashedEvent,
16713
16974
  CertificateErrorEvent,
16714
16975
  CertificateSelectionShownEvent,
16715
16976
  FaviconUpdatedEvent,
@@ -16730,9 +16991,9 @@ declare namespace WebContentsEvents {
16730
16991
  FileDownloadStartedEvent,
16731
16992
  FileDownloadProgressEvent,
16732
16993
  FileDownloadCompletedEvent,
16994
+ WebContentsEvent,
16733
16995
  WillPropagateWebContentsEvent,
16734
- NonPropagatedWebContentsEvent,
16735
- WebContentsEvent
16996
+ NonPropagatedWebContentsEvent
16736
16997
  }
16737
16998
  }
16738
16999
 
@@ -16775,7 +17036,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
16775
17036
  * A general will-move or will-resize event without event type.
16776
17037
  * @interface
16777
17038
  */
16778
- declare type WillMoveOrResizeEvent = NamedEvent & {
17039
+ declare type WillMoveOrResizeEvent = BaseWindowEvent & {
16779
17040
  height: number;
16780
17041
  left: number;
16781
17042
  top: number;
@@ -16784,30 +17045,34 @@ declare type WillMoveOrResizeEvent = NamedEvent & {
16784
17045
  };
16785
17046
 
16786
17047
  /**
16787
- * An Application event that does propagate to (republish on) parent topics.
16788
- */
16789
- declare type WillPropagateApplicationEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
16790
-
16791
- /**
17048
+ * @DEPRECATED all View events propagate, so this is redundant - left as a convenience shim to avoid breaking
17049
+ * user code
17050
+ *
16792
17051
  * A View event that does propagate to (republish on) parent topics.
16793
17052
  */
16794
- declare type WillPropagateViewEvent = (WillPropagateWebContentsEvent & BaseViewEvent) | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent;
17053
+ declare type WillPropagateViewEvent = ViewEvent;
16795
17054
 
16796
17055
  /**
17056
+ * @DEPRECATED all webcontents events propagate, so this is redundant - left as a convenience shim to avoid breaking
17057
+ * user code
17058
+ *
16797
17059
  * A WebContents event that does propagate to (republish on) parent topics.
16798
17060
  */
16799
- declare type WillPropagateWebContentsEvent = BlurredEvent | CertificateSelectionShownEvent | CrashedEvent | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent;
17061
+ declare type WillPropagateWebContentsEvent = WebContentsEvent<string>;
16800
17062
 
16801
17063
  /**
17064
+ * @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
17065
+ * user code
17066
+ *
16802
17067
  * A Window event that does propagate to (republish on) parent topics.
16803
17068
  */
16804
- 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;
17069
+ declare type WillPropagateWindowEvent = WindowSourcedEvent;
16805
17070
 
16806
17071
  /**
16807
17072
  * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
16808
17073
  * @interface
16809
17074
  */
16810
- declare type WillRedirectEvent = NamedEvent & {
17075
+ declare type WillRedirectEvent = BaseWindowEvent & {
16811
17076
  type: 'will-redirect';
16812
17077
  blocked: boolean;
16813
17078
  isInPlace: boolean;
@@ -18348,7 +18613,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18348
18613
  * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
18349
18614
  * @interface
18350
18615
  */
18351
- declare type WindowAlertRequestedEvent = NamedEvent & {
18616
+ declare type WindowAlertRequestedEvent = BaseApplicationEvent & {
18352
18617
  type: 'window-alert-requested';
18353
18618
  };
18354
18619
 
@@ -18365,7 +18630,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18365
18630
  * Generated when a window has closed.
18366
18631
  * @interface
18367
18632
  */
18368
- declare type WindowClosedEvent = NamedEvent & {
18633
+ declare type WindowClosedEvent = BaseWindowEvent & {
18369
18634
  type: 'closed';
18370
18635
  };
18371
18636
 
@@ -18374,7 +18639,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18374
18639
  * @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.
18375
18640
  * @interface
18376
18641
  */
18377
- declare type WindowCloseRequestedEvent = NamedEvent & {
18642
+ declare type WindowCloseRequestedEvent = BaseWindowEvent & {
18378
18643
  type: 'close-requested';
18379
18644
  };
18380
18645
 
@@ -18382,7 +18647,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18382
18647
  * Generated when a window has initiated the closing routine.
18383
18648
  * @interface
18384
18649
  */
18385
- declare type WindowClosingEvent = NamedEvent & {
18650
+ declare type WindowClosingEvent = BaseWindowEvent & {
18386
18651
  type: 'closing';
18387
18652
  };
18388
18653
 
@@ -18390,7 +18655,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18390
18655
  * Generated when a child window is created.
18391
18656
  * @interface
18392
18657
  */
18393
- declare type WindowCreatedEvent = NamedEvent & {
18658
+ declare type WindowCreatedEvent = BaseApplicationEvent & {
18394
18659
  type: 'window-created';
18395
18660
  };
18396
18661
 
@@ -18447,7 +18712,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18447
18712
  * Generated when a child window ends loading.
18448
18713
  * @interface
18449
18714
  */
18450
- declare type WindowEndLoadEvent = NamedEvent & {
18715
+ declare type WindowEndLoadEvent = BaseApplicationEvent & {
18451
18716
  type: 'window-end-load';
18452
18717
  };
18453
18718
 
@@ -18456,14 +18721,16 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18456
18721
  * discriminated by {@link WindowEvent.type | their type}. Event payloads unique to `Window` can be found
18457
18722
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
18458
18723
  */
18459
- declare type WindowEvent = {
18460
- topic: 'window';
18461
- } & (WillPropagateWindowEvent | NonPropagatedWindowEvent | PropagatedViewEvent);
18724
+ declare type WindowEvent = WindowSourcedEvent | PropagatedViewEvent<'window'>;
18462
18725
 
18463
18726
  declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
18464
18727
 
18465
18728
  declare namespace WindowEvents {
18466
18729
  export {
18730
+ BaseWindowEvent,
18731
+ ViewAttachedEvent,
18732
+ ViewDetachedEvent,
18733
+ WindowViewEvent,
18467
18734
  AlertRequestedEvent,
18468
18735
  AuthRequestedEvent,
18469
18736
  EndLoadEvent,
@@ -18480,11 +18747,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18480
18747
  BoundsChangeEvent,
18481
18748
  WillMoveOrResizeEvent,
18482
18749
  PerformanceReportEvent,
18483
- ViewDetachedEvent,
18484
18750
  InputEvent_2 as InputEvent,
18485
18751
  LayoutInitializedEvent,
18486
18752
  LayoutReadyEvent,
18487
- NonPropagatedWindowEvent,
18488
18753
  BeginUserBoundsChangingEvent,
18489
18754
  BoundsChangedEvent,
18490
18755
  BoundsChangingEvent,
@@ -18508,17 +18773,20 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18508
18773
  UserMovementDisabledEvent,
18509
18774
  WillMoveEvent,
18510
18775
  WillResizeEvent,
18511
- PropagatedViewAttachedEvent,
18776
+ NonPropagatedWindowEvent,
18777
+ WindowSourcedEvent,
18512
18778
  WillPropagateWindowEvent,
18513
18779
  WindowEvent,
18514
18780
  WindowEventType,
18515
18781
  PropagatedWindowEvent,
18516
- PropagatedWindowEventType
18782
+ PropagatedWindowEventType,
18783
+ Payload_9 as Payload,
18784
+ ByType_8 as ByType
18517
18785
  }
18518
18786
  }
18519
18787
 
18520
18788
  /**
18521
- * A Window event type.
18789
+ * Union of possible `type` values for a {@link OpenFin.WindowEvents.WindowEvent}.
18522
18790
  */
18523
18791
  declare type WindowEventType = WindowEvent['type'];
18524
18792
 
@@ -18526,7 +18794,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18526
18794
  * Generated when a window has been hidden.
18527
18795
  * @interface
18528
18796
  */
18529
- declare type WindowHiddenEvent = NamedEvent & {
18797
+ declare type WindowHiddenEvent = BaseWindowEvent & {
18530
18798
  type: 'hidden';
18531
18799
  reason: 'closing' | 'hide' | 'hide-on-close';
18532
18800
  };
@@ -18536,7 +18804,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18536
18804
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
18537
18805
  * @interface
18538
18806
  */
18539
- declare type WindowHotkeyEvent = InputEvent_2 & NamedEvent & {
18807
+ declare type WindowHotkeyEvent = InputEvent_2 & BaseWindowEvent & {
18540
18808
  type: 'hotkey';
18541
18809
  };
18542
18810
 
@@ -18555,7 +18823,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18555
18823
  * Generated when a window is initialized.
18556
18824
  * @interface
18557
18825
  */
18558
- declare type WindowInitializedEvent = NamedEvent & {
18826
+ declare type WindowInitializedEvent = BaseWindowEvent & {
18559
18827
  type: 'initialized';
18560
18828
  };
18561
18829
 
@@ -18654,7 +18922,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18654
18922
  * Generated when a child window is not responding.
18655
18923
  * @interface
18656
18924
  */
18657
- declare type WindowNotRespondingEvent = NamedEvent & {
18925
+ declare type WindowNotRespondingEvent = BaseApplicationEvent & {
18658
18926
  type: 'window-not-responding';
18659
18927
  };
18660
18928
 
@@ -18680,7 +18948,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18680
18948
  * @remarks Will not fire if the diff object is empty.
18681
18949
  * @interface
18682
18950
  */
18683
- declare type WindowOptionsChangedEvent_2 = NamedEvent & {
18951
+ declare type WindowOptionsChangedEvent_2 = BaseWindowEvent & {
18684
18952
  type: 'options-changed';
18685
18953
  options: OpenFin_2.WindowOptions;
18686
18954
  diff: OpenFin_2.WindowOptionDiff;
@@ -18692,7 +18960,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18692
18960
  * Generated when a child window is responding.
18693
18961
  * @interface
18694
18962
  */
18695
- declare type WindowRespondingEvent = NamedEvent & {
18963
+ declare type WindowRespondingEvent = BaseApplicationEvent & {
18696
18964
  type: 'window-responding';
18697
18965
  };
18698
18966
 
@@ -18700,7 +18968,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18700
18968
  * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
18701
18969
  * @interface
18702
18970
  */
18703
- declare type WindowRestoredEvent = NamedEvent & {
18971
+ declare type WindowRestoredEvent = BaseWindowEvent & {
18704
18972
  type: 'restored';
18705
18973
  };
18706
18974
 
@@ -18708,7 +18976,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18708
18976
  * Generated when a hidden window has been shown.
18709
18977
  * @interface
18710
18978
  */
18711
- declare type WindowShownEvent = NamedEvent & {
18979
+ declare type WindowShownEvent = BaseWindowEvent & {
18712
18980
  type: 'shown';
18713
18981
  };
18714
18982
 
@@ -18717,15 +18985,21 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18717
18985
  * @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.
18718
18986
  * @interface
18719
18987
  */
18720
- declare type WindowShowRequestedEvent = NamedEvent & {
18988
+ declare type WindowShowRequestedEvent = BaseWindowEvent & {
18721
18989
  type: 'show-requested';
18722
18990
  };
18723
18991
 
18992
+ /**
18993
+ * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
18994
+ * from {@link OpenFin.ViewEvents}.
18995
+ */
18996
+ 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;
18997
+
18724
18998
  /**
18725
18999
  * Generated when a child window starts loading.
18726
19000
  * @interface
18727
19001
  */
18728
- declare type WindowStartLoadEvent = NamedEvent & {
19002
+ declare type WindowStartLoadEvent = BaseApplicationEvent & {
18729
19003
  type: 'window-start-load';
18730
19004
  };
18731
19005
 
@@ -18734,6 +19008,14 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18734
19008
  */
18735
19009
  declare type WindowState = 'maximized' | 'minimized' | 'normal';
18736
19010
 
19011
+ /**
19012
+ * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
19013
+ * to the `Application` level, with the name pattern `window-view-eventname`.
19014
+ */
19015
+ declare type WindowViewEvent = {
19016
+ viewIdentity: OpenFin_2.Identity;
19017
+ } & (ViewAttachedEvent | ViewDetachedEvent);
19018
+
18737
19019
  /**
18738
19020
  * @interface
18739
19021
  */