@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.
package/out/mock.d.ts CHANGED
@@ -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;
@@ -859,6 +859,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
859
859
  * @interface
860
860
  */
861
861
  declare type ApplicationConnectedEvent = IdentityEvent & {
862
+ topic: 'application';
862
863
  type: 'connected';
863
864
  };
864
865
 
@@ -866,7 +867,7 @@ declare type ApplicationConnectedEvent = IdentityEvent & {
866
867
  * Generated when an application is created.
867
868
  * @interface
868
869
  */
869
- declare type ApplicationCreatedEvent = IdentityEvent & {
870
+ declare type ApplicationCreatedEvent = BaseSystemEvent & IdentityEvent & {
870
871
  type: 'application-created';
871
872
  };
872
873
 
@@ -895,14 +896,13 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
895
896
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
896
897
  * from which they propagate).
897
898
  */
898
- declare type ApplicationEvent = {
899
- topic: 'application';
900
- } & (PropagatedViewEvent | PropagatedWindowEvent | ApplicationWindowEvent | WillPropagateApplicationEvent);
899
+ declare type ApplicationEvent = PropagatedViewEvent<'application'> | PropagatedWindowEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
901
900
 
902
901
  declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
903
902
 
904
903
  declare namespace ApplicationEvents {
905
904
  export {
905
+ BaseApplicationEvent,
906
906
  CrashedEvent,
907
907
  FileDownloadLocationChangedEvent,
908
908
  RunRequestedEvent_2 as RunRequestedEvent,
@@ -921,16 +921,18 @@ declare namespace ApplicationEvents {
921
921
  NotRespondingEvent,
922
922
  RespondingEvent,
923
923
  StartedEvent,
924
- WillPropagateApplicationEvent,
924
+ ApplicationSourcedEvent,
925
925
  ApplicationEvent,
926
926
  ApplicationEventType,
927
927
  PropagatedApplicationEvent,
928
- PropagatedApplicationEventType
928
+ PropagatedApplicationEventType,
929
+ Payload_2 as Payload,
930
+ ByType
929
931
  }
930
932
  }
931
933
 
932
934
  /**
933
- * An Application event type.
935
+ * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
934
936
  */
935
937
  declare type ApplicationEventType = ApplicationEvent['type'];
936
938
 
@@ -1281,6 +1283,14 @@ declare type ApplicationPermissions = {
1281
1283
  getFileDownloadLocation: boolean;
1282
1284
  };
1283
1285
 
1286
+ /**
1287
+ * A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
1288
+ * from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
1289
+ * does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
1290
+ *
1291
+ */
1292
+ declare type ApplicationSourcedEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1293
+
1284
1294
  declare type ApplicationState = OpenFin_2.ApplicationState;
1285
1295
 
1286
1296
  /**
@@ -1526,14 +1536,6 @@ declare type AppVersionTypeFromIdEvent<T extends IdEventType> = Extract<AppVersi
1526
1536
  type: WithoutId<T>;
1527
1537
  }>;
1528
1538
 
1529
- /**
1530
- * Generated when a View is attached to a window.
1531
- * @interface
1532
- */
1533
- declare type AttachedEvent = BaseViewEvent & {
1534
- type: 'attached';
1535
- };
1536
-
1537
1539
  declare interface AuthorizationPayload {
1538
1540
  token: string;
1539
1541
  file: string;
@@ -1603,7 +1605,7 @@ declare interface AuthorizationPayload {
1603
1605
  * ```
1604
1606
  * @interface
1605
1607
  */
1606
- declare type AuthRequestedEvent = NamedEvent & {
1608
+ declare type AuthRequestedEvent = BaseWindowEvent & {
1607
1609
  type: 'auth-requested';
1608
1610
  authInfo: {
1609
1611
  host: string;
@@ -1670,6 +1672,14 @@ declare class Base {
1670
1672
  protected isBrowserEnvironment: () => boolean;
1671
1673
  }
1672
1674
 
1675
+ /**
1676
+ * Base type for events emitting on the `application` topic
1677
+ * @interface
1678
+ */
1679
+ declare type BaseApplicationEvent = NamedEvent & {
1680
+ topic: `application`;
1681
+ };
1682
+
1673
1683
  /**
1674
1684
  * A base Channel event.
1675
1685
  * @interface
@@ -1742,6 +1752,14 @@ declare namespace BaseEvents {
1742
1752
  }
1743
1753
  }
1744
1754
 
1755
+ /**
1756
+ * Base type for events emitting on the `externalapplication` topic
1757
+ * @interface
1758
+ */
1759
+ declare type BaseExternalApplicationEvent = BaseEvent & {
1760
+ topic: 'externalapplication';
1761
+ };
1762
+
1745
1763
  /**
1746
1764
  * The base frame event.
1747
1765
  * @interface
@@ -1758,18 +1776,34 @@ declare type BaseLoadFailedEvent = NamedEvent & {
1758
1776
  isMainFrame: boolean;
1759
1777
  };
1760
1778
 
1779
+ /**
1780
+ * Base type for events emitting on the `system` topic
1781
+ * @interface
1782
+ */
1783
+ declare type BaseSystemEvent = BaseEvent & {
1784
+ topic: 'system';
1785
+ };
1786
+
1761
1787
  declare type BaseUrlEvent = NamedEvent & {
1762
1788
  type: 'url-changed';
1763
1789
  url: string;
1764
1790
  };
1765
1791
 
1766
1792
  /**
1767
- * A base View event.
1793
+ * Base type for events emitting on the `view` topic
1768
1794
  * @interface
1769
1795
  */
1770
1796
  declare type BaseViewEvent = NamedEvent & {
1797
+ topic: 'view';
1771
1798
  target: OpenFin_2.Identity;
1772
- viewIdentity: OpenFin_2.Identity;
1799
+ };
1800
+
1801
+ /**
1802
+ * Base type for events emitting on the `window` topic
1803
+ * @interface
1804
+ */
1805
+ declare type BaseWindowEvent = NamedEvent & {
1806
+ topic: 'window';
1773
1807
  };
1774
1808
 
1775
1809
  /**
@@ -1825,7 +1859,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
1825
1859
  * A general bounds change event without event type.
1826
1860
  * @interface
1827
1861
  */
1828
- declare type BoundsChangeEvent = NamedEvent & {
1862
+ declare type BoundsChangeEvent = BaseWindowEvent & {
1829
1863
  changeType: 0 | 1 | 2;
1830
1864
  deferred: boolean;
1831
1865
  height: number;
@@ -1884,6 +1918,78 @@ declare interface BrowserWindow {
1884
1918
  popIn(): void;
1885
1919
  }
1886
1920
 
1921
+ /**
1922
+ * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
1923
+ *
1924
+ * Alias for {@link Payload}, which may read better in source.
1925
+ *
1926
+ * @typeParam Type String key specifying the event to extract
1927
+ */
1928
+ declare type ByType<Type extends ApplicationEventType> = Payload_2<Type>;
1929
+
1930
+ /**
1931
+ * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
1932
+ *
1933
+ * Alias for {@link Payload}, which may read better in source.
1934
+ *
1935
+ * @typeParam Type String key specifying the event to extract
1936
+ */
1937
+ declare type ByType_2<Type extends ExternalApplicationEventType> = Payload_3<Type>;
1938
+
1939
+ /**
1940
+ * Extracts a single event type matching the given key from the {@link FrameEvent} union.
1941
+ *
1942
+ * Alias for {@link Payload}, which may read better in source.
1943
+ *
1944
+ * @typeParam Type String key specifying the event to extract
1945
+ */
1946
+ declare type ByType_3<Type extends FrameEventType> = Payload_4<Type>;
1947
+
1948
+ /**
1949
+ * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
1950
+ *
1951
+ * Alias for {@link Payload}, which may read better in source.
1952
+ *
1953
+ * @typeParam Type String key specifying the event to extract
1954
+ */
1955
+ declare type ByType_4<Type extends GlobalHotkeyEventType> = Payload_5<Type>;
1956
+
1957
+ /**
1958
+ * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
1959
+ *
1960
+ * Alias for {@link Payload}, which may read better in source.
1961
+ *
1962
+ * @typeParam Type String key specifying the event to extract
1963
+ */
1964
+ declare type ByType_5<Type extends PlatformEventType> = Payload_6<Type>;
1965
+
1966
+ /**
1967
+ * Extracts a single event type matching the given key from the {@link SystemEvent} union.
1968
+ *
1969
+ * Alias for {@link Payload}, which may read better in source.
1970
+ *
1971
+ * @typeParam Type String key specifying the event to extract
1972
+ */
1973
+ declare type ByType_6<Type extends SystemEventType> = Payload_7<Type>;
1974
+
1975
+ /**
1976
+ * Extracts a single event type matching the given key from the {@link ViewEvent} union.
1977
+ *
1978
+ * Alias for {@link Payload}, which may read better in source.
1979
+ *
1980
+ * @typeParam Type String key specifying the event to extract
1981
+ */
1982
+ declare type ByType_7<Type extends ViewEventType> = Payload_8<Type>;
1983
+
1984
+ /**
1985
+ * Extracts a single event type matching the given key from the {@link WindowEvent} union.
1986
+ *
1987
+ * Alias for {@link Payload}, which may read better in source.
1988
+ *
1989
+ * @typeParam Type String key specifying the event to extract
1990
+ */
1991
+ declare type ByType_8<Type extends WindowEventType> = Payload_9<Type>;
1992
+
1887
1993
  /**
1888
1994
  * Configuration for page capture.
1889
1995
  *
@@ -2612,7 +2718,9 @@ declare type ChannelDisconnectedEvent = BaseChannelEvent & {
2612
2718
  };
2613
2719
 
2614
2720
  /**
2615
- * A Channel event.
2721
+ * [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
2722
+ * discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
2723
+ * under the {@link OpenFin.ChannelEvents} namespace.
2616
2724
  */
2617
2725
  declare type ChannelEvent = {
2618
2726
  topic: 'channel';
@@ -3155,6 +3263,7 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
3155
3263
  * @interface
3156
3264
  */
3157
3265
  declare type ClosedEvent = IdentityEvent & {
3266
+ topic: 'application';
3158
3267
  type: 'closed';
3159
3268
  };
3160
3269
 
@@ -4207,7 +4316,22 @@ declare type CpuInfo = {
4207
4316
  * Generated when an application has crashed.
4208
4317
  * @interface
4209
4318
  */
4210
- declare type CrashedEvent = NamedEvent & {
4319
+ declare type CrashedEvent = IdentityEvent & {
4320
+ topic: 'application';
4321
+ type: 'crashed';
4322
+ reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
4323
+ exitCode: number;
4324
+ details: {
4325
+ reason: string;
4326
+ exitCode: number;
4327
+ };
4328
+ };
4329
+
4330
+ /**
4331
+ * Generated when a WebContents has crashed.
4332
+ * @interface
4333
+ */
4334
+ declare type CrashedEvent_2 = NamedEvent & {
4211
4335
  type: 'crashed';
4212
4336
  reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
4213
4337
  exitCode: number;
@@ -4353,7 +4477,7 @@ declare interface DesktopAgent_2 {
4353
4477
  * Generated when the desktop icon is clicked while it's already running.
4354
4478
  * @interface
4355
4479
  */
4356
- declare type DesktopIconClickedEvent = BaseEvent & {
4480
+ declare type DesktopIconClickedEvent = BaseSystemEvent & {
4357
4481
  type: 'desktop-icon-clicked';
4358
4482
  };
4359
4483
 
@@ -4583,7 +4707,7 @@ declare interface DragSource {}
4583
4707
  * Generated when a window has been embedded.
4584
4708
  * @interface
4585
4709
  */
4586
- declare type EmbeddedEvent = NamedEvent & {
4710
+ declare type EmbeddedEvent = BaseWindowEvent & {
4587
4711
  type: 'embedded';
4588
4712
  };
4589
4713
 
@@ -4687,7 +4811,7 @@ declare class EmitterMap {
4687
4811
  * Generated when a window ends loading.
4688
4812
  * @interface
4689
4813
  */
4690
- declare type EndLoadEvent = NamedEvent & {
4814
+ declare type EndLoadEvent = BaseWindowEvent & {
4691
4815
  type: 'end-load';
4692
4816
  documentName: string;
4693
4817
  isMain: boolean;
@@ -5012,7 +5136,7 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
5012
5136
  * Generated when an external application has authenticated and is connected.
5013
5137
  * @interface
5014
5138
  */
5015
- declare type ExternalApplicationConnectedEvent = BaseEvent & {
5139
+ declare type ExternalApplicationConnectedEvent = BaseExternalApplicationEvent & {
5016
5140
  type: 'connected';
5017
5141
  };
5018
5142
 
@@ -5020,7 +5144,7 @@ declare type ExternalApplicationConnectedEvent = BaseEvent & {
5020
5144
  * Generated when an external application has disconnected.
5021
5145
  * @interface
5022
5146
  */
5023
- declare type ExternalApplicationDisconnectedEvent = BaseEvent & {
5147
+ declare type ExternalApplicationDisconnectedEvent = BaseExternalApplicationEvent & {
5024
5148
  type: 'disconnected';
5025
5149
  };
5026
5150
 
@@ -5029,20 +5153,27 @@ declare type ExternalApplicationDisconnectedEvent = BaseEvent & {
5029
5153
  * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5030
5154
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5031
5155
  */
5032
- declare type ExternalApplicationEvent = {
5033
- topic: 'externalapplication';
5034
- } & (ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent);
5156
+ declare type ExternalApplicationEvent = ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent;
5035
5157
 
5036
5158
  declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
5037
5159
 
5038
5160
  declare namespace ExternalApplicationEvents {
5039
5161
  export {
5162
+ BaseExternalApplicationEvent,
5040
5163
  ExternalApplicationConnectedEvent,
5041
5164
  ExternalApplicationDisconnectedEvent,
5042
- ExternalApplicationEvent
5165
+ ExternalApplicationEvent,
5166
+ ExternalApplicationEventType,
5167
+ Payload_3 as Payload,
5168
+ ByType_2 as ByType
5043
5169
  }
5044
5170
  }
5045
5171
 
5172
+ /**
5173
+ * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
5174
+ */
5175
+ declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
5176
+
5046
5177
  /**
5047
5178
  * @interface
5048
5179
  */
@@ -5102,7 +5233,7 @@ declare type ExternalConnection = {
5102
5233
  * Generated when an external process has exited.
5103
5234
  * @interface
5104
5235
  */
5105
- declare type ExternalProcessExitedEvent = NamedEvent & {
5236
+ declare type ExternalProcessExitedEvent = BaseWindowEvent & {
5106
5237
  type: 'external-process-exited';
5107
5238
  processUuid: string;
5108
5239
  exitCode: number;
@@ -5147,7 +5278,7 @@ declare type ExternalProcessRequestType = {
5147
5278
  * Generated when an external process has started.
5148
5279
  * @interface
5149
5280
  */
5150
- declare type ExternalProcessStartedEvent = NamedEvent & {
5281
+ declare type ExternalProcessStartedEvent = BaseWindowEvent & {
5151
5282
  type: 'external-process-started';
5152
5283
  processUuid: string;
5153
5284
  };
@@ -5246,7 +5377,7 @@ declare type FileDownloadEvent = {
5246
5377
  *
5247
5378
  * @interface
5248
5379
  */
5249
- declare type FileDownloadLocationChangedEvent = NamedEvent & {
5380
+ declare type FileDownloadLocationChangedEvent = BaseApplicationEvent & {
5250
5381
  type: 'file-download-location-changed';
5251
5382
  };
5252
5383
 
@@ -5532,7 +5663,9 @@ declare type FrameDisconnectedEvent = BaseFrameEvent & {
5532
5663
  };
5533
5664
 
5534
5665
  /**
5535
- * A Frame event.
5666
+ * [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
5667
+ * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5668
+ * under the {@link OpenFin.FrameEvents} namespace.
5536
5669
  */
5537
5670
  declare type FrameEvent = {
5538
5671
  topic: 'frame';
@@ -5546,14 +5679,14 @@ declare namespace FrameEvents {
5546
5679
  FrameConnectedEvent,
5547
5680
  FrameDisconnectedEvent,
5548
5681
  FrameEvent,
5549
- FrameEventType
5682
+ FrameEventType,
5683
+ Payload_4 as Payload,
5684
+ ByType_3 as ByType
5550
5685
  }
5551
5686
  }
5552
5687
 
5553
5688
  /**
5554
- * [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
5555
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5556
- * under the {@link OpenFin.FrameEvents} namespace.
5689
+ * Union of possible `type` values for a {@link FrameEvent}.
5557
5690
  */
5558
5691
  declare type FrameEventType = FrameEvent['type'];
5559
5692
 
@@ -5790,10 +5923,18 @@ declare namespace GlobalHotkeyEvents {
5790
5923
  export {
5791
5924
  RegisteredEvent,
5792
5925
  UnregisteredEvent,
5793
- GlobalHotkeyEvent
5926
+ GlobalHotkeyEvent,
5927
+ GlobalHotkeyEventType,
5928
+ Payload_5 as Payload,
5929
+ ByType_4 as ByType
5794
5930
  }
5795
5931
  }
5796
5932
 
5933
+ /**
5934
+ * Union of possible `type` values for a {@link GlobalHotkeyEvent}
5935
+ */
5936
+ declare type GlobalHotkeyEventType = GlobalHotkeyEvent['type'];
5937
+
5797
5938
  declare namespace GoldenLayout {
5798
5939
  export {
5799
5940
  GoldenLayout_2 as GoldenLayout,
@@ -6239,7 +6380,7 @@ declare type IdEventType = WithId<AppVersionEventType>;
6239
6380
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6240
6381
  * @interface
6241
6382
  */
6242
- declare type IdleEvent = {
6383
+ declare type IdleEvent = BaseSystemEvent & {
6243
6384
  type: 'idle-state-changed';
6244
6385
  elapsedTime: number;
6245
6386
  isIdle: boolean;
@@ -6325,6 +6466,7 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6325
6466
  * @interface
6326
6467
  */
6327
6468
  declare type InitializedEvent = IdentityEvent & {
6469
+ topic: 'application';
6328
6470
  type: 'initialized';
6329
6471
  };
6330
6472
 
@@ -8510,7 +8652,7 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
8510
8652
  * Generated when a window and all of its layout's views have either finished or failed navigation.
8511
8653
  * @interface
8512
8654
  */
8513
- declare type LayoutInitializedEvent = NamedEvent & {
8655
+ declare type LayoutInitializedEvent = BaseWindowEvent & {
8514
8656
  type: 'layout-initialized';
8515
8657
  ofViews: (OpenFin_2.Identity & {
8516
8658
  entityType: 'view';
@@ -9009,7 +9151,7 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9009
9151
  * Generated when a window and all of its layout's views have been created and can receive API calls.
9010
9152
  * @interface
9011
9153
  */
9012
- declare type LayoutReadyEvent = NamedEvent & {
9154
+ declare type LayoutReadyEvent = BaseWindowEvent & {
9013
9155
  type: 'layout-ready';
9014
9156
  views: (OpenFin_2.Identity & {
9015
9157
  success: boolean;
@@ -9144,6 +9286,7 @@ declare type Manifest = {
9144
9286
  * @interface
9145
9287
  */
9146
9288
  declare type ManifestChangedEvent = IdentityEvent & {
9289
+ topic: 'application';
9147
9290
  type: 'manifest-changed';
9148
9291
  };
9149
9292
 
@@ -9195,7 +9338,7 @@ declare type MatchPattern = string;
9195
9338
  * Generated when a window is maximized.
9196
9339
  * @interface
9197
9340
  */
9198
- declare type MaximizedEvent = NamedEvent & {
9341
+ declare type MaximizedEvent = BaseWindowEvent & {
9199
9342
  type: 'maximized';
9200
9343
  };
9201
9344
 
@@ -9295,7 +9438,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
9295
9438
  * Generated when a window is minimized.
9296
9439
  * @interface
9297
9440
  */
9298
- declare type MinimizedEvent = NamedEvent & {
9441
+ declare type MinimizedEvent = BaseWindowEvent & {
9299
9442
  type: 'minimized';
9300
9443
  };
9301
9444
 
@@ -9344,7 +9487,7 @@ declare type MonitorDetails = {
9344
9487
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9345
9488
  * @interface
9346
9489
  */
9347
- declare type MonitorEvent = OpenFin_2.MonitorInfo & {
9490
+ declare type MonitorEvent = BaseSystemEvent & OpenFin_2.MonitorInfo & {
9348
9491
  type: 'monitor-info-changed';
9349
9492
  };
9350
9493
 
@@ -9754,19 +9897,25 @@ declare type NonAppProcessDetails = ProcessDetails & {
9754
9897
  };
9755
9898
 
9756
9899
  /**
9757
- * A View event that does not propagate to (republish on) parent topics.
9900
+ * @DEPRECATED All view events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
9901
+ *
9902
+ * A view event that does not propagate to (republish on) parent topics.
9758
9903
  */
9759
- declare type NonPropagatedViewEvent = BaseViewEvent & NonPropagatedWebContentsEvent;
9904
+ declare type NonPropagatedViewEvent = never;
9760
9905
 
9761
9906
  /**
9907
+ * @DEPRECATED all webcontents events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
9908
+ *
9762
9909
  * A WebContents event that does not propagate to (republish on) parent topics.
9763
9910
  */
9764
- declare type NonPropagatedWebContentsEvent = FoundInPageEvent | CertificateErrorEvent;
9911
+ declare type NonPropagatedWebContentsEvent = never;
9765
9912
 
9766
9913
  /**
9767
- * A Window event that does not propagate to (republish on) parent topics.
9914
+ * @DEPRECATED All window events propagate; this type is erroneous - left as a loudly-breaking shim to alert users
9915
+ *
9916
+ * A window event that does not propagate to (republish on) parent topics.
9768
9917
  */
9769
- declare type NonPropagatedWindowEvent = NonPropagatedWebContentsEvent;
9918
+ declare type NonPropagatedWindowEvent = never;
9770
9919
 
9771
9920
  /**
9772
9921
  * @internal
@@ -9778,6 +9927,7 @@ declare type NotRequested<EventType> = EventType extends `${infer U}-requested`
9778
9927
  * @interface
9779
9928
  */
9780
9929
  declare type NotRespondingEvent = IdentityEvent & {
9930
+ topic: 'application';
9781
9931
  type: 'not-responding';
9782
9932
  };
9783
9933
 
@@ -10145,13 +10295,85 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
10145
10295
  error?: Success extends false ? ErrorPlainObject | undefined : never;
10146
10296
  };
10147
10297
 
10298
+ /**
10299
+ * Extracts a single event type matching the given key from the {@link ApplicationEvent} union.
10300
+ *
10301
+ * @typeParam Type String key specifying the event to extract
10302
+ */
10303
+ declare type Payload_2<Type extends ApplicationEventType> = Extract<ApplicationEvent, {
10304
+ type: Type;
10305
+ }>;
10306
+
10307
+ /**
10308
+ * Extracts a single event type matching the given key from the {@link ExternalApplicationEvent} union.
10309
+ *
10310
+ * @typeParam Type String key specifying the event to extract
10311
+ */
10312
+ declare type Payload_3<Type extends ExternalApplicationEventType> = Extract<ExternalApplicationEvent, {
10313
+ type: Type;
10314
+ }>;
10315
+
10316
+ /**
10317
+ * Extracts a single event type matching the given key from the {@link FrameEvent} union.
10318
+ *
10319
+ * @typeParam Type String key specifying the event to extract
10320
+ */
10321
+ declare type Payload_4<Type extends FrameEventType> = Extract<FrameEvent, {
10322
+ type: Type;
10323
+ }>;
10324
+
10325
+ /**
10326
+ * Extracts a single event type matching the given key from the {@link GlobalHotkeyEvent} union.
10327
+ *
10328
+ * @typeParam Type String key specifying the event to extract
10329
+ */
10330
+ declare type Payload_5<Type extends GlobalHotkeyEventType> = Extract<GlobalHotkeyEvent, {
10331
+ type: Type;
10332
+ }>;
10333
+
10334
+ /**
10335
+ * Extracts a single event type matching the given key from the {@link PlatformEvent} union.
10336
+ *
10337
+ * @typeParam Type String key specifying the event to extract
10338
+ */
10339
+ declare type Payload_6<Type extends PlatformEventType> = Extract<PlatformEvent, {
10340
+ type: Type;
10341
+ }>;
10342
+
10343
+ /**
10344
+ * Extracts a single event type matching the given key from the {@link SystemEvent} union.
10345
+ *
10346
+ * @typeParam Type String key specifying the event to extract
10347
+ */
10348
+ declare type Payload_7<Type extends SystemEventType> = Extract<SystemEvent, {
10349
+ type: Type;
10350
+ }>;
10351
+
10352
+ /**
10353
+ * Extracts a single event type matching the given key from the {@link ViewEvent} union.
10354
+ *
10355
+ * @typeParam Type String key specifying the event to extract
10356
+ */
10357
+ declare type Payload_8<Type extends ViewEventType> = Extract<ViewEvent, {
10358
+ type: Type;
10359
+ }>;
10360
+
10361
+ /**
10362
+ * Extracts a single event type matching the given key from the {@link WindowEvent} union.
10363
+ *
10364
+ * @typeParam Type String key specifying the event to extract
10365
+ */
10366
+ declare type Payload_9<Type extends WindowEventType> = Extract<WindowEvent, {
10367
+ type: Type;
10368
+ }>;
10369
+
10148
10370
  declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T extends ChannelStrategy<infer U> ? U : never;
10149
10371
 
10150
10372
  /**
10151
10373
  * Generated when window finishes loading. Provides performance and navigation data.
10152
10374
  * @interface
10153
10375
  */
10154
- declare type PerformanceReportEvent = Performance & NamedEvent & {
10376
+ declare type PerformanceReportEvent = Performance & BaseWindowEvent & {
10155
10377
  type: 'performance-report';
10156
10378
  };
10157
10379
 
@@ -10838,10 +11060,18 @@ declare namespace PlatformEvents {
10838
11060
  export {
10839
11061
  PlatformApiReadyEvent,
10840
11062
  PlatformSnapshotAppliedEvent,
10841
- PlatformEvent
11063
+ PlatformEvent,
11064
+ PlatformEventType,
11065
+ Payload_6 as Payload,
11066
+ ByType_5 as ByType
10842
11067
  }
10843
11068
  }
10844
11069
 
11070
+ /**
11071
+ * Union of possible `type` values for a {@link PlatformEvent}.
11072
+ */
11073
+ declare type PlatformEventType = PlatformEvent['type'];
11074
+
10845
11075
  /**
10846
11076
  * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
10847
11077
  */
@@ -11822,7 +12052,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
11822
12052
  * A general preload scripts state change event without event type.
11823
12053
  * @interface
11824
12054
  */
11825
- declare type PreloadScriptsStateChangeEvent = NamedEvent & {
12055
+ declare type PreloadScriptsStateChangeEvent = BaseWindowEvent & {
11826
12056
  preloadScripts: (PreloadScriptInfoRunning & any)[];
11827
12057
  };
11828
12058
 
@@ -12031,25 +12261,30 @@ declare type ProcessLoggingOptions = {
12031
12261
  };
12032
12262
 
12033
12263
  /**
12034
- * A propagated Application event.
12264
+ * An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
12265
+ * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
12266
+ * are propagated to `System` without any type string prefixing.
12267
+ *
12268
+ * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
12035
12269
  */
12036
- declare type PropagatedApplicationEvent = PropagatedEvent<'application', WillPropagateApplicationEvent> | ApplicationWindowEvent;
12270
+ declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
12037
12271
 
12038
12272
  /**
12039
- * A propagated Application event type.
12273
+ * Union of possible 'type' values for a {@link OpenFin.ApplicationEvents.PropagatedApplicationEvent}.
12040
12274
  */
12041
- declare type PropagatedApplicationEventType = PropagatedApplicationEvent['type'];
12275
+ declare type PropagatedApplicationEventType = PropagatedApplicationEvent<string>['type'];
12042
12276
 
12043
12277
  /**
12044
12278
  * Modifies an event shape to reflect propagation to a parent topic.
12045
12279
  * @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
12046
12280
  */
12047
- declare type PropagatedEvent<Topic extends string, Event extends {
12281
+ declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
12048
12282
  type: string;
12049
12283
  }> = Event extends infer E extends {
12050
12284
  type: string;
12051
- } ? Omit<E, 'type'> & {
12052
- type: PropagatedEventType<Topic, E['type']>;
12285
+ } ? Omit<E, 'type' | 'topic'> & {
12286
+ type: PropagatedEventType<SourceTopic, E['type']>;
12287
+ topic: TargetTopic;
12053
12288
  } : never;
12054
12289
 
12055
12290
  /**
@@ -12058,29 +12293,33 @@ declare type PropagatedEvent<Topic extends string, Event extends {
12058
12293
  declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
12059
12294
 
12060
12295
  /**
12061
- * A propagated View event that is re-propagated from window.
12062
- */
12063
- declare type PropagatedViewAttachedEvent = PropagatedEvent<'view', AttachedEvent>;
12064
-
12065
- /**
12066
- * A propagated View event.
12296
+ * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
12297
+ * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
12298
+ * event type key with `'view-'`.
12067
12299
  */
12068
- declare type PropagatedViewEvent = PropagatedEvent<'view', WillPropagateViewEvent>;
12300
+ declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
12301
+ viewIdentity: OpenFin_2.Identity;
12302
+ };
12069
12303
 
12070
12304
  /**
12071
- * A propagated View event type.
12305
+ * Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
12072
12306
  */
12073
- declare type PropagatedViewEventType = PropagatedViewEvent['type'];
12307
+ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
12074
12308
 
12075
12309
  /**
12076
- * A propagated Window event.
12310
+ * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
12311
+ * prefixing the type string with `'window-'`. Only {@link NativeWindowEvent native window events} will propagate
12312
+ * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
12313
+ * will *not* re-propagate.
12314
+ *
12315
+ * "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
12077
12316
  */
12078
- declare type PropagatedWindowEvent = PropagatedEvent<'window', Exclude<WillPropagateWindowEvent, WindowCloseRequestedEvent>>;
12317
+ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent<'window', TargetTopic, Exclude<WindowSourcedEvent, WindowCloseRequestedEvent>>;
12079
12318
 
12080
12319
  /**
12081
- * A propagated Window event type.
12320
+ * Union of possible `type` values for a {@link OpenFin.WindowEvents.PropagatedWindowEvent}.
12082
12321
  */
12083
- declare type PropagatedWindowEventType = PropagatedWindowEvent['type'];
12322
+ declare type PropagatedWindowEventType = PropagatedWindowEvent<string>['type'];
12084
12323
 
12085
12324
  declare interface ProtocolMap extends ProtocolMapBase {
12086
12325
  'request-external-authorization': {
@@ -12487,7 +12726,7 @@ declare type RegistryInfo_2 = {
12487
12726
  * Generated when a window has been reloaded.
12488
12727
  * @interface
12489
12728
  */
12490
- declare type ReloadedEvent = NamedEvent & {
12729
+ declare type ReloadedEvent = BaseWindowEvent & {
12491
12730
  type: 'reloaded';
12492
12731
  url: string;
12493
12732
  };
@@ -12609,6 +12848,7 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
12609
12848
  * @interface
12610
12849
  */
12611
12850
  declare type RespondingEvent = IdentityEvent & {
12851
+ topic: 'application';
12612
12852
  type: 'responding';
12613
12853
  };
12614
12854
 
@@ -12675,6 +12915,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
12675
12915
  * @interface
12676
12916
  */
12677
12917
  declare type RunRequestedEvent_2 = IdentityEvent & {
12918
+ topic: 'application';
12678
12919
  type: 'run-requested';
12679
12920
  userAppConfigArgs: Record<string, any>;
12680
12921
  manifest: OpenFin_2.Manifest;
@@ -12855,7 +13096,7 @@ declare type ServiceIdentifier = {
12855
13096
  * Generated on changes to a user’s local computer session.
12856
13097
  * @interface
12857
13098
  */
12858
- declare type SessionChangedEvent = {
13099
+ declare type SessionChangedEvent = BaseSystemEvent & {
12859
13100
  type: 'session-changed';
12860
13101
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
12861
13102
  };
@@ -13266,6 +13507,7 @@ declare type SplitterItem = GoldenLayout.ContentItem & {
13266
13507
  * @interface
13267
13508
  */
13268
13509
  declare type StartedEvent = IdentityEvent & {
13510
+ topic: 'application';
13269
13511
  type: 'started';
13270
13512
  };
13271
13513
 
@@ -14741,9 +14983,7 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
14741
14983
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
14742
14984
  * from which they propagate).
14743
14985
  */
14744
- declare type SystemEvent = {
14745
- topic: 'system';
14746
- } & (ExcludeRequested<PropagatedWindowEvent> | PropagatedViewEvent | PropagatedApplicationEvent | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent);
14986
+ declare type SystemEvent = ExcludeRequested<PropagatedWindowEvent<'system'>> | PropagatedViewEvent<'system'> | PropagatedApplicationEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
14747
14987
 
14748
14988
  declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
14749
14989
 
@@ -14751,6 +14991,7 @@ declare namespace SystemEvents {
14751
14991
  export {
14752
14992
  NotRequested,
14753
14993
  ExcludeRequested,
14994
+ BaseSystemEvent,
14754
14995
  IdleEvent,
14755
14996
  MonitorEvent,
14756
14997
  SessionChangedEvent,
@@ -14766,12 +15007,14 @@ declare namespace SystemEvents {
14766
15007
  DesktopIconClickedEvent,
14767
15008
  SystemShutdownEvent,
14768
15009
  SystemEvent,
14769
- SystemEventType
15010
+ SystemEventType,
15011
+ Payload_7 as Payload,
15012
+ ByType_6 as ByType
14770
15013
  }
14771
15014
  }
14772
15015
 
14773
15016
  /**
14774
- * A system event type.
15017
+ * Union of possible `type` values for a {@link SystemEvent}.
14775
15018
  */
14776
15019
  declare type SystemEventType = SystemEvent['type'];
14777
15020
 
@@ -14818,7 +15061,7 @@ declare type SystemProcessInfo = {
14818
15061
  * Generated when system shutdown or log off.
14819
15062
  * @internal
14820
15063
  */
14821
- declare type SystemShutdownEvent = BaseEvent & {
15064
+ declare type SystemShutdownEvent = BaseSystemEvent & {
14822
15065
  type: 'system-shutdown';
14823
15066
  };
14824
15067
 
@@ -15275,6 +15518,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
15275
15518
  * @interface
15276
15519
  */
15277
15520
  declare type TrayIconClickedEvent = IdentityEvent & {
15521
+ topic: 'application';
15278
15522
  type: 'tray-icon-clicked';
15279
15523
  button: 0 | 1 | 2;
15280
15524
  bounds: OpenFin_2.Rectangle;
@@ -15363,7 +15607,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15363
15607
  * A general user bounds change event without event type.
15364
15608
  * @interface
15365
15609
  */
15366
- declare type UserBoundsChangeEvent = NamedEvent & {
15610
+ declare type UserBoundsChangeEvent = BaseWindowEvent & {
15367
15611
  height: number;
15368
15612
  left: number;
15369
15613
  top: number;
@@ -15375,7 +15619,7 @@ declare type UserBoundsChangeEvent = NamedEvent & {
15375
15619
  * Generated when a window's user movement becomes disabled.
15376
15620
  * @interface
15377
15621
  */
15378
- declare type UserMovementDisabledEvent = NamedEvent & {
15622
+ declare type UserMovementDisabledEvent = BaseWindowEvent & {
15379
15623
  type: 'user-movement-disabled';
15380
15624
  };
15381
15625
 
@@ -15383,7 +15627,7 @@ declare type UserMovementDisabledEvent = NamedEvent & {
15383
15627
  * Generated when a window's user movement becomes enabled.
15384
15628
  * @interface
15385
15629
  */
15386
- declare type UserMovementEnabledEvent = NamedEvent & {
15630
+ declare type UserMovementEnabledEvent = BaseWindowEvent & {
15387
15631
  type: 'user-movement-enabled';
15388
15632
  };
15389
15633
 
@@ -16070,6 +16314,16 @@ declare type View_3 = OpenFin_2.View;
16070
16314
 
16071
16315
  declare type View_4 = OpenFin_2.View;
16072
16316
 
16317
+ /**
16318
+ * Generated when a View is attached to a window.
16319
+ * @interface
16320
+ */
16321
+ declare type ViewAttachedEvent = BaseWindowEvent & {
16322
+ type: 'view-attached';
16323
+ target: OpenFin_2.Identity;
16324
+ viewIdentity: OpenFin_2.Identity;
16325
+ };
16326
+
16073
16327
  declare interface ViewComponent extends GoldenLayout.ContentItem {
16074
16328
  componentState: OpenFin_2.ViewState;
16075
16329
  }
@@ -16094,9 +16348,11 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
16094
16348
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
16095
16349
  * @interface
16096
16350
  */
16097
- declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
16351
+ declare type ViewDetachedEvent = BaseWindowEvent & {
16098
16352
  type: 'view-detached';
16353
+ target: OpenFin_2.Identity;
16099
16354
  previousTarget: OpenFin_2.Identity;
16355
+ viewIdentity: OpenFin_2.Identity;
16100
16356
  };
16101
16357
 
16102
16358
  /**
@@ -16104,9 +16360,9 @@ declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
16104
16360
  * discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
16105
16361
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
16106
16362
  */
16107
- declare type ViewEvent = {
16108
- topic: 'view';
16109
- } & (NonPropagatedViewEvent | WillPropagateViewEvent);
16363
+ declare type ViewEvent = (WebContentsEvent<'view'> & {
16364
+ target: OpenFin_2.Identity;
16365
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent;
16110
16366
 
16111
16367
  declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
16112
16368
 
@@ -16115,22 +16371,23 @@ declare namespace ViewEvents {
16115
16371
  BaseViewEvent,
16116
16372
  TargetChangedEvent,
16117
16373
  NonPropagatedViewEvent,
16118
- AttachedEvent,
16119
16374
  CreatedEvent,
16120
16375
  DestroyedEvent,
16121
16376
  HiddenEvent,
16122
16377
  HotkeyEvent,
16123
16378
  ShownEvent,
16124
- WillPropagateViewEvent,
16125
16379
  ViewEvent,
16380
+ WillPropagateViewEvent,
16126
16381
  ViewEventType,
16127
16382
  PropagatedViewEvent,
16128
- PropagatedViewEventType
16383
+ PropagatedViewEventType,
16384
+ Payload_8 as Payload,
16385
+ ByType_7 as ByType
16129
16386
  }
16130
16387
  }
16131
16388
 
16132
16389
  /**
16133
- * A View event type.
16390
+ * Union of possible `type` values for a {@link OpenFin.ViewEvents.ViewEvent}.
16134
16391
  */
16135
16392
  declare type ViewEventType = ViewEvent['type'];
16136
16393
 
@@ -17305,17 +17562,21 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17305
17562
  }
17306
17563
 
17307
17564
  /**
17308
- * A WebContents event.
17565
+ * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
17566
+ * (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
17309
17567
  */
17310
- declare type WebContentsEvent = NonPropagatedWebContentsEvent | WillPropagateWebContentsEvent;
17568
+ declare type WebContentsEvent<Topic extends string> = {
17569
+ topic: Topic;
17570
+ } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
17311
17571
 
17312
- declare type WebContentsEvent_2 = Events.WebContentsEvents.WebContentsEvent;
17572
+ declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
17313
17573
 
17314
17574
  declare namespace WebContentsEvents {
17315
17575
  export {
17316
17576
  ResourceLoadFailedEvent,
17317
17577
  ResourceResponseReceivedEvent,
17318
17578
  PageTitleUpdatedEvent,
17579
+ CrashedEvent_2 as CrashedEvent,
17319
17580
  CertificateErrorEvent,
17320
17581
  CertificateSelectionShownEvent,
17321
17582
  FaviconUpdatedEvent,
@@ -17336,9 +17597,9 @@ declare namespace WebContentsEvents {
17336
17597
  FileDownloadStartedEvent,
17337
17598
  FileDownloadProgressEvent,
17338
17599
  FileDownloadCompletedEvent,
17600
+ WebContentsEvent,
17339
17601
  WillPropagateWebContentsEvent,
17340
- NonPropagatedWebContentsEvent,
17341
- WebContentsEvent
17602
+ NonPropagatedWebContentsEvent
17342
17603
  }
17343
17604
  }
17344
17605
 
@@ -17381,7 +17642,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
17381
17642
  * A general will-move or will-resize event without event type.
17382
17643
  * @interface
17383
17644
  */
17384
- declare type WillMoveOrResizeEvent = NamedEvent & {
17645
+ declare type WillMoveOrResizeEvent = BaseWindowEvent & {
17385
17646
  height: number;
17386
17647
  left: number;
17387
17648
  top: number;
@@ -17390,30 +17651,34 @@ declare type WillMoveOrResizeEvent = NamedEvent & {
17390
17651
  };
17391
17652
 
17392
17653
  /**
17393
- * An Application event that does propagate to (republish on) parent topics.
17394
- */
17395
- declare type WillPropagateApplicationEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
17396
-
17397
- /**
17654
+ * @DEPRECATED all View events propagate, so this is redundant - left as a convenience shim to avoid breaking
17655
+ * user code
17656
+ *
17398
17657
  * A View event that does propagate to (republish on) parent topics.
17399
17658
  */
17400
- declare type WillPropagateViewEvent = (WillPropagateWebContentsEvent & BaseViewEvent) | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent;
17659
+ declare type WillPropagateViewEvent = ViewEvent;
17401
17660
 
17402
17661
  /**
17662
+ * @DEPRECATED all webcontents events propagate, so this is redundant - left as a convenience shim to avoid breaking
17663
+ * user code
17664
+ *
17403
17665
  * A WebContents event that does propagate to (republish on) parent topics.
17404
17666
  */
17405
- declare type WillPropagateWebContentsEvent = BlurredEvent | CertificateSelectionShownEvent | CrashedEvent | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent;
17667
+ declare type WillPropagateWebContentsEvent = WebContentsEvent<string>;
17406
17668
 
17407
17669
  /**
17670
+ * @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
17671
+ * user code
17672
+ *
17408
17673
  * A Window event that does propagate to (republish on) parent topics.
17409
17674
  */
17410
- 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;
17675
+ declare type WillPropagateWindowEvent = WindowSourcedEvent;
17411
17676
 
17412
17677
  /**
17413
17678
  * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
17414
17679
  * @interface
17415
17680
  */
17416
- declare type WillRedirectEvent = NamedEvent & {
17681
+ declare type WillRedirectEvent = BaseWindowEvent & {
17417
17682
  type: 'will-redirect';
17418
17683
  blocked: boolean;
17419
17684
  isInPlace: boolean;
@@ -19038,7 +19303,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19038
19303
  * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
19039
19304
  * @interface
19040
19305
  */
19041
- declare type WindowAlertRequestedEvent = NamedEvent & {
19306
+ declare type WindowAlertRequestedEvent = BaseApplicationEvent & {
19042
19307
  type: 'window-alert-requested';
19043
19308
  };
19044
19309
 
@@ -19055,7 +19320,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19055
19320
  * Generated when a window has closed.
19056
19321
  * @interface
19057
19322
  */
19058
- declare type WindowClosedEvent = NamedEvent & {
19323
+ declare type WindowClosedEvent = BaseWindowEvent & {
19059
19324
  type: 'closed';
19060
19325
  };
19061
19326
 
@@ -19064,7 +19329,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19064
19329
  * @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.
19065
19330
  * @interface
19066
19331
  */
19067
- declare type WindowCloseRequestedEvent = NamedEvent & {
19332
+ declare type WindowCloseRequestedEvent = BaseWindowEvent & {
19068
19333
  type: 'close-requested';
19069
19334
  };
19070
19335
 
@@ -19072,7 +19337,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19072
19337
  * Generated when a window has initiated the closing routine.
19073
19338
  * @interface
19074
19339
  */
19075
- declare type WindowClosingEvent = NamedEvent & {
19340
+ declare type WindowClosingEvent = BaseWindowEvent & {
19076
19341
  type: 'closing';
19077
19342
  };
19078
19343
 
@@ -19080,7 +19345,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19080
19345
  * Generated when a child window is created.
19081
19346
  * @interface
19082
19347
  */
19083
- declare type WindowCreatedEvent = NamedEvent & {
19348
+ declare type WindowCreatedEvent = BaseApplicationEvent & {
19084
19349
  type: 'window-created';
19085
19350
  };
19086
19351
 
@@ -19137,7 +19402,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19137
19402
  * Generated when a child window ends loading.
19138
19403
  * @interface
19139
19404
  */
19140
- declare type WindowEndLoadEvent = NamedEvent & {
19405
+ declare type WindowEndLoadEvent = BaseApplicationEvent & {
19141
19406
  type: 'window-end-load';
19142
19407
  };
19143
19408
 
@@ -19146,14 +19411,16 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19146
19411
  * discriminated by {@link WindowEvent.type | their type}. Event payloads unique to `Window` can be found
19147
19412
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
19148
19413
  */
19149
- declare type WindowEvent = {
19150
- topic: 'window';
19151
- } & (WillPropagateWindowEvent | NonPropagatedWindowEvent | PropagatedViewEvent);
19414
+ declare type WindowEvent = WindowSourcedEvent | PropagatedViewEvent<'window'>;
19152
19415
 
19153
19416
  declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
19154
19417
 
19155
19418
  declare namespace WindowEvents {
19156
19419
  export {
19420
+ BaseWindowEvent,
19421
+ ViewAttachedEvent,
19422
+ ViewDetachedEvent,
19423
+ WindowViewEvent,
19157
19424
  AlertRequestedEvent,
19158
19425
  AuthRequestedEvent,
19159
19426
  EndLoadEvent,
@@ -19170,11 +19437,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19170
19437
  BoundsChangeEvent,
19171
19438
  WillMoveOrResizeEvent,
19172
19439
  PerformanceReportEvent,
19173
- ViewDetachedEvent,
19174
19440
  InputEvent_2 as InputEvent,
19175
19441
  LayoutInitializedEvent,
19176
19442
  LayoutReadyEvent,
19177
- NonPropagatedWindowEvent,
19178
19443
  BeginUserBoundsChangingEvent,
19179
19444
  BoundsChangedEvent,
19180
19445
  BoundsChangingEvent,
@@ -19198,17 +19463,20 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19198
19463
  UserMovementDisabledEvent,
19199
19464
  WillMoveEvent,
19200
19465
  WillResizeEvent,
19201
- PropagatedViewAttachedEvent,
19466
+ NonPropagatedWindowEvent,
19467
+ WindowSourcedEvent,
19202
19468
  WillPropagateWindowEvent,
19203
19469
  WindowEvent,
19204
19470
  WindowEventType,
19205
19471
  PropagatedWindowEvent,
19206
- PropagatedWindowEventType
19472
+ PropagatedWindowEventType,
19473
+ Payload_9 as Payload,
19474
+ ByType_8 as ByType
19207
19475
  }
19208
19476
  }
19209
19477
 
19210
19478
  /**
19211
- * A Window event type.
19479
+ * Union of possible `type` values for a {@link OpenFin.WindowEvents.WindowEvent}.
19212
19480
  */
19213
19481
  declare type WindowEventType = WindowEvent['type'];
19214
19482
 
@@ -19216,7 +19484,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19216
19484
  * Generated when a window has been hidden.
19217
19485
  * @interface
19218
19486
  */
19219
- declare type WindowHiddenEvent = NamedEvent & {
19487
+ declare type WindowHiddenEvent = BaseWindowEvent & {
19220
19488
  type: 'hidden';
19221
19489
  reason: 'closing' | 'hide' | 'hide-on-close';
19222
19490
  };
@@ -19226,7 +19494,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19226
19494
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
19227
19495
  * @interface
19228
19496
  */
19229
- declare type WindowHotkeyEvent = InputEvent_2 & NamedEvent & {
19497
+ declare type WindowHotkeyEvent = InputEvent_2 & BaseWindowEvent & {
19230
19498
  type: 'hotkey';
19231
19499
  };
19232
19500
 
@@ -19245,7 +19513,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19245
19513
  * Generated when a window is initialized.
19246
19514
  * @interface
19247
19515
  */
19248
- declare type WindowInitializedEvent = NamedEvent & {
19516
+ declare type WindowInitializedEvent = BaseWindowEvent & {
19249
19517
  type: 'initialized';
19250
19518
  };
19251
19519
 
@@ -19344,7 +19612,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19344
19612
  * Generated when a child window is not responding.
19345
19613
  * @interface
19346
19614
  */
19347
- declare type WindowNotRespondingEvent = NamedEvent & {
19615
+ declare type WindowNotRespondingEvent = BaseApplicationEvent & {
19348
19616
  type: 'window-not-responding';
19349
19617
  };
19350
19618
 
@@ -19370,7 +19638,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19370
19638
  * @remarks Will not fire if the diff object is empty.
19371
19639
  * @interface
19372
19640
  */
19373
- declare type WindowOptionsChangedEvent_2 = NamedEvent & {
19641
+ declare type WindowOptionsChangedEvent_2 = BaseWindowEvent & {
19374
19642
  type: 'options-changed';
19375
19643
  options: OpenFin_2.WindowOptions;
19376
19644
  diff: OpenFin_2.WindowOptionDiff;
@@ -19382,7 +19650,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19382
19650
  * Generated when a child window is responding.
19383
19651
  * @interface
19384
19652
  */
19385
- declare type WindowRespondingEvent = NamedEvent & {
19653
+ declare type WindowRespondingEvent = BaseApplicationEvent & {
19386
19654
  type: 'window-responding';
19387
19655
  };
19388
19656
 
@@ -19390,7 +19658,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19390
19658
  * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
19391
19659
  * @interface
19392
19660
  */
19393
- declare type WindowRestoredEvent = NamedEvent & {
19661
+ declare type WindowRestoredEvent = BaseWindowEvent & {
19394
19662
  type: 'restored';
19395
19663
  };
19396
19664
 
@@ -19398,7 +19666,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19398
19666
  * Generated when a hidden window has been shown.
19399
19667
  * @interface
19400
19668
  */
19401
- declare type WindowShownEvent = NamedEvent & {
19669
+ declare type WindowShownEvent = BaseWindowEvent & {
19402
19670
  type: 'shown';
19403
19671
  };
19404
19672
 
@@ -19407,15 +19675,21 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19407
19675
  * @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.
19408
19676
  * @interface
19409
19677
  */
19410
- declare type WindowShowRequestedEvent = NamedEvent & {
19678
+ declare type WindowShowRequestedEvent = BaseWindowEvent & {
19411
19679
  type: 'show-requested';
19412
19680
  };
19413
19681
 
19682
+ /**
19683
+ * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19684
+ * from {@link OpenFin.ViewEvents}.
19685
+ */
19686
+ 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;
19687
+
19414
19688
  /**
19415
19689
  * Generated when a child window starts loading.
19416
19690
  * @interface
19417
19691
  */
19418
- declare type WindowStartLoadEvent = NamedEvent & {
19692
+ declare type WindowStartLoadEvent = BaseApplicationEvent & {
19419
19693
  type: 'window-start-load';
19420
19694
  };
19421
19695
 
@@ -19424,6 +19698,14 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19424
19698
  */
19425
19699
  declare type WindowState = 'maximized' | 'minimized' | 'normal';
19426
19700
 
19701
+ /**
19702
+ * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
19703
+ * to the `Application` level, with the name pattern `window-view-eventname`.
19704
+ */
19705
+ declare type WindowViewEvent = {
19706
+ viewIdentity: OpenFin_2.Identity;
19707
+ } & (ViewAttachedEvent | ViewDetachedEvent);
19708
+
19427
19709
  /**
19428
19710
  * @interface
19429
19711
  */