@expressms/smartapp-sdk 1.12.0-alpha.5 → 1.12.0-alpha.7

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

@@ -0,0 +1,53 @@
+import { EmitterEventPayload } from '@expressms/smartapp-bridge/build/main/types/eventEmitter';
+import { STATUS, StatusResponse } from './bridge';
+export type BluetoothErrorCode = 'permission_denied' | 'bluetooth_not_found' | 'ble_device_not_found' | 'ble_device_not_connected' | 'ble_gatt_service_not_found' | 'ble_gatt_characteristic_not_found' | 'io_error' | 'error';
+export type BleDevice = {
+    address: string;
+    name: string;
+};
+export type BleGattCharacteristic = {
+    uuid: string;
+};
+export type BleGattService = {
+    uuid: string;
+    characteristics: Array<BleGattCharacteristic>;
+};
+export interface BluetoothStatusResponse extends StatusResponse {
+    payload: {
+        status: STATUS;
+        errorCode?: BluetoothErrorCode;
+    };
+}
+export interface BluetoothScanBleDevicesResponse extends EmitterEventPayload {
+    payload: {
+        status: STATUS;
+        errorCode?: BluetoothErrorCode;
+        bleDevices: Array<BleDevice>;
+    };
+}
+export interface BluetoothDiscoverGattServicesResponse extends EmitterEventPayload {
+    payload: {
+        status: STATUS;
+        errorCode?: BluetoothErrorCode;
+        gattServices: Array<BleGattService>;
+    };
+}
+export interface BluetoothBleDeviceFoundEvent extends EmitterEventPayload {
+    payload: {
+        status: STATUS;
+        bleDevice: BleDevice;
+    };
+}
+export type BleDeviceCallback = (device: BleDevice) => {};
+export type NfcErrorCode = 'permission_denied' | 'nfc_not_found' | 'nfc_write_error' | 'cancelled_by_user' | 'error';
+export type NfcMessage = Array<number>;
+export interface NfcReadTagResponse extends EmitterEventPayload {
+    payload: {
+        status: STATUS;
+        errorCode?: NfcErrorCode;
+        nfcTag: {
+            id: string;
+            messages: Array<NfcMessage>;
+        };
+    };
+}

package/build/module/types/devices.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGV2aWNlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy90eXBlcy9kZXZpY2VzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==

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

@@ -4,3 +4,4 @@ export * from "./contacts";
 export * from "./client";
 export * from "./storage";
 export * from "./events";
+export * from "./devices";

package/build/module/types/index.js

@@ -4,4 +4,5 @@ export * from "./contacts";
 export * from "./client";
 export * from "./storage";
 export * from "./events";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdHlwZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxVQUFVLENBQUE7QUFDeEIsY0FBYyxXQUFXLENBQUE7QUFDekIsY0FBYyxZQUFZLENBQUE7QUFDMUIsY0FBYyxVQUFVLENBQUE7QUFDeEIsY0FBYyxXQUFXLENBQUE7QUFDekIsY0FBYyxVQUFVLENBQUEifQ==
+export * from "./devices";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdHlwZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxVQUFVLENBQUE7QUFDeEIsY0FBYyxXQUFXLENBQUE7QUFDekIsY0FBYyxZQUFZLENBQUE7QUFDMUIsY0FBYyxVQUFVLENBQUE7QUFDeEIsY0FBYyxXQUFXLENBQUE7QUFDekIsY0FBYyxVQUFVLENBQUE7QUFDeEIsY0FBYyxXQUFXLENBQUEifQ==

package/build/umd/index.js

@@ -1999,6 +1999,13 @@
         METHODS["GET_CREDENTIALS"] = "get_credentials";
         METHODS["SET_CREDENTIALS"] = "set_credentials";
         METHODS["RUN_WEB_COMMANDS_PIPELINE"] = "run_web_commands_pipeline";
