@openfin/fdc3-api 38.82.59 → 38.82.61

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.
@@ -99,7 +99,7 @@ declare type ApiInjection = DomainApiSettings;
99
99
  * Generated when a new Platform's API becomes responsive.
100
100
  * @interface
101
101
  */
102
- declare type ApiReadyEvent = BaseEvent & {
102
+ declare type ApiReadyEvent = BaseEvents.BaseEvent & {
103
103
  topic: 'application';
104
104
  type: 'platform-api-ready';
105
105
  };
@@ -911,7 +911,7 @@ declare namespace ApplicationEvents {
911
911
  PropagatedApplicationEvent,
912
912
  PropagatedEventType_3 as PropagatedEventType,
913
913
  PropagatedApplicationEventType,
914
- Payload_4 as Payload,
914
+ Payload_5 as Payload,
915
915
  ByType_3 as ByType
916
916
  }
917
917
  }
@@ -1707,7 +1707,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1707
1707
  * A base Channel event.
1708
1708
  * @interface
1709
1709
  */
1710
- declare type BaseEvent_2 = NamedEvent & {
1710
+ declare type BaseEvent_2 = BaseEvents.NamedEvent & {
1711
1711
  channelName: string;
1712
1712
  channelId: string;
1713
1713
  };
@@ -1777,6 +1777,7 @@ declare namespace BaseEvents {
1777
1777
  NotCloseRequested,
1778
1778
  PropagatedEventType,
1779
1779
  PropagatedEvent,
1780
+ Payload_2 as Payload,
1780
1781
  EventHandler,
1781
1782
  BaseEvent,
1782
1783
  IdentityEvent,
@@ -1917,7 +1918,7 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1917
1918
  *
1918
1919
  * @typeParam Type String key specifying the event to extract
1919
1920
  */
1920
- declare type ByType<Type extends EventType> = Payload_2<Type>;
1921
+ declare type ByType<Type extends EventType> = Payload_3<Type>;
1921
1922
 
1922
1923
  /**
1923
1924
  * Extracts a single event type matching the given key from the Window {@link Event} union.
@@ -1926,7 +1927,7 @@ declare type ByType<Type extends EventType> = Payload_2<Type>;
1926
1927
  *
1927
1928
  * @typeParam Type String key specifying the event to extract
1928
1929
  */
1929
- declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
1930
+ declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
1930
1931
 
1931
1932
  /**
1932
1933
  * Extracts a single event type matching the given key from the Application {@link Event} union.
@@ -1935,7 +1936,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
1935
1936
  *
1936
1937
  * @typeParam Type String key specifying the event to extract
1937
1938
  */
1938
- declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
1939
+ declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
1939
1940
 
1940
1941
  /**
1941
1942
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
@@ -1944,7 +1945,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
1944
1945
  *
1945
1946
  * @typeParam Type String key specifying the event to extract
1946
1947
  */
1947
- declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
1948
+ declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
1948
1949
 
1949
1950
  /**
1950
1951
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
@@ -1953,7 +1954,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
1953
1954
  *
1954
1955
  * @typeParam Type String key specifying the event to extract
1955
1956
  */
1956
- declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
1957
+ declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
1957
1958
 
1958
1959
  /**
1959
1960
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
@@ -1962,7 +1963,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
1962
1963
  *
1963
1964
  * @typeParam Type String key specifying the event to extract
1964
1965
  */
1965
- declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
1966
+ declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
1966
1967
 
1967
1968
  /**
1968
1969
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
@@ -1971,7 +1972,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
1971
1972
  *
1972
1973
  * @typeParam Type String key specifying the event to extract
1973
1974
  */
1974
- declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
1975
+ declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
1975
1976
 
1976
1977
  /**
1977
1978
  * Extracts a single event type matching the given key from the System {@link Event} union.
@@ -1980,7 +1981,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
1980
1981
  *
1981
1982
  * @typeParam Type String key specifying the event to extract
1982
1983
  */
1983
- declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
1984
+ declare type ByType_8<Type extends EventType_8> = Payload_10<Type>;
1984
1985
 
1985
1986
  /**
1986
1987
  * Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
@@ -1989,7 +1990,7 @@ declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
1989
1990
  *
1990
1991
  * @typeParam Type String key specifying the event to extract
1991
1992
  */
1992
- declare type ByType_9<Type extends EventType_9> = Payload_10<Type>;
1993
+ declare type ByType_9<Type extends EventType_9> = Payload_11<Type>;
1993
1994
 
1994
1995
  /**
1995
1996
  * Configuration for page capture.
@@ -4805,9 +4806,7 @@ declare class EventAggregator extends EmitterMap {
4805
4806
  * @remarks Selects the correct type for the event
4806
4807
  * payload from the provided union based on the provided string literal type.
4807
4808
  */
4808
- declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
4809
- type: EventType;
4810
- }>, ...args: any[]) => void;
4809
+ declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
4811
4810
 
4812
4811
  declare namespace Events {
4813
4812
  export {
@@ -4943,7 +4942,7 @@ declare namespace ExternalApplicationEvents {
4943
4942
  ExternalApplicationEvent,
4944
4943
  EventType_4 as EventType,
4945
4944
  ExternalApplicationEventType,
4946
- Payload_5 as Payload,
4945
+ Payload_6 as Payload,
4947
4946
  ByType_4 as ByType
4948
4947
  }
4949
4948
  }
@@ -5733,7 +5732,7 @@ declare namespace FrameEvents {
5733
5732
  FrameEvent,
5734
5733
  EventType_5 as EventType,
5735
5734
  FrameEventType,
5736
- Payload_6 as Payload,
5735
+ Payload_7 as Payload,
5737
5736
  ByType_5 as ByType
5738
5737
  }
5739
5738
  }
@@ -5973,7 +5972,7 @@ declare namespace GlobalHotkeyEvents {
5973
5972
  GlobalHotkeyEvent,
5974
5973
  EventType_6 as EventType,
5975
5974
  GlobalHotkeyEventType,
5976
- Payload_7 as Payload,
5975
+ Payload_8 as Payload,
5977
5976
  ByType_6 as ByType
5978
5977
  }
5979
5978
  }
@@ -8053,7 +8052,7 @@ declare namespace LayoutDOMEvents {
8053
8052
  LayoutStateChangedEvent,
8054
8053
  Event_12 as Event,
8055
8054
  EventType_9 as EventType,
8056
- Payload_10 as Payload,
8055
+ Payload_11 as Payload,
8057
8056
  ByType_9 as ByType
8058
8057
  }
8059
8058
  }
