@openfin/node-adapter 34.78.74 → 34.78.76

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.
@@ -88,12 +88,21 @@ declare type Api = {
88
88
  iframe?: {
89
89
  /**
90
90
  * Inject OpenFin API into cross-origin iframes
91
+ *
92
+ * @defaultValue false
91
93
  */
92
94
  crossOriginInjection?: boolean;
93
95
  /**
94
96
  * Inject OpenFin API into same-origin iframes
97
+ *
98
+ * @defaultValue true
95
99
  */
96
100
  sameOriginInjection?: boolean;
101
+ /**
102
+ * @deprecated Shared names should not be used; support is provided purely for back-compat reasons.
103
+ *
104
+ * When `true`, iframes will have the same name as their parent WebContents.
105
+ */
97
106
  enableDeprecatedSharedName?: boolean;
98
107
  };
99
108
  };
@@ -875,7 +884,7 @@ declare type ApplicationConnectedEvent = ConnectedEvent_2;
875
884
  * Generated when an application is created.
876
885
  * @interface
877
886
  */
878
- declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
887
+ declare type ApplicationCreatedEvent = BaseEvent_9 & BaseEvents.IdentityEvent & {
879
888
  type: 'application-created';
880
889
  };
881
890
 
@@ -1733,13 +1742,30 @@ declare type BaseContentCreationRule = {
1733
1742
  /**
1734
1743
  * A base OpenFin event. All OpenFin event payloads extend this type.
1735
1744
  *
1745
+ * OpenFin events are jointly discriminated by their {@link topic} and {@link type} keys. Within each
1746
+ * `topic`, the `type` key is unique.
1747
+ *
1736
1748
  * @interface
1737
1749
  */
1738
1750
  declare type BaseEvent = {
1751
+ /**
1752
+ * The "kebab-case" classname of the {@link OpenFin.Events emitter} that raised the event.
1753
+ *
1754
+ * @remarks {@link OpenFin.Frame} is represented as `iframe`.
1755
+ */
1739
1756
  topic: string;
1757
+ /**
1758
+ * The type of event that was raised. Equal to the typename of the event payload in "kebab case".
1759
+ *
1760
+ * @remarks Guaranteed to be unique within each {@link topic}, but can be repeated
1761
+ * between topics (e.g. {@link OpenFin.WebContentsEvents.CrashedEvent WebContentsEvents.CrashedEvent} and
1762
+ * {@link OpenFin.ApplicationEvents.CrashedEvent ApplicationEvents.CrashedEvent}).
1763
+ */
1740
1764
  type: string;
1741
1765
  };
1742
1766
 
1767
+ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1768
+
1743
1769
  /**
1744
1770
  * A base Channel event.
1745
1771
  * @interface
@@ -1792,14 +1818,22 @@ declare type BaseEvent_7 = NamedEvent & {
1792
1818
  };
1793
1819
 
1794
1820
  /**
1795
- * Base type for events emitting on the `system` topic
1821
+ * Base type for events emitting on the `global-hotkey` topic.
1822
+ *
1796
1823
  * @interface
1797
1824
  */
1798
1825
  declare type BaseEvent_8 = BaseEvents.BaseEvent & {
1799
- topic: 'system';
1826
+ topic: 'global-hotkey';
1827
+ hotkey: string;
1800
1828
  };
1801
1829
 
1802
- declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
1830
+ /**
1831
+ * Base type for events emitting on the `system` topic
1832
+ * @interface
1833
+ */
1834
+ declare type BaseEvent_9 = BaseEvents.BaseEvent & {
1835
+ topic: 'system';
1836
+ };
1803
1837
 
1804
1838
  declare namespace BaseEvents {
1805
1839
  export {
@@ -4454,6 +4488,32 @@ declare type CreateLayoutOptions = {
4454
4488
  container: HTMLElement;
4455
4489
  layoutName: string;
4456
4490
  layout: LayoutOptions;
4491
+ /**
4492
+ * @defaultValue 'default'
4493
+ *
4494
+ * Controls the View behavior for the given `layout` property. Note
4495
+ * that the selected behavior only applies to unnamed Views or
4496
+ * Views with the prefix `internal-generated-`. In all cases, if any
4497
+ * View in the `layout` does not already exist, it will be created
4498
+ * with a name that starts with `internal-generated-`.
4499
+ *
4500
+ * When set to `reparent`, Views prefixed with `internal-generated-` will
4501
+ * be reparented to the current Window and added to this new Layout.
4502
+ * Use this option when you need to transfer an existing Layout between Windows.
4503
+ *
4504
+ * When set to 'duplicate', Views prefixed with `internal-generated-` will
4505
+ * be duplicated with new generated names. Use this option when you need
4506
+ * to clone a Layout to any Window.
4507
+ *
4508
+ * When set to `default` or omitted, the Layout will attempt to re-use
4509
+ * existing Views only if they are attached to the current Window or
4510
+ * the Provider Window. Set to `default` or omit this option when creating
4511
+ * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
4512
+ * override. Note that during applyLayoutSnapshot, Views are created and
4513
+ * attached to the Provider while the Window is being created, so it's
4514
+ * important to not 'duplicate' Views in this workflow.
4515
+ */
4516
+ multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4457
4517
  };
4458
4518
 
4459
4519
  /**
@@ -4602,7 +4662,7 @@ declare interface DesktopAgent_2 {
4602
4662
  * Generated when the desktop icon is clicked while it's already running.
4603
4663
  * @interface
4604
4664
  */
4605
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4665
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4606
4666
  type: 'desktop-icon-clicked';
4607
4667
  };
4608
4668
 
@@ -5135,14 +5195,14 @@ declare type ErrorPlainObject = {
5135
5195
 
5136
5196
  /**
5137
5197
  * [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
5138
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5198
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5139
5199
  * under the {@link OpenFin.PlatformEvents} namespace.
5140
5200
  */
5141
5201
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5142
5202
 
5143
5203
  /**
5144
5204
  * [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
5145
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5205
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5146
5206
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5147
5207
  * from which they propagate).
5148
5208
  */
@@ -5150,7 +5210,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5150
5210
 
5151
5211
  /**
5152
5212
  * [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
5153
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5213
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5154
5214
  * under the {@link OpenFin.ChannelEvents} namespace.
5155
5215
  */
5156
5216
  declare type Event_2 = {
@@ -5159,7 +5219,7 @@ declare type Event_2 = {
5159
5219
 
5160
5220
  /**
5161
5221
  * [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
5162
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5222
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5163
5223
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5164
5224
  * from which they propagate).
5165
5225
  */
@@ -5167,7 +5227,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5167
5227
 
5168
5228
  /**
5169
5229
  * [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
5170
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5230
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5171
5231
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5172
5232
  */
5173
5233
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5184,21 +5244,21 @@ declare type Event_5<Topic extends string> = {
5184
5244
 
5185
5245
  /**
5186
5246
  * [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
5187
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5247
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5188
5248
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5189
5249
  */
5190
5250
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5191
5251
 
5192
5252
  /**
5193
5253
  * [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
5194
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5254
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5195
5255
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5196
5256
  */
5197
5257
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5198
5258
 
5199
5259
  /**
5200
5260
  * [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
5201
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5261
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5202
5262
  * under the {@link OpenFin.FrameEvents} namespace.
5203
5263
  */
5204
5264
  declare type Event_8 = {
@@ -5207,13 +5267,10 @@ declare type Event_8 = {
5207
5267
 
5208
5268
  /**
5209
5269
  * [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
5210
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5270
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5211
5271
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5212
5272
  */
5213
- declare type Event_9 = {
5214
- topic: 'global-hotkey';
5215
- hotkey: 'string';
5216
- } & (RegisteredEvent | UnregisteredEvent);
5273
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5217
5274
 
5218
5275
  declare class EventAggregator extends EmitterMap {
5219
5276
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6216,6 +6273,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6216
6273
 
6217
6274
  declare namespace GlobalHotkeyEvents {
6218
6275
  export {
6276
+ BaseEvent_8 as BaseEvent,
6219
6277
  RegisteredEvent,
6220
6278
  UnregisteredEvent,
6221
6279
  Event_9 as Event,
@@ -6703,7 +6761,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6703
6761
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6704
6762
  * @interface
6705
6763
  */
6706
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6764
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6707
6765
  type: 'idle-state-changed';
6708
6766
  elapsedTime: number;
6709
6767
  isIdle: boolean;
@@ -7730,7 +7788,7 @@ declare type InteropBrokerDisconnectionEvent = {
7730
7788
  * @interface
7731
7789
  */
7732
7790
  declare type InteropBrokerOptions = {
7733
- contextGroups?: ContextGroupInfo;
7791
+ contextGroups?: ContextGroupInfo[];
7734
7792
  logging?: InteropLoggingOptions;
7735
7793
  };
7736
7794
 
@@ -9632,10 +9690,17 @@ declare type MonitorInfo = {
9632
9690
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9633
9691
  * @interface
9634
9692
  */
9635
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9693
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9636
9694
  type: 'monitor-info-changed';
9637
9695
  };
9638
9696
 
9697
+ /**
9698
+ * @experimental
9699
+ *
9700
+ * Used to control view behavior for Layout.create API
9701
+ */
9702
+ declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
9703
+
9639
9704
  /**
9640
9705
  * @interface
9641
9706
  */
@@ -10351,6 +10416,7 @@ declare namespace OpenFin {
10351
10416
  LayoutManagerOverride,
10352
10417
  LayoutManager,
10353
10418
  CreateLayoutOptions,
10419
+ MultiInstanceViewBehavior,
10354
10420
  PresetLayoutOptions_2 as PresetLayoutOptions,
10355
10421
  ResultBehavior,
10356
10422
  PopupBaseBehavior,
@@ -10366,7 +10432,7 @@ declare namespace OpenFin {
10366
10432
  AppVersionCompleteEvent,
10367
10433
  AppVersionRuntimeStatusEvent,
10368
10434
  Events,
10369
- BaseEvent_9 as BaseEvent,
10435
+ BaseEvent_10 as BaseEvent,
10370
10436
  WebContentsEvent_2 as WebContentsEvent,
10371
10437
  SystemEvent_2 as SystemEvent,
10372
10438
  ApplicationEvent_2 as ApplicationEvent,
@@ -12825,7 +12891,7 @@ declare type RectangleByEdgePositions = {
12825
12891
  * Generated when a hotkey has been registered with the operating system.
12826
12892
  * @interface
12827
12893
  */
12828
- declare type RegisteredEvent = BaseEvent & {
12894
+ declare type RegisteredEvent = BaseEvent_8 & {
12829
12895
  type: 'registered';
12830
12896
  };
12831
12897
 
@@ -13247,7 +13313,7 @@ declare type ServiceIdentifier = {
13247
13313
  * Generated on changes to a user’s local computer session.
13248
13314
  * @interface
13249
13315
  */
13250
- declare type SessionChangedEvent = BaseEvent_8 & {
13316
+ declare type SessionChangedEvent = BaseEvent_9 & {
13251
13317
  type: 'session-changed';
13252
13318
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13253
13319
  };
@@ -15241,7 +15307,7 @@ declare namespace SystemEvents {
15241
15307
  export {
15242
15308
  NotRequested,
15243
15309
  ExcludeRequested,
15244
- BaseEvent_8 as BaseEvent,
15310
+ BaseEvent_9 as BaseEvent,
15245
15311
  IdleStateChangedEvent,
15246
15312
  IdleEvent,
15247
15313
  MonitorInfoChangedEvent,
@@ -15719,7 +15785,7 @@ declare interface TypedEventEmitter<Event extends {
15719
15785
  * Generated when a hotkey has been unregistered with the operating system.
15720
15786
  * @interface
15721
15787
  */
15722
- declare type UnregisteredEvent = BaseEvent & {
15788
+ declare type UnregisteredEvent = BaseEvent_8 & {
15723
15789
  type: 'unregistered';
15724
15790
  };
15725
15791
 
@@ -88,12 +88,21 @@ declare type Api = {
88
88
  iframe?: {
89
89
  /**
90
90
  * Inject OpenFin API into cross-origin iframes
91
+ *
92
+ * @defaultValue false
91
93
  */
92
94
  crossOriginInjection?: boolean;
93
95
  /**
94
96
  * Inject OpenFin API into same-origin iframes
97
+ *
98
+ * @defaultValue true
95
99
  */
96
100
  sameOriginInjection?: boolean;
101
+ /**
102
+ * @deprecated Shared names should not be used; support is provided purely for back-compat reasons.
103
+ *
104
+ * When `true`, iframes will have the same name as their parent WebContents.
105
+ */
97
106
  enableDeprecatedSharedName?: boolean;
98
107
  };
99
108
  };
@@ -875,7 +884,7 @@ declare type ApplicationConnectedEvent = ConnectedEvent_2;
875
884
  * Generated when an application is created.
876
885
  * @interface
877
886
  */
878
- declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
887
+ declare type ApplicationCreatedEvent = BaseEvent_9 & BaseEvents.IdentityEvent & {
879
888
  type: 'application-created';
880
889
  };
881
890
 
@@ -1733,13 +1742,30 @@ declare type BaseContentCreationRule = {
1733
1742
  /**
1734
1743
  * A base OpenFin event. All OpenFin event payloads extend this type.
1735
1744
  *
1745
+ * OpenFin events are jointly discriminated by their {@link topic} and {@link type} keys. Within each
1746
+ * `topic`, the `type` key is unique.
1747
+ *
1736
1748
  * @interface
1737
1749
  */
1738
1750
  declare type BaseEvent = {
1751
+ /**
1752
+ * The "kebab-case" classname of the {@link OpenFin.Events emitter} that raised the event.
1753
+ *
1754
+ * @remarks {@link OpenFin.Frame} is represented as `iframe`.
1755
+ */
1739
1756
  topic: string;
1757
+ /**
1758
+ * The type of event that was raised. Equal to the typename of the event payload in "kebab case".
1759
+ *
1760
+ * @remarks Guaranteed to be unique within each {@link topic}, but can be repeated
1761
+ * between topics (e.g. {@link OpenFin.WebContentsEvents.CrashedEvent WebContentsEvents.CrashedEvent} and
1762
+ * {@link OpenFin.ApplicationEvents.CrashedEvent ApplicationEvents.CrashedEvent}).
1763
+ */
1740
1764
  type: string;
1741
1765
  };
1742
1766
 
1767
+ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1768
+
1743
1769
  /**
1744
1770
  * A base Channel event.
1745
1771
  * @interface
@@ -1792,14 +1818,22 @@ declare type BaseEvent_7 = NamedEvent & {
1792
1818
  };
1793
1819
 
1794
1820
  /**
1795
- * Base type for events emitting on the `system` topic
1821
+ * Base type for events emitting on the `global-hotkey` topic.
1822
+ *
1796
1823
  * @interface
1797
1824
  */
1798
1825
  declare type BaseEvent_8 = BaseEvents.BaseEvent & {
1799
- topic: 'system';
1826
+ topic: 'global-hotkey';
1827
+ hotkey: string;
1800
1828
  };
1801
1829
 
1802
- declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
1830
+ /**
1831
+ * Base type for events emitting on the `system` topic
1832
+ * @interface
1833
+ */
1834
+ declare type BaseEvent_9 = BaseEvents.BaseEvent & {
1835
+ topic: 'system';
1836
+ };
1803
1837
 
1804
1838
  declare namespace BaseEvents {
1805
1839
  export {
@@ -4454,6 +4488,32 @@ declare type CreateLayoutOptions = {
4454
4488
  container: HTMLElement;
4455
4489
  layoutName: string;
4456
4490
  layout: LayoutOptions;
4491
+ /**
4492
+ * @defaultValue 'default'
4493
+ *
4494
+ * Controls the View behavior for the given `layout` property. Note
4495
+ * that the selected behavior only applies to unnamed Views or
4496
+ * Views with the prefix `internal-generated-`. In all cases, if any
4497
+ * View in the `layout` does not already exist, it will be created
4498
+ * with a name that starts with `internal-generated-`.
4499
+ *
4500
+ * When set to `reparent`, Views prefixed with `internal-generated-` will
4501
+ * be reparented to the current Window and added to this new Layout.
4502
+ * Use this option when you need to transfer an existing Layout between Windows.
4503
+ *
4504
+ * When set to 'duplicate', Views prefixed with `internal-generated-` will
4505
+ * be duplicated with new generated names. Use this option when you need
4506
+ * to clone a Layout to any Window.
4507
+ *
4508
+ * When set to `default` or omitted, the Layout will attempt to re-use
4509
+ * existing Views only if they are attached to the current Window or
4510
+ * the Provider Window. Set to `default` or omit this option when creating
4511
+ * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
4512
+ * override. Note that during applyLayoutSnapshot, Views are created and
4513
+ * attached to the Provider while the Window is being created, so it's
4514
+ * important to not 'duplicate' Views in this workflow.
4515
+ */
4516
+ multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4457
4517
  };
4458
4518
 
4459
4519
  /**
@@ -4602,7 +4662,7 @@ declare interface DesktopAgent_2 {
4602
4662
  * Generated when the desktop icon is clicked while it's already running.
4603
4663
  * @interface
4604
4664
  */
4605
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4665
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4606
4666
  type: 'desktop-icon-clicked';
4607
4667
  };
4608
4668
 
@@ -5135,14 +5195,14 @@ declare type ErrorPlainObject = {
5135
5195
 
5136
5196
  /**
5137
5197
  * [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
5138
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5198
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5139
5199
  * under the {@link OpenFin.PlatformEvents} namespace.
5140
5200
  */
5141
5201
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5142
5202
 
5143
5203
  /**
5144
5204
  * [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
5145
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5205
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5146
5206
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5147
5207
  * from which they propagate).
5148
5208
  */
@@ -5150,7 +5210,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5150
5210
 
5151
5211
  /**
5152
5212
  * [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
5153
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5213
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5154
5214
  * under the {@link OpenFin.ChannelEvents} namespace.
5155
5215
  */
5156
5216
  declare type Event_2 = {
@@ -5159,7 +5219,7 @@ declare type Event_2 = {
5159
5219
 
5160
5220
  /**
5161
5221
  * [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
5162
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5222
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5163
5223
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5164
5224
  * from which they propagate).
5165
5225
  */
@@ -5167,7 +5227,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5167
5227
 
5168
5228
  /**
5169
5229
  * [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
5170
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5230
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5171
5231
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5172
5232
  */
5173
5233
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5184,21 +5244,21 @@ declare type Event_5<Topic extends string> = {
5184
5244
 
5185
5245
  /**
5186
5246
  * [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
5187
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5247
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5188
5248
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5189
5249
  */
5190
5250
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5191
5251
 
5192
5252
  /**
5193
5253
  * [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
5194
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5254
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5195
5255
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5196
5256
  */
5197
5257
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5198
5258
 
5199
5259
  /**
5200
5260
  * [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
5201
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5261
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5202
5262
  * under the {@link OpenFin.FrameEvents} namespace.
5203
5263
  */
5204
5264
  declare type Event_8 = {
@@ -5207,13 +5267,10 @@ declare type Event_8 = {
5207
5267
 
5208
5268
  /**
5209
5269
  * [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
5210
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5270
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5211
5271
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5212
5272
  */
5213
- declare type Event_9 = {
5214
- topic: 'global-hotkey';
5215
- hotkey: 'string';
5216
- } & (RegisteredEvent | UnregisteredEvent);
5273
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5217
5274
 
5218
5275
  declare class EventAggregator extends EmitterMap {
5219
5276
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6216,6 +6273,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6216
6273
 
6217
6274
  declare namespace GlobalHotkeyEvents {
6218
6275
  export {
6276
+ BaseEvent_8 as BaseEvent,
6219
6277
  RegisteredEvent,
6220
6278
  UnregisteredEvent,
6221
6279
  Event_9 as Event,
@@ -6703,7 +6761,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6703
6761
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6704
6762
  * @interface
6705
6763
  */
6706
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6764
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6707
6765
  type: 'idle-state-changed';
6708
6766
  elapsedTime: number;
6709
6767
  isIdle: boolean;
@@ -7730,7 +7788,7 @@ declare type InteropBrokerDisconnectionEvent = {
7730
7788
  * @interface
7731
7789
  */
7732
7790
  declare type InteropBrokerOptions = {
7733
- contextGroups?: ContextGroupInfo;
7791
+ contextGroups?: ContextGroupInfo[];
7734
7792
  logging?: InteropLoggingOptions;
7735
7793
  };
7736
7794
 
@@ -9632,10 +9690,17 @@ declare type MonitorInfo = {
9632
9690
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9633
9691
  * @interface
9634
9692
  */
9635
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9693
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9636
9694
  type: 'monitor-info-changed';
9637
9695
  };
9638
9696
 
9697
+ /**
9698
+ * @experimental
9699
+ *
9700
+ * Used to control view behavior for Layout.create API
9701
+ */
9702
+ declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
9703
+
9639
9704
  /**
9640
9705
  * @interface
9641
9706
  */
@@ -10351,6 +10416,7 @@ declare namespace OpenFin {
10351
10416
  LayoutManagerOverride,
10352
10417
  LayoutManager,
10353
10418
  CreateLayoutOptions,
10419
+ MultiInstanceViewBehavior,
10354
10420
  PresetLayoutOptions_2 as PresetLayoutOptions,
10355
10421
  ResultBehavior,
10356
10422
  PopupBaseBehavior,
@@ -10366,7 +10432,7 @@ declare namespace OpenFin {
10366
10432
  AppVersionCompleteEvent,
10367
10433
  AppVersionRuntimeStatusEvent,
10368
10434
  Events,
10369
- BaseEvent_9 as BaseEvent,
10435
+ BaseEvent_10 as BaseEvent,
10370
10436
  WebContentsEvent_2 as WebContentsEvent,
10371
10437
  SystemEvent_2 as SystemEvent,
10372
10438
  ApplicationEvent_2 as ApplicationEvent,
@@ -12825,7 +12891,7 @@ declare type RectangleByEdgePositions = {
12825
12891
  * Generated when a hotkey has been registered with the operating system.
12826
12892
  * @interface
12827
12893
  */
12828
- declare type RegisteredEvent = BaseEvent & {
12894
+ declare type RegisteredEvent = BaseEvent_8 & {
12829
12895
  type: 'registered';
12830
12896
  };
12831
12897
 
@@ -13247,7 +13313,7 @@ declare type ServiceIdentifier = {
13247
13313
  * Generated on changes to a user’s local computer session.
13248
13314
  * @interface
13249
13315
  */
13250
- declare type SessionChangedEvent = BaseEvent_8 & {
13316
+ declare type SessionChangedEvent = BaseEvent_9 & {
13251
13317
  type: 'session-changed';
13252
13318
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13253
13319
  };
@@ -15241,7 +15307,7 @@ declare namespace SystemEvents {
15241
15307
  export {
15242
15308
  NotRequested,
15243
15309
  ExcludeRequested,
15244
- BaseEvent_8 as BaseEvent,
15310
+ BaseEvent_9 as BaseEvent,
15245
15311
  IdleStateChangedEvent,
15246
15312
  IdleEvent,
15247
15313
  MonitorInfoChangedEvent,
@@ -15719,7 +15785,7 @@ declare interface TypedEventEmitter<Event extends {
15719
15785
  * Generated when a hotkey has been unregistered with the operating system.
15720
15786
  * @interface
15721
15787
  */
15722
- declare type UnregisteredEvent = BaseEvent & {
15788
+ declare type UnregisteredEvent = BaseEvent_8 & {
15723
15789
  type: 'unregistered';
15724
15790
  };
15725
15791
 
@@ -88,12 +88,21 @@ declare type Api = {
88
88
  iframe?: {
89
89
  /**
90
90
  * Inject OpenFin API into cross-origin iframes
91
+ *
92
+ * @defaultValue false
91
93
  */
92
94
  crossOriginInjection?: boolean;
93
95
  /**
94
96
  * Inject OpenFin API into same-origin iframes
97
+ *
98
+ * @defaultValue true
95
99
  */
96
100
  sameOriginInjection?: boolean;
101
+ /**
102
+ * @deprecated Shared names should not be used; support is provided purely for back-compat reasons.
103
+ *
104
+ * When `true`, iframes will have the same name as their parent WebContents.
105
+ */
97
106
  enableDeprecatedSharedName?: boolean;
98
107
  };
99
108
  };
@@ -875,7 +884,7 @@ declare type ApplicationConnectedEvent = ConnectedEvent_2;
875
884
  * Generated when an application is created.
876
885
  * @interface
877
886
  */
878
- declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
887
+ declare type ApplicationCreatedEvent = BaseEvent_9 & BaseEvents.IdentityEvent & {
879
888
  type: 'application-created';
880
889
  };
881
890
 
@@ -1733,13 +1742,30 @@ declare type BaseContentCreationRule = {
1733
1742
  /**
1734
1743
  * A base OpenFin event. All OpenFin event payloads extend this type.
1735
1744
  *
1745
+ * OpenFin events are jointly discriminated by their {@link topic} and {@link type} keys. Within each
1746
+ * `topic`, the `type` key is unique.
1747
+ *
1736
1748
  * @interface
1737
1749
  */
1738
1750
  declare type BaseEvent = {
1751
+ /**
1752
+ * The "kebab-case" classname of the {@link OpenFin.Events emitter} that raised the event.
1753
+ *
1754
+ * @remarks {@link OpenFin.Frame} is represented as `iframe`.
1755
+ */
1739
1756
  topic: string;
1757
+ /**
1758
+ * The type of event that was raised. Equal to the typename of the event payload in "kebab case".
1759
+ *
1760
+ * @remarks Guaranteed to be unique within each {@link topic}, but can be repeated
1761
+ * between topics (e.g. {@link OpenFin.WebContentsEvents.CrashedEvent WebContentsEvents.CrashedEvent} and
1762
+ * {@link OpenFin.ApplicationEvents.CrashedEvent ApplicationEvents.CrashedEvent}).
1763
+ */
1740
1764
  type: string;
1741
1765
  };
1742
1766
 
1767
+ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1768
+
1743
1769
  /**
1744
1770
  * A base Channel event.
1745
1771
  * @interface
@@ -1792,14 +1818,22 @@ declare type BaseEvent_7 = NamedEvent & {
1792
1818
  };
1793
1819
 
1794
1820
  /**
1795
- * Base type for events emitting on the `system` topic
1821
+ * Base type for events emitting on the `global-hotkey` topic.
1822
+ *
1796
1823
  * @interface
1797
1824
  */
1798
1825
  declare type BaseEvent_8 = BaseEvents.BaseEvent & {
1799
- topic: 'system';
1826
+ topic: 'global-hotkey';
1827
+ hotkey: string;
1800
1828
  };
1801
1829
 
1802
- declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
1830
+ /**
1831
+ * Base type for events emitting on the `system` topic
1832
+ * @interface
1833
+ */
1834
+ declare type BaseEvent_9 = BaseEvents.BaseEvent & {
1835
+ topic: 'system';
1836
+ };
1803
1837
 
1804
1838
  declare namespace BaseEvents {
1805
1839
  export {
@@ -4454,6 +4488,32 @@ declare type CreateLayoutOptions = {
4454
4488
  container: HTMLElement;
4455
4489
  layoutName: string;
4456
4490
  layout: LayoutOptions;
4491
+ /**
4492
+ * @defaultValue 'default'
4493
+ *
4494
+ * Controls the View behavior for the given `layout` property. Note
4495
+ * that the selected behavior only applies to unnamed Views or
4496
+ * Views with the prefix `internal-generated-`. In all cases, if any
4497
+ * View in the `layout` does not already exist, it will be created
4498
+ * with a name that starts with `internal-generated-`.
4499
+ *
4500
+ * When set to `reparent`, Views prefixed with `internal-generated-` will
4501
+ * be reparented to the current Window and added to this new Layout.
4502
+ * Use this option when you need to transfer an existing Layout between Windows.
4503
+ *
4504
+ * When set to 'duplicate', Views prefixed with `internal-generated-` will
4505
+ * be duplicated with new generated names. Use this option when you need
4506
+ * to clone a Layout to any Window.
4507
+ *
4508
+ * When set to `default` or omitted, the Layout will attempt to re-use
4509
+ * existing Views only if they are attached to the current Window or
4510
+ * the Provider Window. Set to `default` or omit this option when creating
4511
+ * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
4512
+ * override. Note that during applyLayoutSnapshot, Views are created and
4513
+ * attached to the Provider while the Window is being created, so it's
4514
+ * important to not 'duplicate' Views in this workflow.
4515
+ */
4516
+ multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4457
4517
  };
4458
4518
 
4459
4519
  /**
@@ -4602,7 +4662,7 @@ declare interface DesktopAgent_2 {
4602
4662
  * Generated when the desktop icon is clicked while it's already running.
4603
4663
  * @interface
4604
4664
  */
4605
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4665
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4606
4666
  type: 'desktop-icon-clicked';
4607
4667
  };
4608
4668
 
@@ -5135,14 +5195,14 @@ declare type ErrorPlainObject = {
5135
5195
 
5136
5196
  /**
5137
5197
  * [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
5138
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5198
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5139
5199
  * under the {@link OpenFin.PlatformEvents} namespace.
5140
5200
  */
5141
5201
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5142
5202
 
5143
5203
  /**
5144
5204
  * [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
5145
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5205
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5146
5206
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5147
5207
  * from which they propagate).
5148
5208
  */
@@ -5150,7 +5210,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5150
5210
 
5151
5211
  /**
5152
5212
  * [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
5153
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5213
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5154
5214
  * under the {@link OpenFin.ChannelEvents} namespace.
5155
5215
  */
5156
5216
  declare type Event_2 = {
@@ -5159,7 +5219,7 @@ declare type Event_2 = {
5159
5219
 
5160
5220
  /**
5161
5221
  * [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
5162
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5222
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5163
5223
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5164
5224
  * from which they propagate).
5165
5225
  */
@@ -5167,7 +5227,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5167
5227
 
5168
5228
  /**
5169
5229
  * [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
5170
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5230
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5171
5231
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5172
5232
  */
5173
5233
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5184,21 +5244,21 @@ declare type Event_5<Topic extends string> = {
5184
5244
 
5185
5245
  /**
5186
5246
  * [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
5187
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5247
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5188
5248
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5189
5249
  */
5190
5250
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5191
5251
 
5192
5252
  /**
5193
5253
  * [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
5194
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5254
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5195
5255
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5196
5256
  */
5197
5257
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5198
5258
 
5199
5259
  /**
5200
5260
  * [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
5201
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5261
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5202
5262
  * under the {@link OpenFin.FrameEvents} namespace.
5203
5263
  */
5204
5264
  declare type Event_8 = {
@@ -5207,13 +5267,10 @@ declare type Event_8 = {
5207
5267
 
5208
5268
  /**
5209
5269
  * [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
5210
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5270
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5211
5271
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5212
5272
  */
5213
- declare type Event_9 = {
5214
- topic: 'global-hotkey';
5215
- hotkey: 'string';
5216
- } & (RegisteredEvent | UnregisteredEvent);
5273
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5217
5274
 
5218
5275
  declare class EventAggregator extends EmitterMap {
5219
5276
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6216,6 +6273,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6216
6273
 
6217
6274
  declare namespace GlobalHotkeyEvents {
6218
6275
  export {
6276
+ BaseEvent_8 as BaseEvent,
6219
6277
  RegisteredEvent,
6220
6278
  UnregisteredEvent,
6221
6279
  Event_9 as Event,
@@ -6703,7 +6761,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6703
6761
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6704
6762
  * @interface
6705
6763
  */
6706
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6764
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6707
6765
  type: 'idle-state-changed';
6708
6766
  elapsedTime: number;
6709
6767
  isIdle: boolean;
@@ -7730,7 +7788,7 @@ declare type InteropBrokerDisconnectionEvent = {
7730
7788
  * @interface
7731
7789
  */
7732
7790
  declare type InteropBrokerOptions = {
7733
- contextGroups?: ContextGroupInfo;
7791
+ contextGroups?: ContextGroupInfo[];
7734
7792
  logging?: InteropLoggingOptions;
7735
7793
  };
7736
7794
 
@@ -9632,10 +9690,17 @@ declare type MonitorInfo = {
9632
9690
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9633
9691
  * @interface
9634
9692
  */
9635
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9693
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9636
9694
  type: 'monitor-info-changed';
9637
9695
  };
9638
9696
 
9697
+ /**
9698
+ * @experimental
9699
+ *
9700
+ * Used to control view behavior for Layout.create API
9701
+ */
9702
+ declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
9703
+
9639
9704
  /**
9640
9705
  * @interface
9641
9706
  */
@@ -10351,6 +10416,7 @@ declare namespace OpenFin {
10351
10416
  LayoutManagerOverride,
10352
10417
  LayoutManager,
10353
10418
  CreateLayoutOptions,
10419
+ MultiInstanceViewBehavior,
10354
10420
  PresetLayoutOptions_2 as PresetLayoutOptions,
10355
10421
  ResultBehavior,
10356
10422
  PopupBaseBehavior,
@@ -10366,7 +10432,7 @@ declare namespace OpenFin {
10366
10432
  AppVersionCompleteEvent,
10367
10433
  AppVersionRuntimeStatusEvent,
10368
10434
  Events,
10369
- BaseEvent_9 as BaseEvent,
10435
+ BaseEvent_10 as BaseEvent,
10370
10436
  WebContentsEvent_2 as WebContentsEvent,
10371
10437
  SystemEvent_2 as SystemEvent,
10372
10438
  ApplicationEvent_2 as ApplicationEvent,
@@ -12825,7 +12891,7 @@ declare type RectangleByEdgePositions = {
12825
12891
  * Generated when a hotkey has been registered with the operating system.
12826
12892
  * @interface
12827
12893
  */
12828
- declare type RegisteredEvent = BaseEvent & {
12894
+ declare type RegisteredEvent = BaseEvent_8 & {
12829
12895
  type: 'registered';
12830
12896
  };
12831
12897
 
@@ -13247,7 +13313,7 @@ declare type ServiceIdentifier = {
13247
13313
  * Generated on changes to a user’s local computer session.
13248
13314
  * @interface
13249
13315
  */
13250
- declare type SessionChangedEvent = BaseEvent_8 & {
13316
+ declare type SessionChangedEvent = BaseEvent_9 & {
13251
13317
  type: 'session-changed';
13252
13318
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13253
13319
  };
@@ -15241,7 +15307,7 @@ declare namespace SystemEvents {
15241
15307
  export {
15242
15308
  NotRequested,
15243
15309
  ExcludeRequested,
15244
- BaseEvent_8 as BaseEvent,
15310
+ BaseEvent_9 as BaseEvent,
15245
15311
  IdleStateChangedEvent,
15246
15312
  IdleEvent,
15247
15313
  MonitorInfoChangedEvent,
@@ -15719,7 +15785,7 @@ declare interface TypedEventEmitter<Event extends {
15719
15785
  * Generated when a hotkey has been unregistered with the operating system.
15720
15786
  * @interface
15721
15787
  */
15722
- declare type UnregisteredEvent = BaseEvent & {
15788
+ declare type UnregisteredEvent = BaseEvent_8 & {
15723
15789
  type: 'unregistered';
15724
15790
  };
15725
15791
 
@@ -88,12 +88,21 @@ declare type Api = {
88
88
  iframe?: {
89
89
  /**
90
90
  * Inject OpenFin API into cross-origin iframes
91
+ *
92
+ * @defaultValue false
91
93
  */
92
94
  crossOriginInjection?: boolean;
93
95
  /**
94
96
  * Inject OpenFin API into same-origin iframes
97
+ *
98
+ * @defaultValue true
95
99
  */
96
100
  sameOriginInjection?: boolean;
101
+ /**
102
+ * @deprecated Shared names should not be used; support is provided purely for back-compat reasons.
103
+ *
104
+ * When `true`, iframes will have the same name as their parent WebContents.
105
+ */
97
106
  enableDeprecatedSharedName?: boolean;
98
107
  };
99
108
  };
@@ -881,7 +890,7 @@ declare type ApplicationConnectedEvent = ConnectedEvent_2;
881
890
  * Generated when an application is created.
882
891
  * @interface
883
892
  */
884
- declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
893
+ declare type ApplicationCreatedEvent = BaseEvent_9 & BaseEvents.IdentityEvent & {
885
894
  type: 'application-created';
886
895
  };
887
896
 
@@ -1753,13 +1762,30 @@ declare type BaseContentCreationRule = {
1753
1762
  /**
1754
1763
  * A base OpenFin event. All OpenFin event payloads extend this type.
1755
1764
  *
1765
+ * OpenFin events are jointly discriminated by their {@link topic} and {@link type} keys. Within each
1766
+ * `topic`, the `type` key is unique.
1767
+ *
1756
1768
  * @interface
1757
1769
  */
1758
1770
  declare type BaseEvent = {
1771
+ /**
1772
+ * The "kebab-case" classname of the {@link OpenFin.Events emitter} that raised the event.
1773
+ *
1774
+ * @remarks {@link OpenFin.Frame} is represented as `iframe`.
1775
+ */
1759
1776
  topic: string;
1777
+ /**
1778
+ * The type of event that was raised. Equal to the typename of the event payload in "kebab case".
1779
+ *
1780
+ * @remarks Guaranteed to be unique within each {@link topic}, but can be repeated
1781
+ * between topics (e.g. {@link OpenFin.WebContentsEvents.CrashedEvent WebContentsEvents.CrashedEvent} and
1782
+ * {@link OpenFin.ApplicationEvents.CrashedEvent ApplicationEvents.CrashedEvent}).
1783
+ */
1760
1784
  type: string;
1761
1785
  };
1762
1786
 
1787
+ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1788
+
1763
1789
  /**
1764
1790
  * A base Channel event.
1765
1791
  * @interface
@@ -1812,14 +1838,22 @@ declare type BaseEvent_7 = NamedEvent & {
1812
1838
  };
1813
1839
 
1814
1840
  /**
1815
- * Base type for events emitting on the `system` topic
1841
+ * Base type for events emitting on the `global-hotkey` topic.
1842
+ *
1816
1843
  * @interface
1817
1844
  */
1818
1845
  declare type BaseEvent_8 = BaseEvents.BaseEvent & {
1819
- topic: 'system';
1846
+ topic: 'global-hotkey';
1847
+ hotkey: string;
1820
1848
  };
1821
1849
 
1822
- declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
1850
+ /**
1851
+ * Base type for events emitting on the `system` topic
1852
+ * @interface
1853
+ */
1854
+ declare type BaseEvent_9 = BaseEvents.BaseEvent & {
1855
+ topic: 'system';
1856
+ };
1823
1857
 
1824
1858
  declare namespace BaseEvents {
1825
1859
  export {
@@ -4497,6 +4531,32 @@ declare type CreateLayoutOptions = {
4497
4531
  container: HTMLElement;
4498
4532
  layoutName: string;
4499
4533
  layout: LayoutOptions;
4534
+ /**
4535
+ * @defaultValue 'default'
4536
+ *
4537
+ * Controls the View behavior for the given `layout` property. Note
4538
+ * that the selected behavior only applies to unnamed Views or
4539
+ * Views with the prefix `internal-generated-`. In all cases, if any
4540
+ * View in the `layout` does not already exist, it will be created
4541
+ * with a name that starts with `internal-generated-`.
4542
+ *
4543
+ * When set to `reparent`, Views prefixed with `internal-generated-` will
4544
+ * be reparented to the current Window and added to this new Layout.
4545
+ * Use this option when you need to transfer an existing Layout between Windows.
4546
+ *
4547
+ * When set to 'duplicate', Views prefixed with `internal-generated-` will
4548
+ * be duplicated with new generated names. Use this option when you need
4549
+ * to clone a Layout to any Window.
4550
+ *
4551
+ * When set to `default` or omitted, the Layout will attempt to re-use
4552
+ * existing Views only if they are attached to the current Window or
4553
+ * the Provider Window. Set to `default` or omit this option when creating
4554
+ * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
4555
+ * override. Note that during applyLayoutSnapshot, Views are created and
4556
+ * attached to the Provider while the Window is being created, so it's
4557
+ * important to not 'duplicate' Views in this workflow.
4558
+ */
4559
+ multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4500
4560
  };
4501
4561
 
4502
4562
  /**
@@ -4645,7 +4705,7 @@ declare interface DesktopAgent_2 {
4645
4705
  * Generated when the desktop icon is clicked while it's already running.
4646
4706
  * @interface
4647
4707
  */
4648
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4708
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4649
4709
  type: 'desktop-icon-clicked';
4650
4710
  };
4651
4711
 
@@ -5183,14 +5243,14 @@ declare type ErrorPlainObject = {
5183
5243
 
5184
5244
  /**
5185
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 Platform}. Events are
5186
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5246
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5187
5247
  * under the {@link OpenFin.PlatformEvents} namespace.
5188
5248
  */
5189
5249
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5190
5250
 
5191
5251
  /**
5192
5252
  * [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
5193
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5253
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5194
5254
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5195
5255
  * from which they propagate).
5196
5256
  */
@@ -5198,7 +5258,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5198
5258
 
5199
5259
  /**
5200
5260
  * [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
5201
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5261
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5202
5262
  * under the {@link OpenFin.ChannelEvents} namespace.
5203
5263
  */
5204
5264
  declare type Event_2 = {
@@ -5207,7 +5267,7 @@ declare type Event_2 = {
5207
5267
 
5208
5268
  /**
5209
5269
  * [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
5210
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5270
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5211
5271
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5212
5272
  * from which they propagate).
5213
5273
  */
@@ -5215,7 +5275,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5215
5275
 
5216
5276
  /**
5217
5277
  * [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
5218
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5278
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5219
5279
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5220
5280
  */
5221
5281
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5232,21 +5292,21 @@ declare type Event_5<Topic extends string> = {
5232
5292
 
5233
5293
  /**
5234
5294
  * [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
5235
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5295
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5236
5296
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5237
5297
  */
5238
5298
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5239
5299
 
5240
5300
  /**
5241
5301
  * [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
5242
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5302
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5243
5303
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5244
5304
  */
5245
5305
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5246
5306
 
5247
5307
  /**
5248
5308
  * [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
5249
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5309
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5250
5310
  * under the {@link OpenFin.FrameEvents} namespace.
5251
5311
  */
5252
5312
  declare type Event_8 = {
@@ -5255,13 +5315,10 @@ declare type Event_8 = {
5255
5315
 
5256
5316
  /**
5257
5317
  * [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
5258
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5318
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5259
5319
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5260
5320
  */
5261
- declare type Event_9 = {
5262
- topic: 'global-hotkey';
5263
- hotkey: 'string';
5264
- } & (RegisteredEvent | UnregisteredEvent);
5321
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5265
5322
 
5266
5323
  declare class EventAggregator extends EmitterMap {
5267
5324
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6313,6 +6370,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6313
6370
 
6314
6371
  declare namespace GlobalHotkeyEvents {
6315
6372
  export {
6373
+ BaseEvent_8 as BaseEvent,
6316
6374
  RegisteredEvent,
6317
6375
  UnregisteredEvent,
6318
6376
  Event_9 as Event,
@@ -6803,7 +6861,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6803
6861
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6804
6862
  * @interface
6805
6863
  */
6806
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6864
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6807
6865
  type: 'idle-state-changed';
6808
6866
  elapsedTime: number;
6809
6867
  isIdle: boolean;
@@ -7845,7 +7903,7 @@ declare type InteropBrokerDisconnectionEvent = {
7845
7903
  * @interface
7846
7904
  */
7847
7905
  declare type InteropBrokerOptions = {
7848
- contextGroups?: ContextGroupInfo;
7906
+ contextGroups?: ContextGroupInfo[];
7849
7907
  logging?: InteropLoggingOptions;
7850
7908
  };
7851
7909
 
@@ -9931,10 +9989,17 @@ declare type MonitorInfo = {
9931
9989
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9932
9990
  * @interface
9933
9991
  */
9934
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
9992
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9935
9993
  type: 'monitor-info-changed';
9936
9994
  };
9937
9995
 
9996
+ /**
9997
+ * @experimental
9998
+ *
9999
+ * Used to control view behavior for Layout.create API
10000
+ */
10001
+ declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
10002
+
9938
10003
  /**
9939
10004
  * @interface
9940
10005
  */
@@ -10672,6 +10737,7 @@ declare namespace OpenFin {
10672
10737
  LayoutManagerOverride,
10673
10738
  LayoutManager,
10674
10739
  CreateLayoutOptions,
10740
+ MultiInstanceViewBehavior,
10675
10741
  PresetLayoutOptions_2 as PresetLayoutOptions,
10676
10742
  ResultBehavior,
10677
10743
  PopupBaseBehavior,
@@ -10687,7 +10753,7 @@ declare namespace OpenFin {
10687
10753
  AppVersionCompleteEvent,
10688
10754
  AppVersionRuntimeStatusEvent,
10689
10755
  Events,
10690
- BaseEvent_9 as BaseEvent,
10756
+ BaseEvent_10 as BaseEvent,
10691
10757
  WebContentsEvent_2 as WebContentsEvent,
10692
10758
  SystemEvent_2 as SystemEvent,
10693
10759
  ApplicationEvent_2 as ApplicationEvent,
@@ -13224,7 +13290,7 @@ declare type RectangleByEdgePositions = {
13224
13290
  * Generated when a hotkey has been registered with the operating system.
13225
13291
  * @interface
13226
13292
  */
13227
- declare type RegisteredEvent = BaseEvent & {
13293
+ declare type RegisteredEvent = BaseEvent_8 & {
13228
13294
  type: 'registered';
13229
13295
  };
13230
13296
 
@@ -13646,7 +13712,7 @@ declare type ServiceIdentifier = {
13646
13712
  * Generated on changes to a user’s local computer session.
13647
13713
  * @interface
13648
13714
  */
13649
- declare type SessionChangedEvent = BaseEvent_8 & {
13715
+ declare type SessionChangedEvent = BaseEvent_9 & {
13650
13716
  type: 'session-changed';
13651
13717
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13652
13718
  };
@@ -15646,7 +15712,7 @@ declare namespace SystemEvents {
15646
15712
  export {
15647
15713
  NotRequested,
15648
15714
  ExcludeRequested,
15649
- BaseEvent_8 as BaseEvent,
15715
+ BaseEvent_9 as BaseEvent,
15650
15716
  IdleStateChangedEvent,
15651
15717
  IdleEvent,
15652
15718
  MonitorInfoChangedEvent,
@@ -15732,7 +15798,7 @@ declare type SystemProcessInfo = {
15732
15798
  * Generated when system shutdown or log off.
15733
15799
  * @internal
15734
15800
  */
15735
- declare type SystemShutdownEvent = BaseEvent_8 & {
15801
+ declare type SystemShutdownEvent = BaseEvent_9 & {
15736
15802
  type: 'system-shutdown';
15737
15803
  };
15738
15804
 
@@ -16131,7 +16197,7 @@ declare interface TypedEventEmitter<Event extends {
16131
16197
  * Generated when a hotkey has been unregistered with the operating system.
16132
16198
  * @interface
16133
16199
  */
16134
- declare type UnregisteredEvent = BaseEvent & {
16200
+ declare type UnregisteredEvent = BaseEvent_8 & {
16135
16201
  type: 'unregistered';
16136
16202
  };
16137
16203
 
@@ -17978,6 +17978,16 @@ Object.defineProperty(frame, "__esModule", { value: true });
17978
17978
 
17979
17979
  var globalHotkey = {};
17980
17980
 
17981
+ /**
17982
+ *
17983
+ * Namespace for events that can be transmitted by {@link GlobalHotkey.GlobalHotkey}.
17984
+ *
17985
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
17986
+ *
17987
+ * For a list of valid string keys for global hotkey events, see {@link GlobalHotkey.GlobalHotkey.on GlobalHotkey.on}.
17988
+ *
17989
+ * @packageDocumentation
17990
+ */
17981
17991
  Object.defineProperty(globalHotkey, "__esModule", { value: true });
17982
17992
 
17983
17993
  var platform = {};
@@ -18042,12 +18052,9 @@ var webcontents = {};
18042
18052
  * Namespace for events shared by all OpenFin WebContents elements (i.e. {@link OpenFin.Window},
18043
18053
  * {@link OpenFin.View}).
18044
18054
  *
18045
- * WebContents events are divided into two groups: {@link WillPropagateWebContentsEvent} and {@link NonPropagatedWebContentsEvent}. Propagating events
18046
- * will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
18055
+ * WebContents events will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
18047
18056
  * parent window, and propagating events in a window will also be emitted on the window's parent {@link OpenFin.Application}.
18048
18057
  *
18049
- * Non-propagating events will not re-emit on parent entities.
18050
- *
18051
18058
  * @packageDocumentation
18052
18059
  */
18053
18060
  Object.defineProperty(webcontents, "__esModule", { value: true });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/node-adapter",
3
- "version": "34.78.74",
3
+ "version": "34.78.76",
4
4
  "description": "See README.md",
5
5
  "main": "out/node-adapter.js",
6
6
  "types": "out/node-adapter.d.ts",