@openfin/core 25.68.29 → 25.70.1

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.
Files changed (199) hide show
  1. package/OpenFin.d.ts +38 -829
  2. package/README.md +12 -2
  3. package/package.json +1 -1
  4. package/src/api/application/Factory.d.ts +145 -145
  5. package/src/api/application/Factory.js +229 -229
  6. package/src/api/application/Instance.d.ts +301 -302
  7. package/src/api/application/Instance.js +412 -412
  8. package/src/api/application/index.d.ts +3 -3
  9. package/src/api/application/index.js +15 -15
  10. package/src/api/base.d.ts +43 -43
  11. package/src/api/base.js +177 -177
  12. package/src/api/clipboard/index.d.ts +69 -69
  13. package/src/api/clipboard/index.js +88 -88
  14. package/src/api/events/application.d.ts +69 -0
  15. package/src/api/events/application.js +2 -0
  16. package/src/api/events/base.d.ts +17 -0
  17. package/src/api/events/base.js +2 -0
  18. package/src/api/events/channel.d.ts +10 -11
  19. package/src/api/events/channel.js +2 -2
  20. package/src/api/events/emitterMap.d.ts +11 -11
  21. package/src/api/events/emitterMap.js +35 -35
  22. package/src/api/events/eventAggregator.d.ts +5 -5
  23. package/src/api/events/eventAggregator.js +43 -43
  24. package/src/api/events/externalApplication.d.ts +5 -0
  25. package/src/api/events/externalApplication.js +2 -0
  26. package/src/api/events/frame.d.ts +9 -0
  27. package/src/api/events/frame.js +2 -0
  28. package/src/api/events/globalHotkey.d.ts +10 -0
  29. package/src/api/events/globalHotkey.js +2 -0
  30. package/src/api/events/platform.d.ts +18 -0
  31. package/src/api/events/platform.js +2 -0
  32. package/src/api/events/system.d.ts +22 -0
  33. package/src/api/events/system.js +2 -0
  34. package/src/api/events/view.d.ts +56 -0
  35. package/src/api/events/view.js +2 -0
  36. package/src/api/events/webcontents.d.ts +48 -0
  37. package/src/api/events/webcontents.js +2 -0
  38. package/src/api/events/window.d.ts +176 -0
  39. package/src/api/events/window.js +2 -0
  40. package/src/api/external-application/Factory.d.ts +26 -26
  41. package/src/api/external-application/Factory.js +40 -40
  42. package/src/api/external-application/Instance.d.ts +101 -102
  43. package/src/api/external-application/Instance.js +109 -109
  44. package/src/api/external-application/index.d.ts +3 -3
  45. package/src/api/external-application/index.js +15 -15
  46. package/src/api/fin.d.ts +49 -49
  47. package/src/api/fin.js +43 -43
  48. package/src/api/frame/Factory.d.ts +36 -36
  49. package/src/api/frame/Factory.js +69 -69
  50. package/src/api/frame/Instance.d.ts +121 -121
  51. package/src/api/frame/Instance.js +130 -130
  52. package/src/api/frame/index.d.ts +3 -3
  53. package/src/api/frame/index.js +15 -15
  54. package/src/api/global-hotkey/index.d.ts +38 -38
  55. package/src/api/global-hotkey/index.js +58 -58
  56. package/src/api/interappbus/channel/channel.d.ts +26 -26
  57. package/src/api/interappbus/channel/channel.js +77 -77
  58. package/src/api/interappbus/channel/channels-docs.d.ts +318 -318
  59. package/src/api/interappbus/channel/channels-docs.js +376 -376
  60. package/src/api/interappbus/channel/client.d.ts +22 -22
  61. package/src/api/interappbus/channel/client.js +84 -84
  62. package/src/api/interappbus/channel/connection-manager.d.ts +28 -28
  63. package/src/api/interappbus/channel/connection-manager.js +244 -244
  64. package/src/api/interappbus/channel/index.d.ts +22 -23
  65. package/src/api/interappbus/channel/index.js +121 -121
  66. package/src/api/interappbus/channel/protocols/classic/message-receiver.d.ts +13 -13
  67. package/src/api/interappbus/channel/protocols/classic/message-receiver.js +73 -73
  68. package/src/api/interappbus/channel/protocols/classic/strategy.d.ts +22 -22
  69. package/src/api/interappbus/channel/protocols/classic/strategy.js +84 -84
  70. package/src/api/interappbus/channel/protocols/combined/strategy.d.ts +20 -20
  71. package/src/api/interappbus/channel/protocols/combined/strategy.js +58 -58
  72. package/src/api/interappbus/channel/protocols/index.d.ts +44 -44
  73. package/src/api/interappbus/channel/protocols/index.js +2 -2
  74. package/src/api/interappbus/channel/protocols/protocol-manager.d.ts +10 -10
  75. package/src/api/interappbus/channel/protocols/protocol-manager.js +43 -43
  76. package/src/api/interappbus/channel/protocols/rtc/endpoint.d.ts +23 -23
  77. package/src/api/interappbus/channel/protocols/rtc/endpoint.js +135 -135
  78. package/src/api/interappbus/channel/protocols/rtc/ice-manager.d.ts +30 -30
  79. package/src/api/interappbus/channel/protocols/rtc/ice-manager.js +131 -131
  80. package/src/api/interappbus/channel/protocols/rtc/strategy.d.ts +22 -22
  81. package/src/api/interappbus/channel/protocols/rtc/strategy.js +87 -87
  82. package/src/api/interappbus/channel/protocols/strategy-types.d.ts +13 -13
  83. package/src/api/interappbus/channel/protocols/strategy-types.js +2 -2
  84. package/src/api/interappbus/channel/protocols/strategy.d.ts +15 -15
  85. package/src/api/interappbus/channel/protocols/strategy.js +2 -2
  86. package/src/api/interappbus/channel/provider.d.ts +31 -31
  87. package/src/api/interappbus/channel/provider.js +160 -160
  88. package/src/api/interappbus/index.d.ts +85 -86
  89. package/src/api/interappbus/index.js +175 -175
  90. package/src/api/interop/Factory.d.ts +37 -37
  91. package/src/api/interop/Factory.js +54 -54
  92. package/src/api/interop/InteropBroker.d.ts +363 -363
  93. package/src/api/interop/InteropBroker.js +914 -914
  94. package/src/api/interop/InteropClient.d.ts +268 -268
  95. package/src/api/interop/InteropClient.js +450 -450
  96. package/src/api/interop/SessionContextGroupBroker.d.ts +26 -26
  97. package/src/api/interop/SessionContextGroupBroker.js +107 -107
  98. package/src/api/interop/SessionContextGroupClient.d.ts +20 -20
  99. package/src/api/interop/SessionContextGroupClient.js +85 -85
  100. package/src/api/interop/fdc3/fdc3-1.2.d.ts +187 -187
  101. package/src/api/interop/fdc3/fdc3-1.2.js +385 -385
  102. package/src/api/interop/fdc3/fdc3.js +17 -17
  103. package/src/api/interop/fdc3/utils.d.ts +6 -6
  104. package/src/api/interop/fdc3/utils.js +17 -17
  105. package/src/api/interop/index.d.ts +4 -4
  106. package/src/api/interop/index.js +16 -16
  107. package/src/api/interop/utils.d.ts +11 -11
  108. package/src/api/interop/utils.js +36 -36
  109. package/src/api/me.d.ts +38 -35
  110. package/src/api/me.js +128 -60
  111. package/src/api/platform/Factory.d.ts +109 -109
  112. package/src/api/platform/Factory.js +188 -188
  113. package/src/api/platform/Instance.d.ts +122 -122
  114. package/src/api/platform/Instance.js +298 -298
  115. package/src/api/platform/common-utils.d.ts +6 -6
  116. package/src/api/platform/common-utils.js +16 -16
  117. package/src/api/platform/index.d.ts +3 -3
  118. package/src/api/platform/index.js +15 -15
  119. package/src/api/platform/layout/Factory.d.ts +108 -108
  120. package/src/api/platform/layout/Factory.js +189 -189
  121. package/src/api/platform/layout/Instance.d.ts +49 -49
  122. package/src/api/platform/layout/Instance.js +99 -99
  123. package/src/api/platform/layout/index.d.ts +2 -2
  124. package/src/api/platform/layout/index.js +14 -14
  125. package/src/api/platform/layout/shapes.d.ts +11 -0
  126. package/src/api/{window → platform/layout}/shapes.js +2 -2
  127. package/src/api/snapshot-source/Factory.d.ts +36 -36
  128. package/src/api/snapshot-source/Factory.js +65 -65
  129. package/src/api/snapshot-source/Instance.d.ts +30 -30
  130. package/src/api/snapshot-source/Instance.js +134 -134
  131. package/src/api/snapshot-source/index.d.ts +3 -3
  132. package/src/api/snapshot-source/index.js +15 -15
  133. package/src/api/snapshot-source/utils.d.ts +1 -1
  134. package/src/api/snapshot-source/utils.js +5 -5
  135. package/src/api/system/index.d.ts +960 -961
  136. package/src/api/system/index.js +1241 -1241
  137. package/src/api/view/Factory.d.ts +49 -49
  138. package/src/api/view/Factory.js +103 -103
  139. package/src/api/view/Instance.d.ts +387 -379
  140. package/src/api/view/Instance.js +422 -415
  141. package/src/api/view/index.d.ts +3 -3
  142. package/src/api/view/index.js +15 -15
  143. package/src/api/webcontents/main.d.ts +36 -36
  144. package/src/api/webcontents/main.js +82 -82
  145. package/src/api/window/Factory.d.ts +44 -44
  146. package/src/api/window/Factory.js +91 -91
  147. package/src/api/window/Instance.d.ts +972 -966
  148. package/src/api/window/Instance.js +1209 -1202
  149. package/src/api/window/index.d.ts +3 -5
  150. package/src/api/window/index.js +15 -17
  151. package/src/environment/environment.d.ts +28 -25
  152. package/src/environment/environment.js +4 -4
  153. package/src/environment/node-env.d.ts +25 -26
  154. package/src/environment/node-env.js +64 -64
  155. package/src/environment/openfin-env.d.ts +29 -30
  156. package/src/environment/openfin-env.js +107 -107
  157. package/src/mock.d.ts +3 -3
  158. package/src/mock.js +91 -90
  159. package/src/shapes/ERROR_BOX_TYPES.d.ts +1 -0
  160. package/src/shapes/ERROR_BOX_TYPES.js +2 -0
  161. package/src/shapes/WebOptions.d.ts +12 -0
  162. package/src/shapes/WebOptions.js +2 -0
  163. package/src/shapes/WindowOptions.d.ts +42 -0
  164. package/src/shapes/WindowOptions.js +2 -0
  165. package/src/shapes/protocol.d.ts +178 -0
  166. package/src/shapes/protocol.js +2 -0
  167. package/src/transport/fin_store.d.ts +4 -4
  168. package/src/transport/fin_store.js +16 -16
  169. package/src/transport/transport-errors.d.ts +18 -18
  170. package/src/transport/transport-errors.js +37 -37
  171. package/src/transport/transport.d.ts +56 -43
  172. package/src/transport/transport.js +181 -181
  173. package/src/transport/wire.d.ts +71 -11
  174. package/src/transport/wire.js +32 -32
  175. package/src/util/asyncFilter.d.ts +1 -1
  176. package/src/util/asyncFilter.js +7 -7
  177. package/src/util/errors.d.ts +9 -5
  178. package/src/util/errors.js +11 -11
  179. package/src/util/exhaustive.d.ts +1 -1
  180. package/src/util/exhaustive.js +7 -7
  181. package/src/util/http.d.ts +11 -11
  182. package/src/util/http.js +83 -83
  183. package/src/util/normalize-config.d.ts +3 -5
  184. package/src/util/normalize-config.js +47 -47
  185. package/src/util/promises.d.ts +5 -5
  186. package/src/util/promises.js +27 -27
  187. package/src/util/ref-counter.d.ts +7 -7
  188. package/src/util/ref-counter.js +51 -51
  189. package/src/util/runtimeVersioning.d.ts +3 -3
  190. package/src/util/runtimeVersioning.js +25 -25
  191. package/src/util/utilTypes.d.ts +8 -8
  192. package/src/util/utilTypes.js +2 -2
  193. package/src/util/validate.d.ts +3 -3
  194. package/src/util/validate.js +11 -11
  195. package/docs.README(OLD).md +0 -82
  196. package/resources/win/OpenFinRVM.exe +0 -0
  197. package/src/api/window/bounds-changed.d.ts +0 -10
  198. package/src/api/window/bounds-changed.js +0 -6
  199. package/src/api/window/shapes.d.ts +0 -13
