@openfin/node-adapter 33.76.38 → 33.77.2

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,13 +899,13 @@ 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
 
@@ -909,9 +915,13 @@ function requireFactory$3 () {
909
915
  if (hasRequiredFactory$3) return Factory$6;
910
916
  hasRequiredFactory$3 = 1;
911
917
  Object.defineProperty(Factory$6, "__esModule", { value: true });
912
- const base_1 = base;
918
+ Factory$6.ViewModule = void 0;
919
+ const base_1 = base$1;
913
920
  const validate_1 = validate;
914
921
  const index_1 = requireView();
922
+ /**
923
+ * Static namespace for OpenFin API methods that interact with the {@link View} class, available under `fin.View`.
924
+ */
915
925
  class ViewModule extends base_1.Base {
916
926
  /**
917
927
  * Creates a new View.
@@ -940,7 +950,6 @@ function requireFactory$3 () {
940
950
  * ```
941
951
  * Note that created views needs to navigate somewhere for them to actually render a website.
942
952
  * @experimental
943
- * @static
944
953
  */
945
954
  async create(options) {
946
955
  const { uuid } = this.wire.me;
@@ -960,7 +969,6 @@ function requireFactory$3 () {
960
969
  }
961
970
  /**
962
971
  * Asynchronously returns a View object that represents an existing view.
963
- * @param identity
964
972
  *
965
973
  * @example
966
974
  * ```js
@@ -969,7 +977,6 @@ function requireFactory$3 () {
969
977
  * .catch(err => console.log(err));
970
978
  * ```
971
979
  * @experimental
972
- * @static
973
980
  */
974
981
  async wrap(identity) {
975
982
  this.wire.sendAction('view-wrap');
@@ -981,7 +988,6 @@ function requireFactory$3 () {
981
988
  }
982
989
  /**
983
990
  * Synchronously returns a View object that represents an existing view.
984
- * @param identity
985
991
  *
986
992
  * @example
987
993
  * ```js
@@ -989,7 +995,6 @@ function requireFactory$3 () {
989
995
  * await view.hide();
990
996
  * ```
991
997
  * @experimental
992
- * @static
993
998
  */
994
999
  wrapSync(identity) {
995
1000
  this.wire.sendAction('view-wrap-sync').catch((e) => {
@@ -1012,7 +1017,6 @@ function requireFactory$3 () {
1012
1017
  *
1013
1018
  * ```
1014
1019
  * @experimental
1015
- * @static
1016
1020
  */
1017
1021
  getCurrent() {
1018
1022
  this.wire.sendAction('view-get-current').catch((e) => {
@@ -1034,7 +1038,6 @@ function requireFactory$3 () {
1034
1038
  *
1035
1039
  * ```
1036
1040
  * @experimental
1037
- * @static
1038
1041
  */
1039
1042
  getCurrentSync() {
1040
1043
  this.wire.sendAction('view-get-current-sync').catch((e) => {
@@ -1047,7 +1050,7 @@ function requireFactory$3 () {
1047
1050
  return this.wrapSync({ uuid, name });
1048
1051
  }
1049
1052
  }
1050
- Factory$6.default = ViewModule;
1053
+ Factory$6.ViewModule = ViewModule;
1051
1054
  return Factory$6;
1052
1055
  }
1053
1056
 
@@ -1877,8 +1880,12 @@ var main = {};
1877
1880
 
1878
1881
  Object.defineProperty(main, "__esModule", { value: true });
1879
1882
  main.WebContents = void 0;
1880
- const base_1$k = base;
1883
+ const base_1$k = base$1;
1881
1884
  class WebContents extends base_1$k.EmitterBase {
1885
+ /**
1886
+ * @param identity The identity of the {@link OpenFin.WebContentsEvents WebContents}.
1887
+ * @param entityType The type of the {@link OpenFin.WebContentsEvents WebContents}.
1888
+ */
1882
1889
  constructor(wire, identity, entityType) {
1883
1890
  super(wire, entityType, identity.uuid, identity.name);
1884
1891
  this.identity = identity;
@@ -1886,10 +1893,7 @@ class WebContents extends base_1$k.EmitterBase {
1886
1893
  }
1887
1894
  /**
1888
1895
  * Gets a base64 encoded image of all or part of the WebContents.
1889
- * @function capturePage
1890
1896
  * @param options Options for the capturePage call.
1891
- * @memberOf View
1892
- * @instance
1893
1897
  *
1894
1898
  * @example
1895
1899
  *
@@ -1934,6 +1938,11 @@ class WebContents extends base_1$k.EmitterBase {
1934
1938
  * }
1935
1939
  * console.log(await wnd.capturePage(options));
1936
1940
  * ```
1941
+ *
1942
+ * @remarks
1943
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
1944
+ * We do not expose an explicit superclass for this functionality, but it does have its own
1945
+ * {@link OpenFin.WebContentsEvents event namespace}.
1937
1946
  */
1938
1947
  capturePage(options) {
1939
1948
  return this.wire.sendAction('capture-page', { options, ...this.identity }).then(({ payload }) => payload.data);
@@ -1942,9 +1951,6 @@ class WebContents extends base_1$k.EmitterBase {
1942
1951
  * Executes Javascript on the WebContents, restricted to contents you own or contents owned by
1943
1952
  * applications you have created.
1944
1953
  * @param code JavaScript code to be executed on the view.
1945
- * @function executeJavaScript
1946
- * @memberOf View
1947
- * @instance
1948
1954
  *
1949
1955
  * @example
1950
1956
  * View:
@@ -1972,6 +1978,10 @@ class WebContents extends base_1$k.EmitterBase {
1972
1978
  *
1973
1979
  * executeJavaScript(`console.log('Hello, Openfin')`).then(() => console.log('Javascript excuted')).catch(err => console.log(err));
1974
1980
  * ```
1981
+ * @remarks
1982
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
1983
+ * We do not expose an explicit superclass for this functionality, but it does have its own
1984
+ * {@link OpenFin.WebContentsEvents event namespace}.
1975
1985
  */
1976
1986
  executeJavaScript(code) {
1977
1987
  return this.wire
@@ -1980,9 +1990,6 @@ class WebContents extends base_1$k.EmitterBase {
1980
1990
  }
1981
1991
  /**
1982
1992
  * Returns the zoom level of the WebContents.
1983
- * @function getZoomLevel
1984
- * @memberOf View
1985
- * @instance
1986
1993
  *
1987
1994
  * @example
1988
1995
  * View:
@@ -2014,6 +2021,10 @@ class WebContents extends base_1$k.EmitterBase {
2014
2021
  *
2015
2022
  * getZoomLevel().then(zoomLevel => console.log(zoomLevel)).catch(err => console.log(err));
2016
2023
  * ```
2024
+ * @remarks
2025
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2026
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2027
+ * {@link OpenFin.WebContentsEvents event namespace}.
2017
2028
  */
2018
2029
  getZoomLevel() {
2019
2030
  return this.wire.sendAction('get-zoom-level', this.identity).then(({ payload }) => payload.data);
@@ -2021,9 +2032,6 @@ class WebContents extends base_1$k.EmitterBase {
2021
2032
  /**
2022
2033
  * Sets the zoom level of the WebContents.
2023
2034
  * @param level The zoom level
2024
- * @function setZoomLevel
2025
- * @memberOf View
2026
- * @instance
2027
2035
  *
2028
2036
  * @example
2029
2037
  * View:
@@ -2055,6 +2063,10 @@ class WebContents extends base_1$k.EmitterBase {
2055
2063
  *
2056
2064
  * setZoomLevel(4).then(() => console.log('Setting a zoom level')).catch(err => console.log(err));
2057
2065
  * ```
2066
+ * @remarks
2067
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2068
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2069
+ * {@link OpenFin.WebContentsEvents event namespace}.
2058
2070
  */
2059
2071
  setZoomLevel(level) {
2060
2072
  return this.wire.sendAction('set-zoom-level', { ...this.identity, level }).then(() => undefined);
@@ -2062,12 +2074,9 @@ class WebContents extends base_1$k.EmitterBase {
2062
2074
  /**
2063
2075
  * Navigates the WebContents to a specified URL.
2064
2076
  *
2065
- * @remarks The url must contain the protocol prefix such as http:// or https://.
2077
+ * Note: The url must contain the protocol prefix such as http:// or https://.
2066
2078
  * @param url - The URL to navigate the WebContents to.
2067
2079
  *
2068
- * @function navigate
2069
- * @memberof View
2070
- * @instance
2071
2080
  * @example
2072
2081
  * View:
2073
2082
  * ```js
@@ -2095,15 +2104,16 @@ class WebContents extends base_1$k.EmitterBase {
2095
2104
  * navigate().then(() => console.log('Navigate to tutorial')).catch(err => console.log(err));
2096
2105
  * ```
2097
2106
  * @experimental
2107
+ * @remarks
2108
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2109
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2110
+ * {@link OpenFin.WebContentsEvents event namespace}.
2098
2111
  */
2099
2112
  navigate(url) {
2100
2113
  return this.wire.sendAction('navigate-window', { ...this.identity, url }).then(() => undefined);
2101
2114
  }
2102
2115
  /**
2103
2116
  * Navigates the WebContents back one page.
2104
- * @function navigateBack
2105
- * @memberOf View
2106
- * @instance
2107
2117
  *
2108
2118
  * @example
2109
2119
  * View:
@@ -2125,15 +2135,16 @@ class WebContents extends base_1$k.EmitterBase {
2125
2135
  * }
2126
2136
  * navigateBack().then(() => console.log('Navigated back')).catch(err => console.log(err));
2127
2137
  * ```
2138
+ * @remarks
2139
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2140
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2141
+ * {@link OpenFin.WebContentsEvents event namespace}.
2128
2142
  */
2129
2143
  navigateBack() {
2130
2144
  return this.wire.sendAction('navigate-window-back', { ...this.identity }).then(() => undefined);
2131
2145
  }
2132
2146
  /**
2133
2147
  * Navigates the WebContents forward one page.
2134
- * @function navigateForward
2135
- * @memberOf View
2136
- * @instance
2137
2148
  *
2138
2149
  * @example
2139
2150
  * View:
@@ -2157,15 +2168,16 @@ class WebContents extends base_1$k.EmitterBase {
2157
2168
  * }
2158
2169
  * navigateForward().then(() => console.log('Navigated forward')).catch(err => console.log(err));
2159
2170
  * ```
2171
+ * @remarks
2172
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2173
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2174
+ * {@link OpenFin.WebContentsEvents event namespace}.
2160
2175
  */
2161
2176
  async navigateForward() {
2162
2177
  await this.wire.sendAction('navigate-window-forward', { ...this.identity });
2163
2178
  }
2164
2179
  /**
2165
2180
  * Stops any current navigation the WebContents is performing.
2166
- * @function stopNavigation
2167
- * @memberOf View
2168
- * @instance
2169
2181
  *
2170
2182
  * @example
2171
2183
  * View:
@@ -2187,15 +2199,16 @@ class WebContents extends base_1$k.EmitterBase {
2187
2199
  * }
2188
2200
  * stopNavigation().then(() => console.log('you shall not navigate')).catch(err => console.log(err));
2189
2201
  * ```
2202
+ * @remarks
2203
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2204
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2205
+ * {@link OpenFin.WebContentsEvents event namespace}.
2190
2206
  */
2191
2207
  stopNavigation() {
2192
2208
  return this.wire.sendAction('stop-window-navigation', { ...this.identity }).then(() => undefined);
2193
2209
  }
2194
2210
  /**
2195
2211
  * Reloads the WebContents
2196
- * @function reload
2197
- * @memberOf View
2198
- * @instance
2199
2212
  *
2200
2213
  * @example
2201
2214
  * View:
@@ -2227,6 +2240,10 @@ class WebContents extends base_1$k.EmitterBase {
2227
2240
  * console.log('Reloaded window')
2228
2241
  * }).catch(err => console.log(err));
2229
2242
  * ```
2243
+ * @remarks
2244
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2245
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2246
+ * {@link OpenFin.WebContentsEvents event namespace}.
2230
2247
  */
2231
2248
  reload(ignoreCache = false) {
2232
2249
  return this.wire
@@ -2239,11 +2256,8 @@ class WebContents extends base_1$k.EmitterBase {
2239
2256
  /**
2240
2257
  * Prints the WebContents.
2241
2258
  * @param options Printer Options
2242
- * @function print
2243
- * @memberOf View
2244
- * @instance
2245
2259
  *
2246
- * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName
2260
+ * Note: When `silent` is set to `true`, the API will pick the system's default printer if deviceName
2247
2261
  * is empty and the default settings for printing.
2248
2262
  *
2249
2263
  * Use the CSS style `page-break-before: always;` to force print to a new page.
@@ -2256,6 +2270,10 @@ class WebContents extends base_1$k.EmitterBase {
2256
2270
  * console.log('print call has been sent to the system');
2257
2271
  * });
2258
2272
  * ```
2273
+ * @remarks
2274
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2275
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2276
+ * {@link OpenFin.WebContentsEvents event namespace}.
2259
2277
  */
2260
2278
  print(options = {}) {
2261
2279
  return this.wire.sendAction('print', { ...this.identity, options }).then(() => undefined);
@@ -2264,11 +2282,8 @@ class WebContents extends base_1$k.EmitterBase {
2264
2282
  * Find and highlight text on a page.
2265
2283
  * @param searchTerm Term to find in page
2266
2284
  * @param options Search options
2267
- * @function findInPage
2268
- * @memberOf View
2269
- * @instance
2270
2285
  *
2271
- * @remarks By default, each subsequent call will highlight the next text that matches the search term.
2286
+ * Note: By default, each subsequent call will highlight the next text that matches the search term.
2272
2287
  *
2273
2288
  * Returns a promise with the results for the request. By subscribing to the
2274
2289
  * found-in-page event, you can get the results of this call as well.
@@ -2303,6 +2318,10 @@ class WebContents extends base_1$k.EmitterBase {
2303
2318
  * console.log(result)
2304
2319
  * });
2305
2320
  * ```
2321
+ * @remarks
2322
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2323
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2324
+ * {@link OpenFin.WebContentsEvents event namespace}.
2306
2325
  */
2307
2326
  findInPage(searchTerm, options) {
2308
2327
  return this.wire
@@ -2346,6 +2365,10 @@ class WebContents extends base_1$k.EmitterBase {
2346
2365
  * console.log(results);
2347
2366
  * });
2348
2367
  * ```
2368
+ * @remarks
2369
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2370
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2371
+ * {@link OpenFin.WebContentsEvents event namespace}.
2349
2372
  */
2350
2373
  stopFindInPage(action) {
2351
2374
  return this.wire.sendAction('stop-find-in-page', { ...this.identity, action }).then(() => undefined);
@@ -2353,9 +2376,6 @@ class WebContents extends base_1$k.EmitterBase {
2353
2376
  /**
2354
2377
  * Returns an array with all system printers
2355
2378
  * @deprecated use System.getPrinters instead
2356
- * @function getPrinters
2357
- * @memberOf View
2358
- * @instance
2359
2379
  *
2360
2380
  * @example
2361
2381
  * View:
@@ -2391,6 +2411,10 @@ class WebContents extends base_1$k.EmitterBase {
2391
2411
  * console.log(err);
2392
2412
  * });
2393
2413
  * ```
2414
+ * @remarks
2415
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2416
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2417
+ * {@link OpenFin.WebContentsEvents event namespace}.
2394
2418
  */
2395
2419
  getPrinters() {
2396
2420
  return this.wire.sendAction('get-printers', { ...this.identity }).then(({ payload }) => payload.data);
@@ -2398,10 +2422,6 @@ class WebContents extends base_1$k.EmitterBase {
2398
2422
  /**
2399
2423
  * Gives focus to the WebContents.
2400
2424
  *
2401
- * @function focus
2402
- * @emits focused
2403
- * @memberOf Window
2404
- * @instance
2405
2425
  * @example
2406
2426
  * ```js
2407
2427
  * async function focusWindow() {
@@ -2417,15 +2437,16 @@ class WebContents extends base_1$k.EmitterBase {
2417
2437
  *
2418
2438
  * focusWindow().then(() => console.log('Window focused')).catch(err => console.log(err));
2419
2439
  * ```
2440
+ * @remarks
2441
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2442
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2443
+ * {@link OpenFin.WebContentsEvents event namespace}.
2420
2444
  */
2421
2445
  async focus({ emitSynthFocused } = { emitSynthFocused: true }) {
2422
2446
  await this.wire.sendAction('focus-window', { emitSynthFocused, ...this.identity });
2423
2447
  }
2424
2448
  /**
2425
2449
  * Shows the Chromium Developer Tools
2426
- * @function showDeveloperTools
2427
- * @memberOf View
2428
- * @instance
2429
2450
  *
2430
2451
  * @example
2431
2452
  * View:
@@ -2451,6 +2472,10 @@ class WebContents extends base_1$k.EmitterBase {
2451
2472
  * .then(() => console.log('Showing dev tools'))
2452
2473
  * .catch(err => console.error(err));
2453
2474
  * ```
2475
+ * @remarks
2476
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2477
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2478
+ * {@link OpenFin.WebContentsEvents event namespace}.
2454
2479
  */
2455
2480
  async showDeveloperTools() {
2456
2481
  // Note this hits the system action map in core state for legacy reasons.
@@ -2459,11 +2484,7 @@ class WebContents extends base_1$k.EmitterBase {
2459
2484
  /**
2460
2485
  * Retrieves the process information associated with a WebContents.
2461
2486
  *
2462
- * @remarks This includes any iframes associated with the WebContents
2463
- *
2464
- * @function getProcessInfo
2465
- * @memberOf View
2466
- * @instance
2487
+ * Note: This includes any iframes associated with the WebContents
2467
2488
  *
2468
2489
  * @example
2469
2490
  * View:
@@ -2477,6 +2498,10 @@ class WebContents extends base_1$k.EmitterBase {
2477
2498
  * const win = await fin.Window.getCurrent();
2478
2499
  * const processInfo = await win.getProcessInfo();
2479
2500
  * ```
2501
+ * @remarks
2502
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2503
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2504
+ * {@link OpenFin.WebContentsEvents event namespace}.
2480
2505
  */
2481
2506
  async getProcessInfo() {
2482
2507
  const { payload: { data } } = await this.wire.sendAction('get-process-info', this.identity);
@@ -2484,9 +2509,6 @@ class WebContents extends base_1$k.EmitterBase {
2484
2509
  }
2485
2510
  /**
2486
2511
  * Retrieves information on all Shared Workers.
2487
- * @function getSharedWorkers
2488
- * @memberOf View
2489
- * @instance
2490
2512
  *
2491
2513
  * @example
2492
2514
  * View:
@@ -2515,15 +2537,16 @@ class WebContents extends base_1$k.EmitterBase {
2515
2537
  * const win = await fin.Window.create(winOption);
2516
2538
  * const sharedWorkers = await win.getSharedWorkers();
2517
2539
  * ```
2540
+ * @remarks
2541
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2542
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2543
+ * {@link OpenFin.WebContentsEvents event namespace}.
2518
2544
  */
2519
2545
  async getSharedWorkers() {
2520
2546
  return this.wire.sendAction('get-shared-workers', this.identity).then(({ payload }) => payload.data);
2521
2547
  }
2522
2548
  /**
2523
2549
  * Opens the developer tools for the shared worker context.
2524
- * @function inspectSharedWorker
2525
- * @memberOf View
2526
- * @instance
2527
2550
  *
2528
2551
  * @example
2529
2552
  * View:
@@ -2552,6 +2575,10 @@ class WebContents extends base_1$k.EmitterBase {
2552
2575
  * const win = await fin.Window.create(winOption);
2553
2576
  * await win.inspectSharedWorker();
2554
2577
  * ```
2578
+ * @remarks
2579
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2580
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2581
+ * {@link OpenFin.WebContentsEvents event namespace}.
2555
2582
  */
2556
2583
  async inspectSharedWorker() {
2557
2584
  await this.wire.sendAction('inspect-shared-worker', { ...this.identity });
@@ -2559,9 +2586,6 @@ class WebContents extends base_1$k.EmitterBase {
2559
2586
  /**
2560
2587
  * Inspects the shared worker based on its ID.
2561
2588
  * @param workerId - The id of the shared worker.
2562
- * @function inspectSharedWorkerById
2563
- * @memberOf View
2564
- * @instance
2565
2589
  *
2566
2590
  * @example
2567
2591
  * View:
@@ -2592,15 +2616,16 @@ class WebContents extends base_1$k.EmitterBase {
2592
2616
  * const sharedWorkers = await win.getSharedWorkers();
2593
2617
  * await win.inspectSharedWorkerById(sharedWorkers[0].id);
2594
2618
  * ```
2619
+ * @remarks
2620
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2621
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2622
+ * {@link OpenFin.WebContentsEvents event namespace}.
2595
2623
  */
2596
2624
  async inspectSharedWorkerById(workerId) {
2597
2625
  await this.wire.sendAction('inspect-shared-worker-by-id', { ...this.identity, workerId });
2598
2626
  }
2599
2627
  /**
2600
2628
  * Opens the developer tools for the service worker context.
2601
- * @function inspectServiceWorker
2602
- * @memberOf View
2603
- * @instance
2604
2629
  *
2605
2630
  * @example
2606
2631
  * View:
@@ -2629,6 +2654,10 @@ class WebContents extends base_1$k.EmitterBase {
2629
2654
  * const win = await fin.Window.create(winOption);
2630
2655
  * await win.inspectServiceWorker();
2631
2656
  * ```
2657
+ * @remarks
2658
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2659
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2660
+ * {@link OpenFin.WebContentsEvents event namespace}.
2632
2661
  */
2633
2662
  async inspectServiceWorker() {
2634
2663
  await this.wire.sendAction('inspect-service-worker', { ...this.identity });
@@ -2636,7 +2665,7 @@ class WebContents extends base_1$k.EmitterBase {
2636
2665
  /**
2637
2666
  * Shows a popup window.
2638
2667
  *
2639
- * @remarks If this WebContents is a view and its attached window has a popup open, this will close it.
2668
+ * Note: If this WebContents is a view and its attached window has a popup open, this will close it.
2640
2669
  *
2641
2670
  * Shows a popup window. Including a `name` in `options` will attempt to show an existing window as a popup, if
2642
2671
  * that window doesn't exist or no `name` is included a window will be created. If the caller view or the caller
@@ -2644,7 +2673,7 @@ class WebContents extends base_1$k.EmitterBase {
2644
2673
  * open popup window before showing the new popup window. Also, if the caller view is destroyed or detached, the popup
2645
2674
  * will be dismissed.
2646
2675
  *
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.
2676
+ * 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
2677
  *
2649
2678
  * @example
2650
2679
  *
@@ -2839,11 +2868,10 @@ class WebContents extends base_1$k.EmitterBase {
2839
2868
  * onPopupReady: popupWindowCallback;
2840
2869
  * });
2841
2870
  * ```
2842
- * @function showPopupWindow
2843
- * @memberOf View
2844
- * @instance
2845
- * @param options
2846
- *
2871
+ * @remarks
2872
+ * `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
2873
+ * We do not expose an explicit superclass for this functionality, but it does have its own
2874
+ * {@link OpenFin.WebContentsEvents event namespace}.
2847
2875
  */
2848
2876
  async showPopupWindow(options) {
2849
2877
  this.wire.sendAction(`${this.entityType}-show-popup-window`, this.identity).catch(() => {
@@ -3128,7 +3156,6 @@ function requireInstance$2 () {
3128
3156
  * Attaches the current view to the given window identity.
3129
3157
  * Identity must be the identity of a window in the same application.
3130
3158
  * 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
3159
  *
3133
3160
  * @example
3134
3161
  * ```js
@@ -3257,7 +3284,6 @@ function requireInstance$2 () {
3257
3284
  };
3258
3285
  /**
3259
3286
  * Sets the bounds (top, left, width, height) of the view relative to its window.
3260
- * @param bounds {ViewBounds}
3261
3287
  *
3262
3288
  * @remarks View position is relative to the bounds of the window.
3263
3289
  * ({top: 0, left: 0} represents the top left corner of the window)
@@ -3422,7 +3448,6 @@ function requireInstance$2 () {
3422
3448
  };
3423
3449
  /**
3424
3450
  * Updates the view's options.
3425
- * @param options
3426
3451
  *
3427
3452
  * @example
3428
3453
  * ```js
@@ -3463,7 +3488,6 @@ function requireInstance$2 () {
3463
3488
  /**
3464
3489
  * Retrieves the window the view is currently attached to.
3465
3490
  *
3466
- * @experimental
3467
3491
  * @example
3468
3492
  * ```js
3469
3493
  * const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
@@ -3471,6 +3495,7 @@ function requireInstance$2 () {
3471
3495
  * .then(win => console.log('current window', win))
3472
3496
  * .catch(err => console.log(err));)
3473
3497
  * ```
3498
+ * @experimental
3474
3499
  */
3475
3500
  this.getCurrentWindow = async () => {
3476
3501
  const { payload: { data } } = await this.wire.sendAction('get-view-window', { ...this.identity });
@@ -3576,10 +3601,6 @@ function requireInstance$2 () {
3576
3601
  /**
3577
3602
  * Focuses the view
3578
3603
  *
3579
- * @function focus
3580
- * @memberof View
3581
- * @emits focused
3582
- * @instance
3583
3604
  * @example
3584
3605
  * ```js
3585
3606
  * const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
@@ -3602,7 +3623,7 @@ function requireInstance$2 () {
3602
3623
  var hasRequiredView;
3603
3624
 
3604
3625
  function requireView () {
3605
- if (hasRequiredView) return view;
3626
+ if (hasRequiredView) return view$1;
3606
3627
  hasRequiredView = 1;
3607
3628
  (function (exports) {
3608
3629
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
@@ -3621,19 +3642,20 @@ function requireView () {
3621
3642
  };
3622
3643
  Object.defineProperty(exports, "__esModule", { value: true });
3623
3644
  /**
3624
- * Entry point for the OpenFin View namespace.
3645
+ * Entry points for the OpenFin `View` API (`fin.View`).
3646
+ *
3647
+ * * {@link ViewModule} contains static members of the `View` API, accessible through `fin.View`.
3648
+ * * {@link View} describes an instance of an OpenFin View, e.g. as returned by `fin.View.getCurrent`.
3625
3649
  *
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.
3650
+ * 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),
3651
+ * both of these were documented on the same page.
3629
3652
  *
3630
3653
  * @packageDocumentation
3631
3654
  */
3632
- const Factory_1 = requireFactory$3();
3633
- exports.default = Factory_1.default;
3655
+ __exportStar(requireFactory$3(), exports);
3634
3656
  __exportStar(requireInstance$2(), exports);
3635
- } (view));
3636
- return view;
3657
+ } (view$1));
3658
+ return view$1;
3637
3659
  }
3638
3660
 
3639
3661
  var hasRequiredInstance$1;
@@ -3644,7 +3666,7 @@ function requireInstance$1 () {
3644
3666
  Object.defineProperty(Instance$6, "__esModule", { value: true });
3645
3667
  Instance$6.Application = void 0;
3646
3668
  /* eslint-disable import/prefer-default-export */
3647
- const base_1 = base;
3669
+ const base_1 = base$1;
3648
3670
  const window_1 = requireWindow();
3649
3671
  const view_1 = requireView();
3650
3672
  /**
@@ -4119,6 +4141,7 @@ function requireInstance$1 () {
4119
4141
  /**
4120
4142
  * Sets or removes a custom JumpList for the application. Only applicable in Windows OS.
4121
4143
  * If categories is null the previously set custom JumpList (if any) will be replaced by the standard JumpList for the app (managed by Windows).
4144
+ *
4122
4145
  * Note: If the "name" property is omitted it defaults to "tasks".
4123
4146
  * @param jumpListCategories An array of JumpList Categories to populate. If null, remove any existing JumpList configuration and set to Windows default.
4124
4147
  *
@@ -4419,6 +4442,7 @@ function requireInstance$1 () {
4419
4442
  }
4420
4443
  /**
4421
4444
  * Sets file auto download location. It's only allowed in the same application.
4445
+ *
4422
4446
  * Note: This method is restricted by default and must be enabled via
4423
4447
  * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
4424
4448
  * @param downloadLocation file auto download location
@@ -4444,6 +4468,7 @@ function requireInstance$1 () {
4444
4468
  }
4445
4469
  /**
4446
4470
  * 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.
4471
+ *
4447
4472
  * Note: This method is restricted by default and must be enabled via
4448
4473
  * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
4449
4474
  *
@@ -4470,13 +4495,16 @@ function requireFactory$2 () {
4470
4495
  if (hasRequiredFactory$2) return Factory$7;
4471
4496
  hasRequiredFactory$2 = 1;
4472
4497
  Object.defineProperty(Factory$7, "__esModule", { value: true });
4473
- const base_1 = base;
4498
+ Factory$7.ApplicationModule = void 0;
4499
+ const base_1 = base$1;
4474
4500
  const validate_1 = validate;
4475
4501
  const Instance_1 = requireInstance$1();
4502
+ /**
4503
+ * Static namespace for OpenFin API methods that interact with the {@link Application} class, available under `fin.Application`.
4504
+ */
4476
4505
  class ApplicationModule extends base_1.Base {
4477
4506
  /**
4478
4507
  * Asynchronously returns an Application object that represents an existing application.
4479
- * @param identity
4480
4508
  *
4481
4509
  * @example
4482
4510
  *
@@ -4487,7 +4515,6 @@ function requireFactory$2 () {
4487
4515
  * .catch(err => console.log(err));
4488
4516
  * ```
4489
4517
  *
4490
- * @static
4491
4518
  */
4492
4519
  async wrap(identity) {
4493
4520
  this.wire.sendAction('wrap-application').catch((e) => {
@@ -4501,7 +4528,6 @@ function requireFactory$2 () {
4501
4528
  }
4502
4529
  /**
4503
4530
  * Synchronously returns an Application object that represents an existing application.
4504
- * @param identity
4505
4531
  *
4506
4532
  * @example
4507
4533
  *
@@ -4510,7 +4536,6 @@ function requireFactory$2 () {
4510
4536
  * await app.close();
4511
4537
  * ```
4512
4538
  *
4513
- * @static
4514
4539
  */
4515
4540
  wrapSync(identity) {
4516
4541
  this.wire.sendAction('wrap-application-sync').catch((e) => {
@@ -4535,8 +4560,6 @@ function requireFactory$2 () {
4535
4560
  }
4536
4561
  /**
4537
4562
  * DEPRECATED method to create a new Application. Use {@link Application.ApplicationModule.start Application.start} instead.
4538
- * @param appOptions
4539
- *
4540
4563
  *
4541
4564
  * @example
4542
4565
  *
@@ -4565,7 +4588,6 @@ function requireFactory$2 () {
4565
4588
  }
4566
4589
  /**
4567
4590
  * Creates and starts a new Application.
4568
- * @param appOptions
4569
4591
  *
4570
4592
  * @example
4571
4593
  *
@@ -4581,8 +4603,6 @@ function requireFactory$2 () {
4581
4603
  * start().then(() => console.log('Application is running')).catch(err => console.log(err));
4582
4604
  * ```
4583
4605
  *
4584
- *
4585
- * @static
4586
4606
  */
4587
4607
  async start(appOptions) {
4588
4608
  this.wire.sendAction('start-application').catch((e) => {
@@ -4595,10 +4615,8 @@ function requireFactory$2 () {
4595
4615
  /**
4596
4616
  * Asynchronously starts a batch of applications given an array of application identifiers and manifestUrls.
4597
4617
  * Returns once the RVM is finished attempting to launch the applications.
4598
- * @param applications
4599
4618
  * @param opts - Parameters that the RVM will use.
4600
4619
  *
4601
- * @static
4602
4620
  * @example
4603
4621
  *
4604
4622
  * ```js
@@ -4650,8 +4668,6 @@ function requireFactory$2 () {
4650
4668
  * });
4651
4669
  *
4652
4670
  * ```
4653
- *
4654
- * @static
4655
4671
  */
4656
4672
  getCurrent() {
4657
4673
  this.wire.sendAction('get-current-application').catch((e) => {
@@ -4677,8 +4693,6 @@ function requireFactory$2 () {
4677
4693
  * });
4678
4694
  *
4679
4695
  * ```
4680
- *
4681
- * @static
4682
4696
  */
4683
4697
  getCurrentSync() {
4684
4698
  this.wire.sendAction('get-current-application-sync').catch((e) => {
@@ -4699,8 +4713,6 @@ function requireFactory$2 () {
4699
4713
  * // For a local manifest file:
4700
4714
  * fin.Application.startFromManifest('file:///C:/somefolder/app.json').then(app => console.log('App is running')).catch(err => console.log(err));
4701
4715
  * ```
4702
- *
4703
- * @static
4704
4716
  */
4705
4717
  async startFromManifest(manifestUrl, opts) {
4706
4718
  this.wire.sendAction('application-start-from-manifest').catch((e) => {
@@ -4745,14 +4757,14 @@ function requireFactory$2 () {
4745
4757
  });
4746
4758
  }
4747
4759
  }
4748
- Factory$7.default = ApplicationModule;
4760
+ Factory$7.ApplicationModule = ApplicationModule;
4749
4761
  return Factory$7;
4750
4762
  }
4751
4763
 
4752
4764
  var hasRequiredApplication;
4753
4765
 
4754
4766
  function requireApplication () {
4755
- if (hasRequiredApplication) return application;
4767
+ if (hasRequiredApplication) return application$1;
4756
4768
  hasRequiredApplication = 1;
4757
4769
  (function (exports) {
4758
4770
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
@@ -4771,19 +4783,20 @@ function requireApplication () {
4771
4783
  };
4772
4784
  Object.defineProperty(exports, "__esModule", { value: true });
4773
4785
  /**
4774
- * Entry point for the OpenFin Application namespace.
4786
+ * Entry points for the OpenFin `Application` API (`fin.Application`).
4787
+ *
4788
+ * * {@link ApplicationModule} contains static members of the `Application` API, accessible through `fin.Application`.
4789
+ * * {@link Application} describes an instance of an OpenFin Application, e.g. as returned by `fin.Application.getCurrent`.
4775
4790
  *
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.
4791
+ * 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),
4792
+ * both of these were documented on the same page.
4779
4793
  *
4780
4794
  * @packageDocumentation
4781
4795
  */
4782
- const Factory_1 = requireFactory$2();
4796
+ __exportStar(requireFactory$2(), exports);
4783
4797
  __exportStar(requireInstance$1(), exports);
4784
- exports.default = Factory_1.default;
4785
- } (application));
4786
- return application;
4798
+ } (application$1));
4799
+ return application$1;
4787
4800
  }
4788
4801
 
4789
4802
  var hasRequiredInstance;
@@ -4906,7 +4919,7 @@ function requireInstance () {
4906
4919
  * alphaMask turns anything of matching RGB value transparent.
4907
4920
  * <br>
4908
4921
  * Caveats:
4909
- * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
4922
+ * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
4910
4923
  * * User cannot click-through transparent regions
4911
4924
  * * Not supported on Mac
4912
4925
  * * Windows Aero must be enabled
@@ -5094,6 +5107,7 @@ function requireInstance () {
5094
5107
  * A flag that specifies how transparent the window will be.
5095
5108
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
5096
5109
  * This value is clamped between `0.0` and `1.0`.
5110
+ * * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
5097
5111
  *
5098
5112
  * @property {preloadScript[]} [preloadScripts] - _Inheritable_
5099
5113
  * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
@@ -5283,7 +5297,6 @@ function requireInstance () {
5283
5297
  */
5284
5298
  constructor(wire, identity) {
5285
5299
  super(wire, identity, 'window');
5286
- this.identity = identity;
5287
5300
  }
5288
5301
  /**
5289
5302
  * Adds a listener to the end of the listeners array for the specified event.
@@ -6114,11 +6127,12 @@ function requireInstance () {
6114
6127
  * moveBy(580, 300).then(() => console.log('Moved')).catch(err => console.log(err));
6115
6128
  * ```
6116
6129
  */
6117
- moveBy(deltaLeft, deltaTop) {
6130
+ moveBy(deltaLeft, deltaTop, positioningOptions) {
6118
6131
  return this.wire
6119
6132
  .sendAction('move-window-by', {
6120
6133
  deltaLeft,
6121
6134
  deltaTop,
6135
+ positioningOptions,
6122
6136
  ...this.identity
6123
6137
  })
6124
6138
  .then(() => undefined);
@@ -6148,11 +6162,12 @@ function requireInstance () {
6148
6162
  * moveTo(580, 300).then(() => console.log('Moved')).catch(err => console.log(err))
6149
6163
  * ```
6150
6164
  */
6151
- moveTo(left, top) {
6165
+ moveTo(left, top, positioningOptions) {
6152
6166
  return this.wire
6153
6167
  .sendAction('move-window', {
6154
6168
  left,
6155
6169
  top,
6170
+ positioningOptions,
6156
6171
  ...this.identity
6157
6172
  })
6158
6173
  .then(() => undefined);
@@ -6185,12 +6200,13 @@ function requireInstance () {
6185
6200
  * resizeBy(580, 300, 'top-right').then(() => console.log('Resized')).catch(err => console.log(err));
6186
6201
  * ```
6187
6202
  */
6188
- resizeBy(deltaWidth, deltaHeight, anchor) {
6203
+ resizeBy(deltaWidth, deltaHeight, anchor, positioningOptions) {
6189
6204
  return this.wire
6190
6205
  .sendAction('resize-window-by', {
6191
6206
  deltaWidth: Math.floor(deltaWidth),
6192
6207
  deltaHeight: Math.floor(deltaHeight),
6193
6208
  anchor,
6209
+ positioningOptions,
6194
6210
  ...this.identity
6195
6211
  })
6196
6212
  .then(() => undefined);
@@ -6223,12 +6239,13 @@ function requireInstance () {
6223
6239
  * resizeTo(580, 300, 'top-left').then(() => console.log('Resized')).catch(err => console.log(err));
6224
6240
  * ```
6225
6241
  */
6226
- resizeTo(width, height, anchor) {
6242
+ resizeTo(width, height, anchor, positioningOptions) {
6227
6243
  return this.wire
6228
6244
  .sendAction('resize-window', {
6229
6245
  width: Math.floor(width),
6230
6246
  height: Math.floor(height),
6231
6247
  anchor,
6248
+ positioningOptions,
6232
6249
  ...this.identity
6233
6250
  })
6234
6251
  .then(() => undefined);
@@ -6287,7 +6304,6 @@ function requireInstance () {
6287
6304
  }
6288
6305
  /**
6289
6306
  * Sets the window's size and position.
6290
- * @property { Bounds } bounds This is a * @type {string} name - name of the window.object that holds the propertys of
6291
6307
  *
6292
6308
  * @example
6293
6309
  * ```js
@@ -6314,8 +6330,10 @@ function requireInstance () {
6314
6330
  * }).then(() => console.log('Bounds set to window')).catch(err => console.log(err));
6315
6331
  * ```
6316
6332
  */
6317
- setBounds(bounds) {
6318
- return this.wire.sendAction('set-window-bounds', { ...bounds, ...this.identity }).then(() => undefined);
6333
+ setBounds(bounds, positioningOptions) {
6334
+ return this.wire
6335
+ .sendAction('set-window-bounds', { ...bounds, ...this.identity, positioningOptions })
6336
+ .then(() => undefined);
6319
6337
  }
6320
6338
  /**
6321
6339
  * Shows the window if it is hidden.
@@ -6457,7 +6475,10 @@ function requireInstance () {
6457
6475
  * Calling this method will close previously opened menus.
6458
6476
  * @experimental
6459
6477
  * @param options
6460
- *
6478
+ * @typeParam Data User-defined shape for data returned upon menu item click. Should be a
6479
+ * [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
6480
+ * of all possible data shapes for the entire menu, and the click handler should process
6481
+ * these with a "reducer" pattern.
6461
6482
  * @example
6462
6483
  * This could be used to show a drop down menu over views in a platform window:
6463
6484
  * ```js
@@ -6547,6 +6568,7 @@ function requireInstance () {
6547
6568
  return this.wire.sendAction('close-popup-menu', { ...this.identity }).then(() => undefined);
6548
6569
  }
6549
6570
  /**
6571
+ * @PORTED
6550
6572
  * @typedef {object} PopupOptions
6551
6573
  * @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.
6552
6574
  * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
@@ -6564,6 +6586,7 @@ function requireInstance () {
6564
6586
  * @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.
6565
6587
  */
6566
6588
  /**
6589
+ * @PORTED
6567
6590
  * @typedef {object} PopupResult
6568
6591
  * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
6569
6592
  * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
@@ -6653,13 +6676,16 @@ function requireFactory$1 () {
6653
6676
  if (hasRequiredFactory$1) return Factory$8;
6654
6677
  hasRequiredFactory$1 = 1;
6655
6678
  Object.defineProperty(Factory$8, "__esModule", { value: true });
6656
- const base_1 = base;
6679
+ Factory$8._WindowModule = void 0;
6680
+ const base_1 = base$1;
6657
6681
  const validate_1 = validate;
6658
6682
  const Instance_1 = requireInstance();
6683
+ /**
6684
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
6685
+ */
6659
6686
  class _WindowModule extends base_1.Base {
6660
6687
  /**
6661
6688
  * Asynchronously returns a Window object that represents an existing window.
6662
- * @param identity
6663
6689
  *
6664
6690
  * @example
6665
6691
  * ```js
@@ -6676,7 +6702,6 @@ function requireFactory$1 () {
6676
6702
  * .then(win => console.log('wrapped window'))
6677
6703
  * .catch(err => console.log(err));
6678
6704
  * ```
6679
- * @static
6680
6705
  */
6681
6706
  async wrap(identity) {
6682
6707
  this.wire.sendAction('window-wrap').catch((e) => {
@@ -6690,7 +6715,6 @@ function requireFactory$1 () {
6690
6715
  }
6691
6716
  /**
6692
6717
  * Synchronously returns a Window object that represents an existing window.
6693
- * @param identity
6694
6718
  *
6695
6719
  * @example
6696
6720
  * ```js
@@ -6706,7 +6730,6 @@ function requireFactory$1 () {
6706
6730
  * await createWin();
6707
6731
  * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
6708
6732
  * ```
6709
- * @static
6710
6733
  */
6711
6734
  wrapSync(identity) {
6712
6735
  this.wire.sendAction('window-wrap-sync').catch((e) => {
@@ -6738,7 +6761,6 @@ function requireFactory$1 () {
6738
6761
  *
6739
6762
  * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
6740
6763
  * ```
6741
- * @static
6742
6764
  */
6743
6765
  create(options) {
6744
6766
  this.wire.sendAction('create-window').catch((e) => {
@@ -6757,7 +6779,6 @@ function requireFactory$1 () {
6757
6779
  * .catch(err => console.log(err));
6758
6780
  *
6759
6781
  * ```
6760
- * @static
6761
6782
  */
6762
6783
  getCurrent() {
6763
6784
  this.wire.sendAction('get-current-window').catch((e) => {
@@ -6779,7 +6800,6 @@ function requireFactory$1 () {
6779
6800
  * console.log(info);
6780
6801
  *
6781
6802
  * ```
6782
- * @static
6783
6803
  */
6784
6804
  getCurrentSync() {
6785
6805
  this.wire.sendAction('get-current-window-sync').catch((e) => {
@@ -6792,14 +6812,14 @@ function requireFactory$1 () {
6792
6812
  return this.wrapSync({ uuid, name });
6793
6813
  }
6794
6814
  }
6795
- Factory$8.default = _WindowModule;
6815
+ Factory$8._WindowModule = _WindowModule;
6796
6816
  return Factory$8;
6797
6817
  }
6798
6818
 
6799
6819
  var hasRequiredWindow;
6800
6820
 
6801
6821
  function requireWindow () {
6802
- if (hasRequiredWindow) return window$1;
6822
+ if (hasRequiredWindow) return window$2;
6803
6823
  hasRequiredWindow = 1;
6804
6824
  (function (exports) {
6805
6825
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
@@ -6818,25 +6838,34 @@ function requireWindow () {
6818
6838
  };
6819
6839
  Object.defineProperty(exports, "__esModule", { value: true });
6820
6840
  /**
6821
- * Entry point for the OpenFin Window namespace.
6841
+ * Entry points for the OpenFin `Window` API (`fin.Window`).
6842
+ *
6843
+ * * {@link _WindowModule} contains static members of the `Window` API, accessible through `fin.Window`.
6844
+ * * {@link _Window} describes an instance of an OpenFin Window, e.g. as returned by `fin.Window.getCurrent`.
6822
6845
  *
6823
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "WindowModule" is used for
6824
- * the module containing static members of the `Window` namespace (available under `fin.Window`), while `Window` documents
6825
- * instances of the OpenFin `Window` class.
6846
+ * 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),
6847
+ * both of these were documented on the same page.
6826
6848
  *
6827
- * Because the `Window` name aliases a DOM entity, the documentation pipeline prefixes the name with an underscore.
6849
+ * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
6828
6850
  *
6829
6851
  * @packageDocumentation
6830
6852
  */
6831
- const Factory_1 = requireFactory$1();
6832
- exports.default = Factory_1.default;
6853
+ __exportStar(requireFactory$1(), exports);
6833
6854
  __exportStar(requireInstance(), exports);
6834
- } (window$1));
6835
- return window$1;
6855
+ } (window$2));
6856
+ return window$2;
6836
6857
  }
6837
6858
 
6838
- Object.defineProperty(system, "__esModule", { value: true });
6839
- const base_1$j = base;
6859
+ /**
6860
+ * Entry point for the OpenFin `System` API (`fin.System`).
6861
+ *
6862
+ * * {@link System} contains static members of the `System` API (available under `fin.System`)
6863
+ *
6864
+ * @packageDocumentation
6865
+ */
6866
+ Object.defineProperty(system$1, "__esModule", { value: true });
6867
+ system$1.System = void 0;
6868
+ const base_1$j = base$1;
6840
6869
  const transport_errors_1$2 = transportErrors;
6841
6870
  const window_1 = requireWindow();
6842
6871
  const events_1$6 = eventsExports;
@@ -7151,7 +7180,6 @@ class System extends base_1$j.EmitterBase {
7151
7180
  * ```js
7152
7181
  * fin.System.getUniqueUserId().then(id => console.log(id)).catch(err => console.log(err));
7153
7182
  * ```
7154
- * @static
7155
7183
  */
7156
7184
  getUniqueUserId() {
7157
7185
  return this.wire.sendAction('get-unique-user-id').then(({ payload }) => payload.data);
@@ -7842,7 +7870,8 @@ class System extends base_1$j.EmitterBase {
7842
7870
  }
7843
7871
  /**
7844
7872
  * Attempt to close an external process. The process will be terminated if it
7845
- * has not closed after the elapsed timeout in milliseconds.<br>
7873
+ * has not closed after the elapsed timeout in milliseconds.
7874
+ *
7846
7875
  * Note: This method is restricted by default and must be enabled via
7847
7876
  * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
7848
7877
  * @param options A object defined in the TerminateExternalRequestType interface
@@ -7878,7 +7907,8 @@ class System extends base_1$j.EmitterBase {
7878
7907
  return this.wire.sendAction('update-proxy', options).then(() => undefined);
7879
7908
  }
7880
7909
  /**
7881
- * Downloads the given application asset<br>
7910
+ * Downloads the given application asset.
7911
+ *
7882
7912
  * Note: This method is restricted by default and must be enabled via
7883
7913
  * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
7884
7914
  * @param appAsset App asset object
@@ -8422,7 +8452,6 @@ class System extends base_1$j.EmitterBase {
8422
8452
  * }
8423
8453
  * });
8424
8454
  * ```
8425
- * @static
8426
8455
  */
8427
8456
  async launchManifest(manifestUrl, opts = {}) {
8428
8457
  const { subscribe, ..._sendOpts } = opts;
@@ -8682,7 +8711,7 @@ class System extends base_1$j.EmitterBase {
8682
8711
  await this.wire.sendAction('set-domain-settings', { domainSettings, ...this.identity });
8683
8712
  }
8684
8713
  }
8685
- system.default = System;
8714
+ system$1.System = System;
8686
8715
 
8687
8716
  var interappbus = {};
8688
8717
 
@@ -9093,6 +9122,7 @@ var __classPrivateFieldSet$b = (commonjsGlobal && commonjsGlobal.__classPrivateF
9093
9122
  };
9094
9123
  var _ChannelClient_protectedObj, _ChannelClient_strategy, _ChannelClient_close;
9095
9124
  Object.defineProperty(client, "__esModule", { value: true });
9125
+ client.ChannelClient = void 0;
9096
9126
  const channel_1$1 = channel;
9097
9127
  const channelClientsByEndpointId = new Map();
9098
9128
  /**
@@ -9101,17 +9131,17 @@ const channelClientsByEndpointId = new Map();
9101
9131
  * provider via {@link ChannelClient#dispatch dispatch} and to listen for communication
9102
9132
  * from the provider by registering an action via {@link ChannelClient#register register}.
9103
9133
  *
9104
- * Synchronous Methods:
9134
+ * ### Synchronous Methods:
9105
9135
  * * {@link ChannelClient#onDisconnection onDisconnection(listener)}
9106
9136
  * * {@link ChannelClient#register register(action, listener)}
9107
9137
  * * {@link ChannelClient#remove remove(action)}
9108
9138
  *
9109
- * Asynchronous Methods:
9139
+ * ### Asynchronous Methods:
9110
9140
  * * {@link ChannelClient#disconnect disconnect()}
9111
9141
  * * {@link ChannelClient#dispatch dispatch(action, payload)}
9112
9142
  *
9113
- * Middleware:
9114
- * <br>Middleware functions receive the following arguments: (action, payload, senderId).
9143
+ * ### Middleware:
9144
+ * Middleware functions receive the following arguments: (action, payload, senderId).
9115
9145
  * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
9116
9146
  * unless it is undefined, in which case the original payload is used. Middleware can be used for side effects.
9117
9147
  * * {@link ChannelClient#setDefaultAction setDefaultAction(middleware)}
@@ -9258,7 +9288,7 @@ class ChannelClient extends channel_1$1.ChannelBase {
9258
9288
  });
9259
9289
  }
9260
9290
  }
9261
- client.default = ChannelClient;
9291
+ client.ChannelClient = ChannelClient;
9262
9292
  _ChannelClient_protectedObj = new WeakMap(), _ChannelClient_strategy = new WeakMap(), _ChannelClient_close = new WeakMap();
9263
9293
 
9264
9294
  var connectionManager = {};
@@ -9623,7 +9653,7 @@ var iceManager = {};
9623
9653
 
9624
9654
  Object.defineProperty(iceManager, "__esModule", { value: true });
9625
9655
  iceManager.RTCICEManager = void 0;
9626
- const base_1$i = base;
9656
+ const base_1$i = base$1;
9627
9657
  /*
9628
9658
  Singleton that facilitates Offer and Answer exchange required for establishing RTC connections.
9629
9659
  */
@@ -9801,20 +9831,20 @@ const runtimeVersioning_1 = runtimeVersioning;
9801
9831
  * a single client via {@link ChannelProvider#dispatch dispatch} or all clients via {@link ChannelProvider#publish publish}
9802
9832
  * and to listen for communication from clients by registering an action via {@link ChannelProvider#register register}.
9803
9833
  *
9804
- * Synchronous Methods:
9834
+ * ### Synchronous Methods:
9805
9835
  * * {@link ChannelProvider#onConnection onConnection(listener)}
9806
9836
  * * {@link ChannelProvider#onDisconnection onDisconnection(listener)}
9807
9837
  * * {@link ChannelProvider#publish publish(action, payload)}
9808
9838
  * * {@link ChannelProvider#register register(action, listener)}
9809
9839
  * * {@link ChannelProvider#remove remove(action)}
9810
9840
  *
9811
- * Asynchronous Methods:
9841
+ * ### Asynchronous Methods:
9812
9842
  * * {@link ChannelProvider#destroy destroy()}
9813
9843
  * * {@link ChannelProvider#dispatch dispatch(to, action, payload)}
9814
9844
  * * {@link ChannelProvider#getAllClientInfo getAllClientInfo()}
9815
9845
  *
9816
- * Middleware:
9817
- * <br>Middleware functions receive the following arguments: (action, payload, senderId).
9846
+ * ### Middleware:
9847
+ * Middleware functions receive the following arguments: (action, payload, senderId).
9818
9848
  * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
9819
9849
  * unless it is undefined, in which case the most recently defined payload is used. Middleware can be used for side effects.
9820
9850
  * * {@link ChannelProvider#setDefaultAction setDefaultAction(middleware)}
@@ -10123,7 +10153,7 @@ var messageReceiver = {};
10123
10153
  Object.defineProperty(messageReceiver, "__esModule", { value: true });
10124
10154
  messageReceiver.MessageReceiver = void 0;
10125
10155
  const client_1$1 = client;
10126
- const base_1$h = base;
10156
+ const base_1$h = base$1;
10127
10157
  /*
10128
10158
  This is a singleton (per fin object) tasked with routing messages coming off the ipc to the correct endpoint.
10129
10159
  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.
@@ -10183,7 +10213,7 @@ class MessageReceiver extends base_1$h.Base {
10183
10213
  const endpointIdFromPreviousConnection = this.latestEndpointIdByChannelId.get(channelId);
10184
10214
  if (endpointIdFromPreviousConnection) {
10185
10215
  // Not convinced by this way of doing things, but pushing up for now.
10186
- client_1$1.default.closeChannelByEndpointId(endpointIdFromPreviousConnection);
10216
+ client_1$1.ChannelClient.closeChannelByEndpointId(endpointIdFromPreviousConnection);
10187
10217
  // eslint-disable-next-line no-console
10188
10218
  console.warn('You have created a second connection to an older provider. First connection has been removed from the clientMap');
10189
10219
  // eslint-disable-next-line no-console
@@ -10313,7 +10343,7 @@ var _ConnectionManager_messageReceiver, _ConnectionManager_rtcConnectionManager;
10313
10343
  Object.defineProperty(connectionManager, "__esModule", { value: true });
10314
10344
  connectionManager.ConnectionManager = void 0;
10315
10345
  const exhaustive_1 = exhaustive;
10316
- const base_1$g = base;
10346
+ const base_1$g = base$1;
10317
10347
  const strategy_1 = strategy$2;
10318
10348
  const strategy_2 = strategy$1;
10319
10349
  const ice_manager_1 = iceManager;
@@ -10544,6 +10574,15 @@ class ConnectionManager extends base_1$g.Base {
10544
10574
  connectionManager.ConnectionManager = ConnectionManager;
10545
10575
  _ConnectionManager_messageReceiver = new WeakMap(), _ConnectionManager_rtcConnectionManager = new WeakMap();
10546
10576
 
10577
+ /**
10578
+ * Entry points for the `Channel` subset of the `InterApplicationBus` API (`fin.InterApplicationBus.Channel`).
10579
+ *
10580
+ * * {@link Channel} contains static members of the `Channel` API, accessible through `fin.InterApplicationBus.Channel`.
10581
+ * * {@link OpenFin.ChannelClient} describes a client of a channel, e.g. as returned by `fin.InterApplicationBus.Channel.connect`.
10582
+ * * {@link OpenFin.ChannelProvider} describes a provider of a channel, e.g. as returned by `fin.InterApplicationBus.Channel.create`.
10583
+ *
10584
+ * @packageDocumentation
10585
+ */
10547
10586
  var __classPrivateFieldSet$5 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
10548
10587
  if (kind === "m") throw new TypeError("Private method is not writable");
10549
10588
  if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
@@ -10561,7 +10600,7 @@ channel$1.Channel = void 0;
10561
10600
  /* eslint-disable no-console */
10562
10601
  const events_1$5 = eventsExports;
10563
10602
  const lazy_1$1 = lazy;
10564
- const base_1$f = base;
10603
+ const base_1$f = base$1;
10565
10604
  const client_1 = client;
10566
10605
  const connection_manager_1 = connectionManager;
10567
10606
  const provider_1 = provider;
@@ -10604,7 +10643,7 @@ class Channel extends base_1$f.EmitterBase {
10604
10643
  _Channel_readyToConnect.set(this, new lazy_1$1.AsyncRetryableLazy(async () => {
10605
10644
  await Promise.all([
10606
10645
  this.on('disconnected', (eventPayload) => {
10607
- client_1.default.handleProviderDisconnect(eventPayload);
10646
+ client_1.ChannelClient.handleProviderDisconnect(eventPayload);
10608
10647
  }),
10609
10648
  this.on('connected', (...args) => {
10610
10649
  __classPrivateFieldGet$7(this, _Channel_internalEmitter, "f").emit('connected', ...args);
@@ -10795,7 +10834,7 @@ class Channel extends base_1$f.EmitterBase {
10795
10834
  };
10796
10835
  const routingInfo = await this.safeConnect(channelName, opts.wait, connectPayload);
10797
10836
  const strategy = await __classPrivateFieldGet$7(this, _Channel_connectionManager, "f").createClientStrategy(rtcPacket, routingInfo);
10798
- const channel = new client_1.default(routingInfo, this.wire, strategy);
10837
+ const channel = new client_1.ChannelClient(routingInfo, this.wire, strategy);
10799
10838
  // It is the client's responsibility to handle endpoint disconnection to the provider.
10800
10839
  // If the endpoint dies, the client will force a disconnection through the core.
10801
10840
  // The provider does not care about endpoint disconnection.
@@ -10807,7 +10846,7 @@ class Channel extends base_1$f.EmitterBase {
10807
10846
  console.warn(`Something went wrong during disconnect for client with uuid: ${routingInfo.uuid} / name: ${routingInfo.name} / endpointId: ${routingInfo.endpointId}.`);
10808
10847
  }
10809
10848
  finally {
10810
- client_1.default.handleProviderDisconnect(routingInfo);
10849
+ client_1.ChannelClient.handleProviderDisconnect(routingInfo);
10811
10850
  }
10812
10851
  });
10813
10852
  return channel;
@@ -10878,9 +10917,16 @@ channel$1.Channel = Channel;
10878
10917
  _Channel_connectionManager = new WeakMap(), _Channel_internalEmitter = new WeakMap(), _Channel_readyToConnect = new WeakMap();
10879
10918
 
10880
10919
  Object.defineProperty(interappbus, "__esModule", { value: true });
10881
- interappbus.InterAppPayload = void 0;
10920
+ interappbus.InterAppPayload = interappbus.InterApplicationBus = void 0;
10921
+ /**
10922
+ * Entry point for the OpenFin `InterApplicationBus` API (`fin.InterApplicationBus`).
10923
+ *
10924
+ * * {@link InterApplicationBus} contains static members of the `InterApplicationBus` API, accessible through `fin.InterApplicationBus`.
10925
+ *
10926
+ * @packageDocumentation
10927
+ */
10882
10928
  const events_1$4 = eventsExports;
10883
- const base_1$e = base;
10929
+ const base_1$e = base$1;
10884
10930
  const ref_counter_1 = refCounter;
10885
10931
  const index_1$2 = channel$1;
10886
10932
  const validate_1$3 = validate;
@@ -11070,7 +11116,7 @@ class InterApplicationBus extends base_1$e.Base {
11070
11116
  return true;
11071
11117
  }
11072
11118
  }
11073
- interappbus.default = InterApplicationBus;
11119
+ interappbus.InterApplicationBus = InterApplicationBus;
11074
11120
  /**
11075
11121
  * @internal
11076
11122
  */
@@ -11087,8 +11133,16 @@ function createKey(...toHash) {
11087
11133
 
11088
11134
  var clipboard = {};
11089
11135
 
11136
+ /**
11137
+ * Entry point for the OpenFin `Clipboard` API (`fin.Clipboard`).
11138
+ *
11139
+ * * {@link Clipboard} contains static members of the `Clipboard` API, accessible through `fin.Clipboard`.
11140
+ *
11141
+ * @packageDocumentation
11142
+ */
11090
11143
  Object.defineProperty(clipboard, "__esModule", { value: true });
11091
- const base_1$d = base;
11144
+ clipboard.Clipboard = void 0;
11145
+ const base_1$d = base$1;
11092
11146
  /**
11093
11147
  * @PORTED
11094
11148
  * WriteRequestType interface
@@ -11285,9 +11339,9 @@ class Clipboard extends base_1$d.Base {
11285
11339
  return payload.data;
11286
11340
  }
11287
11341
  }
11288
- clipboard.default = Clipboard;
11342
+ clipboard.Clipboard = Clipboard;
11289
11343
 
11290
- var externalApplication = {};
11344
+ var externalApplication$1 = {};
11291
11345
 
11292
11346
  var Factory$5 = {};
11293
11347
 
@@ -11296,11 +11350,11 @@ var Instance$4 = {};
11296
11350
  Object.defineProperty(Instance$4, "__esModule", { value: true });
11297
11351
  Instance$4.ExternalApplication = void 0;
11298
11352
  /* eslint-disable import/prefer-default-export */
11299
- const base_1$c = base;
11353
+ const base_1$c = base$1;
11300
11354
  /**
11301
11355
  * An ExternalApplication object representing native language adapter connections to the runtime. Allows
11302
11356
  * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
11303
- * Discovery of connections is provided by <a href="tutorial-System.getAllExternalApplications.html">getAllExternalApplications.</a>
11357
+ * Discovery of connections is provided by {@link System.System.getAllExternalApplications getAllExternalApplications}.</a>
11304
11358
  *
11305
11359
  * Processes that can be wrapped as `ExternalApplication`s include the following:
11306
11360
  * - Processes which have connected to an OpenFin runtime via an adapter
@@ -11411,8 +11465,12 @@ class ExternalApplication extends base_1$c.EmitterBase {
11411
11465
  Instance$4.ExternalApplication = ExternalApplication;
11412
11466
 
11413
11467
  Object.defineProperty(Factory$5, "__esModule", { value: true });
11414
- const base_1$b = base;
11468
+ Factory$5.ExternalApplicationModule = void 0;
11469
+ const base_1$b = base$1;
11415
11470
  const Instance_1$4 = Instance$4;
11471
+ /**
11472
+ * Static namespace for OpenFin API methods that interact with the {@link ExternalApplication} class, available under `fin.ExternalApplication`.
11473
+ */
11416
11474
  class ExternalApplicationModule extends base_1$b.Base {
11417
11475
  /**
11418
11476
  * Asynchronously returns an External Application object that represents an external application.
@@ -11426,7 +11484,6 @@ class ExternalApplicationModule extends base_1$b.Base {
11426
11484
  * .then(extApp => console.log('wrapped external application'))
11427
11485
  * .catch(err => console.log(err));
11428
11486
  * ```
11429
- * @static
11430
11487
  */
11431
11488
  wrap(uuid) {
11432
11489
  this.wire.sendAction('external-application-wrap').catch((e) => {
@@ -11446,7 +11503,6 @@ class ExternalApplicationModule extends base_1$b.Base {
11446
11503
  * const info = await extApp.getInfo();
11447
11504
  * console.log(info);
11448
11505
  * ```
11449
- * @static
11450
11506
  */
11451
11507
  wrapSync(uuid) {
11452
11508
  this.wire.sendAction('external-application-wrap-sync').catch((e) => {
@@ -11455,18 +11511,9 @@ class ExternalApplicationModule extends base_1$b.Base {
11455
11511
  return new Instance_1$4.ExternalApplication(this.wire, { uuid });
11456
11512
  }
11457
11513
  }
11458
- Factory$5.default = ExternalApplicationModule;
11514
+ Factory$5.ExternalApplicationModule = ExternalApplicationModule;
11459
11515
 
11460
11516
  (function (exports) {
11461
- /**
11462
- * Entry point for the OpenFin ExternalApplication namespace.
11463
- *
11464
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "ExternalApplicationModule" is used for
11465
- * the module containing static members of the `ExternalApplication` namespace (available under `fin.ExternalApplication`), while `ExternalApplication`
11466
- * documents instances of the OpenFin `ExternalApplication` class.
11467
- *
11468
- * @packageDocumentation
11469
- */
11470
11517
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
11471
11518
  if (k2 === undefined) k2 = k;
11472
11519
  var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -11482,12 +11529,22 @@ Factory$5.default = ExternalApplicationModule;
11482
11529
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
11483
11530
  };
11484
11531
  Object.defineProperty(exports, "__esModule", { value: true });
11485
- const Factory_1 = Factory$5;
11486
- exports.default = Factory_1.default;
11532
+ /**
11533
+ * Entry points for the OpenFin `ExternalApplication` API (`fin.ExternalApplication`).
11534
+ *
11535
+ * * {@link ExternalApplicationModule} contains static members of the `ExternalApplication` type, accessible through `fin.ExternalApplication`.
11536
+ * * {@link ExternalApplication} describes an instance of an OpenFin ExternalApplication, e.g. as returned by `fin.ExternalApplication.getCurrent`.
11537
+ *
11538
+ * 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),
11539
+ * both of these were documented on the same page.
11540
+ *
11541
+ * @packageDocumentation
11542
+ */
11543
+ __exportStar(Factory$5, exports);
11487
11544
  __exportStar(Instance$4, exports);
11488
- } (externalApplication));
11545
+ } (externalApplication$1));
11489
11546
 
11490
- var frame = {};
11547
+ var frame$1 = {};
11491
11548
 
11492
11549
  var Factory$4 = {};
11493
11550
 
@@ -11496,7 +11553,7 @@ var Instance$3 = {};
11496
11553
  Object.defineProperty(Instance$3, "__esModule", { value: true });
11497
11554
  Instance$3._Frame = void 0;
11498
11555
  /* eslint-disable import/prefer-default-export */
11499
- const base_1$a = base;
11556
+ const base_1$a = base$1;
11500
11557
  /**
11501
11558
  * An iframe represents an embedded HTML page within a parent HTML page. Because this embedded page
11502
11559
  * has its own DOM and global JS context (which may or may not be linked to that of the parent depending
@@ -11637,9 +11694,13 @@ class _Frame extends base_1$a.EmitterBase {
11637
11694
  Instance$3._Frame = _Frame;
11638
11695
 
11639
11696
  Object.defineProperty(Factory$4, "__esModule", { value: true });
11640
- const base_1$9 = base;
11697
+ Factory$4._FrameModule = void 0;
11698
+ const base_1$9 = base$1;
11641
11699
  const validate_1$2 = validate;
11642
11700
  const Instance_1$3 = Instance$3;
11701
+ /**
11702
+ * Static namespace for OpenFin API methods that interact with the {@link _Frame} class, available under `fin.Frame`.
11703
+ */
11643
11704
  class _FrameModule extends base_1$9.Base {
11644
11705
  /**
11645
11706
  * Asynchronously returns a reference to the specified frame. The frame does not have to exist
@@ -11651,7 +11712,6 @@ class _FrameModule extends base_1$9.Base {
11651
11712
  * .then(frm => console.log('wrapped frame'))
11652
11713
  * .catch(err => console.log(err));
11653
11714
  * ```
11654
- * @static
11655
11715
  */
11656
11716
  async wrap(identity) {
11657
11717
  this.wire.sendAction('frame-wrap').catch((e) => {
@@ -11673,7 +11733,6 @@ class _FrameModule extends base_1$9.Base {
11673
11733
  * const info = await frm.getInfo();
11674
11734
  * console.log(info);
11675
11735
  * ```
11676
- * @static
11677
11736
  */
11678
11737
  wrapSync(identity) {
11679
11738
  this.wire.sendAction('frame-wrap-sync').catch((e) => {
@@ -11694,7 +11753,6 @@ class _FrameModule extends base_1$9.Base {
11694
11753
  * .then(frm => console.log('current frame'))
11695
11754
  * .catch(err => console.log(err));
11696
11755
  * ```
11697
- * @static
11698
11756
  */
11699
11757
  getCurrent() {
11700
11758
  this.wire.sendAction('frame-get-current').catch((e) => {
@@ -11711,7 +11769,6 @@ class _FrameModule extends base_1$9.Base {
11711
11769
  * const info = await frm.getInfo();
11712
11770
  * console.log(info);
11713
11771
  * ```
11714
- * @static
11715
11772
  */
11716
11773
  getCurrentSync() {
11717
11774
  this.wire.sendAction('frame-get-current-sync').catch((e) => {
@@ -11720,17 +11777,19 @@ class _FrameModule extends base_1$9.Base {
11720
11777
  return new Instance_1$3._Frame(this.wire, this.wire.environment.getCurrentEntityIdentity());
11721
11778
  }
11722
11779
  }
11723
- Factory$4.default = _FrameModule;
11780
+ Factory$4._FrameModule = _FrameModule;
11724
11781
 
11725
11782
  (function (exports) {
11726
11783
  /**
11727
- * Entry point for the OpenFin Frame namespace.
11784
+ * Entry points for the OpenFin `Frame` API (`fin.Frame`).
11728
11785
  *
11729
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "FrameModule" is used for
11730
- * the module containing static members of the `Frame` namespace (available under `fin.Frame`), while `Frame` documents
11731
- * instances of the OpenFin `Frame` class.
11786
+ * * {@link _FrameModule} contains static members of the `Frame` API, accessible through `fin.Frame`.
11787
+ * * {@link _Frame} describes an instance of an OpenFin Frame, e.g. as returned by `fin.Frame.getCurrent`.
11732
11788
  *
11733
- * Because the `Frame` name aliases a DOM entity, the documentation pipeline prefixes the name with an underscore.
11789
+ * 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),
11790
+ * both of these were documented on the same page.
11791
+ *
11792
+ * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
11734
11793
  *
11735
11794
  * @packageDocumentation
11736
11795
  */
@@ -11749,15 +11808,15 @@ Factory$4.default = _FrameModule;
11749
11808
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
11750
11809
  };
11751
11810
  Object.defineProperty(exports, "__esModule", { value: true });
11752
- const Factory_1 = Factory$4;
11753
- exports.default = Factory_1.default;
11811
+ __exportStar(Factory$4, exports);
11754
11812
  __exportStar(Instance$3, exports);
11755
- } (frame));
11813
+ } (frame$1));
11756
11814
 
11757
- var globalHotkey = {};
11815
+ var globalHotkey$1 = {};
11758
11816
 
11759
- Object.defineProperty(globalHotkey, "__esModule", { value: true });
11760
- const base_1$8 = base;
11817
+ Object.defineProperty(globalHotkey$1, "__esModule", { value: true });
11818
+ globalHotkey$1.GlobalHotkey = void 0;
11819
+ const base_1$8 = base$1;
11761
11820
  /**
11762
11821
  * The GlobalHotkey module can register/unregister a global hotkeys.
11763
11822
  *
@@ -11886,9 +11945,9 @@ class GlobalHotkey extends base_1$8.EmitterBase {
11886
11945
  return data;
11887
11946
  }
11888
11947
  }
11889
- globalHotkey.default = GlobalHotkey;
11948
+ globalHotkey$1.GlobalHotkey = GlobalHotkey;
11890
11949
 
11891
- var platform = {};
11950
+ var platform$1 = {};
11892
11951
 
11893
11952
  var Factory$3 = {};
11894
11953
 
@@ -11903,16 +11962,14 @@ var _Platform_connectToProvider;
11903
11962
  Object.defineProperty(Instance$2, "__esModule", { value: true });
11904
11963
  Instance$2.Platform = void 0;
11905
11964
  /* eslint-disable import/prefer-default-export, no-undef */
11906
- const base_1$7 = base;
11965
+ const base_1$7 = base$1;
11907
11966
  const validate_1$1 = validate;
11908
11967
  // Reuse clients to avoid overwriting already-registered client in provider
11909
11968
  const clientMap = new Map();
11910
11969
  /** Manages the life cycle of windows and views in the application.
11911
11970
  *
11912
- * Enables taking snapshots of itself and applyi
11913
- * ng them to restore a previous configuration
11971
+ * Enables taking snapshots of itself and applying them to restore a previous configuration
11914
11972
  * as well as listen to {@link OpenFin.PlatformEvents platform events}.
11915
- *
11916
11973
  */
11917
11974
  class Platform extends base_1$7.EmitterBase {
11918
11975
  /**
@@ -12271,12 +12328,11 @@ class Platform extends base_1$7.EmitterBase {
12271
12328
  });
12272
12329
  }
12273
12330
  /**
12274
- * ***DEPRECATED - please use Platform.createView.***
12331
+ * ***DEPRECATED - please use {@link Platform.createView Platform.createView}.***
12275
12332
  * Reparents a specified view in a new target window.
12276
12333
  * @param viewIdentity View identity
12277
12334
  * @param target new owner window identity
12278
12335
  *
12279
- * @tutorial Platform.createView
12280
12336
  */
12281
12337
  async reparentView(viewIdentity, target) {
12282
12338
  var _a;
@@ -12737,7 +12793,7 @@ var Instance$1 = {};
12737
12793
  var commonUtils = {};
12738
12794
 
12739
12795
  Object.defineProperty(commonUtils, "__esModule", { value: true });
12740
- commonUtils.isValidPresetType = void 0;
12796
+ commonUtils.overrideFromComposables = commonUtils.isValidPresetType = void 0;
12741
12797
  function isValidPresetType(type) {
12742
12798
  switch (type) {
12743
12799
  case 'columns':
@@ -12750,6 +12806,10 @@ function isValidPresetType(type) {
12750
12806
  }
12751
12807
  }
12752
12808
  commonUtils.isValidPresetType = isValidPresetType;
12809
+ function overrideFromComposables(...overrides) {
12810
+ return (base) => overrides.reduceRight((p, c) => (b) => c(p(b)), (x) => x)(base);
12811
+ }
12812
+ commonUtils.overrideFromComposables = overrideFromComposables;
12753
12813
  commonUtils.default = { isValidPresetType };
12754
12814
 
12755
12815
  var __classPrivateFieldGet$5 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldGet) || function (receiver, state, kind, f) {
@@ -12762,10 +12822,142 @@ Object.defineProperty(Instance$1, "__esModule", { value: true });
12762
12822
  Instance$1.Layout = void 0;
12763
12823
  const lazy_1 = lazy;
12764
12824
  const validate_1 = validate;
12765
- const base_1$6 = base;
12825
+ const base_1$6 = base$1;
12766
12826
  const common_utils_1 = commonUtils;
12767
12827
  const layout_entities_1 = layoutEntities;
12768
12828
  const layout_constants_1 = layout_constants;
12829
+ /**
12830
+ *
12831
+ * Layouts give app providers the ability to embed multiple views in a single window. The Layout namespace
12832
+ * enables the initialization and manipulation of a window's Layout. A Layout will
12833
+ * emit events locally on the DOM element representing the layout-container.
12834
+ *
12835
+ *
12836
+ * ### Layout.DOMEvents
12837
+ *
12838
+ * When a Layout is created, it emits events onto the DOM element representing the Layout container.
12839
+ * This Layout container is the DOM element referenced by containerId in {@link Layout.LayoutModule#init Layout.init}.
12840
+ * 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).
12841
+ * The events are emitted synchronously and only in the process where the Layout exists.
12842
+ * Any values returned by the called listeners are ignored and will be discarded.
12843
+ * If the target DOM element is destroyed, any events that have been set up on that element will be destroyed.
12844
+ *
12845
+ * @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
12846
+ *
12847
+ * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
12848
+ * Adds a listener to the end of the listeners array for the specified event.
12849
+ * @example
12850
+ * ```js
12851
+ * const myLayoutContainer = document.getElementById('layout-container');
12852
+ *
12853
+ * myLayoutContainer.addEventListener('tab-created', function(event) {
12854
+ * const { tabSelector } = event.detail;
12855
+ * const tabElement = document.getElementById(tabSelector);
12856
+ * const existingColor = tabElement.style.backgroundColor;
12857
+ * tabElement.style.backgroundColor = "red";
12858
+ * setTimeout(() => {
12859
+ * tabElement.style.backgroundColor = existingColor;
12860
+ * }, 2000);
12861
+ * });
12862
+ * ```
12863
+ *
12864
+ * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
12865
+ * Adds a listener to the end of the listeners array for the specified event.
12866
+ * @example
12867
+ * ```js
12868
+ * const myLayoutContainer = document.getElementById('layout-container');
12869
+ *
12870
+ * const listener = function(event) {
12871
+ * console.log(event.detail);
12872
+ * console.log('container-created event fired once, removing listener');
12873
+ * myLayoutContainer.removeEventListener('container-created', listener);
12874
+ * };
12875
+ *
12876
+ * myLayoutContainer.addEventListener('container-created', listener);
12877
+ * ```
12878
+ *
12879
+ * ### Supported event types are:
12880
+ *
12881
+ * * tab-created
12882
+ * * container-created
12883
+ * * layout-state-changed
12884
+ * * tab-closed
12885
+ * * tab-dropped
12886
+ *
12887
+ * ### Layout DOM Node Events
12888
+ *
12889
+ * #### tab-created
12890
+ * 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.
12891
+ * ```js
12892
+ * // The response has the following shape in event.detail:
12893
+ * {
12894
+ * containerSelector: "container-component_A",
12895
+ * name: "component_A",
12896
+ * tabSelector: "tab-component_A",
12897
+ * topic: "openfin-DOM-event",
12898
+ * type: "tab-created",
12899
+ * uuid: "OpenFin POC"
12900
+ * }
12901
+ * ```
12902
+ *
12903
+ * #### container-created
12904
+ * 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.
12905
+ * ```js
12906
+ * // The response has the following shape in event.detail:
12907
+ * {
12908
+ * containerSelector: "container-component_A",
12909
+ * name: "component_A",
12910
+ * tabSelector: "tab-component_A",
12911
+ * topic: "openfin-DOM-event",
12912
+ * type: "container-created",
12913
+ * uuid: "OpenFin POC"
12914
+ * }
12915
+ * ```
12916
+ *
12917
+ * ### layout-state-changed
12918
+ * 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.
12919
+ * ```js
12920
+ * // The response has the following shape in event.detail
12921
+ * {
12922
+ * containerSelector: "container-component_A",
12923
+ * name: "component_A",
12924
+ * tabSelector: "tab-component_A",
12925
+ * topic: "openfin-DOM-event",
12926
+ * type: "layout-state-changed",
12927
+ * uuid: "OpenFin POC"
12928
+ * }
12929
+ * ```
12930
+ *
12931
+ * #### tab-closed
12932
+ * Generated when a tab is closed.
12933
+ * ```js
12934
+ * // The response has the following shape in event.detail:
12935
+ * {
12936
+ * containerSelector: "container-component_A",
12937
+ * name: "component_A",
12938
+ * tabSelector: "tab-component_A",
12939
+ * topic: "openfin-DOM-event",
12940
+ * type: "tab-closed",
12941
+ * uuid: "OpenFin POC",
12942
+ * url: "http://openfin.co" // The url of the view that was closed.
12943
+ * }
12944
+ * ```
12945
+ *
12946
+ * #### tab-dropped
12947
+ * Generated when a tab is dropped.
12948
+ * ```js
12949
+ * // The response has the following shape in event.detail:
12950
+ * {
12951
+ * containerSelector: "container-component_A",
12952
+ * name: "component_A",
12953
+ * tabSelector: "tab-component_A",
12954
+ * topic: "openfin-DOM-event",
12955
+ * type: "tab-dropped",
12956
+ * uuid: "OpenFin POC",
12957
+ * url: "http://openfin.co" // The url of the view linked to the dropped tab.
12958
+ * }
12959
+ * ```
12960
+ */
12769
12961
  class Layout extends base_1$6.Base {
12770
12962
  /**
12771
12963
  * @internal
@@ -12991,22 +13183,52 @@ var _LayoutModule_layoutInitializationAttempted;
12991
13183
  Object.defineProperty(Factory$2, "__esModule", { value: true });
12992
13184
  Factory$2.LayoutModule = void 0;
12993
13185
  /* eslint-disable no-undef, import/prefer-default-export */
12994
- const base_1$5 = base;
13186
+ const base_1$5 = base$1;
12995
13187
  const Instance_1$2 = Instance$1;
13188
+ /**
13189
+ * Static namespace for OpenFin API methods that interact with the {@link Layout} class, available under `fin.Platform.Layout`.
13190
+ */
12996
13191
  class LayoutModule extends base_1$5.Base {
12997
13192
  constructor() {
12998
13193
  super(...arguments);
12999
13194
  _LayoutModule_layoutInitializationAttempted.set(this, false);
13000
13195
  /**
13001
- * Initialize the window's Layout. Must be called from a custom window that has a 'layout' option set upon creation of that window.
13196
+ * Initialize the window's Layout.
13197
+ *
13198
+ * @remarks Must be called from a custom window that has a 'layout' option set upon creation of that window.
13002
13199
  * If a containerId is not provided, this method attempts to find an element with the id `layout-container`.
13003
- * A Layout will <a href="tutorial-Layout.DOMEvents.html">emit events locally</a> on the DOM element representing the layout-container.
13200
+ * A Layout will emit events locally on the DOM element representing the layout-container.
13004
13201
  * In order to capture the relevant events during Layout initiation, set up the listeners on the DOM element prior to calling `init`.
13005
13202
  * @param options - Layout init options.
13006
13203
  *
13007
- * @static
13008
13204
  * @experimental
13009
- * @tutorial Layout.init
13205
+ *
13206
+ * @example
13207
+ * ```js
13208
+ * // If no options are included, the layout in the window options is initialized in an element with the id `layout-container`
13209
+ * const layout = await fin.Platform.Layout.init();
13210
+ * ```
13211
+ * <br>
13212
+ *
13213
+ * ```js
13214
+ * const containerId = 'my-custom-container-id';
13215
+ *
13216
+ * const myLayoutContainer = document.getElementById(containerId);
13217
+ *
13218
+ * myLayoutContainer.addEventListener('tab-created', function(event) {
13219
+ * const { tabSelector } = event.detail;
13220
+ * const tabElement = document.getElementById(tabSelector);
13221
+ * const existingColor = tabElement.style.backgroundColor;
13222
+ * tabElement.style.backgroundColor = "red";
13223
+ * setTimeout(() => {
13224
+ * tabElement.style.backgroundColor = existingColor;
13225
+ * }, 2000);
13226
+ * });
13227
+ *
13228
+ * // initialize the layout into an existing HTML element with the div `my-custom-container-id`
13229
+ * // the window must have been created with a layout in its window options
13230
+ * const layout = await fin.Platform.Layout.init({ containerId });
13231
+ * ```
13010
13232
  */
13011
13233
  this.init = async (options = {}) => {
13012
13234
  this.wire.sendAction('layout-init').catch((e) => {
@@ -13024,7 +13246,6 @@ class LayoutModule extends base_1$5.Base {
13024
13246
  }
13025
13247
  /**
13026
13248
  * Asynchronously returns a Layout object that represents a Window's layout.
13027
- * @param identity
13028
13249
  *
13029
13250
  * @example
13030
13251
  * ```js
@@ -13041,9 +13262,7 @@ class LayoutModule extends base_1$5.Base {
13041
13262
  * // Use wrapped instance to control layout, e.g.:
13042
13263
  * const layoutConfig = await layout.getConfig();
13043
13264
  * ```
13044
- * @static
13045
13265
  */
13046
- // eslint-disable-next-line class-methods-use-this
13047
13266
  async wrap(identity) {
13048
13267
  this.wire.sendAction('layout-wrap').catch((e) => {
13049
13268
  // don't expose
@@ -13052,7 +13271,6 @@ class LayoutModule extends base_1$5.Base {
13052
13271
  }
13053
13272
  /**
13054
13273
  * Synchronously returns a Layout object that represents a Window's layout.
13055
- * @param identity
13056
13274
  *
13057
13275
  * @example
13058
13276
  * ```js
@@ -13069,9 +13287,7 @@ class LayoutModule extends base_1$5.Base {
13069
13287
  * // Use wrapped instance to control layout, e.g.:
13070
13288
  * const layoutConfig = await layout.getConfig();
13071
13289
  * ```
13072
- * @static
13073
13290
  */
13074
- // eslint-disable-next-line class-methods-use-this
13075
13291
  wrapSync(identity) {
13076
13292
  this.wire.sendAction('layout-wrap-sync').catch((e) => {
13077
13293
  // don't expose
@@ -13087,7 +13303,6 @@ class LayoutModule extends base_1$5.Base {
13087
13303
  * // Use wrapped instance to control layout, e.g.:
13088
13304
  * const layoutConfig = await layout.getConfig();
13089
13305
  * ```
13090
- * @static
13091
13306
  */
13092
13307
  async getCurrent() {
13093
13308
  this.wire.sendAction('layout-get-current').catch((e) => {
@@ -13111,7 +13326,6 @@ class LayoutModule extends base_1$5.Base {
13111
13326
  * // Use wrapped instance to control layout, e.g.:
13112
13327
  * const layoutConfig = await layout.getConfig();
13113
13328
  * ```
13114
- * @static
13115
13329
  */
13116
13330
  getCurrentSync() {
13117
13331
  this.wire.sendAction('layout-get-current-sync').catch((e) => {
@@ -13129,13 +13343,16 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap();
13129
13343
 
13130
13344
  (function (exports) {
13131
13345
  /**
13132
- * Entry point for the OpenFin Layout namespace.
13346
+ * Entry point for the OpenFin `Layout` subset of the `Platform` API (`fin.Platform.Layout`).
13347
+ *
13348
+ * * {@link LayoutModule} contains static members of the `Layout` API, accessible through `fin.Platform.Layout`.
13349
+ * * {@link Layout} describes an instance of an OpenFin Layout, e.g. as returned by `fin.Platform.Layout.getCurrent`.
13133
13350
  *
13134
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "LayoutModule" is used for
13135
- * the module containing static members of the `Layout` namespace (available under `fin.Platform.Layout`), while `Layout` documents
13136
- * instances of the OpenFin `Layout` class.
13351
+ * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
13352
+ * both of these were documented on the same page.
13137
13353
  *
13138
13354
  * @packageDocumentation
13355
+ *
13139
13356
  */
13140
13357
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
13141
13358
  if (k2 === undefined) k2 = k;
@@ -13157,9 +13374,13 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap();
13157
13374
  } (layout));
13158
13375
 
13159
13376
  Object.defineProperty(Factory$3, "__esModule", { value: true });
13160
- const base_1$4 = base;
13377
+ Factory$3.PlatformModule = void 0;
13378
+ const base_1$4 = base$1;
13161
13379
  const Instance_1$1 = Instance$2;
13162
13380
  const index_1$1 = layout;
13381
+ /**
13382
+ * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
13383
+ */
13163
13384
  class PlatformModule extends base_1$4.Base {
13164
13385
  /**
13165
13386
  * @internal
@@ -13225,14 +13446,12 @@ class PlatformModule extends base_1$4.Base {
13225
13446
  * fin.Platform.init({overrideCallback});
13226
13447
  * ```
13227
13448
  * @experimental
13228
- * @static
13229
13449
  */
13230
13450
  async init(options) {
13231
13451
  return this.wire.environment.initPlatform(this.fin, options);
13232
13452
  }
13233
13453
  /**
13234
13454
  * Asynchronously returns a Platform object that represents an existing platform.
13235
- * @param identity
13236
13455
  *
13237
13456
  * @example
13238
13457
  * ```js
@@ -13241,7 +13460,6 @@ class PlatformModule extends base_1$4.Base {
13241
13460
  * // Use wrapped instance to control layout, e.g.:
13242
13461
  * const snapshot = await platform.getSnapshot();
13243
13462
  * ```
13244
- * @static
13245
13463
  */
13246
13464
  async wrap(identity) {
13247
13465
  this.wire.sendAction('platform-wrap').catch((e) => {
@@ -13251,7 +13469,6 @@ class PlatformModule extends base_1$4.Base {
13251
13469
  }
13252
13470
  /**
13253
13471
  * Synchronously returns a Platform object that represents an existing platform.
13254
- * @param identity
13255
13472
  *
13256
13473
  * @example
13257
13474
  * ```js
@@ -13260,7 +13477,6 @@ class PlatformModule extends base_1$4.Base {
13260
13477
  * // Use wrapped instance to control layout, e.g.:
13261
13478
  * const snapshot = await platform.getSnapshot();
13262
13479
  * ```
13263
- * @static
13264
13480
  */
13265
13481
  wrapSync(identity) {
13266
13482
  this.wire.sendAction('platform-wrap-sync').catch((e) => {
@@ -13277,7 +13493,6 @@ class PlatformModule extends base_1$4.Base {
13277
13493
  * // Use wrapped instance to control layout, e.g.:
13278
13494
  * const snapshot = await platform.getSnapshot();
13279
13495
  * ```
13280
- * @static
13281
13496
  */
13282
13497
  async getCurrent() {
13283
13498
  this.wire.sendAction('platform-get-current').catch((e) => {
@@ -13294,7 +13509,6 @@ class PlatformModule extends base_1$4.Base {
13294
13509
  * // Use wrapped instance to control layout, e.g.:
13295
13510
  * const snapshot = await platform.getSnapshot();
13296
13511
  * ```
13297
- * @static
13298
13512
  */
13299
13513
  getCurrentSync() {
13300
13514
  this.wire.sendAction('platform-get-current-sync').catch((e) => {
@@ -13305,7 +13519,6 @@ class PlatformModule extends base_1$4.Base {
13305
13519
  /**
13306
13520
  * Creates and starts a Platform and returns a wrapped and running Platform instance. The wrapped Platform methods can
13307
13521
  * be used to launch content into the platform. Promise will reject if the platform is already running.
13308
- * @param platformOptions
13309
13522
  *
13310
13523
  * @example
13311
13524
  * ```js
@@ -13326,7 +13539,6 @@ class PlatformModule extends base_1$4.Base {
13326
13539
  * console.error(e);
13327
13540
  * }
13328
13541
  * ```
13329
- * @static
13330
13542
  */
13331
13543
  start(platformOptions) {
13332
13544
  this.wire.sendAction('platform-start').catch((e) => {
@@ -13371,7 +13583,6 @@ class PlatformModule extends base_1$4.Base {
13371
13583
  * console.error(e);
13372
13584
  * }
13373
13585
  * ```
13374
- * @static
13375
13586
  */
13376
13587
  startFromManifest(manifestUrl, opts) {
13377
13588
  this.wire.sendAction('platform-start-from-manifest').catch((e) => {
@@ -13394,18 +13605,9 @@ class PlatformModule extends base_1$4.Base {
13394
13605
  });
13395
13606
  }
13396
13607
  }
13397
- Factory$3.default = PlatformModule;
13608
+ Factory$3.PlatformModule = PlatformModule;
13398
13609
 
13399
13610
  (function (exports) {
13400
- /**
13401
- * Entry point for the OpenFin Platform namespace.
13402
- *
13403
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "PlatformModule" is used for
13404
- * the module containing static members of the `Platform` namespace (available under `fin.Platform`), while `Platform` documents
13405
- * instances of the OpenFin `Platform` class.
13406
- *
13407
- * @packageDocumentation
13408
- */
13409
13611
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
13410
13612
  if (k2 === undefined) k2 = k;
13411
13613
  var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -13421,10 +13623,20 @@ Factory$3.default = PlatformModule;
13421
13623
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
13422
13624
  };
13423
13625
  Object.defineProperty(exports, "__esModule", { value: true });
13424
- const Factory_1 = Factory$3;
13425
- exports.default = Factory_1.default;
13626
+ /**
13627
+ * Entry points for the OpenFin `Platform` API (`fin.Platform`)
13628
+ *
13629
+ * * {@link PlatformModule} contains static members of the `Platform` API, accessible through `fin.Platform`.
13630
+ * * {@link Platform} describes an instance of an OpenFin Platform, e.g. as returned by `fin.Platform.getCurrent`.
13631
+ *
13632
+ * 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),
13633
+ * both of these were documented on the same page.
13634
+ *
13635
+ * @packageDocumentation
13636
+ */
13637
+ __exportStar(Factory$3, exports);
13426
13638
  __exportStar(Instance$2, exports);
13427
- } (platform));
13639
+ } (platform$1));
13428
13640
 
13429
13641
  var me = {};
13430
13642
 
@@ -13432,9 +13644,9 @@ var me = {};
13432
13644
  Object.defineProperty(exports, "__esModule", { value: true });
13433
13645
  exports.getMe = exports.getBaseMe = exports.environmentUnsupportedMessage = void 0;
13434
13646
  const view_1 = requireView();
13435
- const frame_1 = frame;
13647
+ const frame_1 = frame$1;
13436
13648
  const window_1 = requireWindow();
13437
- const external_application_1 = externalApplication;
13649
+ const external_application_1 = externalApplication$1;
13438
13650
  exports.environmentUnsupportedMessage = 'You are not running in OpenFin.';
13439
13651
  function getBaseMe(entityType, uuid, name) {
13440
13652
  const entityTypeHelpers = {
@@ -14095,7 +14307,7 @@ function requireInteropBroker () {
14095
14307
  hasRequiredInteropBroker = 1;
14096
14308
  Object.defineProperty(InteropBroker, "__esModule", { value: true });
14097
14309
  InteropBroker.InteropBroker = void 0;
14098
- const base_1 = base;
14310
+ const base_1 = base$1;
14099
14311
  const SessionContextGroupBroker_1 = requireSessionContextGroupBroker();
14100
14312
  const utils_1 = utils$1;
14101
14313
  const lodash_1 = require$$3;
@@ -14670,7 +14882,8 @@ function requireInteropBroker () {
14670
14882
  * ```
14671
14883
  */
14672
14884
  // eslint-disable-next-line class-methods-use-this
14673
- async handleFiredIntent(intent, clientIdentity) {
14885
+ async handleFiredIntent(intent, clientIdentity // TODO(CORE-811): remove inline intersected type
14886
+ ) {
14674
14887
  const warning = (0, utils_1.generateOverrideWarning)('fdc3.raiseIntent', 'InteropBroker.handleFiredIntent', clientIdentity, 'interopClient.fireIntent');
14675
14888
  console.warn(warning);
14676
14889
  throw new Error(utils_1.BROKER_ERRORS.fireIntent);
@@ -14737,7 +14950,7 @@ function requireInteropBroker () {
14737
14950
  * More information on the AppIntent type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/AppIntent).
14738
14951
  *
14739
14952
  * @param options
14740
- * @param clientIdentity Identity of the Client making the request.
14953
+ * @param clientIdentity Identity of the Client making the request.
14741
14954
  *
14742
14955
  * @example
14743
14956
  * ```js
@@ -14754,7 +14967,8 @@ function requireInteropBroker () {
14754
14967
  * ```
14755
14968
  */
14756
14969
  // eslint-disable-next-line class-methods-use-this
14757
- async handleInfoForIntent(options, clientIdentity) {
14970
+ async handleInfoForIntent(options, clientIdentity // TODO(CORE-811): remove inline intersected type
14971
+ ) {
14758
14972
  const warning = (0, utils_1.generateOverrideWarning)('fdc3.findIntent', 'InteropBroker.handleInfoForIntent', clientIdentity, 'interopClient.getInfoForIntent');
14759
14973
  console.warn(warning);
14760
14974
  throw new Error(utils_1.BROKER_ERRORS.getInfoForIntent);
@@ -14800,7 +15014,8 @@ function requireInteropBroker () {
14800
15014
  * ```
14801
15015
  */
14802
15016
  // eslint-disable-next-line class-methods-use-this
14803
- async handleInfoForIntentsByContext(context, clientIdentity) {
15017
+ async handleInfoForIntentsByContext(context, clientIdentity // TODO(CORE-811): remove inline intersected type
15018
+ ) {
14804
15019
  const warning = (0, utils_1.generateOverrideWarning)('fdc3.findIntentsByContext', 'InteropBroker.handleInfoForIntentsByContext', clientIdentity, 'interopClient.getInfoForIntentsByContext');
14805
15020
  console.warn(warning);
14806
15021
  throw new Error(utils_1.BROKER_ERRORS.getInfoForIntentsByContext);
@@ -14826,7 +15041,7 @@ function requireInteropBroker () {
14826
15041
  * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
14827
15042
  *
14828
15043
  * @param contextForIntent Data passed between entities and applications.
14829
- * @param clientIdentity Identity of the Client making the request.
15044
+ * @param clientIdentity Identity of the Client making the request.
14830
15045
  *
14831
15046
  * @example
14832
15047
  * ```js
@@ -14887,7 +15102,7 @@ function requireInteropBroker () {
14887
15102
  /**
14888
15103
  * Responsible for resolving the fdc3.findInstances call.
14889
15104
  * Must be overridden
14890
- * @param app AppIdentifier that was passed to fdc3.findInstances
15105
+ * @param app AppIdentifier that was passed to fdc3.findInstances
14891
15106
  * @param clientIdentity Identity of the Client making the request.
14892
15107
  */
14893
15108
  // eslint-disable-next-line class-methods-use-this
@@ -14922,7 +15137,7 @@ function requireInteropBroker () {
14922
15137
  * fin.Platform.init({
14923
15138
  * interopOverride: async (InteropBroker) => {
14924
15139
  * class Override extends InteropBroker {
14925
- * async invokeContextHandler(options, clientIdentity) {
15140
+ * async invokeContextHandler(clientIdentity, handlerId, context) {
14926
15141
  * return super.invokeContextHandler(clientIdentity, handlerId, {
14927
15142
  * ...context,
14928
15143
  * contextMetadata: {
@@ -14962,7 +15177,7 @@ function requireInteropBroker () {
14962
15177
  * fin.Platform.init({
14963
15178
  * interopOverride: async (InteropBroker) => {
14964
15179
  * class Override extends InteropBroker {
14965
- * async invokeIntentHandler(options, clientIdentity) {
15180
+ * async invokeIntentHandler(clientIdentity, handlerId, context) {
14966
15181
  * const { context } = intent;
14967
15182
  * return super.invokeIntentHandler(clientIdentity, handlerId, {
14968
15183
  * ...intent,
@@ -15301,7 +15516,8 @@ function requireInteropBroker () {
15301
15516
  }
15302
15517
  // Setup Channel Connection Logic
15303
15518
  wireChannel(channel) {
15304
- channel.onConnection(async (clientIdentity, payload) => {
15519
+ channel.onConnection(async (clientIdentity, // TODO(CORE-811): remove inline intersected type
15520
+ payload) => {
15305
15521
  if (!(await this.isConnectionAuthorized(clientIdentity, payload))) {
15306
15522
  throw new Error(`Connection not authorized for ${clientIdentity.uuid}, ${clientIdentity.name}`);
15307
15523
  }
@@ -15425,7 +15641,7 @@ var __classPrivateFieldGet$3 = (commonjsGlobal && commonjsGlobal.__classPrivateF
15425
15641
  };
15426
15642
  var _SessionContextGroupClient_clientPromise;
15427
15643
  Object.defineProperty(SessionContextGroupClient$1, "__esModule", { value: true });
15428
- const base_1$3 = base;
15644
+ const base_1$3 = base$1;
15429
15645
  const utils_1$3 = utils$1;
15430
15646
  class SessionContextGroupClient extends base_1$3.Base {
15431
15647
  constructor(wire, client, id) {
@@ -15512,7 +15728,7 @@ var __classPrivateFieldGet$2 = (commonjsGlobal && commonjsGlobal.__classPrivateF
15512
15728
  var _InteropClient_clientPromise, _InteropClient_sessionContextGroups;
15513
15729
  Object.defineProperty(InteropClient$1, "__esModule", { value: true });
15514
15730
  InteropClient$1.InteropClient = void 0;
15515
- const base_1$2 = base;
15731
+ const base_1$2 = base$1;
15516
15732
  const SessionContextGroupClient_1 = SessionContextGroupClient$1;
15517
15733
  const utils_1$2 = utils$1;
15518
15734
  /**
@@ -16181,39 +16397,46 @@ class InteropClient extends base_1$2.Base {
16181
16397
  InteropClient$1.InteropClient = InteropClient;
16182
16398
  _InteropClient_clientPromise = new WeakMap(), _InteropClient_sessionContextGroups = new WeakMap();
16183
16399
 
16184
- var overrideCheck$1 = {};
16400
+ var overrideCheck = {};
16185
16401
 
16186
- Object.defineProperty(overrideCheck$1, "__esModule", { value: true });
16187
- overrideCheck$1.overrideCheck = overrideCheck$1.getDefaultViewFdc3VersionFromAppInfo = void 0;
16188
- const InteropBroker_1 = requireInteropBroker();
16189
- function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }) {
16190
- var _a, _b, _c, _d;
16191
- 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;
16192
- return ['1.2', '2.0'].includes(setVersion !== null && setVersion !== void 0 ? setVersion : '') ? setVersion : undefined;
16193
- }
16194
- overrideCheck$1.getDefaultViewFdc3VersionFromAppInfo = getDefaultViewFdc3VersionFromAppInfo;
16195
- // TODO: Unit test this
16196
- function overrideCheck(overriddenBroker, fdc3InteropApi) {
16197
- if (fdc3InteropApi && fdc3InteropApi === '2.0') {
16198
- const mustOverrideAPIs = [
16199
- 'fdc3HandleFindInstances',
16200
- 'handleInfoForIntent',
16201
- 'handleInfoForIntentsByContext',
16202
- 'fdc3HandleGetAppMetadata',
16203
- 'fdc3HandleGetInfo',
16204
- 'fdc3HandleOpen',
16205
- 'handleFiredIntent',
16206
- 'handleFiredIntentForContext'
16207
- ];
16208
- const notOverridden = mustOverrideAPIs.filter((api) => {
16209
- return overriddenBroker[api] === InteropBroker_1.InteropBroker.prototype[api];
16210
- });
16211
- if (notOverridden.length > 0) {
16212
- 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')}`);
16213
- }
16214
- }
16402
+ var hasRequiredOverrideCheck;
16403
+
16404
+ function requireOverrideCheck () {
16405
+ if (hasRequiredOverrideCheck) return overrideCheck;
16406
+ hasRequiredOverrideCheck = 1;
16407
+ Object.defineProperty(overrideCheck, "__esModule", { value: true });
16408
+ overrideCheck.overrideCheck = overrideCheck.getDefaultViewFdc3VersionFromAppInfo = void 0;
16409
+ const InteropBroker_1 = requireInteropBroker();
16410
+ function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }) {
16411
+ var _a, _b, _c, _d;
16412
+ 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;
16413
+ return ['1.2', '2.0'].includes(setVersion !== null && setVersion !== void 0 ? setVersion : '') ? setVersion : undefined;
16414
+ }
16415
+ overrideCheck.getDefaultViewFdc3VersionFromAppInfo = getDefaultViewFdc3VersionFromAppInfo;
16416
+ // TODO: Unit test this
16417
+ function overrideCheck$1(overriddenBroker, fdc3InteropApi) {
16418
+ if (fdc3InteropApi && fdc3InteropApi === '2.0') {
16419
+ const mustOverrideAPIs = [
16420
+ 'fdc3HandleFindInstances',
16421
+ 'handleInfoForIntent',
16422
+ 'handleInfoForIntentsByContext',
16423
+ 'fdc3HandleGetAppMetadata',
16424
+ 'fdc3HandleGetInfo',
16425
+ 'fdc3HandleOpen',
16426
+ 'handleFiredIntent',
16427
+ 'handleFiredIntentForContext'
16428
+ ];
16429
+ const notOverridden = mustOverrideAPIs.filter((api) => {
16430
+ return overriddenBroker[api] === InteropBroker_1.InteropBroker.prototype[api];
16431
+ });
16432
+ if (notOverridden.length > 0) {
16433
+ 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')}`);
16434
+ }
16435
+ }
16436
+ }
16437
+ overrideCheck.overrideCheck = overrideCheck$1;
16438
+ return overrideCheck;
16215
16439
  }
16216
- overrideCheck$1.overrideCheck = overrideCheck;
16217
16440
 
16218
16441
  var hasRequiredFactory;
16219
16442
 
@@ -16221,12 +16444,14 @@ function requireFactory () {
16221
16444
  if (hasRequiredFactory) return Factory$1;
16222
16445
  hasRequiredFactory = 1;
16223
16446
  Object.defineProperty(Factory$1, "__esModule", { value: true });
16447
+ Factory$1.InteropModule = void 0;
16224
16448
  const lodash_1 = require$$3;
16225
16449
  const inaccessibleObject_1 = inaccessibleObject;
16226
- const base_1 = base;
16450
+ const base_1 = base$1;
16227
16451
  const InteropBroker_1 = requireInteropBroker();
16228
16452
  const InteropClient_1 = InteropClient$1;
16229
- const overrideCheck_1 = overrideCheck$1;
16453
+ const overrideCheck_1 = requireOverrideCheck();
16454
+ const common_utils_1 = commonUtils;
16230
16455
  const defaultOverride = (Class) => new Class();
16231
16456
  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.';
16232
16457
  /**
@@ -16248,7 +16473,7 @@ function requireFactory () {
16248
16473
  * when not using a Platform app. You can override functions in the Interop Broker. More info {@link InteropBroker here}.
16249
16474
  *
16250
16475
  * @param name - Name of the Interop Broker.
16251
- * @param override - A callback function that can be used to extend or replace default Interop Broker behavior.
16476
+ * @param override - A callback function or array of callback functions that can be used to extend or replace default Interop Broker behavior.
16252
16477
  *
16253
16478
  * @example
16254
16479
  * ``` js
@@ -16256,11 +16481,10 @@ function requireFactory () {
16256
16481
  * const contextGroups = await interopBroker.getContextGroups();
16257
16482
  * console.log(contextGroups);
16258
16483
  * ```
16259
- * @static
16260
16484
  */
16261
16485
  async init(name, override = defaultOverride) {
16262
16486
  var _a;
16263
- this.wire.sendAction('interop-init').catch((e) => {
16487
+ this.wire.sendAction('interop-init').catch(() => {
16264
16488
  // don't expose, analytics-only call
16265
16489
  });
16266
16490
  // Allows for manifest-level configuration, without having to override. (e.g. specifying custom context groups)
@@ -16280,9 +16504,18 @@ function requireFactory () {
16280
16504
  throw new Error(BrokerParamAccessError);
16281
16505
  };
16282
16506
  const OverrideableBroker = InteropBroker_1.InteropBroker.createClosedConstructor(this.wire, getProvider, opts);
16283
- // We need to use these objects because removing them entirely would be a breaking change and we want an informative error
16284
- // @ts-expect-error
16285
- const broker = await override(OverrideableBroker, objectThatThrows, throwingGetProvider, warningOptsClone);
16507
+ let broker;
16508
+ if (Array.isArray(override)) {
16509
+ const BrokerConstructor = (0, common_utils_1.overrideFromComposables)(...override)(OverrideableBroker);
16510
+ // We need to use these objects because removing them entirely would be a breaking change and we want an informative error
16511
+ // @ts-expect-error
16512
+ broker = new BrokerConstructor(objectThatThrows, throwingGetProvider, warningOptsClone);
16513
+ }
16514
+ else {
16515
+ // We need to use these objects because removing them entirely would be a breaking change and we want an informative error
16516
+ // @ts-expect-error
16517
+ broker = await override(OverrideableBroker, objectThatThrows, throwingGetProvider, warningOptsClone);
16518
+ }
16286
16519
  (0, overrideCheck_1.overrideCheck)(broker, (0, overrideCheck_1.getDefaultViewFdc3VersionFromAppInfo)(options));
16287
16520
  return broker;
16288
16521
  }
@@ -16305,16 +16538,15 @@ function requireFactory () {
16305
16538
  * const contextGroupInfo = await client.getInfoForContextGroup();
16306
16539
  * console.log(contextGroupInfo);
16307
16540
  * ```
16308
- * @static
16309
16541
  */
16310
16542
  connectSync(name, interopConfig) {
16311
- this.wire.sendAction('interop-connect-sync').catch((e) => {
16543
+ this.wire.sendAction('interop-connect-sync').catch(() => {
16312
16544
  // don't expose, analytics-only call
16313
16545
  });
16314
16546
  return new InteropClient_1.InteropClient(this.wire, name, interopConfig);
16315
16547
  }
16316
16548
  }
16317
- Factory$1.default = InteropModule;
16549
+ Factory$1.InteropModule = InteropModule;
16318
16550
  return Factory$1;
16319
16551
  }
16320
16552
 
@@ -16325,10 +16557,10 @@ function requireInterop () {
16325
16557
  hasRequiredInterop = 1;
16326
16558
  (function (exports) {
16327
16559
  /**
16328
- * Entry point for the OpenFin Interop namespace.
16560
+ * Entry point for the OpenFin `Interop` API (`fin.Interop`).
16329
16561
  *
16330
- * "InteropModule" contains static members of the `Interop` namespace (available under `fin.Interop`), while `InteropClient` and
16331
- * `InteropBroker` document instances of their respective classes.
16562
+ * * {@link InteropModule} contains static members of the `Interop` API (available under `fin.Interop`)
16563
+ * * {@link InteropClient} and {@link InteropBroker} document instances of their respective classes.
16332
16564
  *
16333
16565
  * @packageDocumentation
16334
16566
  */
@@ -16347,8 +16579,7 @@ function requireInterop () {
16347
16579
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
16348
16580
  };
16349
16581
  Object.defineProperty(exports, "__esModule", { value: true });
16350
- const Factory_1 = requireFactory();
16351
- exports.default = Factory_1.default;
16582
+ __exportStar(requireFactory(), exports);
16352
16583
  __exportStar(InteropClient$1, exports);
16353
16584
  __exportStar(requireInteropBroker(), exports);
16354
16585
  } (interop));
@@ -16384,12 +16615,14 @@ var _SnapshotSource_identity, _SnapshotSource_getConnection, _SnapshotSource_get
16384
16615
  Object.defineProperty(Instance, "__esModule", { value: true });
16385
16616
  Instance.SnapshotSource = void 0;
16386
16617
  /* eslint-disable @typescript-eslint/no-non-null-assertion */
16387
- const base_1$1 = base;
16618
+ const base_1$1 = base$1;
16388
16619
  const utils_1$1 = utils;
16389
16620
  const connectionMap = new Map();
16390
16621
  /**
16391
16622
  * Enables configuring a SnapshotSource with custom getSnapshot and applySnapshot methods.
16392
16623
  *
16624
+ * @typeParam Snapshot Implementation-defined shape of an application snapshot. Allows
16625
+ * custom snapshot implementations for legacy applications to define their own snapshot format.
16393
16626
  */
16394
16627
  class SnapshotSource extends base_1$1.Base {
16395
16628
  /**
@@ -16524,13 +16757,19 @@ Instance.SnapshotSource = SnapshotSource;
16524
16757
  _SnapshotSource_identity = new WeakMap(), _SnapshotSource_getConnection = new WeakMap(), _SnapshotSource_getClient = new WeakMap(), _SnapshotSource_startConnection = new WeakMap(), _SnapshotSource_setUpConnectionListener = new WeakMap();
16525
16758
 
16526
16759
  Object.defineProperty(Factory, "__esModule", { value: true });
16527
- const base_1 = base;
16760
+ Factory.SnapshotSourceModule = void 0;
16761
+ const base_1 = base$1;
16528
16762
  const Instance_1 = Instance;
16529
16763
  const utils_1 = utils;
16764
+ /**
16765
+ * Static namespace for OpenFin API methods that interact with the {@link SnapshotSource} class, available under `fin.SnapshotSource`.
16766
+ */
16530
16767
  class SnapshotSourceModule extends base_1.Base {
16531
16768
  /**
16532
16769
  * Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
16533
- * @param provider
16770
+ *
16771
+ * @typeParam Snapshot Implementation-defined shape of an application snapshot. Allows
16772
+ * custom snapshot implementations for legacy applications to define their own snapshot format.
16534
16773
  *
16535
16774
  * @example
16536
16775
  * ```js
@@ -16547,7 +16786,7 @@ class SnapshotSourceModule extends base_1.Base {
16547
16786
  *
16548
16787
  * await fin.SnapshotSource.init(snapshotProvider);
16549
16788
  * ```
16550
- * @static
16789
+ *
16551
16790
  */
16552
16791
  async init(provider) {
16553
16792
  this.wire.sendAction('snapshot-source-init').catch((e) => {
@@ -16567,7 +16806,6 @@ class SnapshotSourceModule extends base_1.Base {
16567
16806
  }
16568
16807
  /**
16569
16808
  * Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
16570
- * @param identity
16571
16809
  *
16572
16810
  * @example
16573
16811
  * ```js
@@ -16575,7 +16813,6 @@ class SnapshotSourceModule extends base_1.Base {
16575
16813
  * // Use wrapped instance's getSnapshot method, e.g.:
16576
16814
  * const snapshot = await snapshotSource.getSnapshot();
16577
16815
  * ```
16578
- * @static
16579
16816
  */
16580
16817
  wrapSync(identity) {
16581
16818
  this.wire.sendAction('snapshot-source-wrap-sync').catch((e) => {
@@ -16585,7 +16822,6 @@ class SnapshotSourceModule extends base_1.Base {
16585
16822
  }
16586
16823
  /**
16587
16824
  * Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.
16588
- * @param identity
16589
16825
  *
16590
16826
  * @example
16591
16827
  * ```js
@@ -16593,7 +16829,6 @@ class SnapshotSourceModule extends base_1.Base {
16593
16829
  * // Use wrapped instance's getSnapshot method, e.g.:
16594
16830
  * const snapshot = await snapshotSource.getSnapshot();
16595
16831
  * ```
16596
- * @static
16597
16832
  */
16598
16833
  async wrap(identity) {
16599
16834
  this.wire.sendAction('snapshot-source-wrap').catch((e) => {
@@ -16602,15 +16837,17 @@ class SnapshotSourceModule extends base_1.Base {
16602
16837
  return this.wrapSync(identity);
16603
16838
  }
16604
16839
  }
16605
- Factory.default = SnapshotSourceModule;
16840
+ Factory.SnapshotSourceModule = SnapshotSourceModule;
16606
16841
 
16607
16842
  (function (exports) {
16608
16843
  /**
16609
- * Entry point for the OpenFin SnapshotSource namespace.
16844
+ * Entry points for the OpenFin `SnapshotSource` API (`fin.SnapshotSource`).
16845
+ *
16846
+ * * {@link SnapshotSourceModule} contains static members of the `SnapshotSource` API, accessible through `fin.SnapshotSource`.
16847
+ * * {@link SnapshotSource} describes an instance of an OpenFin SnapshotSource, e.g. as returned by `fin.SnapshotSource.wrap`.
16610
16848
  *
16611
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "SnapshotSourceModule" is used for
16612
- * the module containing static members of the `SnapshotSource` namespace (available under `fin.SnapshotSource`), while `SnapshotSource` documents
16613
- * instances of the OpenFin `SnapshotSource` class.
16849
+ * 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),
16850
+ * both of these were documented on the same page.
16614
16851
  *
16615
16852
  * @packageDocumentation
16616
16853
  */
@@ -16629,27 +16866,30 @@ Factory.default = SnapshotSourceModule;
16629
16866
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
16630
16867
  };
16631
16868
  Object.defineProperty(exports, "__esModule", { value: true });
16632
- const Factory_1 = Factory;
16633
- exports.default = Factory_1.default;
16869
+ __exportStar(Factory, exports);
16634
16870
  __exportStar(Instance, exports);
16635
16871
  } (snapshotSource));
16636
16872
 
16637
16873
  Object.defineProperty(fin, "__esModule", { value: true });
16874
+ fin.Fin = void 0;
16638
16875
  const events_1$3 = eventsExports;
16639
16876
  // Import from the file rather than the directory in case someone consuming types is using module resolution other than "node"
16640
- const index_1 = system;
16877
+ const index_1 = system$1;
16641
16878
  const index_2 = requireWindow();
16642
16879
  const index_3 = requireApplication();
16643
16880
  const index_4 = interappbus;
16644
16881
  const index_5 = clipboard;
16645
- const index_6 = externalApplication;
16646
- const index_7 = frame;
16647
- const index_8 = globalHotkey;
16882
+ const index_6 = externalApplication$1;
16883
+ const index_7 = frame$1;
16884
+ const index_8 = globalHotkey$1;
16648
16885
  const index_9 = requireView();
16649
- const index_10 = platform;
16886
+ const index_10 = platform$1;
16650
16887
  const me_1$1 = me;
16651
16888
  const interop_1 = requireInterop();
16652
16889
  const snapshot_source_1 = snapshotSource;
16890
+ /**
16891
+ * @internal
16892
+ */
16653
16893
  class Fin extends events_1$3.EventEmitter {
16654
16894
  /**
16655
16895
  * @internal
@@ -16657,18 +16897,18 @@ class Fin extends events_1$3.EventEmitter {
16657
16897
  constructor(wire) {
16658
16898
  super();
16659
16899
  this.wire = wire;
16660
- this.System = new index_1.default(wire);
16661
- this.Window = new index_2.default(wire);
16662
- this.Application = new index_3.default(wire);
16663
- this.InterApplicationBus = new index_4.default(wire);
16664
- this.Clipboard = new index_5.default(wire);
16665
- this.ExternalApplication = new index_6.default(wire);
16666
- this.Frame = new index_7.default(wire);
16667
- this.GlobalHotkey = new index_8.default(wire);
16668
- this.Platform = new index_10.default(wire, this.InterApplicationBus.Channel);
16669
- this.View = new index_9.default(wire);
16670
- this.Interop = new interop_1.default(wire);
16671
- this.SnapshotSource = new snapshot_source_1.default(wire);
16900
+ this.System = new index_1.System(wire);
16901
+ this.Window = new index_2._WindowModule(wire);
16902
+ this.Application = new index_3.ApplicationModule(wire);
16903
+ this.InterApplicationBus = new index_4.InterApplicationBus(wire);
16904
+ this.Clipboard = new index_5.Clipboard(wire);
16905
+ this.ExternalApplication = new index_6.ExternalApplicationModule(wire);
16906
+ this.Frame = new index_7._FrameModule(wire);
16907
+ this.GlobalHotkey = new index_8.GlobalHotkey(wire);
16908
+ this.Platform = new index_10.PlatformModule(wire, this.InterApplicationBus.Channel);
16909
+ this.View = new index_9.ViewModule(wire);
16910
+ this.Interop = new interop_1.InteropModule(wire);
16911
+ this.SnapshotSource = new snapshot_source_1.SnapshotSourceModule(wire);
16672
16912
  wire.registerFin(this);
16673
16913
  this.me = (0, me_1$1.getMe)(wire);
16674
16914
  // Handle disconnect events
@@ -16677,7 +16917,7 @@ class Fin extends events_1$3.EventEmitter {
16677
16917
  });
16678
16918
  }
16679
16919
  }
16680
- fin.default = Fin;
16920
+ fin.Fin = Fin;
16681
16921
 
16682
16922
  var wire = {};
16683
16923
 
@@ -17979,7 +18219,7 @@ function requireMain () {
17979
18219
  Object.defineProperty(exports, "__esModule", { value: true });
17980
18220
  exports.ChannelProvider = exports.ChannelClient = exports.Frame = exports.View = exports.System = exports.Window = exports.Application = exports.Fin = exports.launch = exports.connect = void 0;
17981
18221
  const fin_1 = fin;
17982
- exports.Fin = fin_1.default;
18222
+ Object.defineProperty(exports, "Fin", { enumerable: true, get: function () { return fin_1.Fin; } });
17983
18223
  const index_1 = requireApplication();
17984
18224
  Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return index_1.Application; } });
17985
18225
  const window_1 = requireWindow();
@@ -17987,13 +18227,13 @@ function requireMain () {
17987
18227
  const view_1 = requireView();
17988
18228
  Object.defineProperty(exports, "View", { enumerable: true, get: function () { return view_1.View; } });
17989
18229
  const client_1 = client;
17990
- exports.ChannelClient = client_1.default;
18230
+ Object.defineProperty(exports, "ChannelClient", { enumerable: true, get: function () { return client_1.ChannelClient; } });
17991
18231
  const provider_1 = provider;
17992
18232
  Object.defineProperty(exports, "ChannelProvider", { enumerable: true, get: function () { return provider_1.ChannelProvider; } });
17993
- const frame_1 = frame;
18233
+ const frame_1 = frame$1;
17994
18234
  Object.defineProperty(exports, "Frame", { enumerable: true, get: function () { return frame_1._Frame; } });
17995
- const system_1 = system;
17996
- exports.System = system_1.default;
18235
+ const system_1 = system$1;
18236
+ Object.defineProperty(exports, "System", { enumerable: true, get: function () { return system_1.System; } });
17997
18237
  const wire_1 = wire;
17998
18238
  const node_env_1 = requireNodeEnv();
17999
18239
  const transport_1 = transport;
@@ -18010,7 +18250,7 @@ function requireMain () {
18010
18250
  name: (_a = normalized.name) !== null && _a !== void 0 ? _a : normalized.uuid
18011
18251
  });
18012
18252
  await wire.connect(normalized);
18013
- return new fin_1.default(wire);
18253
+ return new fin_1.Fin(wire);
18014
18254
  }
18015
18255
  exports.connect = connect;
18016
18256
  async function launch(config) {
@@ -18028,15 +18268,250 @@ function requireMain () {
18028
18268
 
18029
18269
  var mainExports = requireMain();
18030
18270
 
18031
- var OpenFin$1 = {};
18271
+ var OpenFin$2 = {};
18272
+
18273
+ var events = {};
18274
+
18275
+ var application = {};
18276
+
18277
+ /**
18278
+ * Namespace for events that can be emitted by an {@link OpenFin.Application}. Includes events
18279
+ * re-propagated from the {@link OpenFin.Window} (and, transitively, {@link OpenFin.View}) level, prefixed with `window-` (and also, if applicable, `view-`).
18280
+ * For example, a view's "attached" event will fire as 'window-view-attached' at the application level.
18281
+ *
18282
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
18283
+ *
18284
+ * This namespace contains only payload shapes for events that are unique to `Application`. Events that propagate to `Application` from
18285
+ * child {@link OpenFin.Window windows} and {@link OpenFin.View views} are defined in the {@link OpenFin.WindowEvents} and
18286
+ * {@link OpenFin.ViewEvents} namespaces. For a list of valid string keys for *all* application events, see {@link Application.on Application.on}.
18287
+ *
18288
+ * {@link WillPropagateApplicationEvent Bespoke application events} re-propagate to the system level, prefixed with `application-`. For example,
18289
+ * the `closed` event will fire as `application-closed` at the system level. Propagated events from {@link PropagatedWindowEvent windows}
18290
+ * and {@link PropagatedViewEvent views} within an application will *not* transitively re-propagate to the system level, because they are already
18291
+ * visible at the system level and contain the identity of the application.
18292
+ *
18293
+ * @packageDocumentation
18294
+ */
18295
+ Object.defineProperty(application, "__esModule", { value: true });
18296
+
18297
+ var base = {};
18298
+
18299
+ Object.defineProperty(base, "__esModule", { value: true });
18300
+
18301
+ var externalApplication = {};
18302
+
18303
+ /**
18304
+ * Namespace for events that can be transmitted by an {@link OpenFin.ExternalApplication}.
18305
+ *
18306
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
18307
+ *
18308
+ * For a list of valid string keys for external application events, see {@link ExternalApplication.on ExternalApplication.on}.
18309
+ *
18310
+ * @packageDocumentation
18311
+ */
18312
+ Object.defineProperty(externalApplication, "__esModule", { value: true });
18313
+
18314
+ var frame = {};
18315
+
18316
+ Object.defineProperty(frame, "__esModule", { value: true });
18317
+
18318
+ var globalHotkey = {};
18319
+
18320
+ Object.defineProperty(globalHotkey, "__esModule", { value: true });
18321
+
18322
+ var platform = {};
18323
+
18324
+ /**
18325
+ *
18326
+ * Namespace for events that can emitted by a {@link OpenFin.Platform}.
18327
+ *
18328
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
18329
+ *
18330
+ * The Platform `EventEmitter` is a superset of the {@link OpenFin.Application} `EventEmitter`,
18331
+ * meaning it can listen to all {@link OpenFin.ApplicationEvents Application events} in addition to the
18332
+ * Platform-specific events listed here. For a list of valid string keys for *all* platform events, see
18333
+ * {@link Platform.on Platform.on}.
18334
+ *
18335
+ * @packageDocumentation
18336
+ */
18337
+ Object.defineProperty(platform, "__esModule", { value: true });
18338
+
18339
+ var system = {};
18340
+
18341
+ /**
18342
+ * Namespace for runtime-wide OpenFin events emitted by {@link System.System}. Includes events
18343
+ * re-propagated from {@link OpenFin.Application}, {@link OpenFin.Window}, and {@link OpenFin.View} (prefixed with `application-`, `window-`, and `view-`). All
18344
+ * event propagations are visible at the System level. Propagated events from WebContents (windows, views, frames) to the Application level will *not*
18345
+ * transitively re-propagate to the System level, because they are already visible at the system level and contain the identity
18346
+ * of the application. For example, an application's "closed" event will fire as 'application-closed' at the system level. A view's 'shown' event
18347
+ * will be visible as 'view-shown' at the system level, but *not* as `application-window-view-shown`.
18348
+ *
18349
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
18350
+ *
18351
+ * This namespace contains only payload shapes for events that are unique to `System`. Events that propagate to `System` from
18352
+ * child {@link OpenFin.Application applications}, {@link OpenFin.Window windows}, and {@link OpenFin.View views} are defined in the
18353
+ * {@link OpenFin.ApplicationEvents}, {@link OpenFin.WindowEvents}, and {@link OpenFin.ViewEvents} namespaces. For a list of valid string keys for *all*
18354
+ * system events, see {@link System.on System.on}.
18355
+ *
18356
+ * @packageDocumentation
18357
+ */
18358
+ Object.defineProperty(system, "__esModule", { value: true });
18359
+
18360
+ var view = {};
18361
+
18362
+ /**
18363
+ * Namespace for events that can be emitted by a {@link OpenFin.View}.
18364
+ *
18365
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
18366
+ *
18367
+ * This namespace contains only payload shapes for events that are unique to `View`. Events that are shared between all `WebContents`
18368
+ * (i.e. {@link OpenFin.Window}, {@link OpenFin.View}) are defined in {@link OpenFin.WebContentsEvents}. For a list
18369
+ * of valid string keys for *all* View events, see {@link View.on View.on}.
18370
+ *
18371
+ * View events fall into two categories: {@link WillPropagateViewEvent} and {@link NonPropagatedViewEvent}. Propagated events will
18372
+ * be re-emitted on the parent {@link OpenFin.Window} of the target view, prefixed with "view-". For example,
18373
+ * the "shown" event will be re-emitted on the parent window as "view-shown". Non-propagated events
18374
+ * will not be re-emitted on the parent window.
18375
+ *
18376
+ * @packageDocumentation
18377
+ */
18378
+ Object.defineProperty(view, "__esModule", { value: true });
18379
+
18380
+ var webcontents = {};
18381
+
18382
+ /**
18383
+ * Namespace for events shared by all OpenFin WebContents elements (i.e. {@link OpenFin.Window},
18384
+ * {@link OpenFin.View}).
18385
+ *
18386
+ * WebContents events are divided into two groups: {@link WillPropagateWebContentsEvent} and {@link NonPropagatedWebContentsEvent}. Propagating events
18387
+ * will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
18388
+ * parent window, and propagating events in a window will also be emitted on the window's parent {@link OpenFin.Application}.
18389
+ *
18390
+ * Non-propagating events will not re-emit on parent entities.
18391
+ *
18392
+ * @packageDocumentation
18393
+ */
18394
+ Object.defineProperty(webcontents, "__esModule", { value: true });
18395
+
18396
+ var window$1 = {};
18397
+
18398
+ /**
18399
+ *
18400
+ * Namespace for events that can be emitted by a {@link OpenFin.Window}.
18401
+ *
18402
+ * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
18403
+ *
18404
+ * This namespace contains only payload shapes for events that are unique to `Window`. Events that are shared between all `WebContents`
18405
+ * (i.e. {@link OpenFin.Window}, {@link OpenFin.View}) are defined in {@link OpenFin.WebContentsEvents}. Events that
18406
+ * propagate from `View` are defined in {@link OpenFin.ViewEvents}. For a list of valid string keys for *all* Window events, see
18407
+ * {@link Window.on Window.on}
18408
+ *
18409
+ * Window events fall into two categories: {@link WillPropagateWindowEvent} and {@link NonPropagatedWindowEvent}.
18410
+ * Propagated events will be re-emitted on the parent {@link OpenFin.Application} of the target window, prefixed with "window-". For example,
18411
+ * a window's "reloaded" event will be re-emitted on the parent application as "window-reloaded". Non-propagated
18412
+ * events will not be re-emitted on the parent application.
18413
+ *
18414
+ * @packageDocumentation
18415
+ */
18416
+ Object.defineProperty(window$1, "__esModule", { value: true });
18417
+
18418
+ /**
18419
+ * Namespace for OpenFin event types. Each entity that emits OpenFin events has its own sub-namespace. Event payloads
18420
+ * themselves are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
18421
+ *
18422
+ * #### Event emitters
18423
+ *
18424
+ * The following entities emit OpenFin events, and have corresponding sub-namespaces:
18425
+ *
18426
+ * * {@link OpenFin.Application}: {@link OpenFin.ApplicationEvents}
18427
+ * * {@link OpenFin.ExternalApplication}: {@link OpenFin.ExternalApplicationEvents}
18428
+ * * {@link OpenFin.Frame}: {@link OpenFin.FrameEvents}
18429
+ * * {@link OpenFin.GlobalHotkey}: {@link OpenFin.GlobalHotkeyEvents}
18430
+ * * {@link OpenFin.Platform}: {@link OpenFin.PlatformEvents}
18431
+ * * {@link OpenFin.System}: {@link OpenFin.SystemEvents}
18432
+ * * {@link OpenFin.View}: {@link OpenFin.ViewEvents}
18433
+ * * {@link OpenFin.Window}: {@link OpenFin.WindowEvents}
18434
+ *
18435
+ * These `EventEmitter` entities share a common set of methods for interacting with the OpenFin event bus, which can be
18436
+ * seen on the individual documentation pages for each entity type.
18437
+ *
18438
+ * Registering event handlers is an asynchronous operation. It is important to ensure that the returned Promises are awaited to reduce the
18439
+ * risk of race conditions.
18440
+ *
18441
+ * When the `EventEmitter` receives an event from the browser process and emits on the renderer, all of the functions attached to that
18442
+ * specific event are called synchronously. Any values returned by the called listeners are ignored and will be discarded. If the window document
18443
+ * is destroyed by page navigation or reload, its registered event listeners will be removed.
18444
+ *
18445
+ * We recommend using Arrow Functions for event listeners to ensure the this scope is consistent with the original function context.
18446
+ *
18447
+ * Events re-propagate from smaller/more-local scopes to larger/more-global scopes. For example, an event emitted on a specific
18448
+ * view will propagate to the window in which the view is embedded, and then to the application in which the window is running, and
18449
+ * finally to the OpenFin runtime itself at the "system" level. For details on propagation semantics, see the namespace for
18450
+ * the propagating (or propagated-to) entity.
18451
+ *
18452
+ * @packageDocumentation
18453
+ */
18454
+ Object.defineProperty(events, "__esModule", { value: true });
18455
+ events.WindowEvents = events.WebContentsEvents = events.ViewEvents = events.SystemEvents = events.PlatformEvents = events.GlobalHotkeyEvents = events.FrameEvents = events.ExternalApplicationEvents = events.BaseEvents = events.ApplicationEvents = void 0;
18456
+ const ApplicationEvents = application;
18457
+ events.ApplicationEvents = ApplicationEvents;
18458
+ const BaseEvents = base;
18459
+ events.BaseEvents = BaseEvents;
18460
+ const ExternalApplicationEvents = externalApplication;
18461
+ events.ExternalApplicationEvents = ExternalApplicationEvents;
18462
+ const FrameEvents = frame;
18463
+ events.FrameEvents = FrameEvents;
18464
+ const GlobalHotkeyEvents = globalHotkey;
18465
+ events.GlobalHotkeyEvents = GlobalHotkeyEvents;
18466
+ const PlatformEvents = platform;
18467
+ events.PlatformEvents = PlatformEvents;
18468
+ const SystemEvents = system;
18469
+ events.SystemEvents = SystemEvents;
18470
+ const ViewEvents = view;
18471
+ events.ViewEvents = ViewEvents;
18472
+ const WebContentsEvents = webcontents;
18473
+ events.WebContentsEvents = WebContentsEvents;
18474
+ const WindowEvents = window$1;
18475
+ events.WindowEvents = WindowEvents;
18476
+
18477
+ (function (exports) {
18478
+ /**
18479
+ * Top-level namespace for types referenced by the OpenFin API. Contains:
18480
+ *
18481
+ * * The type of the global `fin` entry point ({@link FinApi})
18482
+ * * Classes that act as static namespaces returned from the `fin` global (e.g. {@link ApplicationModule}, accessible via `fin.Application`)
18483
+ * * Instance classes that are returned from API calls (e.g. {@link Application}, accessible via `fin.Application.getCurrentSync()`)
18484
+ * * Parameter shapes for API methods (e.g. {@link ApplicationOptions}, used in `fin.Application.start()`)
18485
+ * * Event namespaces and payload union types (e.g. {@link ApplicationEvents} and {@link ApplicationEvent})
18486
+ *
18487
+ * @packageDocumentation
18488
+ */
18489
+ var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
18490
+ if (k2 === undefined) k2 = k;
18491
+ var desc = Object.getOwnPropertyDescriptor(m, k);
18492
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
18493
+ desc = { enumerable: true, get: function() { return m[k]; } };
18494
+ }
18495
+ Object.defineProperty(o, k2, desc);
18496
+ }) : (function(o, m, k, k2) {
18497
+ if (k2 === undefined) k2 = k;
18498
+ o[k2] = m[k];
18499
+ }));
18500
+ var __exportStar = (commonjsGlobal && commonjsGlobal.__exportStar) || function(m, exports) {
18501
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
18502
+ };
18503
+ Object.defineProperty(exports, "__esModule", { value: true });
18504
+ // Deprecated shim to preserve v30 namespace names
18505
+ __exportStar(events, exports);
18506
+ } (OpenFin$2));
18032
18507
 
18033
- Object.defineProperty(OpenFin$1, "__esModule", { value: true });
18508
+ var OpenFin = /*@__PURE__*/getDefaultExportFromCjs(OpenFin$2);
18034
18509
 
18035
- var OpenFin = /*#__PURE__*/_mergeNamespaces({
18510
+ var OpenFin$1 = /*#__PURE__*/_mergeNamespaces({
18036
18511
  __proto__: null,
18037
- default: OpenFin$1
18038
- }, [OpenFin$1]);
18512
+ default: OpenFin
18513
+ }, [OpenFin$2]);
18039
18514
 
18040
18515
  exports.connect = mainExports.connect;
18041
- exports.default = OpenFin;
18516
+ exports.default = OpenFin$1;
18042
18517
  exports.launch = mainExports.launch;