@openfin/node-adapter 35.78.1 → 35.78.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1012,6 +1012,15 @@ class LayoutNode {
1012
1012
  /**
1013
1013
  * Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
1014
1014
  *
1015
+ * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
1016
+ * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
1017
+ * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
1018
+ * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
1019
+ *
1020
+ * @param views The views that will populate the new TabStack.
1021
+ * @param options Additional options that control new TabStack creation.
1022
+ * @returns The newly-created TabStack.
1023
+ *
1015
1024
  * @example
1016
1025
  * ```js
1017
1026
  * if (!fin.me.isView) {
@@ -1046,13 +1055,16 @@ class LayoutNode {
1046
1055
  * console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
1047
1056
  *
1048
1057
  * ```
1058
+ * @experimental
1049
1059
  */
1050
1060
  this.createAdjacentStack = async (views, options) => {
1051
1061
  const entityId = await __classPrivateFieldGet$e(this, _LayoutNode_client, "f").createAdjacentStack(this.entityId, views, options);
1052
1062
  return LayoutNode.getEntity({ entityId, type: 'stack' }, __classPrivateFieldGet$e(this, _LayoutNode_client, "f"));
1053
1063
  };
1054
1064
  /**
1055
- * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
1065
+ * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow.
1066
+ *
1067
+ * @param edge Edge whose adjacent TabStacks will be returned.
1056
1068
  *
1057
1069
  * @example
1058
1070
  * ```js
@@ -1072,6 +1084,7 @@ class LayoutNode {
1072
1084
  * console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
1073
1085
  *
1074
1086
  * ```
1087
+ * @experimental
1075
1088
  */
1076
1089
  this.getAdjacentStacks = async (edge) => {
1077
1090
  const adjacentStacks = await __classPrivateFieldGet$e(this, _LayoutNode_client, "f").getAdjacentStacks({
@@ -1115,74 +1128,10 @@ LayoutNode.getEntity = (definition, client) => {
1115
1128
  throw new Error(`Unrecognised Layout Entity encountered ('${JSON.stringify(definition)})`);
1116
1129
  }
1117
1130
  };
1118
- /**
1119
- * @typedef {string} LayoutPosition
1120
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
1121
- */
1122
- /**
1123
- * @typedef {object} StackCreationOptions
1124
- * @summary Stack creation options.
1125
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
1126
- */
1127
- /**
1128
- * @typedef {object} TabStack~AddViewOptions
1129
- * @summary Options to use when adding a view to a {@link TabStack}
1130
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
1131
- */
1132
1131
  /**
1133
1132
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
1134
1133
  */
1135
1134
  class TabStack extends LayoutNode {
1136
- /**
1137
- * Determines if this {@link TabStack} is the top level content item in the current layout.
1138
- * @function isRoot
1139
- * @memberof TabStack
1140
- * @instance
1141
- * @tutorial TabStack.isRoot
1142
- * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
1143
- */
1144
- /**
1145
- * Determines if this {@link TabStack} exists.
1146
- * @function exists
1147
- * @instance
1148
- * @memberof TabStack
1149
- * @tutorial TabStack.exists
1150
- * @returns Resolves true if this is the TabStack exists, or false if it has been destroyed.
1151
- */
1152
- /**
1153
- * Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
1154
- * @function getParent
1155
- * @instance
1156
- * @memberof TabStack
1157
- * @tutorial TabStack.getParent
1158
- * @returns is the root content item or does not exist.
1159
- */
1160
- /**
1161
- * Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
1162
- * @function getAdjacentStacks
1163
- * @instance
1164
- * @memberof TabStack
1165
- * @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
1166
- *
1167
- * @tutorial TabStack.getAdjacentStacks
1168
- */
1169
- /**
1170
- * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
1171
- *
1172
- * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
1173
- * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
1174
- * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
1175
- * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
1176
- *
1177
- * @function createAdjacentStack
1178
- * @instance
1179
- * @memberof TabStack
1180
- * @param views - List of identities or view creation options of the views to include in the stack
1181
- * @param options - Creation options.
1182
- * @returns The created TabStack.
1183
- * @tutorial TabStack.createAdjacentStack
1184
- * @experimental
1185
- */
1186
1135
  /** @internal */
1187
1136
  constructor(client, entityId) {
1188
1137
  super(client, entityId);
@@ -1315,57 +1264,6 @@ _TabStack_client = new WeakMap();
1315
1264
  * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
1316
1265
  */
1317
1266
  class ColumnOrRow extends LayoutNode {
1318
- /**
1319
- * Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
1320
- * @function isRoot
1321
- * @memberof ColumnOrRow
1322
- * @instance
1323
- * @tutorial ColumnOrRow.isRoot
1324
- * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
1325
- */
1326
- /**
1327
- * Determines if this {@link ColumnOrRow} exists.
1328
- * @function exists
1329
- * @instance
1330
- * @memberof ColumnOrRow
1331
- * @tutorial ColumnOrRow.exists
1332
- * @returns Resolves true if the TabStack exists, or false if it has been destroyed.
1333
- */
1334
- /**
1335
- * Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
1336
- * @function getParent
1337
- * @instance
1338
- * @memberof ColumnOrRow
1339
- * @tutorial ColumnOrRow.getParent
1340
- * @returns Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if
1341
- * this {@link ColumnOrRow}does not exist or is the root content item.
1342
- */
1343
- /**
1344
- * Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
1345
- * @function getAdjacentStacks
1346
- * @instance
1347
- * @memberof ColumnOrRow
1348
- * @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
1349
- *
1350
- * @tutorial ColumnOrRow.getAdjacentStacks
1351
- */
1352
- /**
1353
- * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
1354
- *
1355
- * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
1356
- * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
1357
- * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
1358
- * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
1359
- *
1360
- * @function createAdjacentStack
1361
- * @instance
1362
- * @memberof ColumnOrRow
1363
- * @param views - List of identities or view creation options of the views to include in the stack
1364
- * @param options - Creation options.
1365
- * @returns The created TabStack
1366
- * @tutorial ColumnOrRow.createAdjacentStack
1367
- * @experimental
1368
- */
1369
1267
  /**
1370
1268
  * @internal
1371
1269
  */
@@ -1411,7 +1309,8 @@ var layout_constants = {};
1411
1309
  Object.defineProperty(layout_constants, "__esModule", { value: true });
1412
1310
  layout_constants.DEFAULT_LAYOUT_KEY = layout_constants.LAYOUT_CONTROLLER_ID = void 0;
1413
1311
  layout_constants.LAYOUT_CONTROLLER_ID = 'layout-entities';
1414
- layout_constants.DEFAULT_LAYOUT_KEY = 'default';
1312
+ // TODO: eventually export this somehow
1313
+ layout_constants.DEFAULT_LAYOUT_KEY = '__default__';
1415
1314
 
1416
1315
  var main = {};
1417
1316
 
@@ -2440,10 +2339,8 @@ class WebContents extends base_1$k.EmitterBase {
2440
2339
  });
2441
2340
  const { data: { willOpen, options: popupOptions } } = tryCreatePayload;
2442
2341
  if (willOpen) {
2443
- await this.wire.environment.createChildContent({
2444
- options: popupOptions.initialOptions,
2445
- entityType: 'window'
2446
- });
2342
+ // Solve the issue where Interop in a popup window with non cross-origin url is not working(core-1076).
2343
+ await this.fin.Window.create(popupOptions.initialOptions);
2447
2344
  }
2448
2345
  const normalizePopupResult = (payload) => {
2449
2346
  const { name, uuid, result, data } = payload;
@@ -2505,169 +2402,6 @@ function requireInstance$2 () {
2505
2402
  const layout_constants_1 = layout_constants;
2506
2403
  const main_1 = main;
2507
2404
  const window_1 = requireWindow();
2508
- /**
2509
- * @PORTED
2510
- * @typedef {object} View~options
2511
- * @summary View creation options.
2512
- * @desc This is the options object required by {@link View.create View.create}.
2513
- *
2514
- * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
2515
- * (defaults to `"about:blank"` when omitted).
2516
- *
2517
- * @property {object} [experimental]
2518
- * Configurations for API injection.
2519
- *
2520
- * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
2521
- *
2522
- * @property {object} [accelerator]
2523
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
2524
- *
2525
- * @property {boolean} [accelerator.devtools=false]
2526
- * If `true`, enables the devtools keyboard shortcut:<br>
2527
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
2528
- *
2529
- * @property {boolean} [accelerator.reload=false]
2530
- * If `true`, enables the reload keyboard shortcuts:<br>
2531
- * `Ctrl` + `R` _(Windows)_<br>
2532
- * `F5` _(Windows)_<br>
2533
- * `Command` + `R` _(Mac)_
2534
- *
2535
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
2536
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
2537
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
2538
- * `Shift` + `F5` _(Windows)_<br>
2539
- * `Command` + `Shift` + `R` _(Mac)_
2540
- *
2541
- * @property {boolean} [accelerator.zoom=false]
2542
- * If `true`, enables the zoom keyboard shortcuts:<br>
2543
- * `Ctrl` + `+` _(Zoom In)_<br>
2544
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
2545
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
2546
- * `Ctrl` + `-` _(Zoom Out)_<br>
2547
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
2548
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
2549
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
2550
- * `Ctrl` + `0` _(Restore to 100%)_
2551
- *
2552
- * @property {object} [api]
2553
- * Configurations for API injection.
2554
- *
2555
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
2556
- *
2557
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
2558
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
2559
- *
2560
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
2561
- * Autoplay policy to apply to content in the window, can be
2562
- * `no-user-gesture-required`, `user-gesture-required`,
2563
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
2564
- *
2565
- * @property {object} [autoResize] AutoResize options
2566
- *
2567
- * @property {object} [bounds] initial bounds given relative to the window.
2568
- *
2569
- * @property {string} [backgroundColor="#FFF"] - _Updatable._
2570
- * The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
2571
- * (`document.body.style.backgroundColor`),
2572
- * this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
2573
- * areas when growing a window. Setting
2574
- * this value to the anticipated content background color can help improve user experience.
2575
- * Default is white.
2576
- *
2577
- * @property {object} [contentNavigation]
2578
- * Restrict navigation to URLs that match an allowed pattern.
2579
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
2580
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
2581
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
2582
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
2583
- *
2584
- * @property {object} [contentRedirect]
2585
- * Restrict redirects to URLs that match an allowed pattern.
2586
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
2587
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
2588
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
2589
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
2590
- *
2591
- * @property {object} [contextMenuSettings] - _Updatable._
2592
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
2593
- * Configure the context menu when right-clicking on a view.
2594
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
2595
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
2596
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
2597
- *
2598
- * @property {object} [contextMenuOptions] - _Updatable._
2599
- * Configure the context menu when right-clicking on a view. Supported menu items:
2600
- * 'separator'
2601
- * 'cut'
2602
- * 'copy'
2603
- * 'copyImage',
2604
- * 'paste'
2605
- * 'spellCheck'
2606
- * 'inspect'
2607
- * 'reload'
2608
- * 'navigateForward'
2609
- * 'navigateBack'
2610
- * 'print'
2611
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
2612
- * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
2613
- *
2614
- * @property {any} [customData=""] - _Updatable._
2615
- * A field that the user can attach serializable data to be ferried around with the view options.
2616
- * _When omitted, the default value of this property is the empty string (`""`)._
2617
- *
2618
- * @property {any} [customContext=""] - _Updatable._
2619
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
2620
- * is called.
2621
- * When omitted, the default value of this property is the empty string (`""`).
2622
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
2623
- *
2624
- * @property {object[]} [hotkeys=[]] - _Updatable._
2625
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
2626
- * Within Platform, OpenFin also implements a set of pre-defined actions called
2627
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
2628
- * that can be assigned to a specific hotkey in the platform manifest.
2629
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
2630
- * @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
2631
- *
2632
- * @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
2633
- * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
2634
- * if the view isn't part of the new layout when running `Layout.replace`.
2635
- *
2636
- * @property {string} name
2637
- * The name of the view.
2638
- *
2639
- * @property {boolean} [detachOnClose=false] - _Updatable._
2640
- * Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
2641
- * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
2642
- *
2643
- * @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
2644
- * but the properties in the manifest will take precedence if there is any collision.
2645
- *
2646
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
2647
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
2648
- * from the parent application.
2649
- *
2650
- * @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
2651
- *
2652
- * @property {string} [processAffinity=<application uuid>]
2653
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
2654
- *
2655
- * @property {boolean} [spellCheck=false]
2656
- * Enable spell check in input text fields for the view.
2657
- *
2658
- * @property {Identity} [target]
2659
- * The identity of the window this view should be attached to.
2660
- *
2661
- * @property {string} [url="about:blank"]
2662
- * The URL of the view.
2663
- *
2664
- * @property {string} [uuid=<application uuid>]
2665
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
2666
- * If omitted, defaults to the `uuid` of the application spawning the view.
2667
- * If given, must match the `uuid` of the application spawning the view.
2668
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
2669
- * really no need to provide it.
2670
- */
2671
2405
  /**
2672
2406
  * A View can be used to embed additional web content into a Window.
2673
2407
  * It is like a child window, except it is positioned relative to its owning window.
@@ -3243,7 +2977,7 @@ function requireView () {
3243
2977
  * * {@link ViewModule} contains static members of the `View` API, accessible through `fin.View`.
3244
2978
  * * {@link View} describes an instance of an OpenFin View, e.g. as returned by `fin.View.getCurrent`.
3245
2979
  *
3246
- * 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),
2980
+ * 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),
3247
2981
  * both of these were documented on the same page.
3248
2982
  *
3249
2983
  * @packageDocumentation
@@ -3291,100 +3025,6 @@ function requireInstance$1 () {
3291
3025
  });
3292
3026
  return windowList;
3293
3027
  }
3294
- /**
3295
- * Adds a listener to the end of the listeners array for the specified event.
3296
- * @param eventType - The type of the event.
3297
- * @param listener - Called whenever an event of the specified type occurs.
3298
- * @param options - Option to support event timestamps.
3299
- *
3300
- * @function addListener
3301
- * @memberof Application
3302
- * @instance
3303
- * @tutorial Application.EventEmitter
3304
- */
3305
- /**
3306
- * Adds a listener to the end of the listeners array for the specified event.
3307
- * @param eventType - The type of the event.
3308
- * @param listener - Called whenever an event of the specified type occurs.
3309
- * @param options - Option to support event timestamps.
3310
- *
3311
- * @function on
3312
- * @memberof Application
3313
- * @instance
3314
- * @tutorial Application.EventEmitter
3315
- */
3316
- /**
3317
- * 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.
3318
- * @param eventType - The type of the event.
3319
- * @param listener - The callback function.
3320
- * @param options - Option to support event timestamps.
3321
- *
3322
- * @function once
3323
- * @memberof Application
3324
- * @instance
3325
- * @tutorial Application.EventEmitter
3326
- */
3327
- /**
3328
- * Adds a listener to the beginning of the listeners array for the specified event.
3329
- * @param eventType - The type of the event.
3330
- * @param listener - The callback function.
3331
- * @param options - Option to support event timestamps.
3332
- *
3333
- * @function prependListener
3334
- * @memberof Application
3335
- * @instance
3336
- * @tutorial Application.EventEmitter
3337
- */
3338
- /**
3339
- * 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.
3340
- * The listener is added to the beginning of the listeners array.
3341
- * @param eventType - The type of the event.
3342
- * @param listener - The callback function.
3343
- * @param options - Option to support event timestamps.
3344
- *
3345
- * @function prependOnceListener
3346
- * @memberof Application
3347
- * @instance
3348
- * @tutorial Application.EventEmitter
3349
- */
3350
- /**
3351
- * Remove a listener from the listener array for the specified event.
3352
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
3353
- * @param eventType - The type of the event.
3354
- * @param listener - The callback function.
3355
- * @param options - Option to support event timestamps.
3356
- *
3357
- * @function removeListener
3358
- * @memberof Application
3359
- * @instance
3360
- * @tutorial Application.EventEmitter
3361
- */
3362
- /**
3363
- * Removes all listeners, or those of the specified event.
3364
- * @param eventType - The type of the event.
3365
- *
3366
- * @function removeAllListeners
3367
- * @memberof Application
3368
- * @instance
3369
- * @tutorial Application.EventEmitter
3370
- */
3371
- /**
3372
- * JumpListCategory interface
3373
- * @typedef { object } JumpListCategory
3374
- * @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.
3375
- * @property { JumpListItem[] } items Array of JumpListItem objects
3376
- */
3377
- /**
3378
- * @PORTED
3379
- * JumpListItem interface
3380
- * @typedef { object } JumpListItem
3381
- * @property { string } type One of the following: "task" or "separator". Defaults to task.
3382
- * @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
3383
- * @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
3384
- * @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.
3385
- * @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).
3386
- * @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.
3387
- */
3388
3028
  /**
3389
3029
  * Determines if the application is currently running.
3390
3030
  *
@@ -4384,7 +4024,7 @@ function requireApplication () {
4384
4024
  * * {@link ApplicationModule} contains static members of the `Application` API, accessible through `fin.Application`.
4385
4025
  * * {@link Application} describes an instance of an OpenFin Application, e.g. as returned by `fin.Application.getCurrent`.
4386
4026
  *
4387
- * 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),
4027
+ * 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),
4388
4028
  * both of these were documented on the same page.
4389
4029
  *
4390
4030
  * @packageDocumentation
@@ -4410,476 +4050,6 @@ function requireInstance () {
4410
4050
  const main_1 = main;
4411
4051
  const view_1 = requireView();
4412
4052
  const warnings_1 = warnings;
4413
- /**
4414
- * @PORTED
4415
- * @typedef { object } Margins
4416
- * @property { string } [marginType]
4417
- * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
4418
- * you will also need to specify `top`, `bottom`, `left`, and `right`.
4419
- *
4420
- * @property { number } [top] The top margin of the printed web page, in pixels.
4421
- * @property { number } [bottom] The bottom margin of the printed web page, in pixels.
4422
- * @property { number } [left] The left margin of the printed web page, in pixels.
4423
- * @property { number } [right] The right margin of the printed web page, in pixels.
4424
- */
4425
- /**
4426
- * @PORTED
4427
- * @typedef { object } Dpi
4428
- * @property { number } [horizontal] The horizontal dpi
4429
- * @property { number } [vertical] The vertical dpi
4430
- */
4431
- /**
4432
- * @PORTED
4433
- * @typedef { object } PrintOptions
4434
- * @property { boolean } [silent=false] Don't ask user for print settings.
4435
- * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
4436
- * @property { string } [deviceName=''] Set the printer device name to use.
4437
- * @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
4438
- * @property { Margins } [margins] Set margins for the printed web page
4439
- * @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
4440
- * @property { number } [scaleFactor] The scale factor of the web page.
4441
- * @property { number } [pagesPerSheet] The number of pages to print per page sheet.
4442
- * @property { boolean } [collate] Whether the web page should be collated.
4443
- * @property { number } [copies] The number of copies of the web page to print.
4444
- * @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
4445
- * @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
4446
- * @property { Dpi } [dpi] Set dpi for the printed web page
4447
- */
4448
- /**
4449
- * @REMOVED
4450
- * PrinterInfo interface
4451
- * @typedef { object } PrinterInfo
4452
- * @property { string } name Printer Name
4453
- * @property { string } description Printer Description
4454
- * @property { number } status Printer Status
4455
- * @property { boolean } isDefault Indicates that system's default printer
4456
- */
4457
- /**
4458
- * @REMOVED
4459
- * SharedWorkerInfo interface
4460
- * @typedef { object } SharedWorkerInfo
4461
- * @property { string } id The unique id of the shared worker.
4462
- * @property { string } url The url of the shared worker.
4463
- */
4464
- /**
4465
- * @PORTED
4466
- * ContentCreationRule interface
4467
- * @typedef { object } ContentCreationRule
4468
- * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
4469
- * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
4470
- * @property { object } options Window creation options or View creation options.
4471
- */
4472
- /**
4473
- * @PORTED
4474
- * @typedef {object} Window~options
4475
- * @summary Window creation options.
4476
- * @desc This is the options object required by {@link Window.create Window.create}.
4477
- *
4478
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
4479
- * (defaults to `"about:blank"` when omitted).
4480
- *
4481
- * _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
4482
- *
4483
- * @property {object} [accelerator]
4484
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
4485
- *
4486
- * @property {boolean} [accelerator.devtools=false]
4487
- * If `true`, enables the devtools keyboard shortcut:<br>
4488
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
4489
- *
4490
- * @property {boolean} [accelerator.reload=false]
4491
- * If `true`, enables the reload keyboard shortcuts:<br>
4492
- * `Ctrl` + `R` _(Windows)_<br>
4493
- * `F5` _(Windows)_<br>
4494
- * `Command` + `R` _(Mac)_
4495
- *
4496
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
4497
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
4498
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
4499
- * `Shift` + `F5` _(Windows)_<br>
4500
- * `Command` + `Shift` + `R` _(Mac)_
4501
- *
4502
- * @property {boolean} [accelerator.zoom=false]
4503
- * 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.
4504
- * If `true`, enables the zoom keyboard shortcuts:<br>
4505
- * `Ctrl` + `+` _(Zoom In)_<br>
4506
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
4507
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
4508
- * `Ctrl` + `-` _(Zoom Out)_<br>
4509
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
4510
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
4511
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
4512
- * `Ctrl` + `0` _(Restore to 100%)_
4513
- *
4514
- * @property {object} [alphaMask] - _Experimental._ _Updatable._
4515
- * <br>
4516
- * alphaMask turns anything of matching RGB value transparent.
4517
- * <br>
4518
- * Caveats:
4519
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
4520
- * * User cannot click-through transparent regions
4521
- * * Not supported on Mac
4522
- * * Windows Aero must be enabled
4523
- * * Won't make visual sense on Pixel-pushed environments such as Citrix
4524
- * * Not supported on rounded corner windows
4525
- * @property {number} [alphaMask.red=-1] 0-255
4526
- * @property {number} [alphaMask.green=-1] 0-255
4527
- * @property {number} [alphaMask.blue=-1] 0-255
4528
- *
4529
- * @property {boolean} [alwaysOnTop=false] - _Updatable._
4530
- * A flag to always position the window at the top of the window stack.
4531
- *
4532
- * @property {object} [api]
4533
- * Configurations for API injection.
4534
- *
4535
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
4536
- *
4537
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
4538
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
4539
- *
4540
- * @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
4541
- *
4542
- * @property {number} [aspectRatio=0] - _Updatable._
4543
- * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
4544
- * an aspect ratio will not be enforced.
4545
- *
4546
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
4547
- * Autoplay policy to apply to content in the window, can be
4548
- * `no-user-gesture-required`, `user-gesture-required`,
4549
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
4550
- *
4551
- * @property {boolean} [autoShow=true]
4552
- * A flag to automatically show the window when it is created.
4553
- *
4554
- * @property {string} [backgroundColor="#FFF"]
4555
- * The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
4556
- * (`document.body.style.backgroundColor`),
4557
- * this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
4558
- * areas when growing a window. Setting
4559
- * this value to the anticipated content background color can help improve user experience.
4560
- * Default is white.
4561
- *
4562
- * @property {object} [contentCreation]
4563
- * Apply rules that determine how user interaction (`window.open` and links) creates content.
4564
- * @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
4565
- *
4566
- * @property {object} [contentNavigation]
4567
- * Restrict navigation to URLs that match an allowed pattern.
4568
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
4569
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4570
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
4571
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
4572
- *
4573
- * @property {object} [contentRedirect]
4574
- * Restrict redirects to URLs that match an allowed pattern.
4575
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
4576
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
4577
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
4578
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
4579
- *
4580
- * @property {boolean} [contextMenu=true] - _Updatable._
4581
- * A flag to show the context menu when right-clicking on a window.
4582
- * Gives access to the devtools for the window.
4583
- *
4584
- * @property {object} [contextMenuSettings] - _Updatable._
4585
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
4586
- * Configure the context menu when right-clicking on a window.
4587
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
4588
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
4589
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
4590
- *
4591
- * @property {object} [contextMenuOptions] - _Updatable._
4592
- * Configure the context menu when right-clicking on a window. Supported menu items:
4593
- * 'separator'
4594
- * 'cut'
4595
- * 'copy'
4596
- * 'paste'
4597
- * 'spellCheck'
4598
- * 'inspect'
4599
- * 'reload'
4600
- * 'navigateForward'
4601
- * 'navigateBack'
4602
- * 'print'
4603
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
4604
- * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
4605
- *
4606
- * @property {object} [cornerRounding] - _Updatable._
4607
- * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
4608
- * average of _height_ and _width_.
4609
- * @property {number} [cornerRounding.height=0] The height in pixels.
4610
- * @property {number} [cornerRounding.width=0] The width in pixels.
4611
- *
4612
- * @property {any} [customContext=""] - _Updatable. Inheritable._
4613
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
4614
- * is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
4615
- * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
4616
- * _When omitted, _inherits_ from the parent application._
4617
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
4618
- *
4619
- * @property {any} [customData=""] - _Updatable. Inheritable._
4620
- * A field that the user can attach serializable data to be ferried around with the window options.
4621
- * _When omitted, _inherits_ from the parent application._
4622
- *
4623
- * @property {object[]} [customRequestHeaders]
4624
- * Defines list of custom headers for requests sent by the window.
4625
- * @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
4626
- * @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
4627
- * where the object key is the name of header and value at key is the value of the header
4628
- *
4629
- * @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
4630
- * Toggling off would keep the Window alive even if all its Views were closed.
4631
- * This is meant for advanced users and should be used with caution.
4632
- * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
4633
- * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
4634
- * ** note ** - This option is ignored in non-Platforms apps.
4635
- *
4636
- * @property {boolean} [defaultCentered=false]
4637
- * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
4638
- * this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
4639
- * somewhat above center vertically.
4640
- *
4641
- * @property {number} [defaultHeight=500]
4642
- * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
4643
- * in favor of the cached value.
4644
- *
4645
- * @property {number} [defaultLeft=100]
4646
- * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
4647
- * launches in favor of the cached value.
4648
- *
4649
- * @property {number} [defaultTop=100]
4650
- * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
4651
- * launches in favor of the cached value.
4652
- *
4653
- * @property {number} [defaultWidth=800]
4654
- * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
4655
- * launches in favor of the cached value.
4656
- *
4657
- * @property {boolean} [includeInSnapshots=true] - _Updatable._
4658
- * When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
4659
- * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
4660
- *
4661
- * @property {boolean} [frame=true] - _Updatable._
4662
- * A flag to show the frame.
4663
- *
4664
- * @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
4665
- *
4666
- * @property {object[]} [hotkeys=[]] - _Updatable._
4667
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
4668
- * Within Platform, OpenFin also implements a set of pre-defined actions called
4669
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
4670
- * that can be assigned to a specific hotkey in the platform manifest.
4671
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
4672
- * @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
4673
- *
4674
- * @property {string} [icon] - _Updatable. Inheritable._
4675
- * A URL for the icon to be shown in the window title bar and the taskbar.
4676
- * When omitted, inherits from the parent application._
4677
- * note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
4678
- *
4679
- * @property {number} [maxHeight=-1] - _Updatable._
4680
- * The maximum height of a window. Will default to the OS defined value if set to -1.
4681
- *
4682
- * @property {boolean} [maximizable=true] - _Updatable._
4683
- * A flag that lets the window be maximized.
4684
- *
4685
- * @property {number} [maxWidth=-1] - _Updatable._
4686
- * The maximum width of a window. Will default to the OS defined value if set to -1.
4687
- *
4688
- * @property {number} [minHeight=0] - _Updatable._
4689
- * The minimum height of a window.
4690
- *
4691
- * @property {boolean} [minimizable=true] - _Updatable._
4692
- * A flag that lets the window be minimized.
4693
- *
4694
- * @property {number} [minWidth=0] - _Updatable._
4695
- * The minimum width of a window.
4696
- *
4697
- * @property {Identity} [modalParentIdentity]
4698
- * Parent identity of a modal window. It will create a modal child window when this option is set.
4699
- *
4700
- * @property {string} name
4701
- * The name of the window.
4702
- *
4703
- * @property {number} [opacity=1.0] - _Updatable._
4704
- * A flag that specifies how transparent the window will be.
4705
- * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
4706
- * This value is clamped between `0.0` and `1.0`.
4707
- * * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
4708
- *
4709
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
4710
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
4711
- * from the parent application.
4712
- *
4713
- * @property {string} [processAffinity]
4714
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
4715
- *
4716
- * @property {boolean} [resizable=true] - _Updatable._
4717
- * A flag to allow the user to resize the window.
4718
- *
4719
- * @property {object} [resizeRegion] - _Updatable._
4720
- * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
4721
- * @property {number} [resizeRegion.bottomRightCorner=9]
4722
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
4723
- * @property {number} [resizeRegion.size=7]
4724
- * The size in pixels.
4725
- * @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
4726
- * Sides that a window can be resized from.
4727
- *
4728
- * @property {boolean} [saveWindowState=true]
4729
- * A flag to cache the location of the window.
4730
- * ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
4731
- *
4732
- * @property {boolean} [ignoreSavedWindowState]
4733
- * A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
4734
- *
4735
- * @property {boolean} [shadow=false]
4736
- * A flag to display a shadow on frameless windows.
4737
- * `shadow` and `cornerRounding` are mutually exclusive.
4738
- * On Windows 7, Aero theme is required.
4739
- *
4740
- * @property {boolean} [showBackgroundImages=false] - _Updatable._
4741
- * Platforms Only. If true, will show background images in the layout when the Views are hidden.
4742
- * This occurs when the window is resizing or a tab is being dragged within the layout.
4743
- *
4744
- * @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
4745
- * A flag to show the window's icon in the taskbar.
4746
- *
4747
- * @property {boolean} [smallWindow=false]
4748
- * A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
4749
- * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
4750
- * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
4751
- *
4752
- * @property {boolean} [spellCheck=false]
4753
- * Enable spell check in input text fields for the window.
4754
- *
4755
- * @property {string} [state="normal"]
4756
- * The visible state of the window on creation.
4757
- * One of:
4758
- * * `"maximized"`
4759
- * * `"minimized"`
4760
- * * `"normal"`
4761
- *
4762
- * @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
4763
- *
4764
- * @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
4765
- * Specify a taskbar group for the window.
4766
- * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
4767
- *
4768
- * @property {string} [url="about:blank"]
4769
- * The URL of the window.
4770
- *
4771
- * @property {string} [uuid=<application uuid>]
4772
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
4773
- * If omitted, defaults to the `uuid` of the application spawning the window.
4774
- * If given, must match the `uuid` of the application spawning the window.
4775
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
4776
- * really no need to provide it.
4777
- *
4778
- * @property {boolean} [waitForPageLoad=false]
4779
- * When set to `true`, the window will not appear until the `window` object's `load` event fires.
4780
- * When set to `false`, the window will appear immediately without waiting for content to be loaded.
4781
- *
4782
- * @property {ViewVisibility} [viewVisibility]
4783
- * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
4784
- */
4785
- /**
4786
- * @PORTED
4787
- * @typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
4788
- * @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
4789
- * @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
4790
- * @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
4791
- */
4792
- /**
4793
- * @PORTED
4794
- * @typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
4795
- * @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
4796
- * @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
4797
- */
4798
- /**
4799
- * @REMOVED
4800
- * @typedef {Object} ShowViewsOnSplitterDrag _Platform Windows Only_. Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
4801
- * @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
4802
- */
4803
- /**
4804
- * @REMOVED
4805
- * @typedef {Object} ShowViewsOnTabDrag _Platform Windows Only_. Allows views to be shown when the user is manipulating the layout by repositioning a tab.
4806
- * @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
4807
- */
4808
- /**
4809
- * @PORTED
4810
- * @typedef {object} CapturePageOptions
4811
- * @property { Area } [area] The area of the window to be captured.
4812
- * @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
4813
- * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
4814
- */
4815
- /**
4816
- * @PORTED
4817
- * @typedef { object } Area
4818
- * @property { number } height Area's height
4819
- * @property { number } width Area's width
4820
- * @property { number } x X coordinate of area's starting point
4821
- * @property { number } y Y coordinate of area's starting point
4822
- */
4823
- /**
4824
- * @PORTED
4825
- * @typedef {object} FindInPageOptions
4826
- * @property {boolean} [forward=true] Whether to search forward or backward.
4827
- * @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.
4828
- * @property {boolean} [matchCase=false] Whether search should be case-sensitive.
4829
- * @property {boolean} [wordStart=false] Whether to look only at the start of words.
4830
- * @property {boolean} [medialCapitalAsWordStart=false]
4831
- * 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>
4832
- * lowercase or non-letter. Accepts several other intra-word matches.
4833
- */
4834
- /**
4835
- * @REMOVED
4836
- * @typedef {object} Transition
4837
- * @property {Opacity} opacity - The Opacity transition
4838
- * @property {Position} position - The Position transition
4839
- * @property {Size} size - The Size transition
4840
- */
4841
- /**
4842
- * @PORTED
4843
- * @typedef {object} TransitionOptions
4844
- * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
4845
- this animation onto the end of the animation queue.
4846
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
4847
- */
4848
- /**
4849
- * @PORTED
4850
- * @typedef {object} Size
4851
- * @property {number} duration - The total time in milliseconds this transition should take.
4852
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
4853
- * @property {number} width - Optional if height is present. Defaults to the window's current width.
4854
- * @property {number} height - Optional if width is present. Defaults to the window's current height.
4855
- */
4856
- /**
4857
- * @PORTED
4858
- * @typedef {object} Position
4859
- * @property {number} duration - The total time in milliseconds this transition should take.
4860
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
4861
- * @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
4862
- * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
4863
- */
4864
- /**
4865
- * @PORTED
4866
- * @typedef {object} Opacity
4867
- * @property {number} duration - The total time in milliseconds this transition should take.
4868
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
4869
- * @property {number} opacity - This value is clamped from 0.0 to 1.0.
4870
- */
4871
- /**
4872
- * @REMOVED
4873
- * Bounds is a interface that has the properties of height,
4874
- * width, left, top which are all numbers
4875
- * @typedef { object } Bounds
4876
- * @property { number } height Get the application height bound
4877
- * @property { number } width Get the application width bound
4878
- * @property { number } top Get the application top bound
4879
- * @property { number } left Get the application left bound
4880
- * @property { number } right Get the application right bound
4881
- * @property { number } bottom Get the application bottom bound
4882
- */
4883
4053
  /**
4884
4054
  * A basic window that wraps a native HTML window. Provides more fine-grained
4885
4055
  * control over the window state such as the ability to minimize, maximize, restore, etc.
@@ -4895,83 +4065,6 @@ function requireInstance () {
4895
4065
  constructor(wire, identity) {
4896
4066
  super(wire, identity, 'window');
4897
4067
  }
4898
- /**
4899
- * Adds a listener to the end of the listeners array for the specified event.
4900
- * @param eventType - The type of the event.
4901
- * @param listener - Called whenever an event of the specified type occurs.
4902
- * @param options - Option to support event timestamps.
4903
- *
4904
- * @function addListener
4905
- * @memberof Window
4906
- * @instance
4907
- * @tutorial Window.EventEmitter
4908
- */
4909
- /**
4910
- * Adds a listener to the end of the listeners array for the specified event.
4911
- * @param eventType - The type of the event.
4912
- * @param listener - Called whenever an event of the specified type occurs.
4913
- * @param options - Option to support event timestamps.
4914
- *
4915
- * @function on
4916
- * @memberof Window
4917
- * @instance
4918
- * @tutorial Window.EventEmitter
4919
- */
4920
- /**
4921
- * 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.
4922
- * @param eventType - The type of the event.
4923
- * @param listener - The callback function.
4924
- * @param options - Option to support event timestamps.
4925
- *
4926
- * @function once
4927
- * @memberof Window
4928
- * @instance
4929
- * @tutorial Window.EventEmitter
4930
- */
4931
- /**
4932
- * Adds a listener to the beginning of the listeners array for the specified event.
4933
- * @param eventType - The type of the event.
4934
- * @param listener - The callback function.
4935
- * @param options - Option to support event timestamps.
4936
- *
4937
- * @function prependListener
4938
- * @memberof Window
4939
- * @instance
4940
- * @tutorial Window.EventEmitter
4941
- */
4942
- /**
4943
- * 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.
4944
- * The listener is added to the beginning of the listeners array.
4945
- * @param eventType - The type of the event.
4946
- * @param listener - The callback function.
4947
- * @param options - Option to support event timestamps.
4948
- *
4949
- * @function prependOnceListener
4950
- * @memberof Window
4951
- * @instance
4952
- * @tutorial Window.EventEmitter
4953
- */
4954
- /**
4955
- * Remove a listener from the listener array for the specified event.
4956
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
4957
- * @param eventType - The type of the event.
4958
- * @param listener - The callback function.
4959
- * @param options - Option to support event timestamps.
4960
- *
4961
- * @function removeListener
4962
- * @memberof Window
4963
- * @instance
4964
- * @tutorial Window.EventEmitter
4965
- */
4966
- /**
4967
- * Removes all listeners, or those of the specified event.
4968
- * @param eventType - The type of the event.
4969
- *
4970
- * @function removeAllListeners
4971
- * @memberof Window
4972
- * @instance
4973
- * @tutorial Window.EventEmitter
4974
- */
4975
4068
  /**
4976
4069
  * create a new window
4977
4070
  * @internal
@@ -5963,10 +5056,9 @@ function requireInstance () {
5963
5056
  }
5964
5057
  /**
5965
5058
  * Shows the window if it is hidden at the specified location.
5966
- * If the toggle parameter is set to true, the window will
5967
- * alternate between showing and hiding.
5968
- * @param left The left position of the window
5969
- * @param top The right position of the window
5059
+ *
5060
+ * @param left The left position of the window in pixels
5061
+ * @param top The top position of the window in pixels
5970
5062
  * @param force Show will be prevented from closing when force is false and
5971
5063
  * ‘show-requested’ has been subscribed to for application’s main window
5972
5064
  *
@@ -6043,28 +5135,6 @@ function requireInstance () {
6043
5135
  .sendAction('window-authenticate', { userName, password, ...this.identity })
6044
5136
  .then(() => undefined);
6045
5137
  }
6046
- /**
6047
- * @typedef {object} ShowPopupMenuOptions
6048
- * @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
6049
- * @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
6050
- * @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
6051
- */
6052
- /**
6053
- * @typedef {object} MenuItemTemplate
6054
- * @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
6055
- * @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
6056
- * @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
6057
- * @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
6058
- * @property {boolean} [visible] - If false, the menu item will be entirely hidden.
6059
- * @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
6060
- * @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
6061
- * @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
6062
- */
6063
- /**
6064
- * @typedef {object} MenuResult
6065
- * @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
6066
- * @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
6067
- */
6068
5138
  /**
6069
5139
  * Shows a menu on the window.
6070
5140
  *
@@ -6165,31 +5235,6 @@ function requireInstance () {
6165
5235
  async closePopupMenu() {
6166
5236
  return this.wire.sendAction('close-popup-menu', { ...this.identity }).then(() => undefined);
6167
5237
  }
6168
- /**
6169
- * @PORTED
6170
- * @typedef {object} PopupOptions
6171
- * @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.
6172
- * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
6173
- * @property {Window~options} [initialOptions] - Window creation options when using `showPopupWindow` to create a new window.
6174
- * @property {Window~options} [additionalOptions] - Updatable window options applied to new and existing windows when shown as popups.
6175
- * @property {function} [onPopupResult] - Executed when this window's popup calls `dispatchPopupResult`. Note: if this is defined, `showPopupWindow` will not return a `PopupResult`.
6176
- * @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.
6177
- * @property {number} [height] - Height of the popup window (takes priority over `intialOptions` size properties).
6178
- * @property {number} [width] - Width of the popup window (takes priority over `intialOptions` size properties).
6179
- * @property {number} [x] - Left position where the popup window will be shown (relative to the window calling `showPopupWindow`).
6180
- * @property {number} [y] - Top position where the popup window will be shown (relative to the window calling `showPopupWindow`).
6181
- * @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.
6182
- * @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`.
6183
- * @property {boolean} [focus] - Determines if the popup window should or should not be focused when it is shown.
6184
- * @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.
6185
- */
6186
- /**
6187
- * @PORTED
6188
- * @typedef {object} PopupResult
6189
- * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
6190
- * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
6191
- * @property {* | undefined} [data] - Data passed to `dispatchPopupResult`.
6192
- */
6193
5238
  /**
6194
5239
  * Dispatch a result to the caller of `showPopupWindow`.
6195
5240
  *
@@ -6441,7 +5486,7 @@ function requireWindow () {
6441
5486
  * * {@link _WindowModule} contains static members of the `Window` API, accessible through `fin.Window`.
6442
5487
  * * {@link _Window} describes an instance of an OpenFin Window, e.g. as returned by `fin.Window.getCurrent`.
6443
5488
  *
6444
- * 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),
5489
+ * 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),
6445
5490
  * both of these were documented on the same page.
6446
5491
  *
6447
5492
  * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
@@ -6525,83 +5570,6 @@ class System extends base_1$j.EmitterBase {
6525
5570
  });
6526
5571
  });
6527
5572
  }
6528
- /**
6529
- * Adds a listener to the end of the listeners array for the specified event.
6530
- * @param eventType - The type of the event.
6531
- * @param listener - Called whenever an event of the specified type occurs.
6532
- * @param options - Option to support event timestamps.
6533
- *
6534
- * @function addListener
6535
- * @memberof System
6536
- * @instance
6537
- * @tutorial System.EventEmitter
6538
- */
6539
- /**
6540
- * Adds a listener to the end of the listeners array for the specified event.
6541
- * @param eventType - The type of the event.
6542
- * @param listener - Called whenever an event of the specified type occurs.
6543
- * @param options - Option to support event timestamps.
6544
- *
6545
- * @function on
6546
- * @memberof System
6547
- * @instance
6548
- * @tutorial System.EventEmitter
6549
- */
6550
- /**
6551
- * 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.
6552
- * @param eventType - The type of the event.
6553
- * @param listener - The callback function.
6554
- * @param options - Option to support event timestamps.
6555
- *
6556
- * @function once
6557
- * @memberof System
6558
- * @instance
6559
- * @tutorial System.EventEmitter
6560
- */
6561
- /**
6562
- * Adds a listener to the beginning of the listeners array for the specified event.
6563
- * @param eventType - The type of the event.
6564
- * @param listener - The callback function.
6565
- * @param options - Option to support event timestamps.
6566
- *
6567
- * @function prependListener
6568
- * @memberof System
6569
- * @instance
6570
- * @tutorial System.EventEmitter
6571
- */
6572
- /**
6573
- * 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.
6574
- * The listener is added to the beginning of the listeners array.
6575
- * @param eventType - The type of the event.
6576
- * @param listener - The callback function.
6577
- * @param options - Option to support event timestamps.
6578
- *
6579
- * @function prependOnceListener
6580
- * @memberof System
6581
- * @instance
6582
- * @tutorial System.EventEmitter
6583
- */
6584
- /**
6585
- * Remove a listener from the listener array for the specified event.
6586
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
6587
- * @param eventType - The type of the event.
6588
- * @param listener - The callback function.
6589
- * @param options - Option to support event timestamps.
6590
- *
6591
- * @function removeListener
6592
- * @memberof System
6593
- * @instance
6594
- * @tutorial System.EventEmitter
6595
- */
6596
- /**
6597
- * Removes all listeners, or those of the specified event.
6598
- * @param eventType - The type of the event.
6599
- *
6600
- * @function removeAllListeners
6601
- * @memberof System
6602
- * @instance
6603
- * @tutorial System.EventEmitter
6604
- */
6605
5573
  /**
6606
5574
  * Returns the version of the runtime. The version contains the major, minor,
6607
5575
  * build and revision numbers.
@@ -10803,20 +9771,6 @@ var clipboard = {};
10803
9771
  Object.defineProperty(clipboard, "__esModule", { value: true });
10804
9772
  clipboard.Clipboard = void 0;
10805
9773
  const base_1$d = base$1;
10806
- /**
10807
- * @PORTED
10808
- * WriteRequestType interface
10809
- * @typedef { object } WriteRequestType
10810
- * @property { string } data Data to be written
10811
- * @property { string } [type] Clipboard Type
10812
- */
10813
- /**
10814
- * @PORTED
10815
- * OpenFin.WriteAnyClipboardRequest interface
10816
- * @typedef { object } OpenFin.WriteAnyClipboardRequest
10817
- * @property { string } data Data to be written
10818
- * @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
10819
- */
10820
9774
  /**
10821
9775
  * The Clipboard API allows reading and writing to the clipboard in multiple formats.
10822
9776
  *
@@ -11029,83 +9983,6 @@ class ExternalApplication extends base_1$c.EmitterBase {
11029
9983
  super(wire, 'external-application', identity.uuid);
11030
9984
  this.identity = identity;
11031
9985
  }
11032
- /**
11033
- * Adds a listener to the end of the listeners array for the specified event.
11034
- * @param eventType - The type of the event.
11035
- * @param listener - Called whenever an event of the specified type occurs.
11036
- * @param options - Option to support event timestamps.
11037
- *
11038
- * @function addListener
11039
- * @memberof ExternalApplication
11040
- * @instance
11041
- * @tutorial ExternalApplication.EventEmitter
11042
- */
11043
- /**
11044
- * Adds a listener to the end of the listeners array for the specified event.
11045
- * @param eventType - The type of the event.
11046
- * @param listener - Called whenever an event of the specified type occurs.
11047
- * @param options - Option to support event timestamps.
11048
- *
11049
- * @function on
11050
- * @memberof ExternalApplication
11051
- * @instance
11052
- * @tutorial ExternalApplication.EventEmitter
11053
- */
11054
- /**
11055
- * 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.
11056
- * @param eventType - The type of the event.
11057
- * @param listener - The callback function.
11058
- * @param options - Option to support event timestamps.
11059
- *
11060
- * @function once
11061
- * @memberof ExternalApplication
11062
- * @instance
11063
- * @tutorial ExternalApplication.EventEmitter
11064
- */
11065
- /**
11066
- * Adds a listener to the beginning of the listeners array for the specified event.
11067
- * @param eventType - The type of the event.
11068
- * @param listener - The callback function.
11069
- * @param options - Option to support event timestamps.
11070
- *
11071
- * @function prependListener
11072
- * @memberof ExternalApplication
11073
- * @instance
11074
- * @tutorial ExternalApplication.EventEmitter
11075
- */
11076
- /**
11077
- * 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.
11078
- * The listener is added to the beginning of the listeners array.
11079
- * @param eventType - The type of the event.
11080
- * @param listener - The callback function.
11081
- * @param options - Option to support event timestamps.
11082
- *
11083
- * @function prependOnceListener
11084
- * @memberof ExternalApplication
11085
- * @instance
11086
- * @tutorial ExternalApplication.EventEmitter
11087
- */
11088
- /**
11089
- * Remove a listener from the listener array for the specified event.
11090
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
11091
- * @param eventType - The type of the event.
11092
- * @param listener - The callback function.
11093
- * @param options - Option to support event timestamps.
11094
- *
11095
- * @function removeListener
11096
- * @memberof ExternalApplication
11097
- * @instance
11098
- * @tutorial ExternalApplication.EventEmitter
11099
- */
11100
- /**
11101
- * Removes all listeners, or those of the specified event.
11102
- * @param eventType - The type of the event.
11103
- *
11104
- * @function removeAllListeners
11105
- * @memberof ExternalApplication
11106
- * @instance
11107
- * @tutorial ExternalApplication.EventEmitter
11108
- */
11109
9986
  /**
11110
9987
  * Retrieves information about the external application.
11111
9988
  *
@@ -11195,7 +10072,7 @@ Factory$5.ExternalApplicationModule = ExternalApplicationModule;
11195
10072
  * * {@link ExternalApplicationModule} contains static members of the `ExternalApplication` type, accessible through `fin.ExternalApplication`.
11196
10073
  * * {@link ExternalApplication} describes an instance of an OpenFin ExternalApplication, e.g. as returned by `fin.ExternalApplication.getCurrent`.
11197
10074
  *
11198
- * 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),
10075
+ * 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),
11199
10076
  * both of these were documented on the same page.
11200
10077
  *
11201
10078
  * @packageDocumentation
@@ -11242,83 +10119,6 @@ class _Frame extends base_1$a.EmitterBase {
11242
10119
  super(wire, 'frame', identity.uuid, identity.name);
11243
10120
  this.identity = identity;
11244
10121
  }
11245
- /**
11246
- * Adds the listener function to the end of the listeners array for the specified event type.
11247
- * @param eventType - The type of the event.
11248
- * @param listener - Called whenever an event of the specified type occurs.
11249
- * @param options - Option to support event timestamps.
11250
- *
11251
- * @function addListener
11252
- * @memberof Frame
11253
- * @instance
11254
- * @tutorial Frame.EventEmitter
11255
- */
11256
- /**
11257
- * Adds a listener to the end of the listeners array for the specified event.
11258
- * @param eventType - The type of the event.
11259
- * @param listener - Called whenever an event of the specified type occurs.
11260
- * @param options - Option to support event timestamps.
11261
- *
11262
- * @function on
11263
- * @memberof Frame
11264
- * @instance
11265
- * @tutorial Frame.EventEmitter
11266
- */
11267
- /**
11268
- * 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.
11269
- * @param eventType - The type of the event.
11270
- * @param listener - The callback function.
11271
- * @param options - Option to support event timestamps.
11272
- *
11273
- * @function once
11274
- * @memberof Frame
11275
- * @instance
11276
- * @tutorial Frame.EventEmitter
11277
- */
11278
- /**
11279
- * Adds a listener to the beginning of the listeners array for the specified event.
11280
- * @param eventType - The type of the event.
11281
- * @param listener - The callback function.
11282
- * @param options - Option to support event timestamps.
11283
- *
11284
- * @function prependListener
11285
- * @memberof Frame
11286
- * @instance
11287
- * @tutorial Frame.EventEmitter
11288
- */
11289
- /**
11290
- * 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.
11291
- * The listener is added to the beginning of the listeners array.
11292
- * @param eventType - The type of the event.
11293
- * @param listener - The callback function.
11294
- * @param options - Option to support event timestamps.
11295
- *
11296
- * @function prependOnceListener
11297
- * @memberof Frame
11298
- * @instance
11299
- * @tutorial Frame.EventEmitter
11300
- */
11301
- /**
11302
- * Remove a listener from the listener array for the specified event.
11303
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
11304
- * @param eventType - The type of the event.
11305
- * @param listener - The callback function.
11306
- * @param options - Option to support event timestamps.
11307
- *
11308
- * @function removeListener
11309
- * @memberof Frame
11310
- * @instance
11311
- * @tutorial Frame.EventEmitter
11312
- */
11313
- /**
11314
- * Removes all listeners, or those of the specified event.
11315
- * @param eventType - The type of the event.
11316
- *
11317
- * @function removeAllListeners
11318
- * @memberof Frame
11319
- * @instance
11320
- * @tutorial Frame.EventEmitter
11321
- */
11322
10122
  /**
11323
10123
  * Returns a frame info object for the represented frame.
11324
10124
  *
@@ -11446,7 +10246,7 @@ Factory$4._FrameModule = _FrameModule;
11446
10246
  * * {@link _FrameModule} contains static members of the `Frame` API, accessible through `fin.Frame`.
11447
10247
  * * {@link _Frame} describes an instance of an OpenFin Frame, e.g. as returned by `fin.Frame.getCurrent`.
11448
10248
  *
11449
- * 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),
10249
+ * 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),
11450
10250
  * both of these were documented on the same page.
11451
10251
  *
11452
10252
  * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
@@ -12792,7 +11592,6 @@ class Layout extends base_1$6.Base {
12792
11592
  // don't expose
12793
11593
  });
12794
11594
  const client = await this.platform.getClient();
12795
- console.log(`Layout::toConfig() called!`);
12796
11595
  return client.dispatch('get-frame-snapshot', {
12797
11596
  target: this.identity
12798
11597
  });
@@ -12842,7 +11641,7 @@ class Layout extends base_1$6.Base {
12842
11641
  // don't expose
12843
11642
  });
12844
11643
  const client = await __classPrivateFieldGet$5(this, _Layout_layoutClient, "f").getValue();
12845
- const root = await client.getRoot(this.identity);
11644
+ const root = await client.getRoot('layoutName' in this.identity ? this.identity : undefined);
12846
11645
  return layout_entities_1.LayoutNode.getEntity(root, client);
12847
11646
  }
12848
11647
  }
@@ -12860,7 +11659,7 @@ var __classPrivateFieldSet$4 = (commonjsGlobal && commonjsGlobal.__classPrivateF
12860
11659
  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");
12861
11660
  return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
12862
11661
  };
12863
- var _LayoutModule_instances, _LayoutModule_layoutInitializationAttempted, _LayoutModule_layoutManager, _LayoutModule_throwIfLayoutManagerNotInitialized;
11662
+ var _LayoutModule_instances, _LayoutModule_layoutInitializationAttempted, _LayoutModule_layoutManager, _LayoutModule_getBackCompatLayoutManager, _LayoutModule_throwIfLayoutManagerNotInitialized;
12864
11663
  Object.defineProperty(Factory$2, "__esModule", { value: true });
12865
11664
  Factory$2.LayoutModule = void 0;
12866
11665
  const base_1$5 = base$1;
@@ -12923,39 +11722,53 @@ class LayoutModule extends base_1$5.Base {
12923
11722
  throw new Error('Layout.init was already called, please use Layout.create to add additional layouts.');
12924
11723
  }
12925
11724
  __classPrivateFieldSet$4(this, _LayoutModule_layoutInitializationAttempted, true, "f");
12926
- __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayout(this.fin, this.wire, options), "f");
12927
- // back-compat ONLY if layoutManagerOverride not provided
11725
+ __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayoutManager(this.fin, this.wire, options), "f");
11726
+ // apply the initial snapshot which in turn will call fin.Platform.Layout.create()
11727
+ const platformClient = await this.fin.Platform.getCurrentSync().getClient();
11728
+ const snapshot = await platformClient.dispatch('get-initial-layout-snapshot');
11729
+ await __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").applyLayoutSnapshot(snapshot);
12928
11730
  if (!options.layoutManagerOverride) {
12929
- const layoutInstance = await __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").resolveLayout();
12930
- const layout = this.wrapSync(layoutInstance.identity);
12931
- // Backward compat - undocumented / not typed layoutInstance as layoutManager
12932
- return Object.assign(layout, { layoutManager: layoutInstance });
11731
+ return __classPrivateFieldGet$4(this, _LayoutModule_getBackCompatLayoutManager, "f").call(this, this.fin);
12933
11732
  }
12934
- // Warn user if they do not create any layouts in the next 10 seconds
11733
+ // warn user if they do not call create() in the next 30 seconds
12935
11734
  setTimeout(() => {
12936
- const layoutSize = Object.keys(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").getLayouts()).length;
12937
- if (layoutSize === 0) {
12938
- console.warn(`[Layout.init] Layout.init was called but no layouts have been created yet. Make sure you ` +
11735
+ if (__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").size() === 0) {
11736
+ console.warn(`[Layout.init] Layout.init was called 30s ago, but no layouts have been created yet. Make sure you ` +
12939
11737
  `override LayoutManager.applyLayoutSnapshot, and then call fin.Platform.Layout.create()`);
12940
11738
  }
12941
- }, 10000);
11739
+ }, 30000);
12942
11740
  return this.wrapSync(this.fin.me.identity);
12943
11741
  };
11742
+ _LayoutModule_getBackCompatLayoutManager.set(this, async (fin) => {
11743
+ let layoutManager;
11744
+ let resolve;
11745
+ const layoutResolved = new Promise((r) => {
11746
+ resolve = r;
11747
+ });
11748
+ // wait for a layout to be created
11749
+ await fin.me.once('layout-ready', async ({ layoutIdentity }) => {
11750
+ layoutManager = await this.wire.environment.resolveLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
11751
+ // Backward compat - undocumented / not typed openfin-layout as layoutManager
11752
+ // TODO: eventually deprecate this
11753
+ resolve(Object.assign(this.wrapSync(layoutIdentity), { layoutManager }));
11754
+ });
11755
+ return layoutResolved;
11756
+ });
12944
11757
  /**
12945
11758
  * Returns the layout manager for the current window
12946
11759
  * @returns
12947
11760
  */
12948
11761
  this.getCurrentLayoutManagerSync = () => {
12949
- __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this);
11762
+ __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this, `fin.Platform.Layout.getCurrentLayoutManagerSync()`);
12950
11763
  // @ts-expect-error User may have implemented their own snapshot type when overriding LayoutManager
12951
11764
  return __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f");
12952
11765
  };
12953
11766
  this.create = async (options) => {
12954
- __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this);
11767
+ __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this, `fin.Platform.Layout.create()`);
12955
11768
  return this.wire.environment.createLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), options);
12956
11769
  };
12957
11770
  this.destroy = async (layoutIdentity) => {
12958
- __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this);
11771
+ __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this, `fin.Platform.Layout.destroy()`);
12959
11772
  return this.wire.environment.destroyLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
