npm - @ledgerhq/hw-transport-node-hid-singleton - Versions diffs - 6.30.2 → 6.30.3-start-exchange.0 - Mend

@ledgerhq/hw-transport-node-hid-singleton 6.30.2 → 6.30.3-start-exchange.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

package/CHANGELOG.md +14 -0
package/README.md +28 -6
package/lib/TransportNodeHid.d.ts +19 -8
package/lib/TransportNodeHid.d.ts.map +1 -1
package/lib/TransportNodeHid.js +102 -83
package/lib/TransportNodeHid.js.map +1 -1
package/lib-es/TransportNodeHid.d.ts +19 -8
package/lib-es/TransportNodeHid.d.ts.map +1 -1
package/lib-es/TransportNodeHid.js +103 -84
package/lib-es/TransportNodeHid.js.map +1 -1
package/package.json +3 -3
package/src/TransportNodeHid.ts +122 -76

package/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,19 @@
 # @ledgerhq/hw-transport-node-hid-singleton
+## 6.30.3-start-exchange.0
+### Patch Changes
+- [#5749](https://github.com/LedgerHQ/ledger-live/pull/5749) [`eadebff`](https://github.com/LedgerHQ/ledger-live/commit/eadebff3fe58aef6a5befb033d5147afc49663d3) Thanks [@alexandremgo](https://github.com/alexandremgo)! - Fix: HID USB reconnection on LLD during the sync onboarding
+  - Refactoring of the disconnect after inactivity of the transport implementation
+    hw-transport-node-hid-singleton
+  - Better logs and documentation
+- Updated dependencies [[`eadebff`](https://github.com/LedgerHQ/ledger-live/commit/eadebff3fe58aef6a5befb033d5147afc49663d3)]:
+  - @ledgerhq/hw-transport-node-hid-noevents@6.29.3-start-exchange.0
+  - @ledgerhq/hw-transport@6.30.3-start-exchange.0
 ## 6.30.2
 ### Patch Changes

package/README.md CHANGED Viewed

@@ -34,14 +34,16 @@ For a smooth and quick integration:
     *   [Examples](#examples)
     *   [exchange](#exchange)
         *   [Parameters](#parameters-1)
+    *   [close](#close)
     *   [isSupported](#issupported)
     *   [list](#list)
     *   [listen](#listen)
         *   [Parameters](#parameters-2)
-    *   [autoDisconnect](#autodisconnect)
+    *   [setDisconnectAfterInactivityTimeout](#setdisconnectafterinactivitytimeout)
     *   [disconnect](#disconnect)
     *   [open](#open)
         *   [Parameters](#parameters-3)
+*   [onDisconnect](#ondisconnect)
 ### TransportNodeHidSingleton
@@ -66,7 +68,7 @@ TransportNodeHid.create().then(transport => ...)
 #### exchange
-Exchange with the device using APDU protocol.
+Exchanges with the device using APDU protocol
 ##### Parameters
@@ -74,6 +76,15 @@ Exchange with the device using APDU protocol.
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Buffer](https://nodejs.org/api/buffer.html)>** a promise of apdu response
+#### close
+Closes the transport instance by triggering a disconnection after some inactivity (no new `open`).
+Intentionally not disconnecting the device/closing the hid connection directly:
+The HID connection will only be closed after some inactivity.
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<void>**&#x20;
 #### isSupported
 #### list
@@ -86,15 +97,18 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 Returns **Subscription**&#x20;
-#### autoDisconnect
+#### setDisconnectAfterInactivityTimeout
-convenience wrapper for auto-disconnect logic
+Disconnects device from singleton instance after some inactivity (no new `open`).
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<void>**&#x20;
+Currently, there is only one transport instance (for only one device connected via USB).
 #### disconnect
-globally disconnect the transport singleton
+Disconnects from the HID device associated to the transport singleton.
+If you want to try to re-use the same transport instance at the next action (when calling `open` again), you can use
+the transport instance `close` method: it will only enable a disconnect after some inactivity.
 #### open
@@ -112,3 +126,11 @@ Legacy: `_descriptor` is needed to follow the Transport definition
 *   `context` **TraceContext?**&#x20;
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[TransportNodeHidSingleton](#transportnodehidsingleton)>**&#x20;
+### onDisconnect
+Disconnect event received from the transport instance.
+It could be after a disconnection coming from the HID library (e.g. device unplugged) or from the transport instance itself (e.g. close).
+Clearing the singleton instance.
+Currently, only 1 device at a time is supported.

package/lib/TransportNodeHid.d.ts CHANGED Viewed

@@ -3,7 +3,7 @@ import HID from "node-hid";
 import TransportNodeHidNoEvents from "@ledgerhq/hw-transport-node-hid-noevents";
 import type { Observer, DescriptorEvent, Subscription } from "@ledgerhq/hw-transport";
 import { TraceContext } from "@ledgerhq/logs";
-export type ListenDescriptorEvent = DescriptorEvent<any>;
+export type ListenDescriptorEvent = DescriptorEvent<string>;
 /**
  * node-hid Transport implementation
  * @example
@@ -12,7 +12,6 @@ export type ListenDescriptorEvent = DescriptorEvent<any>;
  * TransportNodeHid.create().then(transport => ...)
  */
 export default class TransportNodeHidSingleton extends TransportNodeHidNoEvents {
-    preventAutoDisconnect: boolean;
     constructor(device: HID.HID, { context }?: {
         context?: TraceContext;
     });
@@ -27,14 +26,21 @@ export default class TransportNodeHidSingleton extends TransportNodeHidNoEvents
     /**
      */
     static listen: (observer: Observer<ListenDescriptorEvent>) => Subscription;
+    static disconnectAfterInactivityTimeout: ReturnType<typeof setTimeout> | undefined;
+    static clearDisconnectAfterInactivityTimeout(): void;
     /**
-     * convenience wrapper for auto-disconnect logic
+     * Disconnects device from singleton instance after some inactivity (no new `open`).
+     *
+     * Currently, there is only one transport instance (for only one device connected via USB).
      */
-    static autoDisconnect(): Promise<void>;
+    static setDisconnectAfterInactivityTimeout(): void;
     /**
-     * globally disconnect the transport singleton
+     * Disconnects from the HID device associated to the transport singleton.
+     *
+     * If you want to try to re-use the same transport instance at the next action (when calling `open` again), you can use
+     * the transport instance `close` method: it will only enable a disconnect after some inactivity.
      */
-    static disconnect(): Promise<void>;
+    static disconnect(): void;
     /**
      * Connects to the first Ledger device connected via USB
      *
@@ -44,14 +50,19 @@ export default class TransportNodeHidSingleton extends TransportNodeHidNoEvents
      * Legacy: `_descriptor` is needed to follow the Transport definition
      */
     static open(_descriptor: string, _timeoutMs?: number, context?: TraceContext): Promise<TransportNodeHidSingleton>;
-    setAllowAutoDisconnect(allow: boolean): void;
     /**
-     * Exchange with the device using APDU protocol.
+     * Exchanges with the device using APDU protocol
      *
      * @param apdu
      * @returns a promise of apdu response
      */
     exchange(apdu: Buffer): Promise<Buffer>;
+    /**
+     * Closes the transport instance by triggering a disconnection after some inactivity (no new `open`).
+     *
+     * Intentionally not disconnecting the device/closing the hid connection directly:
+     * The HID connection will only be closed after some inactivity.
+     */
     close(): Promise<void>;
 }
 //# sourceMappingURL=TransportNodeHid.d.ts.map

package/lib/TransportNodeHid.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"TransportNodeHid.d.ts","sourceRoot":"","sources":["../src/TransportNodeHid.ts"],"names":[],"mappings":";AAAA,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,wBAAwC,MAAM,0CAA0C,CAAC;AAChG,OAAO,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtF,OAAO,EAAe,YAAY,~~EAAO~~,MAAM,gBAAgB,CAAC;~~AAyBhE~~,MAAM,MAAM,qBAAqB,GAAG,eAAe,CAAC,~~GAAG~~,CAAC,CAAC;~~AAEzD~~;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,yBAA0B,SAAQ,wBAAwB;~~IAC7E~~,~~qBAAqB,UAAS;gBAElB,~~MAAM,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,GAAE;QAAE,OAAO,CAAC,EAAE,YAAY,CAAA;KAAO;IAIzE;;OAEG;IACH,MAAM,CAAC,WAAW,yBAAwC;IAE1D;;OAEG;IACH,MAAM,CAAC,IAAI,qBAAiC;IAE5C;OACG;IACH,MAAM,CAAC,MAAM,aAAc,SAAS,qBAAqB,CAAC,KAAG,YAAY,CAqDvE;IAEF~~;;OAEG;WACU~~,~~cAAc~~,~~IAAI~~,OAAO,CAAC,~~IAAI~~,CAAC;~~IAW5C;;OAEG~~;~~WACU~~,UAAU;~~IASvB~~;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACT,WAAW,EAAE,MAAM,EACnB,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,yBAAyB,CAAC;~~IAyCrC,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAI5C~~;;;;;OAKG;~~IACG~~,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;~~IAO7C~~,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;~~CAMvB~~"}
1	+ {"version":3,"file":"TransportNodeHid.d.ts","sourceRoot":"","sources":["../src/TransportNodeHid.ts"],"names":[],"mappings":";AAAA,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,wBAAwC,MAAM,0CAA0C,CAAC;AAChG,OAAO,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtF,OAAO,EAAe,YAAY,EAAS,MAAM,gBAAgB,CAAC;AAWlE,MAAM,MAAM,qBAAqB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;AAE5D;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,yBAA0B,SAAQ,wBAAwB;gBACjE,MAAM,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,GAAE;QAAE,OAAO,CAAC,EAAE,YAAY,CAAA;KAAO;IAIzE;;OAEG;IACH,MAAM,CAAC,WAAW,yBAAwC;IAE1D;;OAEG;IACH,MAAM,CAAC,IAAI,qBAAiC;IAE5C;OACG;IACH,MAAM,CAAC,MAAM,aAAc,SAAS,qBAAqB,CAAC,KAAG,YAAY,CAqDvE;IAEF,MAAM,CAAC,gCAAgC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,GAAG,SAAS,CAAC;IACnF,MAAM,CAAC,qCAAqC;IAM5C;;;;OAIG;IACH,MAAM,CAAC,mCAAmC;IAiB1C;;;;;OAKG;IACH,MAAM,CAAC,UAAU;IAsBjB;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACT,WAAW,EAAE,MAAM,EACnB,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,yBAAyB,CAAC;IAkErC;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvC;;;;;OAKG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAavB"}

package/lib/TransportNodeHid.js CHANGED Viewed

@@ -22,15 +22,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -43,17 +34,7 @@ const errors_1 = require("@ledgerhq/errors");
 const listenDevices_1 = require("./listenDevices");
 const LOG_TYPE = "hid-verbose";
 let transportInstance = null;
-const DISCONNECT_TIMEOUT = 5000;
-let disconnectTimeout;
-const clearDisconnectTimeout = () => {
-    if (disconnectTimeout) {
-        clearTimeout(disconnectTimeout);
-    }
-};
-const setDisconnectTimeout = () => {
-    clearDisconnectTimeout();
-    disconnectTimeout = setTimeout(() => TransportNodeHidSingleton.autoDisconnect(), DISCONNECT_TIMEOUT);
-};
+const DISCONNECT_AFTER_INACTIVITY_TIMEOUT_MS = 5000;
 /**
  * node-hid Transport implementation
  * @example
@@ -64,36 +45,56 @@ const setDisconnectTimeout = () => {
 class TransportNodeHidSingleton extends hw_transport_node_hid_noevents_1.default {
     constructor(device, { context } = {}) {
         super(device, { context, logType: LOG_TYPE });
-        this.preventAutoDisconnect = false;
+    }
+    static clearDisconnectAfterInactivityTimeout() {
+        if (TransportNodeHidSingleton.disconnectAfterInactivityTimeout) {
+            clearTimeout(TransportNodeHidSingleton.disconnectAfterInactivityTimeout);
+        }
     }
     /**
-     * convenience wrapper for auto-disconnect logic
+     * Disconnects device from singleton instance after some inactivity (no new `open`).
+     *
+     * Currently, there is only one transport instance (for only one device connected via USB).
      */
-    static autoDisconnect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (transportInstance && !transportInstance.preventAutoDisconnect) {
-                (0, logs_1.log)("hid-verbose", "triggering auto disconnect");
+    static setDisconnectAfterInactivityTimeout() {
+        TransportNodeHidSingleton.clearDisconnectAfterInactivityTimeout();
+        TransportNodeHidSingleton.disconnectAfterInactivityTimeout = setTimeout(() => {
+            (0, logs_1.trace)({
+                type: LOG_TYPE,
+                message: "Disconnecting after inactivity, if not prevented",
+                data: {
+                    hasInstance: Boolean(transportInstance),
+                },
+            });
+            if (transportInstance) {
                 TransportNodeHidSingleton.disconnect();
             }
-            else if (transportInstance) {
-                // If we have disabled the auto-disconnect, try again in DISCONNECT_TIMEOUT
-                clearDisconnectTimeout();
-                setDisconnectTimeout();
-            }
-        });
+        }, DISCONNECT_AFTER_INACTIVITY_TIMEOUT_MS);
     }
     /**
-     * globally disconnect the transport singleton
+     * Disconnects from the HID device associated to the transport singleton.
+     *
+     * If you want to try to re-use the same transport instance at the next action (when calling `open` again), you can use
+     * the transport instance `close` method: it will only enable a disconnect after some inactivity.
      */
     static disconnect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (transportInstance) {
-                transportInstance.device.close();
-                transportInstance.emit("disconnect");
-                transportInstance = null;
-            }
-            clearDisconnectTimeout();
+        (0, logs_1.trace)({
+            type: LOG_TYPE,
+            message: "Disconnecting from HID device",
+            data: {
+                hasInstance: Boolean(transportInstance),
+            },
         });
+        TransportNodeHidSingleton.clearDisconnectAfterInactivityTimeout();
+        if (transportInstance) {
+            transportInstance.device.close();
+            (0, logs_1.trace)({
+                type: LOG_TYPE,
+                message: `Closed HID communication with device. Emitting "disconnect" event from static disconnect and clearing singleton instance`,
+            });
+            transportInstance.emit("disconnect");
+            transportInstance = null;
+        }
     }
     /**
      * Connects to the first Ledger device connected via USB
@@ -105,61 +106,79 @@ class TransportNodeHidSingleton extends hw_transport_node_hid_noevents_1.default
      */
     static open(_descriptor, _timeoutMs, context) {
         const tracer = new logs_1.LocalTracer(LOG_TYPE, context);
-        clearDisconnectTimeout();
-        return Promise.resolve().then(() => {
+        TransportNodeHidSingleton.clearDisconnectAfterInactivityTimeout();
+        if (transportInstance) {
+            tracer.trace("Reusing already opened transport instance");
+            return Promise.resolve(transportInstance);
+        }
+        const devicesDetectedDuringOpen = (0, hw_transport_node_hid_noevents_1.getDevices)();
+        tracer.trace(`Devices detected during open: ${devicesDetectedDuringOpen.length}`, {
+            devicesDetectedDuringOpen,
+        });
+        if (devicesDetectedDuringOpen.length === 0) {
+            return Promise.reject(new errors_1.CantOpenDevice("No device found"));
+        }
+        const device = devicesDetectedDuringOpen[0];
+        tracer.trace("Found a device, creating HID transport instance ...", { device });
+        let HIDDevice;
+        try {
+            HIDDevice = new node_hid_1.default.HID(device.path);
+        }
+        catch (error) {
+            tracer.trace(`Error while connecting to device: ${error}`, { error });
+            return Promise.reject(error);
+        }
+        transportInstance = new TransportNodeHidSingleton(HIDDevice, {
+            context,
+        });
+        const clearDeviceEventsListener = (0, listenDevices_1.listenDevices)(() => { }, () => {
+            // Assumes any ledger disconnection concerns current transport
             if (transportInstance) {
-                tracer.trace("Reusing already opened transport instance");
-                return transportInstance;
+                tracer.trace("Listened to on remove device event. Emitting a disconnect");
+                transportInstance.emit("disconnect");
             }
-            const device = (0, hw_transport_node_hid_noevents_1.getDevices)()[0];
-            if (!device)
-                throw new errors_1.CantOpenDevice("no device found");
-            tracer.trace("Found a device, creating HID transport instance ...", { device });
-            transportInstance = new TransportNodeHidSingleton(new node_hid_1.default.HID(device.path), {
-                context,
-            });
-            const unlisten = (0, listenDevices_1.listenDevices)(() => { }, () => {
-                // Assumes any ledger disconnection concerns current transport
-                if (transportInstance) {
-                    transportInstance.emit("disconnect");
-                }
-            });
-            const onDisconnect = () => {
-                if (!transportInstance)
-                    return;
-                tracer.trace("Device was disconnected, clearing transport instance ...");
-                transportInstance.off("disconnect", onDisconnect);
-                transportInstance = null;
-                unlisten();
-            };
-            transportInstance.on("disconnect", onDisconnect);
-            return transportInstance;
         });
-    }
-    setAllowAutoDisconnect(allow) {
-        this.preventAutoDisconnect = !allow;
+        /**
+         * Disconnect event received from the transport instance.
+         *
+         * It could be after a disconnection coming from the HID library (e.g. device unplugged) or from the transport instance itself (e.g. close).
+         * Clearing the singleton instance.
+         * Currently, only 1 device at a time is supported.
+         */
+        const onDisconnect = () => {
+            if (!transportInstance) {
+                tracer.trace("disconnect event without transport instance, ignoring ...");
+                return;
+            }
+            this.clearDisconnectAfterInactivityTimeout();
+            transportInstance.off("disconnect", onDisconnect);
+            transportInstance = null;
+            clearDeviceEventsListener();
+        };
+        transportInstance.on("disconnect", onDisconnect);
+        return Promise.resolve(transportInstance);
     }
     /**
-     * Exchange with the device using APDU protocol.
+     * Exchanges with the device using APDU protocol
      *
      * @param apdu
      * @returns a promise of apdu response
      */
     exchange(apdu) {
-        const _super = Object.create(null, {
-            exchange: { get: () => super.exchange }
-        });
-        return __awaiter(this, void 0, void 0, function* () {
-            clearDisconnectTimeout();
-            const result = yield _super.exchange.call(this, apdu);
-            setDisconnectTimeout();
-            return result;
-        });
+        return super.exchange(apdu);
     }
+    /**
+     * Closes the transport instance by triggering a disconnection after some inactivity (no new `open`).
+     *
+     * Intentionally not disconnecting the device/closing the hid connection directly:
+     * The HID connection will only be closed after some inactivity.
+     */
     close() {
-        // intentionally, a close will not effectively close the hid connection but
-        // will allow an auto-disconnection after some inactivity
-        this.preventAutoDisconnect = false;
+        this.tracer.trace("Closing transport instance by triggering a disconnection after some inactivity", {
+            hasInstance: !!transportInstance,
+            disconnectAfterInactivityTimeoutMs: DISCONNECT_AFTER_INACTIVITY_TIMEOUT_MS,
+        });
+        TransportNodeHidSingleton.setDisconnectAfterInactivityTimeout();
         return Promise.resolve();
     }
 }

package/lib/TransportNodeHid.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"TransportNodeHid.js","sourceRoot":"","sources":["../src/TransportNodeHid.ts"],"names":[],"mappings":"~~;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;~~AAAA,wDAA2B;AAC3B,2GAAgG;AAEhG,~~yCAAgE~~;~~AAChE~~,+CAAyD;AACzD,6CAAkD;AAClD,mDAAgD;AAEhD,MAAM,QAAQ,GAAG,aAAa,CAAC;AAE/B,IAAI,iBAAiB,GAAqC,IAAI,CAAC;AAE/D,MAAM,~~kBAAkB~~,GAAG,IAAI,CAAC;~~AAChC~~,~~IAAI~~,~~iBAAiB~~,~~CAAC~~;~~AACtB~~,~~MAAM~~,~~sBAAsB~~,~~GAAG~~,~~GAAG,~~EAAE~~;IAClC~~,~~IAAI~~,~~iBAAiB~~,EAAE;~~QACrB~~,~~YAAY~~,CAAC,~~iBAAiB~~,CAAC,CAAC;~~KACjC~~;~~AACH~~,CAAC,~~CAAC~~;~~AAEF~~,~~MAAM~~,~~oBAAoB~~,~~GAAG~~,~~GAAG~~,EAAE;~~IAChC~~,~~sBAAsB~~,~~EAAE~~,CAAC;~~IACzB~~,~~iBAAiB~~,~~GAAG~~,~~UAAU~~,~~CAC5B~~,~~GAAG~~,EAAE,CAAC,yBAAyB,CAAC,~~cAAc~~,~~EAAE~~,~~EAChD~~,~~kBAAkB~~,~~CACnB~~,~~CAAC~~;~~AACJ~~,~~CAAC~~,~~CAAC~~;~~AAIF;;;;;;GAMG~~;~~AACH~~,~~MAAqB~~,~~yBAA0B~~,~~SAAQ,wCAAwB~~;~~IAG7E~~,~~YAAY~~,~~MAAe,~~EAAE,EAAE,OAAO,~~KAAiC~~,~~EAAE~~;~~QACvE~~,~~KAAK~~,CAAC,~~MAAM~~,~~EAAE~~,EAAE,~~OAAO~~,~~EAAE~~,~~OAAO~~,EAAE,~~QAAQ,EAAE,~~CAAC,CAAC~~;QAHhD~~,~~0BAAqB~~,~~GAAG~~,~~KAAK~~,CAAC;~~IAI9B~~,CAAC;~~IAqED;;OAEG~~;IACH,MAAM,~~CAAO~~,~~cAAc;;YACzB~~,~~IAAI~~,~~iBAAiB~~,IAAI,~~CAAC~~,~~iBAAiB~~,~~CAAC~~,~~qBAAqB~~,EAAE;~~gBACjE~~,~~IAAA~~,~~UAAG~~,~~EAAC~~,~~aAAa~~,~~EAAE~~,~~4BAA4B~~,CAAC,CAAC;~~gBACjD~~,yBAAyB,CAAC,~~UAAU~~,EAAE,CAAC;~~aACxC;iBAAM~~,IAAI,iBAAiB,EAAE;~~gBAC5B~~,~~2EAA2E;gBAC3E~~,~~sBAAsB~~,~~EAAE~~,CAAC~~;gBACzB~~,~~oBAAoB~~,EAAE,CAAC;~~aACxB;QACH~~,~~CAAC;KAAA;IAED;;OAEG;IACH~~,~~MAAM~~,~~CAAO~~,~~UAAU;;YACrB,~~IAAI,~~iBAAiB~~,~~EAAE~~;~~gBACrB~~,~~iBAAiB~~,~~CAAC~~,~~MAAM~~,CAAC,~~KAAK,EAAE,~~CAAC;~~gBACjC~~,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;~~gBACrC~~,iBAAiB,GAAG,IAAI,CAAC;~~aAC1B~~;~~YACD~~,~~sBAAsB,EAAE,~~CAAC;~~QAC3B,CAAC;KAAA;~~IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACT,WAAmB,EACnB,UAAmB,EACnB,OAAsB;QAEtB,MAAM,MAAM,GAAG,IAAI,kBAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAClD,~~sBAAsB~~,~~EAAE,~~CAAC~~;QAEzB~~,~~OAAO~~,~~OAAO,CAAC,OAAO,~~EAAE,CAAC~~,IAAI,CAAC,GAAG,EAAE~~;~~YACjC~~,IAAI,iBAAiB,EAAE;~~gBACrB~~,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAC;~~gBAC1D~~,OAAO,iBAAiB,CAAC;~~aAC1B~~;~~YAED~~,MAAM,~~MAAM~~,GAAG,IAAA,2CAAU,GAAE,CAAC,CAAC,CAAC,CAAC;~~YAC/B~~,IAAI,CAAC,MAAM;~~gBAAE~~,MAAM,IAAI,uBAAc,CAAC,iBAAiB,CAAC,CAAC;~~YAEzD~~,MAAM,CAAC,KAAK,CAAC,qDAAqD,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;~~YAChF~~,~~iBAAiB~~,~~GAAG~~,IAAI,~~yBAAyB~~,~~CAAC~~,IAAI,kBAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAc,CAAC,EAAE;~~gBACpF~~,OAAO;~~aACR~~,CAAC,CAAC;~~YAEH~~,MAAM,~~QAAQ~~,GAAG,IAAA,6BAAa,~~EAC5B~~,GAAG,EAAE,GAAE,CAAC,EACR,GAAG,EAAE;~~gBACH~~,8DAA8D;~~gBAC9D~~,IAAI,iBAAiB,EAAE;~~oBACrB~~,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;~~iBACtC~~;~~YACH~~,CAAC,CACF,CAAC;~~YAEF~~,MAAM,YAAY,GAAG,GAAG,EAAE;~~gBACxB~~,IAAI,CAAC,iBAAiB~~;oBAAE~~,~~OAAO~~;~~gBAC/B~~,MAAM,CAAC,KAAK,CAAC,~~0DAA0D~~,CAAC,CAAC;~~gBACzE~~,iBAAiB,CAAC,GAAG,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;~~gBAClD~~,iBAAiB,GAAG,IAAI,CAAC;~~gBACzB~~,~~QAAQ~~,EAAE,CAAC;~~YACb~~,CAAC,CAAC;~~YAEF~~,iBAAiB,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;~~YACjD~~,OAAO,~~iBAAiB~~,CAAC~~;QAC3B~~,CAAC,CAAC,CAAC;~~IACL~~,CAAC;IAED,~~sBAAsB~~,CAAC,~~KAAc~~;~~QACnC~~,~~IAAI~~,CAAC,~~qBAAqB~~,~~GAAG,~~CAAC,~~KAAK~~,CAAC;~~IACtC~~,CAAC;IAED;;;;;OAKG;~~IACG~~,~~QAAQ~~,~~CAAC~~,~~IAAY;;;;;YACzB,sBAAsB,EAAE,~~CAAC~~;YACzB~~,MAAM,~~MAAM~~,~~GAAG~~,~~MAAM~~,~~OAAM~~,~~QAAQ~~,~~YAAC~~,~~IAAI~~,CAAC,CAAC;~~YAC1C~~,~~oBAAoB~~,EAAE,~~CAAC~~;~~YACvB~~,~~OAAO~~,~~MAAM,~~CAAC;~~QAChB~~,~~CAAC;KAAA;IAED~~,~~KAAK;QACH,2EAA2E;QAC3E,yDAAyD;QACzD,IAAI,~~CAAC,~~qBAAqB~~,~~GAAG~~,~~KAAK,~~CAAC;~~QACnC~~,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;;~~AAxKD~~;;GAEG;AACI,qCAAW,GAAG,wCAAwB,CAAC,WAAW,~~AAAvC,CAAwC~~;AAE1D;;GAEG;AACI,8BAAI,GAAG,wCAAwB,CAAC,IAAI,~~AAAhC,CAAiC~~;AAE5C;GACG;AACI,gCAAM,GAAG,CAAC,QAAyC,EAAgB,EAAE;IAC1E,IAAI,YAAqB,CAAC;IAC1B,OAAO,CAAC,OAAO,CAAC,IAAA,2CAAU,GAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;QAC3C,oFAAoF;QACpF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,IAAI,CAAC,YAAY,EAAE;gBACjB,MAAM,WAAW,GAAG,IAAA,8BAAoB,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC3D,QAAQ,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,KAAK;oBACX,UAAU,EAAE,EAAE;oBACd,MAAM,EAAE;wBACN,IAAI,EAAE,MAAM,CAAC,UAAU;qBACxB;oBACD,WAAW;iBACZ,CAAC,CAAC;aACJ;SACF;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,MAAM,CAAC,EAAE;QACrB,MAAM,WAAW,GAAG,IAAA,8BAAoB,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC3D,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,KAAK;YACX,UAAU,EAAE,EAAE;YACd,WAAW;YACX,MAAM,EAAE;gBACN,IAAI,EAAE,MAAM,CAAC,UAAU;aACxB;SACF,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,CAAC,EAAE;QACxB,MAAM,WAAW,GAAG,IAAA,8BAAoB,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC3D,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,EAAE;YACd,WAAW;YACX,MAAM,EAAE;gBACN,IAAI,EAAE,MAAM,CAAC,UAAU;aACxB;SACF,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,IAAI,GAAG,IAAA,6BAAa,EAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAE5C,SAAS,WAAW;QAClB,IAAI,EAAE,CAAC;QACP,YAAY,GAAG,IAAI,CAAC;IACtB,CAAC;IAED,OAAO;QACL,WAAW;KACZ,CAAC;AACJ,CAAC,~~AArDY,CAqDX~~;~~kBAxEiB~~,yBAAyB"}
1	+ {"version":3,"file":"TransportNodeHid.js","sourceRoot":"","sources":["../src/TransportNodeHid.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wDAA2B;AAC3B,2GAAgG;AAEhG,yCAAkE;AAClE,+CAAyD;AACzD,6CAAkD;AAClD,mDAAgD;AAEhD,MAAM,QAAQ,GAAG,aAAa,CAAC;AAE/B,IAAI,iBAAiB,GAAqC,IAAI,CAAC;AAE/D,MAAM,sCAAsC,GAAG,IAAI,CAAC;AAIpD;;;;;;GAMG;AACH,MAAqB,yBAA0B,SAAQ,wCAAwB;IAC7E,YAAY,MAAe,EAAE,EAAE,OAAO,KAAiC,EAAE;QACvE,KAAK,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;IAChD,CAAC;IAsED,MAAM,CAAC,qCAAqC;QAC1C,IAAI,yBAAyB,CAAC,gCAAgC,EAAE;YAC9D,YAAY,CAAC,yBAAyB,CAAC,gCAAgC,CAAC,CAAC;SAC1E;IACH,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,mCAAmC;QACxC,yBAAyB,CAAC,qCAAqC,EAAE,CAAC;QAClE,yBAAyB,CAAC,gCAAgC,GAAG,UAAU,CAAC,GAAG,EAAE;YAC3E,IAAA,YAAK,EAAC;gBACJ,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,kDAAkD;gBAC3D,IAAI,EAAE;oBACJ,WAAW,EAAE,OAAO,CAAC,iBAAiB,CAAC;iBACxC;aACF,CAAC,CAAC;YAEH,IAAI,iBAAiB,EAAE;gBACrB,yBAAyB,CAAC,UAAU,EAAE,CAAC;aACxC;QACH,CAAC,EAAE,sCAAsC,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU;QACf,IAAA,YAAK,EAAC;YACJ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,+BAA+B;YACxC,IAAI,EAAE;gBACJ,WAAW,EAAE,OAAO,CAAC,iBAAiB,CAAC;aACxC;SACF,CAAC,CAAC;QAEH,yBAAyB,CAAC,qCAAqC,EAAE,CAAC;QAElE,IAAI,iBAAiB,EAAE;YACrB,iBAAiB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACjC,IAAA,YAAK,EAAC;gBACJ,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,0HAA0H;aACpI,CAAC,CAAC;YACH,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACrC,iBAAiB,GAAG,IAAI,CAAC;SAC1B;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACT,WAAmB,EACnB,UAAmB,EACnB,OAAsB;QAEtB,MAAM,MAAM,GAAG,IAAI,kBAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAClD,yBAAyB,CAAC,qCAAqC,EAAE,CAAC;QAElE,IAAI,iBAAiB,EAAE;YACrB,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAC;YAC1D,OAAO,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;SAC3C;QAED,MAAM,yBAAyB,GAAG,IAAA,2CAAU,GAAE,CAAC;QAC/C,MAAM,CAAC,KAAK,CAAC,iCAAiC,yBAAyB,CAAC,MAAM,EAAE,EAAE;YAChF,yBAAyB;SAC1B,CAAC,CAAC;QAEH,IAAI,yBAAyB,CAAC,MAAM,KAAK,CAAC,EAAE;YAC1C,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,uBAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC;SAC9D;QACD,MAAM,MAAM,GAAG,yBAAyB,CAAC,CAAC,CAAC,CAAC;QAE5C,MAAM,CAAC,KAAK,CAAC,qDAAqD,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAEhF,IAAI,SAA0B,CAAC;QAC/B,IAAI;YACF,SAAS,GAAG,IAAI,kBAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAc,CAAC,CAAC;SAChD;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,CAAC,KAAK,CAAC,qCAAqC,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YACtE,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SAC9B;QAED,iBAAiB,GAAG,IAAI,yBAAyB,CAAC,SAAS,EAAE;YAC3D,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,yBAAyB,GAAG,IAAA,6BAAa,EAC7C,GAAG,EAAE,GAAE,CAAC,EACR,GAAG,EAAE;YACH,8DAA8D;YAC9D,IAAI,iBAAiB,EAAE;gBACrB,MAAM,CAAC,KAAK,CAAC,2DAA2D,CAAC,CAAC;gBAC1E,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;aACtC;QACH,CAAC,CACF,CAAC;QAEF;;;;;;WAMG;QACH,MAAM,YAAY,GAAG,GAAG,EAAE;YACxB,IAAI,CAAC,iBAAiB,EAAE;gBACtB,MAAM,CAAC,KAAK,CAAC,2DAA2D,CAAC,CAAC;gBAC1E,OAAO;aACR;YACD,IAAI,CAAC,qCAAqC,EAAE,CAAC;YAC7C,iBAAiB,CAAC,GAAG,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;YAClD,iBAAiB,GAAG,IAAI,CAAC;YACzB,yBAAyB,EAAE,CAAC;QAC9B,CAAC,CAAC;QAEF,iBAAiB,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QACjD,OAAO,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,IAAY;QACnB,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,gFAAgF,EAChF;YACE,WAAW,EAAE,CAAC,CAAC,iBAAiB;YAChC,kCAAkC,EAAE,sCAAsC;SAC3E,CACF,CAAC;QAEF,yBAAyB,CAAC,mCAAmC,EAAE,CAAC;QAEhE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;;AAtOD;;GAEG;AACI,qCAAW,GAAG,wCAAwB,CAAC,WAAW,CAAC;AAE1D;;GAEG;AACI,8BAAI,GAAG,wCAAwB,CAAC,IAAI,CAAC;AAE5C;GACG;AACI,gCAAM,GAAG,CAAC,QAAyC,EAAgB,EAAE;IAC1E,IAAI,YAAqB,CAAC;IAC1B,OAAO,CAAC,OAAO,CAAC,IAAA,2CAAU,GAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;QAC3C,oFAAoF;QACpF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,IAAI,CAAC,YAAY,EAAE;gBACjB,MAAM,WAAW,GAAG,IAAA,8BAAoB,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC3D,QAAQ,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,KAAK;oBACX,UAAU,EAAE,EAAE;oBACd,MAAM,EAAE;wBACN,IAAI,EAAE,MAAM,CAAC,UAAU;qBACxB;oBACD,WAAW;iBACZ,CAAC,CAAC;aACJ;SACF;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,MAAM,CAAC,EAAE;QACrB,MAAM,WAAW,GAAG,IAAA,8BAAoB,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC3D,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,KAAK;YACX,UAAU,EAAE,EAAE;YACd,WAAW;YACX,MAAM,EAAE;gBACN,IAAI,EAAE,MAAM,CAAC,UAAU;aACxB;SACF,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,CAAC,EAAE;QACxB,MAAM,WAAW,GAAG,IAAA,8BAAoB,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC3D,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,EAAE;YACd,WAAW;YACX,MAAM,EAAE;gBACN,IAAI,EAAE,MAAM,CAAC,UAAU;aACxB;SACF,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,IAAI,GAAG,IAAA,6BAAa,EAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAE5C,SAAS,WAAW;QAClB,IAAI,EAAE,CAAC;QACP,YAAY,GAAG,IAAI,CAAC;IACtB,CAAC;IAED,OAAO;QACL,WAAW;KACZ,CAAC;AACJ,CAAC,CAAC;kBAtEiB,yBAAyB"}

package/lib-es/TransportNodeHid.d.ts CHANGED Viewed

@@ -3,7 +3,7 @@ import HID from "node-hid";
 import TransportNodeHidNoEvents from "@ledgerhq/hw-transport-node-hid-noevents";
 import type { Observer, DescriptorEvent, Subscription } from "@ledgerhq/hw-transport";
 import { TraceContext } from "@ledgerhq/logs";
-export type ListenDescriptorEvent = DescriptorEvent<any>;
+export type ListenDescriptorEvent = DescriptorEvent<string>;
 /**
  * node-hid Transport implementation
  * @example
@@ -12,7 +12,6 @@ export type ListenDescriptorEvent = DescriptorEvent<any>;
  * TransportNodeHid.create().then(transport => ...)
  */
 export default class TransportNodeHidSingleton extends TransportNodeHidNoEvents {
-    preventAutoDisconnect: boolean;
     constructor(device: HID.HID, { context }?: {
         context?: TraceContext;
     });
@@ -27,14 +26,21 @@ export default class TransportNodeHidSingleton extends TransportNodeHidNoEvents
     /**
      */
     static listen: (observer: Observer<ListenDescriptorEvent>) => Subscription;
+    static disconnectAfterInactivityTimeout: ReturnType<typeof setTimeout> | undefined;
+    static clearDisconnectAfterInactivityTimeout(): void;
     /**
-     * convenience wrapper for auto-disconnect logic
+     * Disconnects device from singleton instance after some inactivity (no new `open`).
+     *
+     * Currently, there is only one transport instance (for only one device connected via USB).
      */
-    static autoDisconnect(): Promise<void>;
+    static setDisconnectAfterInactivityTimeout(): void;
     /**
-     * globally disconnect the transport singleton
+     * Disconnects from the HID device associated to the transport singleton.
+     *
+     * If you want to try to re-use the same transport instance at the next action (when calling `open` again), you can use
+     * the transport instance `close` method: it will only enable a disconnect after some inactivity.
      */
-    static disconnect(): Promise<void>;
+    static disconnect(): void;
     /**
      * Connects to the first Ledger device connected via USB
      *
@@ -44,14 +50,19 @@ export default class TransportNodeHidSingleton extends TransportNodeHidNoEvents
      * Legacy: `_descriptor` is needed to follow the Transport definition
      */
     static open(_descriptor: string, _timeoutMs?: number, context?: TraceContext): Promise<TransportNodeHidSingleton>;
-    setAllowAutoDisconnect(allow: boolean): void;
     /**
-     * Exchange with the device using APDU protocol.
+     * Exchanges with the device using APDU protocol
      *
      * @param apdu
      * @returns a promise of apdu response
      */
     exchange(apdu: Buffer): Promise<Buffer>;
+    /**
+     * Closes the transport instance by triggering a disconnection after some inactivity (no new `open`).
+     *
+     * Intentionally not disconnecting the device/closing the hid connection directly:
+     * The HID connection will only be closed after some inactivity.
+     */
     close(): Promise<void>;
 }
 //# sourceMappingURL=TransportNodeHid.d.ts.map

package/lib-es/TransportNodeHid.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"TransportNodeHid.d.ts","sourceRoot":"","sources":["../src/TransportNodeHid.ts"],"names":[],"mappings":";AAAA,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,wBAAwC,MAAM,0CAA0C,CAAC;AAChG,OAAO,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtF,OAAO,EAAe,YAAY,~~EAAO~~,MAAM,gBAAgB,CAAC;~~AAyBhE~~,MAAM,MAAM,qBAAqB,GAAG,eAAe,CAAC,~~GAAG~~,CAAC,CAAC;~~AAEzD~~;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,yBAA0B,SAAQ,wBAAwB;~~IAC7E~~,~~qBAAqB,UAAS;gBAElB,~~MAAM,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,GAAE;QAAE,OAAO,CAAC,EAAE,YAAY,CAAA;KAAO;IAIzE;;OAEG;IACH,MAAM,CAAC,WAAW,yBAAwC;IAE1D;;OAEG;IACH,MAAM,CAAC,IAAI,qBAAiC;IAE5C;OACG;IACH,MAAM,CAAC,MAAM,aAAc,SAAS,qBAAqB,CAAC,KAAG,YAAY,CAqDvE;IAEF~~;;OAEG;WACU~~,~~cAAc~~,~~IAAI~~,OAAO,CAAC,~~IAAI~~,CAAC;~~IAW5C;;OAEG~~;~~WACU~~,UAAU;~~IASvB~~;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACT,WAAW,EAAE,MAAM,EACnB,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,yBAAyB,CAAC;~~IAyCrC,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAI5C~~;;;;;OAKG;~~IACG~~,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;~~IAO7C~~,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;~~CAMvB~~"}
1	+ {"version":3,"file":"TransportNodeHid.d.ts","sourceRoot":"","sources":["../src/TransportNodeHid.ts"],"names":[],"mappings":";AAAA,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,wBAAwC,MAAM,0CAA0C,CAAC;AAChG,OAAO,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtF,OAAO,EAAe,YAAY,EAAS,MAAM,gBAAgB,CAAC;AAWlE,MAAM,MAAM,qBAAqB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;AAE5D;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,yBAA0B,SAAQ,wBAAwB;gBACjE,MAAM,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,GAAE;QAAE,OAAO,CAAC,EAAE,YAAY,CAAA;KAAO;IAIzE;;OAEG;IACH,MAAM,CAAC,WAAW,yBAAwC;IAE1D;;OAEG;IACH,MAAM,CAAC,IAAI,qBAAiC;IAE5C;OACG;IACH,MAAM,CAAC,MAAM,aAAc,SAAS,qBAAqB,CAAC,KAAG,YAAY,CAqDvE;IAEF,MAAM,CAAC,gCAAgC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,GAAG,SAAS,CAAC;IACnF,MAAM,CAAC,qCAAqC;IAM5C;;;;OAIG;IACH,MAAM,CAAC,mCAAmC;IAiB1C;;;;;OAKG;IACH,MAAM,CAAC,UAAU;IAsBjB;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACT,WAAW,EAAE,MAAM,EACnB,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,yBAAyB,CAAC;IAkErC;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvC;;;;;OAKG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAavB"}

package/lib-es/TransportNodeHid.js CHANGED Viewed

@@ -1,31 +1,12 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import HID from "node-hid";
 import TransportNodeHidNoEvents, { getDevices } from "@ledgerhq/hw-transport-node-hid-noevents";
-import { LocalTracer, log } from "@ledgerhq/logs";
+import { LocalTracer, trace } from "@ledgerhq/logs";
 import { identifyUSBProductId } from "@ledgerhq/devices";
 import { CantOpenDevice } from "@ledgerhq/errors";
 import { listenDevices } from "./listenDevices";
 const LOG_TYPE = "hid-verbose";
 let transportInstance = null;
-const DISCONNECT_TIMEOUT = 5000;
-let disconnectTimeout;
-const clearDisconnectTimeout = () => {
-    if (disconnectTimeout) {
-        clearTimeout(disconnectTimeout);
-    }
-};
-const setDisconnectTimeout = () => {
-    clearDisconnectTimeout();
-    disconnectTimeout = setTimeout(() => TransportNodeHidSingleton.autoDisconnect(), DISCONNECT_TIMEOUT);
-};
+const DISCONNECT_AFTER_INACTIVITY_TIMEOUT_MS = 5000;
 /**
  * node-hid Transport implementation
  * @example
@@ -36,36 +17,56 @@ const setDisconnectTimeout = () => {
 class TransportNodeHidSingleton extends TransportNodeHidNoEvents {
     constructor(device, { context } = {}) {
         super(device, { context, logType: LOG_TYPE });
-        this.preventAutoDisconnect = false;
+    }
+    static clearDisconnectAfterInactivityTimeout() {
+        if (TransportNodeHidSingleton.disconnectAfterInactivityTimeout) {
+            clearTimeout(TransportNodeHidSingleton.disconnectAfterInactivityTimeout);
+        }
     }
     /**
-     * convenience wrapper for auto-disconnect logic
+     * Disconnects device from singleton instance after some inactivity (no new `open`).
+     *
+     * Currently, there is only one transport instance (for only one device connected via USB).
      */
-    static autoDisconnect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (transportInstance && !transportInstance.preventAutoDisconnect) {
-                log("hid-verbose", "triggering auto disconnect");
+    static setDisconnectAfterInactivityTimeout() {
+        TransportNodeHidSingleton.clearDisconnectAfterInactivityTimeout();
+        TransportNodeHidSingleton.disconnectAfterInactivityTimeout = setTimeout(() => {
+            trace({
+                type: LOG_TYPE,
+                message: "Disconnecting after inactivity, if not prevented",
+                data: {
+                    hasInstance: Boolean(transportInstance),
+                },
+            });
+            if (transportInstance) {
                 TransportNodeHidSingleton.disconnect();
             }
-            else if (transportInstance) {
-                // If we have disabled the auto-disconnect, try again in DISCONNECT_TIMEOUT
-                clearDisconnectTimeout();
-                setDisconnectTimeout();
-            }
-        });
+        }, DISCONNECT_AFTER_INACTIVITY_TIMEOUT_MS);
     }
     /**
-     * globally disconnect the transport singleton
+     * Disconnects from the HID device associated to the transport singleton.
+     *
+     * If you want to try to re-use the same transport instance at the next action (when calling `open` again), you can use
+     * the transport instance `close` method: it will only enable a disconnect after some inactivity.
      */
     static disconnect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (transportInstance) {
-                transportInstance.device.close();
-                transportInstance.emit("disconnect");
-                transportInstance = null;
-            }
-            clearDisconnectTimeout();
+        trace({
+            type: LOG_TYPE,
+            message: "Disconnecting from HID device",
+            data: {
+                hasInstance: Boolean(transportInstance),
+            },
         });
+        TransportNodeHidSingleton.clearDisconnectAfterInactivityTimeout();
+        if (transportInstance) {
+            transportInstance.device.close();
+            trace({
+                type: LOG_TYPE,
+                message: `Closed HID communication with device. Emitting "disconnect" event from static disconnect and clearing singleton instance`,
+            });
+            transportInstance.emit("disconnect");
+            transportInstance = null;
+        }
     }
     /**
      * Connects to the first Ledger device connected via USB
@@ -77,61 +78,79 @@ class TransportNodeHidSingleton extends TransportNodeHidNoEvents {
      */
     static open(_descriptor, _timeoutMs, context) {
         const tracer = new LocalTracer(LOG_TYPE, context);
-        clearDisconnectTimeout();
-        return Promise.resolve().then(() => {
+        TransportNodeHidSingleton.clearDisconnectAfterInactivityTimeout();
+        if (transportInstance) {
+            tracer.trace("Reusing already opened transport instance");
+            return Promise.resolve(transportInstance);
+        }
+        const devicesDetectedDuringOpen = getDevices();
+        tracer.trace(`Devices detected during open: ${devicesDetectedDuringOpen.length}`, {
+            devicesDetectedDuringOpen,
+        });
+        if (devicesDetectedDuringOpen.length === 0) {
+            return Promise.reject(new CantOpenDevice("No device found"));
+        }
+        const device = devicesDetectedDuringOpen[0];
+        tracer.trace("Found a device, creating HID transport instance ...", { device });
+        let HIDDevice;
+        try {
+            HIDDevice = new HID.HID(device.path);
+        }
+        catch (error) {
+            tracer.trace(`Error while connecting to device: ${error}`, { error });
+            return Promise.reject(error);
+        }
+        transportInstance = new TransportNodeHidSingleton(HIDDevice, {
+            context,
+        });
+        const clearDeviceEventsListener = listenDevices(() => { }, () => {
+            // Assumes any ledger disconnection concerns current transport
             if (transportInstance) {
-                tracer.trace("Reusing already opened transport instance");
-                return transportInstance;
+                tracer.trace("Listened to on remove device event. Emitting a disconnect");
+                transportInstance.emit("disconnect");
             }
-            const device = getDevices()[0];
-            if (!device)
-                throw new CantOpenDevice("no device found");
-            tracer.trace("Found a device, creating HID transport instance ...", { device });
-            transportInstance = new TransportNodeHidSingleton(new HID.HID(device.path), {
-                context,
-            });
-            const unlisten = listenDevices(() => { }, () => {
-                // Assumes any ledger disconnection concerns current transport
-                if (transportInstance) {
-                    transportInstance.emit("disconnect");
-                }
-            });
-            const onDisconnect = () => {
-                if (!transportInstance)
-                    return;
-                tracer.trace("Device was disconnected, clearing transport instance ...");
-                transportInstance.off("disconnect", onDisconnect);
-                transportInstance = null;
-                unlisten();
-            };
-            transportInstance.on("disconnect", onDisconnect);
-            return transportInstance;
         });
-    }
-    setAllowAutoDisconnect(allow) {
-        this.preventAutoDisconnect = !allow;
+        /**
+         * Disconnect event received from the transport instance.
+         *
+         * It could be after a disconnection coming from the HID library (e.g. device unplugged) or from the transport instance itself (e.g. close).
+         * Clearing the singleton instance.
+         * Currently, only 1 device at a time is supported.
+         */
+        const onDisconnect = () => {
+            if (!transportInstance) {
+                tracer.trace("disconnect event without transport instance, ignoring ...");
+                return;
+            }
+            this.clearDisconnectAfterInactivityTimeout();
+            transportInstance.off("disconnect", onDisconnect);
+            transportInstance = null;
+            clearDeviceEventsListener();
+        };
+        transportInstance.on("disconnect", onDisconnect);
+        return Promise.resolve(transportInstance);
     }
     /**
-     * Exchange with the device using APDU protocol.
+     * Exchanges with the device using APDU protocol
      *
      * @param apdu
      * @returns a promise of apdu response
      */
     exchange(apdu) {
-        const _super = Object.create(null, {
-            exchange: { get: () => super.exchange }
-        });
-        return __awaiter(this, void 0, void 0, function* () {
-            clearDisconnectTimeout();
-            const result = yield _super.exchange.call(this, apdu);
-            setDisconnectTimeout();
-            return result;
-        });
+        return super.exchange(apdu);
     }
+    /**
+     * Closes the transport instance by triggering a disconnection after some inactivity (no new `open`).
+     *
+     * Intentionally not disconnecting the device/closing the hid connection directly:
+     * The HID connection will only be closed after some inactivity.
+     */
     close() {
-        // intentionally, a close will not effectively close the hid connection but
-        // will allow an auto-disconnection after some inactivity
-        this.preventAutoDisconnect = false;
+        this.tracer.trace("Closing transport instance by triggering a disconnection after some inactivity", {
+            hasInstance: !!transportInstance,
+            disconnectAfterInactivityTimeoutMs: DISCONNECT_AFTER_INACTIVITY_TIMEOUT_MS,
+        });
+        TransportNodeHidSingleton.setDisconnectAfterInactivityTimeout();
         return Promise.resolve();
     }
 }

package/lib-es/TransportNodeHid.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"TransportNodeHid.js","sourceRoot":"","sources":["../src/TransportNodeHid.ts"],"names":[],"mappings":"~~;;;;;;;;;~~AAAA,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,wBAAwB,EAAE,EAAE,UAAU,EAAE,MAAM,0CAA0C,CAAC;AAEhG,OAAO,EAAE,WAAW,EAAgB,~~GAAG~~,EAAE,MAAM,gBAAgB,CAAC;~~AAChE~~,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,MAAM,QAAQ,GAAG,aAAa,CAAC;AAE/B,IAAI,iBAAiB,GAAqC,IAAI,CAAC;AAE/D,MAAM,~~kBAAkB~~,GAAG,IAAI,CAAC;~~AAChC~~,~~IAAI~~,~~iBAAiB~~,~~CAAC~~;~~AACtB~~,~~MAAM~~,~~sBAAsB~~,~~GAAG~~,~~GAAG,~~EAAE~~;IAClC~~,~~IAAI~~,~~iBAAiB~~,EAAE;~~QACrB~~,~~YAAY~~,CAAC,~~iBAAiB~~,CAAC,CAAC;~~KACjC~~;~~AACH~~,CAAC,~~CAAC~~;~~AAEF~~,~~MAAM~~,~~oBAAoB~~,~~GAAG~~,~~GAAG~~,EAAE;~~IAChC~~,~~sBAAsB~~,~~EAAE~~,CAAC;~~IACzB~~,~~iBAAiB~~,~~GAAG~~,~~UAAU~~,~~CAC5B~~,~~GAAG~~,EAAE,CAAC,yBAAyB,CAAC,~~cAAc~~,~~EAAE~~,~~EAChD~~,~~kBAAkB~~,~~CACnB~~,~~CAAC~~;~~AACJ~~,~~CAAC~~,CAAC;~~AAIF;;;;;;GAMG~~;~~AACH~~,~~MAAqB~~,~~yBAA0B~~,~~SAAQ,wBAAwB~~;~~IAG7E~~,~~YAAY~~,~~MAAe,~~EAAE,EAAE,OAAO,~~KAAiC~~,~~EAAE~~;~~QACvE~~,~~KAAK~~,CAAC,~~MAAM~~,~~EAAE~~,EAAE,~~OAAO~~,~~EAAE~~,~~OAAO~~,EAAE,~~QAAQ,EAAE,~~CAAC,CAAC~~;QAHhD~~,~~0BAAqB~~,~~GAAG~~,~~KAAK~~,CAAC;~~IAI9B~~,CAAC;~~IAqED;;OAEG~~;IACH,MAAM,~~CAAO~~,~~cAAc;;YACzB~~,~~IAAI~~,~~iBAAiB~~,IAAI,~~CAAC~~,~~iBAAiB~~,~~CAAC~~,~~qBAAqB,~~EAAE;~~gBACjE~~,~~GAAG~~,~~CAAC~~,~~aAAa~~,EAAE,~~4BAA4B~~,CAAC,CAAC;~~gBACjD~~,yBAAyB,CAAC,~~UAAU~~,EAAE,CAAC;~~aACxC;iBAAM~~,IAAI,iBAAiB,EAAE;~~gBAC5B~~,~~2EAA2E;gBAC3E~~,~~sBAAsB~~,~~EAAE~~,CAAC~~;gBACzB~~,~~oBAAoB~~,EAAE,CAAC;~~aACxB;QACH~~,CAAC;~~KAAA;IAED;;OAEG;IACH~~,~~MAAM,CAAO,UAAU;;YACrB,~~IAAI,~~iBAAiB~~,~~EAAE~~;~~gBACrB~~,~~iBAAiB~~,~~CAAC~~,~~MAAM~~,CAAC,~~KAAK,EAAE,~~CAAC;~~gBACjC~~,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;~~gBACrC~~,iBAAiB,GAAG,IAAI,CAAC;~~aAC1B~~;~~YACD~~,~~sBAAsB,EAAE,~~CAAC;~~QAC3B,CAAC;KAAA;~~IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACT,WAAmB,EACnB,UAAmB,EACnB,OAAsB;QAEtB,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAClD,~~sBAAsB~~,~~EAAE,~~CAAC~~;QAEzB~~,~~OAAO~~,~~OAAO,CAAC,OAAO,~~EAAE,CAAC~~,IAAI,CAAC,GAAG,EAAE~~;~~YACjC~~,IAAI,iBAAiB,EAAE;~~gBACrB~~,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAC;~~gBAC1D~~,OAAO,iBAAiB,CAAC;~~aAC1B~~;~~YAED~~,MAAM,~~MAAM~~,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC;~~YAC/B~~,IAAI,CAAC,MAAM;~~gBAAE~~,MAAM,IAAI,cAAc,CAAC,iBAAiB,CAAC,CAAC;~~YAEzD~~,MAAM,CAAC,KAAK,CAAC,qDAAqD,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;~~YAChF~~,~~iBAAiB~~,~~GAAG~~,IAAI,~~yBAAyB~~,~~CAAC~~,IAAI,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAc,CAAC,EAAE;~~gBACpF~~,OAAO;~~aACR~~,CAAC,CAAC;~~YAEH~~,MAAM,~~QAAQ~~,GAAG,aAAa,~~CAC5B~~,GAAG,EAAE,GAAE,CAAC,EACR,GAAG,EAAE;~~gBACH~~,8DAA8D;~~gBAC9D~~,IAAI,iBAAiB,EAAE;~~oBACrB~~,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;~~iBACtC~~;~~YACH~~,CAAC,CACF,CAAC;~~YAEF~~,MAAM,YAAY,GAAG,GAAG,EAAE;~~gBACxB~~,IAAI,CAAC,iBAAiB~~;oBAAE~~,~~OAAO~~;~~gBAC/B~~,MAAM,CAAC,KAAK,CAAC,~~0DAA0D~~,CAAC,CAAC;~~gBACzE~~,iBAAiB,CAAC,GAAG,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;~~gBAClD~~,iBAAiB,GAAG,IAAI,CAAC;~~gBACzB~~,~~QAAQ~~,EAAE,CAAC;~~YACb~~,CAAC,CAAC;~~YAEF~~,iBAAiB,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;~~YACjD~~,OAAO,~~iBAAiB~~,CAAC~~;QAC3B~~,CAAC,CAAC,CAAC;~~IACL~~,CAAC;IAED,~~sBAAsB~~,CAAC,~~KAAc~~;~~QACnC~~,~~IAAI~~,CAAC,~~qBAAqB~~,~~GAAG,~~CAAC,~~KAAK~~,CAAC;~~IACtC~~,CAAC;IAED;;;;;OAKG;~~IACG~~,~~QAAQ~~,~~CAAC~~,~~IAAY;;;;;YACzB,sBAAsB,EAAE,~~CAAC~~;YACzB~~,MAAM,~~MAAM~~,~~GAAG~~,~~MAAM~~,~~OAAM~~,~~QAAQ~~,~~YAAC~~,~~IAAI~~,CAAC,CAAC;~~YAC1C~~,~~oBAAoB~~,EAAE,~~CAAC~~;~~YACvB~~,~~OAAO~~,~~MAAM,~~CAAC;~~QAChB~~,~~CAAC;KAAA;IAED~~,~~KAAK;QACH,2EAA2E;QAC3E,yDAAyD;QACzD,IAAI,~~CAAC,~~qBAAqB~~,~~GAAG~~,~~KAAK,~~CAAC;~~QACnC~~,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;;~~AAxKD~~;;GAEG;AACI,qCAAW,GAAG,wBAAwB,CAAC,WAAW,~~AAAvC,CAAwC~~;AAE1D;;GAEG;AACI,8BAAI,GAAG,wBAAwB,CAAC,IAAI,~~AAAhC,CAAiC~~;AAE5C;GACG;AACI,gCAAM,GAAG,CAAC,QAAyC,EAAgB,EAAE;IAC1E,IAAI,YAAqB,CAAC;IAC1B,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;QAC3C,oFAAoF;QACpF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,IAAI,CAAC,YAAY,EAAE;gBACjB,MAAM,WAAW,GAAG,oBAAoB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC3D,QAAQ,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,KAAK;oBACX,UAAU,EAAE,EAAE;oBACd,MAAM,EAAE;wBACN,IAAI,EAAE,MAAM,CAAC,UAAU;qBACxB;oBACD,WAAW;iBACZ,CAAC,CAAC;aACJ;SACF;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,MAAM,CAAC,EAAE;QACrB,MAAM,WAAW,GAAG,oBAAoB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC3D,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,KAAK;YACX,UAAU,EAAE,EAAE;YACd,WAAW;YACX,MAAM,EAAE;gBACN,IAAI,EAAE,MAAM,CAAC,UAAU;aACxB;SACF,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,CAAC,EAAE;QACxB,MAAM,WAAW,GAAG,oBAAoB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC3D,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,EAAE;YACd,WAAW;YACX,MAAM,EAAE;gBACN,IAAI,EAAE,MAAM,CAAC,UAAU;aACxB;SACF,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAE5C,SAAS,WAAW;QAClB,IAAI,EAAE,CAAC;QACP,YAAY,GAAG,IAAI,CAAC;IACtB,CAAC;IAED,OAAO;QACL,WAAW;KACZ,CAAC;AACJ,CAAC,~~AArDY,CAqDX~~;~~eAxEiB~~,yBAAyB"}
1	+ {"version":3,"file":"TransportNodeHid.js","sourceRoot":"","sources":["../src/TransportNodeHid.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,wBAAwB,EAAE,EAAE,UAAU,EAAE,MAAM,0CAA0C,CAAC;AAEhG,OAAO,EAAE,WAAW,EAAgB,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,MAAM,QAAQ,GAAG,aAAa,CAAC;AAE/B,IAAI,iBAAiB,GAAqC,IAAI,CAAC;AAE/D,MAAM,sCAAsC,GAAG,IAAI,CAAC;AAIpD;;;;;;GAMG;AACH,MAAqB,yBAA0B,SAAQ,wBAAwB;IAC7E,YAAY,MAAe,EAAE,EAAE,OAAO,KAAiC,EAAE;QACvE,KAAK,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;IAChD,CAAC;IAsED,MAAM,CAAC,qCAAqC;QAC1C,IAAI,yBAAyB,CAAC,gCAAgC,EAAE;YAC9D,YAAY,CAAC,yBAAyB,CAAC,gCAAgC,CAAC,CAAC;SAC1E;IACH,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,mCAAmC;QACxC,yBAAyB,CAAC,qCAAqC,EAAE,CAAC;QAClE,yBAAyB,CAAC,gCAAgC,GAAG,UAAU,CAAC,GAAG,EAAE;YAC3E,KAAK,CAAC;gBACJ,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,kDAAkD;gBAC3D,IAAI,EAAE;oBACJ,WAAW,EAAE,OAAO,CAAC,iBAAiB,CAAC;iBACxC;aACF,CAAC,CAAC;YAEH,IAAI,iBAAiB,EAAE;gBACrB,yBAAyB,CAAC,UAAU,EAAE,CAAC;aACxC;QACH,CAAC,EAAE,sCAAsC,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU;QACf,KAAK,CAAC;YACJ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,+BAA+B;YACxC,IAAI,EAAE;gBACJ,WAAW,EAAE,OAAO,CAAC,iBAAiB,CAAC;aACxC;SACF,CAAC,CAAC;QAEH,yBAAyB,CAAC,qCAAqC,EAAE,CAAC;QAElE,IAAI,iBAAiB,EAAE;YACrB,iBAAiB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACjC,KAAK,CAAC;gBACJ,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,0HAA0H;aACpI,CAAC,CAAC;YACH,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACrC,iBAAiB,GAAG,IAAI,CAAC;SAC1B;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACT,WAAmB,EACnB,UAAmB,EACnB,OAAsB;QAEtB,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAClD,yBAAyB,CAAC,qCAAqC,EAAE,CAAC;QAElE,IAAI,iBAAiB,EAAE;YACrB,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAC;YAC1D,OAAO,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;SAC3C;QAED,MAAM,yBAAyB,GAAG,UAAU,EAAE,CAAC;QAC/C,MAAM,CAAC,KAAK,CAAC,iCAAiC,yBAAyB,CAAC,MAAM,EAAE,EAAE;YAChF,yBAAyB;SAC1B,CAAC,CAAC;QAEH,IAAI,yBAAyB,CAAC,MAAM,KAAK,CAAC,EAAE;YAC1C,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC;SAC9D;QACD,MAAM,MAAM,GAAG,yBAAyB,CAAC,CAAC,CAAC,CAAC;QAE5C,MAAM,CAAC,KAAK,CAAC,qDAAqD,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAEhF,IAAI,SAA0B,CAAC;QAC/B,IAAI;YACF,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAc,CAAC,CAAC;SAChD;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,CAAC,KAAK,CAAC,qCAAqC,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YACtE,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SAC9B;QAED,iBAAiB,GAAG,IAAI,yBAAyB,CAAC,SAAS,EAAE;YAC3D,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,yBAAyB,GAAG,aAAa,CAC7C,GAAG,EAAE,GAAE,CAAC,EACR,GAAG,EAAE;YACH,8DAA8D;YAC9D,IAAI,iBAAiB,EAAE;gBACrB,MAAM,CAAC,KAAK,CAAC,2DAA2D,CAAC,CAAC;gBAC1E,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;aACtC;QACH,CAAC,CACF,CAAC;QAEF;;;;;;WAMG;QACH,MAAM,YAAY,GAAG,GAAG,EAAE;YACxB,IAAI,CAAC,iBAAiB,EAAE;gBACtB,MAAM,CAAC,KAAK,CAAC,2DAA2D,CAAC,CAAC;gBAC1E,OAAO;aACR;YACD,IAAI,CAAC,qCAAqC,EAAE,CAAC;YAC7C,iBAAiB,CAAC,GAAG,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;YAClD,iBAAiB,GAAG,IAAI,CAAC;YACzB,yBAAyB,EAAE,CAAC;QAC9B,CAAC,CAAC;QAEF,iBAAiB,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QACjD,OAAO,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,IAAY;QACnB,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,gFAAgF,EAChF;YACE,WAAW,EAAE,CAAC,CAAC,iBAAiB;YAChC,kCAAkC,EAAE,sCAAsC;SAC3E,CACF,CAAC;QAEF,yBAAyB,CAAC,mCAAmC,EAAE,CAAC;QAEhE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;;AAtOD;;GAEG;AACI,qCAAW,GAAG,wBAAwB,CAAC,WAAW,CAAC;AAE1D;;GAEG;AACI,8BAAI,GAAG,wBAAwB,CAAC,IAAI,CAAC;AAE5C;GACG;AACI,gCAAM,GAAG,CAAC,QAAyC,EAAgB,EAAE;IAC1E,IAAI,YAAqB,CAAC;IAC1B,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;QAC3C,oFAAoF;QACpF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,IAAI,CAAC,YAAY,EAAE;gBACjB,MAAM,WAAW,GAAG,oBAAoB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC3D,QAAQ,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,KAAK;oBACX,UAAU,EAAE,EAAE;oBACd,MAAM,EAAE;wBACN,IAAI,EAAE,MAAM,CAAC,UAAU;qBACxB;oBACD,WAAW;iBACZ,CAAC,CAAC;aACJ;SACF;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,MAAM,CAAC,EAAE;QACrB,MAAM,WAAW,GAAG,oBAAoB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC3D,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,KAAK;YACX,UAAU,EAAE,EAAE;YACd,WAAW;YACX,MAAM,EAAE;gBACN,IAAI,EAAE,MAAM,CAAC,UAAU;aACxB;SACF,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,CAAC,EAAE;QACxB,MAAM,WAAW,GAAG,oBAAoB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC3D,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,EAAE;YACd,WAAW;YACX,MAAM,EAAE;gBACN,IAAI,EAAE,MAAM,CAAC,UAAU;aACxB;SACF,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAE5C,SAAS,WAAW;QAClB,IAAI,EAAE,CAAC;QACP,YAAY,GAAG,IAAI,CAAC;IACtB,CAAC;IAED,OAAO;QACL,WAAW;KACZ,CAAC;AACJ,CAAC,CAAC;eAtEiB,yBAAyB"}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@ledgerhq/hw-transport-node-hid-singleton",
-  "version": "6.30.2",
+  "version": "6.30.3-start-exchange.0",
   "description": "Ledger Hardware Wallet Node implementation of the communication layer, using node-hid and node-usb",
   "keywords": [
     "Ledger",
@@ -30,9 +30,9 @@
     "node-hid": "^2.1.2",
     "usb": "2.9.0",
     "@ledgerhq/devices": "^8.2.0",
-    "@ledgerhq/hw-transport": "^6.30.2",
     "@ledgerhq/errors": "^6.16.1",
-    "@ledgerhq/hw-transport-node-hid-noevents": "^6.29.2",
+    "@ledgerhq/hw-transport": "^6.30.3-start-exchange.0",
+    "@ledgerhq/hw-transport-node-hid-noevents": "^6.29.3-start-exchange.0",
     "@ledgerhq/logs": "^6.12.0"
   },
   "gitHead": "dd0dea64b58e5a9125c8a422dcffd29e5ef6abec",

package/src/TransportNodeHid.ts CHANGED Viewed

@@ -1,7 +1,7 @@
 import HID from "node-hid";
 import TransportNodeHidNoEvents, { getDevices } from "@ledgerhq/hw-transport-node-hid-noevents";
 import type { Observer, DescriptorEvent, Subscription } from "@ledgerhq/hw-transport";
-import { LocalTracer, TraceContext, log } from "@ledgerhq/logs";
+import { LocalTracer, TraceContext, trace } from "@ledgerhq/logs";
 import { identifyUSBProductId } from "@ledgerhq/devices";
 import { CantOpenDevice } from "@ledgerhq/errors";
 import { listenDevices } from "./listenDevices";
@@ -10,23 +10,9 @@ const LOG_TYPE = "hid-verbose";
 let transportInstance: TransportNodeHidSingleton | null = null;
-const DISCONNECT_TIMEOUT = 5000;
-let disconnectTimeout;
-const clearDisconnectTimeout = () => {
-  if (disconnectTimeout) {
-    clearTimeout(disconnectTimeout);
-  }
-};
-const setDisconnectTimeout = () => {
-  clearDisconnectTimeout();
-  disconnectTimeout = setTimeout(
-    () => TransportNodeHidSingleton.autoDisconnect(),
-    DISCONNECT_TIMEOUT,
-  );
-};
+const DISCONNECT_AFTER_INACTIVITY_TIMEOUT_MS = 5000;
-export type ListenDescriptorEvent = DescriptorEvent<any>;
+export type ListenDescriptorEvent = DescriptorEvent<string>;
 /**
  * node-hid Transport implementation
@@ -36,8 +22,6 @@ export type ListenDescriptorEvent = DescriptorEvent<any>;
  * TransportNodeHid.create().then(transport => ...)
  */
 export default class TransportNodeHidSingleton extends TransportNodeHidNoEvents {
-  preventAutoDisconnect = false;
   constructor(device: HID.HID, { context }: { context?: TraceContext } = {}) {
     super(device, { context, logType: LOG_TYPE });
   }
@@ -109,30 +93,61 @@ export default class TransportNodeHidSingleton extends TransportNodeHidNoEvents
     };
   };
+  static disconnectAfterInactivityTimeout: ReturnType<typeof setTimeout> | undefined;
+  static clearDisconnectAfterInactivityTimeout() {
+    if (TransportNodeHidSingleton.disconnectAfterInactivityTimeout) {
+      clearTimeout(TransportNodeHidSingleton.disconnectAfterInactivityTimeout);
+    }
+  }
   /**
-   * convenience wrapper for auto-disconnect logic
+   * Disconnects device from singleton instance after some inactivity (no new `open`).
+   *
+   * Currently, there is only one transport instance (for only one device connected via USB).
    */
-  static async autoDisconnect(): Promise<void> {
-    if (transportInstance && !transportInstance.preventAutoDisconnect) {
-      log("hid-verbose", "triggering auto disconnect");
-      TransportNodeHidSingleton.disconnect();
-    } else if (transportInstance) {
-      // If we have disabled the auto-disconnect, try again in DISCONNECT_TIMEOUT
-      clearDisconnectTimeout();
-      setDisconnectTimeout();
-    }
+  static setDisconnectAfterInactivityTimeout() {
+    TransportNodeHidSingleton.clearDisconnectAfterInactivityTimeout();
+    TransportNodeHidSingleton.disconnectAfterInactivityTimeout = setTimeout(() => {
+      trace({
+        type: LOG_TYPE,
+        message: "Disconnecting after inactivity, if not prevented",
+        data: {
+          hasInstance: Boolean(transportInstance),
+        },
+      });
+      if (transportInstance) {
+        TransportNodeHidSingleton.disconnect();
+      }
+    }, DISCONNECT_AFTER_INACTIVITY_TIMEOUT_MS);
   }
   /**
-   * globally disconnect the transport singleton
+   * Disconnects from the HID device associated to the transport singleton.
+   *
+   * If you want to try to re-use the same transport instance at the next action (when calling `open` again), you can use
+   * the transport instance `close` method: it will only enable a disconnect after some inactivity.
    */
-  static async disconnect() {
+  static disconnect() {
+    trace({
+      type: LOG_TYPE,
+      message: "Disconnecting from HID device",
+      data: {
+        hasInstance: Boolean(transportInstance),
+      },
+    });
+    TransportNodeHidSingleton.clearDisconnectAfterInactivityTimeout();
     if (transportInstance) {
       transportInstance.device.close();
+      trace({
+        type: LOG_TYPE,
+        message: `Closed HID communication with device. Emitting "disconnect" event from static disconnect and clearing singleton instance`,
+      });
       transportInstance.emit("disconnect");
       transportInstance = null;
     }
-    clearDisconnectTimeout();
   }
   /**
@@ -149,66 +164,97 @@ export default class TransportNodeHidSingleton extends TransportNodeHidNoEvents
     context?: TraceContext,
   ): Promise<TransportNodeHidSingleton> {
     const tracer = new LocalTracer(LOG_TYPE, context);
-    clearDisconnectTimeout();
+    TransportNodeHidSingleton.clearDisconnectAfterInactivityTimeout();
-    return Promise.resolve().then(() => {
-      if (transportInstance) {
-        tracer.trace("Reusing already opened transport instance");
-        return transportInstance;
-      }
+    if (transportInstance) {
+      tracer.trace("Reusing already opened transport instance");
+      return Promise.resolve(transportInstance);
+    }
-      const device = getDevices()[0];
-      if (!device) throw new CantOpenDevice("no device found");
+    const devicesDetectedDuringOpen = getDevices();
+    tracer.trace(`Devices detected during open: ${devicesDetectedDuringOpen.length}`, {
+      devicesDetectedDuringOpen,
+    });
-      tracer.trace("Found a device, creating HID transport instance ...", { device });
-      transportInstance = new TransportNodeHidSingleton(new HID.HID(device.path as string), {
-        context,
-      });
+    if (devicesDetectedDuringOpen.length === 0) {
+      return Promise.reject(new CantOpenDevice("No device found"));
+    }
+    const device = devicesDetectedDuringOpen[0];
-      const unlisten = listenDevices(
-        () => {},
-        () => {
-          // Assumes any ledger disconnection concerns current transport
-          if (transportInstance) {
-            transportInstance.emit("disconnect");
-          }
-        },
-      );
-      const onDisconnect = () => {
-        if (!transportInstance) return;
-        tracer.trace("Device was disconnected, clearing transport instance ...");
-        transportInstance.off("disconnect", onDisconnect);
-        transportInstance = null;
-        unlisten();
-      };
-      transportInstance.on("disconnect", onDisconnect);
-      return transportInstance;
+    tracer.trace("Found a device, creating HID transport instance ...", { device });
+    let HIDDevice: HID | undefined;
+    try {
+      HIDDevice = new HID.HID(device.path as string);
+    } catch (error) {
+      tracer.trace(`Error while connecting to device: ${error}`, { error });
+      return Promise.reject(error);
+    }
+    transportInstance = new TransportNodeHidSingleton(HIDDevice, {
+      context,
     });
-  }
-  setAllowAutoDisconnect(allow: boolean): void {
-    this.preventAutoDisconnect = !allow;
+    const clearDeviceEventsListener = listenDevices(
+      () => {},
+      () => {
+        // Assumes any ledger disconnection concerns current transport
+        if (transportInstance) {
+          tracer.trace("Listened to on remove device event. Emitting a disconnect");
+          transportInstance.emit("disconnect");
+        }
+      },
+    );
+    /**
+     * Disconnect event received from the transport instance.
+     *
+     * It could be after a disconnection coming from the HID library (e.g. device unplugged) or from the transport instance itself (e.g. close).
+     * Clearing the singleton instance.
+     * Currently, only 1 device at a time is supported.
+     */
+    const onDisconnect = () => {
+      if (!transportInstance) {
+        tracer.trace("disconnect event without transport instance, ignoring ...");
+        return;
+      }
+      this.clearDisconnectAfterInactivityTimeout();
+      transportInstance.off("disconnect", onDisconnect);
+      transportInstance = null;
+      clearDeviceEventsListener();
+    };
+    transportInstance.on("disconnect", onDisconnect);
+    return Promise.resolve(transportInstance);
   }
   /**
-   * Exchange with the device using APDU protocol.
+   * Exchanges with the device using APDU protocol
    *
    * @param apdu
    * @returns a promise of apdu response
    */
-  async exchange(apdu: Buffer): Promise<Buffer> {
-    clearDisconnectTimeout();
-    const result = await super.exchange(apdu);
-    setDisconnectTimeout();
-    return result;
+  exchange(apdu: Buffer): Promise<Buffer> {
+    return super.exchange(apdu);
   }
+  /**
+   * Closes the transport instance by triggering a disconnection after some inactivity (no new `open`).
+   *
+   * Intentionally not disconnecting the device/closing the hid connection directly:
+   * The HID connection will only be closed after some inactivity.
+   */
   close(): Promise<void> {
-    // intentionally, a close will not effectively close the hid connection but
-    // will allow an auto-disconnection after some inactivity
-    this.preventAutoDisconnect = false;
+    this.tracer.trace(
+      "Closing transport instance by triggering a disconnection after some inactivity",
+      {
+        hasInstance: !!transportInstance,
+        disconnectAfterInactivityTimeoutMs: DISCONNECT_AFTER_INACTIVITY_TIMEOUT_MS,
+      },
+    );
+    TransportNodeHidSingleton.setDisconnectAfterInactivityTimeout();
     return Promise.resolve();
   }
 }