@openfin/node-adapter 34.78.9 → 34.78.11

package/out/node-adapter.js

@@ -3547,9 +3547,9 @@ function requireView () {
 		};
 		Object.defineProperty(exports, "__esModule", { value: true });
 		/**
-		 * Entry points for the OpenFin `View` API.
+		 * Entry points for the OpenFin `View` API (`fin.View`).
 		 *
-		 * * {@link ViewModule} contains static methods relating to the `View` type, accessible through `fin.View`.
+		 * * {@link ViewModule} contains static members of the `View` API, accessible through `fin.View`.
 		 * * {@link View} describes an instance of an OpenFin View, e.g. as returned by `fin.View.getCurrent`.
 		 *
 		 * 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),
@@ -4685,9 +4685,9 @@ function requireApplication () {
 		};
 		Object.defineProperty(exports, "__esModule", { value: true });
 		/**
-		 * Entry points for the OpenFin `Application` API.
+		 * Entry points for the OpenFin `Application` API (`fin.Application`).
 		 *
-		 * * {@link ApplicationModule} contains static methods relating to the `Application` type, accessible through `fin.Application`.
+		 * * {@link ApplicationModule} contains static members of the `Application` API, accessible through `fin.Application`.
 		 * * {@link Application} describes an instance of an OpenFin Application, e.g. as returned by `fin.Application.getCurrent`.
 		 *
 		 * 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),
@@ -6468,6 +6468,7 @@ function requireInstance () {
 	        return this.wire.sendAction('close-popup-menu', { ...this.identity }).then(() => undefined);
 	    }
 	    /**
+	     * @PORTED
 	     * @typedef {object} PopupOptions
 	     * @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.
 	     * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
@@ -6485,6 +6486,7 @@ function requireInstance () {
 	     * @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.
 	     */
 	    /**
+	     * @PORTED
 	     * @typedef {object} PopupResult
 	     * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
 	     * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
@@ -6736,9 +6738,9 @@ function requireWindow () {
 		};
 		Object.defineProperty(exports, "__esModule", { value: true });
 		/**
-		 * Entry points for the OpenFin `Window` API.
+		 * Entry points for the OpenFin `Window` API (`fin.Window`).
 		 *
-		 * * {@link _WindowModule} contains static methods relating to the `Window` type, accessible through `fin.Window`.
+		 * * {@link _WindowModule} contains static members of the `Window` API, accessible through `fin.Window`.
 		 * * {@link _Window} describes an instance of an OpenFin Window, e.g. as returned by `fin.Window.getCurrent`.
 		 *
 		 * 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),
@@ -6754,6 +6756,11 @@ function requireWindow () {
 	return window$1;
 }
 
+/**
+ * Entry point for the OpenFin `System` API (`fin.System`).
+ *
+ * * {@link System} contains static members of the `System` API (available under `fin.System`)
+ */
 Object.defineProperty(system, "__esModule", { value: true });
 system.System = void 0;
 const base_1$j = base;
