@openfin/remote-adapter 45.100.114 → 45.100.115

package/out/remote-adapter.js

@@ -758,6 +758,45 @@ class AsyncRetryableLazy {
     }
 }
 
+/**
+ * The default FDC3 user channels advertised by the Interop Broker.
+ */
+const defaultColorChannels = {
+    'fdc3.channel.1': { name: 'Channel 1', color: 'red', glyph: '1' },
+    'fdc3.channel.2': { name: 'Channel 2', color: 'orange', glyph: '2' },
+    'fdc3.channel.3': { name: 'Channel 3', color: 'yellow', glyph: '3' },
+    'fdc3.channel.4': { name: 'Channel 4', color: 'green', glyph: '4' },
+    'fdc3.channel.5': { name: 'Channel 5', color: 'cyan', glyph: '5' },
+    'fdc3.channel.6': { name: 'Channel 6', color: 'blue', glyph: '6' },
+    'fdc3.channel.7': { name: 'Channel 7', color: 'magenta', glyph: '7' },
+    'fdc3.channel.8': { name: 'Channel 8', color: 'purple', glyph: '8' }
+};
+const legacyColorChannelIds = {
+    red: 'fdc3.channel.1',
+    orange: 'fdc3.channel.2',
+    yellow: 'fdc3.channel.3',
+    green: 'fdc3.channel.4',
+    teal: 'fdc3.channel.5',
+    blue: 'fdc3.channel.6',
+    pink: 'fdc3.channel.7',
+    // Legacy indigo (workspace) and purple (core) intentionally converge on the same FDC3 purple channel.
+    indigo: 'fdc3.channel.8',
+    purple: 'fdc3.channel.8'
+};
+/**
+ * Converts a legacy color-named channel ID to its canonical FDC3 user-channel ID.
+ * The removed legacy gray channel resolves to no channel.
+ */
+function normalizeColorChannelId(colorChannelId) {
+    if (colorChannelId === 'gray') {
+        return undefined;
+    }
+    if (Object.prototype.hasOwnProperty.call(legacyColorChannelIds, colorChannelId)) {
+        return legacyColorChannelIds[colorChannelId];
+    }
+    return colorChannelId;
+}
+
 var __classPrivateFieldSet$k = (undefined && undefined.__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");
@@ -770,50 +809,7 @@ var __classPrivateFieldGet$l = (undefined && undefined.__classPrivateFieldGet) |
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _InteropBroker_fdc3Info, _InteropBroker_contextGroups, _InteropBroker_providerPromise;
-const defaultContextGroups = [
-    {
-        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'
-        }
-    },
-    {
-        id: 'pink',
-        displayMetadata: {
-            color: '#FF8FB8',
-            name: 'pink'
-        }
-    },
-    {
-        id: 'yellow',
-        displayMetadata: {
-            color: '#E9FF8F',
-            name: 'yellow'
-        }
-    }
-];
+const defaultContextGroups = Object.entries(defaultColorChannels).map(([id, displayMetadata]) => ({ id, displayMetadata }));
 /**
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
  *
@@ -843,17 +839,19 @@ const defaultContextGroups = [
  *          "interopBrokerConfiguration": {
  *              "contextGroups": [
  *                  {
- *                      "id": "green",
+ *                      "id": "fdc3.channel.4",
  *                      "displayMetadata": {
- *                          "color": "#00CC88",
- *                          "name": "green"
+ *                          "color": "green",
+ *                          "name": "Channel 4",
+ *                          "glyph": "4"
  *                      }
  *                  },
  *                  {
- *                      "id": "purple",
+ *                      "id": "fdc3.channel.8",
  *                      "displayMetadata": {
- *                          "color": "#8C61FF",
- *                          "name": "purple"
+ *                          "color": "purple",
+ *                          "name": "Channel 8",
+ *                          "glyph": "8"
  *                      }
  *                  },
  *              ]
@@ -1016,9 +1014,13 @@ class InteropBroker extends Base {
         this.wire.sendAction('interop-broker-set-context-for-group').catch((e) => {
             // don't expose, analytics-only call
         });
-        const contextGroupState = this.contextGroupsById.get(contextGroupId);
+        const normalizedContextGroupId = this.normalizeContextGroupId(contextGroupId);
+        if (normalizedContextGroupId === undefined) {
+            return;
+        }
+        const contextGroupState = this.contextGroupsById.get(normalizedContextGroupId);
         if (!contextGroupState) {
-            throw new Error(`Unable to set context for context group that isn't in the context group mapping: ${contextGroupId}.`);
+            throw new Error(`Unable to set context for context group that isn't in the context group mapping: ${normalizedContextGroupId}.`);
         }
         const contextIntegrityCheckResult = InteropBroker.checkContextIntegrity(context);
         if (contextIntegrityCheckResult.isValid === false) {
@@ -1026,8 +1028,8 @@ class InteropBroker extends Base {
         }
         const broadcastedContextType = context.type;
         contextGroupState.set(broadcastedContextType, context);
-        this.lastContextMap.set(contextGroupId, broadcastedContextType);
-        const clientsInSameContextGroup = Array.from(this.interopClients.values()).filter((connectedClient) => connectedClient.contextGroupId === contextGroupId);
+        this.lastContextMap.set(normalizedContextGroupId, broadcastedContextType);
+        const clientsInSameContextGroup = Array.from(this.interopClients.values()).filter((connectedClient) => connectedClient.contextGroupId === normalizedContextGroupId);
         clientsInSameContextGroup.forEach((client) => {
             for (const [, handlerInfo] of client.contextHandlers) {
                 if (InteropBroker.isContextTypeCompatible(broadcastedContextType, handlerInfo.contextType)) {
@@ -1073,10 +1075,20 @@ class InteropBroker extends Base {
      * @param joinContextGroupOptions - Id of the Context Group and identity of the entity to join to the group.
      * @param senderIdentity - Identity of the client sender.
      */
