@ledgerhq/hw-transport-node-hid 6.11.2 → 6.25.1-alpha.3

package/lib-es/TransportNodeHid.js.flow

@@ -0,0 +1,125 @@
+//@flow
+
+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 { identifyUSBProductId } from "@ledgerhq/devices";
+import { TransportError } from "@ledgerhq/errors";
+import listenDevices from "./listenDevices";
+
+let listenDevicesDebounce = 500;
+let listenDevicesPollingSkip = () => false;
+
+/**
+ * node-hid Transport implementation
+ * @example
+ * import TransportNodeHid from "@ledgerhq/hw-transport-node-hid";
+ * ...
+ * TransportNodeHid.create().then(transport => ...)
+ */
+export default class TransportNodeHid extends TransportNodeHidNoEvents {
+  /**
+   *
+   */
+  static isSupported = TransportNodeHidNoEvents.isSupported;
+
+  /**
+   *
+   */
+  static list = TransportNodeHidNoEvents.list;
+
+  /**
+   *
+   */
+  static setListenDevicesDebounce = (delay: number) => {
+    listenDevicesDebounce = delay;
+  };
+
+  /**
+   *
+   */
+  static setListenDevicesPollingSkip = (conditionToSkip: () => boolean) => {
+    listenDevicesPollingSkip = conditionToSkip;
+  };
+
+  /**
+   *
+   */
+  static setListenDevicesDebug = () => {
+    console.warn(
+      "setListenDevicesDebug is deprecated. Use @ledgerhq/logs instead. No logs will get emitted there anymore."
+    );
+  };
+
+  /**
+   */
+  static listen = (
+    observer: Observer<DescriptorEvent<?string>>
+  ): Subscription => {
+    let unsubscribed = false;
+    Promise.resolve(getDevices()).then((devices) => {
+      // this needs to run asynchronously so the subscription is defined during this phase
+      for (const device of devices) {
+        if (!unsubscribed) {
+          const descriptor: string = device.path;
+          const deviceModel = identifyUSBProductId(device.productId);
+          observer.next({ type: "add", descriptor, device, deviceModel });
+        }
+      }
+    });
+    const { events, stop } = listenDevices(
+      listenDevicesDebounce,
+      listenDevicesPollingSkip
+    );
+
+    const onAdd = (device) => {
+      if (unsubscribed || !device) return;
+      const deviceModel = identifyUSBProductId(device.productId);
+      observer.next({
+        type: "add",
+        descriptor: device.path,
+        deviceModel,
+        device,
+      });
+    };
+    const onRemove = (device) => {
+      if (unsubscribed || !device) return;
+      const deviceModel = identifyUSBProductId(device.productId);
+      observer.next({
+        type: "remove",
+        descriptor: device.path,
+        deviceModel,
+        device,
+      });
+    };
+    events.on("add", onAdd);
+    events.on("remove", onRemove);
+    function unsubscribe() {
+      unsubscribed = true;
+      events.removeListener("add", onAdd);
+      events.removeListener("remove", onRemove);
+      stop();
+    }
+    return { unsubscribe };
+  };
+
+  /**
+   * if path="" is not provided, the library will take the first device
+   */
+  static open(path: ?string) {
+    return Promise.resolve().then(() => {
+      if (path) {
+        return new TransportNodeHid(new HID.HID(path));
+      }
+      const device = getDevices()[0];
+      if (!device) throw new TransportError("NoDevice", "NoDevice");
+      return new TransportNodeHid(new HID.HID(device.path));
+    });
+  }
+}

package/lib-es/listenDevices.js.flow

