@openfin/node-adapter 37.80.39 → 37.81.20

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.
@@ -76,14 +76,42 @@ declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-rig
76
76
 
77
77
  declare type AnyStrategy = ChannelStrategy<any>;
78
78
 
79
+ /**
80
+ * @deprecated Renamed to {@link ApiSettings}.
81
+ */
82
+ declare type Api = ApiSettings;
83
+
84
+ declare type ApiCall<Request, Response> = {
85
+ request: Request;
86
+ response: Response;
87
+ };
88
+
89
+ declare type ApiClient<T extends Record<any, any>> = {
90
+ [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
91
+ };
92
+
93
+ /**
94
+ * @deprecated Renamed to {@link DomainApiSettings}.
95
+ */
96
+ declare type ApiInjection = DomainApiSettings;
97
+
98
+ /**
99
+ * Generated when a new Platform's API becomes responsive.
100
+ * @interface
101
+ */
102
+ declare type ApiReadyEvent = BaseEvent & {
103
+ topic: 'application';
104
+ type: 'platform-api-ready';
105
+ };
106
+
79
107
  /**
80
108
  * Configurations for API injection.
81
109
  *
82
110
  * @interface
83
111
  */
84
- declare type Api = {
112
+ declare type ApiSettings = {
85
113
  /**
86
- * Configure injection of OpenFin API into iframes based on domain
114
+ * Configure conditional injection of OpenFin API into iframes
87
115
  */
88
116
  iframe?: {
89
117
  /**
@@ -114,41 +142,6 @@ declare type Api = {
114
142
  fin?: InjectionType;
115
143
  };
116
144
 
117
- declare type ApiCall<Request, Response> = {
118
- request: Request;
119
- response: Response;
120
- };
121
-
122
- declare type ApiClient<T extends Record<any, any>> = {
123
- [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
124
- };
125
-
126
- /**
127
- * @interface
128
- *
129
- * Rules for domain-conditional `fin` API injection.
130
- */
131
- declare type ApiInjection = {
132
- /**
133
- * Injection setting for the `fin` API for contexts on a matched domain.
134
- *
135
- * * 'none': The `fin` API will be not available.
136
- * * 'global': The entire `fin` API will be available.
137
- *
138
- * @defaultValue 'global'
139
- */
140
- fin: InjectionType;
141
- };
142
-
143
- /**
144
- * Generated when a new Platform's API becomes responsive.
145
- * @interface
146
- */
147
- declare type ApiReadyEvent = BaseEvent & {
148
- topic: 'application';
149
- type: 'platform-api-ready';
150
- };
151
-
152
145
  /**
153
146
  * @interface
154
147
  */
@@ -187,31 +180,6 @@ declare type AppAssetRequest = {
187
180
  alias: string;
188
181
  };
189
182
 
190
- declare interface AppIdentifier {
191
- /** The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root' */
192
- readonly appId: string;
193
- /** An optional instance identifier, indicating that this object represents a specific instance of the application described. */
194
- readonly instanceId?: string;
195
- }
196
-
197
- /**
198
- * An interface that relates an intent to apps
199
- */
200
- declare interface AppIntent {
201
- readonly intent: IntentMetadata;
202
- readonly apps: Array<AppMetadata>;
203
- }
204
-
205
- /**
206
- * An interface that relates an intent to apps
207
- */
208
- declare interface AppIntent_2 {
209
- /** Details of the intent whose relationship to resolving applications is being described. */
210
- readonly intent: IntentMetadata_2;
211
- /** Details of applications that can resolve the intent. */
212
- readonly apps: Array<AppMetadata_2>;
213
- }
214
-
215
183
  /**
216
184
  * An object representing an application. Allows the developer to create,
217
185
  * execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
@@ -966,7 +934,7 @@ declare type ApplicationIdentity_2 = {
966
934
  * @interface
967
935
  */
968
936
  declare type ApplicationInfo = {
969
- initialOptions: ApplicationCreationOptions | PlatformOptions;
937
+ initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
970
938
  launchMode: string;
971
939
  manifest: Manifest & {
972
940
  [key: string]: any;
@@ -1422,60 +1390,6 @@ declare type ApplySnapshotPayload = {
1422
1390
  options?: ApplySnapshotOptions;
1423
1391
  };
1424
1392
 
1425
- /**
1426
- * App definition as provided by the application directory
1427
- */
1428
- declare interface AppMetadata {
1429
- /** The unique app name that can be used with the open and raiseIntent calls. */
1430
- readonly name: string;
1431
- /** The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root' */
1432
- readonly appId?: string;
1433
- /** The Version of the application. */
1434
- readonly version?: string;
1435
- /** A more user-friendly application title that can be used to render UI elements */
1436
- readonly title?: string;
1437
- /** A tooltip for the application that can be used to render UI elements */
1438
- readonly tooltip?: string;
1439
- /** A longer, multi-paragraph description for the application that could include markup */
1440
- readonly description?: string;
1441
- /** A list of icon URLs for the application that can be used to render UI elements */
1442
- readonly icons?: Array<string>;
1443
- /** A list of image URLs for the application that can be used to render UI elements */
1444
- readonly images?: Array<string>;
1445
- }
1446
-
1447
- /**
1448
- * Extends an `AppIdentifier`, describing an application or instance of an application, with additional descriptive metadata that is usually provided by an FDC3 App Directory that the desktop agent connects to.
1449
- *
1450
- * The additional information from an app directory can aid in rendering UI elements, such as a launcher menu or resolver UI. This includes a title, description, tooltip and icon and screenshot URLs.
1451
- *
1452
- * Note that as `AppMetadata` instances are also `AppIdentifiers` they may be passed to the `app` argument of `fdc3.open`, `fdc3.raiseIntent` etc.
1453
- */
1454
- declare interface AppMetadata_2 extends AppIdentifier {
1455
- /**
1456
- The 'friendly' app name.
1457
- This field was used with the `open` and `raiseIntent` calls in FDC3 <2.0, which now require an `AppIdentifier` wth `appId` set.
1458
- Note that for display purposes the `title` field should be used, if set, in preference to this field.
1459
- */
1460
- readonly name?: string;
1461
- /** The Version of the application. */
1462
- readonly version?: string;
1463
- /** An optional set of, implementation specific, metadata fields that can be used to disambiguate instances, such as a window title or screen position. Must only be set if `instanceId` is set. */
1464
- readonly instanceMetadata?: Record<string, any>;
1465
- /** A more user-friendly application title that can be used to render UI elements */
1466
- readonly title?: string;
1467
- /** A tooltip for the application that can be used to render UI elements */
1468
- readonly tooltip?: string;
1469
- /** A longer, multi-paragraph description for the application that could include markup */
1470
- readonly description?: string;
1471
- /** A list of icon URLs for the application that can be used to render UI elements */
1472
- readonly icons?: Array<Icon>;
1473
- /** Images representing the app in common usage scenarios that can be used to render UI elements */
1474
- readonly screenshots?: Array<Image_2>;
1475
- /** The type of output returned for any intent specified during resolution. May express a particular context type (e.g. "fdc3.instrument"), channel (e.g. "channel") or a channel that will receive a specified type (e.g. "channel<fdc3.instrument>"). */
1476
- readonly resultType?: string | null;
1477
- }
1478
-
1479
1393
  /**
1480
1394
  * @interface
1481
1395
  */
@@ -2369,25 +2283,7 @@ declare class Channel extends EmitterBase<ChannelEvent> {
2369
2283
 
2370
2284
  declare type Channel_2 = OpenFin.Fin['InterApplicationBus']['Channel'];
2371
2285
 
2372
- declare interface Channel_3 {
2373
- id: string;
2374
- type: string;
2375
- displayMetadata?: DisplayMetadata;
2376
- broadcast(context: Context): void;
2377
- getCurrentContext(contextType?: string): Promise<Context | null>;
2378
- addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
2379
- }
2380
-
2381
- declare interface Channel_4 {
2382
- readonly id: string;
2383
- readonly type: 'user' | 'app' | 'private';
2384
- readonly displayMetadata?: DisplayMetadata_2;
2385
- broadcast(context: Context_2): Promise<void>;
2386
- getCurrentContext(contextType?: string): Promise<Context_2 | null>;
2387
- addContextListener(contextType: string | null, handler: ContextHandler_2): Listener_2 & Promise<Listener_2>;
2388
- }
2389
-
2390
- declare type Channel_5 = OpenFin.Fin['InterApplicationBus']['Channel'];
2286
+ declare type Channel_3 = OpenFin.Fin['InterApplicationBus']['Channel'];
2391
2287
 
2392
2288
  declare type ChannelAction = OpenFin.ChannelAction;
2393
2289
 
@@ -2760,6 +2656,7 @@ declare class ChannelClient extends ChannelBase {
2760
2656
  */
2761
2657
  disconnect(): Promise<void>;
2762
2658
  sendDisconnectAction(): Promise<void>;
2659
+ /* Excluded from this release type: wireClose */
2763
2660
  }
2764
2661
 
2765
2662
  declare type ChannelClient_2 = OpenFin.ChannelClient;
@@ -3000,6 +2897,7 @@ declare class ChannelProvider extends ChannelBase {
3000
2897
  private getEndpointIdForOpenFinId;
3001
2898
  private static clientIdentityIncludesEndpointId;
3002
2899
  private static clientIsMultiRuntime;
2900
+ static wireClose(wire: Transport, channelName: string): Promise<void>;
3003
2901
  }
3004
2902
 
3005
2903
  declare type ChannelProviderDisconnectionListener = (identity: ProviderIdentity_4) => any;
@@ -3502,7 +3400,7 @@ declare type ConstViewOptions = {
3502
3400
  /**
3503
3401
  * Configurations for API injection.
3504
3402
  */
3505
- api: Api;
3403
+ api: ApiSettings;
3506
3404
  /**
3507
3405
  * The name of the view.
3508
3406
  */
@@ -3922,7 +3820,23 @@ declare interface Container extends EventEmitter_2 {
3922
3820
  close(): boolean;
3923
3821
  }
3924
3822
 
3925
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3823
+ /**
3824
+ * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
3825
+ */
3826
+ declare type ContentBlockedEvent = NamedEvent & {
3827
+ type: 'content-blocked';
3828
+ /**
3829
+ * The domain whose content was blocked.
3830
+ */
3831
+ url: string;
3832
+ };
3833
+
3834
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3835
+
3836
+ /**
3837
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3838
+ */
3839
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3926
3840
 
3927
3841
  /**
3928
3842
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3946,7 +3860,7 @@ declare type ContentCreationOptions = {
3946
3860
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3947
3861
  * the specified `behavior` key.
3948
3862
  */
3949
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3863
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3950
3864
  behavior: Behavior;
3951
3865
  }>;
3952
3866
 
@@ -4196,39 +4110,39 @@ declare interface ContentItem extends EventEmitter_2 {
4196
4110
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4197
4111
  * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4198
4112
  *
4113
+ * @remarks Superseded by {@link DomainSettingsRule.content}. If {@link DomainSettings.default} includes a
4114
+ * `content` setting, this setting will be **ignored**.
4115
+ *
4199
4116
  * @interface
4200
4117
  */
4201
4118
  declare type ContentNavigation = NavigationRules;
4202
4119
 
4120
+ /**
4121
+ * Whether a content url is allowed or blocked for navigation or redirection.
4122
+ *
4123
+ * * 'allow': The content url is allowed.
4124
+ * * 'block': The content url is blocked.
4125
+ */
4126
+ declare type ContentPermission = 'allow' | 'block';
4127
+
4203
4128
  /**
4204
4129
  * Restrict redirects to URLs that match an allowed pattern.
4205
4130
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4206
4131
  * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4207
4132
  *
4133
+ * @remarks Superseded by {@link DomainSettingsRule.content}. If {@link DomainSettings.default} includes a
4134
+ * `content` setting, this setting will be **ignored**.
4135
+ *
4208
4136
  * @interface
4209
4137
  */
4210
4138
  declare type ContentRedirect = NavigationRules;
4211
4139
 
4212
- declare interface Context {
4213
- id?: { [key: string]: string };
4214
- name?: string;
4215
- type: string;
4216
- }
4217
-
4218
- declare interface Context_2 {
4219
- id?: { [key: string]: string };
4220
- name?: string;
4221
- type: string;
4222
- contextMetadata?: ContextMetadata;
4223
- metadata?: any;
4224
- }
4225
-
4226
4140
  /**
4227
4141
  * Data passed between entities and applications.
4228
4142
  *
4229
4143
  * @interface
4230
4144
  */
4231
- declare type Context_3 = {
4145
+ declare type Context = {
4232
4146
  /**
4233
4147
  * An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
4234
4148
  */
@@ -4257,7 +4171,7 @@ declare type ContextChangedEvent = BaseEvent_5 & {
4257
4171
  /**
4258
4172
  * @interface
4259
4173
  */
4260
- declare type ContextForIntent<MetadataType = any> = Context_3 & {
4174
+ declare type ContextForIntent<MetadataType = any> = Context & {
4261
4175
  metadata?: MetadataType;
4262
4176
  };
4263
4177
 
@@ -4273,23 +4187,19 @@ declare type ContextGroupInfo = {
4273
4187
  /**
4274
4188
  * Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.
4275
4189
  */
4276
- displayMetadata?: DisplayMetadata_3;
4190
+ displayMetadata?: DisplayMetadata;
4277
4191
  };
4278
4192
 
4279
4193
  declare type ContextGroupStates = {
4280
4194
  [key: string]: {
4281
- [key: string]: Context_3;
4195
+ [key: string]: Context;
4282
4196
  };
4283
4197
  };
4284
4198
 
4285
- declare type ContextHandler = (context: Context) => void;
4286
-
4287
- declare type ContextHandler_2 = (context: Context_2, metadata?: ContextMetadata) => void;
4288
-
4289
4199
  /**
4290
4200
  * Subscription function for addContextHandler.
4291
4201
  */
4292
- declare type ContextHandler_3 = (context: Context_3) => void;
4202
+ declare type ContextHandler = (context: Context) => void;
4293
4203
 
4294
4204
  /**
4295
4205
  * Configure the context menu when right-clicking on a window.
@@ -4328,20 +4238,6 @@ declare type ContextMenuSettings = {
4328
4238
  reload?: boolean;
4329
4239
  };
4330
4240
 
4331
- /**
4332
- * Metadata relating to a context or intent and context received through the
4333
- * `addContextListener` and `addIntentListener` functions.
4334
- *
4335
- * @experimental Introduced in FDC3 2.0 and may be refined by further changes outside the normal FDC3 versioning policy.
4336
- */
4337
- declare interface ContextMetadata {
4338
- /** Identifier for the app instance that sent the context and/or intent.
4339
- *
4340
- * @experimental
4341
- */
4342
- readonly source: AppIdentifier;
4343
- }
4344
-
4345
4241
  /**
4346
4242
  * @interface
4347
4243
  */
@@ -4588,45 +4484,6 @@ declare type DefaultDomainSettings = DomainSettings;
4588
4484
  */
4589
4485
  declare type DefaultDomainSettingsRule = DomainSettingsRule;
4590
4486
 
4591
- declare interface DesktopAgent {
4592
- open(app: TargetApp, context?: Context): Promise<void>;
4593
- findIntent(intent: string, context?: Context): Promise<AppIntent>;
4594
- findIntentsByContext(context: Context): Promise<Array<AppIntent>>;
4595
- broadcast(context: Context): void;
4596
- raiseIntent(intent: string, context: Context, app?: TargetApp): Promise<IntentResolution>;
4597
- raiseIntentForContext(context: Context, app?: TargetApp): Promise<IntentResolution>;
4598
- addIntentListener(intent: string, handler: ContextHandler): Listener;
4599
- joinChannel(channelId: string): Promise<void>;
4600
- leaveCurrentChannel(): Promise<void>;
4601
- getInfo(): ImplementationMetadata;
4602
- addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
4603
- getOrCreateChannel(channelId: string): Promise<Channel_3>;
4604
- getSystemChannels(): Promise<SystemChannel[]>;
4605
- getCurrentChannel(): Promise<Channel_3 | null>;
4606
- }
4607
-
4608
- declare interface DesktopAgent_2 {
4609
- open(app: AppIdentifier | TargetApp, context?: Context_2): Promise<AppIdentifier>;
4610
- findIntent(intent: string, context?: Context_2, resultType?: string): Promise<AppIntent_2>;
4611
- findIntentsByContext(context: Context_2, resultType?: string): Promise<Array<AppIntent_2>>;
4612
- findInstances(app: AppIdentifier): Promise<Array<AppIdentifier>>;
4613
- broadcast(context: Context_2): Promise<void>;
4614
- raiseIntent(intent: string, context: Context_2, app?: AppIdentifier | TargetApp): Promise<IntentResolution_2>;
4615
- raiseIntentForContext(context: Context_2, app?: AppIdentifier | TargetApp): Promise<IntentResolution_2>;
4616
- addIntentListener(intent: string, handler: IntentHandler): Promise<Listener_2>;
4617
- addContextListener(contextType: string | null, handler: ContextHandler_2): Promise<Listener_2>;
4618
- getUserChannels(): Promise<Array<SystemChannel>>;
4619
- joinUserChannel(channelId: string): Promise<void>;
4620
- getOrCreateChannel(channelId: string): Promise<Channel_4>;
4621
- createPrivateChannel(): Promise<PrivateChannel>;
4622
- getCurrentChannel(): Promise<Channel_3 | null>;
4623
- leaveCurrentChannel(): Promise<void>;
4624
- getInfo(): Promise<ImplementationMetadata_2>;
4625
- getAppMetadata(app: AppIdentifier): Promise<AppMetadata_2>;
4626
- getSystemChannels(): Promise<Array<SystemChannel>>;
4627
- joinChannel(channelId: string): Promise<void>;
4628
- }
4629
-
4630
4487
  /**
4631
4488
  * Generated when the desktop icon is clicked while it's already running.
4632
4489
  * @interface
@@ -4771,52 +4628,12 @@ declare type DisconnectedEvent_3 = BaseFrameEvent & {
4771
4628
  type: 'disconnected';
4772
4629
  };
4773
4630
 
4774
- /**
4775
- * A system channel will be global enough to have a presence across many apps. This gives us some hints
4776
- * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
4777
- * this is their meaning.
4778
- */
4779
- declare interface DisplayMetadata {
4780
- /**
4781
- * A user-readable name for this channel, e.g: `"Red"`
4782
- */
4783
- readonly name?: string;
4784
- /**
4785
- * The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
4786
- */
4787
- readonly color?: string;
4788
- /**
4789
- * A URL of an image that can be used to display this channel
4790
- */
4791
- readonly glyph?: string;
4792
- }
4793
-
4794
- /**
4795
- * A system channel will be global enough to have a presence across many apps. This gives us some hints
4796
- * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
4797
- * this is their meaning.
4798
- */
4799
- declare interface DisplayMetadata_2 {
4800
- /**
4801
- * A user-readable name for this channel, e.g: `"Red"`
4802
- */
4803
- readonly name?: string;
4804
- /**
4805
- * The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
4806
- */
4807
- readonly color?: string;
4808
- /**
4809
- * A URL of an image that can be used to display this channel
4810
- */
4811
- readonly glyph?: string;
4812
- }
4813
-
4814
4631
  /**
4815
4632
  * The display data for a context group.
4816
4633
  *
4817
4634
  * @interface
4818
4635
  */
4819
- declare type DisplayMetadata_3 = {
4636
+ declare type DisplayMetadata = {
4820
4637
  /**
4821
4638
  * A user-readable name for this context group, e.g: `"Red"`
4822
4639
  */
@@ -4831,6 +4648,25 @@ declare type DisplayMetadata_3 = {
4831
4648
  readonly glyph?: string;
4832
4649
  };
4833
4650
 
4651
+ /**
4652
+ * @interface
4653
+ *
4654
+ * Rules for domain-conditional `fin` API injection.
4655
+ *
4656
+ * @remarks Subset of {@link DomainSettings}.
4657
+ */
4658
+ declare type DomainApiSettings = {
4659
+ /**
4660
+ * Injection setting for the `fin` API for contexts on a matched domain.
4661
+ *
4662
+ * * 'none': The `fin` API will be not available.
4663
+ * * 'global': The entire `fin` API will be available.
4664
+ *
4665
+ * @defaultValue 'global'
4666
+ */
4667
+ fin: InjectionType;
4668
+ };
4669
+
4834
4670
  /**
4835
4671
  * @interface
4836
4672
  * Defines application settings that vary by the domain of the current context.
@@ -4843,6 +4679,10 @@ declare type DomainSettings = {
4843
4679
  * {@inheritDoc DomainSettingsRule}
4844
4680
  */
4845
4681
  rules: DomainSettingsRule[];
4682
+ /**
4683
+ * Default values for settings in {@link DomainSettingsRule}.
4684
+ */
4685
+ default?: PerDomainSettings;
4846
4686
  };
4847
4687
 
4848
4688
  /**
@@ -4855,22 +4695,11 @@ declare type DomainSettingsRule = {
4855
4695
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4856
4696
  * the domain(s) for which the rule applies.
4857
4697
  */
4858
- match: string[];
4698
+ match?: string[];
4859
4699
  /**
4860
4700
  * Settings applied when a webcontents has been navigated to a matched domain.
4861
4701
  */
4862
- options: {
4863
- /**
4864
- * {@inheritDoc FileDownloadSettings}
4865
- *
4866
- * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
4867
- */
4868
- downloadSettings?: FileDownloadSettings;
4869
- /**
4870
- * {@inheritDoc ApiInjection}
4871
- */
4872
- api?: ApiInjection;
4873
- };
4702
+ options: PerDomainSettings;
4874
4703
  };
4875
4704
 
4876
4705
  /**
@@ -4908,18 +4737,19 @@ declare type DownloadPreloadOption = {
4908
4737
  /**
4909
4738
  * @interface
4910
4739
  *
4911
- * A rule governing domain-conditional download behavior.
4740
+ * A rule that governs download behavior, discriminated by the URL of the download.
4912
4741
  */
4913
4742
  declare type DownloadRule = {
4914
4743
  /**
4915
- * {@inheritDoc FileDownloadBehaviorNames}
4744
+ * {@inheritDoc FileDownloadBehavior}
4916
4745
  */
4917
- behavior: FileDownloadBehaviorNames;
4746
+ behavior: FileDownloadBehavior;
4918
4747
  /**
4919
4748
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4920
- * the domain(s) for which the rule applies.
4749
+ * URL(s) of the resource(s) being downloaded.
4921
4750
  *
4922
- * @remarks The match is evaluated against the URL of the *download*.
4751
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4752
+ * of the page in which a file download link is embedded.
4923
4753
  */
4924
4754
  match: string[];
4925
4755
  };
@@ -5194,7 +5024,7 @@ declare interface Environment {
5194
5024
  getWsConstructor(): typeof WebSocket;
5195
5025
  whenReady(): Promise<void>;
5196
5026
  getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
5197
- fdc3Version?: Fdc3Version;
5027
+ fdc3Version?: Version;
5198
5028
  }>;
5199
5029
  readonly type: EnvironmentType;
5200
5030
  }
@@ -5262,7 +5092,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
5262
5092
  */
5263
5093
  declare type Event_5<Topic extends string> = {
5264
5094
  topic: Topic;
5265
- } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
5095
+ } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent | WillRedirectEvent);
5266
5096
 
5267
5097
  /**
5268
5098
  * [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
@@ -5603,13 +5433,12 @@ declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
5603
5433
 
5604
5434
  declare namespace FDC3 {
5605
5435
  export {
5606
- v1,
5607
- v2
5436
+ Version,
5437
+ v1_2,
5438
+ v2_0
5608
5439
  }
5609
5440
  }
5610
5441
 
5611
- declare type Fdc3Version = '1.2' | '2.0';
5612
-
5613
5442
  /**
5614
5443
  * @interface
5615
5444
  */
@@ -5623,7 +5452,12 @@ declare type FetchManifestPayload = {
5623
5452
  /**
5624
5453
  * Whether file downloads raise a user prompt.
5625
5454
  */
5626
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5455
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5456
+
5457
+ /**
5458
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5459
+ */
5460
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5627
5461
 
5628
5462
  /**
5629
5463
  * Generated when a file download has completed.
@@ -5810,8 +5644,8 @@ declare type FindInPageResult = {
5810
5644
  /**
5811
5645
  * @interface
5812
5646
  */
5813
- declare type FindIntentsByContextOptions<MetadataType = IntentMetadata_3> = {
5814
- context: Context_3;
5647
+ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
5648
+ context: Context;
5815
5649
  metadata?: MetadataType;
5816
5650
  };
5817
5651
 
@@ -6250,6 +6084,20 @@ declare class GoldenLayout_2 implements EventEmitter_2 {
6250
6084
 
6251
6085
  dropTargetIndicator: any;
6252
6086
 
6087
+ _isFullPage: boolean;
6088
+
6089
+ _onUnload: any;
6090
+
6091
+ tabDropPlaceholder: any;
6092
+
6093
+ transitionIndicator: any;
6094
+
6095
+ _dragSources: any;
6096
+
6097
+ _resizeFunction: any;
6098
+
6099
+ _unloadFunction: any;
6100
+
6253
6101
  /**
6254
6102
  * @param config A GoldenLayout configuration object
6255
6103
  * @param container The DOM element the layout will be initialised in. Default: document.body
@@ -6578,15 +6426,6 @@ declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
6578
6426
  type: 'hotkey';
6579
6427
  };
6580
6428
 
6581
- declare interface Icon {
6582
- /** The icon url */
6583
- readonly src: string;
6584
- /** The icon dimension, formatted as `<height>x<width>`. */
6585
- readonly size?: string;
6586
- /** Icon media type. If not present the Desktop Agent may use the src file extension. */
6587
- readonly type?: string;
6588
- }
6589
-
6590
6429
  declare type Identity = OpenFin.Identity;
6591
6430
 
6592
6431
  declare type Identity_2 = OpenFin.Identity;
@@ -6645,17 +6484,6 @@ declare type IdleStateChangedEvent = BaseEvent_9 & {
6645
6484
  isIdle: boolean;
6646
6485
  };
6647
6486
 
6648
- declare interface Image_2 {
6649
- /** The image url. */
6650
- readonly src: string;
6651
- /** The image dimension, formatted as `<height>x<width>`. */
6652
- readonly size?: string;
6653
- /** Image media type. If not present the Desktop Agent may use the src file extension. */
6654
- readonly type?: string;
6655
- /** Caption for the image. */
6656
- readonly label?: string;
6657
- }
6658
-
6659
6487
  declare type ImageFormatOptions = {
6660
6488
  format: 'dataURL' | 'png' | 'bmp';
6661
6489
  } | {
@@ -6666,57 +6494,15 @@ declare type ImageFormatOptions = {
6666
6494
  quality?: number;
6667
6495
  };
6668
6496
 
6669
- /**
6670
- * Metadata relating to the FDC3 Desktop Agent implementation and its provider.
6671
- */
6672
- declare interface ImplementationMetadata {
6673
- /** The version number of the FDC3 specification that the implementation provides.
6674
- * The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
6675
- */
6676
- readonly fdc3Version: string;
6677
- /** The name of the provider of the FDC3 Desktop Agent Implementation (e.g. Finsemble, Glue42, OpenFin etc.). */
6678
- readonly provider: string;
6679
- /** The version of the provider of the FDC3 Desktop Agent Implementation (e.g. 5.3.0). */
6680
- readonly providerVersion?: string;
6681
- }
6682
-
6683
- /**
6684
- * Metadata relating to the FDC3 Desktop Agent implementation and its provider.
6685
- */
6686
- declare interface ImplementationMetadata_2 {
6687
- /** The version number of the FDC3 specification that the implementation provides.
6688
- * The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
6689
- */
6690
- readonly fdc3Version: string;
6691
- /** The name of the provider of the Desktop Agent implementation (e.g. Finsemble, Glue42, OpenFin etc.). */
6692
- readonly provider: string;
6693
- /** The version of the provider of the Desktop Agent implementation (e.g. 5.3.0). */
6694
- readonly providerVersion?: string;
6695
- /** Metadata indicating whether the Desktop Agent implements optional features of
6696
- * the Desktop Agent API.
6697
- */
6698
- readonly optionalFeatures: {
6699
- /** Used to indicate whether the exposure of 'originating app metadata' for
6700
- * context and intent messages is supported by the Desktop Agent. */
6701
- readonly OriginatingAppMetadata: boolean;
6702
- /** Used to indicate whether the optional `fdc3.joinUserChannel`,
6703
- * `fdc3.getCurrentChannel` and `fdc3.leaveCurrentChannel` are implemented by
6704
- * the Desktop Agent. */
6705
- readonly UserChannelMembershipAPIs: boolean;
6706
- };
6707
- /** The calling application instance's own metadata, according to the Desktop Agent (MUST include at least the `appId` and `instanceId`). */
6708
- readonly appMetadata: AppMetadata_2;
6709
- }
6710
-
6711
6497
  /**
6712
6498
  * @interface
6713
6499
  */
6714
- declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6500
+ declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
6715
6501
  /**
6716
6502
  * Name of the intent to get info for.
6717
6503
  */
6718
6504
  name: string;
6719
- context?: Context_3;
6505
+ context?: Context;
6720
6506
  metadata?: MetadataType;
6721
6507
  };
6722
6508
 
@@ -6824,16 +6610,10 @@ declare type InstalledApps_2 = {
6824
6610
  [key: string]: InstallationInfo;
6825
6611
  };
6826
6612
 
6827
- declare interface Intent {
6828
- name: string;
6829
- context: Context_2;
6830
- metadata: IntentMetadata_2;
6831
- }
6832
-
6833
6613
  /**
6834
6614
  * Combination of an action and a context that is passed to an application for resolution.
6835
6615
  */
6836
- declare type Intent_2<MetadataType = IntentMetadata_3> = {
6616
+ declare type Intent<MetadataType = IntentMetadata> = {
6837
6617
  /**
6838
6618
  * Name of the intent.
6839
6619
  */
@@ -6841,54 +6621,25 @@ declare type Intent_2<MetadataType = IntentMetadata_3> = {
6841
6621
  /**
6842
6622
  * Data associated with the intent.
6843
6623
  */
6844
- context: Context_3;
6624
+ context: Context;
6845
6625
  metadata?: MetadataType;
6846
6626
  };
6847
6627
 
6848
- declare type IntentHandler = (context: Context_2, metadata?: ContextMetadata) => Promise<IntentResult> | void;
6849
-
6850
6628
  /**
6851
6629
  * Subscription function for registerIntentHandler.
6852
6630
  */
6853
- declare type IntentHandler_2 = (intent: Intent_2) => void;
6631
+ declare type IntentHandler = (intent: Intent) => void;
6854
6632
 
6855
6633
  /**
6856
- * Intent descriptor
6634
+ * The type used to describe an intent within the platform.
6635
+ * @interface
6857
6636
  */
6858
- declare interface IntentMetadata {
6859
- /** The unique name of the intent that can be invoked by the raiseIntent call */
6860
- readonly name: string;
6861
- /** A friendly display name for the intent that should be used to render UI elements */
6862
- readonly displayName: string;
6863
- }
6864
-
6865
- declare type IntentMetadata_2<TargetType = any> = {
6637
+ declare type IntentMetadata<TargetType = any> = {
6866
6638
  target?: TargetType;
6867
6639
  resultType?: string;
6868
6640
  intentResolutionResultId?: string;
6869
6641
  };
6870
6642
 
6871
- /**
6872
- * The type used to describe an intent within the platform.
6873
- * @interface
6874
- */
6875
- declare type IntentMetadata_3<TargetType = any> = FDC3.v2.IntentMetadata<TargetType>;
6876
-
6877
- declare interface IntentResolution {
6878
- source: TargetApp;
6879
- data?: object;
6880
- version: string;
6881
- }
6882
-
6883
- declare interface IntentResolution_2 {
6884
- source: AppIdentifier;
6885
- intent: string;
6886
- version?: string;
6887
- getResult(): Promise<IntentResult>;
6888
- }
6889
-
6890
- declare type IntentResult = Context_2 | Channel_4 | PrivateChannel;
6891
-
6892
6643
  /**
6893
6644
  * A messaging bus that allows for pub/sub messaging between different applications.
6894
6645
  *
@@ -7134,7 +6885,6 @@ declare type InteropActionLoggingOption = {
7134
6885
  */
7135
6886
  declare class InteropBroker extends Base {
7136
6887
  #private;
7137
- private getProvider;
7138
6888
  private interopClients;
7139
6889
  private contextGroupsById;
7140
6890
  private intentClientMap;
@@ -7143,6 +6893,7 @@ declare class InteropBroker extends Base {
7143
6893
  private channel;
7144
6894
  private logging;
7145
6895
  /* Excluded from this release type: __constructor */
6896
+ private getProvider;
7146
6897
  static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
7147
6898
  new (): InteropBroker;
7148
6899
  };
@@ -7447,23 +7198,23 @@ declare class InteropBroker extends Base {
7447
7198
  * @param clientIdentity Identity of the Client making the request.
7448
7199
  */
7449
7200
  fdc3HandleOpen({ app, context }: {
7450
- app: FDC3.v1.TargetApp | FDC3.v2.AppIdentifier;
7201
+ app: FDC3.v1_2.TargetApp | FDC3.v2_0.AppIdentifier;
7451
7202
  context: OpenFin.Context;
7452
- }, clientIdentity: OpenFin.ClientIdentity): Promise<void | FDC3.v2.AppIdentifier>;
7203
+ }, clientIdentity: OpenFin.ClientIdentity): Promise<void | FDC3.v2_0.AppIdentifier>;
7453
7204
  /**
7454
7205
  * Responsible for resolving the fdc3.findInstances call.
7455
7206
  * Must be overridden
7456
7207
  * @param app AppIdentifier that was passed to fdc3.findInstances
7457
7208
  * @param clientIdentity Identity of the Client making the request.
7458
7209
  */
7459
- fdc3HandleFindInstances(app: FDC3.v2.AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
7210
+ fdc3HandleFindInstances(app: FDC3.v2_0.AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
7460
7211
  /**
7461
7212
  * Responsible for resolving the fdc3.getAppMetadata call.
7462
7213
  * Must be overridden
7463
7214
  * @param app AppIdentifier that was passed to fdc3.getAppMetadata
7464
7215
  * @param clientIdentity Identity of the Client making the request.
7465
7216
  */
7466
- fdc3HandleGetAppMetadata(app: FDC3.v2.AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
7217
+ fdc3HandleGetAppMetadata(app: FDC3.v2_0.AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
7467
7218
  /**
7468
7219
  * This function is called by the Interop Broker whenever a Context handler would fire.
7469
7220
  * For FDC3 2.0 you would need to override this function and add the contextMetadata as
@@ -7765,9 +7516,7 @@ declare class InteropClient extends Base {
7765
7516
  * ```
7766
7517
  *
7767
7518
  *
7768
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
7769
- * this, please make sure you add your context handlers at the top level of your application, on a page that
7770
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
7519
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
7771
7520
  *
7772
7521
  * ```js
7773
7522
  * function handleInstrumentContext(contextInfo) {
@@ -8057,6 +7806,23 @@ declare class InteropClient extends Base {
8057
7806
  * ```
8058
7807
  */
8059
7808
  onDisconnection(listener: OpenFin.InteropClientOnDisconnectionListener): Promise<void>;
7809
+ /**
7810
+ * Returns a representation of this Interop Client as an FDC3 DesktopAgent matching the given version.
7811
+ * Note that this does not set a global FDC3 object, it only returns an instance of the FDC3 DesktopAgent.
7812
+ * This also does not raise the FDC3Ready event.
7813
+ */
7814
+ getFDC3Sync(version: '2.0'): OpenFin.FDC3.v2_0.DesktopAgent;
7815
+ getFDC3Sync(version: '1.2'): OpenFin.FDC3.v1_2.DesktopAgent;
7816
+ getFDC3Sync(version: OpenFin.FDC3.Version): OpenFin.FDC3.v1_2.DesktopAgent | OpenFin.FDC3.v2_0.DesktopAgent;
7817
+ /**
7818
+ *
7819
+ * Returns a representation of this Interop Client as an FDC3 DesktopAgent matching the given version.
7820
+ * Note that this does not set a global FDC3 object, it only returns an instance of the FDC3 DesktopAgent.
7821
+ * This also does not raise the FDC3Ready event.
7822
+ */
7823
+ getFDC3(version: '2.0'): Promise<OpenFin.FDC3.v2_0.DesktopAgent>;
7824
+ getFDC3(version: '1.2'): Promise<OpenFin.FDC3.v1_2.DesktopAgent>;
7825
+ getFDC3(version: OpenFin.FDC3.Version): Promise<OpenFin.FDC3.v1_2.DesktopAgent | OpenFin.FDC3.v2_0.DesktopAgent>;
8060
7826
  /* Excluded from this release type: ferryFdc3Call */
8061
7827
  }
8062
7828
 
@@ -9103,21 +8869,7 @@ declare type LayoutSnapshot = {
9103
8869
  */
9104
8870
  declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | 'frame' | 'hideOnClose' | 'icon' | 'maxHeight' | 'maximizable' | 'maxWidth' | 'minHeight' | 'minimizable' | 'minWidth' | 'opacity' | 'preloadScripts' | 'resizable' | 'resizeRegion' | 'saveWindowState' | 'ignoreSavedWindowState' | 'shadow' | 'showTaskbarIcon' | 'smallWindow' | 'state' | 'taskbarIconGroup' | 'waitForPageLoad' | '_internalWorkspaceData'>;
9105
8871
 
9106
- declare interface Listener {
9107
- /**
9108
- * Unsubscribe the listener object.
9109
- */
9110
- unsubscribe(): void;
9111
- }
9112
-
9113
- declare interface Listener_2 {
9114
- /**
9115
- * Unsubscribe the listener object.
9116
- */
9117
- unsubscribe(): void;
9118
- }
9119
-
9120
- declare type Listener_3<T extends {
8872
+ declare type Listener<T extends {
9121
8873
  type: string;
9122
8874
  }> = (payload: T) => void;
9123
8875
 
@@ -9506,7 +9258,7 @@ declare type MutableViewOptions = {
9506
9258
  /**
9507
9259
  * Configurations for API injection.
9508
9260
  */
9509
- api: Api;
9261
+ api: ApiSettings;
9510
9262
  /**
9511
9263
  * Restrict navigation to URLs that match an allowed pattern.
9512
9264
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -9884,6 +9636,7 @@ declare namespace OpenFin {
9884
9636
  export {
9885
9637
  FinApi,
9886
9638
  Fin_2 as Fin,
9639
+ FDC3,
9887
9640
  Application,
9888
9641
  ApplicationModule,
9889
9642
  ExternalApplication,
@@ -9935,11 +9688,11 @@ declare namespace OpenFin {
9935
9688
  CustomProtocolOptions,
9936
9689
  InteropBrokerOptions,
9937
9690
  ContextGroupInfo,
9938
- DisplayMetadata_3 as DisplayMetadata,
9691
+ DisplayMetadata,
9939
9692
  LegacyWinOptionsInAppOptions,
9940
9693
  Snapshot,
9941
9694
  ContextGroupStates,
9942
- Context_3 as Context,
9695
+ Context,
9943
9696
  MonitorInfo,
9944
9697
  Point,
9945
9698
  PointTopLeft,
@@ -9966,6 +9719,7 @@ declare namespace OpenFin {
9966
9719
  ResizeRegion,
9967
9720
  Accelerator,
9968
9721
  Api,
9722
+ ApiSettings,
9969
9723
  InjectionType,
9970
9724
  NavigationRules,
9971
9725
  ContentNavigation,
@@ -10072,6 +9826,7 @@ declare namespace OpenFin {
10072
9826
  AppVersionError,
10073
9827
  AppVersionRuntimeInfo,
10074
9828
  LaunchEmitter,
9829
+ UserAppConfigArgs,
10075
9830
  RvmLaunchOptions,
10076
9831
  ShortCutConfig,
10077
9832
  TerminateExternalRequestType,
@@ -10117,14 +9872,19 @@ declare namespace OpenFin {
10117
9872
  DefaultDomainSettingsRule,
10118
9873
  DomainSettings,
10119
9874
  ApiInjection,
9875
+ DomainApiSettings,
9876
+ ContentPermission,
9877
+ PerDomainSettings,
10120
9878
  DomainSettingsRule,
9879
+ FileDownloadBehavior,
10121
9880
  FileDownloadBehaviorNames,
10122
9881
  FileDownloadSettings,
10123
9882
  DownloadRule,
10124
- ContextHandler_3 as ContextHandler,
10125
- Intent_2 as Intent,
10126
- IntentMetadata_3 as IntentMetadata,
10127
- IntentHandler_2 as IntentHandler,
9883
+ ContextHandler,
9884
+ Intent,
9885
+ IntentMetadata,
9886
+ IntentHandler,
9887
+ ContentCreationBehavior,
10128
9888
  ContentCreationBehaviorNames,
10129
9889
  MatchPattern,
10130
9890
  BaseContentCreationRule,
@@ -10345,6 +10105,31 @@ declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10345
10105
  type: Type;
10346
10106
  }>;
10347
10107
 
10108
+ /**
10109
+ * @interface
10110
+ *
10111
+ * Conditional settings for a domain or set of domains.
10112
+ */
10113
+ declare type PerDomainSettings = {
10114
+ /**
10115
+ * {@inheritDoc FileDownloadSettings}
10116
+ *
10117
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
10118
+ */
10119
+ downloadSettings?: FileDownloadSettings;
10120
+ /**
10121
+ * {@inheritDoc ApiInjection}
10122
+ */
10123
+ api?: DomainApiSettings;
10124
+ /**
10125
+ * Whether DOM content can be loaded (by navigation or redirect).
10126
+ *
10127
+ * @remarks If this is included in {@link DomainSettings.default}, then {@link ContentNavigation} and
10128
+ * {@link ContentRedirect} will be **ignored**.
10129
+ */
10130
+ content?: ContentPermission;
10131
+ };
10132
+
10348
10133
  /**
10349
10134
  * Generated when window finishes loading. Provides performance and navigation data.
10350
10135
  * @interface
@@ -12081,14 +11866,6 @@ declare type PrintOptions = {
12081
11866
  dpi?: Dpi;
12082
11867
  };
12083
11868
 
12084
- declare type PrivateChannel = Omit<Channel_4, 'addContextListener'> & {
12085
- addContextListener(contextType: string | null, handler: ContextHandler_2): Promise<Listener_2>;
12086
- onAddContextListener(handler: (contextType?: string) => void): Listener_2;
12087
- onUnsubscribe(handler: (contextType?: string) => void): Listener_2;
12088
- onDisconnect(handler: () => void): Listener_2;
12089
- disconnect(): void;
12090
- };
12091
-
12092
11869
  /**
12093
11870
  * Strategy to assign views to process affinity by domain.
12094
11871
  *
@@ -12857,7 +12634,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
12857
12634
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12858
12635
  topic: 'application';
12859
12636
  type: 'run-requested';
12860
- userAppConfigArgs: Record<string, any>;
12637
+ userAppConfigArgs: OpenFin.UserAppConfigArgs;
12861
12638
  manifest: OpenFin.Manifest;
12862
12639
  };
12863
12640
 
@@ -12972,7 +12749,7 @@ declare type RvmLaunchOptions = {
12972
12749
  * True if no UI when launching
12973
12750
  */
12974
12751
  noUi?: boolean;
12975
- userAppConfigArgs?: object;
12752
+ userAppConfigArgs?: UserAppConfigArgs;
12976
12753
  /**
12977
12754
  * Timeout in seconds until RVM launch request expires.
12978
12755
  */
@@ -13054,19 +12831,19 @@ declare type SessionContextGroup = {
13054
12831
  * A SessionContextGroup instance method for setting a context in the SessionContextGroup.
13055
12832
  * @param context The Context to be set.
13056
12833
  */
13057
- setContext: (context: Context_3) => Promise<void>;
12834
+ setContext: (context: Context) => Promise<void>;
13058
12835
  /**
13059
12836
  * A SessionContextGroup instance method for getting the current context of a certain type.
13060
12837
  * @param type The Context Type to get. If not specified the last contextType set would get used.
13061
12838
  */
13062
- getCurrentContext: (type?: string) => Promise<Context_3>;
12839
+ getCurrentContext: (type?: string) => Promise<Context>;
13063
12840
  /**
13064
12841
  * A SessionContextGroup instance method for adding a handler for context change.
13065
12842
  * @param handler The callback to be invoked. Is invoked when (a) the context changes or (b) immediately after getting created if the context is already set.
13066
12843
  * @param contextType The context type this handler should listen to. If not specified, a global handler for all context types will get created. Only one global handler is allowed per SessionContextGroup.
13067
12844
  *
13068
12845
  */
13069
- addContextHandler: (handler: ContextHandler_3, contextType?: string) => Promise<{
12846
+ addContextHandler: (handler: ContextHandler, contextType?: string) => Promise<{
13070
12847
  unsubscribe: () => void;
13071
12848
  }>;
13072
12849
  };
@@ -14953,12 +14730,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
14953
14730
  setDomainSettings(domainSettings: OpenFin.DefaultDomainSettings): Promise<void>;
14954
14731
  }
14955
14732
 
14956
- declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast' | 'getCurrentContext'> & {
14957
- addContextListener(): Error;
14958
- broadcast(): Error;
14959
- getCurrentContext(): Error;
14960
- };
14961
-
14962
14733
  /**
14963
14734
  * @deprecated Renamed to {@link Event}.
14964
14735
  */
@@ -15230,8 +15001,6 @@ declare class TabStack extends LayoutNode {
15230
15001
  setActiveView: (view: OpenFin.Identity) => Promise<void>;
15231
15002
  }
15232
15003
 
15233
- declare type TargetApp = string | AppMetadata;
15234
-
15235
15004
  /**
15236
15005
  * Generated when a View changes its window target.
15237
15006
  * @remarks This event will fire during creation of a View.
@@ -15429,13 +15198,13 @@ declare type tween = 'linear' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'ease-i
15429
15198
  declare interface TypedEventEmitter<Event extends {
15430
15199
  type: string;
15431
15200
  }, EmitterEventType = Event['type']> {
15432
- on<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
15201
+ on<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
15433
15202
  type: EventType;
15434
15203
  }>>): this;
15435
- addListener<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
15204
+ addListener<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
15436
15205
  type: EventType;
15437
15206
  }>>): this;
15438
- removeListener<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
15207
+ removeListener<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
15439
15208
  type: EventType;
15440
15209
  }>>): this;
15441
15210
  removeAllListeners<EventType extends EmitterEventType>(event?: EmitterEventType): this;
@@ -15478,6 +15247,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15478
15247
  httpStatusText: string;
15479
15248
  });
15480
15249
 
15250
+ /**
15251
+ * @interface
15252
+ */
15253
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15254
+
15481
15255
  /**
15482
15256
  * A general user bounds change event without event type.
15483
15257
  * @interface
@@ -15506,45 +15280,102 @@ declare type UserMovementEnabledEvent = BaseEvent_5 & {
15506
15280
  type: 'user-movement-enabled';
15507
15281
  };
15508
15282
 
15509
- declare namespace v1 {
15510
- export {
15511
- Listener,
15512
- AppMetadata,
15513
- IntentMetadata,
15283
+ declare namespace v1_2 {
15284
+ {
15514
15285
  AppIntent,
15286
+ AppMetadata,
15515
15287
  DisplayMetadata,
15288
+ OpenError,
15289
+ ResolveError,
15290
+ ChannelError,
15516
15291
  ImplementationMetadata,
15517
- ContextHandler,
15518
- TargetApp,
15292
+ IntentMetadata,
15293
+ Listener,
15294
+ ContextTypes,
15295
+ ContextType,
15519
15296
  Context,
15297
+ ContactList,
15298
+ Contact,
15299
+ ContactID,
15300
+ InstrumentList,
15301
+ Instrument,
15302
+ InstrumentID,
15303
+ Country,
15304
+ CountryID,
15305
+ Organization,
15306
+ OrganizationID,
15307
+ Portfolio,
15308
+ Position,
15309
+ Convert,
15310
+ Intents,
15311
+ Channel,
15312
+ DesktopAgent,
15520
15313
  IntentResolution,
15521
- Channel_3 as Channel,
15522
- SystemChannel,
15523
- DesktopAgent
15314
+ TargetApp,
15315
+ ContextHandler
15524
15316
  }
15525
15317
  }
15526
15318
 
15527
- declare namespace v2 {
15528
- export {
15529
- IntentMetadata_2 as IntentMetadata,
15319
+ declare namespace v2_0 {
15320
+ {
15530
15321
  AppIdentifier,
15531
- Listener_2 as Listener,
15532
15322
  AppIntent_2 as AppIntent,
15533
- ImplementationMetadata_2 as ImplementationMetadata,
15323
+ AppMetadata_2 as AppMetadata,
15534
15324
  ContextMetadata,
15325
+ DisplayMetadata_2 as DisplayMetadata,
15326
+ OpenError_2 as OpenError,
15327
+ ResolveError_2 as ResolveError,
15328
+ ResultError,
15329
+ ChannelError_2 as ChannelError,
15535
15330
  Icon,
15536
15331
  Image_2 as Image,
15537
- AppMetadata_2 as AppMetadata,
15538
- DisplayMetadata_2 as DisplayMetadata,
15539
- ContextHandler_2 as ContextHandler,
15540
- IntentHandler,
15541
- IntentResult,
15332
+ ImplementationMetadata_2 as ImplementationMetadata,
15333
+ IntentMetadata_2 as IntentMetadata,
15334
+ Listener_2 as Listener,
15335
+ ContextTypes_2 as ContextTypes,
15336
+ ContextType_2 as ContextType,
15337
+ Chart,
15338
+ InstrumentElement,
15339
+ PurpleID,
15340
+ PurpleMarket,
15341
+ TimeRangeObject,
15342
+ Style,
15343
+ ChatInitSettings,
15344
+ ContactListObject,
15345
+ ContactElement,
15346
+ FluffyID,
15347
+ Contact_2 as Contact,
15348
+ TentacledID,
15349
+ ContactList_2 as ContactList,
15542
15350
  Context_2 as Context,
15543
- Intent,
15351
+ Country_2 as Country,
15352
+ CountryID_2 as CountryID,
15353
+ Currency,
15354
+ CurrencyID,
15355
+ Email,
15356
+ RecipientsObject,
15357
+ RecipientsID,
15358
+ Instrument_2 as Instrument,
15359
+ StickyID,
15360
+ FluffyMarket,
15361
+ InstrumentList_2 as InstrumentList,
15362
+ Nothing,
15363
+ Organization_2 as Organization,
15364
+ OrganizationID_2 as OrganizationID,
15365
+ Portfolio_2 as Portfolio,
15366
+ PositionElement,
15367
+ Position_2 as Position,
15368
+ TimeRange,
15369
+ Valuation,
15370
+ Convert_2 as Convert,
15371
+ Intents_2 as Intents,
15372
+ Channel_2 as Channel,
15373
+ DesktopAgent_2 as DesktopAgent,
15544
15374
  IntentResolution_2 as IntentResolution,
15545
- Channel_4 as Channel,
15546
15375
  PrivateChannel,
15547
- DesktopAgent_2 as DesktopAgent
15376
+ ContextHandler_2 as ContextHandler,
15377
+ IntentResult,
15378
+ IntentHandler
15548
15379
  }
15549
15380
  }
15550
15381
 
@@ -15553,6 +15384,13 @@ declare type VerboseWebPermission = {
15553
15384
  enabled: boolean;
15554
15385
  };
15555
15386
 
15387
+ declare type Version = (typeof versions)[keyof typeof versions];
15388
+
15389
+ declare const versions: {
15390
+ readonly v1_2: "1.2";
15391
+ readonly v2_0: "2.0";
15392
+ };
15393
+
15556
15394
  declare type View = OpenFin.View;
15557
15395
 
15558
15396
  /**
@@ -17254,10 +17092,12 @@ declare namespace WebContentsEvents {
17254
17092
  FileDownloadStartedEvent,
17255
17093
  FileDownloadProgressEvent,
17256
17094
  FileDownloadCompletedEvent,
17095
+ ContentBlockedEvent,
17257
17096
  Event_5 as Event,
17258
17097
  WebContentsEvent,
17259
17098
  WillPropagateWebContentsEvent,
17260
- NonPropagatedWebContentsEvent
17099
+ NonPropagatedWebContentsEvent,
17100
+ WillRedirectEvent
17261
17101
  }
17262
17102
  }
17263
17103
 
@@ -17335,14 +17175,15 @@ declare type WillPropagateWebContentsEvent = Event_5<string>;
17335
17175
  declare type WillPropagateWindowEvent = WindowSourcedEvent;
17336
17176
 
17337
17177
  /**
17338
- * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
17178
+ * Generated whenever a redirection occurs.
17339
17179
  * @interface
17340
17180
  */
17341
- declare type WillRedirectEvent = BaseEvent_5 & {
17181
+ declare type WillRedirectEvent = NamedEvent & {
17342
17182
  type: 'will-redirect';
17343
17183
  blocked: boolean;
17344
17184
  isInPlace: boolean;
17345
17185
  url: string;
17186
+ isMainFrame: boolean;
17346
17187
  };
17347
17188
 
17348
17189
  /**
@@ -17364,7 +17205,7 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
17364
17205
  */
17365
17206
  declare class _Window extends WebContents<OpenFin.WindowEvent> {
17366
17207
  /* Excluded from this release type: __constructor */
17367
- /* Excluded from this release type: createWindow */
17208
+ createWindow(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
17368
17209
  /**
17369
17210
  * Retrieves an array of frame info objects representing the main frame and any
17370
17211
  * iframes that are currently on the page.
@@ -18487,7 +18328,6 @@ declare namespace WindowEvents {
18487
18328
  AlertRequestedEvent,
18488
18329
  AuthRequestedEvent,
18489
18330
  EndLoadEvent,
18490
- WillRedirectEvent,
18491
18331
  ReloadedEvent,
18492
18332
  OptionsChangedEvent,
18493
18333
  WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
@@ -18743,7 +18583,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
18743
18583
  * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
18744
18584
  * from {@link OpenFin.ViewEvents}.
18745
18585
  */
18746
- declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillRedirectEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
18586
+ declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
18747
18587
 
18748
18588
  /**
18749
18589
  * Generated when a child window starts loading.
@@ -18798,6 +18638,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18798
18638
  positioningOptions?: OpenFin.PositioningOptions;
18799
18639
  };
18800
18640
 
18641
+ declare type WithUserAppConfigArgs = {
18642
+ /**
18643
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18644
+ * that launches this application.
18645
+ *
18646
+ * @remarks
18647
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18648
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18649
+ *
18650
+ * Results in the following object:
18651
+ * ```json
18652
+ * {
18653
+ * "use-last-configuration": true"
18654
+ * }
18655
+ * ```
18656
+ *
18657
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18658
+ * ```typescript
18659
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18660
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18661
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18662
+ * ```
18663
+ */
18664
+ userAppConfigArgs?: UserAppConfigArgs;
18665
+ };
18666
+
18801
18667
  /* Excluded from this release type: WorkspacePlatformOptions */
18802
18668
 
18803
18669
  /**