@openfin/core 30.73.6 → 30.73.7

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',
@@ -93,6 +94,32 @@ let contextGroups = [
  * }
  * ```
  *
+ * By default the Interop Broker logs all actions to the console. You can disable this by using the logging option in `interopBrokerConfiguration`:
+ * ```js
+ * {
+ *      "runtime": {
+ *          "arguments": "--v=1 --inspect",
+ *          "version": "alpha-v19"
+ *      },
+ *      "platform": {
+ *          "uuid": "platform_customization_local",
+ *          "applicationIcon": "https://openfin.github.io/golden-prototype/favicon.ico",
+ *          "autoShow": false,
+ *          "providerUrl": "http://localhost:5555/provider.html",
+ *		    "interopBrokerConfiguration": {
+ *       		"logging": {
+ *   				"beforeAction": {
+ *   					"enabled": false
+ *   				},
+ *   				"afterAction": {
+ *   					"enabled": false
+ *   				}
+ *   			}
+ *		    }
+ *      }
+ * }
+ * ```
+ *
  * ---
  * **2. Overriding**
  *
@@ -121,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')
@@ -130,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();
  *   }
  * });
  * ```
@@ -172,59 +169,90 @@ 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();
         this.contextGroupsById = new Map();
-        if (options.contextGroups) {
+        if (options === null || options === void 0 ? void 0 : options.contextGroups) {
             contextGroups = options.contextGroups;
         }
+        if (options === null || options === void 0 ? void 0 : options.logging) {
+            this.logging = options.logging;
+        }
         this.intentClientMap = new Map();
         this.lastContextMap = new Map();
         this.sessionContextGroupMap = new Map();
         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
     */
     /**
+     * @REMOVED
      * SetContextOptions interface
      * @typedef { object } SetContextOptions
      * @property { Context } {context} - New context to set.
      */
     /**
+     * @REMOVED
      * GetContextOptions interface
      * @typedef { object } GetContextOptions
      * @property { string } [contextType] - Context Type
      */
+    // TODO: extract inline type and do proper comments
     /**
+     * @REMOVED
      * JoinContextGroupOptions interface
      * @typedef { object } JoinContextGroupOptions
      * @property { string } contextGroupId - Id of the context group.
      * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
      */
     /**
+     * @REMOVED
      * AddClientToContextGroupOptions interface
      * @typedef { object } AddClientToContextGroupOptions
      * @property { string } contextGroupId - Name of the context group.
      */
     /**
+     * @REMOVED
      * RemoveFromContextGroupOptions interface
      * @typedef { object } RemoveFromContextGroupOptions
      * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
      */
     /**
+     * @REMOVED
      * GetInfoForContextGroupOptions interface
      * @typedef { object } GetInfoForContextGroupOptions
      * @property { string } contextGroupId - Name of the context group to get info for.
      */
     /**
+     * @REMOVED
      * GetAllClientsInContextGroupOptions interface
      * @typedef { object } GetAllClientsInContextGroupOptions
      * @property { string } contextGroupId - Name of the context group to get info for.
      */
     /**
+     * @PORTED
      * InfoForIntentOptions interface
      * @typedef { object } InfoForIntentOptions
      * @property { string } name Name of the intent to get info for.
@@ -371,7 +399,7 @@ class InteropBroker extends base_1.Base {
         const oldContextGroupId = clientSubscriptionState.contextGroupId;
         if (oldContextGroupId !== contextGroupId) {
             clientSubscriptionState.contextGroupId = contextGroupId;
-            await InteropBroker.setCurrentContextGroupInClientOptions(clientIdentity, contextGroupId);
+            await this.setCurrentContextGroupInClientOptions(clientIdentity, contextGroupId);
             const contextGroupMap = this.contextGroupsById.get(contextGroupId);
             for (const [, handlerInfo] of clientSubscriptionState.contextHandlers) {
                 const { contextType, handlerId } = handlerInfo;
@@ -450,7 +478,7 @@ class InteropBroker extends base_1.Base {
         if (clientState) {
             clientState.contextGroupId = undefined;
         }
-        await InteropBroker.setCurrentContextGroupInClientOptions(clientIdentity, null);
+        await this.setCurrentContextGroupInClientOptions(clientIdentity, null);
     }
     // Used by platform windows to know what client groups the provider has declared. Also used internally to access context groups. Overrideable so that the platform developer can modify it.
     /**
@@ -513,7 +541,7 @@ class InteropBroker extends base_1.Base {
      */
     // eslint-disable-next-line class-methods-use-this
     async handleFiredIntent(intent, clientIdentity) {
-        const warning = utils_1.generateOverrideWarning('fdc3.raiseIntent', 'InteropBroker.handleFiredIntent', clientIdentity, 'interopClient.fireIntent');
+        const warning = (0, utils_1.generateOverrideWarning)('fdc3.raiseIntent', 'InteropBroker.handleFiredIntent', clientIdentity, 'interopClient.fireIntent');
         console.warn(warning);
         throw new Error(utils_1.BROKER_ERRORS.fireIntent);
     }
@@ -571,7 +599,7 @@ class InteropBroker extends base_1.Base {
      */
     // eslint-disable-next-line class-methods-use-this
     async handleInfoForIntent(options, clientIdentity) {
-        const warning = utils_1.generateOverrideWarning('fdc3.findIntent', 'InteropBroker.handleInfoForIntent', clientIdentity, 'interopClient.getInfoForIntent');
+        const warning = (0, utils_1.generateOverrideWarning)('fdc3.findIntent', 'InteropBroker.handleInfoForIntent', clientIdentity, 'interopClient.getInfoForIntent');
         console.warn(warning);
         throw new Error(utils_1.BROKER_ERRORS.getInfoForIntent);
     }
@@ -586,7 +614,7 @@ class InteropBroker extends base_1.Base {
      */
     // eslint-disable-next-line class-methods-use-this
     async handleInfoForIntentsByContext(context, clientIdentity) {
-        const warning = utils_1.generateOverrideWarning('fdc3.findIntentsByContext', 'InteropBroker.handleInfoForIntentsByContext', clientIdentity, 'interopClient.getInfoForIntentsByContext');
+        const warning = (0, utils_1.generateOverrideWarning)('fdc3.findIntentsByContext', 'InteropBroker.handleInfoForIntentsByContext', clientIdentity, 'interopClient.getInfoForIntentsByContext');
         console.warn(warning);
         throw new Error(utils_1.BROKER_ERRORS.getInfoForIntentsByContext);
     }
@@ -601,7 +629,7 @@ class InteropBroker extends base_1.Base {
      */
     // eslint-disable-next-line class-methods-use-this
     async handleFiredIntentForContext(contextForIntent, clientIdentity) {
-        const warning = utils_1.generateOverrideWarning('fdc3.raiseIntentForContext', 'InteropBroker.handleFiredIntentForContext', clientIdentity, 'interopClient.fireIntentForContext');
+        const warning = (0, utils_1.generateOverrideWarning)('fdc3.raiseIntentForContext', 'InteropBroker.handleFiredIntentForContext', clientIdentity, 'interopClient.fireIntentForContext');
         console.warn(warning);
         throw new Error(utils_1.BROKER_ERRORS.fireIntentForContext);
     }
@@ -624,7 +652,7 @@ class InteropBroker extends base_1.Base {
      */
     // eslint-disable-next-line class-methods-use-this
     async fdc3HandleOpen({ app, context }, clientIdentity) {
-        const warning = utils_1.generateOverrideWarning('fdc3.open', 'InteropBroker.fdc3HandleOpen', clientIdentity);
+        const warning = (0, utils_1.generateOverrideWarning)('fdc3.open', 'InteropBroker.fdc3HandleOpen', clientIdentity);
         console.warn(warning);
         throw new Error(utils_1.BROKER_ERRORS.fdc3Open);
     }
@@ -636,7 +664,7 @@ class InteropBroker extends base_1.Base {
      */
     // eslint-disable-next-line class-methods-use-this
     async fdc3HandleFindInstances(app, clientIdentity) {
-        const warning = utils_1.generateOverrideWarning('fdc3.open', 'InteropBroker.fdc3HandleFindInstances', clientIdentity);
+        const warning = (0, utils_1.generateOverrideWarning)('fdc3.open', 'InteropBroker.fdc3HandleFindInstances', clientIdentity);
         console.warn(warning);
         throw new Error(utils_1.BROKER_ERRORS.fdc3FindInstances);
     }
@@ -648,7 +676,7 @@ class InteropBroker extends base_1.Base {
      */
     // eslint-disable-next-line class-methods-use-this
     async fdc3HandleGetAppMetadata(app, clientIdentity) {
-        const warning = utils_1.generateOverrideWarning('fdc3.getAppMetadata', 'InteropBroker.fdc3HandleGetAppMetadata', clientIdentity);
+        const warning = (0, utils_1.generateOverrideWarning)('fdc3.getAppMetadata', 'InteropBroker.fdc3HandleGetAppMetadata', clientIdentity);
         console.warn(warning);
         throw new Error(utils_1.BROKER_ERRORS.fdc3GetAppMetadata);
     }
@@ -695,10 +723,33 @@ class InteropBroker extends base_1.Base {
      * @returns { Promise<ImplementationMetadata(2)> }
      */
     // eslint-disable-next-line class-methods-use-this
-    async fdc3HandleGetInfo(clientIdentity) {
-        const warning = utils_1.generateOverrideWarning('fdc3.getInfo', 'InteropBroker.fdc3GetInfo', clientIdentity);
-        console.warn(warning);
-        throw new Error(utils_1.BROKER_ERRORS.fdc3GetInfo);
+    async fdc3HandleGetInfo(payload, clientIdentity) {
+        const { fdc3Version } = payload;
+        return {
+            fdc3Version,
+            provider: 'OpenFin',
+            providerVersion: await this.fin.System.getVersion(),
+            optionalFeatures: {
+                OriginatingAppMetadata: false,
+                UserChannelMembershipAPIs: true
+            },
+            appMetadata: {
+                appId: '',
+                instanceId: ''
+            }
+        };
+    }
+    /**
+     * Returns an array of info for each Interop Client connected to the Interop Broker.
+     *
+     * FDC3 2.0: Use the endpointId in the ClientInfo as the instanceId when generating
+     * an AppIdentifier.
+     * @return { Promise<Array<ClientInfo>> }
+     * @tutorial interop.getAllClientInfo
+     */
+    async getAllClientInfo() {
+        const provider = await this.getProvider();
+        return provider.getAllClientInfo();
     }
     /*
     Snapshot APIs
@@ -908,14 +959,14 @@ class InteropBroker extends base_1.Base {
             this.contextGroupsById.set(contextGroupInfo.id, new Map());
         }
     }
-    static async setCurrentContextGroupInClientOptions(clientIdentity, contextGroupId) {
-        const entityInfo = await fin.System.getEntityInfo(clientIdentity.uuid, clientIdentity.name);
+    async setCurrentContextGroupInClientOptions(clientIdentity, contextGroupId) {
+        const entityInfo = await this.fin.System.getEntityInfo(clientIdentity.uuid, clientIdentity.name);
         let entity;
         if (entityInfo.entityType === 'view') {
-            entity = await fin.View.wrap(clientIdentity);
+            entity = await this.fin.View.wrap(clientIdentity);
         }
         else if (entityInfo.entityType === 'window') {
-            entity = await fin.Window.wrap(clientIdentity);
+            entity = await this.fin.Window.wrap(clientIdentity);
         }
         if (entity) {
             await entity.updateOptions({
@@ -961,7 +1012,7 @@ class InteropBroker extends base_1.Base {
         channel.onDisconnection((clientIdentity) => {
             this.interopClients.delete(clientIdentity.endpointId);
             const targetInfo = this.intentClientMap.get(clientIdentity.name);
-            if (targetInfo && clientIdentity.uuid === fin.me.identity.uuid) {
+            if (targetInfo && clientIdentity.uuid === this.fin.me.uuid) {
                 targetInfo.forEach((handler) => {
                     handler.isReady = false;
                 });
@@ -971,15 +1022,23 @@ class InteropBroker extends base_1.Base {
             });
             this.clientDisconnected(clientIdentity);
         });
-        // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
         channel.beforeAction(async (action, payload, clientIdentity) => {
+            var _a, _b;
             if (!(await this.isActionAuthorized(action, payload, clientIdentity))) {
                 throw new Error(`Action (${action}) not authorized for ${clientIdentity.uuid}, ${clientIdentity.name}`);
             }
-            console.log(action, payload, clientIdentity);
+            if ((_b = (_a = this.logging) === null || _a === void 0 ? void 0 : _a.beforeAction) === null || _b === void 0 ? void 0 : _b.enabled) {
+                console.log(action, payload, clientIdentity);
+            }
+        });
+        channel.afterAction((action, payload, clientIdentity) => {
+            var _a, _b;
+            if ((_b = (_a = this.logging) === null || _a === void 0 ? void 0 : _a.afterAction) === null || _b === void 0 ? void 0 : _b.enabled) {
+                console.log(action, payload, clientIdentity);
+            }
         });
-        channel.afterAction(console.log);
         // Client functions
         channel.register('setContext', this.setContext.bind(this));
         channel.register('fireIntent', this.handleFiredIntent.bind(this));
@@ -1004,7 +1063,7 @@ class InteropBroker extends base_1.Base {
         channel.register('fdc3FindInstances', this.fdc3HandleFindInstances.bind(this));
         channel.register('fdc3GetAppMetadata', this.fdc3HandleGetAppMetadata.bind(this));
         channel.register('fdc3v2GetInfo', async (payload, clientIdentity) => {
-            return this.fdc3HandleGetInfo.bind(this)(clientIdentity);
+            return this.fdc3HandleGetInfo.bind(this)(payload, clientIdentity);
         });
     }
     /**

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

@@ -1,12 +1,15 @@
+import type * as OpenFin from '../../OpenFin';
 import Transport from '../../transport/transport';
 import { Base } from '../base';
 /**
+ * @PORTED
  * @typedef { object } Intent
  * @summary The combination of an action and a context that is passed to an application for resolution.
  * @property { string } name Name of the intent.
  * @property { Context } context Data associated with the intent
  */
 /**
+ * @REMOVED
  * @typedef { object } Subscription
  * @summary Object returned when subscribing a handler.
  * @property { function } unsubscribe Function to unsubscribe the handler.
@@ -20,6 +23,7 @@ import { Base } from '../base';
  * @summary Subscription function for registerIntentHandler
  */
 /**
+ * @PORTED
  * @typedef { object } ClientIdentity
  * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
  * @property {string} uuid GUID of an application.
@@ -27,12 +31,14 @@ import { Base } from '../base';
  * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
  */
 /**
+ * @PORTED
  * @typedef { object } ContextGroupInfo
  * @summary Information for a Context Group. Contains metadata for displaying the group properly.
  * @property {string} id Name of the context group
  * @property {DisplayMetadata} displayMetadata Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.
  */
 /**
+ * @PORTED
  * @typedef { object } DisplayMetadata
  * @summary The display data for a Context Group.
  * @property {string} name A user-readable name for this context group, e.g: `"Red"`
@@ -40,6 +46,7 @@ import { Base } from '../base';
  * @property {string} [glyph] A URL of an image that can be used to display this context group
  */
 /**
+ * @PORTED
  * @typedef { object } Context
  * @summary Data passed between entities and applications.
  * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
@@ -47,6 +54,7 @@ import { Base } from '../base';
  * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
  */
 /**
+ * @REMOVED
  * @typedef { object } ContextForIntent
  * @summary Data passed between entities and applications, including an optional metadata.
  * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
@@ -55,6 +63,7 @@ import { Base } from '../base';
  * @property {any} [metadata]
  */
 /**
+ * @REMOVED
  * @typedef { object } SessionContextGroup
  * @summary An instance of a SessionContextGroup
  * @property {string} id The SessionContextGroup's id.