@expressms/smartapp-sdk 1.9.0-alpha.2 → 1.10.0-alpha.1

package/build/umd/index.js

@@ -1343,30 +1343,88 @@
         }
     }
 
-    /** @ignore */
-    const log = (...args) => {
-        const text = args.map((arg) => (typeof arg === 'string' ? arg : JSON.stringify(arg))).join(' ');
-        alert(text);
-    };
+    const DATA_MASK = '***';
+    class Logger {
+        logsEnabled;
+        hideRecvLogPayload;
+        constructor() {
+            this.logsEnabled = false;
+            this.hideRecvLogPayload = new Map();
+        }
+        /** @ignore */
+        alert(...args) {
+            const text = args.map((arg) => (typeof arg === 'string' ? arg : JSON.stringify(arg))).join(' ');
+            alert(text);
+        }
+        /**
+         * Enabling logs.
+         *
+         * ```js
+         * bridge
+         *   .enableLogs()
+         * ```
+         */
+        enableLogs() {
+            this.logsEnabled = true;
+        }
+        /**
+         * Disabling logs.
+         *
+         * ```js
+         * bridge
+         *   .disableLogs()
+         * ```
+         */
+        disableLogs() {
+            this.logsEnabled = false;
+        }
+        /**
+         * Log outgouing event
+         * @param event Bridge event
+         */
+        logSendEvent(event) {
+            this.hideRecvLogPayload.set(event.ref, !!event.hide_recv_event_data);
+            if (!this.logsEnabled)
+                return;
+            const logEvent = event.hide_send_event_data
+                ? {
+                    ...event,
+                    payload: DATA_MASK,
+                }
+                : event;
+            console.log('Bridge ~ Outgoing event', JSON.stringify(logEvent, null, '  '));
+        }
+        logRecvEvent(event) {
+            const hideRecvLogPayload = !!this.hideRecvLogPayload.get(event.ref);
+            this.hideRecvLogPayload.delete(event.ref);
+            if (!this.logsEnabled)
+                return;
+            const logEvent = hideRecvLogPayload
+                ? {
+                    ...event,
+                    data: DATA_MASK,
+                }
+                : event;
+            console.log('Bridge ~ Incoming event', JSON.stringify(logEvent, null, 2));
+        }
+    }
 