@@ -9712,86 +9711,110 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
9712
9711
  error?: Success extends false ? ErrorPlainObject | undefined : never;
9713
9712
  };
9714
9713
 
9714
+ /**
9715
+ * Extracts a single event type matching the given key from the System {@link Event} union.
9716
+ *
9717
+ * @see {@link ByType}
9718
+ *
9719
+ * @typeParam Type String key specifying the event to extract
9720
+ */
9721
+ declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
9722
+
9715
9723
  /**
9716
9724
  * Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
9717
9725
  *
9718
9726
  * @typeParam Type String key specifying the event to extract
9719
9727
  */
9720
- declare type Payload_10<Type extends EventType_9> = Extract<Event_12, {
9728
+ declare type Payload_11<Type extends EventType_9> = Extract<Event_12, {
9721
9729
  type: Type;
9722
9730
  }>;
9723
9731
 
9732
+ /**
9733
+ * Extracts a single event type matching the given type key from the provided EmitterEvent union.
9734
+ *
9735
+ * @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
9736
+ * the appropriate payload union for that namespace.
9737
+ *
9738
+ * @typeParam Event Union of payloads for events on the given emitter
9739
+ * @see {@link ByType}
9740
+ *
9741
+ * @typeParam Type String key specifying the event to extract from the union
9742
+ *
9743
+ * @see {@link OpenFin.Events.ApplicationEvents.Payload}
9744
+ * @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
9745
+ * @see {@link OpenFin.Events.FrameEvents.Payload}
9746
+ * @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
9747
+ * @see {@link OpenFin.Events.PlatformEvents.Payload}
9748
+ * @see {@link OpenFin.Events.SystemEvents.Payload}
9749
+ * @see {@link OpenFin.Events.ViewEvents.Payload}
9750
+ * @see {@link OpenFin.Events.WindowEvents.Payload}
9751
+ */
9752
+ declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
9753
+ type: EventType;
9754
+ }>;
9755
+
9724
9756
  /**
9725
9757
  * Extracts a single event type matching the given key from the View {@link Event} union.
9726
9758
  *
9759
+ * @see {@link ByType}
9760
+ *
9727
9761
  * @typeParam Type String key specifying the event to extract
9728
9762
  */
9729
- declare type Payload_2<Type extends EventType> = Extract<Event_4, {
9730
- type: Type;
9731
- }>;
9763
+ declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
9732
9764
 
9733
9765
  /**
9734
9766
  * Extracts a single event type matching the given key from the Window {@link Event} union.
9735
9767
  *
9768
+ * @see {@link ByType}
9769
+ *
9736
9770
  * @typeParam Type String key specifying the event to extract
9737
9771
  */
9738
- declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
9739
- type: Type;
9740
- }>;
9772
+ declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
9741
9773
 
9742
9774
  /**
9743
9775
  * Extracts a single event type matching the given key from the Application {@link Event} union.
9744
9776
  *
9777
+ * @see {@link ByType}
9778
+ *
9745
9779
  * @typeParam Type String key specifying the event to extract
9746
9780
  */
9747
- declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
9748
- type: Type;
9749
- }>;
9781
+ declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
9750
9782
 
9751
9783
  /**
9752
9784
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
9753
9785
  *
9786
+ * @see {@link ByType}
9787
+ *
9754
9788
  * @typeParam Type String key specifying the event to extract
9755
9789
  */
9756
- declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
9757
- type: Type;
9758
- }>;
9790
+ declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
9759
9791
 
9760
9792
  /**
9761
9793
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
9762
9794
  *
9795
+ * @see {@link ByType}
9796
+ *
9763
9797
  * @typeParam Type String key specifying the event to extract
9764
9798
  */
9765
- declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
9766
- type: Type;
9767
- }>;
9799
+ declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
9768
9800
 
9769
9801
  /**
9770
9802
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
9771
9803
  *
9804
+ * @see {@link ByType}
9805
+ *
9772
9806
  * @typeParam Type String key specifying the event to extract
9773
9807
  */
9774
- declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
9775
- type: Type;
9776
- }>;
9808
+ declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
9777
9809
 
9778
9810
  /**
9779
9811
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
9780
9812
  *
9781
- * @typeParam Type String key specifying the event to extract
9782
- */
9783
- declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
9784
- type: Type;
9785
- }>;
9786
-
9787
- /**
9788
- * Extracts a single event type matching the given key from the System {@link Event} union.
9813
+ * @see {@link ByType}
9789
9814
  *
9790
9815
  * @typeParam Type String key specifying the event to extract
9791
9816
  */
9792
- declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
9793
- type: Type;
9794
- }>;
9817
+ declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
9795
9818
 
9796
9819
  /**
9797
9820
  * @interface
@@ -10486,7 +10509,7 @@ declare namespace PlatformEvents {
10486
10509
  PlatformEvent,
10487
10510
  EventType_7 as EventType,
10488
10511
  PlatformEventType,
10489
- Payload_8 as Payload,
10512
+ Payload_9 as Payload,
10490
10513
  ByType_7 as ByType
10491
10514
  }
10492
10515
  }
@@ -12777,7 +12800,7 @@ declare type Snapshot = {
12777
12800
  * _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
12778
12801
  * @interface
12779
12802
  */
12780
- declare type SnapshotAppliedEvent = BaseEvent & {
12803
+ declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
12781
12804
  topic: 'application';
12782
12805
  type: 'platform-snapshot-applied';
12783
12806
  };
@@ -14382,7 +14405,7 @@ declare namespace SystemEvents {
14382
14405
  SystemEvent,
14383
14406
  EventType_8 as EventType,
14384
14407
  SystemEventType,
14385
- Payload_9 as Payload,
14408
+ Payload_10 as Payload,
14386
14409
  ByType_8 as ByType
14387
14410
  }
14388
14411
  }
@@ -15509,7 +15532,7 @@ declare namespace ViewEvents {
15509
15532
  PropagatedViewEvent,
15510
15533
  PropagatedEventType_2 as PropagatedEventType,
15511
15534
  PropagatedViewEventType,
15512
- Payload_2 as Payload,
15535
+ Payload_3 as Payload,
15513
15536
  ByType
15514
15537
  }
15515
15538
  }
@@ -18030,7 +18053,7 @@ declare namespace WindowEvents {
18030
18053
  PropagatedEvent_3 as PropagatedEvent,
18031
18054
  PropagatedWindowEvent,
18032
18055
  PropagatedWindowEventType,
18033
- Payload_3 as Payload,
18056
+ Payload_4 as Payload,
18034
18057
  ByType_2 as ByType
18035
18058
  }
