@ledgerhq/device-transport-kit-web-ble 0.0.0-legacy-speculos-datasource-20250821095840 → 0.0.0-multisig-20250822145545

package/lib/types/api/transport/BleDeviceConnection.d.ts

@@ -0,0 +1,98 @@
+import { type ApduReceiverServiceFactory, type ApduResponse, type ApduSenderServiceFactory, type DeviceConnection, type DmkError, type LoggerPublisherService } from "@ledgerhq/device-management-kit";
+import { type Either } from "purify-ts";
+type BleDeviceConnectionConstructorArgs = {
+    writeCharacteristic: BluetoothRemoteGATTCharacteristic;
+    notifyCharacteristic: BluetoothRemoteGATTCharacteristic;
+    apduSenderFactory: ApduSenderServiceFactory;
+    apduReceiverFactory: ApduReceiverServiceFactory;
+};
+export type DataViewEvent = Event & {
+    target: {
+        value: DataView;
+    };
+};
+export declare class BleDeviceConnection implements DeviceConnection {
+    private _writeCharacteristic;
+    private _notifyCharacteristic;
+    private readonly _logger;
+    private _apduSender;
+    private readonly _apduSenderFactory;
+    private readonly _apduReceiver;
+    private _isDeviceReady;
+    private _sendApduPromiseResolver;
+    private _settleReconnectionPromiseResolvers;
+    constructor({ writeCharacteristic, notifyCharacteristic, apduSenderFactory, apduReceiverFactory, }: BleDeviceConnectionConstructorArgs, loggerServiceFactory: (tag: string) => LoggerPublisherService);
+    /**
+     * NotifyCharacteristic setter
+     * Register a listener on characteristic value change
+     * @param notifyCharacteristic
+     * @private
+     */
+    private set notifyCharacteristic(value);
+    /**
+     * WriteCharacteristic setter
+     * @param writeCharacteristic
+     * @private
+     */
+    private set writeCharacteristic(value);
+    /**
+     * Event handler to setup the mtu size in response of 0x0800000000 APDU
+     * @param value
+     * @private
+     */
+    private onReceiveSetupApduResponse;
+    /**
+     * Main event handler for BLE notify characteristic
+     * Call _onReceiveSetupApduResponse if device mtu is not set
+     * Call receiveApdu otherwise
+     * @param event
+     */
+    private onNotifyCharacteristicValueChanged;
+    /**
+     * Setup BleDeviceConnection
+     *
+     * The device is considered as ready once the mtu had been set
+     * APDU 0x0800000000 is used to get this mtu size
+     */
+    setup(): Promise<void>;
+    /**
+     * Receive APDU response
+     * Resolve sendApdu promise once the framer receives all the frames of the response
+     * @param data
+     */
+    receiveApdu(data: ArrayBuffer): void;
+    /**
+     * Send apdu if the mtu had been set
+     *
+     * Get all frames for a given APDU
+     * Save a promise that would be completed once the response had been received
+     * @param apdu
+     * @param triggersDisconnection
+     */
+    sendApdu(apdu: Uint8Array, triggersDisconnection?: boolean): Promise<Either<DmkError, ApduResponse>>;
+    /**
+     * Typeguard to check if an event contains target value of type DataView
+     *
+     * @param event
+     * @private
+     */
+    private isDataViewEvent;
+    /**
+     * Setup a promise that would be resolved once the device is reconnected
+     *
+     * @private
+     */
+    private setupWaitForReconnection;
+    /**
+     * Reconnect to the device by resetting new ble characteristics
+     * @param writeCharacteristic
+     * @param notifyCharacteristic
+     */
+    reconnect(writeCharacteristic: BluetoothRemoteGATTCharacteristic, notifyCharacteristic: BluetoothRemoteGATTCharacteristic): Promise<void>;
+    /**
+     * Disconnect from the device
+     */
+    disconnect(): void;
+}
+export {};
+//# sourceMappingURL=BleDeviceConnection.d.ts.map

