@openfin/core 30.73.28 → 31.74.2

package/src/api/interop/Factory.js

@@ -1,10 +1,15 @@
 "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.';
 /**
+ * @PORTED
  * @typedef { object } InteropConfig
  * @summary Information relevant to the Interop Broker.
  * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
@@ -22,15 +27,18 @@ class InteropModule extends base_1.Base {
      * @param { OverrideCallback<InteropBroker> } [override] - A callback function that can be used to extend or replace default Interop Broker behavior.
      * @return {Promise.<InteropBroker>}
      * @tutorial Interop.init
-     * @experimental
      * @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.
@@ -47,7 +64,6 @@ class InteropModule extends base_1.Base {
      * what context(s) the entity wants to subscribe to, and the current Context Group of the entity.
      * @return {InteropClient}
      * @tutorial Interop.connectSync
-     * @experimental
      * @static
      */
     connectSync(name, interopConfig) {

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

@@ -2,10 +2,10 @@ import { TargetApp } from './fdc3/shapes/fdc3v1';
 import { AppIdentifier } from './fdc3/shapes/fdc3v2';
 import type * as OpenFin from '../../OpenFin';
 import { Base } from '../base';
-import type Transport from '../../transport/transport';
-declare type Identity = OpenFin.Identity;
+import type { Transport } from '../../transport/transport';
+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**}
+ * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
  *
  * The Interop Broker is responsible for keeping track of the Interop state of the Platform, and for directing messages to the proper locations.
  *