18036
18059
  }
@@ -99,7 +99,7 @@ declare type ApiInjection = DomainApiSettings;
99
99
  * Generated when a new Platform's API becomes responsive.
100
100
  * @interface
101
101
  */
102
- declare type ApiReadyEvent = BaseEvent & {
102
+ declare type ApiReadyEvent = BaseEvents.BaseEvent & {
103
103
  topic: 'application';
104
104
  type: 'platform-api-ready';
105
105
  };
@@ -911,7 +911,7 @@ declare namespace ApplicationEvents {
911
911
  PropagatedApplicationEvent,
912
912
  PropagatedEventType_3 as PropagatedEventType,
913
913
  PropagatedApplicationEventType,
914
- Payload_4 as Payload,
914
+ Payload_5 as Payload,
915
915
  ByType_3 as ByType
916
916
  }
917
917
  }
@@ -1707,7 +1707,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1707
1707
  * A base Channel event.
1708
1708
  * @interface
1709
1709
  */
1710
- declare type BaseEvent_2 = NamedEvent & {
1710
+ declare type BaseEvent_2 = BaseEvents.NamedEvent & {
1711
1711
  channelName: string;
1712
1712
  channelId: string;
1713
1713
  };
@@ -1777,6 +1777,7 @@ declare namespace BaseEvents {
1777
1777
  NotCloseRequested,
1778
1778
  PropagatedEventType,
1779
1779
  PropagatedEvent,
1780
+ Payload_2 as Payload,
1780
1781
  EventHandler,
1781
1782
  BaseEvent,
1782
1783
  IdentityEvent,
@@ -1917,7 +1918,7 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1917
1918
  *
1918
1919
  * @typeParam Type String key specifying the event to extract
1919
1920
  */
1920
- declare type ByType<Type extends EventType> = Payload_2<Type>;
1921
+ declare type ByType<Type extends EventType> = Payload_3<Type>;
1921
1922
 
1922
1923
  /**
1923
1924
  * Extracts a single event type matching the given key from the Window {@link Event} union.
@@ -1926,7 +1927,7 @@ declare type ByType<Type extends EventType> = Payload_2<Type>;
1926
1927
  *
1927
1928
  * @typeParam Type String key specifying the event to extract
1928
1929
  */
1929
- declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
1930
+ declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
1930
1931
 
1931
1932
  /**
1932
1933
  * Extracts a single event type matching the given key from the Application {@link Event} union.
@@ -1935,7 +1936,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
1935
1936
  *
1936
1937
  * @typeParam Type String key specifying the event to extract
1937
1938
  */
1938
- declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
1939
+ declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
1939
1940
 
1940
1941
  /**
1941
1942
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
@@ -1944,7 +1945,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
1944
1945
  *
1945
1946
  * @typeParam Type String key specifying the event to extract
1946
1947
  */
1947
- declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
1948
+ declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
1948
1949
 
1949
1950
  /**
1950
1951
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
@@ -1953,7 +1954,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
1953
1954
  *
1954
1955
  * @typeParam Type String key specifying the event to extract
1955
1956
  */
1956
- declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
1957
+ declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
1957
1958
 
1958
1959
  /**
1959
1960
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
@@ -1962,7 +1963,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
1962
1963
  *
1963
1964
  * @typeParam Type String key specifying the event to extract
1964
1965
  */
1965
- declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
1966
+ declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
1966
1967
 
1967
1968
  /**
1968
1969
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
@@ -1971,7 +1972,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
1971
1972
  *
1972
1973
  * @typeParam Type String key specifying the event to extract
1973
1974
  */
1974
- declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
1975
+ declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
1975
1976
 
1976
1977
  /**
1977
1978
  * Extracts a single event type matching the given key from the System {@link Event} union.
@@ -1980,7 +1981,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
1980
1981
  *
1981
1982
  * @typeParam Type String key specifying the event to extract
1982
1983
  */
1983
- declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
1984
+ declare type ByType_8<Type extends EventType_8> = Payload_10<Type>;
1984
1985
 
1985
1986
  /**
1986
1987
  * Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
@@ -1989,7 +1990,7 @@ declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
1989
1990
  *
1990
1991
  * @typeParam Type String key specifying the event to extract
1991
1992
  */
1992
- declare type ByType_9<Type extends EventType_9> = Payload_10<Type>;
1993
+ declare type ByType_9<Type extends EventType_9> = Payload_11<Type>;
1993
1994
 
1994
1995
  /**
1995
1996
  * Configuration for page capture.
@@ -4805,9 +4806,7 @@ declare class EventAggregator extends EmitterMap {
4805
4806
  * @remarks Selects the correct type for the event
4806
4807
  * payload from the provided union based on the provided string literal type.
4807
4808
  */
4808
- declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
4809
- type: EventType;
4810
- }>, ...args: any[]) => void;
4809
+ declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
4811
4810
 
4812
4811
  declare namespace Events {
4813
4812
  export {
@@ -4943,7 +4942,7 @@ declare namespace ExternalApplicationEvents {
4943
4942
  ExternalApplicationEvent,
4944
4943
  EventType_4 as EventType,
4945
4944
  ExternalApplicationEventType,
4946
- Payload_5 as Payload,
4945
+ Payload_6 as Payload,
4947
4946
  ByType_4 as ByType
4948
4947
  }
4949
4948
  }
@@ -5733,7 +5732,7 @@ declare namespace FrameEvents {
5733
5732
  FrameEvent,
5734
5733
  EventType_5 as EventType,
5735
5734
  FrameEventType,
5736
- Payload_6 as Payload,
5735
+ Payload_7 as Payload,
5737
5736
  ByType_5 as ByType
5738
5737
  }
5739
5738
  }
@@ -5973,7 +5972,7 @@ declare namespace GlobalHotkeyEvents {
5973
5972
  GlobalHotkeyEvent,
5974
5973
  EventType_6 as EventType,
5975
5974
  GlobalHotkeyEventType,
5976
- Payload_7 as Payload,
5975
+ Payload_8 as Payload,
5977
5976
  ByType_6 as ByType
5978
5977
  }
5979
5978
  }
@@ -8053,7 +8052,7 @@ declare namespace LayoutDOMEvents {
8053
8052
  LayoutStateChangedEvent,
8054
8053
  Event_12 as Event,
8055
8054
  EventType_9 as EventType,
8056
- Payload_10 as Payload,
8055
+ Payload_11 as Payload,
8057
8056
  ByType_9 as ByType
8058
8057
  }
8059
8058
  }
@@ -9712,86 +9711,110 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
9712
9711
  error?: Success extends false ? ErrorPlainObject | undefined : never;