-    class AndroidBridge {
+    class AndroidBridge extends Logger {
         eventEmitter;
         hasCommunicationObject;
-        logsEnabled;
         isRenameParamsEnabledForBotx;
         constructor() {
+            super();
             this.hasCommunicationObject = typeof window.express !== 'undefined' && !!window.express.handleSmartAppEvent;
             this.eventEmitter = new ExtendedEventEmitter();
-            this.logsEnabled = false;
             this.isRenameParamsEnabledForBotx = true;
             if (!this.hasCommunicationObject) {
-                log('No method "express.handleSmartAppEvent", cannot send message to Android');
+                this.alert('No method "express.handleSmartAppEvent", cannot send message to Android');
                 return;
             }
             // Expect json data as string
             window.handleAndroidEvent = ({ ref, data, files, }) => {
-                if (this.logsEnabled)
-                    console.log('Bridge ~ Incoming event', JSON.stringify({ ref, data, files }, null, 2));
+                this.logRecvEvent({ ref, data, files });
                 const { type, ...payload } = data;
                 const emitterType = ref || EVENT_TYPE.RECEIVE;
                 // const isRenameParamsEnabled = data.handler === HANDLER.BOTX ? this.isRenameParamsEnabledForBotx : true // TODO uncomment when client is ready
@@ -1396,7 +1454,7 @@
         onReceive(callback) {
             this.eventEmitter.on(EVENT_TYPE.RECEIVE, callback);
         }
-        sendEvent({ handler, method, params, files, timeout = RESPONSE_TIMEOUT, guaranteed_delivery_required = false, sync_request = false, sync_request_timeout = SYNC_RESPONSE_TIMEOUT, }) {
+        sendEvent({ handler, method, params, files, timeout = RESPONSE_TIMEOUT, guaranteed_delivery_required = false, sync_request = false, sync_request_timeout = SYNC_RESPONSE_TIMEOUT, hide_send_event_data = false, hide_recv_event_data = false, }) {
             if (!this.hasCommunicationObject)
                 return Promise.reject();
             const isRenameParamsEnabled = handler === HANDLER.BOTX ? this.isRenameParamsEnabledForBotx : true;
@@ -1410,13 +1468,14 @@
                 guaranteed_delivery_required,
                 sync_request,
                 sync_request_timeout,
+                hide_send_event_data,
+                hide_recv_event_data,
             };
             const eventFiles = isRenameParamsEnabled ?
                 files?.map((file) => camelCaseToSnakeCase(file)) : files;
-            const event = JSON.stringify(files ? { ...eventParams, files: eventFiles } : eventParams);
-            if (this.logsEnabled)
-                console.log('Bridge ~ Outgoing event', JSON.stringify(event, null, '  '));
-            window.express.handleSmartAppEvent(event);
+            const event = files ? { ...eventParams, files: eventFiles } : eventParams;
+            this.logSendEvent(event);
+            window.express.handleSmartAppEvent(JSON.stringify(event));
             return this.eventEmitter.onceWithTimeout(ref, timeout);
         }
         /**
@@ -1443,9 +1502,13 @@
          * @param files
          * @param timeout - Timeout in ms.
          * @param guaranteed_delivery_required - boolean.
+         * @param sync_request - boolean, default false
+         * @param sync_request_timeout - number
+         * @param hide_send_event_data - boolean, default false
+         * @param hide_recv_event_data - boolean, default false
          * @returns Promise.
          */
-        sendBotEvent({ method, params, files, timeout, guaranteed_delivery_required, sync_request, sync_request_timeout, }) {
+        sendBotEvent({ method, params, files, timeout, guaranteed_delivery_required, sync_request, sync_request_timeout, hide_send_event_data, hide_recv_event_data, }) {
             return this.sendEvent({
                 handler: HANDLER.BOTX,
                 method,
@@ -1455,6 +1518,8 @@
                 guaranteed_delivery_required,
                 sync_request,
                 sync_request_timeout,
+                hide_send_event_data,
+                hide_recv_event_data,
             });
         }
         /**
@@ -1484,28 +1549,6 @@
         sendClientEvent({ method, params, timeout }) {
             return this.sendEvent({ handler: HANDLER.EXPRESS, method, params, timeout });
         }
-        /**
-         * Enabling logs.
-         *
-         * ```js
-         * bridge
-         *   .enableLogs()
-         * ```
-         */
-        enableLogs() {
-            this.logsEnabled = true;
-        }
-        /**
-         * Disabling logs.
-         *
-         * ```js
-         * bridge
-         *   .disableLogs()
-         * ```
-         */
-        disableLogs() {
-            this.logsEnabled = false;
-        }
         /**
          * Enabling renaming event params from camelCase to snake_case and vice versa
          * ```js
@@ -1536,28 +1579,26 @@
         }
     }
 
-    class IosBridge {
+    class IosBridge extends Logger {
         eventEmitter;
         hasCommunicationObject;
-        logsEnabled;
         isRenameParamsEnabledForBotx;
         constructor() {
+            super();
             this.hasCommunicationObject =
                 window.webkit &&
                     window.webkit.messageHandlers &&
                     window.webkit.messageHandlers.express &&
                     !!window.webkit.messageHandlers.express.postMessage;
             this.eventEmitter = new ExtendedEventEmitter();
-            this.logsEnabled = false;
             this.isRenameParamsEnabledForBotx = true;
             if (!this.hasCommunicationObject) {
-                log('No method "express.postMessage", cannot send message to iOS');
+                this.alert('No method "express.postMessage", cannot send message to iOS');
                 return;
             }
             // Expect json data as string
             window.handleIosEvent = ({ ref, data, files, }) => {
-                if (this.logsEnabled)
-                    console.log('Bridge ~ Incoming event', JSON.stringify({ ref, data, files }, null, 2));
+                this.logRecvEvent({ ref, data, files });
                 const { type, ...payload } = data;
                 const emitterType = ref || EVENT_TYPE.RECEIVE;
                 // const isRenameParamsEnabled = data.handler === HANDLER.BOTX ? this.isRenameParamsEnabledForBotx : true // TODO uncomment when client is ready
@@ -1586,7 +1627,7 @@
         onReceive(callback) {
             this.eventEmitter.on(EVENT_TYPE.RECEIVE, callback);
         }
-        sendEvent({ handler, method, params, files, timeout = RESPONSE_TIMEOUT, guaranteed_delivery_required = false, sync_request = false, sync_request_timeout = SYNC_RESPONSE_TIMEOUT, }) {
+        sendEvent({ handler, method, params, files, timeout = RESPONSE_TIMEOUT, guaranteed_delivery_required = false, sync_request = false, sync_request_timeout = SYNC_RESPONSE_TIMEOUT, hide_send_event_data = false, hide_recv_event_data = false, }) {
             if (!this.hasCommunicationObject)
                 return Promise.reject();
             const ref = v4(); // UUID to detect express response.
@@ -1600,12 +1641,13 @@
                 guaranteed_delivery_required,
                 sync_request,
                 sync_request_timeout,
+                hide_send_event_data,
+                hide_recv_event_data,
             };
             const eventFiles = isRenameParamsEnabled ?
                 files?.map((file) => camelCaseToSnakeCase(file)) : files;
             const event = files ? { ...eventProps, files: eventFiles } : eventProps;
-            if (this.logsEnabled)
-                console.log('Bridge ~ Outgoing event', JSON.stringify(event, null, '  '));
+            this.logSendEvent(event);
             window.webkit.messageHandlers.express.postMessage(event);
             return this.eventEmitter.onceWithTimeout(ref, timeout);
         }
@@ -1629,7 +1671,7 @@
          *   })
          * ```
          */
-        sendBotEvent({ method, params, files, timeout = RESPONSE_TIMEOUT, guaranteed_delivery_required, sync_request, sync_request_timeout, }) {
+        sendBotEvent({ method, params, files, timeout = RESPONSE_TIMEOUT, guaranteed_delivery_required, sync_request, sync_request_timeout, hide_send_event_data, hide_recv_event_data, }) {
             return this.sendEvent({
                 handler: HANDLER.BOTX,
                 method,
@@ -1639,6 +1681,8 @@
                 guaranteed_delivery_required,
                 sync_request,
                 sync_request_timeout,
+                hide_send_event_data,
+                hide_recv_event_data,
             });
         }
         /**
@@ -1669,28 +1713,6 @@
                 timeout,
             });
         }
-        /**
-         * Enabling logs.
-         *
-         * ```js
-         * bridge
-         *   .enableLogs()
-         * ```
-         */
-        enableLogs() {
-            this.logsEnabled = true;
-        }
-        /**
-         * Disabling logs.
-         *
-         * ```js
-         * bridge
-         *   .disableLogs()
-         * ```
-         */
-        disableLogs() {
-            this.logsEnabled = false;
-        }
         /**
          * Enabling renaming event params from camelCase to snake_case and vice versa
          * ```js
@@ -1729,14 +1751,13 @@
         }
     }
 
-    class WebBridge {
+    class WebBridge extends Logger {
         eventEmitter;
-        logsEnabled;
         isRenameParamsEnabledForBotx;
         constructor() {
+            super();
             this.eventEmitter = new ExtendedEventEmitter();
             this.addGlobalListener();
-            this.logsEnabled = false;
             this.isRenameParamsEnabledForBotx = true;
         }
         addGlobalListener() {
@@ -1747,8 +1768,7 @@
                     return;
                 const { ref, data: { type, ...payload }, files, } = event.data;
                 const isRenameParamsEnabled = this.isRenameParamsEnabledForBotx; // TODO fix when handler is passed
-                if (this.logsEnabled)
-                    console.log('Bridge ~ Incoming event', event.data);
+                this.logRecvEvent(event.data);
                 const emitterType = ref || EVENT_TYPE.RECEIVE;
                 const eventFiles = isRenameParamsEnabled ?
                     files?.map((file) => snakeCaseToCamelCase(file)) : files;
@@ -1774,7 +1794,7 @@
         onReceive(callback) {
             this.eventEmitter.on(EVENT_TYPE.RECEIVE, callback);
         }
-        sendEvent({ handler, method, params, files, timeout = RESPONSE_TIMEOUT, guaranteed_delivery_required = false, sync_request = false, sync_request_timeout = SYNC_RESPONSE_TIMEOUT, }) {
+        sendEvent({ handler, method, params, files, timeout = RESPONSE_TIMEOUT, guaranteed_delivery_required = false, sync_request = false, sync_request_timeout = SYNC_RESPONSE_TIMEOUT, hide_send_event_data = false, hide_recv_event_data = false, }) {
             const isRenameParamsEnabled = handler === HANDLER.BOTX ? this.isRenameParamsEnabledForBotx : false;
             const ref = v4(); // UUID to detect express response.
             const payload = {
@@ -1786,12 +1806,13 @@
                 guaranteed_delivery_required,
                 sync_request,
                 sync_request_timeout,
+                hide_send_event_data,
+                hide_recv_event_data,
             };
             const eventFiles = isRenameParamsEnabled ?
                 files?.map((file) => camelCaseToSnakeCase(file)) : files;
             const event = files ? { ...payload, files: eventFiles } : payload;
-            if (this.logsEnabled)
-                console.log('Bridge ~ Outgoing event', event);
+            this.logSendEvent(event);
             window.parent.postMessage({
                 type: WEB_COMMAND_TYPE,
                 payload: event,
@@ -1817,7 +1838,7 @@
          *   })
          * ```
          */
-        sendBotEvent({ method, params, files, timeout, guaranteed_delivery_required, sync_request, sync_request_timeout, }) {
+        sendBotEvent({ method, params, files, timeout, guaranteed_delivery_required, sync_request, sync_request_timeout, hide_send_event_data, hide_recv_event_data, }) {
             return this.sendEvent({
                 handler: HANDLER.BOTX,
                 method,
@@ -1827,6 +1848,8 @@
                 guaranteed_delivery_required,
                 sync_request,
                 sync_request_timeout,
+                hide_send_event_data,
+                hide_recv_event_data,
             });
         }
         /**
@@ -1875,17 +1898,6 @@
                 _log.apply(console, rest);
             };
         }
-        /**
-         * Disabling logs.
-         *
-         * ```js
-         * bridge
-         *   .disableLogs()
-         * ```
-         */
-        disableLogs() {
-            this.logsEnabled = false;
-        }
         /**
          * Enabling renaming event params from camelCase to snake_case and vice versa
          * ```js
@@ -1910,7 +1922,7 @@
         }
     }
 
-    const LIB_VERSION = "1.3.0";
+    const LIB_VERSION = "1.4.0-alpha.1";
 
     const getBridge = () => {
         if (process.env.NODE_ENV === 'test')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressms/smartapp-sdk",
-  "version": "1.9.0-alpha.2",
+  "version": "1.10.0-alpha.1",
   "description": "Smartapp SDK",
   "main": "build/main/index.js",
   "typings": "build/main/index.d.ts",
@@ -38,7 +38,7 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "@expressms/smartapp-bridge": "1.3.0"
+    "@expressms/smartapp-bridge": "1.4.0-alpha.1"
   },
   "files": [
     "build/main",