@expressms/smartapp-sdk 1.14.0-alpha.6 → 1.14.0-alpha.8

package/build/main/types/bridge.d.ts

@@ -182,6 +182,7 @@ export type ReadyEventResponse = {
         initialData?: InitialDataEmail | InitialDataProfileAction | InitialDataPush | InitialDataDeeplink | InitialDataMenuAction | InitialDataLink;
         rules?: Array<RuleDownload | RuleUpload | RuleShare | RuleCopy>;
         isPinned?: boolean;
+        toolbarVisible?: boolean;
     };
 } | undefined;
 export interface File {

package/build/module/types/bridge.d.ts

@@ -182,6 +182,7 @@ export type ReadyEventResponse = {
         initialData?: InitialDataEmail | InitialDataProfileAction | InitialDataPush | InitialDataDeeplink | InitialDataMenuAction | InitialDataLink;
         rules?: Array<RuleDownload | RuleUpload | RuleShare | RuleCopy>;
         isPinned?: boolean;
+        toolbarVisible?: boolean;
     };
 } | undefined;
 export interface File {

package/build/umd/index.js

@@ -9,6 +9,7 @@
         PLATFORM["WEB"] = "web";
         PLATFORM["IOS"] = "ios";
         PLATFORM["ANDROID"] = "android";
+        PLATFORM["AURORA"] = "aurora";
         PLATFORM["UNKNOWN"] = "unknown";
     })(PLATFORM || (PLATFORM = {}));
     var EVENT_TYPE;
@@ -42,6 +43,9 @@
             (navigator.userAgent.includes('Mac') && 'ontouchend' in document)) &&
             !window.MSStream)
             return PLATFORM.IOS;
+        if (/aurora/i.test(navigator.userAgent)) {
+            return PLATFORM.AURORA;
+        }
         return PLATFORM.WEB;
     };
     /**
@@ -50,7 +54,7 @@
      * ```typescript
      * const platform = getPlatform();
      *
-     * // => 'web' | 'ios' | 'android'
+     * // => 'web' | 'ios' | 'android' | 'aurora'
      * ```
      */
     const getPlatform = () => {
@@ -1598,6 +1602,170 @@
         }
     }
 
