react-native-ble-manager 11.5.6 → 12.0.0-rc.0

package/package.json

@@ -1,58 +1,109 @@
 {
-  "name": "react-native-ble-manager",
-  "version": "11.5.6",
-  "description": "A BLE module for react native.",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/innoveit/react-native-ble-manager.git"
-  },
-  "bugs": {
-    "url": "https://github.com/innoveit/react-native-ble-manager/issues"
-  },
-  "keywords": [
-    "react-native",
-    "android",
-    "ios",
-    "ble",
-    "bluetooth",
-    "low energy"
-  ],
-  "license": "Apache-2.0",
-  "author": {
-    "name": "Innove",
-    "url": "https://github.com/innoveit"
-  },
-  "main": "dist/cjs/index.js",
-  "types": "dist/esm/index.d.ts",
-  "module": "dist/esm/index.js",
-  "react-native": "src/index.ts",
-  "files": [
-    "/dist",
-    "/src",
-    "/android",
-    "!/android/build",
-    "/ios",
-    "/*.podspec"
-  ],
-  "scripts": {
-    "version": "git add -A",
-    "clean": "rimraf dist",
-    "type:check": "tsc -p tsconfig.json --noEmit",
-    "prebuild": "npm run clean",
-    "build:cjs": "tsc --module commonjs --outDir dist/cjs",
-    "build:esm": "tsc --outDir dist/esm",
-    "build": "npm run build:esm && npm run build:cjs",
-    "watch": "npm run build --watch",
-    "prepare": "npm run build",
-    "preversion": "npm run build",
-    "postversion": "git push --follow-tags"
-  },
-  "peerDependencies": {
-    "react-native": ">=0.60.0"
-  },
-  "devDependencies": {
-    "react-native": "0.73.6",
-    "rimraf": "4.1.2",
-    "typescript": "4.9.5"
-  }
+    "name": "react-native-ble-manager",
+    "version": "12.0.0-rc.0",
+    "description": "A BLE module for react native.",
+    "homepage": "https://innoveit.github.io/react-native-ble-manager/",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/innoveit/react-native-ble-manager.git"
+    },
+    "bugs": {
+        "url": "https://github.com/innoveit/react-native-ble-manager/issues"
+    },
+    "keywords": [
+        "react-native",
+        "android",
+        "ios",
+        "ble",
+        "bluetooth",
+        "low energy"
+    ],
+    "license": "Apache-2.0",
+    "author": {
+        "name": "Innove",
+        "url": "https://github.com/innoveit"
+    },
+    "main": "dist/cjs/index.js",
+    "types": "dist/esm/index.d.ts",
+    "module": "dist/esm/index.js",
+    "react-native": "src/index.ts",
+    "files": [
+        "/dist",
+        "/src",
+        "/android",
+        "/ios",
+        "*.podspec",
+        "react-native.config.json",
+        "!ios/build",
+        "!android/build",
+        "!android/gradle",
+        "!android/gradlew",
+        "!android/gradlew.bat",
+        "!android/local.properties",
+        "!**/__tests__",
+        "!**/__fixtures__",
+        "!**/__mocks__",
+        "!**/.*"
+    ],
+    "scripts": {
+        "version": "git add -A",
+        "clean": "rimraf dist",
+        "type:check": "tsc -p tsconfig.json --noEmit",
+        "prepare": "npm run build",
+        "prebuild": "npm run clean",
+        "build:cjs": "tsc --module commonjs --outDir dist/cjs",
+        "build:esm": "tsc --outDir dist/esm",
+        "build": "npm run build:esm && npm run build:cjs",
+        "watch": "npm run build --watch",
+        "preversion": "npm run build",
+        "postversion": "git push --follow-tags"
+    },
+    "resolutions": {
+        "@types/react": "^18.2.44"
+    },
+    "peerDependencies": {
+        "react": "*",
+        "react-native": "*"
+    },
+    "devDependencies": {
+        "@commitlint/config-conventional": "^17.0.2",
+        "@react-native/eslint-config": "^0.73.1",
+        "@release-it/conventional-changelog": "^5.0.0",
+        "@types/jest": "^29.5.5",
+        "@types/react": "^18.2.44",
+        "commitlint": "^17.0.2",
+        "del-cli": "^5.1.0",
+        "eslint": "^8.51.0",
+        "eslint-config-prettier": "^9.0.0",
+        "eslint-plugin-prettier": "^5.0.1",
+        "jest": "^29.7.0",
+        "prettier": "^3.0.3",
+        "react": "18.2.0",
+        "react-native": "0.76.1",
+        "@react-native/gradle-plugin": "^0.75.1",
+        "turbo": "^1.10.7",
+        "typescript": "^5.2.2"
+    },
+    "eslintConfig": {
+        "root": true,
+        "extends": [
+            "@react-native",
+            "prettier"
+        ],
+        "rules": {
+            "react/react-in-jsx-scope": "off"
+        }
+    },
+    "eslintIgnore": [
+        "node_modules/",
+        "lib/"
+    ],
+    "codegenConfig": {
+        "name": "BleManagerSpec",
+        "type": "modules",
+        "jsSrcsDir": "src",
+        "android": {
+            "javaPackageName": "it.innove"
+        }
+    }
 }

