react-native-ble-manager 12.0.0-rc.3 → 12.0.0

package/README.md

@@ -1,8 +1,9 @@
 # react-native-ble-manager
 
-[![npm version](https://img.shields.io/npm/v/react-native-ble-manager.svg?style=flat)](https://www.npmjs.com/package/react-native-ble-manager)
-[![npm downloads](https://img.shields.io/npm/dm/react-native-ble-manager.svg?style=flat)](https://www.npmjs.com/package/react-native-ble-manager)
-[![GitHub issues](https://img.shields.io/github/issues/innoveit/react-native-ble-manager.svg?style=flat)](https://github.com/innoveit/react-native-ble-manager/issues)
+![GitHub Release](https://img.shields.io/github/v/release/innoveit/react-native-ble-manager?style=for-the-badge)
+[![npm version](https://img.shields.io/npm/v/react-native-ble-manager.svg?style=for-the-badge)](https://www.npmjs.com/package/react-native-ble-manager)
+[![npm downloads](https://img.shields.io/npm/dm/react-native-ble-manager.svg?style=for-the-badge)](https://www.npmjs.com/package/react-native-ble-manager)
+[![GitHub issues](https://img.shields.io/github/issues/innoveit/react-native-ble-manager.svg?style=for-the-badge)](https://github.com/innoveit/react-native-ble-manager/issues)
 
 A React Native Bluetooth Low Energy library.
 

package/android/src/main/java/it/innove/Peripheral.java

@@ -76,7 +76,6 @@ public class Peripheral extends BluetoothGattCallback {
 
     private final Queue<Runnable> commandQueue = new ConcurrentLinkedQueue<>();
     private final Handler mainHandler = new Handler(Looper.getMainLooper());
-    private Runnable discoverServicesRunnable;
     private boolean commandQueueBusy = false;
 
     private List<byte[]> writeQueue = new ArrayList<>();
@@ -324,21 +323,6 @@ public class Peripheral extends BluetoothGattCallback {
             if (newState == BluetoothProfile.STATE_CONNECTED && status == BluetoothGatt.GATT_SUCCESS) {
                 connected = true;
 
-                discoverServicesRunnable = new Runnable() {
-                    @Override
-                    public void run() {
-                        try {
-                            gatt.discoverServices();
-                        } catch (NullPointerException e) {
-                            Log.d(BleManager.LOG_TAG,
-                                    "onConnectionStateChange connected but gatt of Run method was null");
-                        }
-                        discoverServicesRunnable = null;
-                    }
-                };
-
-                mainHandler.post(discoverServicesRunnable);
-
                 sendConnectionEvent(device, status);
 
                 Log.d(BleManager.LOG_TAG, "Connected to: " + device.getAddress());
@@ -349,11 +333,6 @@ public class Peripheral extends BluetoothGattCallback {
 
             } else if (newState == BluetoothProfile.STATE_DISCONNECTED || status != BluetoothGatt.GATT_SUCCESS) {
 
-                if (discoverServicesRunnable != null) {
-                    mainHandler.removeCallbacks(discoverServicesRunnable);
-                    discoverServicesRunnable = null;
-                }
-
                 for (Callback writeCallback : writeCallbacks) {
                     writeCallback.invoke("Device disconnected");
                 }
@@ -404,8 +383,6 @@ public class Peripheral extends BluetoothGattCallback {
                 commandQueueBusy = false;
                 connected = false;
                 clearBuffers();
-                commandQueue.clear();
-                commandQueueBusy = false;
 
                 gatt.disconnect();
                 gatt.close();

package/app.plugin.js

@@ -0,0 +1 @@
+module.exports = require('./plugin/build/withBLE')

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "react-native-ble-manager",
-    "version": "12.0.0-rc.3",
+    "version": "12.0.0",
     "description": "A BLE module for react native.",
     "homepage": "https://innoveit.github.io/react-native-ble-manager/",
     "repository": {
@@ -34,6 +34,8 @@
         "/ios",
         "*.podspec",
         "react-native.config.json",
+        "app.plugin.js",
+        "plugin/build",
         "!ios/build",
         "!android/build",
         "!android/gradle",
@@ -49,11 +51,13 @@
         "version": "git add -A",
         "clean": "rimraf dist",
         "type:check": "tsc -p tsconfig.json --noEmit",
+        "build:plugin": "tsc --build plugin",
+        "clean:plugin": "expo-module clean plugin",
         "prepare": "npm run build",
-        "prebuild": "npm run clean",
+        "prebuild": "npm run clean && npm run clean:plugin",
         "build:cjs": "tsc --module commonjs --outDir dist/cjs",
         "build:esm": "tsc --outDir dist/esm",
-        "build": "npm run build:esm && npm run build:cjs",
+        "build": "npm run build:esm && npm run build:cjs && npm run build:plugin",
         "watch": "npm run build --watch",
         "preversion": "npm run build",
         "postversion": "git push --follow-tags"
@@ -82,7 +86,9 @@
         "react-native": "0.76.2",
         "@react-native/gradle-plugin": "^0.76.2",
         "turbo": "^2.3.0",
-        "typescript": "^5.6.3"
+        "typescript": "^5.6.3",
+        "@expo/config-plugins": "^9.0.10",
+        "expo-module-scripts": "^4.0.2"
     },
     "eslintConfig": {
         "root": true,

package/plugin/build/withBLE.d.ts

@@ -0,0 +1,10 @@
+import { ConfigPlugin } from 'expo/config-plugins';
+/**
+ * Apply BLE native configuration.
+ */
+declare const withBLE: ConfigPlugin<{
+    neverForLocation?: boolean;
+    bluetoothAlwaysPermission?: string | false;
+    companionDeviceEnabled?: boolean;
+} | void>;
+export default withBLE;

package/plugin/build/withBLE.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_plugins_1 = require("expo/config-plugins");
+const withBLEAndroidManifest_1 = require("./withBLEAndroidManifest");
+const withBluetoothPermissions_1 = require("./withBluetoothPermissions");
+/**
+ * Apply BLE native configuration.
+ */
+const withBLE = (config, props = {}) => {
+    const _props = props || {};
+    const isBackgroundEnabled = false;
+    const neverForLocation = _props.neverForLocation ?? false;
+    const companionDeviceEnabled = _props.companionDeviceEnabled ?? false;
+    // iOS
+    config = (0, withBluetoothPermissions_1.withBluetoothPermissions)(config, _props);
+    // Android
+    config = config_plugins_1.AndroidConfig.Permissions.withPermissions(config, [
+        'android.permission.BLUETOOTH',
+        'android.permission.BLUETOOTH_ADMIN',
+        'android.permission.BLUETOOTH_CONNECT', // since Android SDK 31
+    ]);
+    config = (0, withBLEAndroidManifest_1.withBLEAndroidManifest)(config, {
+        isBackgroundEnabled,
+        neverForLocation,
+        companionDeviceEnabled,
+    });
+    return config;
+};
+exports.default = withBLE;

package/plugin/build/withBLEAndroidManifest.d.ts

@@ -0,0 +1,38 @@
+import { ConfigPlugin, AndroidConfig } from 'expo/config-plugins';
+type InnerManifest = AndroidConfig.Manifest.AndroidManifest['manifest'];
+type ManifestPermission = InnerManifest['permission'];
+type ExtraTools = {
+    'tools:targetApi'?: string;
+};
+type ManifestUsesPermissionWithExtraTools = {
+    $: AndroidConfig.Manifest.ManifestUsesPermission['$'] & ExtraTools;
+};
+type AndroidManifest = {
+    manifest: InnerManifest & {
+        permission?: ManifestPermission;
+        'uses-permission'?: ManifestUsesPermissionWithExtraTools[];
+        'uses-permission-sdk-23'?: ManifestUsesPermissionWithExtraTools[];
+        'uses-feature'?: InnerManifest['uses-feature'];
+    };
+};
+export declare const withBLEAndroidManifest: ConfigPlugin<{
+    isBackgroundEnabled: boolean;
+    neverForLocation: boolean;
+    companionDeviceEnabled: boolean;
+}>;
+/**
+ * Add location permissions
+ *  - 'android.permission.ACCESS_COARSE_LOCATION' for Android SDK 28 (Android 9) and lower
+ *  - 'android.permission.ACCESS_FINE_LOCATION' for Android SDK 29 (Android 10) and higher.
+ *    From Android SDK 31 (Android 12) it might not be required if BLE is not used for location.
+ */
+export declare function addLocationPermissionToManifest(androidManifest: AndroidManifest, neverForLocationSinceSdk31: boolean): AndroidManifest;
+/**
+ * Add 'android.permission.BLUETOOTH_SCAN'.
+ * Required since Android SDK 31 (Android 12).
+ */
+export declare function addScanPermissionToManifest(androidManifest: AndroidManifest, neverForLocation: boolean): AndroidManifest;
+export declare function addConnectPermissionToManifest(androidManifest: AndroidManifest, neverForLocation: boolean): AndroidManifest;
+export declare function addCompanionPermissionToManifest(androidManifest: AndroidManifest): AndroidManifest;
+export declare function addBLEHardwareFeatureToManifest(androidManifest: AndroidConfig.Manifest.AndroidManifest): AndroidConfig.Manifest.AndroidManifest;
+export {};

package/plugin/build/withBLEAndroidManifest.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withBLEAndroidManifest = void 0;
+exports.addLocationPermissionToManifest = addLocationPermissionToManifest;
+exports.addScanPermissionToManifest = addScanPermissionToManifest;
+exports.addConnectPermissionToManifest = addConnectPermissionToManifest;
+exports.addCompanionPermissionToManifest = addCompanionPermissionToManifest;
+exports.addBLEHardwareFeatureToManifest = addBLEHardwareFeatureToManifest;
+const config_plugins_1 = require("expo/config-plugins");
+const withBLEAndroidManifest = (config, { isBackgroundEnabled, neverForLocation, companionDeviceEnabled }) => {
+    return (0, config_plugins_1.withAndroidManifest)(config, config => {
+        config.modResults = addLocationPermissionToManifest(config.modResults, neverForLocation);
+        config.modResults = addScanPermissionToManifest(config.modResults, neverForLocation);
+        config.modResults = addConnectPermissionToManifest(config.modResults, neverForLocation);
+        if (companionDeviceEnabled) {
+            config.modResults = addCompanionPermissionToManifest(config.modResults);
+        }
+        if (isBackgroundEnabled) {
+            config.modResults = addBLEHardwareFeatureToManifest(config.modResults);
+        }
+        return config;
+    });
+};
+exports.withBLEAndroidManifest = withBLEAndroidManifest;
+/**
+ * Add location permissions
+ *  - 'android.permission.ACCESS_COARSE_LOCATION' for Android SDK 28 (Android 9) and lower
+ *  - 'android.permission.ACCESS_FINE_LOCATION' for Android SDK 29 (Android 10) and higher.
+ *    From Android SDK 31 (Android 12) it might not be required if BLE is not used for location.
+ */
+function addLocationPermissionToManifest(androidManifest, neverForLocationSinceSdk31) {
+    if (!Array.isArray(androidManifest.manifest['uses-permission-sdk-23'])) {
+        androidManifest.manifest['uses-permission-sdk-23'] = [];
+    }
+    const optMaxSdkVersion = neverForLocationSinceSdk31
+        ? {
+            'android:maxSdkVersion': '30',
+        }
+        : {};
+    if (!androidManifest.manifest['uses-permission-sdk-23'].find(item => item.$['android:name'] === 'android.permission.ACCESS_COARSE_LOCATION')) {
+        androidManifest.manifest['uses-permission-sdk-23'].push({
+            $: {
+                'android:name': 'android.permission.ACCESS_COARSE_LOCATION',
+                ...optMaxSdkVersion,
+            },
+        });
+    }
+    if (!androidManifest.manifest['uses-permission-sdk-23'].find(item => item.$['android:name'] === 'android.permission.ACCESS_FINE_LOCATION')) {
+        androidManifest.manifest['uses-permission-sdk-23'].push({
+            $: {
+                'android:name': 'android.permission.ACCESS_FINE_LOCATION',
+                ...optMaxSdkVersion,
+            },
+        });
+    }
+    return androidManifest;
+}
+/**
+ * Add 'android.permission.BLUETOOTH_SCAN'.
+ * Required since Android SDK 31 (Android 12).
+ */
+function addScanPermissionToManifest(androidManifest, neverForLocation) {
+    if (!Array.isArray(androidManifest.manifest['uses-permission'])) {
+        androidManifest.manifest['uses-permission'] = [];
+    }
+    if (!androidManifest.manifest['uses-permission'].find(item => item.$['android:name'] === 'android.permission.BLUETOOTH_SCAN')) {
+        config_plugins_1.AndroidConfig.Manifest.ensureToolsAvailable(androidManifest);
+        androidManifest.manifest['uses-permission']?.push({
+            $: {
+                'android:name': 'android.permission.BLUETOOTH_SCAN',
+                ...(neverForLocation
+                    ? {
+                        'android:usesPermissionFlags': 'neverForLocation',
+                    }
+                    : {}),
+                'tools:targetApi': '31',
+            },
+        });
+    }
+    return androidManifest;
+}
+function addConnectPermissionToManifest(androidManifest, neverForLocation) {
+    if (!Array.isArray(androidManifest.manifest['uses-permission'])) {
+        androidManifest.manifest['uses-permission'] = [];
+    }
+    if (!androidManifest.manifest['uses-permission'].find(item => item.$['android:name'] === 'android.permission.BLUETOOTH_CONNECT')) {
+        config_plugins_1.AndroidConfig.Manifest.ensureToolsAvailable(androidManifest);
+        androidManifest.manifest['uses-permission']?.push({
+            $: {
+                'android:name': 'android.permission.BLUETOOTH_CONNECT',
+            },
+        });
+    }
+    return androidManifest;
+}
+function addCompanionPermissionToManifest(androidManifest) {
+    if (!Array.isArray(androidManifest.manifest['uses-feature'])) {
+        androidManifest.manifest['uses-feature'] = [];
+    }
+    if (!androidManifest.manifest['uses-feature'].find(item => item.$['android:name'] === 'android.software.companion_device_setup')) {
+        androidManifest.manifest['uses-feature']?.push({
+            $: {
+                'android:name': 'android.software.companion_device_setup',
+                'android:required': 'true',
+            },
+        });
+    }
+    return androidManifest;
+}
+// Add this line if your application always requires BLE. More info can be found on: https://developer.android.com/guide/topics/connectivity/bluetooth-le.html#permissions
+function addBLEHardwareFeatureToManifest(androidManifest) {
+    // Add `<uses-feature android:name="android.hardware.bluetooth_le" android:required="true"/>` to the AndroidManifest.xml
+    if (!Array.isArray(androidManifest.manifest['uses-feature'])) {
+        androidManifest.manifest['uses-feature'] = [];
+    }
+    if (!androidManifest.manifest['uses-feature'].find(item => item.$['android:name'] === 'android.hardware.bluetooth_le')) {
+        androidManifest.manifest['uses-feature']?.push({
+            $: {
+                'android:name': 'android.hardware.bluetooth_le',
+                'android:required': 'true',
+            },
+        });
+    }
+    return androidManifest;
+}

package/plugin/build/withBluetoothPermissions.d.ts

@@ -0,0 +1,4 @@
+import { ConfigPlugin } from 'expo/config-plugins';
+export declare const withBluetoothPermissions: ConfigPlugin<{
+    bluetoothAlwaysPermission?: string | false;
+}>;

package/plugin/build/withBluetoothPermissions.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withBluetoothPermissions = void 0;
+const config_plugins_1 = require("expo/config-plugins");
+const BLUETOOTH_ALWAYS = 'Allow $(PRODUCT_NAME) to connect to bluetooth devices';
+const withBluetoothPermissions = (c, { bluetoothAlwaysPermission } = {}) => {
+    return (0, config_plugins_1.withInfoPlist)(c, config => {
+        if (bluetoothAlwaysPermission !== false) {
+            config.modResults.NSBluetoothAlwaysUsageDescription =
+                bluetoothAlwaysPermission ||
+                    config.modResults.NSBluetoothAlwaysUsageDescription ||
+                    BLUETOOTH_ALWAYS;
+        }
+        return config;
+    });
+};
+exports.withBluetoothPermissions = withBluetoothPermissions;