@openfin/node-adapter 34.78.18 → 34.78.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.
@@ -1,9 +1,8 @@
1
1
  /// <reference types="jquery" />
2
2
  /// <reference types="node" />
3
3
 
4
- import { AppIdentifier } from 'fdc3v2/dist/api/AppIdentifier';
5
- import type { AppMetadata } from 'fdc3v1/dist/api/AppMetadata';
6
4
  import { EventEmitter } from 'events';
5
+ import type * as GoldenLayout from '@openfin/golden-layout';
7
6
 
8
7
  /**
9
8
  * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
@@ -138,6 +137,31 @@ declare type AppAssetRequest = {
138
137
  alias: string;
139
138
  };
140
139
 
140
+ declare interface AppIdentifier {
141
+ /** The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root' */
142
+ readonly appId: string;
143
+ /** An optional instance identifier, indicating that this object represents a specific instance of the application described. */
144
+ readonly instanceId?: string;
145
+ }
146
+
147
+ /**
148
+ * An interface that relates an intent to apps
149
+ */
150
+ declare interface AppIntent {
151
+ readonly intent: IntentMetadata;
152
+ readonly apps: Array<AppMetadata>;
153
+ }
154
+
155
+ /**
156
+ * An interface that relates an intent to apps
157
+ */
158
+ declare interface AppIntent_2 {
159
+ /** Details of the intent whose relationship to resolving applications is being described. */
160
+ readonly intent: IntentMetadata_2;
161
+ /** Details of applications that can resolve the intent. */
162
+ readonly apps: Array<AppMetadata_2>;
163
+ }
164
+
141
165
  /**
142
166
  * An object representing an application. Allows the developer to create,
143
167
  * execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
@@ -1347,6 +1371,60 @@ declare type ApplySnapshotPayload = {
1347
1371
  options?: ApplySnapshotOptions;
1348
1372
  };
1349
1373
 
1374
+ /**
1375
+ * App definition as provided by the application directory
1376
+ */
1377
+ declare interface AppMetadata {
1378
+ /** The unique app name that can be used with the open and raiseIntent calls. */
1379
+ readonly name: string;
1380
+ /** The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root' */
1381
+ readonly appId?: string;
1382
+ /** The Version of the application. */
1383
+ readonly version?: string;
1384
+ /** A more user-friendly application title that can be used to render UI elements */
1385
+ readonly title?: string;
1386
+ /** A tooltip for the application that can be used to render UI elements */
1387
+ readonly tooltip?: string;
1388
+ /** A longer, multi-paragraph description for the application that could include markup */
1389
+ readonly description?: string;
1390
+ /** A list of icon URLs for the application that can be used to render UI elements */
1391
+ readonly icons?: Array<string>;
1392
+ /** A list of image URLs for the application that can be used to render UI elements */
1393
+ readonly images?: Array<string>;
1394
+ }
1395
+
1396
+ /**
1397
+ * 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.
1398
+ *
1399
+ * 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.
1400
+ *
1401
+ * Note that as `AppMetadata` instances are also `AppIdentifiers` they may be passed to the `app` argument of `fdc3.open`, `fdc3.raiseIntent` etc.
1402
+ */
1403
+ declare interface AppMetadata_2 extends AppIdentifier {
1404
+ /**
1405
+ The 'friendly' app name.
1406
+ This field was used with the `open` and `raiseIntent` calls in FDC3 <2.0, which now require an `AppIdentifier` wth `appId` set.
1407
+ Note that for display purposes the `title` field should be used, if set, in preference to this field.
1408
+ */
1409
+ readonly name?: string;
1410
+ /** The Version of the application. */
1411
+ readonly version?: string;
1412
+ /** 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. */
1413
+ readonly instanceMetadata?: Record<string, any>;
1414
+ /** A more user-friendly application title that can be used to render UI elements */
1415
+ readonly title?: string;
1416
+ /** A tooltip for the application that can be used to render UI elements */
1417
+ readonly tooltip?: string;
1418
+ /** A longer, multi-paragraph description for the application that could include markup */
1419
+ readonly description?: string;
1420
+ /** A list of icon URLs for the application that can be used to render UI elements */
1421
+ readonly icons?: Array<Icon>;
1422
+ /** Images representing the app in common usage scenarios that can be used to render UI elements */
1423
+ readonly screenshots?: Array<Image_2>;
1424
+ /** 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>"). */
1425
+ readonly resultType?: string | null;
1426
+ }
1427
+
1350
1428
  /**
1351
1429
  * @interface
1352
1430
  */