9713
9712
  };
9714
9713
 
9714
+ /**
9715
+ * Extracts a single event type matching the given key from the System {@link Event} union.
9716
+ *
9717
+ * @see {@link ByType}
9718
+ *
9719
+ * @typeParam Type String key specifying the event to extract
9720
+ */
9721
+ declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
9722
+
9715
9723
  /**
9716
9724
  * Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
9717
9725
  *
9718
9726
  * @typeParam Type String key specifying the event to extract
9719
9727
  */
9720
- declare type Payload_10<Type extends EventType_9> = Extract<Event_12, {
9728
+ declare type Payload_11<Type extends EventType_9> = Extract<Event_12, {
9721
9729
  type: Type;
9722
9730
  }>;
9723
9731
 
9732
+ /**
9733
+ * Extracts a single event type matching the given type key from the provided EmitterEvent union.
9734
+ *
9735
+ * @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
9736
+ * the appropriate payload union for that namespace.
9737
+ *
9738
+ * @typeParam Event Union of payloads for events on the given emitter
9739
+ * @see {@link ByType}
9740
+ *
9741
+ * @typeParam Type String key specifying the event to extract from the union
9742
+ *
9743
+ * @see {@link OpenFin.Events.ApplicationEvents.Payload}
9744
+ * @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
9745
+ * @see {@link OpenFin.Events.FrameEvents.Payload}
9746
+ * @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
9747
+ * @see {@link OpenFin.Events.PlatformEvents.Payload}
9748
+ * @see {@link OpenFin.Events.SystemEvents.Payload}
9749
+ * @see {@link OpenFin.Events.ViewEvents.Payload}
9750
+ * @see {@link OpenFin.Events.WindowEvents.Payload}
9751
+ */
9752
+ declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
9753
+ type: EventType;
9754
+ }>;
9755
+
9724
9756
  /**
9725
9757
  * Extracts a single event type matching the given key from the View {@link Event} union.
9726
9758
  *
9759
+ * @see {@link ByType}
9760
+ *
9727
9761
  * @typeParam Type String key specifying the event to extract
9728
9762
  */
9729
- declare type Payload_2<Type extends EventType> = Extract<Event_4, {
9730
- type: Type;
9731
- }>;
9763
+ declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
9732
9764
 
9733
9765
  /**
9734
9766
  * Extracts a single event type matching the given key from the Window {@link Event} union.
9735
9767
  *
9768
+ * @see {@link ByType}
9769
+ *
9736
9770
  * @typeParam Type String key specifying the event to extract
9737
9771
  */
9738
- declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
9739
- type: Type;
9740
- }>;
9772
+ declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
9741
9773
 
9742
9774
  /**
9743
9775
  * Extracts a single event type matching the given key from the Application {@link Event} union.
9744
9776
  *
9777
+ * @see {@link ByType}
9778
+ *
9745
9779
  * @typeParam Type String key specifying the event to extract
9746
9780
  */
9747
- declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
9748
- type: Type;
9749
- }>;
9781
+ declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
9750
9782
 
9751
9783
  /**
9752
9784
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
9753
9785
  *
9786
+ * @see {@link ByType}
9787
+ *
9754
9788
  * @typeParam Type String key specifying the event to extract
9755
9789
  */
9756
- declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
9757
- type: Type;
9758
- }>;
9790
+ declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
9759
9791
 
9760
9792
  /**
9761
9793
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
9762
9794
  *
9795
+ * @see {@link ByType}
9796
+ *
9763
9797
  * @typeParam Type String key specifying the event to extract
9764
9798
  */
9765
- declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
9766
- type: Type;
9767
- }>;
9799
+ declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
9768
9800
 
9769
9801
  /**
9770
9802
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
9771
9803
  *
9804
+ * @see {@link ByType}
9805
+ *
9772
9806
  * @typeParam Type String key specifying the event to extract
9773
9807
  */
9774
- declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
9775
- type: Type;
9776
- }>;
9808
+ declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
9777
9809
 
9778
9810
  /**
9779
9811
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
9780
9812
  *
9781
- * @typeParam Type String key specifying the event to extract
9782
- */
9783
- declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
9784
- type: Type;
9785
- }>;
9786
-
9787
- /**
9788
- * Extracts a single event type matching the given key from the System {@link Event} union.
9813
+ * @see {@link ByType}
9789
9814
  *
9790
9815
  * @typeParam Type String key specifying the event to extract
9791
9816
  */
9792
- declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
9793
- type: Type;
9794
- }>;
9817
+ declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
9795
9818
 
9796
9819
  /**
9797
9820
  * @interface
@@ -10486,7 +10509,7 @@ declare namespace PlatformEvents {
10486
10509
  PlatformEvent,
10487
10510
  EventType_7 as EventType,
10488
10511
  PlatformEventType,
10489
- Payload_8 as Payload,
10512
+ Payload_9 as Payload,
10490
10513
  ByType_7 as ByType
10491
10514
  }
10492
10515
  }
@@ -12777,7 +12800,7 @@ declare type Snapshot = {
12777
12800
  * _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
12778
12801
  * @interface
12779
12802
  */
12780
- declare type SnapshotAppliedEvent = BaseEvent & {
12803
+ declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
12781
12804
  topic: 'application';
12782
12805
  type: 'platform-snapshot-applied';
12783
12806
  };
@@ -14382,7 +14405,7 @@ declare namespace SystemEvents {
14382
14405
  SystemEvent,
14383
14406
  EventType_8 as EventType,
14384
14407
  SystemEventType,
14385
- Payload_9 as Payload,
14408
+ Payload_10 as Payload,
14386
14409
  ByType_8 as ByType
14387
14410
  }
14388
14411
  }
@@ -15509,7 +15532,7 @@ declare namespace ViewEvents {
15509
15532
  PropagatedViewEvent,
15510
15533
  PropagatedEventType_2 as PropagatedEventType,
15511
15534
  PropagatedViewEventType,
15512
- Payload_2 as Payload,
15535
+ Payload_3 as Payload,
15513
15536
  ByType
15514
15537
  }
15515
15538
  }
@@ -18030,7 +18053,7 @@ declare namespace WindowEvents {
18030
18053
  PropagatedEvent_3 as PropagatedEvent,
18031
18054
  PropagatedWindowEvent,
18032
18055
  PropagatedWindowEventType,
18033
- Payload_3 as Payload,
18056
+ Payload_4 as Payload,
18034
18057
  ByType_2 as ByType
18035
18058
  }
18036
18059
  }