package/lib/types/api/transport/BleDeviceConnection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BleDeviceConnection.d.ts","sourceRoot":"","sources":["../../../../src/api/transport/BleDeviceConnection.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,0BAA0B,EAC/B,KAAK,YAAY,EAEjB,KAAK,wBAAwB,EAE7B,KAAK,gBAAgB,EAErB,KAAK,QAAQ,EACb,KAAK,sBAAsB,EAE5B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,KAAK,MAAM,EAA+B,MAAM,WAAW,CAAC;AAErE,KAAK,kCAAkC,GAAG;IACxC,mBAAmB,EAAE,iCAAiC,CAAC;IACvD,oBAAoB,EAAE,iCAAiC,CAAC;IACxD,iBAAiB,EAAE,wBAAwB,CAAC;IAC5C,mBAAmB,EAAE,0BAA0B,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG;IAClC,MAAM,EAAE;QACN,KAAK,EAAE,QAAQ,CAAC;KACjB,CAAC;CACH,CAAC;AAEF,qBAAa,mBAAoB,YAAW,gBAAgB;IAC1D,OAAO,CAAC,oBAAoB,CAAoC;IAChE,OAAO,CAAC,qBAAqB,CAAoC;IACjE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IACjD,OAAO,CAAC,WAAW,CAA2B;IAC9C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAA2B;IAC9D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAsB;IACpD,OAAO,CAAC,cAAc,CAAU;IAChC,OAAO,CAAC,wBAAwB,CAE7B;IACH,OAAO,CAAC,mCAAmC,CAGxC;gBAGD,EACE,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,GACpB,EAAE,kCAAkC,EACrC,oBAAoB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,sBAAsB;IAe/D;;;;;OAKG;IACH,OAAO,KAAK,oBAAoB,QAM/B;IAED;;;;OAIG;IACH,OAAO,KAAK,mBAAmB,QAI9B;IAED;;;;OAIG;IACH,OAAO,CAAC,0BAA0B;IAclC;;;;;OAKG;IACH,OAAO,CAAC,kCAAkC,CAgBxC;IAEF;;;;;OAKG;IACU,KAAK;IAOlB;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,WAAW;IAqB7B;;;;;;;OAOG;IACG,QAAQ,CACZ,IAAI,EAAE,UAAU,EAChB,qBAAqB,CAAC,EAAE,OAAO,GAC9B,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAiD1C;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IAQvB;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;IAShC;;;;OAIG;IACU,SAAS,CACpB,mBAAmB,EAAE,iCAAiC,EACtD,oBAAoB,EAAE,iCAAiC;IAQzD;;OAEG;IACI,UAAU;CAQlB"}

package/lib/types/api/transport/BleDeviceConnection.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=BleDeviceConnection.test.d.ts.map

package/lib/types/api/transport/BleDeviceConnection.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BleDeviceConnection.test.d.ts","sourceRoot":"","sources":["../../../../src/api/transport/BleDeviceConnection.test.ts"],"names":[],"mappings":""}

package/lib/types/api/transport/WebBleTransport.d.ts