12960
11773
  };
12961
11774
  }
@@ -13054,9 +11867,9 @@ class LayoutModule extends base_1$5.Base {
13054
11867
  }
13055
11868
  }
13056
11869
  Factory$2.LayoutModule = LayoutModule;
13057
- _LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layoutManager = new WeakMap(), _LayoutModule_instances = new WeakSet(), _LayoutModule_throwIfLayoutManagerNotInitialized = function _LayoutModule_throwIfLayoutManagerNotInitialized() {
11870
+ _LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layoutManager = new WeakMap(), _LayoutModule_getBackCompatLayoutManager = new WeakMap(), _LayoutModule_instances = new WeakSet(), _LayoutModule_throwIfLayoutManagerNotInitialized = function _LayoutModule_throwIfLayoutManagerNotInitialized(method) {
13058
11871
  if (!__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f")) {
13059
- throw new Error('You must call init before using this API');
11872
+ throw new Error(`You must call init before using the API ${method}`);
13060
11873
  }
13061
11874
  };
13062
11875
 
@@ -13067,7 +11880,7 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layou
13067
11880
  * * {@link LayoutModule} contains static members of the `Layout` API, accessible through `fin.Platform.Layout`.
13068
11881
  * * {@link Layout} describes an instance of an OpenFin Layout, e.g. as returned by `fin.Platform.Layout.getCurrent`.
13069
11882
  *
13070
- * 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),
11883
+ * 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),
13071
11884
  * both of these were documented on the same page.
