@openfin/core 29.73.2 → 29.73.4

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;
     };
@@ -100,6 +105,7 @@ declare namespace OpenFin {
 
     type InteropBrokerOptions = {
         contextGroups?: ContextGroupInfo;
+        logging?: InteropLoggingOptions;
     };
 
     export type ContextGroupInfo = {
@@ -610,9 +616,28 @@ declare namespace OpenFin {
         setFileDownloadLocation: boolean;
     };
 
+    export type LaunchExternalProcessRule = {
+        behavior: 'allow' | 'block';
+        match: string[]; // could be url match or path match
+    };
+
     export type SystemPermissions = {
         getAllExternalWindows: boolean;
-        launchExternalProcess: boolean;
+        launchExternalProcess:
+            | boolean
+            | {
+                  assets: {
+                      enabled: boolean;
+                      srcRules?: LaunchExternalProcessRule[];
+                  };
+                  downloads: {
+                      enabled: boolean;
+                  };
+                  executables: {
+                      enabled: boolean;
+                      pathRules?: LaunchExternalProcessRule[];
+                  };
+              };
         readRegistryValue:
             | boolean
             | {
@@ -723,6 +748,7 @@ declare namespace OpenFin {
             forwardErrorReports?: boolean;
             enableErrorReporting?: boolean;
         };
+        interopBrokerConfiguration: InteropBrokerOptions;
     };
 
     export type LayoutContent = (LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent)[];
@@ -1229,6 +1255,7 @@ declare namespace OpenFin {
         uuid: string;
         entityType: EntityType;
         parent: Identity;
+        url: string;
     };
 
     export type ExternalApplicationInfo = {
@@ -1248,6 +1275,7 @@ declare namespace OpenFin {
         lifetime?: string;
         certificate?: CertificationInfo;
         uuid?: string;
+        fileUuid?: string;
         initialWindowState?: string;
         cwd?: string;
     };
@@ -1743,4 +1771,12 @@ declare namespace OpenFin {
     export type InteropClientOnDisconnectionListener = (
         InteropBrokerDisconnectionEvent: InteropBrokerDisconnectionEvent
     ) => any;
+
+    export interface InteropActionLoggingOption {
+        enabled: boolean;
+    }
+
+    export type InteropLoggingActions = 'beforeAction' | 'afterAction';
+
+    export type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "29.73.2",
+    "version": "29.73.4",
     "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/Factory.js

@@ -38,7 +38,7 @@ class InteropModule extends base_1.Base {
             }
             return provider;
         };
-        return override(InteropBroker_1.InteropBroker, this.wire, getProvider, options.initialOptions.interopBrokerConfiguration || {});
+        return override(InteropBroker_1.InteropBroker, this.wire, getProvider, options.initialOptions.interopBrokerConfiguration);
     }
     /**
      * 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

@@ -46,6 +46,32 @@ import Identity = OpenFin.Identity;
  * }
  * ```
  *
+ * 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**
  *
@@ -131,6 +157,7 @@ export declare class InteropBroker extends Base {
     private lastContextMap;
     private sessionContextGroupMap;
     private channel;
+    private logging;
     constructor(wire: Transport, getProvider: () => Promise<OpenFin.ChannelProvider>, options?: any);
     /**
      * SetContextOptions interface
@@ -377,7 +404,18 @@ export declare class InteropBroker extends Base {
      * @param clientIdentity
      * @returns { Promise<ImplementationMetadata(2)> }
      */
-    fdc3HandleGetInfo(clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
+    fdc3HandleGetInfo(payload: {
+        fdc3Version: string;
+    }, 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

@@ -93,6 +93,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**
  *
@@ -176,9 +202,12 @@ class InteropBroker extends base_1.Base {
         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();
@@ -695,10 +724,33 @@ class InteropBroker extends base_1.Base {
      * @returns { Promise<ImplementationMetadata(2)> }
      */
     // eslint-disable-next-line class-methods-use-this
-    async fdc3HandleGetInfo(clientIdentity) {
-        const warning = (0, 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 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
@@ -974,12 +1026,20 @@ class InteropBroker extends base_1.Base {
         // 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 +1064,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/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.d.ts

@@ -290,6 +290,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
     leaveCurrentChannel(): Promise<void>;
     /**
      * Retrieves information about the FDC3 implementation, including the supported version of the FDC3 specification, the name of the provider of the implementation, its own version number, details of whether optional API features are implemented and the metadata of the calling application according to the desktop agent.
+     * fdc3HandleGetInfo must be overridden in the InteropBroker so that the ImplementationMetadata will have the appMetadata info.
      * @returns { Promise<ImplementationMetadata(2)> }
      * @tutorial fdc3v2.getInfo
      */

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);
     }
     /**
@@ -448,19 +455,12 @@ class Fdc3Module2 extends base_1.Base {
     }
     /**
      * Retrieves information about the FDC3 implementation, including the supported version of the FDC3 specification, the name of the provider of the implementation, its own version number, details of whether optional API features are implemented and the metadata of the calling application according to the desktop agent.
+     * fdc3HandleGetInfo must be overridden in the InteropBroker so that the ImplementationMetadata will have the appMetadata info.
      * @returns { Promise<ImplementationMetadata(2)> }
      * @tutorial fdc3v2.getInfo
      */
     async getInfo() {
-        try {
-            const result = await InteropClient_1.InteropClient.ferryFdc3Call(fin.me.interop, 'fdc3v2GetInfo', {});
-            const partialInfo = this.fdc3Module.getInfo();
-            return { ...partialInfo, ...result };
-        }
-        catch (error) {
-            const errorToThrow = error.message === utils_1.BROKER_ERRORS.fdc3GetInfo ? 'ResolverUnavailable' : error;
-            throw new Error(errorToThrow);
-        }
+        return InteropClient_1.InteropClient.ferryFdc3Call(fin.me.interop, 'fdc3v2GetInfo', { fdc3Version: '2.0' });
     }
 }
 exports.default = Fdc3Module2;

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/interop/utils.d.ts

@@ -15,3 +15,4 @@ export declare const BROKER_ERRORS: {
     fdc3GetInfo: string;
 };
 export declare const wrapIntentHandler: (handler: OpenFin.IntentHandler, handlerId: string) => (intent: OpenFin.Intent) => Promise<void>;
+export declare const generateDefaultLoggingOptions: () => OpenFin.InteropLoggingOptions;

package/src/api/interop/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.wrapIntentHandler = exports.BROKER_ERRORS = exports.generateOverrideWarning = exports.generateOverrideError = exports.wrapContextHandler = exports.wrapInTryCatch = exports.generateId = void 0;
+exports.generateDefaultLoggingOptions = exports.wrapIntentHandler = exports.BROKER_ERRORS = exports.generateOverrideWarning = exports.generateOverrideError = exports.wrapContextHandler = exports.wrapInTryCatch = exports.generateId = void 0;
 const generateId = () => `${Math.random()}${Date.now()}`;
 exports.generateId = generateId;
 const wrapInTryCatch = (f, prefix) => (...args) => {
@@ -59,3 +59,11 @@ const wrapIntentHandler = (handler, handlerId) => {
     };
 };
 exports.wrapIntentHandler = wrapIntentHandler;
+const generateDefaultLoggingOptions = () => {
+    const loggingActions = ['beforeAction', 'afterAction'];
+    const options = loggingActions.reduce((accumulator, loggingOption) => {
+        return { ...accumulator, [loggingOption]: { enabled: true } };
+    }, {});
+    return options;
+};
+exports.generateDefaultLoggingOptions = generateDefaultLoggingOptions;

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
@@ -769,7 +770,7 @@ export default class System extends EmitterBase<SystemEvents> {
      * Runs an executable or batch file. A path to the file must be included in options.
      * <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
      * <br> Note: This method is restricted by default and must be enabled via
-     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
+     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>. Also, this api has an enhanced permission set to make it less dangerous. So application owners can only allow to launch the assets owned by the application, the enabled downloaded files or the restricted executables.
      * @param { ExternalProcessRequestType } options A object that is defined in the ExternalProcessRequestType interface
      * @return {Promise.<Identity>}
      * @tutorial System.launchExternalProcess

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
@@ -890,7 +891,7 @@ class System extends base_1.EmitterBase {
      * Runs an executable or batch file. A path to the file must be included in options.
      * <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
      * <br> Note: This method is restricted by default and must be enabled via
-     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
+     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>. Also, this api has an enhanced permission set to make it less dangerous. So application owners can only allow to launch the assets owned by the application, the enabled downloaded files or the restricted executables.
      * @param { ExternalProcessRequestType } options A object that is defined in the ExternalProcessRequestType interface
      * @return {Promise.<Identity>}
      * @tutorial System.launchExternalProcess