@openfin/core 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.
- 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
|
}
|
@@ -1710,7 +1710,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
|
|
1710
1710
|
* A base Channel event.
|
1711
1711
|
* @interface
|
1712
1712
|
*/
|
1713
|
-
declare type BaseEvent_2 = NamedEvent & {
|
1713
|
+
declare type BaseEvent_2 = BaseEvents.NamedEvent & {
|
1714
1714
|
channelName: string;
|
1715
1715
|
channelId: string;
|
1716
1716
|
};
|
@@ -1780,6 +1780,7 @@ declare namespace BaseEvents {
|
|
1780
1780
|
NotCloseRequested,
|
1781
1781
|
PropagatedEventType,
|
1782
1782
|
PropagatedEvent,
|
1783
|
+
Payload_2 as Payload,
|
1783
1784
|
EventHandler,
|
1784
1785
|
BaseEvent,
|
1785
1786
|
IdentityEvent,
|
@@ -1920,7 +1921,7 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
|
|
1920
1921
|
*
|
1921
1922
|
* @typeParam Type String key specifying the event to extract
|
1922
1923
|
*/
|
1923
|
-
declare type ByType<Type extends EventType> =
|
1924
|
+
declare type ByType<Type extends EventType> = Payload_3<Type>;
|
1924
1925
|
|
1925
1926
|
/**
|
1926
1927
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
@@ -1929,7 +1930,7 @@ declare type ByType<Type extends EventType> = Payload_2<Type>;
|
|
1929
1930
|
*
|
1930
1931
|
* @typeParam Type String key specifying the event to extract
|
1931
1932
|
*/
|
1932
|
-
declare type ByType_2<Type extends EventType_2> =
|
1933
|
+
declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
|
1933
1934
|
|
1934
1935
|
/**
|
1935
1936
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
@@ -1938,7 +1939,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
|
|
1938
1939
|
*
|
1939
1940
|
* @typeParam Type String key specifying the event to extract
|
1940
1941
|
*/
|
1941
|
-
declare type ByType_3<Type extends EventType_3> =
|
1942
|
+
declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
|
1942
1943
|
|
1943
1944
|
/**
|
1944
1945
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
@@ -1947,7 +1948,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
|
|
1947
1948
|
*
|
1948
1949
|
* @typeParam Type String key specifying the event to extract
|
1949
1950
|
*/
|
1950
|
-
declare type ByType_4<Type extends EventType_4> =
|
1951
|
+
declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
|
1951
1952
|
|
1952
1953
|
/**
|
1953
1954
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
@@ -1956,7 +1957,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
|
|
1956
1957
|
*
|
1957
1958
|
* @typeParam Type String key specifying the event to extract
|
1958
1959
|
*/
|
1959
|
-
declare type ByType_5<Type extends EventType_5> =
|
1960
|
+
declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
|
1960
1961
|
|
1961
1962
|
/**
|
1962
1963
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
@@ -1965,7 +1966,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
|
|
1965
1966
|
*
|
1966
1967
|
* @typeParam Type String key specifying the event to extract
|
1967
1968
|
*/
|
1968
|
-
declare type ByType_6<Type extends EventType_6> =
|
1969
|
+
declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
|
1969
1970
|
|
1970
1971
|
/**
|
1971
1972
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
@@ -1974,7 +1975,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
|
|
1974
1975
|
*
|
1975
1976
|
* @typeParam Type String key specifying the event to extract
|
1976
1977
|
*/
|
1977
|
-
declare type ByType_7<Type extends EventType_7> =
|
1978
|
+
declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
|
1978
1979
|
|
1979
1980
|
/**
|
1980
1981
|
* Extracts a single event type matching the given key from the System {@link Event} union.
|
@@ -1983,7 +1984,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
|
|
1983
1984
|
*
|
1984
1985
|
* @typeParam Type String key specifying the event to extract
|
1985
1986
|
*/
|
1986
|
-
declare type ByType_8<Type extends EventType_8> =
|
1987
|
+
declare type ByType_8<Type extends EventType_8> = Payload_10<Type>;
|
1987
1988
|
|
1988
1989
|
/**
|
1989
1990
|
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
@@ -1992,7 +1993,7 @@ declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
|
|
1992
1993
|
*
|
1993
1994
|
* @typeParam Type String key specifying the event to extract
|
1994
1995
|
*/
|
1995
|
-
declare type ByType_9<Type extends EventType_9> =
|
1996
|
+
declare type ByType_9<Type extends EventType_9> = Payload_11<Type>;
|
1996
1997
|
|
1997
1998
|
/**
|
1998
1999
|
* Configuration for page capture.
|
@@ -4808,9 +4809,7 @@ declare class EventAggregator extends EmitterMap {
|
|
4808
4809
|
* @remarks Selects the correct type for the event
|
4809
4810
|
* payload from the provided union based on the provided string literal type.
|
4810
4811
|
*/
|
4811
|
-
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload:
|
4812
|
-
type: EventType;
|
4813
|
-
}>, ...args: any[]) => void;
|
4812
|
+
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
|
4814
4813
|
|
4815
4814
|
declare namespace Events {
|
4816
4815
|
export {
|
@@ -4946,7 +4945,7 @@ declare namespace ExternalApplicationEvents {
|
|
4946
4945
|
ExternalApplicationEvent,
|
4947
4946
|
EventType_4 as EventType,
|
4948
4947
|
ExternalApplicationEventType,
|
4949
|
-
|
4948
|
+
Payload_6 as Payload,
|
4950
4949
|
ByType_4 as ByType
|
4951
4950
|
}
|
4952
4951
|
}
|
@@ -5391,7 +5390,7 @@ declare namespace FrameEvents {
|
|
5391
5390
|
FrameEvent,
|
5392
5391
|
EventType_5 as EventType,
|
5393
5392
|
FrameEventType,
|
5394
|
-
|
5393
|
+
Payload_7 as Payload,
|
5395
5394
|
ByType_5 as ByType
|
5396
5395
|
}
|
5397
5396
|
}
|
@@ -5631,7 +5630,7 @@ declare namespace GlobalHotkeyEvents {
|
|
5631
5630
|
GlobalHotkeyEvent,
|
5632
5631
|
EventType_6 as EventType,
|
5633
5632
|
GlobalHotkeyEventType,
|
5634
|
-
|
5633
|
+
Payload_8 as Payload,
|
5635
5634
|
ByType_6 as ByType
|
5636
5635
|
}
|
5637
5636
|
}
|
@@ -7711,7 +7710,7 @@ declare namespace LayoutDOMEvents {
|
|
7711
7710
|
LayoutStateChangedEvent,
|
7712
7711
|
Event_12 as Event,
|
7713
7712
|
EventType_9 as EventType,
|
7714
|
-
|
7713
|
+
Payload_11 as Payload,
|
7715
7714
|
ByType_9 as ByType
|
7716
7715
|
}
|
7717
7716
|
}
|
@@ -9372,86 +9371,110 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
9372
9371
|
error?: Success extends false ? ErrorPlainObject | undefined : never;
|
9373
9372
|
};
|
9374
9373
|
|
9374
|
+
/**
|
9375
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
9376
|
+
*
|
9377
|
+
* @see {@link ByType}
|
9378
|
+
*
|
9379
|
+
* @typeParam Type String key specifying the event to extract
|
9380
|
+
*/
|
9381
|
+
declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
|
9382
|
+
|
9375
9383
|
/**
|
9376
9384
|
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
9377
9385
|
*
|
9378
9386
|
* @typeParam Type String key specifying the event to extract
|
9379
9387
|
*/
|
9380
|
-
declare type
|
9388
|
+
declare type Payload_11<Type extends EventType_9> = Extract<Event_12, {
|
9381
9389
|
type: Type;
|
9382
9390
|
}>;
|
9383
9391
|
|
9392
|
+
/**
|
9393
|
+
* Extracts a single event type matching the given type key from the provided EmitterEvent union.
|
9394
|
+
*
|
9395
|
+
* @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
|
9396
|
+
* the appropriate payload union for that namespace.
|
9397
|
+
*
|
9398
|
+
* @typeParam Event Union of payloads for events on the given emitter
|
9399
|
+
* @see {@link ByType}
|
9400
|
+
*
|
9401
|
+
* @typeParam Type String key specifying the event to extract from the union
|
9402
|
+
*
|
9403
|
+
* @see {@link OpenFin.Events.ApplicationEvents.Payload}
|
9404
|
+
* @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
|
9405
|
+
* @see {@link OpenFin.Events.FrameEvents.Payload}
|
9406
|
+
* @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
|
9407
|
+
* @see {@link OpenFin.Events.PlatformEvents.Payload}
|
9408
|
+
* @see {@link OpenFin.Events.SystemEvents.Payload}
|
9409
|
+
* @see {@link OpenFin.Events.ViewEvents.Payload}
|
9410
|
+
* @see {@link OpenFin.Events.WindowEvents.Payload}
|
9411
|
+
*/
|
9412
|
+
declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
|
9413
|
+
type: EventType;
|
9414
|
+
}>;
|
9415
|
+
|
9384
9416
|
/**
|
9385
9417
|
* Extracts a single event type matching the given key from the View {@link Event} union.
|
9386
9418
|
*
|
9419
|
+
* @see {@link ByType}
|
9420
|
+
*
|
9387
9421
|
* @typeParam Type String key specifying the event to extract
|
9388
9422
|
*/
|
9389
|
-
declare type
|
9390
|
-
type: Type;
|
9391
|
-
}>;
|
9423
|
+
declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
|
9392
9424
|
|
9393
9425
|
/**
|
9394
9426
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
9395
9427
|
*
|
9428
|
+
* @see {@link ByType}
|
9429
|
+
*
|
9396
9430
|
* @typeParam Type String key specifying the event to extract
|
9397
9431
|
*/
|
9398
|
-
declare type
|
9399
|
-
type: Type;
|
9400
|
-
}>;
|
9432
|
+
declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
|
9401
9433
|
|
9402
9434
|
/**
|
9403
9435
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
9404
9436
|
*
|
9437
|
+
* @see {@link ByType}
|
9438
|
+
*
|
9405
9439
|
* @typeParam Type String key specifying the event to extract
|
9406
9440
|
*/
|
9407
|
-
declare type
|
9408
|
-
type: Type;
|
9409
|
-
}>;
|
9441
|
+
declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
|
9410
9442
|
|
9411
9443
|
/**
|
9412
9444
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
9413
9445
|
*
|
9446
|
+
* @see {@link ByType}
|
9447
|
+
*
|
9414
9448
|
* @typeParam Type String key specifying the event to extract
|
9415
9449
|
*/
|
9416
|
-
declare type
|
9417
|
-
type: Type;
|
9418
|
-
}>;
|
9450
|
+
declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
|
9419
9451
|
|
9420
9452
|
/**
|
9421
9453
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
9422
9454
|
*
|
9455
|
+
* @see {@link ByType}
|
9456
|
+
*
|
9423
9457
|
* @typeParam Type String key specifying the event to extract
|
9424
9458
|
*/
|
9425
|
-
declare type
|
9426
|
-
type: Type;
|
9427
|
-
}>;
|
9459
|
+
declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
|
9428
9460
|
|
9429
9461
|
/**
|
9430
9462
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
9431
9463
|
*
|
9464
|
+
* @see {@link ByType}
|
9465
|
+
*
|
9432
9466
|
* @typeParam Type String key specifying the event to extract
|
9433
9467
|
*/
|
9434
|
-
declare type
|
9435
|
-
type: Type;
|
9436
|
-
}>;
|
9468
|
+
declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
|
9437
9469
|
|
9438
9470
|
/**
|
9439
9471
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
9440
9472
|
*
|
9441
|
-
* @
|
9442
|
-
*/
|
9443
|
-
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
9444
|
-
type: Type;
|
9445
|
-
}>;
|
9446
|
-
|
9447
|
-
/**
|
9448
|
-
* Extracts a single event type matching the given key from the System {@link Event} union.
|
9473
|
+
* @see {@link ByType}
|
9449
9474
|
*
|
9450
9475
|
* @typeParam Type String key specifying the event to extract
|
9451
9476
|
*/
|
9452
|
-
declare type Payload_9<Type extends
|
9453
|
-
type: Type;
|
9454
|
-
}>;
|
9477
|
+
declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
|
9455
9478
|
|
9456
9479
|
/**
|
9457
9480
|
* @interface
|
@@ -10146,7 +10169,7 @@ declare namespace PlatformEvents {
|
|
10146
10169
|
PlatformEvent,
|
10147
10170
|
EventType_7 as EventType,
|
10148
10171
|
PlatformEventType,
|
10149
|
-
|
10172
|
+
Payload_9 as Payload,
|
10150
10173
|
ByType_7 as ByType
|
10151
10174
|
}
|
10152
10175
|
}
|
@@ -12437,7 +12460,7 @@ declare type Snapshot = {
|
|
12437
12460
|
* _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.
|
12438
12461
|
* @interface
|
12439
12462
|
*/
|
12440
|
-
declare type SnapshotAppliedEvent = BaseEvent & {
|
12463
|
+
declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
|
12441
12464
|
topic: 'application';
|
12442
12465
|
type: 'platform-snapshot-applied';
|
12443
12466
|
};
|
@@ -14042,7 +14065,7 @@ declare namespace SystemEvents {
|
|
14042
14065
|
SystemEvent,
|
14043
14066
|
EventType_8 as EventType,
|
14044
14067
|
SystemEventType,
|
14045
|
-
|
14068
|
+
Payload_10 as Payload,
|
14046
14069
|
ByType_8 as ByType
|
14047
14070
|
}
|
14048
14071
|
}
|
@@ -15063,7 +15086,7 @@ declare namespace ViewEvents {
|
|
15063
15086
|
PropagatedViewEvent,
|
15064
15087
|
PropagatedEventType_2 as PropagatedEventType,
|
15065
15088
|
PropagatedViewEventType,
|
15066
|
-
|
15089
|
+
Payload_3 as Payload,
|
15067
15090
|
ByType
|
15068
15091
|
}
|
15069
15092
|
}
|
@@ -17584,7 +17607,7 @@ declare namespace WindowEvents {
|
|
17584
17607
|
PropagatedEvent_3 as PropagatedEvent,
|
17585
17608
|
PropagatedWindowEvent,
|
17586
17609
|
PropagatedWindowEventType,
|
17587
|
-
|
17610
|
+
Payload_4 as Payload,
|
17588
17611
|
ByType_2 as ByType
|
17589
17612
|
}
|
17590
17613
|
}
|
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
|
}
|
@@ -1742,7 +1742,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
|
|
1742
1742
|
* A base Channel event.
|
1743
1743
|
* @interface
|
1744
1744
|
*/
|
1745
|
-
declare type BaseEvent_2 = NamedEvent & {
|
1745
|
+
declare type BaseEvent_2 = BaseEvents.NamedEvent & {
|
1746
1746
|
channelName: string;
|
1747
1747
|
channelId: string;
|
1748
1748
|
};
|
@@ -1812,6 +1812,7 @@ declare namespace BaseEvents {
|
|
1812
1812
|
NotCloseRequested,
|
1813
1813
|
PropagatedEventType,
|
1814
1814
|
PropagatedEvent,
|
1815
|
+
Payload_2 as Payload,
|
1815
1816
|
EventHandler,
|
1816
1817
|
BaseEvent,
|
1817
1818
|
IdentityEvent,
|
@@ -1952,7 +1953,7 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
|
|
1952
1953
|
*
|
1953
1954
|
* @typeParam Type String key specifying the event to extract
|
1954
1955
|
*/
|
1955
|
-
declare type ByType<Type extends EventType> =
|
1956
|
+
declare type ByType<Type extends EventType> = Payload_3<Type>;
|
1956
1957
|
|
1957
1958
|
/**
|
1958
1959
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
@@ -1961,7 +1962,7 @@ declare type ByType<Type extends EventType> = Payload_2<Type>;
|
|
1961
1962
|
*
|
1962
1963
|
* @typeParam Type String key specifying the event to extract
|
1963
1964
|
*/
|
1964
|
-
declare type ByType_2<Type extends EventType_2> =
|
1965
|
+
declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
|
1965
1966
|
|
1966
1967
|
/**
|
1967
1968
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
@@ -1970,7 +1971,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
|
|
1970
1971
|
*
|
1971
1972
|
* @typeParam Type String key specifying the event to extract
|
1972
1973
|
*/
|
1973
|
-
declare type ByType_3<Type extends EventType_3> =
|
1974
|
+
declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
|
1974
1975
|
|
1975
1976
|
/**
|
1976
1977
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
@@ -1979,7 +1980,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
|
|
1979
1980
|
*
|
1980
1981
|
* @typeParam Type String key specifying the event to extract
|
1981
1982
|
*/
|
1982
|
-
declare type ByType_4<Type extends EventType_4> =
|
1983
|
+
declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
|
1983
1984
|
|
1984
1985
|
/**
|
1985
1986
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
@@ -1988,7 +1989,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
|
|
1988
1989
|
*
|
1989
1990
|
* @typeParam Type String key specifying the event to extract
|
1990
1991
|
*/
|
1991
|
-
declare type ByType_5<Type extends EventType_5> =
|
1992
|
+
declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
|
1992
1993
|
|
1993
1994
|
/**
|
1994
1995
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
@@ -1997,7 +1998,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
|
|
1997
1998
|
*
|
1998
1999
|
* @typeParam Type String key specifying the event to extract
|
1999
2000
|
*/
|
2000
|
-
declare type ByType_6<Type extends EventType_6> =
|
2001
|
+
declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
|
2001
2002
|
|
2002
2003
|
/**
|
2003
2004
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
@@ -2006,7 +2007,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
|
|
2006
2007
|
*
|
2007
2008
|
* @typeParam Type String key specifying the event to extract
|
2008
2009
|
*/
|
2009
|
-
declare type ByType_7<Type extends EventType_7> =
|
2010
|
+
declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
|
2010
2011
|
|
2011
2012
|
/**
|
2012
2013
|
* Extracts a single event type matching the given key from the System {@link Event} union.
|
@@ -2015,7 +2016,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
|
|
2015
2016
|
*
|
2016
2017
|
* @typeParam Type String key specifying the event to extract
|
2017
2018
|
*/
|
2018
|
-
declare type ByType_8<Type extends EventType_8> =
|
2019
|
+
declare type ByType_8<Type extends EventType_8> = Payload_10<Type>;
|
2019
2020
|
|
2020
2021
|
/**
|
2021
2022
|
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
@@ -2024,7 +2025,7 @@ declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
|
|
2024
2025
|
*
|
2025
2026
|
* @typeParam Type String key specifying the event to extract
|
2026
2027
|
*/
|
2027
|
-
declare type ByType_9<Type extends EventType_9> =
|
2028
|
+
declare type ByType_9<Type extends EventType_9> = Payload_11<Type>;
|
2028
2029
|
|
2029
2030
|
/**
|
2030
2031
|
* Configuration for page capture.
|
@@ -4872,9 +4873,7 @@ declare class EventAggregator extends EmitterMap {
|
|
4872
4873
|
* @remarks Selects the correct type for the event
|
4873
4874
|
* payload from the provided union based on the provided string literal type.
|
4874
4875
|
*/
|
4875
|
-
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload:
|
4876
|
-
type: EventType;
|
4877
|
-
}>, ...args: any[]) => void;
|
4876
|
+
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
|
4878
4877
|
|
4879
4878
|
declare namespace Events {
|
4880
4879
|
export {
|
@@ -5031,7 +5030,7 @@ declare namespace ExternalApplicationEvents {
|
|
5031
5030
|
ExternalApplicationEvent,
|
5032
5031
|
EventType_4 as EventType,
|
5033
5032
|
ExternalApplicationEventType,
|
5034
|
-
|
5033
|
+
Payload_6 as Payload,
|
5035
5034
|
ByType_4 as ByType
|
5036
5035
|
}
|
5037
5036
|
}
|
@@ -5479,7 +5478,7 @@ declare namespace FrameEvents {
|
|
5479
5478
|
FrameEvent,
|
5480
5479
|
EventType_5 as EventType,
|
5481
5480
|
FrameEventType,
|
5482
|
-
|
5481
|
+
Payload_7 as Payload,
|
5483
5482
|
ByType_5 as ByType
|
5484
5483
|
}
|
5485
5484
|
}
|
@@ -5722,7 +5721,7 @@ declare namespace GlobalHotkeyEvents {
|
|
5722
5721
|
GlobalHotkeyEvent,
|
5723
5722
|
EventType_6 as EventType,
|
5724
5723
|
GlobalHotkeyEventType,
|
5725
|
-
|
5724
|
+
Payload_8 as Payload,
|
5726
5725
|
ByType_6 as ByType
|
5727
5726
|
}
|
5728
5727
|
}
|
@@ -7834,7 +7833,7 @@ declare namespace LayoutDOMEvents {
|
|
7834
7833
|
LayoutStateChangedEvent,
|
7835
7834
|
Event_12 as Event,
|
7836
7835
|
EventType_9 as EventType,
|
7837
|
-
|
7836
|
+
Payload_11 as Payload,
|
7838
7837
|
ByType_9 as ByType
|
7839
7838
|
}
|
7840
7839
|
}
|
@@ -9687,86 +9686,110 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
9687
9686
|
error?: Success extends false ? ErrorPlainObject | undefined : never;
|
9688
9687
|
};
|
9689
9688
|
|
9689
|
+
/**
|
9690
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
9691
|
+
*
|
9692
|
+
* @see {@link ByType}
|
9693
|
+
*
|
9694
|
+
* @typeParam Type String key specifying the event to extract
|
9695
|
+
*/
|
9696
|
+
declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
|
9697
|
+
|
9690
9698
|
/**
|
9691
9699
|
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
9692
9700
|
*
|
9693
9701
|
* @typeParam Type String key specifying the event to extract
|
9694
9702
|
*/
|
9695
|
-
declare type
|
9703
|
+
declare type Payload_11<Type extends EventType_9> = Extract<Event_12, {
|
9696
9704
|
type: Type;
|
9697
9705
|
}>;
|
9698
9706
|
|
9707
|
+
/**
|
9708
|
+
* Extracts a single event type matching the given type key from the provided EmitterEvent union.
|
9709
|
+
*
|
9710
|
+
* @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
|
9711
|
+
* the appropriate payload union for that namespace.
|
9712
|
+
*
|
9713
|
+
* @typeParam Event Union of payloads for events on the given emitter
|
9714
|
+
* @see {@link ByType}
|
9715
|
+
*
|
9716
|
+
* @typeParam Type String key specifying the event to extract from the union
|
9717
|
+
*
|
9718
|
+
* @see {@link OpenFin.Events.ApplicationEvents.Payload}
|
9719
|
+
* @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
|
9720
|
+
* @see {@link OpenFin.Events.FrameEvents.Payload}
|
9721
|
+
* @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
|
9722
|
+
* @see {@link OpenFin.Events.PlatformEvents.Payload}
|
9723
|
+
* @see {@link OpenFin.Events.SystemEvents.Payload}
|
9724
|
+
* @see {@link OpenFin.Events.ViewEvents.Payload}
|
9725
|
+
* @see {@link OpenFin.Events.WindowEvents.Payload}
|
9726
|
+
*/
|
9727
|
+
declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
|
9728
|
+
type: EventType;
|
9729
|
+
}>;
|
9730
|
+
|
9699
9731
|
/**
|
9700
9732
|
* Extracts a single event type matching the given key from the View {@link Event} union.
|
9701
9733
|
*
|
9734
|
+
* @see {@link ByType}
|
9735
|
+
*
|
9702
9736
|
* @typeParam Type String key specifying the event to extract
|
9703
9737
|
*/
|
9704
|
-
declare type
|
9705
|
-
type: Type;
|
9706
|
-
}>;
|
9738
|
+
declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
|
9707
9739
|
|
9708
9740
|
/**
|
9709
9741
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
9710
9742
|
*
|
9743
|
+
* @see {@link ByType}
|
9744
|
+
*
|
9711
9745
|
* @typeParam Type String key specifying the event to extract
|
9712
9746
|
*/
|
9713
|
-
declare type
|
9714
|
-
type: Type;
|
9715
|
-
}>;
|
9747
|
+
declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
|
9716
9748
|
|
9717
9749
|
/**
|
9718
9750
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
9719
9751
|
*
|
9752
|
+
* @see {@link ByType}
|
9753
|
+
*
|
9720
9754
|
* @typeParam Type String key specifying the event to extract
|
9721
9755
|
*/
|
9722
|
-
declare type
|
9723
|
-
type: Type;
|
9724
|
-
}>;
|
9756
|
+
declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
|
9725
9757
|
|
9726
9758
|
/**
|
9727
9759
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
9728
9760
|
*
|
9761
|
+
* @see {@link ByType}
|
9762
|
+
*
|
9729
9763
|
* @typeParam Type String key specifying the event to extract
|
9730
9764
|
*/
|
9731
|
-
declare type
|
9732
|
-
type: Type;
|
9733
|
-
}>;
|
9765
|
+
declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
|
9734
9766
|
|
9735
9767
|
/**
|
9736
9768
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
9737
9769
|
*
|
9770
|
+
* @see {@link ByType}
|
9771
|
+
*
|
9738
9772
|
* @typeParam Type String key specifying the event to extract
|
9739
9773
|
*/
|
9740
|
-
declare type
|
9741
|
-
type: Type;
|
9742
|
-
}>;
|
9774
|
+
declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
|
9743
9775
|
|
9744
9776
|
/**
|
9745
9777
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
9746
9778
|
*
|
9779
|
+
* @see {@link ByType}
|
9780
|
+
*
|
9747
9781
|
* @typeParam Type String key specifying the event to extract
|
9748
9782
|
*/
|
9749
|
-
declare type
|
9750
|
-
type: Type;
|
9751
|
-
}>;
|
9783
|
+
declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
|
9752
9784
|
|
9753
9785
|
/**
|
9754
9786
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
9755
9787
|
*
|
9756
|
-
* @
|
9757
|
-
*/
|
9758
|
-
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
9759
|
-
type: Type;
|
9760
|
-
}>;
|
9761
|
-
|
9762
|
-
/**
|
9763
|
-
* Extracts a single event type matching the given key from the System {@link Event} union.
|
9788
|
+
* @see {@link ByType}
|
9764
9789
|
*
|
9765
9790
|
* @typeParam Type String key specifying the event to extract
|
9766
9791
|
*/
|
9767
|
-
declare type Payload_9<Type extends
|
9768
|
-
type: Type;
|
9769
|
-
}>;
|
9792
|
+
declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
|
9770
9793
|
|
9771
9794
|
/**
|
9772
9795
|
* @interface
|
@@ -10491,7 +10514,7 @@ declare namespace PlatformEvents {
|
|
10491
10514
|
PlatformEvent,
|
10492
10515
|
EventType_7 as EventType,
|
10493
10516
|
PlatformEventType,
|
10494
|
-
|
10517
|
+
Payload_9 as Payload,
|
10495
10518
|
ByType_7 as ByType
|
10496
10519
|
}
|
10497
10520
|
}
|
@@ -12830,7 +12853,7 @@ declare type Snapshot = {
|
|
12830
12853
|
* _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.
|
12831
12854
|
* @interface
|
12832
12855
|
*/
|
12833
|
-
declare type SnapshotAppliedEvent = BaseEvent & {
|
12856
|
+
declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
|
12834
12857
|
topic: 'application';
|
12835
12858
|
type: 'platform-snapshot-applied';
|
12836
12859
|
};
|
@@ -14441,7 +14464,7 @@ declare namespace SystemEvents {
|
|
14441
14464
|
SystemEvent,
|
14442
14465
|
EventType_8 as EventType,
|
14443
14466
|
SystemEventType,
|
14444
|
-
|
14467
|
+
Payload_10 as Payload,
|
14445
14468
|
ByType_8 as ByType
|
14446
14469
|
}
|
14447
14470
|
}
|
@@ -15506,7 +15529,7 @@ declare namespace ViewEvents {
|
|
15506
15529
|
PropagatedViewEvent,
|
15507
15530
|
PropagatedEventType_2 as PropagatedEventType,
|
15508
15531
|
PropagatedViewEventType,
|
15509
|
-
|
15532
|
+
Payload_3 as Payload,
|
15510
15533
|
ByType
|
15511
15534
|
}
|
15512
15535
|
}
|
@@ -18030,7 +18053,7 @@ declare namespace WindowEvents {
|
|
18030
18053
|
PropagatedEvent_3 as PropagatedEvent,
|
18031
18054
|
PropagatedWindowEvent,
|
18032
18055
|
PropagatedWindowEventType,
|
18033
|
-
|
18056
|
+
Payload_4 as Payload,
|
18034
18057
|
ByType_2 as ByType
|
18035
18058
|
}
|
18036
18059
|
}
|