@onekeyfe/hd-transport-web-device 1.2.0-alpha.15 → 1.2.0-alpha.151

package/dist/electron-ble-transport.d.ts

@@ -12,24 +12,32 @@ export type BleAcquireInput = {
     uuid: string;
     forceCleanRunPromise?: boolean;
     expectedProtocol?: ProtocolType;
+    protocolHint?: ProtocolType;
 };
 export default class ElectronBleTransport {
     private _messages;
     private _messagesV2;
+    private protocolV2SchemaConfiguration;
     name: string;
     configured: boolean;
     runPromise: Deferred<Uint8Array | string> | null;
+    private runPromiseDeviceId;
     Log?: any;
     emitter?: EventEmitter;
     private connectedDevices;
     private deviceProtocol;
     private deviceProtocolHints;
+    private confirmedProtocolV2;
+    private deviceMtus;
+    private devicePacketCapacities;
     private v1Buffers;
     private v2Assemblers;
     private v2FrameQueues;
     private v2FramePromises;
     private protocolV2Links;
+    private warnedMissingRelease;
     private notificationCleanups;
+    private mtuCleanups;
     private disconnectCleanups;
     private notificationTokens;
     private nextNotificationToken;
@@ -51,7 +59,10 @@ export default class ElectronBleTransport {
         name: string | null;
         protocolType?: ProtocolType | undefined;
     }>;
-    release(id: string): Promise<void>;
+    release(id: string, _onclose?: boolean, keepSession?: boolean): Promise<void>;
+    disconnect(id: string): Promise<void>;
+    private releaseNative;
+    private releaseLogical;
     private createProtocolMismatchError;
     private createProtocolDetectionError;
     private clearProbeProtocol;
@@ -60,18 +71,21 @@ export default class ElectronBleTransport {
     private resetProbeStateAfterProtocolProbe;
     private probeProtocolV1;
     private probeProtocolV2;
-    private writeWithChunking;
     private writeOnce;
+    private refreshBlePacketCapacity;
+    private updateBlePacketCapacity;
+    private createMtuSubscription;
+    private writeProtocolV2Frame;
     private handleNotification;
     private handleProtocolV2Notification;
     private getProtocolV2FrameQueue;
     private resolveProtocolV2Frame;
-    private rejectAllProtocolV2Frames;
     private resetProtocolV2Frames;
     private rejectProtocolV2Frames;
     private readProtocolV2Frame;
     private handleProtocolV1Notification;
     call(uuid: string, name: string, data: Record<string, unknown>, options?: TransportCallOptions): Promise<import("@onekeyfe/hd-transport").MessageFromOneKey>;
+    post(uuid: string, name: string, data: Record<string, unknown>): Promise<void>;
     private callProtocolV1;
     private callProtocolV2;
     private createProtocolV2Adapter;

package/dist/electron-ble-transport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"electron-ble-transport.d.ts","sourceRoot":"","sources":["../src/electron-ble-transport.ts"],"names":[],"mappings":";AAoBA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,KAAK,EAAE,gBAAgB,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnG,OAAO,KAAK,YAAY,MAAM,QAAQ,CAAC;AAIvC,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,UAAU,CAAC,EAAE,UAAU,CAAC;KACzB;CACF;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,gBAAgB,CAAC,EAAE,YAAY,CAAC;CACjC,CAAC;AAqCF,MAAM,CAAC,OAAO,OAAO,oBAAoB;IACvC,OAAO,CAAC,SAAS,CAA0D;IAE3E,OAAO,CAAC,WAAW,CAA0D;IAE7E,IAAI,SAA0B;IAE9B,UAAU,UAAS;IAEnB,UAAU,EAAE,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,GAAG,IAAI,CAAQ;IAExD,GAAG,CAAC,EAAE,GAAG,CAAC;IAEV,OAAO,CAAC,EAAE,YAAY,CAAC;IAEvB,OAAO,CAAC,gBAAgB,CAA0B;IAElD,OAAO,CAAC,cAAc,CAAwC;IAE9D,OAAO,CAAC,mBAAmB,CAAwC;IAEnE,OAAO,CAAC,SAAS,CAAsE;IAEvF,OAAO,CAAC,YAAY,CAAoD;IAExE,OAAO,CAAC,aAAa,CAAwC;IAE7D,OAAO,CAAC,eAAe,CAAgD;IAEvE,OAAO,CAAC,eAAe,CAmBpB;IAEH,OAAO,CAAC,oBAAoB,CAAsC;IAElE,OAAO,CAAC,kBAAkB,CAAsC;IAEhE,OAAO,CAAC,kBAAkB,CAAkC;IAE5D,OAAO,CAAC,qBAAqB,CAAK;IAElC,OAAO,CAAC,oBAAoB;IA+B5B,OAAO,CAAC,kBAAkB;IA0B1B,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY;IAcxC,SAAS,CAAC,UAAU,EAAE,GAAG;IAKzB,mBAAmB,CAAC,UAAU,EAAE,GAAG;IAO7B,MAAM;IAIN,SAAS,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAqBxC,OAAO,CAAC,KAAK,EAAE,eAAe;;;;;;;;;;;IA0F9B,OAAO,CAAC,EAAE,EAAE,MAAM;IAgBxB,OAAO,CAAC,2BAA2B;IAOnC,OAAO,CAAC,4BAA4B;IAOpC,OAAO,CAAC,kBAAkB;YAMZ,cAAc;IA+C5B,OAAO,CAAC,8BAA8B;YAgBxB,iCAAiC;YAqCjC,eAAe;YAgBf,eAAe;YAuBf,iBAAiB;YAsBjB,SAAS;IASvB,OAAO,CAAC,kBAAkB;IAwB1B,OAAO,CAAC,4BAA4B;IAkBpC,OAAO,CAAC,uBAAuB;IAS/B,OAAO,CAAC,sBAAsB;IAU9B,OAAO,CAAC,yBAAyB;IAQjC,OAAO,CAAC,qBAAqB;IAK7B,OAAO,CAAC,sBAAsB;YAShB,mBAAmB;IAiBjC,OAAO,CAAC,4BAA4B;IAgB9B,IAAI,CACR,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,CAAC,EAAE,oBAAoB;YA2BlB,cAAc;YAuEd,cAAc;IA6B5B,OAAO,CAAC,uBAAuB;IA0C/B,OAAO,CAAC,6BAA6B;IAsCrC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;CAGxD"}
+{"version":3,"file":"electron-ble-transport.d.ts","sourceRoot":"","sources":["../src/electron-ble-transport.ts"],"names":[],"mappings":";AAsBA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,KAAK,EACV,gBAAgB,EAChB,YAAY,EAEZ,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,YAAY,MAAM,QAAQ,CAAC;AAIvC,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,UAAU,CAAC,EAAE,UAAU,CAAC;KACzB;CACF;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AAiCF,MAAM,CAAC,OAAO,OAAO,oBAAoB;IACvC,OAAO,CAAC,SAAS,CAA0D;IAE3E,OAAO,CAAC,WAAW,CAA0D;IAE7E,OAAO,CAAC,6BAA6B,CAAqB;IAE1D,IAAI,SAA0B;IAE9B,UAAU,UAAS;IAEnB,UAAU,EAAE,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,GAAG,IAAI,CAAQ;IAExD,OAAO,CAAC,kBAAkB,CAAuB;IAEjD,GAAG,CAAC,EAAE,GAAG,CAAC;IAEV,OAAO,CAAC,EAAE,YAAY,CAAC;IAEvB,OAAO,CAAC,gBAAgB,CAA0B;IAElD,OAAO,CAAC,cAAc,CAAwC;IAE9D,OAAO,CAAC,mBAAmB,CAAwC;IAGnE,OAAO,CAAC,mBAAmB,CAAqB;IAEhD,OAAO,CAAC,UAAU,CAAkC;IAEpD,OAAO,CAAC,sBAAsB,CAAkC;IAEhE,OAAO,CAAC,SAAS,CAAsE;IAEvF,OAAO,CAAC,YAAY,CAAoD;IAExE,OAAO,CAAC,aAAa,CAAwC;IAE7D,OAAO,CAAC,eAAe,CAAgD;IAEvE,OAAO,CAAC,eAAe,CAmBpB;IAGH,OAAO,CAAC,oBAAoB,CAAS;IAErC,OAAO,CAAC,oBAAoB,CAAsC;IAElE,OAAO,CAAC,WAAW,CAAsC;IAEzD,OAAO,CAAC,kBAAkB,CAAsC;IAEhE,OAAO,CAAC,kBAAkB,CAAkC;IAE5D,OAAO,CAAC,qBAAqB,CAAK;IAElC,OAAO,CAAC,oBAAoB;IA+B5B,OAAO,CAAC,kBAAkB;IAuC1B,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY;IAcxC,SAAS,CAAC,UAAU,EAAE,GAAG;IAKzB,mBAAmB,CAAC,UAAU,EAAE,GAAG;IAgB7B,MAAM;IAIN,SAAS,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAiBxC,OAAO,CAAC,KAAK,EAAE,eAAe;;;;;;;;;;;IAqG9B,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,OAAO;IAY7D,UAAU,CAAC,EAAE,EAAE,MAAM;YAKb,aAAa;YAiBb,cAAc;IAwB5B,OAAO,CAAC,2BAA2B;IAUnC,OAAO,CAAC,4BAA4B;IAOpC,OAAO,CAAC,kBAAkB;YAMZ,cAAc;IAoD5B,OAAO,CAAC,8BAA8B;YAgBxB,iCAAiC;YAwBjC,eAAe;YAkBf,eAAe;YAuBf,SAAS;YAST,wBAAwB;IAKtC,OAAO,CAAC,uBAAuB;IAc/B,OAAO,CAAC,qBAAqB;IAU7B,OAAO,CAAC,oBAAoB;IAqB5B,OAAO,CAAC,kBAAkB;IAwB1B,OAAO,CAAC,4BAA4B;IAkBpC,OAAO,CAAC,uBAAuB;IAS/B,OAAO,CAAC,sBAAsB;IAU9B,OAAO,CAAC,qBAAqB;IAI7B,OAAO,CAAC,sBAAsB;YAShB,mBAAmB;IAiBjC,OAAO,CAAC,4BAA4B;IAqB9B,IAAI,CACR,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,CAAC,EAAE,oBAAoB;IAuB1B,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;YAatD,cAAc;YAqFd,cAAc;IA0B5B,OAAO,CAAC,uBAAuB;IAyC/B,OAAO,CAAC,6BAA6B;IA4CrC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;CAGxD"}

package/dist/index.d.ts

@@ -1,51 +1,136 @@
 import * as _onekeyfe_hd_transport from '@onekeyfe/hd-transport';
-import _onekeyfe_hd_transport__default, { AcquireInput, TransportCallOptions, ProtocolType, OneKeyDeviceInfoBase, OneKeyDeviceInfo } from '@onekeyfe/hd-transport';
+import _onekeyfe_hd_transport__default, { ProtocolV2UsbTransportBase, AcquireInput, TransportCallOptions, ProtocolV2Schemas, ProtocolV2CallContext, ProtocolType, OneKeyDeviceInfoBase, OneKeyDeviceInfo } from '@onekeyfe/hd-transport';
 import { Deferred } from '@onekeyfe/hd-shared';
 import { DesktopAPI } from '@onekeyfe/hd-transport-electron';
 import EventEmitter from 'events';
 
+/**
+ * Device information with path and WebUSB device instance
+ */
 interface DeviceInfo extends OneKeyDeviceInfoBase {
     path: string;
     device: USBDevice;
     protocolType?: ProtocolType;
 }
-declare class WebUsbTransport {
+declare class WebUsbTransport extends ProtocolV2UsbTransportBase<string> {
     messages: ReturnType<typeof _onekeyfe_hd_transport__default.parseConfigure> | undefined;
+    /** Protobuf schema for Protocol V2 transports. */
     messagesV2: ReturnType<typeof _onekeyfe_hd_transport__default.parseConfigure> | undefined;
+    private protocolV2SchemaSource;
+    /** Per-path protocol type detected by active wire-level probe. */
     private deviceProtocol;
     private deviceProtocolHints;
-    private protocolV2Assemblers;
-    private protocolV2Sessions;
-    private protocolV2ReadTimeouts;
+    /**
+     * Paths whose cached protocol must be re-probed on the next acquire (a USB
+     * disconnect was seen, or a transfer-level reconnect happened mid-call).
+     */
+    private staleProtocolPaths;
+    /** Paths currently acquired (between a successful acquire() and its release()). */
+    private acquiredPaths;
+    /**
+     * The exact USBDevice object each cached protocol was probed against. The
+     * browser returns the same object identity for a device as long as it stays
+     * connected, and a replug/reboot always yields a new object — so an identity
+     * mismatch proves the device was re-enumerated since the probe, even when the
+     * disconnect event itself was delayed or missed.
+     */
+    private probedDeviceObjects;
+    /** Per-path USB endpoint / interface numbers (discovered from USB descriptors) */
     private deviceEndpoints;
-    private mockSerialPaths;
-    private mockSerialCounter;
     name: string;
     stopped: boolean;
     configured: boolean;
     Log?: any;
     usb?: USB;
+    /**
+     * Cached list of connected devices
+     * This is essential for maintaining device references between operations
+     */
     deviceList: Array<DeviceInfo>;
     configurationId: number;
     endpointId: number;
     interfaceId: number;
+    constructor();
+    /**
+     * Initialize WebUSB transport
+     */
     init(logger: any): void;
+    /**
+     * Protocol type is a property of the physical device keyed by USB serial number.
+     * It can only change across a device reboot (e.g. normal ↔ bootloader mode), and
+     * a reboot always surfaces as a USB disconnect. Disconnects (and transfer-level
+     * reconnects, which cover a missed disconnect event) only MARK the cached probe
+     * result stale instead of deleting it: an in-flight session keeps using the old
+     * value so the transfer-level reconnect retries can absorb a transient
+     * re-enumeration exactly as they did before the cache existed, while the next
+     * acquire re-probes from scratch.
+     */
+    markProtocolStale(path: string): void;
+    /**
+     * Configure Protocol V1 protobuf schema (legacy chunked 0x3F framing).
+     */
     configure(signedData: any): void;
+    /**
+     * Cache the Protocol V2 protobuf schema.
+     */
     configureProtocolV2(signedData: any): void;
+    /**
+     * Request user to select a device
+     * This method must be called in response to a user action
+     * to comply with WebUSB security requirements
+     */
     promptDeviceAccess(): Promise<USBDevice | null>;
+    /**
+     * Enumerate already connected devices
+     * This method only returns devices that are already authorized by the browser
+     * It does NOT prompt the user to select a device
+     */
     enumerate(): Promise<DeviceInfo[]>;
-    private getDevicePath;
+    /**
+     * Get list of connected devices
+     */
     getConnectedDevices(): Promise<DeviceInfo[]>;
+    /**
+     * Acquire device control
+     */
     acquire(input: AcquireInput): Promise<string | undefined>;
+    /**
+     * Determine protocol type after connect.
+     * Probe Protocol V1 first with Initialize. If it does not answer in time,
+     * fall back to a Protocol V2 Ping probe.
+     */
     private createProtocolMismatchError;
+    private createProtocolProbeTimeoutError;
     private createProtocolDetectionError;
     private detectProtocol;
+    /**
+     * Find device by path
+     */
     findDevice(path: string): Promise<USBDevice>;
+    /**
+     * Connect to device with retry mechanism
+     */
     connect(path: string, first: boolean): Promise<void>;
+    /**
+     * Discover vendor-class (0xFF) interface and its IN/OUT endpoint numbers from USB descriptors.
+     * Falls back to legacy hardcoded values if no vendor interface is found.
+     */
     private discoverEndpoints;
+    /**
+     * Connect to specific device.
+     * Discovers interface/endpoint numbers from USB descriptors on first connection.
+     */
     connectToDevice(path: string, first: boolean): Promise<void>;
     private closeOpenDevice;
     private clearEndpointHalt;
+    /**
+     * With the protocol cache surviving release(), deviceProtocol presence no
+     * longer implies an active session. Guard call()/post() explicitly so a
+     * post-release straggler fails fast instead of silently reopening the device
+     * and driving it outside any session (pre-cache behavior: the deleted
+     * protocol entry produced the same fail-fast).
+     */
+    private assertAcquired;
     post(session: string, name: string, data: Record<string, unknown>): Promise<void>;
     private getErrorMessage;
     private isRetryablePacketIoError;
@@ -55,16 +140,43 @@ declare class WebUsbTransport {
     private transferOutWithRetry;
     private transferOutOnce;
     private transferInWithRetry;
+    private transferInOnce;
+    private closeConnectionAfterProbe;
     private resetConnectionAfterProbe;
     private withProtocolReadTimeout;
     private probeProtocolV1;
     private probeProtocolV2;
+    /**
+     * Call device method — branches to Protocol V1 or Protocol V2 based on active probe.
+     */
     call(path: string, name: string, data: Record<string, unknown>, options?: TransportCallOptions): Promise<_onekeyfe_hd_transport.MessageFromOneKey>;
     private callProtocolV1;
+    /**
+     * Send/receive a single call over Protocol V2 (0x5A framing).
+     *
+     * Encoding:  protobuf message → 2-byte LE messageTypeId + pb bytes → Protocol V2 frame
+     * Decoding:  Protocol V2 frame → messageTypeId + pb bytes → protobuf message
+     */
     private callProtocolV2;
-    private receiveProtocolV2Frame;
+    /**
+     * Receive data from device
+     */
     receiveData(path: string, timeoutMs?: number): Promise<string>;
+    /**
+     * Release device
+     */
     release(path: string): Promise<void>;
+    protected getProtocolV2UsbSchemas(): ProtocolV2Schemas;
+    protected getProtocolV2UsbLogger(): any;
+    protected writeProtocolV2UsbPacket(path: string, frame: Uint8Array, _context: ProtocolV2CallContext): Promise<void>;
+    protected readProtocolV2UsbPacket(path: string, _context: ProtocolV2CallContext): Promise<Uint8Array>;
+    protected resetProtocolV2UsbNativeLink(path: string, _reason: string): Promise<void>;
+    protected onProtocolV2UsbLinkInvalidated(path: string, reason: string): void;
+    protected createProtocolV2UsbTimeoutError(name: string, timeoutMs: number): Error;
+    /**
+     * Expose the detected protocol type for a given device path.
+     * Used by upper layers (e.g. TransportManager) to select the correct schema.
+     */
     getProtocolType(path: string): ProtocolType | undefined;
 }
 
@@ -77,24 +189,40 @@ type BleAcquireInput = {
     uuid: string;
     forceCleanRunPromise?: boolean;
     expectedProtocol?: ProtocolType;
+    protocolHint?: ProtocolType;
 };
+/**
+ * Desktop Electron BLE transport with automatic Protocol V1/V2 detection.
+ *
+ * Protocol V1 devices continue using chunked packets. Protocol V2 is detected
+ * after a Protocol V1 GetFeatures timeout by probing Protocol V2 Ping.
+ */
 declare class ElectronBleTransport {
     private _messages;
     private _messagesV2;
+    private protocolV2SchemaConfiguration;
     name: string;
     configured: boolean;
     runPromise: Deferred<Uint8Array | string> | null;
+    private runPromiseDeviceId;
     Log?: any;
     emitter?: EventEmitter;
     private connectedDevices;
     private deviceProtocol;
     private deviceProtocolHints;
+    /** Endpoints that answered a V2 probe in this transport lifetime. Survives disconnect. */
+    private confirmedProtocolV2;
+    private deviceMtus;
+    private devicePacketCapacities;
     private v1Buffers;
     private v2Assemblers;
     private v2FrameQueues;
     private v2FramePromises;
     private protocolV2Links;
+    /** One-shot guard so a missing preload `release` bridge is reported once. */
+    private warnedMissingRelease;
     private notificationCleanups;
+    private mtuCleanups;
     private disconnectCleanups;
     private notificationTokens;
     private nextNotificationToken;
@@ -116,7 +244,10 @@ declare class ElectronBleTransport {
         name: string | null;
         protocolType?: ProtocolType | undefined;
     }>;
-    release(id: string): Promise<void>;
+    release(id: string, _onclose?: boolean, keepSession?: boolean): Promise<void>;
+    disconnect(id: string): Promise<void>;
+    private releaseNative;
+    private releaseLogical;
     private createProtocolMismatchError;
     private createProtocolDetectionError;
     private clearProbeProtocol;
@@ -125,18 +256,21 @@ declare class ElectronBleTransport {
     private resetProbeStateAfterProtocolProbe;
     private probeProtocolV1;
     private probeProtocolV2;
-    private writeWithChunking;
     private writeOnce;
+    private refreshBlePacketCapacity;
+    private updateBlePacketCapacity;
+    private createMtuSubscription;
+    private writeProtocolV2Frame;
     private handleNotification;
     private handleProtocolV2Notification;
     private getProtocolV2FrameQueue;
     private resolveProtocolV2Frame;
-    private rejectAllProtocolV2Frames;
     private resetProtocolV2Frames;
     private rejectProtocolV2Frames;
     private readProtocolV2Frame;
     private handleProtocolV1Notification;
     call(uuid: string, name: string, data: Record<string, unknown>, options?: TransportCallOptions): Promise<_onekeyfe_hd_transport.MessageFromOneKey>;
+    post(uuid: string, name: string, data: Record<string, unknown>): Promise<void>;
     private callProtocolV1;
     private callProtocolV2;
     private createProtocolV2Adapter;