@@ -99,7 +99,7 @@ declare type ApiInjection = DomainApiSettings;
99
99
  * Generated when a new Platform's API becomes responsive.
100
100
  * @interface
101
101
  */
102
- declare type ApiReadyEvent = BaseEvent & {
102
+ declare type ApiReadyEvent = BaseEvents.BaseEvent & {
103
103
  topic: 'application';
104
104
  type: 'platform-api-ready';
105
105
  };
@@ -911,7 +911,7 @@ declare namespace ApplicationEvents {
911
911
  PropagatedApplicationEvent,
912
912
  PropagatedEventType_3 as PropagatedEventType,
913
913
  PropagatedApplicationEventType,
914
- Payload_4 as Payload,
914
+ Payload_5 as Payload,
915
915
  ByType_3 as ByType
916
916
  }
917
917
  }
@@ -1707,7 +1707,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1707
1707
  * A base Channel event.
1708
1708
  * @interface
1709
1709
  */
1710
- declare type BaseEvent_2 = NamedEvent & {
1710
+ declare type BaseEvent_2 = BaseEvents.NamedEvent & {
1711
1711
  channelName: string;
1712
1712
  channelId: string;
1713
1713
  };
@@ -1777,6 +1777,7 @@ declare namespace BaseEvents {
1777
1777
  NotCloseRequested,
1778
1778
  PropagatedEventType,
1779
1779
  PropagatedEvent,
1780
+ Payload_2 as Payload,
1780
1781
  EventHandler,
1781
1782
  BaseEvent,
1782
1783
  IdentityEvent,
@@ -1917,7 +1918,7 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1917
1918
  *
1918
1919
  * @typeParam Type String key specifying the event to extract
1919
1920
  */
1920
- declare type ByType<Type extends EventType> = Payload_2<Type>;
1921
+ declare type ByType<Type extends EventType> = Payload_3<Type>;
1921
1922
 
1922
1923
  /**
1923
1924
  * Extracts a single event type matching the given key from the Window {@link Event} union.
@@ -1926,7 +1927,7 @@ declare type ByType<Type extends EventType> = Payload_2<Type>;
1926
1927
  *
1927
1928
  * @typeParam Type String key specifying the event to extract
1928
1929
  */
1929
- declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
1930
+ declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
1930
1931
 
1931
1932
  /**
1932
1933
  * Extracts a single event type matching the given key from the Application {@link Event} union.
@@ -1935,7 +1936,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
1935
1936
  *
1936
1937
  * @typeParam Type String key specifying the event to extract
1937
1938
  */
1938
- declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
1939
+ declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
1939
1940
 
1940
1941
  /**
1941
1942
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
@@ -1944,7 +1945,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
1944
1945
  *
1945
1946
  * @typeParam Type String key specifying the event to extract
1946
1947
  */
1947
- declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
1948
+ declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
1948
1949
 
1949
1950
  /**
1950
1951
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
@@ -1953,7 +1954,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
1953
1954
  *
1954
1955
  * @typeParam Type String key specifying the event to extract
1955
1956
  */
1956
- declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
1957
+ declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
1957
1958
 
1958
1959
  /**
1959
1960
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
@@ -1962,7 +1963,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
1962
1963
  *
1963
1964
  * @typeParam Type String key specifying the event to extract
1964
1965
  */
1965
- declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
1966
+ declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
1966
1967
 
1967
1968
  /**
1968
1969
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
@@ -1971,7 +1972,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
1971
1972
  *
1972
1973
  * @typeParam Type String key specifying the event to extract
1973
1974
  */
1974
- declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
1975
+ declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
1975
1976
 
1976
1977
  /**
1977
1978
  * Extracts a single event type matching the given key from the System {@link Event} union.
@@ -1980,7 +1981,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
1980
1981
  *
1981
1982
  * @typeParam Type String key specifying the event to extract
1982
1983
  */
1983
- declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
1984
+ declare type ByType_8<Type extends EventType_8> = Payload_10<Type>;
1984
1985
 
1985
1986
  /**
1986
1987
  * Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
@@ -1989,7 +1990,7 @@ declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
1989
1990
  *
1990
1991
  * @typeParam Type String key specifying the event to extract
1991
1992
  */
1992
- declare type ByType_9<Type extends EventType_9> = Payload_10<Type>;
1993
+ declare type ByType_9<Type extends EventType_9> = Payload_11<Type>;
1993
1994
 
1994
1995
  /**
1995
1996
  * Configuration for page capture.
@@ -4805,9 +4806,7 @@ declare class EventAggregator extends EmitterMap {
4805
4806
  * @remarks Selects the correct type for the event
4806
4807
  * payload from the provided union based on the provided string literal type.
4807
4808
  */
4808
- declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
4809
- type: EventType;
4810
- }>, ...args: any[]) => void;
4809
+ declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
4811
4810
 
4812
4811
  declare namespace Events {
4813
4812
  export {
@@ -4943,7 +4942,7 @@ declare namespace ExternalApplicationEvents {
4943
4942
  ExternalApplicationEvent,
4944
4943
  EventType_4 as EventType,
4945
4944
  ExternalApplicationEventType,
4946
- Payload_5 as Payload,
4945
+ Payload_6 as Payload,
4947
4946
  ByType_4 as ByType
4948
4947
  }
4949
4948
  }
@@ -5733,7 +5732,7 @@ declare namespace FrameEvents {
5733
5732
  FrameEvent,
5734
5733
  EventType_5 as EventType,
5735
5734
  FrameEventType,
5736
- Payload_6 as Payload,
5735
+ Payload_7 as Payload,
5737
5736
  ByType_5 as ByType
5738
5737
  }
5739
5738
  }
@@ -5973,7 +5972,7 @@ declare namespace GlobalHotkeyEvents {
5973
5972
  GlobalHotkeyEvent,
5974
5973
  EventType_6 as EventType,
5975
5974
  GlobalHotkeyEventType,
5976
- Payload_7 as Payload,
5975
+ Payload_8 as Payload,
5977
5976
  ByType_6 as ByType
5978
5977
  }
5979
5978
  }
@@ -8053,7 +8052,7 @@ declare namespace LayoutDOMEvents {
8053
8052
  LayoutStateChangedEvent,
8054
8053
  Event_12 as Event,
8055
8054
  EventType_9 as EventType,
8056
- Payload_10 as Payload,
8055
+ Payload_11 as Payload,
8057
8056
  ByType_9 as ByType
8058
8057
  }
8059
8058
  }
@@ -9712,86 +9711,110 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
9712
9711
  error?: Success extends false ? ErrorPlainObject | undefined : never;