package/src/NativeBleManager.ts

@@ -0,0 +1,409 @@
+import { TurboModule, TurboModuleRegistry } from 'react-native';
+// @ts-ignore Ignore since it comes from codegen types.
+import type { EventEmitter } from 'react-native/Libraries/Types/CodegenTypes';
+
+/**
+ * This represents the Turbo Module version of react-native-ble-manager.
+ * This adds the codegen definition to react-native generate the c++ bindings on compile time.
+ * That should work only on 0.75 and higher.
+ * Don't remove it! and please modify with caution! Knowing that can create wrong bindings into jsi and break at compile or execution time.
+ *  - Knowing that also every type needs to match the current Objective C++ and Java callbacks types and callbacks type definitions and be aware of the current differences between implementation in both platforms.
+ */
+export interface Spec extends TurboModule {
+  start(options: Object, callback: (error: CallbackError) => void): void;
+
+  scan(
+    serviceUUIDStrings: string[],
+    timeoutSeconds: number,
+    allowDuplicates: boolean,
+    scanningOptions: Object,
+    callback: (error: CallbackError) => void
+  ): void;
+
+  stopScan(callback: (error: CallbackError) => void): void;
+
+  connect(
+    peripheralUUID: string,
+    options: Object,
+    callback: (error: CallbackError) => void
+  ): void;
+
+  disconnect(
+    peripheralUUID: string,
+    force: boolean,
+    callback: (error: CallbackError) => void
+  ): void;
+
+  retrieveServices(
+    peripheralUUID: string,
+    services: string[],
+    callback: (error: CallbackError, peripheral: PeripheralInfo) => void
+  ): void;
+
+  readRSSI(
+    peripheralUUID: string,
+    callback: (error: string | null, rssi: number) => void
+  ): void;
+
+  readDescriptor(
+    peripheralUUID: string,
+    serviceUUID: string,
+    characteristicUUID: string,
+    descriptorUUID: string,
+    callback: (error: string | null, data: number[]) => void
+  ): void;
+
+  writeDescriptor(
+    peripheralUUID: string,
+    serviceUUID: string,
+    characteristicUUID: string,
+    descriptorUUID: string,
+    data: object[],
+    callback: (error: string | null) => void
+  ): void;
+
+  getDiscoveredPeripherals(
+    callback: (error: string | null, result: Peripheral[] | null) => void
+  ): void;
+
+  checkState(callback: (state: BleState) => void): void;
+
+  write(
+    peripheralUUID: string,
+    serviceUUID: string,
+    characteristicUUID: string,
+    message: object[],
+    maxByteSize: number,
+    callback: (error: string | null) => void
+  ): void;
+
+  writeWithoutResponse(
+    peripheralUUID: string,
+    serviceUUID: string,
+    characteristicUUID: string,
+    message: object[],
+    maxByteSize: number,
+    queueSleepTime: number,
+    callback: (error: string | null) => void
+  ): void;
+
+  read(
+    peripheralUUID: string,
+    serviceUUID: string,
+    characteristicUUID: string,
+    callback: (error: string | null, data: number[]) => void
+  ): void;
+
+  startNotification(
+    peripheralUUID: string,
+    serviceUUID: string,
+    characteristicUUID: string,
+    callback: (error: string | null) => void
+  ): void;
+
+  stopNotification(
+    peripheralUUID: string,
+    serviceUUID: string,
+    characteristicUUID: string,
+    callback: (error: string | null) => void
+  ): void;
+
+  getConnectedPeripherals(
+    serviceUUIDStrings: string[],
+    callback: (error: string | null, result: Peripheral[] | null) => void
+  ): void;
+
+  isPeripheralConnected(
+    peripheralUUID: string,
+    callback: (error: Peripheral[]) => void
+  ): void;
+
+  isScanning(callback: (error: string | null, status: boolean) => void): void;
+
+  getMaximumWriteValueLengthForWithoutResponse(
+    peripheralUUID: string,
+    callback: (error: string | null, max: number) => void
+  ): void;
+
+  getMaximumWriteValueLengthForWithResponse(
+    deviceUUID: string,
+    callback: (error: string | null, max: number) => void
+  ): void;
+
+  enableBluetooth(callback: (error: string | null) => void): void;
+
+  getBondedPeripherals(
+    callback: (error: string | null, result: Peripheral[] | null) => void
+  ): void;
+
+  createBond(
+    peripheralUUID: string,
+    devicePin: string,
+    callback: (error: string | null) => void
+  ): void;
+
+  removeBond(
+    peripheralUUID: string,
+    callback: (error: string | null) => void
+  ): void;
+
+  removePeripheral(
+    peripheralUUID: string,
+    callback: (error: string | null) => void
+  ): void;
+
+  requestMTU(
+    peripheralUUID: string,
+    mtu: number,
+    callback: (error: string | null, mtu: number) => void
+  ): void;
+
+  requestConnectionPriority(
+    peripheralUUID: string,
+    connectionPriority: number,
+    callback: (error: string | null, status: boolean) => void
+  ): void;
+
+  refreshCache(
+    peripheralUUID: string,
+    callback: (error: string | null, result: boolean) => void
+  ): void;
+
+  setName(name: string): void;
+
+  getAssociatedPeripherals(
+    callback: (error: string | null, peripherals: Peripheral[] | null) => void
+  ): void;
+
+  removeAssociatedPeripheral(
+    peripheralUUID: string,
+    callback: (error: string | null) => void
+  ): void;
+
+  supportsCompanion(callback: (supports: boolean) => void): void;
+
+  companionScan(
+    serviceUUIDs: string[],
+    option: Object,
+    callback: (error: string | null, peripheral: Peripheral | null) => void
+  ): void;
+
+  /**
+   * Supported events.
+   */
+  readonly onDiscoverPeripheral: EventEmitter<Peripheral>;
+  readonly onStopScan: EventEmitter<EventStopScan>;
+  readonly onDidUpdateState: EventEmitter<EventDidUpdateState>;
+  readonly onDidUpdateValueForCharacteristic: EventEmitter<EventDidUpdateValueForCharacteristic>;
+  readonly onConnectPeripheral: EventEmitter<EventConnectPeripheral>;
+  readonly onDisconnectPeripheral: EventEmitter<EventDisconnectPeripheral>;
+  readonly onPeripheralDidBond: EventEmitter<EventPeripheralDidBond>;
+  readonly onCentralManagerWillRestoreState: EventEmitter<EventCentralManagerWillRestoreState>;
+  readonly onDidUpdateNotificationStateFor: EventEmitter<EventDidUpdateNotificationStateFor>;
+  readonly onCompanionPeripheral: EventEmitter<EventCompanionPeripheral>;
+  readonly onCompanionFailure: EventEmitter<EventCompanionFailure>;
+}
+
+export default TurboModuleRegistry.get<Spec>('BleManager') as Spec;
+
+/** Turbo Module Type Definitions */
+// These types are more loose than types.ts for simplicity and for codegen support.
+// No interfaces or generics are currently supported.
+export type BleScanCallbackType = number;
+export type BleScanMatchCount = number;
+export type BleScanMatchMode = number;
+export type BleScanMode = number;
+export type BleScanPhyMode = number;
+export type CallbackError = string | null;
+export type BleState = string;
+
+export type Peripheral = {
+  id: string;
+  rssi: number;
+  name: string | null;
+  advertising: {
+    isConnectable?: boolean;
+    localName?: string | null;
+    rawData?: {
+      CDVType: number[];
+      bytes: number[];
+      data: string;
+    };
+    manufacturerData?:
+      | {
+          CDVType: number[];
+          bytes: number[];
+          data: string;
+        }[]
+      | null;
+    manufacturerRawData?: {
+      CDVType: number[];
+      bytes: number[];
+      data: string;
+    } | null;
+    serviceData?:
+      | {
+          CDVType: number[];
+          bytes: number[];
+          data: string;
+        }[]
+      | null;
+    serviceUUIDs?: string[];
+    txPowerLevel?: number;
+  };
+};
+
+export type PeripheralInfo = {
+  id: string;
+  rssi: number;
+  name: string | null;
+  advertising: {
+    isConnectable?: boolean;
+    localName?: string | null;
+    rawData?: {
+      CDVType: number[];
+      bytes: number[];
+      data: string;
+    } | null;
+    manufacturerData?:
+      | {
+          CDVType: number[];
+          bytes: number[];
+          data: string;
+        }[]
+      | null;
+    manufacturerRawData?: {
+      CDVType: number[];
+      bytes: number[];
+      data: string;
+    } | null;
+    serviceData?:
+      | {
+          CDVType: number[];
+          bytes: number[];
+          data: string;
+        }[]
+      | null;
+    serviceUUIDs?: string[];
+    txPowerLevel?: number;
+  };
+  serviceUUIDs?: string[];
+  characteristics?: {
+    properties: {
+      Broadcast?: string;
+      Read?: string;
+      WriteWithoutResponse?: string;
+      Write?: string;
+      Notify?: string;
+      Indicate?: string;
+      AuthenticatedSignedWrites?: string;
+      ExtendedProperties?: string;
+      NotifyEncryptionRequired?: string;
+      IndicateEncryptionRequired?: string;
+    };
+    characteristic: string;
+    service: string;
+    descriptors?: {
+      value: string;
+      uuid: string;
+    }[];
+  }[];
+  services?: { uuid: string }[];
+};
+
+export type EventStopScan = {
+  status: number;
+};
+
+export type EventDidUpdateState = {
+  state: string;
+};
+
+export type EventDiscoverPeripheral = {
+  id: string;
+  name: string;
+  rssi: number;
+  advertising: {
+    isConnectable: boolean;
+    serviceUUIDs: string[];
+    manufacturerData: number[];
+    serviceData: number[];
+    txPowerLevel: number;
+    rawData?: number | null;
+  };
+};
+
+export type EventDidUpdateValueForCharacteristic = {
+  value: number[];
+  peripheral: string;
+  characteristic: string;
+  service: string;
+};
+
+export type EventConnectPeripheral = {
+  peripheral: string;
+  status?: number | null;
+};
+
+export type EventDisconnectPeripheral = {
+  peripheral: string;
+  status?: number | null;
+  domain?: string | null;
+  code?: number | null;
+};
+
+export type EventPeripheralDidBond = {
+  id: string;
+  name: string;
+  rssi: number;
+  advertising: {
+    isConnectable: boolean;
+    serviceUUIDs: string[];
+    manufacturerData: number[];
+    serviceData: number[];
+    txPowerLevel: number;
+    rawData?: number | null;
+  };
+};
+
+export type EventCentralManagerWillRestoreState = {
+  peripherals: {
+    id: string;
+    name: string;
+    rssi: number;
+    advertising: {
+      isConnectable: boolean;
+      serviceUUIDs: string[];
+      manufacturerData: number[];
+      serviceData: number[];
+      txPowerLevel: number;
+      rawData?: number | null;
+    };
+  }[];
+};
+
+export type EventDidUpdateNotificationStateFor = {
+  peripheral: string;
+  characteristic: string;
+  isNotifying: boolean;
+  domain?: string | null;
+  code?: number | null;
+};
+
+export type EventCompanionPeripheral = {
+  id: string;
+  name: string;
+  rssi: number;
+  advertising: {
+    isConnectable: boolean;
+    serviceUUIDs: string[];
+    manufacturerData: number[];
+    serviceData: number[];
+    txPowerLevel: number;
+    rawData?: number | null;
+  };
+};
+
+export type EventCompanionFailure = {
+  error: string;
+};