@@ -1,36 +1,91 @@
-import { type ApduReceiverServiceFactory, type ApduSenderServiceFactory, type ConnectError, type DeviceModelDataSource, type LoggerPublisherService, type Transport, TransportConnectedDevice, type TransportDiscoveredDevice, type TransportFactory, type TransportIdentifier, UnknownDeviceError } from "@ledgerhq/device-management-kit";
+import { type ApduReceiverServiceFactory, type ApduSenderServiceFactory, type ConnectError, type DeviceId, type DeviceModelDataSource, type DisconnectHandler, type DmkError, type LoggerPublisherService, type Transport, TransportConnectedDevice, type TransportDiscoveredDevice, type TransportFactory, type TransportIdentifier } from "@ledgerhq/device-management-kit";
 import { type Either } from "purify-ts";
 import { type Observable } from "rxjs";
 export declare const webBleIdentifier: TransportIdentifier;
 export declare class WebBleTransport implements Transport {
-    private loggerFactory;
+    private readonly _deviceModelDataSource;
+    private readonly _loggerServiceFactory;
+    private readonly _apduSenderFactory;
+    private readonly _apduReceiverFactory;
+    private readonly _connectedDevices;
+    private readonly _internalDevicesById;
+    private _deviceConnectionById;
+    private _disconnectionHandlersById;
     private _logger;
-    private _deviceModelDataSource;
-    private _apduSenderFactory;
-    private _apduReceiverFactory;
-    private _deviceRegistry;
-    private _connectionMachines;
-    private _discoveredDevicesSubject;
-    private _reconnectionPromises;
-    private _reconnectionTimers;
-    constructor(deviceModelDataSource: DeviceModelDataSource, loggerFactory: (tag: string) => LoggerPublisherService, apduSenderFactory: ApduSenderServiceFactory, apduReceiverFactory: ApduReceiverServiceFactory);
+    private readonly connectionType;
+    private readonly identifier;
+    constructor(_deviceModelDataSource: DeviceModelDataSource, _loggerServiceFactory: (tag: string) => LoggerPublisherService, _apduSenderFactory: ApduSenderServiceFactory, _apduReceiverFactory: ApduReceiverServiceFactory);
+    /**
+     * Get the Bluetooth API if supported or error
+     * @returns `Either<BleTransportNotSupportedError, Bluetooth>`
+     */
+    private getBluetoothApi;
     isSupported(): boolean;
     getIdentifier(): TransportIdentifier;
-    startDiscovering(): Observable<TransportDiscoveredDevice>;
     listenToAvailableDevices(): Observable<TransportDiscoveredDevice[]>;
+    /**
+     * Get Bluetooth GATT Primary service that is used to get writeCharacteristic and notifyCharacteristic
+     * @param bleDevice
+     * @private
+     */
+    private getBleGattService;
+    /**
+     * BleDeviceInfos to map primary service uuid to device model & characteristics uuid
+     * @param bleGattService
+     * @private
+     */
+    private getBleDeviceInfos;
+    /**
+     * Prompt device selection in navigator
+     *
+     * @private
+     */
+    private promptDeviceAccess;
+    /**
+     * Generate a discovered device from BluetoothDevice, BleGATT primary service and BLE device infos
+     * @param bleDeviceInfos
+     * @private
+     */
+    private getDiscoveredDeviceFrom;
+    /**
+     * Generate an InternalDevice from a unique id, a BluetoothDevice, BleGATT primary service and BLE device infos
+     * @param discoveredDevice
+     * @param bleDevice
+     * @param bleDeviceInfos
+     * @param bleGattService
+     * @private
+     */
+    private setInternalDeviceFrom;
+    /**
+     * Main method to get a device from a button click handler
+     * The GATT connection is done here in order to populate TransportDiscoveredDevice with deviceModel
+     */
+    startDiscovering(): Observable<TransportDiscoveredDevice>;
     stopDiscovering(): void;
-    connect(params: {
-        deviceId: string;
-        onDisconnect: (deviceId: string) => void;
-        onReconnect?: (deviceId: string) => Promise<void> | void;
+    /**
+     * Connect to a BLE device and update the internal state of the associated device
+     * Handle ondisconnect event on the device in order to try a reconnection
+     */
+    connect({ deviceId, onDisconnect, }: {
+        deviceId: DeviceId;
+        onDisconnect: DisconnectHandler;
     }): Promise<Either<ConnectError, TransportConnectedDevice>>;
-    private handleDisconnect;
-    private _cleanupDevice;
-    private _cleanupConnection;
-    private _rebindCharacteristics;
+    /**
+     * Get the device disconnected handler
+     * @param internalDevice WebBleInternalDevice
+     * @param deviceConnection BleDeviceConnection
+     * @returns async () => void
+     * @private
+     */
+    private _getDeviceDisconnectedHandler;
+    /**
+     * Disconnect from a BLE device and delete its handlers
+     *
+     * @param params { connectedDevice: TransportConnectedDevice }
+     */
     disconnect(params: {
         connectedDevice: TransportConnectedDevice;
-    }): Promise<Either<UnknownDeviceError, never> | Either<never, undefined>>;
+    }): Promise<Either<DmkError, void>>;
 }
 export declare const webBleTransportFactory: TransportFactory;
 //# sourceMappingURL=WebBleTransport.d.ts.map

