@openfin/core 30.73.16 → 30.73.18

package/OpenFin.d.ts

@@ -1,6 +1,9 @@
 // / <reference lib="dom"/>
 
 declare namespace OpenFin {
+    // fin
+    export type Fin<MeType extends EntityType = 'window' | 'view'> = import('./src/api/fin').FinApi<MeType>;
+
     // "wrappable entities"
     export type Application = import('./src/api/application/index').Application;
     export type ExternalApplication = import('./src/api/external-application/index').ExternalApplication;
@@ -105,6 +108,7 @@ declare namespace OpenFin {
 
     type InteropBrokerOptions = {
         contextGroups?: ContextGroupInfo;
+        logging?: InteropLoggingOptions;
     };
 
     export type ContextGroupInfo = {
@@ -728,6 +732,7 @@ declare namespace OpenFin {
             forwardErrorReports?: boolean;
             enableErrorReporting?: boolean;
         };
+        interopBrokerConfiguration: InteropBrokerOptions;
     };
 
     export type LayoutContent = (LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent)[];
@@ -1749,4 +1754,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/fin.d.ts

@@ -1,4 +1,4 @@
 /* eslint-disable spaced-comment */
 /* eslint-disable @typescript-eslint/triple-slash-reference */
 /// <reference path="./OpenFin.d.ts"/>
-declare const fin: import('./src/api/fin').FinApi<'window' | 'view'>;
+declare const fin: OpenFin.Fin<'window' | 'view'>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "30.73.16",
+    "version": "30.73.18",
     "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

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();
@@ -986,12 +1015,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));

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

@@ -1,10 +1,9 @@
-import { FinApi } from './api/fin';
 import { RemoteConfig } from './transport/wire';
 interface GetRemoteConnectionPayload extends RemoteConfig {
     interopProviderId: string;
     withInterop: boolean;
 }
-export declare function getRemoteConnectionPayload(fin: FinApi<OpenFin.EntityType>, uuid?: string, interopProviderId?: string): Promise<GetRemoteConnectionPayload>;
-export declare function remoteConnect({ uuid, token, address, interopProviderId, withInterop }: GetRemoteConnectionPayload): Promise<FinApi<'external connection'>>;
-export declare function remoteConnectInterop(fin: FinApi<OpenFin.EntityType>, interopProviderId: string): Promise<FinApi<OpenFin.EntityType>>;
+export declare function getRemoteConnectionPayload(fin: OpenFin.Fin<OpenFin.EntityType>, uuid?: string, interopProviderId?: string): Promise<GetRemoteConnectionPayload>;
+export declare function remoteConnect({ uuid, token, address, interopProviderId, withInterop }: GetRemoteConnectionPayload): Promise<OpenFin.Fin<'external connection'>>;
+export declare function remoteConnectInterop(fin: OpenFin.Fin<OpenFin.EntityType>, interopProviderId: string): Promise<OpenFin.Fin<OpenFin.EntityType>>;
 export {};