package/OpenFin.d.ts CHANGED
@@ -2,7 +2,6 @@
2
2
 
3
3
  declare namespace OpenFin {
4
4
  // "wrappable entities"
5
- import EventEmitter = NodeJS.EventEmitter;
6
5
  export type Application = import('./src/api/application/index').Application;
7
6
  export type ExternalApplication = import('./src/api/external-application/index').ExternalApplication;
8
7
  export type Frame = import('./src/api/frame/index')._Frame;
@@ -12,7 +11,7 @@ declare namespace OpenFin {
12
11
  export type Layout = import('./src/api/platform/layout/index').Layout;
13
12
  export type View = import('./src/api/view/index').View;
14
13
  export type Window = import('./src/api/window/index')._Window;
15
- export type WebContent = View | Window;
14
+ export type WebContent = View | OpenFin.Window;
16
15
  export type InteropClient = import('./src/api/interop/index').InteropClient;
17
16
  export type InteropBroker = import('./src/api/interop/index').InteropBroker;
18
17
  export type SnapshotSource = import('./src/api/snapshot-source/index').SnapshotSource;
@@ -69,12 +68,12 @@ declare namespace OpenFin {
69
68
  height: number;
70
69
  };
71
70
 
72
- export type ApplicationCreationOptions = Partial<ApplicationOption> & {
71
+ export type ApplicationCreationOptions = Partial<ApplicationOptions> & {
73
72
  name: string;
74
73
  uuid: string;
75
74
  };
76
75
 
77
- export type ApplicationOption = LegacyWinOptionsInAppOptions & {
76
+ export type ApplicationOptions = LegacyWinOptionsInAppOptions & {
78
77
  disableIabSecureLogging: boolean;
79
78
  loadErrorMessage: string;
80
79
  mainWindowOptions: WindowCreationOptions;
@@ -246,7 +245,7 @@ declare namespace OpenFin {
246
245
  name: string;
247
246
  };
248
247
 
249
- export type UpdateableWindowOptions = Partial<MutableWindowOptions>;
248
+ export type UpdatableWindowOptions = Partial<MutableWindowOptions>;
250
249
 
251
250
  export type DefaultWindowOptions = WindowOptions & {
252
251
  permissions: Partial<Permissions>;
@@ -456,13 +455,16 @@ declare namespace OpenFin {
456
455
  url: string;
457
456
  favicons: string[];
458
457
  };
458
+
459
+ export type UpdatableViewOptions = Partial<MutableViewOptions>;
460
+
459
461
  export type ViewCreationOptions = Partial<ViewOptions> & {
460
462
  name: string;
461
463
  url: string;
462
464
  target: Identity;
463
465
  };
464
466
 
465
- export type UpdatableViewOptions = {
467
+ export type MutableViewOptions = {
466
468
  autoResize: AutoResizeOptions;
467
469
  contextMenuSettings: ContextMenuSettings;
468
470
  backgroundColor: string;
@@ -481,7 +483,9 @@ declare namespace OpenFin {
481
483
  permissions: Partial<Permissions>;
482
484
  };
483
485
 
484
- export type ViewOptions = UpdatableViewOptions & {
486
+ export type ViewOptions = ConstViewOptions & MutableViewOptions;
487
+
488
+ export type ConstViewOptions = {
485
489
  name: string;
486
490
  url: string;
487
491
  target: Identity;
@@ -724,7 +728,7 @@ declare namespace OpenFin {
724
728
  type: 'component';
725
729
  componentName: 'view';
726
730
  componentState: {
727
- identity: Identity;
731
+ name: string;
728
732
  url: string;
729
733
  title?: string;
730
734
  };
@@ -865,7 +869,7 @@ declare namespace OpenFin {
865
869
  * @return { Promise<HostContextChangedPayload> } The event that it raised.
866
870
  */
867
871
  onWindowContextUpdated(
868
- payload: WindowOptionsChangedEvent<'window', 'options-changed'>
872
+ payload: import('./src/api/events/window').WindowOptionsChangedEvent<'window', 'options-changed'>
869
873
  ): Promise<OpenFin.HostContextChangedPayload | undefined>;
870
874
  };
871
875
 
@@ -1336,10 +1340,6 @@ declare namespace OpenFin {
1336
1340
  // match pattern is a string type
1337
1341
  match: string[];
1338
1342
  };
1339
- export type ContextSubscription = {
1340
- handler: ContextHandler;
1341
- contextType?: string;
1342
- };
1343
1343
 
1344
1344
  export type ContextHandler = (context: OpenFin.Context) => void;
1345
1345
 
@@ -1354,9 +1354,10 @@ declare namespace OpenFin {
1354
1354
  };
1355
1355
 
1356
1356
  export type IntentHandler = (intent: OpenFin.Intent) => void;
1357
- type MatchPattern = string;
1358
1357
 
1359
1358
  export type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
1359
+
1360
+ type MatchPattern = string;
1360
1361
  export type ContentCreationRule<T = ContentCreationBehaviorNames> = {
1361
1362
  behavior: T;
1362
1363
  match: MatchPattern[];
@@ -1436,492 +1437,6 @@ declare namespace OpenFin {
1436
1437
  proxy: string;
1437
1438
  };
1438
1439
 
1439
- export type BaseEvent<Topic, Type> = {
1440
- topic: Topic;
1441
- type: Type;
1442
- };
1443
-
1444
- export type ApplicationEvent<Topic, Type> = BaseEvent<Topic, Type> & {
1445
- uuid: string;
1446
- };
1447
-
1448
- export type WindowEvent<Topic, Type> = ApplicationEvent<Topic, Type> & {
1449
- name: string;
1450
- };
1451
-
1452
- export type BaseEventMap = {
1453
- [name: string]: any;
1454
- newListener: string;
1455
- listenerRemoved: string;
1456
- };
1457
-
1458
- export type WindowResourceLoadFailedEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1459
- errorCode: number;
1460
- errorDescription: string;
1461
- validatedURL: string;
1462
- isMainFrame: boolean;
1463
- };
1464
-
1465
- export type WindowResourceResponseReceivedEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1466
- status: boolean;
1467
- newUrl: string;
1468
- originalUrl: string;
1469
- httpResponseCode: number;
1470
- requestMethod: string;
1471
- referrer: string;
1472
- headers: any;
1473
- resourceType: 'mainFrame' | 'subFrame' | 'styleSheet' | 'script' | 'image' | 'object' | 'xhr' | 'other';
1474
- };
1475
-
1476
- export type PageTitleUpdatedEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1477
- title: string;
1478
- };
1479
-
1480
- export type CertificateErrorEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1481
- error: string;
1482
- url: string;
1483
- certificate: OpenFin.Certificate;
1484
- };
1485
-
1486
- export type CertificateSelectionShownEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1487
- url: string;
1488
- certificates: OpenFin.Certificate[];
1489
- };
1490
-
1491
- export type FaviconUpdatedEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1492
- favicons: string[];
1493
- };
1494
-
1495
- export type CrashedEvent = {
1496
- reason:
1497
- | 'normal-termination'
1498
- | 'abnormal-termination'
1499
- | 'killed'
1500
- | 'crashed'
1501
- | 'still-running'
1502
- | 'launch-failed'
1503
- | 'out-of-memory'
1504
- | 'integrity-failure';
1505
- exitCode: number;
1506
- details: {
1507
- reason: string;
1508
- exitCode: number;
1509
- };
1510
- };
1511
-
1512
- export type WindowNavigationRejectedEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1513
- sourceName?: string; // DEPRECATED
1514
- url: string;
1515
- };
1516
-
1517
- export type FrameEvent<Type> = WindowEvent<'frame', Type> & {
1518
- entityType: 'iframe';
1519
- frameName: string;
1520
- };
1521
-
1522
- export type FrameEvents = BaseEventMap & {
1523
- connected: FrameEvent<'connected'>;
1524
- disconnected: FrameEvent<'disconnected'>;
1525
- };
1526
-
1527
- // This file exports base event types to level specific events
1528
- // Those files map event names to event shapes and use a mapped type to specify topic and type
1529
- export type RuntimeEvent<Topic = string, Type = string> = Topic extends 'window' | 'view'
1530
- ? WindowEvent<Topic, Type>
1531
- : Topic extends 'frame'
1532
- ? FrameEvent<Type>
1533
- : Topic extends 'application'
1534
- ? ApplicationEvent<Topic, Type>
1535
- : BaseEvent<Topic, Type>;
1536
-
1537
- export type WebContentsEventMapping<Topic = string, Type = string> = BaseEventMap & {
1538
- 'blurred': WindowEvent<Topic, Type>;
1539
- 'certificate-error': CertificateErrorEvent<Topic, Type>;
1540
- 'certificate-selection-shown': CertificateSelectionShownEvent<Topic, Type>;
1541
- 'crashed': CrashedEvent & WindowEvent<Topic, Type>;
1542
- 'did-change-theme-color': WindowEvent<Topic, Type>;
1543
- 'focused': WindowEvent<Topic, Type>;
1544
- 'found-in-page': WindowEvent<Topic, Type>;
1545
- 'navigation-rejected': WindowNavigationRejectedEvent<Topic, Type>;
1546
- 'page-favicon-updated': FaviconUpdatedEvent<Topic, Type>;
1547
- 'page-title-updated': PageTitleUpdatedEvent<Topic, Type>;
1548
- 'resource-load-failed': WindowResourceLoadFailedEvent<Topic, Type>;
1549
- 'resource-response-received': WindowResourceResponseReceivedEvent<Topic, Type>;
1550
- };
1551
-
1552
- export type RunRequestedEvent<Topic, Type> = ApplicationEvent<Topic, Type> & {
1553
- userAppConfigArgs: any;
1554
- manifest: OpenFin.ManifestInfo;
1555
- };
1556
-
1557
- export type TrayIconClicked<Topic, Type> = ApplicationEvent<Topic, Type> & {
1558
- button: 0 | 1 | 2;
1559
- bounds: OpenFin.Rectangle;
1560
- x: number;
1561
- y: number;
1562
- monitorInfo: any;
1563
- };
1564
-
1565
- export type WindowAlertRequestedEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1566
- message: string;
1567
- url: string;
1568
- };
1569
-
1570
- export type WindowAuthRequestedEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1571
- authInfo: {
1572
- host: string;
1573
- isProxy: boolean;
1574
- port: number;
1575
- realm: string;
1576
- scheme: string;
1577
- };
1578
- };
1579
-
1580
- export type WindowEndLoadEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1581
- documentName: string;
1582
- isMain: boolean;
1583
- };
1584
-
1585
- export type WindowReloadedEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1586
- url: string;
1587
- };
1588
-
1589
- export type WindowOptionsChangedEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1590
- options: OpenFin.WindowOptions;
1591
- diff: OpenFin.WindowOptionDiff;
1592
- };
1593
-
1594
- export type WindowExternalProcessExitedEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1595
- processUuid: string;
1596
- exitCode: number;
1597
- };
1598
-
1599
- export type WindowExternalProcessStartedEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1600
- processUuid: string;
1601
- };
1602
-
1603
- export type WindowHiddenEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1604
- reason: 'closing' | 'hide' | 'hide-on-close';
1605
- };
1606
-
1607
- export type PreloadScriptInfoRunning = {
1608
- state:
1609
- | 'load-started' // started loading preload script
1610
- | 'load-failed' // preload script failed to load
1611
- | 'load-succeeded' // preload script is loaded and ready to be eval'ed
1612
- | 'failed' // preload script failed to eval
1613
- | 'succeeded'; // preload script eval'ed successfully
1614
- };
1615
-
1616
- export type PreloadScriptInfo = {
1617
- state:
1618
- | 'load-failed' // preload script failed to load
1619
- | 'failed' // preload script failed to eval
1620
- | 'succeeded'; // preload script eval'ed successfully
1621
- };
1622
- export type WindowPreloadScriptsStateChangeEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1623
- preloadScripts: (PreloadScriptInfoRunning & any)[];
1624
- };
1625
- export type WindowPreloadScriptsStateChangedEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1626
- preloadScripts: (PreloadScriptInfoRunning & any)[];
1627
- };
1628
-
1629
- export type WindowBeginBoundsChangingEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1630
- height: number;
1631
- left: number;
1632
- top: number;
1633
- width: number;
1634
- windowState: 'minimized' | 'normal' | 'maximized';
1635
- };
1636
-
1637
- export type WindowEndBoundsChangingEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1638
- height: number;
1639
- left: number;
1640
- top: number;
1641
- width: number;
1642
- windowState: 'minimized' | 'normal' | 'maximized';
1643
- };
1644
-
1645
- export type WindowBoundsChange<Topic, Type> = WindowEvent<Topic, Type> & {
1646
- changeType: 0 | 1 | 2;
1647
- deferred: boolean;
1648
- height: number;
1649
- left: number;
1650
- top: number;
1651
- width: number;
1652
- };
1653
-
1654
- export type WillMoveOrResize<Topic, Type> = WindowEvent<Topic, Type> & {
1655
- height: number;
1656
- left: number;
1657
- top: number;
1658
- width: number;
1659
- monitorScaleFactor: number;
1660
- };
1661
-
1662
- export type WindowPerformanceReport<Topic, Type> = Performance & WindowEvent<Topic, Type>;
1663
-
1664
- export type ViewDetached<Topic, Type> = WindowEvent<Topic, Type> & {
1665
- previousTarget: OpenFin.Identity;
1666
- target: OpenFin.Identity;
1667
- viewIdentity: OpenFin.Identity;
1668
- };
1669
-
1670
- export type WindowEventMapping<Topic = string, Type = string> = WebContentsEventMapping & {
1671
- 'auth-requested': WindowAuthRequestedEvent<Topic, Type>;
1672
- 'begin-user-bounds-changing': WindowBeginBoundsChangingEvent<Topic, Type>;
1673
- 'bounds-changed': WindowBoundsChange<Topic, Type>;
1674
- 'bounds-changing': WindowBoundsChange<Topic, Type>;
1675
- 'close-requested': WindowEvent<Topic, Type>;
1676
- 'closed': WindowEvent<Topic, Type>;
1677
- 'closing': WindowEvent<Topic, Type>;
1678
- 'disabled-movement-bounds-changed': WindowBoundsChange<Topic, Type>;
1679
- 'disabled-movement-bounds-changing': WindowBoundsChange<Topic, Type>;
1680
- 'embedded': WindowEvent<Topic, Type>;
1681
- 'end-user-bounds-changing': WindowEndBoundsChangingEvent<Topic, Type>;
1682
- 'external-process-exited': WindowExternalProcessExitedEvent<Topic, Type>;
1683
- 'external-process-started': WindowExternalProcessStartedEvent<Topic, Type>;
1684
- 'hidden': WindowHiddenEvent<Topic, Type>;
1685
- 'hotkey': InputEvent & WindowEvent<Topic, Type>;
1686
- 'initialized': WindowEvent<Topic, Type>;
1687
- 'layout-initialized': WindowEvent<Topic, Type>;
1688
- 'layout-ready': WindowEvent<Topic, Type>;
1689
- 'maximized': WindowEvent<Topic, Type>;
1690
- 'minimized': WindowEvent<Topic, Type>;
1691
- 'options-changed': WindowOptionsChangedEvent<Topic, Type>;
1692
- 'performance-report': WindowPerformanceReport<Topic, Type>;
1693
- 'preload-scripts-state-changed': WindowPreloadScriptsStateChangeEvent<Topic, Type>;
1694
- 'preload-scripts-state-changing': WindowPreloadScriptsStateChangeEvent<Topic, Type>;
1695
- 'reloaded': WindowReloadedEvent<Topic, Type>;
1696
- 'restored': WindowEvent<Topic, Type>;
1697
- 'show-requested': WindowEvent<Topic, Type>;
1698
- 'shown': WindowEvent<Topic, Type>;
1699
- 'user-movement-disabled': WindowEvent<Topic, Type>;
1700
- 'user-movement-enabled': WindowEvent<Topic, Type>;
1701
- 'view-attached': WindowEvent<Topic, Type>;
1702
- 'view-detached': ViewDetached<Topic, Type>;
1703
- 'will-move': WillMoveOrResize<Topic, Type>;
1704
- 'will-resize': WillMoveOrResize<Topic, Type>;
1705
- };
1706
-
1707
- export type PropagatedWindowEventMapping<Topic = string, Type = string> = BaseEventMap & {
1708
- 'window-begin-user-bounds-changing': WindowBeginBoundsChangingEvent<Topic, Type>;
1709
- 'window-blurred': WindowEvent<Topic, Type>;
1710
- 'window-bounds-changed': WindowBoundsChange<Topic, Type>;
1711
- 'window-bounds-changing': WindowBoundsChange<Topic, Type>;
1712
- 'window-certificate-selection-shown': CertificateSelectionShownEvent<Topic, Type>;
1713
- 'window-closed': WindowEvent<Topic, Type>;
1714
- 'window-closing': WindowEvent<Topic, Type>;
1715
- 'window-crashed': CrashedEvent & WindowEvent<Topic, Type>;
1716
- 'window-disabled-movement-bounds-changed': WindowBoundsChange<Topic, Type>;
1717
- 'window-disabled-movement-bounds-changing': WindowBoundsChange<Topic, Type>;
1718
- 'window-embedded': WindowEvent<Topic, Type>;
1719
- 'window-end-user-bounds-changing': WindowBeginBoundsChangingEvent<Topic, Type>;
1720
- 'window-external-process-exited': WindowExternalProcessExitedEvent<Topic, Type>;
1721
- 'window-external-process-started': WindowExternalProcessStartedEvent<Topic, Type>;
1722
- 'window-focused': WindowEvent<Topic, Type>;
1723
- 'window-hidden': WindowHiddenEvent<Topic, Type>;
1724
- 'window-hotkey': InputEvent & WindowEvent<Topic, Type>;
1725
- 'window-initialized': WindowEvent<Topic, Type>;
1726
- 'window-layout-initialized': WindowEvent<Topic, Type>;
1727
- 'window-layout-ready': WindowEvent<Topic, Type>;
1728
- 'window-maximized': WindowEvent<Topic, Type>;
1729
- 'window-minimized': WindowEvent<Topic, Type>;
1730
- 'window-navigation-rejected': WindowNavigationRejectedEvent<Topic, Type>;
1731
- 'window-options-changed': WindowOptionsChangedEvent<Topic, Type>;
1732
- 'window-performance-report': WindowPerformanceReport<Topic, Type>;
1733
- 'window-preload-scripts-state-changed': WindowPreloadScriptsStateChangeEvent<Topic, Type>;
1734
- 'window-preload-scripts-state-changing': WindowPreloadScriptsStateChangedEvent<Topic, Type>;
1735
- 'window-resource-load-failed': WindowResourceLoadFailedEvent<Topic, Type>;
1736
- 'window-resource-response-received': WindowResourceResponseReceivedEvent<Topic, Type>;
1737
- 'window-reloaded': WindowReloadedEvent<Topic, Type>;
1738
- 'window-restored': WindowEvent<Topic, Type>;
1739
- 'window-shown': WindowEvent<Topic, Type>;
1740
- 'window-user-movement-disabled': WindowEvent<Topic, Type>;
1741
- 'window-user-movement-enabled': WindowEvent<Topic, Type>;
1742
- 'window-will-move': WillMoveOrResize<Topic, Type>;
1743
- 'window-will-resize': WillMoveOrResize<Topic, Type>;
1744
- };
1745
-
1746
- export type ViewEventMapping<Topic = string, Type = string> = WebContentsEventMapping & {
1747
- 'attached': WindowEvent<Topic, Type>;
1748
- 'created': WindowEvent<Topic, Type>;
1749
- 'destroyed': WindowEvent<Topic, Type>;
1750
- 'hidden': WindowEvent<Topic, Type>;
1751
- 'hotkey': InputEvent & WindowEvent<Topic, Type>;
1752
- 'shown': WindowEvent<Topic, Type>;
1753
- 'target-changed': TargetChangedEvent<Topic, Type>;
1754
- };
1755
-
1756
- type PropagatedViewIdentity = {
1757
- viewIdentity: OpenFin.Identity;
1758
- };
1759
-
1760
- export type PropagatedViewEventMapping<Topic = string, Type = string> = BaseEventMap & {
1761
- 'view-blurred': WindowEvent<Topic, Type> & PropagatedViewIdentity;
1762
- 'view-certificate-selection-shown': CertificateSelectionShownEvent<Topic, Type> & PropagatedViewIdentity;
1763
- 'view-crashed': CrashedEvent & WindowEvent<Topic, Type> & PropagatedViewIdentity;
1764
- 'view-created': CrashedEvent & WindowEvent<Topic, Type> & PropagatedViewIdentity;
1765
- 'view-destroyed': WindowEvent<Topic, Type> & PropagatedViewIdentity;
1766
- 'view-did-change-theme-color': WindowEvent<Topic, Type> & PropagatedViewIdentity;
1767
- 'view-focused': WindowEvent<Topic, Type> & PropagatedViewIdentity;
1768
- 'view-hidden': WindowEvent<Topic, Type> & PropagatedViewIdentity;
1769
- 'view-hotkey': InputEvent & WindowEvent<Topic, Type> & PropagatedViewIdentity;
1770
- 'view-navigation-rejected': WindowNavigationRejectedEvent<Topic, Type> & PropagatedViewIdentity;
1771
- 'view-page-favicon-updated': WindowEvent<Topic, Type> & PropagatedViewIdentity;
1772
- 'view-page-title-updated': WindowEvent<Topic, Type> & PropagatedViewIdentity;
1773
- 'view-resource-load-failed': WindowResourceLoadFailedEvent<Topic, Type> & PropagatedViewIdentity;
1774
- 'view-resource-response-received': WindowResourceResponseReceivedEvent<Topic, Type> & PropagatedViewIdentity;
1775
- 'view-shown': WindowEvent<Topic, Type> & PropagatedViewIdentity;
1776
- 'view-target-changed': TargetChangedEvent<Topic, Type> & PropagatedViewIdentity;
1777
- };
1778
-
1779
- export type ViewEvents = {
1780
- [Type in keyof ViewEventMapping]: ViewEventMapping<'view', Type>[Type];
1781
- };
1782
-
1783
- export type PropagatedViewEvents<Topic> = {
1784
- [Type in keyof PropagatedViewEventMapping]: PropagatedViewEventMapping<Topic, Type>[Type];
1785
- };
1786
-
1787
- export type InputEvent = {
1788
- inputType: 'keyUp' | 'keyDown';
1789
- ctrlKey: boolean;
1790
- shiftKey: boolean;
1791
- altKey: boolean;
1792
- metaKey: boolean;
1793
- key: string;
1794
- code: string;
1795
- repeat: boolean;
1796
- command?: string;
1797
- };
1798
-
1799
- export type TargetChangedEvent<Topic, Type> = WindowEvent<Topic, Type> & {
1800
- previousTarget: OpenFin.Identity;
1801
- target: OpenFin.Identity;
1802
- };
1803
-
1804
- // This is the type we should be using. It takes the more generic mapping and applies the proper Topic and Type to each event
1805
- export type WindowEvents = PropagatedViewEventMapping<'window'> &
1806
- {
1807
- [Type in keyof WindowEventMapping]: WindowEventMapping<'window', Type>[Type];
1808
- };
1809
-
1810
- export type PropagatedWindowEvents<Topic> = {
1811
- [Type in keyof PropagatedWindowEventMapping]: PropagatedWindowEventMapping<Topic, Type>[Type];
1812
- };
1813
-
1814
- export type ApplicationEventMapping<Topic = string, Type = string> = BaseEventMap & {
1815
- 'closed': ApplicationEvent<Topic, Type>;
1816
- 'connected': ApplicationEvent<Topic, Type>;
1817
- 'crashed': CrashedEvent & ApplicationEvent<Topic, Type>;
1818
- 'initialized': ApplicationEvent<Topic, Type>;
1819
- 'manifest-changed': ApplicationEvent<Topic, Type>;
1820
- 'not-responding': ApplicationEvent<Topic, Type>;
1821
- 'responding': ApplicationEvent<Topic, Type>;
1822
- 'run-requested': RunRequestedEvent<Topic, Type>;
1823
- 'started': ApplicationEvent<Topic, Type>;
1824
- 'tray-icon-clicked': TrayIconClicked<Topic, Type>;
1825
- 'window-alert-requested': WindowAlertRequestedEvent<Topic, Type>;
1826
- 'window-auth-requested': WindowAuthRequestedEvent<Topic, Type>;
1827
- 'window-created': WindowEvent<Topic, Type>;
1828
- 'window-end-load': WindowEndLoadEvent<Topic, Type>;
1829
- 'window-not-responding': WindowEvent<Topic, Type>;
1830
- 'window-performance-report': WindowPerformanceReport<Topic, Type>;
1831
- 'window-responding': WindowEvent<Topic, Type>;
1832
- 'window-show-requested': WindowEvent<Topic, Type>;
1833
- 'window-start-load': WindowEvent<Topic, Type>;
1834
- };
1835
-
1836
- export type PropagatedApplicationEventMapping<Topic = string, Type = string> = {
1837
- 'application-closed': ApplicationEvent<Topic, Type>;
1838
- 'application-connected': ApplicationEvent<Topic, Type>;
1839
- 'application-crashed': CrashedEvent & ApplicationEvent<Topic, Type>;
1840
- 'application-initialized': ApplicationEvent<Topic, Type>;
1841
- 'application-manifest-changed': ApplicationEvent<Topic, Type>;
1842
- 'application-not-responding': ApplicationEvent<Topic, Type>;
1843
- 'application-responding': ApplicationEvent<Topic, Type>;
1844
- 'application-started': ApplicationEvent<Topic, Type>;
1845
- 'application-tray-icon-clicked': TrayIconClicked<Topic, Type>;
1846
- 'window-created': WindowEvent<Topic, Type>;
1847
- 'window-did-change-theme-color': WindowEvent<Topic, Type>;
1848
- 'window-end-load': WindowEndLoadEvent<Topic, Type>;
1849
- 'window-not-responding': WindowEvent<Topic, Type>;
1850
- 'window-page-favicon-updated': WindowEvent<Topic, Type>;
1851
- 'window-page-title-updated': WindowEvent<Topic, Type>;
1852
- 'window-performance-report': WindowPerformanceReport<Topic, Type>;
1853
- 'window-responding': WindowEvent<Topic, Type>;
1854
- 'window-start-load': WindowEvent<Topic, Type>;
1855
- };
1856
-
1857
- export type ApplicationEvents = PropagatedWindowEvents<'application'> &
1858
- PropagatedViewEvents<'application'> &
1859
- {
1860
- [Type in keyof ApplicationEventMapping]: ApplicationEventMapping<'application', Type>[Type];
1861
- };
1862
- export type PropagatedApplicationEvents<Topic> = {
1863
- [Type in keyof PropagatedApplicationEventMapping]: PropagatedApplicationEventMapping<Topic, Type>[Type];
1864
- };
1865
-
1866
- export type PlatformEventMapping<Topic = string, Type = string> = ApplicationEventMapping & {
1867
- 'platform-api-ready': ApplicationEvent<Topic, Type>;
1868
- 'platform-snapshot-applied': ApplicationEvent<Topic, Type>;
1869
- };
1870
-
1871
- export type PropagatedPlatformEventMapping<Topic = string, Type = string> = PropagatedApplicationEventMapping & {
1872
- 'platform-api-ready': ApplicationEvent<Topic, Type>;
1873
- 'platform-snapshot-applied': ApplicationEvent<Topic, Type>;
1874
- };
1875
-
1876
- export type PlatformEvents = PropagatedWindowEvents<'application'> &
1877
- PropagatedViewEvents<'application'> &
1878
- {
1879
- [Type in keyof PlatformEventMapping]: PlatformEventMapping<'application', Type>[Type];
1880
- };
1881
- export type PropagatedPlatformEvents<Topic> = {
1882
- [Type in keyof PropagatedPlatformEventMapping]: PropagatedPlatformEventMapping<Topic, Type>[Type];
1883
- };
1884
-
1885
- export type IdleEvent<Topic, Type> = BaseEvent<Topic, Type> & {
1886
- elapsedTime: number;
1887
- isIdle: boolean;
1888
- };
1889
-
1890
- export type MonitorEvent<Topic, Type> = OpenFin.MonitorInfo & BaseEvent<Topic, Type>;
1891
-
1892
- export type SessionChangedEvent<Topic, Type> = BaseEvent<Topic, Type> & {
1893
- reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
1894
- };
1895
-
1896
- export type SystemEventMapping<Topic = string, Type = string> = BaseEventMap & {
1897
- 'application-created': ApplicationEvent<Topic, Type>;
1898
- 'desktop-icon-clicked': ApplicationEvent<Topic, Type>;
1899
- 'idle-state-changed': IdleEvent<Topic, Type>;
1900
- 'monitor-info-changed': MonitorEvent<Topic, Type>;
1901
- 'session-changed': SessionChangedEvent<Topic, Type>;
1902
- };
1903
- export type SystemEvents = PropagatedWindowEvents<'system'> &
1904
- PropagatedApplicationEvents<'system'> &
1905
- PropagatedViewEvents<'system'> &
1906
- {
1907
- [Type in keyof SystemEventMapping]: SystemEventMapping<'system', Type>[Type];
1908
- };
1909
-
1910
- export type GlobalHotkeyEvent<Type> = RuntimeEvent<'global-hotkey', Type> & {
1911
- identity: Identity;
1912
- hotkey: string;
1913
- };
1914
-
1915
- export type GlobalHotkeyEvents = BaseEventMap & {
1916
- registered: GlobalHotkeyEvent<'registered'>;
1917
- unregistered: GlobalHotkeyEvent<'unregistered'>;
1918
- };
1919
-
1920
- export type ExternalApplicationEvents = BaseEventMap & {
1921
- connected: RuntimeEvent<'externalapplication', 'connected'>;
1922
- disconnected: RuntimeEvent<'externalapplication', 'disconnected'>;
1923
- };
1924
-
1925
1440
  export type ChannelAction = (payload: unknown, id: ProviderIdentity | OpenFin.ClientIdentity) => unknown;
