@openfin/node-adapter 33.77.2 → 33.77.3

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,16 +30,12 @@ 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
-
37
33
  var main$1 = {};
38
34
 
39
35
  var fin = {};
40
36
 
41
37
  var eventsExports = {};
42
- var events$1 = {
38
+ var events = {
43
39
  get exports(){ return eventsExports; },
44
40
  set exports(v){ eventsExports = v; },
45
41
  };
@@ -76,7 +72,7 @@ var NumberIsNaN = Number.isNaN || function NumberIsNaN(value) {
76
72
  function EventEmitter() {
77
73
  EventEmitter.init.call(this);
78
74
  }
79
- events$1.exports = EventEmitter;
75
+ events.exports = EventEmitter;
80
76
  eventsExports.once = once;
81
77
 
82
78
  // Backwards-compat with node 0.10.x
@@ -518,9 +514,9 @@ function eventTargetAgnosticAddListener(emitter, name, listener, flags) {
518
514
  }
519
515
  }
520
516
 
521
- var system$1 = {};
517
+ var system = {};
522
518
 
523
- var base$1 = {};
519
+ var base = {};
524
520
 
525
521
  var promises = {};
526
522
 
@@ -563,8 +559,8 @@ var __classPrivateFieldGet$f = (commonjsGlobal && commonjsGlobal.__classPrivateF
563
559
  return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
564
560
  };
565
561
  var _EmitterBase_emitterAccessor;
566
- Object.defineProperty(base$1, "__esModule", { value: true });
567
- base$1.Reply = base$1.EmitterBase = base$1.Base = void 0;
562
+ Object.defineProperty(base, "__esModule", { value: true });
563
+ base.Reply = base.EmitterBase = base.Base = void 0;
568
564
  const promises_1$2 = promises;
569
565
  class Base {
570
566
  /**
@@ -585,18 +581,11 @@ class Base {
585
581
  get fin() {
586
582
  return this.wire.getFin();
587
583
  }
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
- */
595
584
  get me() {
596
585
  return this.wire.me;
597
586
  }
598
587
  }
599
- base$1.Base = Base;
588
+ base.Base = Base;
600
589
  /**
601
590
  * An entity that emits OpenFin events.
602
591
  *
@@ -626,9 +615,6 @@ class EmitterBase extends Base {
626
615
  this.topic = topic;
627
616
  _EmitterBase_emitterAccessor.set(this, void 0);
628
617
  this.eventNames = () => (this.hasEmitter() ? this.getOrCreateEmitter().eventNames() : []);
629
- /**
630
- * @internal
631
- */
632
618
  this.emit = (eventType, payload, ...args) => {
633
619
  return this.hasEmitter() ? this.getOrCreateEmitter().emit(eventType, payload, ...args) : false;
634
620
  };
@@ -671,13 +657,16 @@ class EmitterBase extends Base {
671
657
  // This will only be reached if unsubscribe from event that does not exist but do not want to error here
672
658
  return Promise.resolve();
673
659
  };
660
+ this.addListener = this.on;
674
661
  __classPrivateFieldSet$d(this, _EmitterBase_emitterAccessor, [topic, ...additionalAccessors], "f");
675
662
  this.listeners = (event) => this.hasEmitter() ? this.getOrCreateEmitter().listeners(event) : [];
676
663
  }
677
664
  /**
678
665
  * Adds a listener to the end of the listeners array for the specified event.
679
666
  *
680
- * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
667
+ * @param eventType
668
+ * @param listener
669
+ * @param options
681
670
  */
682
671
  async on(eventType, listener, options) {
683
672
  await this.registerEventListener(eventType, options, (emitter) => {
@@ -687,16 +676,12 @@ class EmitterBase extends Base {
687
676
  });
688
677
  return this;
689
678
  }
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
- }
696
679
  /**
697
680
  * 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.
698
681
  *
699
- * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
682
+ * @param eventType
683
+ * @param listener
684
+ * @param options
700
685
  */
