@openfin/core 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 {
@@ -4450,6 +4484,32 @@ declare type CreateLayoutOptions = {
4450
4484
  container: HTMLElement;
4451
4485
  layoutName: string;
4452
4486
  layout: LayoutOptions;
4487
+ /**
4488
+ * @defaultValue 'default'
4489
+ *
4490
+ * Controls the View behavior for the given `layout` property. Note
4491
+ * that the selected behavior only applies to unnamed Views or
4492
+ * Views with the prefix `internal-generated-`. In all cases, if any
4493
+ * View in the `layout` does not already exist, it will be created
4494
+ * with a name that starts with `internal-generated-`.
4495
+ *
4496
+ * When set to `reparent`, Views prefixed with `internal-generated-` will
4497
+ * be reparented to the current Window and added to this new Layout.
4498
+ * Use this option when you need to transfer an existing Layout between Windows.
4499
+ *
4500
+ * When set to 'duplicate', Views prefixed with `internal-generated-` will
4501
+ * be duplicated with new generated names. Use this option when you need
4502
+ * to clone a Layout to any Window.
4503
+ *
4504
+ * When set to `default` or omitted, the Layout will attempt to re-use
4505
+ * existing Views only if they are attached to the current Window or
4506
+ * the Provider Window. Set to `default` or omit this option when creating
4507
+ * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
4508
+ * override. Note that during applyLayoutSnapshot, Views are created and
4509
+ * attached to the Provider while the Window is being created, so it's
4510
+ * important to not 'duplicate' Views in this workflow.
4511
+ */
4512
+ multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4453
4513
  };
4454
4514
 
4455
4515
  /**
@@ -4598,7 +4658,7 @@ declare interface DesktopAgent_2 {
4598
4658
  * Generated when the desktop icon is clicked while it's already running.
4599
4659
  * @interface
4600
4660
  */
4601
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4661
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4602
4662
  type: 'desktop-icon-clicked';
4603
4663
  };
4604
4664
 
