@openfin/core 39.82.13 → 40.82.2
Sign up to get free protection for your applications and to get access to all the features.
- package/out/mock-alpha.d.ts +77 -54
- package/out/mock-beta.d.ts +77 -54
- package/out/mock-public.d.ts +77 -54
- package/out/mock.d.ts +77 -54
- package/out/mock.js +14 -0
- package/package.json +1 -1
package/out/mock-public.d.ts
CHANGED
@@ -102,7 +102,7 @@ declare type ApiInjection = DomainApiSettings;
|
|
102
102
|
* Generated when a new Platform's API becomes responsive.
|
103
103
|
* @interface
|
104
104
|
*/
|
105
|
-
declare type ApiReadyEvent = BaseEvent & {
|
105
|
+
declare type ApiReadyEvent = BaseEvents.BaseEvent & {
|
106
106
|
topic: 'application';
|
107
107
|
type: 'platform-api-ready';
|
108
108
|
};
|
@@ -914,7 +914,7 @@ declare namespace ApplicationEvents {
|
|
914
914
|
PropagatedApplicationEvent,
|
915
915
|
PropagatedEventType_3 as PropagatedEventType,
|
916
916
|
PropagatedApplicationEventType,
|
917
|
-
|
917
|
+
Payload_5 as Payload,
|
918
918
|
ByType_3 as ByType
|
919
919
|
}
|
920
920
|
}
|
@@ -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> =
|
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> =
|
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> =
|
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> =
|
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> =
|
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> =
|
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> =
|
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> =
|
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> =
|
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:
|
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
|
-
|
4945
|
+
Payload_6 as Payload,
|
4947
4946
|
ByType_4 as ByType
|
4948
4947
|
}
|
4949
4948
|
}
|
@@ -5395,7 +5394,7 @@ declare namespace FrameEvents {
|
|
5395
5394
|
FrameEvent,
|
5396
5395
|
EventType_5 as EventType,
|
5397
5396
|
FrameEventType,
|
5398
|
-
|
5397
|
+
Payload_7 as Payload,
|
5399
5398
|
ByType_5 as ByType
|
5400
5399
|
}
|
5401
5400
|
}
|
@@ -5635,7 +5634,7 @@ declare namespace GlobalHotkeyEvents {
|
|
5635
5634
|
GlobalHotkeyEvent,
|
5636
5635
|
EventType_6 as EventType,
|
5637
5636
|
GlobalHotkeyEventType,
|
5638
|
-
|
5637
|
+
Payload_8 as Payload,
|
5639
5638
|
ByType_6 as ByType
|
5640
5639
|
}
|
5641
5640
|
}
|
@@ -7715,7 +7714,7 @@ declare namespace LayoutDOMEvents {
|
|
7715
7714
|
LayoutStateChangedEvent,
|
7716
7715
|
Event_12 as Event,
|
7717
7716
|
EventType_9 as EventType,
|
7718
|
-
|
7717
|
+
Payload_11 as Payload,
|
7719
7718
|
ByType_9 as ByType
|
7720
7719
|
}
|
7721
7720
|
}
|
@@ -9376,86 +9375,110 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
9376
9375
|
error?: Success extends false ? ErrorPlainObject | undefined : never;
|
9377
9376
|
};
|
9378
9377
|
|
9378
|
+
/**
|
9379
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
9380
|
+
*
|
9381
|
+
* @see {@link ByType}
|
9382
|
+
*
|
9383
|
+
* @typeParam Type String key specifying the event to extract
|
9384
|
+
*/
|
9385
|
+
declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
|
9386
|
+
|
9379
9387
|
/**
|
9380
9388
|
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
9381
9389
|
*
|
9382
9390
|
* @typeParam Type String key specifying the event to extract
|
9383
9391
|
*/
|
9384
|
-
declare type
|
9392
|
+
declare type Payload_11<Type extends EventType_9> = Extract<Event_12, {
|
9385
9393
|
type: Type;
|
9386
9394
|
}>;
|
9387
9395
|
|
9396
|
+
/**
|
9397
|
+
* Extracts a single event type matching the given type key from the provided EmitterEvent union.
|
9398
|
+
*
|
9399
|
+
* @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
|
9400
|
+
* the appropriate payload union for that namespace.
|
9401
|
+
*
|
9402
|
+
* @typeParam Event Union of payloads for events on the given emitter
|
9403
|
+
* @see {@link ByType}
|
9404
|
+
*
|
9405
|
+
* @typeParam Type String key specifying the event to extract from the union
|
9406
|
+
*
|
9407
|
+
* @see {@link OpenFin.Events.ApplicationEvents.Payload}
|
9408
|
+
* @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
|
9409
|
+
* @see {@link OpenFin.Events.FrameEvents.Payload}
|
9410
|
+
* @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
|
9411
|
+
* @see {@link OpenFin.Events.PlatformEvents.Payload}
|
9412
|
+
* @see {@link OpenFin.Events.SystemEvents.Payload}
|
9413
|
+
* @see {@link OpenFin.Events.ViewEvents.Payload}
|
9414
|
+
* @see {@link OpenFin.Events.WindowEvents.Payload}
|
9415
|
+
*/
|
9416
|
+
declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
|
9417
|
+
type: EventType;
|
9418
|
+
}>;
|
9419
|
+
|
9388
9420
|
/**
|
9389
9421
|
* Extracts a single event type matching the given key from the View {@link Event} union.
|
9390
9422
|
*
|
9423
|
+
* @see {@link ByType}
|
9424
|
+
*
|
9391
9425
|
* @typeParam Type String key specifying the event to extract
|
9392
9426
|
*/
|
9393
|
-
declare type
|
9394
|
-
type: Type;
|
9395
|
-
}>;
|
9427
|
+
declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
|
9396
9428
|
|
9397
9429
|
/**
|
9398
9430
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
9399
9431
|
*
|
9432
|
+
* @see {@link ByType}
|
9433
|
+
*
|
9400
9434
|
* @typeParam Type String key specifying the event to extract
|
9401
9435
|
*/
|
9402
|
-
declare type
|
9403
|
-
type: Type;
|
9404
|
-
}>;
|
9436
|
+
declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
|
9405
9437
|
|
9406
9438
|
/**
|
9407
9439
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
9408
9440
|
*
|
9441
|
+
* @see {@link ByType}
|
9442
|
+
*
|
9409
9443
|
* @typeParam Type String key specifying the event to extract
|
9410
9444
|
*/
|
9411
|
-
declare type
|
9412
|
-
type: Type;
|
9413
|
-
}>;
|
9445
|
+
declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
|
9414
9446
|
|
9415
9447
|
/**
|
9416
9448
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
9417
9449
|
*
|
9450
|
+
* @see {@link ByType}
|
9451
|
+
*
|
9418
9452
|
* @typeParam Type String key specifying the event to extract
|
9419
9453
|
*/
|
9420
|
-
declare type
|
9421
|
-
type: Type;
|
9422
|
-
}>;
|
9454
|
+
declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
|
9423
9455
|
|
9424
9456
|
/**
|
9425
9457
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
9426
9458
|
*
|
9459
|
+
* @see {@link ByType}
|
9460
|
+
*
|
9427
9461
|
* @typeParam Type String key specifying the event to extract
|
9428
9462
|
*/
|
9429
|
-
declare type
|
9430
|
-
type: Type;
|
9431
|
-
}>;
|
9463
|
+
declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
|
9432
9464
|
|
9433
9465
|
/**
|
9434
9466
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
9435
9467
|
*
|
9468
|
+
* @see {@link ByType}
|
9469
|
+
*
|
9436
9470
|
* @typeParam Type String key specifying the event to extract
|
9437
9471
|
*/
|
9438
|
-
declare type
|
9439
|
-
type: Type;
|
9440
|
-
}>;
|
9472
|
+
declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
|
9441
9473
|
|
9442
9474
|
/**
|
9443
9475
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
9444
9476
|
*
|
9445
|
-
* @
|
9446
|
-
*/
|
9447
|
-
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
9448
|
-
type: Type;
|
9449
|
-
}>;
|
9450
|
-
|
9451
|
-
/**
|
9452
|
-
* Extracts a single event type matching the given key from the System {@link Event} union.
|
9477
|
+
* @see {@link ByType}
|
9453
9478
|
*
|
9454
9479
|
* @typeParam Type String key specifying the event to extract
|
9455
9480
|
*/
|
9456
|
-
declare type Payload_9<Type extends
|
9457
|
-
type: Type;
|
9458
|
-
}>;
|
9481
|
+
declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
|
9459
9482
|
|
9460
9483
|
/**
|
9461
9484
|
* @interface
|
@@ -10150,7 +10173,7 @@ declare namespace PlatformEvents {
|
|
10150
10173
|
PlatformEvent,
|
10151
10174
|
EventType_7 as EventType,
|
10152
10175
|
PlatformEventType,
|
10153
|
-
|
10176
|
+
Payload_9 as Payload,
|
10154
10177
|
ByType_7 as ByType
|
10155
10178
|
}
|
10156
10179
|
}
|
@@ -12441,7 +12464,7 @@ declare type Snapshot = {
|
|
12441
12464
|
* _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.
|
12442
12465
|
* @interface
|
12443
12466
|
*/
|
12444
|
-
declare type SnapshotAppliedEvent = BaseEvent & {
|
12467
|
+
declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
|
12445
12468
|
topic: 'application';
|
12446
12469
|
type: 'platform-snapshot-applied';
|
12447
12470
|
};
|
@@ -14046,7 +14069,7 @@ declare namespace SystemEvents {
|
|
14046
14069
|
SystemEvent,
|
14047
14070
|
EventType_8 as EventType,
|
14048
14071
|
SystemEventType,
|
14049
|
-
|
14072
|
+
Payload_10 as Payload,
|
14050
14073
|
ByType_8 as ByType
|
14051
14074
|
}
|
14052
14075
|
}
|
@@ -15067,7 +15090,7 @@ declare namespace ViewEvents {
|
|
15067
15090
|
PropagatedViewEvent,
|
15068
15091
|
PropagatedEventType_2 as PropagatedEventType,
|
15069
15092
|
PropagatedViewEventType,
|
15070
|
-
|
15093
|
+
Payload_3 as Payload,
|
15071
15094
|
ByType
|
15072
15095
|
}
|
15073
15096
|
}
|
@@ -17588,7 +17611,7 @@ declare namespace WindowEvents {
|
|
17588
17611
|
PropagatedEvent_3 as PropagatedEvent,
|
17589
17612
|
PropagatedWindowEvent,
|
17590
17613
|
PropagatedWindowEventType,
|
17591
|
-
|
17614
|
+
Payload_4 as Payload,
|
17592
17615
|
ByType_2 as ByType
|
17593
17616
|
}
|
17594
17617
|
}
|
package/out/mock.d.ts
CHANGED
@@ -102,7 +102,7 @@ declare type ApiInjection = DomainApiSettings;
|
|
102
102
|
* Generated when a new Platform's API becomes responsive.
|
103
103
|
* @interface
|
104
104
|
*/
|
105
|
-
declare type ApiReadyEvent = BaseEvent & {
|
105
|
+
declare type ApiReadyEvent = BaseEvents.BaseEvent & {
|
106
106
|
topic: 'application';
|
107
107
|
type: 'platform-api-ready';
|
108
108
|
};
|
@@ -920,7 +920,7 @@ declare namespace ApplicationEvents {
|
|
920
920
|
PropagatedApplicationEvent,
|
921
921
|
PropagatedEventType_3 as PropagatedEventType,
|
922
922
|
PropagatedApplicationEventType,
|
923
|
-
|
923
|
+
Payload_5 as Payload,
|
924
924
|
ByType_3 as ByType
|
925
925
|
}
|
926
926
|
}
|
@@ -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> =
|
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> =
|
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> =
|
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> =
|
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> =
|
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> =
|
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> =
|
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> =
|
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> =
|
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:
|
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
|
-
|
5030
|
+
Payload_6 as Payload,
|
5032
5031
|
ByType_4 as ByType
|
5033
5032
|
}
|
5034
5033
|
}
|
@@ -5483,7 +5482,7 @@ declare namespace FrameEvents {
|
|
5483
5482
|
FrameEvent,
|
5484
5483
|
EventType_5 as EventType,
|
5485
5484
|
FrameEventType,
|
5486
|
-
|
5485
|
+
Payload_7 as Payload,
|
5487
5486
|
ByType_5 as ByType
|
5488
5487
|
}
|
5489
5488
|
}
|
@@ -5726,7 +5725,7 @@ declare namespace GlobalHotkeyEvents {
|
|
5726
5725
|
GlobalHotkeyEvent,
|
5727
5726
|
EventType_6 as EventType,
|
5728
5727
|
GlobalHotkeyEventType,
|
5729
|
-
|
5728
|
+
Payload_8 as Payload,
|
5730
5729
|
ByType_6 as ByType
|
5731
5730
|
}
|
5732
5731
|
}
|
@@ -7838,7 +7837,7 @@ declare namespace LayoutDOMEvents {
|
|
7838
7837
|
LayoutStateChangedEvent,
|
7839
7838
|
Event_12 as Event,
|
7840
7839
|
EventType_9 as EventType,
|
7841
|
-
|
7840
|
+
Payload_11 as Payload,
|
7842
7841
|
ByType_9 as ByType
|
7843
7842
|
}
|
7844
7843
|
}
|
@@ -9691,86 +9690,110 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
9691
9690
|
error?: Success extends false ? ErrorPlainObject | undefined : never;
|
9692
9691
|
};
|
9693
9692
|
|
9693
|
+
/**
|
9694
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
9695
|
+
*
|
9696
|
+
* @see {@link ByType}
|
9697
|
+
*
|
9698
|
+
* @typeParam Type String key specifying the event to extract
|
9699
|
+
*/
|
9700
|
+
declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
|
9701
|
+
|
9694
9702
|
/**
|
9695
9703
|
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
9696
9704
|
*
|
9697
9705
|
* @typeParam Type String key specifying the event to extract
|
9698
9706
|
*/
|
9699
|
-
declare type
|
9707
|
+
declare type Payload_11<Type extends EventType_9> = Extract<Event_12, {
|
9700
9708
|
type: Type;
|
9701
9709
|
}>;
|
9702
9710
|
|
9711
|
+
/**
|
9712
|
+
* Extracts a single event type matching the given type key from the provided EmitterEvent union.
|
9713
|
+
*
|
9714
|
+
* @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
|
9715
|
+
* the appropriate payload union for that namespace.
|
9716
|
+
*
|
9717
|
+
* @typeParam Event Union of payloads for events on the given emitter
|
9718
|
+
* @see {@link ByType}
|
9719
|
+
*
|
9720
|
+
* @typeParam Type String key specifying the event to extract from the union
|
9721
|
+
*
|
9722
|
+
* @see {@link OpenFin.Events.ApplicationEvents.Payload}
|
9723
|
+
* @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
|
9724
|
+
* @see {@link OpenFin.Events.FrameEvents.Payload}
|
9725
|
+
* @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
|
9726
|
+
* @see {@link OpenFin.Events.PlatformEvents.Payload}
|
9727
|
+
* @see {@link OpenFin.Events.SystemEvents.Payload}
|
9728
|
+
* @see {@link OpenFin.Events.ViewEvents.Payload}
|
9729
|
+
* @see {@link OpenFin.Events.WindowEvents.Payload}
|
9730
|
+
*/
|
9731
|
+
declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
|
9732
|
+
type: EventType;
|
9733
|
+
}>;
|
9734
|
+
|
9703
9735
|
/**
|
9704
9736
|
* Extracts a single event type matching the given key from the View {@link Event} union.
|
9705
9737
|
*
|
9738
|
+
* @see {@link ByType}
|
9739
|
+
*
|
9706
9740
|
* @typeParam Type String key specifying the event to extract
|
9707
9741
|
*/
|
9708
|
-
declare type
|
9709
|
-
type: Type;
|
9710
|
-
}>;
|
9742
|
+
declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
|
9711
9743
|
|
9712
9744
|
/**
|
9713
9745
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
9714
9746
|
*
|
9747
|
+
* @see {@link ByType}
|
9748
|
+
*
|
9715
9749
|
* @typeParam Type String key specifying the event to extract
|
9716
9750
|
*/
|
9717
|
-
declare type
|
9718
|
-
type: Type;
|
9719
|
-
}>;
|
9751
|
+
declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
|
9720
9752
|
|
9721
9753
|
/**
|
9722
9754
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
9723
9755
|
*
|
9756
|
+
* @see {@link ByType}
|
9757
|
+
*
|
9724
9758
|
* @typeParam Type String key specifying the event to extract
|
9725
9759
|
*/
|
9726
|
-
declare type
|
9727
|
-
type: Type;
|
9728
|
-
}>;
|
9760
|
+
declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
|
9729
9761
|
|
9730
9762
|
/**
|
9731
9763
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
9732
9764
|
*
|
9765
|
+
* @see {@link ByType}
|
9766
|
+
*
|
9733
9767
|
* @typeParam Type String key specifying the event to extract
|
9734
9768
|
*/
|
9735
|
-
declare type
|
9736
|
-
type: Type;
|
9737
|
-
}>;
|
9769
|
+
declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
|
9738
9770
|
|
9739
9771
|
/**
|
9740
9772
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
9741
9773
|
*
|
9774
|
+
* @see {@link ByType}
|
9775
|
+
*
|
9742
9776
|
* @typeParam Type String key specifying the event to extract
|
9743
9777
|
*/
|
9744
|
-
declare type
|
9745
|
-
type: Type;
|
9746
|
-
}>;
|
9778
|
+
declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
|
9747
9779
|
|
9748
9780
|
/**
|
9749
9781
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
9750
9782
|
*
|
9783
|
+
* @see {@link ByType}
|
9784
|
+
*
|
9751
9785
|
* @typeParam Type String key specifying the event to extract
|
9752
9786
|
*/
|
9753
|
-
declare type
|
9754
|
-
type: Type;
|
9755
|
-
}>;
|
9787
|
+
declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
|
9756
9788
|
|
9757
9789
|
/**
|
9758
9790
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
9759
9791
|
*
|
9760
|
-
* @
|
9761
|
-
*/
|
9762
|
-
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
9763
|
-
type: Type;
|
9764
|
-
}>;
|
9765
|
-
|
9766
|
-
/**
|
9767
|
-
* Extracts a single event type matching the given key from the System {@link Event} union.
|
9792
|
+
* @see {@link ByType}
|
9768
9793
|
*
|
9769
9794
|
* @typeParam Type String key specifying the event to extract
|
9770
9795
|
*/
|
9771
|
-
declare type Payload_9<Type extends
|
9772
|
-
type: Type;
|
9773
|
-
}>;
|
9796
|
+
declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
|
9774
9797
|
|
9775
9798
|
/**
|
9776
9799
|
* @interface
|
@@ -10495,7 +10518,7 @@ declare namespace PlatformEvents {
|
|
10495
10518
|
PlatformEvent,
|
10496
10519
|
EventType_7 as EventType,
|
10497
10520
|
PlatformEventType,
|
10498
|
-
|
10521
|
+
Payload_9 as Payload,
|
10499
10522
|
ByType_7 as ByType
|
10500
10523
|
}
|
10501
10524
|
}
|
@@ -12834,7 +12857,7 @@ declare type Snapshot = {
|
|
12834
12857
|
* _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.
|
12835
12858
|
* @interface
|
12836
12859
|
*/
|
12837
|
-
declare type SnapshotAppliedEvent = BaseEvent & {
|
12860
|
+
declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
|
12838
12861
|
topic: 'application';
|
12839
12862
|
type: 'platform-snapshot-applied';
|
12840
12863
|
};
|
@@ -14445,7 +14468,7 @@ declare namespace SystemEvents {
|
|
14445
14468
|
SystemEvent,
|
14446
14469
|
EventType_8 as EventType,
|
14447
14470
|
SystemEventType,
|
14448
|
-
|
14471
|
+
Payload_10 as Payload,
|
14449
14472
|
ByType_8 as ByType
|
14450
14473
|
}
|
14451
14474
|
}
|
@@ -15510,7 +15533,7 @@ declare namespace ViewEvents {
|
|
15510
15533
|
PropagatedViewEvent,
|
15511
15534
|
PropagatedEventType_2 as PropagatedEventType,
|
15512
15535
|
PropagatedViewEventType,
|
15513
|
-
|
15536
|
+
Payload_3 as Payload,
|
15514
15537
|
ByType
|
15515
15538
|
}
|
15516
15539
|
}
|
@@ -18034,7 +18057,7 @@ declare namespace WindowEvents {
|
|
18034
18057
|
PropagatedEvent_3 as PropagatedEvent,
|
18035
18058
|
PropagatedWindowEvent,
|
18036
18059
|
PropagatedWindowEventType,
|
18037
|
-
|
18060
|
+
Payload_4 as Payload,
|
18038
18061
|
ByType_2 as ByType
|
18039
18062
|
}
|
18040
18063
|
}
|