@openfin/node-adapter 34.78.10 → 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),
@@ -6738,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),
@@ -6756,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;
@@ -10465,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");
@@ -10800,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;
@@ -11008,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;
@@ -11398,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),
@@ -11649,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),
@@ -13213,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),
@@ -13494,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),
@@ -16267,39 +16295,46 @@ class InteropClient extends base_1$2.Base {
 InteropClient$1.InteropClient = InteropClient;
 _InteropClient_clientPromise = new WeakMap(), _InteropClient_sessionContextGroups = new WeakMap();
 
-var overrideCheck$1 = {};
+var overrideCheck = {};
 
-Object.defineProperty(overrideCheck$1, "__esModule", { value: true });
-overrideCheck$1.overrideCheck = overrideCheck$1.getDefaultViewFdc3VersionFromAppInfo = void 0;
-const InteropBroker_1 = requireInteropBroker();
-function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }) {
-    var _a, _b, _c, _d;
-    const setVersion = (_c = (_b = (_a = manifest.platform) === null || _a === void 0 ? void 0 : _a.defaultViewOptions) === null || _b === void 0 ? void 0 : _b.fdc3InteropApi) !== null && _c !== void 0 ? _c : (_d = initialOptions.defaultViewOptions) === null || _d === void 0 ? void 0 : _d.fdc3InteropApi;
-    return ['1.2', '2.0'].includes(setVersion !== null && setVersion !== void 0 ? setVersion : '') ? setVersion : undefined;
-}
-overrideCheck$1.getDefaultViewFdc3VersionFromAppInfo = getDefaultViewFdc3VersionFromAppInfo;
-// TODO: Unit test this
-function overrideCheck(overriddenBroker, fdc3InteropApi) {
-    if (fdc3InteropApi && fdc3InteropApi === '2.0') {
-        const mustOverrideAPIs = [
-            'fdc3HandleFindInstances',
-            'handleInfoForIntent',
-            'handleInfoForIntentsByContext',
-            'fdc3HandleGetAppMetadata',
-            'fdc3HandleGetInfo',
-            'fdc3HandleOpen',
-            'handleFiredIntent',
-            'handleFiredIntentForContext'
-        ];
-        const notOverridden = mustOverrideAPIs.filter((api) => {
-            return overriddenBroker[api] === InteropBroker_1.InteropBroker.prototype[api];
-        });
-        if (notOverridden.length > 0) {
-            console.warn(`WARNING: FDC3 2.0 has been set as a default option for Views in this Platform, but the required InteropBroker APIs for FDC3 2.0 compliance have not all been overridden.\nThe following APIs need to be overridden:\n${notOverridden.join('\n')}`);
-        }
-    }
+var hasRequiredOverrideCheck;
+
+function requireOverrideCheck () {
+	if (hasRequiredOverrideCheck) return overrideCheck;
+	hasRequiredOverrideCheck = 1;
+	Object.defineProperty(overrideCheck, "__esModule", { value: true });
+	overrideCheck.overrideCheck = overrideCheck.getDefaultViewFdc3VersionFromAppInfo = void 0;
+	const InteropBroker_1 = requireInteropBroker();
+	function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }) {
+	    var _a, _b, _c, _d;
+	    const setVersion = (_c = (_b = (_a = manifest.platform) === null || _a === void 0 ? void 0 : _a.defaultViewOptions) === null || _b === void 0 ? void 0 : _b.fdc3InteropApi) !== null && _c !== void 0 ? _c : (_d = initialOptions.defaultViewOptions) === null || _d === void 0 ? void 0 : _d.fdc3InteropApi;
+	    return ['1.2', '2.0'].includes(setVersion !== null && setVersion !== void 0 ? setVersion : '') ? setVersion : undefined;
+	}
+	overrideCheck.getDefaultViewFdc3VersionFromAppInfo = getDefaultViewFdc3VersionFromAppInfo;
+	// TODO: Unit test this
+	function overrideCheck$1(overriddenBroker, fdc3InteropApi) {
+	    if (fdc3InteropApi && fdc3InteropApi === '2.0') {
+	        const mustOverrideAPIs = [
+	            'fdc3HandleFindInstances',
+	            'handleInfoForIntent',
+	            'handleInfoForIntentsByContext',
+	            'fdc3HandleGetAppMetadata',
+	            'fdc3HandleGetInfo',
+	            'fdc3HandleOpen',
+	            'handleFiredIntent',
+	            'handleFiredIntentForContext'
+	        ];
+	        const notOverridden = mustOverrideAPIs.filter((api) => {
+	            return overriddenBroker[api] === InteropBroker_1.InteropBroker.prototype[api];
+	        });
+	        if (notOverridden.length > 0) {
+	            console.warn(`WARNING: FDC3 2.0 has been set as a default option for Views in this Platform, but the required InteropBroker APIs for FDC3 2.0 compliance have not all been overridden.\nThe following APIs need to be overridden:\n${notOverridden.join('\n')}`);
+	        }
+	    }
+	}
+	overrideCheck.overrideCheck = overrideCheck$1;
+	return overrideCheck;
 }
-overrideCheck$1.overrideCheck = overrideCheck;
 
 var hasRequiredFactory;
 
@@ -16313,7 +16348,7 @@ function requireFactory () {
 	const base_1 = base;
 	const InteropBroker_1 = requireInteropBroker();
 	const InteropClient_1 = InteropClient$1;
-	const overrideCheck_1 = overrideCheck$1;
+	const overrideCheck_1 = requireOverrideCheck();
 	const common_utils_1 = commonUtils;
 	const defaultOverride = (Class) => new Class();
 	const BrokerParamAccessError = 'You have attempted to use or modify InteropBroker parameters, which is not allowed. You are likely using an older InteropBroker override scheme. Please consult our Interop docs for guidance on migrating to the new override scheme.';
@@ -16420,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
@@ -16484,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 {
     /**
@@ -16629,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 = {
@@ -16644,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) => {
@@ -16698,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),
@@ -16744,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
@@ -18124,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.10",
+    "version": "34.78.11",
     "description": "See README.md",
     "main": "out/node-adapter.js",
     "types": "out/node-adapter.d.ts",