@@ -5131,14 +5191,14 @@ declare type ErrorPlainObject = {
5131
5191
 
5132
5192
  /**
5133
5193
  * [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
5134
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5194
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5135
5195
  * under the {@link OpenFin.PlatformEvents} namespace.
5136
5196
  */
5137
5197
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5138
5198
 
5139
5199
  /**
5140
5200
  * [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
5141
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5201
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5142
5202
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5143
5203
  * from which they propagate).
5144
5204
  */
@@ -5146,7 +5206,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5146
5206
 
5147
5207
  /**
5148
5208
  * [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
5149
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5209
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5150
5210
  * under the {@link OpenFin.ChannelEvents} namespace.
5151
5211
  */
5152
5212
  declare type Event_2 = {
@@ -5155,7 +5215,7 @@ declare type Event_2 = {
5155
5215
 
5156
5216
  /**
5157
5217
  * [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
5158
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5218
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5159
5219
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5160
5220
  * from which they propagate).
5161
5221
  */
@@ -5163,7 +5223,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5163
5223
 
5164
5224
  /**
5165
5225
  * [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
5166
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5226
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5167
5227
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5168
5228
  */
5169
5229
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5180,21 +5240,21 @@ declare type Event_5<Topic extends string> = {
5180
5240
 
5181
5241
  /**
5182
5242
  * [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
5183
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5243
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5184
5244
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5185
5245
  */
5186
5246
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5187
5247
 
5188
5248
  /**
5189
5249
  * [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
5190
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5250
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5191
5251
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5192
5252
  */
5193
5253
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5194
5254
 
5195
5255
  /**
5196
5256
  * [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
5197
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5257
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5198
5258
  * under the {@link OpenFin.FrameEvents} namespace.
5199
5259
  */
5200
5260
  declare type Event_8 = {
@@ -5203,13 +5263,10 @@ declare type Event_8 = {
5203
5263
 
5204
5264
  /**
5205
5265
  * [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
5206
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5266
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5207
5267
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5208
5268
  */
5209
- declare type Event_9 = {
5210
- topic: 'global-hotkey';
5211
- hotkey: 'string';
5212
- } & (RegisteredEvent | UnregisteredEvent);
5269
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5213
5270
 
5214
5271
  declare class EventAggregator extends EmitterMap {
5215
5272
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6208,6 +6265,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6208
6265
 
6209
6266
  declare namespace GlobalHotkeyEvents {
6210
6267
  export {
6268
+ BaseEvent_8 as BaseEvent,
6211
6269
  RegisteredEvent,
6212
6270
  UnregisteredEvent,
6213
6271
  Event_9 as Event,
@@ -6695,7 +6753,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6695
6753
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6696
6754
  * @interface
6697
6755
  */
6698
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6756
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6699
6757
  type: 'idle-state-changed';
6700
6758
  elapsedTime: number;
6701
6759
  isIdle: boolean;
@@ -7722,7 +7780,7 @@ declare type InteropBrokerDisconnectionEvent = {
7722
7780
  * @interface
7723
7781
  */
7724
7782
  declare type InteropBrokerOptions = {
7725
- contextGroups?: ContextGroupInfo;
7783
+ contextGroups?: ContextGroupInfo[];
7726
7784
  logging?: InteropLoggingOptions;
7727
7785
  };
7728
7786
 
@@ -9622,10 +9680,17 @@ declare type MonitorInfo = {
9622
9680
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9623
9681
  * @interface
9624
9682
  */
9625
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin_2.MonitorInfo & {
9683
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin_2.MonitorInfo & {
9626
9684
  type: 'monitor-info-changed';
9627
9685
  };
9628
9686
 
9687
+ /**
9688
+ * @experimental
9689
+ *
9690
+ * Used to control view behavior for Layout.create API
9691
+ */
9692
+ declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
9693
+
9629
9694
  /**
9630
9695
  * @interface
9631
9696
  */
@@ -10341,6 +10406,7 @@ declare namespace OpenFin_2 {
10341
10406
  LayoutManagerOverride,
10342
10407
  LayoutManager,
10343
10408
  CreateLayoutOptions,
10409
+ MultiInstanceViewBehavior,
10344
10410
  PresetLayoutOptions_2 as PresetLayoutOptions,
10345
10411
  ResultBehavior,
10346
10412
  PopupBaseBehavior,
@@ -10356,7 +10422,7 @@ declare namespace OpenFin_2 {
10356
10422
  AppVersionCompleteEvent,
10357
10423
  AppVersionRuntimeStatusEvent,
10358
10424
  Events,
10359
- BaseEvent_9 as BaseEvent,
10425
+ BaseEvent_10 as BaseEvent,
10360
10426
  WebContentsEvent_2 as WebContentsEvent,
10361
10427
  SystemEvent_2 as SystemEvent,
10362
10428
  ApplicationEvent_2 as ApplicationEvent,
@@ -12815,7 +12881,7 @@ declare type RectangleByEdgePositions = {
12815
12881
  * Generated when a hotkey has been registered with the operating system.
12816
12882
  * @interface
12817
12883
  */
12818
- declare type RegisteredEvent = BaseEvent & {
12884
+ declare type RegisteredEvent = BaseEvent_8 & {
12819
12885
  type: 'registered';
12820
12886
  };
12821
12887
 
@@ -13237,7 +13303,7 @@ declare type ServiceIdentifier = {
13237
13303
  * Generated on changes to a user’s local computer session.
13238
13304
  * @interface
13239
13305
  */
13240
- declare type SessionChangedEvent = BaseEvent_8 & {
13306
+ declare type SessionChangedEvent = BaseEvent_9 & {
13241
13307
  type: 'session-changed';
13242
13308
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13243
13309
  };
@@ -15231,7 +15297,7 @@ declare namespace SystemEvents {
15231
15297
  export {
15232
15298
  NotRequested,
15233
15299
  ExcludeRequested,
15234
- BaseEvent_8 as BaseEvent,
15300
+ BaseEvent_9 as BaseEvent,
15235
15301
  IdleStateChangedEvent,
15236
15302
  IdleEvent,
15237
15303
  MonitorInfoChangedEvent,
@@ -15709,7 +15775,7 @@ declare interface TypedEventEmitter<Event extends {
15709
15775
  * Generated when a hotkey has been unregistered with the operating system.
15710
15776
  * @interface
15711
15777
  */
15712
- declare type UnregisteredEvent = BaseEvent & {
15778
+ declare type UnregisteredEvent = BaseEvent_8 & {
15713
15779
  type: 'unregistered';
15714
15780
  };
15715
15781
 
@@ -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 {
@@ -4450,6 +4484,32 @@ declare type CreateLayoutOptions = {
4450
4484
  container: HTMLElement;
4451
4485
  layoutName: string;
4452
4486
  layout: LayoutOptions;
4487
+ /**
4488
+ * @defaultValue 'default'
4489
+ *
4490
+ * Controls the View behavior for the given `layout` property. Note
4491
+ * that the selected behavior only applies to unnamed Views or
4492
+ * Views with the prefix `internal-generated-`. In all cases, if any
4493
+ * View in the `layout` does not already exist, it will be created
4494
+ * with a name that starts with `internal-generated-`.
4495
+ *
4496
+ * When set to `reparent`, Views prefixed with `internal-generated-` will
4497
+ * be reparented to the current Window and added to this new Layout.
4498
+ * Use this option when you need to transfer an existing Layout between Windows.
4499
+ *
4500
+ * When set to 'duplicate', Views prefixed with `internal-generated-` will
4501
+ * be duplicated with new generated names. Use this option when you need
4502
+ * to clone a Layout to any Window.
4503
+ *
4504
+ * When set to `default` or omitted, the Layout will attempt to re-use
4505
+ * existing Views only if they are attached to the current Window or
4506
+ * the Provider Window. Set to `default` or omit this option when creating
4507
+ * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
4508
+ * override. Note that during applyLayoutSnapshot, Views are created and
4509
+ * attached to the Provider while the Window is being created, so it's
4510
+ * important to not 'duplicate' Views in this workflow.
4511
+ */
4512
+ multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4453
4513
  };
4454
4514
 
4455
4515
  /**
@@ -4598,7 +4658,7 @@ declare interface DesktopAgent_2 {
4598
4658
  * Generated when the desktop icon is clicked while it's already running.
4599
4659
  * @interface
4600
4660
  */
4601
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4661
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4602
4662
  type: 'desktop-icon-clicked';
4603
4663
  };
4604
4664
 
@@ -5131,14 +5191,14 @@ declare type ErrorPlainObject = {
5131
5191
 
5132
5192
  /**
5133
5193
  * [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
5134
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5194
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5135
5195
  * under the {@link OpenFin.PlatformEvents} namespace.
5136
5196
  */
5137
5197
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5138
5198
 
5139
5199
  /**
5140
5200
  * [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
5141
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5201
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5142
5202
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5143
5203
  * from which they propagate).
5144
5204
  */
@@ -5146,7 +5206,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5146
5206
 
5147
5207
  /**
5148
5208
  * [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
5149
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5209
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5150
5210
  * under the {@link OpenFin.ChannelEvents} namespace.
5151
5211
  */
5152
5212
  declare type Event_2 = {
@@ -5155,7 +5215,7 @@ declare type Event_2 = {
5155
5215
 
5156
5216
  /**
5157
5217
  * [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
5158
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5218
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5159
5219
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5160
5220
  * from which they propagate).
5161
5221
  */
@@ -5163,7 +5223,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5163
5223
 
5164
5224
  /**
5165
5225
  * [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
5166
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5226
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5167
5227
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5168
5228
  */
5169
5229
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5180,21 +5240,21 @@ declare type Event_5<Topic extends string> = {
5180
5240
 
5181
5241
  /**
5182
5242
  * [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
5183
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5243
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5184
5244
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5185
5245
  */
5186
5246
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5187
5247
 
5188
5248
  /**
5189
5249
  * [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
5190
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5250
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5191
5251
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5192
5252
  */
5193
5253
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5194
5254
 
5195
5255
  /**
5196
5256
  * [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
5197
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5257
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5198
5258
  * under the {@link OpenFin.FrameEvents} namespace.
5199
5259
  */
5200
5260
  declare type Event_8 = {
@@ -5203,13 +5263,10 @@ declare type Event_8 = {
5203
5263
 
5204
5264
  /**
5205
5265
  * [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
5206
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5266
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5207
5267
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5208
5268
  */
5209
- declare type Event_9 = {
5210
- topic: 'global-hotkey';
5211
- hotkey: 'string';
5212
- } & (RegisteredEvent | UnregisteredEvent);
5269
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5213
5270
 
5214
5271
  declare class EventAggregator extends EmitterMap {
5215
5272
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6208,6 +6265,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6208
6265
 
6209
6266
  declare namespace GlobalHotkeyEvents {
6210
6267
  export {
6268
+ BaseEvent_8 as BaseEvent,
6211
6269
  RegisteredEvent,
6212
6270
  UnregisteredEvent,
6213
6271
  Event_9 as Event,
@@ -6695,7 +6753,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6695
6753
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6696
6754
  * @interface
6697
6755
  */
6698
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6756
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6699
6757
  type: 'idle-state-changed';
6700
6758
  elapsedTime: number;
6701
6759
  isIdle: boolean;
@@ -7722,7 +7780,7 @@ declare type InteropBrokerDisconnectionEvent = {
7722
7780
  * @interface
7723
7781
  */
7724
7782
  declare type InteropBrokerOptions = {
7725
- contextGroups?: ContextGroupInfo;
7783
+ contextGroups?: ContextGroupInfo[];
7726
7784
  logging?: InteropLoggingOptions;
7727
7785
  };
7728
7786
 
@@ -9622,10 +9680,17 @@ declare type MonitorInfo = {
9622
9680
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9623
9681
  * @interface
9624
9682
  */
9625
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin_2.MonitorInfo & {
9683
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin_2.MonitorInfo & {
9626
9684
  type: 'monitor-info-changed';
9627
9685
  };
9628
9686
 
9687
+ /**
9688
+ * @experimental
9689
+ *
9690
+ * Used to control view behavior for Layout.create API
9691
+ */
9692
+ declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
9693
+
9629
9694
  /**
9630
9695
  * @interface
9631
9696
  */
@@ -10341,6 +10406,7 @@ declare namespace OpenFin_2 {
10341
10406
  LayoutManagerOverride,
10342
10407
  LayoutManager,
10343
10408
  CreateLayoutOptions,
10409
+ MultiInstanceViewBehavior,
10344
10410
  PresetLayoutOptions_2 as PresetLayoutOptions,
10345
10411
  ResultBehavior,
10346
10412
  PopupBaseBehavior,
@@ -10356,7 +10422,7 @@ declare namespace OpenFin_2 {
10356
10422
  AppVersionCompleteEvent,
10357
10423
  AppVersionRuntimeStatusEvent,
10358
10424
  Events,
10359
- BaseEvent_9 as BaseEvent,
10425
+ BaseEvent_10 as BaseEvent,
10360
10426
  WebContentsEvent_2 as WebContentsEvent,
10361
10427
  SystemEvent_2 as SystemEvent,
10362
10428
  ApplicationEvent_2 as ApplicationEvent,
@@ -12815,7 +12881,7 @@ declare type RectangleByEdgePositions = {
12815
12881
  * Generated when a hotkey has been registered with the operating system.
12816
12882
  * @interface
12817
12883
  */
12818
- declare type RegisteredEvent = BaseEvent & {
12884
+ declare type RegisteredEvent = BaseEvent_8 & {
12819
12885
  type: 'registered';
12820
12886
  };
12821
12887
 
@@ -13237,7 +13303,7 @@ declare type ServiceIdentifier = {
13237
13303
  * Generated on changes to a user’s local computer session.
13238
13304
  * @interface
13239
13305
  */
13240
- declare type SessionChangedEvent = BaseEvent_8 & {
13306
+ declare type SessionChangedEvent = BaseEvent_9 & {
13241
13307
  type: 'session-changed';
13242
13308
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13243
13309
  };
@@ -15231,7 +15297,7 @@ declare namespace SystemEvents {
15231
15297
  export {
15232
15298
  NotRequested,
15233
15299
  ExcludeRequested,
15234
- BaseEvent_8 as BaseEvent,
15300
+ BaseEvent_9 as BaseEvent,
15235
15301
  IdleStateChangedEvent,
15236
15302
  IdleEvent,
15237
15303
  MonitorInfoChangedEvent,
@@ -15709,7 +15775,7 @@ declare interface TypedEventEmitter<Event extends {
15709
15775
  * Generated when a hotkey has been unregistered with the operating system.
15710
15776
  * @interface
15711
15777
  */
15712
- declare type UnregisteredEvent = BaseEvent & {
15778
+ declare type UnregisteredEvent = BaseEvent_8 & {
15713
15779
  type: 'unregistered';
15714
15780
  };
15715
15781
 
@@ -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 {
@@ -4450,6 +4484,32 @@ declare type CreateLayoutOptions = {
4450
4484
  container: HTMLElement;
4451
4485
  layoutName: string;
4452
4486
  layout: LayoutOptions;
4487
+ /**
4488
+ * @defaultValue 'default'
4489
+ *
4490
+ * Controls the View behavior for the given `layout` property. Note
4491
+ * that the selected behavior only applies to unnamed Views or
4492
+ * Views with the prefix `internal-generated-`. In all cases, if any
4493
+ * View in the `layout` does not already exist, it will be created
4494
+ * with a name that starts with `internal-generated-`.
4495
+ *
4496
+ * When set to `reparent`, Views prefixed with `internal-generated-` will
4497
+ * be reparented to the current Window and added to this new Layout.
4498
+ * Use this option when you need to transfer an existing Layout between Windows.
4499
+ *
4500
+ * When set to 'duplicate', Views prefixed with `internal-generated-` will
4501
+ * be duplicated with new generated names. Use this option when you need
4502
+ * to clone a Layout to any Window.
4503
+ *
4504
+ * When set to `default` or omitted, the Layout will attempt to re-use
4505
+ * existing Views only if they are attached to the current Window or
4506
+ * the Provider Window. Set to `default` or omit this option when creating
4507
+ * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
4508
+ * override. Note that during applyLayoutSnapshot, Views are created and
4509
+ * attached to the Provider while the Window is being created, so it's
4510
+ * important to not 'duplicate' Views in this workflow.
4511
+ */
4512
+ multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4453
4513
  };
4454
4514
 
4455
4515
  /**
@@ -4598,7 +4658,7 @@ declare interface DesktopAgent_2 {
4598
4658
  * Generated when the desktop icon is clicked while it's already running.
4599
4659
  * @interface
4600
4660
  */
4601
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4661
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4602
4662
  type: 'desktop-icon-clicked';
4603
4663
  };
4604
4664
 
@@ -5131,14 +5191,14 @@ declare type ErrorPlainObject = {
5131
5191
 
5132
5192
  /**
5133
5193
  * [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
5134
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5194
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5135
5195
  * under the {@link OpenFin.PlatformEvents} namespace.
5136
5196
  */
5137
5197
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5138
5198
 
5139
5199
  /**
5140
5200
  * [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
5141
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5201
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5142
5202
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5143
5203
  * from which they propagate).
5144
5204
  */
@@ -5146,7 +5206,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5146
5206
 
5147
5207
  /**
5148
5208
  * [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
5149
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5209
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5150
5210
  * under the {@link OpenFin.ChannelEvents} namespace.
5151
5211
  */
5152
5212
  declare type Event_2 = {
@@ -5155,7 +5215,7 @@ declare type Event_2 = {
5155
5215
 
5156
5216
  /**
5157
5217
  * [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
5158
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5218
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5159
5219
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5160
5220
  * from which they propagate).
5161
5221
  */
@@ -5163,7 +5223,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5163
5223
 
5164
5224
  /**
5165
5225
  * [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
5166
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5226
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5167
5227
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5168
5228
  */
5169
5229
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5180,21 +5240,21 @@ declare type Event_5<Topic extends string> = {
5180
5240
 
5181
5241
  /**
5182
5242
  * [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
5183
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5243
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5184
5244
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5185
5245
  */
5186
5246
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5187
5247
 
5188
5248
  /**
5189
5249
  * [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
5190
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5250
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5191
5251
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5192
5252
  */
5193
5253
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5194
5254
 
5195
5255
  /**
5196
5256
  * [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
5197
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5257
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5198
5258
  * under the {@link OpenFin.FrameEvents} namespace.
5199
5259
  */
5200
5260
  declare type Event_8 = {
@@ -5203,13 +5263,10 @@ declare type Event_8 = {
5203
5263
 
5204
5264
  /**
5205
5265
  * [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
5206
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5266
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5207
5267
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5208
5268
  */
5209
- declare type Event_9 = {
5210
- topic: 'global-hotkey';
5211
- hotkey: 'string';
5212
- } & (RegisteredEvent | UnregisteredEvent);
5269
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5213
5270
 
5214
5271
  declare class EventAggregator extends EmitterMap {
5215
5272
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6208,6 +6265,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6208
6265
 
6209
6266
  declare namespace GlobalHotkeyEvents {
6210
6267
  export {
6268
+ BaseEvent_8 as BaseEvent,
6211
6269
  RegisteredEvent,
6212
6270
  UnregisteredEvent,
6213
6271
  Event_9 as Event,
@@ -6695,7 +6753,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6695
6753
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6696
6754
  * @interface
6697
6755
  */
6698
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6756
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6699
6757
  type: 'idle-state-changed';
6700
6758
  elapsedTime: number;
6701
6759
  isIdle: boolean;
@@ -7722,7 +7780,7 @@ declare type InteropBrokerDisconnectionEvent = {
7722
7780
  * @interface
7723
7781
  */
7724
7782
  declare type InteropBrokerOptions = {
7725
- contextGroups?: ContextGroupInfo;
7783
+ contextGroups?: ContextGroupInfo[];
7726
7784
  logging?: InteropLoggingOptions;
7727
7785
  };
7728
7786
 
@@ -9622,10 +9680,17 @@ declare type MonitorInfo = {
9622
9680
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9623
9681
  * @interface
9624
9682
  */
9625
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin_2.MonitorInfo & {
9683
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin_2.MonitorInfo & {
9626
9684
  type: 'monitor-info-changed';
9627
9685
  };
9628
9686
 
9687
+ /**
9688
+ * @experimental
9689
+ *
9690
+ * Used to control view behavior for Layout.create API
9691
+ */
9692
+ declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
9693
+
9629
9694
  /**
9630
9695
  * @interface
9631
9696
  */
@@ -10341,6 +10406,7 @@ declare namespace OpenFin_2 {
10341
10406
  LayoutManagerOverride,
10342
10407
  LayoutManager,
10343
10408
  CreateLayoutOptions,
10409
+ MultiInstanceViewBehavior,
10344
10410
  PresetLayoutOptions_2 as PresetLayoutOptions,
10345
10411
  ResultBehavior,
10346
10412
  PopupBaseBehavior,
@@ -10356,7 +10422,7 @@ declare namespace OpenFin_2 {
10356
10422
  AppVersionCompleteEvent,
10357
10423
  AppVersionRuntimeStatusEvent,
10358
10424
  Events,
10359
- BaseEvent_9 as BaseEvent,
10425
+ BaseEvent_10 as BaseEvent,
10360
10426
  WebContentsEvent_2 as WebContentsEvent,
10361
10427
  SystemEvent_2 as SystemEvent,
10362
10428
  ApplicationEvent_2 as ApplicationEvent,
@@ -12815,7 +12881,7 @@ declare type RectangleByEdgePositions = {
12815
12881
  * Generated when a hotkey has been registered with the operating system.
12816
12882
  * @interface
12817
12883
  */
12818
- declare type RegisteredEvent = BaseEvent & {
12884
+ declare type RegisteredEvent = BaseEvent_8 & {
12819
12885
  type: 'registered';
12820
12886
  };
12821
12887
 
@@ -13237,7 +13303,7 @@ declare type ServiceIdentifier = {
13237
13303
  * Generated on changes to a user’s local computer session.
13238
13304
  * @interface
13239
13305
  */
13240
- declare type SessionChangedEvent = BaseEvent_8 & {
13306
+ declare type SessionChangedEvent = BaseEvent_9 & {
13241
13307
  type: 'session-changed';
13242
13308
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13243
13309
  };
@@ -15231,7 +15297,7 @@ declare namespace SystemEvents {
15231
15297
  export {
15232
15298
  NotRequested,
15233
15299
  ExcludeRequested,
15234
- BaseEvent_8 as BaseEvent,
15300
+ BaseEvent_9 as BaseEvent,
15235
15301
  IdleStateChangedEvent,
15236
15302
  IdleEvent,
15237
15303
  MonitorInfoChangedEvent,
@@ -15709,7 +15775,7 @@ declare interface TypedEventEmitter<Event extends {
15709
15775
  * Generated when a hotkey has been unregistered with the operating system.
15710
15776
  * @interface
15711
15777
  */
15712
- declare type UnregisteredEvent = BaseEvent & {
15778
+ declare type UnregisteredEvent = BaseEvent_8 & {
15713
15779
  type: 'unregistered';
15714
15780
  };
15715
15781
 
package/out/mock.d.ts CHANGED
@@ -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 {
@@ -4493,6 +4527,32 @@ declare type CreateLayoutOptions = {
4493
4527
  container: HTMLElement;
4494
4528
  layoutName: string;
4495
4529
  layout: LayoutOptions;
4530
+ /**
4531
+ * @defaultValue 'default'
4532
+ *
4533
+ * Controls the View behavior for the given `layout` property. Note
4534
+ * that the selected behavior only applies to unnamed Views or
4535
+ * Views with the prefix `internal-generated-`. In all cases, if any
4536
+ * View in the `layout` does not already exist, it will be created
4537
+ * with a name that starts with `internal-generated-`.
4538
+ *
4539
+ * When set to `reparent`, Views prefixed with `internal-generated-` will
4540
+ * be reparented to the current Window and added to this new Layout.
4541
+ * Use this option when you need to transfer an existing Layout between Windows.
4542
+ *
4543
+ * When set to 'duplicate', Views prefixed with `internal-generated-` will
4544
+ * be duplicated with new generated names. Use this option when you need
4545
+ * to clone a Layout to any Window.
4546
+ *
4547
+ * When set to `default` or omitted, the Layout will attempt to re-use
4548
+ * existing Views only if they are attached to the current Window or
4549
+ * the Provider Window. Set to `default` or omit this option when creating
4550
+ * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
4551
+ * override. Note that during applyLayoutSnapshot, Views are created and
4552
+ * attached to the Provider while the Window is being created, so it's
4553
+ * important to not 'duplicate' Views in this workflow.
4554
+ */
4555
+ multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4496
4556
  };
4497
4557
 
4498
4558
  /**
@@ -4641,7 +4701,7 @@ declare interface DesktopAgent_2 {
4641
4701
  * Generated when the desktop icon is clicked while it's already running.
4642
4702
  * @interface
4643
4703
  */
4644
- declare type DesktopIconClickedEvent = BaseEvent_8 & {
4704
+ declare type DesktopIconClickedEvent = BaseEvent_9 & {
4645
4705
  type: 'desktop-icon-clicked';
4646
4706
  };
4647
4707
 
@@ -5179,14 +5239,14 @@ declare type ErrorPlainObject = {
5179
5239
 
5180
5240
  /**
5181
5241
  * [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
5182
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
5242
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Platform` can be found
5183
5243
  * under the {@link OpenFin.PlatformEvents} namespace.
5184
5244
  */
5185
5245
  declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
5186
5246
 
5187
5247
  /**
5188
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 System}. Events are
5189
- * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
5249
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `System` can be found
5190
5250
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5191
5251
  * from which they propagate).
5192
5252
  */
@@ -5194,7 +5254,7 @@ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>>
5194
5254
 
5195
5255
  /**
5196
5256
  * [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
5197
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
5257
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Channel` can be found
5198
5258
  * under the {@link OpenFin.ChannelEvents} namespace.
5199
5259
  */
5200
5260
  declare type Event_2 = {
@@ -5203,7 +5263,7 @@ declare type Event_2 = {
5203
5263
 
5204
5264
  /**
5205
5265
  * [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
5206
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
5266
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Application` can be found
5207
5267
  * under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
5208
5268
  * from which they propagate).
5209
5269
  */
@@ -5211,7 +5271,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5211
5271
 
5212
5272
  /**
5213
5273
  * [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
5214
- * discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
5274
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `View` can be found
5215
5275
  * under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5216
5276
  */
5217
5277
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
@@ -5228,21 +5288,21 @@ declare type Event_5<Topic extends string> = {
5228
5288
 
5229
5289
  /**
5230
5290
  * [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
5231
- * discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
5291
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Window` can be found
5232
5292
  * under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
5233
5293
  */
5234
5294
  declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
5235
5295
 
5236
5296
  /**
5237
5297
  * [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
5238
- * discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5298
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
5239
5299
  * under the {@link OpenFin.ExternalApplicationEvents} namespace.
5240
5300
  */
5241
5301
  declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
5242
5302
 
5243
5303
  /**
5244
5304
  * [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
5245
- * discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
5305
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `Frame` can be found
5246
5306
  * under the {@link OpenFin.FrameEvents} namespace.
5247
5307
  */
5248
5308
  declare type Event_8 = {
@@ -5251,13 +5311,10 @@ declare type Event_8 = {
5251
5311
 
5252
5312
  /**
5253
5313
  * [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
5254
- * discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5314
+ * discriminated by {@link BaseEvents.BaseEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
5255
5315
  * under the {@link OpenFin.GlobalHotkeyEvents} namespace.
5256
5316
  */
5257
- declare type Event_9 = {
5258
- topic: 'global-hotkey';
5259
- hotkey: 'string';
5260
- } & (RegisteredEvent | UnregisteredEvent);
5317
+ declare type Event_9 = RegisteredEvent | UnregisteredEvent;
5261
5318
 
5262
5319
  declare class EventAggregator extends EmitterMap {
5263
5320
  dispatchEvent: (message: Message<any>) => boolean;
@@ -6283,6 +6340,7 @@ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6283
6340
 
6284
6341
  declare namespace GlobalHotkeyEvents {
6285
6342
  export {
6343
+ BaseEvent_8 as BaseEvent,
6286
6344
  RegisteredEvent,
6287
6345
  UnregisteredEvent,
6288
6346
  Event_9 as Event,
@@ -6773,7 +6831,7 @@ declare type IdleEvent = IdleStateChangedEvent;
6773
6831
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6774
6832
  * @interface
6775
6833
  */
6776
- declare type IdleStateChangedEvent = BaseEvent_8 & {
6834
+ declare type IdleStateChangedEvent = BaseEvent_9 & {
6777
6835
  type: 'idle-state-changed';
6778
6836
  elapsedTime: number;
6779
6837
  isIdle: boolean;
@@ -7815,7 +7873,7 @@ declare type InteropBrokerDisconnectionEvent = {
7815
7873
  * @interface
7816
7874
  */
7817
7875
  declare type InteropBrokerOptions = {
7818
- contextGroups?: ContextGroupInfo;
7876
+ contextGroups?: ContextGroupInfo[];
7819
7877
  logging?: InteropLoggingOptions;
7820
7878
  };
7821
7879
 
@@ -9899,10 +9957,17 @@ declare type MonitorInfo = {
9899
9957
  * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9900
9958
  * @interface
9901
9959
  */
9902
- declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin_2.MonitorInfo & {
9960
+ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin_2.MonitorInfo & {
9903
9961
  type: 'monitor-info-changed';
9904
9962
  };
9905
9963
 
9964
+ /**
9965
+ * @experimental
9966
+ *
9967
+ * Used to control view behavior for Layout.create API
9968
+ */
9969
+ declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
9970
+
9906
9971
  /**
9907
9972
  * @interface
9908
9973
  */
@@ -10640,6 +10705,7 @@ declare namespace OpenFin_2 {
10640
10705
  LayoutManagerOverride,
10641
10706
  LayoutManager,
10642
10707
  CreateLayoutOptions,
10708
+ MultiInstanceViewBehavior,
10643
10709
  PresetLayoutOptions_2 as PresetLayoutOptions,
10644
10710
  ResultBehavior,
10645
10711
  PopupBaseBehavior,
@@ -10655,7 +10721,7 @@ declare namespace OpenFin_2 {
10655
10721
  AppVersionCompleteEvent,
10656
10722
  AppVersionRuntimeStatusEvent,
10657
10723
  Events,
10658
- BaseEvent_9 as BaseEvent,
10724
+ BaseEvent_10 as BaseEvent,
10659
10725
  WebContentsEvent_2 as WebContentsEvent,
10660
10726
  SystemEvent_2 as SystemEvent,
10661
10727
  ApplicationEvent_2 as ApplicationEvent,
@@ -13192,7 +13258,7 @@ declare type RectangleByEdgePositions = {
13192
13258
  * Generated when a hotkey has been registered with the operating system.
13193
13259
  * @interface
13194
13260
  */
13195
- declare type RegisteredEvent = BaseEvent & {
13261
+ declare type RegisteredEvent = BaseEvent_8 & {
13196
13262
  type: 'registered';
13197
13263
  };
13198
13264
 
@@ -13614,7 +13680,7 @@ declare type ServiceIdentifier = {
13614
13680
  * Generated on changes to a user’s local computer session.
13615
13681
  * @interface
13616
13682
  */
13617
- declare type SessionChangedEvent = BaseEvent_8 & {
13683
+ declare type SessionChangedEvent = BaseEvent_9 & {
13618
13684
  type: 'session-changed';
13619
13685
  reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
13620
13686
  };
@@ -15614,7 +15680,7 @@ declare namespace SystemEvents {
15614
15680
  export {
15615
15681
  NotRequested,
15616
15682
  ExcludeRequested,
15617
- BaseEvent_8 as BaseEvent,
15683
+ BaseEvent_9 as BaseEvent,
15618
15684
  IdleStateChangedEvent,
15619
15685
  IdleEvent,
15620
15686
  MonitorInfoChangedEvent,
@@ -15700,7 +15766,7 @@ declare type SystemProcessInfo = {
15700
15766
  * Generated when system shutdown or log off.
15701
15767
  * @internal
15702
15768
  */
15703
- declare type SystemShutdownEvent = BaseEvent_8 & {
15769
+ declare type SystemShutdownEvent = BaseEvent_9 & {
15704
15770
  type: 'system-shutdown';
15705
15771
  };
15706
15772
 
@@ -16099,7 +16165,7 @@ declare interface TypedEventEmitter<Event extends {
16099
16165
  * Generated when a hotkey has been unregistered with the operating system.
16100
16166
  * @interface
16101
16167
  */
16102
- declare type UnregisteredEvent = BaseEvent & {
16168
+ declare type UnregisteredEvent = BaseEvent_8 & {
16103
16169
  type: 'unregistered';
16104
16170
  };
16105
16171
 
package/out/mock.js CHANGED
@@ -65,6 +65,16 @@ Object.defineProperty(frame$1, "__esModule", { value: true });
65
65
 
66
66
  var globalHotkey$1 = {};
67
67
 
68
+ /**
69
+ *
70
+ * Namespace for events that can be transmitted by {@link GlobalHotkey.GlobalHotkey}.
71
+ *
72
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
73
+ *
74
+ * For a list of valid string keys for global hotkey events, see {@link GlobalHotkey.GlobalHotkey.on GlobalHotkey.on}.
75
+ *
76
+ * @packageDocumentation
77
+ */
68
78
  Object.defineProperty(globalHotkey$1, "__esModule", { value: true });
69
79
 
70
80
  var platform$1 = {};
@@ -129,12 +139,9 @@ var webcontents = {};
129
139
  * Namespace for events shared by all OpenFin WebContents elements (i.e. {@link OpenFin.Window},
130
140
  * {@link OpenFin.View}).
131
141
  *
132
- * WebContents events are divided into two groups: {@link WillPropagateWebContentsEvent} and {@link NonPropagatedWebContentsEvent}. Propagating events
133
- * will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
142
+ * WebContents events will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
134
143
  * parent window, and propagating events in a window will also be emitted on the window's parent {@link OpenFin.Application}.
135
144
  *
136
- * Non-propagating events will not re-emit on parent entities.
137
- *
138
145
  * @packageDocumentation
139
146
  */
140
147
  Object.defineProperty(webcontents, "__esModule", { value: true });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "34.78.74",
3
+ "version": "34.78.76",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/mock.js",