9713
9712
  };
9714
9713
 
9714
+ /**
9715
+ * Extracts a single event type matching the given key from the System {@link Event} union.
9716
+ *
9717
+ * @see {@link ByType}
9718
+ *
9719
+ * @typeParam Type String key specifying the event to extract
9720
+ */
9721
+ declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
9722
+
9715
9723
  /**
9716
9724
  * Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
9717
9725
  *
9718
9726
  * @typeParam Type String key specifying the event to extract
9719
9727
  */
9720
- declare type Payload_10<Type extends EventType_9> = Extract<Event_12, {
9728
+ declare type Payload_11<Type extends EventType_9> = Extract<Event_12, {
9721
9729
  type: Type;
9722
9730
  }>;
9723
9731
 
9732
+ /**
9733
+ * Extracts a single event type matching the given type key from the provided EmitterEvent union.
9734
+ *
9735
+ * @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
9736
+ * the appropriate payload union for that namespace.
9737
+ *
9738
+ * @typeParam Event Union of payloads for events on the given emitter
9739
+ * @see {@link ByType}
9740
+ *
9741
+ * @typeParam Type String key specifying the event to extract from the union
9742
+ *
9743
+ * @see {@link OpenFin.Events.ApplicationEvents.Payload}
9744
+ * @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
9745
+ * @see {@link OpenFin.Events.FrameEvents.Payload}
9746
+ * @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
9747
+ * @see {@link OpenFin.Events.PlatformEvents.Payload}
9748
+ * @see {@link OpenFin.Events.SystemEvents.Payload}
9749
+ * @see {@link OpenFin.Events.ViewEvents.Payload}
9750
+ * @see {@link OpenFin.Events.WindowEvents.Payload}
9751
+ */
9752
+ declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
9753
+ type: EventType;
9754
+ }>;
9755
+
9724
9756
  /**
9725
9757
  * Extracts a single event type matching the given key from the View {@link Event} union.
9726
9758
  *
9759
+ * @see {@link ByType}
9760
+ *
9727
9761
  * @typeParam Type String key specifying the event to extract
9728
9762
  */
9729
- declare type Payload_2<Type extends EventType> = Extract<Event_4, {
9730
- type: Type;
9731
- }>;
9763
+ declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
9732
9764
 
9733
9765
  /**
9734
9766
  * Extracts a single event type matching the given key from the Window {@link Event} union.
9735
9767
  *
9768
+ * @see {@link ByType}
9769
+ *
9736
9770
  * @typeParam Type String key specifying the event to extract
9737
9771
  */
9738
- declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
9739
- type: Type;
9740
- }>;
9772
+ declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
9741
9773
 
9742
9774
  /**
9743
9775
  * Extracts a single event type matching the given key from the Application {@link Event} union.
9744
9776
  *
9777
+ * @see {@link ByType}
9778
+ *
9745
9779
  * @typeParam Type String key specifying the event to extract
9746
9780
  */
9747
- declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
9748
- type: Type;
9749
- }>;
9781
+ declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
9750
9782
 
9751
9783
  /**
9752
9784
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
9753
9785
  *
9786
+ * @see {@link ByType}
9787
+ *
9754
9788
  * @typeParam Type String key specifying the event to extract
9755
9789
  */
9756
- declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
9757
- type: Type;
9758
- }>;
9790
+ declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
9759
9791
 
9760
9792
  /**
9761
9793
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
9762
9794
  *
9795
+ * @see {@link ByType}
9796
+ *
9763
9797
  * @typeParam Type String key specifying the event to extract
9764
9798
  */
9765
- declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
9766
- type: Type;
9767
- }>;
9799
+ declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
9768
9800
 
9769
9801
  /**
9770
9802
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
9771
9803
  *
9804
+ * @see {@link ByType}
9805
+ *
9772
9806
  * @typeParam Type String key specifying the event to extract
9773
9807
  */
9774
- declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
9775
- type: Type;
9776
- }>;
9808
+ declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
9777
9809
 
9778
9810
  /**
9779
9811
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
9780
9812
  *
9781
- * @typeParam Type String key specifying the event to extract
9782
- */
9783
- declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
9784
- type: Type;
9785
- }>;
9786
-
9787
- /**
9788
- * Extracts a single event type matching the given key from the System {@link Event} union.
9813
+ * @see {@link ByType}
9789
9814
  *
9790
9815
  * @typeParam Type String key specifying the event to extract
9791
9816
  */
9792
- declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
9793
- type: Type;
9794
- }>;
9817
+ declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
9795
9818
 
9796
9819
  /**
9797
9820
  * @interface
@@ -10486,7 +10509,7 @@ declare namespace PlatformEvents {
10486
10509
  PlatformEvent,
10487
10510
  EventType_7 as EventType,
10488
10511
  PlatformEventType,
10489
- Payload_8 as Payload,
10512
+ Payload_9 as Payload,
10490
10513
  ByType_7 as ByType
10491
10514
  }
10492
10515
  }
@@ -12777,7 +12800,7 @@ declare type Snapshot = {
12777
12800
  * _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
12778
12801
  * @interface
12779
12802
  */
12780
- declare type SnapshotAppliedEvent = BaseEvent & {
12803
+ declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
12781
12804
  topic: 'application';
12782
12805
  type: 'platform-snapshot-applied';
12783
12806
  };
@@ -14382,7 +14405,7 @@ declare namespace SystemEvents {
14382
14405
  SystemEvent,
14383
14406
  EventType_8 as EventType,
14384
14407
  SystemEventType,
14385
- Payload_9 as Payload,
14408
+ Payload_10 as Payload,
14386
14409
  ByType_8 as ByType
14387
14410
  }
14388
14411
  }
@@ -15509,7 +15532,7 @@ declare namespace ViewEvents {
15509
15532
  PropagatedViewEvent,
15510
15533
  PropagatedEventType_2 as PropagatedEventType,
15511
15534
  PropagatedViewEventType,
15512
- Payload_2 as Payload,
15535
+ Payload_3 as Payload,
15513
15536
  ByType
15514
15537
  }
15515
15538
  }
@@ -18030,7 +18053,7 @@ declare namespace WindowEvents {
18030
18053
  PropagatedEvent_3 as PropagatedEvent,
18031
18054
  PropagatedWindowEvent,
18032
18055
  PropagatedWindowEventType,
18033
- Payload_3 as Payload,
18056
+ Payload_4 as Payload,
18034
18057
  ByType_2 as ByType
18035
18058
  }
18036
18059
  }
