@openfin/node-adapter 33.77.7 → 33.77.9

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.
@@ -30,12 +30,16 @@ function _mergeNamespaces(n, m) {
30
30
 
31
31
  var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
32
32
 
33
+ function getDefaultExportFromCjs (x) {
34
+ return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
35
+ }
36
+
33
37
  var main$1 = {};
34
38
 
35
39
  var fin = {};
36
40
 
37
41
  var eventsExports = {};
38
- var events = {
42
+ var events$1 = {
39
43
  get exports(){ return eventsExports; },
40
44
  set exports(v){ eventsExports = v; },
41
45
  };
@@ -72,7 +76,7 @@ var NumberIsNaN = Number.isNaN || function NumberIsNaN(value) {
72
76
  function EventEmitter() {
73
77
  EventEmitter.init.call(this);
74
78
  }
75
- events.exports = EventEmitter;
79
+ events$1.exports = EventEmitter;
76
80
  eventsExports.once = once;
77
81
 
78
82
  // Backwards-compat with node 0.10.x
@@ -514,9 +518,9 @@ function eventTargetAgnosticAddListener(emitter, name, listener, flags) {
514
518
  }
515
519
  }
516
520
 
517
- var system = {};
521
+ var system$1 = {};
518
522
 
519
- var base = {};
523
+ var base$1 = {};
520
524
 
521
525
  var promises = {};
522
526
 
@@ -559,8 +563,8 @@ var __classPrivateFieldGet$f = (commonjsGlobal && commonjsGlobal.__classPrivateF
559
563
  return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
560
564
  };
561
565
  var _EmitterBase_emitterAccessor;
562
- Object.defineProperty(base, "__esModule", { value: true });
563
- base.Reply = base.EmitterBase = base.Base = void 0;
566
+ Object.defineProperty(base$1, "__esModule", { value: true });
567
+ base$1.Reply = base$1.EmitterBase = base$1.Base = void 0;
564
568
  const promises_1$2 = promises;
565
569
  class Base {
566
570
  /**
@@ -581,11 +585,18 @@ class Base {
581
585
  get fin() {
582
586
  return this.wire.getFin();
583
587
  }
588
+ /**
589
+ * Provides access to the OpenFin representation of the current code context (usually a document
590
+ * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
591
+ *
592
+ * Useful for debugging in the devtools console, where this will intelligently type itself based
593
+ * on the context in which the devtools panel was opened.
594
+ */
584
595
  get me() {
585
596
  return this.wire.me;
586
597
  }
587
598
  }
588
- base.Base = Base;
599
+ base$1.Base = Base;
589
600
  /**
590
601
  * An entity that emits OpenFin events.
591
602
  *
@@ -615,6 +626,9 @@ class EmitterBase extends Base {
615
626
  this.topic = topic;
616
627
  _EmitterBase_emitterAccessor.set(this, void 0);
617
628
  this.eventNames = () => (this.hasEmitter() ? this.getOrCreateEmitter().eventNames() : []);
629
+ /**
630
+ * @internal
631
+ */
618
632
  this.emit = (eventType, payload, ...args) => {
619
633
  return this.hasEmitter() ? this.getOrCreateEmitter().emit(eventType, payload, ...args) : false;
620
634
  };
@@ -657,16 +671,13 @@ class EmitterBase extends Base {
657
671
  // This will only be reached if unsubscribe from event that does not exist but do not want to error here
658
672
  return Promise.resolve();
659
673
  };
660
- this.addListener = this.on;
661
674
  __classPrivateFieldSet$d(this, _EmitterBase_emitterAccessor, [topic, ...additionalAccessors], "f");
662
675
  this.listeners = (event) => this.hasEmitter() ? this.getOrCreateEmitter().listeners(event) : [];
663
676
  }
664
677
  /**
665
678
  * Adds a listener to the end of the listeners array for the specified event.
666
679
  *
667
- * @param eventType
668
- * @param listener
669
- * @param options
680
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
670
681
  */
671
682
  async on(eventType, listener, options) {
672
683
  await this.registerEventListener(eventType, options, (emitter) => {
@@ -676,12 +687,16 @@ class EmitterBase extends Base {
676
687
  });
677
688
  return this;
678
689
  }
690
+ /**
691
+ * Adds a listener to the end of the listeners array for the specified event.
692
+ */
693
+ async addListener(eventType, listener, options) {
694
+ return this.on(eventType, listener, options);
695
+ }
679
696
  /**
680
697
  * 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.
681
698
  *
682
- * @param eventType
683
- * @param listener
684
- * @param options
699
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
685
700
  */
686
701
  async once(eventType, listener, options) {
687
702
  const deregister = () => this.deregisterEventListener(eventType);
@@ -697,9 +712,7 @@ class EmitterBase extends Base {
697
712
  /**
698
713
  * Adds a listener to the beginning of the listeners array for the specified event.
699
714
  *
700
- * @param eventType
701
- * @param listener
702
- * @param options
715
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
703
716
  */
704
717
  async prependListener(eventType, listener, options) {
705
718
  await this.registerEventListener(eventType, options, (emitter) => {
@@ -713,9 +726,7 @@ class EmitterBase extends Base {
713
726
  * Adds a one time listener for the event. The listener is invoked only the first time the event is fired,
714
727
  * after which it is removed. The listener is added to the beginning of the listeners array.
715
728
  *
716
- * @param eventType
717
- * @param listener
718
- * @param options
729
+ * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
719
730
  */
720
731
  async prependOnceListener(eventType, listener, options) {
721
732
  const deregister = () => this.deregisterEventListener(eventType);
@@ -732,10 +743,6 @@ class EmitterBase extends Base {
732
743
  * Remove a listener from the listener array for the specified event.
733
744
  *
734
745
  * @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
735
- *
736
- * @param eventType
737
- * @param listener
738
- * @param options
739
746
  */
740
747
  async removeListener(eventType, listener, options) {
741
748
  const emitter = await this.deregisterEventListener(eventType, options);
@@ -762,7 +769,6 @@ class EmitterBase extends Base {
762
769
  /**
763
770
  * Removes all listeners, or those of the specified event.
764
771
  *
765
- * @param eventType
766
772
  */
767
773
  async removeAllListeners(eventType) {
768
774
  const removeByEvent = async (event) => {
@@ -787,11 +793,11 @@ class EmitterBase extends Base {
787
793
  }
788
794
  }
789
795
  }
790
- base.EmitterBase = EmitterBase;
796
+ base$1.EmitterBase = EmitterBase;
791
797
  _EmitterBase_emitterAccessor = new WeakMap();
792
798
  class Reply {
793
799
  }
794
- base.Reply = Reply;
800
+ base$1.Reply = Reply;
795
801
 
796
802
  var transportErrors = {};
797
803
 
@@ -874,7 +880,7 @@ class RuntimeError extends Error {
874
880
  }
875
881
  transportErrors.RuntimeError = RuntimeError;
876
882
 
877
- var window$1 = {};
883
+ var window$2 = {};
878
884
 
879
885
  var Factory$8 = {};
880
886
 
@@ -893,25 +899,45 @@ validate.validateIdentity = validateIdentity;
893
899
 
894
900
  var Instance$7 = {};
895
901
 
896
- var application = {};
902
+ var application$1 = {};
897
903
 
898
904
  var Factory$7 = {};
899
905
 
900
906
  var Instance$6 = {};
901
907
 
902
- var view = {};
908
+ var view$1 = {};
903
909
 
904
910
  var Factory$6 = {};
905
911
 
912
+ var warnings = {};
913
+
914
+ Object.defineProperty(warnings, "__esModule", { value: true });
915
+ warnings.handleDeprecatedWarnings = void 0;
916
+ const handleDeprecatedWarnings = (options) => {
917
+ var _a, _b, _c, _d;
918
+ if (((_a = options.contentNavigation) === null || _a === void 0 ? void 0 : _a.whitelist) ||
919
+ ((_b = options.contentNavigation) === null || _b === void 0 ? void 0 : _b.blacklist) ||
920
+ ((_c = options.contentRedirect) === null || _c === void 0 ? void 0 : _c.whitelist) ||
921
+ ((_d = options.contentRedirect) === null || _d === void 0 ? void 0 : _d.blacklist)) {
922
+ console.warn(`The properties 'whitelist' and 'blacklist' have been marked as deprecated and will be removed in a future version. Please use 'allowlist' and 'denylist'.`);
923
+ }
924
+ };
925
+ warnings.handleDeprecatedWarnings = handleDeprecatedWarnings;
926
+
906
927
  var hasRequiredFactory$3;
907
928
 
908
929
  function requireFactory$3 () {
909
930
  if (hasRequiredFactory$3) return Factory$6;
910
931
  hasRequiredFactory$3 = 1;
911
932
  Object.defineProperty(Factory$6, "__esModule", { value: true });
912
- const base_1 = base;
933
+ Factory$6.ViewModule = void 0;
934
+ const base_1 = base$1;
913
935
  const validate_1 = validate;
914
936
  const index_1 = requireView();
937
+ const warnings_1 = warnings;
938
+ /**
939
+ * Static namespace for OpenFin API methods that interact with the {@link View} class, available under `fin.View`.
940
+ */
915
941
  class ViewModule extends base_1.Base {
916
942
  /**
917
943
  * Creates a new View.
@@ -940,13 +966,13 @@ function requireFactory$3 () {
940
966
  * ```
941
967
  * Note that created views needs to navigate somewhere for them to actually render a website.
942
968
  * @experimental
943
- * @static
944
969
  */
945
970
  async create(options) {
946
971
  const { uuid } = this.wire.me;
947
972
  if (!options.name || typeof options.name !== 'string') {
948
973
  throw new Error('Please provide a name property as a string in order to create a View.');
949
974
  }
975
+ (0, warnings_1.handleDeprecatedWarnings)(options);
950
976
  if (this.wire.environment.childViews) {
951
977
  await this.wire.environment.createChildContent({
952
978
  entityType: 'view',
@@ -960,7 +986,6 @@ function requireFactory$3 () {
960
986
  }
961
987
  /**
962
988
  * Asynchronously returns a View object that represents an existing view.
963
- * @param identity
964
989
  *
965
990
  * @example
966
991
  * ```js
@@ -969,7 +994,6 @@ function requireFactory$3 () {
969
994
  * .catch(err => console.log(err));
970
995
  * ```
971
996
  * @experimental
972
- * @static
973
997
  */
974
998
  async wrap(identity) {
975
999
  this.wire.sendAction('view-wrap');
@@ -981,7 +1005,6 @@ function requireFactory$3 () {
981
1005
  }
982
1006
  /**
983
1007
  * Synchronously returns a View object that represents an existing view.
984
- * @param identity
985
1008
  *
986
1009
  * @example
987
1010
  * ```js
@@ -989,7 +1012,6 @@ function requireFactory$3 () {
989
1012
  * await view.hide();
990
1013
  * ```
991
1014
  * @experimental
992
- * @static
993
1015
  */
994
1016
  wrapSync(identity) {
995
1017
  this.wire.sendAction('view-wrap-sync').catch((e) => {
@@ -1012,7 +1034,6 @@ function requireFactory$3 () {
1012
1034
  *
1013
1035
  * ```
1014
1036
  * @experimental
1015
- * @static
1016
1037
  */
1017
1038
  getCurrent() {
1018
1039
  this.wire.sendAction('view-get-current').catch((e) => {
@@ -1034,7 +1055,6 @@ function requireFactory$3 () {
1034
1055
  *
1035
1056
  * ```
1036
1057
  * @experimental
1037
- * @static
1038
1058
  */
1039
1059
  getCurrentSync() {
1040
1060
  this.wire.sendAction('view-get-current-sync').catch((e) => {
@@ -1047,7 +1067,7 @@ function requireFactory$3 () {
1047
1067
  return this.wrapSync({ uuid, name });
1048
1068
  }
1049
1069
  }
1050
- Factory$6.default = ViewModule;
1070
+ Factory$6.ViewModule = ViewModule;
1051
1071
  return Factory$6;
1052
1072
  }
1053
1073
 
@@ -1877,8 +1897,12 @@ var main = {};
1877
1897
 
1878
1898
  Object.defineProperty(main, "__esModule", { value: true });
1879
1899
  main.WebContents = void 0;
1880
- const base_1$k = base;
1900
+ const base_1$k = base$1;
1881
1901
  class WebContents extends base_1$k.EmitterBase {
1902
+ /**
1903
+ * @param identity The identity of the {@link OpenFin.WebContentsEvents WebContents}.
1904
+ * @param entityType The type of the {@link OpenFin.WebContentsEvents WebContents}.
1905
+ */
1882
1906
  constructor(wire, identity, entityType) {
1883
1907
  super(wire, entityType, identity.uuid, identity.name);
1884
1908
  this.identity = identity;
@@ -1886,10 +1910,7 @@ class WebContents extends base_1$k.EmitterBase {
1886
1910
  }
1887
1911
  /**
1888
1912
  * Gets a base64 encoded image of all or part of the WebContents.
1889
- * @function capturePage
1890
1913
  * @param options Options for the capturePage call.
1891
- * @memberOf View
1892
- * @instance
1893
1914
  *
1894
1915
  * @example
1895
1916
  *
@@ -1934,6 +1955,11 @@ class WebContents extends base_1$k.EmitterBase {
1934
1955
  * }
1935
1956
  * console.log(await wnd.capturePage(options));
1936
1957
  * ```
1958
+ *
1959
+ * @remarks
1960
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
1961
+ * We do not expose an explicit superclass for this functionality, but it does have its own
1962
+ * {@link OpenFin.WebContentsEvents event namespace}.
1937
1963
  */
1938
1964
  capturePage(options) {
1939
1965
  return this.wire.sendAction('capture-page', { options, ...this.identity }).then(({ payload }) => payload.data);
@@ -1942,9 +1968,6 @@ class WebContents extends base_1$k.EmitterBase {
1942
1968
  * Executes Javascript on the WebContents, restricted to contents you own or contents owned by
1943
1969
  * applications you have created.
1944
1970
  * @param code JavaScript code to be executed on the view.
1945
- * @function executeJavaScript
1946
- * @memberOf View
1947
- * @instance
1948
1971
  *
1949
1972
  * @example
1950
1973
  * View:
@@ -1972,6 +1995,10 @@ class WebContents extends base_1$k.EmitterBase {
1972
1995
  *
1973
1996
  * executeJavaScript(`console.log('Hello, Openfin')`).then(() => console.log('Javascript excuted')).catch(err => console.log(err));
1974
1997
  * ```
1998
+ * @remarks
1999
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2000
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2001
+ * {@link OpenFin.WebContentsEvents event namespace}.
1975
2002
  */
1976
2003
  executeJavaScript(code) {
1977
2004
  return this.wire
@@ -1980,9 +2007,6 @@ class WebContents extends base_1$k.EmitterBase {
1980
2007
  }
1981
2008
  /**
1982
2009
  * Returns the zoom level of the WebContents.
1983
- * @function getZoomLevel
1984
- * @memberOf View
1985
- * @instance
1986
2010
  *
1987
2011
  * @example
1988
2012
  * View:
@@ -2014,6 +2038,10 @@ class WebContents extends base_1$k.EmitterBase {
2014
2038
  *
2015
2039
  * getZoomLevel().then(zoomLevel => console.log(zoomLevel)).catch(err => console.log(err));
2016
2040
  * ```
2041
+ * @remarks
2042
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2043
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2044
+ * {@link OpenFin.WebContentsEvents event namespace}.
2017
2045
  */
2018
2046
  getZoomLevel() {
2019
2047
  return this.wire.sendAction('get-zoom-level', this.identity).then(({ payload }) => payload.data);
@@ -2021,9 +2049,6 @@ class WebContents extends base_1$k.EmitterBase {
2021
2049
  /**
2022
2050
  * Sets the zoom level of the WebContents.
2023
2051
  * @param level The zoom level
2024
- * @function setZoomLevel
2025
- * @memberOf View
2026
- * @instance
2027
2052
  *
2028
2053
  * @example
2029
2054
  * View:
@@ -2055,6 +2080,10 @@ class WebContents extends base_1$k.EmitterBase {
2055
2080
  *
2056
2081
  * setZoomLevel(4).then(() => console.log('Setting a zoom level')).catch(err => console.log(err));
2057
2082
  * ```
2083
+ * @remarks
2084
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2085
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2086
+ * {@link OpenFin.WebContentsEvents event namespace}.
2058
2087
  */
2059
2088
  setZoomLevel(level) {
2060
2089
  return this.wire.sendAction('set-zoom-level', { ...this.identity, level }).then(() => undefined);
@@ -2062,12 +2091,9 @@ class WebContents extends base_1$k.EmitterBase {
2062
2091
  /**
2063
2092
  * Navigates the WebContents to a specified URL.
2064
2093
  *
2065
- * @remarks The url must contain the protocol prefix such as http:// or https://.
2094
+ * Note: The url must contain the protocol prefix such as http:// or https://.
2066
2095
  * @param url - The URL to navigate the WebContents to.
2067
2096
  *
2068
- * @function navigate
2069
- * @memberof View
2070
- * @instance
2071
2097
  * @example
2072
2098
  * View:
2073
2099
  * ```js
@@ -2095,15 +2121,16 @@ class WebContents extends base_1$k.EmitterBase {
2095
2121
  * navigate().then(() => console.log('Navigate to tutorial')).catch(err => console.log(err));
2096
2122
  * ```
2097
2123
  * @experimental
2124
+ * @remarks
2125
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2126
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2127
+ * {@link OpenFin.WebContentsEvents event namespace}.
2098
2128
  */
2099
2129
  navigate(url) {
2100
2130
  return this.wire.sendAction('navigate-window', { ...this.identity, url }).then(() => undefined);
2101
2131
  }
2102
2132
  /**
2103
2133
  * Navigates the WebContents back one page.
2104
- * @function navigateBack
2105
- * @memberOf View
2106
- * @instance
2107
2134
  *
2108
2135
  * @example
2109
2136
  * View:
@@ -2125,15 +2152,16 @@ class WebContents extends base_1$k.EmitterBase {
2125
2152
  * }
2126
2153
  * navigateBack().then(() => console.log('Navigated back')).catch(err => console.log(err));
2127
2154
  * ```
2155
+ * @remarks
2156
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2157
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2158
+ * {@link OpenFin.WebContentsEvents event namespace}.
2128
2159
  */
2129
2160
  navigateBack() {
2130
2161
  return this.wire.sendAction('navigate-window-back', { ...this.identity }).then(() => undefined);
2131
2162
  }
2132
2163
  /**
2133
2164
  * Navigates the WebContents forward one page.
2134
- * @function navigateForward
2135
- * @memberOf View
2136
- * @instance
2137
2165
  *
2138
2166
  * @example
2139
2167
  * View:
@@ -2157,15 +2185,16 @@ class WebContents extends base_1$k.EmitterBase {
2157
2185
  * }
2158
2186
  * navigateForward().then(() => console.log('Navigated forward')).catch(err => console.log(err));
2159
2187
  * ```
2188
+ * @remarks
2189
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2190
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2191
+ * {@link OpenFin.WebContentsEvents event namespace}.
2160
2192
  */
2161
2193
  async navigateForward() {
2162
2194
  await this.wire.sendAction('navigate-window-forward', { ...this.identity });
2163
2195
  }
2164
2196
  /**
2165
2197
  * Stops any current navigation the WebContents is performing.
2166
- * @function stopNavigation
2167
- * @memberOf View
2168
- * @instance
2169
2198
  *
2170
2199
  * @example
2171
2200
  * View:
@@ -2187,15 +2216,16 @@ class WebContents extends base_1$k.EmitterBase {
2187
2216
  * }
2188
2217
  * stopNavigation().then(() => console.log('you shall not navigate')).catch(err => console.log(err));
2189
2218
  * ```
2219
+ * @remarks
2220
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2221
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2222
+ * {@link OpenFin.WebContentsEvents event namespace}.
2190
2223
  */
2191
2224
  stopNavigation() {
2192
2225
  return this.wire.sendAction('stop-window-navigation', { ...this.identity }).then(() => undefined);
2193
2226
  }
2194
2227
  /**
2195
2228
  * Reloads the WebContents
2196
- * @function reload
2197
- * @memberOf View
2198
- * @instance
2199
2229
  *
2200
2230
  * @example
2201
2231
  * View:
@@ -2227,6 +2257,10 @@ class WebContents extends base_1$k.EmitterBase {
2227
2257
  * console.log('Reloaded window')
2228
2258
  * }).catch(err => console.log(err));
2229
2259
  * ```
2260
+ * @remarks
2261
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2262
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2263
+ * {@link OpenFin.WebContentsEvents event namespace}.
2230
2264
  */
2231
2265
  reload(ignoreCache = false) {
2232
2266
  return this.wire
@@ -2239,11 +2273,8 @@ class WebContents extends base_1$k.EmitterBase {
2239
2273
  /**
2240
2274
  * Prints the WebContents.
2241
2275
  * @param options Printer Options
2242
- * @function print
2243
- * @memberOf View
2244
- * @instance
2245
2276
  *
2246
- * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName
2277
+ * Note: When `silent` is set to `true`, the API will pick the system's default printer if deviceName
2247
2278
  * is empty and the default settings for printing.
2248
2279
  *
2249
2280
  * Use the CSS style `page-break-before: always;` to force print to a new page.
@@ -2256,6 +2287,10 @@ class WebContents extends base_1$k.EmitterBase {
2256
2287
  * console.log('print call has been sent to the system');
2257
2288
  * });
2258
2289
  * ```
2290
+ * @remarks
2291
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2292
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2293
+ * {@link OpenFin.WebContentsEvents event namespace}.
2259
2294
  */
2260
2295
  print(options = {}) {
2261
2296
  return this.wire.sendAction('print', { ...this.identity, options }).then(() => undefined);
@@ -2264,11 +2299,8 @@ class WebContents extends base_1$k.EmitterBase {
2264
2299
  * Find and highlight text on a page.
2265
2300
  * @param searchTerm Term to find in page
2266
2301
  * @param options Search options
2267
- * @function findInPage
2268
- * @memberOf View
2269
- * @instance
2270
2302
  *
2271
- * @remarks By default, each subsequent call will highlight the next text that matches the search term.
2303
+ * Note: By default, each subsequent call will highlight the next text that matches the search term.
2272
2304
  *
2273
2305
  * Returns a promise with the results for the request. By subscribing to the
2274
2306
  * found-in-page event, you can get the results of this call as well.
@@ -2303,6 +2335,10 @@ class WebContents extends base_1$k.EmitterBase {
2303
2335
  * console.log(result)
2304
2336
  * });
2305
2337
  * ```
2338
+ * @remarks
2339
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2340
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2341
+ * {@link OpenFin.WebContentsEvents event namespace}.
2306
2342
  */
2307
2343
  findInPage(searchTerm, options) {
2308
2344
  return this.wire
@@ -2346,6 +2382,10 @@ class WebContents extends base_1$k.EmitterBase {
2346
2382
  * console.log(results);
2347
2383
  * });
2348
2384
  * ```
2385
+ * @remarks
2386
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2387
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2388
+ * {@link OpenFin.WebContentsEvents event namespace}.
2349
2389
  */
2350
2390
  stopFindInPage(action) {
2351
2391
  return this.wire.sendAction('stop-find-in-page', { ...this.identity, action }).then(() => undefined);
@@ -2353,9 +2393,6 @@ class WebContents extends base_1$k.EmitterBase {
2353
2393
  /**
2354
2394
  * Returns an array with all system printers
2355
2395
  * @deprecated use System.getPrinters instead
2356
- * @function getPrinters
2357
- * @memberOf View
2358
- * @instance
2359
2396
  *
2360
2397
  * @example
2361
2398
  * View:
@@ -2391,6 +2428,10 @@ class WebContents extends base_1$k.EmitterBase {
2391
2428
  * console.log(err);
2392
2429
  * });
2393
2430
  * ```
2431
+ * @remarks
2432
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2433
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2434
+ * {@link OpenFin.WebContentsEvents event namespace}.
2394
2435
  */
2395
2436
  getPrinters() {
2396
2437
  return this.wire.sendAction('get-printers', { ...this.identity }).then(({ payload }) => payload.data);
@@ -2398,10 +2439,6 @@ class WebContents extends base_1$k.EmitterBase {
2398
2439
  /**
2399
2440
  * Gives focus to the WebContents.
2400
2441
  *
2401
- * @function focus
2402
- * @emits focused
2403
- * @memberOf Window
2404
- * @instance
2405
2442
  * @example
2406
2443
  * ```js
2407
2444
  * async function focusWindow() {
@@ -2417,15 +2454,16 @@ class WebContents extends base_1$k.EmitterBase {
2417
2454
  *
2418
2455
  * focusWindow().then(() => console.log('Window focused')).catch(err => console.log(err));
2419
2456
  * ```
2457
+ * @remarks
2458
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2459
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2460
+ * {@link OpenFin.WebContentsEvents event namespace}.
2420
2461
  */
2421
2462
  async focus({ emitSynthFocused } = { emitSynthFocused: true }) {
2422
2463
  await this.wire.sendAction('focus-window', { emitSynthFocused, ...this.identity });
2423
2464
  }
2424
2465
  /**
2425
2466
  * Shows the Chromium Developer Tools
2426
- * @function showDeveloperTools
2427
- * @memberOf View
2428
- * @instance
2429
2467
  *
2430
2468
  * @example
2431
2469
  * View:
@@ -2451,6 +2489,10 @@ class WebContents extends base_1$k.EmitterBase {
2451
2489
  * .then(() => console.log('Showing dev tools'))
2452
2490
  * .catch(err => console.error(err));
2453
2491
  * ```
2492
+ * @remarks
2493
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2494
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2495
+ * {@link OpenFin.WebContentsEvents event namespace}.
2454
2496
  */
2455
2497
  async showDeveloperTools() {
2456
2498
  // Note this hits the system action map in core state for legacy reasons.
@@ -2459,11 +2501,7 @@ class WebContents extends base_1$k.EmitterBase {
2459
2501
  /**
2460
2502
  * Retrieves the process information associated with a WebContents.
2461
2503
  *
2462
- * @remarks This includes any iframes associated with the WebContents
2463
- *
2464
- * @function getProcessInfo
2465
- * @memberOf View
2466
- * @instance
2504
+ * Note: This includes any iframes associated with the WebContents
2467
2505
  *
2468
2506
  * @example
2469
2507
  * View:
@@ -2477,6 +2515,10 @@ class WebContents extends base_1$k.EmitterBase {
2477
2515
  * const win = await fin.Window.getCurrent();
2478
2516
  * const processInfo = await win.getProcessInfo();
2479
2517
  * ```
2518
+ * @remarks
2519
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2520
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2521
+ * {@link OpenFin.WebContentsEvents event namespace}.
2480
2522
  */
2481
2523
  async getProcessInfo() {
2482
2524
  const { payload: { data } } = await this.wire.sendAction('get-process-info', this.identity);
@@ -2484,9 +2526,6 @@ class WebContents extends base_1$k.EmitterBase {
2484
2526
  }
2485
2527
  /**
2486
2528
  * Retrieves information on all Shared Workers.
2487
- * @function getSharedWorkers
2488
- * @memberOf View
2489
- * @instance
2490
2529
  *
2491
2530
  * @example
2492
2531
  * View:
@@ -2515,15 +2554,16 @@ class WebContents extends base_1$k.EmitterBase {
2515
2554
  * const win = await fin.Window.create(winOption);
2516
2555
  * const sharedWorkers = await win.getSharedWorkers();
2517
2556
  * ```
2557
+ * @remarks
2558
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2559
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2560
+ * {@link OpenFin.WebContentsEvents event namespace}.
2518
2561
  */
2519
2562
  async getSharedWorkers() {
2520
2563
  return this.wire.sendAction('get-shared-workers', this.identity).then(({ payload }) => payload.data);
2521
2564
  }
2522
2565
  /**
2523
2566
  * Opens the developer tools for the shared worker context.
2524
- * @function inspectSharedWorker
2525
- * @memberOf View
2526
- * @instance
2527
2567
  *
2528
2568
  * @example
2529
2569
  * View:
@@ -2552,6 +2592,10 @@ class WebContents extends base_1$k.EmitterBase {
2552
2592
  * const win = await fin.Window.create(winOption);
2553
2593
  * await win.inspectSharedWorker();
2554
2594
  * ```
2595
+ * @remarks
2596
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2597
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2598
+ * {@link OpenFin.WebContentsEvents event namespace}.
2555
2599
  */
2556
2600
  async inspectSharedWorker() {
2557
2601
  await this.wire.sendAction('inspect-shared-worker', { ...this.identity });
@@ -2559,9 +2603,6 @@ class WebContents extends base_1$k.EmitterBase {
2559
2603
  /**
2560
2604
  * Inspects the shared worker based on its ID.
2561
2605
  * @param workerId - The id of the shared worker.
2562
- * @function inspectSharedWorkerById
2563
- * @memberOf View
2564
- * @instance
2565
2606
  *
2566
2607
  * @example
2567
2608
  * View:
@@ -2592,15 +2633,16 @@ class WebContents extends base_1$k.EmitterBase {
2592
2633
  * const sharedWorkers = await win.getSharedWorkers();
2593
2634
  * await win.inspectSharedWorkerById(sharedWorkers[0].id);
2594
2635
  * ```
2636
+ * @remarks
2637
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2638
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2639
+ * {@link OpenFin.WebContentsEvents event namespace}.
2595
2640
  */
2596
2641
  async inspectSharedWorkerById(workerId) {
2597
2642
  await this.wire.sendAction('inspect-shared-worker-by-id', { ...this.identity, workerId });
2598
2643
  }
2599
2644
  /**
2600
2645
  * Opens the developer tools for the service worker context.
2601
- * @function inspectServiceWorker
2602
- * @memberOf View
2603
- * @instance
2604
2646
  *
2605
2647
  * @example
2606
2648
  * View:
@@ -2629,6 +2671,10 @@ class WebContents extends base_1$k.EmitterBase {
2629
2671
  * const win = await fin.Window.create(winOption);
2630
2672
  * await win.inspectServiceWorker();
2631
2673
  * ```
2674
+ * @remarks
2675
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2676
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2677
+ * {@link OpenFin.WebContentsEvents event namespace}.
2632
2678
  */
2633
2679
  async inspectServiceWorker() {
2634
2680
  await this.wire.sendAction('inspect-service-worker', { ...this.identity });
@@ -2636,7 +2682,7 @@ class WebContents extends base_1$k.EmitterBase {
2636
2682
  /**
2637
2683
  * Shows a popup window.
2638
2684
  *
2639
- * @remarks If this WebContents is a view and its attached window has a popup open, this will close it.
2685
+ * Note: If this WebContents is a view and its attached window has a popup open, this will close it.
2640
2686
  *
2641
2687
  * Shows a popup window. Including a `name` in `options` will attempt to show an existing window as a popup, if
2642
2688
  * that window doesn't exist or no `name` is included a window will be created. If the caller view or the caller
@@ -2644,7 +2690,7 @@ class WebContents extends base_1$k.EmitterBase {
2644
2690
  * open popup window before showing the new popup window. Also, if the caller view is destroyed or detached, the popup
2645
2691
  * will be dismissed.
2646
2692
  *
2647
- * NOTE: in the case where the window being shown as a popup needs to be created, it is a child of the caller view's parent window.
2693
+ * Note: in the case where the window being shown as a popup needs to be created, it is a child of the caller view's parent window.
2648
2694
  *
2649
2695
  * @example
2650
2696
  *
@@ -2839,11 +2885,10 @@ class WebContents extends base_1$k.EmitterBase {
2839
2885
  * onPopupReady: popupWindowCallback;
2840
2886
  * });
2841
2887
  * ```
2842
- * @function showPopupWindow
2843
- * @memberOf View
2844
- * @instance
2845
- * @param options
2846
- *
2888
+ * @remarks
2889
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2890
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2891
+ * {@link OpenFin.WebContentsEvents event namespace}.
2847
2892
  */
2848
2893
  async showPopupWindow(options) {
2849
2894
  this.wire.sendAction(`${this.entityType}-show-popup-window`, this.identity).catch(() => {
@@ -3128,7 +3173,6 @@ function requireInstance$2 () {
3128
3173
  * Attaches the current view to the given window identity.
3129
3174
  * Identity must be the identity of a window in the same application.
3130
3175
  * This detaches the view from its current window, and sets the view to be destroyed when its new window closes.
3131
- * @param target {Identity}
3132
3176
  *
3133
3177
  * @example
3134
3178
  * ```js
@@ -3257,7 +3301,6 @@ function requireInstance$2 () {
3257
3301
  };
3258
3302
  /**
3259
3303
  * Sets the bounds (top, left, width, height) of the view relative to its window.
3260
- * @param bounds {ViewBounds}
3261
3304
  *
3262
3305
  * @remarks View position is relative to the bounds of the window.
3263
3306
  * ({top: 0, left: 0} represents the top left corner of the window)
@@ -3422,7 +3465,6 @@ function requireInstance$2 () {
3422
3465
  };
3423
3466
  /**
3424
3467
  * Updates the view's options.
3425
- * @param options
3426
3468
  *
3427
3469
  * @example
3428
3470
  * ```js
@@ -3463,7 +3505,6 @@ function requireInstance$2 () {
3463
3505
  /**
3464
3506
  * Retrieves the window the view is currently attached to.
3465
3507
  *
3466
- * @experimental
3467
3508
  * @example
3468
3509
  * ```js
3469
3510
  * const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
@@ -3471,6 +3512,7 @@ function requireInstance$2 () {
3471
3512
  * .then(win => console.log('current window', win))
3472
3513
  * .catch(err => console.log(err));)
3473
3514
  * ```
3515
+ * @experimental
3474
3516
  */
3475
3517
  this.getCurrentWindow = async () => {
3476
3518
  const { payload: { data } } = await this.wire.sendAction('get-view-window', { ...this.identity });
@@ -3576,10 +3618,6 @@ function requireInstance$2 () {
3576
3618
  /**
3577
3619
  * Focuses the view
3578
3620
  *
3579
- * @function focus
3580
- * @memberof View
3581
- * @emits focused
3582
- * @instance
3583
3621
  * @example
3584
3622
  * ```js
3585
3623
  * const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
@@ -3602,7 +3640,7 @@ function requireInstance$2 () {
3602
3640
  var hasRequiredView;
3603
3641
 
3604
3642
  function requireView () {
3605
- if (hasRequiredView) return view;
3643
+ if (hasRequiredView) return view$1;
3606
3644
  hasRequiredView = 1;
3607
3645
  (function (exports) {
3608
3646
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
@@ -3621,19 +3659,20 @@ function requireView () {
3621
3659
  };
3622
3660
  Object.defineProperty(exports, "__esModule", { value: true });
3623
3661
  /**
3624
- * Entry point for the OpenFin View namespace.
3662
+ * Entry points for the OpenFin `View` API (`fin.View`).
3663
+ *
3664
+ * * {@link ViewModule} contains static members of the `View` API, accessible through `fin.View`.
3665
+ * * {@link View} describes an instance of an OpenFin View, e.g. as returned by `fin.View.getCurrent`.
3625
3666
  *
3626
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "ViewModule" is used for
3627
- * the module containing static members of the `View` namespace (available under `fin.View`), while `View` documents
3628
- * instances of the OpenFin `View` class.
3667
+ * 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),
3668
+ * both of these were documented on the same page.
3629
3669
  *
3630
3670
  * @packageDocumentation
3631
3671
  */
3632
- const Factory_1 = requireFactory$3();
3633
- exports.default = Factory_1.default;
3672
+ __exportStar(requireFactory$3(), exports);
3634
3673
  __exportStar(requireInstance$2(), exports);
3635
- } (view));
3636
- return view;
3674
+ } (view$1));
3675
+ return view$1;
3637
3676
  }
3638
3677
 
3639
3678
  var hasRequiredInstance$1;
@@ -3644,7 +3683,7 @@ function requireInstance$1 () {
3644
3683
  Object.defineProperty(Instance$6, "__esModule", { value: true });
3645
3684
  Instance$6.Application = void 0;
3646
3685
  /* eslint-disable import/prefer-default-export */
3647
- const base_1 = base;
3686
+ const base_1 = base$1;
3648
3687
  const window_1 = requireWindow();
3649
3688
  const view_1 = requireView();
3650
3689
  /**
@@ -4119,6 +4158,7 @@ function requireInstance$1 () {
4119
4158
  /**
4120
4159
  * Sets or removes a custom JumpList for the application. Only applicable in Windows OS.
4121
4160
  * If categories is null the previously set custom JumpList (if any) will be replaced by the standard JumpList for the app (managed by Windows).
4161
+ *
4122
4162
  * Note: If the "name" property is omitted it defaults to "tasks".
4123
4163
  * @param jumpListCategories An array of JumpList Categories to populate. If null, remove any existing JumpList configuration and set to Windows default.
4124
4164
  *
@@ -4419,6 +4459,7 @@ function requireInstance$1 () {
4419
4459
  }
4420
4460
  /**
4421
4461
  * Sets file auto download location. It's only allowed in the same application.
4462
+ *
4422
4463
  * Note: This method is restricted by default and must be enabled via
4423
4464
  * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
4424
4465
  * @param downloadLocation file auto download location
@@ -4444,6 +4485,7 @@ function requireInstance$1 () {
4444
4485
  }
4445
4486
  /**
4446
4487
  * Gets file auto download location. It's only allowed in the same application. If file auto download location is not set, it will return the default location.
4488
+ *
4447
4489
  * Note: This method is restricted by default and must be enabled via
4448
4490
  * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
4449
4491
  *
@@ -4470,13 +4512,16 @@ function requireFactory$2 () {
4470
4512
  if (hasRequiredFactory$2) return Factory$7;
4471
4513
  hasRequiredFactory$2 = 1;
4472
4514
  Object.defineProperty(Factory$7, "__esModule", { value: true });
4473
- const base_1 = base;
4515
+ Factory$7.ApplicationModule = void 0;
4516
+ const base_1 = base$1;
4474
4517
  const validate_1 = validate;
4475
4518
  const Instance_1 = requireInstance$1();
4519
+ /**
4520
+ * Static namespace for OpenFin API methods that interact with the {@link Application} class, available under `fin.Application`.
4521
+ */
4476
4522
  class ApplicationModule extends base_1.Base {
4477
4523
  /**
4478
4524
  * Asynchronously returns an Application object that represents an existing application.
4479
- * @param identity
4480
4525
  *
4481
4526
  * @example
4482
4527
  *
@@ -4487,7 +4532,6 @@ function requireFactory$2 () {
4487
4532
  * .catch(err => console.log(err));
4488
4533
  * ```
4489
4534
  *
4490
- * @static
4491
4535
  */
4492
4536
  async wrap(identity) {
4493
4537
  this.wire.sendAction('wrap-application').catch((e) => {
@@ -4501,7 +4545,6 @@ function requireFactory$2 () {
4501
4545
  }
4502
4546
  /**
4503
4547
  * Synchronously returns an Application object that represents an existing application.
4504
- * @param identity
4505
4548
  *
4506
4549
  * @example
4507
4550
  *
@@ -4510,7 +4553,6 @@ function requireFactory$2 () {
4510
4553
  * await app.close();
4511
4554
  * ```
4512
4555
  *
4513
- * @static
4514
4556
  */
4515
4557
  wrapSync(identity) {
4516
4558
  this.wire.sendAction('wrap-application-sync').catch((e) => {
@@ -4535,8 +4577,6 @@ function requireFactory$2 () {
4535
4577
  }
4536
4578
  /**
4537
4579
  * DEPRECATED method to create a new Application. Use {@link Application.ApplicationModule.start Application.start} instead.
4538
- * @param appOptions
4539
- *
4540
4580
  *
4541
4581
  * @example
4542
4582
  *
@@ -4565,7 +4605,6 @@ function requireFactory$2 () {
4565
4605
  }
4566
4606
  /**
4567
4607
  * Creates and starts a new Application.
4568
- * @param appOptions
4569
4608
  *
4570
4609
  * @example
4571
4610
  *
@@ -4581,8 +4620,6 @@ function requireFactory$2 () {
4581
4620
  * start().then(() => console.log('Application is running')).catch(err => console.log(err));
4582
4621
  * ```
4583
4622
  *
4584
- *
4585
- * @static
4586
4623
  */
4587
4624
  async start(appOptions) {
4588
4625
  this.wire.sendAction('start-application').catch((e) => {
@@ -4595,10 +4632,8 @@ function requireFactory$2 () {
4595
4632
  /**
4596
4633
  * Asynchronously starts a batch of applications given an array of application identifiers and manifestUrls.
4597
4634
  * Returns once the RVM is finished attempting to launch the applications.
4598
- * @param applications
4599
4635
  * @param opts - Parameters that the RVM will use.
4600
4636
  *
4601
- * @static
4602
4637
  * @example
4603
4638
  *
4604
4639
  * ```js
@@ -4650,8 +4685,6 @@ function requireFactory$2 () {
4650
4685
  * });
4651
4686
  *
4652
4687
  * ```
4653
- *
4654
- * @static
4655
4688
  */
4656
4689
  getCurrent() {
4657
4690
  this.wire.sendAction('get-current-application').catch((e) => {
@@ -4677,8 +4710,6 @@ function requireFactory$2 () {
4677
4710
  * });
4678
4711
  *
4679
4712
  * ```
4680
- *
4681
- * @static
4682
4713
  */
4683
4714
  getCurrentSync() {
4684
4715
  this.wire.sendAction('get-current-application-sync').catch((e) => {
@@ -4699,8 +4730,6 @@ function requireFactory$2 () {
4699
4730
  * // For a local manifest file:
4700
4731
  * fin.Application.startFromManifest('file:///C:/somefolder/app.json').then(app => console.log('App is running')).catch(err => console.log(err));
4701
4732
  * ```
4702
- *
4703
- * @static
4704
4733
  */
4705
4734
  async startFromManifest(manifestUrl, opts) {
4706
4735
  this.wire.sendAction('application-start-from-manifest').catch((e) => {
@@ -4745,14 +4774,14 @@ function requireFactory$2 () {
4745
4774
  });
4746
4775
  }
4747
4776
  }
4748
- Factory$7.default = ApplicationModule;
4777
+ Factory$7.ApplicationModule = ApplicationModule;
4749
4778
  return Factory$7;
4750
4779
  }
4751
4780
 
4752
4781
  var hasRequiredApplication;
4753
4782
 
4754
4783
  function requireApplication () {
4755
- if (hasRequiredApplication) return application;
4784
+ if (hasRequiredApplication) return application$1;
4756
4785
  hasRequiredApplication = 1;
4757
4786
  (function (exports) {
4758
4787
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
@@ -4771,19 +4800,20 @@ function requireApplication () {
4771
4800
  };
4772
4801
  Object.defineProperty(exports, "__esModule", { value: true });
4773
4802
  /**
4774
- * Entry point for the OpenFin Application namespace.
4803
+ * Entry points for the OpenFin `Application` API (`fin.Application`).
4804
+ *
4805
+ * * {@link ApplicationModule} contains static members of the `Application` API, accessible through `fin.Application`.
4806
+ * * {@link Application} describes an instance of an OpenFin Application, e.g. as returned by `fin.Application.getCurrent`.
4775
4807
  *
4776
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "ApplicationModule" is used for
4777
- * the module containing static members of the `Application` namespace (available under `fin.Application`), while `Application` documents
4778
- * instances of the OpenFin `Application` class.
4808
+ * 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),
4809
+ * both of these were documented on the same page.
4779
4810
  *
4780
4811
  * @packageDocumentation
4781
4812
  */
4782
- const Factory_1 = requireFactory$2();
4813
+ __exportStar(requireFactory$2(), exports);
4783
4814
  __exportStar(requireInstance$1(), exports);
4784
- exports.default = Factory_1.default;
4785
- } (application));
4786
- return application;
4815
+ } (application$1));
4816
+ return application$1;
4787
4817
  }
4788
4818
 
4789
4819
  var hasRequiredInstance;
@@ -4800,6 +4830,7 @@ function requireInstance () {
4800
4830
  const application_1 = requireApplication();
4801
4831
  const main_1 = main;
4802
4832
  const view_1 = requireView();
4833
+ const warnings_1 = warnings;
4803
4834
  /**
4804
4835
  * @PORTED
4805
4836
  * @typedef { object } Margins
@@ -5284,7 +5315,6 @@ function requireInstance () {
5284
5315
  */
5285
5316
  constructor(wire, identity) {
5286
5317
  super(wire, identity, 'window');
5287
- this.identity = identity;
5288
5318
  }
5289
5319
  /**
5290
5320
  * Adds a listener to the end of the listeners array for the specified event.
@@ -5410,6 +5440,7 @@ function requireInstance () {
5410
5440
  if (options.autoShow === undefined) {
5411
5441
  options.autoShow = true;
5412
5442
  }
5443
+ (0, warnings_1.handleDeprecatedWarnings)(options);
5413
5444
  const windowCreation = this.wire.environment.createChildContent({ entityType: 'window', options });
5414
5445
  Promise.all([pageResponse, windowCreation])
5415
5446
  .then((resolvedArr) => {
@@ -6115,11 +6146,12 @@ function requireInstance () {
6115
6146
  * moveBy(580, 300).then(() => console.log('Moved')).catch(err => console.log(err));
6116
6147
  * ```
6117
6148
  */
6118
- moveBy(deltaLeft, deltaTop) {
6149
+ moveBy(deltaLeft, deltaTop, positioningOptions) {
6119
6150
  return this.wire
6120
6151
  .sendAction('move-window-by', {
6121
6152
  deltaLeft,
6122
6153
  deltaTop,
6154
+ positioningOptions,
6123
6155
  ...this.identity
6124
6156
  })
6125
6157
  .then(() => undefined);
@@ -6149,11 +6181,12 @@ function requireInstance () {
6149
6181
  * moveTo(580, 300).then(() => console.log('Moved')).catch(err => console.log(err))
6150
6182
  * ```
6151
6183
  */
6152
- moveTo(left, top) {
6184
+ moveTo(left, top, positioningOptions) {
6153
6185
  return this.wire
6154
6186
  .sendAction('move-window', {
6155
6187
  left,
6156
6188
  top,
6189
+ positioningOptions,
6157
6190
  ...this.identity
6158
6191
  })
6159
6192
  .then(() => undefined);
@@ -6186,12 +6219,13 @@ function requireInstance () {
6186
6219
  * resizeBy(580, 300, 'top-right').then(() => console.log('Resized')).catch(err => console.log(err));
6187
6220
  * ```
6188
6221
  */
6189
- resizeBy(deltaWidth, deltaHeight, anchor) {
6222
+ resizeBy(deltaWidth, deltaHeight, anchor, positioningOptions) {
6190
6223
  return this.wire
6191
6224
  .sendAction('resize-window-by', {
6192
6225
  deltaWidth: Math.floor(deltaWidth),
6193
6226
  deltaHeight: Math.floor(deltaHeight),
6194
6227
  anchor,
6228
+ positioningOptions,
6195
6229
  ...this.identity
6196
6230
  })
6197
6231
  .then(() => undefined);
@@ -6224,12 +6258,13 @@ function requireInstance () {
6224
6258
  * resizeTo(580, 300, 'top-left').then(() => console.log('Resized')).catch(err => console.log(err));
6225
6259
  * ```
6226
6260
  */
6227
- resizeTo(width, height, anchor) {
6261
+ resizeTo(width, height, anchor, positioningOptions) {
6228
6262
  return this.wire
6229
6263
  .sendAction('resize-window', {
6230
6264
  width: Math.floor(width),
6231
6265
  height: Math.floor(height),
6232
6266
  anchor,
6267
+ positioningOptions,
6233
6268
  ...this.identity
6234
6269
  })
6235
6270
  .then(() => undefined);
@@ -6288,7 +6323,6 @@ function requireInstance () {
6288
6323
  }
6289
6324
  /**
6290
6325
  * Sets the window's size and position.
6291
- * @property { Bounds } bounds This is a * @type {string} name - name of the window.object that holds the propertys of
6292
6326
  *
6293
6327
  * @example
6294
6328
  * ```js
@@ -6315,8 +6349,10 @@ function requireInstance () {
6315
6349
  * }).then(() => console.log('Bounds set to window')).catch(err => console.log(err));
6316
6350
  * ```
6317
6351
  */
6318
- setBounds(bounds) {
6319
- return this.wire.sendAction('set-window-bounds', { ...bounds, ...this.identity }).then(() => undefined);
6352
+ setBounds(bounds, positioningOptions) {
6353
+ return this.wire
6354
+ .sendAction('set-window-bounds', { ...bounds, ...this.identity, positioningOptions })
6355
+ .then(() => undefined);
6320
6356
  }
6321
6357
  /**
6322
6358
  * Shows the window if it is hidden.
@@ -6458,7 +6494,10 @@ function requireInstance () {
6458
6494
  * Calling this method will close previously opened menus.
6459
6495
  * @experimental
6460
6496
  * @param options
6461
- *
6497
+ * @typeParam Data User-defined shape for data returned upon menu item click. Should be a
6498
+ * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
6499
+ * of all possible data shapes for the entire menu, and the click handler should process
6500
+ * these with a "reducer" pattern.
6462
6501
  * @example
6463
6502
  * This could be used to show a drop down menu over views in a platform window:
6464
6503
  * ```js
@@ -6548,6 +6587,7 @@ function requireInstance () {
6548
6587
  return this.wire.sendAction('close-popup-menu', { ...this.identity }).then(() => undefined);
6549
6588
  }
6550
6589
  /**
6590
+ * @PORTED
6551
6591
  * @typedef {object} PopupOptions
6552
6592
  * @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.
6553
6593
  * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
@@ -6565,6 +6605,7 @@ function requireInstance () {
6565
6605
  * @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.
6566
6606
  */
6567
6607
  /**
6608
+ * @PORTED
6568
6609
  * @typedef {object} PopupResult
6569
6610
  * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
6570
6611
  * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
@@ -6654,13 +6695,16 @@ function requireFactory$1 () {
6654
6695
  if (hasRequiredFactory$1) return Factory$8;
6655
6696
  hasRequiredFactory$1 = 1;
6656
6697
  Object.defineProperty(Factory$8, "__esModule", { value: true });
6657
- const base_1 = base;
6698
+ Factory$8._WindowModule = void 0;
6699
+ const base_1 = base$1;
6658
6700
  const validate_1 = validate;
6659
6701
  const Instance_1 = requireInstance();
6702
+ /**
6703
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
6704
+ */
6660
6705
  class _WindowModule extends base_1.Base {
6661
6706
  /**
6662
6707
  * Asynchronously returns a Window object that represents an existing window.
6663
- * @param identity
6664
6708
  *
6665
6709
  * @example
6666
6710
  * ```js
@@ -6677,7 +6721,6 @@ function requireFactory$1 () {
6677
6721
  * .then(win => console.log('wrapped window'))
6678
6722
  * .catch(err => console.log(err));
6679
6723
  * ```
6680
- * @static
6681
6724
  */
6682
6725
  async wrap(identity) {
6683
6726
  this.wire.sendAction('window-wrap').catch((e) => {
@@ -6691,7 +6734,6 @@ function requireFactory$1 () {
6691
6734
  }
6692
6735
  /**
6693
6736
  * Synchronously returns a Window object that represents an existing window.
6694
- * @param identity
6695
6737
  *
6696
6738
  * @example
6697
6739
  * ```js
@@ -6707,7 +6749,6 @@ function requireFactory$1 () {
6707
6749
  * await createWin();
6708
6750
  * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
6709
6751
  * ```
6710
- * @static
6711
6752
  */
6712
6753
  wrapSync(identity) {
6713
6754
  this.wire.sendAction('window-wrap-sync').catch((e) => {
@@ -6739,7 +6780,6 @@ function requireFactory$1 () {
6739
6780
  *
6740
6781
  * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
6741
6782
  * ```
6742
- * @static
6743
6783
  */
6744
6784
  create(options) {
6745
6785
  this.wire.sendAction('create-window').catch((e) => {
@@ -6758,7 +6798,6 @@ function requireFactory$1 () {
6758
6798
  * .catch(err => console.log(err));
6759
6799
  *
6760
6800
  * ```
6761
- * @static
6762
6801
  */
6763
6802
  getCurrent() {
6764
6803
  this.wire.sendAction('get-current-window').catch((e) => {
@@ -6780,7 +6819,6 @@ function requireFactory$1 () {
6780
6819
  * console.log(info);
6781
6820
  *
6782
6821
  * ```
6783
- * @static
6784
6822
  */
6785
6823
  getCurrentSync() {
6786
6824
  this.wire.sendAction('get-current-window-sync').catch((e) => {
@@ -6793,14 +6831,14 @@ function requireFactory$1 () {
6793
6831
  return this.wrapSync({ uuid, name });
6794
6832
  }
6795
6833
  }
6796
- Factory$8.default = _WindowModule;
6834
+ Factory$8._WindowModule = _WindowModule;
6797
6835
  return Factory$8;
6798
6836
  }
6799
6837
 
6800
6838
  var hasRequiredWindow;
6801
6839
 
6802
6840
  function requireWindow () {
6803
- if (hasRequiredWindow) return window$1;
6841
+ if (hasRequiredWindow) return window$2;
6804
6842
  hasRequiredWindow = 1;
6805
6843
  (function (exports) {
6806
6844
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
@@ -6819,25 +6857,34 @@ function requireWindow () {
6819
6857
  };
6820
6858
  Object.defineProperty(exports, "__esModule", { value: true });
6821
6859
  /**
6822
- * Entry point for the OpenFin Window namespace.
6860
+ * Entry points for the OpenFin `Window` API (`fin.Window`).
6861
+ *
6862
+ * * {@link _WindowModule} contains static members of the `Window` API, accessible through `fin.Window`.
6863
+ * * {@link _Window} describes an instance of an OpenFin Window, e.g. as returned by `fin.Window.getCurrent`.
6823
6864
  *
6824
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "WindowModule" is used for
6825
- * the module containing static members of the `Window` namespace (available under `fin.Window`), while `Window` documents
6826
- * instances of the OpenFin `Window` class.
6865
+ * 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),
6866
+ * both of these were documented on the same page.
6827
6867
  *
6828
- * Because the `Window` name aliases a DOM entity, the documentation pipeline prefixes the name with an underscore.
6868
+ * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
6829
6869
  *
6830
6870
  * @packageDocumentation
6831
6871
  */
6832
- const Factory_1 = requireFactory$1();
6833
- exports.default = Factory_1.default;
6872
+ __exportStar(requireFactory$1(), exports);
6834
6873
  __exportStar(requireInstance(), exports);
6835
- } (window$1));
6836
- return window$1;
6874
+ } (window$2));
6875
+ return window$2;
6837
6876
  }
6838
6877
 
6839
- Object.defineProperty(system, "__esModule", { value: true });
6840
- const base_1$j = base;
6878
+ /**
6879
+ * Entry point for the OpenFin `System` API (`fin.System`).
6880
+ *
6881
+ * * {@link System} contains static members of the `System` API (available under `fin.System`)
6882
+ *
6883
+ * @packageDocumentation
6884
+ */
6885
+ Object.defineProperty(system$1, "__esModule", { value: true });
6886
+ system$1.System = void 0;
6887
+ const base_1$j = base$1;
6841
6888
  const transport_errors_1$2 = transportErrors;
6842
6889
  const window_1 = requireWindow();
6843
6890
  const events_1$6 = eventsExports;
@@ -7152,7 +7199,6 @@ class System extends base_1$j.EmitterBase {
7152
7199
  * ```js
7153
7200
  * fin.System.getUniqueUserId().then(id => console.log(id)).catch(err => console.log(err));
7154
7201
  * ```
7155
- * @static
7156
7202
  */
7157
7203
  getUniqueUserId() {
7158
7204
  return this.wire.sendAction('get-unique-user-id').then(({ payload }) => payload.data);
@@ -7843,7 +7889,8 @@ class System extends base_1$j.EmitterBase {
7843
7889
  }
7844
7890
  /**
7845
7891
  * Attempt to close an external process. The process will be terminated if it
7846
- * has not closed after the elapsed timeout in milliseconds.<br>
7892
+ * has not closed after the elapsed timeout in milliseconds.
7893
+ *
7847
7894
  * Note: This method is restricted by default and must be enabled via
7848
7895
  * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
7849
7896
  * @param options A object defined in the TerminateExternalRequestType interface
@@ -7879,7 +7926,8 @@ class System extends base_1$j.EmitterBase {
7879
7926
  return this.wire.sendAction('update-proxy', options).then(() => undefined);
7880
7927
  }
7881
7928
  /**
7882
- * Downloads the given application asset<br>
7929
+ * Downloads the given application asset.
7930
+ *
7883
7931
  * Note: This method is restricted by default and must be enabled via
7884
7932
  * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
7885
7933
  * @param appAsset App asset object
@@ -8423,7 +8471,6 @@ class System extends base_1$j.EmitterBase {
8423
8471
  * }
8424
8472
  * });
8425
8473
  * ```
8426
- * @static
8427
8474
  */
8428
8475
  async launchManifest(manifestUrl, opts = {}) {
8429
8476
  const { subscribe, ..._sendOpts } = opts;
@@ -8683,7 +8730,7 @@ class System extends base_1$j.EmitterBase {
8683
8730
  await this.wire.sendAction('set-domain-settings', { domainSettings, ...this.identity });
8684
8731
  }
8685
8732
  }
8686
- system.default = System;
8733
+ system$1.System = System;
8687
8734
 
8688
8735
  var interappbus = {};
8689
8736
 
@@ -9094,6 +9141,7 @@ var __classPrivateFieldSet$b = (commonjsGlobal && commonjsGlobal.__classPrivateF
9094
9141
  };
9095
9142
  var _ChannelClient_protectedObj, _ChannelClient_strategy, _ChannelClient_close;
9096
9143
  Object.defineProperty(client, "__esModule", { value: true });
9144
+ client.ChannelClient = void 0;
9097
9145
  const channel_1$1 = channel;
9098
9146
  const channelClientsByEndpointId = new Map();
9099
9147
  /**
@@ -9102,17 +9150,17 @@ const channelClientsByEndpointId = new Map();
9102
9150
  * provider via {@link ChannelClient#dispatch dispatch} and to listen for communication
9103
9151
  * from the provider by registering an action via {@link ChannelClient#register register}.
9104
9152
  *
9105
- * Synchronous Methods:
9153
+ * ### Synchronous Methods:
9106
9154
  * * {@link ChannelClient#onDisconnection onDisconnection(listener)}
9107
9155
  * * {@link ChannelClient#register register(action, listener)}
9108
9156
  * * {@link ChannelClient#remove remove(action)}
9109
9157
  *
9110
- * Asynchronous Methods:
9158
+ * ### Asynchronous Methods:
9111
9159
  * * {@link ChannelClient#disconnect disconnect()}
9112
9160
  * * {@link ChannelClient#dispatch dispatch(action, payload)}
9113
9161
  *
9114
- * Middleware:
9115
- * <br>Middleware functions receive the following arguments: (action, payload, senderId).
9162
+ * ### Middleware:
9163
+ * Middleware functions receive the following arguments: (action, payload, senderId).
9116
9164
  * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
9117
9165
  * unless it is undefined, in which case the original payload is used. Middleware can be used for side effects.
9118
9166
  * * {@link ChannelClient#setDefaultAction setDefaultAction(middleware)}
@@ -9259,7 +9307,7 @@ class ChannelClient extends channel_1$1.ChannelBase {
9259
9307
  });
9260
9308
  }
9261
9309
  }
9262
- client.default = ChannelClient;
9310
+ client.ChannelClient = ChannelClient;
9263
9311
  _ChannelClient_protectedObj = new WeakMap(), _ChannelClient_strategy = new WeakMap(), _ChannelClient_close = new WeakMap();
9264
9312
 
9265
9313
  var connectionManager = {};
@@ -9624,7 +9672,7 @@ var iceManager = {};
9624
9672
 
9625
9673
  Object.defineProperty(iceManager, "__esModule", { value: true });
9626
9674
  iceManager.RTCICEManager = void 0;
9627
- const base_1$i = base;
9675
+ const base_1$i = base$1;
9628
9676
  /*
9629
9677
  Singleton that facilitates Offer and Answer exchange required for establishing RTC connections.
9630
9678
  */
@@ -9802,20 +9850,20 @@ const runtimeVersioning_1 = runtimeVersioning;
9802
9850
  * a single client via {@link ChannelProvider#dispatch dispatch} or all clients via {@link ChannelProvider#publish publish}
9803
9851
  * and to listen for communication from clients by registering an action via {@link ChannelProvider#register register}.
9804
9852
  *
9805
- * Synchronous Methods:
9853
+ * ### Synchronous Methods:
9806
9854
  * * {@link ChannelProvider#onConnection onConnection(listener)}
9807
9855
  * * {@link ChannelProvider#onDisconnection onDisconnection(listener)}
9808
9856
  * * {@link ChannelProvider#publish publish(action, payload)}
9809
9857
  * * {@link ChannelProvider#register register(action, listener)}
9810
9858
  * * {@link ChannelProvider#remove remove(action)}
9811
9859
  *
9812
- * Asynchronous Methods:
9860
+ * ### Asynchronous Methods:
9813
9861
  * * {@link ChannelProvider#destroy destroy()}
9814
9862
  * * {@link ChannelProvider#dispatch dispatch(to, action, payload)}
9815
9863
  * * {@link ChannelProvider#getAllClientInfo getAllClientInfo()}
9816
9864
  *
9817
- * Middleware:
9818
- * <br>Middleware functions receive the following arguments: (action, payload, senderId).
9865
+ * ### Middleware:
9866
+ * Middleware functions receive the following arguments: (action, payload, senderId).
9819
9867
  * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
9820
9868
  * unless it is undefined, in which case the most recently defined payload is used. Middleware can be used for side effects.
9821
9869
  * * {@link ChannelProvider#setDefaultAction setDefaultAction(middleware)}
@@ -10124,7 +10172,7 @@ var messageReceiver = {};
10124
10172
  Object.defineProperty(messageReceiver, "__esModule", { value: true });
10125
10173
  messageReceiver.MessageReceiver = void 0;
10126
10174
  const client_1$1 = client;
10127
- const base_1$h = base;
10175
+ const base_1$h = base$1;
10128
10176
  /*
10129
10177
  This is a singleton (per fin object) tasked with routing messages coming off the ipc to the correct endpoint.
10130
10178
  It needs to be a singleton because there can only be one per wire. It tracks both clients and providers' processAction passed in via the strategy.
@@ -10184,7 +10232,7 @@ class MessageReceiver extends base_1$h.Base {
10184
10232
  const endpointIdFromPreviousConnection = this.latestEndpointIdByChannelId.get(channelId);
10185
10233
  if (endpointIdFromPreviousConnection) {
10186
10234
  // Not convinced by this way of doing things, but pushing up for now.
10187
- client_1$1.default.closeChannelByEndpointId(endpointIdFromPreviousConnection);
10235
+ client_1$1.ChannelClient.closeChannelByEndpointId(endpointIdFromPreviousConnection);
10188
10236
  // eslint-disable-next-line no-console
10189
10237
  console.warn('You have created a second connection to an older provider. First connection has been removed from the clientMap');
10190
10238
  // eslint-disable-next-line no-console
@@ -10314,7 +10362,7 @@ var _ConnectionManager_messageReceiver, _ConnectionManager_rtcConnectionManager;
10314
10362
  Object.defineProperty(connectionManager, "__esModule", { value: true });
10315
10363
  connectionManager.ConnectionManager = void 0;
10316
10364
  const exhaustive_1 = exhaustive;
10317
- const base_1$g = base;
10365
+ const base_1$g = base$1;
10318
10366
  const strategy_1 = strategy$2;
10319
10367
  const strategy_2 = strategy$1;
10320
10368
  const ice_manager_1 = iceManager;
@@ -10545,6 +10593,15 @@ class ConnectionManager extends base_1$g.Base {
10545
10593
  connectionManager.ConnectionManager = ConnectionManager;
10546
10594
  _ConnectionManager_messageReceiver = new WeakMap(), _ConnectionManager_rtcConnectionManager = new WeakMap();
10547
10595
 
10596
+ /**
10597
+ * Entry points for the `Channel` subset of the `InterApplicationBus` API (`fin.InterApplicationBus.Channel`).
10598
+ *
10599
+ * * {@link Channel} contains static members of the `Channel` API, accessible through `fin.InterApplicationBus.Channel`.
10600
+ * * {@link OpenFin.ChannelClient} describes a client of a channel, e.g. as returned by `fin.InterApplicationBus.Channel.connect`.
10601
+ * * {@link OpenFin.ChannelProvider} describes a provider of a channel, e.g. as returned by `fin.InterApplicationBus.Channel.create`.
10602
+ *
10603
+ * @packageDocumentation
10604
+ */
10548
10605
  var __classPrivateFieldSet$5 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
10549
10606
  if (kind === "m") throw new TypeError("Private method is not writable");
10550
10607
  if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
@@ -10562,7 +10619,7 @@ channel$1.Channel = void 0;
10562
10619
  /* eslint-disable no-console */
10563
10620
  const events_1$5 = eventsExports;
10564
10621
  const lazy_1$1 = lazy;
10565
- const base_1$f = base;
10622
+ const base_1$f = base$1;
10566
10623
  const client_1 = client;
10567
10624
  const connection_manager_1 = connectionManager;
10568
10625
  const provider_1 = provider;
@@ -10605,7 +10662,7 @@ class Channel extends base_1$f.EmitterBase {
10605
10662
  _Channel_readyToConnect.set(this, new lazy_1$1.AsyncRetryableLazy(async () => {
10606
10663
  await Promise.all([
10607
10664
  this.on('disconnected', (eventPayload) => {
10608
- client_1.default.handleProviderDisconnect(eventPayload);
10665
+ client_1.ChannelClient.handleProviderDisconnect(eventPayload);
10609
10666
  }),
10610
10667
  this.on('connected', (...args) => {
10611
10668
  __classPrivateFieldGet$7(this, _Channel_internalEmitter, "f").emit('connected', ...args);
@@ -10796,7 +10853,7 @@ class Channel extends base_1$f.EmitterBase {
10796
10853
  };
10797
10854
  const routingInfo = await this.safeConnect(channelName, opts.wait, connectPayload);
10798
10855
  const strategy = await __classPrivateFieldGet$7(this, _Channel_connectionManager, "f").createClientStrategy(rtcPacket, routingInfo);
10799
- const channel = new client_1.default(routingInfo, this.wire, strategy);
10856
+ const channel = new client_1.ChannelClient(routingInfo, this.wire, strategy);
10800
10857
  // It is the client's responsibility to handle endpoint disconnection to the provider.
10801
10858
  // If the endpoint dies, the client will force a disconnection through the core.
10802
10859
  // The provider does not care about endpoint disconnection.
@@ -10808,7 +10865,7 @@ class Channel extends base_1$f.EmitterBase {
10808
10865
  console.warn(`Something went wrong during disconnect for client with uuid: ${routingInfo.uuid} / name: ${routingInfo.name} / endpointId: ${routingInfo.endpointId}.`);
10809
10866
  }
10810
10867
  finally {
10811
- client_1.default.handleProviderDisconnect(routingInfo);
10868
+ client_1.ChannelClient.handleProviderDisconnect(routingInfo);
10812
10869
  }
10813
10870
  });
10814
10871
  return channel;
@@ -10879,9 +10936,16 @@ channel$1.Channel = Channel;
10879
10936
  _Channel_connectionManager = new WeakMap(), _Channel_internalEmitter = new WeakMap(), _Channel_readyToConnect = new WeakMap();
10880
10937
 
10881
10938
  Object.defineProperty(interappbus, "__esModule", { value: true });
10882
- interappbus.InterAppPayload = void 0;
10939
+ interappbus.InterAppPayload = interappbus.InterApplicationBus = void 0;
10940
+ /**
10941
+ * Entry point for the OpenFin `InterApplicationBus` API (`fin.InterApplicationBus`).
10942
+ *
10943
+ * * {@link InterApplicationBus} contains static members of the `InterApplicationBus` API, accessible through `fin.InterApplicationBus`.
10944
+ *
10945
+ * @packageDocumentation
10946
+ */
10883
10947
  const events_1$4 = eventsExports;
10884
- const base_1$e = base;
10948
+ const base_1$e = base$1;
10885
10949
  const ref_counter_1 = refCounter;
10886
10950
  const index_1$2 = channel$1;
10887
10951
  const validate_1$3 = validate;
@@ -11071,7 +11135,7 @@ class InterApplicationBus extends base_1$e.Base {
11071
11135
  return true;
11072
11136
  }
11073
11137
  }
11074
- interappbus.default = InterApplicationBus;
11138
+ interappbus.InterApplicationBus = InterApplicationBus;
11075
11139
  /**
11076
11140
  * @internal
11077
11141
  */
@@ -11088,8 +11152,16 @@ function createKey(...toHash) {
11088
11152
 
11089
11153
  var clipboard = {};
11090
11154
 
11155
+ /**
11156
+ * Entry point for the OpenFin `Clipboard` API (`fin.Clipboard`).
11157
+ *
11158
+ * * {@link Clipboard} contains static members of the `Clipboard` API, accessible through `fin.Clipboard`.
11159
+ *
11160
+ * @packageDocumentation
11161
+ */
11091
11162
  Object.defineProperty(clipboard, "__esModule", { value: true });
11092
- const base_1$d = base;
11163
+ clipboard.Clipboard = void 0;
11164
+ const base_1$d = base$1;
11093
11165
  /**
11094
11166
  * @PORTED
11095
11167
  * WriteRequestType interface
@@ -11286,9 +11358,9 @@ class Clipboard extends base_1$d.Base {
11286
11358
  return payload.data;
11287
11359
  }
11288
11360
  }
11289
- clipboard.default = Clipboard;
11361
+ clipboard.Clipboard = Clipboard;
11290
11362
 
11291
- var externalApplication = {};
11363
+ var externalApplication$1 = {};
11292
11364
 
11293
11365
  var Factory$5 = {};
11294
11366
 
@@ -11297,11 +11369,11 @@ var Instance$4 = {};
11297
11369
  Object.defineProperty(Instance$4, "__esModule", { value: true });
11298
11370
  Instance$4.ExternalApplication = void 0;
11299
11371
  /* eslint-disable import/prefer-default-export */
11300
- const base_1$c = base;
11372
+ const base_1$c = base$1;
11301
11373
  /**
11302
11374
  * An ExternalApplication object representing native language adapter connections to the runtime. Allows
11303
11375
  * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
11304
- * Discovery of connections is provided by <a href="tutorial-System.getAllExternalApplications.html">getAllExternalApplications.</a>
11376
+ * Discovery of connections is provided by {@link System.System.getAllExternalApplications getAllExternalApplications}.</a>
11305
11377
  *
11306
11378
  * Processes that can be wrapped as `ExternalApplication`s include the following:
11307
11379
  * - Processes which have connected to an OpenFin runtime via an adapter
@@ -11412,8 +11484,12 @@ class ExternalApplication extends base_1$c.EmitterBase {
11412
11484
  Instance$4.ExternalApplication = ExternalApplication;
11413
11485
 
11414
11486
  Object.defineProperty(Factory$5, "__esModule", { value: true });
11415
- const base_1$b = base;
11487
+ Factory$5.ExternalApplicationModule = void 0;
11488
+ const base_1$b = base$1;
11416
11489
  const Instance_1$4 = Instance$4;
11490
+ /**
11491
+ * Static namespace for OpenFin API methods that interact with the {@link ExternalApplication} class, available under `fin.ExternalApplication`.
11492
+ */
11417
11493
  class ExternalApplicationModule extends base_1$b.Base {
11418
11494
  /**
11419
11495
  * Asynchronously returns an External Application object that represents an external application.
@@ -11427,7 +11503,6 @@ class ExternalApplicationModule extends base_1$b.Base {
11427
11503
  * .then(extApp => console.log('wrapped external application'))
11428
11504
  * .catch(err => console.log(err));
11429
11505
  * ```
11430
- * @static
11431
11506
  */
11432
11507
  wrap(uuid) {
11433
11508
  this.wire.sendAction('external-application-wrap').catch((e) => {
@@ -11447,7 +11522,6 @@ class ExternalApplicationModule extends base_1$b.Base {
11447
11522
  * const info = await extApp.getInfo();
11448
11523
  * console.log(info);
11449
11524
  * ```
11450
- * @static
11451
11525
  */
11452
11526
  wrapSync(uuid) {
11453
11527
  this.wire.sendAction('external-application-wrap-sync').catch((e) => {
@@ -11456,18 +11530,9 @@ class ExternalApplicationModule extends base_1$b.Base {
11456
11530
  return new Instance_1$4.ExternalApplication(this.wire, { uuid });
11457
11531
  }
11458
11532
  }
11459
- Factory$5.default = ExternalApplicationModule;
11533
+ Factory$5.ExternalApplicationModule = ExternalApplicationModule;
11460
11534
 
11461
11535
  (function (exports) {
11462
- /**
11463
- * Entry point for the OpenFin ExternalApplication namespace.
11464
- *
11465
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "ExternalApplicationModule" is used for
11466
- * the module containing static members of the `ExternalApplication` namespace (available under `fin.ExternalApplication`), while `ExternalApplication`
11467
- * documents instances of the OpenFin `ExternalApplication` class.
11468
- *
11469
- * @packageDocumentation
11470
- */
11471
11536
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
11472
11537
  if (k2 === undefined) k2 = k;
11473
11538
  var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -11483,12 +11548,22 @@ Factory$5.default = ExternalApplicationModule;
11483
11548
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
11484
11549
  };
11485
11550
  Object.defineProperty(exports, "__esModule", { value: true });
11486
- const Factory_1 = Factory$5;
11487
- exports.default = Factory_1.default;
11551
+ /**
11552
+ * Entry points for the OpenFin `ExternalApplication` API (`fin.ExternalApplication`).
11553
+ *
11554
+ * * {@link ExternalApplicationModule} contains static members of the `ExternalApplication` type, accessible through `fin.ExternalApplication`.
11555
+ * * {@link ExternalApplication} describes an instance of an OpenFin ExternalApplication, e.g. as returned by `fin.ExternalApplication.getCurrent`.
11556
+ *
11557
+ * 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),
11558
+ * both of these were documented on the same page.
11559
+ *
11560
+ * @packageDocumentation
11561
+ */
11562
+ __exportStar(Factory$5, exports);
11488
11563
  __exportStar(Instance$4, exports);
11489
- } (externalApplication));
11564
+ } (externalApplication$1));
11490
11565
 
11491
- var frame = {};
11566
+ var frame$1 = {};
11492
11567
 
11493
11568
  var Factory$4 = {};
11494
11569
 
@@ -11497,7 +11572,7 @@ var Instance$3 = {};
11497
11572
  Object.defineProperty(Instance$3, "__esModule", { value: true });
11498
11573
  Instance$3._Frame = void 0;
11499
11574
  /* eslint-disable import/prefer-default-export */
11500
- const base_1$a = base;
11575
+ const base_1$a = base$1;
11501
11576
  /**
11502
11577
  * An iframe represents an embedded HTML page within a parent HTML page. Because this embedded page
11503
11578
  * has its own DOM and global JS context (which may or may not be linked to that of the parent depending
@@ -11638,9 +11713,13 @@ class _Frame extends base_1$a.EmitterBase {
11638
11713
  Instance$3._Frame = _Frame;
11639
11714
 
11640
11715
  Object.defineProperty(Factory$4, "__esModule", { value: true });
11641
- const base_1$9 = base;
11716
+ Factory$4._FrameModule = void 0;
11717
+ const base_1$9 = base$1;
11642
11718
  const validate_1$2 = validate;
11643
11719
  const Instance_1$3 = Instance$3;
11720
+ /**
11721
+ * Static namespace for OpenFin API methods that interact with the {@link _Frame} class, available under `fin.Frame`.
11722
+ */
11644
11723
  class _FrameModule extends base_1$9.Base {
11645
11724
  /**
11646
11725
  * Asynchronously returns a reference to the specified frame. The frame does not have to exist
@@ -11652,7 +11731,6 @@ class _FrameModule extends base_1$9.Base {
11652
11731
  * .then(frm => console.log('wrapped frame'))
11653
11732
  * .catch(err => console.log(err));
11654
11733
  * ```
11655
- * @static
11656
11734
  */
11657
11735
  async wrap(identity) {
11658
11736
  this.wire.sendAction('frame-wrap').catch((e) => {
@@ -11674,7 +11752,6 @@ class _FrameModule extends base_1$9.Base {
11674
11752
  * const info = await frm.getInfo();
11675
11753
  * console.log(info);
11676
11754
  * ```
11677
- * @static
11678
11755
  */
11679
11756
  wrapSync(identity) {
11680
11757
  this.wire.sendAction('frame-wrap-sync').catch((e) => {
@@ -11695,7 +11772,6 @@ class _FrameModule extends base_1$9.Base {
11695
11772
  * .then(frm => console.log('current frame'))
11696
11773
  * .catch(err => console.log(err));
11697
11774
  * ```
11698
- * @static
11699
11775
  */
11700
11776
  getCurrent() {
11701
11777
  this.wire.sendAction('frame-get-current').catch((e) => {
@@ -11712,7 +11788,6 @@ class _FrameModule extends base_1$9.Base {
11712
11788
  * const info = await frm.getInfo();
11713
11789
  * console.log(info);
11714
11790
  * ```
11715
- * @static
11716
11791
  */
11717
11792
  getCurrentSync() {
11718
11793
  this.wire.sendAction('frame-get-current-sync').catch((e) => {
@@ -11721,17 +11796,19 @@ class _FrameModule extends base_1$9.Base {
11721
11796
  return new Instance_1$3._Frame(this.wire, this.wire.environment.getCurrentEntityIdentity());
11722
11797
  }
11723
11798
  }
11724
- Factory$4.default = _FrameModule;
11799
+ Factory$4._FrameModule = _FrameModule;
11725
11800
 
11726
11801
  (function (exports) {
11727
11802
  /**
11728
- * Entry point for the OpenFin Frame namespace.
11803
+ * Entry points for the OpenFin `Frame` API (`fin.Frame`).
11804
+ *
11805
+ * * {@link _FrameModule} contains static members of the `Frame` API, accessible through `fin.Frame`.
11806
+ * * {@link _Frame} describes an instance of an OpenFin Frame, e.g. as returned by `fin.Frame.getCurrent`.
11729
11807
  *
11730
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "FrameModule" is used for
11731
- * the module containing static members of the `Frame` namespace (available under `fin.Frame`), while `Frame` documents
11732
- * instances of the OpenFin `Frame` class.
11808
+ * 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),
11809
+ * both of these were documented on the same page.
11733
11810
  *
11734
- * Because the `Frame` name aliases a DOM entity, the documentation pipeline prefixes the name with an underscore.
11811
+ * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
11735
11812
  *
11736
11813
  * @packageDocumentation
11737
11814
  */
@@ -11750,15 +11827,15 @@ Factory$4.default = _FrameModule;
11750
11827
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
11751
11828
  };
11752
11829
  Object.defineProperty(exports, "__esModule", { value: true });
11753
- const Factory_1 = Factory$4;
11754
- exports.default = Factory_1.default;
11830
+ __exportStar(Factory$4, exports);
11755
11831
  __exportStar(Instance$3, exports);
11756
- } (frame));
11832
+ } (frame$1));
11757
11833
 
11758
- var globalHotkey = {};
11834
+ var globalHotkey$1 = {};
11759
11835
 
11760
- Object.defineProperty(globalHotkey, "__esModule", { value: true });
11761
- const base_1$8 = base;
11836
+ Object.defineProperty(globalHotkey$1, "__esModule", { value: true });
11837
+ globalHotkey$1.GlobalHotkey = void 0;
11838
+ const base_1$8 = base$1;
11762
11839
  /**
11763
11840
  * The GlobalHotkey module can register/unregister a global hotkeys.
11764
11841
  *
@@ -11887,9 +11964,9 @@ class GlobalHotkey extends base_1$8.EmitterBase {
11887
11964
  return data;
11888
11965
  }
11889
11966
  }
11890
- globalHotkey.default = GlobalHotkey;
11967
+ globalHotkey$1.GlobalHotkey = GlobalHotkey;
11891
11968
 
11892
- var platform = {};
11969
+ var platform$1 = {};
11893
11970
 
11894
11971
  var Factory$3 = {};
11895
11972
 
@@ -11904,16 +11981,14 @@ var _Platform_connectToProvider;
11904
11981
  Object.defineProperty(Instance$2, "__esModule", { value: true });
11905
11982
  Instance$2.Platform = void 0;
11906
11983
  /* eslint-disable import/prefer-default-export, no-undef */
11907
- const base_1$7 = base;
11984
+ const base_1$7 = base$1;
11908
11985
  const validate_1$1 = validate;
11909
11986
  // Reuse clients to avoid overwriting already-registered client in provider
11910
11987
  const clientMap = new Map();
11911
11988
  /** Manages the life cycle of windows and views in the application.
11912
11989
  *
11913
- * Enables taking snapshots of itself and applyi
11914
- * ng them to restore a previous configuration
11990
+ * Enables taking snapshots of itself and applying them to restore a previous configuration
11915
11991
  * as well as listen to {@link OpenFin.PlatformEvents platform events}.
11916
- *
11917
11992
  */
11918
11993
  class Platform extends base_1$7.EmitterBase {
11919
11994
  /**
@@ -12272,12 +12347,11 @@ class Platform extends base_1$7.EmitterBase {
12272
12347
  });
12273
12348
  }
12274
12349
  /**
12275
- * ***DEPRECATED - please use Platform.createView.***
12350
+ * ***DEPRECATED - please use {@link Platform.createView Platform.createView}.***
12276
12351
  * Reparents a specified view in a new target window.
12277
12352
  * @param viewIdentity View identity
12278
12353
  * @param target new owner window identity
12279
12354
  *
12280
- * @tutorial Platform.createView
12281
12355
  */
12282
12356
  async reparentView(viewIdentity, target) {
12283
12357
  var _a;
@@ -12767,10 +12841,142 @@ Object.defineProperty(Instance$1, "__esModule", { value: true });
12767
12841
  Instance$1.Layout = void 0;
12768
12842
  const lazy_1 = lazy;
12769
12843
  const validate_1 = validate;
12770
- const base_1$6 = base;
12844
+ const base_1$6 = base$1;
12771
12845
  const common_utils_1 = commonUtils;
12772
12846
  const layout_entities_1 = layoutEntities;
12773
12847
  const layout_constants_1 = layout_constants;
12848
+ /**
12849
+ *
12850
+ * Layouts give app providers the ability to embed multiple views in a single window. The Layout namespace
12851
+ * enables the initialization and manipulation of a window's Layout. A Layout will
12852
+ * emit events locally on the DOM element representing the layout-container.
12853
+ *
12854
+ *
12855
+ * ### Layout.DOMEvents
12856
+ *
12857
+ * When a Layout is created, it emits events onto the DOM element representing the Layout container.
12858
+ * This Layout container is the DOM element referenced by containerId in {@link Layout.LayoutModule#init Layout.init}.
12859
+ * You can use the built-in event emitter to listen to these events using [addEventListener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener).
12860
+ * The events are emitted synchronously and only in the process where the Layout exists.
12861
+ * Any values returned by the called listeners are ignored and will be discarded.
12862
+ * If the target DOM element is destroyed, any events that have been set up on that element will be destroyed.
12863
+ *
12864
+ * @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
12865
+ *
12866
+ * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
12867
+ * Adds a listener to the end of the listeners array for the specified event.
12868
+ * @example
12869
+ * ```js
12870
+ * const myLayoutContainer = document.getElementById('layout-container');
12871
+ *
12872
+ * myLayoutContainer.addEventListener('tab-created', function(event) {
12873
+ * const { tabSelector } = event.detail;
12874
+ * const tabElement = document.getElementById(tabSelector);
12875
+ * const existingColor = tabElement.style.backgroundColor;
12876
+ * tabElement.style.backgroundColor = "red";
12877
+ * setTimeout(() => {
12878
+ * tabElement.style.backgroundColor = existingColor;
12879
+ * }, 2000);
12880
+ * });
12881
+ * ```
12882
+ *
12883
+ * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
12884
+ * Adds a listener to the end of the listeners array for the specified event.
12885
+ * @example
12886
+ * ```js
12887
+ * const myLayoutContainer = document.getElementById('layout-container');
12888
+ *
12889
+ * const listener = function(event) {
12890
+ * console.log(event.detail);
12891
+ * console.log('container-created event fired once, removing listener');
12892
+ * myLayoutContainer.removeEventListener('container-created', listener);
12893
+ * };
12894
+ *
12895
+ * myLayoutContainer.addEventListener('container-created', listener);
12896
+ * ```
12897
+ *
12898
+ * ### Supported event types are:
12899
+ *
12900
+ * * tab-created
12901
+ * * container-created
12902
+ * * layout-state-changed
12903
+ * * tab-closed
12904
+ * * tab-dropped
12905
+ *
12906
+ * ### Layout DOM Node Events
12907
+ *
12908
+ * #### tab-created
12909
+ * Generated when a tab is created. As a user drags and drops tabs within window, new tabs are created. A single view may have multiple tabs created and destroyed during its lifetime attached to a single window.
12910
+ * ```js
12911
+ * // The response has the following shape in event.detail:
12912
+ * {
12913
+ * containerSelector: "container-component_A",
12914
+ * name: "component_A",
12915
+ * tabSelector: "tab-component_A",
12916
+ * topic: "openfin-DOM-event",
12917
+ * type: "tab-created",
12918
+ * uuid: "OpenFin POC"
12919
+ * }
12920
+ * ```
12921
+ *
12922
+ * #### container-created
12923
+ * Generated when a container is created. A single view will have only one container during its lifetime attached to a single window and the container's lifecycle is tied to the view. To discover when the container is destroyed, please listen to view-detached event.
12924
+ * ```js
12925
+ * // The response has the following shape in event.detail:
12926
+ * {
12927
+ * containerSelector: "container-component_A",
12928
+ * name: "component_A",
12929
+ * tabSelector: "tab-component_A",
12930
+ * topic: "openfin-DOM-event",
12931
+ * type: "container-created",
12932
+ * uuid: "OpenFin POC"
12933
+ * }
12934
+ * ```
12935
+ *
12936
+ * ### layout-state-changed
12937
+ * Generated when the state of the layout changes in any way, such as a view added/removed/replaced. Note that this event can fire frequently as the underlying layout can change multiple components from all kinds of changes (resizing for example). Given this, it is recommended to debounce this event and then you can use the {@link Layout#getConfig Layout.getConfig} API to retrieve the most up-to-date state.
12938
+ * ```js
12939
+ * // The response has the following shape in event.detail
12940
+ * {
12941
+ * containerSelector: "container-component_A",
12942
+ * name: "component_A",
12943
+ * tabSelector: "tab-component_A",
12944
+ * topic: "openfin-DOM-event",
12945
+ * type: "layout-state-changed",
12946
+ * uuid: "OpenFin POC"
12947
+ * }
12948
+ * ```
12949
+ *
12950
+ * #### tab-closed
12951
+ * Generated when a tab is closed.
12952
+ * ```js
12953
+ * // The response has the following shape in event.detail:
12954
+ * {
12955
+ * containerSelector: "container-component_A",
12956
+ * name: "component_A",
12957
+ * tabSelector: "tab-component_A",
12958
+ * topic: "openfin-DOM-event",
12959
+ * type: "tab-closed",
12960
+ * uuid: "OpenFin POC",
12961
+ * url: "http://openfin.co" // The url of the view that was closed.
12962
+ * }
12963
+ * ```
12964
+ *
12965
+ * #### tab-dropped
12966
+ * Generated when a tab is dropped.
12967
+ * ```js
12968
+ * // The response has the following shape in event.detail:
12969
+ * {
12970
+ * containerSelector: "container-component_A",
12971
+ * name: "component_A",
12972
+ * tabSelector: "tab-component_A",
12973
+ * topic: "openfin-DOM-event",
12974
+ * type: "tab-dropped",
12975
+ * uuid: "OpenFin POC",
12976
+ * url: "http://openfin.co" // The url of the view linked to the dropped tab.
12977
+ * }
12978
+ * ```
12979
+ */
12774
12980
  class Layout extends base_1$6.Base {
12775
12981
  /**
12776
12982
  * @internal
@@ -12996,22 +13202,52 @@ var _LayoutModule_layoutInitializationAttempted;
12996
13202
  Object.defineProperty(Factory$2, "__esModule", { value: true });
12997
13203
  Factory$2.LayoutModule = void 0;
12998
13204
  /* eslint-disable no-undef, import/prefer-default-export */
12999
- const base_1$5 = base;
13205
+ const base_1$5 = base$1;
13000
13206
  const Instance_1$2 = Instance$1;
13207
+ /**
13208
+ * Static namespace for OpenFin API methods that interact with the {@link Layout} class, available under `fin.Platform.Layout`.
13209
+ */
13001
13210
  class LayoutModule extends base_1$5.Base {
13002
13211
  constructor() {
13003
13212
  super(...arguments);
13004
13213
  _LayoutModule_layoutInitializationAttempted.set(this, false);
13005
13214
  /**
13006
- * Initialize the window's Layout. Must be called from a custom window that has a 'layout' option set upon creation of that window.
13215
+ * Initialize the window's Layout.
13216
+ *
13217
+ * @remarks Must be called from a custom window that has a 'layout' option set upon creation of that window.
13007
13218
  * If a containerId is not provided, this method attempts to find an element with the id `layout-container`.
13008
- * A Layout will <a href="tutorial-Layout.DOMEvents.html">emit events locally</a> on the DOM element representing the layout-container.
13219
+ * A Layout will emit events locally on the DOM element representing the layout-container.
13009
13220
  * In order to capture the relevant events during Layout initiation, set up the listeners on the DOM element prior to calling `init`.
13010
13221
  * @param options - Layout init options.
13011
13222
  *
13012
- * @static
13013
13223
  * @experimental
13014
- * @tutorial Layout.init
13224
+ *
13225
+ * @example
13226
+ * ```js
13227
+ * // If no options are included, the layout in the window options is initialized in an element with the id `layout-container`
13228
+ * const layout = await fin.Platform.Layout.init();
13229
+ * ```
13230
+ * <br>
13231
+ *
13232
+ * ```js
13233
+ * const containerId = 'my-custom-container-id';
13234
+ *
13235
+ * const myLayoutContainer = document.getElementById(containerId);
13236
+ *
13237
+ * myLayoutContainer.addEventListener('tab-created', function(event) {
13238
+ * const { tabSelector } = event.detail;
13239
+ * const tabElement = document.getElementById(tabSelector);
13240
+ * const existingColor = tabElement.style.backgroundColor;
13241
+ * tabElement.style.backgroundColor = "red";
13242
+ * setTimeout(() => {
13243
+ * tabElement.style.backgroundColor = existingColor;
13244
+ * }, 2000);
13245
+ * });
13246
+ *
13247
+ * // initialize the layout into an existing HTML element with the div `my-custom-container-id`
13248
+ * // the window must have been created with a layout in its window options
13249
+ * const layout = await fin.Platform.Layout.init({ containerId });
13250
+ * ```
13015
13251
  */
13016
13252
  this.init = async (options = {}) => {
13017
13253
  this.wire.sendAction('layout-init').catch((e) => {
@@ -13029,7 +13265,6 @@ class LayoutModule extends base_1$5.Base {
13029
13265
  }
13030
13266
  /**
13031
13267
  * Asynchronously returns a Layout object that represents a Window's layout.
13032
- * @param identity
13033
13268
  *
13034
13269
  * @example
13035
13270
  * ```js
@@ -13046,9 +13281,7 @@ class LayoutModule extends base_1$5.Base {
13046
13281
  * // Use wrapped instance to control layout, e.g.:
13047
13282
  * const layoutConfig = await layout.getConfig();
13048
13283
  * ```
13049
- * @static
13050
13284
  */
13051
- // eslint-disable-next-line class-methods-use-this
13052
13285
  async wrap(identity) {
13053
13286
  this.wire.sendAction('layout-wrap').catch((e) => {
13054
13287
  // don't expose
@@ -13057,7 +13290,6 @@ class LayoutModule extends base_1$5.Base {
13057
13290
  }
13058
13291
  /**
13059
13292
  * Synchronously returns a Layout object that represents a Window's layout.
13060
- * @param identity
13061
13293
  *
13062
13294
  * @example
13063
13295
  * ```js
@@ -13074,9 +13306,7 @@ class LayoutModule extends base_1$5.Base {
13074
13306
  * // Use wrapped instance to control layout, e.g.:
13075
13307
  * const layoutConfig = await layout.getConfig();
13076
13308
  * ```
13077
- * @static
13078
13309
  */
13079
- // eslint-disable-next-line class-methods-use-this
13080
13310
  wrapSync(identity) {
13081
13311
  this.wire.sendAction('layout-wrap-sync').catch((e) => {
13082
13312
  // don't expose
@@ -13092,7 +13322,6 @@ class LayoutModule extends base_1$5.Base {
13092
13322
  * // Use wrapped instance to control layout, e.g.:
13093
13323
  * const layoutConfig = await layout.getConfig();
13094
13324
  * ```
13095
- * @static
13096
13325
  */
13097
13326
  async getCurrent() {
13098
13327
  this.wire.sendAction('layout-get-current').catch((e) => {
@@ -13116,7 +13345,6 @@ class LayoutModule extends base_1$5.Base {
13116
13345
  * // Use wrapped instance to control layout, e.g.:
13117
13346
  * const layoutConfig = await layout.getConfig();
13118
13347
  * ```
13119
- * @static
13120
13348
  */
13121
13349
  getCurrentSync() {
13122
13350
  this.wire.sendAction('layout-get-current-sync').catch((e) => {
@@ -13134,13 +13362,16 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap();
13134
13362
 
13135
13363
  (function (exports) {
13136
13364
  /**
13137
- * Entry point for the OpenFin Layout namespace.
13365
+ * Entry point for the OpenFin `Layout` subset of the `Platform` API (`fin.Platform.Layout`).
13366
+ *
13367
+ * * {@link LayoutModule} contains static members of the `Layout` API, accessible through `fin.Platform.Layout`.
13368
+ * * {@link Layout} describes an instance of an OpenFin Layout, e.g. as returned by `fin.Platform.Layout.getCurrent`.
13138
13369
  *
13139
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "LayoutModule" is used for
13140
- * the module containing static members of the `Layout` namespace (available under `fin.Platform.Layout`), while `Layout` documents
13141
- * instances of the OpenFin `Layout` class.
13370
+ * 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),
13371
+ * both of these were documented on the same page.
13142
13372
  *
13143
13373
  * @packageDocumentation
13374
+ *
13144
13375
  */
13145
13376
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
13146
13377
  if (k2 === undefined) k2 = k;
@@ -13162,9 +13393,13 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap();
13162
13393
  } (layout));
13163
13394
 
13164
13395
  Object.defineProperty(Factory$3, "__esModule", { value: true });
13165
- const base_1$4 = base;
13396
+ Factory$3.PlatformModule = void 0;
13397
+ const base_1$4 = base$1;
13166
13398
  const Instance_1$1 = Instance$2;
13167
13399
  const index_1$1 = layout;
13400
+ /**
13401
+ * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
13402
+ */
13168
13403
  class PlatformModule extends base_1$4.Base {
13169
13404
  /**
13170
13405
  * @internal
@@ -13230,14 +13465,12 @@ class PlatformModule extends base_1$4.Base {
13230
13465
  * fin.Platform.init({overrideCallback});
13231
13466
  * ```
13232
13467
  * @experimental
13233
- * @static
13234
13468
  */
13235
13469
  async init(options) {
13236
13470
  return this.wire.environment.initPlatform(this.fin, options);
13237
13471
  }
13238
13472
  /**
13239
13473
  * Asynchronously returns a Platform object that represents an existing platform.
13240
- * @param identity
13241
13474
  *
13242
13475
  * @example
13243
13476
  * ```js
@@ -13246,7 +13479,6 @@ class PlatformModule extends base_1$4.Base {
13246
13479
  * // Use wrapped instance to control layout, e.g.:
13247
13480
  * const snapshot = await platform.getSnapshot();
13248
13481
  * ```
13249
- * @static
13250
13482
  */
13251
13483
  async wrap(identity) {
13252
13484
  this.wire.sendAction('platform-wrap').catch((e) => {
@@ -13256,7 +13488,6 @@ class PlatformModule extends base_1$4.Base {
13256
13488
  }
13257
13489
  /**
13258
13490
  * Synchronously returns a Platform object that represents an existing platform.
13259
- * @param identity
13260
13491
  *
13261
13492
  * @example
13262
13493
  * ```js
@@ -13265,7 +13496,6 @@ class PlatformModule extends base_1$4.Base {
13265
13496
  * // Use wrapped instance to control layout, e.g.:
13266
13497
  * const snapshot = await platform.getSnapshot();
13267
13498
  * ```
13268
- * @static
13269
13499
  */
13270
13500
  wrapSync(identity) {
13271
13501
  this.wire.sendAction('platform-wrap-sync').catch((e) => {
@@ -13282,7 +13512,6 @@ class PlatformModule extends base_1$4.Base {
13282
13512
  * // Use wrapped instance to control layout, e.g.:
13283
13513
  * const snapshot = await platform.getSnapshot();
13284
13514
  * ```
13285
- * @static
13286
13515
  */
13287
13516
  async getCurrent() {
13288
13517
  this.wire.sendAction('platform-get-current').catch((e) => {
@@ -13299,7 +13528,6 @@ class PlatformModule extends base_1$4.Base {
13299
13528
  * // Use wrapped instance to control layout, e.g.:
13300
13529
  * const snapshot = await platform.getSnapshot();
13301
13530
  * ```
13302
- * @static
13303
13531
  */
13304
13532
  getCurrentSync() {
13305
13533
  this.wire.sendAction('platform-get-current-sync').catch((e) => {
@@ -13310,7 +13538,6 @@ class PlatformModule extends base_1$4.Base {
13310
13538
  /**
13311
13539
  * Creates and starts a Platform and returns a wrapped and running Platform instance. The wrapped Platform methods can
13312
13540
  * be used to launch content into the platform. Promise will reject if the platform is already running.
13313
- * @param platformOptions
13314
13541
  *
13315
13542
  * @example
13316
13543
  * ```js
@@ -13331,7 +13558,6 @@ class PlatformModule extends base_1$4.Base {
13331
13558
  * console.error(e);
13332
13559
  * }
13333
13560
  * ```
13334
- * @static
13335
13561
  */
13336
13562
  start(platformOptions) {
13337
13563
  this.wire.sendAction('platform-start').catch((e) => {
@@ -13376,7 +13602,6 @@ class PlatformModule extends base_1$4.Base {
13376
13602
  * console.error(e);
13377
13603
  * }
13378
13604
  * ```
13379
- * @static
13380
13605
  */
13381
13606
  startFromManifest(manifestUrl, opts) {
13382
13607
  this.wire.sendAction('platform-start-from-manifest').catch((e) => {
@@ -13399,18 +13624,9 @@ class PlatformModule extends base_1$4.Base {
13399
13624
  });
13400
13625
  }
13401
13626
  }
13402
- Factory$3.default = PlatformModule;
13627
+ Factory$3.PlatformModule = PlatformModule;
13403
13628
 
13404
13629
  (function (exports) {
13405
- /**
13406
- * Entry point for the OpenFin Platform namespace.
13407
- *
13408
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "PlatformModule" is used for
13409
- * the module containing static members of the `Platform` namespace (available under `fin.Platform`), while `Platform` documents
13410
- * instances of the OpenFin `Platform` class.
13411
- *
13412
- * @packageDocumentation
13413
- */
13414
13630
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
13415
13631
  if (k2 === undefined) k2 = k;
13416
13632
  var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -13426,10 +13642,20 @@ Factory$3.default = PlatformModule;
13426
13642
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
13427
13643
  };
13428
13644
  Object.defineProperty(exports, "__esModule", { value: true });
13429
- const Factory_1 = Factory$3;
13430
- exports.default = Factory_1.default;
13645
+ /**
13646
+ * Entry points for the OpenFin `Platform` API (`fin.Platform`)
13647
+ *
13648
+ * * {@link PlatformModule} contains static members of the `Platform` API, accessible through `fin.Platform`.
13649
+ * * {@link Platform} describes an instance of an OpenFin Platform, e.g. as returned by `fin.Platform.getCurrent`.
13650
+ *
13651
+ * 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),
13652
+ * both of these were documented on the same page.
13653
+ *
13654
+ * @packageDocumentation
13655
+ */
13656
+ __exportStar(Factory$3, exports);
13431
13657
  __exportStar(Instance$2, exports);
13432
- } (platform));
13658
+ } (platform$1));
13433
13659
 
13434
13660
  var me = {};
13435
13661
 
@@ -13437,9 +13663,9 @@ var me = {};
13437
13663
  Object.defineProperty(exports, "__esModule", { value: true });
13438
13664
  exports.getMe = exports.getBaseMe = exports.environmentUnsupportedMessage = void 0;
13439
13665
  const view_1 = requireView();
13440
- const frame_1 = frame;
13666
+ const frame_1 = frame$1;
13441
13667
  const window_1 = requireWindow();
13442
- const external_application_1 = externalApplication;
13668
+ const external_application_1 = externalApplication$1;
13443
13669
  exports.environmentUnsupportedMessage = 'You are not running in OpenFin.';
13444
13670
  function getBaseMe(entityType, uuid, name) {
13445
13671
  const entityTypeHelpers = {
@@ -14100,7 +14326,7 @@ function requireInteropBroker () {
14100
14326
  hasRequiredInteropBroker = 1;
14101
14327
  Object.defineProperty(InteropBroker, "__esModule", { value: true });
14102
14328
  InteropBroker.InteropBroker = void 0;
14103
- const base_1 = base;
14329
+ const base_1 = base$1;
14104
14330
  const SessionContextGroupBroker_1 = requireSessionContextGroupBroker();
14105
14331
  const utils_1 = utils$1;
14106
14332
  const lodash_1 = require$$3;
@@ -14675,7 +14901,8 @@ function requireInteropBroker () {
14675
14901
  * ```
14676
14902
  */
14677
14903
  // eslint-disable-next-line class-methods-use-this
14678
- async handleFiredIntent(intent, clientIdentity) {
14904
+ async handleFiredIntent(intent, clientIdentity // TODO(CORE-811): remove inline intersected type
14905
+ ) {
14679
14906
  const warning = (0, utils_1.generateOverrideWarning)('fdc3.raiseIntent', 'InteropBroker.handleFiredIntent', clientIdentity, 'interopClient.fireIntent');
14680
14907
  console.warn(warning);
14681
14908
  throw new Error(utils_1.BROKER_ERRORS.fireIntent);
@@ -14742,7 +14969,7 @@ function requireInteropBroker () {
14742
14969
  * More information on the AppIntent type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/AppIntent).
14743
14970
  *
14744
14971
  * @param options
14745
- * @param clientIdentity Identity of the Client making the request.
14972
+ * @param clientIdentity Identity of the Client making the request.
14746
14973
  *
14747
14974
  * @example
14748
14975
  * ```js
@@ -14759,7 +14986,8 @@ function requireInteropBroker () {
14759
14986
  * ```
14760
14987
  */
14761
14988
  // eslint-disable-next-line class-methods-use-this
14762
- async handleInfoForIntent(options, clientIdentity) {
14989
+ async handleInfoForIntent(options, clientIdentity // TODO(CORE-811): remove inline intersected type
14990
+ ) {
14763
14991
  const warning = (0, utils_1.generateOverrideWarning)('fdc3.findIntent', 'InteropBroker.handleInfoForIntent', clientIdentity, 'interopClient.getInfoForIntent');
14764
14992
  console.warn(warning);
14765
14993
  throw new Error(utils_1.BROKER_ERRORS.getInfoForIntent);
@@ -14805,7 +15033,8 @@ function requireInteropBroker () {
14805
15033
  * ```
14806
15034
  */
14807
15035
  // eslint-disable-next-line class-methods-use-this
14808
- async handleInfoForIntentsByContext(context, clientIdentity) {
15036
+ async handleInfoForIntentsByContext(context, clientIdentity // TODO(CORE-811): remove inline intersected type
15037
+ ) {
14809
15038
  const warning = (0, utils_1.generateOverrideWarning)('fdc3.findIntentsByContext', 'InteropBroker.handleInfoForIntentsByContext', clientIdentity, 'interopClient.getInfoForIntentsByContext');
14810
15039
  console.warn(warning);
14811
15040
  throw new Error(utils_1.BROKER_ERRORS.getInfoForIntentsByContext);
@@ -14831,7 +15060,7 @@ function requireInteropBroker () {
14831
15060
  * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
14832
15061
  *
14833
15062
  * @param contextForIntent Data passed between entities and applications.
14834
- * @param clientIdentity Identity of the Client making the request.
15063
+ * @param clientIdentity Identity of the Client making the request.
14835
15064
  *
14836
15065
  * @example
14837
15066
  * ```js
@@ -14892,7 +15121,7 @@ function requireInteropBroker () {
14892
15121
  /**
14893
15122
  * Responsible for resolving the fdc3.findInstances call.
14894
15123
  * Must be overridden
14895
- * @param app AppIdentifier that was passed to fdc3.findInstances
15124
+ * @param app AppIdentifier that was passed to fdc3.findInstances
14896
15125
  * @param clientIdentity Identity of the Client making the request.
14897
15126
  */
14898
15127
  // eslint-disable-next-line class-methods-use-this
@@ -14927,7 +15156,7 @@ function requireInteropBroker () {
14927
15156
  * fin.Platform.init({
14928
15157
  * interopOverride: async (InteropBroker) => {
14929
15158
  * class Override extends InteropBroker {
14930
- * async invokeContextHandler(options, clientIdentity) {
15159
+ * async invokeContextHandler(clientIdentity, handlerId, context) {
14931
15160
  * return super.invokeContextHandler(clientIdentity, handlerId, {
14932
15161
  * ...context,
14933
15162
  * contextMetadata: {
@@ -14967,7 +15196,7 @@ function requireInteropBroker () {
14967
15196
  * fin.Platform.init({
14968
15197
  * interopOverride: async (InteropBroker) => {
14969
15198
  * class Override extends InteropBroker {
14970
- * async invokeIntentHandler(options, clientIdentity) {
15199
+ * async invokeIntentHandler(clientIdentity, handlerId, context) {
14971
15200
  * const { context } = intent;
14972
15201
  * return super.invokeIntentHandler(clientIdentity, handlerId, {
14973
15202
  * ...intent,
@@ -15306,7 +15535,8 @@ function requireInteropBroker () {
15306
15535
  }
15307
15536
  // Setup Channel Connection Logic
15308
15537
  wireChannel(channel) {
15309
- channel.onConnection(async (clientIdentity, payload) => {
15538
+ channel.onConnection(async (clientIdentity, // TODO(CORE-811): remove inline intersected type
15539
+ payload) => {
15310
15540
  if (!(await this.isConnectionAuthorized(clientIdentity, payload))) {
15311
15541
  throw new Error(`Connection not authorized for ${clientIdentity.uuid}, ${clientIdentity.name}`);
15312
15542
  }
@@ -15430,7 +15660,7 @@ var __classPrivateFieldGet$3 = (commonjsGlobal && commonjsGlobal.__classPrivateF
15430
15660
  };
15431
15661
  var _SessionContextGroupClient_clientPromise;
15432
15662
  Object.defineProperty(SessionContextGroupClient$1, "__esModule", { value: true });
15433
- const base_1$3 = base;
15663
+ const base_1$3 = base$1;
15434
15664
  const utils_1$3 = utils$1;
15435
15665
  class SessionContextGroupClient extends base_1$3.Base {
15436
15666
  constructor(wire, client, id) {
@@ -15517,7 +15747,7 @@ var __classPrivateFieldGet$2 = (commonjsGlobal && commonjsGlobal.__classPrivateF
15517
15747
  var _InteropClient_clientPromise, _InteropClient_sessionContextGroups;
15518
15748
  Object.defineProperty(InteropClient$1, "__esModule", { value: true });
15519
15749
  InteropClient$1.InteropClient = void 0;
15520
- const base_1$2 = base;
15750
+ const base_1$2 = base$1;
15521
15751
  const SessionContextGroupClient_1 = SessionContextGroupClient$1;
15522
15752
  const utils_1$2 = utils$1;
15523
15753
  /**
@@ -16186,39 +16416,46 @@ class InteropClient extends base_1$2.Base {
16186
16416
  InteropClient$1.InteropClient = InteropClient;
16187
16417
  _InteropClient_clientPromise = new WeakMap(), _InteropClient_sessionContextGroups = new WeakMap();
16188
16418
 
16189
- var overrideCheck$1 = {};
16419
+ var overrideCheck = {};
16190
16420
 
16191
- Object.defineProperty(overrideCheck$1, "__esModule", { value: true });
16192
- overrideCheck$1.overrideCheck = overrideCheck$1.getDefaultViewFdc3VersionFromAppInfo = void 0;
16193
- const InteropBroker_1 = requireInteropBroker();
16194
- function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }) {
16195
- var _a, _b, _c, _d;
16196
- const setVersion = (_c = (_b = (_a = manifest.platform) === null || _a === void 0 ? void 0 : _a.defaultViewOptions) === null || _b === void 0 ? void 0 : _b.fdc3InteropApi) !== null && _c !== void 0 ? _c : (_d = initialOptions.defaultViewOptions) === null || _d === void 0 ? void 0 : _d.fdc3InteropApi;
16197
- return ['1.2', '2.0'].includes(setVersion !== null && setVersion !== void 0 ? setVersion : '') ? setVersion : undefined;
16198
- }
16199
- overrideCheck$1.getDefaultViewFdc3VersionFromAppInfo = getDefaultViewFdc3VersionFromAppInfo;
16200
- // TODO: Unit test this
16201
- function overrideCheck(overriddenBroker, fdc3InteropApi) {
16202
- if (fdc3InteropApi && fdc3InteropApi === '2.0') {
16203
- const mustOverrideAPIs = [
16204
- 'fdc3HandleFindInstances',
16205
- 'handleInfoForIntent',
16206
- 'handleInfoForIntentsByContext',
16207
- 'fdc3HandleGetAppMetadata',
16208
- 'fdc3HandleGetInfo',
16209
- 'fdc3HandleOpen',
16210
- 'handleFiredIntent',
16211
- 'handleFiredIntentForContext'
16212
- ];
16213
- const notOverridden = mustOverrideAPIs.filter((api) => {
16214
- return overriddenBroker[api] === InteropBroker_1.InteropBroker.prototype[api];
16215
- });
16216
- if (notOverridden.length > 0) {
16217
- console.warn(`WARNING: FDC3 2.0 has been set as a default option for Views in this Platform, but the required InteropBroker APIs for FDC3 2.0 compliance have not all been overridden.\nThe following APIs need to be overridden:\n${notOverridden.join('\n')}`);
16218
- }
16219
- }
16421
+ var hasRequiredOverrideCheck;
16422
+
16423
+ function requireOverrideCheck () {
16424
+ if (hasRequiredOverrideCheck) return overrideCheck;
16425
+ hasRequiredOverrideCheck = 1;
16426
+ Object.defineProperty(overrideCheck, "__esModule", { value: true });
16427
+ overrideCheck.overrideCheck = overrideCheck.getDefaultViewFdc3VersionFromAppInfo = void 0;
16428
+ const InteropBroker_1 = requireInteropBroker();
16429
+ function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }) {
16430
+ var _a, _b, _c, _d;
16431
+ const setVersion = (_c = (_b = (_a = manifest.platform) === null || _a === void 0 ? void 0 : _a.defaultViewOptions) === null || _b === void 0 ? void 0 : _b.fdc3InteropApi) !== null && _c !== void 0 ? _c : (_d = initialOptions.defaultViewOptions) === null || _d === void 0 ? void 0 : _d.fdc3InteropApi;
16432
+ return ['1.2', '2.0'].includes(setVersion !== null && setVersion !== void 0 ? setVersion : '') ? setVersion : undefined;
16433
+ }
16434
+ overrideCheck.getDefaultViewFdc3VersionFromAppInfo = getDefaultViewFdc3VersionFromAppInfo;
16435
+ // TODO: Unit test this
16436
+ function overrideCheck$1(overriddenBroker, fdc3InteropApi) {
16437
+ if (fdc3InteropApi && fdc3InteropApi === '2.0') {
16438
+ const mustOverrideAPIs = [
16439
+ 'fdc3HandleFindInstances',
16440
+ 'handleInfoForIntent',
16441
+ 'handleInfoForIntentsByContext',
16442
+ 'fdc3HandleGetAppMetadata',
16443
+ 'fdc3HandleGetInfo',
16444
+ 'fdc3HandleOpen',
16445
+ 'handleFiredIntent',
16446
+ 'handleFiredIntentForContext'
16447
+ ];
16448
+ const notOverridden = mustOverrideAPIs.filter((api) => {
16449
+ return overriddenBroker[api] === InteropBroker_1.InteropBroker.prototype[api];
16450
+ });
16451
+ if (notOverridden.length > 0) {
16452
+ console.warn(`WARNING: FDC3 2.0 has been set as a default option for Views in this Platform, but the required InteropBroker APIs for FDC3 2.0 compliance have not all been overridden.\nThe following APIs need to be overridden:\n${notOverridden.join('\n')}`);
16453
+ }
16454
+ }
16455
+ }
16456
+ overrideCheck.overrideCheck = overrideCheck$1;
16457
+ return overrideCheck;
16220
16458
  }
16221
- overrideCheck$1.overrideCheck = overrideCheck;
16222
16459
 
16223
16460
  var hasRequiredFactory;
16224
16461
 
@@ -16226,12 +16463,13 @@ function requireFactory () {
16226
16463
  if (hasRequiredFactory) return Factory$1;
16227
16464
  hasRequiredFactory = 1;
16228
16465
  Object.defineProperty(Factory$1, "__esModule", { value: true });
16466
+ Factory$1.InteropModule = void 0;
16229
16467
  const lodash_1 = require$$3;
16230
16468
  const inaccessibleObject_1 = inaccessibleObject;
16231
- const base_1 = base;
16469
+ const base_1 = base$1;
16232
16470
  const InteropBroker_1 = requireInteropBroker();
16233
16471
  const InteropClient_1 = InteropClient$1;
16234
- const overrideCheck_1 = overrideCheck$1;
16472
+ const overrideCheck_1 = requireOverrideCheck();
16235
16473
  const common_utils_1 = commonUtils;
16236
16474
  const defaultOverride = (Class) => new Class();
16237
16475
  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.';
@@ -16262,7 +16500,6 @@ function requireFactory () {
16262
16500
  * const contextGroups = await interopBroker.getContextGroups();
16263
16501
  * console.log(contextGroups);
16264
16502
  * ```
16265
- * @static
16266
16503
  */
16267
16504
  async init(name, override = defaultOverride) {
16268
16505
  var _a;
@@ -16320,7 +16557,6 @@ function requireFactory () {
16320
16557
  * const contextGroupInfo = await client.getInfoForContextGroup();
16321
16558
  * console.log(contextGroupInfo);
16322
16559
  * ```
16323
- * @static
16324
16560
  */
16325
16561
  connectSync(name, interopConfig) {
16326
16562
  this.wire.sendAction('interop-connect-sync').catch(() => {
@@ -16329,7 +16565,7 @@ function requireFactory () {
16329
16565
  return new InteropClient_1.InteropClient(this.wire, name, interopConfig);
16330
16566
  }
16331
16567
  }
16332
- Factory$1.default = InteropModule;
16568
+ Factory$1.InteropModule = InteropModule;
16333
16569
  return Factory$1;
16334
16570
  }
16335
16571
 
@@ -16340,10 +16576,10 @@ function requireInterop () {
16340
16576
  hasRequiredInterop = 1;
16341
16577
  (function (exports) {
16342
16578
  /**
16343
- * Entry point for the OpenFin Interop namespace.
16579
+ * Entry point for the OpenFin `Interop` API (`fin.Interop`).
16344
16580
  *
16345
- * "InteropModule" contains static members of the `Interop` namespace (available under `fin.Interop`), while `InteropClient` and
16346
- * `InteropBroker` document instances of their respective classes.
16581
+ * * {@link InteropModule} contains static members of the `Interop` API (available under `fin.Interop`)
16582
+ * * {@link InteropClient} and {@link InteropBroker} document instances of their respective classes.
16347
16583
  *
16348
16584
  * @packageDocumentation
16349
16585
  */
@@ -16362,8 +16598,7 @@ function requireInterop () {
16362
16598
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
16363
16599
  };
16364
16600
  Object.defineProperty(exports, "__esModule", { value: true });
16365
- const Factory_1 = requireFactory();
16366
- exports.default = Factory_1.default;
16601
+ __exportStar(requireFactory(), exports);
16367
16602
  __exportStar(InteropClient$1, exports);
16368
16603
  __exportStar(requireInteropBroker(), exports);
16369
16604
  } (interop));
@@ -16399,12 +16634,14 @@ var _SnapshotSource_identity, _SnapshotSource_getConnection, _SnapshotSource_get
16399
16634
  Object.defineProperty(Instance, "__esModule", { value: true });
16400
16635
  Instance.SnapshotSource = void 0;
16401
16636
  /* eslint-disable @typescript-eslint/no-non-null-assertion */
16402
- const base_1$1 = base;
16637
+ const base_1$1 = base$1;
16403
16638
  const utils_1$1 = utils;
16404
16639
  const connectionMap = new Map();
16405
16640
  /**
16406
16641
  * Enables configuring a SnapshotSource with custom getSnapshot and applySnapshot methods.
16407
16642
  *
16643
+ * @typeParam Snapshot Implementation-defined shape of an application snapshot. Allows
16644
+ * custom snapshot implementations for legacy applications to define their own snapshot format.
16408
16645
  */
16409
16646
  class SnapshotSource extends base_1$1.Base {
16410
16647
  /**
@@ -16539,13 +16776,19 @@ Instance.SnapshotSource = SnapshotSource;
16539
16776
  _SnapshotSource_identity = new WeakMap(), _SnapshotSource_getConnection = new WeakMap(), _SnapshotSource_getClient = new WeakMap(), _SnapshotSource_startConnection = new WeakMap(), _SnapshotSource_setUpConnectionListener = new WeakMap();
16540
16777
 
16541
16778
  Object.defineProperty(Factory, "__esModule", { value: true });
16542
- const base_1 = base;
16779
+ Factory.SnapshotSourceModule = void 0;
16780
+ const base_1 = base$1;
16543
16781
  const Instance_1 = Instance;
16544
16782
  const utils_1 = utils;
16783
+ /**
16784
+ * Static namespace for OpenFin API methods that interact with the {@link SnapshotSource} class, available under `fin.SnapshotSource`.
16785
+ */
16545
16786
  class SnapshotSourceModule extends base_1.Base {
16546
16787
  /**
16547
16788
  * Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
16548
- * @param provider
16789
+ *
16790
+ * @typeParam Snapshot Implementation-defined shape of an application snapshot. Allows
16791
+ * custom snapshot implementations for legacy applications to define their own snapshot format.
16549
16792
  *
16550
16793
  * @example
16551
16794
  * ```js
@@ -16562,7 +16805,7 @@ class SnapshotSourceModule extends base_1.Base {
16562
16805
  *
16563
16806
  * await fin.SnapshotSource.init(snapshotProvider);
16564
16807
  * ```
16565
- * @static
16808
+ *
16566
16809
  */
16567
16810
  async init(provider) {
16568
16811
  this.wire.sendAction('snapshot-source-init').catch((e) => {
@@ -16582,7 +16825,6 @@ class SnapshotSourceModule extends base_1.Base {
16582
16825
  }
16583
16826
  /**
16584
16827
  * Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
16585
- * @param identity
16586
16828
  *
16587
16829
  * @example
16588
16830
  * ```js
@@ -16590,7 +16832,6 @@ class SnapshotSourceModule extends base_1.Base {
16590
16832
  * // Use wrapped instance's getSnapshot method, e.g.:
16591
16833
  * const snapshot = await snapshotSource.getSnapshot();
16592
16834
  * ```
16593
- * @static
16594
16835
  */
16595
16836
  wrapSync(identity) {
16596
16837
  this.wire.sendAction('snapshot-source-wrap-sync').catch((e) => {
@@ -16600,7 +16841,6 @@ class SnapshotSourceModule extends base_1.Base {
16600
16841
  }
16601
16842
  /**
16602
16843
  * Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.
16603
- * @param identity
16604
16844
  *
16605
16845
  * @example
16606
16846
  * ```js
@@ -16608,7 +16848,6 @@ class SnapshotSourceModule extends base_1.Base {
16608
16848
  * // Use wrapped instance's getSnapshot method, e.g.:
16609
16849
  * const snapshot = await snapshotSource.getSnapshot();
16610
16850
  * ```
16611
- * @static
16612
16851
  */
16613
16852
  async wrap(identity) {
16614
16853
  this.wire.sendAction('snapshot-source-wrap').catch((e) => {
@@ -16617,15 +16856,17 @@ class SnapshotSourceModule extends base_1.Base {
16617
16856
  return this.wrapSync(identity);
16618
16857
  }
16619
16858
  }
16620
- Factory.default = SnapshotSourceModule;
16859
+ Factory.SnapshotSourceModule = SnapshotSourceModule;
16621
16860
 
16622
16861
  (function (exports) {
16623
16862
  /**
16624
- * Entry point for the OpenFin SnapshotSource namespace.
16863
+ * Entry points for the OpenFin `SnapshotSource` API (`fin.SnapshotSource`).
16625
16864
  *
16626
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "SnapshotSourceModule" is used for
16627
- * the module containing static members of the `SnapshotSource` namespace (available under `fin.SnapshotSource`), while `SnapshotSource` documents
16628
- * instances of the OpenFin `SnapshotSource` class.
16865
+ * * {@link SnapshotSourceModule} contains static members of the `SnapshotSource` API, accessible through `fin.SnapshotSource`.
16866
+ * * {@link SnapshotSource} describes an instance of an OpenFin SnapshotSource, e.g. as returned by `fin.SnapshotSource.wrap`.
16867
+ *
16868
+ * 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),
16869
+ * both of these were documented on the same page.
16629
16870
  *
16630
16871
  * @packageDocumentation
16631
16872
  */
@@ -16644,27 +16885,30 @@ Factory.default = SnapshotSourceModule;
16644
16885
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
16645
16886
  };
16646
16887
  Object.defineProperty(exports, "__esModule", { value: true });
16647
- const Factory_1 = Factory;
16648
- exports.default = Factory_1.default;
16888
+ __exportStar(Factory, exports);
16649
16889
  __exportStar(Instance, exports);
16650
16890
  } (snapshotSource));
16651
16891
 
16652
16892
  Object.defineProperty(fin, "__esModule", { value: true });
16893
+ fin.Fin = void 0;
16653
16894
  const events_1$3 = eventsExports;
16654
16895
  // Import from the file rather than the directory in case someone consuming types is using module resolution other than "node"
16655
- const index_1 = system;
16896
+ const index_1 = system$1;
16656
16897
  const index_2 = requireWindow();
16657
16898
  const index_3 = requireApplication();
16658
16899
  const index_4 = interappbus;
16659
16900
  const index_5 = clipboard;
16660
- const index_6 = externalApplication;
16661
- const index_7 = frame;
16662
- const index_8 = globalHotkey;
16901
+ const index_6 = externalApplication$1;
16902
+ const index_7 = frame$1;
16903
+ const index_8 = globalHotkey$1;
16663
16904
  const index_9 = requireView();
16664
- const index_10 = platform;
16905
+ const index_10 = platform$1;
16665
16906
  const me_1$1 = me;
16666
16907
  const interop_1 = requireInterop();
16667
16908
  const snapshot_source_1 = snapshotSource;
16909
+ /**
16910
+ * @internal
16911
+ */
16668
16912
  class Fin extends events_1$3.EventEmitter {
16669
16913
  /**
16670
16914
  * @internal
@@ -16672,18 +16916,18 @@ class Fin extends events_1$3.EventEmitter {
16672
16916
  constructor(wire) {
16673
16917
  super();
16674
16918
  this.wire = wire;
16675
- this.System = new index_1.default(wire);
16676
- this.Window = new index_2.default(wire);
16677
- this.Application = new index_3.default(wire);
16678
- this.InterApplicationBus = new index_4.default(wire);
16679
- this.Clipboard = new index_5.default(wire);
16680
- this.ExternalApplication = new index_6.default(wire);
16681
- this.Frame = new index_7.default(wire);
16682
- this.GlobalHotkey = new index_8.default(wire);
16683
- this.Platform = new index_10.default(wire, this.InterApplicationBus.Channel);
16684
- this.View = new index_9.default(wire);
16685
- this.Interop = new interop_1.default(wire);
16686
- this.SnapshotSource = new snapshot_source_1.default(wire);
16919
+ this.System = new index_1.System(wire);
16920
+ this.Window = new index_2._WindowModule(wire);
16921
+ this.Application = new index_3.ApplicationModule(wire);
16922
+ this.InterApplicationBus = new index_4.InterApplicationBus(wire);
16923
+ this.Clipboard = new index_5.Clipboard(wire);
16924
+ this.ExternalApplication = new index_6.ExternalApplicationModule(wire);
16925
+ this.Frame = new index_7._FrameModule(wire);
16926
+ this.GlobalHotkey = new index_8.GlobalHotkey(wire);
16927
+ this.Platform = new index_10.PlatformModule(wire, this.InterApplicationBus.Channel);
16928
+ this.View = new index_9.ViewModule(wire);
16929
+ this.Interop = new interop_1.InteropModule(wire);
16930
+ this.SnapshotSource = new snapshot_source_1.SnapshotSourceModule(wire);
16687
16931
  wire.registerFin(this);
16688
16932
  this.me = (0, me_1$1.getMe)(wire);
16689
16933
  // Handle disconnect events
@@ -16692,7 +16936,7 @@ class Fin extends events_1$3.EventEmitter {
16692
16936
  });
16693
16937
  }
16694
16938
  }
16695
- fin.default = Fin;
16939
+ fin.Fin = Fin;
16696
16940
 
16697
16941
  var wire = {};
16698
16942
 
@@ -17994,7 +18238,7 @@ function requireMain () {
17994
18238
  Object.defineProperty(exports, "__esModule", { value: true });
17995
18239
  exports.ChannelProvider = exports.ChannelClient = exports.Frame = exports.View = exports.System = exports.Window = exports.Application = exports.Fin = exports.launch = exports.connect = void 0;
17996
18240
  const fin_1 = fin;
17997
- exports.Fin = fin_1.default;
18241
+ Object.defineProperty(exports, "Fin", { enumerable: true, get: function () { return fin_1.Fin; } });
17998
18242
  const index_1 = requireApplication();
17999
18243
  Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return index_1.Application; } });
18000
18244
  const window_1 = requireWindow();
@@ -18002,13 +18246,13 @@ function requireMain () {
18002
18246
  const view_1 = requireView();
18003
18247
  Object.defineProperty(exports, "View", { enumerable: true, get: function () { return view_1.View; } });
18004
18248
  const client_1 = client;
18005
- exports.ChannelClient = client_1.default;
18249
+ Object.defineProperty(exports, "ChannelClient", { enumerable: true, get: function () { return client_1.ChannelClient; } });
18006
18250
  const provider_1 = provider;
18007
18251
  Object.defineProperty(exports, "ChannelProvider", { enumerable: true, get: function () { return provider_1.ChannelProvider; } });
18008
- const frame_1 = frame;
18252
+ const frame_1 = frame$1;
18009
18253
  Object.defineProperty(exports, "Frame", { enumerable: true, get: function () { return frame_1._Frame; } });
18010
- const system_1 = system;
18011
- exports.System = system_1.default;
18254
+ const system_1 = system$1;
18255
+ Object.defineProperty(exports, "System", { enumerable: true, get: function () { return system_1.System; } });
18012
18256
  const wire_1 = wire;
18013
18257
  const node_env_1 = requireNodeEnv();
18014
18258
  const transport_1 = transport;
@@ -18025,7 +18269,7 @@ function requireMain () {
18025
18269
  name: (_a = normalized.name) !== null && _a !== void 0 ? _a : normalized.uuid
18026
18270
  });
18027
18271
  await wire.connect(normalized);
18028
- return new fin_1.default(wire);
18272
+ return new fin_1.Fin(wire);
18029
18273
  }
18030
18274
  exports.connect = connect;
18031
18275
  async function launch(config) {
@@ -18043,15 +18287,261 @@ function requireMain () {
18043
18287
 
18044
18288
  var mainExports = requireMain();
18045
18289
 
18046
- var OpenFin$1 = {};
18290
+ var OpenFin$2 = {};
18291
+
18292
+ var events = {};
18293
+
18294
+ var application = {};
18295
+
18296
+ /**
18297
+ * Namespace for events that can be emitted by an {@link OpenFin.Application}. Includes events
18298
+ * re-propagated from the {@link OpenFin.Window} (and, transitively, {@link OpenFin.View}) level, prefixed with `window-` (and also, if applicable, `view-`).
18299
+ * For example, a view's "attached" event will fire as 'window-view-attached' at the application level.
18300
+ *
18301
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
18302
+ *
18303
+ * This namespace contains only payload shapes for events that are unique to `Application`. Events that propagate to `Application` from
18304
+ * child {@link OpenFin.Window windows} and {@link OpenFin.View views} are defined in the {@link OpenFin.WindowEvents} and
18305
+ * {@link OpenFin.ViewEvents} namespaces. For a list of valid string keys for *all* application events, see {@link Application.on Application.on}.
18306
+ *
18307
+ * {@link ApplicationSourcedEvent Application-sourced events} (i.e. those that have not propagated from {@link OpenFin.ViewEvents Views}
18308
+ * or {@link OpenFin.WindowEvents Windows} re-propagate to {@link OpenFin.SystemEvents System} with their type string prefixed with `application-`.
18309
+ * {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
18310
+ * are propagated to `System` without any type string prefixing.
18311
+ *
18312
+ * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
18313
+ *
18314
+ * @packageDocumentation
18315
+ */
18316
+ Object.defineProperty(application, "__esModule", { value: true });
18317
+
18318
+ var base = {};
18319
+
18320
+ /**
18321
+ * Namespace for shared event payloads and utility types common to all event emitters.
18322
+ *
18323
+ * @packageDocumentation
18324
+ */
18325
+ Object.defineProperty(base, "__esModule", { value: true });
18326
+
18327
+ var externalApplication = {};
18328
+
18329
+ /**
18330
+ * Namespace for events that can be transmitted by an {@link OpenFin.ExternalApplication}.
18331
+ *
18332
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
18333
+ *
18334
+ * For a list of valid string keys for external application events, see {@link ExternalApplication.on ExternalApplication.on}.
18335
+ *
18336
+ * @packageDocumentation
18337
+ */
18338
+ Object.defineProperty(externalApplication, "__esModule", { value: true });
18339
+
18340
+ var frame = {};
18341
+
18342
+ Object.defineProperty(frame, "__esModule", { value: true });
18343
+
18344
+ var globalHotkey = {};
18345
+
18346
+ Object.defineProperty(globalHotkey, "__esModule", { value: true });
18347
+
18348
+ var platform = {};
18349
+
18350
+ /**
18351
+ *
18352
+ * Namespace for events that can emitted by a {@link OpenFin.Platform}.
18353
+ *
18354
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
18355
+ *
18356
+ * The Platform `EventEmitter` is a superset of the {@link OpenFin.Application} `EventEmitter`,
18357
+ * meaning it can listen to all {@link OpenFin.ApplicationEvents Application events} in addition to the
18358
+ * Platform-specific events listed here. For a list of valid string keys for *all* platform events, see
18359
+ * {@link Platform.on Platform.on}.
18360
+ *
18361
+ * @packageDocumentation
18362
+ */
18363
+ Object.defineProperty(platform, "__esModule", { value: true });
18364
+
18365
+ var system = {};
18366
+
18367
+ /**
18368
+ * Namespace for runtime-wide OpenFin events emitted by {@link System.System}. Includes events
18369
+ * re-propagated from {@link OpenFin.Application}, {@link OpenFin.Window}, and {@link OpenFin.View} (prefixed with `application-`, `window-`, and `view-`). All
18370
+ * event propagations are visible at the System level. Propagated events from WebContents (windows, views, frames) to the Application level will *not*
18371
+ * transitively re-propagate to the System level, because they are already visible at the system level and contain the identity
18372
+ * of the application. For example, an application's "closed" event will fire as 'application-closed' at the system level. A view's 'shown' event
18373
+ * will be visible as 'view-shown' at the system level, but *not* as `application-window-view-shown`.
18374
+ *
18375
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
18376
+ *
18377
+ * This namespace contains only payload shapes for events that are unique to `System`. Events that propagate to `System` from
18378
+ * child {@link OpenFin.Application applications}, {@link OpenFin.Window windows}, and {@link OpenFin.View views} are defined in the
18379
+ * {@link OpenFin.ApplicationEvents}, {@link OpenFin.WindowEvents}, and {@link OpenFin.ViewEvents} namespaces. For a list of valid string keys for *all*
18380
+ * system events, see {@link System.on System.on}.
18381
+ *
18382
+ * @packageDocumentation
18383
+ */
18384
+ Object.defineProperty(system, "__esModule", { value: true });
18385
+
18386
+ var view = {};
18387
+
18388
+ /**
18389
+ * Namespace for events that can be emitted by a {@link OpenFin.View}.
18390
+ *
18391
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
18392
+ *
18393
+ * This namespace contains only payload shapes for events that are unique to `View`. Events that are shared between all `WebContents`
18394
+ * (i.e. {@link OpenFin.Window}, {@link OpenFin.View}) are defined in {@link OpenFin.WebContentsEvents}. For a list
18395
+ * of valid string keys for *all* View events, see {@link View.on View.on}.
18396
+ *
18397
+ * View events propagate to their parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
18398
+ * and {@link OpenFin.SystemEvents System} with an added `viewIdentity` property and their event types prefixed with `'view-'`.
18399
+ *
18400
+ * @packageDocumentation
18401
+ */
18402
+ Object.defineProperty(view, "__esModule", { value: true });
18403
+
18404
+ var webcontents = {};
18405
+
18406
+ /**
18407
+ * Namespace for events shared by all OpenFin WebContents elements (i.e. {@link OpenFin.Window},
18408
+ * {@link OpenFin.View}).
18409
+ *
18410
+ * WebContents events are divided into two groups: {@link WillPropagateWebContentsEvent} and {@link NonPropagatedWebContentsEvent}. Propagating events
18411
+ * will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
18412
+ * parent window, and propagating events in a window will also be emitted on the window's parent {@link OpenFin.Application}.
18413
+ *
18414
+ * Non-propagating events will not re-emit on parent entities.
18415
+ *
18416
+ * @packageDocumentation
18417
+ */
18418
+ Object.defineProperty(webcontents, "__esModule", { value: true });
18419
+
18420
+ var window$1 = {};
18421
+
18422
+ /**
18423
+ * Namespace for events that can be emitted by a {@link OpenFin.Window}.
18424
+ *
18425
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
18426
+ *
18427
+ * This namespace contains only payload shapes for events that are unique to `Window`. Events that are shared between all `WebContents`
18428
+ * (i.e. {@link OpenFin.Window}, {@link OpenFin.View}) are defined in {@link OpenFin.WebContentsEvents}. Events that
18429
+ * propagate from `View` are defined in {@link OpenFin.ViewEvents}. For a list of valid string keys for *all* Window events, see
18430
+ * {@link Window.on Window.on}
18431
+ *
18432
+ * {@link OpenFin.WindowEvents.WindowSourcedEvent Window-sourced events} (i.e. those that are not propagated from a
18433
+ * {@link OpenFin.ViewEvents View}) propagate to their parent {@link OpenFin.ApplicationEvents Application} and
18434
+ * {@link OpenFin.SystemEvents System} with their event types prefixed with `'window-'`).
18435
+ *
18436
+ * "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System. The {@link OpenFin.WindowEvents.WindowCloseRequestedEvent}
18437
+ * does not propagate at all.
18438
+ *
18439
+ * @packageDocumentation
18440
+ */
18441
+ Object.defineProperty(window$1, "__esModule", { value: true });
18442
+
18443
+ /**
18444
+ * Namespace for OpenFin event types. Each entity that emits OpenFin events has its own sub-namespace. Event payloads
18445
+ * themselves are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
18446
+ *
18447
+ * #### Event emitters
18448
+ *
18449
+ * The following entities emit OpenFin events, and have corresponding sub-namespaces:
18450
+ *
18451
+ * * {@link OpenFin.Application}: {@link OpenFin.ApplicationEvents}
18452
+ * * {@link OpenFin.ExternalApplication}: {@link OpenFin.ExternalApplicationEvents}
18453
+ * * {@link OpenFin.Frame}: {@link OpenFin.FrameEvents}
18454
+ * * {@link OpenFin.GlobalHotkey}: {@link OpenFin.GlobalHotkeyEvents}
18455
+ * * {@link OpenFin.Platform}: {@link OpenFin.PlatformEvents}
18456
+ * * {@link OpenFin.System}: {@link OpenFin.SystemEvents}
18457
+ * * {@link OpenFin.View}: {@link OpenFin.ViewEvents}
18458
+ * * {@link OpenFin.Window}: {@link OpenFin.WindowEvents}
18459
+ *
18460
+ * These `EventEmitter` entities share a common set of methods for interacting with the OpenFin event bus, which can be
18461
+ * seen on the individual documentation pages for each entity type.
18462
+ *
18463
+ * Registering event handlers is an asynchronous operation. It is important to ensure that the returned Promises are awaited to reduce the
18464
+ * risk of race conditions.
18465
+ *
18466
+ * When the `EventEmitter` receives an event from the browser process and emits on the renderer, all of the functions attached to that
18467
+ * specific event are called synchronously. Any values returned by the called listeners are ignored and will be discarded. If the window document
18468
+ * is destroyed by page navigation or reload, its registered event listeners will be removed.
18469
+ *
18470
+ * We recommend using Arrow Functions for event listeners to ensure the this scope is consistent with the original function context.
18471
+ *
18472
+ * Events re-propagate from smaller/more-local scopes to larger/more-global scopes. For example, an event emitted on a specific
18473
+ * view will propagate to the window in which the view is embedded, and then to the application in which the window is running, and
18474
+ * finally to the OpenFin runtime itself at the "system" level. For details on propagation semantics, see the namespace for
18475
+ * the propagating (or propagated-to) entity.
18476
+ *
18477
+ * If you need the payload type for a specific type of event (especially propagated events), use the emitting topic's `Payload` generic
18478
+ * (e.g. {@link WindowEvents.Payload}) with the event's `type` string. For example, the payload of
18479
+ * a {@link ViewEvents.CreatedEvent} after it has propagated to its parent {@link WindowEvents Window} can be found with
18480
+ * `WindowEvents.Payload<'view-created'>`.
18481
+ *
18482
+ * @packageDocumentation
18483
+ */
18484
+ Object.defineProperty(events, "__esModule", { value: true });
18485
+ events.WindowEvents = events.WebContentsEvents = events.ViewEvents = events.SystemEvents = events.PlatformEvents = events.GlobalHotkeyEvents = events.FrameEvents = events.ExternalApplicationEvents = events.BaseEvents = events.ApplicationEvents = void 0;
18486
+ const ApplicationEvents = application;
18487
+ events.ApplicationEvents = ApplicationEvents;
18488
+ const BaseEvents = base;
18489
+ events.BaseEvents = BaseEvents;
18490
+ const ExternalApplicationEvents = externalApplication;
18491
+ events.ExternalApplicationEvents = ExternalApplicationEvents;
18492
+ const FrameEvents = frame;
18493
+ events.FrameEvents = FrameEvents;
18494
+ const GlobalHotkeyEvents = globalHotkey;
18495
+ events.GlobalHotkeyEvents = GlobalHotkeyEvents;
18496
+ const PlatformEvents = platform;
18497
+ events.PlatformEvents = PlatformEvents;
18498
+ const SystemEvents = system;
18499
+ events.SystemEvents = SystemEvents;
18500
+ const ViewEvents = view;
18501
+ events.ViewEvents = ViewEvents;
18502
+ const WebContentsEvents = webcontents;
18503
+ events.WebContentsEvents = WebContentsEvents;
18504
+ const WindowEvents = window$1;
18505
+ events.WindowEvents = WindowEvents;
18506
+
18507
+ (function (exports) {
18508
+ /**
18509
+ * Top-level namespace for types referenced by the OpenFin API. Contains:
18510
+ *
18511
+ * * The type of the global `fin` entry point ({@link FinApi})
18512
+ * * Classes that act as static namespaces returned from the `fin` global (e.g. {@link ApplicationModule}, accessible via `fin.Application`)
18513
+ * * Instance classes that are returned from API calls (e.g. {@link Application}, accessible via `fin.Application.getCurrentSync()`)
18514
+ * * Parameter shapes for API methods (e.g. {@link ApplicationOptions}, used in `fin.Application.start()`)
18515
+ * * Event namespaces and payload union types (e.g. {@link ApplicationEvents} and {@link ApplicationEvent})
18516
+ *
18517
+ * @packageDocumentation
18518
+ */
18519
+ var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
18520
+ if (k2 === undefined) k2 = k;
18521
+ var desc = Object.getOwnPropertyDescriptor(m, k);
18522
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
18523
+ desc = { enumerable: true, get: function() { return m[k]; } };
18524
+ }
18525
+ Object.defineProperty(o, k2, desc);
18526
+ }) : (function(o, m, k, k2) {
18527
+ if (k2 === undefined) k2 = k;
18528
+ o[k2] = m[k];
18529
+ }));
18530
+ var __exportStar = (commonjsGlobal && commonjsGlobal.__exportStar) || function(m, exports) {
18531
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
18532
+ };
18533
+ Object.defineProperty(exports, "__esModule", { value: true });
18534
+ // Deprecated shim to preserve v30 namespace names
18535
+ __exportStar(events, exports);
18536
+ } (OpenFin$2));
18047
18537
 
18048
- Object.defineProperty(OpenFin$1, "__esModule", { value: true });
18538
+ var OpenFin = /*@__PURE__*/getDefaultExportFromCjs(OpenFin$2);
18049
18539
 
18050
- var OpenFin = /*#__PURE__*/_mergeNamespaces({
18540
+ var OpenFin$1 = /*#__PURE__*/_mergeNamespaces({
18051
18541
  __proto__: null,
18052
- default: OpenFin$1
18053
- }, [OpenFin$1]);
18542
+ default: OpenFin
18543
+ }, [OpenFin$2]);
18054
18544
 
18055
18545
  exports.connect = mainExports.connect;
18056
- exports.default = OpenFin;
18546
+ exports.default = OpenFin$1;
18057
18547
  exports.launch = mainExports.launch;