@openfin/core 35.78.15 → 35.78.17

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
@@ -2623,169 +2623,6 @@ function requireInstance$2 () {
2623
2623
  const layout_constants_1 = layout_constants;
2624
2624
  const main_1 = main;
2625
2625
  const window_1 = requireWindow();
2626
- /**
2627
- * @PORTED
2628
- * @typedef {object} View~options
2629
- * @summary View creation options.
2630
- * @desc This is the options object required by {@link View.create View.create}.
2631
- *
2632
- * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
2633
- * (defaults to `"about:blank"` when omitted).
2634
- *
2635
- * @property {object} [experimental]
2636
- * Configurations for API injection.
2637
- *
2638
- * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
2639
- *
2640
- * @property {object} [accelerator]
2641
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
2642
- *
2643
- * @property {boolean} [accelerator.devtools=false]
2644
- * If `true`, enables the devtools keyboard shortcut:<br>
2645
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
2646
- *
2647
- * @property {boolean} [accelerator.reload=false]
2648
- * If `true`, enables the reload keyboard shortcuts:<br>
2649
- * `Ctrl` + `R` _(Windows)_<br>
2650
- * `F5` _(Windows)_<br>
2651
- * `Command` + `R` _(Mac)_
2652
- *
2653
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
2654
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
2655
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
2656
- * `Shift` + `F5` _(Windows)_<br>
2657
- * `Command` + `Shift` + `R` _(Mac)_
2658
- *
2659
- * @property {boolean} [accelerator.zoom=false]
2660
- * If `true`, enables the zoom keyboard shortcuts:<br>
2661
- * `Ctrl` + `+` _(Zoom In)_<br>
2662
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
2663
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
2664
- * `Ctrl` + `-` _(Zoom Out)_<br>
2665
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
2666
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
2667
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
2668
- * `Ctrl` + `0` _(Restore to 100%)_
2669
- *
2670
- * @property {object} [api]
2671
- * Configurations for API injection.
2672
- *
2673
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
2674
- *
2675
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
2676
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
2677
- *
2678
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
2679
- * Autoplay policy to apply to content in the window, can be
2680
- * `no-user-gesture-required`, `user-gesture-required`,
2681
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
2682
- *
2683
- * @property {object} [autoResize] AutoResize options
2684
- *
2685
- * @property {object} [bounds] initial bounds given relative to the window.
2686
- *
2687
- * @property {string} [backgroundColor="#FFF"] - _Updatable._
2688
- * The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
2689
- * (`document.body.style.backgroundColor`),
2690
- * this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
2691
- * areas when growing a window. Setting
2692
- * this value to the anticipated content background color can help improve user experience.
2693
- * Default is white.
2694
- *
2695
- * @property {object} [contentNavigation]
2696
- * Restrict navigation to URLs that match an allowed pattern.
2697
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
2698
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
2699
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
2700
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
2701
- *
2702
- * @property {object} [contentRedirect]
2703
- * Restrict redirects to URLs that match an allowed pattern.
2704
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
2705
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
2706
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
2707
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
2708
- *
2709
- * @property {object} [contextMenuSettings] - _Updatable._
2710
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
2711
- * Configure the context menu when right-clicking on a view.
2712
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
2713
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
2714
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
2715
- *
2716
- * @property {object} [contextMenuOptions] - _Updatable._
2717
- * Configure the context menu when right-clicking on a view. Supported menu items:
2718
- * 'separator'
2719
- * 'cut'
2720
- * 'copy'
2721
- * 'copyImage',
2722
- * 'paste'
2723
- * 'spellCheck'
2724
- * 'inspect'
2725
- * 'reload'
2726
- * 'navigateForward'
2727
- * 'navigateBack'
2728
- * 'print'
2729
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
2730
- * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
2731
- *
2732
- * @property {any} [customData=""] - _Updatable._
2733
- * A field that the user can attach serializable data to be ferried around with the view options.
2734
- * _When omitted, the default value of this property is the empty string (`""`)._
2735
- *
2736
- * @property {any} [customContext=""] - _Updatable._
2737
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
2738
- * is called.
2739
- * When omitted, the default value of this property is the empty string (`""`).
2740
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
2741
- *
2742
- * @property {object[]} [hotkeys=[]] - _Updatable._
2743
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
2744
- * Within Platform, OpenFin also implements a set of pre-defined actions called
2745
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
2746
- * that can be assigned to a specific hotkey in the platform manifest.
2747
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
2748
- * @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
2749
- *
2750
- * @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
2751
- * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
2752
- * if the view isn't part of the new layout when running `Layout.replace`.
2753
- *
2754
- * @property {string} name
2755
- * The name of the view.
2756
- *
2757
- * @property {boolean} [detachOnClose=false] - _Updatable._
2758
- * Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
2759
- * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
2760
- *
2761
- * @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
2762
- * but the properties in the manifest will take precedence if there is any collision.
2763
- *
2764
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
2765
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
2766
- * from the parent application.
2767
- *
2768
- * @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
2769
- *
2770
- * @property {string} [processAffinity=<application uuid>]
2771
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
2772
- *
2773
- * @property {boolean} [spellCheck=false]
2774
- * Enable spell check in input text fields for the view.
2775
- *
2776
- * @property {Identity} [target]
2777
- * The identity of the window this view should be attached to.
2778
- *
2779
- * @property {string} [url="about:blank"]
2780
- * The URL of the view.
2781
- *
2782
- * @property {string} [uuid=<application uuid>]
2783
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
2784
- * If omitted, defaults to the `uuid` of the application spawning the view.
2785
- * If given, must match the `uuid` of the application spawning the view.
2786
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
2787
- * really no need to provide it.
2788
- */
2789
2626
  /**
2790
2627
  * A View can be used to embed additional web content into a Window.
2791
2628
  * It is like a child window, except it is positioned relative to its owning window.
@@ -3409,100 +3246,6 @@ function requireInstance$1 () {
3409
3246
  });
3410
3247
  return windowList;
3411
3248
  }
3412
- /**
3413
- * Adds a listener to the end of the listeners array for the specified event.
3414
- * @param eventType - The type of the event.
3415
- * @param listener - Called whenever an event of the specified type occurs.
3416
- * @param options - Option to support event timestamps.
3417
- *
3418
- * @function addListener
3419
- * @memberof Application
3420
- * @instance
3421
- * @tutorial Application.EventEmitter
3422
- */
3423
- /**
3424
- * Adds a listener to the end of the listeners array for the specified event.
3425
- * @param eventType - The type of the event.
3426
- * @param listener - Called whenever an event of the specified type occurs.
3427
- * @param options - Option to support event timestamps.
3428
- *
3429
- * @function on
3430
- * @memberof Application
3431
- * @instance
3432
- * @tutorial Application.EventEmitter
3433
- */
3434
- /**
3435
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
3436
- * @param eventType - The type of the event.
3437
- * @param listener - The callback function.
3438
- * @param options - Option to support event timestamps.
3439
- *
3440
- * @function once
3441
- * @memberof Application
3442
- * @instance
3443
- * @tutorial Application.EventEmitter
3444
- */
3445
- /**
3446
- * Adds a listener to the beginning of the listeners array for the specified event.
3447
- * @param eventType - The type of the event.
3448
- * @param listener - The callback function.
3449
- * @param options - Option to support event timestamps.
3450
- *
3451
- * @function prependListener
3452
- * @memberof Application
3453
- * @instance
3454
- * @tutorial Application.EventEmitter
3455
- */
3456
- /**
3457
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
3458
- * The listener is added to the beginning of the listeners array.
3459
- * @param eventType - The type of the event.
3460
- * @param listener - The callback function.
3461
- * @param options - Option to support event timestamps.
3462
- *
3463
- * @function prependOnceListener
3464
- * @memberof Application
3465
- * @instance
3466
- * @tutorial Application.EventEmitter
3467
- */
3468
- /**
3469
- * Remove a listener from the listener array for the specified event.
3470
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
3471
- * @param eventType - The type of the event.
3472
- * @param listener - The callback function.
3473
- * @param options - Option to support event timestamps.
3474
- *
3475
- * @function removeListener
3476
- * @memberof Application
3477
- * @instance
3478
- * @tutorial Application.EventEmitter
3479
- */
3480
- /**
3481
- * Removes all listeners, or those of the specified event.
3482
- * @param eventType - The type of the event.
3483
- *
3484
- * @function removeAllListeners
3485
- * @memberof Application
3486
- * @instance
3487
- * @tutorial Application.EventEmitter
3488
- */
3489
- /**
3490
- * JumpListCategory interface
3491
- * @typedef { object } JumpListCategory
3492
- * @property { string } name The display title for the category. If omitted, items in this category will be placed into the standard 'Tasks' category. There can be only one such category, and it will always be displayed at the bottom of the JumpList.
3493
- * @property { JumpListItem[] } items Array of JumpListItem objects
3494
- */
3495
- /**
3496
- * @PORTED
3497
- * JumpListItem interface
3498
- * @typedef { object } JumpListItem
3499
- * @property { string } type One of the following: "task" or "separator". Defaults to task.
3500
- * @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
3501
- * @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
3502
- * @property { string } deepLink Deep link to a manifest, i.e: fins://path.to/manifest.json?$$param1=value1. See {@link https://developers.openfin.co/docs/deep-linking deep-linking} for more information.
3503
- * @property { string } iconPath The absolute path to an icon to be displayed for the item, which can be an arbitrary resource file that contains an icon (e.g. .ico, .exe, .dll).
3504
- * @property { number } iconIndex The index of the icon in the resource file. If a resource file contains multiple icons this value can be used to specify the zero-based index of the icon that should be displayed for this task. If a resource file contains only one icon, this property should be set to zero.
3505
- */
3506
3249
  /**
3507
3250
  * Determines if the application is currently running.
3508
3251
  *
@@ -4528,476 +4271,6 @@ function requireInstance () {
4528
4271
  const main_1 = main;
4529
4272
  const view_1 = requireView();
4530
4273
  const warnings_1 = warnings;
4531
- /**
4532
- * @PORTED
4533
- * @typedef { object } Margins
4534
- * @property { string } [marginType]
4535
- * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
4536
- * you will also need to specify `top`, `bottom`, `left`, and `right`.
4537
- *
4538
- * @property { number } [top] The top margin of the printed web page, in pixels.
4539
- * @property { number } [bottom] The bottom margin of the printed web page, in pixels.
4540
- * @property { number } [left] The left margin of the printed web page, in pixels.
4541
- * @property { number } [right] The right margin of the printed web page, in pixels.
4542
- */
4543
- /**
4544
- * @PORTED
4545
- * @typedef { object } Dpi
4546
- * @property { number } [horizontal] The horizontal dpi
4547
- * @property { number } [vertical] The vertical dpi
4548
- */
4549
- /**
4550
- * @PORTED
4551
- * @typedef { object } PrintOptions
4552
- * @property { boolean } [silent=false] Don't ask user for print settings.
4553
- * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
4554
- * @property { string } [deviceName=''] Set the printer device name to use.
4555
- * @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
4556
- * @property { Margins } [margins] Set margins for the printed web page
4557
- * @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
4558
- * @property { number } [scaleFactor] The scale factor of the web page.
4559
- * @property { number } [pagesPerSheet] The number of pages to print per page sheet.
4560
- * @property { boolean } [collate] Whether the web page should be collated.
4561
- * @property { number } [copies] The number of copies of the web page to print.
4562
- * @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
4563
- * @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
4564
- * @property { Dpi } [dpi] Set dpi for the printed web page
4565
- */
4566
- /**
4567
- * @REMOVED
4568
- * PrinterInfo interface
4569
- * @typedef { object } PrinterInfo
4570
- * @property { string } name Printer Name
4571
- * @property { string } description Printer Description
4572
- * @property { number } status Printer Status
4573
- * @property { boolean } isDefault Indicates that system's default printer
4574
- */
4575
- /**
4576
- * @REMOVED
4577
- * SharedWorkerInfo interface
4578
- * @typedef { object } SharedWorkerInfo
4579
- * @property { string } id The unique id of the shared worker.
4580
- * @property { string } url The url of the shared worker.
4581
- */
4582
- /**
4583
- * @PORTED
4584
- * ContentCreationRule interface
4585
- * @typedef { object } ContentCreationRule
4586
- * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
4587
- * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
4588
- * @property { object } options Window creation options or View creation options.
4589
- */
4590
- /**
4591
- * @PORTED
4592
- * @typedef {object} Window~options
4593
- * @summary Window creation options.
4594
- * @desc This is the options object required by {@link Window.create Window.create}.
4595
- *
4596
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
4597
- * (defaults to `"about:blank"` when omitted).
4598
- *
4599
- * _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
4600
- *
4601
- * @property {object} [accelerator]
4602
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
4603
- *
4604
- * @property {boolean} [accelerator.devtools=false]
4605
- * If `true`, enables the devtools keyboard shortcut:<br>
4606
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
4607
- *
4608
- * @property {boolean} [accelerator.reload=false]
4609
- * If `true`, enables the reload keyboard shortcuts:<br>
4610
- * `Ctrl` + `R` _(Windows)_<br>
4611
- * `F5` _(Windows)_<br>
4612
- * `Command` + `R` _(Mac)_
4613
- *
4614
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
4615
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
4616
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
4617
- * `Shift` + `F5` _(Windows)_<br>
4618
- * `Command` + `Shift` + `R` _(Mac)_
4619
- *
4620
- * @property {boolean} [accelerator.zoom=false]
4621
- * NOTE: It is not recommended to set this value to true for Windows in Platforms as that may lead to unexpected visual shifts in layout.
4622
- * If `true`, enables the zoom keyboard shortcuts:<br>
4623
- * `Ctrl` + `+` _(Zoom In)_<br>
4624
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
4625
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
4626
- * `Ctrl` + `-` _(Zoom Out)_<br>
4627
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
4628
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
4629
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
4630
- * `Ctrl` + `0` _(Restore to 100%)_
4631
- *
4632
- * @property {object} [alphaMask] - _Experimental._ _Updatable._
4633
- * <br>
4634
- * alphaMask turns anything of matching RGB value transparent.
4635
- * <br>
4636
- * Caveats:
4637
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
4638
- * * User cannot click-through transparent regions
4639
- * * Not supported on Mac
4640
- * * Windows Aero must be enabled
4641
- * * Won't make visual sense on Pixel-pushed environments such as Citrix
4642
- * * Not supported on rounded corner windows
4643
- * @property {number} [alphaMask.red=-1] 0-255
4644
- * @property {number} [alphaMask.green=-1] 0-255
4645
- * @property {number} [alphaMask.blue=-1] 0-255
4646
- *
4647
- * @property {boolean} [alwaysOnTop=false] - _Updatable._
4648
- * A flag to always position the window at the top of the window stack.
4649
- *
4650
- * @property {object} [api]
4651
- * Configurations for API injection.
4652
- *
4653
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
4654
- *
4655
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
4656
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
4657
- *
4658
- * @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
4659
- *
4660
- * @property {number} [aspectRatio=0] - _Updatable._
4661
- * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
4662
- * an aspect ratio will not be enforced.
4663
- *
4664
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
4665
- * Autoplay policy to apply to content in the window, can be
4666
- * `no-user-gesture-required`, `user-gesture-required`,
4667
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
4668
- *
4669
- * @property {boolean} [autoShow=true]
4670
- * A flag to automatically show the window when it is created.
4671
- *
4672
- * @property {string} [backgroundColor="#FFF"]
4673
- * The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
4674
- * (`document.body.style.backgroundColor`),
4675
- * this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
4676
- * areas when growing a window. Setting
4677
- * this value to the anticipated content background color can help improve user experience.
4678
- * Default is white.
4679
- *
4680
- * @property {object} [contentCreation]
4681
- * Apply rules that determine how user interaction (`window.open` and links) creates content.
4682
- * @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
4683
- *
4684
- * @property {object} [contentNavigation]
4685
- * Restrict navigation to URLs that match an allowed pattern.
4686
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4687
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4688
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
4689
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
4690
- *
4691
- * @property {object} [contentRedirect]
4692
- * Restrict redirects to URLs that match an allowed pattern.
4693
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4694
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4695
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
4696
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
4697
- *
4698
- * @property {boolean} [contextMenu=true] - _Updatable._
4699
- * A flag to show the context menu when right-clicking on a window.
4700
- * Gives access to the devtools for the window.
4701
- *
4702
- * @property {object} [contextMenuSettings] - _Updatable._
4703
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
4704
- * Configure the context menu when right-clicking on a window.
4705
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
4706
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
4707
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
4708
- *
4709
- * @property {object} [contextMenuOptions] - _Updatable._
4710
- * Configure the context menu when right-clicking on a window. Supported menu items:
4711
- * 'separator'
4712
- * 'cut'
4713
- * 'copy'
4714
- * 'paste'
4715
- * 'spellCheck'
4716
- * 'inspect'
4717
- * 'reload'
4718
- * 'navigateForward'
4719
- * 'navigateBack'
4720
- * 'print'
4721
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
4722
- * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
4723
- *
4724
- * @property {object} [cornerRounding] - _Updatable._
4725
- * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
4726
- * average of _height_ and _width_.
4727
- * @property {number} [cornerRounding.height=0] The height in pixels.
4728
- * @property {number} [cornerRounding.width=0] The width in pixels.
4729
- *
4730
- * @property {any} [customContext=""] - _Updatable. Inheritable._
4731
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
4732
- * is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
4733
- * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
4734
- * _When omitted, _inherits_ from the parent application._
4735
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
4736
- *
4737
- * @property {any} [customData=""] - _Updatable. Inheritable._
4738
- * A field that the user can attach serializable data to be ferried around with the window options.
4739
- * _When omitted, _inherits_ from the parent application._
4740
- *
4741
- * @property {object[]} [customRequestHeaders]
4742
- * Defines list of custom headers for requests sent by the window.
4743
- * @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
4744
- * @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
4745
- * where the object key is the name of header and value at key is the value of the header
4746
- *
4747
- * @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
4748
- * Toggling off would keep the Window alive even if all its Views were closed.
4749
- * This is meant for advanced users and should be used with caution.
4750
- * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
4751
- * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
4752
- * ** note ** - This option is ignored in non-Platforms apps.
4753
- *
4754
- * @property {boolean} [defaultCentered=false]
4755
- * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
4756
- * this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
4757
- * somewhat above center vertically.
4758
- *
4759
- * @property {number} [defaultHeight=500]
4760
- * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
4761
- * in favor of the cached value.
4762
- *
4763
- * @property {number} [defaultLeft=100]
4764
- * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
4765
- * launches in favor of the cached value.
4766
- *
4767
- * @property {number} [defaultTop=100]
4768
- * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
4769
- * launches in favor of the cached value.
4770
- *
4771
- * @property {number} [defaultWidth=800]
4772
- * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
4773
- * launches in favor of the cached value.
4774
- *
4775
- * @property {boolean} [includeInSnapshots=true] - _Updatable._
4776
- * When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
4777
- * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
4778
- *
4779
- * @property {boolean} [frame=true] - _Updatable._
4780
- * A flag to show the frame.
4781
- *
4782
- * @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
4783
- *
4784
- * @property {object[]} [hotkeys=[]] - _Updatable._
4785
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
4786
- * Within Platform, OpenFin also implements a set of pre-defined actions called
4787
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
4788
- * that can be assigned to a specific hotkey in the platform manifest.
4789
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
4790
- * @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
4791
- *
4792
- * @property {string} [icon] - _Updatable. Inheritable._
4793
- * A URL for the icon to be shown in the window title bar and the taskbar.
4794
- * When omitted, inherits from the parent application._
4795
- * note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
4796
- *
4797
- * @property {number} [maxHeight=-1] - _Updatable._
4798
- * The maximum height of a window. Will default to the OS defined value if set to -1.
4799
- *
4800
- * @property {boolean} [maximizable=true] - _Updatable._
4801
- * A flag that lets the window be maximized.
4802
- *
4803
- * @property {number} [maxWidth=-1] - _Updatable._
4804
- * The maximum width of a window. Will default to the OS defined value if set to -1.
4805
- *
4806
- * @property {number} [minHeight=0] - _Updatable._
4807
- * The minimum height of a window.
4808
- *
4809
- * @property {boolean} [minimizable=true] - _Updatable._
4810
- * A flag that lets the window be minimized.
4811
- *
4812
- * @property {number} [minWidth=0] - _Updatable._
4813
- * The minimum width of a window.
4814
- *
4815
- * @property {Identity} [modalParentIdentity]
4816
- * Parent identity of a modal window. It will create a modal child window when this option is set.
4817
- *
4818
- * @property {string} name
4819
- * The name of the window.
4820
- *
4821
- * @property {number} [opacity=1.0] - _Updatable._
4822
- * A flag that specifies how transparent the window will be.
4823
- * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
4824
- * This value is clamped between `0.0` and `1.0`.
4825
- * * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
4826
- *
4827
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
4828
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
4829
- * from the parent application.
4830
- *
4831
- * @property {string} [processAffinity]
4832
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
4833
- *
4834
- * @property {boolean} [resizable=true] - _Updatable._
4835
- * A flag to allow the user to resize the window.
4836
- *
4837
- * @property {object} [resizeRegion] - _Updatable._
4838
- * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
4839
- * @property {number} [resizeRegion.bottomRightCorner=9]
4840
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
4841
- * @property {number} [resizeRegion.size=7]
4842
- * The size in pixels.
4843
- * @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
4844
- * Sides that a window can be resized from.
4845
- *
4846
- * @property {boolean} [saveWindowState=true]
4847
- * A flag to cache the location of the window.
4848
- * ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
4849
- *
4850
- * @property {boolean} [ignoreSavedWindowState]
4851
- * A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
4852
- *
4853
- * @property {boolean} [shadow=false]
4854
- * A flag to display a shadow on frameless windows.
4855
- * `shadow` and `cornerRounding` are mutually exclusive.
4856
- * On Windows 7, Aero theme is required.
4857
- *
4858
- * @property {boolean} [showBackgroundImages=false] - _Updatable._
4859
- * Platforms Only. If true, will show background images in the layout when the Views are hidden.
4860
- * This occurs when the window is resizing or a tab is being dragged within the layout.
4861
- *
4862
- * @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
4863
- * A flag to show the window's icon in the taskbar.
4864
- *
4865
- * @property {boolean} [smallWindow=false]
4866
- * A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
4867
- * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
4868
- * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
4869
- *
4870
- * @property {boolean} [spellCheck=false]
4871
- * Enable spell check in input text fields for the window.
4872
- *
4873
- * @property {string} [state="normal"]
4874
- * The visible state of the window on creation.
4875
- * One of:
4876
- * * `"maximized"`
4877
- * * `"minimized"`
4878
- * * `"normal"`
4879
- *
4880
- * @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
4881
- *
4882
- * @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
4883
- * Specify a taskbar group for the window.
4884
- * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
4885
- *
4886
- * @property {string} [url="about:blank"]
4887
- * The URL of the window.
4888
- *
4889
- * @property {string} [uuid=<application uuid>]
4890
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
4891
- * If omitted, defaults to the `uuid` of the application spawning the window.
4892
- * If given, must match the `uuid` of the application spawning the window.
4893
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
4894
- * really no need to provide it.
4895
- *
4896
- * @property {boolean} [waitForPageLoad=false]
4897
- * When set to `true`, the window will not appear until the `window` object's `load` event fires.
4898
- * When set to `false`, the window will appear immediately without waiting for content to be loaded.
4899
- *
4900
- * @property {ViewVisibility} [viewVisibility]
4901
- * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
4902
- */
4903
- /**
4904
- * @PORTED
4905
- * @typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
4906
- * @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
4907
- * @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
4908
- * @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
4909
- */
4910
- /**
4911
- * @PORTED
4912
- * @typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
4913
- * @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
4914
- * @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
4915
- */
4916
- /**
4917
- * @REMOVED
4918
- * @typedef {Object} ShowViewsOnSplitterDrag _Platform Windows Only_. Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
4919
- * @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
4920
- */
4921
- /**
4922
- * @REMOVED
4923
- * @typedef {Object} ShowViewsOnTabDrag _Platform Windows Only_. Allows views to be shown when the user is manipulating the layout by repositioning a tab.
4924
- * @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
4925
- */
4926
- /**
4927
- * @PORTED
4928
- * @typedef {object} CapturePageOptions
4929
- * @property { Area } [area] The area of the window to be captured.
4930
- * @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
4931
- * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
4932
- */
4933
- /**
4934
- * @PORTED
4935
- * @typedef { object } Area
4936
- * @property { number } height Area's height
4937
- * @property { number } width Area's width
4938
- * @property { number } x X coordinate of area's starting point
4939
- * @property { number } y Y coordinate of area's starting point
4940
- */
4941
- /**
4942
- * @PORTED
4943
- * @typedef {object} FindInPageOptions
4944
- * @property {boolean} [forward=true] Whether to search forward or backward.
4945
- * @property {boolean} [findNext=false] Whether to begin a new text finding session. Should be true for first requests, and false for subsequent requests. Defaults to false.
4946
- * @property {boolean} [matchCase=false] Whether search should be case-sensitive.
4947
- * @property {boolean} [wordStart=false] Whether to look only at the start of words.
4948
- * @property {boolean} [medialCapitalAsWordStart=false]
4949
- * When combined with wordStart, accepts a match in the middle of a word if the match begins with an uppercase letter followed by a<br>
4950
- * lowercase or non-letter. Accepts several other intra-word matches.
4951
- */
4952
- /**
4953
- * @REMOVED
4954
- * @typedef {object} Transition
4955
- * @property {Opacity} opacity - The Opacity transition
4956
- * @property {Position} position - The Position transition
4957
- * @property {Size} size - The Size transition
4958
- */
4959
- /**
4960
- * @PORTED
4961
- * @typedef {object} TransitionOptions
4962
- * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
4963
- this animation onto the end of the animation queue.
4964
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
4965
- */
4966
- /**
4967
- * @PORTED
4968
- * @typedef {object} Size
4969
- * @property {number} duration - The total time in milliseconds this transition should take.
4970
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
4971
- * @property {number} width - Optional if height is present. Defaults to the window's current width.
4972
- * @property {number} height - Optional if width is present. Defaults to the window's current height.
4973
- */
4974
- /**
4975
- * @PORTED
4976
- * @typedef {object} Position
4977
- * @property {number} duration - The total time in milliseconds this transition should take.
4978
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
4979
- * @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
4980
- * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
4981
- */
4982
- /**
4983
- * @PORTED
4984
- * @typedef {object} Opacity
4985
- * @property {number} duration - The total time in milliseconds this transition should take.
4986
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
4987
- * @property {number} opacity - This value is clamped from 0.0 to 1.0.
4988
- */
4989
- /**
4990
- * @REMOVED
4991
- * Bounds is a interface that has the properties of height,
4992
- * width, left, top which are all numbers
4993
- * @typedef { object } Bounds
4994
- * @property { number } height Get the application height bound
4995
- * @property { number } width Get the application width bound
4996
- * @property { number } top Get the application top bound
4997
- * @property { number } left Get the application left bound
4998
- * @property { number } right Get the application right bound
4999
- * @property { number } bottom Get the application bottom bound
5000
- */
5001
4274
  /**
5002
4275
  * A basic window that wraps a native HTML window. Provides more fine-grained
5003
4276
  * control over the window state such as the ability to minimize, maximize, restore, etc.
@@ -5013,83 +4286,6 @@ function requireInstance () {
5013
4286
  constructor(wire, identity) {
5014
4287
  super(wire, identity, 'window');
5015
4288
  }
5016
- /**
5017
- * Adds a listener to the end of the listeners array for the specified event.
5018
- * @param eventType - The type of the event.
5019
- * @param listener - Called whenever an event of the specified type occurs.
5020
- * @param options - Option to support event timestamps.
5021
- *
5022
- * @function addListener
5023
- * @memberof Window
5024
- * @instance
5025
- * @tutorial Window.EventEmitter
5026
- */
5027
- /**
5028
- * Adds a listener to the end of the listeners array for the specified event.
5029
- * @param eventType - The type of the event.
5030
- * @param listener - Called whenever an event of the specified type occurs.
5031
- * @param options - Option to support event timestamps.
5032
- *
5033
- * @function on
5034
- * @memberof Window
5035
- * @instance
5036
- * @tutorial Window.EventEmitter
5037
- */
5038
- /**
5039
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
5040
- * @param eventType - The type of the event.
5041
- * @param listener - The callback function.
5042
- * @param options - Option to support event timestamps.
5043
- *
5044
- * @function once
5045
- * @memberof Window
5046
- * @instance
5047
- * @tutorial Window.EventEmitter
5048
- */
5049
- /**
5050
- * Adds a listener to the beginning of the listeners array for the specified event.
5051
- * @param eventType - The type of the event.
5052
- * @param listener - The callback function.
5053
- * @param options - Option to support event timestamps.
5054
- *
5055
- * @function prependListener
5056
- * @memberof Window
5057
- * @instance
5058
- * @tutorial Window.EventEmitter
5059
- */
5060
- /**
5061
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
5062
- * The listener is added to the beginning of the listeners array.
5063
- * @param eventType - The type of the event.
5064
- * @param listener - The callback function.
5065
- * @param options - Option to support event timestamps.
5066
- *
5067
- * @function prependOnceListener
5068
- * @memberof Window
5069
- * @instance
5070
- * @tutorial Window.EventEmitter
5071
- */
5072
- /**
5073
- * Remove a listener from the listener array for the specified event.
5074
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5075
- * @param eventType - The type of the event.
5076
- * @param listener - The callback function.
5077
- * @param options - Option to support event timestamps.
5078
- *
5079
- * @function removeListener
5080
- * @memberof Window
5081
- * @instance
5082
- * @tutorial Window.EventEmitter
5083
- */
5084
- /**
5085
- * Removes all listeners, or those of the specified event.
5086
- * @param eventType - The type of the event.
5087
- *
5088
- * @function removeAllListeners
5089
- * @memberof Window
5090
- * @instance
5091
- * @tutorial Window.EventEmitter
5092
- */
5093
4289
  /**
5094
4290
  * create a new window
5095
4291
  * @internal
@@ -6161,28 +5357,6 @@ function requireInstance () {
6161
5357
  .sendAction('window-authenticate', { userName, password, ...this.identity })
6162
5358
  .then(() => undefined);
6163
5359
  }
6164
- /**
6165
- * @typedef {object} ShowPopupMenuOptions
6166
- * @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
6167
- * @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
6168
- * @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
6169
- */
6170
- /**
6171
- * @typedef {object} MenuItemTemplate
6172
- * @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
6173
- * @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
6174
- * @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
6175
- * @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
6176
- * @property {boolean} [visible] - If false, the menu item will be entirely hidden.
6177
- * @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
6178
- * @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
6179
- * @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
6180
- */
6181
- /**
6182
- * @typedef {object} MenuResult
6183
- * @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
6184
- * @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
6185
- */
6186
5360
  /**
6187
5361
  * Shows a menu on the window.
6188
5362
  *
@@ -6283,31 +5457,6 @@ function requireInstance () {
6283
5457
  async closePopupMenu() {
6284
5458
  return this.wire.sendAction('close-popup-menu', { ...this.identity }).then(() => undefined);
6285
5459
  }
6286
- /**
6287
- * @PORTED
6288
- * @typedef {object} PopupOptions
6289
- * @property {string} [name] - If a window with this `name` exists, it will be shown as a popup. Otherwise, a new window with this `name` will be created. If this `name` is undefined, `initialOptions.name` will be used. If this `name` and `intialOptions.name` are both undefined, a `name` will be generated.
6290
- * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
6291
- * @property {Window~options} [initialOptions] - Window creation options when using `showPopupWindow` to create a new window.
6292
- * @property {Window~options} [additionalOptions] - Updatable window options applied to new and existing windows when shown as popups.
6293
- * @property {function} [onPopupResult] - Executed when this window's popup calls `dispatchPopupResult`. Note: if this is defined, `showPopupWindow` will not return a `PopupResult`.
6294
- * @property {function} [onPopupReady] - Executed when the popup window is shown. Provides the popup window to the provided function, and allows for easy access the popup window for additional behavior customization.
6295
- * @property {number} [height] - Height of the popup window (takes priority over `intialOptions` size properties).
6296
- * @property {number} [width] - Width of the popup window (takes priority over `intialOptions` size properties).
6297
- * @property {number} [x] - Left position where the popup window will be shown (relative to the window calling `showPopupWindow`).
6298
- * @property {number} [y] - Top position where the popup window will be shown (relative to the window calling `showPopupWindow`).
6299
- * @property {'modal' | 'hide' | 'close'} [blurBehavior] - Determines what happens if the popup window is blurred. 'modal' restricts resizing and positioning in the caller, 'hide' hides the popup window on blur and 'close' closes the popup window on blur.
6300
- * @property {'none' | 'hide' | 'close'} [resultDispatchBehavior] - Determines what happens when the popup window calls `dispatchPopupResult`. 'none' will do nothing, 'hide' hides the popup window on `dispatchPopupResult` and 'close' closes the popup window on `dispatchPopupResult`.
6301
- * @property {boolean} [focus] - Determines if the popup window should or should not be focused when it is shown.
6302
- * @property {boolean} [hideOnClose] - Hide the popup window instead of closing whenever `close` is called on it. Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
6303
- */
6304
- /**
6305
- * @PORTED
6306
- * @typedef {object} PopupResult
6307
- * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
6308
- * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
6309
- * @property {* | undefined} [data] - Data passed to `dispatchPopupResult`.
6310
- */
6311
5460
  /**
6312
5461
  * Dispatch a result to the caller of `showPopupWindow`.
6313
5462
  *
@@ -6643,83 +5792,6 @@ class System extends base_1$j.EmitterBase {
6643
5792
  });
6644
5793
  });
6645
5794
  }
6646
- /**
6647
- * Adds a listener to the end of the listeners array for the specified event.
6648
- * @param eventType - The type of the event.
6649
- * @param listener - Called whenever an event of the specified type occurs.
6650
- * @param options - Option to support event timestamps.
6651
- *
6652
- * @function addListener
6653
- * @memberof System
6654
- * @instance
6655
- * @tutorial System.EventEmitter
6656
- */
6657
- /**
6658
- * Adds a listener to the end of the listeners array for the specified event.
6659
- * @param eventType - The type of the event.
6660
- * @param listener - Called whenever an event of the specified type occurs.
6661
- * @param options - Option to support event timestamps.
6662
- *
6663
- * @function on
6664
- * @memberof System
6665
- * @instance
6666
- * @tutorial System.EventEmitter
6667
- */
6668
- /**
6669
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
6670
- * @param eventType - The type of the event.
6671
- * @param listener - The callback function.
6672
- * @param options - Option to support event timestamps.
6673
- *
6674
- * @function once
6675
- * @memberof System
6676
- * @instance
6677
- * @tutorial System.EventEmitter
6678
- */
6679
- /**
6680
- * Adds a listener to the beginning of the listeners array for the specified event.
6681
- * @param eventType - The type of the event.
6682
- * @param listener - The callback function.
6683
- * @param options - Option to support event timestamps.
6684
- *
6685
- * @function prependListener
6686
- * @memberof System
6687
- * @instance
6688
- * @tutorial System.EventEmitter
6689
- */
6690
- /**
6691
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
6692
- * The listener is added to the beginning of the listeners array.
6693
- * @param eventType - The type of the event.
6694
- * @param listener - The callback function.
6695
- * @param options - Option to support event timestamps.
6696
- *
6697
- * @function prependOnceListener
6698
- * @memberof System
6699
- * @instance
6700
- * @tutorial System.EventEmitter
6701
- */
6702
- /**
6703
- * Remove a listener from the listener array for the specified event.
6704
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
6705
- * @param eventType - The type of the event.
6706
- * @param listener - The callback function.
6707
- * @param options - Option to support event timestamps.
6708
- *
6709
- * @function removeListener
6710
- * @memberof System
6711
- * @instance
6712
- * @tutorial System.EventEmitter
6713
- */
6714
- /**
6715
- * Removes all listeners, or those of the specified event.
6716
- * @param eventType - The type of the event.
6717
- *
6718
- * @function removeAllListeners
6719
- * @memberof System
6720
- * @instance
6721
- * @tutorial System.EventEmitter
6722
- */
6723
5795
  /**
6724
5796
  * Returns the version of the runtime. The version contains the major, minor,
6725
5797
  * build and revision numbers.
@@ -10921,20 +9993,6 @@ var clipboard = {};
10921
9993
  Object.defineProperty(clipboard, "__esModule", { value: true });
10922
9994
  clipboard.Clipboard = void 0;
10923
9995
  const base_1$d = base;
10924
- /**
10925
- * @PORTED
10926
- * WriteRequestType interface
10927
- * @typedef { object } WriteRequestType
10928
- * @property { string } data Data to be written
10929
- * @property { string } [type] Clipboard Type
10930
- */
10931
- /**
10932
- * @PORTED
10933
- * OpenFin.WriteAnyClipboardRequest interface
10934
- * @typedef { object } OpenFin.WriteAnyClipboardRequest
10935
- * @property { string } data Data to be written
10936
- * @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
10937
- */
10938
9996
  /**
10939
9997
  * The Clipboard API allows reading and writing to the clipboard in multiple formats.
10940
9998
  *
@@ -11147,83 +10205,6 @@ class ExternalApplication extends base_1$c.EmitterBase {
11147
10205
  super(wire, 'external-application', identity.uuid);
11148
10206
  this.identity = identity;
11149
10207
  }
11150
- /**
11151
- * Adds a listener to the end of the listeners array for the specified event.
11152
- * @param eventType - The type of the event.
11153
- * @param listener - Called whenever an event of the specified type occurs.
11154
- * @param options - Option to support event timestamps.
11155
- *
11156
- * @function addListener
11157
- * @memberof ExternalApplication
11158
- * @instance
11159
- * @tutorial ExternalApplication.EventEmitter
11160
- */
11161
- /**
11162
- * Adds a listener to the end of the listeners array for the specified event.
11163
- * @param eventType - The type of the event.
11164
- * @param listener - Called whenever an event of the specified type occurs.
11165
- * @param options - Option to support event timestamps.
11166
- *
11167
- * @function on
11168
- * @memberof ExternalApplication
11169
- * @instance
11170
- * @tutorial ExternalApplication.EventEmitter
11171
- */
11172
- /**
11173
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
11174
- * @param eventType - The type of the event.
11175
- * @param listener - The callback function.
11176
- * @param options - Option to support event timestamps.
11177
- *
11178
- * @function once
11179
- * @memberof ExternalApplication
11180
- * @instance
11181
- * @tutorial ExternalApplication.EventEmitter
11182
- */
11183
- /**
11184
- * Adds a listener to the beginning of the listeners array for the specified event.
11185
- * @param eventType - The type of the event.
11186
- * @param listener - The callback function.
11187
- * @param options - Option to support event timestamps.
11188
- *
11189
- * @function prependListener
11190
- * @memberof ExternalApplication
11191
- * @instance
11192
- * @tutorial ExternalApplication.EventEmitter
11193
- */
11194
- /**
11195
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
11196
- * The listener is added to the beginning of the listeners array.
11197
- * @param eventType - The type of the event.
11198
- * @param listener - The callback function.
11199
- * @param options - Option to support event timestamps.
11200
- *
11201
- * @function prependOnceListener
11202
- * @memberof ExternalApplication
11203
- * @instance
11204
- * @tutorial ExternalApplication.EventEmitter
11205
- */
11206
- /**
11207
- * Remove a listener from the listener array for the specified event.
11208
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
11209
- * @param eventType - The type of the event.
11210
- * @param listener - The callback function.
11211
- * @param options - Option to support event timestamps.
11212
- *
11213
- * @function removeListener
11214
- * @memberof ExternalApplication
11215
- * @instance
11216
- * @tutorial ExternalApplication.EventEmitter
11217
- */
11218
- /**
11219
- * Removes all listeners, or those of the specified event.
11220
- * @param eventType - The type of the event.
11221
- *
11222
- * @function removeAllListeners
11223
- * @memberof ExternalApplication
11224
- * @instance
11225
- * @tutorial ExternalApplication.EventEmitter
11226
- */
11227
10208
  /**
11228
10209
  * Retrieves information about the external application.
11229
10210
  *
@@ -11360,83 +10341,6 @@ class _Frame extends base_1$a.EmitterBase {
11360
10341
  super(wire, 'frame', identity.uuid, identity.name);
11361
10342
  this.identity = identity;
11362
10343
  }
11363
- /**
11364
- * Adds the listener function to the end of the listeners array for the specified event type.
11365
- * @param eventType - The type of the event.
11366
- * @param listener - Called whenever an event of the specified type occurs.
11367
- * @param options - Option to support event timestamps.
11368
- *
11369
- * @function addListener
11370
- * @memberof Frame
11371
- * @instance
11372
- * @tutorial Frame.EventEmitter
11373
- */
11374
- /**
11375
- * Adds a listener to the end of the listeners array for the specified event.
11376
- * @param eventType - The type of the event.
11377
- * @param listener - Called whenever an event of the specified type occurs.
11378
- * @param options - Option to support event timestamps.
11379
- *
11380
- * @function on
11381
- * @memberof Frame
11382
- * @instance
11383
- * @tutorial Frame.EventEmitter
11384
- */
11385
- /**
11386
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
11387
- * @param eventType - The type of the event.
11388
- * @param listener - The callback function.
11389
- * @param options - Option to support event timestamps.
11390
- *
11391
- * @function once
11392
- * @memberof Frame
11393
- * @instance
11394
- * @tutorial Frame.EventEmitter
11395
- */
11396
- /**
11397
- * Adds a listener to the beginning of the listeners array for the specified event.
11398
- * @param eventType - The type of the event.
11399
- * @param listener - The callback function.
11400
- * @param options - Option to support event timestamps.
11401
- *
11402
- * @function prependListener
11403
- * @memberof Frame
11404
- * @instance
11405
- * @tutorial Frame.EventEmitter
11406
- */
11407
- /**
11408
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
11409
- * The listener is added to the beginning of the listeners array.
11410
- * @param eventType - The type of the event.
11411
- * @param listener - The callback function.
11412
- * @param options - Option to support event timestamps.
11413
- *
11414
- * @function prependOnceListener
11415
- * @memberof Frame
11416
- * @instance
11417
- * @tutorial Frame.EventEmitter
11418
- */
11419
- /**
11420
- * Remove a listener from the listener array for the specified event.
11421
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
11422
- * @param eventType - The type of the event.
11423
- * @param listener - The callback function.
11424
- * @param options - Option to support event timestamps.
11425
- *
11426
- * @function removeListener
11427
- * @memberof Frame
11428
- * @instance
11429
- * @tutorial Frame.EventEmitter
11430
- */
11431
- /**
11432
- * Removes all listeners, or those of the specified event.
11433
- * @param eventType - The type of the event.
11434
- *
11435
- * @function removeAllListeners
11436
- * @memberof Frame
11437
- * @instance
11438
- * @tutorial Frame.EventEmitter
11439
- */
11440
10344
  /**
11441
10345
  * Returns a frame info object for the represented frame.
11442
10346
  *
@@ -14367,57 +13271,6 @@ function requireInteropBroker () {
14367
13271
  /*
14368
13272
  Client API
14369
13273
  */
14370
- /**
14371
- * @REMOVED
14372
- * SetContextOptions interface
14373
- * @typedef { object } SetContextOptions
14374
- * @property { Context } {context} - New context to set.
14375
- */
14376
- /**
14377
- * @REMOVED
14378
- * GetContextOptions interface
14379
- * @typedef { object } GetContextOptions
14380
- * @property { string } [contextType] - Context Type
14381
- */
14382
- // TODO: extract inline type and do proper comments
14383
- /**
14384
- * @REMOVED
14385
- * JoinContextGroupOptions interface
14386
- * @typedef { object } JoinContextGroupOptions
14387
- * @property { string } contextGroupId - Id of the context group.
14388
- * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
14389
- */
14390
- /**
14391
- * @REMOVED
14392
- * AddClientToContextGroupOptions interface
14393
- * @typedef { object } AddClientToContextGroupOptions
14394
- * @property { string } contextGroupId - Name of the context group.
14395
- */
14396
- /**
14397
- * @REMOVED
14398
- * RemoveFromContextGroupOptions interface
14399
- * @typedef { object } RemoveFromContextGroupOptions
14400
- * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
14401
- */
14402
- /**
14403
- * @REMOVED
14404
- * GetInfoForContextGroupOptions interface
14405
- * @typedef { object } GetInfoForContextGroupOptions
14406
- * @property { string } contextGroupId - Name of the context group to get info for.
14407
- */
14408
- /**
14409
- * @REMOVED
14410
- * GetAllClientsInContextGroupOptions interface
14411
- * @typedef { object } GetAllClientsInContextGroupOptions
14412
- * @property { string } contextGroupId - Name of the context group to get info for.
14413
- */
14414
- /**
14415
- * @PORTED
14416
- * InfoForIntentOptions interface
14417
- * @typedef { object } InfoForIntentOptions
14418
- * @property { string } name Name of the intent to get info for.
14419
- * @property { Context } [context] Optional context.
14420
- */
14421
13274
  /**
14422
13275
  * Sets a context for the context group of the incoming current entity.
14423
13276
  * @param setContextOptions - New context to set.
@@ -15576,95 +14429,6 @@ InteropClient$1.InteropClient = void 0;
15576
14429
  const base_1$2 = base;
15577
14430
  const SessionContextGroupClient_1 = SessionContextGroupClient$1;
15578
14431
  const utils_1$2 = utils$1;
15579
- /**
15580
- * @PORTED
15581
- * @typedef { object } Intent
15582
- * @summary The combination of an action and a context that is passed to an application for resolution.
15583
- * @property { string } name Name of the intent.
15584
- * @property { Context } context Data associated with the intent
15585
- */
15586
- /**
15587
- * @REMOVED
15588
- * @typedef { object } Subscription
15589
- * @summary Object returned when subscribing a handler.
15590
- * @property { function } unsubscribe Function to unsubscribe the handler.
15591
- */
15592
- /**
15593
- * @typedef { function } ContextHandler
15594
- * @summary Subscription function for addContextHandler.
15595
- */
15596
- /**
15597
- * @typedef { function } IntentHandler
15598
- * @summary Subscription function for registerIntentHandler
15599
- */
15600
- /**
15601
- * @PORTED
15602
- * @typedef { object } ClientIdentity
15603
- * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
15604
- * @property {string} uuid GUID of an application.
15605
- * @property {string} name Name of an entity in an application.
15606
- * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
15607
- */
15608
- /**
15609
- * @PORTED
15610
- * @typedef { object } ContextGroupInfo
15611
- * @summary Information for a Context Group. Contains metadata for displaying the group properly.
15612
- * @property {string} id Name of the context group
15613
- * @property {DisplayMetadata} displayMetadata Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.
15614
- */
15615
- /**
15616
- * @PORTED
15617
- * @typedef { object } DisplayMetadata
15618
- * @summary The display data for a Context Group.
15619
- * @property {string} name A user-readable name for this context group, e.g: `"Red"`
15620
- * @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
15621
- * @property {string} [glyph] A URL of an image that can be used to display this context group
15622
- */
15623
- /**
15624
- * @PORTED
15625
- * @typedef { object } Context
15626
- * @summary Data passed between entities and applications.
15627
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
15628
- * @property {string} [name] User-readable name for the incoming context.
15629
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
15630
- */
15631
- /**
15632
- * @REMOVED
15633
- * @typedef { object } ContextForIntent
15634
- * @summary Data passed between entities and applications, including an optional metadata.
15635
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
15636
- * @property {string} [name] User-readable name for the incoming context.
15637
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
15638
- * @property {any} [metadata]
15639
- */
15640
- /**
15641
- * @REMOVED
15642
- * @typedef { object } SessionContextGroup
15643
- * @summary An instance of a SessionContextGroup
15644
- * @property {string} id The SessionContextGroup's id.
15645
- * @property {setContext} setContext Sets a context of a certain type
15646
- * @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
15647
- * @property {addContextHandler} addContextHandler Adds a handler for context change.
15648
- */
15649
- /**
15650
- * @typedef {function} setContext
15651
- * @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
15652
- * @param context The Context to be set.
15653
- *
15654
- */
15655
- /**
15656
- * @typedef {function} getCurrentContext
15657
- * @summary A SessionContextGroup instance method for getting the current context of a certain type.
15658
- * @param contextType The Context Type to get. If not specified the last contextType set would get used.
15659
- *
15660
- */
15661
- /**
15662
- * @typedef {function} addContextHandler
15663
- * @summary A SessionContextGroup instance method for adding a handler for context change.
15664
- * @param contextHandler The callback to be invoked. Is invoked when (a) the context changes or (b) immediately after getting created if the context is already set.
15665
- * @param contextType The context type this handler should listen to. If not specified, a global handler for all context types will get created. Only one global handler is allowed per SessionContextGroup.
15666
- *
15667
- */
15668
14432
  /**
15669
14433
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
15670
14434
  *
@@ -16298,13 +15062,6 @@ function requireFactory () {
16298
15062
  const common_utils_1 = commonUtils;
16299
15063
  const defaultOverride = (Class) => new Class();
16300
15064
  const BrokerParamAccessError = 'You have attempted to use or modify InteropBroker parameters, which is not allowed. You are likely using an older InteropBroker override scheme. Please consult our Interop docs for guidance on migrating to the new override scheme.';
16301
- /**
16302
- * @PORTED
16303
- * @typedef { object } InteropConfig
16304
- * @summary Information relevant to the Interop Broker.
16305
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
16306
- * @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
16307
- */
16308
15065
  /**
16309
15066
  * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
16310
15067
  *