@openfin/core 37.80.38 → 38.81.8

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}.
@@ -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_2.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_2.Fin['InterApplicationBus']['Channel'];
2286
+ declare type Channel_3 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
2391
2287
 
2392
2288
  declare type ChannelAction = OpenFin_2.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_2.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;
@@ -3498,7 +3396,7 @@ declare type ConstViewOptions = {
3498
3396
  /**
3499
3397
  * Configurations for API injection.
3500
3398
  */
3501
- api: Api;
3399
+ api: ApiSettings;
3502
3400
  /**
3503
3401
  * The name of the view.
3504
3402
  */
@@ -3918,7 +3816,23 @@ declare interface Container extends EventEmitter_2 {
3918
3816
  close(): boolean;
3919
3817
  }
3920
3818
 
3921
- declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3819
+ /**
3820
+ * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
3821
+ */
3822
+ declare type ContentBlockedEvent = NamedEvent & {
3823
+ type: 'content-blocked';
3824
+ /**
3825
+ * The domain whose content was blocked.
3826
+ */
3827
+ url: string;
3828
+ };
3829
+
3830
+ declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3831
+
3832
+ /**
3833
+ * @deprecated Renamed to {@link ContentCreationBehavior}.
3834
+ */
3835
+ declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3922
3836
 
3923
3837
  /**
3924
3838
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3942,7 +3856,7 @@ declare type ContentCreationOptions = {
3942
3856
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3943
3857
  * the specified `behavior` key.
3944
3858
  */
3945
- declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3859
+ declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3946
3860
  behavior: Behavior;
3947
3861
  }>;
3948
3862
 
@@ -4192,39 +4106,39 @@ declare interface ContentItem extends EventEmitter_2 {
4192
4106
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4193
4107
  * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4194
4108
  *
4109
+ * @remarks Superseded by {@link DomainSettingsRule.content}. If {@link DomainSettings.default} includes a
4110
+ * `content` setting, this setting will be **ignored**.
4111
+ *
4195
4112
  * @interface
4196
4113
  */
4197
4114
  declare type ContentNavigation = NavigationRules;
4198
4115
 
4116
+ /**
4117
+ * Whether a content url is allowed or blocked for navigation or redirection.
4118
+ *
4119
+ * * 'allow': The content url is allowed.
4120
+ * * 'block': The content url is blocked.
4121
+ */
4122
+ declare type ContentPermission = 'allow' | 'block';
4123
+
4199
4124
  /**
4200
4125
  * Restrict redirects to URLs that match an allowed pattern.
4201
4126
  * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4202
4127
  * See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
4203
4128
  *
4129
+ * @remarks Superseded by {@link DomainSettingsRule.content}. If {@link DomainSettings.default} includes a
4130
+ * `content` setting, this setting will be **ignored**.
4131
+ *
4204
4132
  * @interface
4205
4133
  */
4206
4134
  declare type ContentRedirect = NavigationRules;
4207
4135
 
4208
- declare interface Context {
4209
- id?: { [key: string]: string };
4210
- name?: string;
4211
- type: string;
4212
- }
4213
-
4214
- declare interface Context_2 {
4215
- id?: { [key: string]: string };
4216
- name?: string;
4217
- type: string;
4218
- contextMetadata?: ContextMetadata;
4219
- metadata?: any;
4220
- }
4221
-
4222
4136
  /**
4223
4137
  * Data passed between entities and applications.
4224
4138
  *
4225
4139
  * @interface
4226
4140
  */
4227
- declare type Context_3 = {
4141
+ declare type Context = {
4228
4142
  /**
4229
4143
  * An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
4230
4144
  */
@@ -4253,7 +4167,7 @@ declare type ContextChangedEvent = BaseEvent_5 & {
4253
4167
  /**
4254
4168
  * @interface
4255
4169
  */
4256
- declare type ContextForIntent<MetadataType = any> = Context_3 & {
4170
+ declare type ContextForIntent<MetadataType = any> = Context & {
4257
4171
  metadata?: MetadataType;
4258
4172
  };
4259
4173
 
@@ -4269,23 +4183,19 @@ declare type ContextGroupInfo = {
4269
4183
  /**
4270
4184
  * Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.
4271
4185
  */
4272
- displayMetadata?: DisplayMetadata_3;
4186
+ displayMetadata?: DisplayMetadata;
4273
4187
  };
4274
4188
 
4275
4189
  declare type ContextGroupStates = {
4276
4190
  [key: string]: {
4277
- [key: string]: Context_3;
4191
+ [key: string]: Context;
4278
4192
  };
4279
4193
  };
4280
4194
 
4281
- declare type ContextHandler = (context: Context) => void;
4282
-
4283
- declare type ContextHandler_2 = (context: Context_2, metadata?: ContextMetadata) => void;
4284
-
4285
4195
  /**
4286
4196
  * Subscription function for addContextHandler.
4287
4197
  */
4288
- declare type ContextHandler_3 = (context: Context_3) => void;
4198
+ declare type ContextHandler = (context: Context) => void;
4289
4199
 
4290
4200
  /**
4291
4201
  * Configure the context menu when right-clicking on a window.
@@ -4324,20 +4234,6 @@ declare type ContextMenuSettings = {
4324
4234
  reload?: boolean;
4325
4235
  };
4326
4236
 
4327
- /**
4328
- * Metadata relating to a context or intent and context received through the
4329
- * `addContextListener` and `addIntentListener` functions.
4330
- *
4331
- * @experimental Introduced in FDC3 2.0 and may be refined by further changes outside the normal FDC3 versioning policy.
4332
- */
4333
- declare interface ContextMetadata {
4334
- /** Identifier for the app instance that sent the context and/or intent.
4335
- *
4336
- * @experimental
4337
- */
4338
- readonly source: AppIdentifier;
4339
- }
4340
-
4341
4237
  /**
4342
4238
  * @interface
4343
4239
  */
@@ -4584,45 +4480,6 @@ declare type DefaultDomainSettings = DomainSettings;
4584
4480
  */
4585
4481
  declare type DefaultDomainSettingsRule = DomainSettingsRule;
4586
4482
 
4587
- declare interface DesktopAgent {
4588
- open(app: TargetApp, context?: Context): Promise<void>;
4589
- findIntent(intent: string, context?: Context): Promise<AppIntent>;
4590
- findIntentsByContext(context: Context): Promise<Array<AppIntent>>;
4591
- broadcast(context: Context): void;
4592
- raiseIntent(intent: string, context: Context, app?: TargetApp): Promise<IntentResolution>;
4593
- raiseIntentForContext(context: Context, app?: TargetApp): Promise<IntentResolution>;
4594
- addIntentListener(intent: string, handler: ContextHandler): Listener;
4595
- joinChannel(channelId: string): Promise<void>;
4596
- leaveCurrentChannel(): Promise<void>;
4597
- getInfo(): ImplementationMetadata;
4598
- addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
4599
- getOrCreateChannel(channelId: string): Promise<Channel_3>;
4600
- getSystemChannels(): Promise<SystemChannel[]>;
4601
- getCurrentChannel(): Promise<Channel_3 | null>;
4602
- }
4603
-
4604
- declare interface DesktopAgent_2 {
4605
- open(app: AppIdentifier | TargetApp, context?: Context_2): Promise<AppIdentifier>;
4606
- findIntent(intent: string, context?: Context_2, resultType?: string): Promise<AppIntent_2>;
4607
- findIntentsByContext(context: Context_2, resultType?: string): Promise<Array<AppIntent_2>>;
4608
- findInstances(app: AppIdentifier): Promise<Array<AppIdentifier>>;
4609
- broadcast(context: Context_2): Promise<void>;
4610
- raiseIntent(intent: string, context: Context_2, app?: AppIdentifier | TargetApp): Promise<IntentResolution_2>;
4611
- raiseIntentForContext(context: Context_2, app?: AppIdentifier | TargetApp): Promise<IntentResolution_2>;
4612
- addIntentListener(intent: string, handler: IntentHandler): Promise<Listener_2>;
4613
- addContextListener(contextType: string | null, handler: ContextHandler_2): Promise<Listener_2>;
4614
- getUserChannels(): Promise<Array<SystemChannel>>;
4615
- joinUserChannel(channelId: string): Promise<void>;
4616
- getOrCreateChannel(channelId: string): Promise<Channel_4>;
4617
- createPrivateChannel(): Promise<PrivateChannel>;
4618
- getCurrentChannel(): Promise<Channel_3 | null>;
4619
- leaveCurrentChannel(): Promise<void>;
4620
- getInfo(): Promise<ImplementationMetadata_2>;
4621
- getAppMetadata(app: AppIdentifier): Promise<AppMetadata_2>;
4622
- getSystemChannels(): Promise<Array<SystemChannel>>;
4623
- joinChannel(channelId: string): Promise<void>;
4624
- }
4625
-
4626
4483
  /**
4627
4484
  * Generated when the desktop icon is clicked while it's already running.
4628
4485
  * @interface
@@ -4767,52 +4624,12 @@ declare type DisconnectedEvent_3 = BaseFrameEvent & {
4767
4624
  type: 'disconnected';
4768
4625
  };
4769
4626
 
4770
- /**
4771
- * A system channel will be global enough to have a presence across many apps. This gives us some hints
4772
- * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
4773
- * this is their meaning.
4774
- */
4775
- declare interface DisplayMetadata {
4776
- /**
4777
- * A user-readable name for this channel, e.g: `"Red"`
4778
- */
4779
- readonly name?: string;
4780
- /**
4781
- * The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
4782
- */
4783
- readonly color?: string;
4784
- /**
4785
- * A URL of an image that can be used to display this channel
4786
- */
4787
- readonly glyph?: string;
4788
- }
4789
-
4790
- /**
4791
- * A system channel will be global enough to have a presence across many apps. This gives us some hints
4792
- * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
4793
- * this is their meaning.
4794
- */
4795
- declare interface DisplayMetadata_2 {
4796
- /**
4797
- * A user-readable name for this channel, e.g: `"Red"`
4798
- */
4799
- readonly name?: string;
4800
- /**
4801
- * The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
4802
- */
4803
- readonly color?: string;
4804
- /**
4805
- * A URL of an image that can be used to display this channel
4806
- */
4807
- readonly glyph?: string;
4808
- }
4809
-
4810
4627
  /**
4811
4628
  * The display data for a context group.
4812
4629
  *
4813
4630
  * @interface
4814
4631
  */
4815
- declare type DisplayMetadata_3 = {
4632
+ declare type DisplayMetadata = {
4816
4633
  /**
4817
4634
  * A user-readable name for this context group, e.g: `"Red"`
4818
4635
  */
@@ -4827,6 +4644,25 @@ declare type DisplayMetadata_3 = {
4827
4644
  readonly glyph?: string;
4828
4645
  };
4829
4646
 
4647
+ /**
4648
+ * @interface
4649
+ *
4650
+ * Rules for domain-conditional `fin` API injection.
4651
+ *
4652
+ * @remarks Subset of {@link DomainSettings}.
4653
+ */
4654
+ declare type DomainApiSettings = {
4655
+ /**
4656
+ * Injection setting for the `fin` API for contexts on a matched domain.
4657
+ *
4658
+ * * 'none': The `fin` API will be not available.
4659
+ * * 'global': The entire `fin` API will be available.
4660
+ *
4661
+ * @defaultValue 'global'
4662
+ */
4663
+ fin: InjectionType;
4664
+ };
4665
+
4830
4666
  /**
4831
4667
  * @interface
4832
4668
  * Defines application settings that vary by the domain of the current context.
@@ -4839,6 +4675,10 @@ declare type DomainSettings = {
4839
4675
  * {@inheritDoc DomainSettingsRule}
4840
4676
  */
4841
4677
  rules: DomainSettingsRule[];
4678
+ /**
4679
+ * Default values for settings in {@link DomainSettingsRule}.
4680
+ */
4681
+ default?: PerDomainSettings;
4842
4682
  };
4843
4683
 
4844
4684
  /**
@@ -4851,22 +4691,11 @@ declare type DomainSettingsRule = {
4851
4691
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4852
4692
  * the domain(s) for which the rule applies.
4853
4693
  */
4854
- match: string[];
4694
+ match?: string[];
4855
4695
  /**
4856
4696
  * Settings applied when a webcontents has been navigated to a matched domain.
4857
4697
  */
4858
- options: {
4859
- /**
4860
- * {@inheritDoc FileDownloadSettings}
4861
- *
4862
- * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
4863
- */
4864
- downloadSettings?: FileDownloadSettings;
4865
- /**
4866
- * {@inheritDoc ApiInjection}
4867
- */
4868
- api?: ApiInjection;
4869
- };
4698
+ options: PerDomainSettings;
4870
4699
  };
4871
4700
 
4872
4701
  /**
@@ -4904,18 +4733,19 @@ declare type DownloadPreloadOption = {
4904
4733
  /**
4905
4734
  * @interface
4906
4735
  *
4907
- * A rule governing domain-conditional download behavior.
4736
+ * A rule that governs download behavior, discriminated by the URL of the download.
4908
4737
  */
4909
4738
  declare type DownloadRule = {
4910
4739
  /**
4911
- * {@inheritDoc FileDownloadBehaviorNames}
4740
+ * {@inheritDoc FileDownloadBehavior}
4912
4741
  */
4913
- behavior: FileDownloadBehaviorNames;
4742
+ behavior: FileDownloadBehavior;
4914
4743
  /**
4915
4744
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4916
- * the domain(s) for which the rule applies.
4745
+ * URL(s) of the resource(s) being downloaded.
4917
4746
  *
4918
- * @remarks The match is evaluated against the URL of the *download*.
4747
+ * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4748
+ * of the page in which a file download link is embedded.
4919
4749
  */
4920
4750
  match: string[];
4921
4751
  };
@@ -5190,7 +5020,7 @@ declare interface Environment {
5190
5020
  getWsConstructor(): typeof WebSocket;
5191
5021
  whenReady(): Promise<void>;
5192
5022
  getInteropInfo(fin: OpenFin_2.Fin<OpenFin_2.EntityType>): Promise<InternalInteropBrokerOptions & {
5193
- fdc3Version?: Fdc3Version;
5023
+ fdc3Version?: Version;
5194
5024
  }>;
5195
5025
  readonly type: EnvironmentType;
5196
5026
  }
@@ -5258,7 +5088,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
5258
5088
  */
5259
5089
  declare type Event_5<Topic extends string> = {
5260
5090
  topic: Topic;
5261
- } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
5091
+ } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent);
5262
5092
 
5263
5093
  /**
5264
5094
  * [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
@@ -5595,13 +5425,12 @@ declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
5595
5425
 
5596
5426
  declare namespace FDC3 {
5597
5427
  export {
5598
- v1,
5599
- v2
5428
+ Version,
5429
+ v1_2,
5430
+ v2_0
5600
5431
  }
5601
5432
  }
5602
5433
 
5603
- declare type Fdc3Version = '1.2' | '2.0';
5604
-
5605
5434
  /**
5606
5435
  * @interface
5607
5436
  */
@@ -5615,7 +5444,12 @@ declare type FetchManifestPayload = {
5615
5444
  /**
5616
5445
  * Whether file downloads raise a user prompt.
5617
5446
  */
5618
- declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5447
+ declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5448
+
5449
+ /**
5450
+ * @deprecated Renamed to {@link FileDownloadBehavior}.
5451
+ */
5452
+ declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5619
5453
 
5620
5454
  /**
5621
5455
  * Generated when a file download has completed.
@@ -5802,8 +5636,8 @@ declare type FindInPageResult = {
5802
5636
  /**
5803
5637
  * @interface
5804
5638
  */
5805
- declare type FindIntentsByContextOptions<MetadataType = IntentMetadata_3> = {
5806
- context: Context_3;
5639
+ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
5640
+ context: Context;
5807
5641
  metadata?: MetadataType;
5808
5642
  };
5809
5643
 
@@ -6242,6 +6076,20 @@ declare class GoldenLayout_2 implements EventEmitter_2 {
6242
6076
 
6243
6077
  dropTargetIndicator: any;
6244
6078
 
6079
+ _isFullPage: boolean;
6080
+
6081
+ _onUnload: any;
6082
+
6083
+ tabDropPlaceholder: any;
6084
+
6085
+ transitionIndicator: any;
6086
+
6087
+ _dragSources: any;
6088
+
6089
+ _resizeFunction: any;
6090
+
6091
+ _unloadFunction: any;
6092
+
6245
6093
  /**
6246
6094
  * @param config A GoldenLayout configuration object
6247
6095
  * @param container The DOM element the layout will be initialised in. Default: document.body
@@ -6570,15 +6418,6 @@ declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
6570
6418
  type: 'hotkey';
6571
6419
  };
6572
6420
 
6573
- declare interface Icon {
6574
- /** The icon url */
6575
- readonly src: string;
6576
- /** The icon dimension, formatted as `<height>x<width>`. */
6577
- readonly size?: string;
6578
- /** Icon media type. If not present the Desktop Agent may use the src file extension. */
6579
- readonly type?: string;
6580
- }
6581
-
6582
6421
  declare type Identity = OpenFin_2.Identity;
6583
6422
 
6584
6423
  declare type Identity_2 = OpenFin_2.Identity;
@@ -6637,17 +6476,6 @@ declare type IdleStateChangedEvent = BaseEvent_9 & {
6637
6476
  isIdle: boolean;
6638
6477
  };
6639
6478
 
6640
- declare interface Image_2 {
6641
- /** The image url. */
6642
- readonly src: string;
6643
- /** The image dimension, formatted as `<height>x<width>`. */
6644
- readonly size?: string;
6645
- /** Image media type. If not present the Desktop Agent may use the src file extension. */
6646
- readonly type?: string;
6647
- /** Caption for the image. */
6648
- readonly label?: string;
6649
- }
6650
-
6651
6479
  declare type ImageFormatOptions = {
6652
6480
  format: 'dataURL' | 'png' | 'bmp';
6653
6481
  } | {
@@ -6658,57 +6486,15 @@ declare type ImageFormatOptions = {
6658
6486
  quality?: number;
6659
6487
  };
6660
6488
 
6661
- /**
6662
- * Metadata relating to the FDC3 Desktop Agent implementation and its provider.
6663
- */
6664
- declare interface ImplementationMetadata {
6665
- /** The version number of the FDC3 specification that the implementation provides.
6666
- * The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
6667
- */
6668
- readonly fdc3Version: string;
6669
- /** The name of the provider of the FDC3 Desktop Agent Implementation (e.g. Finsemble, Glue42, OpenFin etc.). */
6670
- readonly provider: string;
6671
- /** The version of the provider of the FDC3 Desktop Agent Implementation (e.g. 5.3.0). */
6672
- readonly providerVersion?: string;
6673
- }
6674
-
6675
- /**
6676
- * Metadata relating to the FDC3 Desktop Agent implementation and its provider.
6677
- */
6678
- declare interface ImplementationMetadata_2 {
6679
- /** The version number of the FDC3 specification that the implementation provides.
6680
- * The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
6681
- */
6682
- readonly fdc3Version: string;
6683
- /** The name of the provider of the Desktop Agent implementation (e.g. Finsemble, Glue42, OpenFin etc.). */
6684
- readonly provider: string;
6685
- /** The version of the provider of the Desktop Agent implementation (e.g. 5.3.0). */
6686
- readonly providerVersion?: string;
6687
- /** Metadata indicating whether the Desktop Agent implements optional features of
6688
- * the Desktop Agent API.
6689
- */
6690
- readonly optionalFeatures: {
6691
- /** Used to indicate whether the exposure of 'originating app metadata' for
6692
- * context and intent messages is supported by the Desktop Agent. */
6693
- readonly OriginatingAppMetadata: boolean;
6694
- /** Used to indicate whether the optional `fdc3.joinUserChannel`,
6695
- * `fdc3.getCurrentChannel` and `fdc3.leaveCurrentChannel` are implemented by
6696
- * the Desktop Agent. */
6697
- readonly UserChannelMembershipAPIs: boolean;
6698
- };
6699
- /** The calling application instance's own metadata, according to the Desktop Agent (MUST include at least the `appId` and `instanceId`). */
6700
- readonly appMetadata: AppMetadata_2;
6701
- }
6702
-
6703
6489
  /**
6704
6490
  * @interface
6705
6491
  */
6706
- declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6492
+ declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
6707
6493
  /**
6708
6494
  * Name of the intent to get info for.
6709
6495
  */
6710
6496
  name: string;
6711
- context?: Context_3;
6497
+ context?: Context;
6712
6498
  metadata?: MetadataType;
6713
6499
  };
6714
6500
 
@@ -6816,16 +6602,10 @@ declare type InstalledApps_2 = {
6816
6602
  [key: string]: InstallationInfo;
6817
6603
  };
6818
6604
 
6819
- declare interface Intent {
6820
- name: string;
6821
- context: Context_2;
6822
- metadata: IntentMetadata_2;
6823
- }
6824
-
6825
6605
  /**
6826
6606
  * Combination of an action and a context that is passed to an application for resolution.
6827
6607
  */
6828
- declare type Intent_2<MetadataType = IntentMetadata_3> = {
6608
+ declare type Intent<MetadataType = IntentMetadata> = {
6829
6609
  /**
6830
6610
  * Name of the intent.
6831
6611
  */
@@ -6833,54 +6613,25 @@ declare type Intent_2<MetadataType = IntentMetadata_3> = {
6833
6613
  /**
6834
6614
  * Data associated with the intent.
6835
6615
  */
6836
- context: Context_3;
6616
+ context: Context;
6837
6617
  metadata?: MetadataType;
6838
6618
  };
6839
6619
 
6840
- declare type IntentHandler = (context: Context_2, metadata?: ContextMetadata) => Promise<IntentResult> | void;
6841
-
6842
6620
  /**
6843
6621
  * Subscription function for registerIntentHandler.
6844
6622
  */
6845
- declare type IntentHandler_2 = (intent: Intent_2) => void;
6623
+ declare type IntentHandler = (intent: Intent) => void;
6846
6624
 
6847
6625
  /**
6848
- * Intent descriptor
6626
+ * The type used to describe an intent within the platform.
6627
+ * @interface
6849
6628
  */
6850
- declare interface IntentMetadata {
6851
- /** The unique name of the intent that can be invoked by the raiseIntent call */
6852
- readonly name: string;
6853
- /** A friendly display name for the intent that should be used to render UI elements */
6854
- readonly displayName: string;
6855
- }
6856
-
6857
- declare type IntentMetadata_2<TargetType = any> = {
6629
+ declare type IntentMetadata<TargetType = any> = {
6858
6630
  target?: TargetType;
6859
6631
  resultType?: string;
6860
6632
  intentResolutionResultId?: string;
6861
6633
  };
6862
6634
 
6863
- /**
6864
- * The type used to describe an intent within the platform.
6865
- * @interface
6866
- */
6867
- declare type IntentMetadata_3<TargetType = any> = FDC3.v2.IntentMetadata<TargetType>;
6868
-
6869
- declare interface IntentResolution {
6870
- source: TargetApp;
6871
- data?: object;
6872
- version: string;
6873
- }
6874
-
6875
- declare interface IntentResolution_2 {
6876
- source: AppIdentifier;
6877
- intent: string;
6878
- version?: string;
6879
- getResult(): Promise<IntentResult>;
6880
- }
6881
-
6882
- declare type IntentResult = Context_2 | Channel_4 | PrivateChannel;
6883
-
6884
6635
  /**
6885
6636
  * A messaging bus that allows for pub/sub messaging between different applications.
6886
6637
  *
@@ -7126,7 +6877,6 @@ declare type InteropActionLoggingOption = {
7126
6877
  */
7127
6878
  declare class InteropBroker extends Base {
7128
6879
  #private;
7129
- private getProvider;
7130
6880
  private interopClients;
7131
6881
  private contextGroupsById;
7132
6882
  private intentClientMap;
@@ -7135,6 +6885,7 @@ declare class InteropBroker extends Base {
7135
6885
  private channel;
7136
6886
  private logging;
7137
6887
  /* Excluded from this release type: __constructor */
6888
+ private getProvider;
7138
6889
  static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
7139
6890
  new (): InteropBroker;
7140
6891
  };
@@ -7439,23 +7190,23 @@ declare class InteropBroker extends Base {
7439
7190
  * @param clientIdentity Identity of the Client making the request.
7440
7191
  */
7441
7192
  fdc3HandleOpen({ app, context }: {
7442
- app: FDC3.v1.TargetApp | FDC3.v2.AppIdentifier;
7193
+ app: FDC3.v1_2.TargetApp | FDC3.v2_0.AppIdentifier;
7443
7194
  context: OpenFin_2.Context;
7444
- }, clientIdentity: OpenFin_2.ClientIdentity): Promise<void | FDC3.v2.AppIdentifier>;
7195
+ }, clientIdentity: OpenFin_2.ClientIdentity): Promise<void | FDC3.v2_0.AppIdentifier>;
7445
7196
  /**
7446
7197
  * Responsible for resolving the fdc3.findInstances call.
7447
7198
  * Must be overridden
7448
7199
  * @param app AppIdentifier that was passed to fdc3.findInstances
7449
7200
  * @param clientIdentity Identity of the Client making the request.
7450
7201
  */
7451
- fdc3HandleFindInstances(app: FDC3.v2.AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
7202
+ fdc3HandleFindInstances(app: FDC3.v2_0.AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
7452
7203
  /**
7453
7204
  * Responsible for resolving the fdc3.getAppMetadata call.
7454
7205
  * Must be overridden
7455
7206
  * @param app AppIdentifier that was passed to fdc3.getAppMetadata
7456
7207
  * @param clientIdentity Identity of the Client making the request.
7457
7208
  */
7458
- fdc3HandleGetAppMetadata(app: FDC3.v2.AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
7209
+ fdc3HandleGetAppMetadata(app: FDC3.v2_0.AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
7459
7210
  /**
7460
7211
  * This function is called by the Interop Broker whenever a Context handler would fire.
7461
7212
  * For FDC3 2.0 you would need to override this function and add the contextMetadata as
@@ -8049,6 +7800,23 @@ declare class InteropClient extends Base {
8049
7800
  * ```
8050
7801
  */
8051
7802
  onDisconnection(listener: OpenFin_2.InteropClientOnDisconnectionListener): Promise<void>;
7803
+ /**
7804
+ * Returns a representation of this Interop Client as an FDC3 DesktopAgent matching the given version.
7805
+ * Note that this does not set a global FDC3 object, it only returns an instance of the FDC3 DesktopAgent.
7806
+ * This also does not raise the FDC3Ready event.
7807
+ */
7808
+ getFDC3Sync(version: '2.0'): OpenFin_2.FDC3.v2_0.DesktopAgent;
7809
+ getFDC3Sync(version: '1.2'): OpenFin_2.FDC3.v1_2.DesktopAgent;
7810
+ getFDC3Sync(version: OpenFin_2.FDC3.Version): OpenFin_2.FDC3.v1_2.DesktopAgent | OpenFin_2.FDC3.v2_0.DesktopAgent;
7811
+ /**
7812
+ *
7813
+ * Returns a representation of this Interop Client as an FDC3 DesktopAgent matching the given version.
7814
+ * Note that this does not set a global FDC3 object, it only returns an instance of the FDC3 DesktopAgent.
7815
+ * This also does not raise the FDC3Ready event.
7816
+ */
7817
+ getFDC3(version: '2.0'): Promise<OpenFin_2.FDC3.v2_0.DesktopAgent>;
7818
+ getFDC3(version: '1.2'): Promise<OpenFin_2.FDC3.v1_2.DesktopAgent>;
7819
+ getFDC3(version: OpenFin_2.FDC3.Version): Promise<OpenFin_2.FDC3.v1_2.DesktopAgent | OpenFin_2.FDC3.v2_0.DesktopAgent>;
8052
7820
  /* Excluded from this release type: ferryFdc3Call */
8053
7821
  }
8054
7822
 
@@ -9093,21 +8861,7 @@ declare type LayoutSnapshot = {
9093
8861
  */
9094
8862
  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'>;
9095
8863
 
9096
- declare interface Listener {
9097
- /**
9098
- * Unsubscribe the listener object.
9099
- */
9100
- unsubscribe(): void;
9101
- }
9102
-
9103
- declare interface Listener_2 {
9104
- /**
9105
- * Unsubscribe the listener object.
9106
- */
9107
- unsubscribe(): void;
9108
- }
9109
-
9110
- declare type Listener_3<T extends {
8864
+ declare type Listener<T extends {
9111
8865
  type: string;
9112
8866
  }> = (payload: T) => void;
9113
8867
 
@@ -9496,7 +9250,7 @@ declare type MutableViewOptions = {
9496
9250
  /**
9497
9251
  * Configurations for API injection.
9498
9252
  */
9499
- api: Api;
9253
+ api: ApiSettings;
9500
9254
  /**
9501
9255
  * Restrict navigation to URLs that match an allowed pattern.
9502
9256
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -9874,6 +9628,7 @@ declare namespace OpenFin_2 {
9874
9628
  export {
9875
9629
  FinApi,
9876
9630
  Fin,
9631
+ FDC3,
9877
9632
  Application,
9878
9633
  ApplicationModule,
9879
9634
  ExternalApplication,
@@ -9925,11 +9680,11 @@ declare namespace OpenFin_2 {
9925
9680
  CustomProtocolOptions,
9926
9681
  InteropBrokerOptions,
9927
9682
  ContextGroupInfo,
9928
- DisplayMetadata_3 as DisplayMetadata,
9683
+ DisplayMetadata,
9929
9684
  LegacyWinOptionsInAppOptions,
9930
9685
  Snapshot,
9931
9686
  ContextGroupStates,
9932
- Context_3 as Context,
9687
+ Context,
9933
9688
  MonitorInfo,
9934
9689
  Point,
9935
9690
  PointTopLeft,
@@ -9956,6 +9711,7 @@ declare namespace OpenFin_2 {
9956
9711
  ResizeRegion,
9957
9712
  Accelerator,
9958
9713
  Api,
9714
+ ApiSettings,
9959
9715
  InjectionType,
9960
9716
  NavigationRules,
9961
9717
  ContentNavigation,
@@ -10107,14 +9863,19 @@ declare namespace OpenFin_2 {
10107
9863
  DefaultDomainSettingsRule,
10108
9864
  DomainSettings,
10109
9865
  ApiInjection,
9866
+ DomainApiSettings,
9867
+ ContentPermission,
9868
+ PerDomainSettings,
10110
9869
  DomainSettingsRule,
9870
+ FileDownloadBehavior,
10111
9871
  FileDownloadBehaviorNames,
10112
9872
  FileDownloadSettings,
10113
9873
  DownloadRule,
10114
- ContextHandler_3 as ContextHandler,
10115
- Intent_2 as Intent,
10116
- IntentMetadata_3 as IntentMetadata,
10117
- IntentHandler_2 as IntentHandler,
9874
+ ContextHandler,
9875
+ Intent,
9876
+ IntentMetadata,
9877
+ IntentHandler,
9878
+ ContentCreationBehavior,
10118
9879
  ContentCreationBehaviorNames,
10119
9880
  MatchPattern,
10120
9881
  BaseContentCreationRule,
@@ -10335,6 +10096,31 @@ declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10335
10096
  type: Type;
10336
10097
  }>;
10337
10098
 
10099
+ /**
10100
+ * @interface
10101
+ *
10102
+ * Conditional settings for a domain or set of domains.
10103
+ */
10104
+ declare type PerDomainSettings = {
10105
+ /**
10106
+ * {@inheritDoc FileDownloadSettings}
10107
+ *
10108
+ * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
10109
+ */
10110
+ downloadSettings?: FileDownloadSettings;
10111
+ /**
10112
+ * {@inheritDoc ApiInjection}
10113
+ */
10114
+ api?: DomainApiSettings;
10115
+ /**
10116
+ * Whether DOM content can be loaded (by navigation or redirect).
10117
+ *
10118
+ * @remarks If this is included in {@link DomainSettings.default}, then {@link ContentNavigation} and
10119
+ * {@link ContentRedirect} will be **ignored**.
10120
+ */
10121
+ content?: ContentPermission;
10122
+ };
10123
+
10338
10124
  /**
10339
10125
  * Generated when window finishes loading. Provides performance and navigation data.
10340
10126
  * @interface
@@ -12071,14 +11857,6 @@ declare type PrintOptions = {
12071
11857
  dpi?: Dpi;
12072
11858
  };
12073
11859
 
12074
- declare type PrivateChannel = Omit<Channel_4, 'addContextListener'> & {
12075
- addContextListener(contextType: string | null, handler: ContextHandler_2): Promise<Listener_2>;
12076
- onAddContextListener(handler: (contextType?: string) => void): Listener_2;
12077
- onUnsubscribe(handler: (contextType?: string) => void): Listener_2;
12078
- onDisconnect(handler: () => void): Listener_2;
12079
- disconnect(): void;
12080
- };
12081
-
12082
11860
  /**
12083
11861
  * Strategy to assign views to process affinity by domain.
12084
11862
  *
@@ -13044,19 +12822,19 @@ declare type SessionContextGroup = {
13044
12822
  * A SessionContextGroup instance method for setting a context in the SessionContextGroup.
13045
12823
  * @param context The Context to be set.
13046
12824
  */
13047
- setContext: (context: Context_3) => Promise<void>;
12825
+ setContext: (context: Context) => Promise<void>;
13048
12826
  /**
13049
12827
  * A SessionContextGroup instance method for getting the current context of a certain type.
13050
12828
  * @param type The Context Type to get. If not specified the last contextType set would get used.
13051
12829
  */
13052
- getCurrentContext: (type?: string) => Promise<Context_3>;
12830
+ getCurrentContext: (type?: string) => Promise<Context>;
13053
12831
  /**
13054
12832
  * A SessionContextGroup instance method for adding a handler for context change.
13055
12833
  * @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.
13056
12834
  * @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.
13057
12835
  *
13058
12836
  */
13059
- addContextHandler: (handler: ContextHandler_3, contextType?: string) => Promise<{
12837
+ addContextHandler: (handler: ContextHandler, contextType?: string) => Promise<{
13060
12838
  unsubscribe: () => void;
13061
12839
  }>;
13062
12840
  };
@@ -14943,12 +14721,6 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
14943
14721
  setDomainSettings(domainSettings: OpenFin_2.DefaultDomainSettings): Promise<void>;
14944
14722
  }
14945
14723
 
14946
- declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast' | 'getCurrentContext'> & {
14947
- addContextListener(): Error;
14948
- broadcast(): Error;
14949
- getCurrentContext(): Error;
14950
- };
14951
-
14952
14724
  /**
14953
14725
  * @deprecated Renamed to {@link Event}.
14954
14726
  */
@@ -15220,8 +14992,6 @@ declare class TabStack extends LayoutNode {
15220
14992
  setActiveView: (view: OpenFin_2.Identity) => Promise<void>;
15221
14993
  }
15222
14994
 
15223
- declare type TargetApp = string | AppMetadata;
15224
-
15225
14995
  /**
15226
14996
  * Generated when a View changes its window target.
15227
14997
  * @remarks This event will fire during creation of a View.
@@ -15419,13 +15189,13 @@ declare type tween = 'linear' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'ease-i
15419
15189
  declare interface TypedEventEmitter<Event extends {
15420
15190
  type: string;
15421
15191
  }, EmitterEventType = Event['type']> {
15422
- on<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
15192
+ on<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
15423
15193
  type: EventType;
15424
15194
  }>>): this;
15425
- addListener<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
15195
+ addListener<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
15426
15196
  type: EventType;
15427
15197
  }>>): this;
15428
- removeListener<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
15198
+ removeListener<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
15429
15199
  type: EventType;
15430
15200
  }>>): this;
15431
15201
  removeAllListeners<EventType extends EmitterEventType>(event?: EmitterEventType): this;
@@ -15496,45 +15266,102 @@ declare type UserMovementEnabledEvent = BaseEvent_5 & {
15496
15266
  type: 'user-movement-enabled';
15497
15267
  };
15498
15268
 
15499
- declare namespace v1 {
15500
- export {
15501
- Listener,
15502
- AppMetadata,
15503
- IntentMetadata,
15269
+ declare namespace v1_2 {
15270
+ {
15504
15271
  AppIntent,
15272
+ AppMetadata,
15505
15273
  DisplayMetadata,
15274
+ OpenError,
15275
+ ResolveError,
15276
+ ChannelError,
15506
15277
  ImplementationMetadata,
15507
- ContextHandler,
15508
- TargetApp,
15278
+ IntentMetadata,
15279
+ Listener,
15280
+ ContextTypes,
15281
+ ContextType,
15509
15282
  Context,
15283
+ ContactList,
15284
+ Contact,
15285
+ ContactID,
15286
+ InstrumentList,
15287
+ Instrument,
15288
+ InstrumentID,
15289
+ Country,
15290
+ CountryID,
15291
+ Organization,
15292
+ OrganizationID,
15293
+ Portfolio,
15294
+ Position,
15295
+ Convert,
15296
+ Intents,
15297
+ Channel,
15298
+ DesktopAgent,
15510
15299
  IntentResolution,
15511
- Channel_3 as Channel,
15512
- SystemChannel,
15513
- DesktopAgent
15300
+ TargetApp,
15301
+ ContextHandler
15514
15302
  }
15515
15303
  }
15516
15304
 
15517
- declare namespace v2 {
15518
- export {
15519
- IntentMetadata_2 as IntentMetadata,
15305
+ declare namespace v2_0 {
15306
+ {
15520
15307
  AppIdentifier,
15521
- Listener_2 as Listener,
15522
15308
  AppIntent_2 as AppIntent,
15523
- ImplementationMetadata_2 as ImplementationMetadata,
15309
+ AppMetadata_2 as AppMetadata,
15524
15310
  ContextMetadata,
15311
+ DisplayMetadata_2 as DisplayMetadata,
15312
+ OpenError_2 as OpenError,
15313
+ ResolveError_2 as ResolveError,
15314
+ ResultError,
15315
+ ChannelError_2 as ChannelError,
15525
15316
  Icon,
15526
15317
  Image_2 as Image,
15527
- AppMetadata_2 as AppMetadata,
15528
- DisplayMetadata_2 as DisplayMetadata,
15529
- ContextHandler_2 as ContextHandler,
15530
- IntentHandler,
15531
- IntentResult,
15318
+ ImplementationMetadata_2 as ImplementationMetadata,
15319
+ IntentMetadata_2 as IntentMetadata,
15320
+ Listener_2 as Listener,
15321
+ ContextTypes_2 as ContextTypes,
15322
+ ContextType_2 as ContextType,
15323
+ Chart,
15324
+ InstrumentElement,
15325
+ PurpleID,
15326
+ PurpleMarket,
15327
+ TimeRangeObject,
15328
+ Style,
15329
+ ChatInitSettings,
15330
+ ContactListObject,
15331
+ ContactElement,
15332
+ FluffyID,
15333
+ Contact_2 as Contact,
15334
+ TentacledID,
15335
+ ContactList_2 as ContactList,
15532
15336
  Context_2 as Context,
15533
- Intent,
15337
+ Country_2 as Country,
15338
+ CountryID_2 as CountryID,
15339
+ Currency,
15340
+ CurrencyID,
15341
+ Email,
15342
+ RecipientsObject,
15343
+ RecipientsID,
15344
+ Instrument_2 as Instrument,
15345
+ StickyID,
15346
+ FluffyMarket,
15347
+ InstrumentList_2 as InstrumentList,
15348
+ Nothing,
15349
+ Organization_2 as Organization,
15350
+ OrganizationID_2 as OrganizationID,
15351
+ Portfolio_2 as Portfolio,
15352
+ PositionElement,
15353
+ Position_2 as Position,
15354
+ TimeRange,
15355
+ Valuation,
15356
+ Convert_2 as Convert,
15357
+ Intents_2 as Intents,
15358
+ Channel_2 as Channel,
15359
+ DesktopAgent_2 as DesktopAgent,
15534
15360
  IntentResolution_2 as IntentResolution,
15535
- Channel_4 as Channel,
15536
15361
  PrivateChannel,
15537
- DesktopAgent_2 as DesktopAgent
15362
+ ContextHandler_2 as ContextHandler,
15363
+ IntentResult,
15364
+ IntentHandler
15538
15365
  }
15539
15366
  }
15540
15367
 
@@ -15543,6 +15370,13 @@ declare type VerboseWebPermission = {
15543
15370
  enabled: boolean;
15544
15371
  };
15545
15372
 
15373
+ declare type Version = (typeof versions)[keyof typeof versions];
15374
+
15375
+ declare const versions: {
15376
+ readonly v1_2: "1.2";
15377
+ readonly v2_0: "2.0";
15378
+ };
15379
+
15546
15380
  declare type View = OpenFin_2.View;
15547
15381
 
15548
15382
  /**
@@ -17244,6 +17078,7 @@ declare namespace WebContentsEvents {
17244
17078
  FileDownloadStartedEvent,
17245
17079
  FileDownloadProgressEvent,
17246
17080
  FileDownloadCompletedEvent,
17081
+ ContentBlockedEvent,
17247
17082
  Event_5 as Event,
17248
17083
  WebContentsEvent,
17249
17084
  WillPropagateWebContentsEvent,
@@ -17354,7 +17189,7 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
17354
17189
  */
17355
17190
  declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
17356
17191
  /* Excluded from this release type: __constructor */
17357
- /* Excluded from this release type: createWindow */
17192
+ createWindow(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
17358
17193
  /**
17359
17194
  * Retrieves an array of frame info objects representing the main frame and any
17360
17195
  * iframes that are currently on the page.