@openfin/core 29.73.5 → 29.73.8

package/package.json

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

package/src/OpenFin.d.ts

@@ -660,8 +660,8 @@ export declare type LayoutOptions = {
         headerHeight?: number;
     };
 };
-export declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>, ...args: ConstructorParameters<Constructor<T>>) => U | Promise<U>;
-export declare type Constructor<T = {}> = new (...args: any[]) => T;
+export declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
+export declare type Constructor<T = {}> = new () => T;
 export declare type HostContextChangedReasons = 'updated' | 'reparented';
 export declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
 export declare type PlatformProvider = {
@@ -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.d.ts

@@ -1,3 +1,4 @@
+import type * as OpenFin from '../../OpenFin';
 import { Base } from '../base';
 import { InteropBroker } from './InteropBroker';
 import { InteropClient } from './InteropClient';

package/src/api/interop/Factory.js

@@ -1,9 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = require("lodash");
+const inaccessibleObject_1 = require("../../util/inaccessibleObject");
 const base_1 = require("../base");
 const InteropBroker_1 = require("./InteropBroker");
 const InteropClient_1 = require("./InteropClient");
-const defaultOverride = (Class, ...args) => new Class(...args);
+const overrideCheck_1 = require("./fdc3/overrideCheck");
+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.';
 /**
  * @typedef { object } InteropConfig
  * @summary Information relevant to the Interop Broker.
@@ -26,11 +30,15 @@ class InteropModule extends base_1.Base {
      * @static
      */
     async init(name, override = defaultOverride) {
+        var _a;
         this.wire.sendAction('interop-init').catch((e) => {
             // don't expose, analytics-only call
         });
         // Allows for manifest-level configuration, without having to override. (e.g. specifying custom context groups)
         const options = await this.fin.Application.getCurrentSync().getInfo();
+        const opts = (_a = options.initialOptions.interopBrokerConfiguration) !== null && _a !== void 0 ? _a : {};
+        const objectThatThrows = (0, inaccessibleObject_1.createUnusableObject)(BrokerParamAccessError);
+        const warningOptsClone = (0, inaccessibleObject_1.createWarningObject)(BrokerParamAccessError, (0, lodash_1.cloneDeep)(opts));
         let provider;
         const getProvider = () => {
             if (!provider) {
@@ -38,7 +46,16 @@ class InteropModule extends base_1.Base {
             }
             return provider;
         };
-        return override(InteropBroker_1.InteropBroker, this.wire, getProvider, options.initialOptions.interopBrokerConfiguration);
+        const throwingGetProvider = async () => {
+            // eslint-disable-next-line no-console
+            throw new Error(BrokerParamAccessError);
+        };
+        const OverrideableBroker = InteropBroker_1.InteropBroker.createClosedConstructor(this.wire, getProvider, opts);
+        // We need to use these objects because removing them entirely would be a breaking change and we want an informative error
+        // @ts-expect-error
+        const broker = await override(OverrideableBroker, objectThatThrows, throwingGetProvider, warningOptsClone);
+        (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

@@ -2,7 +2,7 @@ import { TargetApp } from './fdc3/shapes/fdc3v1';
 import { AppIdentifier } from './fdc3/shapes/fdc3v2';
 import { Base } from '../base';
 import type Transport from '../../transport/transport';
-import Identity = OpenFin.Identity;
+declare type Identity = OpenFin.Identity;
 /**
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking **THE INTEROP API IS EXPERIMENTAL. IF YOU WOULD LIKE TO USE IT, PLEASE USE OUR DEFAULT IMPLEMENTATION IN BROWSER**}
  *
@@ -102,7 +102,7 @@ import Identity = OpenFin.Identity;
  *         };
  *         return new Override();
  *     },
- *     interopOverride: async (InteropBroker, provider, options, ...args) => {
+ *     interopOverride: async (InteropBroker) => {
  *         class Override extends InteropBroker {
  *             async joinContextGroup(channelName = 'default', target) {
  *                 console.log('before super joinContextGroup')
@@ -111,37 +111,7 @@ import Identity = OpenFin.Identity;
  *             }
  *         }
  *
- *         options.contextGroups = [
- *             {
- *                 id: 'green',
- *                 displayMetadata: {
- *                     color: '#00CC88',
- *                     name: 'green'
- *                 }
- *             },
- *             {
- *                 id: 'purple',
- *                 displayMetadata: {
- *                     color: '#8C61FF',
- *                     name: 'purple'
- *                 }
- *             },
- *             {
- *                 id: 'orange',
- *                 displayMetadata: {
- *                     color: '#FF8C4C',
- *                     name: 'orange'
- *                 }
- *             },
- *             {
- *                 id: 'red',
- *                 displayMetadata: {
- *                     color: '#FF5E60',
- *                     name: 'red'
- *                 }
- *             }
- *         ];
- *       return new Override(provider, options, ...args);
+ *       return new Override();
  *   }
  * });
  * ```
@@ -161,6 +131,9 @@ export declare class InteropBroker extends Base {
     private channel;
     private logging;
     constructor(wire: Transport, getProvider: () => Promise<OpenFin.ChannelProvider>, options?: any);
+    static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
+        new (): InteropBroker;
+    };
     /**
      * SetContextOptions interface
      * @typedef { object } SetContextOptions
@@ -415,7 +388,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;
@@ -465,3 +438,4 @@ export declare class InteropBroker extends Base {
      */
     isActionAuthorized(_action: string, _payload: any, _identity: OpenFin.ClientIdentity): Promise<boolean> | boolean;
 }
+export {};

package/src/api/interop/InteropBroker.js

@@ -4,6 +4,7 @@ exports.InteropBroker = void 0;
 const base_1 = require("../base");
 const SessionContextGroupBroker_1 = require("./SessionContextGroupBroker");
 const utils_1 = require("./utils");
+const lodash_1 = require("lodash");
 let contextGroups = [
     {
         id: 'green',
@@ -147,7 +148,7 @@ let contextGroups = [
  *         };
  *         return new Override();
  *     },
- *     interopOverride: async (InteropBroker, provider, options, ...args) => {
+ *     interopOverride: async (InteropBroker) => {
  *         class Override extends InteropBroker {
  *             async joinContextGroup(channelName = 'default', target) {
  *                 console.log('before super joinContextGroup')
@@ -156,37 +157,7 @@ let contextGroups = [
  *             }
  *         }
  *
- *         options.contextGroups = [
- *             {
- *                 id: 'green',
- *                 displayMetadata: {
- *                     color: '#00CC88',
- *                     name: 'green'
- *                 }
- *             },
- *             {
- *                 id: 'purple',
- *                 displayMetadata: {
- *                     color: '#8C61FF',
- *                     name: 'purple'
- *                 }
- *             },
- *             {
- *                 id: 'orange',
- *                 displayMetadata: {
- *                     color: '#FF8C4C',
- *                     name: 'orange'
- *                 }
- *             },
- *             {
- *                 id: 'red',
- *                 displayMetadata: {
- *                     color: '#FF5E60',
- *                     name: 'red'
- *                 }
- *             }
- *         ];
- *       return new Override(provider, options, ...args);
+ *       return new Override();
  *   }
  * });
  * ```
@@ -198,6 +169,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();
@@ -214,6 +186,24 @@ class InteropBroker extends base_1.Base {
         this.setContextGroupMap();
         this.setupChannelProvider();
     }
+    static createClosedConstructor(...args) {
+        return class OverrideableBroker extends InteropBroker {
+            constructor(...unused) {
+                if (unused.length) {
+                    const [_ignore1, ignore2, opts] = unused;
+                    if (opts && typeof opts === 'object' && !(0, lodash_1.isEqual)(opts, args[2])) {
+                        // eslint-disable-next-line no-console
+                        console.warn('You have modified the parameters of the InteropOverride constructor. This behavior is deprecated and will be removed in a future version. You can modify these options in your manifest. Please consult our Interop docs for guidance on migrating to the new override scheme.');
+                        super(args[0], args[1], opts);
+                        return;
+                    }
+                    // eslint-disable-next-line no-console
+                    console.warn('You are attempting to pass arguments to the InteropOverride constructor. This is not necessary, and these passed arguments will be ignored. You are likely using an older InteropBroker override scheme. Please consult our Interop docs for guidance on migrating to the new override scheme.');
+                }
+                super(...args);
+            }
+        };
+    }
     /*
     Client API
     */
@@ -746,7 +736,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
          */

package/src/util/inaccessibleObject.d.ts

@@ -0,0 +1,2 @@
+export declare function createUnusableObject(message: string): Record<any, never>;
+export declare function createWarningObject<T extends {}>(message: string, obj: T): T;

package/src/util/inaccessibleObject.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createWarningObject = exports.createUnusableObject = void 0;
+function createUnusableObject(message) {
+    const handle = () => {
+        throw new Error(message);
+    };
+    return new Proxy({}, {
+        apply: handle,
+        construct: handle,
+        defineProperty: handle,
+        deleteProperty: handle,
+        get: handle,
+        getOwnPropertyDescriptor: handle,
+        getPrototypeOf: handle,
+        has: handle,
+        isExtensible: handle,
+        ownKeys: handle,
+        preventExtensions: handle,
+        set: handle,
+        setPrototypeOf: handle
+    });
+}
+exports.createUnusableObject = createUnusableObject;
+function createWarningObject(message, obj) {
+    return new Proxy(obj, {
+        get: (...args) => {
+            // eslint-disable-next-line no-console
+            console.warn(message);
+            return Reflect.get(...args);
+        },
+        set: (...args) => {
+            // eslint-disable-next-line no-console
+            console.warn(message);
+            return Reflect.set(...args);
+        },
+        getOwnPropertyDescriptor: (...args) => {
+            // eslint-disable-next-line no-console
+            console.warn(message);
+            return Reflect.getOwnPropertyDescriptor(...args);
+        },
+        ownKeys: (...args) => {
+            // eslint-disable-next-line no-console
+            console.warn(message);
+            return Reflect.ownKeys(...args);
+        }
+    });
+}
+exports.createWarningObject = createWarningObject;