-    async joinContextGroup({ contextGroupId, target }, senderIdentity) {
+    async joinContextGroup({ contextGroupId: requestedContextGroupId, target }, senderIdentity) {
         this.wire.sendAction('interop-broker-join-context-group').catch((e) => {
             // don't expose, analytics-only call
         });
+        const contextGroupId = this.normalizeContextGroupId(requestedContextGroupId);
+        if (contextGroupId === undefined) {
+            if (target) {
+                await this.removeFromContextGroup({ target }, senderIdentity);
+            }
+            else {
+                await this.removeClientFromContextGroup(senderIdentity);
+            }
+            return;
+        }
         if (this.sessionContextGroupMap.has(contextGroupId)) {
             throw new Error(BROKER_ERRORS.joinSessionContextGroupWithJoinContextGroup);
         }
@@ -1118,10 +1130,15 @@ class InteropBroker extends Base {
      * @param addClientToContextGroupOptions - Contains the contextGroupId
      * @param clientIdentity - Identity of the client sender.
      */
-    async addClientToContextGroup({ contextGroupId }, clientIdentity) {
+    async addClientToContextGroup({ contextGroupId: requestedContextGroupId }, clientIdentity) {
         this.wire.sendAction('interop-broker-add-client-to-context-group').catch((e) => {
             // don't expose, analytics-only call
         });
+        const contextGroupId = this.normalizeContextGroupId(requestedContextGroupId);
+        if (contextGroupId === undefined) {
+            await this.removeClientFromContextGroup(clientIdentity);
+            return;
+        }
         const clientSubscriptionState = this.getClientState(clientIdentity);
         if (!clientSubscriptionState) {
             throw new Error(`Client with Identity: ${clientIdentity.uuid} ${clientIdentity.name} not in Client State Map`);
@@ -1220,6 +1237,9 @@ class InteropBroker extends Base {
             clientState.contextGroupId = undefined;
         }
         await this.setCurrentContextGroupInClientOptions(clientIdentity, null);
+        if (previousContextGroupId === undefined) {
+            return;
+        }
         // All settled will suppress uncaught exceptions. We don't want to await this because it could
         // result in the operation hanging.
         Promise.allSettled(this.channel.publish('client-changed-context-group', {
@@ -1257,7 +1277,11 @@ class InteropBroker extends Base {
         this.wire.sendAction('interop-broker-get-info-for-context-group').catch((e) => {
             // don't expose, analytics-only call
         });
-        return this.getContextGroups().find((contextGroup) => contextGroup.id === contextGroupId);
+        const normalizedContextGroupId = this.normalizeContextGroupId(contextGroupId);
+        if (normalizedContextGroupId === undefined) {
+            return undefined;
+        }
+        return this.getContextGroups().find((contextGroup) => contextGroup.id === normalizedContextGroupId);
     }
     // Used by platform windows to get all clients for a context group.
     /**
@@ -1273,8 +1297,12 @@ class InteropBroker extends Base {
         this.wire.sendAction('interop-broker-get-all-clients-in-context-group').catch((e) => {
             // don't expose, analytics-only call
         });
+        const normalizedContextGroupId = this.normalizeContextGroupId(contextGroupId);
+        if (normalizedContextGroupId === undefined) {
+            return [];
+        }
         const clientsInContextGroup = Array.from(this.interopClients.values())
-            .filter((connectedClient) => connectedClient.contextGroupId === contextGroupId)
+            .filter((connectedClient) => connectedClient.contextGroupId === normalizedContextGroupId)
             .map((subscriptionState) => {
             return subscriptionState.clientIdentity;
         });
@@ -1721,8 +1749,9 @@ class InteropBroker extends Base {
     }
     // Used to restore interop broker state in snapshots.
     applySnapshot(snapshot, options) {
-        const contextGroupStates = snapshot?.interopSnapshotDetails?.contextGroupStates;
-        if (contextGroupStates) {
+        const incomingContextGroupStates = snapshot?.interopSnapshotDetails?.contextGroupStates;
+        if (incomingContextGroupStates) {
+            const contextGroupStates = this.normalizeContextGroupStates(incomingContextGroupStates);
             if (!options?.closeExistingWindows) {
                 this.updateExistingClients(contextGroupStates);
             }
@@ -1867,6 +1896,23 @@ class InteropBroker extends Base {
         });
         return newObject;
     }
+    normalizeContextGroupStates(incomingContextGroupStates) {
+        const normalizedContextGroupStates = {};
+        for (const [contextGroupId, contexts] of Object.entries(incomingContextGroupStates)) {
+            const normalizedContextGroupId = this.normalizeContextGroupId(contextGroupId);
+            if (normalizedContextGroupId !== undefined) {
+                normalizedContextGroupStates[normalizedContextGroupId] = {
+                    ...normalizedContextGroupStates[normalizedContextGroupId],
+                    ...contexts
+                };
+            }
+        }
+        return normalizedContextGroupStates;
+    }
+    normalizeContextGroupId(contextGroupId) {
+        const usesDefaultColorChannels = Object.keys(defaultColorChannels).every((defaultContextGroupId) => this.contextGroupsById.has(defaultContextGroupId));
+        return usesDefaultColorChannels ? normalizeColorChannelId(contextGroupId) : contextGroupId;
+    }
     // Util to check a client identity.
     static hasEndpointId(target) {
         return target.endpointId !== undefined;
@@ -1930,8 +1976,14 @@ class InteropBroker extends Base {
                 clientIdentity
             };
             // Only allow the client to join a contextGroup that actually exists.
-            if (payload?.currentContextGroup && this.contextGroupsById.has(payload.currentContextGroup)) {
-                clientSubscriptionState.contextGroupId = payload?.currentContextGroup;
+            const currentContextGroup = payload?.currentContextGroup
+                ? this.normalizeContextGroupId(payload.currentContextGroup)
+                : undefined;
+            if (currentContextGroup && this.contextGroupsById.has(currentContextGroup)) {
+                clientSubscriptionState.contextGroupId = currentContextGroup;
+                if (currentContextGroup !== payload.currentContextGroup) {
+                    await this.setCurrentContextGroupInClientOptions(clientIdentity, currentContextGroup);
+                }
             }
             this.interopClients.set(clientIdentity.endpointId, clientSubscriptionState);
         });
@@ -3714,6 +3766,47 @@ class Application extends EmitterBase {
     constructor(wire, identity) {
         super(wire, 'application', identity.uuid);
         this.identity = identity;
+        /**
+         * @experimental
+         * Retrieves a performance snapshot for all Windows, Views and Frames in the Application.
+         *
+         * By default, all custom marks and measures are collected, along with navigation/paint entries
+         * and resource timing (`resources` defaults to `true`). Pass `include` to restrict custom
+         * marks/measures to matching names (string substring or RegExp). Pass `browser: true` to also
+         * include hereio internal runtime metrics.
+         *
+         * See also [MDN | Performance Mark API](https://developer.mozilla.org/en-US/docs/Web/API/Performance/mark)
+         *
+         * Note - only currently running WebContents will be captured, and performance entries can only be
+         * captured for the current navigation of each.
+         */
+        this.getPerformanceStats = async (options = {}) => {
+            /**
+             * Returns a filter object compatible with JSON.stringify (regexs stringify to `{}`).
+             * @param include Array of strings or regexps.
+             */
+            const getSerializableFilterObject = (include) => {
+                return include.map((filter) => {
+                    if (filter instanceof RegExp) {
+                        return {
+                            type: 'regex',
+                            expression: filter.source,
+                            flags: filter.flags
+                        };
+                    }
+                    return filter;
+                });
+            };
+            const { include, resources = true, browser = false } = options;
+            const result = await this.wire.sendAction('get-application-performance-stats', {
+                ...this.identity,
+                // Omit `include` when unspecified so the runtime collects all custom marks/measures.
+                ...(include !== undefined ? { include: getSerializableFilterObject(include) } : {}),
+                resources,
+                browser
+            });
+            return result.payload.data;
+        };
         this.window = new _Window(this.wire, {
             uuid: this.identity.uuid,
             name: this.identity.uuid
@@ -15150,7 +15243,7 @@ class InteropClient extends Base {
      *
      * getLastFocusedView()
      *     .then(lastFocusedViewIdentity => {
-     *         joinViewToContextGroup('red', lastFocusedViewIdentity)
+     *         joinViewToContextGroup('fdc3.channel.1', lastFocusedViewIdentity)
      *     })
      * ```
      */
@@ -15200,7 +15293,7 @@ class InteropClient extends Base {
      *
      * @example
      * ```js
-     * fin.me.interop.getAllClientsInContextGroup('red')
+     * fin.me.interop.getAllClientsInContextGroup('fdc3.channel.1')
      *     .then(clientsInContextGroup => {
      *         console.log(clientsInContextGroup)
      *     })
@@ -15224,7 +15317,7 @@ class InteropClient extends Base {
      *
      * @example
      * ```js
-     * fin.me.interop.getInfoForContextGroup('red')
+     * fin.me.interop.getInfoForContextGroup('fdc3.channel.1')
      *     .then(contextGroupInfo => {
      *         console.log(contextGroupInfo.displayMetadata.name)
      *         console.log(contextGroupInfo.displayMetadata.color)
@@ -15313,12 +15406,12 @@ class InteropClient extends Base {
      *
      * @example
      * ```js
-     * await fin.me.interop.joinContextGroup('yellow');
+     * await fin.me.interop.joinContextGroup('fdc3.channel.3');
      * await fin.me.interop.setContext({ type: 'instrument', id: { ticker: 'FOO' }});
      * const currentContext = await fin.me.interop.getCurrentContext();
      *
      * // with a specific context
-     * await fin.me.interop.joinContextGroup('yellow');
+     * await fin.me.interop.joinContextGroup('fdc3.channel.3');
      * await fin.me.interop.setContext({ type: 'country', id: { ISOALPHA3: 'US' }});
      * await fin.me.interop.setContext({ type: 'instrument', id: { ticker: 'FOO' }});
      * const currentContext = await fin.me.interop.getCurrentContext('country');
@@ -15955,15 +16048,18 @@ class FDC3ModuleBase {
     async joinChannel(channelId) {
         this.wire.recordAnalytic('fdc3-join-channel');
         try {
+            const contextGroup = await this.client.getInfoForContextGroup(channelId);
+            if (!contextGroup) {
+                console.error(`No User Channel was found with the ID "${channelId}". If this is an App Channel, use getOrCreateChannel instead.`);
+                throw new Error(ChannelError.NoChannelFound);
+            }
             return await this.client.joinContextGroup(channelId);
         }
         catch (error) {
-            if (error.message === BROKER_ERRORS.joinSessionContextGroupWithJoinContextGroup) {
-                console.error('The Channel you have tried to join is an App Channel. Custom Channels can only be defined by the Interop Broker through code or manifest configuration. Please use getOrCreateChannel.');
-            }
-            else {
-                console.error(error.message);
+            if (error.message === ChannelError.NoChannelFound) {
+                throw new Error(ChannelError.NoChannelFound);
             }
+            console.error(error.message);
             if (error.message.startsWith('Attempting to join a context group that does not exist')) {
                 throw new Error(ChannelError.NoChannelFound);
             }
@@ -16643,7 +16739,7 @@ class InteropModule extends Base {
      * @example
      * ```js
      * const interopConfig = {
-     *     currentContextGroup: 'green'
+     *     currentContextGroup: 'fdc3.channel.4'
      * }
      *
      * const interopBroker = await fin.Interop.init('openfin');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfin/remote-adapter",
-  "version": "45.100.114",
+  "version": "45.100.115",
   "description": "Establish intermachine runtime connections using webRTC.",
   "license": "SEE LICENSE IN LICENSE.md",
   "private": false,
@@ -16,7 +16,7 @@
   "dependencies": {
     "es-toolkit": "^1.39.3",
     "tslib": "2.8.1",
-    "@openfin/core": "45.100.114"
+    "@openfin/core": "45.100.115"
   },
   "scripts": {
     "prebuild": "rimraf ./out",