@openfin/core 35.78.6 → 35.78.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/out/mock.js CHANGED
@@ -1232,6 +1232,15 @@ class LayoutNode {
1232
1232
  /**
1233
1233
  * Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
1234
1234
  *
1235
+ * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
1236
+ * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
1237
+ * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
1238
+ * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
1239
+ *
1240
+ * @param views The views that will populate the new TabStack.
1241
+ * @param options Additional options that control new TabStack creation.
1242
+ * @returns The newly-created TabStack.
1243
+ *
1235
1244
  * @example
1236
1245
  * ```js
1237
1246
  * if (!fin.me.isView) {
@@ -1266,13 +1275,16 @@ class LayoutNode {
1266
1275
  * console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
1267
1276
  *
1268
1277
  * ```
1278
+ * @experimental
1269
1279
  */
1270
1280
  this.createAdjacentStack = async (views, options) => {
1271
1281
  const entityId = await __classPrivateFieldGet$e(this, _LayoutNode_client, "f").createAdjacentStack(this.entityId, views, options);
1272
1282
  return LayoutNode.getEntity({ entityId, type: 'stack' }, __classPrivateFieldGet$e(this, _LayoutNode_client, "f"));
1273
1283
  };
1274
1284
  /**
1275
- * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
1285
+ * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow.
1286
+ *
1287
+ * @param edge Edge whose adjacent TabStacks will be returned.
1276
1288
  *
1277
1289
  * @example
1278
1290
  * ```js
@@ -1292,6 +1304,7 @@ class LayoutNode {
1292
1304
  * console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
1293
1305
  *
1294
1306
  * ```
1307
+ * @experimental
1295
1308
  */
1296
1309
  this.getAdjacentStacks = async (edge) => {
1297
1310
  const adjacentStacks = await __classPrivateFieldGet$e(this, _LayoutNode_client, "f").getAdjacentStacks({
@@ -1335,74 +1348,10 @@ LayoutNode.getEntity = (definition, client) => {
1335
1348
  throw new Error(`Unrecognised Layout Entity encountered ('${JSON.stringify(definition)})`);
1336
1349
  }
1337
1350
  };
1338
- /**
1339
- * @typedef {string} LayoutPosition
1340
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
1341
- */
1342
- /**
1343
- * @typedef {object} StackCreationOptions
1344
- * @summary Stack creation options.
1345
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
1346
- */
1347
- /**
1348
- * @typedef {object} TabStack~AddViewOptions
1349
- * @summary Options to use when adding a view to a {@link TabStack}
1350
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
1351
- */
1352
1351
  /**
1353
1352
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
1354
1353
  */
1355
1354
  class TabStack extends LayoutNode {
1356
- /**
1357
- * Determines if this {@link TabStack} is the top level content item in the current layout.
1358
- * @function isRoot
1359
- * @memberof TabStack
1360
- * @instance
1361
- * @tutorial TabStack.isRoot
1362
- * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
1363
- */
1364
- /**
1365
- * Determines if this {@link TabStack} exists.
1366
- * @function exists
1367
- * @instance
1368
- * @memberof TabStack
1369
- * @tutorial TabStack.exists
1370
- * @returns Resolves true if this is the TabStack exists, or false if it has been destroyed.
1371
- */
1372
- /**
1373
- * Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
1374
- * @function getParent
1375
- * @instance
1376
- * @memberof TabStack
1377
- * @tutorial TabStack.getParent
1378
- * @returns is the root content item or does not exist.
1379
- */
1380
- /**
1381
- * Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
1382
- * @function getAdjacentStacks
1383
- * @instance
1384
- * @memberof TabStack
1385
- * @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
1386
- *
1387
- * @tutorial TabStack.getAdjacentStacks
1388
- */
1389
- /**
1390
- * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
1391
- *
1392
- * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
1393
- * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
1394
- * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
1395
- * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
1396
- *
1397
- * @function createAdjacentStack
1398
- * @instance
1399
- * @memberof TabStack
1400
- * @param views - List of identities or view creation options of the views to include in the stack
1401
- * @param options - Creation options.
1402
- * @returns The created TabStack.
1403
- * @tutorial TabStack.createAdjacentStack
1404
- * @experimental
1405
- */
1406
1355
  /** @internal */
1407
1356
  constructor(client, entityId) {
1408
1357
  super(client, entityId);
@@ -1535,57 +1484,6 @@ _TabStack_client = new WeakMap();
1535
1484
  * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
1536
1485
  */
1537
1486
  class ColumnOrRow extends LayoutNode {
1538
- /**
1539
- * Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
1540
- * @function isRoot
1541
- * @memberof ColumnOrRow
1542
- * @instance
1543
- * @tutorial ColumnOrRow.isRoot
1544
- * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
1545
- */
1546
- /**
1547
- * Determines if this {@link ColumnOrRow} exists.
1548
- * @function exists
1549
- * @instance
1550
- * @memberof ColumnOrRow
1551
- * @tutorial ColumnOrRow.exists
1552
- * @returns Resolves true if the TabStack exists, or false if it has been destroyed.
1553
- */
1554
- /**
1555
- * Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
1556
- * @function getParent
1557
- * @instance
1558
- * @memberof ColumnOrRow
1559
- * @tutorial ColumnOrRow.getParent
1560
- * @returns Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if
1561
- * this {@link ColumnOrRow}does not exist or is the root content item.
1562
- */
1563
- /**
1564
- * Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
1565
- * @function getAdjacentStacks
1566
- * @instance
1567
- * @memberof ColumnOrRow
1568
- * @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
1569
- *
1570
- * @tutorial ColumnOrRow.getAdjacentStacks
1571
- */
1572
- /**
1573
- * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
1574
- *
1575
- * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
1576
- * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
1577
- * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
1578
- * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
1579
- *
1580
- * @function createAdjacentStack
1581
- * @instance
1582
- * @memberof ColumnOrRow
1583
- * @param views - List of identities or view creation options of the views to include in the stack
1584
- * @param options - Creation options.
1585
- * @returns The created TabStack
1586
- * @tutorial ColumnOrRow.createAdjacentStack
1587
- * @experimental
1588
- */
1589
1487
  /**
1590
1488
  * @internal
1591
1489
  */
@@ -1631,7 +1529,8 @@ var layout_constants = {};
1631
1529
  Object.defineProperty(layout_constants, "__esModule", { value: true });
1632
1530
  layout_constants.DEFAULT_LAYOUT_KEY = layout_constants.LAYOUT_CONTROLLER_ID = void 0;
1633
1531
  layout_constants.LAYOUT_CONTROLLER_ID = 'layout-entities';
1634
- layout_constants.DEFAULT_LAYOUT_KEY = 'default';
1532
+ // TODO: eventually export this somehow
1533
+ layout_constants.DEFAULT_LAYOUT_KEY = '__default__';
1635
1534
 
1636
1535
  var main = {};
1637
1536
 
@@ -2660,10 +2559,8 @@ class WebContents extends base_1$k.EmitterBase {
2660
2559
  });
2661
2560
  const { data: { willOpen, options: popupOptions } } = tryCreatePayload;
2662
2561
  if (willOpen) {
2663
- await this.wire.environment.createChildContent({
2664
- options: popupOptions.initialOptions,
2665
- entityType: 'window'
2666
- });
2562
+ // Solve the issue where Interop in a popup window with non cross-origin url is not working(core-1076).
2563
+ await this.fin.Window.create(popupOptions.initialOptions);
2667
2564
  }
2668
2565
  const normalizePopupResult = (payload) => {
2669
2566
  const { name, uuid, result, data } = payload;
@@ -2725,169 +2622,6 @@ function requireInstance$2 () {
2725
2622
  const layout_constants_1 = layout_constants;
2726
2623
  const main_1 = main;
2727
2624
  const window_1 = requireWindow();
2728
- /**
2729
- * @PORTED
2730
- * @typedef {object} View~options
2731
- * @summary View creation options.
2732
- * @desc This is the options object required by {@link View.create View.create}.
2733
- *
2734
- * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
2735
- * (defaults to `"about:blank"` when omitted).
2736
- *
2737
- * @property {object} [experimental]
2738
- * Configurations for API injection.
2739
- *
2740
- * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
2741
- *
2742
- * @property {object} [accelerator]
2743
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
2744
- *
2745
- * @property {boolean} [accelerator.devtools=false]
2746
- * If `true`, enables the devtools keyboard shortcut:<br>
2747
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
2748
- *
2749
- * @property {boolean} [accelerator.reload=false]
2750
- * If `true`, enables the reload keyboard shortcuts:<br>
2751
- * `Ctrl` + `R` _(Windows)_<br>
2752
- * `F5` _(Windows)_<br>
2753
- * `Command` + `R` _(Mac)_
2754
- *
2755
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
2756
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
2757
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
2758
- * `Shift` + `F5` _(Windows)_<br>
2759
- * `Command` + `Shift` + `R` _(Mac)_
2760
- *
2761
- * @property {boolean} [accelerator.zoom=false]
2762
- * If `true`, enables the zoom keyboard shortcuts:<br>
2763
- * `Ctrl` + `+` _(Zoom In)_<br>
2764
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
2765
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
2766
- * `Ctrl` + `-` _(Zoom Out)_<br>
2767
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
2768
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
2769
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
2770
- * `Ctrl` + `0` _(Restore to 100%)_
2771
- *
2772
- * @property {object} [api]
2773
- * Configurations for API injection.
2774
- *
2775
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
2776
- *
2777
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
2778
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
2779
- *
2780
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
2781
- * Autoplay policy to apply to content in the window, can be
2782
- * `no-user-gesture-required`, `user-gesture-required`,
2783
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
2784
- *
2785
- * @property {object} [autoResize] AutoResize options
2786
- *
2787
- * @property {object} [bounds] initial bounds given relative to the window.
2788
- *
2789
- * @property {string} [backgroundColor="#FFF"] - _Updatable._
2790
- * The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
2791
- * (`document.body.style.backgroundColor`),
2792
- * this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
2793
- * areas when growing a window. Setting
2794
- * this value to the anticipated content background color can help improve user experience.
2795
- * Default is white.
2796
- *
2797
- * @property {object} [contentNavigation]
2798
- * Restrict navigation to URLs that match an allowed pattern.
2799
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
2800
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
2801
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
2802
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
2803
- *
2804
- * @property {object} [contentRedirect]
2805
- * Restrict redirects to URLs that match an allowed pattern.
2806
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
2807
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
2808
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
2809
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
2810
- *
2811
- * @property {object} [contextMenuSettings] - _Updatable._
2812
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
2813
- * Configure the context menu when right-clicking on a view.
2814
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
2815
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
2816
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
2817
- *
2818
- * @property {object} [contextMenuOptions] - _Updatable._
2819
- * Configure the context menu when right-clicking on a view. Supported menu items:
2820
- * 'separator'
2821
- * 'cut'
2822
- * 'copy'
2823
- * 'copyImage',
2824
- * 'paste'
2825
- * 'spellCheck'
2826
- * 'inspect'
2827
- * 'reload'
2828
- * 'navigateForward'
2829
- * 'navigateBack'
2830
- * 'print'
2831
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
2832
- * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
2833
- *
2834
- * @property {any} [customData=""] - _Updatable._
2835
- * A field that the user can attach serializable data to be ferried around with the view options.
2836
- * _When omitted, the default value of this property is the empty string (`""`)._
2837
- *
2838
- * @property {any} [customContext=""] - _Updatable._
2839
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
2840
- * is called.
2841
- * When omitted, the default value of this property is the empty string (`""`).
2842
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
2843
- *
2844
- * @property {object[]} [hotkeys=[]] - _Updatable._
2845
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
2846
- * Within Platform, OpenFin also implements a set of pre-defined actions called
2847
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
2848
- * that can be assigned to a specific hotkey in the platform manifest.
2849
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
2850
- * @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
2851
- *
2852
- * @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
2853
- * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
2854
- * if the view isn't part of the new layout when running `Layout.replace`.
2855
- *
2856
- * @property {string} name
2857
- * The name of the view.
2858
- *
2859
- * @property {boolean} [detachOnClose=false] - _Updatable._
2860
- * Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
2861
- * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
2862
- *
2863
- * @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
2864
- * but the properties in the manifest will take precedence if there is any collision.
2865
- *
2866
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
2867
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
2868
- * from the parent application.
2869
- *
2870
- * @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
2871
- *
2872
- * @property {string} [processAffinity=<application uuid>]
2873
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
2874
- *
2875
- * @property {boolean} [spellCheck=false]
2876
- * Enable spell check in input text fields for the view.
2877
- *
2878
- * @property {Identity} [target]
2879
- * The identity of the window this view should be attached to.
2880
- *
2881
- * @property {string} [url="about:blank"]
2882
- * The URL of the view.
2883
- *
2884
- * @property {string} [uuid=<application uuid>]
2885
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
2886
- * If omitted, defaults to the `uuid` of the application spawning the view.
2887
- * If given, must match the `uuid` of the application spawning the view.
2888
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
2889
- * really no need to provide it.
2890
- */
2891
2625
  /**
2892
2626
  * A View can be used to embed additional web content into a Window.
2893
2627
  * It is like a child window, except it is positioned relative to its owning window.
@@ -3463,7 +3197,7 @@ function requireView () {
3463
3197
  * * {@link ViewModule} contains static members of the `View` API, accessible through `fin.View`.
3464
3198
  * * {@link View} describes an instance of an OpenFin View, e.g. as returned by `fin.View.getCurrent`.
3465
3199
  *
3466
- * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
3200
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
3467
3201
  * both of these were documented on the same page.
3468
3202
  *
3469
3203
  * @packageDocumentation
@@ -3511,100 +3245,6 @@ function requireInstance$1 () {
3511
3245
  });
3512
3246
  return windowList;
3513
3247
  }
3514
- /**
3515
- * Adds a listener to the end of the listeners array for the specified event.
3516
- * @param eventType - The type of the event.
3517
- * @param listener - Called whenever an event of the specified type occurs.
3518
- * @param options - Option to support event timestamps.
3519
- *
3520
- * @function addListener
3521
- * @memberof Application
3522
- * @instance
3523
- * @tutorial Application.EventEmitter
3524
- */
3525
- /**
3526
- * Adds a listener to the end of the listeners array for the specified event.
3527
- * @param eventType - The type of the event.
3528
- * @param listener - Called whenever an event of the specified type occurs.
3529
- * @param options - Option to support event timestamps.
3530
- *
3531
- * @function on
3532
- * @memberof Application
3533
- * @instance
3534
- * @tutorial Application.EventEmitter
3535
- */
3536
- /**
3537
- * 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.
3538
- * @param eventType - The type of the event.
3539
- * @param listener - The callback function.
3540
- * @param options - Option to support event timestamps.
3541
- *
3542
- * @function once
3543
- * @memberof Application
3544
- * @instance
3545
- * @tutorial Application.EventEmitter
3546
- */
3547
- /**
3548
- * Adds a listener to the beginning of the listeners array for the specified event.
3549
- * @param eventType - The type of the event.
3550
- * @param listener - The callback function.
3551
- * @param options - Option to support event timestamps.
3552
- *
3553
- * @function prependListener
3554
- * @memberof Application
3555
- * @instance
3556
- * @tutorial Application.EventEmitter
3557
- */
3558
- /**
3559
- * 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.
3560
- * The listener is added to the beginning of the listeners array.
3561
- * @param eventType - The type of the event.
3562
- * @param listener - The callback function.
3563
- * @param options - Option to support event timestamps.
3564
- *
3565
- * @function prependOnceListener
3566
- * @memberof Application
3567
- * @instance
3568
- * @tutorial Application.EventEmitter
3569
- */
3570
- /**
3571
- * Remove a listener from the listener array for the specified event.
3572
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
3573
- * @param eventType - The type of the event.
3574
- * @param listener - The callback function.
3575
- * @param options - Option to support event timestamps.
3576
- *
3577
- * @function removeListener
3578
- * @memberof Application
3579
- * @instance
3580
- * @tutorial Application.EventEmitter
3581
- */
3582
- /**
3583
- * Removes all listeners, or those of the specified event.
3584
- * @param eventType - The type of the event.
3585
- *
3586
- * @function removeAllListeners
3587
- * @memberof Application
3588
- * @instance
3589
- * @tutorial Application.EventEmitter
3590
- */
3591
- /**
3592
- * JumpListCategory interface
3593
- * @typedef { object } JumpListCategory
3594
- * @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.
3595
- * @property { JumpListItem[] } items Array of JumpListItem objects
3596
- */
3597
- /**
3598
- * @PORTED
3599
- * JumpListItem interface
3600
- * @typedef { object } JumpListItem
3601
- * @property { string } type One of the following: "task" or "separator". Defaults to task.
3602
- * @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
3603
- * @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
3604
- * @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.
3605
- * @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).
3606
- * @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.
3607
- */
3608
3248
  /**
3609
3249
  * Determines if the application is currently running.
3610
3250
  *
@@ -4604,7 +4244,7 @@ function requireApplication () {
4604
4244
  * * {@link ApplicationModule} contains static members of the `Application` API, accessible through `fin.Application`.
4605
4245
  * * {@link Application} describes an instance of an OpenFin Application, e.g. as returned by `fin.Application.getCurrent`.
4606
4246
  *
4607
- * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
4247
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
4608
4248
  * both of these were documented on the same page.
4609
4249
  *
4610
4250
  * @packageDocumentation
@@ -4630,476 +4270,6 @@ function requireInstance () {
4630
4270
  const main_1 = main;
4631
4271
  const view_1 = requireView();
4632
4272
  const warnings_1 = warnings;
4633
- /**
4634
- * @PORTED
4635
- * @typedef { object } Margins
4636
- * @property { string } [marginType]
4637
- * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
4638
- * you will also need to specify `top`, `bottom`, `left`, and `right`.
4639
- *
4640
- * @property { number } [top] The top margin of the printed web page, in pixels.
4641
- * @property { number } [bottom] The bottom margin of the printed web page, in pixels.
4642
- * @property { number } [left] The left margin of the printed web page, in pixels.
4643
- * @property { number } [right] The right margin of the printed web page, in pixels.
4644
- */
4645
- /**
4646
- * @PORTED
4647
- * @typedef { object } Dpi
4648
- * @property { number } [horizontal] The horizontal dpi
4649
- * @property { number } [vertical] The vertical dpi
4650
- */
4651
- /**
4652
- * @PORTED
4653
- * @typedef { object } PrintOptions
4654
- * @property { boolean } [silent=false] Don't ask user for print settings.
4655
- * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
4656
- * @property { string } [deviceName=''] Set the printer device name to use.
4657
- * @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
4658
- * @property { Margins } [margins] Set margins for the printed web page
4659
- * @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
4660
- * @property { number } [scaleFactor] The scale factor of the web page.
4661
- * @property { number } [pagesPerSheet] The number of pages to print per page sheet.
4662
- * @property { boolean } [collate] Whether the web page should be collated.
4663
- * @property { number } [copies] The number of copies of the web page to print.
4664
- * @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
4665
- * @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
4666
- * @property { Dpi } [dpi] Set dpi for the printed web page
4667
- */
4668
- /**
4669
- * @REMOVED
4670
- * PrinterInfo interface
4671
- * @typedef { object } PrinterInfo
4672
- * @property { string } name Printer Name
4673
- * @property { string } description Printer Description
4674
- * @property { number } status Printer Status
4675
- * @property { boolean } isDefault Indicates that system's default printer
4676
- */
4677
- /**
4678
- * @REMOVED
4679
- * SharedWorkerInfo interface
4680
- * @typedef { object } SharedWorkerInfo
4681
- * @property { string } id The unique id of the shared worker.
4682
- * @property { string } url The url of the shared worker.
4683
- */
4684
- /**
4685
- * @PORTED
4686
- * ContentCreationRule interface
4687
- * @typedef { object } ContentCreationRule
4688
- * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
4689
- * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
4690
- * @property { object } options Window creation options or View creation options.
4691
- */
4692
- /**
4693
- * @PORTED
4694
- * @typedef {object} Window~options
4695
- * @summary Window creation options.
4696
- * @desc This is the options object required by {@link Window.create Window.create}.
4697
- *
4698
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
4699
- * (defaults to `"about:blank"` when omitted).
4700
- *
4701
- * _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
4702
- *
4703
- * @property {object} [accelerator]
4704
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
4705
- *
4706
- * @property {boolean} [accelerator.devtools=false]
4707
- * If `true`, enables the devtools keyboard shortcut:<br>
4708
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
4709
- *
4710
- * @property {boolean} [accelerator.reload=false]
4711
- * If `true`, enables the reload keyboard shortcuts:<br>
4712
- * `Ctrl` + `R` _(Windows)_<br>
4713
- * `F5` _(Windows)_<br>
4714
- * `Command` + `R` _(Mac)_
4715
- *
4716
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
4717
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
4718
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
4719
- * `Shift` + `F5` _(Windows)_<br>
4720
- * `Command` + `Shift` + `R` _(Mac)_
4721
- *
4722
- * @property {boolean} [accelerator.zoom=false]
4723
- * 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.
4724
- * If `true`, enables the zoom keyboard shortcuts:<br>
4725
- * `Ctrl` + `+` _(Zoom In)_<br>
4726
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
4727
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
4728
- * `Ctrl` + `-` _(Zoom Out)_<br>
4729
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
4730
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
4731
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
4732
- * `Ctrl` + `0` _(Restore to 100%)_
4733
- *
4734
- * @property {object} [alphaMask] - _Experimental._ _Updatable._
4735
- * <br>
4736
- * alphaMask turns anything of matching RGB value transparent.
4737
- * <br>
4738
- * Caveats:
4739
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
4740
- * * User cannot click-through transparent regions
4741
- * * Not supported on Mac
4742
- * * Windows Aero must be enabled
4743
- * * Won't make visual sense on Pixel-pushed environments such as Citrix
4744
- * * Not supported on rounded corner windows
4745
- * @property {number} [alphaMask.red=-1] 0-255
4746
- * @property {number} [alphaMask.green=-1] 0-255
4747
- * @property {number} [alphaMask.blue=-1] 0-255
4748
- *
4749
- * @property {boolean} [alwaysOnTop=false] - _Updatable._
4750
- * A flag to always position the window at the top of the window stack.
4751
- *
4752
- * @property {object} [api]
4753
- * Configurations for API injection.
4754
- *
4755
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
4756
- *
4757
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
4758
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
4759
- *
4760
- * @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
4761
- *
4762
- * @property {number} [aspectRatio=0] - _Updatable._
4763
- * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
4764
- * an aspect ratio will not be enforced.
4765
- *
4766
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
4767
- * Autoplay policy to apply to content in the window, can be
4768
- * `no-user-gesture-required`, `user-gesture-required`,
4769
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
4770
- *
4771
- * @property {boolean} [autoShow=true]
4772
- * A flag to automatically show the window when it is created.
4773
- *
4774
- * @property {string} [backgroundColor="#FFF"]
4775
- * The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
4776
- * (`document.body.style.backgroundColor`),
4777
- * this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
4778
- * areas when growing a window. Setting
4779
- * this value to the anticipated content background color can help improve user experience.
4780
- * Default is white.
4781
- *
4782
- * @property {object} [contentCreation]
4783
- * Apply rules that determine how user interaction (`window.open` and links) creates content.
4784
- * @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
4785
- *
4786
- * @property {object} [contentNavigation]
4787
- * Restrict navigation to URLs that match an allowed pattern.
4788
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4789
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4790
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
4791
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
4792
- *
4793
- * @property {object} [contentRedirect]
4794
- * Restrict redirects to URLs that match an allowed pattern.
4795
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4796
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4797
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
4798
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
4799
- *
4800
- * @property {boolean} [contextMenu=true] - _Updatable._
4801
- * A flag to show the context menu when right-clicking on a window.
4802
- * Gives access to the devtools for the window.
4803
- *
4804
- * @property {object} [contextMenuSettings] - _Updatable._
4805
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
4806
- * Configure the context menu when right-clicking on a window.
4807
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
4808
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
4809
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
4810
- *
4811
- * @property {object} [contextMenuOptions] - _Updatable._
4812
- * Configure the context menu when right-clicking on a window. Supported menu items:
4813
- * 'separator'
4814
- * 'cut'
4815
- * 'copy'
4816
- * 'paste'
4817
- * 'spellCheck'
4818
- * 'inspect'
4819
- * 'reload'
4820
- * 'navigateForward'
4821
- * 'navigateBack'
4822
- * 'print'
4823
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
4824
- * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
4825
- *
4826
- * @property {object} [cornerRounding] - _Updatable._
4827
- * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
4828
- * average of _height_ and _width_.
4829
- * @property {number} [cornerRounding.height=0] The height in pixels.
4830
- * @property {number} [cornerRounding.width=0] The width in pixels.
4831
- *
4832
- * @property {any} [customContext=""] - _Updatable. Inheritable._
4833
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
4834
- * is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
4835
- * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
4836
- * _When omitted, _inherits_ from the parent application._
4837
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
4838
- *
4839
- * @property {any} [customData=""] - _Updatable. Inheritable._
4840
- * A field that the user can attach serializable data to be ferried around with the window options.
4841
- * _When omitted, _inherits_ from the parent application._
4842
- *
4843
- * @property {object[]} [customRequestHeaders]
4844
- * Defines list of custom headers for requests sent by the window.
4845
- * @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
4846
- * @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
4847
- * where the object key is the name of header and value at key is the value of the header
4848
- *
4849
- * @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
4850
- * Toggling off would keep the Window alive even if all its Views were closed.
4851
- * This is meant for advanced users and should be used with caution.
4852
- * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
4853
- * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
4854
- * ** note ** - This option is ignored in non-Platforms apps.
4855
- *
4856
- * @property {boolean} [defaultCentered=false]
4857
- * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
4858
- * this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
4859
- * somewhat above center vertically.
4860
- *
4861
- * @property {number} [defaultHeight=500]
4862
- * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
4863
- * in favor of the cached value.
4864
- *
4865
- * @property {number} [defaultLeft=100]
4866
- * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
4867
- * launches in favor of the cached value.
4868
- *
4869
- * @property {number} [defaultTop=100]
4870
- * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
4871
- * launches in favor of the cached value.
4872
- *
4873
- * @property {number} [defaultWidth=800]
4874
- * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
4875
- * launches in favor of the cached value.
4876
- *
4877
- * @property {boolean} [includeInSnapshots=true] - _Updatable._
4878
- * When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
4879
- * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
4880
- *
4881
- * @property {boolean} [frame=true] - _Updatable._
4882
- * A flag to show the frame.
4883
- *
4884
- * @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
4885
- *
4886
- * @property {object[]} [hotkeys=[]] - _Updatable._
4887
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
4888
- * Within Platform, OpenFin also implements a set of pre-defined actions called
4889
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
4890
- * that can be assigned to a specific hotkey in the platform manifest.
4891
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
4892
- * @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
4893
- *
4894
- * @property {string} [icon] - _Updatable. Inheritable._
4895
- * A URL for the icon to be shown in the window title bar and the taskbar.
4896
- * When omitted, inherits from the parent application._
4897
- * note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
4898
- *
4899
- * @property {number} [maxHeight=-1] - _Updatable._
4900
- * The maximum height of a window. Will default to the OS defined value if set to -1.
4901
- *
4902
- * @property {boolean} [maximizable=true] - _Updatable._
4903
- * A flag that lets the window be maximized.
4904
- *
4905
- * @property {number} [maxWidth=-1] - _Updatable._
4906
- * The maximum width of a window. Will default to the OS defined value if set to -1.
4907
- *
4908
- * @property {number} [minHeight=0] - _Updatable._
4909
- * The minimum height of a window.
4910
- *
4911
- * @property {boolean} [minimizable=true] - _Updatable._
4912
- * A flag that lets the window be minimized.
4913
- *
4914
- * @property {number} [minWidth=0] - _Updatable._
4915
- * The minimum width of a window.
4916
- *
4917
- * @property {Identity} [modalParentIdentity]
4918
- * Parent identity of a modal window. It will create a modal child window when this option is set.
4919
- *
4920
- * @property {string} name
4921
- * The name of the window.
4922
- *
4923
- * @property {number} [opacity=1.0] - _Updatable._
4924
- * A flag that specifies how transparent the window will be.
4925
- * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
4926
- * This value is clamped between `0.0` and `1.0`.
4927
- * * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
4928
- *
4929
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
4930
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
4931
- * from the parent application.
4932
- *
4933
- * @property {string} [processAffinity]
4934
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
4935
- *
4936
- * @property {boolean} [resizable=true] - _Updatable._
4937
- * A flag to allow the user to resize the window.
4938
- *
4939
- * @property {object} [resizeRegion] - _Updatable._
4940
- * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
4941
- * @property {number} [resizeRegion.bottomRightCorner=9]
4942
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
4943
- * @property {number} [resizeRegion.size=7]
4944
- * The size in pixels.
4945
- * @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
4946
- * Sides that a window can be resized from.
4947
- *
4948
- * @property {boolean} [saveWindowState=true]
4949
- * A flag to cache the location of the window.
4950
- * ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
4951
- *
4952
- * @property {boolean} [ignoreSavedWindowState]
4953
- * A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
4954
- *
4955
- * @property {boolean} [shadow=false]
4956
- * A flag to display a shadow on frameless windows.
4957
- * `shadow` and `cornerRounding` are mutually exclusive.
4958
- * On Windows 7, Aero theme is required.
4959
- *
4960
- * @property {boolean} [showBackgroundImages=false] - _Updatable._
4961
- * Platforms Only. If true, will show background images in the layout when the Views are hidden.
4962
- * This occurs when the window is resizing or a tab is being dragged within the layout.
4963
- *
4964
- * @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
4965
- * A flag to show the window's icon in the taskbar.
4966
- *
4967
- * @property {boolean} [smallWindow=false]
4968
- * A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
4969
- * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
4970
- * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
4971
- *
4972
- * @property {boolean} [spellCheck=false]
4973
- * Enable spell check in input text fields for the window.
4974
- *
4975
- * @property {string} [state="normal"]
4976
- * The visible state of the window on creation.
4977
- * One of:
4978
- * * `"maximized"`
4979
- * * `"minimized"`
4980
- * * `"normal"`
4981
- *
4982
- * @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
4983
- *
4984
- * @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
4985
- * Specify a taskbar group for the window.
4986
- * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
4987
- *
4988
- * @property {string} [url="about:blank"]
4989
- * The URL of the window.
4990
- *
4991
- * @property {string} [uuid=<application uuid>]
4992
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
4993
- * If omitted, defaults to the `uuid` of the application spawning the window.
4994
- * If given, must match the `uuid` of the application spawning the window.
4995
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
4996
- * really no need to provide it.
4997
- *
4998
- * @property {boolean} [waitForPageLoad=false]
4999
- * When set to `true`, the window will not appear until the `window` object's `load` event fires.
5000
- * When set to `false`, the window will appear immediately without waiting for content to be loaded.
5001
- *
5002
- * @property {ViewVisibility} [viewVisibility]
5003
- * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
5004
- */
5005
- /**
5006
- * @PORTED
5007
- * @typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
5008
- * @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
5009
- * @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
5010
- * @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
5011
- */
5012
- /**
5013
- * @PORTED
5014
- * @typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
5015
- * @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
5016
- * @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
5017
- */
5018
- /**
5019
- * @REMOVED
5020
- * @typedef {Object} ShowViewsOnSplitterDrag _Platform Windows Only_. Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
5021
- * @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
5022
- */
5023
- /**
5024
- * @REMOVED
5025
- * @typedef {Object} ShowViewsOnTabDrag _Platform Windows Only_. Allows views to be shown when the user is manipulating the layout by repositioning a tab.
5026
- * @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
5027
- */
5028
- /**
5029
- * @PORTED
5030
- * @typedef {object} CapturePageOptions
5031
- * @property { Area } [area] The area of the window to be captured.
5032
- * @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
5033
- * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
5034
- */
5035
- /**
5036
- * @PORTED
5037
- * @typedef { object } Area
5038
- * @property { number } height Area's height
5039
- * @property { number } width Area's width
5040
- * @property { number } x X coordinate of area's starting point
5041
- * @property { number } y Y coordinate of area's starting point
5042
- */
5043
- /**
5044
- * @PORTED
5045
- * @typedef {object} FindInPageOptions
5046
- * @property {boolean} [forward=true] Whether to search forward or backward.
5047
- * @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.
5048
- * @property {boolean} [matchCase=false] Whether search should be case-sensitive.
5049
- * @property {boolean} [wordStart=false] Whether to look only at the start of words.
5050
- * @property {boolean} [medialCapitalAsWordStart=false]
5051
- * 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>
5052
- * lowercase or non-letter. Accepts several other intra-word matches.
5053
- */
5054
- /**
5055
- * @REMOVED
5056
- * @typedef {object} Transition
5057
- * @property {Opacity} opacity - The Opacity transition
5058
- * @property {Position} position - The Position transition
5059
- * @property {Size} size - The Size transition
5060
- */
5061
- /**
5062
- * @PORTED
5063
- * @typedef {object} TransitionOptions
5064
- * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
5065
- this animation onto the end of the animation queue.
5066
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
5067
- */
5068
- /**
5069
- * @PORTED
5070
- * @typedef {object} Size
5071
- * @property {number} duration - The total time in milliseconds this transition should take.
5072
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
5073
- * @property {number} width - Optional if height is present. Defaults to the window's current width.
5074
- * @property {number} height - Optional if width is present. Defaults to the window's current height.
5075
- */
5076
- /**
5077
- * @PORTED
5078
- * @typedef {object} Position
5079
- * @property {number} duration - The total time in milliseconds this transition should take.
5080
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
5081
- * @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
5082
- * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
5083
- */
5084
- /**
5085
- * @PORTED
5086
- * @typedef {object} Opacity
5087
- * @property {number} duration - The total time in milliseconds this transition should take.
5088
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
5089
- * @property {number} opacity - This value is clamped from 0.0 to 1.0.
5090
- */
5091
- /**
5092
- * @REMOVED
5093
- * Bounds is a interface that has the properties of height,
5094
- * width, left, top which are all numbers
5095
- * @typedef { object } Bounds
5096
- * @property { number } height Get the application height bound
5097
- * @property { number } width Get the application width bound
5098
- * @property { number } top Get the application top bound
5099
- * @property { number } left Get the application left bound
5100
- * @property { number } right Get the application right bound
5101
- * @property { number } bottom Get the application bottom bound
5102
- */
5103
4273
  /**
5104
4274
  * A basic window that wraps a native HTML window. Provides more fine-grained
5105
4275
  * control over the window state such as the ability to minimize, maximize, restore, etc.
@@ -5115,83 +4285,6 @@ function requireInstance () {
5115
4285
  constructor(wire, identity) {
5116
4286
  super(wire, identity, 'window');
5117
4287
  }
5118
- /**
5119
- * Adds a listener to the end of the listeners array for the specified event.
5120
- * @param eventType - The type of the event.
5121
- * @param listener - Called whenever an event of the specified type occurs.
5122
- * @param options - Option to support event timestamps.
5123
- *
5124
- * @function addListener
5125
- * @memberof Window
5126
- * @instance
5127
- * @tutorial Window.EventEmitter
5128
- */
5129
- /**
5130
- * Adds a listener to the end of the listeners array for the specified event.
5131
- * @param eventType - The type of the event.
5132
- * @param listener - Called whenever an event of the specified type occurs.
5133
- * @param options - Option to support event timestamps.
5134
- *
5135
- * @function on
5136
- * @memberof Window
5137
- * @instance
5138
- * @tutorial Window.EventEmitter
5139
- */
5140
- /**
5141
- * 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.
5142
- * @param eventType - The type of the event.
5143
- * @param listener - The callback function.
5144
- * @param options - Option to support event timestamps.
5145
- *
5146
- * @function once
5147
- * @memberof Window
5148
- * @instance
5149
- * @tutorial Window.EventEmitter
5150
- */
5151
- /**
5152
- * Adds a listener to the beginning of the listeners array for the specified event.
5153
- * @param eventType - The type of the event.
5154
- * @param listener - The callback function.
5155
- * @param options - Option to support event timestamps.
5156
- *
5157
- * @function prependListener
5158
- * @memberof Window
5159
- * @instance
5160
- * @tutorial Window.EventEmitter
5161
- */
5162
- /**
5163
- * 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.
5164
- * The listener is added to the beginning of the listeners array.
5165
- * @param eventType - The type of the event.
5166
- * @param listener - The callback function.
5167
- * @param options - Option to support event timestamps.
5168
- *
5169
- * @function prependOnceListener
5170
- * @memberof Window
5171
- * @instance
5172
- * @tutorial Window.EventEmitter
5173
- */
5174
- /**
5175
- * Remove a listener from the listener array for the specified event.
5176
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5177
- * @param eventType - The type of the event.
5178
- * @param listener - The callback function.
5179
- * @param options - Option to support event timestamps.
5180
- *
5181
- * @function removeListener
5182
- * @memberof Window
5183
- * @instance
5184
- * @tutorial Window.EventEmitter
5185
- */
5186
- /**
5187
- * Removes all listeners, or those of the specified event.
5188
- * @param eventType - The type of the event.
5189
- *
5190
- * @function removeAllListeners
5191
- * @memberof Window
5192
- * @instance
5193
- * @tutorial Window.EventEmitter
5194
- */
5195
4288
  /**
5196
4289
  * create a new window
5197
4290
  * @internal
@@ -6183,10 +5276,9 @@ function requireInstance () {
6183
5276
  }
6184
5277
  /**
6185
5278
  * Shows the window if it is hidden at the specified location.
6186
- * If the toggle parameter is set to true, the window will
6187
- * alternate between showing and hiding.
6188
- * @param left The left position of the window
6189
- * @param top The right position of the window
5279
+ *
5280
+ * @param left The left position of the window in pixels
5281
+ * @param top The top position of the window in pixels
6190
5282
  * @param force Show will be prevented from closing when force is false and
6191
5283
  * ‘show-requested’ has been subscribed to for application’s main window
6192
5284
  *
@@ -6263,28 +5355,6 @@ function requireInstance () {
6263
5355
  .sendAction('window-authenticate', { userName, password, ...this.identity })
6264
5356
  .then(() => undefined);
6265
5357
  }
6266
- /**
6267
- * @typedef {object} ShowPopupMenuOptions
6268
- * @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
6269
- * @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
6270
- * @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
6271
- */
6272
- /**
6273
- * @typedef {object} MenuItemTemplate
6274
- * @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
6275
- * @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
6276
- * @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
6277
- * @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
6278
- * @property {boolean} [visible] - If false, the menu item will be entirely hidden.
6279
- * @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
6280
- * @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
6281
- * @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
6282
- */
6283
- /**
6284
- * @typedef {object} MenuResult
6285
- * @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
6286
- * @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
6287
- */
6288
5358
  /**
6289
5359
  * Shows a menu on the window.
6290
5360
  *
@@ -6385,31 +5455,6 @@ function requireInstance () {
6385
5455
  async closePopupMenu() {
6386
5456
  return this.wire.sendAction('close-popup-menu', { ...this.identity }).then(() => undefined);
6387
5457
  }
6388
- /**
6389
- * @PORTED
6390
- * @typedef {object} PopupOptions
6391
- * @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.
6392
- * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
6393
- * @property {Window~options} [initialOptions] - Window creation options when using `showPopupWindow` to create a new window.
6394
- * @property {Window~options} [additionalOptions] - Updatable window options applied to new and existing windows when shown as popups.
6395
- * @property {function} [onPopupResult] - Executed when this window's popup calls `dispatchPopupResult`. Note: if this is defined, `showPopupWindow` will not return a `PopupResult`.
6396
- * @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.
6397
- * @property {number} [height] - Height of the popup window (takes priority over `intialOptions` size properties).
6398
- * @property {number} [width] - Width of the popup window (takes priority over `intialOptions` size properties).
6399
- * @property {number} [x] - Left position where the popup window will be shown (relative to the window calling `showPopupWindow`).
6400
- * @property {number} [y] - Top position where the popup window will be shown (relative to the window calling `showPopupWindow`).
6401
- * @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.
6402
- * @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`.
6403
- * @property {boolean} [focus] - Determines if the popup window should or should not be focused when it is shown.
6404
- * @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.
6405
- */
6406
- /**
6407
- * @PORTED
6408
- * @typedef {object} PopupResult
6409
- * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
6410
- * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
6411
- * @property {* | undefined} [data] - Data passed to `dispatchPopupResult`.
6412
- */
6413
5458
  /**
6414
5459
  * Dispatch a result to the caller of `showPopupWindow`.
6415
5460
  *
@@ -6661,7 +5706,7 @@ function requireWindow () {
6661
5706
  * * {@link _WindowModule} contains static members of the `Window` API, accessible through `fin.Window`.
6662
5707
  * * {@link _Window} describes an instance of an OpenFin Window, e.g. as returned by `fin.Window.getCurrent`.
6663
5708
  *
6664
- * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
5709
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
6665
5710
  * both of these were documented on the same page.
6666
5711
  *
6667
5712
  * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
@@ -6745,83 +5790,6 @@ class System extends base_1$j.EmitterBase {
6745
5790
  });
6746
5791
  });
6747
5792
  }
6748
- /**
6749
- * Adds a listener to the end of the listeners array for the specified event.
6750
- * @param eventType - The type of the event.
6751
- * @param listener - Called whenever an event of the specified type occurs.
6752
- * @param options - Option to support event timestamps.
6753
- *
6754
- * @function addListener
6755
- * @memberof System
6756
- * @instance
6757
- * @tutorial System.EventEmitter
6758
- */
6759
- /**
6760
- * Adds a listener to the end of the listeners array for the specified event.
6761
- * @param eventType - The type of the event.
6762
- * @param listener - Called whenever an event of the specified type occurs.
6763
- * @param options - Option to support event timestamps.
6764
- *
6765
- * @function on
6766
- * @memberof System
6767
- * @instance
6768
- * @tutorial System.EventEmitter
6769
- */
6770
- /**
6771
- * 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.
6772
- * @param eventType - The type of the event.
6773
- * @param listener - The callback function.
6774
- * @param options - Option to support event timestamps.
6775
- *
6776
- * @function once
6777
- * @memberof System
6778
- * @instance
6779
- * @tutorial System.EventEmitter
6780
- */
6781
- /**
6782
- * Adds a listener to the beginning of the listeners array for the specified event.
6783
- * @param eventType - The type of the event.
6784
- * @param listener - The callback function.
6785
- * @param options - Option to support event timestamps.
6786
- *
6787
- * @function prependListener
6788
- * @memberof System
6789
- * @instance
6790
- * @tutorial System.EventEmitter
6791
- */
6792
- /**
6793
- * 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.
6794
- * The listener is added to the beginning of the listeners array.
6795
- * @param eventType - The type of the event.
6796
- * @param listener - The callback function.
6797
- * @param options - Option to support event timestamps.
6798
- *
6799
- * @function prependOnceListener
6800
- * @memberof System
6801
- * @instance
6802
- * @tutorial System.EventEmitter
6803
- */
6804
- /**
6805
- * Remove a listener from the listener array for the specified event.
6806
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
6807
- * @param eventType - The type of the event.
6808
- * @param listener - The callback function.
6809
- * @param options - Option to support event timestamps.
6810
- *
6811
- * @function removeListener
6812
- * @memberof System
6813
- * @instance
6814
- * @tutorial System.EventEmitter
6815
- */
6816
- /**
6817
- * Removes all listeners, or those of the specified event.
6818
- * @param eventType - The type of the event.
6819
- *
6820
- * @function removeAllListeners
6821
- * @memberof System
6822
- * @instance
6823
- * @tutorial System.EventEmitter
6824
- */
6825
5793
  /**
6826
5794
  * Returns the version of the runtime. The version contains the major, minor,
6827
5795
  * build and revision numbers.
@@ -11023,20 +9991,6 @@ var clipboard = {};
11023
9991
  Object.defineProperty(clipboard, "__esModule", { value: true });
11024
9992
  clipboard.Clipboard = void 0;
11025
9993
  const base_1$d = base;
11026
- /**
11027
- * @PORTED
11028
- * WriteRequestType interface
11029
- * @typedef { object } WriteRequestType
11030
- * @property { string } data Data to be written
11031
- * @property { string } [type] Clipboard Type
11032
- */
11033
- /**
11034
- * @PORTED
11035
- * OpenFin.WriteAnyClipboardRequest interface
11036
- * @typedef { object } OpenFin.WriteAnyClipboardRequest
11037
- * @property { string } data Data to be written
11038
- * @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
11039
- */
11040
9994
  /**
11041
9995
  * The Clipboard API allows reading and writing to the clipboard in multiple formats.
11042
9996
  *
@@ -11249,83 +10203,6 @@ class ExternalApplication extends base_1$c.EmitterBase {
11249
10203
  super(wire, 'external-application', identity.uuid);
11250
10204
  this.identity = identity;
11251
10205
  }
11252
- /**
11253
- * Adds a listener to the end of the listeners array for the specified event.
11254
- * @param eventType - The type of the event.
11255
- * @param listener - Called whenever an event of the specified type occurs.
11256
- * @param options - Option to support event timestamps.
11257
- *
11258
- * @function addListener
11259
- * @memberof ExternalApplication
11260
- * @instance
11261
- * @tutorial ExternalApplication.EventEmitter
11262
- */
11263
- /**
11264
- * Adds a listener to the end of the listeners array for the specified event.
11265
- * @param eventType - The type of the event.
11266
- * @param listener - Called whenever an event of the specified type occurs.
11267
- * @param options - Option to support event timestamps.
11268
- *
11269
- * @function on
11270
- * @memberof ExternalApplication
11271
- * @instance
11272
- * @tutorial ExternalApplication.EventEmitter
11273
- */
11274
- /**
11275
- * 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.
11276
- * @param eventType - The type of the event.
11277
- * @param listener - The callback function.
11278
- * @param options - Option to support event timestamps.
11279
- *
11280
- * @function once
11281
- * @memberof ExternalApplication
11282
- * @instance
11283
- * @tutorial ExternalApplication.EventEmitter
11284
- */
11285
- /**
11286
- * Adds a listener to the beginning of the listeners array for the specified event.
11287
- * @param eventType - The type of the event.
11288
- * @param listener - The callback function.
11289
- * @param options - Option to support event timestamps.
11290
- *
11291
- * @function prependListener
11292
- * @memberof ExternalApplication
11293
- * @instance
11294
- * @tutorial ExternalApplication.EventEmitter
11295
- */
11296
- /**
11297
- * 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.
11298
- * The listener is added to the beginning of the listeners array.
11299
- * @param eventType - The type of the event.
11300
- * @param listener - The callback function.
11301
- * @param options - Option to support event timestamps.
11302
- *
11303
- * @function prependOnceListener
11304
- * @memberof ExternalApplication
11305
- * @instance
11306
- * @tutorial ExternalApplication.EventEmitter
11307
- */
11308
- /**
11309
- * Remove a listener from the listener array for the specified event.
11310
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
11311
- * @param eventType - The type of the event.
11312
- * @param listener - The callback function.
11313
- * @param options - Option to support event timestamps.
11314
- *
11315
- * @function removeListener
11316
- * @memberof ExternalApplication
11317
- * @instance
11318
- * @tutorial ExternalApplication.EventEmitter
11319
- */
11320
- /**
11321
- * Removes all listeners, or those of the specified event.
11322
- * @param eventType - The type of the event.
11323
- *
11324
- * @function removeAllListeners
11325
- * @memberof ExternalApplication
11326
- * @instance
11327
- * @tutorial ExternalApplication.EventEmitter
11328
- */
11329
10206
  /**
11330
10207
  * Retrieves information about the external application.
11331
10208
  *
@@ -11415,7 +10292,7 @@ Factory$5.ExternalApplicationModule = ExternalApplicationModule;
11415
10292
  * * {@link ExternalApplicationModule} contains static members of the `ExternalApplication` type, accessible through `fin.ExternalApplication`.
11416
10293
  * * {@link ExternalApplication} describes an instance of an OpenFin ExternalApplication, e.g. as returned by `fin.ExternalApplication.getCurrent`.
11417
10294
  *
11418
- * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
10295
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
11419
10296
  * both of these were documented on the same page.
11420
10297
  *
11421
10298
  * @packageDocumentation
@@ -11462,83 +10339,6 @@ class _Frame extends base_1$a.EmitterBase {
11462
10339
  super(wire, 'frame', identity.uuid, identity.name);
11463
10340
  this.identity = identity;
11464
10341
  }
11465
- /**
11466
- * Adds the listener function to the end of the listeners array for the specified event type.
11467
- * @param eventType - The type of the event.
11468
- * @param listener - Called whenever an event of the specified type occurs.
11469
- * @param options - Option to support event timestamps.
11470
- *
11471
- * @function addListener
11472
- * @memberof Frame
11473
- * @instance
11474
- * @tutorial Frame.EventEmitter
11475
- */
11476
- /**
11477
- * Adds a listener to the end of the listeners array for the specified event.
11478
- * @param eventType - The type of the event.
11479
- * @param listener - Called whenever an event of the specified type occurs.
11480
- * @param options - Option to support event timestamps.
11481
- *
11482
- * @function on
11483
- * @memberof Frame
11484
- * @instance
11485
- * @tutorial Frame.EventEmitter
11486
- */
11487
- /**
11488
- * 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.
11489
- * @param eventType - The type of the event.
11490
- * @param listener - The callback function.
11491
- * @param options - Option to support event timestamps.
11492
- *
11493
- * @function once
11494
- * @memberof Frame
11495
- * @instance
11496
- * @tutorial Frame.EventEmitter
11497
- */
11498
- /**
11499
- * Adds a listener to the beginning of the listeners array for the specified event.
11500
- * @param eventType - The type of the event.
11501
- * @param listener - The callback function.
11502
- * @param options - Option to support event timestamps.
11503
- *
11504
- * @function prependListener
11505
- * @memberof Frame
11506
- * @instance
11507
- * @tutorial Frame.EventEmitter
11508
- */
11509
- /**
11510
- * 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.
11511
- * The listener is added to the beginning of the listeners array.
11512
- * @param eventType - The type of the event.
11513
- * @param listener - The callback function.
11514
- * @param options - Option to support event timestamps.
11515
- *
11516
- * @function prependOnceListener
11517
- * @memberof Frame
11518
- * @instance
11519
- * @tutorial Frame.EventEmitter
11520
- */
11521
- /**
11522
- * Remove a listener from the listener array for the specified event.
11523
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
11524
- * @param eventType - The type of the event.
11525
- * @param listener - The callback function.
11526
- * @param options - Option to support event timestamps.
11527
- *
11528
- * @function removeListener
11529
- * @memberof Frame
11530
- * @instance
11531
- * @tutorial Frame.EventEmitter
11532
- */
11533
- /**
11534
- * Removes all listeners, or those of the specified event.
11535
- * @param eventType - The type of the event.
11536
- *
11537
- * @function removeAllListeners
11538
- * @memberof Frame
11539
- * @instance
11540
- * @tutorial Frame.EventEmitter
11541
- */
11542
10342
  /**
11543
10343
  * Returns a frame info object for the represented frame.
11544
10344
  *
@@ -11666,7 +10466,7 @@ Factory$4._FrameModule = _FrameModule;
11666
10466
  * * {@link _FrameModule} contains static members of the `Frame` API, accessible through `fin.Frame`.
11667
10467
  * * {@link _Frame} describes an instance of an OpenFin Frame, e.g. as returned by `fin.Frame.getCurrent`.
11668
10468
  *
11669
- * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
10469
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
11670
10470
  * both of these were documented on the same page.
11671
10471
  *
11672
10472
  * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
@@ -13061,7 +11861,7 @@ class Layout extends base_1$6.Base {
13061
11861
  // don't expose
13062
11862
  });
13063
11863
  const client = await __classPrivateFieldGet$5(this, _Layout_layoutClient, "f").getValue();
13064
- const root = await client.getRoot(this.identity);
11864
+ const root = await client.getRoot('layoutName' in this.identity ? this.identity : undefined);
13065
11865
  return layout_entities_1.LayoutNode.getEntity(root, client);
13066
11866
  }
13067
11867
  }
@@ -13079,7 +11879,7 @@ var __classPrivateFieldSet$4 = (commonjsGlobal && commonjsGlobal.__classPrivateF
13079
11879
  if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
13080
11880
  return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
13081
11881
  };
13082
- var _LayoutModule_instances, _LayoutModule_layoutInitializationAttempted, _LayoutModule_layoutManager, _LayoutModule_throwIfLayoutManagerNotInitialized;
11882
+ var _LayoutModule_instances, _LayoutModule_layoutInitializationAttempted, _LayoutModule_layoutManager, _LayoutModule_getBackCompatLayoutManager, _LayoutModule_getSafeLayoutManager;
13083
11883
  Object.defineProperty(Factory$2, "__esModule", { value: true });
13084
11884
  Factory$2.LayoutModule = void 0;
13085
11885
  const base_1$5 = base;
@@ -13142,40 +11942,51 @@ class LayoutModule extends base_1$5.Base {
13142
11942
  throw new Error('Layout.init was already called, please use Layout.create to add additional layouts.');
13143
11943
  }
13144
11944
  __classPrivateFieldSet$4(this, _LayoutModule_layoutInitializationAttempted, true, "f");
13145
- __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayout(this.fin, this.wire, options), "f");
13146
- // back-compat ONLY if layoutManagerOverride not provided
11945
+ __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayoutManager(this.fin, this.wire, options), "f");
11946
+ // apply the initial snapshot which in turn will call fin.Platform.Layout.create()
11947
+ const platformClient = await this.fin.Platform.getCurrentSync().getClient();
11948
+ const snapshot = await platformClient.dispatch('get-initial-layout-snapshot');
11949
+ await __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").applyLayoutSnapshot(snapshot);
13147
11950
  if (!options.layoutManagerOverride) {
13148
- const layoutInstance = await __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").resolveLayout();
13149
- const layout = this.wrapSync(layoutInstance.identity);
13150
- // Backward compat - undocumented / not typed layoutInstance as layoutManager
13151
- return Object.assign(layout, { layoutManager: layoutInstance });
11951
+ return __classPrivateFieldGet$4(this, _LayoutModule_getBackCompatLayoutManager, "f").call(this, this.fin);
13152
11952
  }
13153
- // Warn user if they do not create any layouts in the next 10 seconds
11953
+ // warn user if they do not call create() in the next 30 seconds
13154
11954
  setTimeout(() => {
13155
- const layoutSize = Object.keys(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").getLayouts()).length;
13156
- if (layoutSize === 0) {
13157
- console.warn(`[Layout.init] Layout.init was called but no layouts have been created yet. Make sure you ` +
11955
+ if (__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f")?.size() === 0) {
11956
+ console.warn(`[Layout.init] Layout.init was called 30s ago, but no layouts have been created yet. Make sure you ` +
13158
11957
  `override LayoutManager.applyLayoutSnapshot, and then call fin.Platform.Layout.create()`);
13159
11958
  }
13160
- }, 10000);
11959
+ }, 30000);
13161
11960
  return this.wrapSync(this.fin.me.identity);
13162
11961
  };
11962
+ _LayoutModule_getBackCompatLayoutManager.set(this, async (fin) => {
11963
+ let layoutManager;
11964
+ let resolve;
11965
+ const layoutResolved = new Promise((r) => {
11966
+ resolve = r;
11967
+ });
11968
+ // wait for a layout to be created
11969
+ await fin.me.once('layout-ready', async ({ layoutIdentity }) => {
11970
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
11971
+ layoutManager = await this.wire.environment.resolveLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
11972
+ // Backward compat - undocumented / not typed openfin-layout as layoutManager
11973
+ // TODO: eventually deprecate this
11974
+ resolve(Object.assign(this.wrapSync(layoutIdentity), { layoutManager }));
11975
+ });
11976
+ return layoutResolved;
11977
+ });
13163
11978
  /**
13164
11979
  * Returns the layout manager for the current window
13165
11980
  * @returns
13166
11981
  */
13167
11982
  this.getCurrentLayoutManagerSync = () => {
13168
- __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this);
13169
- // @ts-expect-error User may have implemented their own snapshot type when overriding LayoutManager
13170
- return __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f");
11983
+ return __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_getSafeLayoutManager).call(this, `fin.Platform.Layout.getCurrentLayoutManagerSync()`);
13171
11984
  };
13172
11985
  this.create = async (options) => {
13173
- __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this);
13174
- return this.wire.environment.createLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), options);
11986
+ return this.wire.environment.createLayout(__classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_getSafeLayoutManager).call(this, `fin.Platform.Layout.create()`), options);
13175
11987
  };
13176
11988
  this.destroy = async (layoutIdentity) => {
13177
- __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this);
13178
- return this.wire.environment.destroyLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
11989
+ return this.wire.environment.destroyLayout(__classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_getSafeLayoutManager).call(this, `fin.Platform.Layout.destroy()`), layoutIdentity);
13179
11990
  };