13072
11885
  *
13073
11886
  * @packageDocumentation
@@ -13348,7 +12161,7 @@ Factory$3.PlatformModule = PlatformModule;
13348
12161
  * * {@link PlatformModule} contains static members of the `Platform` API, accessible through `fin.Platform`.
13349
12162
  * * {@link Platform} describes an instance of an OpenFin Platform, e.g. as returned by `fin.Platform.getCurrent`.
13350
12163
  *
13351
- * 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),
12164
+ * 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),
13352
12165
  * both of these were documented on the same page.
13353
12166
  *
13354
12167
  * @packageDocumentation
@@ -14236,57 +13049,6 @@ function requireInteropBroker () {
14236
13049
  /*
14237
13050
  Client API
14238
13051
  */
14239
- /**
14240
- * @REMOVED
14241
- * SetContextOptions interface
14242
- * @typedef { object } SetContextOptions
14243
- * @property { Context } {context} - New context to set.
14244
- */
14245
- /**
14246
- * @REMOVED
14247
- * GetContextOptions interface
14248
- * @typedef { object } GetContextOptions
14249
- * @property { string } [contextType] - Context Type
14250
- */
14251
- // TODO: extract inline type and do proper comments
14252
- /**
14253
- * @REMOVED
14254
- * JoinContextGroupOptions interface
14255
- * @typedef { object } JoinContextGroupOptions
14256
- * @property { string } contextGroupId - Id of the context group.
14257
- * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
14258
- */
14259
- /**
14260
- * @REMOVED
14261
- * AddClientToContextGroupOptions interface
14262
- * @typedef { object } AddClientToContextGroupOptions
14263
- * @property { string } contextGroupId - Name of the context group.
14264
- */
14265
- /**
14266
- * @REMOVED
14267
- * RemoveFromContextGroupOptions interface
14268
- * @typedef { object } RemoveFromContextGroupOptions
14269
- * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
14270
- */
14271
- /**
14272
- * @REMOVED
14273
- * GetInfoForContextGroupOptions interface
14274
- * @typedef { object } GetInfoForContextGroupOptions
14275
- * @property { string } contextGroupId - Name of the context group to get info for.
14276
- */
14277
- /**
14278
- * @REMOVED
14279
- * GetAllClientsInContextGroupOptions interface
14280
- * @typedef { object } GetAllClientsInContextGroupOptions
14281
- * @property { string } contextGroupId - Name of the context group to get info for.
14282
- */
14283
- /**
14284
- * @PORTED
14285
- * InfoForIntentOptions interface
14286
- * @typedef { object } InfoForIntentOptions
14287
- * @property { string } name Name of the intent to get info for.
14288
- * @property { Context } [context] Optional context.
14289
- */
14290
13052
  /**
14291
13053
  * Sets a context for the context group of the incoming current entity.
14292
13054
  * @param setContextOptions - New context to set.
@@ -14755,7 +13517,7 @@ function requireInteropBroker () {
14755
13517
  * // }
14756
13518
  * ```
14757
13519
  *
14758
- * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
13520
+ * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
14759
13521
  *
14760
13522
  * @param contextForIntent Data passed between entities and applications.
14761
13523
  * @param clientIdentity Identity of the Client making the request.
@@ -15445,95 +14207,6 @@ InteropClient$1.InteropClient = void 0;
15445
14207
  const base_1$2 = base$1;
15446
14208
  const SessionContextGroupClient_1 = SessionContextGroupClient$1;
15447
14209
  const utils_1$2 = utils$1;
15448
- /**
15449
- * @PORTED
15450
- * @typedef { object } Intent
15451
- * @summary The combination of an action and a context that is passed to an application for resolution.
15452
- * @property { string } name Name of the intent.
15453
- * @property { Context } context Data associated with the intent
15454
- */
15455
- /**
15456
- * @REMOVED
15457
- * @typedef { object } Subscription
15458
- * @summary Object returned when subscribing a handler.
15459
- * @property { function } unsubscribe Function to unsubscribe the handler.
15460
- */
15461
- /**
15462
- * @typedef { function } ContextHandler
15463
- * @summary Subscription function for addContextHandler.
15464
- */
15465
- /**
15466
- * @typedef { function } IntentHandler
15467
- * @summary Subscription function for registerIntentHandler
15468
- */
15469
- /**
15470
- * @PORTED
15471
- * @typedef { object } ClientIdentity
15472
- * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
15473
- * @property {string} uuid GUID of an application.
15474
- * @property {string} name Name of an entity in an application.
15475
- * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
15476
- */
15477
- /**
15478
- * @PORTED
15479
- * @typedef { object } ContextGroupInfo
15480
- * @summary Information for a Context Group. Contains metadata for displaying the group properly.
15481
- * @property {string} id Name of the context group
15482
- * @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.
15483
- */
15484
- /**
15485
- * @PORTED
15486
- * @typedef { object } DisplayMetadata
15487
- * @summary The display data for a Context Group.
15488
- * @property {string} name A user-readable name for this context group, e.g: `"Red"`
15489
- * @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
15490
- * @property {string} [glyph] A URL of an image that can be used to display this context group
15491
- */
15492
- /**
15493
- * @PORTED
15494
- * @typedef { object } Context
15495
- * @summary Data passed between entities and applications.
15496
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
15497
- * @property {string} [name] User-readable name for the incoming context.
15498
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
15499
- */
15500
- /**
15501
- * @REMOVED
15502
- * @typedef { object } ContextForIntent
15503
- * @summary Data passed between entities and applications, including an optional metadata.
15504
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
15505
- * @property {string} [name] User-readable name for the incoming context.
15506
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
15507
- * @property {any} [metadata]
15508
- */
15509
- /**
15510
- * @REMOVED
15511
- * @typedef { object } SessionContextGroup
15512
- * @summary An instance of a SessionContextGroup
15513
- * @property {string} id The SessionContextGroup's id.
15514
- * @property {setContext} setContext Sets a context of a certain type
15515
- * @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
15516
- * @property {addContextHandler} addContextHandler Adds a handler for context change.
15517
- */
15518
- /**
15519
- * @typedef {function} setContext
15520
- * @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
15521
- * @param context The Context to be set.
15522
- *
15523
- */
15524
- /**
15525
- * @typedef {function} getCurrentContext
15526
- * @summary A SessionContextGroup instance method for getting the current context of a certain type.
15527
- * @param contextType The Context Type to get. If not specified the last contextType set would get used.
15528
- *
15529
- */
15530
- /**
15531
- * @typedef {function} addContextHandler
15532
- * @summary A SessionContextGroup instance method for adding a handler for context change.
15533
- * @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.
15534
- * @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.
15535
- *
15536
- */
15537
14210
  /**
15538
14211
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
15539
14212
  *
@@ -16167,13 +14840,6 @@ function requireFactory () {
16167
14840
  const common_utils_1 = commonUtils;
16168
14841
  const defaultOverride = (Class) => new Class();
16169
14842
  const BrokerParamAccessError = 'You have attempted to use or modify InteropBroker parameters, which is not allowed. You are likely using an older InteropBroker override scheme. Please consult our Interop docs for guidance on migrating to the new override scheme.';
16170
- /**
16171
- * @PORTED
16172
- * @typedef { object } InteropConfig
16173
- * @summary Information relevant to the Interop Broker.
16174
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
16175
- * @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
16176
- */
16177
14843
  /**
16178
14844
  * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
16179
14845
  *
@@ -16558,7 +15224,7 @@ Factory.SnapshotSourceModule = SnapshotSourceModule;
16558
15224
  * * {@link SnapshotSourceModule} contains static members of the `SnapshotSource` API, accessible through `fin.SnapshotSource`.
16559
15225
  * * {@link SnapshotSource} describes an instance of an OpenFin SnapshotSource, e.g. as returned by `fin.SnapshotSource.wrap`.
16560
15226
  *
16561
- * 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),
15227
+ * 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),
16562
15228
  * both of these were documented on the same page.
16563
15229
  *
16564
15230
  * @packageDocumentation
@@ -17502,7 +16168,7 @@ function requireNodeEnv () {
17502
16168
  getRtcPeer() {
17503
16169
  throw new Error('Method not implemented.');
17504
16170
  }
17505
- async initLayout() {
16171
+ async initLayoutManager() {
17506
16172
  throw new Error('Method not implemented.');
17507
16173
  }
17508
16174
  async createLayout() {
@@ -17511,6 +16177,9 @@ function requireNodeEnv () {
17511
16177
  async destroyLayout() {
17512
16178
  throw new Error('Method not implemented.');
17513
16179
  }
16180
+ async resolveLayout() {
16181
+ throw new Error('Method not implemented.');
16182
+ }
17514
16183
  async initPlatform() {
17515
16184
  throw new Error('Method not implemented.');
17516
16185
  }