+        METHODS["ENABLE_BLUETOOTH"] = "enable_bluetooth";
+        METHODS["SCAN_BLE_DEVICES"] = "scan_ble_devices";
+        METHODS["CONNECT_BLE_DEVICE"] = "connect_ble_device";
+        METHODS["DISCONNECT_BLE_DEVICE"] = "disconnect_ble_device";
+        METHODS["DISCOVER_BLE_GATT_SERVICES"] = "discover_ble_gatt_services";
+        METHODS["READ_BLE_GATT_CHARACTERISTIC"] = "read_ble_gatt_characteristic";
+        METHODS["READ_NFC_TAG"] = "read_nfc_tag";
     })(METHODS || (METHODS = {}));
     var STATUS;
     (function (STATUS) {
@@ -2053,7 +2060,7 @@
         const id = getSubscriptionId(eventType, payload);
         return subscriptions.some(sub => sub.id == id);
     };
-    const installBridgeEventListener = () => {
+    const installBridgeEventListener$1 = () => {
         if (bridgeEventListenerInstalled || !bridge)
             return;
         bridgeEventListenerInstalled = true;
@@ -2092,7 +2099,7 @@
             const id = getSubscriptionId(eventType, payload);
             if (response.payload.status !== STATUS.SUCCESS)
                 return response;
-            installBridgeEventListener();
+            installBridgeEventListener$1();
             subscriptions.push({ id, callback });
             return response;
         });
@@ -2242,12 +2249,6 @@
             },
         });
     };
-    const requestLocation = () => {
-        return bridge?.sendClientEvent({
-            method: METHODS.REQUEST_LOCATION,
-            params: {},
-        });
-    };
     /**
      * Get client current connection status. It's based on client's WebSocket connection state.
      * @returns Promise that'll be fullfilled with status data on success, otherwise rejected with reason
@@ -2545,6 +2546,45 @@
         });
     };
 
+    const routingChanged = (isRoot) => {
+        return bridge?.sendClientEvent({
+            method: METHODS.ROUTING_CHANGED,
+            params: {
+                location: isRoot ? LOCATION.ROOT : LOCATION.NESTED,
+            },
+        });
+    };
+    const onBackPressed = (handleBackPressed) => {
+        return bridge?.onReceive(event => {
+            if (event.type === METHODS.BACK_PRESSED)
+                handleBackPressed();
+        });
+    };
+    const openSmartApp = ({ appId, meta }) => {
+        return bridge?.sendClientEvent({
+            method: METHODS.OPEN_SMART_APP,
+            params: meta ? { appId, meta } : { appId },
+        });
+    };
+    const closeSmartApp = () => {
+        return bridge?.sendClientEvent({
+            method: METHODS.CLOSE_SMART_APP,
+            params: {},
+        });
+    };
+    const onMoveToRoot = (handleMoveToRoot) => {
+        return bridge?.onReceive(event => {
+            if (event.type === METHODS.MOVE_TO_ROOT)
+                handleMoveToRoot();
+        });
+    };
+    const exitSmartAppToCatalog = () => {
+        return bridge?.sendClientEvent({
+            method: METHODS.OPEN_SMART_APP,
+            params: { appId: '' },
+        });
+    };
+
     /**
      * Set cookies for web resouce. It's needed for SSO auth cases.
      * @param cookies List of cookie strings !with domains!
@@ -2634,46 +2674,202 @@
             .then(event => event);
     };
 
-    const routingChanged = (isRoot) => {
-        return bridge?.sendClientEvent({
-            method: METHODS.ROUTING_CHANGED,
-            params: {
-                location: isRoot ? LOCATION.ROOT : LOCATION.NESTED,
-            },
+    const deviceCallbacks = [];
+    /**
+     * Install bridge event listener for founded devices during scan
+     */
+    const installBridgeEventListener = () => {
+        if (!bridge)
+            return;
+        bridge.onReceive(event => {
+            if (event.type !== 'ble_device_found')
+                return;
+            const { payload: { bleDevice }, } = event;
+            deviceCallbacks.map(cb => cb(bleDevice));
         });
     };