1926
1441
 
1927
1442
  export type ChannelMiddleware = (
@@ -1936,7 +1451,7 @@ declare namespace OpenFin {
1936
1451
  id: ProviderIdentity | OpenFin.ClientIdentity
1937
1452
  ) => unknown;
1938
1453
 
1939
- export type SystemApplicationInfo = {
1454
+ export type ApplicationState = {
1940
1455
  isPlatform: boolean;
1941
1456
  isRunning: boolean;
1942
1457
  uuid: string;
@@ -1963,25 +1478,13 @@ declare namespace OpenFin {
1963
1478
  date: string;
1964
1479
  };
1965
1480
 
1481
+ export type SendApplicationLogResponse = {
1482
+ logId: string;
1483
+ };
1484
+
1966
1485
  // 2.4 supports string enum types, currently we use 2.2
1967
1486
  export type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
1968
1487
 
1969
- export type ProcessInfo = {
1970
- cpuUsage?: number;
1971
- name?: string;
1972
- nonPagedPoolUsage?: number;
1973
- pageFaultCount?: number;
1974
- pagedPoolUsage?: number;
1975
- pagefileUsage?: number;
1976
- peakNonPagedPoolUsage?: number;
1977
- peakPagedPoolUsage?: number;
1978
- peakPagefileUsage?: number;
1979
- peakWorkingSetSize?: number;
1980
- processId?: number;
1981
- uuid?: string;
1982
- workingSetSize?: number;
1983
- };
1984
-
1985
1488
  export type PermissionState = 'granted' | 'denied' | 'unavailable';
1986
1489
 
1987
1490
  export type RegistryInfo = {
@@ -1992,12 +1495,20 @@ declare namespace OpenFin {
1992
1495
  value: string;
1993
1496
  };
1994
1497
 
1995
- export type Entity = {
1996
- type: string;
1498
+ export type ApplicationType = {
1499
+ type: 'application' | 'external-app';
1997
1500
  uuid: string;
1998
1501
  };
1999
1502
 
2000
1503
  export type WindowInfo = {
1504
+ canNavigateBack: boolean;
1505
+ canNavigateForward: boolean;
1506
+ preloadScripts: Array<any>;
1507
+ title: string;
1508
+ url: string;
1509
+ };
1510
+
1511
+ export type ApplicationWindowInfo = {
2001
1512
  childWindows: Array<WindowDetail>;
2002
1513
  mainWindow: WindowDetail;
2003
1514
  uuid: string;
@@ -2015,25 +1526,6 @@ declare namespace OpenFin {
2015
1526
  width: number;
2016
1527
  };
2017
1528
 
2018
- export type WebOptions = {
2019
- preloadScripts?: OpenFin.PreloadScript[];
2020
- uuid: string;
2021
- name: string;
2022
- contentCreation?: OpenFin.ContentCreationOptions;
2023
- contentRedirect?: Partial<OpenFin.ContentRedirect>;
2024
- customContext?: any;
2025
- experimental?: any;
2026
- processAffinity?: string;
2027
- backgroundThrottling?: boolean;
2028
- interop?: OpenFin.InteropConfig;
2029
- };
2030
-
2031
- // Error types
2032
- export type ERROR_BOX_TYPES =
2033
- | 'OF_error_box:app_initialization'
2034
- | 'OF_error_box:main_process'
2035
- | 'OF_error_box:renderer_crash';
2036
-
2037
1529
  export type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
2038
1530
 
2039
1531
  export type InitLayoutOptions = {
@@ -2044,302 +1536,19 @@ declare namespace OpenFin {
2044
1536
  presetType: LayoutPresetType;
2045
1537
  };
2046
1538
 
2047
- export type DragPayload = {
2048
- 'view-config': OpenFin.ViewCreationOptions;
2049
- 'view-identity': [string, string, string]; // [componentState, uuid, name]
2050
- };
1539
+ export type SystemEvents = import('./src/api/events/system').SystemEvents;
2051
1540
 
2052
- export type Message<T> = {
2053
- action: string;
2054
- payload: T;
2055
- correlationId?: number;
2056
- };
1541
+ export type ApplicationEvents = import('./src/api/events/application').ApplicationEvents;
2057
1542
 
2058
- export type EventMessage = Message<RuntimeEvent> & {
2059
- action: 'process-desktop-event';
2060
- payload: RuntimeEvent;
2061
- };
1543
+ export type WindowEvents = import('./src/api/events/window').WindowEvents;
2062
1544
 
2063
- export type Payload = {
2064
- success: boolean;
2065
- data: any;
2066
- };
1545
+ export type ViewEvents = import('./src/api/events/view').ViewEvents;
2067
1546
 
2068
- export type AuthorizationPayload = {
2069
- token: string;
2070
- file: string;
2071
- };
2072
-
2073
- /*
2074
- To Add an api call:
2075
- 1. The action (string passed to wire.sendAction and key in the actionMap on the core side) should be the key in the protocolmap
2076
- 2. The request for that key is the type of the second object passed to wire.sendAction, it will be picked up as message.payload in the handler
2077
- 3. The response for that key is what the core api handler either returns or passes to "ack". It will be the 'data' property of the return value of wire.sendAction
2078
- */
2079
- export type ProtocolMap = ProtocolMapBase & {
2080
- 'request-external-authorization': {
2081
- request: any;
2082
- response: void;
2083
- specialResponse: AuthorizationPayload;
2084
- };
2085
- 'application-get-views': {
2086
- request: OpenFin.ApplicationIdentity;
2087
- response: OpenFin.Identity[];
2088
- };
2089
- 'set-jump-list': {
2090
- request: { config: OpenFin.JumpListCategory[] | null } & OpenFin.ApplicationIdentity;
2091
- response: void;
2092
- };
2093
- 'get-view-window': {
2094
- request: OpenFin.Identity;
2095
- response: OpenFin.Identity;
2096
- };
2097
- 'window-get-views': {
2098
- request: OpenFin.Identity;
2099
- response: OpenFin.Identity[];
2100
- };
2101
- 'hide-view': {
2102
- request: OpenFin.Identity;
2103
- response: void;
2104
- };
2105
- 'launch-manifest': {
2106
- request: { manifestUrl: string; opts?: OpenFin.RvmLaunchOptions };
2107
- response: { manifest: OpenFin.Manifest };
2108
- };
2109
- 'get-system-app-configuration': {
2110
- request: { name: string };
2111
- response: any;
2112
- };
2113
- 'show-popup-menu': {
2114
- request: OpenFin.Identity & { options: OpenFin.ShowPopupMenuOptions };
2115
- response: OpenFin.MenuResult;
2116
- };
2117
- 'enable-native-window-integration-provider': {
2118
- request: { permissions: any };
2119
- response: OpenFin.NativeWindowIntegrationProviderAuthorization;
2120
- };
2121
- 'get-permissions': {
2122
- request: void;
2123
- response: any;
2124
- };
2125
- 'set-file-download-location': {
2126
- request: OpenFin.ApplicationIdentity & { downloadLocation: string };
2127
- response: void;
2128
- };
2129
- 'close-popup-menu': {
2130
- request: OpenFin.Identity;
2131
- response: void;
2132
- };
2133
- 'fdc3-add-context-listener': {
2134
- request: void;
2135
- response: void;
2136
- };
2137
- 'fdc3-broadcast': {
2138
- request: void;
2139
- response: void;
2140
- };
2141
- 'fdc3-get-system-channels': {
2142
- request: void;
2143
- response: void;
2144
- };
2145
- 'fdc3-join-channel': {
2146
- request: void;
2147
- response: void;
2148
- };
2149
- 'fdc3-leave-current-channel': {
2150
- request: void;
2151
- response: void;
2152
- };
2153
- 'interop-connect-sync': {
2154
- request: void;
2155
- response: void;
2156
- };
2157
- 'interop-client-set-context': {
2158
- request: void;
2159
- response: void;
2160
- };
2161
- 'interop-client-add-context-handler': {
2162
- request: void;
2163
- response: void;
2164
- };
2165
- 'interop-client-get-context-groups': {
2166
- request: void;
2167
- response: void;
2168
- };
2169
- 'interop-client-join-context-group': {
2170
- request: void;
2171
- response: void;
2172
- };
2173
- 'interop-client-remove-from-context-group': {
2174
- request: void;
2175
- response: void;
2176
- };
2177
- 'interop-client-get-all-clients-in-context-group': {
2178
- request: void;
2179
- response: void;
2180
- };
2181
- 'interop-client-get-info-for-context-group': {
2182
- request: void;
2183
- response: void;
2184
- };
2185
- 'interop-broker-add-client-to-context-group': {
2186
- request: void;
2187
- response: void;
2188
- };
2189
- 'interop-broker-get-all-clients-in-context-group': {
2190
- request: void;
2191
- response: void;
2192
- };
2193
- 'interop-broker-get-context-groups': {
2194
- request: void;
2195
- response: void;
2196
- };
2197
- 'interop-broker-get-info-for-context-group': {
2198
- request: void;
2199
- response: void;
2200
- };
2201
- 'interop-broker-is-action-authorized': {
2202
- request: void;
2203
- response: void;
2204
- };
2205
- 'interop-broker-is-connection-authorized': {
2206
- request: void;
2207
- response: void;
2208
- };
2209
- 'interop-broker-join-context-group': {
2210
- request: void;
2211
- response: void;
2212
- };
2213
- 'interop-broker-remove-client-from-context-group': {
2214
- request: void;
2215
- response: void;
2216
- };
2217
- 'interop-broker-remove-from-context-group': {
2218
- request: void;
2219
- response: void;
2220
- };
2221
- 'interop-broker-set-context': {
2222
- request: void;
2223
- response: void;
2224
- };
2225
- 'query-permission-for-current-context': {
2226
- request: { apiName: string; identity: OpenFin.Identity };
2227
- response: OpenFin.QueryPermissionResult;
2228
- };
2229
- };
2230
-
2231
- type ProtocolMapBase = {
2232
- [action: string]: {
2233
- request: any;
2234
- response: any;
2235
- specialResponse?: any; // Used for anything not on payload.data (only request-external-authorization for now)
2236
- };
2237
- };
2238
-
2239
- export type MessageHandler = (data: any) => boolean;
2240
-
2241
- export type ViewState = OpenFin.ViewCreationOptions & {
2242
- url: string;
2243
- };
2244
-
2245
- export type OsConfig = {
2246
- manifestLocation: string;
2247
- namedPipeName: string;
2248
- urlPath: string;
2249
- executablePath: string;
2250
- };
2251
-
2252
- export type Wire = EventEmitter & {
2253
- connect(address: string): Promise<any>;
2254
- connectSync(): any;
2255
- send(data: any): Promise<any>;
2256
- shutdown(): Promise<void>;
2257
- };
2258
- export type WireConstructor = {
2259
- new (onmessage: (data: any) => void): Wire;
2260
- };
1547
+ export type GlobalHotkeyEvents = import('./src/api/events/globalHotkey').GlobalHotkeyEvents;
2261
1548
 
2262
- export type RuntimeConfig = {
2263
- version: string;
2264
- fallbackVersion?: string;
2265
- securityRealm?: string;
2266
- verboseLogging?: boolean;
2267
- arguments?: string;
2268
- rvmDir?: string;
2269
- };
2270
-
2271
- export type ServiceConfig = {
2272
- name: string;
2273
- manifestUrl: string;
2274
- };
1549
+ export type FrameEvents = import('./src/api/events/frame').FrameEvents;
2275
1550
 
2276
- export type BaseConfig = {
2277
- uuid?: string;
2278
- address?: string;
2279
- name?: string;
2280
- nonPersistent?: boolean;
2281
- runtimeClient?: boolean;
2282
- licenseKey?: string;
2283
- client?: any;
2284
- manifestUrl?: string;
2285
- startupApp?: any;
2286
- lrsUrl?: string;
2287
- assetsUrl?: string;
2288
- devToolsPort?: number;
2289
- installerUI?: boolean;
2290
- runtime?: RuntimeConfig;
2291
- services?: ServiceConfig[];
2292
- appAssets?: [
2293
- {
2294
- src: string;
2295
- alias: string;
2296
- target: string;
2297
- version: string;
2298
- args: string;
2299
- }
2300
- ];
2301
- customItems?: [any];
2302
- timeout?: number; // in seconds
2303
- };
2304
-
2305
- export type ConfigWithUuid = BaseConfig & {
2306
- uuid: string;
2307
- };
2308
-
2309
- export type ExistingConnectConfig = ConfigWithUuid & {
2310
- address: string;
2311
- };
1551
+ export type PlatformEvents = import('./src/api/events/platform').PlatformEvents;
2312
1552
 
2313
- export type ConfigWithRuntime = BaseConfig & {
2314
- runtime: RuntimeConfig;
2315
- };
2316
-
2317
- export type ExternalConfig = BaseConfig & {
2318
- manifestUrl: string;
2319
- };
2320
-
2321
- export type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
2322
-
2323
- export type PortDiscoveryConfig = (ExternalConfig & ConfigWithRuntime) | NewConnectConfig;
2324
-
2325
- export type ConnectConfig = ExistingConnectConfig | NewConnectConfig | ExternalConfig;
2326
-
2327
- export type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
2328
-
2329
- export type ReadyState = // https://github.com/websockets/ws/blob/master/doc/ws.md#ready-state-constants
2330
- | 'CONNECTING' // The connection is not yet open.
2331
- | 'OPEN' // The connection is open and ready to communicate.
2332
- | 'CLOSING' // The connection is in the process of closing.
2333
- | 'CLOSED'; // The connection is closed.
2334
-
2335
- export type ChildContentOptions = {
2336
- options: any;
2337
- entityType: EntityType;
2338
- };
2339
-
2340
- export type ErrorPlainObject = {
2341
- stack: string;
2342
- message: string;
2343
- toString(): string;
2344
- };
1553
+ export type ExternalApplicationEvents = import('./src/api/events/externalApplication').ExternalApplicationEvents;
2345
1554
  }