@openfin/node-adapter 34.78.62 → 35.78.4

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.
@@ -2402,169 +2402,6 @@ function requireInstance$2 () {
2402
2402
  const layout_constants_1 = layout_constants;
2403
2403
  const main_1 = main;
2404
2404
  const window_1 = requireWindow();
2405
- /**
2406
- * @PORTED
2407
- * @typedef {object} View~options
2408
- * @summary View creation options.
2409
- * @desc This is the options object required by {@link View.create View.create}.
2410
- *
2411
- * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
2412
- * (defaults to `"about:blank"` when omitted).
2413
- *
2414
- * @property {object} [experimental]
2415
- * Configurations for API injection.
2416
- *
2417
- * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
2418
- *
2419
- * @property {object} [accelerator]
2420
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
2421
- *
2422
- * @property {boolean} [accelerator.devtools=false]
2423
- * If `true`, enables the devtools keyboard shortcut:<br>
2424
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
2425
- *
2426
- * @property {boolean} [accelerator.reload=false]
2427
- * If `true`, enables the reload keyboard shortcuts:<br>
2428
- * `Ctrl` + `R` _(Windows)_<br>
2429
- * `F5` _(Windows)_<br>
2430
- * `Command` + `R` _(Mac)_
2431
- *
2432
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
2433
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
2434
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
2435
- * `Shift` + `F5` _(Windows)_<br>
2436
- * `Command` + `Shift` + `R` _(Mac)_
2437
- *
2438
- * @property {boolean} [accelerator.zoom=false]
2439
- * If `true`, enables the zoom keyboard shortcuts:<br>
2440
- * `Ctrl` + `+` _(Zoom In)_<br>
2441
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
2442
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
2443
- * `Ctrl` + `-` _(Zoom Out)_<br>
2444
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
2445
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
2446
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
2447
- * `Ctrl` + `0` _(Restore to 100%)_
2448
- *
2449
- * @property {object} [api]
2450
- * Configurations for API injection.
2451
- *
2452
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
2453
- *
2454
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
2455
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
2456
- *
2457
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
2458
- * Autoplay policy to apply to content in the window, can be
2459
- * `no-user-gesture-required`, `user-gesture-required`,
2460
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
2461
- *
2462
- * @property {object} [autoResize] AutoResize options
2463
- *
2464
- * @property {object} [bounds] initial bounds given relative to the window.
2465
- *
2466
- * @property {string} [backgroundColor="#FFF"] - _Updatable._
2467
- * The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
2468
- * (`document.body.style.backgroundColor`),
2469
- * this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
2470
- * areas when growing a window. Setting
2471
- * this value to the anticipated content background color can help improve user experience.
2472
- * Default is white.
2473
- *
2474
- * @property {object} [contentNavigation]
2475
- * Restrict navigation to URLs that match an allowed pattern.
2476
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
2477
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
2478
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
2479
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
2480
- *
2481
- * @property {object} [contentRedirect]
2482
- * Restrict redirects to URLs that match an allowed pattern.
2483
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
2484
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
2485
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
2486
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
2487
- *
2488
- * @property {object} [contextMenuSettings] - _Updatable._
2489
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
2490
- * Configure the context menu when right-clicking on a view.
2491
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
2492
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
2493
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
2494
- *
2495
- * @property {object} [contextMenuOptions] - _Updatable._
2496
- * Configure the context menu when right-clicking on a view. Supported menu items:
2497
- * 'separator'
2498
- * 'cut'
2499
- * 'copy'
2500
- * 'copyImage',
2501
- * 'paste'
2502
- * 'spellCheck'
2503
- * 'inspect'
2504
- * 'reload'
2505
- * 'navigateForward'
2506
- * 'navigateBack'
2507
- * 'print'
2508
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
2509
- * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
2510
- *
2511
- * @property {any} [customData=""] - _Updatable._
2512
- * A field that the user can attach serializable data to be ferried around with the view options.
2513
- * _When omitted, the default value of this property is the empty string (`""`)._
2514
- *
2515
- * @property {any} [customContext=""] - _Updatable._
2516
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
2517
- * is called.
2518
- * When omitted, the default value of this property is the empty string (`""`).
2519
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
2520
- *
2521
- * @property {object[]} [hotkeys=[]] - _Updatable._
2522
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
2523
- * Within Platform, OpenFin also implements a set of pre-defined actions called
2524
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
2525
- * that can be assigned to a specific hotkey in the platform manifest.
2526
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
2527
- * @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
2528
- *
2529
- * @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
2530
- * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
2531
- * if the view isn't part of the new layout when running `Layout.replace`.
2532
- *
2533
- * @property {string} name
2534
- * The name of the view.
2535
- *
2536
- * @property {boolean} [detachOnClose=false] - _Updatable._
2537
- * Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
2538
- * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
2539
- *
2540
- * @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
2541
- * but the properties in the manifest will take precedence if there is any collision.
2542
- *
2543
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
2544
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
2545
- * from the parent application.
2546
- *
2547
- * @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
2548
- *
2549
- * @property {string} [processAffinity=<application uuid>]
2550
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
2551
- *
2552
- * @property {boolean} [spellCheck=false]
2553
- * Enable spell check in input text fields for the view.
2554
- *
2555
- * @property {Identity} [target]
2556
- * The identity of the window this view should be attached to.
2557
- *
2558
- * @property {string} [url="about:blank"]
2559
- * The URL of the view.
2560
- *
2561
- * @property {string} [uuid=<application uuid>]
2562
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
2563
- * If omitted, defaults to the `uuid` of the application spawning the view.
2564
- * If given, must match the `uuid` of the application spawning the view.
2565
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
2566
- * really no need to provide it.
2567
- */
2568
2405
  /**
2569
2406
  * A View can be used to embed additional web content into a Window.
2570
2407
  * It is like a child window, except it is positioned relative to its owning window.
@@ -3188,100 +3025,6 @@ function requireInstance$1 () {
3188
3025
  });
3189
3026
  return windowList;
3190
3027
  }
3191
- /**
3192
- * Adds a listener to the end of the listeners array for the specified event.
3193
- * @param eventType - The type of the event.
3194
- * @param listener - Called whenever an event of the specified type occurs.
3195
- * @param options - Option to support event timestamps.
3196
- *
3197
- * @function addListener
3198
- * @memberof Application
3199
- * @instance
3200
- * @tutorial Application.EventEmitter
3201
- */
3202
- /**
3203
- * Adds a listener to the end of the listeners array for the specified event.
3204
- * @param eventType - The type of the event.
3205
- * @param listener - Called whenever an event of the specified type occurs.
3206
- * @param options - Option to support event timestamps.
3207
- *
3208
- * @function on
3209
- * @memberof Application
3210
- * @instance
3211
- * @tutorial Application.EventEmitter
3212
- */
3213
- /**
3214
- * 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.
3215
- * @param eventType - The type of the event.
3216
- * @param listener - The callback function.
3217
- * @param options - Option to support event timestamps.
3218
- *
3219
- * @function once
3220
- * @memberof Application
3221
- * @instance
3222
- * @tutorial Application.EventEmitter
3223
- */
3224
- /**
3225
- * Adds a listener to the beginning of the listeners array for the specified event.
3226
- * @param eventType - The type of the event.
3227
- * @param listener - The callback function.
3228
- * @param options - Option to support event timestamps.
3229
- *
3230
- * @function prependListener
3231
- * @memberof Application
3232
- * @instance
3233
- * @tutorial Application.EventEmitter
3234
- */
3235
- /**
3236
- * 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.
3237
- * The listener is added to the beginning of the listeners array.
3238
- * @param eventType - The type of the event.
3239
- * @param listener - The callback function.
3240
- * @param options - Option to support event timestamps.
3241
- *
3242
- * @function prependOnceListener
3243
- * @memberof Application
3244
- * @instance
3245
- * @tutorial Application.EventEmitter
3246
- */
3247
- /**
3248
- * Remove a listener from the listener array for the specified event.
3249
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
3250
- * @param eventType - The type of the event.
3251
- * @param listener - The callback function.
3252
- * @param options - Option to support event timestamps.
3253
- *
3254
- * @function removeListener
3255
- * @memberof Application
3256
- * @instance
3257
- * @tutorial Application.EventEmitter
3258
- */
3259
- /**
3260
- * Removes all listeners, or those of the specified event.
3261
- * @param eventType - The type of the event.
3262
- *
3263
- * @function removeAllListeners
3264
- * @memberof Application
3265
- * @instance
3266
- * @tutorial Application.EventEmitter
3267
- */
3268
- /**
3269
- * JumpListCategory interface
3270
- * @typedef { object } JumpListCategory
3271
- * @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.
3272
- * @property { JumpListItem[] } items Array of JumpListItem objects
3273
- */
3274
- /**
3275
- * @PORTED
3276
- * JumpListItem interface
3277
- * @typedef { object } JumpListItem
3278
- * @property { string } type One of the following: "task" or "separator". Defaults to task.
3279
- * @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
3280
- * @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
3281
- * @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.
3282
- * @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).
3283
- * @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.
3284
- */
3285
3028
  /**
3286
3029
  * Determines if the application is currently running.
3287
3030
  *
@@ -4307,476 +4050,6 @@ function requireInstance () {
4307
4050
  const main_1 = main;
4308
4051
  const view_1 = requireView();
4309
4052
  const warnings_1 = warnings;
4310
- /**
4311
- * @PORTED
4312
- * @typedef { object } Margins
4313
- * @property { string } [marginType]
4314
- * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
4315
- * you will also need to specify `top`, `bottom`, `left`, and `right`.
4316
- *
4317
- * @property { number } [top] The top margin of the printed web page, in pixels.
4318
- * @property { number } [bottom] The bottom margin of the printed web page, in pixels.
4319
- * @property { number } [left] The left margin of the printed web page, in pixels.
4320
- * @property { number } [right] The right margin of the printed web page, in pixels.
4321
- */
4322
- /**
4323
- * @PORTED
4324
- * @typedef { object } Dpi
4325
- * @property { number } [horizontal] The horizontal dpi
4326
- * @property { number } [vertical] The vertical dpi
4327
- */
4328
- /**
4329
- * @PORTED
4330
- * @typedef { object } PrintOptions
4331
- * @property { boolean } [silent=false] Don't ask user for print settings.
4332
- * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
4333
- * @property { string } [deviceName=''] Set the printer device name to use.
4334
- * @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
4335
- * @property { Margins } [margins] Set margins for the printed web page
4336
- * @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
4337
- * @property { number } [scaleFactor] The scale factor of the web page.
4338
- * @property { number } [pagesPerSheet] The number of pages to print per page sheet.
4339
- * @property { boolean } [collate] Whether the web page should be collated.
4340
- * @property { number } [copies] The number of copies of the web page to print.
4341
- * @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
4342
- * @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
4343
- * @property { Dpi } [dpi] Set dpi for the printed web page
4344
- */
4345
- /**
4346
- * @REMOVED
4347
- * PrinterInfo interface
4348
- * @typedef { object } PrinterInfo
4349
- * @property { string } name Printer Name
4350
- * @property { string } description Printer Description
4351
- * @property { number } status Printer Status
4352
- * @property { boolean } isDefault Indicates that system's default printer
4353
- */
4354
- /**
4355
- * @REMOVED
4356
- * SharedWorkerInfo interface
4357
- * @typedef { object } SharedWorkerInfo
4358
- * @property { string } id The unique id of the shared worker.
4359
- * @property { string } url The url of the shared worker.
4360
- */
4361
- /**
4362
- * @PORTED
4363
- * ContentCreationRule interface
4364
- * @typedef { object } ContentCreationRule
4365
- * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
4366
- * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
4367
- * @property { object } options Window creation options or View creation options.
4368
- */
4369
- /**
4370
- * @PORTED
4371
- * @typedef {object} Window~options
4372
- * @summary Window creation options.
4373
- * @desc This is the options object required by {@link Window.create Window.create}.
4374
- *
4375
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
4376
- * (defaults to `"about:blank"` when omitted).
4377
- *
4378
- * _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
4379
- *
4380
- * @property {object} [accelerator]
4381
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
4382
- *
4383
- * @property {boolean} [accelerator.devtools=false]
4384
- * If `true`, enables the devtools keyboard shortcut:<br>
4385
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
4386
- *
4387
- * @property {boolean} [accelerator.reload=false]
4388
- * If `true`, enables the reload keyboard shortcuts:<br>
4389
- * `Ctrl` + `R` _(Windows)_<br>
4390
- * `F5` _(Windows)_<br>
4391
- * `Command` + `R` _(Mac)_
4392
- *
4393
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
4394
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
4395
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
4396
- * `Shift` + `F5` _(Windows)_<br>
4397
- * `Command` + `Shift` + `R` _(Mac)_
4398
- *
4399
- * @property {boolean} [accelerator.zoom=false]
4400
- * 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.
4401
- * If `true`, enables the zoom keyboard shortcuts:<br>
4402
- * `Ctrl` + `+` _(Zoom In)_<br>
4403
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
4404
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
4405
- * `Ctrl` + `-` _(Zoom Out)_<br>
4406
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
4407
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
4408
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
4409
- * `Ctrl` + `0` _(Restore to 100%)_
4410
- *
4411
- * @property {object} [alphaMask] - _Experimental._ _Updatable._
4412
- * <br>
4413
- * alphaMask turns anything of matching RGB value transparent.
4414
- * <br>
4415
- * Caveats:
4416
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
4417
- * * User cannot click-through transparent regions
4418
- * * Not supported on Mac
4419
- * * Windows Aero must be enabled
4420
- * * Won't make visual sense on Pixel-pushed environments such as Citrix
4421
- * * Not supported on rounded corner windows
4422
- * @property {number} [alphaMask.red=-1] 0-255
4423
- * @property {number} [alphaMask.green=-1] 0-255
4424
- * @property {number} [alphaMask.blue=-1] 0-255
4425
- *
4426
- * @property {boolean} [alwaysOnTop=false] - _Updatable._
4427
- * A flag to always position the window at the top of the window stack.
4428
- *
4429
- * @property {object} [api]
4430
- * Configurations for API injection.
4431
- *
4432
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
4433
- *
4434
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
4435
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
4436
- *
4437
- * @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
4438
- *
4439
- * @property {number} [aspectRatio=0] - _Updatable._
4440
- * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
4441
- * an aspect ratio will not be enforced.
4442
- *
4443
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
4444
- * Autoplay policy to apply to content in the window, can be
4445
- * `no-user-gesture-required`, `user-gesture-required`,
4446
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
4447
- *
4448
- * @property {boolean} [autoShow=true]
4449
- * A flag to automatically show the window when it is created.
4450
- *
4451
- * @property {string} [backgroundColor="#FFF"]
4452
- * The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
4453
- * (`document.body.style.backgroundColor`),
4454
- * this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
4455
- * areas when growing a window. Setting
4456
- * this value to the anticipated content background color can help improve user experience.
4457
- * Default is white.
4458
- *
4459
- * @property {object} [contentCreation]
4460
- * Apply rules that determine how user interaction (`window.open` and links) creates content.
4461
- * @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
4462
- *
4463
- * @property {object} [contentNavigation]
4464
- * Restrict navigation to URLs that match an allowed pattern.
4465
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4466
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4467
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
4468
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
4469
- *
4470
- * @property {object} [contentRedirect]
4471
- * Restrict redirects to URLs that match an allowed pattern.
4472
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4473
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4474
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
4475
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
4476
- *
4477
- * @property {boolean} [contextMenu=true] - _Updatable._
4478
- * A flag to show the context menu when right-clicking on a window.
4479
- * Gives access to the devtools for the window.
4480
- *
4481
- * @property {object} [contextMenuSettings] - _Updatable._
4482
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
4483
- * Configure the context menu when right-clicking on a window.
4484
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
4485
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
4486
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
4487
- *
4488
- * @property {object} [contextMenuOptions] - _Updatable._
4489
- * Configure the context menu when right-clicking on a window. Supported menu items:
4490
- * 'separator'
4491
- * 'cut'
4492
- * 'copy'
4493
- * 'paste'
4494
- * 'spellCheck'
4495
- * 'inspect'
4496
- * 'reload'
4497
- * 'navigateForward'
4498
- * 'navigateBack'
4499
- * 'print'
4500
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
4501
- * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
4502
- *
4503
- * @property {object} [cornerRounding] - _Updatable._
4504
- * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
4505
- * average of _height_ and _width_.
4506
- * @property {number} [cornerRounding.height=0] The height in pixels.
4507
- * @property {number} [cornerRounding.width=0] The width in pixels.
4508
- *
4509
- * @property {any} [customContext=""] - _Updatable. Inheritable._
4510
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
4511
- * is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
4512
- * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
4513
- * _When omitted, _inherits_ from the parent application._
4514
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
4515
- *
4516
- * @property {any} [customData=""] - _Updatable. Inheritable._
4517
- * A field that the user can attach serializable data to be ferried around with the window options.
4518
- * _When omitted, _inherits_ from the parent application._
4519
- *
4520
- * @property {object[]} [customRequestHeaders]
4521
- * Defines list of custom headers for requests sent by the window.
4522
- * @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
4523
- * @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
4524
- * where the object key is the name of header and value at key is the value of the header
4525
- *
4526
- * @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
4527
- * Toggling off would keep the Window alive even if all its Views were closed.
4528
- * This is meant for advanced users and should be used with caution.
4529
- * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
4530
- * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
4531
- * ** note ** - This option is ignored in non-Platforms apps.
4532
- *
4533
- * @property {boolean} [defaultCentered=false]
4534
- * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
4535
- * this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
4536
- * somewhat above center vertically.
4537
- *
4538
- * @property {number} [defaultHeight=500]
4539
- * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
4540
- * in favor of the cached value.
4541
- *
4542
- * @property {number} [defaultLeft=100]
4543
- * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
4544
- * launches in favor of the cached value.
4545
- *
4546
- * @property {number} [defaultTop=100]
4547
- * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
4548
- * launches in favor of the cached value.
4549
- *
4550
- * @property {number} [defaultWidth=800]
4551
- * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
4552
- * launches in favor of the cached value.
4553
- *
4554
- * @property {boolean} [includeInSnapshots=true] - _Updatable._
4555
- * When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
4556
- * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
4557
- *
4558
- * @property {boolean} [frame=true] - _Updatable._
4559
- * A flag to show the frame.
4560
- *
4561
- * @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
4562
- *
4563
- * @property {object[]} [hotkeys=[]] - _Updatable._
4564
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
4565
- * Within Platform, OpenFin also implements a set of pre-defined actions called
4566
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
4567
- * that can be assigned to a specific hotkey in the platform manifest.
4568
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
4569
- * @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
4570
- *
4571
- * @property {string} [icon] - _Updatable. Inheritable._
4572
- * A URL for the icon to be shown in the window title bar and the taskbar.
4573
- * When omitted, inherits from the parent application._
4574
- * note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
4575
- *
4576
- * @property {number} [maxHeight=-1] - _Updatable._
4577
- * The maximum height of a window. Will default to the OS defined value if set to -1.
4578
- *
4579
- * @property {boolean} [maximizable=true] - _Updatable._
4580
- * A flag that lets the window be maximized.
4581
- *
4582
- * @property {number} [maxWidth=-1] - _Updatable._
4583
- * The maximum width of a window. Will default to the OS defined value if set to -1.
4584
- *
4585
- * @property {number} [minHeight=0] - _Updatable._
4586
- * The minimum height of a window.
4587
- *
4588
- * @property {boolean} [minimizable=true] - _Updatable._
4589
- * A flag that lets the window be minimized.
4590
- *
4591
- * @property {number} [minWidth=0] - _Updatable._
4592
- * The minimum width of a window.
4593
- *
4594
- * @property {Identity} [modalParentIdentity]
4595
- * Parent identity of a modal window. It will create a modal child window when this option is set.
4596
- *
4597
- * @property {string} name
4598
- * The name of the window.
4599
- *
4600
- * @property {number} [opacity=1.0] - _Updatable._
4601
- * A flag that specifies how transparent the window will be.
4602
- * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
4603
- * This value is clamped between `0.0` and `1.0`.
4604
- * * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
4605
- *
4606
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
4607
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
4608
- * from the parent application.
4609
- *
4610
- * @property {string} [processAffinity]
4611
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
4612
- *
4613
- * @property {boolean} [resizable=true] - _Updatable._
4614
- * A flag to allow the user to resize the window.
4615
- *
4616
- * @property {object} [resizeRegion] - _Updatable._
4617
- * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
4618
- * @property {number} [resizeRegion.bottomRightCorner=9]
4619
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
4620
- * @property {number} [resizeRegion.size=7]
4621
- * The size in pixels.
4622
- * @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
4623
- * Sides that a window can be resized from.
4624
- *
4625
- * @property {boolean} [saveWindowState=true]
4626
- * A flag to cache the location of the window.
4627
- * ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
4628
- *
4629
- * @property {boolean} [ignoreSavedWindowState]
4630
- * A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
4631
- *
4632
- * @property {boolean} [shadow=false]
4633
- * A flag to display a shadow on frameless windows.
4634
- * `shadow` and `cornerRounding` are mutually exclusive.
4635
- * On Windows 7, Aero theme is required.
4636
- *
4637
- * @property {boolean} [showBackgroundImages=false] - _Updatable._
4638
- * Platforms Only. If true, will show background images in the layout when the Views are hidden.
4639
- * This occurs when the window is resizing or a tab is being dragged within the layout.
4640
- *
4641
- * @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
4642
- * A flag to show the window's icon in the taskbar.
4643
- *
4644
- * @property {boolean} [smallWindow=false]
4645
- * A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
4646
- * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
4647
- * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
4648
- *
4649
- * @property {boolean} [spellCheck=false]
4650
- * Enable spell check in input text fields for the window.
4651
- *
4652
- * @property {string} [state="normal"]
4653
- * The visible state of the window on creation.
4654
- * One of:
4655
- * * `"maximized"`
4656
- * * `"minimized"`
4657
- * * `"normal"`
4658
- *
4659
- * @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
4660
- *
4661
- * @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
4662
- * Specify a taskbar group for the window.
4663
- * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
4664
- *
4665
- * @property {string} [url="about:blank"]
4666
- * The URL of the window.
4667
- *
4668
- * @property {string} [uuid=<application uuid>]
4669
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
4670
- * If omitted, defaults to the `uuid` of the application spawning the window.
4671
- * If given, must match the `uuid` of the application spawning the window.
4672
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
4673
- * really no need to provide it.
4674
- *
4675
- * @property {boolean} [waitForPageLoad=false]
4676
- * When set to `true`, the window will not appear until the `window` object's `load` event fires.
4677
- * When set to `false`, the window will appear immediately without waiting for content to be loaded.
4678
- *
4679
- * @property {ViewVisibility} [viewVisibility]
4680
- * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
4681
- */
4682
- /**
4683
- * @PORTED
4684
- * @typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
4685
- * @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
4686
- * @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
4687
- * @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
4688
- */
4689
- /**
4690
- * @PORTED
4691
- * @typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
4692
- * @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
4693
- * @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
4694
- */
4695
- /**
4696
- * @REMOVED
4697
- * @typedef {Object} ShowViewsOnSplitterDrag _Platform Windows Only_. Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
4698
- * @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
4699
- */
4700
- /**
4701
- * @REMOVED
4702
- * @typedef {Object} ShowViewsOnTabDrag _Platform Windows Only_. Allows views to be shown when the user is manipulating the layout by repositioning a tab.
4703
- * @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
4704
- */
4705
- /**
4706
- * @PORTED
4707
- * @typedef {object} CapturePageOptions
4708
- * @property { Area } [area] The area of the window to be captured.
4709
- * @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
4710
- * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
4711
- */
4712
- /**
4713
- * @PORTED
4714
- * @typedef { object } Area
4715
- * @property { number } height Area's height
4716
- * @property { number } width Area's width
4717
- * @property { number } x X coordinate of area's starting point
4718
- * @property { number } y Y coordinate of area's starting point
4719
- */
4720
- /**
4721
- * @PORTED
4722
- * @typedef {object} FindInPageOptions
4723
- * @property {boolean} [forward=true] Whether to search forward or backward.
4724
- * @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.
4725
- * @property {boolean} [matchCase=false] Whether search should be case-sensitive.
4726
- * @property {boolean} [wordStart=false] Whether to look only at the start of words.
4727
- * @property {boolean} [medialCapitalAsWordStart=false]
4728
- * 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>
4729
- * lowercase or non-letter. Accepts several other intra-word matches.
4730
- */
4731
- /**
4732
- * @REMOVED
4733
- * @typedef {object} Transition
4734
- * @property {Opacity} opacity - The Opacity transition
4735
- * @property {Position} position - The Position transition
4736
- * @property {Size} size - The Size transition
4737
- */
4738
- /**
4739
- * @PORTED
4740
- * @typedef {object} TransitionOptions
4741
- * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
4742
- this animation onto the end of the animation queue.
4743
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
4744
- */
4745
- /**
4746
- * @PORTED
4747
- * @typedef {object} Size
4748
- * @property {number} duration - The total time in milliseconds this transition should take.
4749
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
4750
- * @property {number} width - Optional if height is present. Defaults to the window's current width.
4751
- * @property {number} height - Optional if width is present. Defaults to the window's current height.
4752
- */
4753
- /**
4754
- * @PORTED
4755
- * @typedef {object} Position
4756
- * @property {number} duration - The total time in milliseconds this transition should take.
4757
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
4758
- * @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
4759
- * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
4760
- */
4761
- /**
4762
- * @PORTED
4763
- * @typedef {object} Opacity
4764
- * @property {number} duration - The total time in milliseconds this transition should take.
4765
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
4766
- * @property {number} opacity - This value is clamped from 0.0 to 1.0.
4767
- */
4768
- /**
4769
- * @REMOVED
4770
- * Bounds is a interface that has the properties of height,
4771
- * width, left, top which are all numbers
4772
- * @typedef { object } Bounds
4773
- * @property { number } height Get the application height bound
4774
- * @property { number } width Get the application width bound
4775
- * @property { number } top Get the application top bound
4776
- * @property { number } left Get the application left bound
4777
- * @property { number } right Get the application right bound
4778
- * @property { number } bottom Get the application bottom bound
4779
- */
4780
4053
  /**
4781
4054
  * A basic window that wraps a native HTML window. Provides more fine-grained
4782
4055
  * control over the window state such as the ability to minimize, maximize, restore, etc.
@@ -4792,83 +4065,6 @@ function requireInstance () {
4792
4065
  constructor(wire, identity) {
4793
4066
  super(wire, identity, 'window');
4794
4067
  }
4795
- /**
4796
- * Adds a listener to the end of the listeners array for the specified event.
4797
- * @param eventType - The type of the event.
4798
- * @param listener - Called whenever an event of the specified type occurs.
4799
- * @param options - Option to support event timestamps.
4800
- *
4801
- * @function addListener
4802
- * @memberof Window
4803
- * @instance
4804
- * @tutorial Window.EventEmitter
4805
- */
4806
- /**
4807
- * Adds a listener to the end of the listeners array for the specified event.
4808
- * @param eventType - The type of the event.
4809
- * @param listener - Called whenever an event of the specified type occurs.
4810
- * @param options - Option to support event timestamps.
4811
- *
4812
- * @function on
4813
- * @memberof Window
4814
- * @instance
4815
- * @tutorial Window.EventEmitter
4816
- */
4817
- /**
4818
- * 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.
4819
- * @param eventType - The type of the event.
4820
- * @param listener - The callback function.
4821
- * @param options - Option to support event timestamps.
4822
- *
4823
- * @function once
4824
- * @memberof Window
4825
- * @instance
4826
- * @tutorial Window.EventEmitter
4827
- */
4828
- /**
4829
- * Adds a listener to the beginning of the listeners array for the specified event.
4830
- * @param eventType - The type of the event.
4831
- * @param listener - The callback function.
4832
- * @param options - Option to support event timestamps.
4833
- *
4834
- * @function prependListener
4835
- * @memberof Window
4836
- * @instance
4837
- * @tutorial Window.EventEmitter
4838
- */
4839
- /**
4840
- * 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.
4841
- * The listener is added to the beginning of the listeners array.
4842
- * @param eventType - The type of the event.
4843
- * @param listener - The callback function.
4844
- * @param options - Option to support event timestamps.
4845
- *
4846
- * @function prependOnceListener
4847
- * @memberof Window
4848
- * @instance
4849
- * @tutorial Window.EventEmitter
4850
- */
4851
- /**
4852
- * Remove a listener from the listener array for the specified event.
4853
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
4854
- * @param eventType - The type of the event.
4855
- * @param listener - The callback function.
4856
- * @param options - Option to support event timestamps.
4857
- *
4858
- * @function removeListener
4859
- * @memberof Window
4860
- * @instance
4861
- * @tutorial Window.EventEmitter
4862
- */
4863
- /**
4864
- * Removes all listeners, or those of the specified event.
4865
- * @param eventType - The type of the event.
4866
- *
4867
- * @function removeAllListeners
4868
- * @memberof Window
4869
- * @instance
4870
- * @tutorial Window.EventEmitter
4871
- */
4872
4068
  /**
4873
4069
  * create a new window
4874
4070
  * @internal
@@ -5939,28 +5135,6 @@ function requireInstance () {
5939
5135
  .sendAction('window-authenticate', { userName, password, ...this.identity })
5940
5136
  .then(() => undefined);
5941
5137
  }
5942
- /**
5943
- * @typedef {object} ShowPopupMenuOptions
5944
- * @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
5945
- * @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
5946
- * @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
5947
- */
5948
- /**
5949
- * @typedef {object} MenuItemTemplate
5950
- * @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
5951
- * @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
5952
- * @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
5953
- * @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
5954
- * @property {boolean} [visible] - If false, the menu item will be entirely hidden.
5955
- * @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
5956
- * @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
5957
- * @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
5958
- */
5959
- /**
5960
- * @typedef {object} MenuResult
5961
- * @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
5962
- * @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
5963
- */
5964
5138
  /**
5965
5139
  * Shows a menu on the window.
5966
5140
  *
@@ -6061,31 +5235,6 @@ function requireInstance () {
6061
5235
  async closePopupMenu() {
6062
5236
  return this.wire.sendAction('close-popup-menu', { ...this.identity }).then(() => undefined);
6063
5237
  }
6064
- /**
6065
- * @PORTED
6066
- * @typedef {object} PopupOptions
6067
- * @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.
6068
- * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
6069
- * @property {Window~options} [initialOptions] - Window creation options when using `showPopupWindow` to create a new window.
6070
- * @property {Window~options} [additionalOptions] - Updatable window options applied to new and existing windows when shown as popups.
6071
- * @property {function} [onPopupResult] - Executed when this window's popup calls `dispatchPopupResult`. Note: if this is defined, `showPopupWindow` will not return a `PopupResult`.
6072
- * @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.
6073
- * @property {number} [height] - Height of the popup window (takes priority over `intialOptions` size properties).
6074
- * @property {number} [width] - Width of the popup window (takes priority over `intialOptions` size properties).
6075
- * @property {number} [x] - Left position where the popup window will be shown (relative to the window calling `showPopupWindow`).
6076
- * @property {number} [y] - Top position where the popup window will be shown (relative to the window calling `showPopupWindow`).
6077
- * @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.
6078
- * @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`.
6079
- * @property {boolean} [focus] - Determines if the popup window should or should not be focused when it is shown.
6080
- * @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.
6081
- */
6082
- /**
6083
- * @PORTED
6084
- * @typedef {object} PopupResult
6085
- * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
6086
- * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
6087
- * @property {* | undefined} [data] - Data passed to `dispatchPopupResult`.
6088
- */
6089
5238
  /**
6090
5239
  * Dispatch a result to the caller of `showPopupWindow`.
6091
5240
  *
@@ -6421,83 +5570,6 @@ class System extends base_1$j.EmitterBase {
6421
5570
  });
6422
5571
  });
6423
5572
  }
6424
- /**
6425
- * Adds a listener to the end of the listeners array for the specified event.
6426
- * @param eventType - The type of the event.
6427
- * @param listener - Called whenever an event of the specified type occurs.
6428
- * @param options - Option to support event timestamps.
6429
- *
6430
- * @function addListener
6431
- * @memberof System
6432
- * @instance
6433
- * @tutorial System.EventEmitter
6434
- */
6435
- /**
6436
- * Adds a listener to the end of the listeners array for the specified event.
6437
- * @param eventType - The type of the event.
6438
- * @param listener - Called whenever an event of the specified type occurs.
6439
- * @param options - Option to support event timestamps.
6440
- *
6441
- * @function on
6442
- * @memberof System
6443
- * @instance
6444
- * @tutorial System.EventEmitter
6445
- */
6446
- /**
6447
- * 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.
6448
- * @param eventType - The type of the event.
6449
- * @param listener - The callback function.
6450
- * @param options - Option to support event timestamps.
6451
- *
6452
- * @function once
6453
- * @memberof System
6454
- * @instance
6455
- * @tutorial System.EventEmitter
6456
- */
6457
- /**
6458
- * Adds a listener to the beginning of the listeners array for the specified event.
6459
- * @param eventType - The type of the event.
6460
- * @param listener - The callback function.
6461
- * @param options - Option to support event timestamps.
6462
- *
6463
- * @function prependListener
6464
- * @memberof System
6465
- * @instance
6466
- * @tutorial System.EventEmitter
6467
- */
6468
- /**
6469
- * 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.
6470
- * The listener is added to the beginning of the listeners array.
6471
- * @param eventType - The type of the event.
6472
- * @param listener - The callback function.
6473
- * @param options - Option to support event timestamps.
6474
- *
6475
- * @function prependOnceListener
6476
- * @memberof System
6477
- * @instance
6478
- * @tutorial System.EventEmitter
6479
- */
6480
- /**
6481
- * Remove a listener from the listener array for the specified event.
6482
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
6483
- * @param eventType - The type of the event.
6484
- * @param listener - The callback function.
6485
- * @param options - Option to support event timestamps.
6486
- *
6487
- * @function removeListener
6488
- * @memberof System
6489
- * @instance
6490
- * @tutorial System.EventEmitter
6491
- */
6492
- /**
6493
- * Removes all listeners, or those of the specified event.
6494
- * @param eventType - The type of the event.
6495
- *
6496
- * @function removeAllListeners
6497
- * @memberof System
6498
- * @instance
6499
- * @tutorial System.EventEmitter
6500
- */
6501
5573
  /**
6502
5574
  * Returns the version of the runtime. The version contains the major, minor,
6503
5575
  * build and revision numbers.
@@ -10699,20 +9771,6 @@ var clipboard = {};
10699
9771
  Object.defineProperty(clipboard, "__esModule", { value: true });
10700
9772
  clipboard.Clipboard = void 0;
10701
9773
  const base_1$d = base$1;
10702
- /**
10703
- * @PORTED
10704
- * WriteRequestType interface
10705
- * @typedef { object } WriteRequestType
10706
- * @property { string } data Data to be written
10707
- * @property { string } [type] Clipboard Type
10708
- */
10709
- /**
10710
- * @PORTED
10711
- * OpenFin.WriteAnyClipboardRequest interface
10712
- * @typedef { object } OpenFin.WriteAnyClipboardRequest
10713
- * @property { string } data Data to be written
10714
- * @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
10715
- */
10716
9774
  /**
10717
9775
  * The Clipboard API allows reading and writing to the clipboard in multiple formats.
10718
9776
  *
@@ -10925,83 +9983,6 @@ class ExternalApplication extends base_1$c.EmitterBase {
10925
9983
  super(wire, 'external-application', identity.uuid);
10926
9984
  this.identity = identity;
10927
9985
  }
10928
- /**
10929
- * Adds a listener to the end of the listeners array for the specified event.
10930
- * @param eventType - The type of the event.
10931
- * @param listener - Called whenever an event of the specified type occurs.
10932
- * @param options - Option to support event timestamps.
10933
- *
10934
- * @function addListener
10935
- * @memberof ExternalApplication
10936
- * @instance
10937
- * @tutorial ExternalApplication.EventEmitter
10938
- */
10939
- /**
10940
- * Adds a listener to the end of the listeners array for the specified event.
10941
- * @param eventType - The type of the event.
10942
- * @param listener - Called whenever an event of the specified type occurs.
10943
- * @param options - Option to support event timestamps.
10944
- *
10945
- * @function on
10946
- * @memberof ExternalApplication
10947
- * @instance
10948
- * @tutorial ExternalApplication.EventEmitter
10949
- */
10950
- /**
10951
- * 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.
10952
- * @param eventType - The type of the event.
10953
- * @param listener - The callback function.
10954
- * @param options - Option to support event timestamps.
10955
- *
10956
- * @function once
10957
- * @memberof ExternalApplication
10958
- * @instance
10959
- * @tutorial ExternalApplication.EventEmitter
10960
- */
10961
- /**
10962
- * Adds a listener to the beginning of the listeners array for the specified event.
10963
- * @param eventType - The type of the event.
10964
- * @param listener - The callback function.
10965
- * @param options - Option to support event timestamps.
10966
- *
10967
- * @function prependListener
10968
- * @memberof ExternalApplication
10969
- * @instance
10970
- * @tutorial ExternalApplication.EventEmitter
10971
- */
10972
- /**
10973
- * 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.
10974
- * The listener is added to the beginning of the listeners array.
10975
- * @param eventType - The type of the event.
10976
- * @param listener - The callback function.
10977
- * @param options - Option to support event timestamps.
10978
- *
10979
- * @function prependOnceListener
10980
- * @memberof ExternalApplication
10981
- * @instance
10982
- * @tutorial ExternalApplication.EventEmitter
10983
- */
10984
- /**
10985
- * Remove a listener from the listener array for the specified event.
10986
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
10987
- * @param eventType - The type of the event.
10988
- * @param listener - The callback function.
10989
- * @param options - Option to support event timestamps.
10990
- *
10991
- * @function removeListener
10992
- * @memberof ExternalApplication
10993
- * @instance
10994
- * @tutorial ExternalApplication.EventEmitter
10995
- */
10996
- /**
10997
- * Removes all listeners, or those of the specified event.
10998
- * @param eventType - The type of the event.
10999
- *
11000
- * @function removeAllListeners
11001
- * @memberof ExternalApplication
11002
- * @instance
11003
- * @tutorial ExternalApplication.EventEmitter
11004
- */
11005
9986
  /**
11006
9987
  * Retrieves information about the external application.
11007
9988
  *
@@ -11138,83 +10119,6 @@ class _Frame extends base_1$a.EmitterBase {
11138
10119
  super(wire, 'frame', identity.uuid, identity.name);
11139
10120
  this.identity = identity;
11140
10121
  }
11141
- /**
11142
- * Adds the listener function to the end of the listeners array for the specified event type.
11143
- * @param eventType - The type of the event.
11144
- * @param listener - Called whenever an event of the specified type occurs.
11145
- * @param options - Option to support event timestamps.
11146
- *
11147
- * @function addListener
11148
- * @memberof Frame
11149
- * @instance
11150
- * @tutorial Frame.EventEmitter
11151
- */
11152
- /**
11153
- * Adds a listener to the end of the listeners array for the specified event.
11154
- * @param eventType - The type of the event.
11155
- * @param listener - Called whenever an event of the specified type occurs.
11156
- * @param options - Option to support event timestamps.
11157
- *
11158
- * @function on
11159
- * @memberof Frame
11160
- * @instance
11161
- * @tutorial Frame.EventEmitter
11162
- */
11163
- /**
11164
- * 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.
11165
- * @param eventType - The type of the event.
11166
- * @param listener - The callback function.
11167
- * @param options - Option to support event timestamps.
11168
- *
11169
- * @function once
11170
- * @memberof Frame
11171
- * @instance
11172
- * @tutorial Frame.EventEmitter
11173
- */
11174
- /**
11175
- * Adds a listener to the beginning of the listeners array for the specified event.
11176
- * @param eventType - The type of the event.
11177
- * @param listener - The callback function.
11178
- * @param options - Option to support event timestamps.
11179
- *
11180
- * @function prependListener
11181
- * @memberof Frame
11182
- * @instance
11183
- * @tutorial Frame.EventEmitter
11184
- */
11185
- /**
11186
- * 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.
11187
- * The listener is added to the beginning of the listeners array.
11188
- * @param eventType - The type of the event.
11189
- * @param listener - The callback function.
11190
- * @param options - Option to support event timestamps.
11191
- *
11192
- * @function prependOnceListener
11193
- * @memberof Frame
11194
- * @instance
11195
- * @tutorial Frame.EventEmitter
11196
- */
11197
- /**
11198
- * Remove a listener from the listener array for the specified event.
11199
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
11200
- * @param eventType - The type of the event.
11201
- * @param listener - The callback function.
11202
- * @param options - Option to support event timestamps.
11203
- *
11204
- * @function removeListener
11205
- * @memberof Frame
11206
- * @instance
11207
- * @tutorial Frame.EventEmitter
11208
- */
11209
- /**
11210
- * Removes all listeners, or those of the specified event.
11211
- * @param eventType - The type of the event.
11212
- *
11213
- * @function removeAllListeners
11214
- * @memberof Frame
11215
- * @instance
11216
- * @tutorial Frame.EventEmitter
11217
- */
11218
10122
  /**
11219
10123
  * Returns a frame info object for the represented frame.
11220
10124
  *
@@ -14145,57 +13049,6 @@ function requireInteropBroker () {
14145
13049
  /*
14146
13050
  Client API
14147
13051
  */
14148
- /**
14149
- * @REMOVED
14150
- * SetContextOptions interface
14151
- * @typedef { object } SetContextOptions
14152
- * @property { Context } {context} - New context to set.
14153
- */
14154
- /**
14155
- * @REMOVED
14156
- * GetContextOptions interface
14157
- * @typedef { object } GetContextOptions
14158
- * @property { string } [contextType] - Context Type
14159
- */
14160
- // TODO: extract inline type and do proper comments
14161
- /**
14162
- * @REMOVED
14163
- * JoinContextGroupOptions interface
14164
- * @typedef { object } JoinContextGroupOptions
14165
- * @property { string } contextGroupId - Id of the context group.
14166
- * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
14167
- */
14168
- /**
14169
- * @REMOVED
14170
- * AddClientToContextGroupOptions interface
14171
- * @typedef { object } AddClientToContextGroupOptions
14172
- * @property { string } contextGroupId - Name of the context group.
14173
- */
14174
- /**
14175
- * @REMOVED
14176
- * RemoveFromContextGroupOptions interface
14177
- * @typedef { object } RemoveFromContextGroupOptions
14178
- * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
14179
- */
14180
- /**
14181
- * @REMOVED
14182
- * GetInfoForContextGroupOptions interface
14183
- * @typedef { object } GetInfoForContextGroupOptions
14184
- * @property { string } contextGroupId - Name of the context group to get info for.
14185
- */
14186
- /**
14187
- * @REMOVED
14188
- * GetAllClientsInContextGroupOptions interface
14189
- * @typedef { object } GetAllClientsInContextGroupOptions
14190
- * @property { string } contextGroupId - Name of the context group to get info for.
14191
- */
14192
- /**
14193
- * @PORTED
14194
- * InfoForIntentOptions interface
14195
- * @typedef { object } InfoForIntentOptions
14196
- * @property { string } name Name of the intent to get info for.
14197
- * @property { Context } [context] Optional context.
14198
- */
14199
13052
  /**
14200
13053
  * Sets a context for the context group of the incoming current entity.
14201
13054
  * @param setContextOptions - New context to set.
@@ -15354,95 +14207,6 @@ InteropClient$1.InteropClient = void 0;
15354
14207
  const base_1$2 = base$1;
15355
14208
  const SessionContextGroupClient_1 = SessionContextGroupClient$1;
15356
14209
  const utils_1$2 = utils$1;
15357
- /**
15358
- * @PORTED
15359
- * @typedef { object } Intent
15360
- * @summary The combination of an action and a context that is passed to an application for resolution.
15361
- * @property { string } name Name of the intent.
15362
- * @property { Context } context Data associated with the intent
15363
- */
15364
- /**
15365
- * @REMOVED
15366
- * @typedef { object } Subscription
15367
- * @summary Object returned when subscribing a handler.
15368
- * @property { function } unsubscribe Function to unsubscribe the handler.
15369
- */
15370
- /**
15371
- * @typedef { function } ContextHandler
15372
- * @summary Subscription function for addContextHandler.
15373
- */
15374
- /**
15375
- * @typedef { function } IntentHandler
15376
- * @summary Subscription function for registerIntentHandler
15377
- */
15378
- /**
15379
- * @PORTED
15380
- * @typedef { object } ClientIdentity
15381
- * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
15382
- * @property {string} uuid GUID of an application.
15383
- * @property {string} name Name of an entity in an application.
15384
- * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
15385
- */
15386
- /**
15387
- * @PORTED
15388
- * @typedef { object } ContextGroupInfo
15389
- * @summary Information for a Context Group. Contains metadata for displaying the group properly.
15390
- * @property {string} id Name of the context group
15391
- * @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.
15392
- */
15393
- /**
15394
- * @PORTED
15395
- * @typedef { object } DisplayMetadata
15396
- * @summary The display data for a Context Group.
15397
- * @property {string} name A user-readable name for this context group, e.g: `"Red"`
15398
- * @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
15399
- * @property {string} [glyph] A URL of an image that can be used to display this context group
15400
- */
15401
- /**
15402
- * @PORTED
15403
- * @typedef { object } Context
15404
- * @summary Data passed between entities and applications.
15405
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
15406
- * @property {string} [name] User-readable name for the incoming context.
15407
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
15408
- */
15409
- /**
15410
- * @REMOVED
15411
- * @typedef { object } ContextForIntent
15412
- * @summary Data passed between entities and applications, including an optional metadata.
15413
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
15414
- * @property {string} [name] User-readable name for the incoming context.
15415
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
15416
- * @property {any} [metadata]
15417
- */
15418
- /**
15419
- * @REMOVED
15420
- * @typedef { object } SessionContextGroup
15421
- * @summary An instance of a SessionContextGroup
15422
- * @property {string} id The SessionContextGroup's id.
15423
- * @property {setContext} setContext Sets a context of a certain type
15424
- * @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
15425
- * @property {addContextHandler} addContextHandler Adds a handler for context change.
15426
- */
15427
- /**
15428
- * @typedef {function} setContext
15429
- * @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
15430
- * @param context The Context to be set.
15431
- *
15432
- */
15433
- /**
15434
- * @typedef {function} getCurrentContext
15435
- * @summary A SessionContextGroup instance method for getting the current context of a certain type.
15436
- * @param contextType The Context Type to get. If not specified the last contextType set would get used.
15437
- *
15438
- */
15439
- /**
15440
- * @typedef {function} addContextHandler
15441
- * @summary A SessionContextGroup instance method for adding a handler for context change.
15442
- * @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.
15443
- * @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.
15444
- *
15445
- */
15446
14210
  /**
15447
14211
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
15448
14212
  *
@@ -16076,13 +14840,6 @@ function requireFactory () {
16076
14840
  const common_utils_1 = commonUtils;
16077
14841
  const defaultOverride = (Class) => new Class();
16078
14842
  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.';
16079
- /**
16080
- * @PORTED
16081
- * @typedef { object } InteropConfig
16082
- * @summary Information relevant to the Interop Broker.
16083
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
16084
- * @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
16085
- */
16086
14843
  /**
16087
14844
  * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
16088
14845
  *