@@ -10463,6 +10470,15 @@ class ConnectionManager extends base_1$g.Base {
 connectionManager.ConnectionManager = ConnectionManager;
 _ConnectionManager_messageReceiver = new WeakMap(), _ConnectionManager_rtcConnectionManager = new WeakMap();
 
+/**
+ * Entry points for the `Channel` subset of the `InterApplicationBus` API (`fin.InterApplicationBus.Channel`).
+ *
+ * * {@link Channel} contains static members of the `Channel` API, accessible through `fin.InterApplicationBus.Channel`.
+ * * {@link OpenFin.ChannelClient} describes a client of a channel, e.g. as returned by `fin.InterApplicationBus.Channel.connect`.
+ * * {@link OpenFin.ChannelProvider} describes a provider of a channel, e.g. as returned by `fin.InterApplicationBus.Channel.create`.
+ *
+ * @packageDocumentation
+ */
 var __classPrivateFieldSet$5 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
     if (kind === "m") throw new TypeError("Private method is not writable");
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
@@ -10798,6 +10814,13 @@ _Channel_connectionManager = new WeakMap(), _Channel_internalEmitter = new WeakM
 
 Object.defineProperty(interappbus, "__esModule", { value: true });
 interappbus.InterAppPayload = interappbus.InterApplicationBus = void 0;
+/**
+ * Entry point for the OpenFin `InterApplicationBus` API (`fin.InterApplicationBus`).
+ *
+ * * {@link InterApplicationBus} contains static members of the `InterApplicationBus` API, accessible through `fin.InterApplicationBus`.
+ *
+ * @packageDocumentation
+ */
 const events_1$4 = eventsExports;
 const base_1$e = base;
 const ref_counter_1 = refCounter;
@@ -11006,6 +11029,13 @@ function createKey(...toHash) {
 
 var clipboard = {};
 
+/**
+ * Entry point for the OpenFin `Clipboard` API (`fin.Clipboard`).
+ *
+ * * {@link Clipboard} contains static members of the `Clipboard` API, accessible through `fin.Clipboard`.
+ *
+ * @packageDocumentation
+ */
 Object.defineProperty(clipboard, "__esModule", { value: true });
 clipboard.Clipboard = void 0;
 const base_1$d = base;
@@ -11396,9 +11426,9 @@ Factory$5.ExternalApplicationModule = ExternalApplicationModule;
 	};
 	Object.defineProperty(exports, "__esModule", { value: true });
 	/**
-	 * Entry points for the OpenFin `ExternalApplication` API.
+	 * Entry points for the OpenFin `ExternalApplication` API (`fin.ExternalApplication`).
 	 *
-	 * * {@link ExternalApplicationModule} contains static methods relating to the `ExternalApplication` type, accessible through `fin.ExternalApplication`.
+	 * * {@link ExternalApplicationModule} contains static members of the `ExternalApplication` type, accessible through `fin.ExternalApplication`.
 	 * * {@link ExternalApplication} describes an instance of an OpenFin ExternalApplication, e.g. as returned by `fin.ExternalApplication.getCurrent`.
 	 *
 	 * 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),
@@ -11647,9 +11677,9 @@ Factory$4._FrameModule = _FrameModule;
 
 (function (exports) {
 	/**
-	 * Entry points for the OpenFin `Frame` API.
+	 * Entry points for the OpenFin `Frame` API (`fin.Frame`).
 	 *
-	 * * {@link _FrameModule} contains static methods relating to the `Frame` type, accessible through `fin.Frame`.
+	 * * {@link _FrameModule} contains static members of the `Frame` API, accessible through `fin.Frame`.
 	 * * {@link _Frame} describes an instance of an OpenFin Frame, e.g. as returned by `fin.Frame.getCurrent`.
 	 *
 	 * 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),
@@ -12196,12 +12226,11 @@ class Platform extends base_1$7.EmitterBase {
         });
     }
     /**
-     * ***DEPRECATED - please use Platform.createView.***
+     * ***DEPRECATED - please use {@link Platform.createView Platform.createView}.***
      * Reparents a specified view in a new target window.
      * @param viewIdentity View identity
      * @param target new owner window identity
      *
-     * @tutorial Platform.createView
      */
     async reparentView(viewIdentity, target) {
         var _a;
@@ -13212,9 +13241,9 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap();
 
 (function (exports) {
 	/**
-	 * Entry point for the OpenFin `Layout` namespace.
+	 * Entry point for the OpenFin `Layout` subset of the `Platform` API (`fin.Platform.Layout`).
 	 *
-	 * * {@link LayoutModule} contains static methods relating to the `Layout` type, accessible through `fin.Platform.Layout`.
+	 * * {@link LayoutModule} contains static members of the `Layout` API, accessible through `fin.Platform.Layout`.
 	 * * {@link Layout} describes an instance of an OpenFin Layout, e.g. as returned by `fin.Platform.Layout.getCurrent`.
 	 *
 	 * 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),
@@ -13493,9 +13522,9 @@ Factory$3.PlatformModule = PlatformModule;
 	};
 	Object.defineProperty(exports, "__esModule", { value: true });
 	/**
-	 * Entry points for the OpenFin `Platform` API.
+	 * Entry points for the OpenFin `Platform` API (`fin.Platform`)
 	 *
-	 * * {@link PlatformModule} contains static methods relating to the `Platform` type, accessible through `fin.Platform`.
+	 * * {@link PlatformModule} contains static members of the `Platform` API, accessible through `fin.Platform`.
 	 * * {@link Platform} describes an instance of an OpenFin Platform, e.g. as returned by `fin.Platform.getCurrent`.
 	 *
 	 * 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),
@@ -16426,9 +16455,9 @@ function requireInterop () {
 	hasRequiredInterop = 1;
 	(function (exports) {
 		/**
-		 * Entry point for the OpenFin Interop namespace.
+		 * Entry point for the OpenFin `Interop` API (`fin.Interop`).
 		 *
-		 * * {@link InteropModule} contains static members of the `Interop` namespace (available under `fin.Interop`)
+		 * * {@link InteropModule} contains static members of the `Interop` API (available under `fin.Interop`)
 		 * * {@link InteropClient} and {@link InteropBroker} document instances of their respective classes.
 		 *
 		 * @packageDocumentation
@@ -16490,6 +16519,8 @@ const connectionMap = new Map();
 /**
  * Enables configuring a SnapshotSource with custom getSnapshot and applySnapshot methods.
  *
+ * @typeParam Snapshot Implementation-defined shape of an application snapshot.  Allows
+ * custom snapshot implementations for legacy applications to define their own snapshot format.
  */
 class SnapshotSource extends base_1$1.Base {
     /**
@@ -16635,6 +16666,9 @@ class SnapshotSourceModule extends base_1.Base {
     /**
      * Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
      *
+     * @typeParam Snapshot Implementation-defined shape of an application snapshot.  Allows
+     * custom snapshot implementations for legacy applications to define their own snapshot format.
+     *
      * @example
      * ```js
      * const snapshotProvider = {
@@ -16650,6 +16684,7 @@ class SnapshotSourceModule extends base_1.Base {
      *
      * await fin.SnapshotSource.init(snapshotProvider);
      * ```
+     *
      */
     async init(provider) {
         this.wire.sendAction('snapshot-source-init').catch((e) => {
@@ -16704,9 +16739,9 @@ Factory.SnapshotSourceModule = SnapshotSourceModule;
 
 (function (exports) {
 	/**
-	 * Entry points for the OpenFin `SnapshotSource` API.
+	 * Entry points for the OpenFin `SnapshotSource` API (`fin.SnapshotSource`).
 	 *
-	 * * {@link SnapshotSourceModule} contains static methods relating to the `SnapshotSource` type, accessible through `fin.SnapshotSource`.
+	 * * {@link SnapshotSourceModule} contains static members of the `SnapshotSource` API, accessible through `fin.SnapshotSource`.
 	 * * {@link SnapshotSource} describes an instance of an OpenFin SnapshotSource, e.g. as returned by `fin.SnapshotSource.wrap`.
 	 *
 	 * 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),
@@ -16750,6 +16785,9 @@ const index_10 = platform;
 const me_1$1 = me;
 const interop_1 = requireInterop();
 const snapshot_source_1 = snapshotSource;
+/**
+ * @internal
+ */
 class Fin extends events_1$3.EventEmitter {
     /**
      * @internal
@@ -18130,6 +18168,17 @@ var mainExports = requireMain();
 
 var OpenFin$1 = {};
 
+/**
+ * Top-level namespace for types referenced by the OpenFin API.  Contains:
+ *
+ * * The type of the global `fin` entry point ({@link FinApi})
+ * * Classes that act as static namespaces returned from the `fin` global (e.g. {@link ApplicationModule}, accessible via `fin.Application`)
+ * * Instance classes that are returned from API calls (e.g. {@link Application}, accessible via `fin.Application.getCurrentSync()`)
+ * * Parameter shapes for API methods (e.g. {@link ApplicationOptions}, used in `fin.Application.start()`)
+ * * Event namespaces and payload union types (e.g. {@link ApplicationEvents} and {@link ApplicationEvent})
+ *
+ * @packageDocumentation
+ */
 Object.defineProperty(OpenFin$1, "__esModule", { value: true });
 
 var OpenFin = /*#__PURE__*/_mergeNamespaces({

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/node-adapter",
-    "version": "34.78.9",
+    "version": "34.78.11",
     "description": "See README.md",
     "main": "out/node-adapter.js",
     "types": "out/node-adapter.d.ts",