@openfin/remote-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;
@@ -3522,7 +3420,7 @@ declare type ConstViewOptions = {
3522
3420
  /**
3523
3421
  * Configurations for API injection.
3524
3422
  */
3525
- api: Api;
3423
+ api: ApiSettings;
3526
3424
  /**
3527
3425
  * The name of the view.
3528
3426
  */
@@ -3942,7 +3840,23 @@ declare interface Container extends EventEmitter_2 {
3942
3840
  close(): boolean;
3943
3841
  }
3944
3842
 
3945
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3843
+ /**
3844
+ * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
3845
+ */
3846
+ declare type ContentBlockedEvent = NamedEvent & {
3847
+ type: 'content-blocked';
3848
+ /**
3849
+ * The domain whose content was blocked.
3850
+ */
3851
+ url: string;
3852
+ };
3853
+
3854
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3855
+
3856
+ /**
3857
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3858
+ */
3859
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3946
3860
 
3947
3861
  /**
3948
3862
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3966,7 +3880,7 @@ declare type ContentCreationOptions = {
3966
3880
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3967
3881
  * the specified `behavior` key.
3968
3882
  */
3969
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3883
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3970
3884
  behavior: Behavior;
3971
3885
  }>;
3972
3886
 
@@ -4216,39 +4130,39 @@ declare interface ContentItem extends EventEmitter_2 {
4216
4130
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4217
4131
  * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4218
4132
  *
4133
+ * @remarks Superseded by {@link DomainSettingsRule.content}. If {@link DomainSettings.default} includes a
4134
+ * `content` setting, this setting will be **ignored**.
4135
+ *
4219
4136
  * @interface
4220
4137
  */
4221
4138
  declare type ContentNavigation = NavigationRules;
4222
4139
 
4140
+ /**
4141
+ * Whether a content url is allowed or blocked for navigation or redirection.
4142
+ *
4143
+ * * 'allow': The content url is allowed.
4144
+ * * 'block': The content url is blocked.
4145
+ */
4146
+ declare type ContentPermission = 'allow' | 'block';
4147
+
4223
4148
  /**
4224
4149
  * Restrict redirects to URLs that match an allowed pattern.
4225
4150
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4226
4151
  * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4227
4152
  *
4153
+ * @remarks Superseded by {@link DomainSettingsRule.content}. If {@link DomainSettings.default} includes a
4154
+ * `content` setting, this setting will be **ignored**.
4155
+ *
4228
4156
  * @interface
4229
4157
  */
4230
4158
  declare type ContentRedirect = NavigationRules;
4231
4159
 
4232
- declare interface Context {
4233
- id?: { [key: string]: string };
4234
- name?: string;
4235
- type: string;
4236
- }
4237
-
4238
- declare interface Context_2 {
4239
- id?: { [key: string]: string };
4240
- name?: string;
4241
- type: string;
4242
- contextMetadata?: ContextMetadata;
4243
- metadata?: any;
4244
- }
4245
-
4246
4160
  /**
4247
4161
  * Data passed between entities and applications.
4248
4162
  *
4249
4163
  * @interface
4250
4164
  */
4251
- declare type Context_3 = {
4165
+ declare type Context = {
4252
4166
  /**
4253
4167
  * An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
4254
4168
  */
@@ -4277,7 +4191,7 @@ declare type ContextChangedEvent = BaseEvent_5 & {
4277
4191
  /**
4278
4192
  * @interface
4279
4193
  */
4280
- declare type ContextForIntent<MetadataType = any> = Context_3 & {
4194
+ declare type ContextForIntent<MetadataType = any> = Context & {
4281
4195
  metadata?: MetadataType;
4282
4196
  };
4283
4197
 
@@ -4293,23 +4207,19 @@ declare type ContextGroupInfo = {
4293
4207
  /**
4294
4208
  * Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.
4295
4209
  */
4296
- displayMetadata?: DisplayMetadata_3;
4210
+ displayMetadata?: DisplayMetadata;
4297
4211
  };
4298
4212
 
4299
4213
  declare type ContextGroupStates = {
4300
4214
  [key: string]: {
4301
- [key: string]: Context_3;
4215
+ [key: string]: Context;
4302
4216
  };
4303
4217
  };
4304
4218
 
4305
- declare type ContextHandler = (context: Context) => void;
4306
-
4307
- declare type ContextHandler_2 = (context: Context_2, metadata?: ContextMetadata) => void;
4308
-
4309
4219
  /**
4310
4220
  * Subscription function for addContextHandler.
4311
4221
  */
4312
- declare type ContextHandler_3 = (context: Context_3) => void;
4222
+ declare type ContextHandler = (context: Context) => void;
4313
4223
 
4314
4224
  /**
4315
4225
  * Configure the context menu when right-clicking on a window.
@@ -4348,20 +4258,6 @@ declare type ContextMenuSettings = {
4348
4258
  reload?: boolean;
4349
4259
  };
4350
4260
 
4351
- /**
4352
- * Metadata relating to a context or intent and context received through the
4353
- * `addContextListener` and `addIntentListener` functions.
4354
- *
4355
- * @experimental Introduced in FDC3 2.0 and may be refined by further changes outside the normal FDC3 versioning policy.
4356
- */
4357
- declare interface ContextMetadata {
4358
- /** Identifier for the app instance that sent the context and/or intent.
4359
- *
4360
- * @experimental
4361
- */
4362
- readonly source: AppIdentifier;
4363
- }
4364
-
4365
4261
  /**
4366
4262
  * @interface
4367
4263
  */
@@ -4608,45 +4504,6 @@ declare type DefaultDomainSettings = DomainSettings;
4608
4504
  */
4609
4505
  declare type DefaultDomainSettingsRule = DomainSettingsRule;
4610
4506
 
4611
- declare interface DesktopAgent {
4612
- open(app: TargetApp, context?: Context): Promise<void>;
4613
- findIntent(intent: string, context?: Context): Promise<AppIntent>;
4614
- findIntentsByContext(context: Context): Promise<Array<AppIntent>>;
4615
- broadcast(context: Context): void;
4616
- raiseIntent(intent: string, context: Context, app?: TargetApp): Promise<IntentResolution>;
4617
- raiseIntentForContext(context: Context, app?: TargetApp): Promise<IntentResolution>;
4618
- addIntentListener(intent: string, handler: ContextHandler): Listener;
4619
- joinChannel(channelId: string): Promise<void>;
4620
- leaveCurrentChannel(): Promise<void>;
4621
- getInfo(): ImplementationMetadata;
4622
- addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
4623
- getOrCreateChannel(channelId: string): Promise<Channel_3>;
4624
- getSystemChannels(): Promise<SystemChannel[]>;
4625
- getCurrentChannel(): Promise<Channel_3 | null>;
4626
- }
4627
-
4628
- declare interface DesktopAgent_2 {
4629
- open(app: AppIdentifier | TargetApp, context?: Context_2): Promise<AppIdentifier>;
4630
- findIntent(intent: string, context?: Context_2, resultType?: string): Promise<AppIntent_2>;
4631
- findIntentsByContext(context: Context_2, resultType?: string): Promise<Array<AppIntent_2>>;
4632
- findInstances(app: AppIdentifier): Promise<Array<AppIdentifier>>;
4633
- broadcast(context: Context_2): Promise<void>;
4634
- raiseIntent(intent: string, context: Context_2, app?: AppIdentifier | TargetApp): Promise<IntentResolution_2>;
4635
- raiseIntentForContext(context: Context_2, app?: AppIdentifier | TargetApp): Promise<IntentResolution_2>;
4636
- addIntentListener(intent: string, handler: IntentHandler): Promise<Listener_2>;
4637
- addContextListener(contextType: string | null, handler: ContextHandler_2): Promise<Listener_2>;
4638
- getUserChannels(): Promise<Array<SystemChannel>>;
4639
- joinUserChannel(channelId: string): Promise<void>;
4640
- getOrCreateChannel(channelId: string): Promise<Channel_4>;
4641
- createPrivateChannel(): Promise<PrivateChannel>;
4642
- getCurrentChannel(): Promise<Channel_3 | null>;
4643
- leaveCurrentChannel(): Promise<void>;
4644
- getInfo(): Promise<ImplementationMetadata_2>;
4645
- getAppMetadata(app: AppIdentifier): Promise<AppMetadata_2>;
4646
- getSystemChannels(): Promise<Array<SystemChannel>>;
4647
- joinChannel(channelId: string): Promise<void>;
4648
- }
4649
-
4650
4507
  /**
4651
4508
  * Generated when the desktop icon is clicked while it's already running.
4652
4509
  * @interface
@@ -4791,52 +4648,12 @@ declare type DisconnectedEvent_3 = BaseFrameEvent & {
4791
4648
  type: 'disconnected';
4792
4649
  };
4793
4650
 
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 {
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
- /**
4815
- * A system channel will be global enough to have a presence across many apps. This gives us some hints
4816
- * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
4817
- * this is their meaning.
4818
- */
4819
- declare interface DisplayMetadata_2 {
4820
- /**
4821
- * A user-readable name for this channel, e.g: `"Red"`
4822
- */
4823
- readonly name?: string;
4824
- /**
4825
- * The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
4826
- */
4827
- readonly color?: string;
4828
- /**
4829
- * A URL of an image that can be used to display this channel
4830
- */
4831
- readonly glyph?: string;
4832
- }
4833
-
4834
4651
  /**
4835
4652
  * The display data for a context group.
4836
4653
  *
4837
4654
  * @interface
4838
4655
  */
4839
- declare type DisplayMetadata_3 = {
4656
+ declare type DisplayMetadata = {
4840
4657
  /**
4841
4658
  * A user-readable name for this context group, e.g: `"Red"`
4842
4659
  */
@@ -4851,6 +4668,25 @@ declare type DisplayMetadata_3 = {
4851
4668
  readonly glyph?: string;
4852
4669
  };
4853
4670
 
4671
+ /**
4672
+ * @interface
4673
+ *
4674
+ * Rules for domain-conditional `fin` API injection.
4675
+ *
4676
+ * @remarks Subset of {@link DomainSettings}.
4677
+ */
4678
+ declare type DomainApiSettings = {
4679
+ /**
4680
+ * Injection setting for the `fin` API for contexts on a matched domain.
4681
+ *
4682
+ * * 'none': The `fin` API will be not available.
4683
+ * * 'global': The entire `fin` API will be available.
4684
+ *
4685
+ * @defaultValue 'global'
4686
+ */
4687
+ fin: InjectionType;
4688
+ };
4689
+
4854
4690
  /**
4855
4691
  * @interface
4856
4692
  * Defines application settings that vary by the domain of the current context.
@@ -4863,6 +4699,10 @@ declare type DomainSettings = {
4863
4699
  * {@inheritDoc DomainSettingsRule}
4864
4700
  */
4865
4701
  rules: DomainSettingsRule[];
4702
+ /**
4703
+ * Default values for settings in {@link DomainSettingsRule}.
4704
+ */
4705
+ default?: PerDomainSettings;
4866
4706
  };
4867
4707
 
4868
4708
  /**
@@ -4875,22 +4715,11 @@ declare type DomainSettingsRule = {
4875
4715
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4876
4716
  * the domain(s) for which the rule applies.
4877
4717
  */
4878
- match: string[];
4718
+ match?: string[];
4879
4719
  /**
4880
4720
  * Settings applied when a webcontents has been navigated to a matched domain.
4881
4721
  */
4882
- options: {
4883
- /**
4884
- * {@inheritDoc FileDownloadSettings}
4885
- *
4886
- * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
4887
- */
4888
- downloadSettings?: FileDownloadSettings;
4889
- /**
4890
- * {@inheritDoc ApiInjection}
4891
- */
4892
- api?: ApiInjection;
4893
- };
4722
+ options: PerDomainSettings;
4894
4723
  };
4895
4724
 
4896
4725
  /**
@@ -4928,18 +4757,19 @@ declare type DownloadPreloadOption = {
4928
4757
  /**
4929
4758
  * @interface
4930
4759
  *
4931
- * A rule governing domain-conditional download behavior.
4760
+ * A rule that governs download behavior, discriminated by the URL of the download.
4932
4761
  */
4933
4762
  declare type DownloadRule = {
4934
4763
  /**
4935
- * {@inheritDoc FileDownloadBehaviorNames}
4764
+ * {@inheritDoc FileDownloadBehavior}
4936
4765
  */
4937
- behavior: FileDownloadBehaviorNames;
4766
+ behavior: FileDownloadBehavior;
4938
4767
  /**
4939
4768
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4940
- * the domain(s) for which the rule applies.
4769
+ * URL(s) of the resource(s) being downloaded.
4941
4770
  *
4942
- * @remarks The match is evaluated against the URL of the *download*.
4771
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4772
+ * of the page in which a file download link is embedded.
4943
4773
  */
4944
4774
  match: string[];
4945
4775
  };
@@ -5214,7 +5044,7 @@ declare interface Environment {
5214
5044
  getWsConstructor(): typeof WebSocket;
5215
5045
  whenReady(): Promise<void>;
5216
5046
  getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
5217
- fdc3Version?: Fdc3Version;
5047
+ fdc3Version?: Version;
5218
5048
  }>;
5219
5049
  readonly type: EnvironmentType;
5220
5050
  }
@@ -5282,7 +5112,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
5282
5112
  */
5283
5113
  declare type Event_5<Topic extends string> = {
5284
5114
  topic: Topic;
5285
- } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
5115
+ } & (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);
5286
5116
 
5287
5117
  /**
5288
5118
  * [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
@@ -5619,13 +5449,12 @@ declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
5619
5449
 
5620
5450
  declare namespace FDC3 {
5621
5451
  export {
5622
- v1,
5623
- v2
5452
+ Version,
5453
+ v1_2,
5454
+ v2_0
5624
5455
  }
5625
5456
  }
5626
5457
 
5627
- declare type Fdc3Version = '1.2' | '2.0';
5628
-
5629
5458
  /**
5630
5459
  * @interface
5631
5460
  */
@@ -5639,7 +5468,12 @@ declare type FetchManifestPayload = {
5639
5468
  /**
5640
5469
  * Whether file downloads raise a user prompt.
5641
5470
  */
5642
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5471
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5472
+
5473
+ /**
5474
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5475
+ */
5476
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5643
5477
 
5644
5478
  /**
5645
5479
  * Generated when a file download has completed.
@@ -5824,8 +5658,8 @@ declare type FindInPageResult = {
5824
5658
  /**
5825
5659
  * @interface
5826
5660
  */
5827
- declare type FindIntentsByContextOptions<MetadataType = IntentMetadata_3> = {
5828
- context: Context_3;
5661
+ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
5662
+ context: Context;
5829
5663
  metadata?: MetadataType;
5830
5664
  };
5831
5665
 
@@ -6264,6 +6098,20 @@ declare class GoldenLayout_2 implements EventEmitter_2 {
6264
6098
 
6265
6099
  dropTargetIndicator: any;
6266
6100
 
6101
+ _isFullPage: boolean;
6102
+
6103
+ _onUnload: any;
6104
+
6105
+ tabDropPlaceholder: any;
6106
+
6107
+ transitionIndicator: any;
6108
+
6109
+ _dragSources: any;
6110
+
6111
+ _resizeFunction: any;
6112
+
6113
+ _unloadFunction: any;
6114
+
6267
6115
  /**
6268
6116
  * @param config A GoldenLayout configuration object
6269
6117
  * @param container The DOM element the layout will be initialised in. Default: document.body
@@ -6592,15 +6440,6 @@ declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
6592
6440
  type: 'hotkey';
6593
6441
  };
6594
6442
 
6595
- declare interface Icon {
6596
- /** The icon url */
6597
- readonly src: string;
6598
- /** The icon dimension, formatted as `<height>x<width>`. */
6599
- readonly size?: string;
6600
- /** Icon media type. If not present the Desktop Agent may use the src file extension. */
6601
- readonly type?: string;
6602
- }
6603
-
6604
6443
  declare type Identity = OpenFin.Identity;
6605
6444
 
6606
6445
  declare type Identity_2 = OpenFin.Identity;
@@ -6659,17 +6498,6 @@ declare type IdleStateChangedEvent = BaseEvent_9 & {
6659
6498
  isIdle: boolean;
6660
6499
  };
6661
6500
 
6662
- declare interface Image_2 {
6663
- /** The image url. */
6664
- readonly src: string;
6665
- /** The image dimension, formatted as `<height>x<width>`. */
6666
- readonly size?: string;
6667
- /** Image media type. If not present the Desktop Agent may use the src file extension. */
6668
- readonly type?: string;
6669
- /** Caption for the image. */
6670
- readonly label?: string;
6671
- }
6672
-
6673
6501
  declare type ImageFormatOptions = {
6674
6502
  format: 'dataURL' | 'png' | 'bmp';
6675
6503
  } | {
@@ -6680,57 +6508,15 @@ declare type ImageFormatOptions = {
6680
6508
  quality?: number;
6681
6509
  };
6682
6510
 
6683
- /**
6684
- * Metadata relating to the FDC3 Desktop Agent implementation and its provider.
6685
- */
6686
- declare interface ImplementationMetadata {
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 FDC3 Desktop Agent Implementation (e.g. Finsemble, Glue42, OpenFin etc.). */
6692
- readonly provider: string;
6693
- /** The version of the provider of the FDC3 Desktop Agent Implementation (e.g. 5.3.0). */
6694
- readonly providerVersion?: string;
6695
- }
6696
-
6697
- /**
6698
- * Metadata relating to the FDC3 Desktop Agent implementation and its provider.
6699
- */
6700
- declare interface ImplementationMetadata_2 {
6701
- /** The version number of the FDC3 specification that the implementation provides.
6702
- * The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
6703
- */
6704
- readonly fdc3Version: string;
6705
- /** The name of the provider of the Desktop Agent implementation (e.g. Finsemble, Glue42, OpenFin etc.). */
6706
- readonly provider: string;
6707
- /** The version of the provider of the Desktop Agent implementation (e.g. 5.3.0). */
6708
- readonly providerVersion?: string;
6709
- /** Metadata indicating whether the Desktop Agent implements optional features of
6710
- * the Desktop Agent API.
6711
- */
6712
- readonly optionalFeatures: {
6713
- /** Used to indicate whether the exposure of 'originating app metadata' for
6714
- * context and intent messages is supported by the Desktop Agent. */
6715
- readonly OriginatingAppMetadata: boolean;
6716
- /** Used to indicate whether the optional `fdc3.joinUserChannel`,
6717
- * `fdc3.getCurrentChannel` and `fdc3.leaveCurrentChannel` are implemented by
6718
- * the Desktop Agent. */
6719
- readonly UserChannelMembershipAPIs: boolean;
6720
- };
6721
- /** The calling application instance's own metadata, according to the Desktop Agent (MUST include at least the `appId` and `instanceId`). */
6722
- readonly appMetadata: AppMetadata_2;
6723
- }
6724
-
6725
6511
  /**
6726
6512
  * @interface
6727
6513
  */
6728
- declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6514
+ declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
6729
6515
  /**
6730
6516
  * Name of the intent to get info for.
6731
6517
  */
6732
6518
  name: string;
6733
- context?: Context_3;
6519
+ context?: Context;
6734
6520
  metadata?: MetadataType;
6735
6521
  };
6736
6522
 
@@ -6859,16 +6645,10 @@ declare type InstalledApps_2 = {
6859
6645
  [key: string]: InstallationInfo;
6860
6646
  };
6861
6647
 
6862
- declare interface Intent {
6863
- name: string;
6864
- context: Context_2;
6865
- metadata: IntentMetadata_2;
6866
- }
6867
-
6868
6648
  /**
6869
6649
  * Combination of an action and a context that is passed to an application for resolution.
6870
6650
  */
6871
- declare type Intent_2<MetadataType = IntentMetadata_3> = {
6651
+ declare type Intent<MetadataType = IntentMetadata> = {
6872
6652
  /**
6873
6653
  * Name of the intent.
6874
6654
  */
@@ -6876,54 +6656,25 @@ declare type Intent_2<MetadataType = IntentMetadata_3> = {
6876
6656
  /**
6877
6657
  * Data associated with the intent.
6878
6658
  */
6879
- context: Context_3;
6659
+ context: Context;
6880
6660
  metadata?: MetadataType;
6881
6661
  };
6882
6662
 
6883
- declare type IntentHandler = (context: Context_2, metadata?: ContextMetadata) => Promise<IntentResult> | void;
6884
-
6885
6663
  /**
6886
6664
  * Subscription function for registerIntentHandler.
6887
6665
  */
6888
- declare type IntentHandler_2 = (intent: Intent_2) => void;
6666
+ declare type IntentHandler = (intent: Intent) => void;
6889
6667
 
6890
6668
  /**
6891
- * Intent descriptor
6669
+ * The type used to describe an intent within the platform.
6670
+ * @interface
6892
6671
  */
6893
- declare interface IntentMetadata {
6894
- /** The unique name of the intent that can be invoked by the raiseIntent call */
6895
- readonly name: string;
6896
- /** A friendly display name for the intent that should be used to render UI elements */
6897
- readonly displayName: string;
6898
- }
6899
-
6900
- declare type IntentMetadata_2<TargetType = any> = {
6672
+ declare type IntentMetadata<TargetType = any> = {
6901
6673
  target?: TargetType;
6902
6674
  resultType?: string;
6903
6675
  intentResolutionResultId?: string;
6904
6676
  };
6905
6677
 
6906
- /**
6907
- * The type used to describe an intent within the platform.
6908
- * @interface
6909
- */
6910
- declare type IntentMetadata_3<TargetType = any> = FDC3.v2.IntentMetadata<TargetType>;
6911
-
6912
- declare interface IntentResolution {
6913
- source: TargetApp;
6914
- data?: object;
6915
- version: string;
6916
- }
6917
-
6918
- declare interface IntentResolution_2 {
6919
- source: AppIdentifier;
6920
- intent: string;
6921
- version?: string;
6922
- getResult(): Promise<IntentResult>;
6923
- }
6924
-
6925
- declare type IntentResult = Context_2 | Channel_4 | PrivateChannel;
6926
-
6927
6678
  /**
6928
6679
  * A messaging bus that allows for pub/sub messaging between different applications.
6929
6680
  *
@@ -7169,7 +6920,6 @@ declare type InteropActionLoggingOption = {
7169
6920
  */
7170
6921
  declare class InteropBroker extends Base {
7171
6922
  #private;
7172
- private getProvider;
7173
6923
  private interopClients;
7174
6924
  private contextGroupsById;
7175
6925
  private intentClientMap;
@@ -7178,6 +6928,7 @@ declare class InteropBroker extends Base {
7178
6928
  private channel;
7179
6929
  private logging;
7180
6930
  /* Excluded from this release type: __constructor */
6931
+ private getProvider;
7181
6932
  static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
7182
6933
  new (): InteropBroker;
7183
6934
  };
@@ -7482,23 +7233,23 @@ declare class InteropBroker extends Base {
7482
7233
  * @param clientIdentity Identity of the Client making the request.
7483
7234
  */
7484
7235
  fdc3HandleOpen({ app, context }: {
7485
- app: FDC3.v1.TargetApp | FDC3.v2.AppIdentifier;
7236
+ app: FDC3.v1_2.TargetApp | FDC3.v2_0.AppIdentifier;
7486
7237
  context: OpenFin.Context;
7487
- }, clientIdentity: OpenFin.ClientIdentity): Promise<void | FDC3.v2.AppIdentifier>;
7238
+ }, clientIdentity: OpenFin.ClientIdentity): Promise<void | FDC3.v2_0.AppIdentifier>;
7488
7239
  /**
7489
7240
  * Responsible for resolving the fdc3.findInstances call.
7490
7241
  * Must be overridden
7491
7242
  * @param app AppIdentifier that was passed to fdc3.findInstances
7492
7243
  * @param clientIdentity Identity of the Client making the request.
7493
7244
  */
7494
- fdc3HandleFindInstances(app: FDC3.v2.AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
7245
+ fdc3HandleFindInstances(app: FDC3.v2_0.AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
7495
7246
  /**
7496
7247
  * Responsible for resolving the fdc3.getAppMetadata call.
7497
7248
  * Must be overridden
7498
7249
  * @param app AppIdentifier that was passed to fdc3.getAppMetadata
7499
7250
  * @param clientIdentity Identity of the Client making the request.
7500
7251
  */
7501
- fdc3HandleGetAppMetadata(app: FDC3.v2.AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
7252
+ fdc3HandleGetAppMetadata(app: FDC3.v2_0.AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
7502
7253
  /**
7503
7254
  * This function is called by the Interop Broker whenever a Context handler would fire.
7504
7255
  * For FDC3 2.0 you would need to override this function and add the contextMetadata as
@@ -7800,9 +7551,7 @@ declare class InteropClient extends Base {
7800
7551
  * ```
7801
7552
  *
7802
7553
  *
7803
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
7804
- * this, please make sure you add your context handlers at the top level of your application, on a page that
7805
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
7554
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
7806
7555
  *
7807
7556
  * ```js
7808
7557
  * function handleInstrumentContext(contextInfo) {
@@ -8092,6 +7841,23 @@ declare class InteropClient extends Base {
8092
7841
  * ```
8093
7842
  */
8094
7843
  onDisconnection(listener: OpenFin.InteropClientOnDisconnectionListener): Promise<void>;
7844
+ /**
7845
+ * Returns a representation of this Interop Client as an FDC3 DesktopAgent matching the given version.
7846
+ * Note that this does not set a global FDC3 object, it only returns an instance of the FDC3 DesktopAgent.
7847
+ * This also does not raise the FDC3Ready event.
7848
+ */
7849
+ getFDC3Sync(version: '2.0'): OpenFin.FDC3.v2_0.DesktopAgent;
7850
+ getFDC3Sync(version: '1.2'): OpenFin.FDC3.v1_2.DesktopAgent;
7851
+ getFDC3Sync(version: OpenFin.FDC3.Version): OpenFin.FDC3.v1_2.DesktopAgent | OpenFin.FDC3.v2_0.DesktopAgent;
7852
+ /**
7853
+ *
7854
+ * Returns a representation of this Interop Client as an FDC3 DesktopAgent matching the given version.
7855
+ * Note that this does not set a global FDC3 object, it only returns an instance of the FDC3 DesktopAgent.
7856
+ * This also does not raise the FDC3Ready event.
7857
+ */
7858
+ getFDC3(version: '2.0'): Promise<OpenFin.FDC3.v2_0.DesktopAgent>;
7859
+ getFDC3(version: '1.2'): Promise<OpenFin.FDC3.v1_2.DesktopAgent>;
7860
+ getFDC3(version: OpenFin.FDC3.Version): Promise<OpenFin.FDC3.v1_2.DesktopAgent | OpenFin.FDC3.v2_0.DesktopAgent>;
8095
7861
  /* Excluded from this release type: ferryFdc3Call */
8096
7862
  }
8097
7863
 
@@ -9136,21 +8902,7 @@ declare type LayoutSnapshot = {
9136
8902
  */
9137
8903
  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'>;
9138
8904
 
9139
- declare interface Listener {
9140
- /**
9141
- * Unsubscribe the listener object.
9142
- */
9143
- unsubscribe(): void;
9144
- }
9145
-
9146
- declare interface Listener_2 {
9147
- /**
9148
- * Unsubscribe the listener object.
9149
- */
9150
- unsubscribe(): void;
9151
- }
9152
-
9153
- declare type Listener_3<T extends {
8905
+ declare type Listener<T extends {
9154
8906
  type: string;
9155
8907
  }> = (payload: T) => void;
9156
8908
 
@@ -9539,7 +9291,7 @@ declare type MutableViewOptions = {
9539
9291
  /**
9540
9292
  * Configurations for API injection.
9541
9293
  */
9542
- api: Api;
9294
+ api: ApiSettings;
9543
9295
  /**
9544
9296
  * Restrict navigation to URLs that match an allowed pattern.
9545
9297
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -9917,6 +9669,7 @@ declare namespace OpenFin {
9917
9669
  export {
9918
9670
  FinApi,
9919
9671
  Fin,
9672
+ FDC3,
9920
9673
  Application,
9921
9674
  ApplicationModule,
9922
9675
  ExternalApplication,
@@ -9968,11 +9721,11 @@ declare namespace OpenFin {
9968
9721
  CustomProtocolOptions,
9969
9722
  InteropBrokerOptions,
9970
9723
  ContextGroupInfo,
9971
- DisplayMetadata_3 as DisplayMetadata,
9724
+ DisplayMetadata,
9972
9725
  LegacyWinOptionsInAppOptions,
9973
9726
  Snapshot,
9974
9727
  ContextGroupStates,
9975
- Context_3 as Context,
9728
+ Context,
9976
9729
  MonitorInfo,
9977
9730
  Point,
9978
9731
  PointTopLeft,
@@ -9999,6 +9752,7 @@ declare namespace OpenFin {
9999
9752
  ResizeRegion,
10000
9753
  Accelerator,
10001
9754
  Api,
9755
+ ApiSettings,
10002
9756
  InjectionType,
10003
9757
  NavigationRules,
10004
9758
  ContentNavigation,
@@ -10105,6 +9859,7 @@ declare namespace OpenFin {
10105
9859
  AppVersionError,
10106
9860
  AppVersionRuntimeInfo,
10107
9861
  LaunchEmitter,
9862
+ UserAppConfigArgs,
10108
9863
  RvmLaunchOptions,
10109
9864
  ShortCutConfig,
10110
9865
  TerminateExternalRequestType,
@@ -10150,14 +9905,19 @@ declare namespace OpenFin {
10150
9905
  DefaultDomainSettingsRule,
10151
9906
  DomainSettings,
10152
9907
  ApiInjection,
9908
+ DomainApiSettings,
9909
+ ContentPermission,
9910
+ PerDomainSettings,
10153
9911
  DomainSettingsRule,
9912
+ FileDownloadBehavior,
10154
9913
  FileDownloadBehaviorNames,
10155
9914
  FileDownloadSettings,
10156
9915
  DownloadRule,
10157
- ContextHandler_3 as ContextHandler,
10158
- Intent_2 as Intent,
10159
- IntentMetadata_3 as IntentMetadata,
10160
- IntentHandler_2 as IntentHandler,
9916
+ ContextHandler,
9917
+ Intent,
9918
+ IntentMetadata,
9919
+ IntentHandler,
9920
+ ContentCreationBehavior,
10161
9921
  ContentCreationBehaviorNames,
10162
9922
  MatchPattern,
10163
9923
  BaseContentCreationRule,
@@ -10377,6 +10137,31 @@ declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10377
10137
  type: Type;
10378
10138
  }>;
10379
10139
 
10140
+ /**
10141
+ * @interface
10142
+ *
10143
+ * Conditional settings for a domain or set of domains.
10144
+ */
10145
+ declare type PerDomainSettings = {
10146
+ /**
10147
+ * {@inheritDoc FileDownloadSettings}
10148
+ *
10149
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
10150
+ */
10151
+ downloadSettings?: FileDownloadSettings;
10152
+ /**
10153
+ * {@inheritDoc ApiInjection}
10154
+ */
10155
+ api?: DomainApiSettings;
10156
+ /**
10157
+ * Whether DOM content can be loaded (by navigation or redirect).
10158
+ *
10159
+ * @remarks If this is included in {@link DomainSettings.default}, then {@link ContentNavigation} and
10160
+ * {@link ContentRedirect} will be **ignored**.
10161
+ */
10162
+ content?: ContentPermission;
10163
+ };
10164
+
10380
10165
  /**
10381
10166
  * Generated when window finishes loading. Provides performance and navigation data.
10382
10167
  * @interface
@@ -12113,14 +11898,6 @@ declare type PrintOptions = {
12113
11898
  dpi?: Dpi;
12114
11899
  };
12115
11900
 
12116
- declare type PrivateChannel = Omit<Channel_4, 'addContextListener'> & {
12117
- addContextListener(contextType: string | null, handler: ContextHandler_2): Promise<Listener_2>;
12118
- onAddContextListener(handler: (contextType?: string) => void): Listener_2;
12119
- onUnsubscribe(handler: (contextType?: string) => void): Listener_2;
12120
- onDisconnect(handler: () => void): Listener_2;
12121
- disconnect(): void;
12122
- };
12123
-
12124
11901
  /**
12125
11902
  * Strategy to assign views to process affinity by domain.
12126
11903
  *
@@ -12889,7 +12666,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
12889
12666
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12890
12667
  topic: 'application';
12891
12668
  type: 'run-requested';
12892
- userAppConfigArgs: Record<string, any>;
12669
+ userAppConfigArgs: OpenFin.UserAppConfigArgs;
12893
12670
  manifest: OpenFin.Manifest;
12894
12671
  };
12895
12672
 
@@ -13004,7 +12781,7 @@ declare type RvmLaunchOptions = {
13004
12781
  * True if no UI when launching
13005
12782
  */
13006
12783
  noUi?: boolean;
13007
- userAppConfigArgs?: object;
12784
+ userAppConfigArgs?: UserAppConfigArgs;
13008
12785
  /**
13009
12786
  * Timeout in seconds until RVM launch request expires.
13010
12787
  */
@@ -13086,19 +12863,19 @@ declare type SessionContextGroup = {
13086
12863
  * A SessionContextGroup instance method for setting a context in the SessionContextGroup.
13087
12864
  * @param context The Context to be set.
13088
12865
  */
13089
- setContext: (context: Context_3) => Promise<void>;
12866
+ setContext: (context: Context) => Promise<void>;
13090
12867
  /**
13091
12868
  * A SessionContextGroup instance method for getting the current context of a certain type.
13092
12869
  * @param type The Context Type to get. If not specified the last contextType set would get used.
13093
12870
  */
13094
- getCurrentContext: (type?: string) => Promise<Context_3>;
12871
+ getCurrentContext: (type?: string) => Promise<Context>;
13095
12872
  /**
13096
12873
  * A SessionContextGroup instance method for adding a handler for context change.
13097
12874
  * @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.
13098
12875
  * @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.
13099
12876
  *
13100
12877
  */
13101
- addContextHandler: (handler: ContextHandler_3, contextType?: string) => Promise<{
12878
+ addContextHandler: (handler: ContextHandler, contextType?: string) => Promise<{
13102
12879
  unsubscribe: () => void;
13103
12880
  }>;
13104
12881
  };
@@ -14985,12 +14762,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
14985
14762
  setDomainSettings(domainSettings: OpenFin.DefaultDomainSettings): Promise<void>;
14986
14763
  }
14987
14764
 
14988
- declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast' | 'getCurrentContext'> & {
14989
- addContextListener(): Error;
14990
- broadcast(): Error;
14991
- getCurrentContext(): Error;
14992
- };
14993
-
14994
14765
  /**
14995
14766
  * @deprecated Renamed to {@link Event}.
14996
14767
  */
@@ -15262,8 +15033,6 @@ declare class TabStack extends LayoutNode {
15262
15033
  setActiveView: (view: OpenFin.Identity) => Promise<void>;
15263
15034
  }
15264
15035
 
15265
- declare type TargetApp = string | AppMetadata;
15266
-
15267
15036
  /**
15268
15037
  * Generated when a View changes its window target.
15269
15038
  * @remarks This event will fire during creation of a View.
@@ -15461,13 +15230,13 @@ declare type tween = 'linear' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'ease-i
15461
15230
  declare interface TypedEventEmitter<Event extends {
15462
15231
  type: string;
15463
15232
  }, EmitterEventType = Event['type']> {
15464
- on<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
15233
+ on<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
15465
15234
  type: EventType;
15466
15235
  }>>): this;
15467
- addListener<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
15236
+ addListener<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
15468
15237
  type: EventType;
15469
15238
  }>>): this;
15470
- removeListener<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
15239
+ removeListener<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
15471
15240
  type: EventType;
15472
15241
  }>>): this;
15473
15242
  removeAllListeners<EventType extends EmitterEventType>(event?: EmitterEventType): this;
@@ -15510,6 +15279,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15510
15279
  httpStatusText: string;
15511
15280
  });
15512
15281
 
15282
+ /**
15283
+ * @interface
15284
+ */
15285
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15286
+
15513
15287
  /**
15514
15288
  * A general user bounds change event without event type.
15515
15289
  * @interface
@@ -15538,45 +15312,102 @@ declare type UserMovementEnabledEvent = BaseEvent_5 & {
15538
15312
  type: 'user-movement-enabled';
15539
15313
  };
15540
15314
 
15541
- declare namespace v1 {
15542
- export {
15543
- Listener,
15544
- AppMetadata,
15545
- IntentMetadata,
15315
+ declare namespace v1_2 {
15316
+ {
15546
15317
  AppIntent,
15318
+ AppMetadata,
15547
15319
  DisplayMetadata,
15320
+ OpenError,
15321
+ ResolveError,
15322
+ ChannelError,
15548
15323
  ImplementationMetadata,
15549
- ContextHandler,
15550
- TargetApp,
15324
+ IntentMetadata,
15325
+ Listener,
15326
+ ContextTypes,
15327
+ ContextType,
15551
15328
  Context,
15329
+ ContactList,
15330
+ Contact,
15331
+ ContactID,
15332
+ InstrumentList,
15333
+ Instrument,
15334
+ InstrumentID,
15335
+ Country,
15336
+ CountryID,
15337
+ Organization,
15338
+ OrganizationID,
15339
+ Portfolio,
15340
+ Position,
15341
+ Convert,
15342
+ Intents,
15343
+ Channel,
15344
+ DesktopAgent,
15552
15345
  IntentResolution,
15553
- Channel_3 as Channel,
15554
- SystemChannel,
15555
- DesktopAgent
15346
+ TargetApp,
15347
+ ContextHandler
15556
15348
  }
15557
15349
  }
15558
15350
 
15559
- declare namespace v2 {
15560
- export {
15561
- IntentMetadata_2 as IntentMetadata,
15351
+ declare namespace v2_0 {
15352
+ {
15562
15353
  AppIdentifier,
15563
- Listener_2 as Listener,
15564
15354
  AppIntent_2 as AppIntent,
15565
- ImplementationMetadata_2 as ImplementationMetadata,
15355
+ AppMetadata_2 as AppMetadata,
15566
15356
  ContextMetadata,
15357
+ DisplayMetadata_2 as DisplayMetadata,
15358
+ OpenError_2 as OpenError,
15359
+ ResolveError_2 as ResolveError,
15360
+ ResultError,
15361
+ ChannelError_2 as ChannelError,
15567
15362
  Icon,
15568
15363
  Image_2 as Image,
15569
- AppMetadata_2 as AppMetadata,
15570
- DisplayMetadata_2 as DisplayMetadata,
15571
- ContextHandler_2 as ContextHandler,
15572
- IntentHandler,
15573
- IntentResult,
15364
+ ImplementationMetadata_2 as ImplementationMetadata,
15365
+ IntentMetadata_2 as IntentMetadata,
15366
+ Listener_2 as Listener,
15367
+ ContextTypes_2 as ContextTypes,
15368
+ ContextType_2 as ContextType,
15369
+ Chart,
15370
+ InstrumentElement,
15371
+ PurpleID,
15372
+ PurpleMarket,
15373
+ TimeRangeObject,
15374
+ Style,
15375
+ ChatInitSettings,
15376
+ ContactListObject,
15377
+ ContactElement,
15378
+ FluffyID,
15379
+ Contact_2 as Contact,
15380
+ TentacledID,
15381
+ ContactList_2 as ContactList,
15574
15382
  Context_2 as Context,
15575
- Intent,
15383
+ Country_2 as Country,
15384
+ CountryID_2 as CountryID,
15385
+ Currency,
15386
+ CurrencyID,
15387
+ Email,
15388
+ RecipientsObject,
15389
+ RecipientsID,
15390
+ Instrument_2 as Instrument,
15391
+ StickyID,
15392
+ FluffyMarket,
15393
+ InstrumentList_2 as InstrumentList,
15394
+ Nothing,
15395
+ Organization_2 as Organization,
15396
+ OrganizationID_2 as OrganizationID,
15397
+ Portfolio_2 as Portfolio,
15398
+ PositionElement,
15399
+ Position_2 as Position,
15400
+ TimeRange,
15401
+ Valuation,
15402
+ Convert_2 as Convert,
15403
+ Intents_2 as Intents,
15404
+ Channel_2 as Channel,
15405
+ DesktopAgent_2 as DesktopAgent,
15576
15406
  IntentResolution_2 as IntentResolution,
15577
- Channel_4 as Channel,
15578
15407
  PrivateChannel,
15579
- DesktopAgent_2 as DesktopAgent
15408
+ ContextHandler_2 as ContextHandler,
15409
+ IntentResult,
15410
+ IntentHandler
15580
15411
  }
15581
15412
  }
15582
15413
 
@@ -15585,6 +15416,13 @@ declare type VerboseWebPermission = {
15585
15416
  enabled: boolean;
15586
15417
  };
15587
15418
 
15419
+ declare type Version = (typeof versions)[keyof typeof versions];
15420
+
15421
+ declare const versions: {
15422
+ readonly v1_2: "1.2";
15423
+ readonly v2_0: "2.0";
15424
+ };
15425
+
15588
15426
  declare type View = OpenFin.View;
15589
15427
 
15590
15428
  /**
@@ -17286,10 +17124,12 @@ declare namespace WebContentsEvents {
17286
17124
  FileDownloadStartedEvent,
17287
17125
  FileDownloadProgressEvent,
17288
17126
  FileDownloadCompletedEvent,
17127
+ ContentBlockedEvent,
17289
17128
  Event_5 as Event,
17290
17129
  WebContentsEvent,
17291
17130
  WillPropagateWebContentsEvent,
17292
- NonPropagatedWebContentsEvent
17131
+ NonPropagatedWebContentsEvent,
17132
+ WillRedirectEvent
17293
17133
  }
17294
17134
  }
17295
17135
 
@@ -17367,14 +17207,15 @@ declare type WillPropagateWebContentsEvent = Event_5<string>;
17367
17207
  declare type WillPropagateWindowEvent = WindowSourcedEvent;
17368
17208
 
17369
17209
  /**
17370
- * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
17210
+ * Generated whenever a redirection occurs.
17371
17211
  * @interface
17372
17212
  */
17373
- declare type WillRedirectEvent = BaseEvent_5 & {
17213
+ declare type WillRedirectEvent = NamedEvent & {
17374
17214
  type: 'will-redirect';
17375
17215
  blocked: boolean;
17376
17216
  isInPlace: boolean;
17377
17217
  url: string;
17218
+ isMainFrame: boolean;
17378
17219
  };
17379
17220
 
17380
17221
  /**
@@ -17396,7 +17237,7 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
17396
17237
  */
17397
17238
  declare class _Window extends WebContents<OpenFin.WindowEvent> {
17398
17239
  /* Excluded from this release type: __constructor */
17399
- /* Excluded from this release type: createWindow */
17240
+ createWindow(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
17400
17241
  /**
17401
17242
  * Retrieves an array of frame info objects representing the main frame and any
17402
17243
  * iframes that are currently on the page.
@@ -18519,7 +18360,6 @@ declare namespace WindowEvents {
18519
18360
  AlertRequestedEvent,
18520
18361
  AuthRequestedEvent,
18521
18362
  EndLoadEvent,
18522
- WillRedirectEvent,
18523
18363
  ReloadedEvent,
18524
18364
  OptionsChangedEvent,
18525
18365
  WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
@@ -18775,7 +18615,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
18775
18615
  * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
18776
18616
  * from {@link OpenFin.ViewEvents}.
18777
18617
  */
18778
- 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;
18618
+ 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;
18779
18619
 
18780
18620
  /**
18781
18621
  * Generated when a child window starts loading.
@@ -18830,6 +18670,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18830
18670
  positioningOptions?: OpenFin.PositioningOptions;
18831
18671
  };
18832
18672
 
18673
+ declare type WithUserAppConfigArgs = {
18674
+ /**
18675
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18676
+ * that launches this application.
18677
+ *
18678
+ * @remarks
18679
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18680
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18681
+ *
18682
+ * Results in the following object:
18683
+ * ```json
18684
+ * {
18685
+ * "use-last-configuration": true"
18686
+ * }
18687
+ * ```
18688
+ *
18689
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18690
+ * ```typescript
18691
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18692
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18693
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18694
+ * ```
18695
+ */
18696
+ userAppConfigArgs?: UserAppConfigArgs;
18697
+ };
18698
+
18833
18699
  /* Excluded from this release type: WorkspacePlatformOptions */
18834
18700
 
18835
18701
  /**