@openfin/core 29.73.1 → 29.73.3

package/OpenFin.d.ts

@@ -34,6 +34,11 @@ declare namespace OpenFin {
         isLocalEndpointId: boolean; // If true, this connection is from a legacy client.
     };
 
+    export type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
+        entityType: EntityType;
+        connectionUrl: string;
+    };
+
     export type ClientIdentityMultiRuntime = ClientIdentity & {
         runtimeUuid: string;
     };
@@ -1229,6 +1234,7 @@ declare namespace OpenFin {
         uuid: string;
         entityType: EntityType;
         parent: Identity;
+        url: string;
     };
 
     export type ExternalApplicationInfo = {

package/package.json

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

package/src/api/interappbus/channel/channels-docs.d.ts

@@ -18,6 +18,7 @@ declare const InterApplicationBus: any;
  * ##### Asynchronous Methods
  *  * {@link Channel#ChannelProvider#destroy destroy()}
  *  * {@link Channel#ChannelProvider#dispatch dispatch(to, action, payload)}
+ *  * {@link Channel#ChannelProvider#getAllClientInfo getAllClientInfo()}
  *
  * ##### Middleware
  * Middleware functions receive the following arguments: (action, payload, senderId).
@@ -131,6 +132,11 @@ declare class ChannelProvider {
      * @tutorial ChannelMiddleware.setDefaultAction
      */
     setDefaultAction(): void;
+    /** Returns an array with info on every Client connected to the Provider
+     * @returns { Promise<Array<ClientInfo>> }
+     * @tutorial Channel.getAllClientInfo
+     */
+    getAllClientInfo(): void;
 }
 /**
  * Instance created to enable use of a channel as a client.  Allows for communication with the
@@ -316,3 +322,12 @@ declare class ChannelClient {
  * @property {string} endpointId - Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
  *
  */
+/**
+ * Extended Client Information
+ * @typedef {object} InterApplicationBus.Channel~ClientInfo
+ * @property {string} uuid - Channel client uuid
+ * @property {string} name - Channel client name
+ * @property {string} endpointId - Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
+ * @property {string} entityType - Indicates if the client belongs to a Window or View
+ * @property {string} connectionUrl - URL of the View or Window at the time of connection to the Channel Provider.
+ */

package/src/api/interappbus/channel/channels-docs.js

@@ -76,6 +76,7 @@ InterApplicationBus.Channel.onChannelDisconnect = function () { };
  * ##### Asynchronous Methods
  *  * {@link Channel#ChannelProvider#destroy destroy()}
  *  * {@link Channel#ChannelProvider#dispatch dispatch(to, action, payload)}
+ *  * {@link Channel#ChannelProvider#getAllClientInfo getAllClientInfo()}
  *
  * ##### Middleware
  * Middleware functions receive the following arguments: (action, payload, senderId).
@@ -189,6 +190,11 @@ class ChannelProvider {
      * @tutorial ChannelMiddleware.setDefaultAction
      */
     setDefaultAction() { }
+    /** Returns an array with info on every Client connected to the Provider
+     * @returns { Promise<Array<ClientInfo>> }
+     * @tutorial Channel.getAllClientInfo
+     */
+    getAllClientInfo() { }
 }
 /**
  * Instance created to enable use of a channel as a client.  Allows for communication with the
@@ -374,3 +380,12 @@ class ChannelClient {
  * @property {string} endpointId - Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
  *
  */
+/**
+ * Extended Client Information
+ * @typedef {object} InterApplicationBus.Channel~ClientInfo
+ * @property {string} uuid - Channel client uuid
+ * @property {string} name - Channel client name
+ * @property {string} endpointId - Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
+ * @property {string} entityType - Indicates if the client belongs to a Window or View
+ * @property {string} connectionUrl - URL of the View or Window at the time of connection to the Channel Provider.
+ */

package/src/api/interappbus/channel/index.js

@@ -54,7 +54,21 @@ class Channel extends base_1.EmitterBase {
         });
         try {
             const { offer, rtc: rtcPacket } = await __classPrivateFieldGet(this, _Channel_connectionManager, "f").createClientOffer(opts);
-            const res = await this.wire.sendAction('connect-to-channel', { channelName, ...opts, offer });
+            let connectionUrl;
+            const entityType = this.wire.environment.getCurrentEntityType();
+            if (entityType === 'iframe') {
+                const frame = fin.Frame.getCurrentSync();
+                connectionUrl = (await frame.getInfo()).url;
+            }
+            else if (entityType === 'window' || entityType === 'view') {
+                connectionUrl = (await fin.me.getInfo()).url;
+            }
+            const res = await this.wire.sendAction('connect-to-channel', {
+                channelName,
+                ...opts,
+                offer,
+                connectionUrl
+            });
             const { payload: { data: routingInfo } } = res;
             // If there isn't a matching channel, the above sendAction call will error out and go to catch, skipping the logic below.
             if (resolver) {

package/src/api/interappbus/channel/provider.d.ts

@@ -5,22 +5,24 @@ import ProviderIdentity = OpenFin.ProviderIdentity;
 import ClientIdentity = OpenFin.ClientIdentity;
 export declare type ConnectionListener = (identity: ClientIdentity, connectionMessage?: any) => Promise<any> | any;
 export declare type DisconnectionListener = (identity: ClientIdentity) => any;
+declare type ClientConnectionPayload = OpenFin.ClientIdentity & OpenFin.ClientInfo;
 export declare class ChannelProvider extends ChannelBase {
     #private;
     private static removalMap;
     private connectListener;
     private disconnectListener;
-    get connections(): OpenFin.ClientIdentity[];
+    get connections(): ClientConnectionPayload[];
     static handleClientDisconnection(channel: ChannelProvider, payload: any): void;
     static setProviderRemoval(provider: ChannelProvider, remove: Function): void;
     constructor(providerIdentity: ProviderIdentity, wire: Transport, strategy: AnyStrategy);
     dispatch(to: OpenFin.ClientIdentity | OpenFin.Identity, action: string, payload?: any): Promise<any>;
     protected processAction: (action: string, payload: any, senderIdentity: OpenFin.ClientIdentity | OpenFin.ClientIdentityMultiRuntime) => Promise<any>;
-    processConnection(senderId: OpenFin.ClientIdentity, payload: any): Promise<any>;
+    processConnection(senderId: ClientConnectionPayload, payload: any): Promise<any>;
     publish(action: string, payload: any): Promise<any>[];
     onConnection(listener: ConnectionListener): void;
     onDisconnection(listener: DisconnectionListener): void;
     destroy(): Promise<void>;
+    getAllClientInfo(): Promise<Array<OpenFin.ClientInfo>>;
     private checkForClientConnection;
     private isClientConnected;
     private isLegacyClientConnected;
@@ -29,3 +31,4 @@ export declare class ChannelProvider extends ChannelBase {
     private static clientIdentityIncludesEndpointId;
     private static clientIsMultiRuntime;
 }
+export {};

package/src/api/interappbus/channel/provider.js

@@ -98,6 +98,12 @@ class ChannelProvider extends channel_1.ChannelBase {
         await protectedObj.wire.sendAction('destroy-channel', { channelName });
         __classPrivateFieldGet(this, _ChannelProvider_close, "f").call(this);
     }
+    async getAllClientInfo() {
+        return this.connections.map((clientInfo) => {
+            const { uuid, name, endpointId, entityType, connectionUrl } = clientInfo;
+            return { uuid, name, endpointId, entityType, connectionUrl };
+        });
+    }
     checkForClientConnection(clientIdentity) {
         if (!this.isClientConnected(clientIdentity)) {
             throw new Error(`This action was sent from a client that is not connected to the provider.

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

@@ -378,6 +378,15 @@ export declare class InteropBroker extends Base {
      * @returns { Promise<ImplementationMetadata(2)> }
      */
     fdc3HandleGetInfo(clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
+    /**
+     * 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()
+     */
+    getAllClientInfo(): Promise<Array<OpenFin.ClientInfo>>;
     decorateSnapshot(snapshot: OpenFin.Snapshot): OpenFin.Snapshot;
     applySnapshot(snapshot: OpenFin.Snapshot, options: OpenFin.ApplySnapshotOptions): void;
     updateExistingClients(contextGroupStates: OpenFin.ContextGroupStates): void;

package/src/api/interop/InteropBroker.js

@@ -700,6 +700,18 @@ class InteropBroker extends base_1.Base {
         console.warn(warning);
         throw new Error(utils_1.BROKER_ERRORS.fdc3GetInfo);
     }
+    /**
+     * 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
     */

package/src/api/interop/fdc3/fdc3-1.2.js

@@ -143,21 +143,10 @@ class Fdc3Module extends base_1.Base {
             // we do not want to expose this error, just continue if this analytics-only call fails
         });
         const channels = await this.fin.me.interop.getContextGroups();
-        const unsupportedChannelApis = {
-            addContextListener: () => {
-                throw new utils_1.UnsupportedChannelApiError('Channel.addContextListener');
-            },
-            broadcast: () => {
-                throw new utils_1.UnsupportedChannelApiError('Channel.broadcast');
-            },
-            getCurrentChannel: () => {
-                throw new utils_1.UnsupportedChannelApiError('Channel.getCurrentChannel');
-            }
-        };
         // fdc3 implementation of getSystemChannels returns on array of channels, have to decorate over
         // this so people know that these APIs are not supported
         return channels.map((channel) => {
-            return { ...channel, type: 'system', ...unsupportedChannelApis };
+            return { ...channel, type: 'system', ...(0, utils_1.getUnsupportedChannelApis)() };
         });
     }
     /**

package/src/api/interop/fdc3/fdc3-2.0.js

@@ -401,7 +401,12 @@ class Fdc3Module2 extends base_1.Base {
      * @tutorial fdc3v2.getUserChannels
      */
     async getUserChannels() {
-        return this.fdc3Module.getSystemChannels();
+        const channels = await this.fin.me.interop.getContextGroups();
+        // fdc3 implementation of getUserChannels returns on array of channels, have to decorate over
+        // this so people know that these APIs are not supported
+        return channels.map((channel) => {
+            return { ...channel, type: 'user', ...(0, utils_2.getUnsupportedChannelApis)('User') };
+        });
     }
     /**
      * Retrieves a list of the User Channels available for the app to join.
@@ -410,6 +415,7 @@ class Fdc3Module2 extends base_1.Base {
      * @tutorial fdc3.getSystemChannels
      */
     async getSystemChannels() {
+        console.warn('This API has been deprecated. Please use fdc3.getUserChannels instead.');
         return this.fdc3Module.getSystemChannels();
     }
     /**
@@ -429,6 +435,7 @@ class Fdc3Module2 extends base_1.Base {
      * @tutorial fdc3.joinChannel
      */
     async joinChannel(channelId) {
+        console.warn('This API has been deprecated. Please use fdc3.joinUserChannel instead.');
         return this.fdc3Module.joinChannel(channelId);
     }
     /**

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

@@ -1,6 +1,12 @@
 import { PrivateChannelClient } from './PrivateChannelClient';
+interface UnsupportedChannelApis {
+    addContextListener(): Error;
+    broadcast(): Error;
+    getCurrentChannel(): Error;
+}
+export declare const getUnsupportedChannelApis: (channelType?: string) => UnsupportedChannelApis;
 export declare class UnsupportedChannelApiError extends Error {
-    constructor(apiName: string);
+    constructor(apiName: string, channelType?: string);
 }
 export declare enum ResultError {
     /** Returned if the `IntentHandler` exited without returning a Promise or that
@@ -16,3 +22,4 @@ export declare const buildPrivateChannelObject: (privateChannelClient: PrivateCh
 export declare const buildAppChannelObject: (sessionContextGroup: OpenFin.SessionContextGroup) => FDC3.Channel;
 export declare const connectPrivateChannel: (channelId: string) => Promise<FDC3v2.PrivateChannel>;
 export declare const getIntentResolution: (interopModule: OpenFin.InteropClient, context: OpenFin.Context, app?: FDC3v2.AppIdentifier | FDC3.TargetApp, intent?: string) => Promise<FDC3v2.IntentResolution>;
+export {};

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

@@ -1,12 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIntentResolution = exports.connectPrivateChannel = exports.buildAppChannelObject = exports.buildPrivateChannelObject = exports.ResultError = exports.UnsupportedChannelApiError = void 0;
+exports.getIntentResolution = exports.connectPrivateChannel = exports.buildAppChannelObject = exports.buildPrivateChannelObject = exports.ResultError = exports.UnsupportedChannelApiError = exports.getUnsupportedChannelApis = void 0;
 const utils_1 = require("../utils");
 const PrivateChannelClient_1 = require("./PrivateChannelClient");
+const getUnsupportedChannelApis = (channelType) => {
+    return {
+        addContextListener: () => {
+            throw new UnsupportedChannelApiError('Channel.addContextListener', channelType);
+        },
+        broadcast: () => {
+            throw new UnsupportedChannelApiError('Channel.broadcast', channelType);
+        },
+        getCurrentChannel: () => {
+            throw new UnsupportedChannelApiError('Channel.getCurrentChannel', channelType);
+        }
+    };
+};
+exports.getUnsupportedChannelApis = getUnsupportedChannelApis;
 class UnsupportedChannelApiError extends Error {
-    constructor(apiName) {
+    constructor(apiName, channelType = 'System') {
         super(apiName);
-        this.message = `Calling ${apiName} on an instance of a System Channel returned by fdc3.getSystemChannels is not supported. If you would like to use a System Channel, please use fdc3.joinChannel, fdc3.addContextListener, and fdc3.broadcast instead.`;
+        this.message = `Calling ${apiName} on an instance of a ${channelType} Channel returned by fdc3.get${channelType}Channels is not supported. If you would like to use a ${channelType} Channel, please use fdc3.joinChannel, fdc3.addContextListener, and fdc3.broadcast instead.`;
     }
 }
 exports.UnsupportedChannelApiError = UnsupportedChannelApiError;

package/src/api/system/index.d.ts

@@ -147,6 +147,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { string } uuid The uuid of the frame
  * @property { EntityType } entityType The entity type, could be 'window', 'iframe', 'external connection' or 'unknown'
  * @property { Identity } parent The parent identity
+ * @property { string } url URL
  */
 /**
  * GetLogRequestType interface

package/src/api/system/index.js

@@ -136,6 +136,7 @@ const window_1 = require("../window");
  * @property { string } uuid The uuid of the frame
  * @property { EntityType } entityType The entity type, could be 'window', 'iframe', 'external connection' or 'unknown'
  * @property { Identity } parent The parent identity
+ * @property { string } url URL
  */
 /**
  * GetLogRequestType interface