@openfin/node-adapter 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.
@@ -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 {
@@ -3655,13 +3693,13 @@ declare type ConstWindowOptions = {
3655
3693
  /**
3656
3694
  * Restrict navigation to URLs that match an allowed pattern.
3657
3695
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
3658
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3696
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3659
3697
  */
3660
3698
  contentNavigation: ContentNavigation;
3661
3699
  /**
3662
3700
  * Restrict redirects to URLs that match an allowed pattern.
3663
3701
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
3664
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
3702
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
3665
3703
  */
3666
3704
  contentRedirect: Partial<ContentRedirect>;
3667
3705
  /**
@@ -4206,7 +4244,7 @@ declare interface ContentItem extends EventEmitter_2 {
4206
4244
  /**
4207
4245
  * Restrict navigation to URLs that match an allowed pattern.
4208
4246
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4209
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4247
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4210
4248
  *
4211
4249
  * @interface
4212
4250
  */
@@ -4215,7 +4253,7 @@ declare type ContentNavigation = NavigationRules;
4215
4253
  /**
4216
4254
  * Restrict redirects to URLs that match an allowed pattern.
4217
4255
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4218
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4256
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4219
4257
  *
4220
4258
  * @interface
4221
4259
  */
@@ -4617,7 +4655,7 @@ declare interface DesktopAgent_2 {
4617
4655
  * Generated when the desktop icon is clicked while it's already running.
4618
4656
  * @interface
4619
4657
  */
4620
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4658
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4621
4659
  type: 'desktop-icon-clicked';
4622
4660
  };
4623
4661
 
@@ -4819,19 +4857,42 @@ declare type DisplayMetadata_3 = {
4819
4857
 
4820
4858
  /**
4821
4859
  * @interface
4822
- * 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.
4860
+ * Defines application settings that vary by the domain of the current context.
4861
+ *
4862
+ * @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
4863
+ * domain should be represented with a single rule.
4823
4864
  */
4824
4865
  declare type DomainSettings = {
4866
+ /**
4867
+ * {@inheritDoc DomainSettingsRule}
4868
+ */
4825
4869
  rules: DomainSettingsRule[];
4826
4870
  };
4827
4871
 
4828
4872
  /**
4829
4873
  * @interface
4874
+ *
4875
+ * Defines domain-conditional settings for an OpenFin application.
4830
4876
  */
4831
4877
  declare type DomainSettingsRule = {
4878
+ /**
4879
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4880
+ * the domain(s) for which the rule applies.
4881
+ */
4832
4882
  match: string[];
4883
+ /**
4884
+ * Settings applied when a webcontents has been navigated to a matched domain.
4885
+ */
4833
4886
  options: {
4887
+ /**
4888
+ * {@inheritDoc FileDownloadSettings}
4889
+ *
4890
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
4891
+ */
4834
4892
  downloadSettings?: FileDownloadSettings;
4893
+ /**
4894
+ * {@inheritDoc ApiInjection}
4895
+ */
4835
4896
  api?: ApiInjection;
4836
4897
  };
4837
4898
  };
@@ -4870,9 +4931,20 @@ declare type DownloadPreloadOption = {
4870
4931
 
4871
4932
  /**
4872
4933
  * @interface
4934
+ *
4935
+ * A rule governing domain-conditional download behavior.
4873
4936
  */
4874
4937
  declare type DownloadRule = {
4938
+ /**
4939
+ * {@inheritDoc FileDownloadBehaviorNames}
4940
+ */
4875
4941
  behavior: FileDownloadBehaviorNames;
4942
+ /**
4943
+ * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4944
+ * the domain(s) for which the rule applies.
4945
+ *
4946
+ * @remarks The match is evaluated against the URL of the *download*.
4947
+ */
4876
4948
  match: string[];
4877
4949
  };
4878
4950
 
@@ -5132,6 +5204,7 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5132
5204
 
5133
5205
  declare interface Environment {
5134
5206
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5207
+ applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
5135
5208
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5136
5209
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
5137
5210
  resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
@@ -5173,14 +5246,14 @@ declare type ErrorPlainObject = {
5173
5246
 
5174
5247
  /**
5175
5248
  * [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
5176
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5249
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5177
5250
  * under the {@link OpenFin.PlatformEvents} namespace.
5178
5251
  */
5179
5252
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5180
5253
 
5181
5254
  /**
5182
5255
  * [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
5183
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5256
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5184
5257
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5185
5258
  * from which they propagate).
5186
5259
  */
@@ -5188,7 +5261,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5188
5261
 
5189
5262
  /**
5190
5263
  * [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
5191
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5264
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5192
5265
  * under the {@link OpenFin.ChannelEvents} namespace.
5193
5266
  */
5194
5267
  declare type Event_2 = {
@@ -5197,7 +5270,7 @@ declare type Event_2 = {
5197
5270
 
5198
5271
  /**
5199
5272
  * [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
5200
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5273
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5201
5274
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5202
5275
  * from which they propagate).
5203
5276
  */
@@ -5205,7 +5278,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5205
5278
 
5206
5279
  /**
5207
5280
  * [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
5208
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5281
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5209
5282
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5210
5283
  */
5211
5284
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5222,21 +5295,21 @@ declare type Event_5<Topic extends string> = {
5222
5295
 
5223
5296
  /**
5224
5297
  * [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
5225
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5298
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5226
5299
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5227
5300
  */
5228
5301
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5229
5302
 
5230
5303
  /**
5231
5304
  * [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
5232
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5305
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5233
5306
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5234
5307
  */
5235
5308
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5236
5309
 
5237
5310
  /**
5238
5311
  * [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
5239
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5312
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5240
5313
  * under the {@link OpenFin.FrameEvents} namespace.
5241
5314
  */
5242
5315
  declare type Event_8 = {
@@ -5245,13 +5318,10 @@ declare type Event_8 = {
5245
5318
 
5246
5319
  /**
5247
5320
  * [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
5248
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5321
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5249
5322
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5250
5323
  */
5251
- declare type Event_9 = {
5252
- topic: 'global-hotkey';
5253
- hotkey: 'string';
5254
- } & (RegisteredEvent | UnregisteredEvent);
5324
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5255
5325
 
5256
5326
  declare class EventAggregator extends EmitterMap {
5257
5327
  dispatchEvent: (message: Message<any>) => boolean;
@@ -5598,6 +5668,9 @@ declare type FetchManifestPayload = {
5598
5668
  manifestUrl: string;
5599
5669
  };
5600
5670
 
5671
+ /**
5672
+ * Whether file downloads raise a user prompt.
5673
+ */
5601
5674
  declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5602
5675
 
5603
5676
  /**
@@ -5680,9 +5753,14 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
5680
5753
  };
5681
5754
 
5682
5755
  /**
5683
- * @interface
5756
+ * Domain-conditional rules for file downloads.
5757
+ *
5758
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
5684
5759
  */
5685
5760
  declare type FileDownloadSettings = {
5761
+ /**
5762
+ * {@inheritDoc DownloadRule}
5763
+ */
5686
5764
  rules: DownloadRule[];
5687
5765
  };
5688
5766
 
@@ -6149,6 +6227,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6149
6227
 
6150
6228
  declare namespace GlobalHotkeyEvents {
6151
6229
  export {
6230
+ BaseEvent_8 as BaseEvent,
6152
6231
  RegisteredEvent,
6153
6232
  UnregisteredEvent,
6154
6233
  Event_9 as Event,
@@ -6639,7 +6718,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6639
6718
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6640
6719
  * @interface
6641
6720
  */
6642
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6721
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6643
6722
  type: 'idle-state-changed';
6644
6723
  elapsedTime: number;
6645
6724
  isIdle: boolean;
@@ -6778,9 +6857,10 @@ declare type InitPlatformOptions = {
6778
6857
  };
6779
6858
 
6780
6859
  /**
6781
- * * 'none': The `fin` API will be not available from within this context.
6782
- * * 'global': The entire `fin` API will be available from within this context.
6783
- * @defaultValue 'global'
6860
+ * Injection setting for the `fin` API.
6861
+ *
6862
+ * * 'none': The `fin` API will be not available.
6863
+ * * 'global': The entire `fin` API will be available.
6784
6864
  */
6785
6865
  declare type InjectionType = 'none' | 'global';
6786
6866
 
@@ -8700,16 +8780,17 @@ declare type LayoutIdentity = Identity_5 & {
8700
8780
  };
8701
8781
 
8702
8782
  /**
8703
- * Generated when the window is created, and all of its layout's views have either finished or failed
8704
- * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8783
+ * Generated after a layout is created and all of its views have either finished or failed navigation
8784
+ * once per layout. Does not emit for layouts created using Layout.replace() API.
8705
8785
  * @interface
8706
8786
  */
8707
8787
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8708
8788
  type: 'layout-initialized';
8709
8789
  layoutIdentity: OpenFin.LayoutIdentity;
8710
- ofViews: (OpenFin.Identity & {
8790
+ ofViews: {
8791
+ identity: OpenFin.Identity;
8711
8792
  entityType: 'view';
8712
- })[];
8793
+ }[];
8713
8794
  };
8714
8795
 
8715
8796
  /**
@@ -9247,9 +9328,11 @@ declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9247
9328
  declare type LayoutReadyEvent = BaseEvent_5 & {
9248
9329
  type: 'layout-ready';
9249
9330
  layoutIdentity: OpenFin.LayoutIdentity;
9250
- views: (OpenFin.Identity & {
9331
+ views: {
9332
+ identity: OpenFin.Identity;
9251
9333
  success: boolean;
9252
- })[];
9334
+ error?: Error;
9335
+ }[];
9253
9336
  };
9254
9337
 
9255
9338
  /**
@@ -9625,7 +9708,7 @@ declare type MonitorInfo = {
9625
9708
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9626
9709
  * @interface
9627
9710
  */
9628
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9711
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9629
9712
  type: 'monitor-info-changed';
9630
9713
  };
9631
9714
 
@@ -9682,7 +9765,7 @@ declare type MutableViewOptions = {
9682
9765
  /**
9683
9766
  * Restrict navigation to URLs that match an allowed pattern.
9684
9767
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
9685
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
9768
+ * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
9686
9769
  */
9687
9770
  contentNavigation: ContentNavigation;
9688
9771
  contentRedirect: ContentRedirect;
@@ -10386,7 +10469,7 @@ declare namespace OpenFin {
10386
10469
  AppVersionCompleteEvent,
10387
10470
  AppVersionRuntimeStatusEvent,
10388
10471
  Events,
10389
- BaseEvent_9 as BaseEvent,
10472
+ BaseEvent_10 as BaseEvent,
10390
10473
  WebContentsEvent_2 as WebContentsEvent,
10391
10474
  SystemEvent_2 as SystemEvent,
10392
10475
  ApplicationEvent_2 as ApplicationEvent,
@@ -12923,7 +13006,7 @@ declare type RectangleByEdgePositions = {
12923
13006
  * Generated when a hotkey has been registered with the operating system.
12924
13007
  * @interface
12925
13008
  */
12926
- declare type RegisteredEvent = BaseEvent & {
13009
+ declare type RegisteredEvent = BaseEvent_8 & {
12927
13010
  type: 'registered';
12928
13011
  };
12929
13012
 
@@ -13345,7 +13428,7 @@ declare type ServiceIdentifier = {
13345
13428
  * Generated on changes to a user’s local computer session.
13346
13429
  * @interface
13347
13430
  */
13348
- declare type SessionChangedEvent = BaseEvent_8 & {
13431
+ declare type SessionChangedEvent = BaseEvent_9 & {
13349
13432
  type: 'session-changed';
13350
13433
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13351
13434
  };
@@ -15285,7 +15368,7 @@ declare namespace SystemEvents {
15285
15368
  export {
15286
15369
  NotRequested,
15287
15370
  ExcludeRequested,
15288
- BaseEvent_8 as BaseEvent,
15371
+ BaseEvent_9 as BaseEvent,
15289
15372
  IdleStateChangedEvent,
15290
15373
  IdleEvent,
15291
15374
  MonitorInfoChangedEvent,
@@ -15371,7 +15454,7 @@ declare type SystemProcessInfo = {
15371
15454
  * Generated when system shutdown or log off.
15372
15455
  * @internal
15373
15456
  */
15374
- declare type SystemShutdownEvent = BaseEvent_8 & {
15457
+ declare type SystemShutdownEvent = BaseEvent_9 & {
15375
15458
  type: 'system-shutdown';
15376
15459
  };
15377
15460
 
@@ -15770,7 +15853,7 @@ declare interface TypedEventEmitter<Event extends {
15770
15853
  * Generated when a hotkey has been unregistered with the operating system.
15771
15854
  * @interface
15772
15855
  */
15773
- declare type UnregisteredEvent = BaseEvent & {
15856
+ declare type UnregisteredEvent = BaseEvent_8 & {
15774
15857
  type: 'unregistered';
15775
15858
  };
15776
15859
 
@@ -11799,24 +11799,16 @@ class LayoutModule extends base_1$5.Base {
11799
11799
  throw new Error('Layout.init was already called, please use Layout.create to add additional layouts.');
11800
11800
  }
11801
11801
  __classPrivateFieldSet$4(this, _LayoutModule_layoutInitializationAttempted, true, "f");
11802
+ // preload the client
11803
+ await this.fin.Platform.getCurrentSync().getClient();
11802
11804
  __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayoutManager(this.fin, this.wire, options), "f");
11803
- // apply the initial snapshot which in turn will call fin.Platform.Layout.create()
11804
- const platformClient = await this.fin.Platform.getCurrentSync().getClient();
11805
- const snapshot = await platformClient.dispatch('get-initial-layout-snapshot');
11806
- await __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").applyLayoutSnapshot(snapshot);
11805
+ await this.wire.environment.applyLayoutSnapshot(this.fin, __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), options);
11807
11806
  if (!options.layoutManagerOverride) {
11808
11807
  // in single-layout case, we return the undocumented layoutManager type (deprecate with CORE-1081)
11809
11808
  const layoutIdentity = { layoutName: layout_constants_1.DEFAULT_LAYOUT_KEY, ...this.fin.me.identity };
11810
11809
  const layoutManager = await this.wire.environment.resolveLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
11811
11810
  return Object.assign(this.wrapSync(layoutIdentity), { layoutManager });
11812
11811
  }
11813
- // warn user if they do not call create() in the next 30 seconds
11814
- setTimeout(() => {
11815
- if (__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f")?.size() === 0) {
11816
- console.warn(`[Layout.init] Layout.init was called 30s ago, but no layouts have been created yet. Make sure you ` +
11817
- `override LayoutManager.applyLayoutSnapshot, and then call fin.Platform.Layout.create()`);
11818
- }
11819
- }, 30000);
11820
11812
  return this.wrapSync(this.fin.me.identity);
11821
11813
  };
11822
11814
  /**
@@ -16253,6 +16245,9 @@ function requireNodeEnv () {
16253
16245
  async initLayoutManager() {
16254
16246
  throw new Error('Method not implemented.');
16255
16247
  }
16248
+ async applyLayoutSnapshot() {
16249
+ throw new Error('Method not implemented.');
16250
+ }
16256
16251
  async createLayout() {
16257
16252
  throw new Error('Method not implemented.');
16258
16253
  }
@@ -16824,6 +16819,16 @@ Object.defineProperty(frame, "__esModule", { value: true });
16824
16819
 
16825
16820
  var globalHotkey = {};
16826
16821
 
16822
+ /**
16823
+ *
16824
+ * Namespace for events that can be transmitted by {@link GlobalHotkey.GlobalHotkey}.
16825
+ *
16826
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
16827
+ *
16828
+ * For a list of valid string keys for global hotkey events, see {@link GlobalHotkey.GlobalHotkey.on GlobalHotkey.on}.
16829
+ *
16830
+ * @packageDocumentation
16831
+ */
16827
16832
  Object.defineProperty(globalHotkey, "__esModule", { value: true });
16828
16833
 
16829
16834
  var platform = {};
@@ -16888,12 +16893,9 @@ var webcontents = {};
16888
16893
  * Namespace for events shared by all OpenFin WebContents elements (i.e. {@link OpenFin.Window},
16889
16894
  * {@link OpenFin.View}).
16890
16895
  *
16891
- * WebContents events are divided into two groups: {@link WillPropagateWebContentsEvent} and {@link NonPropagatedWebContentsEvent}. Propagating events
16892
- * will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
16896
+ * WebContents events will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
16893
16897
  * parent window, and propagating events in a window will also be emitted on the window's parent {@link OpenFin.Application}.
16894
16898
  *
16895
- * Non-propagating events will not re-emit on parent entities.
16896
- *
16897
16899
  * @packageDocumentation
16898
16900
  */
16899
16901
  Object.defineProperty(webcontents, "__esModule", { value: true });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/node-adapter",
3
- "version": "36.79.5",
3
+ "version": "36.79.10",
4
4
  "description": "See README.md",
5
5
  "main": "out/node-adapter.js",
6
6
  "types": "out/node-adapter.d.ts",