@ledgerhq/react-native-hw-transport-ble 6.28.3 → 6.28.4-nightly.0

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
 
-> @ledgerhq/react-native-hw-transport-ble@6.28.2 build /home/runner/work/ledger-live/ledger-live/libs/ledgerjs/packages/react-native-hw-transport-ble
+> @ledgerhq/react-native-hw-transport-ble@6.28.3 build /home/runner/work/ledger-live/ledger-live/libs/ledgerjs/packages/react-native-hw-transport-ble
 > tsc && tsc -m ES6 --outDir lib-es
 

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @ledgerhq/react-native-hw-transport-ble
 
+## 6.28.4-nightly.0
+
+### Patch Changes
+
+- Updated dependencies [[`1d0b2d19eb`](https://github.com/LedgerHQ/ledger-live/commit/1d0b2d19ebc5acd058930b842c6d37f8daf2a5a3)]:
+  - @ledgerhq/errors@6.12.4-nightly.0
+  - @ledgerhq/devices@8.0.1-nightly.0
+  - @ledgerhq/hw-transport@6.28.2-nightly.0
+
 ## 6.28.3
 
 ### Patch Changes
@@ -8,6 +17,14 @@
   - @ledgerhq/devices@8.0.0
   - @ledgerhq/hw-transport@6.28.1
 
+## 6.28.3-next.0
+
+### Patch Changes
+
+- Updated dependencies [[`62af25493e`](https://github.com/LedgerHQ/ledger-live/commit/62af25493e2becf897d517af42542db208b971c7)]:
+  - @ledgerhq/devices@8.0.0-next.0
+  - @ledgerhq/hw-transport@6.28.1-next.0
+
 ## 6.28.2
 
 ### Patch Changes

package/lib/BleTransport.d.ts

@@ -1,21 +1,14 @@
 /// <reference types="node" />
 import Transport from "@ledgerhq/hw-transport";
-import type { Subscription as TransportSubscription, Observer as TransportObserver, DescriptorEvent } from "@ledgerhq/hw-transport";
+import type { Subscription as TransportSubscription, Observer as TransportObserver } from "@ledgerhq/hw-transport";
+import { DeviceId, Device, Characteristic } from "react-native-ble-plx";
 import type { DeviceModel } from "@ledgerhq/devices";
-import { Observable } from "rxjs";
+import { Observable, Observer } from "rxjs";
 import { HwTransportError } from "@ledgerhq/errors";
-import type { Device, Characteristic } from "./types";
-declare type ReconnectionConfig = {
-    pairingThreshold: number;
-    delayAfterFirstPairing: number;
-};
-export declare function setReconnectionConfig(config: ReconnectionConfig | null | undefined): void;
-/**
- * react-native bluetooth BLE implementation
- * @example
- * import BluetoothTransport from "@ledgerhq/react-native-hw-transport-ble";
- */
-export default class BluetoothTransport extends Transport {
+import { ReconnectionConfig } from "./types";
+export declare const setReconnectionConfig: (config: ReconnectionConfig | null | undefined) => void;
+export default class BleTransport extends Transport {
+    static disconnectTimeoutMs: number;
     /**
      *
      */
@@ -23,47 +16,84 @@ export default class BluetoothTransport extends Transport {
     /**
      *
      */
-    static setLogLevel: (level: any) => void;
+    static list: () => Promise<void[]>;
     /**
-     * TODO could add this concept in all transports
-     * observe event with { available: bool, string } // available is generic, type is specific
-     * an event is emit once and then listened
+     * Exposed method from the ble-plx library
+     * Sets new log level for native module's logging mechanism.
+     * @param string logLevel New log level to be set.
      */
-    static observeState(observer: any): {
-        unsubscribe: () => void;
-    };
-    static list: () => any;
+    static setLogLevel: (logLevel: string) => void;
+    /**
+     * Listen to state changes on the bleManagerInstance and notify the
+     * specified observer.
+     * @param observer
+     * @returns TransportSubscription
+     */
+    static observeState(observer: Observer<{
+        type: string;
+        available: boolean;
+    }>): TransportSubscription;
     /**
      * Scan for bluetooth Ledger devices
+     * @param observer Device is partial in order to avoid the live-common/this dep
+     * @returns TransportSubscription
      */
-    static listen(observer: TransportObserver<DescriptorEvent<Device>, HwTransportError>): TransportSubscription;
+    static listen(observer: TransportObserver<any, HwTransportError>): TransportSubscription;
     /**
      * Open a BLE transport
-     * @param {*} deviceOrId
+     * @param {Device | string} deviceOrId
      */
-    static open(deviceOrId: Device | string): Promise<any>;
+    static open(deviceOrId: Device | string): Promise<BleTransport>;
     /**
-     * Globally disconnect a BLE device by its ID
+     * Exposed method from the ble-plx library
+     * Disconnects from {@link Device} if it's connected or cancels pending connection.
      */
-    static disconnect: (id: any) => Promise<void>;
-    id: string;
+    static disconnect: (id: DeviceId) => Promise<void>;
     device: Device;
+    deviceModel: DeviceModel;
+    disconnectTimeout: null | ReturnType<typeof setTimeout>;
+    id: string;
+    isConnected: boolean;
     mtuSize: number;
-    writeCharacteristic: Characteristic;
-    writeCmdCharacteristic: Characteristic;
     notifyObservable: Observable<any>;
-    deviceModel: DeviceModel;
     notYetDisconnected: boolean;
-    constructor(device: Device, writeCharacteristic: Characteristic, writeCmdCharacteristic: Characteristic, notifyObservable: Observable<any>, deviceModel: DeviceModel);
+    writeCharacteristic: Characteristic;
+    writeCmdCharacteristic: Characteristic | undefined;
+    constructor(device: Device, writeCharacteristic: Characteristic, writeCmdCharacteristic: Characteristic | undefined, notifyObservable: Observable<any>, deviceModel: DeviceModel);
     /**
-     * communicate with a BLE transport
+     * Send data to the device using a low level API.
+     * It's recommended to use the "send" method for a higher level API.
+     * @param {Buffer} apdu - The data to send.
+     * @returns {Promise<Buffer>} A promise that resolves with the response data from the device.
      */
     exchange: (apdu: Buffer) => Promise<any>;
+    /**
+     * Negotiate with the device the maximum transfer unit for the ble frames
+     * @returns Promise<number>
+     */
     inferMTU(): Promise<number>;
-    requestConnectionPriority(connectionPriority: "Balanced" | "High" | "LowPower"): Promise<void>;
-    setScrambleKey(): void;
-    write: (buffer: Buffer, txid?: string | null | undefined) => Promise<void>;
+    /**
+     * Exposed method from the ble-plx library
+     * Request the connection priority for the given device.
+     * @param {"Balanced" | "High" | "LowPower"} connectionPriority: Connection priority.
+     * @returns {Promise<Device>} Connected device.
+     */
+    requestConnectionPriority(connectionPriority: "Balanced" | "High" | "LowPower"): Promise<Device>;
+    /**
+     * Do not call this directly unless you know what you're doing. Communication
+     * with a Ledger device should be through the {@link exchange} method.
+     * @param buffer
+     * @param txid
+     */
+    write: (buffer: Buffer, txid?: string | undefined) => Promise<void>;
+    /**
+     * We intentionally do not immediately close a transport connection.
+     * Instead, we queue the disconnect and wait for a future connection to dismiss the event.
+     * This approach prevents unnecessary disconnects and reconnects. We use the isConnected
+     * flag to ensure that we do not trigger a disconnect if the current cached transport has
+     * already been disconnected.
+     * @returns {Promise<void>}
+     */
     close(): Promise<void>;
 }
-export {};
 //# sourceMappingURL=BleTransport.d.ts.map

package/lib/BleTransport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BleTransport.d.ts","sourceRoot":"","sources":["../src/BleTransport.ts"],"names":[],"mappings":";AACA,OAAO,SAAS,MAAM,wBAAwB,CAAC;AAC/C,OAAO,KAAK,EACV,YAAY,IAAI,qBAAqB,EACrC,QAAQ,IAAI,iBAAiB,EAC7B,eAAe,EAChB,MAAM,wBAAwB,CAAC;AAWhC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAYrD,OAAO,EAAE,UAAU,EAAsC,MAAM,MAAM,CAAC;AAStE,OAAO,EAKL,gBAAgB,EAEjB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAmCtD,aAAK,kBAAkB,GAAG;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,sBAAsB,EAAE,MAAM,CAAC;CAChC,CAAC;AAKF,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,kBAAkB,GAAG,IAAI,GAAG,SAAS,QAG9C;AAyOD;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,SAAS;IACvD;;OAEG;IACH,MAAM,CAAC,WAAW,QAAO,QAAQ,OAAO,CAAC,CACW;IAEpD;;OAEG;IACH,MAAM,CAAC,WAAW,UAAW,GAAG,UAE9B;IAEF;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,GAAG;;;IAcjC,MAAM,CAAC,IAAI,QAAO,GAAG,CAEnB;IAEF;;OAEG;IACH,MAAM,CAAC,MAAM,CACX,QAAQ,EAAE,iBAAiB,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,gBAAgB,CAAC,GACrE,qBAAqB;IAuDxB;;;OAGG;WACU,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IAI7C;;OAEG;IACH,MAAM,CAAC,UAAU,OAAc,GAAG,mBAGhC;IACF,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,SAAM;IACb,mBAAmB,EAAE,cAAc,CAAC;IACpC,sBAAsB,EAAE,cAAc,CAAC;IACvC,gBAAgB,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;IAClC,WAAW,EAAE,WAAW,CAAC;IACzB,kBAAkB,UAAQ;gBAGxB,MAAM,EAAE,MAAM,EACd,mBAAmB,EAAE,cAAc,EACnC,sBAAsB,EAAE,cAAc,EACtC,gBAAgB,EAAE,UAAU,CAAC,GAAG,CAAC,EACjC,WAAW,EAAE,WAAW;IAY1B;;OAEG;IACH,QAAQ,SAAU,MAAM,KAAG,QAAQ,GAAG,CAAC,CAyBlC;IAGC,QAAQ;IAuCR,yBAAyB,CAC7B,kBAAkB,EAAE,UAAU,GAAG,MAAM,GAAG,UAAU;IAStD,cAAc;IAEd,KAAK,WAAkB,MAAM,SAAS,MAAM,GAAG,IAAI,GAAG,SAAS,mBAsB7D;IAEI,KAAK;CAKZ"}
+{"version":3,"file":"BleTransport.d.ts","sourceRoot":"","sources":["../src/BleTransport.ts"],"names":[],"mappings":";AAAA,OAAO,SAAS,MAAM,wBAAwB,CAAC;AAY/C,OAAO,KAAK,EACV,YAAY,IAAI,qBAAqB,EACrC,QAAQ,IAAI,iBAAiB,EAC9B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAKL,QAAQ,EACR,MAAM,EACN,cAAc,EAGf,MAAM,sBAAsB,CAAC;AAM9B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,OAAO,EAAE,UAAU,EAAsC,QAAQ,EAAE,MAAM,MAAM,CAAC;AAShF,OAAO,EAKL,gBAAgB,EACjB,MAAM,kBAAkB,CAAC;AAQ1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAW7C,eAAO,MAAM,qBAAqB,WACxB,kBAAkB,GAAG,IAAI,GAAG,SAAS,KAC5C,IAEF,CAAC;AAyRF,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,SAAS;IACjD,MAAM,CAAC,mBAAmB,SAAQ;IAClC;;OAEG;IACH,MAAM,CAAC,WAAW,QAAO,QAAQ,OAAO,CAAC,CACW;IAEpD;;OAEG;IACH,MAAM,CAAC,IAAI,QAAO,QAAQ,IAAI,EAAE,CAAC,CAE/B;IAEF;;;;OAIG;IACH,MAAM,CAAC,WAAW,aAAc,MAAM,KAAG,IAAI,CAM3C;IAEF;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CACjB,QAAQ,EAAE,QAAQ,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,OAAO,CAAC;KACpB,CAAC,GACD,qBAAqB;IAexB;;;;OAIG;IACH,MAAM,CAAC,MAAM,CACX,QAAQ,EAAE,iBAAiB,CAAC,GAAG,EAAE,gBAAgB,CAAC,GACjD,qBAAqB;IA2DxB;;;OAGG;WACU,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAIrE;;;OAGG;IACH,MAAM,CAAC,UAAU,OAAc,QAAQ,KAAG,QAAQ,IAAI,CAAC,CAIrD;IAEF,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,WAAW,CAAC;IACzB,iBAAiB,EAAE,IAAI,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,CAAQ;IAC/D,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,UAAQ;IACnB,OAAO,SAAM;IACb,gBAAgB,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;IAClC,kBAAkB,UAAQ;IAC1B,mBAAmB,EAAE,cAAc,CAAC;IACpC,sBAAsB,EAAE,cAAc,GAAG,SAAS,CAAC;gBAGjD,MAAM,EAAE,MAAM,EACd,mBAAmB,EAAE,cAAc,EACnC,sBAAsB,EAAE,cAAc,GAAG,SAAS,EAClD,gBAAgB,EAAE,UAAU,CAAC,GAAG,CAAC,EACjC,WAAW,EAAE,WAAW;IAc1B;;;;;OAKG;IACH,QAAQ,SAAU,MAAM,KAAG,QAAQ,GAAG,CAAC,CA2BlC;IAEL;;;OAGG;IACG,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;IAsCjC;;;;;OAKG;IACG,yBAAyB,CAC7B,kBAAkB,EAAE,UAAU,GAAG,MAAM,GAAG,UAAU,GACnD,OAAO,CAAC,MAAM,CAAC;IAQlB;;;;;OAKG;IACH,KAAK,WAAkB,MAAM,SAAS,MAAM,GAAG,SAAS,KAAG,QAAQ,IAAI,CAAC,CAqBtE;IAEF;;;;;;;OAOG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CA8B7B"}