@openfin/core 36.79.9 → 36.79.11
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 +58 -31
- package/out/mock-beta.d.ts +58 -31
- package/out/mock-public.d.ts +58 -31
- package/out/mock.d.ts +59 -32
- package/out/mock.js +59 -50
- package/package.json +1 -1
package/out/mock-alpha.d.ts
CHANGED
@@ -871,7 +871,7 @@ declare type ApplicationConnectedEvent = ConnectedEvent_2;
|
|
871
871
|
* Generated when an application is created.
|
872
872
|
* @interface
|
873
873
|
*/
|
874
|
-
declare type ApplicationCreatedEvent =
|
874
|
+
declare type ApplicationCreatedEvent = BaseEvent_9 & BaseEvents.IdentityEvent & {
|
875
875
|
type: 'application-created';
|
876
876
|
};
|
877
877
|
|
@@ -1738,13 +1738,30 @@ declare type BaseContentCreationRule = {
|
|
1738
1738
|
/**
|
1739
1739
|
* A base OpenFin event. All OpenFin event payloads extend this type.
|
1740
1740
|
*
|
1741
|
+
* OpenFin events are jointly discriminated by their {@link topic} and {@link type} keys. Within each
|
1742
|
+
* `topic`, the `type` key is unique.
|
1743
|
+
*
|
1741
1744
|
* @interface
|
1742
1745
|
*/
|
1743
1746
|
declare type BaseEvent = {
|
1747
|
+
/**
|
1748
|
+
* The "kebab-case" classname of the {@link OpenFin.Events emitter} that raised the event.
|
1749
|
+
*
|
1750
|
+
* @remarks {@link OpenFin.Frame} is represented as `iframe`.
|
1751
|
+
*/
|
1744
1752
|
topic: string;
|
1753
|
+
/**
|
1754
|
+
* The type of event that was raised. Equal to the typename of the event payload in "kebab case".
|
1755
|
+
*
|
1756
|
+
* @remarks Guaranteed to be unique within each {@link topic}, but can be repeated
|
1757
|
+
* between topics (e.g. {@link OpenFin.WebContentsEvents.CrashedEvent WebContentsEvents.CrashedEvent} and
|
1758
|
+
* {@link OpenFin.ApplicationEvents.CrashedEvent ApplicationEvents.CrashedEvent}).
|
1759
|
+
*/
|
1745
1760
|
type: string;
|
1746
1761
|
};
|
1747
1762
|
|
1763
|
+
declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
|
1764
|
+
|
1748
1765
|
/**
|
1749
1766
|
* A base Channel event.
|
1750
1767
|
* @interface
|
@@ -1797,14 +1814,22 @@ declare type BaseEvent_7 = NamedEvent & {
|
|
1797
1814
|
};
|
1798
1815
|
|
1799
1816
|
/**
|
1800
|
-
* Base type for events emitting on the `
|
1817
|
+
* Base type for events emitting on the `global-hotkey` topic.
|
1818
|
+
*
|
1801
1819
|
* @interface
|
1802
1820
|
*/
|
1803
1821
|
declare type BaseEvent_8 = BaseEvents.BaseEvent & {
|
1804
|
-
topic: '
|
1822
|
+
topic: 'global-hotkey';
|
1823
|
+
hotkey: string;
|
1805
1824
|
};
|
1806
1825
|
|
1807
|
-
|
1826
|
+
/**
|
1827
|
+
* Base type for events emitting on the `system` topic
|
1828
|
+
* @interface
|
1829
|
+
*/
|
1830
|
+
declare type BaseEvent_9 = BaseEvents.BaseEvent & {
|
1831
|
+
topic: 'system';
|
1832
|
+
};
|
1808
1833
|
|
1809
1834
|
declare namespace BaseEvents {
|
1810
1835
|
export {
|
@@ -4583,7 +4608,7 @@ declare interface DesktopAgent_2 {
|
|
4583
4608
|
* Generated when the desktop icon is clicked while it's already running.
|
4584
4609
|
* @interface
|
4585
4610
|
*/
|
4586
|
-
declare type DesktopIconClickedEvent =
|
4611
|
+
declare type DesktopIconClickedEvent = BaseEvent_9 & {
|
4587
4612
|
type: 'desktop-icon-clicked';
|
4588
4613
|
};
|
4589
4614
|
|
@@ -5127,6 +5152,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
|
|
5127
5152
|
|
5128
5153
|
declare interface Environment {
|
5129
5154
|
initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
|
5155
|
+
applyLayoutSnapshot(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.InitLayoutOptions): Promise<void>;
|
5130
5156
|
createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
|
5131
5157
|
destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
|
5132
5158
|
resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
|
@@ -5168,14 +5194,14 @@ declare type ErrorPlainObject = {
|
|
5168
5194
|
|
5169
5195
|
/**
|
5170
5196
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}. Events are
|
5171
|
-
* discriminated by {@link
|
5197
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
|
5172
5198
|
* under the {@link OpenFin.PlatformEvents} namespace.
|
5173
5199
|
*/
|
5174
5200
|
declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
|
5175
5201
|
|
5176
5202
|
/**
|
5177
5203
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}. Events are
|
5178
|
-
* discriminated by {@link
|
5204
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
|
5179
5205
|
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5180
5206
|
* from which they propagate).
|
5181
5207
|
*/
|
@@ -5183,7 +5209,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
|
|
5183
5209
|
|
5184
5210
|
/**
|
5185
5211
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
|
5186
|
-
* discriminated by {@link
|
5212
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
|
5187
5213
|
* under the {@link OpenFin.ChannelEvents} namespace.
|
5188
5214
|
*/
|
5189
5215
|
declare type Event_2 = {
|
@@ -5192,7 +5218,7 @@ declare type Event_2 = {
|
|
5192
5218
|
|
5193
5219
|
/**
|
5194
5220
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}. Events are
|
5195
|
-
* discriminated by {@link
|
5221
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
|
5196
5222
|
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5197
5223
|
* from which they propagate).
|
5198
5224
|
*/
|
@@ -5200,7 +5226,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
|
|
5200
5226
|
|
5201
5227
|
/**
|
5202
5228
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}. Events are
|
5203
|
-
* discriminated by {@link
|
5229
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
|
5204
5230
|
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5205
5231
|
*/
|
5206
5232
|
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
@@ -5217,21 +5243,21 @@ declare type Event_5<Topic extends string> = {
|
|
5217
5243
|
|
5218
5244
|
/**
|
5219
5245
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
|
5220
|
-
* discriminated by {@link
|
5246
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
|
5221
5247
|
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5222
5248
|
*/
|
5223
5249
|
declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
|
5224
5250
|
|
5225
5251
|
/**
|
5226
5252
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}. Events are
|
5227
|
-
* discriminated by {@link
|
5253
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
5228
5254
|
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
5229
5255
|
*/
|
5230
5256
|
declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
|
5231
5257
|
|
5232
5258
|
/**
|
5233
5259
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}. Events are
|
5234
|
-
* discriminated by {@link
|
5260
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
|
5235
5261
|
* under the {@link OpenFin.FrameEvents} namespace.
|
5236
5262
|
*/
|
5237
5263
|
declare type Event_8 = {
|
@@ -5240,13 +5266,10 @@ declare type Event_8 = {
|
|
5240
5266
|
|
5241
5267
|
/**
|
5242
5268
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}. Events are
|
5243
|
-
* discriminated by {@link
|
5269
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
5244
5270
|
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
5245
5271
|
*/
|
5246
|
-
declare type Event_9 =
|
5247
|
-
topic: 'global-hotkey';
|
5248
|
-
hotkey: 'string';
|
5249
|
-
} & (RegisteredEvent | UnregisteredEvent);
|
5272
|
+
declare type Event_9 = RegisteredEvent | UnregisteredEvent;
|
5250
5273
|
|
5251
5274
|
declare class EventAggregator extends EmitterMap {
|
5252
5275
|
dispatchEvent: (message: Message<any>) => boolean;
|
@@ -6099,6 +6122,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
|
6099
6122
|
|
6100
6123
|
declare namespace GlobalHotkeyEvents {
|
6101
6124
|
export {
|
6125
|
+
BaseEvent_8 as BaseEvent,
|
6102
6126
|
RegisteredEvent,
|
6103
6127
|
UnregisteredEvent,
|
6104
6128
|
Event_9 as Event,
|
@@ -6586,7 +6610,7 @@ declare type IdleEvent = IdleStateChangedEvent;
|
|
6586
6610
|
* A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
|
6587
6611
|
* @interface
|
6588
6612
|
*/
|
6589
|
-
declare type IdleStateChangedEvent =
|
6613
|
+
declare type IdleStateChangedEvent = BaseEvent_9 & {
|
6590
6614
|
type: 'idle-state-changed';
|
6591
6615
|
elapsedTime: number;
|
6592
6616
|
isIdle: boolean;
|
@@ -8617,16 +8641,17 @@ declare type LayoutIdentity = Identity_5 & {
|
|
8617
8641
|
};
|
8618
8642
|
|
8619
8643
|
/**
|
8620
|
-
* Generated
|
8621
|
-
*
|
8644
|
+
* Generated after a layout is created and all of its views have either finished or failed navigation
|
8645
|
+
* once per layout. Does not emit for layouts created using Layout.replace() API.
|
8622
8646
|
* @interface
|
8623
8647
|
*/
|
8624
8648
|
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
8625
8649
|
type: 'layout-initialized';
|
8626
8650
|
layoutIdentity: OpenFin_2.LayoutIdentity;
|
8627
|
-
ofViews:
|
8651
|
+
ofViews: {
|
8652
|
+
identity: OpenFin_2.Identity;
|
8628
8653
|
entityType: 'view';
|
8629
|
-
}
|
8654
|
+
}[];
|
8630
8655
|
};
|
8631
8656
|
|
8632
8657
|
/**
|
@@ -8994,9 +9019,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
8994
9019
|
declare type LayoutReadyEvent = BaseEvent_5 & {
|
8995
9020
|
type: 'layout-ready';
|
8996
9021
|
layoutIdentity: OpenFin_2.LayoutIdentity;
|
8997
|
-
views:
|
9022
|
+
views: {
|
9023
|
+
identity: OpenFin_2.Identity;
|
8998
9024
|
success: boolean;
|
8999
|
-
|
9025
|
+
error?: Error;
|
9026
|
+
}[];
|
9000
9027
|
};
|
9001
9028
|
|
9002
9029
|
/**
|
@@ -9372,7 +9399,7 @@ declare type MonitorInfo = {
|
|
9372
9399
|
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
9373
9400
|
* @interface
|
9374
9401
|
*/
|
9375
|
-
declare type MonitorInfoChangedEvent =
|
9402
|
+
declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin_2.MonitorInfo & {
|
9376
9403
|
type: 'monitor-info-changed';
|
9377
9404
|
};
|
9378
9405
|
|
@@ -10111,7 +10138,7 @@ declare namespace OpenFin_2 {
|
|
10111
10138
|
AppVersionCompleteEvent,
|
10112
10139
|
AppVersionRuntimeStatusEvent,
|
10113
10140
|
Events,
|
10114
|
-
|
10141
|
+
BaseEvent_10 as BaseEvent,
|
10115
10142
|
WebContentsEvent_2 as WebContentsEvent,
|
10116
10143
|
SystemEvent_2 as SystemEvent,
|
10117
10144
|
ApplicationEvent_2 as ApplicationEvent,
|
@@ -12570,7 +12597,7 @@ declare type RectangleByEdgePositions = {
|
|
12570
12597
|
* Generated when a hotkey has been registered with the operating system.
|
12571
12598
|
* @interface
|
12572
12599
|
*/
|
12573
|
-
declare type RegisteredEvent =
|
12600
|
+
declare type RegisteredEvent = BaseEvent_8 & {
|
12574
12601
|
type: 'registered';
|
12575
12602
|
};
|
12576
12603
|
|
@@ -12992,7 +13019,7 @@ declare type ServiceIdentifier = {
|
|
12992
13019
|
* Generated on changes to a user’s local computer session.
|
12993
13020
|
* @interface
|
12994
13021
|
*/
|
12995
|
-
declare type SessionChangedEvent =
|
13022
|
+
declare type SessionChangedEvent = BaseEvent_9 & {
|
12996
13023
|
type: 'session-changed';
|
12997
13024
|
reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
|
12998
13025
|
};
|
@@ -14926,7 +14953,7 @@ declare namespace SystemEvents {
|
|
14926
14953
|
export {
|
14927
14954
|
NotRequested,
|
14928
14955
|
ExcludeRequested,
|
14929
|
-
|
14956
|
+
BaseEvent_9 as BaseEvent,
|
14930
14957
|
IdleStateChangedEvent,
|
14931
14958
|
IdleEvent,
|
14932
14959
|
MonitorInfoChangedEvent,
|
@@ -15404,7 +15431,7 @@ declare interface TypedEventEmitter<Event extends {
|
|
15404
15431
|
* Generated when a hotkey has been unregistered with the operating system.
|
15405
15432
|
* @interface
|
15406
15433
|
*/
|
15407
|
-
declare type UnregisteredEvent =
|
15434
|
+
declare type UnregisteredEvent = BaseEvent_8 & {
|
15408
15435
|
type: 'unregistered';
|
15409
15436
|
};
|
15410
15437
|
|
package/out/mock-beta.d.ts
CHANGED
@@ -871,7 +871,7 @@ declare type ApplicationConnectedEvent = ConnectedEvent_2;
|
|
871
871
|
* Generated when an application is created.
|
872
872
|
* @interface
|
873
873
|
*/
|
874
|
-
declare type ApplicationCreatedEvent =
|
874
|
+
declare type ApplicationCreatedEvent = BaseEvent_9 & BaseEvents.IdentityEvent & {
|
875
875
|
type: 'application-created';
|
876
876
|
};
|
877
877
|
|
@@ -1738,13 +1738,30 @@ declare type BaseContentCreationRule = {
|
|
1738
1738
|
/**
|
1739
1739
|
* A base OpenFin event. All OpenFin event payloads extend this type.
|
1740
1740
|
*
|
1741
|
+
* OpenFin events are jointly discriminated by their {@link topic} and {@link type} keys. Within each
|
1742
|
+
* `topic`, the `type` key is unique.
|
1743
|
+
*
|
1741
1744
|
* @interface
|
1742
1745
|
*/
|
1743
1746
|
declare type BaseEvent = {
|
1747
|
+
/**
|
1748
|
+
* The "kebab-case" classname of the {@link OpenFin.Events emitter} that raised the event.
|
1749
|
+
*
|
1750
|
+
* @remarks {@link OpenFin.Frame} is represented as `iframe`.
|
1751
|
+
*/
|
1744
1752
|
topic: string;
|
1753
|
+
/**
|
1754
|
+
* The type of event that was raised. Equal to the typename of the event payload in "kebab case".
|
1755
|
+
*
|
1756
|
+
* @remarks Guaranteed to be unique within each {@link topic}, but can be repeated
|
1757
|
+
* between topics (e.g. {@link OpenFin.WebContentsEvents.CrashedEvent WebContentsEvents.CrashedEvent} and
|
1758
|
+
* {@link OpenFin.ApplicationEvents.CrashedEvent ApplicationEvents.CrashedEvent}).
|
1759
|
+
*/
|
1745
1760
|
type: string;
|
1746
1761
|
};
|
1747
1762
|
|
1763
|
+
declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
|
1764
|
+
|
1748
1765
|
/**
|
1749
1766
|
* A base Channel event.
|
1750
1767
|
* @interface
|
@@ -1797,14 +1814,22 @@ declare type BaseEvent_7 = NamedEvent & {
|
|
1797
1814
|
};
|
1798
1815
|
|
1799
1816
|
/**
|
1800
|
-
* Base type for events emitting on the `
|
1817
|
+
* Base type for events emitting on the `global-hotkey` topic.
|
1818
|
+
*
|
1801
1819
|
* @interface
|
1802
1820
|
*/
|
1803
1821
|
declare type BaseEvent_8 = BaseEvents.BaseEvent & {
|
1804
|
-
topic: '
|
1822
|
+
topic: 'global-hotkey';
|
1823
|
+
hotkey: string;
|
1805
1824
|
};
|
1806
1825
|
|
1807
|
-
|
1826
|
+
/**
|
1827
|
+
* Base type for events emitting on the `system` topic
|
1828
|
+
* @interface
|
1829
|
+
*/
|
1830
|
+
declare type BaseEvent_9 = BaseEvents.BaseEvent & {
|
1831
|
+
topic: 'system';
|
1832
|
+
};
|
1808
1833
|
|
1809
1834
|
declare namespace BaseEvents {
|
1810
1835
|
export {
|
@@ -4583,7 +4608,7 @@ declare interface DesktopAgent_2 {
|
|
4583
4608
|
* Generated when the desktop icon is clicked while it's already running.
|
4584
4609
|
* @interface
|
4585
4610
|
*/
|
4586
|
-
declare type DesktopIconClickedEvent =
|
4611
|
+
declare type DesktopIconClickedEvent = BaseEvent_9 & {
|
4587
4612
|
type: 'desktop-icon-clicked';
|
4588
4613
|
};
|
4589
4614
|
|
@@ -5127,6 +5152,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
|
|
5127
5152
|
|
5128
5153
|
declare interface Environment {
|
5129
5154
|
initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
|
5155
|
+
applyLayoutSnapshot(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.InitLayoutOptions): Promise<void>;
|
5130
5156
|
createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
|
5131
5157
|
destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
|
5132
5158
|
resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
|
@@ -5168,14 +5194,14 @@ declare type ErrorPlainObject = {
|
|
5168
5194
|
|
5169
5195
|
/**
|
5170
5196
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}. Events are
|
5171
|
-
* discriminated by {@link
|
5197
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
|
5172
5198
|
* under the {@link OpenFin.PlatformEvents} namespace.
|
5173
5199
|
*/
|
5174
5200
|
declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
|
5175
5201
|
|
5176
5202
|
/**
|
5177
5203
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}. Events are
|
5178
|
-
* discriminated by {@link
|
5204
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
|
5179
5205
|
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5180
5206
|
* from which they propagate).
|
5181
5207
|
*/
|
@@ -5183,7 +5209,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
|
|
5183
5209
|
|
5184
5210
|
/**
|
5185
5211
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
|
5186
|
-
* discriminated by {@link
|
5212
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
|
5187
5213
|
* under the {@link OpenFin.ChannelEvents} namespace.
|
5188
5214
|
*/
|
5189
5215
|
declare type Event_2 = {
|
@@ -5192,7 +5218,7 @@ declare type Event_2 = {
|
|
5192
5218
|
|
5193
5219
|
/**
|
5194
5220
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}. Events are
|
5195
|
-
* discriminated by {@link
|
5221
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
|
5196
5222
|
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5197
5223
|
* from which they propagate).
|
5198
5224
|
*/
|
@@ -5200,7 +5226,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
|
|
5200
5226
|
|
5201
5227
|
/**
|
5202
5228
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}. Events are
|
5203
|
-
* discriminated by {@link
|
5229
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
|
5204
5230
|
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5205
5231
|
*/
|
5206
5232
|
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
@@ -5217,21 +5243,21 @@ declare type Event_5<Topic extends string> = {
|
|
5217
5243
|
|
5218
5244
|
/**
|
5219
5245
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
|
5220
|
-
* discriminated by {@link
|
5246
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
|
5221
5247
|
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5222
5248
|
*/
|
5223
5249
|
declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
|
5224
5250
|
|
5225
5251
|
/**
|
5226
5252
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}. Events are
|
5227
|
-
* discriminated by {@link
|
5253
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
5228
5254
|
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
5229
5255
|
*/
|
5230
5256
|
declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
|
5231
5257
|
|
5232
5258
|
/**
|
5233
5259
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}. Events are
|
5234
|
-
* discriminated by {@link
|
5260
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
|
5235
5261
|
* under the {@link OpenFin.FrameEvents} namespace.
|
5236
5262
|
*/
|
5237
5263
|
declare type Event_8 = {
|
@@ -5240,13 +5266,10 @@ declare type Event_8 = {
|
|
5240
5266
|
|
5241
5267
|
/**
|
5242
5268
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}. Events are
|
5243
|
-
* discriminated by {@link
|
5269
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
5244
5270
|
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
5245
5271
|
*/
|
5246
|
-
declare type Event_9 =
|
5247
|
-
topic: 'global-hotkey';
|
5248
|
-
hotkey: 'string';
|
5249
|
-
} & (RegisteredEvent | UnregisteredEvent);
|
5272
|
+
declare type Event_9 = RegisteredEvent | UnregisteredEvent;
|
5250
5273
|
|
5251
5274
|
declare class EventAggregator extends EmitterMap {
|
5252
5275
|
dispatchEvent: (message: Message<any>) => boolean;
|
@@ -6099,6 +6122,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
|
6099
6122
|
|
6100
6123
|
declare namespace GlobalHotkeyEvents {
|
6101
6124
|
export {
|
6125
|
+
BaseEvent_8 as BaseEvent,
|
6102
6126
|
RegisteredEvent,
|
6103
6127
|
UnregisteredEvent,
|
6104
6128
|
Event_9 as Event,
|
@@ -6586,7 +6610,7 @@ declare type IdleEvent = IdleStateChangedEvent;
|
|
6586
6610
|
* A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
|
6587
6611
|
* @interface
|
6588
6612
|
*/
|
6589
|
-
declare type IdleStateChangedEvent =
|
6613
|
+
declare type IdleStateChangedEvent = BaseEvent_9 & {
|
6590
6614
|
type: 'idle-state-changed';
|
6591
6615
|
elapsedTime: number;
|
6592
6616
|
isIdle: boolean;
|
@@ -8617,16 +8641,17 @@ declare type LayoutIdentity = Identity_5 & {
|
|
8617
8641
|
};
|
8618
8642
|
|
8619
8643
|
/**
|
8620
|
-
* Generated
|
8621
|
-
*
|
8644
|
+
* Generated after a layout is created and all of its views have either finished or failed navigation
|
8645
|
+
* once per layout. Does not emit for layouts created using Layout.replace() API.
|
8622
8646
|
* @interface
|
8623
8647
|
*/
|
8624
8648
|
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
8625
8649
|
type: 'layout-initialized';
|
8626
8650
|
layoutIdentity: OpenFin_2.LayoutIdentity;
|
8627
|
-
ofViews:
|
8651
|
+
ofViews: {
|
8652
|
+
identity: OpenFin_2.Identity;
|
8628
8653
|
entityType: 'view';
|
8629
|
-
}
|
8654
|
+
}[];
|
8630
8655
|
};
|
8631
8656
|
|
8632
8657
|
/**
|
@@ -8994,9 +9019,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
8994
9019
|
declare type LayoutReadyEvent = BaseEvent_5 & {
|
8995
9020
|
type: 'layout-ready';
|
8996
9021
|
layoutIdentity: OpenFin_2.LayoutIdentity;
|
8997
|
-
views:
|
9022
|
+
views: {
|
9023
|
+
identity: OpenFin_2.Identity;
|
8998
9024
|
success: boolean;
|
8999
|
-
|
9025
|
+
error?: Error;
|
9026
|
+
}[];
|
9000
9027
|
};
|
9001
9028
|
|
9002
9029
|
/**
|
@@ -9372,7 +9399,7 @@ declare type MonitorInfo = {
|
|
9372
9399
|
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
9373
9400
|
* @interface
|
9374
9401
|
*/
|
9375
|
-
declare type MonitorInfoChangedEvent =
|
9402
|
+
declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin_2.MonitorInfo & {
|
9376
9403
|
type: 'monitor-info-changed';
|
9377
9404
|
};
|
9378
9405
|
|
@@ -10111,7 +10138,7 @@ declare namespace OpenFin_2 {
|
|
10111
10138
|
AppVersionCompleteEvent,
|
10112
10139
|
AppVersionRuntimeStatusEvent,
|
10113
10140
|
Events,
|
10114
|
-
|
10141
|
+
BaseEvent_10 as BaseEvent,
|
10115
10142
|
WebContentsEvent_2 as WebContentsEvent,
|
10116
10143
|
SystemEvent_2 as SystemEvent,
|
10117
10144
|
ApplicationEvent_2 as ApplicationEvent,
|
@@ -12570,7 +12597,7 @@ declare type RectangleByEdgePositions = {
|
|
12570
12597
|
* Generated when a hotkey has been registered with the operating system.
|
12571
12598
|
* @interface
|
12572
12599
|
*/
|
12573
|
-
declare type RegisteredEvent =
|
12600
|
+
declare type RegisteredEvent = BaseEvent_8 & {
|
12574
12601
|
type: 'registered';
|
12575
12602
|
};
|
12576
12603
|
|
@@ -12992,7 +13019,7 @@ declare type ServiceIdentifier = {
|
|
12992
13019
|
* Generated on changes to a user’s local computer session.
|
12993
13020
|
* @interface
|
12994
13021
|
*/
|
12995
|
-
declare type SessionChangedEvent =
|
13022
|
+
declare type SessionChangedEvent = BaseEvent_9 & {
|
12996
13023
|
type: 'session-changed';
|
12997
13024
|
reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
|
12998
13025
|
};
|
@@ -14926,7 +14953,7 @@ declare namespace SystemEvents {
|
|
14926
14953
|
export {
|
14927
14954
|
NotRequested,
|
14928
14955
|
ExcludeRequested,
|
14929
|
-
|
14956
|
+
BaseEvent_9 as BaseEvent,
|
14930
14957
|
IdleStateChangedEvent,
|
14931
14958
|
IdleEvent,
|
14932
14959
|
MonitorInfoChangedEvent,
|
@@ -15404,7 +15431,7 @@ declare interface TypedEventEmitter<Event extends {
|
|
15404
15431
|
* Generated when a hotkey has been unregistered with the operating system.
|
15405
15432
|
* @interface
|
15406
15433
|
*/
|
15407
|
-
declare type UnregisteredEvent =
|
15434
|
+
declare type UnregisteredEvent = BaseEvent_8 & {
|
15408
15435
|
type: 'unregistered';
|
15409
15436
|
};
|
15410
15437
|
|
package/out/mock-public.d.ts
CHANGED
@@ -871,7 +871,7 @@ declare type ApplicationConnectedEvent = ConnectedEvent_2;
|
|
871
871
|
* Generated when an application is created.
|
872
872
|
* @interface
|
873
873
|
*/
|
874
|
-
declare type ApplicationCreatedEvent =
|
874
|
+
declare type ApplicationCreatedEvent = BaseEvent_9 & BaseEvents.IdentityEvent & {
|
875
875
|
type: 'application-created';
|
876
876
|
};
|
877
877
|
|
@@ -1738,13 +1738,30 @@ declare type BaseContentCreationRule = {
|
|
1738
1738
|
/**
|
1739
1739
|
* A base OpenFin event. All OpenFin event payloads extend this type.
|
1740
1740
|
*
|
1741
|
+
* OpenFin events are jointly discriminated by their {@link topic} and {@link type} keys. Within each
|
1742
|
+
* `topic`, the `type` key is unique.
|
1743
|
+
*
|
1741
1744
|
* @interface
|
1742
1745
|
*/
|
1743
1746
|
declare type BaseEvent = {
|
1747
|
+
/**
|
1748
|
+
* The "kebab-case" classname of the {@link OpenFin.Events emitter} that raised the event.
|
1749
|
+
*
|
1750
|
+
* @remarks {@link OpenFin.Frame} is represented as `iframe`.
|
1751
|
+
*/
|
1744
1752
|
topic: string;
|
1753
|
+
/**
|
1754
|
+
* The type of event that was raised. Equal to the typename of the event payload in "kebab case".
|
1755
|
+
*
|
1756
|
+
* @remarks Guaranteed to be unique within each {@link topic}, but can be repeated
|
1757
|
+
* between topics (e.g. {@link OpenFin.WebContentsEvents.CrashedEvent WebContentsEvents.CrashedEvent} and
|
1758
|
+
* {@link OpenFin.ApplicationEvents.CrashedEvent ApplicationEvents.CrashedEvent}).
|
1759
|
+
*/
|
1745
1760
|
type: string;
|
1746
1761
|
};
|
1747
1762
|
|
1763
|
+
declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
|
1764
|
+
|
1748
1765
|
/**
|
1749
1766
|
* A base Channel event.
|
1750
1767
|
* @interface
|
@@ -1797,14 +1814,22 @@ declare type BaseEvent_7 = NamedEvent & {
|
|
1797
1814
|
};
|
1798
1815
|
|
1799
1816
|
/**
|
1800
|
-
* Base type for events emitting on the `
|
1817
|
+
* Base type for events emitting on the `global-hotkey` topic.
|
1818
|
+
*
|
1801
1819
|
* @interface
|
1802
1820
|
*/
|
1803
1821
|
declare type BaseEvent_8 = BaseEvents.BaseEvent & {
|
1804
|
-
topic: '
|
1822
|
+
topic: 'global-hotkey';
|
1823
|
+
hotkey: string;
|
1805
1824
|
};
|
1806
1825
|
|
1807
|
-
|
1826
|
+
/**
|
1827
|
+
* Base type for events emitting on the `system` topic
|
1828
|
+
* @interface
|
1829
|
+
*/
|
1830
|
+
declare type BaseEvent_9 = BaseEvents.BaseEvent & {
|
1831
|
+
topic: 'system';
|
1832
|
+
};
|
1808
1833
|
|
1809
1834
|
declare namespace BaseEvents {
|
1810
1835
|
export {
|
@@ -4583,7 +4608,7 @@ declare interface DesktopAgent_2 {
|
|
4583
4608
|
* Generated when the desktop icon is clicked while it's already running.
|
4584
4609
|
* @interface
|
4585
4610
|
*/
|
4586
|
-
declare type DesktopIconClickedEvent =
|
4611
|
+
declare type DesktopIconClickedEvent = BaseEvent_9 & {
|
4587
4612
|
type: 'desktop-icon-clicked';
|
4588
4613
|
};
|
4589
4614
|
|
@@ -5127,6 +5152,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
|
|
5127
5152
|
|
5128
5153
|
declare interface Environment {
|
5129
5154
|
initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
|
5155
|
+
applyLayoutSnapshot(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.InitLayoutOptions): Promise<void>;
|
5130
5156
|
createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
|
5131
5157
|
destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
|
5132
5158
|
resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
|
@@ -5168,14 +5194,14 @@ declare type ErrorPlainObject = {
|
|
5168
5194
|
|
5169
5195
|
/**
|
5170
5196
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}. Events are
|
5171
|
-
* discriminated by {@link
|
5197
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
|
5172
5198
|
* under the {@link OpenFin.PlatformEvents} namespace.
|
5173
5199
|
*/
|
5174
5200
|
declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
|
5175
5201
|
|
5176
5202
|
/**
|
5177
5203
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}. Events are
|
5178
|
-
* discriminated by {@link
|
5204
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
|
5179
5205
|
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5180
5206
|
* from which they propagate).
|
5181
5207
|
*/
|
@@ -5183,7 +5209,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
|
|
5183
5209
|
|
5184
5210
|
/**
|
5185
5211
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
|
5186
|
-
* discriminated by {@link
|
5212
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
|
5187
5213
|
* under the {@link OpenFin.ChannelEvents} namespace.
|
5188
5214
|
*/
|
5189
5215
|
declare type Event_2 = {
|
@@ -5192,7 +5218,7 @@ declare type Event_2 = {
|
|
5192
5218
|
|
5193
5219
|
/**
|
5194
5220
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}. Events are
|
5195
|
-
* discriminated by {@link
|
5221
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
|
5196
5222
|
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5197
5223
|
* from which they propagate).
|
5198
5224
|
*/
|
@@ -5200,7 +5226,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
|
|
5200
5226
|
|
5201
5227
|
/**
|
5202
5228
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}. Events are
|
5203
|
-
* discriminated by {@link
|
5229
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
|
5204
5230
|
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5205
5231
|
*/
|
5206
5232
|
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
@@ -5217,21 +5243,21 @@ declare type Event_5<Topic extends string> = {
|
|
5217
5243
|
|
5218
5244
|
/**
|
5219
5245
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
|
5220
|
-
* discriminated by {@link
|
5246
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
|
5221
5247
|
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5222
5248
|
*/
|
5223
5249
|
declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
|
5224
5250
|
|
5225
5251
|
/**
|
5226
5252
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}. Events are
|
5227
|
-
* discriminated by {@link
|
5253
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
5228
5254
|
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
5229
5255
|
*/
|
5230
5256
|
declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
|
5231
5257
|
|
5232
5258
|
/**
|
5233
5259
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}. Events are
|
5234
|
-
* discriminated by {@link
|
5260
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
|
5235
5261
|
* under the {@link OpenFin.FrameEvents} namespace.
|
5236
5262
|
*/
|
5237
5263
|
declare type Event_8 = {
|
@@ -5240,13 +5266,10 @@ declare type Event_8 = {
|
|
5240
5266
|
|
5241
5267
|
/**
|
5242
5268
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}. Events are
|
5243
|
-
* discriminated by {@link
|
5269
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
5244
5270
|
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
5245
5271
|
*/
|
5246
|
-
declare type Event_9 =
|
5247
|
-
topic: 'global-hotkey';
|
5248
|
-
hotkey: 'string';
|
5249
|
-
} & (RegisteredEvent | UnregisteredEvent);
|
5272
|
+
declare type Event_9 = RegisteredEvent | UnregisteredEvent;
|
5250
5273
|
|
5251
5274
|
declare class EventAggregator extends EmitterMap {
|
5252
5275
|
dispatchEvent: (message: Message<any>) => boolean;
|
@@ -6099,6 +6122,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
|
6099
6122
|
|
6100
6123
|
declare namespace GlobalHotkeyEvents {
|
6101
6124
|
export {
|
6125
|
+
BaseEvent_8 as BaseEvent,
|
6102
6126
|
RegisteredEvent,
|
6103
6127
|
UnregisteredEvent,
|
6104
6128
|
Event_9 as Event,
|
@@ -6586,7 +6610,7 @@ declare type IdleEvent = IdleStateChangedEvent;
|
|
6586
6610
|
* A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
|
6587
6611
|
* @interface
|
6588
6612
|
*/
|
6589
|
-
declare type IdleStateChangedEvent =
|
6613
|
+
declare type IdleStateChangedEvent = BaseEvent_9 & {
|
6590
6614
|
type: 'idle-state-changed';
|
6591
6615
|
elapsedTime: number;
|
6592
6616
|
isIdle: boolean;
|
@@ -8617,16 +8641,17 @@ declare type LayoutIdentity = Identity_5 & {
|
|
8617
8641
|
};
|
8618
8642
|
|
8619
8643
|
/**
|
8620
|
-
* Generated
|
8621
|
-
*
|
8644
|
+
* Generated after a layout is created and all of its views have either finished or failed navigation
|
8645
|
+
* once per layout. Does not emit for layouts created using Layout.replace() API.
|
8622
8646
|
* @interface
|
8623
8647
|
*/
|
8624
8648
|
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
8625
8649
|
type: 'layout-initialized';
|
8626
8650
|
layoutIdentity: OpenFin_2.LayoutIdentity;
|
8627
|
-
ofViews:
|
8651
|
+
ofViews: {
|
8652
|
+
identity: OpenFin_2.Identity;
|
8628
8653
|
entityType: 'view';
|
8629
|
-
}
|
8654
|
+
}[];
|
8630
8655
|
};
|
8631
8656
|
|
8632
8657
|
/**
|
@@ -8994,9 +9019,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
8994
9019
|
declare type LayoutReadyEvent = BaseEvent_5 & {
|
8995
9020
|
type: 'layout-ready';
|
8996
9021
|
layoutIdentity: OpenFin_2.LayoutIdentity;
|
8997
|
-
views:
|
9022
|
+
views: {
|
9023
|
+
identity: OpenFin_2.Identity;
|
8998
9024
|
success: boolean;
|
8999
|
-
|
9025
|
+
error?: Error;
|
9026
|
+
}[];
|
9000
9027
|
};
|
9001
9028
|
|
9002
9029
|
/**
|
@@ -9372,7 +9399,7 @@ declare type MonitorInfo = {
|
|
9372
9399
|
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
9373
9400
|
* @interface
|
9374
9401
|
*/
|
9375
|
-
declare type MonitorInfoChangedEvent =
|
9402
|
+
declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin_2.MonitorInfo & {
|
9376
9403
|
type: 'monitor-info-changed';
|
9377
9404
|
};
|
9378
9405
|
|
@@ -10111,7 +10138,7 @@ declare namespace OpenFin_2 {
|
|
10111
10138
|
AppVersionCompleteEvent,
|
10112
10139
|
AppVersionRuntimeStatusEvent,
|
10113
10140
|
Events,
|
10114
|
-
|
10141
|
+
BaseEvent_10 as BaseEvent,
|
10115
10142
|
WebContentsEvent_2 as WebContentsEvent,
|
10116
10143
|
SystemEvent_2 as SystemEvent,
|
10117
10144
|
ApplicationEvent_2 as ApplicationEvent,
|
@@ -12570,7 +12597,7 @@ declare type RectangleByEdgePositions = {
|
|
12570
12597
|
* Generated when a hotkey has been registered with the operating system.
|
12571
12598
|
* @interface
|
12572
12599
|
*/
|
12573
|
-
declare type RegisteredEvent =
|
12600
|
+
declare type RegisteredEvent = BaseEvent_8 & {
|
12574
12601
|
type: 'registered';
|
12575
12602
|
};
|
12576
12603
|
|
@@ -12992,7 +13019,7 @@ declare type ServiceIdentifier = {
|
|
12992
13019
|
* Generated on changes to a user’s local computer session.
|
12993
13020
|
* @interface
|
12994
13021
|
*/
|
12995
|
-
declare type SessionChangedEvent =
|
13022
|
+
declare type SessionChangedEvent = BaseEvent_9 & {
|
12996
13023
|
type: 'session-changed';
|
12997
13024
|
reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
|
12998
13025
|
};
|
@@ -14926,7 +14953,7 @@ declare namespace SystemEvents {
|
|
14926
14953
|
export {
|
14927
14954
|
NotRequested,
|
14928
14955
|
ExcludeRequested,
|
14929
|
-
|
14956
|
+
BaseEvent_9 as BaseEvent,
|
14930
14957
|
IdleStateChangedEvent,
|
14931
14958
|
IdleEvent,
|
14932
14959
|
MonitorInfoChangedEvent,
|
@@ -15404,7 +15431,7 @@ declare interface TypedEventEmitter<Event extends {
|
|
15404
15431
|
* Generated when a hotkey has been unregistered with the operating system.
|
15405
15432
|
* @interface
|
15406
15433
|
*/
|
15407
|
-
declare type UnregisteredEvent =
|
15434
|
+
declare type UnregisteredEvent = BaseEvent_8 & {
|
15408
15435
|
type: 'unregistered';
|
15409
15436
|
};
|
15410
15437
|
|
package/out/mock.d.ts
CHANGED
@@ -877,7 +877,7 @@ declare type ApplicationConnectedEvent = ConnectedEvent_2;
|
|
877
877
|
* Generated when an application is created.
|
878
878
|
* @interface
|
879
879
|
*/
|
880
|
-
declare type ApplicationCreatedEvent =
|
880
|
+
declare type ApplicationCreatedEvent = BaseEvent_9 & BaseEvents.IdentityEvent & {
|
881
881
|
type: 'application-created';
|
882
882
|
};
|
883
883
|
|
@@ -1758,13 +1758,30 @@ declare type BaseContentCreationRule = {
|
|
1758
1758
|
/**
|
1759
1759
|
* A base OpenFin event. All OpenFin event payloads extend this type.
|
1760
1760
|
*
|
1761
|
+
* OpenFin events are jointly discriminated by their {@link topic} and {@link type} keys. Within each
|
1762
|
+
* `topic`, the `type` key is unique.
|
1763
|
+
*
|
1761
1764
|
* @interface
|
1762
1765
|
*/
|
1763
1766
|
declare type BaseEvent = {
|
1767
|
+
/**
|
1768
|
+
* The "kebab-case" classname of the {@link OpenFin.Events emitter} that raised the event.
|
1769
|
+
*
|
1770
|
+
* @remarks {@link OpenFin.Frame} is represented as `iframe`.
|
1771
|
+
*/
|
1764
1772
|
topic: string;
|
1773
|
+
/**
|
1774
|
+
* The type of event that was raised. Equal to the typename of the event payload in "kebab case".
|
1775
|
+
*
|
1776
|
+
* @remarks Guaranteed to be unique within each {@link topic}, but can be repeated
|
1777
|
+
* between topics (e.g. {@link OpenFin.WebContentsEvents.CrashedEvent WebContentsEvents.CrashedEvent} and
|
1778
|
+
* {@link OpenFin.ApplicationEvents.CrashedEvent ApplicationEvents.CrashedEvent}).
|
1779
|
+
*/
|
1765
1780
|
type: string;
|
1766
1781
|
};
|
1767
1782
|
|
1783
|
+
declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
|
1784
|
+
|
1768
1785
|
/**
|
1769
1786
|
* A base Channel event.
|
1770
1787
|
* @interface
|
@@ -1817,14 +1834,22 @@ declare type BaseEvent_7 = NamedEvent & {
|
|
1817
1834
|
};
|
1818
1835
|
|
1819
1836
|
/**
|
1820
|
-
* Base type for events emitting on the `
|
1837
|
+
* Base type for events emitting on the `global-hotkey` topic.
|
1838
|
+
*
|
1821
1839
|
* @interface
|
1822
1840
|
*/
|
1823
1841
|
declare type BaseEvent_8 = BaseEvents.BaseEvent & {
|
1824
|
-
topic: '
|
1842
|
+
topic: 'global-hotkey';
|
1843
|
+
hotkey: string;
|
1825
1844
|
};
|
1826
1845
|
|
1827
|
-
|
1846
|
+
/**
|
1847
|
+
* Base type for events emitting on the `system` topic
|
1848
|
+
* @interface
|
1849
|
+
*/
|
1850
|
+
declare type BaseEvent_9 = BaseEvents.BaseEvent & {
|
1851
|
+
topic: 'system';
|
1852
|
+
};
|
1828
1853
|
|
1829
1854
|
declare namespace BaseEvents {
|
1830
1855
|
export {
|
@@ -4626,7 +4651,7 @@ declare interface DesktopAgent_2 {
|
|
4626
4651
|
* Generated when the desktop icon is clicked while it's already running.
|
4627
4652
|
* @interface
|
4628
4653
|
*/
|
4629
|
-
declare type DesktopIconClickedEvent =
|
4654
|
+
declare type DesktopIconClickedEvent = BaseEvent_9 & {
|
4630
4655
|
type: 'desktop-icon-clicked';
|
4631
4656
|
};
|
4632
4657
|
|
@@ -5175,6 +5200,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
|
|
5175
5200
|
|
5176
5201
|
declare interface Environment {
|
5177
5202
|
initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
|
5203
|
+
applyLayoutSnapshot(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.InitLayoutOptions): Promise<void>;
|
5178
5204
|
createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
|
5179
5205
|
destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
|
5180
5206
|
resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
|
@@ -5216,14 +5242,14 @@ declare type ErrorPlainObject = {
|
|
5216
5242
|
|
5217
5243
|
/**
|
5218
5244
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Platform}. Events are
|
5219
|
-
* discriminated by {@link
|
5245
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
|
5220
5246
|
* under the {@link OpenFin.PlatformEvents} namespace.
|
5221
5247
|
*/
|
5222
5248
|
declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
|
5223
5249
|
|
5224
5250
|
/**
|
5225
5251
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}. Events are
|
5226
|
-
* discriminated by {@link
|
5252
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
|
5227
5253
|
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5228
5254
|
* from which they propagate).
|
5229
5255
|
*/
|
@@ -5231,7 +5257,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
|
|
5231
5257
|
|
5232
5258
|
/**
|
5233
5259
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
|
5234
|
-
* discriminated by {@link
|
5260
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
|
5235
5261
|
* under the {@link OpenFin.ChannelEvents} namespace.
|
5236
5262
|
*/
|
5237
5263
|
declare type Event_2 = {
|
@@ -5240,7 +5266,7 @@ declare type Event_2 = {
|
|
5240
5266
|
|
5241
5267
|
/**
|
5242
5268
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}. Events are
|
5243
|
-
* discriminated by {@link
|
5269
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
|
5244
5270
|
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5245
5271
|
* from which they propagate).
|
5246
5272
|
*/
|
@@ -5248,7 +5274,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
|
|
5248
5274
|
|
5249
5275
|
/**
|
5250
5276
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link View}. Events are
|
5251
|
-
* discriminated by {@link
|
5277
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
|
5252
5278
|
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5253
5279
|
*/
|
5254
5280
|
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
@@ -5265,21 +5291,21 @@ declare type Event_5<Topic extends string> = {
|
|
5265
5291
|
|
5266
5292
|
/**
|
5267
5293
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
|
5268
|
-
* discriminated by {@link
|
5294
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
|
5269
5295
|
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5270
5296
|
*/
|
5271
5297
|
declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
|
5272
5298
|
|
5273
5299
|
/**
|
5274
5300
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link ExternalApplication}. Events are
|
5275
|
-
* discriminated by {@link
|
5301
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
5276
5302
|
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
5277
5303
|
*/
|
5278
5304
|
declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
|
5279
5305
|
|
5280
5306
|
/**
|
5281
5307
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link _Frame}. Events are
|
5282
|
-
* discriminated by {@link
|
5308
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
|
5283
5309
|
* under the {@link OpenFin.FrameEvents} namespace.
|
5284
5310
|
*/
|
5285
5311
|
declare type Event_8 = {
|
@@ -5288,13 +5314,10 @@ declare type Event_8 = {
|
|
5288
5314
|
|
5289
5315
|
/**
|
5290
5316
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by {@link GlobalHotkey}. Events are
|
5291
|
-
* discriminated by {@link
|
5317
|
+
* discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
5292
5318
|
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
5293
5319
|
*/
|
5294
|
-
declare type Event_9 =
|
5295
|
-
topic: 'global-hotkey';
|
5296
|
-
hotkey: 'string';
|
5297
|
-
} & (RegisteredEvent | UnregisteredEvent);
|
5320
|
+
declare type Event_9 = RegisteredEvent | UnregisteredEvent;
|
5298
5321
|
|
5299
5322
|
declare class EventAggregator extends EmitterMap {
|
5300
5323
|
dispatchEvent: (message: Message<any>) => boolean;
|
@@ -6174,6 +6197,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
|
6174
6197
|
|
6175
6198
|
declare namespace GlobalHotkeyEvents {
|
6176
6199
|
export {
|
6200
|
+
BaseEvent_8 as BaseEvent,
|
6177
6201
|
RegisteredEvent,
|
6178
6202
|
UnregisteredEvent,
|
6179
6203
|
Event_9 as Event,
|
@@ -6664,7 +6688,7 @@ declare type IdleEvent = IdleStateChangedEvent;
|
|
6664
6688
|
* A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
|
6665
6689
|
* @interface
|
6666
6690
|
*/
|
6667
|
-
declare type IdleStateChangedEvent =
|
6691
|
+
declare type IdleStateChangedEvent = BaseEvent_9 & {
|
6668
6692
|
type: 'idle-state-changed';
|
6669
6693
|
elapsedTime: number;
|
6670
6694
|
isIdle: boolean;
|
@@ -8724,16 +8748,17 @@ declare type LayoutIdentity = Identity_5 & {
|
|
8724
8748
|
};
|
8725
8749
|
|
8726
8750
|
/**
|
8727
|
-
* Generated
|
8728
|
-
*
|
8751
|
+
* Generated after a layout is created and all of its views have either finished or failed navigation
|
8752
|
+
* once per layout. Does not emit for layouts created using Layout.replace() API.
|
8729
8753
|
* @interface
|
8730
8754
|
*/
|
8731
8755
|
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
8732
8756
|
type: 'layout-initialized';
|
8733
8757
|
layoutIdentity: OpenFin_2.LayoutIdentity;
|
8734
|
-
ofViews:
|
8758
|
+
ofViews: {
|
8759
|
+
identity: OpenFin_2.Identity;
|
8735
8760
|
entityType: 'view';
|
8736
|
-
}
|
8761
|
+
}[];
|
8737
8762
|
};
|
8738
8763
|
|
8739
8764
|
/**
|
@@ -9271,9 +9296,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
9271
9296
|
declare type LayoutReadyEvent = BaseEvent_5 & {
|
9272
9297
|
type: 'layout-ready';
|
9273
9298
|
layoutIdentity: OpenFin_2.LayoutIdentity;
|
9274
|
-
views:
|
9299
|
+
views: {
|
9300
|
+
identity: OpenFin_2.Identity;
|
9275
9301
|
success: boolean;
|
9276
|
-
|
9302
|
+
error?: Error;
|
9303
|
+
}[];
|
9277
9304
|
};
|
9278
9305
|
|
9279
9306
|
/**
|
@@ -9649,7 +9676,7 @@ declare type MonitorInfo = {
|
|
9649
9676
|
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
9650
9677
|
* @interface
|
9651
9678
|
*/
|
9652
|
-
declare type MonitorInfoChangedEvent =
|
9679
|
+
declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin_2.MonitorInfo & {
|
9653
9680
|
type: 'monitor-info-changed';
|
9654
9681
|
};
|
9655
9682
|
|
@@ -10410,7 +10437,7 @@ declare namespace OpenFin_2 {
|
|
10410
10437
|
AppVersionCompleteEvent,
|
10411
10438
|
AppVersionRuntimeStatusEvent,
|
10412
10439
|
Events,
|
10413
|
-
|
10440
|
+
BaseEvent_10 as BaseEvent,
|
10414
10441
|
WebContentsEvent_2 as WebContentsEvent,
|
10415
10442
|
SystemEvent_2 as SystemEvent,
|
10416
10443
|
ApplicationEvent_2 as ApplicationEvent,
|
@@ -12947,7 +12974,7 @@ declare type RectangleByEdgePositions = {
|
|
12947
12974
|
* Generated when a hotkey has been registered with the operating system.
|
12948
12975
|
* @interface
|
12949
12976
|
*/
|
12950
|
-
declare type RegisteredEvent =
|
12977
|
+
declare type RegisteredEvent = BaseEvent_8 & {
|
12951
12978
|
type: 'registered';
|
12952
12979
|
};
|
12953
12980
|
|
@@ -13369,7 +13396,7 @@ declare type ServiceIdentifier = {
|
|
13369
13396
|
* Generated on changes to a user’s local computer session.
|
13370
13397
|
* @interface
|
13371
13398
|
*/
|
13372
|
-
declare type SessionChangedEvent =
|
13399
|
+
declare type SessionChangedEvent = BaseEvent_9 & {
|
13373
13400
|
type: 'session-changed';
|
13374
13401
|
reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
|
13375
13402
|
};
|
@@ -15309,7 +15336,7 @@ declare namespace SystemEvents {
|
|
15309
15336
|
export {
|
15310
15337
|
NotRequested,
|
15311
15338
|
ExcludeRequested,
|
15312
|
-
|
15339
|
+
BaseEvent_9 as BaseEvent,
|
15313
15340
|
IdleStateChangedEvent,
|
15314
15341
|
IdleEvent,
|
15315
15342
|
MonitorInfoChangedEvent,
|
@@ -15395,7 +15422,7 @@ declare type SystemProcessInfo = {
|
|
15395
15422
|
* Generated when system shutdown or log off.
|
15396
15423
|
* @internal
|
15397
15424
|
*/
|
15398
|
-
declare type SystemShutdownEvent =
|
15425
|
+
declare type SystemShutdownEvent = BaseEvent_9 & {
|
15399
15426
|
type: 'system-shutdown';
|
15400
15427
|
};
|
15401
15428
|
|
@@ -15794,7 +15821,7 @@ declare interface TypedEventEmitter<Event extends {
|
|
15794
15821
|
* Generated when a hotkey has been unregistered with the operating system.
|
15795
15822
|
* @interface
|
15796
15823
|
*/
|
15797
|
-
declare type UnregisteredEvent =
|
15824
|
+
declare type UnregisteredEvent = BaseEvent_8 & {
|
15798
15825
|
type: 'unregistered';
|
15799
15826
|
};
|
15800
15827
|
|
package/out/mock.js
CHANGED
@@ -65,6 +65,16 @@ Object.defineProperty(frame$1, "__esModule", { value: true });
|
|
65
65
|
|
66
66
|
var globalHotkey$1 = {};
|
67
67
|
|
68
|
+
/**
|
69
|
+
*
|
70
|
+
* Namespace for events that can be transmitted by {@link GlobalHotkey.GlobalHotkey}.
|
71
|
+
*
|
72
|
+
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
73
|
+
*
|
74
|
+
* For a list of valid string keys for global hotkey events, see {@link GlobalHotkey.GlobalHotkey.on GlobalHotkey.on}.
|
75
|
+
*
|
76
|
+
* @packageDocumentation
|
77
|
+
*/
|
68
78
|
Object.defineProperty(globalHotkey$1, "__esModule", { value: true });
|
69
79
|
|
70
80
|
var platform$1 = {};
|
@@ -129,12 +139,9 @@ var webcontents = {};
|
|
129
139
|
* Namespace for events shared by all OpenFin WebContents elements (i.e. {@link OpenFin.Window},
|
130
140
|
* {@link OpenFin.View}).
|
131
141
|
*
|
132
|
-
* WebContents events
|
133
|
-
* will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
|
142
|
+
* WebContents events will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
|
134
143
|
* parent window, and propagating events in a window will also be emitted on the window's parent {@link OpenFin.Application}.
|
135
144
|
*
|
136
|
-
* Non-propagating events will not re-emit on parent entities.
|
137
|
-
*
|
138
145
|
* @packageDocumentation
|
139
146
|
*/
|
140
147
|
Object.defineProperty(webcontents, "__esModule", { value: true });
|
@@ -12019,24 +12026,16 @@ class LayoutModule extends base_1$5.Base {
|
|
12019
12026
|
throw new Error('Layout.init was already called, please use Layout.create to add additional layouts.');
|
12020
12027
|
}
|
12021
12028
|
__classPrivateFieldSet$4(this, _LayoutModule_layoutInitializationAttempted, true, "f");
|
12029
|
+
// preload the client
|
12030
|
+
await this.fin.Platform.getCurrentSync().getClient();
|
12022
12031
|
__classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayoutManager(this.fin, this.wire, options), "f");
|
12023
|
-
|
12024
|
-
const platformClient = await this.fin.Platform.getCurrentSync().getClient();
|
12025
|
-
const snapshot = await platformClient.dispatch('get-initial-layout-snapshot');
|
12026
|
-
await __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").applyLayoutSnapshot(snapshot);
|
12032
|
+
await this.wire.environment.applyLayoutSnapshot(this.fin, __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), options);
|
12027
12033
|
if (!options.layoutManagerOverride) {
|
12028
12034
|
// in single-layout case, we return the undocumented layoutManager type (deprecate with CORE-1081)
|
12029
12035
|
const layoutIdentity = { layoutName: layout_constants_1.DEFAULT_LAYOUT_KEY, ...this.fin.me.identity };
|
12030
12036
|
const layoutManager = await this.wire.environment.resolveLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
|
12031
12037
|
return Object.assign(this.wrapSync(layoutIdentity), { layoutManager });
|
12032
12038
|
}
|
12033
|
-
// warn user if they do not call create() in the next 30 seconds
|
12034
|
-
setTimeout(() => {
|
12035
|
-
if (__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f")?.size() === 0) {
|
12036
|
-
console.warn(`[Layout.init] Layout.init was called 30s ago, but no layouts have been created yet. Make sure you ` +
|
12037
|
-
`override LayoutManager.applyLayoutSnapshot, and then call fin.Platform.Layout.create()`);
|
12038
|
-
}
|
12039
|
-
}, 30000);
|
12040
12039
|
return this.wrapSync(this.fin.me.identity);
|
12041
12040
|
};
|
12042
12041
|
/**
|
@@ -15071,42 +15070,49 @@ class InteropClient extends base_1$2.Base {
|
|
15071
15070
|
InteropClient$1.InteropClient = InteropClient;
|
15072
15071
|
_InteropClient_clientPromise = new WeakMap(), _InteropClient_sessionContextGroups = new WeakMap();
|
15073
15072
|
|
15074
|
-
var overrideCheck
|
15073
|
+
var overrideCheck = {};
|
15075
15074
|
|
15076
|
-
|
15077
|
-
|
15078
|
-
|
15079
|
-
|
15080
|
-
|
15081
|
-
|
15082
|
-
|
15083
|
-
|
15084
|
-
function
|
15085
|
-
|
15086
|
-
|
15087
|
-
|
15088
|
-
|
15089
|
-
|
15090
|
-
|
15091
|
-
|
15092
|
-
|
15093
|
-
|
15094
|
-
|
15095
|
-
|
15096
|
-
|
15097
|
-
|
15098
|
-
|
15099
|
-
|
15100
|
-
|
15101
|
-
|
15102
|
-
|
15103
|
-
|
15104
|
-
|
15105
|
-
|
15106
|
-
|
15107
|
-
|
15075
|
+
var hasRequiredOverrideCheck;
|
15076
|
+
|
15077
|
+
function requireOverrideCheck () {
|
15078
|
+
if (hasRequiredOverrideCheck) return overrideCheck;
|
15079
|
+
hasRequiredOverrideCheck = 1;
|
15080
|
+
Object.defineProperty(overrideCheck, "__esModule", { value: true });
|
15081
|
+
overrideCheck.overrideCheck = overrideCheck.checkFDC32Overrides = overrideCheck.getDefaultViewFdc3VersionFromAppInfo = void 0;
|
15082
|
+
const InteropBroker_1 = requireInteropBroker();
|
15083
|
+
function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }) {
|
15084
|
+
const setVersion = manifest.platform?.defaultViewOptions?.fdc3InteropApi ?? initialOptions.defaultViewOptions?.fdc3InteropApi;
|
15085
|
+
return ['1.2', '2.0'].includes(setVersion ?? '') ? setVersion : undefined;
|
15086
|
+
}
|
15087
|
+
overrideCheck.getDefaultViewFdc3VersionFromAppInfo = getDefaultViewFdc3VersionFromAppInfo;
|
15088
|
+
function checkFDC32Overrides(overriddenBroker) {
|
15089
|
+
// These are the APIs that must be overridden for FDC3 2.0 compliance
|
15090
|
+
const mustOverrideAPIs = [
|
15091
|
+
'fdc3HandleFindInstances',
|
15092
|
+
'handleInfoForIntent',
|
15093
|
+
'handleInfoForIntentsByContext',
|
15094
|
+
'fdc3HandleGetAppMetadata',
|
15095
|
+
'fdc3HandleGetInfo',
|
15096
|
+
'fdc3HandleOpen',
|
15097
|
+
'handleFiredIntent',
|
15098
|
+
'handleFiredIntentForContext'
|
15099
|
+
];
|
15100
|
+
return mustOverrideAPIs.filter((api) => {
|
15101
|
+
return overriddenBroker[api] === InteropBroker_1.InteropBroker.prototype[api];
|
15102
|
+
});
|
15103
|
+
}
|
15104
|
+
overrideCheck.checkFDC32Overrides = checkFDC32Overrides;
|
15105
|
+
function overrideCheck$1(overriddenBroker, fdc3InteropApi) {
|
15106
|
+
if (fdc3InteropApi && fdc3InteropApi === '2.0') {
|
15107
|
+
const notOverridden = checkFDC32Overrides(overriddenBroker);
|
15108
|
+
if (notOverridden.length > 0) {
|
15109
|
+
console.warn(`WARNING: FDC3 2.0 has been set as a default option for Views in this Platform, but the required InteropBroker APIs for FDC3 2.0 compliance have not all been overridden.\nThe following APIs need to be overridden:\n${notOverridden.join('\n')}`);
|
15110
|
+
}
|
15111
|
+
}
|
15112
|
+
}
|
15113
|
+
overrideCheck.overrideCheck = overrideCheck$1;
|
15114
|
+
return overrideCheck;
|
15108
15115
|
}
|
15109
|
-
overrideCheck$1.overrideCheck = overrideCheck;
|
15110
15116
|
|
15111
15117
|
var hasRequiredFactory;
|
15112
15118
|
|
@@ -15120,7 +15126,7 @@ function requireFactory () {
|
|
15120
15126
|
const base_1 = base;
|
15121
15127
|
const InteropBroker_1 = requireInteropBroker();
|
15122
15128
|
const InteropClient_1 = InteropClient$1;
|
15123
|
-
const overrideCheck_1 =
|
15129
|
+
const overrideCheck_1 = requireOverrideCheck();
|
15124
15130
|
const common_utils_1 = commonUtils;
|
15125
15131
|
const defaultOverride = (Class) => new Class();
|
15126
15132
|
const BrokerParamAccessError = 'You have attempted to use or modify InteropBroker parameters, which is not allowed. You are likely using an older InteropBroker override scheme. Please consult our Interop docs for guidance on migrating to the new override scheme.';
|
@@ -15945,6 +15951,9 @@ class MockEnvironment {
|
|
15945
15951
|
initLayoutManager() {
|
15946
15952
|
throw new Error(me_1.environmentUnsupportedMessage);
|
15947
15953
|
}
|
15954
|
+
applyLayoutSnapshot() {
|
15955
|
+
throw new Error(me_1.environmentUnsupportedMessage);
|
15956
|
+
}
|
15948
15957
|
async createLayout() {
|
15949
15958
|
throw new Error(me_1.environmentUnsupportedMessage);
|
15950
15959
|
}
|