@openfin/core 34.78.3 → 34.78.7

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.
package/out/mock.js CHANGED
@@ -921,7 +921,6 @@ function requireFactory$3 () {
921
921
  * ```
922
922
  * Note that created views needs to navigate somewhere for them to actually render a website.
923
923
  * @experimental
924
- * @static
925
924
  */
926
925
  async create(options) {
927
926
  const { uuid } = this.wire.me;
@@ -941,7 +940,6 @@ function requireFactory$3 () {
941
940
  }
942
941
  /**
943
942
  * Asynchronously returns a View object that represents an existing view.
944
- * @param identity
945
943
  *
946
944
  * @example
947
945
  * ```js
@@ -950,7 +948,6 @@ function requireFactory$3 () {
950
948
  * .catch(err => console.log(err));
951
949
  * ```
952
950
  * @experimental
953
- * @static
954
951
  */
955
952
  async wrap(identity) {
956
953
  this.wire.sendAction('view-wrap');
@@ -962,7 +959,6 @@ function requireFactory$3 () {
962
959
  }
963
960
  /**
964
961
  * Synchronously returns a View object that represents an existing view.
965
- * @param identity
966
962
  *
967
963
  * @example
968
964
  * ```js
@@ -970,7 +966,6 @@ function requireFactory$3 () {
970
966
  * await view.hide();
971
967
  * ```
972
968
  * @experimental
973
- * @static
974
969
  */
975
970
  wrapSync(identity) {
976
971
  this.wire.sendAction('view-wrap-sync').catch((e) => {
@@ -993,7 +988,6 @@ function requireFactory$3 () {
993
988
  *
994
989
  * ```
995
990
  * @experimental
996
- * @static
997
991
  */
998
992
  getCurrent() {
999
993
  this.wire.sendAction('view-get-current').catch((e) => {
@@ -1015,7 +1009,6 @@ function requireFactory$3 () {
1015
1009
  *
1016
1010
  * ```
1017
1011
  * @experimental
1018
- * @static
1019
1012
  */
1020
1013
  getCurrentSync() {
1021
1014
  this.wire.sendAction('view-get-current-sync').catch((e) => {
@@ -1867,10 +1860,7 @@ class WebContents extends base_1$k.EmitterBase {
1867
1860
  }
1868
1861
  /**
1869
1862
  * Gets a base64 encoded image of all or part of the WebContents.
1870
- * @function capturePage
1871
1863
  * @param options Options for the capturePage call.
1872
- * @memberOf View
1873
- * @instance
1874
1864
  *
1875
1865
  * @example
1876
1866
  *
@@ -1923,9 +1913,6 @@ class WebContents extends base_1$k.EmitterBase {
1923
1913
  * Executes Javascript on the WebContents, restricted to contents you own or contents owned by
1924
1914
  * applications you have created.
1925
1915
  * @param code JavaScript code to be executed on the view.
1926
- * @function executeJavaScript
1927
- * @memberOf View
1928
- * @instance
1929
1916
  *
1930
1917
  * @example
1931
1918
  * View:
@@ -1961,9 +1948,6 @@ class WebContents extends base_1$k.EmitterBase {
1961
1948
  }
1962
1949
  /**
1963
1950
  * Returns the zoom level of the WebContents.
1964
- * @function getZoomLevel
1965
- * @memberOf View
1966
- * @instance
1967
1951
  *
1968
1952
  * @example
1969
1953
  * View:
@@ -2002,9 +1986,6 @@ class WebContents extends base_1$k.EmitterBase {
2002
1986
  /**
2003
1987
  * Sets the zoom level of the WebContents.
2004
1988
  * @param level The zoom level
2005
- * @function setZoomLevel
2006
- * @memberOf View
2007
- * @instance
2008
1989
  *
2009
1990
  * @example
2010
1991
  * View:
@@ -2046,9 +2027,6 @@ class WebContents extends base_1$k.EmitterBase {
2046
2027
  * @remarks The url must contain the protocol prefix such as http:// or https://.
2047
2028
  * @param url - The URL to navigate the WebContents to.
2048
2029
  *
2049
- * @function navigate
2050
- * @memberof View
2051
- * @instance
2052
2030
  * @example
2053
2031
  * View:
2054
2032
  * ```js
@@ -2082,9 +2060,6 @@ class WebContents extends base_1$k.EmitterBase {
2082
2060
  }
2083
2061
  /**
2084
2062
  * Navigates the WebContents back one page.
2085
- * @function navigateBack
2086
- * @memberOf View
2087
- * @instance
2088
2063
  *
2089
2064
  * @example
2090
2065
  * View:
@@ -2112,9 +2087,6 @@ class WebContents extends base_1$k.EmitterBase {
2112
2087
  }
2113
2088
  /**
2114
2089
  * Navigates the WebContents forward one page.
2115
- * @function navigateForward
2116
- * @memberOf View
2117
- * @instance
2118
2090
  *
2119
2091
  * @example
2120
2092
  * View:
@@ -2144,9 +2116,6 @@ class WebContents extends base_1$k.EmitterBase {
2144
2116
  }
2145
2117
  /**
2146
2118
  * Stops any current navigation the WebContents is performing.
2147
- * @function stopNavigation
2148
- * @memberOf View
2149
- * @instance
2150
2119
  *
2151
2120
  * @example
2152
2121
  * View:
@@ -2174,9 +2143,6 @@ class WebContents extends base_1$k.EmitterBase {
2174
2143
  }
2175
2144
  /**
2176
2145
  * Reloads the WebContents
2177
- * @function reload
2178
- * @memberOf View
2179
- * @instance
2180
2146
  *
2181
2147
  * @example
2182
2148
  * View:
@@ -2220,9 +2186,6 @@ class WebContents extends base_1$k.EmitterBase {
2220
2186
  /**
2221
2187
  * Prints the WebContents.
2222
2188
  * @param options Printer Options
2223
- * @function print
2224
- * @memberOf View
2225
- * @instance
2226
2189
  *
2227
2190
  * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName
2228
2191
  * is empty and the default settings for printing.
@@ -2245,9 +2208,6 @@ class WebContents extends base_1$k.EmitterBase {
2245
2208
  * Find and highlight text on a page.
2246
2209
  * @param searchTerm Term to find in page
2247
2210
  * @param options Search options
2248
- * @function findInPage
2249
- * @memberOf View
2250
- * @instance
2251
2211
  *
2252
2212
  * @remarks By default, each subsequent call will highlight the next text that matches the search term.
2253
2213
  *
@@ -2334,9 +2294,6 @@ class WebContents extends base_1$k.EmitterBase {
2334
2294
  /**
2335
2295
  * Returns an array with all system printers
2336
2296
  * @deprecated use System.getPrinters instead
2337
- * @function getPrinters
2338
- * @memberOf View
2339
- * @instance
2340
2297
  *
2341
2298
  * @example
2342
2299
  * View:
@@ -2379,10 +2336,6 @@ class WebContents extends base_1$k.EmitterBase {
2379
2336
  /**
2380
2337
  * Gives focus to the WebContents.
2381
2338
  *
2382
- * @function focus
2383
- * @emits focused
2384
- * @memberOf Window
2385
- * @instance
2386
2339
  * @example
2387
2340
  * ```js
2388
2341
  * async function focusWindow() {
@@ -2404,9 +2357,6 @@ class WebContents extends base_1$k.EmitterBase {
2404
2357
  }
2405
2358
  /**
2406
2359
  * Shows the Chromium Developer Tools
2407
- * @function showDeveloperTools
2408
- * @memberOf View
2409
- * @instance
2410
2360
  *
2411
2361
  * @example
2412
2362
  * View:
@@ -2442,10 +2392,6 @@ class WebContents extends base_1$k.EmitterBase {
2442
2392
  *
2443
2393
  * @remarks This includes any iframes associated with the WebContents
2444
2394
  *
2445
- * @function getProcessInfo
2446
- * @memberOf View
2447
- * @instance
2448
- *
2449
2395
  * @example
2450
2396
  * View:
2451
2397
  * ```js
@@ -2465,9 +2411,6 @@ class WebContents extends base_1$k.EmitterBase {
2465
2411
  }
2466
2412
  /**
2467
2413
  * Retrieves information on all Shared Workers.
2468
- * @function getSharedWorkers
2469
- * @memberOf View
2470
- * @instance
2471
2414
  *
2472
2415
  * @example
2473
2416
  * View:
@@ -2502,9 +2445,6 @@ class WebContents extends base_1$k.EmitterBase {
2502
2445
  }
2503
2446
  /**
2504
2447
  * Opens the developer tools for the shared worker context.
2505
- * @function inspectSharedWorker
2506
- * @memberOf View
2507
- * @instance
2508
2448
  *
2509
2449
  * @example
2510
2450
  * View:
@@ -2540,9 +2480,6 @@ class WebContents extends base_1$k.EmitterBase {
2540
2480
  /**
2541
2481
  * Inspects the shared worker based on its ID.
2542
2482
  * @param workerId - The id of the shared worker.
2543
- * @function inspectSharedWorkerById
2544
- * @memberOf View
2545
- * @instance
2546
2483
  *
2547
2484
  * @example
2548
2485
  * View:
@@ -2579,9 +2516,6 @@ class WebContents extends base_1$k.EmitterBase {
2579
2516
  }
2580
2517
  /**
2581
2518
  * Opens the developer tools for the service worker context.
2582
- * @function inspectServiceWorker
2583
- * @memberOf View
2584
- * @instance
2585
2519
  *
2586
2520
  * @example
2587
2521
  * View:
@@ -2820,11 +2754,6 @@ class WebContents extends base_1$k.EmitterBase {
2820
2754
  * onPopupReady: popupWindowCallback;
2821
2755
  * });
2822
2756
  * ```
2823
- * @function showPopupWindow
2824
- * @memberOf View
2825
- * @instance
2826
- * @param options
2827
- *
2828
2757
  */
2829
2758
  async showPopupWindow(options) {
2830
2759
  this.wire.sendAction(`${this.entityType}-show-popup-window`, this.identity).catch(() => {
@@ -3401,7 +3330,6 @@ function requireInstance$2 () {
3401
3330
  };
3402
3331
  /**
3403
3332
  * Updates the view's options.
3404
- * @param options
3405
3333
  *
3406
3334
  * @example
3407
3335
  * ```js
@@ -3442,7 +3370,6 @@ function requireInstance$2 () {
3442
3370
  /**
3443
3371
  * Retrieves the window the view is currently attached to.
3444
3372
  *
3445
- * @experimental
3446
3373
  * @example
3447
3374
  * ```js
3448
3375
  * const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
@@ -3450,6 +3377,7 @@ function requireInstance$2 () {
3450
3377
  * .then(win => console.log('current window', win))
3451
3378
  * .catch(err => console.log(err));)
3452
3379
  * ```
3380
+ * @experimental
3453
3381
  */
3454
3382
  this.getCurrentWindow = async () => {
3455
3383
  const { payload: { data } } = await this.wire.sendAction('get-view-window', { ...this.identity });
@@ -3555,10 +3483,6 @@ function requireInstance$2 () {
3555
3483
  /**
3556
3484
  * Focuses the view
3557
3485
  *
3558
- * @function focus
3559
- * @memberof View
3560
- * @emits focused
3561
- * @instance
3562
3486
  * @example
3563
3487
  * ```js
3564
3488
  * const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
@@ -3602,12 +3526,12 @@ function requireView () {
3602
3526
  /**
3603
3527
  * Entry points for the OpenFin `View` API.
3604
3528
  *
3605
- * In the previous version of the API documentation, both static methods involving `View` and instance properties of the
3606
- * `View` type itself were documented on the same page. These are separate code entities, and are now documented separately:
3607
- *
3608
3529
  * * {@link ViewModule} contains static methods relating to the `View` type, accessible through `fin.View`.
3609
3530
  * * {@link View} describes an instance of an OpenFin View, e.g. as returned by `fin.View.getCurrent`.
3610
3531
  *
3532
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
3533
+ * both of these were documented on the same page.
3534
+ *
3611
3535
  * @packageDocumentation
3612
3536
  */
3613
3537
  __exportStar(requireFactory$3(), exports);
@@ -4457,7 +4381,6 @@ function requireFactory$2 () {
4457
4381
  class ApplicationModule extends base_1.Base {
4458
4382
  /**
4459
4383
  * Asynchronously returns an Application object that represents an existing application.
4460
- * @param identity
4461
4384
  *
4462
4385
  * @example
4463
4386
  *
@@ -4468,7 +4391,6 @@ function requireFactory$2 () {
4468
4391
  * .catch(err => console.log(err));
4469
4392
  * ```
4470
4393
  *
4471
- * @static
4472
4394
  */
4473
4395
  async wrap(identity) {
4474
4396
  this.wire.sendAction('wrap-application').catch((e) => {
@@ -4482,7 +4404,6 @@ function requireFactory$2 () {
4482
4404
  }
4483
4405
  /**
4484
4406
  * Synchronously returns an Application object that represents an existing application.
4485
- * @param identity
4486
4407
  *
4487
4408
  * @example
4488
4409
  *
@@ -4491,7 +4412,6 @@ function requireFactory$2 () {
4491
4412
  * await app.close();
4492
4413
  * ```
4493
4414
  *
4494
- * @static
4495
4415
  */
4496
4416
  wrapSync(identity) {
4497
4417
  this.wire.sendAction('wrap-application-sync').catch((e) => {
@@ -4516,8 +4436,6 @@ function requireFactory$2 () {
4516
4436
  }
4517
4437
  /**
4518
4438
  * DEPRECATED method to create a new Application. Use {@link Application.ApplicationModule.start Application.start} instead.
4519
- * @param appOptions
4520
- *
4521
4439
  *
4522
4440
  * @example
4523
4441
  *
@@ -4546,7 +4464,6 @@ function requireFactory$2 () {
4546
4464
  }
4547
4465
  /**
4548
4466
  * Creates and starts a new Application.
4549
- * @param appOptions
4550
4467
  *
4551
4468
  * @example
4552
4469
  *
@@ -4562,8 +4479,6 @@ function requireFactory$2 () {
4562
4479
  * start().then(() => console.log('Application is running')).catch(err => console.log(err));
4563
4480
  * ```
4564
4481
  *
4565
- *
4566
- * @static
4567
4482
  */
4568
4483
  async start(appOptions) {
4569
4484
  this.wire.sendAction('start-application').catch((e) => {
@@ -4576,10 +4491,8 @@ function requireFactory$2 () {
4576
4491
  /**
4577
4492
  * Asynchronously starts a batch of applications given an array of application identifiers and manifestUrls.
4578
4493
  * Returns once the RVM is finished attempting to launch the applications.
4579
- * @param applications
4580
4494
  * @param opts - Parameters that the RVM will use.
4581
4495
  *
4582
- * @static
4583
4496
  * @example
4584
4497
  *
4585
4498
  * ```js
@@ -4631,8 +4544,6 @@ function requireFactory$2 () {
4631
4544
  * });
4632
4545
  *
4633
4546
  * ```
4634
- *
4635
- * @static
4636
4547
  */
4637
4548
  getCurrent() {
4638
4549
  this.wire.sendAction('get-current-application').catch((e) => {
@@ -4658,8 +4569,6 @@ function requireFactory$2 () {
4658
4569
  * });
4659
4570
  *
4660
4571
  * ```
4661
- *
4662
- * @static
4663
4572
  */
4664
4573
  getCurrentSync() {
4665
4574
  this.wire.sendAction('get-current-application-sync').catch((e) => {
@@ -4680,8 +4589,6 @@ function requireFactory$2 () {
4680
4589
  * // For a local manifest file:
4681
4590
  * fin.Application.startFromManifest('file:///C:/somefolder/app.json').then(app => console.log('App is running')).catch(err => console.log(err));
4682
4591
  * ```
4683
- *
4684
- * @static
4685
4592
  */
4686
4593
  async startFromManifest(manifestUrl, opts) {
4687
4594
  this.wire.sendAction('application-start-from-manifest').catch((e) => {
@@ -4754,12 +4661,12 @@ function requireApplication () {
4754
4661
  /**
4755
4662
  * Entry points for the OpenFin `Application` API.
4756
4663
  *
4757
- * In the previous version of the API documentation, both static methods involving `Application` and instance properties of the
4758
- * `Application` type itself were documented on the same page. These are separate code entities, and are now documented separately:
4759
- *
4760
4664
  * * {@link ApplicationModule} contains static methods relating to the `Application` type, accessible through `fin.Application`.
4761
4665
  * * {@link Application} describes an instance of an OpenFin Application, e.g. as returned by `fin.Application.getCurrent`.
4762
4666
  *
4667
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
4668
+ * both of these were documented on the same page.
4669
+ *
4763
4670
  * @packageDocumentation
4764
4671
  */
4765
4672
  __exportStar(requireFactory$2(), exports);
@@ -6643,7 +6550,6 @@ function requireFactory$1 () {
6643
6550
  class _WindowModule extends base_1.Base {
6644
6551
  /**
6645
6552
  * Asynchronously returns a Window object that represents an existing window.
6646
- * @param identity
6647
6553
  *
6648
6554
  * @example
6649
6555
  * ```js
@@ -6660,7 +6566,6 @@ function requireFactory$1 () {
6660
6566
  * .then(win => console.log('wrapped window'))
6661
6567
  * .catch(err => console.log(err));
6662
6568
  * ```
6663
- * @static
6664
6569
  */
6665
6570
  async wrap(identity) {
6666
6571
  this.wire.sendAction('window-wrap').catch((e) => {
@@ -6674,7 +6579,6 @@ function requireFactory$1 () {
6674
6579
  }
6675
6580
  /**
6676
6581
  * Synchronously returns a Window object that represents an existing window.
6677
- * @param identity
6678
6582
  *
6679
6583
  * @example
6680
6584
  * ```js
@@ -6690,7 +6594,6 @@ function requireFactory$1 () {
6690
6594
  * await createWin();
6691
6595
  * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
6692
6596
  * ```
6693
- * @static
6694
6597
  */
6695
6598
  wrapSync(identity) {
6696
6599
  this.wire.sendAction('window-wrap-sync').catch((e) => {
@@ -6722,7 +6625,6 @@ function requireFactory$1 () {
6722
6625
  *
6723
6626
  * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
6724
6627
  * ```
6725
- * @static
6726
6628
  */
6727
6629
  create(options) {
6728
6630
  this.wire.sendAction('create-window').catch((e) => {
@@ -6741,7 +6643,6 @@ function requireFactory$1 () {
6741
6643
  * .catch(err => console.log(err));
6742
6644
  *
6743
6645
  * ```
6744
- * @static
6745
6646
  */
6746
6647
  getCurrent() {
6747
6648
  this.wire.sendAction('get-current-window').catch((e) => {
@@ -6763,7 +6664,6 @@ function requireFactory$1 () {
6763
6664
  * console.log(info);
6764
6665
  *
6765
6666
  * ```
6766
- * @static
6767
6667
  */
6768
6668
  getCurrentSync() {
6769
6669
  this.wire.sendAction('get-current-window-sync').catch((e) => {
@@ -6804,12 +6704,12 @@ function requireWindow () {
6804
6704
  /**
6805
6705
  * Entry points for the OpenFin `Window` API.
6806
6706
  *
6807
- * In the previous version of the API documentation, both static methods involving `Window` and instance properties of the
6808
- * `Window` type itself were documented on the same page. These are separate code entities, and are now documented separately:
6809
- *
6810
6707
  * * {@link _WindowModule} contains static methods relating to the `Window` type, accessible through `fin.Window`.
6811
6708
  * * {@link _Window} describes an instance of an OpenFin Window, e.g. as returned by `fin.Window.getCurrent`.
6812
6709
  *
6710
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
6711
+ * both of these were documented on the same page.
6712
+ *
6813
6713
  * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
6814
6714
  *
6815
6715
  * @packageDocumentation
@@ -7137,7 +7037,6 @@ class System extends base_1$j.EmitterBase {
7137
7037
  * ```js
7138
7038
  * fin.System.getUniqueUserId().then(id => console.log(id)).catch(err => console.log(err));
7139
7039
  * ```
7140
- * @static
7141
7040
  */
7142
7041
  getUniqueUserId() {
7143
7042
  return this.wire.sendAction('get-unique-user-id').then(({ payload }) => payload.data);
@@ -8408,7 +8307,6 @@ class System extends base_1$j.EmitterBase {
8408
8307
  * }
8409
8308
  * });
8410
8309
  * ```
8411
- * @static
8412
8310
  */
8413
8311
  async launchManifest(manifestUrl, opts = {}) {
8414
8312
  const { subscribe, ..._sendOpts } = opts;
@@ -11415,7 +11313,6 @@ class ExternalApplicationModule extends base_1$b.Base {
11415
11313
  * .then(extApp => console.log('wrapped external application'))
11416
11314
  * .catch(err => console.log(err));
11417
11315
  * ```
11418
- * @static
11419
11316
  */
11420
11317
  wrap(uuid) {
11421
11318
  this.wire.sendAction('external-application-wrap').catch((e) => {
@@ -11435,7 +11332,6 @@ class ExternalApplicationModule extends base_1$b.Base {
11435
11332
  * const info = await extApp.getInfo();
11436
11333
  * console.log(info);
11437
11334
  * ```
11438
- * @static
11439
11335
  */
11440
11336
  wrapSync(uuid) {
11441
11337
  this.wire.sendAction('external-application-wrap-sync').catch((e) => {
@@ -11465,12 +11361,12 @@ Factory$5.ExternalApplicationModule = ExternalApplicationModule;
11465
11361
  /**
11466
11362
  * Entry points for the OpenFin `ExternalApplication` API.
11467
11363
  *
11468
- * In the previous version of the API documentation, both static methods involving `ExternalApplication` and instance properties of the
11469
- * `ExternalApplication` type itself were documented on the same page. These are separate code entities, and are now documented separately:
11470
- *
11471
11364
  * * {@link ExternalApplicationModule} contains static methods relating to the `ExternalApplication` type, accessible through `fin.ExternalApplication`.
11472
11365
  * * {@link ExternalApplication} describes an instance of an OpenFin ExternalApplication, e.g. as returned by `fin.ExternalApplication.getCurrent`.
11473
11366
  *
11367
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
11368
+ * both of these were documented on the same page.
11369
+ *
11474
11370
  * @packageDocumentation
11475
11371
  */
11476
11372
  __exportStar(Factory$5, exports);
@@ -11642,7 +11538,6 @@ class _FrameModule extends base_1$9.Base {
11642
11538
  * .then(frm => console.log('wrapped frame'))
11643
11539
  * .catch(err => console.log(err));
11644
11540
  * ```
11645
- * @static
11646
11541
  */
11647
11542
  async wrap(identity) {
11648
11543
  this.wire.sendAction('frame-wrap').catch((e) => {
@@ -11664,7 +11559,6 @@ class _FrameModule extends base_1$9.Base {
11664
11559
  * const info = await frm.getInfo();
11665
11560
  * console.log(info);
11666
11561
  * ```
11667
- * @static
11668
11562
  */
11669
11563
  wrapSync(identity) {
11670
11564
  this.wire.sendAction('frame-wrap-sync').catch((e) => {
@@ -11685,7 +11579,6 @@ class _FrameModule extends base_1$9.Base {
11685
11579
  * .then(frm => console.log('current frame'))
11686
11580
  * .catch(err => console.log(err));
11687
11581
  * ```
11688
- * @static
11689
11582
  */
11690
11583
  getCurrent() {
11691
11584
  this.wire.sendAction('frame-get-current').catch((e) => {
@@ -11702,7 +11595,6 @@ class _FrameModule extends base_1$9.Base {
11702
11595
  * const info = await frm.getInfo();
11703
11596
  * console.log(info);
11704
11597
  * ```
11705
- * @static
11706
11598
  */
11707
11599
  getCurrentSync() {
11708
11600
  this.wire.sendAction('frame-get-current-sync').catch((e) => {
@@ -11717,12 +11609,12 @@ Factory$4._FrameModule = _FrameModule;
11717
11609
  /**
11718
11610
  * Entry points for the OpenFin `Frame` API.
11719
11611
  *
11720
- * In the previous version of the API documentation, both static methods involving `Frame` and instance properties of the
11721
- * `Frame` type itself were documented on the same page. These are separate code entities, and are now documented separately:
11722
- *
11723
11612
  * * {@link _FrameModule} contains static methods relating to the `Frame` type, accessible through `fin.Frame`.
11724
11613
  * * {@link _Frame} describes an instance of an OpenFin Frame, e.g. as returned by `fin.Frame.getCurrent`.
11725
11614
  *
11615
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
11616
+ * both of these were documented on the same page.
11617
+ *
11726
11618
  * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
11727
11619
  *
11728
11620
  * @packageDocumentation
@@ -13031,7 +12923,6 @@ class LayoutModule extends base_1$5.Base {
13031
12923
  * // the window must have been created with a layout in its window options
13032
12924
  * const layout = await fin.Platform.Layout.init({ containerId });
13033
12925
  * ```
13034
- * @static
13035
12926
  */
13036
12927
  this.init = async (options = {}) => {
13037
12928
  this.wire.sendAction('layout-init').catch((e) => {
@@ -13049,7 +12940,6 @@ class LayoutModule extends base_1$5.Base {
13049
12940
  }
13050
12941
  /**
13051
12942
  * Asynchronously returns a Layout object that represents a Window's layout.
13052
- * @param identity
13053
12943
  *
13054
12944
  * @example
13055
12945
  * ```js
@@ -13066,9 +12956,7 @@ class LayoutModule extends base_1$5.Base {
13066
12956
  * // Use wrapped instance to control layout, e.g.:
13067
12957
  * const layoutConfig = await layout.getConfig();
13068
12958
  * ```
13069
- * @static
13070
12959
  */
13071
- // eslint-disable-next-line class-methods-use-this
13072
12960
  async wrap(identity) {
13073
12961
  this.wire.sendAction('layout-wrap').catch((e) => {
13074
12962
  // don't expose
@@ -13077,7 +12965,6 @@ class LayoutModule extends base_1$5.Base {
13077
12965
  }
13078
12966
  /**
13079
12967
  * Synchronously returns a Layout object that represents a Window's layout.
13080
- * @param identity
13081
12968
  *
13082
12969
  * @example
13083
12970
  * ```js
@@ -13094,9 +12981,7 @@ class LayoutModule extends base_1$5.Base {
13094
12981
  * // Use wrapped instance to control layout, e.g.:
13095
12982
  * const layoutConfig = await layout.getConfig();
13096
12983
  * ```
13097
- * @static
13098
12984
  */
13099
- // eslint-disable-next-line class-methods-use-this
13100
12985
  wrapSync(identity) {
13101
12986
  this.wire.sendAction('layout-wrap-sync').catch((e) => {
13102
12987
  // don't expose
@@ -13112,7 +12997,6 @@ class LayoutModule extends base_1$5.Base {
13112
12997
  * // Use wrapped instance to control layout, e.g.:
13113
12998
  * const layoutConfig = await layout.getConfig();
13114
12999
  * ```
13115
- * @static
13116
13000
  */
13117
13001
  async getCurrent() {
13118
13002
  this.wire.sendAction('layout-get-current').catch((e) => {
@@ -13136,7 +13020,6 @@ class LayoutModule extends base_1$5.Base {
13136
13020
  * // Use wrapped instance to control layout, e.g.:
13137
13021
  * const layoutConfig = await layout.getConfig();
13138
13022
  * ```
13139
- * @static
13140
13023
  */
13141
13024
  getCurrentSync() {
13142
13025
  this.wire.sendAction('layout-get-current-sync').catch((e) => {
@@ -13154,11 +13037,13 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap();
13154
13037
 
13155
13038
  (function (exports) {
13156
13039
  /**
13157
- * Entry point for the OpenFin Layout namespace.
13040
+ * Entry point for the OpenFin `Layout` namespace.
13158
13041
  *
13159
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "LayoutModule" is used for
13160
- * the module containing static members of the `Layout` namespace (available under `fin.Platform.Layout`), while `Layout` documents
13161
- * instances of the OpenFin `Layout` class.
13042
+ * * {@link LayoutModule} contains static methods relating to the `Layout` type, accessible through `fin.Platform.Layout`.
13043
+ * * {@link Layout} describes an instance of an OpenFin Layout, e.g. as returned by `fin.Platform.Layout.getCurrent`.
13044
+ *
13045
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
13046
+ * both of these were documented on the same page.
13162
13047
  *
13163
13048
  * @packageDocumentation
13164
13049
  *
@@ -13377,14 +13262,12 @@ class PlatformModule extends base_1$4.Base {
13377
13262
  * fin.Platform.init({overrideCallback});
13378
13263
  * ```
13379
13264
  * @experimental
13380
- * @static
13381
13265
  */
13382
13266
  async init(options) {
13383
13267
  return this.wire.environment.initPlatform(this.fin, options);
13384
13268
  }
13385
13269
  /**
13386
13270
  * Asynchronously returns a Platform object that represents an existing platform.
13387
- * @param identity
13388
13271
  *
13389
13272
  * @example
13390
13273
  * ```js
@@ -13393,7 +13276,6 @@ class PlatformModule extends base_1$4.Base {
13393
13276
  * // Use wrapped instance to control layout, e.g.:
13394
13277
  * const snapshot = await platform.getSnapshot();
13395
13278
  * ```
13396
- * @static
13397
13279
  */
13398
13280
  async wrap(identity) {
13399
13281
  this.wire.sendAction('platform-wrap').catch((e) => {
@@ -13403,7 +13285,6 @@ class PlatformModule extends base_1$4.Base {
13403
13285
  }
13404
13286
  /**
13405
13287
  * Synchronously returns a Platform object that represents an existing platform.
13406
- * @param identity
13407
13288
  *
13408
13289
  * @example
13409
13290
  * ```js
@@ -13412,7 +13293,6 @@ class PlatformModule extends base_1$4.Base {
13412
13293
  * // Use wrapped instance to control layout, e.g.:
13413
13294
  * const snapshot = await platform.getSnapshot();
13414
13295
  * ```
13415
- * @static
13416
13296
  */
13417
13297
  wrapSync(identity) {
13418
13298
  this.wire.sendAction('platform-wrap-sync').catch((e) => {
@@ -13429,7 +13309,6 @@ class PlatformModule extends base_1$4.Base {
13429
13309
  * // Use wrapped instance to control layout, e.g.:
13430
13310
  * const snapshot = await platform.getSnapshot();
13431
13311
  * ```
13432
- * @static
13433
13312
  */
13434
13313
  async getCurrent() {
13435
13314
  this.wire.sendAction('platform-get-current').catch((e) => {
@@ -13446,7 +13325,6 @@ class PlatformModule extends base_1$4.Base {
13446
13325
  * // Use wrapped instance to control layout, e.g.:
13447
13326
  * const snapshot = await platform.getSnapshot();
13448
13327
  * ```
13449
- * @static
13450
13328
  */
13451
13329
  getCurrentSync() {
13452
13330
  this.wire.sendAction('platform-get-current-sync').catch((e) => {
@@ -13457,7 +13335,6 @@ class PlatformModule extends base_1$4.Base {
13457
13335
  /**
13458
13336
  * Creates and starts a Platform and returns a wrapped and running Platform instance. The wrapped Platform methods can
13459
13337
  * be used to launch content into the platform. Promise will reject if the platform is already running.
13460
- * @param platformOptions
13461
13338
  *
13462
13339
  * @example
13463
13340
  * ```js
@@ -13478,7 +13355,6 @@ class PlatformModule extends base_1$4.Base {
13478
13355
  * console.error(e);
13479
13356
  * }
13480
13357
  * ```
13481
- * @static
13482
13358
  */
13483
13359
  start(platformOptions) {
13484
13360
  this.wire.sendAction('platform-start').catch((e) => {
@@ -13523,7 +13399,6 @@ class PlatformModule extends base_1$4.Base {
13523
13399
  * console.error(e);
13524
13400
  * }
13525
13401
  * ```
13526
- * @static
13527
13402
  */
13528
13403
  startFromManifest(manifestUrl, opts) {
13529
13404
  this.wire.sendAction('platform-start-from-manifest').catch((e) => {
@@ -13567,12 +13442,12 @@ Factory$3.PlatformModule = PlatformModule;
13567
13442
  /**
13568
13443
  * Entry points for the OpenFin `Platform` API.
13569
13444
  *
13570
- * In the previous version of the API documentation, both static methods involving `Platform` and instance properties of the
13571
- * `Platform` type itself were documented on the same page. These are separate code entities, and are now documented separately:
13572
- *
13573
13445
  * * {@link PlatformModule} contains static methods relating to the `Platform` type, accessible through `fin.Platform`.
13574
13446
  * * {@link Platform} describes an instance of an OpenFin Platform, e.g. as returned by `fin.Platform.getCurrent`.
13575
13447
  *
13448
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
13449
+ * both of these were documented on the same page.
13450
+ *
13576
13451
  * @packageDocumentation
13577
13452
  */
13578
13453
  __exportStar(Factory$3, exports);
@@ -14823,7 +14698,8 @@ function requireInteropBroker () {
14823
14698
  * ```
14824
14699
  */
14825
14700
  // eslint-disable-next-line class-methods-use-this
14826
- async handleFiredIntent(intent, clientIdentity) {
14701
+ async handleFiredIntent(intent, clientIdentity // TODO(CORE-811): remove inline intersected type
14702
+ ) {
14827
14703
  const warning = (0, utils_1.generateOverrideWarning)('fdc3.raiseIntent', 'InteropBroker.handleFiredIntent', clientIdentity, 'interopClient.fireIntent');
14828
14704
  console.warn(warning);
14829
14705
  throw new Error(utils_1.BROKER_ERRORS.fireIntent);
@@ -14890,7 +14766,7 @@ function requireInteropBroker () {
14890
14766
  * More information on the AppIntent type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/AppIntent).
14891
14767
  *
14892
14768
  * @param options
14893
- * @param clientIdentity Identity of the Client making the request.
14769
+ * @param clientIdentity Identity of the Client making the request.
14894
14770
  *
14895
14771
  * @example
14896
14772
  * ```js
@@ -14907,7 +14783,8 @@ function requireInteropBroker () {
14907
14783
  * ```
14908
14784
  */
14909
14785
  // eslint-disable-next-line class-methods-use-this
14910
- async handleInfoForIntent(options, clientIdentity) {
14786
+ async handleInfoForIntent(options, clientIdentity // TODO(CORE-811): remove inline intersected type
14787
+ ) {
14911
14788
  const warning = (0, utils_1.generateOverrideWarning)('fdc3.findIntent', 'InteropBroker.handleInfoForIntent', clientIdentity, 'interopClient.getInfoForIntent');
14912
14789
  console.warn(warning);
14913
14790
  throw new Error(utils_1.BROKER_ERRORS.getInfoForIntent);
@@ -14953,7 +14830,8 @@ function requireInteropBroker () {
14953
14830
  * ```
14954
14831
  */
14955
14832
  // eslint-disable-next-line class-methods-use-this
14956
- async handleInfoForIntentsByContext(context, clientIdentity) {
14833
+ async handleInfoForIntentsByContext(context, clientIdentity // TODO(CORE-811): remove inline intersected type
14834
+ ) {
14957
14835
  const warning = (0, utils_1.generateOverrideWarning)('fdc3.findIntentsByContext', 'InteropBroker.handleInfoForIntentsByContext', clientIdentity, 'interopClient.getInfoForIntentsByContext');
14958
14836
  console.warn(warning);
14959
14837
  throw new Error(utils_1.BROKER_ERRORS.getInfoForIntentsByContext);
@@ -14979,7 +14857,7 @@ function requireInteropBroker () {
14979
14857
  * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
14980
14858
  *
14981
14859
  * @param contextForIntent Data passed between entities and applications.
14982
- * @param clientIdentity Identity of the Client making the request.
14860
+ * @param clientIdentity Identity of the Client making the request.
14983
14861
  *
14984
14862
  * @example
14985
14863
  * ```js
@@ -15040,7 +14918,7 @@ function requireInteropBroker () {
15040
14918
  /**
15041
14919
  * Responsible for resolving the fdc3.findInstances call.
15042
14920
  * Must be overridden
15043
- * @param app AppIdentifier that was passed to fdc3.findInstances
14921
+ * @param app AppIdentifier that was passed to fdc3.findInstances
15044
14922
  * @param clientIdentity Identity of the Client making the request.
15045
14923
  */
15046
14924
  // eslint-disable-next-line class-methods-use-this
@@ -15075,7 +14953,7 @@ function requireInteropBroker () {
15075
14953
  * fin.Platform.init({
15076
14954
  * interopOverride: async (InteropBroker) => {
15077
14955
  * class Override extends InteropBroker {
15078
- * async invokeContextHandler(options, clientIdentity) {
14956
+ * async invokeContextHandler(clientIdentity, handlerId, context) {
15079
14957
  * return super.invokeContextHandler(clientIdentity, handlerId, {
15080
14958
  * ...context,
15081
14959
  * contextMetadata: {
@@ -15115,7 +14993,7 @@ function requireInteropBroker () {
15115
14993
  * fin.Platform.init({
15116
14994
  * interopOverride: async (InteropBroker) => {
15117
14995
  * class Override extends InteropBroker {
15118
- * async invokeIntentHandler(options, clientIdentity) {
14996
+ * async invokeIntentHandler(clientIdentity, handlerId, context) {
15119
14997
  * const { context } = intent;
15120
14998
  * return super.invokeIntentHandler(clientIdentity, handlerId, {
15121
14999
  * ...intent,
@@ -15454,7 +15332,8 @@ function requireInteropBroker () {
15454
15332
  }
15455
15333
  // Setup Channel Connection Logic
15456
15334
  wireChannel(channel) {
15457
- channel.onConnection(async (clientIdentity, payload) => {
15335
+ channel.onConnection(async (clientIdentity, // TODO(CORE-811): remove inline intersected type
15336
+ payload) => {
15458
15337
  if (!(await this.isConnectionAuthorized(clientIdentity, payload))) {
15459
15338
  throw new Error(`Connection not authorized for ${clientIdentity.uuid}, ${clientIdentity.name}`);
15460
15339
  }
@@ -16418,7 +16297,6 @@ function requireFactory () {
16418
16297
  * const contextGroups = await interopBroker.getContextGroups();
16419
16298
  * console.log(contextGroups);
16420
16299
  * ```
16421
- * @static
16422
16300
  */
16423
16301
  async init(name, override = defaultOverride) {
16424
16302
  var _a;
@@ -16476,7 +16354,6 @@ function requireFactory () {
16476
16354
  * const contextGroupInfo = await client.getInfoForContextGroup();
16477
16355
  * console.log(contextGroupInfo);
16478
16356
  * ```
16479
- * @static
16480
16357
  */
16481
16358
  connectSync(name, interopConfig) {
16482
16359
  this.wire.sendAction('interop-connect-sync').catch(() => {
@@ -16701,7 +16578,6 @@ const utils_1 = utils;
16701
16578
  class SnapshotSourceModule extends base_1.Base {
16702
16579
  /**
16703
16580
  * Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
16704
- * @param provider
16705
16581
  *
16706
16582
  * @example
16707
16583
  * ```js
@@ -16718,7 +16594,6 @@ class SnapshotSourceModule extends base_1.Base {
16718
16594
  *
16719
16595
  * await fin.SnapshotSource.init(snapshotProvider);
16720
16596
  * ```
16721
- * @static
16722
16597
  */
16723
16598
  async init(provider) {
16724
16599
  this.wire.sendAction('snapshot-source-init').catch((e) => {
@@ -16738,7 +16613,6 @@ class SnapshotSourceModule extends base_1.Base {
16738
16613
  }
16739
16614
  /**
16740
16615
  * Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
16741
- * @param identity
16742
16616
  *
16743
16617
  * @example
16744
16618
  * ```js
@@ -16746,7 +16620,6 @@ class SnapshotSourceModule extends base_1.Base {
16746
16620
  * // Use wrapped instance's getSnapshot method, e.g.:
16747
16621
  * const snapshot = await snapshotSource.getSnapshot();
16748
16622
  * ```
16749
- * @static
16750
16623
  */
16751
16624
  wrapSync(identity) {
16752
16625
  this.wire.sendAction('snapshot-source-wrap-sync').catch((e) => {
@@ -16756,7 +16629,6 @@ class SnapshotSourceModule extends base_1.Base {
16756
16629
  }
16757
16630
  /**
16758
16631
  * Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.
16759
- * @param identity
16760
16632
  *
16761
16633
  * @example
16762
16634
  * ```js
@@ -16764,7 +16636,6 @@ class SnapshotSourceModule extends base_1.Base {
16764
16636
  * // Use wrapped instance's getSnapshot method, e.g.:
16765
16637
  * const snapshot = await snapshotSource.getSnapshot();
16766
16638
  * ```
16767
- * @static
16768
16639
  */
16769
16640
  async wrap(identity) {
16770
16641
  this.wire.sendAction('snapshot-source-wrap').catch((e) => {
@@ -16779,12 +16650,12 @@ Factory.SnapshotSourceModule = SnapshotSourceModule;
16779
16650
  /**
16780
16651
  * Entry points for the OpenFin `SnapshotSource` API.
16781
16652
  *
16782
- * In the previous version of the API documentation, both static methods involving `SnapshotSource` and instance properties of the
16783
- * `SnapshotSource` type itself were documented on the same page. These are separate code entities, and are now documented separately:
16784
- *
16785
16653
  * * {@link SnapshotSourceModule} contains static methods relating to the `SnapshotSource` type, accessible through `fin.SnapshotSource`.
16786
16654
  * * {@link SnapshotSource} describes an instance of an OpenFin SnapshotSource, e.g. as returned by `fin.SnapshotSource.getCurrent`.
16787
16655
  *
16656
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
16657
+ * both of these were documented on the same page.
16658
+ *
16788
16659
  * @packageDocumentation
16789
16660
  */
16790
16661
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {