@openfin/core 41.103.3 → 41.103.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -88,6 +88,12 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
88
88
  url: string;
89
89
  };
90
90
 
91
+ declare type AnalyticsOnlyCalls = 'layout-get-stack-by-view' | 'layout-add-view' | 'layout-close-view' | `layout-controller-${string}`;
92
+
93
+ declare type AnalyticsProtocolMap = {
94
+ [k in AnalyticsOnlyCalls]: VoidCall;
95
+ };
96
+
91
97
  declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
92
98
 
93
99
  declare type AnyStrategy = ChannelStrategy<any>;
@@ -1676,6 +1682,7 @@ declare type BaseConfig = {
1676
1682
  devToolsPort?: number;
1677
1683
  installerUI?: boolean;
1678
1684
  runtime?: RuntimeConfig;
1685
+ apiDiagnostics?: boolean;
1679
1686
  appAssets?: [
1680
1687
  {
1681
1688
  src: string;
@@ -3033,6 +3040,11 @@ declare type ClearCacheOption = {
3033
3040
  * browser data that can be used across sessions
3034
3041
  */
3035
3042
  localStorage?: boolean;
3043
+ /**
3044
+ * Clears saved window-state data written for windows that use `saveWindowState`.
3045
+ * After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
3046
+ */
3047
+ windowState?: boolean;
3036
3048
  };
3037
3049
 
3038
3050
  /**
@@ -3258,6 +3270,7 @@ declare type ClipboardApiPermissions = {
3258
3270
  writeRtf: boolean;
3259
3271
  readRtf: boolean;
3260
3272
  write: boolean;
3273
+ setClipboard: boolean;
3261
3274
  };
3262
3275
 
3263
3276
  /**
@@ -4773,20 +4786,11 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
4773
4786
  eventNames: () => (string | symbol)[];
4774
4787
  /* Excluded from this release type: emit */
4775
4788
  private hasEmitter;
4776
- /**
4777
- * Cleans up after removal of a listener, e.g. deleting any lingering deregistration handlers for a
4778
- * `once` subscription.
4779
- *
4780
- * @remarks Implementing this as a `removeListener` handler ensures that direct removal of a listener
4781
- * on the base emitter will not leak additional core handlers. We could do this in the forwarding method,
4782
- * which would involve less "magic," but would be more-vulnerable to accidental re-introduction of a leak.
4783
- */
4784
- private cleanUpRemovedListener;
4785
4789
  private getOrCreateEmitter;
4786
4790
  listeners: (type: string | symbol) => Function[];
4787
4791
  listenerCount: (type: string | symbol) => number;
4788
4792
  protected registerEventListener: (eventType: EmitterEventType, options: OpenFin_2.SubscriptionOptions | undefined, applySubscription: (emitter: EventEmitter) => void, undoSubscription: (emitter: EventEmitter) => void) => Promise<void>;
4789
- protected deregisterEventListener: (eventType: EmitterEventType, options?: OpenFin_2.SubscriptionOptions) => Promise<void | EventEmitter>;
4793
+ private deregisterEventListener;
4790
4794
  /**
4791
4795
  * Adds a listener to the end of the listeners array for the specified event.
4792
4796
  *
@@ -4822,7 +4826,7 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
4822
4826
  * @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
4823
4827
  */
4824
4828
  removeListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
4825
- protected deregisterAllListeners(eventType: EmitterEventType): Promise<EventEmitter | void>;
4829
+ private deregisterAllListeners;
4826
4830
  /**
4827
4831
  * Removes all listeners, or those of the specified event.
4828
4832
  *
@@ -5253,6 +5257,19 @@ declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
5253
5257
  type: 'extensions-install-failed';
5254
5258
  };
5255
5259
 
5260
+ /**
5261
+ * these api calls are not implemented in the javscript api, only in the external adapter
5262
+ * If they don't exist in the external adapter they should be removed.
5263
+ */
5264
+ declare type ExternalAdapterOnlyCalls = 'subscriber-added' | 'subscriber-removed' | 'clipboard-clear' | 'create-proxy-socket' | 'authenticate-proxy-socket' | 'convert-options' | 'generate-guid' | 'get-config' | 'get-remote-config' | 'get-nearest-display-root' | 'get-preload-scripts' | 'raise-event' | 'set-window-preload-state' | 'dock-window' | 'get-current-window-options' | 'redirect-window-to-url' | 'request-new-content' | 'raise-many-events' | 'show-menu' | 'resolve-proxy' | 'undock-window' | 'window-embedded' | 'window-get-cached-bounds' | 'resource-fetch-authenticate' | 'set-cookie';
5265
+
5266
+ declare type ExternalAdapterOnlyCallsMap = {
5267
+ [k in ExternalAdapterOnlyCalls]: {
5268
+ request: any;
5269
+ response: any;
5270
+ };
5271
+ };
5272
+
5256
5273
  /**
5257
5274
  * An ExternalApplication object representing native language adapter connections to the runtime. Allows
5258
5275
  * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
@@ -6385,6 +6402,16 @@ declare type IntentMetadata<TargetType = any> = {
6385
6402
  */
6386
6403
  declare class InterApplicationBus extends Base {
6387
6404
  Channel: Channel;
6405
+ /**
6406
+ * Event types for the InterApplicationBus.
6407
+ *
6408
+ * @remarks The `subscriber-added` and `subscriber-removed` events are disabled by default.
6409
+ * To re-enable them, launch the runtime with the `--emit-legacy-iab-events` flag.
6410
+ * These events will be removed in a future version. Use {@link Channel} for connection
6411
+ * lifecycle management instead.
6412
+ *
6413
+ * @deprecated Use {@link Channel} `onConnection` / `onDisconnection` instead.
6414
+ */
6388
6415
  events: {
6389
6416
  subscriberAdded: string;
6390
6417
  subscriberRemoved: string;
@@ -9216,11 +9243,11 @@ declare type MutableWindowOptions = {
9216
9243
  */
9217
9244
  customData: any;
9218
9245
  /**
9219
- * @deprecated Will be removed in runtime version 45
9220
- * @defaultValue true
9221
- *
9222
9246
  * Show the window's frame.
9223
9247
  *
9248
+ * @remarks
9249
+ * This property will not be updatable starting runtime version 45.
9250
+ *
9224
9251
  * @default true
9225
9252
  */
9226
9253
  frame: boolean;
@@ -9543,6 +9570,8 @@ declare namespace OpenFin_2 {
9543
9570
  TabStack,
9544
9571
  _Window as Window,
9545
9572
  _WindowModule,
9573
+ Clipboard_2 as Clipboard,
9574
+ InterApplicationBus,
9546
9575
  InteropClient,
9547
9576
  InteropBroker,
9548
9577
  InteropModule,
@@ -12141,7 +12170,7 @@ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent
12141
12170
  */
12142
12171
  declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
12143
12172
 
12144
- declare interface ProtocolMap extends ProtocolMapBase {
12173
+ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap & {
12145
12174
  'is-application-running': ApplicationIdentityCall<{}, boolean>;
12146
12175
  'destroy-application': ApplicationIdentityCall<{
12147
12176
  force: boolean;
@@ -12208,8 +12237,15 @@ declare interface ProtocolMap extends ProtocolMapBase {
12208
12237
  downloadLocation: string;
12209
12238
  };
12210
12239
  response: void;
12240
+ secure: true;
12241
+ namespace: 'Application';
12242
+ apiPath: '.setFileDownloadLocation';
12243
+ };
12244
+ 'get-file-download-location': ApplicationIdentityCall<{}, string> & {
12245
+ secure: true;
12246
+ namespace: 'Application';
12247
+ apiPath: '.getFileDownloadLocation';
12211
12248
  };
12212
- 'get-file-download-location': ApplicationIdentityCall<{}, string>;
12213
12249
  'show-tray-icon-popup-menu': {
12214
12250
  request: OpenFin_2.Identity & {
12215
12251
  options: OpenFin_2.ShowTrayIconPopupMenuOptions;
@@ -12217,19 +12253,17 @@ declare interface ProtocolMap extends ProtocolMapBase {
12217
12253
  response: OpenFin_2.MenuResult;
12218
12254
  };
12219
12255
  'close-tray-icon-popup-menu': IdentityCall<{}, void>;
12220
- 'wrap-application': VoidCall;
12221
- 'wrap-application-sync': VoidCall;
12222
12256
  'create-application': ApiCall<OpenFin_2.ApplicationCreationOptions, void>;
12223
- 'application-create': VoidCall;
12224
- 'start-application': VoidCall;
12225
12257
  'run-applications': ApiCall<{
12226
12258
  applications: Array<OpenFin_2.ManifestInfo>;
12227
12259
  opts?: OpenFin_2.RvmLaunchOptions;
12228
12260
  }, void>;
12229
- 'get-current-application': VoidCall;
12230
- 'get-current-application-sync': VoidCall;
12231
- 'application-start-from-manifest': VoidCall;
12232
- 'application-create-from-manifest': VoidCall;
12261
+ 'send-analytics-batch': {
12262
+ request: {
12263
+ counts: Record<string, number>;
12264
+ };
12265
+ response: void;
12266
+ };
12233
12267
  'request-external-authorization': {
12234
12268
  request: any;
12235
12269
  response: void;
@@ -12249,44 +12283,69 @@ declare interface ProtocolMap extends ProtocolMapBase {
12249
12283
  'clipboard-read-image': {
12250
12284
  request: OpenFin_2.ReadImageClipboardRequest;
12251
12285
  response: string;
12286
+ apiPath: '.readImage';
12287
+ namespace: 'Clipboard';
12252
12288
  };
12253
12289
  'clipboard-read-text': {
12254
12290
  request: {
12255
12291
  type?: OpenFin_2.ClipboardSelectionType;
12256
12292
  };
12257
12293
  response: string;
12294
+ apiPath: '.readText';
12295
+ namespace: 'Clipboard';
12258
12296
  };
12259
12297
  'clipboard-read-html': {
12260
12298
  request: {
12261
12299
  type?: OpenFin_2.ClipboardSelectionType;
12262
12300
  };
12263
12301
  response: string;
12302
+ apiPath: '.readHtml';
12303
+ namespace: 'Clipboard';
12264
12304
  };
12265
12305
  'clipboard-read-rtf': {
12266
12306
  request: {
12267
12307
  type?: OpenFin_2.ClipboardSelectionType;
12268
12308
  };
12269
12309
  response: string;
12310
+ apiPath: '.readRtf';
12311
+ namespace: 'Clipboard';
12270
12312
  };
12271
12313
  'clipboard-write-image': {
12272
12314
  request: OpenFin_2.WriteImageClipboardRequest;
12273
12315
  response: void;
12316
+ apiPath: '.writeImage';
12317
+ namespace: 'Clipboard';
12274
12318
  };
12275
12319
  'clipboard-write': {
12276
12320
  request: OpenFin_2.WriteAnyRequestType;
12277
12321
  response: void;
12322
+ apiPath: '.write';
12323
+ namespace: 'Clipboard';
12278
12324
  };
12279
12325
  'clipboard-write-text': {
12280
12326
  request: OpenFin_2.WriteClipboardRequest;
12281
12327
  response: void;
12328
+ apiPath: '.writeText';
12329
+ namespace: 'Clipboard';
12330
+ foo: '';
12331
+ };
12332
+ 'set-clipboard': {
12333
+ request: OpenFin_2.WriteClipboardRequest;
12334
+ response: void;
12335
+ apiPath: '.setClipboard';
12336
+ namespace: 'Clipboard';
12282
12337
  };
12283
12338
  'clipboard-write-html': {
12284
12339
  request: OpenFin_2.WriteClipboardRequest;
12285
12340
  response: void;
12341
+ apiPath: '.writeHtml';
12342
+ namespace: 'Clipboard';
12286
12343
  };
12287
12344
  'clipboard-write-rtf': {
12288
12345
  request: OpenFin_2.WriteClipboardRequest;
12289
12346
  response: void;
12347
+ apiPath: '.writeRtf';
12348
+ namespace: 'Clipboard';
12290
12349
  };
12291
12350
  'get-view-window': IdentityCall<{}, OpenFin_2.Identity>;
12292
12351
  'create-view': IdentityCall<OpenFin_2.ViewCreationOptions & {
@@ -12313,18 +12372,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
12313
12372
  options: OpenFin_2.UpdatableViewOptions;
12314
12373
  }>;
12315
12374
  'trigger-before-unload': IdentityCall<{}, boolean>;
12316
- 'view-wrap-sync': VoidCall;
12317
- 'view-wrap': VoidCall;
12318
- 'view-get-current': VoidCall;
12319
- 'view-get-current-sync': VoidCall;
12320
12375
  'animate-window': IdentityCall<{
12321
12376
  transitions: OpenFin_2.Transition;
12322
12377
  options: OpenFin_2.TransitionOptions;
12323
12378
  }>;
12324
- 'activate-window-and-focus': ApiCall<{
12325
- winIdentity: OpenFin_2.Identity;
12326
- focusIdentity: OpenFin_2.Identity;
12327
- }, boolean>;
12328
12379
  'get-all-frames': IdentityCall<{}, OpenFin_2.FrameInfo[]>;
12329
12380
  'get-window-bounds': IdentityCall<{
12330
12381
  options?: OpenFin_2.GetBoundsOptions;
@@ -12413,15 +12464,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
12413
12464
  'create-window': VoidCall;
12414
12465
  'get-current-window': VoidCall;
12415
12466
  'get-current-window-sync': VoidCall;
12467
+ 'activate-window-and-focus': ApiCall<{
12468
+ winIdentity: OpenFin_2.Identity;
12469
+ focusIdentity: OpenFin_2.Identity;
12470
+ }, boolean>;
12416
12471
  'get-external-application-info': ApiCall<OpenFin_2.ApplicationIdentity, OpenFin_2.ExternalApplicationInfo>;
12417
- 'external-application-wrap': VoidCall;
12418
- 'external-application-wrap-sync': VoidCall;
12419
12472
  'get-frame-info': ApiCall<OpenFin_2.Identity, OpenFin_2.FrameInfo>;
12420
12473
  'get-parent-window': ApiCall<OpenFin_2.Identity, OpenFin_2.FrameInfo>;
12421
- 'frame-wrap': VoidCall;
12422
- 'frame-wrap-sync': VoidCall;
12423
- 'frame-get-current': VoidCall;
12424
- 'frame-get-current-sync': VoidCall;
12425
12474
  'global-hotkey-register': {
12426
12475
  request: {
12427
12476
  hotkey: string;
@@ -12505,6 +12554,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
12505
12554
  request: any;
12506
12555
  response: any;
12507
12556
  };
12557
+ 'send-channel-result': {
12558
+ request: any;
12559
+ response: any;
12560
+ };
12508
12561
  'get-version': GetterCall<string>;
12509
12562
  'clear-cache': ApiCall<OpenFin_2.ClearCacheOption, void>;
12510
12563
  'delete-cache-request': VoidCall;
@@ -12554,7 +12607,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
12554
12607
  action: string;
12555
12608
  runtimes: string[];
12556
12609
  }>;
12557
- 'get-installed-apps': GetterCall<OpenFin_2.InstalledApps>;
12610
+ 'get-installed-apps': GetterCall<OpenFin_2.InstalledApps> & {
12611
+ secure: true;
12612
+ apiPath: '.getInstalledApps';
12613
+ namespace: 'System';
12614
+ };
12558
12615
  'view-log': ApiCall<OpenFin_2.GetLogRequestType, string>;
12559
12616
  'get-machine-id': GetterCall<string>;
12560
12617
  'get-min-log-level': GetterCall<OpenFin_2.LogLevel>;
@@ -12567,8 +12624,16 @@ declare interface ProtocolMap extends ProtocolMapBase {
12567
12624
  'get-runtime-info': GetterCall<OpenFin_2.RuntimeInfo>;
12568
12625
  'get-rvm-info': GetterCall<OpenFin_2.RVMInfo>;
12569
12626
  'get-host-specs': GetterCall<OpenFin_2.HostSpecs>;
12570
- 'get-os-info': GetterCall<OpenFin_2.OSInfo>;
12571
- 'launch-external-process': ApiCall<OpenFin_2.ExternalProcessRequestType, OpenFin_2.Identity>;
12627
+ 'get-os-info': GetterCall<OpenFin_2.OSInfo> & {
12628
+ secure: true;
12629
+ apiPath: '.getOSInfo';
12630
+ namespace: 'System';
12631
+ };
12632
+ 'launch-external-process': ApiCall<OpenFin_2.ExternalProcessRequestType, OpenFin_2.Identity> & {
12633
+ secure: true;
12634
+ apiPath: '.launchExternalProcess';
12635
+ namespace: 'System';
12636
+ };
12572
12637
  'monitor-external-process': ApiCall<OpenFin_2.ExternalProcessInfo, OpenFin_2.Identity>;
12573
12638
  'write-to-log': ApiCall<{
12574
12639
  level: string;
@@ -12576,25 +12641,48 @@ declare interface ProtocolMap extends ProtocolMapBase {
12576
12641
  }, void>;
12577
12642
  'open-url-with-browser': ApiCall<{
12578
12643
  url: string;
12579
- }, void>;
12580
- 'register-custom-protocol': ApiCall<OpenFin_2.CustomProtocolOptions, void>;
12644
+ }, void> & {
12645
+ secure: true;
12646
+ apiPath: '.openUrlWithBrowser';
12647
+ namespace: 'System';
12648
+ };
12649
+ 'register-custom-protocol': ApiCall<OpenFin_2.CustomProtocolOptions, void> & {
12650
+ secure: true;
12651
+ apiPath: '.registerCustomProtocol';
12652
+ namespace: 'System';
12653
+ };
12581
12654
  'unregister-custom-protocol': ApiCall<{
12582
12655
  protocolName: string;
12583
- }, void>;
12656
+ }, void> & {
12657
+ secure: true;
12658
+ apiPath: '.unregisterCustomProtocol';
12659
+ namespace: 'System';
12660
+ };
12584
12661
  'get-custom-protocol-state': ApiCall<{
12585
12662
  protocolName: string;
12586
- }, OpenFin_2.CustomProtocolState>;
12663
+ }, OpenFin_2.CustomProtocolState> & {
12664
+ secure: true;
12665
+ apiPath: '.getCustomProtocolState';
12666
+ namespace: 'System';
12667
+ };
12587
12668
  'release-external-process': ApiCall<{
12588
12669
  uuid: string;
12589
12670
  }, void>;
12590
12671
  'show-developer-tools': ApiCall<OpenFin_2.Identity, void>;
12591
- 'terminate-external-process': ApiCall<OpenFin_2.TerminateExternalRequestType, void>;
12672
+ 'terminate-external-process': ApiCall<OpenFin_2.TerminateExternalRequestType, void> & {
12673
+ secure: true;
12674
+ apiPath: '.terminateExternalProcess';
12675
+ namespace: 'System';
12676
+ };
12592
12677
  'update-proxy': ApiCall<OpenFin_2.ProxyConfig, void>;
12593
12678
  'download-asset': {
12594
12679
  request: OpenFin_2.AppAssetInfo & {
12595
12680
  downloadId: string;
12596
12681
  };
12597
12682
  response: void;
12683
+ secure: true;
12684
+ apiPath: '.downloadAsset';
12685
+ namespace: 'System';
12598
12686
  };
12599
12687
  'download-runtime': {
12600
12688
  request: OpenFin_2.RuntimeDownloadOptions & {
@@ -12623,7 +12711,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
12623
12711
  rootKey: string;
12624
12712
  subkey: string;
12625
12713
  value: string;
12626
- }, OpenFin_2.RegistryInfo>;
12714
+ }, OpenFin_2.RegistryInfo> & {
12715
+ secure: true;
12716
+ apiPath: '.readRegistryValue';
12717
+ namespace: 'System';
12718
+ };
12627
12719
  'register-external-connection': ApiCall<{
12628
12720
  uuid: string;
12629
12721
  }, OpenFin_2.ExternalConnection>;
@@ -12657,26 +12749,48 @@ declare interface ProtocolMap extends ProtocolMapBase {
12657
12749
  permissions: any;
12658
12750
  };
12659
12751
  response: OpenFin_2.NativeWindowIntegrationProviderAuthorization;
12752
+ secure: true;
12753
+ apiPath: '.enableNativeWindowIntegrationProvider';
12754
+ namespace: 'System';
12660
12755
  };
12661
12756
  'register-usage': ApiCall<OpenFin_2.RegisterUsageData, void>;
12662
12757
  'system-get-printers': GetterCall<OpenFin_2.PrinterInfo[]>;
12663
12758
  'system-update-process-logging-options': ApiCall<{
12664
12759
  options: OpenFin_2.ProcessLoggingOptions;
12665
12760
  }, void>;
12666
- 'get-domain-settings': ApiCall<void, OpenFin_2.DomainSettings>;
12761
+ 'get-domain-settings': ApiCall<void, OpenFin_2.DomainSettings> & {
12762
+ secure: true;
12763
+ apiPath: '.getDomainSettings';
12764
+ namespace: 'System';
12765
+ };
12667
12766
  'serve-asset': ApiCall<{
12668
12767
  options: OpenFin_2.ServeAssetOptions;
12669
- }, OpenFin_2.ServedAssetInfo>;
12768
+ }, OpenFin_2.ServedAssetInfo> & {
12769
+ secure: true;
12770
+ apiPath: '.serveAsset';
12771
+ namespace: 'System';
12772
+ };
12670
12773
  'set-domain-settings': ApiCall<{
12671
12774
  domainSettings: OpenFin_2.DomainSettings;
12672
- }, void>;
12775
+ }, void> & {
12776
+ secure: true;
12777
+ apiPath: '.setDomainSettings';
12778
+ namespace: 'System';
12779
+ };
12673
12780
  'get-current-domain-settings': ApiCall<{
12674
12781
  identity: OpenFin_2.Identity;
12675
- }, OpenFin_2.ResolvedDomainSettings>;
12782
+ }, OpenFin_2.ResolvedDomainSettings> & {
12783
+ secure: true;
12784
+ apiPath: '.getCurrentDomainSettings';
12785
+ namespace: 'System';
12786
+ };
12676
12787
  'resolve-domain-settings': ApiCall<{
12677
12788
  url: string;
12678
- }, OpenFin_2.ResolvedDomainSettings>;
12679
- 'system-register-shutdown-handler': VoidCall;
12789
+ }, OpenFin_2.ResolvedDomainSettings> & {
12790
+ secure: true;
12791
+ apiPath: '.resolveDomainSettings';
12792
+ namespace: 'System';
12793
+ };
12680
12794
  'get-permissions': GetterCall<any>;
12681
12795
  'refresh-extensions': {
12682
12796
  request: void;
@@ -12686,24 +12800,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
12686
12800
  request: void;
12687
12801
  response: OpenFin_2.ExtensionInfo[];
12688
12802
  };
12689
- 'fdc3-add-context-listener': VoidCall;
12690
- 'fdc3-add-intent-listener': VoidCall;
12691
- 'fdc3-raise-intent': VoidCall;
12692
- 'fdc3-find-intent': VoidCall;
12693
- 'fdc3-find-intents-by-context': VoidCall;
12694
- 'fdc3-raise-intent-for-context': VoidCall;
12695
- 'fdc3-get-info': VoidCall;
12696
- 'fdc3-find-instances': VoidCall;
12697
- 'fdc3-get-app-metadata': VoidCall;
12698
- 'fdc3-broadcast': VoidCall;
12699
- 'fdc3-open': VoidCall;
12700
- 'fdc3-get-or-create-channel': VoidCall;
12701
- 'fdc3-get-system-channels': VoidCall;
12702
- 'fdc3-join-channel': VoidCall;
12703
- 'fdc3-get-current-channel': VoidCall;
12704
- 'fdc3-leave-current-channel': VoidCall;
12705
- 'interop-init': VoidCall;
12706
- 'interop-connect-sync': VoidCall;
12707
12803
  'interop-client-set-context': VoidCall;
12708
12804
  'interop-client-add-context-handler': VoidCall;
12709
12805
  'interop-client-get-context-groups': VoidCall;
@@ -12734,12 +12830,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
12734
12830
  'interop-session-context-group-set-context': VoidCall;
12735
12831
  'interop-session-context-group-get-context': VoidCall;
12736
12832
  'interop-session-context-group-add-handler': VoidCall;
12737
- 'platform-wrap': VoidCall;
12738
- 'platform-wrap-sync': VoidCall;
12739
- 'platform-get-current': VoidCall;
12740
- 'platform-get-current-sync': VoidCall;
12741
- 'platform-start': VoidCall;
12742
- 'platform-start-from-manifest': VoidCall;
12743
12833
  'platform-get-client': ApplicationIdentityCall<{}, void>;
12744
12834
  'platform-create-view': ApplicationIdentityCall<{}, void>;
12745
12835
  'platform-create-window': ApplicationIdentityCall<{}, void>;
@@ -12752,11 +12842,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
12752
12842
  'platform-set-window-context': ApplicationIdentityCall<{}, void>;
12753
12843
  'platform-get-window-context': ApplicationIdentityCall<{}, void>;
12754
12844
  'platform-close-window': ApplicationIdentityCall<{}, void>;
12755
- 'layout-wrap': VoidCall;
12756
- 'layout-wrap-sync': VoidCall;
12757
- 'layout-get-current': VoidCall;
12758
- 'layout-get-current-sync': VoidCall;
12759
- 'layout-init': VoidCall;
12760
12845
  'layout-get-config': VoidCall;
12761
12846
  'layout-get-views': VoidCall;
12762
12847
  'layout-replace': VoidCall;
@@ -12775,12 +12860,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
12775
12860
  'layout-controller-create-adjacent-stack': VoidCall;
12776
12861
  'layout-controller-get-adjacent-stacks': VoidCall;
12777
12862
  'layout-controller-set-stack-active-view': VoidCall;
12778
- 'snapshot-source-init': VoidCall;
12779
- 'snapshot-source-wrap-sync': VoidCall;
12780
- 'snapshot-source-wrap': VoidCall;
12781
- 'snapshot-source-ready': VoidCall;
12782
- 'snapshot-source-get-snapshot': VoidCall;
12783
- 'snapshot-source-apply-snapshot': VoidCall;
12784
12863
  'capture-page': IdentityCall<{
12785
12864
  options?: OpenFin_2.CapturePageOptions;
12786
12865
  }, string>;
@@ -12861,15 +12940,27 @@ declare interface ProtocolMap extends ProtocolMapBase {
12861
12940
  };
12862
12941
  response: void;
12863
12942
  };
12864
- }
12865
-
12866
- declare interface ProtocolMapBase {
12867
- [action: string]: {
12868
- request: any;
12869
- response: any;
12870
- specialResponse?: any;
12943
+ 'subscribe-to-desktop-event': {
12944
+ request: {
12945
+ topic: string;
12946
+ type: string;
12947
+ uuid?: string;
12948
+ name?: string;
12949
+ timestamp?: number;
12950
+ };
12951
+ response: void;
12871
12952
  };
12872
- }
12953
+ 'unsubscribe-to-desktop-event': {
12954
+ request: {
12955
+ topic: string;
12956
+ type: string;
12957
+ uuid?: string;
12958
+ name?: string;
12959
+ timestamp?: number;
12960
+ };
12961
+ response: void;
12962
+ };
12963
+ };
12873
12964
 
12874
12965
  declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
12875
12966
 
@@ -13435,7 +13526,9 @@ declare type SecurityRealmEvent = BaseEvent_9 & {
13435
13526
 
13436
13527
  declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
13437
13528
  data: ProtocolMap[T]['response'];
13438
- } & ProtocolMap[T]['specialResponse']>;
13529
+ } & (ProtocolMap[T] extends {
13530
+ specialResponse: infer U;
13531
+ } ? U : {})>;
13439
13532
 
13440
13533
  /**
13441
13534
  * @interface
@@ -13944,13 +14037,15 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
13944
14037
  * * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
13945
14038
  * * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
13946
14039
  * * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
14040
+ * * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
13947
14041
  * @example
13948
14042
  * ```js
13949
14043
  * const clearCacheOptions = {
13950
14044
  * appcache: true,
13951
14045
  * cache: true,
13952
14046
  * cookies: true,
13953
- * localStorage: true
14047
+ * localStorage: true,
14048
+ * windowState: true
13954
14049
  * };
13955
14050
  * fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
13956
14051
  * ```
@@ -15448,7 +15543,6 @@ declare type SystemEventType = EventType_8;
15448
15543
  */
15449
15544
  declare type SystemPermissions = {
15450
15545
  getOSInfo: boolean;
15451
- getAllExternalWindows: boolean;
15452
15546
  setDomainSettings: boolean;
15453
15547
  getDomainSettings: boolean;
15454
15548
  getCurrentDomainSettings: boolean;
@@ -15488,6 +15582,10 @@ declare type SystemPermissions = {
15488
15582
  enabled: boolean;
15489
15583
  protocols: string[];
15490
15584
  };
15585
+ getInstalledApps: boolean;
15586
+ downloadAsset: boolean;
15587
+ serveAsset: boolean;
15588
+ enableNativeWindowIntegrationProvider: boolean;
15491
15589
  };
15492
15590
 
15493
15591
  /**
@@ -15789,9 +15887,12 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
15789
15887
  sendRaw: Wire['send'];
15790
15888
  eventAggregator: EventAggregator;
15791
15889
  protected messageHandlers: MessageHandler[];
15792
- constructor(factory: WireFactory, environment: Environment, config: OpenFin_2.Identity);
15890
+ constructor(factory: WireFactory, environment: Environment, config: OpenFin_2.Identity & {
15891
+ apiDiagnostics?: boolean;
15892
+ });
15793
15893
  getFin(): OpenFin_2.Fin<MeType>;
15794
15894
  registerFin(_fin: OpenFin_2.Fin<MeType>): void;
15895
+ recordAnalytic(action: string): void;
15795
15896
  connectSync: () => void;
15796
15897
  getPort: () => string;
15797
15898
  shutdown(): Promise<void>;
@@ -15799,7 +15900,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
15799
15900
  private connectRemote;
15800
15901
  connectByPort(config: ExistingConnectConfig): Promise<void>;
15801
15902
  private authorize;
15802
- sendAction<T extends keyof ProtocolMap = string>(action: T, payload?: ProtocolMap[T]['request'], uncorrelated?: boolean): SentMessage<SendActionResponse<T>>;
15903
+ sendAction<T extends keyof ProtocolMap>(action: T, payload?: ProtocolMap[T]['request'], uncorrelated?: boolean): SentMessage<SendActionResponse<T>>;
15803
15904
  protected nackHandler(payloadOrMessage: RuntimeErrorPayload | string, reject: Function, callSites?: NodeJS.CallSite[]): void;
15804
15905
  ferryAction(origData: any): Promise<Message<any>>;
15805
15906
  registerMessageHandler(handler: MessageHandler): void;