@@ -0,0 +1,107 @@
+// @flow
+
+import EventEmitter from "events";
+import { getDevices } from "@ledgerhq/hw-transport-node-hid-noevents";
+import { log } from "@ledgerhq/logs";
+import usb from "usb";
+import debounce from "lodash/debounce";
+
+export default (
+  delay: number,
+  listenDevicesPollingSkip: () => boolean
+): ({
+  events: EventEmitter,
+  stop: () => void,
+}) => {
+  const events = new EventEmitter();
+  events.setMaxListeners(0);
+
+  let listDevices = getDevices();
+
+  const flatDevice = (d) => d.path;
+
+  const getFlatDevices = () => [
+    ...new Set(getDevices().map((d) => flatDevice(d))),
+  ];
+
+  const getDeviceByPaths = (paths) =>
+    listDevices.find((d) => paths.includes(flatDevice(d)));
+
+  let lastDevices = getFlatDevices();
+
+  const poll = () => {
+    if (!listenDevicesPollingSkip()) {
+      log("hid-listen", "Polling for added or removed devices");
+
+      let changeFound = false;
+      const currentDevices = getFlatDevices();
+      const newDevices = currentDevices.filter((d) => !lastDevices.includes(d));
+
+      if (newDevices.length > 0) {
+        log("hid-listen", "New device found:", newDevices);
+
+        listDevices = getDevices();
+        events.emit("add", getDeviceByPaths(newDevices));
+
+        changeFound = true;
+      } else {
+        log("hid-listen", "No new device found");
+      }
+
+      const removeDevices = lastDevices.filter(
+        (d) => !currentDevices.includes(d)
+      );
+
+      if (removeDevices.length > 0) {
+        log("hid-listen", "Removed device found:", removeDevices);
+
+        events.emit("remove", getDeviceByPaths(removeDevices));
+        listDevices = listDevices.filter(
+          (d) => !removeDevices.includes(flatDevice(d))
+        );
+
+        changeFound = true;
+      } else {
+        log("hid-listen", "No removed device found");
+      }
+
+      if (changeFound) {
+        lastDevices = currentDevices;
+      }
+    } else {
+      log("hid-listen", "Polling skipped, re-debouncing");
+      debouncedPoll();
+    }
+  };
+
+  const debouncedPoll = debounce(poll, delay);
+
+  const attachDetected = (device) => {
+    log("hid-listen", "Device add detected:", device);
+
+    debouncedPoll();
+  };
+  usb.on("attach", attachDetected);
+  log("hid-listen", "attach listener added");
+
+  const detachDetected = (device) => {
+    log("hid-listen", "Device removal detected:", device);
+
+    debouncedPoll();
+  };
+  usb.on("detach", detachDetected);
+  log("hid-listen", "detach listener added");
+
+  return {
+    stop: () => {
+      log(
+        "hid-listen",
+        "Stop received, removing listeners and cancelling pending debounced polls"
+      );
+      debouncedPoll.cancel();
+      usb.removeListener("attach", attachDetected);
+      usb.removeListener("detach", detachDetected);
+    },
+    events,
+  };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ledgerhq/hw-transport-node-hid",
-  "version": "6.11.2",
+  "version": "6.25.1-alpha.3+eb669e17",
   "description": "Ledger Hardware Wallet Node implementation of the communication layer, using node-hid",
   "keywords": [
     "Ledger",
@@ -27,10 +27,10 @@
   "types": "lib/TransportNodeHid.d.ts",
   "license": "Apache-2.0",
   "dependencies": {
-    "@ledgerhq/devices": "^6.11.2",
+    "@ledgerhq/devices": "^6.24.1",
     "@ledgerhq/errors": "^6.10.0",
-    "@ledgerhq/hw-transport": "^6.11.2",
-    "@ledgerhq/hw-transport-node-hid-noevents": "^6.11.2",
+    "@ledgerhq/hw-transport": "^6.25.1-alpha.3+eb669e17",
+    "@ledgerhq/hw-transport-node-hid-noevents": "^6.25.1-alpha.3+eb669e17",
     "@ledgerhq/logs": "^6.10.0",
     "lodash": "^4.17.21",
     "node-hid": "2.1.1",
@@ -42,5 +42,5 @@
     "watch": "bash ../../script/watch.sh",
     "doc": "bash ../../script/doc.sh"
   },
-  "gitHead": "d243550a31bd781924fc301492320b16212c3dbe"
+  "gitHead": "eb669e17dd87d3ab568beab1f9a5ddb1a2536e83"
 }