-    const onBackPressed = (handleBackPressed) => {
-        return bridge?.onReceive(event => {
-            if (event.type === METHODS.BACK_PRESSED)
-                handleBackPressed();
-        });
+    /**
+     * Add callback to list
+     */
+    const addDeviceCallback = (callback) => {
+        if (callback)
+            deviceCallbacks.push(callback);
     };
-    const openSmartApp = ({ appId, meta }) => {
-        return bridge?.sendClientEvent({
-            method: METHODS.OPEN_SMART_APP,
-            params: meta ? { appId, meta } : { appId },
-        });
+    /**
+     * Remove callback from list
+     */
+    const removeDeviceCallback = (callback) => {
+        if (!callback)
+            return;
+        const index = deviceCallbacks.findIndex(cb => cb === callback);
+        if (index !== -1)
+            deviceCallbacks.splice(index, 1);
     };
-    const closeSmartApp = () => {
-        return bridge?.sendClientEvent({
-            method: METHODS.CLOSE_SMART_APP,
+    /**
+     * Enable bluetooth
+     * @returns Promise that'll be fullfilled on success, otherwise rejected with reason
+     */
+    const enable = () => {
+        if (!bridge)
+            return Promise.reject(ERROR_CODES.NO_BRIDGE);
+        return bridge
+            .sendClientEvent({
+            method: METHODS.ENABLE_BLUETOOTH,
             params: {},
-        });
+        })
+            .then(event => event);
     };
-    const onMoveToRoot = (handleMoveToRoot) => {
-        return bridge?.onReceive(event => {
-            if (event.type === METHODS.MOVE_TO_ROOT)
-                handleMoveToRoot();
+    /**
+     * Scan BLE devices nearby
+     * @param scanDuration Duration to scan devices in milliseconds
+     * @param deviceCallback Callback that triggered on device found
+     * @returns Promise that'll be fullfilled with `payload.bleDevices` on success, otherwise rejected with reason
+     */
+    const scanBleDevices = ({ scanDuration, deviceCallback, }) => {
+        if (!bridge)
+            return Promise.reject(ERROR_CODES.NO_BRIDGE);
+        addDeviceCallback(deviceCallback);
+        return bridge
+            .sendClientEvent({
+            method: METHODS.SCAN_BLE_DEVICES,
+            params: {
+                scanDuration,
+            },
+        })
+            .then(event => {
+            removeDeviceCallback(deviceCallback);
+            return event;
+        })
+            .catch(() => {
+            removeDeviceCallback(deviceCallback);
+            return Promise.reject();
         });
     };
-    const exitSmartAppToCatalog = () => {
+    /**
+     * Connect bluetooth BLE device
+     * @param bleDeviceAddress Address of the BLE device
+     * @returns Promise that'll be fullfilled on success, otherwise rejected with reason
+     */
+    const connectBleDevice = ({ bleDeviceAddress, }) => {
+        if (!bridge)
+            return Promise.reject(ERROR_CODES.NO_BRIDGE);
+        return bridge
+            .sendClientEvent({
+            method: METHODS.CONNECT_BLE_DEVICE,
+            params: {
+                bleDeviceAddress,
+            },
+        })
+            .then(event => event);
+    };
+    /**
+     * Disonnect bluetooth BLE device
+     * @param bleDeviceAddress Address of the BLE device
+     * @returns Promise that'll be fullfilled on success, otherwise rejected with reason
+     */
+    const disconnectBleDevice = ({ bleDeviceAddress, }) => {
+        if (!bridge)
+            return Promise.reject(ERROR_CODES.NO_BRIDGE);
+        return bridge
+            .sendClientEvent({
+            method: METHODS.DISCONNECT_BLE_DEVICE,
+            params: {
+                bleDeviceAddress,
+            },
+        })
+            .then(event => event);
+    };
+    /**
+     * Discover services and characteristics of the BLE device
+     * @param bleDeviceAddress Address of the BLE device
+     * @returns Promise that'll be fullfilled with `payload.gattServices` on success, otherwise rejected with reason
+     */
+    const discoverGattServices = ({ bleDeviceAddress, }) => {
+        if (!bridge)
+            return Promise.reject(ERROR_CODES.NO_BRIDGE);
+        return bridge
+            .sendClientEvent({
+            method: METHODS.DISCOVER_BLE_GATT_SERVICES,
+            params: {
+                bleDeviceAddress,
+            },
+        })
+            .then(event => event);
+    };
+    /**
+     * Read BLE GATT characteristic
+     * @param bleDeviceAddress Address of the BLE device
+     * @param gattServiceUuid UUID of the GATT service
+     * @param gattCharacteristicUuid UUID of the GATT characteristic
+     * @returns Promise that'll be fullfilled with `payload.value` on success, otherwise rejected with reason
+     */
+    const readBleGattCharacteristic = ({ bleDeviceAddress, gattServiceUuid, gattCharacteristicUuid, }) => {
+        if (!bridge)
+            return Promise.reject(ERROR_CODES.NO_BRIDGE);
+        return bridge
+            .sendClientEvent({
+            method: METHODS.READ_BLE_GATT_CHARACTERISTIC,
+            params: {
+                bleDeviceAddress,
+                gattServiceUuid,
+                gattCharacteristicUuid,
+            },
+        })
+            .then(event => event);
+    };
+    // Init device event listener
+    installBridgeEventListener();
+
+    var bluetooth = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        enable: enable,
+        scanBleDevices: scanBleDevices,
+        connectBleDevice: connectBleDevice,
+        disconnectBleDevice: disconnectBleDevice,
+        discoverGattServices: discoverGattServices,
+        readBleGattCharacteristic: readBleGattCharacteristic
+    });
+
+    /**
+     * Request GPS position
+     * @returns Promise that'll be fullfilled with `payload.*` on success, otherwise rejected with reason
+     */
+    const requestLocation = () => {
         return bridge?.sendClientEvent({
-            method: METHODS.OPEN_SMART_APP,
-            params: { appId: '' },
+            method: METHODS.REQUEST_LOCATION,
+            params: {},
         });
     };
 
+    var gps = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        requestLocation: requestLocation
+    });
+
+    /**
+     * Enable bluetooth
+     * @returns Promise that'll be fullfilled with `payload.nfcTag` on success, otherwise rejected with reason
+     */
+    const readTag = () => {
+        if (!bridge)
+            return Promise.reject(ERROR_CODES.NO_BRIDGE);
+        return bridge
+            .sendClientEvent({
+            method: METHODS.ENABLE_BLUETOOTH,
+            params: {},
+        })
+            .then(event => event);
+    };
+
+    var nfc = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        readTag: readTag
+    });
+
+    exports.Bluetooth = bluetooth;
     exports.Bridge = bridge;
+    exports.GPS = gps;
+    exports.NFC = nfc;
     exports.addContact = addContact;
     exports.cleanCache = cleanCache;
     exports.clientStorageClear = clientStorageClear;
@@ -2683,6 +2879,7 @@
     exports.closeSmartApp = closeSmartApp;
     exports.createDeeplink = createDeeplink;
     exports.createPersonalChat = createPersonalChat;
+    exports.disableCopy = disableCopy;
     exports.exitSmartAppToCatalog = exitSmartAppToCatalog;
     exports.getAppVisibility = getAppVisibility;
     exports.getChats = getChats;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressms/smartapp-sdk",
-  "version": "1.12.0-alpha.5",
+  "version": "1.12.0-alpha.7",
   "description": "Smartapp SDK",
   "main": "build/main/index.js",
   "typings": "build/main/index.d.ts",