package/out/fdc3-api.d.ts CHANGED
@@ -99,7 +99,7 @@ declare type ApiInjection = DomainApiSettings;
99
99
  * Generated when a new Platform's API becomes responsive.
100
100
  * @interface
101
101
  */
102
- declare type ApiReadyEvent = BaseEvent & {
102
+ declare type ApiReadyEvent = BaseEvents.BaseEvent & {
103
103
  topic: 'application';
104
104
  type: 'platform-api-ready';
105
105
  };
@@ -917,7 +917,7 @@ declare namespace ApplicationEvents {
917
917
  PropagatedApplicationEvent,
918
918
  PropagatedEventType_3 as PropagatedEventType,
919
919
  PropagatedApplicationEventType,
920
- Payload_4 as Payload,
920
+ Payload_5 as Payload,
921
921
  ByType_3 as ByType
922
922
  }
923
923
  }
@@ -1739,7 +1739,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1739
1739
  * A base Channel event.
1740
1740
  * @interface
1741
1741
  */
1742
- declare type BaseEvent_2 = NamedEvent & {
1742
+ declare type BaseEvent_2 = BaseEvents.NamedEvent & {
1743
1743
  channelName: string;
1744
1744
  channelId: string;
1745
1745
  };
@@ -1809,6 +1809,7 @@ declare namespace BaseEvents {
1809
1809
  NotCloseRequested,
1810
1810
  PropagatedEventType,
1811
1811
  PropagatedEvent,
1812
+ Payload_2 as Payload,
1812
1813
  EventHandler,
1813
1814
  BaseEvent,
1814
1815
  IdentityEvent,
@@ -1949,7 +1950,7 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1949
1950
  *
1950
1951
  * @typeParam Type String key specifying the event to extract
1951
1952
  */
1952
- declare type ByType<Type extends EventType> = Payload_2<Type>;
1953
+ declare type ByType<Type extends EventType> = Payload_3<Type>;
1953
1954
 
1954
1955
  /**
1955
1956
  * Extracts a single event type matching the given key from the Window {@link Event} union.
@@ -1958,7 +1959,7 @@ declare type ByType<Type extends EventType> = Payload_2<Type>;
1958
1959
  *
1959
1960
  * @typeParam Type String key specifying the event to extract
1960
1961
  */
1961
- declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
1962
+ declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
1962
1963
 
1963
1964
  /**
1964
1965
  * Extracts a single event type matching the given key from the Application {@link Event} union.
@@ -1967,7 +1968,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
1967
1968
  *
1968
1969
  * @typeParam Type String key specifying the event to extract
1969
1970
  */
1970
- declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
1971
+ declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
1971
1972
 
1972
1973
  /**
1973
1974
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
@@ -1976,7 +1977,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
1976
1977
  *
1977
1978
  * @typeParam Type String key specifying the event to extract
1978
1979
  */
1979
- declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
1980
+ declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
1980
1981
 
1981
1982
  /**
1982
1983
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
@@ -1985,7 +1986,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
1985
1986
  *
1986
1987
  * @typeParam Type String key specifying the event to extract
1987
1988
  */
1988
- declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
1989
+ declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
1989
1990
 
1990
1991
  /**
1991
1992
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
@@ -1994,7 +1995,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
1994
1995
  *
1995
1996
  * @typeParam Type String key specifying the event to extract
1996
1997
  */
1997
- declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
1998
+ declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
1998
1999
 
1999
2000
  /**
2000
2001
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
@@ -2003,7 +2004,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
2003
2004
  *
2004
2005
  * @typeParam Type String key specifying the event to extract
2005
2006
  */
2006
- declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
2007
+ declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
2007
2008
 
2008
2009
  /**
2009
2010
  * Extracts a single event type matching the given key from the System {@link Event} union.
@@ -2012,7 +2013,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
2012
2013
  *
2013
2014
  * @typeParam Type String key specifying the event to extract
2014
2015
  */
2015
- declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
2016
+ declare type ByType_8<Type extends EventType_8> = Payload_10<Type>;
2016
2017
 
2017
2018
  /**
2018
2019
  * Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
@@ -2021,7 +2022,7 @@ declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
2021
2022
  *
2022
2023
  * @typeParam Type String key specifying the event to extract
2023
2024
  */
2024
- declare type ByType_9<Type extends EventType_9> = Payload_10<Type>;
2025
+ declare type ByType_9<Type extends EventType_9> = Payload_11<Type>;
2025
2026
 
2026
2027
  /**
2027
2028
  * Configuration for page capture.
@@ -4869,9 +4870,7 @@ declare class EventAggregator extends EmitterMap {
4869
4870
  * @remarks Selects the correct type for the event
4870
4871
  * payload from the provided union based on the provided string literal type.
4871
4872
  */
4872
- declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
4873
- type: EventType;
4874
- }>, ...args: any[]) => void;
4873
+ declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
4875
4874
 
4876
4875
  declare namespace Events {
4877
4876
  export {
@@ -5028,7 +5027,7 @@ declare namespace ExternalApplicationEvents {
5028
5027
  ExternalApplicationEvent,
5029
5028
  EventType_4 as EventType,
5030
5029
  ExternalApplicationEventType,
5031
- Payload_5 as Payload,
5030
+ Payload_6 as Payload,
5032
5031
  ByType_4 as ByType
5033
5032
  }
5034
5033
  }
@@ -5821,7 +5820,7 @@ declare namespace FrameEvents {
5821
5820
  FrameEvent,
5822
5821
  EventType_5 as EventType,
5823
5822
  FrameEventType,
5824
- Payload_6 as Payload,
5823
+ Payload_7 as Payload,
5825
5824
  ByType_5 as ByType
5826
5825
  }
5827
5826
  }
@@ -6064,7 +6063,7 @@ declare namespace GlobalHotkeyEvents {
6064
6063
  GlobalHotkeyEvent,
6065
6064
  EventType_6 as EventType,
6066
6065
  GlobalHotkeyEventType,
6067
- Payload_7 as Payload,
6066
+ Payload_8 as Payload,
6068
6067
  ByType_6 as ByType
6069
6068
  }
6070
6069
  }
@@ -8176,7 +8175,7 @@ declare namespace LayoutDOMEvents {
8176
8175
  LayoutStateChangedEvent,
8177
8176
  Event_12 as Event,
8178
8177
  EventType_9 as EventType,
8179
- Payload_10 as Payload,
8178
+ Payload_11 as Payload,
8180
8179
  ByType_9 as ByType
8181
8180
  }
8182
8181
  }
@@ -10027,86 +10026,110 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
10027
10026
  error?: Success extends false ? ErrorPlainObject | undefined : never;