@@ -103,7 +103,7 @@ declare type 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')
@@ -112,37 +112,7 @@ declare type 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();
  *   }
  * });
  * ```
@@ -162,43 +132,54 @@ 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;
+    };
     /**
+     * @REMOVED
      * SetContextOptions interface
      * @typedef { object } SetContextOptions
      * @property { Context } {context} - New context to set.
      */
     /**
+     * @REMOVED
      * GetContextOptions interface
      * @typedef { object } GetContextOptions
      * @property { string } [contextType] - Context Type
      */
     /**
+     * @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.
@@ -209,7 +190,6 @@ export declare class InteropBroker extends Base {
      * @param { SetContextOptions } setContextOptions - New context to set.
      * @param { ClientIdentity } clientIdentity - Identity of the client sender.
      * @return { void }
-     * @experimental
      */
     setContext({ context }: {
         context: OpenFin.Context;
@@ -231,7 +211,6 @@ export declare class InteropBroker extends Base {
      * @return { Promise<void> }
      * @param { JoinContextGroupOptions } joinContextGroupOptions - Id of the Context Group and identity of the entity to join to the group.
      * @param { ClientIdentity } senderIdentity - Identity of the client sender.
-     * @experimental
      */
     joinContextGroup({ contextGroupId, target }: {
         contextGroupId: string;
@@ -243,7 +222,6 @@ export declare class InteropBroker extends Base {
      * @return { Promise<void> }
      * @param { AddClientToContextGroupOptions } addClientToContextGroupOptions - Contains the contextGroupId
      * @param { ClientIdentity } clientIdentity - Identity of the client sender.
-     * @experimental
      */
     addClientToContextGroup({ contextGroupId }: {
         contextGroupId: string;
@@ -256,7 +234,6 @@ export declare class InteropBroker extends Base {
      * @return { Promise<void> }
      * @param { RemoveFromContextGroupOptions } removeFromContextGroupOptions - Contains the target identity to remove.
      * @param { ClientIdentity } senderIdentity - Identity of the client sender.
-     * @experimental
      */
     removeFromContextGroup({ target }: {
         target: OpenFin.Identity;
@@ -266,14 +243,12 @@ export declare class InteropBroker extends Base {
      * Used by Platform Windows.
      * @return { Promise<void> }
      * @property { ClientIdentity } clientIdentity - Identity of the client sender.
-     * @experimental
      */
     removeClientFromContextGroup(clientIdentity: OpenFin.ClientIdentity): Promise<void>;
     /**
      * Returns the Interop-Broker-defined context groups available for an entity to join. Because this function is used in the rest of the Interop Broker to fetch the Context Groups, overriding this allows you to customize the Context Groups for the Interop Broker. However, we recommend customizing the context groups through configuration instead.
      * Used by Platform Windows.
      * @return { Promise<ContextGroupInfo[]>}
-     * @experimental
      */
     getContextGroups(): Readonly<OpenFin.ContextGroupInfo[]>;
     /**
@@ -281,7 +256,6 @@ export declare class InteropBroker extends Base {
      * Used by Platform Windows.
      * @param { GetInfoForContextGroupOptions } getInfoForContextGroupOptions - Contains contextGroupId, the context group you wish to get display info for.
      * @return { Promise<ContextGroupInfo>}
-     * @experimental
      */
     getInfoForContextGroup({ contextGroupId }: {
         contextGroupId: string;
@@ -291,7 +265,6 @@ export declare class InteropBroker extends Base {
      * Used by Platform Windows.
      * @param { GetAllClientsInContextGroupOptions } getAllClientsInContextGroupOptions - Contains contextGroupId, the context group you wish to get clients for.
      * @return { Promise<ClientIdentity[]>}
-     * @experimental
      */
     getAllClientsInContextGroup({ contextGroupId }: {
         contextGroupId: string;
@@ -303,7 +276,6 @@ export declare class InteropBroker extends Base {
      * @param { ClientIdentity }  clientIdentity Identity of the Client making the request.
      * @return { Promise<unknown> }
      * @tutorial interop.handleFiredIntent
-     * @experimental
      */
     handleFiredIntent(intent: OpenFin.Intent, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
     /**
@@ -312,7 +284,6 @@ export declare class InteropBroker extends Base {
      * @param { Intent } intent The combination of an action and a context that is passed to an application for resolution.
      * @param { Identity } target - Identity of the target that will handle the intent.
      * @return { Promise<void> }
-     * @experimental
      */
     setIntentTarget(intent: OpenFin.Intent, target: OpenFin.Identity): Promise<void>;
     /**
@@ -322,7 +293,6 @@ export declare class InteropBroker extends Base {
      * @param { ClientIdentity }  clientIdentity Identity of the Client making the request.
      * @return { Promise<unknown> }
      * @tutorial interop.handleInfoForIntent
-     * @experimental
      */
     handleInfoForIntent(options: OpenFin.InfoForIntentOptions, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
     /**
@@ -332,7 +302,6 @@ export declare class InteropBroker extends Base {
      * @param { ClientIdentity } clientIdentity Identity of the Client making the request.
      * @return { Promise<unknown> }
      * @tutorial interop.handleInfoForIntentsByContext
-     * @experimental
      */
     handleInfoForIntentsByContext(context: OpenFin.Context | OpenFin.FindIntentsByContextOptions, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
     /**
@@ -342,7 +311,6 @@ export declare class InteropBroker extends Base {
      * @param { ClientIdentity }  clientIdentity Identity of the Client making the request.
      * @return { Promise<unknown> }
      * @tutorial interop.handleFiredIntentForContext
-     * @experimental
      */
     handleFiredIntentForContext(contextForIntent: OpenFin.ContextForIntent, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
     /**

package/src/api/interop/InteropBroker.js

@@ -4,6 +4,8 @@ exports.InteropBroker = void 0;
 const base_1 = require("../base");
 const SessionContextGroupBroker_1 = require("./SessionContextGroupBroker");
 const utils_1 = require("./utils");
+const lodash_1 = require("lodash");
+const PrivateChannelProvider_1 = require("./fdc3/PrivateChannelProvider");
 let contextGroups = [
     {
         id: 'green',
@@ -49,7 +51,7 @@ let contextGroups = [
     }
 ];
 /**
- * {@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**}
+ * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
  *
  * The Interop Broker is responsible for keeping track of the Interop state of the Platform, and for directing messages to the proper locations.
  *
@@ -147,7 +149,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 +158,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 +170,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,46 +187,73 @@ 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
     */
     /**
+     * @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.
@@ -264,7 +264,6 @@ class InteropBroker extends base_1.Base {
      * @param { SetContextOptions } setContextOptions - New context to set.
      * @param { ClientIdentity } clientIdentity - Identity of the client sender.
      * @return { void }
-     * @experimental
      */
     setContext({ context }, clientIdentity) {
         this.wire.sendAction('interop-broker-set-context').catch((e) => {
@@ -338,7 +337,6 @@ class InteropBroker extends base_1.Base {
      * @return { Promise<void> }
      * @param { JoinContextGroupOptions } joinContextGroupOptions - Id of the Context Group and identity of the entity to join to the group.
      * @param { ClientIdentity } senderIdentity - Identity of the client sender.
-     * @experimental
      */
     async joinContextGroup({ contextGroupId, target }, senderIdentity) {
         this.wire.sendAction('interop-broker-join-context-group').catch((e) => {
@@ -384,7 +382,6 @@ class InteropBroker extends base_1.Base {
      * @return { Promise<void> }
      * @param { AddClientToContextGroupOptions } addClientToContextGroupOptions - Contains the contextGroupId
      * @param { ClientIdentity } clientIdentity - Identity of the client sender.
-     * @experimental
      */
     async addClientToContextGroup({ contextGroupId }, clientIdentity) {
         this.wire.sendAction('interop-broker-add-client-to-context-group').catch((e) => {
@@ -428,7 +425,6 @@ class InteropBroker extends base_1.Base {
      * @return { Promise<void> }
      * @param { RemoveFromContextGroupOptions } removeFromContextGroupOptions - Contains the target identity to remove.
      * @param { ClientIdentity } senderIdentity - Identity of the client sender.
-     * @experimental
      */
     async removeFromContextGroup({ target }, senderIdentity) {
         this.wire.sendAction('interop-broker-remove-from-context-group').catch((e) => {
@@ -469,7 +465,6 @@ class InteropBroker extends base_1.Base {
      * Used by Platform Windows.
      * @return { Promise<void> }
      * @property { ClientIdentity } clientIdentity - Identity of the client sender.
-     * @experimental
      */
     async removeClientFromContextGroup(clientIdentity) {
         this.wire.sendAction('interop-broker-remove-client-from-context-group').catch((e) => {
@@ -486,7 +481,6 @@ class InteropBroker extends base_1.Base {
      * Returns the Interop-Broker-defined context groups available for an entity to join. Because this function is used in the rest of the Interop Broker to fetch the Context Groups, overriding this allows you to customize the Context Groups for the Interop Broker. However, we recommend customizing the context groups through configuration instead.
      * Used by Platform Windows.
      * @return { Promise<ContextGroupInfo[]>}
-     * @experimental
      */
     // eslint-disable-next-line class-methods-use-this
     getContextGroups() {
@@ -504,7 +498,6 @@ class InteropBroker extends base_1.Base {
      * Used by Platform Windows.
      * @param { GetInfoForContextGroupOptions } getInfoForContextGroupOptions - Contains contextGroupId, the context group you wish to get display info for.
      * @return { Promise<ContextGroupInfo>}
-     * @experimental
      */
     getInfoForContextGroup({ contextGroupId }) {
         this.wire.sendAction('interop-broker-get-info-for-context-group').catch((e) => {
@@ -518,7 +511,6 @@ class InteropBroker extends base_1.Base {
      * Used by Platform Windows.
      * @param { GetAllClientsInContextGroupOptions } getAllClientsInContextGroupOptions - Contains contextGroupId, the context group you wish to get clients for.
      * @return { Promise<ClientIdentity[]>}
-     * @experimental
      */
     getAllClientsInContextGroup({ contextGroupId }) {
         this.wire.sendAction('interop-broker-get-all-clients-in-context-group').catch((e) => {
@@ -538,7 +530,6 @@ class InteropBroker extends base_1.Base {
      * @param { ClientIdentity }  clientIdentity Identity of the Client making the request.
      * @return { Promise<unknown> }
      * @tutorial interop.handleFiredIntent
-     * @experimental
      */
     // eslint-disable-next-line class-methods-use-this
     async handleFiredIntent(intent, clientIdentity) {
@@ -552,7 +543,6 @@ class InteropBroker extends base_1.Base {
      * @param { Intent } intent The combination of an action and a context that is passed to an application for resolution.
      * @param { Identity } target - Identity of the target that will handle the intent.
      * @return { Promise<void> }
-     * @experimental
      */
     async setIntentTarget(intent, target) {
         this.wire.sendAction('interop-broker-set-intent-target').catch((e) => {
@@ -596,7 +586,6 @@ class InteropBroker extends base_1.Base {
      * @param { ClientIdentity }  clientIdentity Identity of the Client making the request.
      * @return { Promise<unknown> }
      * @tutorial interop.handleInfoForIntent
-     * @experimental
      */
     // eslint-disable-next-line class-methods-use-this
     async handleInfoForIntent(options, clientIdentity) {
@@ -611,7 +600,6 @@ class InteropBroker extends base_1.Base {
      * @param { ClientIdentity } clientIdentity Identity of the Client making the request.
      * @return { Promise<unknown> }
      * @tutorial interop.handleInfoForIntentsByContext
-     * @experimental
      */
     // eslint-disable-next-line class-methods-use-this
     async handleInfoForIntentsByContext(context, clientIdentity) {
@@ -626,7 +614,6 @@ class InteropBroker extends base_1.Base {
      * @param { ClientIdentity }  clientIdentity Identity of the Client making the request.
      * @return { Promise<unknown> }
      * @tutorial interop.handleFiredIntentForContext
-     * @experimental
      */
     // eslint-disable-next-line class-methods-use-this
     async handleFiredIntentForContext(contextForIntent, clientIdentity) {
@@ -1023,8 +1010,6 @@ class InteropBroker extends base_1.Base {
             });
             this.clientDisconnected(clientIdentity);
         });
-        // 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))) {
@@ -1066,6 +1051,11 @@ class InteropBroker extends base_1.Base {
         channel.register('fdc3v2GetInfo', async (payload, clientIdentity) => {
             return this.fdc3HandleGetInfo.bind(this)(payload, clientIdentity);
         });
+        channel.register('createPrivateChannelProvider', async (payload) => {
+            const { channelId } = payload;
+            const channelProvider = await this.fin.InterApplicationBus.Channel.create(channelId);
+            PrivateChannelProvider_1.PrivateChannelProvider.init(channelProvider, channelId);
+        });
     }
     /**
      * Can be used to completely prevent a connection. Return false to prevent connections. Allows all connections by default.

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

@@ -1,13 +1,15 @@
 import type * as OpenFin from '../../OpenFin';
-import Transport from '../../transport/transport';
+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.
@@ -21,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.
@@ -28,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"`
@@ -41,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.
@@ -48,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.
@@ -56,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.
@@ -83,7 +91,7 @@ import { Base } from '../base';
  * @return {Promise<void>}
  */
 /**
- * {@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**}
+ * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
  *
  * The Interop Client API is broken up into two groups:
  *
@@ -207,7 +215,6 @@ export declare class InteropClient extends Base {
      * @param { Intent } intent - The combination of an action and a context that is passed to an application for resolution.
      * @return { Promise<unknown>}
      * @tutorial interop.fireIntent
-     * @experimental
      */
     fireIntent<T = unknown>(intent: OpenFin.Intent): Promise<T>;
     /**
@@ -216,7 +223,6 @@ export declare class InteropClient extends Base {
      * @param { string } intentName - The name of an intent.
      * @return { Promise<Subscription> }
      * @tutorial interop.registerIntentHandler
-     * @experimental
      */
     registerIntentHandler(handler: OpenFin.IntentHandler, intentName: string, options?: any): Promise<{
         unsubscribe: () => Promise<void>;
@@ -227,7 +233,6 @@ export declare class InteropClient extends Base {
      * @param { string } [contextType]
      * @return { Promise<Context> }
      * @tutorial interop.getCurrentContext
-     * @experimental
      */
     getCurrentContext(contextType?: string): Promise<OpenFin.Context>;
     /**
@@ -235,7 +240,6 @@ export declare class InteropClient extends Base {
      * @param { InfoForIntentOptions } options
      * @return { Promise<unknown> }
      * @tutorial interop.getInfoForIntent
-     * @experimental
      */
     getInfoForIntent<T = unknown>(options: OpenFin.InfoForIntentOptions): Promise<T>;
     /**
@@ -243,7 +247,6 @@ export declare class InteropClient extends Base {
      * @param { Context } context
      * @return { Promise<unknown> }
      * @tutorial interop.getInfoForIntentsByContext
-     * @experimental
      */
     getInfoForIntentsByContext<T = unknown>(context: OpenFin.Context): Promise<T>;
     /**
@@ -252,7 +255,6 @@ export declare class InteropClient extends Base {
      * @param { ContextForIntent } context
      * @return { Promise<unknown> }
      * @tutorial interop.fireIntentForContext
-     * @experimental
      */
     fireIntentForContext<T = unknown>(context: OpenFin.ContextForIntent): Promise<T>;
     /**
@@ -262,7 +264,6 @@ export declare class InteropClient extends Base {
      * @param { string } sessionContextGroupId - Id of the context group.
      * @return { Promise<SessionContextGroup>}
      * @tutorial interop.joinSessionContextGroup
-     * @experimental
      */
     joinSessionContextGroup(sessionContextGroupId: string): Promise<OpenFin.SessionContextGroup>;
     /**