+    class AuroraBridge extends Logger {
+        eventEmitter;
+        isRenameParamsEnabledForBotx;
+        constructor() {
+            super();
+            this.eventEmitter = new ExtendedEventEmitter();
+            this.isRenameParamsEnabledForBotx = true;
+            window.handleAuroraEvent = this.handleAuroraEvent.bind(this);
+        }
+        handleAuroraEvent({ ref, data, files, }) {
+            this.logRecvEvent({ ref, data, files });
+            const { type, ...payload } = data;
+            const emitterType = ref || EVENT_TYPE.RECEIVE;
+            const eventFiles = this.isRenameParamsEnabledForBotx ? files?.map((file) => snakeCaseToCamelCase(file)) : files;
+            const event = {
+                ref,
+                type,
+                payload: this.isRenameParamsEnabledForBotx ? snakeCaseToCamelCase(payload) : payload,
+                files: eventFiles,
+            };
+            this.eventEmitter.emit(emitterType, event);
+        }
+        /**
+         * Set callback function to handle events without **ref**
+         * (notifications for example).
+         *
+         * ```js
+         * bridge.onRecieve(({ type, handler, payload }) => {
+         *   // Handle event data
+         *   console.log('event', type, handler, payload)
+         * })
+         * ```
+         * @param callback - Callback function.
+         */
+        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, hide_send_event_data = false, hide_recv_event_data = false, }) {
+            const ref = v4(); // UUID to detect express response.
+            const isRenameParamsEnabled = handler === HANDLER.BOTX ? this.isRenameParamsEnabledForBotx : true;
+            const eventProps = {
+                ref,
+                type: WEB_COMMAND_TYPE_RPC,
+                method,
+                handler,
+                payload: isRenameParamsEnabled ? camelCaseToSnakeCase(params) : params,
+                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;
+            this.logSendEvent(event);
+            const customEvent = new CustomEvent('framescript:action', { detail: event });
+            document.dispatchEvent(customEvent);
+            return this.eventEmitter.onceWithTimeout(ref, timeout);
+        }
+        /**
+         * Send event and wait response from express client.
+         *
+         * ```js
+         * bridge
+         *   .sendBotEvent(
+         *     {
+         *       method: 'get_weather',
+         *       params: {
+         *         city: 'Moscow',
+         *       },
+         *       files: []
+         *     }
+         *   )
+         *   .then(data => {
+         *     // Handle response
+         *     console.log('response', data)
+         *   })
+         * ```
+         */
+        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,
+                params,
+                files,
+                timeout,
+                guaranteed_delivery_required,
+                sync_request,
+                sync_request_timeout,
+                hide_send_event_data,
+                hide_recv_event_data,
+            });
+        }
+        /**
+         * Send event and wait response from express client.
+         *
+         * ```js
+         * bridge
+         *   .sendClientEvent(
+         *     {
+         *       type: 'get_weather',
+         *       handler: 'express',
+         *       payload: {
+         *         city: 'Moscow',
+         *       },
+         *     }
+         *   )
+         *   .then(data => {
+         *     // Handle response
+         *     console.log('response', data)
+         *   })
+         * ```
+         */
+        sendClientEvent({ method, params, timeout = RESPONSE_TIMEOUT, hide_send_event_data, hide_recv_event_data, }) {
+            return this.sendEvent({
+                handler: HANDLER.EXPRESS,
+                method,
+                params,
+                timeout,
+                hide_send_event_data,
+                hide_recv_event_data,
+            });
+        }
+        /**
+         * Enabling renaming event params from camelCase to snake_case and vice versa
+         * ```js
+         * bridge
+         *    .enableRenameParams()
+         * ```
+         */
+        enableRenameParams() {
+            this.isRenameParamsEnabledForBotx = true;
+            console.log('Bridge ~ Enabled renaming event params from camelCase to snake_case and vice versa');
+        }
+        /**
+         * Enabling renaming event params from camelCase to snake_case and vice versa
+         * ```js
+         * bridge
+         *    .disableRenameParams()
+         * ```
+         */
+        disableRenameParams() {
+            this.isRenameParamsEnabledForBotx = false;
+            console.log('Bridge ~ Disabled renaming event params from camelCase to snake_case and vice versa');
+        }
+        /**
+         * Write log to client
+         * @param data Any data to log
+         */
+        log(data) {
+            let value = '';
+            if (typeof data === 'string') {
+                value = data;
+            }
+            else if (typeof data === 'object') {
+                value = JSON.stringify(data, null, 2);
+            }
+            else
+                return;
+            const event = new CustomEvent('framescript:action', { detail: { 'SmartApp Log': value } });
+            document.dispatchEvent(event);
+        }
+    }
+
     class IosBridge extends Logger {
         eventEmitter;
         hasCommunicationObject;
@@ -1945,7 +2113,7 @@
         }
     }
 
-    const LIB_VERSION = "1.4.5";
+    const LIB_VERSION = "1.5.0-alpha.0";
 
     const getBridge = () => {
         if (process.env.NODE_ENV === 'test')
@@ -1955,6 +2123,8 @@
         switch (platform) {
             case PLATFORM.ANDROID:
                 return new AndroidBridge();
+            case PLATFORM.AURORA:
+                return new AuroraBridge();
             case PLATFORM.IOS:
                 return new IosBridge();
             case PLATFORM.WEB:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressms/smartapp-sdk",
-  "version": "1.14.0-alpha.6",
+  "version": "1.14.0-alpha.8",
   "description": "Smartapp SDK",
   "main": "build/main/index.js",
   "typings": "build/main/index.d.ts",
@@ -40,7 +40,7 @@
     "vitest": "^1.6.0"
   },
   "dependencies": {
-    "@expressms/smartapp-bridge": "1.4.5"
+    "@expressms/smartapp-bridge": "1.5.0-alpha.0"
   },
   "files": [
     "build/main",