10028
10027
  };
10029
10028
 
10029
+ /**
10030
+ * Extracts a single event type matching the given key from the System {@link Event} union.
10031
+ *
10032
+ * @see {@link ByType}
10033
+ *
10034
+ * @typeParam Type String key specifying the event to extract
10035
+ */
10036
+ declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
10037
+
10030
10038
  /**
10031
10039
  * Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
10032
10040
  *
10033
10041
  * @typeParam Type String key specifying the event to extract
10034
10042
  */
10035
- declare type Payload_10<Type extends EventType_9> = Extract<Event_12, {
10043
+ declare type Payload_11<Type extends EventType_9> = Extract<Event_12, {
10036
10044
  type: Type;
10037
10045
  }>;
10038
10046
 
10047
+ /**
10048
+ * Extracts a single event type matching the given type key from the provided EmitterEvent union.
10049
+ *
10050
+ * @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
10051
+ * the appropriate payload union for that namespace.
10052
+ *
10053
+ * @typeParam Event Union of payloads for events on the given emitter
10054
+ * @see {@link ByType}
10055
+ *
10056
+ * @typeParam Type String key specifying the event to extract from the union
10057
+ *
10058
+ * @see {@link OpenFin.Events.ApplicationEvents.Payload}
10059
+ * @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
10060
+ * @see {@link OpenFin.Events.FrameEvents.Payload}
10061
+ * @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
10062
+ * @see {@link OpenFin.Events.PlatformEvents.Payload}
10063
+ * @see {@link OpenFin.Events.SystemEvents.Payload}
10064
+ * @see {@link OpenFin.Events.ViewEvents.Payload}
10065
+ * @see {@link OpenFin.Events.WindowEvents.Payload}
10066
+ */
10067
+ declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
10068
+ type: EventType;
10069
+ }>;
10070
+
10039
10071
  /**
10040
10072
  * Extracts a single event type matching the given key from the View {@link Event} union.
10041
10073
  *
10074
+ * @see {@link ByType}
10075
+ *
10042
10076
  * @typeParam Type String key specifying the event to extract
10043
10077
  */
10044
- declare type Payload_2<Type extends EventType> = Extract<Event_4, {
10045
- type: Type;
10046
- }>;
10078
+ declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
10047
10079
 
10048
10080
  /**
10049
10081
  * Extracts a single event type matching the given key from the Window {@link Event} union.
10050
10082
  *
10083
+ * @see {@link ByType}
10084
+ *
10051
10085
  * @typeParam Type String key specifying the event to extract
10052
10086
  */
10053
- declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
10054
- type: Type;
10055
- }>;
10087
+ declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
10056
10088
 
10057
10089
  /**
10058
10090
  * Extracts a single event type matching the given key from the Application {@link Event} union.
10059
10091
  *
10092
+ * @see {@link ByType}
10093
+ *
10060
10094
  * @typeParam Type String key specifying the event to extract
10061
10095
  */
10062
- declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
10063
- type: Type;
10064
- }>;
10096
+ declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
10065
10097
 
10066
10098
  /**
10067
10099
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
10068
10100
  *
10101
+ * @see {@link ByType}
10102
+ *
10069
10103
  * @typeParam Type String key specifying the event to extract
10070
10104
  */
10071
- declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
10072
- type: Type;
10073
- }>;
10105
+ declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
10074
10106
 
10075
10107
  /**
10076
10108
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
10077
10109
  *
10110
+ * @see {@link ByType}
10111
+ *
10078
10112
  * @typeParam Type String key specifying the event to extract
10079
10113
  */
10080
- declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
10081
- type: Type;
10082
- }>;
10114
+ declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
10083
10115
 
10084
10116
  /**
10085
10117
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
10086
10118
  *
10119
+ * @see {@link ByType}
10120
+ *
10087
10121
  * @typeParam Type String key specifying the event to extract
10088
10122
  */
10089
- declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
10090
- type: Type;
10091
- }>;
10123
+ declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
10092
10124
 
10093
10125
  /**
10094
10126
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
10095
10127
  *
10096
- * @typeParam Type String key specifying the event to extract
10097
- */
10098
- declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
10099
- type: Type;
10100
- }>;
10101
-
10102
- /**
10103
- * Extracts a single event type matching the given key from the System {@link Event} union.
10128
+ * @see {@link ByType}
10104
10129
  *
10105
10130
  * @typeParam Type String key specifying the event to extract
10106
10131
  */
10107
- declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10108
- type: Type;
10109
- }>;
10132
+ declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
10110
10133
 
10111
10134
  /**
10112
10135
  * @interface
@@ -10831,7 +10854,7 @@ declare namespace PlatformEvents {
10831
10854
  PlatformEvent,
10832
10855
  EventType_7 as EventType,
10833
10856
  PlatformEventType,
10834
- Payload_8 as Payload,
10857
+ Payload_9 as Payload,
10835
10858
  ByType_7 as ByType
10836
10859
  }
10837
10860
  }
@@ -13170,7 +13193,7 @@ declare type Snapshot = {
13170
13193
  * _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
13171
13194
  * @interface
13172
13195
  */
13173
- declare type SnapshotAppliedEvent = BaseEvent & {
13196
+ declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
13174
13197
  topic: 'application';
13175
13198
  type: 'platform-snapshot-applied';
13176
13199
  };
@@ -14781,7 +14804,7 @@ declare namespace SystemEvents {
14781
14804
  SystemEvent,
14782
14805
  EventType_8 as EventType,
14783
14806
  SystemEventType,
14784
- Payload_9 as Payload,
14807
+ Payload_10 as Payload,
14785
14808
  ByType_8 as ByType
14786
14809
  }
14787
14810
  }
@@ -15952,7 +15975,7 @@ declare namespace ViewEvents {
15952
15975
  PropagatedViewEvent,
15953
15976
  PropagatedEventType_2 as PropagatedEventType,
15954
15977
  PropagatedViewEventType,
15955
- Payload_2 as Payload,
15978
+ Payload_3 as Payload,
15956
15979
  ByType
15957
15980
  }
15958
15981
  }
@@ -18476,7 +18499,7 @@ declare namespace WindowEvents {
18476
18499
  PropagatedEvent_3 as PropagatedEvent,
18477
18500
  PropagatedWindowEvent,
18478
18501
  PropagatedWindowEventType,
18479
- Payload_3 as Payload,
18502
+ Payload_4 as Payload,
18480
18503
  ByType_2 as ByType
18481
18504
  }
18482
18505
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "38.82.59",
3
+ "version": "38.82.61",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.MD",
6
6
  "private": false,