13180
11991
  }
13181
11992
  /**
@@ -13273,10 +12084,11 @@ class LayoutModule extends base_1$5.Base {
13273
12084
  }
13274
12085
  }
13275
12086
  Factory$2.LayoutModule = LayoutModule;
13276
- _LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layoutManager = new WeakMap(), _LayoutModule_instances = new WeakSet(), _LayoutModule_throwIfLayoutManagerNotInitialized = function _LayoutModule_throwIfLayoutManagerNotInitialized() {
12087
+ _LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layoutManager = new WeakMap(), _LayoutModule_getBackCompatLayoutManager = new WeakMap(), _LayoutModule_instances = new WeakSet(), _LayoutModule_getSafeLayoutManager = function _LayoutModule_getSafeLayoutManager(method) {
13277
12088
  if (!__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f")) {
13278
- throw new Error('You must call init before using this API');
12089
+ throw new Error(`You must call init before using the API ${method}`);
13279
12090
  }
12091
+ return __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f");
13280
12092
  };
13281
12093
 
13282
12094
  (function (exports) {
@@ -13286,7 +12098,7 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layou
13286
12098
  * * {@link LayoutModule} contains static members of the `Layout` API, accessible through `fin.Platform.Layout`.
13287
12099
  * * {@link Layout} describes an instance of an OpenFin Layout, e.g. as returned by `fin.Platform.Layout.getCurrent`.
13288
12100
  *
13289
- * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
12101
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
13290
12102
  * both of these were documented on the same page.
13291
12103
  *
13292
12104
  * @packageDocumentation
@@ -13567,7 +12379,7 @@ Factory$3.PlatformModule = PlatformModule;
13567
12379
  * * {@link PlatformModule} contains static members of the `Platform` API, accessible through `fin.Platform`.
13568
12380
  * * {@link Platform} describes an instance of an OpenFin Platform, e.g. as returned by `fin.Platform.getCurrent`.
13569
12381
  *
13570
- * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
12382
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
13571
12383
  * both of these were documented on the same page.
13572
12384
  *
13573
12385
  * @packageDocumentation
@@ -14455,57 +13267,6 @@ function requireInteropBroker () {
14455
13267
  /*
14456
13268
  Client API
14457
13269
  */
