@openfin/core 29.73.3 → 29.73.4

package/OpenFin.d.ts

@@ -105,6 +105,7 @@ declare namespace OpenFin {
 
     type InteropBrokerOptions = {
         contextGroups?: ContextGroupInfo;
+        logging?: InteropLoggingOptions;
     };
 
     export type ContextGroupInfo = {
@@ -615,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
             | {
@@ -728,6 +748,7 @@ declare namespace OpenFin {
             forwardErrorReports?: boolean;
             enableErrorReporting?: boolean;
         };
+        interopBrokerConfiguration: InteropBrokerOptions;
     };
 
     export type LayoutContent = (LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent)[];
@@ -1254,6 +1275,7 @@ declare namespace OpenFin {
         lifetime?: string;
         certificate?: CertificationInfo;
         uuid?: string;
+        fileUuid?: string;
         initialWindowState?: string;
         cwd?: string;
     };
@@ -1749,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.3",
+    "version": "29.73.4",
     "license": "Apache-2.0",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

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,9 @@ 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.
      *

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,21 @@ 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.
@@ -986,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));
@@ -1016,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-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

@@ -455,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/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

@@ -770,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

@@ -891,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