@openfin/core 36.79.5 → 36.79.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/out/mock.d.ts CHANGED
@@ -97,7 +97,10 @@ declare type Api = {
97
97
  enableDeprecatedSharedName?: boolean;
98
98
  };
99
99
  /**
100
- * Prevent fin API injection. If 'none', `fin` won't be available in this context.
100
+ * Configure injection of the `fin` API in this context.
101
+ *
102
+ * * 'none': The `fin` API will be not available in this context.
103
+ * * 'global': The entire `fin` API will be available in this context.
101
104
  */
102
105
  fin?: InjectionType;
103
106
  };
@@ -113,8 +116,18 @@ declare type ApiClient<T extends Record<any, any>> = {
113
116
 
114
117
  /**
115
118
  * @interface
119
+ *
120
+ * Rules for domain-conditional `fin` API injection.
116
121
  */
117
122
  declare type ApiInjection = {
123
+ /**
124
+ * Injection setting for the `fin` API for contexts on a matched domain.
125
+ *
126
+ * * 'none': The `fin` API will be not available.
127
+ * * 'global': The entire `fin` API will be available.
128
+ *
129
+ * @defaultValue 'global'
130
+ */
118
131
  fin: InjectionType;
119
132
  };
120
133
 
@@ -864,7 +877,7 @@ declare type ApplicationConnectedEvent = ConnectedEvent_2;
864
877
  * Generated when an application is created.
865
878
  * @interface
866
879
  */
867
- declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
880
+ declare type ApplicationCreatedEvent = BaseEvent_9 & BaseEvents.IdentityEvent & {
868
881
  type: 'application-created';
869
882
  };
870
883
 
@@ -1732,7 +1745,7 @@ declare type BaseConfig = {
1732
1745
  */
1733
1746
  declare type BaseContentCreationRule = {
1734
1747
  /**
1735
- * List of [match patterns](https://developer.chrome.com/extensions/match_patterns) that indicate the specified
1748
+ * List of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) that indicate the specified
1736
1749
  * behavior should be used
1737
1750
  */
1738
1751
  match: MatchPattern[];
@@ -1745,13 +1758,30 @@ declare type BaseContentCreationRule = {
1745
1758
  /**
1746
1759
  * A base OpenFin event. All OpenFin event payloads extend this type.
1747
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
+ *
1748
1764
  * @interface
1749
1765
  */
1750
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
+ */
1751
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
+ */
1752
1780
  type: string;
1753
1781
  };
1754
1782
 
1783
+ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1784
+
1755
1785
  /**
1756
1786
  * A base Channel event.
1757
1787
  * @interface
@@ -1804,14 +1834,22 @@ declare type BaseEvent_7 = NamedEvent & {
1804
1834
  };
1805
1835
 
1806
1836
  /**
1807
- * Base type for events emitting on the `system` topic
1837
+ * Base type for events emitting on the `global-hotkey` topic.
1838
+ *
1808
1839
  * @interface
1809
1840
  */
1810
1841
  declare type BaseEvent_8 = BaseEvents.BaseEvent & {
1811
- topic: 'system';
1842
+ topic: 'global-hotkey';
1843
+ hotkey: string;
1812
1844
  };
1813
1845
 
1814
- declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
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
+ };
1815
1853
 
1816
1854
  declare namespace BaseEvents {
1817
1855
  export {
@@ -3651,13 +3689,13 @@ declare type ConstWindowOptions = {
3651
3689
  /**
3652
3690
  * Restrict navigation to URLs that match an allowed pattern.
3653
3691
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
3654
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3692
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3655
3693
  */
3656
3694
  contentNavigation: ContentNavigation;
3657
3695
  /**
3658
3696
  * Restrict redirects to URLs that match an allowed pattern.
3659
3697
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
3660
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3698
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3661
3699
  */
3662
3700
  contentRedirect: Partial<ContentRedirect>;
3663
3701
  /**
@@ -4202,7 +4240,7 @@ declare interface ContentItem extends EventEmitter_2 {
4202
4240
  /**
4203
4241
  * Restrict navigation to URLs that match an allowed pattern.
4204
4242
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4205
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4243
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4206
4244
  *
4207
4245
  * @interface
4208
4246
  */
@@ -4211,7 +4249,7 @@ declare type ContentNavigation = NavigationRules;
4211
4249
  /**
4212
4250
  * Restrict redirects to URLs that match an allowed pattern.
4213
4251
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4214
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4252
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4215
4253
  *
4216
4254
  * @interface
4217
4255
  */
@@ -4613,7 +4651,7 @@ declare interface DesktopAgent_2 {
4613
4651
  * Generated when the desktop icon is clicked while it's already running.
4614
4652
  * @interface
4615
4653
  */
4616
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4654
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4617
4655
  type: 'desktop-icon-clicked';
4618
4656
  };
4619
4657
 
@@ -4815,19 +4853,42 @@ declare type DisplayMetadata_3 = {
4815
4853
 
4816
4854
  /**
4817
4855
  * @interface
4818
- * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
4856
+ * Defines application settings that vary by the domain of the current context.
4857
+ *
4858
+ * @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
4859
+ * domain should be represented with a single rule.
4819
4860
  */
4820
4861
  declare type DomainSettings = {
4862
+ /**
4863
+ * {@inheritDoc DomainSettingsRule}
4864
+ */
4821
4865
  rules: DomainSettingsRule[];
4822
4866
  };
4823
4867
 
4824
4868
  /**
4825
4869
  * @interface
4870
+ *
4871
+ * Defines domain-conditional settings for an OpenFin application.
4826
4872
  */
4827
4873
  declare type DomainSettingsRule = {
4874
+ /**
4875
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4876
+ * the domain(s) for which the rule applies.
4877
+ */
4828
4878
  match: string[];
4879
+ /**
4880
+ * Settings applied when a webcontents has been navigated to a matched domain.
4881
+ */
4829
4882
  options: {
4883
+ /**
4884
+ * {@inheritDoc FileDownloadSettings}
4885
+ *
4886
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
4887
+ */
4830
4888
  downloadSettings?: FileDownloadSettings;
4889
+ /**
4890
+ * {@inheritDoc ApiInjection}
4891
+ */
4831
4892
  api?: ApiInjection;
4832
4893
  };
4833
4894
  };
@@ -4866,9 +4927,20 @@ declare type DownloadPreloadOption = {
4866
4927
 
4867
4928
  /**
4868
4929
  * @interface
4930
+ *
4931
+ * A rule governing domain-conditional download behavior.
4869
4932
  */
4870
4933
  declare type DownloadRule = {
4934
+ /**
4935
+ * {@inheritDoc FileDownloadBehaviorNames}
4936
+ */
4871
4937
  behavior: FileDownloadBehaviorNames;
4938
+ /**
4939
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4940
+ * the domain(s) for which the rule applies.
4941
+ *
4942
+ * @remarks The match is evaluated against the URL of the *download*.
4943
+ */
4872
4944
  match: string[];
4873
4945
  };
4874
4946
 
@@ -5128,6 +5200,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5128
5200
 
5129
5201
  declare interface Environment {
5130
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>;
5131
5204
  createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
5132
5205
  destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
5133
5206
  resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
@@ -5169,14 +5242,14 @@ declare type ErrorPlainObject = {
5169
5242
 
5170
5243
  /**
5171
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
5172
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5245
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5173
5246
  * under the {@link OpenFin.PlatformEvents} namespace.
5174
5247
  */
5175
5248
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5176
5249
 
5177
5250
  /**
5178
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
5179
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5252
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5180
5253
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5181
5254
  * from which they propagate).
5182
5255
  */
@@ -5184,7 +5257,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5184
5257
 
5185
5258
  /**
5186
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
5187
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5260
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5188
5261
  * under the {@link OpenFin.ChannelEvents} namespace.
5189
5262
  */
5190
5263
  declare type Event_2 = {
@@ -5193,7 +5266,7 @@ declare type Event_2 = {
5193
5266
 
5194
5267
  /**
5195
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
5196
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5269
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5197
5270
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5198
5271
  * from which they propagate).
5199
5272
  */
@@ -5201,7 +5274,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5201
5274
 
5202
5275
  /**
5203
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
5204
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5277
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5205
5278
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5206
5279
  */
5207
5280
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5218,21 +5291,21 @@ declare type Event_5<Topic extends string> = {
5218
5291
 
5219
5292
  /**
5220
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
5221
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5294
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5222
5295
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5223
5296
  */
5224
5297
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5225
5298
 
5226
5299
  /**
5227
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
5228
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5301
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5229
5302
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5230
5303
  */
5231
5304
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5232
5305
 
5233
5306
  /**
5234
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
5235
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5308
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5236
5309
  * under the {@link OpenFin.FrameEvents} namespace.
5237
5310
  */
5238
5311
  declare type Event_8 = {
@@ -5241,13 +5314,10 @@ declare type Event_8 = {
5241
5314
 
5242
5315
  /**
5243
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
5244
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5317
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5245
5318
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5246
5319
  */
5247
- declare type Event_9 = {
5248
- topic: 'global-hotkey';
5249
- hotkey: 'string';
5250
- } & (RegisteredEvent | UnregisteredEvent);
5320
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5251
5321
 
5252
5322
  declare class EventAggregator extends EmitterMap {
5253
5323
  dispatchEvent: (message: Message<any>) => boolean;
@@ -5590,6 +5660,9 @@ declare type FetchManifestPayload = {
5590
5660
  manifestUrl: string;
5591
5661
  };
5592
5662
 
5663
+ /**
5664
+ * Whether file downloads raise a user prompt.
5665
+ */
5593
5666
  declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5594
5667
 
5595
5668
  /**
@@ -5672,9 +5745,14 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5672
5745
  };
5673
5746
 
5674
5747
  /**
5675
- * @interface
5748
+ * Domain-conditional rules for file downloads.
5749
+ *
5750
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5676
5751
  */
5677
5752
  declare type FileDownloadSettings = {
5753
+ /**
5754
+ * {@inheritDoc DownloadRule}
5755
+ */
5678
5756
  rules: DownloadRule[];
5679
5757
  };
5680
5758
 
@@ -6119,6 +6197,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6119
6197
 
6120
6198
  declare namespace GlobalHotkeyEvents {
6121
6199
  export {
6200
+ BaseEvent_8 as BaseEvent,
6122
6201
  RegisteredEvent,
6123
6202
  UnregisteredEvent,
6124
6203
  Event_9 as Event,
@@ -6609,7 +6688,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6609
6688
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6610
6689
  * @interface
6611
6690
  */
6612
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6691
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6613
6692
  type: 'idle-state-changed';
6614
6693
  elapsedTime: number;
6615
6694
  isIdle: boolean;
@@ -6748,9 +6827,10 @@ declare type InitPlatformOptions = {
6748
6827
  };
6749
6828
 
6750
6829
  /**
6751
- * * 'none': The `fin` API will be not available from within this context.
6752
- * * 'global': The entire `fin` API will be available from within this context.
6753
- * @defaultValue 'global'
6830
+ * Injection setting for the `fin` API.
6831
+ *
6832
+ * * 'none': The `fin` API will be not available.
6833
+ * * 'global': The entire `fin` API will be available.
6754
6834
  */
6755
6835
  declare type InjectionType = 'none' | 'global';
6756
6836
 
@@ -8668,16 +8748,17 @@ declare type LayoutIdentity = Identity_5 & {
8668
8748
  };
8669
8749
 
8670
8750
  /**
8671
- * Generated when the window is created, and all of its layout's views have either finished or failed
8672
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
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.
8673
8753
  * @interface
8674
8754
  */
8675
8755
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8676
8756
  type: 'layout-initialized';
8677
8757
  layoutIdentity: OpenFin_2.LayoutIdentity;
8678
- ofViews: (OpenFin_2.Identity & {
8758
+ ofViews: {
8759
+ identity: OpenFin_2.Identity;
8679
8760
  entityType: 'view';
8680
- })[];
8761
+ }[];
8681
8762
  };
8682
8763
 
8683
8764
  /**
@@ -9215,9 +9296,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9215
9296
  declare type LayoutReadyEvent = BaseEvent_5 & {
9216
9297
  type: 'layout-ready';
9217
9298
  layoutIdentity: OpenFin_2.LayoutIdentity;
9218
- views: (OpenFin_2.Identity & {
9299
+ views: {
9300
+ identity: OpenFin_2.Identity;
9219
9301
  success: boolean;
9220
- })[];
9302
+ error?: Error;
9303
+ }[];
9221
9304
  };
9222
9305
 
9223
9306
  /**
@@ -9593,7 +9676,7 @@ declare type MonitorInfo = {
9593
9676
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9594
9677
  * @interface
9595
9678
  */
9596
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin_2.MonitorInfo & {
9679
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin_2.MonitorInfo & {
9597
9680
  type: 'monitor-info-changed';
9598
9681
  };
9599
9682
 
@@ -9650,7 +9733,7 @@ declare type MutableViewOptions = {
9650
9733
  /**
9651
9734
  * Restrict navigation to URLs that match an allowed pattern.
9652
9735
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
9653
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
9736
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
9654
9737
  */
9655
9738
  contentNavigation: ContentNavigation;
9656
9739
  contentRedirect: ContentRedirect;
@@ -10354,7 +10437,7 @@ declare namespace OpenFin_2 {
10354
10437
  AppVersionCompleteEvent,
10355
10438
  AppVersionRuntimeStatusEvent,
10356
10439
  Events,
10357
- BaseEvent_9 as BaseEvent,
10440
+ BaseEvent_10 as BaseEvent,
10358
10441
  WebContentsEvent_2 as WebContentsEvent,
10359
10442
  SystemEvent_2 as SystemEvent,
10360
10443
  ApplicationEvent_2 as ApplicationEvent,
@@ -12891,7 +12974,7 @@ declare type RectangleByEdgePositions = {
12891
12974
  * Generated when a hotkey has been registered with the operating system.
12892
12975
  * @interface
12893
12976
  */
12894
- declare type RegisteredEvent = BaseEvent & {
12977
+ declare type RegisteredEvent = BaseEvent_8 & {
12895
12978
  type: 'registered';
12896
12979
  };
12897
12980
 
@@ -13313,7 +13396,7 @@ declare type ServiceIdentifier = {
13313
13396
  * Generated on changes to a user’s local computer session.
13314
13397
  * @interface
13315
13398
  */
13316
- declare type SessionChangedEvent = BaseEvent_8 & {
13399
+ declare type SessionChangedEvent = BaseEvent_9 & {
13317
13400
  type: 'session-changed';
13318
13401
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13319
13402
  };
@@ -15253,7 +15336,7 @@ declare namespace SystemEvents {
15253
15336
  export {
15254
15337
  NotRequested,
15255
15338
  ExcludeRequested,
15256
- BaseEvent_8 as BaseEvent,
15339
+ BaseEvent_9 as BaseEvent,
15257
15340
  IdleStateChangedEvent,
15258
15341
  IdleEvent,
15259
15342
  MonitorInfoChangedEvent,
@@ -15339,7 +15422,7 @@ declare type SystemProcessInfo = {
15339
15422
  * Generated when system shutdown or log off.
15340
15423
  * @internal
15341
15424
  */
15342
- declare type SystemShutdownEvent = BaseEvent_8 & {
15425
+ declare type SystemShutdownEvent = BaseEvent_9 & {
15343
15426
  type: 'system-shutdown';
15344
15427
  };
15345
15428
 
@@ -15738,7 +15821,7 @@ declare interface TypedEventEmitter<Event extends {
15738
15821
  * Generated when a hotkey has been unregistered with the operating system.
15739
15822
  * @interface
15740
15823
  */
15741
- declare type UnregisteredEvent = BaseEvent & {
15824
+ declare type UnregisteredEvent = BaseEvent_8 & {
15742
15825
  type: 'unregistered';
15743
15826
  };
15744
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 are divided into two groups: {@link WillPropagateWebContentsEvent} and {@link NonPropagatedWebContentsEvent}. Propagating 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
- // apply the initial snapshot which in turn will call fin.Platform.Layout.create()
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
  /**
@@ -15952,6 +15951,9 @@ class MockEnvironment {
15952
15951
  initLayoutManager() {
15953
15952
  throw new Error(me_1.environmentUnsupportedMessage);
15954
15953
  }
15954
+ applyLayoutSnapshot() {
15955
+ throw new Error(me_1.environmentUnsupportedMessage);
15956
+ }
15955
15957
  async createLayout() {
15956
15958
  throw new Error(me_1.environmentUnsupportedMessage);
15957
15959
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "36.79.5",
3
+ "version": "36.79.10",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/mock.js",