701
686
  async once(eventType, listener, options) {
702
687
  const deregister = () => this.deregisterEventListener(eventType);
@@ -712,7 +697,9 @@ class EmitterBase extends Base {
712
697
  /**
713
698
  * Adds a listener to the beginning of the listeners array for the specified event.
714
699
  *
715
- * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
700
+ * @param eventType
701
+ * @param listener
702
+ * @param options
716
703
  */
717
704
  async prependListener(eventType, listener, options) {
718
705
  await this.registerEventListener(eventType, options, (emitter) => {
@@ -726,7 +713,9 @@ class EmitterBase extends Base {
726
713
  * Adds a one time listener for the event. The listener is invoked only the first time the event is fired,
727
714
  * after which it is removed. The listener is added to the beginning of the listeners array.
728
715
  *
729
- * @remarks Event payloads are documented in the {@link OpenFin.Events} namespace.
716
+ * @param eventType
717
+ * @param listener
718
+ * @param options
730
719
  */
731
720
  async prependOnceListener(eventType, listener, options) {
732
721
  const deregister = () => this.deregisterEventListener(eventType);
@@ -743,6 +732,10 @@ class EmitterBase extends Base {
743
732
  * Remove a listener from the listener array for the specified event.
744
733
  *
745
734
  * @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
746
739
  */
747
740
  async removeListener(eventType, listener, options) {
748
741
  const emitter = await this.deregisterEventListener(eventType, options);
@@ -769,6 +762,7 @@ class EmitterBase extends Base {
769
762
  /**
770
763
  * Removes all listeners, or those of the specified event.
771
764
  *
765
+ * @param eventType
772
766
  */
773
767
  async removeAllListeners(eventType) {
774
768
  const removeByEvent = async (event) => {
@@ -793,11 +787,11 @@ class EmitterBase extends Base {
793
787
  }
794
788
  }
795
789
  }
796
- base$1.EmitterBase = EmitterBase;
790
+ base.EmitterBase = EmitterBase;
797
791
  _EmitterBase_emitterAccessor = new WeakMap();
798
792
  class Reply {
799
793
  }
800
- base$1.Reply = Reply;
794
+ base.Reply = Reply;
801
795
 
802
796
  var transportErrors = {};
803
797
 
@@ -880,7 +874,7 @@ class RuntimeError extends Error {
880
874
  }
881
875
  transportErrors.RuntimeError = RuntimeError;
882
876
 
883
- var window$2 = {};
877
+ var window$1 = {};
884
878
 
885
879
  var Factory$8 = {};
886
880
 
@@ -899,13 +893,13 @@ validate.validateIdentity = validateIdentity;
899
893
 
900
894
  var Instance$7 = {};
901
895
 
902
- var application$1 = {};
896
+ var application = {};
903
897
 
904
898
  var Factory$7 = {};
905
899
 
906
900
  var Instance$6 = {};
907
901
 
908
- var view$1 = {};
902
+ var view = {};
909
903
 
910
904
  var Factory$6 = {};
911
905
 
@@ -915,13 +909,9 @@ function requireFactory$3 () {
915
909
  if (hasRequiredFactory$3) return Factory$6;
916
910
  hasRequiredFactory$3 = 1;
917
911
  Object.defineProperty(Factory$6, "__esModule", { value: true });
918
- Factory$6.ViewModule = void 0;
919
- const base_1 = base$1;
912
+ const base_1 = base;
920
913
  const validate_1 = validate;
921
914
  const index_1 = requireView();
922
- /**
923
- * Static namespace for OpenFin API methods that interact with the {@link View} class, available under `fin.View`.
924
- */
925
915
  class ViewModule extends base_1.Base {
926
916
  /**
927
917
  * Creates a new View.
@@ -950,6 +940,7 @@ function requireFactory$3 () {
950
940
  * ```
951
941
  * Note that created views needs to navigate somewhere for them to actually render a website.
952
942
  * @experimental
943
+ * @static
953
944
  */
954
945
  async create(options) {
955
946
  const { uuid } = this.wire.me;
@@ -969,6 +960,7 @@ function requireFactory$3 () {
969
960
  }
970
961
  /**
971
962
  * Asynchronously returns a View object that represents an existing view.
963
+ * @param identity
972
964
  *
973
965
  * @example
974
966
  * ```js
@@ -977,6 +969,7 @@ function requireFactory$3 () {
977
969
  * .catch(err => console.log(err));
978
970
  * ```
979
971
  * @experimental
972
+ * @static
980
973
  */
981
974
  async wrap(identity) {
982
975
  this.wire.sendAction('view-wrap');
@@ -988,6 +981,7 @@ function requireFactory$3 () {
988
981
  }
989
982
  /**
990
983
  * Synchronously returns a View object that represents an existing view.
984
+ * @param identity
991
985
  *
992
986
  * @example
993
987
  * ```js
@@ -995,6 +989,7 @@ function requireFactory$3 () {
995
989
  * await view.hide();
996
990
  * ```
997
991
  * @experimental
992
+ * @static
998
993
  */
999
994
  wrapSync(identity) {
1000
995
  this.wire.sendAction('view-wrap-sync').catch((e) => {
@@ -1017,6 +1012,7 @@ function requireFactory$3 () {
1017
1012
  *
1018
1013
  * ```
1019
1014
  * @experimental
1015
+ * @static
1020
1016
  */
1021
1017
  getCurrent() {
1022
1018
  this.wire.sendAction('view-get-current').catch((e) => {
@@ -1038,6 +1034,7 @@ function requireFactory$3 () {
1038
1034
  *
1039
1035
  * ```
1040
1036
  * @experimental
1037
+ * @static
1041
1038
  */
1042
1039
  getCurrentSync() {
1043
1040
  this.wire.sendAction('view-get-current-sync').catch((e) => {
@@ -1050,7 +1047,7 @@ function requireFactory$3 () {
1050
1047
  return this.wrapSync({ uuid, name });
1051
1048
  }
1052
1049
  }
1053
- Factory$6.ViewModule = ViewModule;
1050
+ Factory$6.default = ViewModule;
1054
1051
  return Factory$6;
1055
1052
  }
1056
1053
 
@@ -1880,12 +1877,8 @@ var main = {};
1880
1877
 
1881
1878
  Object.defineProperty(main, "__esModule", { value: true });
1882
1879
  main.WebContents = void 0;
1883
- const base_1$k = base$1;
1880
+ const base_1$k = base;
1884
1881
  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
- */
1889
1882
  constructor(wire, identity, entityType) {
1890
1883
  super(wire, entityType, identity.uuid, identity.name);
1891
1884
  this.identity = identity;
@@ -1893,7 +1886,10 @@ class WebContents extends base_1$k.EmitterBase {
1893
1886
  }
1894
1887
  /**
1895
1888
  * Gets a base64 encoded image of all or part of the WebContents.
1889
+ * @function capturePage
1896
1890
  * @param options Options for the capturePage call.
1891
+ * @memberOf View
1892
+ * @instance
1897
1893
  *
1898
1894
  * @example
1899
1895
  *
@@ -1938,11 +1934,6 @@ class WebContents extends base_1$k.EmitterBase {
1938
1934
  * }
1939
1935
  * console.log(await wnd.capturePage(options));
1940
1936
  * ```
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}.
1946
1937
  */
1947
1938
  capturePage(options) {
1948
1939
  return this.wire.sendAction('capture-page', { options, ...this.identity }).then(({ payload }) => payload.data);
@@ -1951,6 +1942,9 @@ class WebContents extends base_1$k.EmitterBase {
1951
1942
  * Executes Javascript on the WebContents, restricted to contents you own or contents owned by
1952
1943
  * applications you have created.
1953
1944
  * @param code JavaScript code to be executed on the view.
1945
+ * @function executeJavaScript
1946
+ * @memberOf View
1947
+ * @instance
1954
1948
  *
1955
1949
  * @example
1956
1950
  * View:
@@ -1978,10 +1972,6 @@ class WebContents extends base_1$k.EmitterBase {
1978
1972
  *
1979
1973
  * executeJavaScript(`console.log('Hello, Openfin')`).then(() => console.log('Javascript excuted')).catch(err => console.log(err));
1980
1974
  * ```
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}.
1985
1975
  */
1986
1976
  executeJavaScript(code) {
1987
1977
  return this.wire
@@ -1990,6 +1980,9 @@ class WebContents extends base_1$k.EmitterBase {
1990
1980
  }
1991
1981
  /**
1992
1982
  * Returns the zoom level of the WebContents.
1983
+ * @function getZoomLevel
1984
+ * @memberOf View
1985
+ * @instance
1993
1986
  *
1994
1987
  * @example
1995
1988
  * View:
@@ -2021,10 +2014,6 @@ class WebContents extends base_1$k.EmitterBase {
2021
2014
  *
2022
2015
  * getZoomLevel().then(zoomLevel => console.log(zoomLevel)).catch(err => console.log(err));
2023
2016
  * ```
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}.
2028
2017
  */
2029
2018
  getZoomLevel() {
2030
2019
  return this.wire.sendAction('get-zoom-level', this.identity).then(({ payload }) => payload.data);
@@ -2032,6 +2021,9 @@ class WebContents extends base_1$k.EmitterBase {
2032
2021
  /**
2033
2022
  * Sets the zoom level of the WebContents.
2034
2023
  * @param level The zoom level
2024
+ * @function setZoomLevel
2025
+ * @memberOf View
2026
+ * @instance
2035
2027
  *
2036
2028
  * @example
2037
2029
  * View:
@@ -2063,10 +2055,6 @@ class WebContents extends base_1$k.EmitterBase {
2063
2055
  *
2064
2056
  * setZoomLevel(4).then(() => console.log('Setting a zoom level')).catch(err => console.log(err));
2065
2057
  * ```
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}.
2070
2058
  */
2071
2059
  setZoomLevel(level) {
2072
2060
  return this.wire.sendAction('set-zoom-level', { ...this.identity, level }).then(() => undefined);
@@ -2074,9 +2062,12 @@ class WebContents extends base_1$k.EmitterBase {
2074
2062
  /**
2075
2063
  * Navigates the WebContents to a specified URL.
2076
2064
  *
2077
- * Note: The url must contain the protocol prefix such as http:// or https://.
2065
+ * @remarks The url must contain the protocol prefix such as http:// or https://.
2078
2066
  * @param url - The URL to navigate the WebContents to.
2079
2067
  *
2068
+ * @function navigate
2069
+ * @memberof View
2070
+ * @instance
2080
2071
  * @example
2081
2072
  * View:
2082
2073
  * ```js
@@ -2104,16 +2095,15 @@ class WebContents extends base_1$k.EmitterBase {
2104
2095
  * navigate().then(() => console.log('Navigate to tutorial')).catch(err => console.log(err));
2105
2096
  * ```
2106
2097
  * @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}.
2111
2098
  */
2112
2099
  navigate(url) {
2113
2100
  return this.wire.sendAction('navigate-window', { ...this.identity, url }).then(() => undefined);
2114
2101
  }
2115
2102
  /**
2116
2103
  * Navigates the WebContents back one page.
2104
+ * @function navigateBack
2105
+ * @memberOf View
2106
+ * @instance
2117
2107
  *
2118
2108
  * @example
2119
2109
  * View:
@@ -2135,16 +2125,15 @@ class WebContents extends base_1$k.EmitterBase {
2135
2125
  * }
2136
2126
  * navigateBack().then(() => console.log('Navigated back')).catch(err => console.log(err));
2137
2127
  * ```
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}.
2142
2128
  */
2143
2129
  navigateBack() {
2144
2130
  return this.wire.sendAction('navigate-window-back', { ...this.identity }).then(() => undefined);
2145
2131
  }
2146
2132
  /**
2147
2133
  * Navigates the WebContents forward one page.
2134
+ * @function navigateForward
2135
+ * @memberOf View
2136
+ * @instance
2148
2137
  *
2149
2138
  * @example
2150
2139
  * View:
@@ -2168,16 +2157,15 @@ class WebContents extends base_1$k.EmitterBase {
2168
2157
  * }
2169
2158
  * navigateForward().then(() => console.log('Navigated forward')).catch(err => console.log(err));
2170
2159
  * ```
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}.
2175
2160
  */
2176
2161
  async navigateForward() {
2177
2162
  await this.wire.sendAction('navigate-window-forward', { ...this.identity });
2178
2163
  }
2179
2164
  /**
2180
2165
  * Stops any current navigation the WebContents is performing.
2166
+ * @function stopNavigation
2167
+ * @memberOf View
2168
+ * @instance
2181
2169
  *
2182
2170
  * @example
2183
2171
  * View:
@@ -2199,16 +2187,15 @@ class WebContents extends base_1$k.EmitterBase {
2199
2187
  * }
2200
2188
  * stopNavigation().then(() => console.log('you shall not navigate')).catch(err => console.log(err));
2201
2189
  * ```
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}.
2206
2190
  */
2207
2191
  stopNavigation() {
2208
2192
  return this.wire.sendAction('stop-window-navigation', { ...this.identity }).then(() => undefined);
2209
2193
  }
2210
2194
  /**
2211
2195
  * Reloads the WebContents
2196
+ * @function reload
2197
+ * @memberOf View
2198
+ * @instance
2212
2199
  *
2213
2200
  * @example
2214
2201
  * View:
@@ -2240,10 +2227,6 @@ class WebContents extends base_1$k.EmitterBase {
2240
2227
  * console.log('Reloaded window')
2241
2228
  * }).catch(err => console.log(err));
2242
2229
  * ```
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}.
2247
2230
  */
2248
2231
  reload(ignoreCache = false) {
2249
2232
  return this.wire
@@ -2256,8 +2239,11 @@ class WebContents extends base_1$k.EmitterBase {
2256
2239
  /**
2257
2240
  * Prints the WebContents.
2258
2241
  * @param options Printer Options
2242
+ * @function print
2243
+ * @memberOf View
2244
+ * @instance
2259
2245
  *
2260
- * Note: When `silent` is set to `true`, the API will pick the system's default printer if deviceName
2246
+ * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName
2261
2247
  * is empty and the default settings for printing.
2262
2248
  *
2263
2249
  * Use the CSS style `page-break-before: always;` to force print to a new page.
@@ -2270,10 +2256,6 @@ class WebContents extends base_1$k.EmitterBase {
2270
2256
  * console.log('print call has been sent to the system');
2271
2257
  * });
2272
2258
  * ```
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}.
2277
2259
  */
2278
2260
  print(options = {}) {
2279
2261
  return this.wire.sendAction('print', { ...this.identity, options }).then(() => undefined);
@@ -2282,8 +2264,11 @@ class WebContents extends base_1$k.EmitterBase {
2282
2264
  * Find and highlight text on a page.
2283
2265
  * @param searchTerm Term to find in page
2284
2266
  * @param options Search options
2267
+ * @function findInPage
2268
+ * @memberOf View
2269
+ * @instance
2285
2270
  *
2286
- * Note: By default, each subsequent call will highlight the next text that matches the search term.
2271
+ * @remarks By default, each subsequent call will highlight the next text that matches the search term.
2287
2272
  *
2288
2273
  * Returns a promise with the results for the request. By subscribing to the
2289
2274
  * found-in-page event, you can get the results of this call as well.
@@ -2318,10 +2303,6 @@ class WebContents extends base_1$k.EmitterBase {
2318
2303
  * console.log(result)
2319
2304
  * });
2320
2305
  * ```
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}.
2325
2306
  */
2326
2307
  findInPage(searchTerm, options) {
2327
2308
  return this.wire
@@ -2365,10 +2346,6 @@ class WebContents extends base_1$k.EmitterBase {
2365
2346
  * console.log(results);
2366
2347
  * });
2367
2348
  * ```
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}.
2372
2349
  */
2373
2350
  stopFindInPage(action) {
2374
2351
  return this.wire.sendAction('stop-find-in-page', { ...this.identity, action }).then(() => undefined);
@@ -2376,6 +2353,9 @@ class WebContents extends base_1$k.EmitterBase {
2376
2353
  /**
2377
2354
  * Returns an array with all system printers
2378
2355
  * @deprecated use System.getPrinters instead
2356
+ * @function getPrinters
2357
+ * @memberOf View
2358
+ * @instance
2379
2359
  *
2380
2360
  * @example
2381
2361
  * View:
@@ -2411,10 +2391,6 @@ class WebContents extends base_1$k.EmitterBase {
2411
2391
  * console.log(err);
2412
2392
  * });
2413
2393
  * ```
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}.
2418
2394
  */
2419
2395
  getPrinters() {
2420
2396
  return this.wire.sendAction('get-printers', { ...this.identity }).then(({ payload }) => payload.data);
@@ -2422,6 +2398,10 @@ class WebContents extends base_1$k.EmitterBase {
2422
2398
  /**
2423
2399
  * Gives focus to the WebContents.
2424
2400
  *
2401
+ * @function focus
2402
+ * @emits focused
2403
+ * @memberOf Window
2404
+ * @instance
2425
2405
  * @example
2426
2406
  * ```js
2427
2407
  * async function focusWindow() {
@@ -2437,16 +2417,15 @@ class WebContents extends base_1$k.EmitterBase {
2437
2417
  *
2438
2418
  * focusWindow().then(() => console.log('Window focused')).catch(err => console.log(err));
2439
2419
  * ```
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}.
2444
2420
  */
2445
2421
  async focus({ emitSynthFocused } = { emitSynthFocused: true }) {
2446
2422
  await this.wire.sendAction('focus-window', { emitSynthFocused, ...this.identity });
2447
2423
  }
2448
2424
  /**
2449
2425
  * Shows the Chromium Developer Tools
2426
+ * @function showDeveloperTools
2427
+ * @memberOf View
2428
+ * @instance
2450
2429
  *
2451
2430
  * @example
2452
2431
  * View:
@@ -2472,10 +2451,6 @@ class WebContents extends base_1$k.EmitterBase {
2472
2451
  * .then(() => console.log('Showing dev tools'))
2473
2452
  * .catch(err => console.error(err));
2474
2453
  * ```
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}.
2479
2454
  */
2480
2455
  async showDeveloperTools() {
2481
2456
  // Note this hits the system action map in core state for legacy reasons.
@@ -2484,7 +2459,11 @@ class WebContents extends base_1$k.EmitterBase {
2484
2459
  /**
2485
2460
  * Retrieves the process information associated with a WebContents.
2486
2461
  *
2487
- * Note: This includes any iframes associated with the WebContents
2462
+ * @remarks This includes any iframes associated with the WebContents
2463
+ *
2464
+ * @function getProcessInfo
2465
+ * @memberOf View
2466
+ * @instance
2488
2467
  *
2489
2468
  * @example
2490
2469
  * View:
@@ -2498,10 +2477,6 @@ class WebContents extends base_1$k.EmitterBase {
2498
2477
  * const win = await fin.Window.getCurrent();
2499
2478
  * const processInfo = await win.getProcessInfo();
2500
2479
  * ```
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}.
2505
2480
  */
2506
2481
  async getProcessInfo() {
2507
2482
  const { payload: { data } } = await this.wire.sendAction('get-process-info', this.identity);
@@ -2509,6 +2484,9 @@ class WebContents extends base_1$k.EmitterBase {
2509
2484
  }
2510
2485
  /**
2511
2486
  * Retrieves information on all Shared Workers.
2487
+ * @function getSharedWorkers
2488
+ * @memberOf View
2489
+ * @instance
2512
2490
  *
2513
2491
  * @example
2514
2492
  * View:
@@ -2537,16 +2515,15 @@ class WebContents extends base_1$k.EmitterBase {
2537
2515
  * const win = await fin.Window.create(winOption);
2538
2516
  * const sharedWorkers = await win.getSharedWorkers();
2539
2517
  * ```
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}.
2544
2518
  */
2545
2519
  async getSharedWorkers() {
2546
2520
  return this.wire.sendAction('get-shared-workers', this.identity).then(({ payload }) => payload.data);
2547
2521
  }
2548
2522
  /**
2549
2523
  * Opens the developer tools for the shared worker context.
2524
+ * @function inspectSharedWorker
2525
+ * @memberOf View
2526
+ * @instance
2550
2527
  *
2551
2528
  * @example
2552
2529
  * View:
@@ -2575,10 +2552,6 @@ class WebContents extends base_1$k.EmitterBase {
2575
2552
  * const win = await fin.Window.create(winOption);
2576
2553
  * await win.inspectSharedWorker();
2577
2554
  * ```
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}.
2582
2555
  */
2583
2556
  async inspectSharedWorker() {
2584
2557
  await this.wire.sendAction('inspect-shared-worker', { ...this.identity });
@@ -2586,6 +2559,9 @@ class WebContents extends base_1$k.EmitterBase {
2586
2559
  /**
2587
2560
  * Inspects the shared worker based on its ID.
2588
2561
  * @param workerId - The id of the shared worker.
2562
+ * @function inspectSharedWorkerById
2563
+ * @memberOf View
2564
+ * @instance
2589
2565
  *
2590
2566
  * @example
2591
2567
  * View:
@@ -2616,16 +2592,15 @@ class WebContents extends base_1$k.EmitterBase {
2616
2592
  * const sharedWorkers = await win.getSharedWorkers();
2617
2593
  * await win.inspectSharedWorkerById(sharedWorkers[0].id);
2618
2594
  * ```
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}.
2623
2595
  */
2624
2596
  async inspectSharedWorkerById(workerId) {
2625
2597
  await this.wire.sendAction('inspect-shared-worker-by-id', { ...this.identity, workerId });
2626
2598
  }
2627
2599
  /**
2628
2600
  * Opens the developer tools for the service worker context.
2601
+ * @function inspectServiceWorker
2602
+ * @memberOf View
2603
+ * @instance
2629
2604
  *
2630
2605
  * @example
2631
2606
  * View:
@@ -2654,10 +2629,6 @@ class WebContents extends base_1$k.EmitterBase {
2654
2629
  * const win = await fin.Window.create(winOption);
2655
2630
  * await win.inspectServiceWorker();
2656
2631
  * ```
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}.
2661
2632
  */
2662
2633
  async inspectServiceWorker() {
2663
2634
  await this.wire.sendAction('inspect-service-worker', { ...this.identity });
@@ -2665,7 +2636,7 @@ class WebContents extends base_1$k.EmitterBase {
2665
2636
  /**
2666
2637
  * Shows a popup window.
2667
2638
  *
2668
- * Note: If this WebContents is a view and its attached window has a popup open, this will close it.
2639
+ * @remarks If this WebContents is a view and its attached window has a popup open, this will close it.
2669
2640
  *
2670
2641
  * Shows a popup window. Including a `name` in `options` will attempt to show an existing window as a popup, if
2671
2642
  * that window doesn't exist or no `name` is included a window will be created. If the caller view or the caller
@@ -2673,7 +2644,7 @@ class WebContents extends base_1$k.EmitterBase {
2673
2644
  * open popup window before showing the new popup window. Also, if the caller view is destroyed or detached, the popup
2674
2645
  * will be dismissed.
2675
2646
  *
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.
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.
2677
2648
  *
2678
2649
  * @example
2679
2650
  *
@@ -2868,10 +2839,11 @@ class WebContents extends base_1$k.EmitterBase {
2868
2839
  * onPopupReady: popupWindowCallback;
2869
2840
  * });
2870
2841
  * ```
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}.
2842
+ * @function showPopupWindow
2843
+ * @memberOf View
2844
+ * @instance
2845
+ * @param options
2846
+ *
2875
2847
  */
2876
2848
  async showPopupWindow(options) {
2877
2849
  this.wire.sendAction(`${this.entityType}-show-popup-window`, this.identity).catch(() => {
@@ -3156,6 +3128,7 @@ function requireInstance$2 () {
3156
3128
  * Attaches the current view to the given window identity.
3157
3129
  * Identity must be the identity of a window in the same application.
3158
3130
  * This detaches the view from its current window, and sets the view to be destroyed when its new window closes.
3131
+ * @param target {Identity}
3159
3132
  *
3160
3133
  * @example
3161
3134
  * ```js
@@ -3284,6 +3257,7 @@ function requireInstance$2 () {
3284
3257
  };
3285
3258
  /**
3286
3259
  * Sets the bounds (top, left, width, height) of the view relative to its window.
3260
+ * @param bounds {ViewBounds}
3287
3261
  *
3288
3262
  * @remarks View position is relative to the bounds of the window.
3289
3263
  * ({top: 0, left: 0} represents the top left corner of the window)
@@ -3448,6 +3422,7 @@ function requireInstance$2 () {
3448
3422
  };
3449
3423
  /**
3450
3424
  * Updates the view's options.
3425
+ * @param options
3451
3426
  *
3452
3427
  * @example
3453
3428
  * ```js
@@ -3488,6 +3463,7 @@ function requireInstance$2 () {
3488
3463
  /**
3489
3464
  * Retrieves the window the view is currently attached to.
3490
3465
  *
3466
+ * @experimental
3491
3467
  * @example
3492
3468
  * ```js
3493
3469
  * const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
@@ -3495,7 +3471,6 @@ function requireInstance$2 () {
3495
3471
  * .then(win => console.log('current window', win))
3496
3472
  * .catch(err => console.log(err));)
3497
3473
  * ```
3498
- * @experimental
3499
3474
  */
3500
3475
  this.getCurrentWindow = async () => {
3501
3476
  const { payload: { data } } = await this.wire.sendAction('get-view-window', { ...this.identity });
@@ -3601,6 +3576,10 @@ function requireInstance$2 () {
3601
3576
  /**
3602
3577
  * Focuses the view
3603
3578
  *
3579
+ * @function focus
3580
+ * @memberof View
3581
+ * @emits focused
3582
+ * @instance
3604
3583
  * @example
3605
3584
  * ```js
3606
3585
  * const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
@@ -3623,7 +3602,7 @@ function requireInstance$2 () {
3623
3602
  var hasRequiredView;
3624
3603
 
3625
3604
  function requireView () {
3626
- if (hasRequiredView) return view$1;
3605
+ if (hasRequiredView) return view;
3627
3606
  hasRequiredView = 1;
3628
3607
  (function (exports) {
3629
3608
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
@@ -3642,20 +3621,19 @@ function requireView () {
3642
3621
  };
3643
3622
  Object.defineProperty(exports, "__esModule", { value: true });
3644
3623
  /**
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`.
3624
+ * Entry point for the OpenFin View namespace.
3649
3625
  *
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.
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.
3652
3629
  *
3653
3630
  * @packageDocumentation
3654
3631
  */
3655
- __exportStar(requireFactory$3(), exports);
3632
+ const Factory_1 = requireFactory$3();
3633
+ exports.default = Factory_1.default;
3656
3634
  __exportStar(requireInstance$2(), exports);
3657
- } (view$1));
3658
- return view$1;
3635
+ } (view));
3636
+ return view;
3659
3637
  }
3660
3638
 
3661
3639
  var hasRequiredInstance$1;
@@ -3666,7 +3644,7 @@ function requireInstance$1 () {
3666
3644
  Object.defineProperty(Instance$6, "__esModule", { value: true });
3667
3645
  Instance$6.Application = void 0;
3668
3646
  /* eslint-disable import/prefer-default-export */
3669
- const base_1 = base$1;
3647
+ const base_1 = base;
3670
3648
  const window_1 = requireWindow();
3671
3649
  const view_1 = requireView();
3672
3650
  /**
@@ -4141,7 +4119,6 @@ function requireInstance$1 () {
4141
4119
  /**
4142
4120
  * Sets or removes a custom JumpList for the application. Only applicable in Windows OS.
4143
4121
  * 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
- *
4145
4122
  * Note: If the "name" property is omitted it defaults to "tasks".
4146
4123
  * @param jumpListCategories An array of JumpList Categories to populate. If null, remove any existing JumpList configuration and set to Windows default.
4147
4124
  *
@@ -4442,7 +4419,6 @@ function requireInstance$1 () {
4442
4419
  }
4443
4420
  /**
4444
4421
  * Sets file auto download location. It's only allowed in the same application.
4445
- *
4446
4422
  * Note: This method is restricted by default and must be enabled via
4447
4423
  * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
4448
4424
  * @param downloadLocation file auto download location
@@ -4468,7 +4444,6 @@ function requireInstance$1 () {
4468
4444
  }
4469
4445
  /**
4470
4446
  * 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
- *
4472
4447
  * Note: This method is restricted by default and must be enabled via
4473
4448
  * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
4474
4449
  *
@@ -4495,16 +4470,13 @@ function requireFactory$2 () {
4495
4470
  if (hasRequiredFactory$2) return Factory$7;
4496
4471
  hasRequiredFactory$2 = 1;
4497
4472
  Object.defineProperty(Factory$7, "__esModule", { value: true });
4498
- Factory$7.ApplicationModule = void 0;
4499
- const base_1 = base$1;
4473
+ const base_1 = base;
4500
4474
  const validate_1 = validate;
4501
4475
  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
- */
4505
4476
  class ApplicationModule extends base_1.Base {
4506
4477
  /**
4507
4478
  * Asynchronously returns an Application object that represents an existing application.
4479
+ * @param identity
4508
4480
  *
4509
4481
  * @example
4510
4482
  *
@@ -4515,6 +4487,7 @@ function requireFactory$2 () {
4515
4487
  * .catch(err => console.log(err));
4516
4488
  * ```
4517
4489
  *
4490
+ * @static
4518
4491
  */
4519
4492
  async wrap(identity) {
4520
4493
  this.wire.sendAction('wrap-application').catch((e) => {
@@ -4528,6 +4501,7 @@ function requireFactory$2 () {
4528
4501
  }
4529
4502
  /**
4530
4503
  * Synchronously returns an Application object that represents an existing application.
4504
+ * @param identity
4531
4505
  *
4532
4506
  * @example
4533
4507
  *
@@ -4536,6 +4510,7 @@ function requireFactory$2 () {
4536
4510
  * await app.close();
4537
4511
  * ```
4538
4512
  *
4513
+ * @static
4539
4514
  */
4540
4515
  wrapSync(identity) {
4541
4516
  this.wire.sendAction('wrap-application-sync').catch((e) => {
@@ -4560,6 +4535,8 @@ function requireFactory$2 () {
4560
4535
  }
4561
4536
  /**
4562
4537
  * DEPRECATED method to create a new Application. Use {@link Application.ApplicationModule.start Application.start} instead.
4538
+ * @param appOptions
4539
+ *
4563
4540
  *
4564
4541
  * @example
4565
4542
  *
@@ -4588,6 +4565,7 @@ function requireFactory$2 () {
4588
4565
  }
4589
4566
  /**
4590
4567
  * Creates and starts a new Application.
4568
+ * @param appOptions
4591
4569
  *
4592
4570
  * @example
4593
4571
  *
@@ -4603,6 +4581,8 @@ function requireFactory$2 () {
4603
4581
  * start().then(() => console.log('Application is running')).catch(err => console.log(err));
4604
4582
  * ```
4605
4583
  *
4584
+ *
4585
+ * @static
4606
4586
  */
4607
4587
  async start(appOptions) {
4608
4588
  this.wire.sendAction('start-application').catch((e) => {
@@ -4615,8 +4595,10 @@ function requireFactory$2 () {
4615
4595
  /**
4616
4596
  * Asynchronously starts a batch of applications given an array of application identifiers and manifestUrls.
4617
4597
  * Returns once the RVM is finished attempting to launch the applications.
4598
+ * @param applications
4618
4599
  * @param opts - Parameters that the RVM will use.
4619
4600
  *
4601
+ * @static
4620
4602
  * @example
4621
4603
  *
4622
4604
  * ```js
@@ -4668,6 +4650,8 @@ function requireFactory$2 () {
4668
4650
  * });
4669
4651
  *
4670
4652
  * ```
4653
+ *
4654
+ * @static
4671
4655
  */
4672
4656
  getCurrent() {
4673
4657
  this.wire.sendAction('get-current-application').catch((e) => {
@@ -4693,6 +4677,8 @@ function requireFactory$2 () {
4693
4677
  * });
4694
4678
  *
4695
4679
  * ```
4680
+ *
4681
+ * @static
4696
4682
  */
4697
4683
  getCurrentSync() {
4698
4684
  this.wire.sendAction('get-current-application-sync').catch((e) => {
@@ -4713,6 +4699,8 @@ function requireFactory$2 () {
4713
4699
  * // For a local manifest file:
4714
4700
  * fin.Application.startFromManifest('file:///C:/somefolder/app.json').then(app => console.log('App is running')).catch(err => console.log(err));
4715
4701
  * ```
4702
+ *
4703
+ * @static
4716
4704
  */
4717
4705
  async startFromManifest(manifestUrl, opts) {
4718
4706
  this.wire.sendAction('application-start-from-manifest').catch((e) => {
@@ -4757,14 +4745,14 @@ function requireFactory$2 () {
4757
4745
  });
4758
4746
  }
4759
4747
  }
4760
- Factory$7.ApplicationModule = ApplicationModule;
4748
+ Factory$7.default = ApplicationModule;
4761
4749
  return Factory$7;
4762
4750
  }
4763
4751
 
4764
4752
  var hasRequiredApplication;
4765
4753
 
4766
4754
  function requireApplication () {
4767
- if (hasRequiredApplication) return application$1;
4755
+ if (hasRequiredApplication) return application;
4768
4756
  hasRequiredApplication = 1;
4769
4757
  (function (exports) {
4770
4758
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
@@ -4783,20 +4771,19 @@ function requireApplication () {
4783
4771
  };
4784
4772
  Object.defineProperty(exports, "__esModule", { value: true });
4785
4773
  /**
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`.
4774
+ * Entry point for the OpenFin Application namespace.
4790
4775
  *
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.
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.
4793
4779
  *
4794
4780
  * @packageDocumentation
4795
4781
  */
4796
- __exportStar(requireFactory$2(), exports);
4782
+ const Factory_1 = requireFactory$2();
4797
4783
  __exportStar(requireInstance$1(), exports);
4798
- } (application$1));
4799
- return application$1;
4784
+ exports.default = Factory_1.default;
4785
+ } (application));
4786
+ return application;
4800
4787
  }
4801
4788
 
4802
4789
  var hasRequiredInstance;
@@ -4919,7 +4906,7 @@ function requireInstance () {
4919
4906
  * alphaMask turns anything of matching RGB value transparent.
4920
4907
  * <br>
4921
4908
  * Caveats:
4922
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
4909
+ * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
4923
4910
  * * User cannot click-through transparent regions
4924
4911
  * * Not supported on Mac
4925
4912
  * * Windows Aero must be enabled
@@ -5107,7 +5094,6 @@ function requireInstance () {
5107
5094
  * A flag that specifies how transparent the window will be.
5108
5095
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
5109
5096
  * This value is clamped between `0.0` and `1.0`.
5110
- * * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
5111
5097
  *
5112
5098
  * @property {preloadScript[]} [preloadScripts] - _Inheritable_
5113
5099
  * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
@@ -5297,6 +5283,7 @@ function requireInstance () {
5297
5283
  */
5298
5284
  constructor(wire, identity) {
5299
5285
  super(wire, identity, 'window');
5286
+ this.identity = identity;
5300
5287
  }
5301
5288
  /**
5302
5289
  * Adds a listener to the end of the listeners array for the specified event.
@@ -6127,12 +6114,11 @@ function requireInstance () {
6127
6114
  * moveBy(580, 300).then(() => console.log('Moved')).catch(err => console.log(err));
6128
6115
  * ```
6129
6116
  */
6130
- moveBy(deltaLeft, deltaTop, positioningOptions) {
6117
+ moveBy(deltaLeft, deltaTop) {
6131
6118
  return this.wire
6132
6119
  .sendAction('move-window-by', {
6133
6120
  deltaLeft,
6134
6121
  deltaTop,
6135
- positioningOptions,
6136
6122
  ...this.identity
6137
6123
  })
6138
6124
  .then(() => undefined);
@@ -6162,12 +6148,11 @@ function requireInstance () {
6162
6148
  * moveTo(580, 300).then(() => console.log('Moved')).catch(err => console.log(err))
6163
6149
  * ```
6164
6150
  */
6165
- moveTo(left, top, positioningOptions) {
6151
+ moveTo(left, top) {
6166
6152
  return this.wire
6167
6153
  .sendAction('move-window', {
6168
6154
  left,
6169
6155
  top,
6170
- positioningOptions,
6171
6156
  ...this.identity
6172
6157
  })
6173
6158
  .then(() => undefined);
@@ -6200,13 +6185,12 @@ function requireInstance () {
6200
6185
  * resizeBy(580, 300, 'top-right').then(() => console.log('Resized')).catch(err => console.log(err));
6201
6186
  * ```
6202
6187
  */
6203
- resizeBy(deltaWidth, deltaHeight, anchor, positioningOptions) {
6188
+ resizeBy(deltaWidth, deltaHeight, anchor) {
6204
6189
  return this.wire
6205
6190
  .sendAction('resize-window-by', {
6206
6191
  deltaWidth: Math.floor(deltaWidth),
6207
6192
  deltaHeight: Math.floor(deltaHeight),
6208
6193
  anchor,
6209
- positioningOptions,
6210
6194
  ...this.identity
6211
6195
  })
6212
6196
  .then(() => undefined);
@@ -6239,13 +6223,12 @@ function requireInstance () {
6239
6223
  * resizeTo(580, 300, 'top-left').then(() => console.log('Resized')).catch(err => console.log(err));
6240
6224
  * ```
6241
6225
  */
6242
- resizeTo(width, height, anchor, positioningOptions) {
6226
+ resizeTo(width, height, anchor) {
6243
6227
  return this.wire
6244
6228
  .sendAction('resize-window', {
6245
6229
  width: Math.floor(width),
6246
6230
  height: Math.floor(height),
6247
6231
  anchor,
6248
- positioningOptions,
6249
6232
  ...this.identity
6250
6233
  })
6251
6234
  .then(() => undefined);
@@ -6304,6 +6287,7 @@ function requireInstance () {
6304
6287
  }
6305
6288
  /**
6306
6289
  * 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
6307
6291
  *
6308
6292
  * @example
6309
6293
  * ```js
@@ -6330,10 +6314,8 @@ function requireInstance () {
6330
6314
  * }).then(() => console.log('Bounds set to window')).catch(err => console.log(err));
6331
6315
  * ```
6332
6316
  */
6333
- setBounds(bounds, positioningOptions) {
6334
- return this.wire
6335
- .sendAction('set-window-bounds', { ...bounds, ...this.identity, positioningOptions })
6336
- .then(() => undefined);
6317
+ setBounds(bounds) {
6318
+ return this.wire.sendAction('set-window-bounds', { ...bounds, ...this.identity }).then(() => undefined);
6337
6319
  }
6338
6320
  /**
6339
6321
  * Shows the window if it is hidden.
@@ -6475,10 +6457,7 @@ function requireInstance () {
6475
6457
  * Calling this method will close previously opened menus.
6476
6458
  * @experimental
6477
6459
  * @param options
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.
6460
+ *
6482
6461
  * @example
6483
6462
  * This could be used to show a drop down menu over views in a platform window:
6484
6463
  * ```js
@@ -6568,7 +6547,6 @@ function requireInstance () {
6568
6547
  return this.wire.sendAction('close-popup-menu', { ...this.identity }).then(() => undefined);
6569
6548
  }
6570
6549
  /**
6571
- * @PORTED
6572
6550
  * @typedef {object} PopupOptions
6573
6551
  * @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.
6574
6552
  * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
@@ -6586,7 +6564,6 @@ function requireInstance () {
6586
6564
  * @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.
6587
6565
  */
6588
6566
  /**
6589
- * @PORTED
6590
6567
  * @typedef {object} PopupResult
6591
6568
  * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
6592
6569
  * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
@@ -6676,16 +6653,13 @@ function requireFactory$1 () {
6676
6653
  if (hasRequiredFactory$1) return Factory$8;
6677
6654
  hasRequiredFactory$1 = 1;
6678
6655
  Object.defineProperty(Factory$8, "__esModule", { value: true });
6679
- Factory$8._WindowModule = void 0;
6680
- const base_1 = base$1;
6656
+ const base_1 = base;
6681
6657
  const validate_1 = validate;
6682
6658
  const Instance_1 = requireInstance();
6683
- /**
6684
- * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
6685
- */
6686
6659
  class _WindowModule extends base_1.Base {
6687
6660
  /**
6688
6661
  * Asynchronously returns a Window object that represents an existing window.
6662
+ * @param identity
6689
6663
  *
6690
6664
  * @example
6691
6665
  * ```js
@@ -6702,6 +6676,7 @@ function requireFactory$1 () {
6702
6676
  * .then(win => console.log('wrapped window'))
6703
6677
  * .catch(err => console.log(err));
6704
6678
  * ```
6679
+ * @static
6705
6680
  */
6706
6681
  async wrap(identity) {
6707
6682
  this.wire.sendAction('window-wrap').catch((e) => {
@@ -6715,6 +6690,7 @@ function requireFactory$1 () {
6715
6690
  }
6716
6691
  /**
6717
6692
  * Synchronously returns a Window object that represents an existing window.
6693
+ * @param identity
6718
6694
  *
6719
6695
  * @example
6720
6696
  * ```js
@@ -6730,6 +6706,7 @@ function requireFactory$1 () {
6730
6706
  * await createWin();
6731
6707
  * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
6732
6708
  * ```
6709
+ * @static
6733
6710
  */
6734
6711
  wrapSync(identity) {
6735
6712
  this.wire.sendAction('window-wrap-sync').catch((e) => {
@@ -6761,6 +6738,7 @@ function requireFactory$1 () {
6761
6738
  *
6762
6739
  * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
6763
6740
  * ```
6741
+ * @static
6764
6742
  */
6765
6743
  create(options) {
6766
6744
  this.wire.sendAction('create-window').catch((e) => {
@@ -6779,6 +6757,7 @@ function requireFactory$1 () {
6779
6757
  * .catch(err => console.log(err));
6780
6758
  *
6781
6759
  * ```
6760
+ * @static
6782
6761
  */
6783
6762
  getCurrent() {
6784
6763
  this.wire.sendAction('get-current-window').catch((e) => {
@@ -6800,6 +6779,7 @@ function requireFactory$1 () {
6800
6779
  * console.log(info);
6801
6780
  *
6802
6781
  * ```
6782
+ * @static
6803
6783
  */
6804
6784
  getCurrentSync() {
6805
6785
  this.wire.sendAction('get-current-window-sync').catch((e) => {
@@ -6812,14 +6792,14 @@ function requireFactory$1 () {
6812
6792
  return this.wrapSync({ uuid, name });
6813
6793
  }
6814
6794
  }
6815
- Factory$8._WindowModule = _WindowModule;
6795
+ Factory$8.default = _WindowModule;
6816
6796
  return Factory$8;
6817
6797
  }
6818
6798
 
6819
6799
  var hasRequiredWindow;
6820
6800
 
6821
6801
  function requireWindow () {
6822
- if (hasRequiredWindow) return window$2;
6802
+ if (hasRequiredWindow) return window$1;
6823
6803
  hasRequiredWindow = 1;
6824
6804
  (function (exports) {
6825
6805
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
@@ -6838,34 +6818,25 @@ function requireWindow () {
6838
6818
  };
6839
6819
  Object.defineProperty(exports, "__esModule", { value: true });
6840
6820
  /**
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`.
6821
+ * Entry point for the OpenFin Window namespace.
6845
6822
  *
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.
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.
6848
6826
  *
6849
- * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
6827
+ * Because the `Window` name aliases a DOM entity, the documentation pipeline prefixes the name with an underscore.
6850
6828
  *
6851
6829
  * @packageDocumentation
6852
6830
  */
6853
- __exportStar(requireFactory$1(), exports);
6831
+ const Factory_1 = requireFactory$1();
6832
+ exports.default = Factory_1.default;
6854
6833
  __exportStar(requireInstance(), exports);
6855
- } (window$2));
6856
- return window$2;
6834
+ } (window$1));
6835
+ return window$1;
6857
6836
  }
6858
6837
 
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;
6838
+ Object.defineProperty(system, "__esModule", { value: true });
6839
+ const base_1$j = base;
6869
6840
  const transport_errors_1$2 = transportErrors;
6870
6841
  const window_1 = requireWindow();
6871
6842
  const events_1$6 = eventsExports;
@@ -7180,6 +7151,7 @@ class System extends base_1$j.EmitterBase {
7180
7151
  * ```js
7181
7152
  * fin.System.getUniqueUserId().then(id => console.log(id)).catch(err => console.log(err));
7182
7153
  * ```
7154
+ * @static
7183
7155
  */
7184
7156
  getUniqueUserId() {
7185
7157
  return this.wire.sendAction('get-unique-user-id').then(({ payload }) => payload.data);
@@ -7870,8 +7842,7 @@ class System extends base_1$j.EmitterBase {
7870
7842
  }
7871
7843
  /**
7872
7844
  * Attempt to close an external process. The process will be terminated if it
7873
- * has not closed after the elapsed timeout in milliseconds.
7874
- *
7845
+ * has not closed after the elapsed timeout in milliseconds.<br>
7875
7846
  * Note: This method is restricted by default and must be enabled via
7876
7847
  * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
7877
7848
  * @param options A object defined in the TerminateExternalRequestType interface
@@ -7907,8 +7878,7 @@ class System extends base_1$j.EmitterBase {
7907
7878
  return this.wire.sendAction('update-proxy', options).then(() => undefined);
7908
7879
  }
7909
7880
  /**
7910
- * Downloads the given application asset.
7911
- *
7881
+ * Downloads the given application asset<br>
7912
7882
  * Note: This method is restricted by default and must be enabled via
7913
7883
  * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
7914
7884
  * @param appAsset App asset object
@@ -8452,6 +8422,7 @@ class System extends base_1$j.EmitterBase {
8452
8422
  * }
8453
8423
  * });
8454
8424
  * ```
8425
+ * @static
8455
8426
  */
8456
8427
  async launchManifest(manifestUrl, opts = {}) {
8457
8428
  const { subscribe, ..._sendOpts } = opts;
@@ -8711,7 +8682,7 @@ class System extends base_1$j.EmitterBase {
8711
8682
  await this.wire.sendAction('set-domain-settings', { domainSettings, ...this.identity });
8712
8683
  }
8713
8684
  }
8714
- system$1.System = System;
8685
+ system.default = System;
8715
8686
 
8716
8687
  var interappbus = {};
8717
8688
 
@@ -9122,7 +9093,6 @@ var __classPrivateFieldSet$b = (commonjsGlobal && commonjsGlobal.__classPrivateF
9122
9093
  };
9123
9094
  var _ChannelClient_protectedObj, _ChannelClient_strategy, _ChannelClient_close;
9124
9095
  Object.defineProperty(client, "__esModule", { value: true });
9125
- client.ChannelClient = void 0;
9126
9096
  const channel_1$1 = channel;
9127
9097
  const channelClientsByEndpointId = new Map();
9128
9098
  /**
@@ -9131,17 +9101,17 @@ const channelClientsByEndpointId = new Map();
9131
9101
  * provider via {@link ChannelClient#dispatch dispatch} and to listen for communication
9132
9102
  * from the provider by registering an action via {@link ChannelClient#register register}.
9133
9103
  *
9134
- * ### Synchronous Methods:
9104
+ * Synchronous Methods:
9135
9105
  * * {@link ChannelClient#onDisconnection onDisconnection(listener)}
9136
9106
  * * {@link ChannelClient#register register(action, listener)}
9137
9107
  * * {@link ChannelClient#remove remove(action)}
9138
9108
  *
9139
- * ### Asynchronous Methods:
9109
+ * Asynchronous Methods:
9140
9110
  * * {@link ChannelClient#disconnect disconnect()}
9141
9111
  * * {@link ChannelClient#dispatch dispatch(action, payload)}
9142
9112
  *
9143
- * ### Middleware:
9144
- * Middleware functions receive the following arguments: (action, payload, senderId).
9113
+ * Middleware:
9114
+ * <br>Middleware functions receive the following arguments: (action, payload, senderId).
9145
9115
  * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
9146
9116
  * unless it is undefined, in which case the original payload is used. Middleware can be used for side effects.
9147
9117
  * * {@link ChannelClient#setDefaultAction setDefaultAction(middleware)}
@@ -9288,7 +9258,7 @@ class ChannelClient extends channel_1$1.ChannelBase {
9288
9258
  });
9289
9259
  }
9290
9260
  }
9291
- client.ChannelClient = ChannelClient;
9261
+ client.default = ChannelClient;
9292
9262
  _ChannelClient_protectedObj = new WeakMap(), _ChannelClient_strategy = new WeakMap(), _ChannelClient_close = new WeakMap();
9293
9263
 
9294
9264
  var connectionManager = {};
@@ -9653,7 +9623,7 @@ var iceManager = {};
9653
9623
 
9654
9624
  Object.defineProperty(iceManager, "__esModule", { value: true });
9655
9625
  iceManager.RTCICEManager = void 0;
9656
- const base_1$i = base$1;
9626
+ const base_1$i = base;
9657
9627
  /*
9658
9628
  Singleton that facilitates Offer and Answer exchange required for establishing RTC connections.
9659
9629
  */
@@ -9831,20 +9801,20 @@ const runtimeVersioning_1 = runtimeVersioning;
9831
9801
  * a single client via {@link ChannelProvider#dispatch dispatch} or all clients via {@link ChannelProvider#publish publish}
9832
9802
  * and to listen for communication from clients by registering an action via {@link ChannelProvider#register register}.
9833
9803
  *
9834
- * ### Synchronous Methods:
9804
+ * Synchronous Methods:
9835
9805
  * * {@link ChannelProvider#onConnection onConnection(listener)}
9836
9806
  * * {@link ChannelProvider#onDisconnection onDisconnection(listener)}
9837
9807
  * * {@link ChannelProvider#publish publish(action, payload)}
9838
9808
  * * {@link ChannelProvider#register register(action, listener)}
9839
9809
  * * {@link ChannelProvider#remove remove(action)}
9840
9810
  *
9841
- * ### Asynchronous Methods:
9811
+ * Asynchronous Methods:
9842
9812
  * * {@link ChannelProvider#destroy destroy()}
9843
9813
  * * {@link ChannelProvider#dispatch dispatch(to, action, payload)}
9844
9814
  * * {@link ChannelProvider#getAllClientInfo getAllClientInfo()}
9845
9815
  *
9846
- * ### Middleware:
9847
- * Middleware functions receive the following arguments: (action, payload, senderId).
9816
+ * Middleware:
9817
+ * <br>Middleware functions receive the following arguments: (action, payload, senderId).
9848
9818
  * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
9849
9819
  * unless it is undefined, in which case the most recently defined payload is used. Middleware can be used for side effects.
9850
9820
  * * {@link ChannelProvider#setDefaultAction setDefaultAction(middleware)}
@@ -10153,7 +10123,7 @@ var messageReceiver = {};
10153
10123
  Object.defineProperty(messageReceiver, "__esModule", { value: true });
10154
10124
  messageReceiver.MessageReceiver = void 0;
10155
10125
  const client_1$1 = client;
10156
- const base_1$h = base$1;
10126
+ const base_1$h = base;
10157
10127
  /*
10158
10128
  This is a singleton (per fin object) tasked with routing messages coming off the ipc to the correct endpoint.
10159
10129
  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.
@@ -10213,7 +10183,7 @@ class MessageReceiver extends base_1$h.Base {
10213
10183
  const endpointIdFromPreviousConnection = this.latestEndpointIdByChannelId.get(channelId);
10214
10184
  if (endpointIdFromPreviousConnection) {
10215
10185
  // Not convinced by this way of doing things, but pushing up for now.
10216
- client_1$1.ChannelClient.closeChannelByEndpointId(endpointIdFromPreviousConnection);
10186
+ client_1$1.default.closeChannelByEndpointId(endpointIdFromPreviousConnection);
10217
10187
  // eslint-disable-next-line no-console
10218
10188
  console.warn('You have created a second connection to an older provider. First connection has been removed from the clientMap');
10219
10189
  // eslint-disable-next-line no-console
@@ -10343,7 +10313,7 @@ var _ConnectionManager_messageReceiver, _ConnectionManager_rtcConnectionManager;
10343
10313
  Object.defineProperty(connectionManager, "__esModule", { value: true });
10344
10314
  connectionManager.ConnectionManager = void 0;
10345
10315
  const exhaustive_1 = exhaustive;
10346
- const base_1$g = base$1;
10316
+ const base_1$g = base;
10347
10317
  const strategy_1 = strategy$2;
10348
10318
  const strategy_2 = strategy$1;
10349
10319
  const ice_manager_1 = iceManager;
@@ -10574,15 +10544,6 @@ class ConnectionManager extends base_1$g.Base {
10574
10544
  connectionManager.ConnectionManager = ConnectionManager;
10575
10545
  _ConnectionManager_messageReceiver = new WeakMap(), _ConnectionManager_rtcConnectionManager = new WeakMap();
10576
10546
 
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
- */
10586
10547
  var __classPrivateFieldSet$5 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
10587
10548
  if (kind === "m") throw new TypeError("Private method is not writable");
10588
10549
  if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
@@ -10600,7 +10561,7 @@ channel$1.Channel = void 0;
10600
10561
  /* eslint-disable no-console */
10601
10562
  const events_1$5 = eventsExports;
10602
10563
  const lazy_1$1 = lazy;
10603
- const base_1$f = base$1;
10564
+ const base_1$f = base;
10604
10565
  const client_1 = client;
10605
10566
  const connection_manager_1 = connectionManager;
10606
10567
  const provider_1 = provider;
@@ -10643,7 +10604,7 @@ class Channel extends base_1$f.EmitterBase {
10643
10604
  _Channel_readyToConnect.set(this, new lazy_1$1.AsyncRetryableLazy(async () => {
10644
10605
  await Promise.all([
10645
10606
  this.on('disconnected', (eventPayload) => {
10646
- client_1.ChannelClient.handleProviderDisconnect(eventPayload);
10607
+ client_1.default.handleProviderDisconnect(eventPayload);
10647
10608
  }),
10648
10609
  this.on('connected', (...args) => {
10649
10610
  __classPrivateFieldGet$7(this, _Channel_internalEmitter, "f").emit('connected', ...args);
@@ -10834,7 +10795,7 @@ class Channel extends base_1$f.EmitterBase {
10834
10795
  };
10835
10796
  const routingInfo = await this.safeConnect(channelName, opts.wait, connectPayload);
10836
10797
  const strategy = await __classPrivateFieldGet$7(this, _Channel_connectionManager, "f").createClientStrategy(rtcPacket, routingInfo);
10837
- const channel = new client_1.ChannelClient(routingInfo, this.wire, strategy);
10798
+ const channel = new client_1.default(routingInfo, this.wire, strategy);
10838
10799
  // It is the client's responsibility to handle endpoint disconnection to the provider.
10839
10800
  // If the endpoint dies, the client will force a disconnection through the core.
10840
10801
  // The provider does not care about endpoint disconnection.
@@ -10846,7 +10807,7 @@ class Channel extends base_1$f.EmitterBase {
10846
10807
  console.warn(`Something went wrong during disconnect for client with uuid: ${routingInfo.uuid} / name: ${routingInfo.name} / endpointId: ${routingInfo.endpointId}.`);
10847
10808
  }
10848
10809
  finally {
10849
- client_1.ChannelClient.handleProviderDisconnect(routingInfo);
10810
+ client_1.default.handleProviderDisconnect(routingInfo);
10850
10811
  }
10851
10812
  });
10852
10813
  return channel;
@@ -10917,16 +10878,9 @@ channel$1.Channel = Channel;
10917
10878
  _Channel_connectionManager = new WeakMap(), _Channel_internalEmitter = new WeakMap(), _Channel_readyToConnect = new WeakMap();
10918
10879
 
10919
10880
  Object.defineProperty(interappbus, "__esModule", { value: true });
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
- */
10881
+ interappbus.InterAppPayload = void 0;
10928
10882
  const events_1$4 = eventsExports;
10929
- const base_1$e = base$1;
10883
+ const base_1$e = base;
10930
10884
  const ref_counter_1 = refCounter;
10931
10885
  const index_1$2 = channel$1;
10932
10886
  const validate_1$3 = validate;
@@ -11116,7 +11070,7 @@ class InterApplicationBus extends base_1$e.Base {
11116
11070
  return true;
11117
11071
  }
11118
11072
  }
11119
- interappbus.InterApplicationBus = InterApplicationBus;
11073
+ interappbus.default = InterApplicationBus;
11120
11074
  /**
11121
11075
  * @internal
11122
11076
  */
@@ -11133,16 +11087,8 @@ function createKey(...toHash) {
11133
11087
 
11134
11088
  var clipboard = {};
11135
11089
 
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
- */
11143
11090
  Object.defineProperty(clipboard, "__esModule", { value: true });
11144
- clipboard.Clipboard = void 0;
11145
- const base_1$d = base$1;
11091
+ const base_1$d = base;
11146
11092
  /**
11147
11093
  * @PORTED
11148
11094
  * WriteRequestType interface
@@ -11339,9 +11285,9 @@ class Clipboard extends base_1$d.Base {
11339
11285
  return payload.data;
11340
11286
  }
11341
11287
  }
11342
- clipboard.Clipboard = Clipboard;
11288
+ clipboard.default = Clipboard;
11343
11289
 
11344
- var externalApplication$1 = {};
11290
+ var externalApplication = {};
11345
11291
 
11346
11292
  var Factory$5 = {};
11347
11293
 
@@ -11350,11 +11296,11 @@ var Instance$4 = {};
11350
11296
  Object.defineProperty(Instance$4, "__esModule", { value: true });
11351
11297
  Instance$4.ExternalApplication = void 0;
11352
11298
  /* eslint-disable import/prefer-default-export */
11353
- const base_1$c = base$1;
11299
+ const base_1$c = base;
11354
11300
  /**
11355
11301
  * An ExternalApplication object representing native language adapter connections to the runtime. Allows
11356
11302
  * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
11357
- * Discovery of connections is provided by {@link System.System.getAllExternalApplications getAllExternalApplications}.</a>
11303
+ * Discovery of connections is provided by <a href="tutorial-System.getAllExternalApplications.html">getAllExternalApplications.</a>
11358
11304
  *
11359
11305
  * Processes that can be wrapped as `ExternalApplication`s include the following:
11360
11306
  * - Processes which have connected to an OpenFin runtime via an adapter
@@ -11465,12 +11411,8 @@ class ExternalApplication extends base_1$c.EmitterBase {
11465
11411
  Instance$4.ExternalApplication = ExternalApplication;
11466
11412
 
11467
11413
  Object.defineProperty(Factory$5, "__esModule", { value: true });
11468
- Factory$5.ExternalApplicationModule = void 0;
11469
- const base_1$b = base$1;
11414
+ const base_1$b = base;
11470
11415
  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
- */
11474
11416
  class ExternalApplicationModule extends base_1$b.Base {
11475
11417
  /**
11476
11418
  * Asynchronously returns an External Application object that represents an external application.
@@ -11484,6 +11426,7 @@ class ExternalApplicationModule extends base_1$b.Base {
11484
11426
  * .then(extApp => console.log('wrapped external application'))
11485
11427
  * .catch(err => console.log(err));
11486
11428
  * ```
11429
+ * @static
11487
11430
  */
11488
11431
  wrap(uuid) {
11489
11432
  this.wire.sendAction('external-application-wrap').catch((e) => {
@@ -11503,6 +11446,7 @@ class ExternalApplicationModule extends base_1$b.Base {
11503
11446
  * const info = await extApp.getInfo();
11504
11447
  * console.log(info);
11505
11448
  * ```
11449
+ * @static
11506
11450
  */
11507
11451
  wrapSync(uuid) {
11508
11452
  this.wire.sendAction('external-application-wrap-sync').catch((e) => {
@@ -11511,9 +11455,18 @@ class ExternalApplicationModule extends base_1$b.Base {
11511
11455
  return new Instance_1$4.ExternalApplication(this.wire, { uuid });
11512
11456
  }
11513
11457
  }
11514
- Factory$5.ExternalApplicationModule = ExternalApplicationModule;
11458
+ Factory$5.default = ExternalApplicationModule;
11515
11459
 
11516
11460
  (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
+ */
11517
11470
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
11518
11471
  if (k2 === undefined) k2 = k;
11519
11472
  var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -11529,22 +11482,12 @@ Factory$5.ExternalApplicationModule = ExternalApplicationModule;
11529
11482
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
11530
11483
  };
11531
11484
  Object.defineProperty(exports, "__esModule", { value: true });
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);
11485
+ const Factory_1 = Factory$5;
11486
+ exports.default = Factory_1.default;
11544
11487
  __exportStar(Instance$4, exports);
11545
- } (externalApplication$1));
11488
+ } (externalApplication));
11546
11489
 
11547
- var frame$1 = {};
11490
+ var frame = {};
11548
11491
 
11549
11492
  var Factory$4 = {};
11550
11493
 
@@ -11553,7 +11496,7 @@ var Instance$3 = {};
11553
11496
  Object.defineProperty(Instance$3, "__esModule", { value: true });
11554
11497
  Instance$3._Frame = void 0;
11555
11498
  /* eslint-disable import/prefer-default-export */
11556
- const base_1$a = base$1;
11499
+ const base_1$a = base;
11557
11500
  /**
11558
11501
  * An iframe represents an embedded HTML page within a parent HTML page. Because this embedded page
11559
11502
  * has its own DOM and global JS context (which may or may not be linked to that of the parent depending
@@ -11694,13 +11637,9 @@ class _Frame extends base_1$a.EmitterBase {
11694
11637
  Instance$3._Frame = _Frame;
11695
11638
 
11696
11639
  Object.defineProperty(Factory$4, "__esModule", { value: true });
11697
- Factory$4._FrameModule = void 0;
11698
- const base_1$9 = base$1;
11640
+ const base_1$9 = base;
11699
11641
  const validate_1$2 = validate;
11700
11642
  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
- */
11704
11643
  class _FrameModule extends base_1$9.Base {
11705
11644
  /**
11706
11645
  * Asynchronously returns a reference to the specified frame. The frame does not have to exist
@@ -11712,6 +11651,7 @@ class _FrameModule extends base_1$9.Base {
11712
11651
  * .then(frm => console.log('wrapped frame'))
11713
11652
  * .catch(err => console.log(err));
11714
11653
  * ```
11654
+ * @static
11715
11655
  */
11716
11656
  async wrap(identity) {
11717
11657
  this.wire.sendAction('frame-wrap').catch((e) => {
@@ -11733,6 +11673,7 @@ class _FrameModule extends base_1$9.Base {
11733
11673
  * const info = await frm.getInfo();
11734
11674
  * console.log(info);
11735
11675
  * ```
11676
+ * @static
11736
11677
  */
11737
11678
  wrapSync(identity) {
11738
11679
  this.wire.sendAction('frame-wrap-sync').catch((e) => {
@@ -11753,6 +11694,7 @@ class _FrameModule extends base_1$9.Base {
11753
11694
  * .then(frm => console.log('current frame'))
11754
11695
  * .catch(err => console.log(err));
11755
11696
  * ```
11697
+ * @static
11756
11698
  */
11757
11699
  getCurrent() {
11758
11700
  this.wire.sendAction('frame-get-current').catch((e) => {
@@ -11769,6 +11711,7 @@ class _FrameModule extends base_1$9.Base {
11769
11711
  * const info = await frm.getInfo();
11770
11712
  * console.log(info);
11771
11713
  * ```
11714
+ * @static
11772
11715
  */
11773
11716
  getCurrentSync() {
11774
11717
  this.wire.sendAction('frame-get-current-sync').catch((e) => {
@@ -11777,19 +11720,17 @@ class _FrameModule extends base_1$9.Base {
11777
11720
  return new Instance_1$3._Frame(this.wire, this.wire.environment.getCurrentEntityIdentity());
11778
11721
  }
11779
11722
  }
11780
- Factory$4._FrameModule = _FrameModule;
11723
+ Factory$4.default = _FrameModule;
11781
11724
 
11782
11725
  (function (exports) {
11783
11726
  /**
11784
- * Entry points for the OpenFin `Frame` API (`fin.Frame`).
11727
+ * Entry point for the OpenFin Frame namespace.
11785
11728
  *
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`.
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.
11788
11732
  *
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.
11733
+ * Because the `Frame` name aliases a DOM entity, the documentation pipeline prefixes the name with an underscore.
11793
11734
  *
11794
11735
  * @packageDocumentation
11795
11736
  */
@@ -11808,15 +11749,15 @@ Factory$4._FrameModule = _FrameModule;
11808
11749
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
11809
11750
  };
11810
11751
  Object.defineProperty(exports, "__esModule", { value: true });
11811
- __exportStar(Factory$4, exports);
11752
+ const Factory_1 = Factory$4;
11753
+ exports.default = Factory_1.default;
11812
11754
  __exportStar(Instance$3, exports);
11813
- } (frame$1));
11755
+ } (frame));
11814
11756
 
11815
- var globalHotkey$1 = {};
11757
+ var globalHotkey = {};
11816
11758
 
11817
- Object.defineProperty(globalHotkey$1, "__esModule", { value: true });
11818
- globalHotkey$1.GlobalHotkey = void 0;
11819
- const base_1$8 = base$1;
11759
+ Object.defineProperty(globalHotkey, "__esModule", { value: true });
11760
+ const base_1$8 = base;
11820
11761
  /**
11821
11762
  * The GlobalHotkey module can register/unregister a global hotkeys.
11822
11763
  *
@@ -11945,9 +11886,9 @@ class GlobalHotkey extends base_1$8.EmitterBase {
11945
11886
  return data;
11946
11887
  }
11947
11888
  }
11948
- globalHotkey$1.GlobalHotkey = GlobalHotkey;
11889
+ globalHotkey.default = GlobalHotkey;
11949
11890
 
11950
- var platform$1 = {};
11891
+ var platform = {};
11951
11892
 
11952
11893
  var Factory$3 = {};
11953
11894
 
@@ -11962,14 +11903,16 @@ var _Platform_connectToProvider;
11962
11903
  Object.defineProperty(Instance$2, "__esModule", { value: true });
11963
11904
  Instance$2.Platform = void 0;
11964
11905
  /* eslint-disable import/prefer-default-export, no-undef */
11965
- const base_1$7 = base$1;
11906
+ const base_1$7 = base;
11966
11907
  const validate_1$1 = validate;
11967
11908
  // Reuse clients to avoid overwriting already-registered client in provider
11968
11909
  const clientMap = new Map();
11969
11910
  /** Manages the life cycle of windows and views in the application.
11970
11911
  *
11971
- * Enables taking snapshots of itself and applying them to restore a previous configuration
11912
+ * Enables taking snapshots of itself and applyi
11913
+ * ng them to restore a previous configuration
11972
11914
  * as well as listen to {@link OpenFin.PlatformEvents platform events}.
11915
+ *
11973
11916
  */
11974
11917
  class Platform extends base_1$7.EmitterBase {
11975
11918
  /**
@@ -12328,11 +12271,12 @@ class Platform extends base_1$7.EmitterBase {
12328
12271
  });
12329
12272
  }
12330
12273
  /**
12331
- * ***DEPRECATED - please use {@link Platform.createView Platform.createView}.***
12274
+ * ***DEPRECATED - please use Platform.createView.***
12332
12275
  * Reparents a specified view in a new target window.
12333
12276
  * @param viewIdentity View identity
12334
12277
  * @param target new owner window identity
12335
12278
  *
12279
+ * @tutorial Platform.createView
12336
12280
  */
12337
12281
  async reparentView(viewIdentity, target) {
12338
12282
  var _a;
@@ -12822,142 +12766,10 @@ Object.defineProperty(Instance$1, "__esModule", { value: true });
12822
12766
  Instance$1.Layout = void 0;
12823
12767
  const lazy_1 = lazy;
12824
12768
  const validate_1 = validate;
12825
- const base_1$6 = base$1;
12769
+ const base_1$6 = base;
12826
12770
  const common_utils_1 = commonUtils;
12827
12771
  const layout_entities_1 = layoutEntities;
12828
12772
  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
- */
12961
12773
  class Layout extends base_1$6.Base {
12962
12774
  /**
12963
12775
  * @internal
@@ -13183,52 +12995,22 @@ var _LayoutModule_layoutInitializationAttempted;
13183
12995
  Object.defineProperty(Factory$2, "__esModule", { value: true });
13184
12996
  Factory$2.LayoutModule = void 0;
13185
12997
  /* eslint-disable no-undef, import/prefer-default-export */
13186
- const base_1$5 = base$1;
12998
+ const base_1$5 = base;
13187
12999
  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
- */
13191
13000
  class LayoutModule extends base_1$5.Base {
13192
13001
  constructor() {
13193
13002
  super(...arguments);
13194
13003
  _LayoutModule_layoutInitializationAttempted.set(this, false);
13195
13004
  /**
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.
13005
+ * Initialize the window's Layout. Must be called from a custom window that has a 'layout' option set upon creation of that window.
13199
13006
  * If a containerId is not provided, this method attempts to find an element with the id `layout-container`.
13200
- * A Layout will emit events locally on the DOM element representing the layout-container.
13007
+ * A Layout will <a href="tutorial-Layout.DOMEvents.html">emit events locally</a> on the DOM element representing the layout-container.
13201
13008
  * In order to capture the relevant events during Layout initiation, set up the listeners on the DOM element prior to calling `init`.
13202
13009
  * @param options - Layout init options.
13203
13010
  *
13011
+ * @static
13204
13012
  * @experimental
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
- * ```
13013
+ * @tutorial Layout.init
13232
13014
  */
13233
13015
  this.init = async (options = {}) => {
13234
13016
  this.wire.sendAction('layout-init').catch((e) => {
@@ -13246,6 +13028,7 @@ class LayoutModule extends base_1$5.Base {
13246
13028
  }
13247
13029
  /**
13248
13030
  * Asynchronously returns a Layout object that represents a Window's layout.
13031
+ * @param identity
13249
13032
  *
13250
13033
  * @example
13251
13034
  * ```js
@@ -13262,7 +13045,9 @@ class LayoutModule extends base_1$5.Base {
13262
13045
  * // Use wrapped instance to control layout, e.g.:
13263
13046
  * const layoutConfig = await layout.getConfig();
13264
13047
  * ```
13048
+ * @static
13265
13049
  */
13050
+ // eslint-disable-next-line class-methods-use-this
13266
13051
  async wrap(identity) {
13267
13052
  this.wire.sendAction('layout-wrap').catch((e) => {
13268
13053
  // don't expose
@@ -13271,6 +13056,7 @@ class LayoutModule extends base_1$5.Base {
13271
13056
  }
13272
13057
  /**
13273
13058
  * Synchronously returns a Layout object that represents a Window's layout.
13059
+ * @param identity
13274
13060
  *
13275
13061
  * @example
13276
13062
  * ```js
@@ -13287,7 +13073,9 @@ class LayoutModule extends base_1$5.Base {
13287
13073
  * // Use wrapped instance to control layout, e.g.:
13288
13074
  * const layoutConfig = await layout.getConfig();
13289
13075
  * ```
13076
+ * @static
13290
13077
  */
13078
+ // eslint-disable-next-line class-methods-use-this
13291
13079
  wrapSync(identity) {
13292
13080
  this.wire.sendAction('layout-wrap-sync').catch((e) => {
13293
13081
  // don't expose
@@ -13303,6 +13091,7 @@ class LayoutModule extends base_1$5.Base {
13303
13091
  * // Use wrapped instance to control layout, e.g.:
13304
13092
  * const layoutConfig = await layout.getConfig();
13305
13093
  * ```
13094
+ * @static
13306
13095
  */
13307
13096
  async getCurrent() {
13308
13097
  this.wire.sendAction('layout-get-current').catch((e) => {
@@ -13326,6 +13115,7 @@ class LayoutModule extends base_1$5.Base {
13326
13115
  * // Use wrapped instance to control layout, e.g.:
13327
13116
  * const layoutConfig = await layout.getConfig();
13328
13117
  * ```
13118
+ * @static
13329
13119
  */
13330
13120
  getCurrentSync() {
13331
13121
  this.wire.sendAction('layout-get-current-sync').catch((e) => {
@@ -13343,16 +13133,13 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap();
13343
13133
 
13344
13134
  (function (exports) {
13345
13135
  /**
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`.
13136
+ * Entry point for the OpenFin Layout namespace.
13350
13137
  *
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.
13138
+ * Because TypeDoc does not currently support multiple modules with the same name, the module alias "LayoutModule" is used for
13139
+ * the module containing static members of the `Layout` namespace (available under `fin.Platform.Layout`), while `Layout` documents
13140
+ * instances of the OpenFin `Layout` class.
13353
13141
  *
13354
13142
  * @packageDocumentation
13355
- *
13356
13143
  */
13357
13144
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
13358
13145
  if (k2 === undefined) k2 = k;
@@ -13374,13 +13161,9 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap();
13374
13161
  } (layout));
13375
13162
 
13376
13163
  Object.defineProperty(Factory$3, "__esModule", { value: true });
13377
- Factory$3.PlatformModule = void 0;
13378
- const base_1$4 = base$1;
13164
+ const base_1$4 = base;
13379
13165
  const Instance_1$1 = Instance$2;
13380
13166
  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
- */
13384
13167
  class PlatformModule extends base_1$4.Base {
13385
13168
  /**
13386
13169
  * @internal
@@ -13446,12 +13229,14 @@ class PlatformModule extends base_1$4.Base {
13446
13229
  * fin.Platform.init({overrideCallback});
13447
13230
  * ```
13448
13231
  * @experimental
13232
+ * @static
13449
13233
  */
13450
13234
  async init(options) {
13451
13235
  return this.wire.environment.initPlatform(this.fin, options);
13452
13236
  }
13453
13237
  /**
13454
13238
  * Asynchronously returns a Platform object that represents an existing platform.
13239
+ * @param identity
13455
13240
  *
13456
13241
  * @example
13457
13242
  * ```js
@@ -13460,6 +13245,7 @@ class PlatformModule extends base_1$4.Base {
13460
13245
  * // Use wrapped instance to control layout, e.g.:
13461
13246
  * const snapshot = await platform.getSnapshot();
13462
13247
  * ```
13248
+ * @static
13463
13249
  */
13464
13250
  async wrap(identity) {
13465
13251
  this.wire.sendAction('platform-wrap').catch((e) => {
@@ -13469,6 +13255,7 @@ class PlatformModule extends base_1$4.Base {
13469
13255
  }
13470
13256
  /**
13471
13257
  * Synchronously returns a Platform object that represents an existing platform.
13258
+ * @param identity
13472
13259
  *
13473
13260
  * @example
13474
13261
  * ```js
@@ -13477,6 +13264,7 @@ class PlatformModule extends base_1$4.Base {
13477
13264
  * // Use wrapped instance to control layout, e.g.:
13478
13265
  * const snapshot = await platform.getSnapshot();
13479
13266
  * ```
13267
+ * @static
13480
13268
  */
13481
13269
  wrapSync(identity) {
13482
13270
  this.wire.sendAction('platform-wrap-sync').catch((e) => {
@@ -13493,6 +13281,7 @@ class PlatformModule extends base_1$4.Base {
13493
13281
  * // Use wrapped instance to control layout, e.g.:
13494
13282
  * const snapshot = await platform.getSnapshot();
13495
13283
  * ```
13284
+ * @static
13496
13285
  */
13497
13286
  async getCurrent() {
13498
13287
  this.wire.sendAction('platform-get-current').catch((e) => {
@@ -13509,6 +13298,7 @@ class PlatformModule extends base_1$4.Base {
13509
13298
  * // Use wrapped instance to control layout, e.g.:
13510
13299
  * const snapshot = await platform.getSnapshot();
13511
13300
  * ```
13301
+ * @static
13512
13302
  */
13513
13303
  getCurrentSync() {
13514
13304
  this.wire.sendAction('platform-get-current-sync').catch((e) => {
@@ -13519,6 +13309,7 @@ class PlatformModule extends base_1$4.Base {
13519
13309
  /**
13520
13310
  * Creates and starts a Platform and returns a wrapped and running Platform instance. The wrapped Platform methods can
13521
13311
  * be used to launch content into the platform. Promise will reject if the platform is already running.
13312
+ * @param platformOptions
13522
13313
  *
13523
13314
  * @example
13524
13315
  * ```js
@@ -13539,6 +13330,7 @@ class PlatformModule extends base_1$4.Base {
13539
13330
  * console.error(e);
13540
13331
  * }
13541
13332
  * ```
13333
+ * @static
13542
13334
  */
13543
13335
  start(platformOptions) {
13544
13336
  this.wire.sendAction('platform-start').catch((e) => {
@@ -13583,6 +13375,7 @@ class PlatformModule extends base_1$4.Base {
13583
13375
  * console.error(e);
13584
13376
  * }
13585
13377
  * ```
13378
+ * @static
13586
13379
  */
13587
13380
  startFromManifest(manifestUrl, opts) {
13588
13381
  this.wire.sendAction('platform-start-from-manifest').catch((e) => {
@@ -13605,9 +13398,18 @@ class PlatformModule extends base_1$4.Base {
13605
13398
  });
13606
13399
  }
13607
13400
  }
13608
- Factory$3.PlatformModule = PlatformModule;
13401
+ Factory$3.default = PlatformModule;
13609
13402
 
13610
13403
  (function (exports) {
13404
+ /**
13405
+ * Entry point for the OpenFin Platform namespace.
13406
+ *
13407
+ * Because TypeDoc does not currently support multiple modules with the same name, the module alias "PlatformModule" is used for
13408
+ * the module containing static members of the `Platform` namespace (available under `fin.Platform`), while `Platform` documents
13409
+ * instances of the OpenFin `Platform` class.
13410
+ *
13411
+ * @packageDocumentation
13412
+ */
13611
13413
  var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
13612
13414
  if (k2 === undefined) k2 = k;
13613
13415
  var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -13623,20 +13425,10 @@ Factory$3.PlatformModule = PlatformModule;
13623
13425
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
13624
13426
  };
13625
13427
  Object.defineProperty(exports, "__esModule", { value: true });
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);
13428
+ const Factory_1 = Factory$3;
13429
+ exports.default = Factory_1.default;
13638
13430
  __exportStar(Instance$2, exports);
13639
- } (platform$1));
13431
+ } (platform));
13640
13432
 
13641
13433
  var me = {};
13642
13434
 
@@ -13644,9 +13436,9 @@ var me = {};
13644
13436
  Object.defineProperty(exports, "__esModule", { value: true });
13645
13437
  exports.getMe = exports.getBaseMe = exports.environmentUnsupportedMessage = void 0;
13646
13438
  const view_1 = requireView();
13647
- const frame_1 = frame$1;
13439
+ const frame_1 = frame;
13648
13440
  const window_1 = requireWindow();
13649
- const external_application_1 = externalApplication$1;
13441
+ const external_application_1 = externalApplication;
13650
13442
  exports.environmentUnsupportedMessage = 'You are not running in OpenFin.';
13651
13443
  function getBaseMe(entityType, uuid, name) {
13652
13444
  const entityTypeHelpers = {
@@ -14307,7 +14099,7 @@ function requireInteropBroker () {
14307
14099
  hasRequiredInteropBroker = 1;
14308
14100
  Object.defineProperty(InteropBroker, "__esModule", { value: true });
14309
14101
  InteropBroker.InteropBroker = void 0;
14310
- const base_1 = base$1;
14102
+ const base_1 = base;
14311
14103
  const SessionContextGroupBroker_1 = requireSessionContextGroupBroker();
14312
14104
  const utils_1 = utils$1;
14313
14105
  const lodash_1 = require$$3;
@@ -14882,8 +14674,7 @@ function requireInteropBroker () {
14882
14674
  * ```
14883
14675
  */
14884
14676
  // eslint-disable-next-line class-methods-use-this
14885
- async handleFiredIntent(intent, clientIdentity // TODO(CORE-811): remove inline intersected type
14886
- ) {
14677
+ async handleFiredIntent(intent, clientIdentity) {
14887
14678
  const warning = (0, utils_1.generateOverrideWarning)('fdc3.raiseIntent', 'InteropBroker.handleFiredIntent', clientIdentity, 'interopClient.fireIntent');
14888
14679
  console.warn(warning);
14889
14680
  throw new Error(utils_1.BROKER_ERRORS.fireIntent);
@@ -14950,7 +14741,7 @@ function requireInteropBroker () {
14950
14741
  * More information on the AppIntent type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/AppIntent).
14951
14742
  *
14952
14743
  * @param options
14953
- * @param clientIdentity Identity of the Client making the request.
14744
+ * @param clientIdentity Identity of the Client making the request.
14954
14745
  *
14955
14746
  * @example
14956
14747
  * ```js
@@ -14967,8 +14758,7 @@ function requireInteropBroker () {
14967
14758
  * ```
14968
14759
  */
14969
14760
  // eslint-disable-next-line class-methods-use-this
14970
- async handleInfoForIntent(options, clientIdentity // TODO(CORE-811): remove inline intersected type
14971
- ) {
14761
+ async handleInfoForIntent(options, clientIdentity) {
14972
14762
  const warning = (0, utils_1.generateOverrideWarning)('fdc3.findIntent', 'InteropBroker.handleInfoForIntent', clientIdentity, 'interopClient.getInfoForIntent');
14973
14763
  console.warn(warning);
14974
14764
  throw new Error(utils_1.BROKER_ERRORS.getInfoForIntent);
@@ -15014,8 +14804,7 @@ function requireInteropBroker () {
15014
14804
  * ```
15015
14805
  */
15016
14806
  // eslint-disable-next-line class-methods-use-this
15017
- async handleInfoForIntentsByContext(context, clientIdentity // TODO(CORE-811): remove inline intersected type
15018
- ) {
14807
+ async handleInfoForIntentsByContext(context, clientIdentity) {
15019
14808
  const warning = (0, utils_1.generateOverrideWarning)('fdc3.findIntentsByContext', 'InteropBroker.handleInfoForIntentsByContext', clientIdentity, 'interopClient.getInfoForIntentsByContext');
15020
14809
  console.warn(warning);
15021
14810
  throw new Error(utils_1.BROKER_ERRORS.getInfoForIntentsByContext);
@@ -15041,7 +14830,7 @@ function requireInteropBroker () {
15041
14830
  * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
15042
14831
  *
15043
14832
  * @param contextForIntent Data passed between entities and applications.
15044
- * @param clientIdentity Identity of the Client making the request.
14833
+ * @param clientIdentity Identity of the Client making the request.
15045
14834
  *
15046
14835
  * @example
15047
14836
  * ```js
@@ -15102,7 +14891,7 @@ function requireInteropBroker () {
15102
14891
  /**
15103
14892
  * Responsible for resolving the fdc3.findInstances call.
15104
14893
  * Must be overridden
15105
- * @param app AppIdentifier that was passed to fdc3.findInstances
14894
+ * @param app AppIdentifier that was passed to fdc3.findInstances
15106
14895
  * @param clientIdentity Identity of the Client making the request.
15107
14896
  */
15108
14897
  // eslint-disable-next-line class-methods-use-this
@@ -15137,7 +14926,7 @@ function requireInteropBroker () {
15137
14926
  * fin.Platform.init({
15138
14927
  * interopOverride: async (InteropBroker) => {
15139
14928
  * class Override extends InteropBroker {
15140
- * async invokeContextHandler(clientIdentity, handlerId, context) {
14929
+ * async invokeContextHandler(options, clientIdentity) {
15141
14930
  * return super.invokeContextHandler(clientIdentity, handlerId, {
15142
14931
  * ...context,
15143
14932
  * contextMetadata: {
@@ -15177,7 +14966,7 @@ function requireInteropBroker () {
15177
14966
  * fin.Platform.init({
15178
14967
  * interopOverride: async (InteropBroker) => {
15179
14968
  * class Override extends InteropBroker {
15180
- * async invokeIntentHandler(clientIdentity, handlerId, context) {
14969
+ * async invokeIntentHandler(options, clientIdentity) {
15181
14970
  * const { context } = intent;
15182
14971
  * return super.invokeIntentHandler(clientIdentity, handlerId, {
15183
14972
  * ...intent,
@@ -15516,8 +15305,7 @@ function requireInteropBroker () {
15516
15305
  }
15517
15306
  // Setup Channel Connection Logic
15518
15307
  wireChannel(channel) {
15519
- channel.onConnection(async (clientIdentity, // TODO(CORE-811): remove inline intersected type
15520
- payload) => {
15308
+ channel.onConnection(async (clientIdentity, payload) => {
15521
15309
  if (!(await this.isConnectionAuthorized(clientIdentity, payload))) {
15522
15310
  throw new Error(`Connection not authorized for ${clientIdentity.uuid}, ${clientIdentity.name}`);
15523
15311
  }
@@ -15641,7 +15429,7 @@ var __classPrivateFieldGet$3 = (commonjsGlobal && commonjsGlobal.__classPrivateF
15641
15429
  };
15642
15430
  var _SessionContextGroupClient_clientPromise;
15643
15431
  Object.defineProperty(SessionContextGroupClient$1, "__esModule", { value: true });
15644
- const base_1$3 = base$1;
15432
+ const base_1$3 = base;
15645
15433
  const utils_1$3 = utils$1;
15646
15434
  class SessionContextGroupClient extends base_1$3.Base {
15647
15435
  constructor(wire, client, id) {
@@ -15728,7 +15516,7 @@ var __classPrivateFieldGet$2 = (commonjsGlobal && commonjsGlobal.__classPrivateF
15728
15516
  var _InteropClient_clientPromise, _InteropClient_sessionContextGroups;
15729
15517
  Object.defineProperty(InteropClient$1, "__esModule", { value: true });
15730
15518
  InteropClient$1.InteropClient = void 0;
15731
- const base_1$2 = base$1;
15519
+ const base_1$2 = base;
15732
15520
  const SessionContextGroupClient_1 = SessionContextGroupClient$1;
15733
15521
  const utils_1$2 = utils$1;
15734
15522
  /**
@@ -16444,10 +16232,9 @@ function requireFactory () {
16444
16232
  if (hasRequiredFactory) return Factory$1;
16445
16233
  hasRequiredFactory = 1;
16446
16234
  Object.defineProperty(Factory$1, "__esModule", { value: true });
16447
- Factory$1.InteropModule = void 0;
16448
16235
  const lodash_1 = require$$3;
16449
16236
  const inaccessibleObject_1 = inaccessibleObject;
16450
- const base_1 = base$1;
16237
+ const base_1 = base;
16451
16238
  const InteropBroker_1 = requireInteropBroker();
16452
16239
  const InteropClient_1 = InteropClient$1;
16453
16240
  const overrideCheck_1 = requireOverrideCheck();
@@ -16481,6 +16268,7 @@ function requireFactory () {
16481
16268
  * const contextGroups = await interopBroker.getContextGroups();
16482
16269
  * console.log(contextGroups);
16483
16270
  * ```
16271
+ * @static
16484
16272
  */
16485
16273
  async init(name, override = defaultOverride) {
16486
16274
  var _a;
@@ -16538,6 +16326,7 @@ function requireFactory () {
16538
16326
  * const contextGroupInfo = await client.getInfoForContextGroup();
16539
16327
  * console.log(contextGroupInfo);
16540
16328
  * ```
16329
+ * @static
16541
16330
  */
16542
16331
  connectSync(name, interopConfig) {
16543
16332
  this.wire.sendAction('interop-connect-sync').catch(() => {
@@ -16546,7 +16335,7 @@ function requireFactory () {
16546
16335
  return new InteropClient_1.InteropClient(this.wire, name, interopConfig);
16547
16336
  }
16548
16337
  }
16549
- Factory$1.InteropModule = InteropModule;
16338
+ Factory$1.default = InteropModule;
16550
16339
  return Factory$1;
16551
16340
  }
16552
16341
 
@@ -16557,10 +16346,10 @@ function requireInterop () {
16557
16346
  hasRequiredInterop = 1;
16558
16347
  (function (exports) {
16559
16348
  /**
16560
- * Entry point for the OpenFin `Interop` API (`fin.Interop`).
16349
+ * Entry point for the OpenFin Interop namespace.
16561
16350
  *
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.
16351
+ * "InteropModule" contains static members of the `Interop` namespace (available under `fin.Interop`), while `InteropClient` and
16352
+ * `InteropBroker` document instances of their respective classes.
16564
16353
  *
16565
16354
  * @packageDocumentation
16566
16355
  */
@@ -16579,7 +16368,8 @@ function requireInterop () {
16579
16368
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
16580
16369
  };
16581
16370
  Object.defineProperty(exports, "__esModule", { value: true });
16582
- __exportStar(requireFactory(), exports);
16371
+ const Factory_1 = requireFactory();
16372
+ exports.default = Factory_1.default;
16583
16373
  __exportStar(InteropClient$1, exports);
16584
16374
  __exportStar(requireInteropBroker(), exports);
16585
16375
  } (interop));
@@ -16615,14 +16405,12 @@ var _SnapshotSource_identity, _SnapshotSource_getConnection, _SnapshotSource_get
16615
16405
  Object.defineProperty(Instance, "__esModule", { value: true });
16616
16406
  Instance.SnapshotSource = void 0;
16617
16407
  /* eslint-disable @typescript-eslint/no-non-null-assertion */
16618
- const base_1$1 = base$1;
16408
+ const base_1$1 = base;
16619
16409
  const utils_1$1 = utils;
16620
16410
  const connectionMap = new Map();
16621
16411
  /**
16622
16412
  * Enables configuring a SnapshotSource with custom getSnapshot and applySnapshot methods.
16623
16413
  *
16624
- * @typeParam Snapshot Implementation-defined shape of an application snapshot. Allows
16625
- * custom snapshot implementations for legacy applications to define their own snapshot format.
16626
16414
  */
16627
16415
  class SnapshotSource extends base_1$1.Base {
16628
16416
  /**
@@ -16757,19 +16545,13 @@ Instance.SnapshotSource = SnapshotSource;
16757
16545
  _SnapshotSource_identity = new WeakMap(), _SnapshotSource_getConnection = new WeakMap(), _SnapshotSource_getClient = new WeakMap(), _SnapshotSource_startConnection = new WeakMap(), _SnapshotSource_setUpConnectionListener = new WeakMap();
16758
16546
 
16759
16547
  Object.defineProperty(Factory, "__esModule", { value: true });
16760
- Factory.SnapshotSourceModule = void 0;
16761
- const base_1 = base$1;
16548
+ const base_1 = base;
16762
16549
  const Instance_1 = Instance;
16763
16550
  const utils_1 = utils;
16764
- /**
16765
- * Static namespace for OpenFin API methods that interact with the {@link SnapshotSource} class, available under `fin.SnapshotSource`.
16766
- */
16767
16551
  class SnapshotSourceModule extends base_1.Base {
16768
16552
  /**
16769
16553
  * Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
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.
16554
+ * @param provider
16773
16555
  *
16774
16556
  * @example
16775
16557
  * ```js
@@ -16786,7 +16568,7 @@ class SnapshotSourceModule extends base_1.Base {
16786
16568
  *
16787
16569
  * await fin.SnapshotSource.init(snapshotProvider);
16788
16570
  * ```
16789
- *
16571
+ * @static
16790
16572
  */
16791
16573
  async init(provider) {
16792
16574
  this.wire.sendAction('snapshot-source-init').catch((e) => {
@@ -16806,6 +16588,7 @@ class SnapshotSourceModule extends base_1.Base {
16806
16588
  }
16807
16589
  /**
16808
16590
  * Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
16591
+ * @param identity
16809
16592
  *
16810
16593
  * @example
16811
16594
  * ```js
@@ -16813,6 +16596,7 @@ class SnapshotSourceModule extends base_1.Base {
16813
16596
  * // Use wrapped instance's getSnapshot method, e.g.:
16814
16597
  * const snapshot = await snapshotSource.getSnapshot();
16815
16598
  * ```
16599
+ * @static
16816
16600
  */
16817
16601
  wrapSync(identity) {
16818
16602
  this.wire.sendAction('snapshot-source-wrap-sync').catch((e) => {
@@ -16822,6 +16606,7 @@ class SnapshotSourceModule extends base_1.Base {
16822
16606
  }
16823
16607
  /**
16824
16608
  * Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.
16609
+ * @param identity
16825
16610
  *
16826
16611
  * @example
16827
16612
  * ```js
@@ -16829,6 +16614,7 @@ class SnapshotSourceModule extends base_1.Base {
16829
16614
  * // Use wrapped instance's getSnapshot method, e.g.:
16830
16615
  * const snapshot = await snapshotSource.getSnapshot();
16831
16616
  * ```
16617
+ * @static
16832
16618
  */
16833
16619
  async wrap(identity) {
16834
16620
  this.wire.sendAction('snapshot-source-wrap').catch((e) => {
@@ -16837,17 +16623,15 @@ class SnapshotSourceModule extends base_1.Base {
16837
16623
  return this.wrapSync(identity);
16838
16624
  }
16839
16625
  }
16840
- Factory.SnapshotSourceModule = SnapshotSourceModule;
16626
+ Factory.default = SnapshotSourceModule;
16841
16627
 
16842
16628
  (function (exports) {
16843
16629
  /**
16844
- * Entry points for the OpenFin `SnapshotSource` API (`fin.SnapshotSource`).
16630
+ * Entry point for the OpenFin SnapshotSource namespace.
16845
16631
  *
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`.
16848
- *
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.
16632
+ * Because TypeDoc does not currently support multiple modules with the same name, the module alias "SnapshotSourceModule" is used for
16633
+ * the module containing static members of the `SnapshotSource` namespace (available under `fin.SnapshotSource`), while `SnapshotSource` documents
16634
+ * instances of the OpenFin `SnapshotSource` class.
16851
16635
  *
16852
16636
  * @packageDocumentation
16853
16637
  */
@@ -16866,30 +16650,27 @@ Factory.SnapshotSourceModule = SnapshotSourceModule;
16866
16650
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
16867
16651
  };
16868
16652
  Object.defineProperty(exports, "__esModule", { value: true });
16869
- __exportStar(Factory, exports);
16653
+ const Factory_1 = Factory;
16654
+ exports.default = Factory_1.default;
16870
16655
  __exportStar(Instance, exports);
16871
16656
  } (snapshotSource));
16872
16657
 
16873
16658
  Object.defineProperty(fin, "__esModule", { value: true });
16874
- fin.Fin = void 0;
16875
16659
  const events_1$3 = eventsExports;
16876
16660
  // Import from the file rather than the directory in case someone consuming types is using module resolution other than "node"
16877
- const index_1 = system$1;
16661
+ const index_1 = system;
16878
16662
  const index_2 = requireWindow();
16879
16663
  const index_3 = requireApplication();
16880
16664
  const index_4 = interappbus;
16881
16665
  const index_5 = clipboard;
16882
- const index_6 = externalApplication$1;
16883
- const index_7 = frame$1;
16884
- const index_8 = globalHotkey$1;
16666
+ const index_6 = externalApplication;
16667
+ const index_7 = frame;
16668
+ const index_8 = globalHotkey;
16885
16669
  const index_9 = requireView();
16886
- const index_10 = platform$1;
16670
+ const index_10 = platform;
16887
16671
  const me_1$1 = me;
16888
16672
  const interop_1 = requireInterop();
16889
16673
  const snapshot_source_1 = snapshotSource;
16890
- /**
16891
- * @internal
16892
- */
16893
16674
  class Fin extends events_1$3.EventEmitter {
16894
16675
  /**
16895
16676
  * @internal
@@ -16897,18 +16678,18 @@ class Fin extends events_1$3.EventEmitter {
16897
16678
  constructor(wire) {
16898
16679
  super();
16899
16680
  this.wire = 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);
16681
+ this.System = new index_1.default(wire);
16682
+ this.Window = new index_2.default(wire);
16683
+ this.Application = new index_3.default(wire);
16684
+ this.InterApplicationBus = new index_4.default(wire);
16685
+ this.Clipboard = new index_5.default(wire);
16686
+ this.ExternalApplication = new index_6.default(wire);
16687
+ this.Frame = new index_7.default(wire);
16688
+ this.GlobalHotkey = new index_8.default(wire);
16689
+ this.Platform = new index_10.default(wire, this.InterApplicationBus.Channel);
16690
+ this.View = new index_9.default(wire);
16691
+ this.Interop = new interop_1.default(wire);
16692
+ this.SnapshotSource = new snapshot_source_1.default(wire);
16912
16693
  wire.registerFin(this);
16913
16694
  this.me = (0, me_1$1.getMe)(wire);
16914
16695
  // Handle disconnect events
@@ -16917,7 +16698,7 @@ class Fin extends events_1$3.EventEmitter {
16917
16698
  });
16918
16699
  }
16919
16700
  }
16920
- fin.Fin = Fin;
16701
+ fin.default = Fin;
16921
16702
 
16922
16703
  var wire = {};
16923
16704
 
@@ -18219,7 +18000,7 @@ function requireMain () {
18219
18000
  Object.defineProperty(exports, "__esModule", { value: true });
18220
18001
  exports.ChannelProvider = exports.ChannelClient = exports.Frame = exports.View = exports.System = exports.Window = exports.Application = exports.Fin = exports.launch = exports.connect = void 0;
18221
18002
  const fin_1 = fin;
18222
- Object.defineProperty(exports, "Fin", { enumerable: true, get: function () { return fin_1.Fin; } });
18003
+ exports.Fin = fin_1.default;
18223
18004
  const index_1 = requireApplication();
18224
18005
  Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return index_1.Application; } });
18225
18006
  const window_1 = requireWindow();
@@ -18227,13 +18008,13 @@ function requireMain () {
18227
18008
  const view_1 = requireView();
18228
18009
  Object.defineProperty(exports, "View", { enumerable: true, get: function () { return view_1.View; } });
18229
18010
  const client_1 = client;
18230
- Object.defineProperty(exports, "ChannelClient", { enumerable: true, get: function () { return client_1.ChannelClient; } });
18011
+ exports.ChannelClient = client_1.default;
18231
18012
  const provider_1 = provider;
18232
18013
  Object.defineProperty(exports, "ChannelProvider", { enumerable: true, get: function () { return provider_1.ChannelProvider; } });
18233
- const frame_1 = frame$1;
18014
+ const frame_1 = frame;
18234
18015
  Object.defineProperty(exports, "Frame", { enumerable: true, get: function () { return frame_1._Frame; } });
18235
- const system_1 = system$1;
18236
- Object.defineProperty(exports, "System", { enumerable: true, get: function () { return system_1.System; } });
18016
+ const system_1 = system;
18017
+ exports.System = system_1.default;
18237
18018
  const wire_1 = wire;
18238
18019
  const node_env_1 = requireNodeEnv();
18239
18020
  const transport_1 = transport;
@@ -18250,7 +18031,7 @@ function requireMain () {
18250
18031
  name: (_a = normalized.name) !== null && _a !== void 0 ? _a : normalized.uuid
18251
18032
  });
18252
18033
  await wire.connect(normalized);
18253
- return new fin_1.Fin(wire);
18034
+ return new fin_1.default(wire);
18254
18035
  }
18255
18036
  exports.connect = connect;
18256
18037
  async function launch(config) {
@@ -18268,250 +18049,15 @@ function requireMain () {
18268
18049
 
18269
18050
  var mainExports = requireMain();
18270
18051
 
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));
18052
+ var OpenFin$1 = {};
18507
18053
 
18508
- var OpenFin = /*@__PURE__*/getDefaultExportFromCjs(OpenFin$2);
18054
+ Object.defineProperty(OpenFin$1, "__esModule", { value: true });
18509
18055
 
18510
- var OpenFin$1 = /*#__PURE__*/_mergeNamespaces({
18056
+ var OpenFin = /*#__PURE__*/_mergeNamespaces({
18511
18057
  __proto__: null,
18512
- default: OpenFin
18513
- }, [OpenFin$2]);
18058
+ default: OpenFin$1
18059
+ }, [OpenFin$1]);
18514
18060
 
18515
18061
  exports.connect = mainExports.connect;
18516
- exports.default = OpenFin$1;
18062
+ exports.default = OpenFin;
18517
18063
  exports.launch = mainExports.launch;