@@ -2008,7 +2086,25 @@ declare class Channel extends EmitterBase<ChannelEvent> {
2008
2086
 
2009
2087
  declare type Channel_2 = OpenFin.Fin['InterApplicationBus']['Channel'];
2010
2088
 
2011
- declare type Channel_3 = OpenFin.Fin['InterApplicationBus']['Channel'];
2089
+ declare interface Channel_3 {
2090
+ id: string;
2091
+ type: string;
2092
+ displayMetadata?: DisplayMetadata;
2093
+ broadcast(context: Context): void;
2094
+ getCurrentContext(contextType?: string): Promise<Context | null>;
2095
+ addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
2096
+ }
2097
+
2098
+ declare interface Channel_4 {
2099
+ readonly id: string;
2100
+ readonly type: 'user' | 'app' | 'private';
2101
+ readonly displayMetadata?: DisplayMetadata_2;
2102
+ broadcast(context: Context_2): Promise<void>;
2103
+ getCurrentContext(contextType?: string): Promise<Context_2 | null>;
2104
+ addContextListener(contextType: string | null, handler: ContextHandler_2): Listener_2 & Promise<Listener_2>;
2105
+ }
2106
+
2107
+ declare type Channel_5 = OpenFin.Fin['InterApplicationBus']['Channel'];
2012
2108
 
2013
2109
  declare type ChannelAction = OpenFin.ChannelAction;
2014
2110
 
@@ -3445,12 +3541,26 @@ declare type ContentNavigation = NavigationRules;
3445
3541
  */
3446
3542
  declare type ContentRedirect = NavigationRules;
3447
3543
 
3544
+ declare interface Context {
3545
+ id?: { [key: string]: string };
3546
+ name?: string;
3547
+ type: string;
3548
+ }
3549
+
3550
+ declare interface Context_2 {
3551
+ id?: { [key: string]: string };
3552
+ name?: string;
3553
+ type: string;
3554
+ contextMetadata?: ContextMetadata;
3555
+ metadata?: any;
3556
+ }
3557
+
3448
3558
  /**
3449
3559
  * Data passed between entities and applications.
3450
3560
  *
3451
3561
  * @interface
3452
3562
  */
3453
- declare type Context = {
3563
+ declare type Context_3 = {
3454
3564
  /**
3455
3565
  * An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
3456
3566
  */
@@ -3470,7 +3580,7 @@ declare type Context = {
3470
3580
  /**
3471
3581
  * @interface
3472
3582
  */
3473
- declare type ContextForIntent<MetadataType = any> = Context & {
3583
+ declare type ContextForIntent<MetadataType = any> = Context_3 & {
3474
3584
  metadata?: MetadataType;
3475
3585
  };
3476
3586
 
@@ -3486,19 +3596,23 @@ declare type ContextGroupInfo = {
3486
3596
  /**
3487
3597
  * Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.
3488
3598
  */
3489
- displayMetadata?: DisplayMetadata;
3599
+ displayMetadata?: DisplayMetadata_3;
3490
3600
  };
3491
3601
 
3492
3602
  declare type ContextGroupStates = {
3493
3603
  [key: string]: {
3494
- [key: string]: Context;
3604
+ [key: string]: Context_3;
3495
3605
  };
3496
3606
  };
3497
3607
 
3608
+ declare type ContextHandler = (context: Context) => void;
3609
+
3610
+ declare type ContextHandler_2 = (context: Context_2, metadata?: ContextMetadata) => void;
3611
+
3498
3612
  /**
3499
3613
  * Subscription function for addContextHandler.
3500
3614
  */
3501
- declare type ContextHandler = (context: Context) => void;
3615
+ declare type ContextHandler_3 = (context: Context_3) => void;
3502
3616
 
3503
3617
  /**
3504
3618
  * Configure the context menu when right-clicking on a window.
@@ -3537,6 +3651,20 @@ declare type ContextMenuSettings = {
3537
3651
  reload?: boolean;
3538
3652
  };
3539
3653
 
3654
+ /**
3655
+ * Metadata relating to a context or intent and context received through the
3656
+ * `addContextListener` and `addIntentListener` functions.
3657
+ *
3658
+ * @experimental Introduced in FDC3 2.0 and may be refined by further changes outside the normal FDC3 versioning policy.
3659
+ */
3660
+ declare interface ContextMetadata {
3661
+ /** Identifier for the app instance that sent the context and/or intent.
3662
+ *
3663
+ * @experimental
3664
+ */
3665
+ readonly source: AppIdentifier;
3666
+ }
3667
+
3540
3668
  /**
3541
3669
  * @interface
3542
3670
  */
@@ -3699,6 +3827,45 @@ declare type DefaultDomainSettingsRule = {
3699
3827
  };
3700
3828
  };
3701
3829
 
3830
+ declare interface DesktopAgent {
3831
+ open(app: TargetApp, context?: Context): Promise<void>;
3832
+ findIntent(intent: string, context?: Context): Promise<AppIntent>;
3833
+ findIntentsByContext(context: Context): Promise<Array<AppIntent>>;
3834
+ broadcast(context: Context): void;
3835
+ raiseIntent(intent: string, context: Context, app?: TargetApp): Promise<IntentResolution>;
3836
+ raiseIntentForContext(context: Context, app?: TargetApp): Promise<IntentResolution>;
3837
+ addIntentListener(intent: string, handler: ContextHandler): Listener;
3838
+ joinChannel(channelId: string): Promise<void>;
3839
+ leaveCurrentChannel(): Promise<void>;
3840
+ getInfo(): ImplementationMetadata;
3841
+ addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
3842
+ getOrCreateChannel(channelId: string): Promise<Channel_3>;
3843
+ getSystemChannels(): Promise<SystemChannel[]>;
3844
+ getCurrentChannel(): Promise<Channel_3 | null>;
3845
+ }
3846
+
3847
+ declare interface DesktopAgent_2 {
3848
+ open(app: AppIdentifier | TargetApp, context?: Context_2): Promise<AppIdentifier>;
3849
+ findIntent(intent: string, context?: Context_2, resultType?: string): Promise<AppIntent_2>;
3850
+ findIntentsByContext(context: Context_2, resultType?: string): Promise<Array<AppIntent_2>>;
3851
+ findInstances(app: AppIdentifier): Promise<Array<AppIdentifier>>;
3852
+ broadcast(context: Context_2): Promise<void>;
3853
+ raiseIntent(intent: string, context: Context_2, app?: AppIdentifier | TargetApp): Promise<IntentResolution_2>;
3854
+ raiseIntentForContext(context: Context_2, app?: AppIdentifier | TargetApp): Promise<IntentResolution_2>;
3855
+ addIntentListener(intent: string, handler: IntentHandler): Promise<Listener_2>;
3856
+ addContextListener(contextType: string | null, handler: ContextHandler_2): Promise<Listener_2>;
3857
+ getUserChannels(): Promise<Array<SystemChannel>>;
3858
+ joinUserChannel(channelId: string): Promise<void>;
3859
+ getOrCreateChannel(channelId: string): Promise<Channel_4>;
3860
+ createPrivateChannel(): Promise<PrivateChannel>;
3861
+ getCurrentChannel(): Promise<Channel_3 | null>;
3862
+ leaveCurrentChannel(): Promise<void>;
3863
+ getInfo(): Promise<ImplementationMetadata_2>;
3864
+ getAppMetadata(app: AppIdentifier): Promise<AppMetadata_2>;
3865
+ getSystemChannels(): Promise<Array<SystemChannel>>;
3866
+ joinChannel(channelId: string): Promise<void>;
3867
+ }
3868
+
3702
3869
  /**
3703
3870
  * Generated when the desktop icon is clicked while it's already running.
3704
3871
  * @interface
@@ -3771,12 +3938,52 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
3771
3938
  type: 'disabled-movement-bounds-changing';
3772
3939
  };
3773
3940
 
3941
+ /**
3942
+ * A system channel will be global enough to have a presence across many apps. This gives us some hints
3943
+ * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
3944
+ * this is their meaning.
3945
+ */
3946
+ declare interface DisplayMetadata {
3947
+ /**
3948
+ * A user-readable name for this channel, e.g: `"Red"`
3949
+ */
3950
+ readonly name?: string;
3951
+ /**
3952
+ * The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
3953
+ */
3954
+ readonly color?: string;
3955
+ /**
3956
+ * A URL of an image that can be used to display this channel
3957
+ */
3958
+ readonly glyph?: string;
3959
+ }
3960
+
3961
+ /**
3962
+ * A system channel will be global enough to have a presence across many apps. This gives us some hints
3963
+ * to render them in a standard way. It is assumed it may have other properties too, but if it has these,
3964
+ * this is their meaning.
3965
+ */
3966
+ declare interface DisplayMetadata_2 {
3967
+ /**
3968
+ * A user-readable name for this channel, e.g: `"Red"`
3969
+ */
3970
+ readonly name?: string;
3971
+ /**
3972
+ * The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
3973
+ */
3974
+ readonly color?: string;
3975
+ /**
3976
+ * A URL of an image that can be used to display this channel
3977
+ */
3978
+ readonly glyph?: string;
3979
+ }
3980
+
3774
3981
  /**
3775
3982
  * The display data for a context group.
3776
3983
  *
3777
3984
  * @interface
3778
3985
  */
3779
- declare type DisplayMetadata = {
3986
+ declare type DisplayMetadata_3 = {
3780
3987
  /**
3781
3988
  * A user-readable name for this context group, e.g: `"Red"`
3782
3989
  */
@@ -4372,6 +4579,13 @@ declare type FaviconUpdatedEvent = NamedEvent & {
4372
4579
  favicons: string[];
4373
4580
  };
4374
4581
 
4582
+ declare namespace FDC3 {
4583
+ export {
4584
+ v1,
4585
+ v2
4586
+ }
4587
+ }
4588
+
4375
4589
  /**
4376
4590
  * @interface
4377
4591
  */
@@ -4564,8 +4778,8 @@ declare type FindInPageResult = {
4564
4778
  /**
4565
4779
  * @interface
4566
4780
  */
4567
- declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
4568
- context: Context;
4781
+ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata_3> = {
4782
+ context: Context_3;
4569
4783
  metadata?: MetadataType;
4570
4784
  };
4571
4785
 
@@ -5084,6 +5298,15 @@ declare type HotkeyEvent = BaseViewEvent & {
5084
5298
  type: 'hotkey';
5085
5299
  };
5086
5300
 
5301
+ declare interface Icon {
5302
+ /** The icon url */
5303
+ readonly src: string;
5304
+ /** The icon dimension, formatted as `<height>x<width>`. */
5305
+ readonly size?: string;
5306
+ /** Icon media type. If not present the Desktop Agent may use the src file extension. */
5307
+ readonly type?: string;
5308
+ }
5309
+
5087
5310
  declare type Identity = OpenFin.Identity;
5088
5311
 
5089
5312
  declare type Identity_2 = OpenFin.Identity;
@@ -5136,6 +5359,17 @@ declare type IdleEvent = {
5136
5359
  isIdle: boolean;
5137
5360
  };
5138
5361
 
5362
+ declare interface Image_2 {
5363
+ /** The image url. */
5364
+ readonly src: string;
5365
+ /** The image dimension, formatted as `<height>x<width>`. */
5366
+ readonly size?: string;
5367
+ /** Image media type. If not present the Desktop Agent may use the src file extension. */
5368
+ readonly type?: string;
5369
+ /** Caption for the image. */
5370
+ readonly label?: string;
5371
+ }
5372
+
5139
5373
  declare type ImageFormatOptions = {
5140
5374
  format: 'dataURL' | 'png' | 'bmp';
5141
5375
  } | {
@@ -5146,15 +5380,57 @@ declare type ImageFormatOptions = {
5146
5380
  quality?: number;
5147
5381
  };
5148
5382
 
5383
+ /**
5384
+ * Metadata relating to the FDC3 Desktop Agent implementation and its provider.
5385
+ */
5386
+ declare interface ImplementationMetadata {
5387
+ /** The version number of the FDC3 specification that the implementation provides.
5388
+ * The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
5389
+ */
5390
+ readonly fdc3Version: string;
5391
+ /** The name of the provider of the FDC3 Desktop Agent Implementation (e.g. Finsemble, Glue42, OpenFin etc.). */
5392
+ readonly provider: string;
5393
+ /** The version of the provider of the FDC3 Desktop Agent Implementation (e.g. 5.3.0). */
5394
+ readonly providerVersion?: string;
5395
+ }
5396
+
5397
+ /**
5398
+ * Metadata relating to the FDC3 Desktop Agent implementation and its provider.
5399
+ */
5400
+ declare interface ImplementationMetadata_2 {
5401
+ /** The version number of the FDC3 specification that the implementation provides.
5402
+ * The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
5403
+ */
5404
+ readonly fdc3Version: string;
5405
+ /** The name of the provider of the Desktop Agent implementation (e.g. Finsemble, Glue42, OpenFin etc.). */
5406
+ readonly provider: string;
5407
+ /** The version of the provider of the Desktop Agent implementation (e.g. 5.3.0). */
5408
+ readonly providerVersion?: string;
5409
+ /** Metadata indicating whether the Desktop Agent implements optional features of
5410
+ * the Desktop Agent API.
5411
+ */
5412
+ readonly optionalFeatures: {
5413
+ /** Used to indicate whether the exposure of 'originating app metadata' for
5414
+ * context and intent messages is supported by the Desktop Agent. */
5415
+ readonly OriginatingAppMetadata: boolean;
5416
+ /** Used to indicate whether the optional `fdc3.joinUserChannel`,
5417
+ * `fdc3.getCurrentChannel` and `fdc3.leaveCurrentChannel` are implemented by
5418
+ * the Desktop Agent. */
5419
+ readonly UserChannelMembershipAPIs: boolean;
5420
+ };
5421
+ /** The calling application instance's own metadata, according to the Desktop Agent (MUST include at least the `appId` and `instanceId`). */
5422
+ readonly appMetadata: AppMetadata_2;
5423
+ }
5424
+
5149
5425
  /**
5150
5426
  * @interface
5151
5427
  */
5152
- declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
5428
+ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
5153
5429
  /**
5154
5430
  * Name of the intent to get info for.
5155
5431
  */
5156
5432
  name: string;
5157
- context?: Context;
5433
+ context?: Context_3;
5158
5434
  metadata?: MetadataType;
5159
5435
  };
5160
5436
 
@@ -5227,10 +5503,16 @@ declare type InstalledApps_2 = {
5227
5503
  [key: string]: InstallationInfo;
5228
5504
  };
5229
5505
 
5506
+ declare interface Intent {
5507
+ name: string;
5508
+ context: Context_2;
5509
+ metadata: IntentMetadata_2;
5510
+ }
5511
+
5230
5512
  /**
5231
5513
  * Combination of an action and a context that is passed to an application for resolution.
5232
5514
  */
5233
- declare type Intent<MetadataType = IntentMetadata> = {
5515
+ declare type Intent_2<MetadataType = IntentMetadata_3> = {
5234
5516
  /**
5235
5517
  * Name of the intent.
5236
5518
  */
@@ -5238,25 +5520,54 @@ declare type Intent<MetadataType = IntentMetadata> = {
5238
5520
  /**
5239
5521
  * Data associated with the intent.
5240
5522
  */
5241
- context: Context;
5523
+ context: Context_3;
5242
5524
  metadata?: MetadataType;
5243
5525
  };
5244
5526
 
5527
+ declare type IntentHandler = (context: Context_2, metadata?: ContextMetadata) => Promise<IntentResult> | void;
5528
+
5245
5529
  /**
5246
5530
  * Subscription function for registerIntentHandler.
5247
5531
  */
5248
- declare type IntentHandler = (intent: Intent) => void;
5532
+ declare type IntentHandler_2 = (intent: Intent_2) => void;
5249
5533
 
5250
5534
  /**
5251
- * The type used to describe an intent within the platform.
5252
- * @interface
5535
+ * Intent descriptor
5253
5536
  */
5254
- declare type IntentMetadata<TargetType = any> = {
5537
+ declare interface IntentMetadata {
5538
+ /** The unique name of the intent that can be invoked by the raiseIntent call */
5539
+ readonly name: string;
5540
+ /** A friendly display name for the intent that should be used to render UI elements */
5541
+ readonly displayName: string;
5542
+ }
5543
+
5544
+ declare type IntentMetadata_2<TargetType = any> = {
5255
5545
  target?: TargetType;
5256
5546
  resultType?: string;
5257
5547
  intentResolutionResultId?: string;
5258
5548
  };
5259
5549
 
5550
+ /**
5551
+ * The type used to describe an intent within the platform.
5552
+ * @interface
5553
+ */
5554
+ declare type IntentMetadata_3<TargetType = any> = FDC3.v2.IntentMetadata<TargetType>;
5555
+
5556
+ declare interface IntentResolution {
5557
+ source: TargetApp;
5558
+ data?: object;
5559
+ version: string;
5560
+ }
5561
+
5562
+ declare interface IntentResolution_2 {
5563
+ source: AppIdentifier;
5564
+ intent: string;
5565
+ version?: string;
5566
+ getResult(): Promise<IntentResult>;
5567
+ }
5568
+
5569
+ declare type IntentResult = Context_2 | Channel_4 | PrivateChannel;
5570
+
5260
5571
  /**
5261
5572
  * A messaging bus that allows for pub/sub messaging between different applications.
5262
5573
  *
@@ -5846,23 +6157,23 @@ declare class InteropBroker extends Base {
5846
6157
  * @param clientIdentity Identity of the Client making the request.
5847
6158
  */
5848
6159
  fdc3HandleOpen({ app, context }: {
5849
- app: TargetApp | AppIdentifier;
6160
+ app: FDC3.v1.TargetApp | FDC3.v2.AppIdentifier;
5850
6161
  context: OpenFin.Context;
5851
- }, clientIdentity: OpenFin.ClientIdentity): Promise<void | AppIdentifier>;
6162
+ }, clientIdentity: OpenFin.ClientIdentity): Promise<void | FDC3.v2.AppIdentifier>;
5852
6163
  /**
5853
6164
  * Responsible for resolving the fdc3.findInstances call.
5854
6165
  * Must be overridden
5855
6166
  * @param app AppIdentifier that was passed to fdc3.findInstances
5856
6167
  * @param clientIdentity Identity of the Client making the request.
5857
6168
  */
5858
- fdc3HandleFindInstances(app: AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
6169
+ fdc3HandleFindInstances(app: FDC3.v2.AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
5859
6170
  /**
5860
6171
  * Responsible for resolving the fdc3.getAppMetadata call.
5861
6172
  * Must be overridden
5862
6173
  * @param app AppIdentifier that was passed to fdc3.getAppMetadata
5863
6174
  * @param clientIdentity Identity of the Client making the request.
5864
6175
  */
5865
- fdc3HandleGetAppMetadata(app: AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
6176
+ fdc3HandleGetAppMetadata(app: FDC3.v2.AppIdentifier, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
5866
6177
  /**
5867
6178
  * This function is called by the Interop Broker whenever a Context handler would fire.
5868
6179
  * For FDC3 2.0 you would need to override this function and add the contextMetadata as
@@ -7452,7 +7763,21 @@ declare type LayoutRow = LayoutItemConfig & {
7452
7763
  */
7453
7764
  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'>;
7454
7765
 
7455
- declare type Listener<T extends {
7766
+ declare interface Listener {
7767
+ /**
7768
+ * Unsubscribe the listener object.
7769
+ */
7770
+ unsubscribe(): void;
7771
+ }
7772
+
7773
+ declare interface Listener_2 {
7774
+ /**
7775
+ * Unsubscribe the listener object.
7776
+ */
7777
+ unsubscribe(): void;
7778
+ }
7779
+
7780
+ declare type Listener_3<T extends {
7456
7781
  type: string;
7457
7782
  }> = (payload: T) => void;
7458
7783
 
@@ -8242,11 +8567,11 @@ declare namespace OpenFin {
8242
8567
  ApplicationOptions,
8243
8568
  InteropBrokerOptions,
8244
8569
  ContextGroupInfo,
8245
- DisplayMetadata,
8570
+ DisplayMetadata_3 as DisplayMetadata,
8246
8571
  LegacyWinOptionsInAppOptions,
8247
8572
  Snapshot,
8248
8573
  ContextGroupStates,
8249
- Context,
8574
+ Context_3 as Context,
8250
8575
  MonitorInfo,
8251
8576
  Point,
8252
8577
  PointTopLeft,
@@ -8415,10 +8740,10 @@ declare namespace OpenFin {
8415
8740
  FileDownloadBehaviorNames,
8416
8741
  FileDownloadSettings,
8417
8742
  DownloadRule,
8418
- ContextHandler,
8419
- Intent,
8420
- IntentMetadata,
8421
- IntentHandler,
8743
+ ContextHandler_3 as ContextHandler,
8744
+ Intent_2 as Intent,
8745
+ IntentMetadata_3 as IntentMetadata,
8746
+ IntentHandler_2 as IntentHandler,
8422
8747
  ContentCreationBehaviorNames,
8423
8748
  MatchPattern,
8424
8749
  ContentCreationRule,
@@ -10265,6 +10590,14 @@ declare type PrintOptions = {
10265
10590
  dpi?: Dpi;
10266
10591
  };
10267
10592
 
10593
+ declare type PrivateChannel = Omit<Channel_4, 'addContextListener'> & {
10594
+ addContextListener(contextType: string | null, handler: ContextHandler_2): Promise<Listener_2>;
10595
+ onAddContextListener(handler: (contextType?: string) => void): Listener_2;
10596
+ onUnsubscribe(handler: (contextType?: string) => void): Listener_2;
10597
+ onDisconnect(handler: () => void): Listener_2;
10598
+ disconnect(): void;
10599
+ };
10600
+
10268
10601
  /**
10269
10602
  * Strategy to assign views to process affinity by domain.
10270
10603
  *
@@ -11177,19 +11510,19 @@ declare type SessionContextGroup = {
11177
11510
  * A SessionContextGroup instance method for setting a context in the SessionContextGroup.
11178
11511
  * @param context The Context to be set.
11179
11512
  */
11180
- setContext: (context: Context) => Promise<void>;
11513
+ setContext: (context: Context_3) => Promise<void>;
11181
11514
  /**
11182
11515
  * A SessionContextGroup instance method for getting the current context of a certain type.
11183
11516
  * @param type The Context Type to get. If not specified the last contextType set would get used.
11184
11517
  */
11185
- getCurrentContext: (type?: string) => Promise<Context>;
11518
+ getCurrentContext: (type?: string) => Promise<Context_3>;
11186
11519
  /**
11187
11520
  * A SessionContextGroup instance method for adding a handler for context change.
11188
11521
  * @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.
11189
11522
  * @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.
11190
11523
  *
11191
11524
  */
11192
- addContextHandler: (handler: ContextHandler, contextType?: string) => Promise<{
11525
+ addContextHandler: (handler: ContextHandler_3, contextType?: string) => Promise<{
11193
11526
  unsubscribe: () => void;
11194
11527
  }>;
11195
11528
  };
@@ -12936,6 +13269,12 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
12936
13269
  setDomainSettings(domainSettings: OpenFin.DefaultDomainSettings): Promise<void>;
12937
13270
  }
12938
13271
 
13272
+ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast' | 'getCurrentContext'> & {
13273
+ addContextListener(): Error;
13274
+ broadcast(): Error;
13275
+ getCurrentContext(): Error;
13276
+ };
13277
+
12939
13278
  /**
12940
13279
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}. Events are
12941
13280
  * discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
@@ -13408,13 +13747,13 @@ declare type tween = 'linear' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'ease-i
13408
13747
  declare interface TypedEventEmitter<Event extends {
13409
13748
  type: string;
13410
13749
  }, EmitterEventType = Event['type']> {
13411
- on<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
13750
+ on<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
13412
13751
  type: EventType;
13413
13752
  }>>): this;
13414
- addListener<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
13753
+ addListener<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
13415
13754
  type: EventType;
13416
13755
  }>>): this;
13417
- removeListener<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
13756
+ removeListener<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
13418
13757
  type: EventType;
13419
13758
  }>>): this;
13420
13759
  removeAllListeners<EventType extends EmitterEventType>(event?: EmitterEventType): this;
@@ -13485,6 +13824,48 @@ declare type UserMovementEnabledEvent = NamedEvent & {
13485
13824
  type: 'user-movement-enabled';
13486
13825
  };
13487
13826
 
13827
+ declare namespace v1 {
13828
+ export {
13829
+ Listener,
13830
+ AppMetadata,
13831
+ IntentMetadata,
13832
+ AppIntent,
13833
+ DisplayMetadata,
13834
+ ImplementationMetadata,
13835
+ ContextHandler,
13836
+ TargetApp,
13837
+ Context,
13838
+ IntentResolution,
13839
+ Channel_3 as Channel,
13840
+ SystemChannel,
13841
+ DesktopAgent
13842
+ }
13843
+ }
13844
+
13845
+ declare namespace v2 {
13846
+ export {
13847
+ IntentMetadata_2 as IntentMetadata,
13848
+ AppIdentifier,
13849
+ Listener_2 as Listener,
13850
+ AppIntent_2 as AppIntent,
13851
+ ImplementationMetadata_2 as ImplementationMetadata,
13852
+ ContextMetadata,
13853
+ Icon,
13854
+ Image_2 as Image,
13855
+ AppMetadata_2 as AppMetadata,
13856
+ DisplayMetadata_2 as DisplayMetadata,
13857
+ ContextHandler_2 as ContextHandler,
13858
+ IntentHandler,
13859
+ IntentResult,
13860
+ Context_2 as Context,
13861
+ Intent,
13862
+ IntentResolution_2 as IntentResolution,
13863
+ Channel_4 as Channel,
13864
+ PrivateChannel,
13865
+ DesktopAgent_2 as DesktopAgent
13866
+ }
13867
+ }
13868
+
13488
13869
  declare type View = OpenFin.View;
13489
13870
 
13490
13871
  /**