14458
- /**
14459
- * @REMOVED
14460
- * SetContextOptions interface
14461
- * @typedef { object } SetContextOptions
14462
- * @property { Context } {context} - New context to set.
14463
- */
14464
- /**
14465
- * @REMOVED
14466
- * GetContextOptions interface
14467
- * @typedef { object } GetContextOptions
14468
- * @property { string } [contextType] - Context Type
14469
- */
14470
- // TODO: extract inline type and do proper comments
14471
- /**
14472
- * @REMOVED
14473
- * JoinContextGroupOptions interface
14474
- * @typedef { object } JoinContextGroupOptions
14475
- * @property { string } contextGroupId - Id of the context group.
14476
- * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
14477
- */
14478
- /**
14479
- * @REMOVED
14480
- * AddClientToContextGroupOptions interface
14481
- * @typedef { object } AddClientToContextGroupOptions
14482
- * @property { string } contextGroupId - Name of the context group.
14483
- */
14484
- /**
14485
- * @REMOVED
14486
- * RemoveFromContextGroupOptions interface
14487
- * @typedef { object } RemoveFromContextGroupOptions
14488
- * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
14489
- */
14490
- /**
14491
- * @REMOVED
14492
- * GetInfoForContextGroupOptions interface
14493
- * @typedef { object } GetInfoForContextGroupOptions
14494
- * @property { string } contextGroupId - Name of the context group to get info for.
14495
- */
14496
- /**
14497
- * @REMOVED
14498
- * GetAllClientsInContextGroupOptions interface
14499
- * @typedef { object } GetAllClientsInContextGroupOptions
14500
- * @property { string } contextGroupId - Name of the context group to get info for.
14501
- */
14502
- /**
14503
- * @PORTED
14504
- * InfoForIntentOptions interface
14505
- * @typedef { object } InfoForIntentOptions
14506
- * @property { string } name Name of the intent to get info for.
14507
- * @property { Context } [context] Optional context.
14508
- */
14509
13270
  /**
14510
13271
  * Sets a context for the context group of the incoming current entity.
14511
13272
  * @param setContextOptions - New context to set.
@@ -14974,7 +13735,7 @@ function requireInteropBroker () {
14974
13735
  * // }
14975
13736
  * ```
14976
13737
  *
14977
- * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
13738
+ * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
14978
13739
  *
14979
13740
  * @param contextForIntent Data passed between entities and applications.
14980
13741
  * @param clientIdentity Identity of the Client making the request.
@@ -15664,95 +14425,6 @@ InteropClient$1.InteropClient = void 0;
15664
14425
  const base_1$2 = base;
15665
14426
  const SessionContextGroupClient_1 = SessionContextGroupClient$1;
15666
14427
  const utils_1$2 = utils$1;
15667
- /**
15668
- * @PORTED
15669
- * @typedef { object } Intent
15670
- * @summary The combination of an action and a context that is passed to an application for resolution.
15671
- * @property { string } name Name of the intent.
15672
- * @property { Context } context Data associated with the intent
15673
- */
15674
- /**
15675
- * @REMOVED
15676
- * @typedef { object } Subscription
15677
- * @summary Object returned when subscribing a handler.
15678
- * @property { function } unsubscribe Function to unsubscribe the handler.
15679
- */
15680
- /**
15681
- * @typedef { function } ContextHandler
15682
- * @summary Subscription function for addContextHandler.
15683
- */
15684
- /**
15685
- * @typedef { function } IntentHandler
15686
- * @summary Subscription function for registerIntentHandler
15687
- */
15688
- /**
15689
- * @PORTED
15690
- * @typedef { object } ClientIdentity
15691
- * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
15692
- * @property {string} uuid GUID of an application.
15693
- * @property {string} name Name of an entity in an application.
15694
- * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
15695
- */
15696
- /**
15697
- * @PORTED
15698
- * @typedef { object } ContextGroupInfo
15699
- * @summary Information for a Context Group. Contains metadata for displaying the group properly.
15700
- * @property {string} id Name of the context group
15701
- * @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.
15702
- */
15703
- /**
15704
- * @PORTED
15705
- * @typedef { object } DisplayMetadata
15706
- * @summary The display data for a Context Group.
15707
- * @property {string} name A user-readable name for this context group, e.g: `"Red"`
15708
- * @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
15709
- * @property {string} [glyph] A URL of an image that can be used to display this context group
15710
- */
15711
- /**
15712
- * @PORTED
15713
- * @typedef { object } Context
15714
- * @summary Data passed between entities and applications.
15715
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
15716
- * @property {string} [name] User-readable name for the incoming context.
15717
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
15718
- */
15719
- /**
15720
- * @REMOVED
15721
- * @typedef { object } ContextForIntent
15722
- * @summary Data passed between entities and applications, including an optional metadata.
15723
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
15724
- * @property {string} [name] User-readable name for the incoming context.
15725
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
15726
- * @property {any} [metadata]
15727
- */
15728
- /**
15729
- * @REMOVED
15730
- * @typedef { object } SessionContextGroup
15731
- * @summary An instance of a SessionContextGroup
15732
- * @property {string} id The SessionContextGroup's id.
15733
- * @property {setContext} setContext Sets a context of a certain type
15734
- * @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
15735
- * @property {addContextHandler} addContextHandler Adds a handler for context change.
15736
- */
15737
- /**
15738
- * @typedef {function} setContext
15739
- * @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
15740
- * @param context The Context to be set.
15741
- *
15742
- */
15743
- /**
15744
- * @typedef {function} getCurrentContext
15745
- * @summary A SessionContextGroup instance method for getting the current context of a certain type.
15746
- * @param contextType The Context Type to get. If not specified the last contextType set would get used.
15747
- *
15748
- */
15749
- /**
15750
- * @typedef {function} addContextHandler
15751
- * @summary A SessionContextGroup instance method for adding a handler for context change.
15752
- * @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.
15753
- * @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.
15754
- *
15755
- */
15756
14428
  /**
15757
14429
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
15758
14430
  *
@@ -16386,13 +15058,6 @@ function requireFactory () {
16386
15058
  const common_utils_1 = commonUtils;
16387
15059
  const defaultOverride = (Class) => new Class();
16388
15060
  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.';
16389
- /**
16390
- * @PORTED
16391
- * @typedef { object } InteropConfig
16392
- * @summary Information relevant to the Interop Broker.
16393
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
16394
- * @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
16395
- */
16396
15061
  /**
16397
15062
  * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
16398
15063
  *
@@ -16777,7 +15442,7 @@ Factory.SnapshotSourceModule = SnapshotSourceModule;
16777
15442
  * * {@link SnapshotSourceModule} contains static members of the `SnapshotSource` API, accessible through `fin.SnapshotSource`.
16778
15443
  * * {@link SnapshotSource} describes an instance of an OpenFin SnapshotSource, e.g. as returned by `fin.SnapshotSource.wrap`.
16779
15444
  *
16780
- * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
15445
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/32.114.76.10/index.html),
16781
15446
  * both of these were documented on the same page.
16782
15447
  *
16783
15448
  * @packageDocumentation
@@ -17211,7 +15876,7 @@ class MockEnvironment {
17211
15876
  getRtcPeer() {
17212
15877
  throw new Error(me_1.environmentUnsupportedMessage);
17213
15878
  }
17214
- initLayout() {
15879
+ initLayoutManager() {
17215
15880
  throw new Error(me_1.environmentUnsupportedMessage);
17216
15881
  }
17217
15882
  async createLayout() {
@@ -17220,6 +15885,9 @@ class MockEnvironment {
17220
15885
  async destroyLayout() {
17221
15886
  throw new Error(me_1.environmentUnsupportedMessage);
17222
15887
  }
15888
+ async resolveLayout() {
15889
+ throw new Error(me_1.environmentUnsupportedMessage);
15890
+ }
17223
15891
  initPlatform() {
17224
15892
  throw new Error(me_1.environmentUnsupportedMessage);
17225
15893
  }