@openfin/core 29.73.5 → 29.73.7

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "29.73.5",
+    "version": "29.73.7",
     "license": "Apache-2.0",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

package/src/OpenFin.d.ts

@@ -680,9 +680,12 @@ export declare type PlatformProvider = {
      */
     getSnapshot(payload: undefined, identity: Identity): Promise<Snapshot>;
     /**
+     * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
      * Gets the current state of a single view and returns an object with the options needed to restore that view as part of a snapshot.
      * @param { Identity } payload Identity of the view.
      * @return { Promise<ViewState> }
+     * @internal
+     * @experimental
      */
     getViewSnapshot(payload: {
         viewIdentity: Identity;

package/src/api/interop/Factory.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const base_1 = require("../base");
 const InteropBroker_1 = require("./InteropBroker");
 const InteropClient_1 = require("./InteropClient");
+const overrideCheck_1 = require("./fdc3/overrideCheck");
 const defaultOverride = (Class, ...args) => new Class(...args);
 /**
  * @typedef { object } InteropConfig
@@ -38,7 +39,9 @@ class InteropModule extends base_1.Base {
             }
             return provider;
         };
-        return override(InteropBroker_1.InteropBroker, this.wire, getProvider, options.initialOptions.interopBrokerConfiguration);
+        const broker = await override(InteropBroker_1.InteropBroker, this.wire, getProvider, options.initialOptions.interopBrokerConfiguration);
+        (0, overrideCheck_1.overrideCheck)(broker, (0, overrideCheck_1.getDefaultViewFdc3VersionFromAppInfo)(options));
+        return broker;
     }
     /**
      * Connects a client to an Interop broker. This is called under-the-hood for Views in a Platform.

package/src/api/interop/InteropBroker.d.ts

@@ -415,7 +415,7 @@ export declare class InteropBroker extends Base {
      * FDC3 2.0: Use the endpointId in the ClientInfo as the instanceId when generating
      * an AppIdentifier.
      * @return { Promise<Array<ClientInfo>> }
-     * @tutorial interop.getAllClientInfo()
+     * @tutorial interop.getAllClientInfo
      */
     getAllClientInfo(): Promise<Array<OpenFin.ClientInfo>>;
     decorateSnapshot(snapshot: OpenFin.Snapshot): OpenFin.Snapshot;

package/src/api/interop/InteropBroker.js

@@ -198,6 +198,7 @@ let contextGroups = [
  */
 class InteropBroker extends base_1.Base {
     constructor(wire, getProvider, options) {
+        // Tip from Pierre and Michael from the overrideCheck work: Don't use bound methods for overrideable InteropBroker functions.
         super(wire);
         this.getProvider = getProvider;
         this.interopClients = new Map();
@@ -746,7 +747,7 @@ class InteropBroker extends base_1.Base {
      * FDC3 2.0: Use the endpointId in the ClientInfo as the instanceId when generating
      * an AppIdentifier.
      * @return { Promise<Array<ClientInfo>> }
-     * @tutorial interop.getAllClientInfo()
+     * @tutorial interop.getAllClientInfo
      */
     async getAllClientInfo() {
         const provider = await this.getProvider();

package/src/api/interop/fdc3/fdc3.d.ts

@@ -1,13 +1,12 @@
 import Fdc3Module from './fdc3-1.2';
 import Fdc3Module2 from './fdc3-2.0';
 import type Transport from '../../../transport/transport';
+import { Fdc3Version } from './versions';
 declare global {
     interface Window {
         fdc3: Fdc3Module | Fdc3Module2;
     }
 }
-declare type Fdc3Versions = '1.2' | '2.0';
-export declare const versionMap: Record<Fdc3Versions, typeof Fdc3Module | typeof Fdc3Module2>;
+export declare const versionMap: Record<Fdc3Version, typeof Fdc3Module | typeof Fdc3Module2>;
 export declare function registerFdc3Shim(version: string, transport: Transport): void;
-export declare function getFdc3(transport: Transport, version?: Fdc3Versions): Fdc3Module | Fdc3Module2;
-export {};
+export declare function getFdc3(transport: Transport, version?: Fdc3Version): Fdc3Module | Fdc3Module2;

package/src/api/interop/fdc3/overrideCheck.d.ts

@@ -0,0 +1,4 @@
+import * as OpenFin from '../../../OpenFin';
+import { Fdc3Version } from './versions';
+export declare function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }: Awaited<ReturnType<OpenFin.Application['getInfo']>>): Fdc3Version | undefined;
+export declare function overrideCheck(overriddenBroker: OpenFin.InteropBroker, fdc3InteropApi?: Fdc3Version): void;

package/src/api/interop/fdc3/overrideCheck.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.overrideCheck = exports.getDefaultViewFdc3VersionFromAppInfo = void 0;
+const InteropBroker_1 = require("../InteropBroker");
+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;
+}
+exports.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')}`);
+        }
+    }
+}
+exports.overrideCheck = overrideCheck;

package/src/api/interop/fdc3/versions.d.ts

@@ -0,0 +1 @@
+export declare type Fdc3Version = '1.2' | '2.0';

package/src/api/interop/fdc3/versions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/api/platform/Instance.d.ts

@@ -65,14 +65,16 @@ export declare class Platform extends EmitterBase<PlatformEvents> {
      */
     getSnapshot(): Promise<OpenFin.Snapshot>;
     /**
+     * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
+     *
      * Returns a snapshot of a single view's options in its current state.
      *
      * Can be used to restore a view to a previous state.
      *
-     * NOTE: this method is meant for advanced usage only, it is not recommended to manage the state of individual views.
-     *
      * @param { Identity } viewIdentity View identity
      * @returns { Promise<ViewState> }
+     * @internal
+     * @experimental
      * @tutorial Platform.getViewSnapshot
      */
     getViewSnapshot(viewIdentity: OpenFin.Identity): Promise<OpenFin.ViewState>;

package/src/api/platform/Instance.js

@@ -174,14 +174,16 @@ class Platform extends base_1.EmitterBase {
         return client.dispatch('get-snapshot');
     }
     /**
+     * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
+     *
      * Returns a snapshot of a single view's options in its current state.
      *
      * Can be used to restore a view to a previous state.
      *
-     * NOTE: this method is meant for advanced usage only, it is not recommended to manage the state of individual views.
-     *
      * @param { Identity } viewIdentity View identity
      * @returns { Promise<ViewState> }
+     * @internal
+     * @experimental
      * @tutorial Platform.getViewSnapshot
      */
     async getViewSnapshot(viewIdentity) {

package/src/api/view/Instance.d.ts

@@ -452,9 +452,12 @@ export declare class View extends WebContents<ViewEvents> {
      */
     triggerBeforeUnload: () => Promise<boolean>;
     /**
+     * **NOTE**: Internal use only.
      * Attaches this view to an HTML element in the current context. The view will resize responsively when the element bounds change.
+     *
      * @param { string } elementId - id of the HTML element to attach the view to.
      * @return {Function} - Cleanup function that will disconnect the element resize observer.
+     * @internal
      * @experimental
      * @tutorial View.bindToElement
      */

package/src/api/view/Instance.js

@@ -457,9 +457,12 @@ class View extends main_1.WebContents {
             return message.payload.data;
         };
         /**
+         * **NOTE**: Internal use only.
          * Attaches this view to an HTML element in the current context. The view will resize responsively when the element bounds change.
+         *
          * @param { string } elementId - id of the HTML element to attach the view to.
          * @return {Function} - Cleanup function that will disconnect the element resize observer.
+         * @internal
          * @experimental
          * @tutorial View.bindToElement
          */