package/lib/types/api/transport/WebBleTransport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WebBleTransport.d.ts","sourceRoot":"","sources":["../../../../src/api/transport/WebBleTransport.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,YAAY,EAGjB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAE3B,KAAK,SAAS,EACd,wBAAwB,EAExB,KAAK,yBAAyB,EAC9B,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,kBAAkB,EACnB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,KAAK,MAAM,EAAe,MAAM,WAAW,CAAC;AACrD,OAAO,EAAe,KAAK,UAAU,EAAuB,MAAM,MAAM,CAAC;AAezE,eAAO,MAAM,gBAAgB,EAAE,mBAA+B,CAAC;AAE/D,qBAAa,eAAgB,YAAW,SAAS;IAyC7C,OAAO,CAAC,aAAa;IAxCvB,OAAO,CAAC,OAAO,CAAyB;IACxC,OAAO,CAAC,sBAAsB,CAAwB;IACtD,OAAO,CAAC,kBAAkB,CAA2B;IACrD,OAAO,CAAC,oBAAoB,CAA6B;IAEzD,OAAO,CAAC,eAAe,CAenB;IAEJ,OAAO,CAAC,mBAAmB,CAGvB;IACJ,OAAO,CAAC,yBAAyB,CAE7B;IACJ,OAAO,CAAC,qBAAqB,CAGzB;IACJ,OAAO,CAAC,mBAAmB,CAGvB;gBAGF,qBAAqB,EAAE,qBAAqB,EACpC,aAAa,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,sBAAsB,EAC9D,iBAAiB,EAAE,wBAAwB,EAC3C,mBAAmB,EAAE,0BAA0B;IAQjD,WAAW,IAAI,OAAO;IAItB,aAAa,IAAI,mBAAmB;IAIpC,gBAAgB,IAAI,UAAU,CAAC,yBAAyB,CAAC;IA8CzD,wBAAwB,IAAI,UAAU,CAAC,yBAAyB,EAAE,CAAC;IAQnE,eAAe,IAAI,IAAI;IAIjB,OAAO,CAAC,MAAM,EAAE;QACpB,QAAQ,EAAE,MAAM,CAAC;QACjB,YAAY,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;QACzC,WAAW,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;KAC1D,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,wBAAwB,CAAC,CAAC;IAqH3D,OAAO,CAAC,gBAAgB;IA+HxB,OAAO,CAAC,cAAc;IAgDtB,OAAO,CAAC,kBAAkB;YAyBZ,sBAAsB;IAkCvB,UAAU,CAAC,MAAM,EAAE;QAC9B,eAAe,EAAE,wBAAwB,CAAC;KAC3C;CAqBF;AAED,eAAO,MAAM,sBAAsB,EAAE,gBAWlC,CAAC"}
+{"version":3,"file":"WebBleTransport.d.ts","sourceRoot":"","sources":["../../../../src/api/transport/WebBleTransport.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAE7B,KAAK,YAAY,EAGjB,KAAK,QAAQ,EACb,KAAK,qBAAqB,EAE1B,KAAK,iBAAiB,EACtB,KAAK,QAAQ,EACb,KAAK,sBAAsB,EAG3B,KAAK,SAAS,EACd,wBAAwB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EAEzB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,KAAK,MAAM,EAAmC,MAAM,WAAW,CAAC;AACzE,OAAO,EAAQ,KAAK,UAAU,EAAoB,MAAM,MAAM,CAAC;AAuB/D,eAAO,MAAM,gBAAgB,EAAE,mBAA+B,CAAC;AAE/D,qBAAa,eAAgB,YAAW,SAAS;IAU7C,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IACvC,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IAGtC,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IACnC,OAAO,CAAC,QAAQ,CAAC,oBAAoB;IAdvC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAyB;IAC3D,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAsC;IAC3E,OAAO,CAAC,qBAAqB,CAAqC;IAClE,OAAO,CAAC,0BAA0B,CAA4B;IAC9D,OAAO,CAAC,OAAO,CAAyB;IACxC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAyB;IACxD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAyC;gBAGjD,sBAAsB,EAAE,qBAAqB,EAC7C,qBAAqB,EAAE,CACtC,GAAG,EAAE,MAAM,KACR,sBAAsB,EACV,kBAAkB,EAAE,wBAAwB,EAC5C,oBAAoB,EAAE,0BAA0B;IASnE;;;OAGG;IACH,OAAO,CAAC,eAAe;IAQvB,WAAW,IAAI,OAAO;IAStB,aAAa,IAAI,mBAAmB;IAIpC,wBAAwB,IAAI,UAAU,CAAC,yBAAyB,EAAE,CAAC;IAInE;;;;OAIG;YACW,iBAAiB;IAmB/B;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAoBzB;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAwB1B;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;IAU/B;;;;;;;OAOG;IACH,OAAO,CAAC,qBAAqB;IAoB7B;;;OAGG;IACH,gBAAgB,IAAI,UAAU,CAAC,yBAAyB,CAAC;IAoDzD,eAAe,IAAI,IAAI;IAIvB;;;OAGG;IACG,OAAO,CAAC,EACZ,QAAQ,EACR,YAAY,GACb,EAAE;QACD,QAAQ,EAAE,QAAQ,CAAC;QACnB,YAAY,EAAE,iBAAiB,CAAC;KACjC,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,wBAAwB,CAAC,CAAC;IA+E3D;;;;;;OAMG;IACH,OAAO,CAAC,6BAA6B;IA0CrC;;;;OAIG;IACG,UAAU,CAAC,MAAM,EAAE;QACvB,eAAe,EAAE,wBAAwB,CAAC;KAC3C,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;CAgDpC;AAED,eAAO,MAAM,sBAAsB,EAAE,gBAWlC,CAAC"}