usb 3.0.0-alpha.3 → 3.0.0-alpha.4

package/README.md

@@ -8,6 +8,9 @@ Node.JS library for communicating with USB devices.
 
 This is a complete rewrite in rust using [@kevinmehall](https://github.com/kevinmehall)'s excellent [nusb library](https://docs.rs/nusb/latest/nusb) and [napi-rs](https://napi.rs/).
 
+# License
+[MIT](LICENSE.md)
+
 # Prerequisites
 
 [Node.js >= v12.22.0](https://nodejs.org), which includes `npm`.
@@ -26,7 +29,22 @@ You may need to modify your udev and permission rules in order to access your de
 SUBSYSTEM=="usb", ATTR{idVendor}=="USB-VENDOR-ID", ATTR{idProduct}=="USB-PRODUCT-ID", MODE="0660", GROUP="GROUP-YOUR-USER-IS-IN"
 ```
 
-# Installation
+# Getting Started
+
+## Supported Architectures and Operating Systems
+
+- i686-pc-windows-msvc
+- x86_64-apple-darwin
+- x86_64-pc-windows-msvc
+- x86_64-unknown-linux-gnu
+- x86_64-unknown-linux-musl
+- aarch64-apple-darwin
+- aarch64-pc-windows-msvc
+- aarch64-unknown-linux-gnu
+- aarch64-unknown-linux-musl
+- armv7-unknown-linux-gnueabihf
+
+## Installation
 
 Native modules are bundled as separate optional packages, so installation should be as simple as installing the package.
 
@@ -42,27 +60,85 @@ With `yarn`:
 yarn add usb
 ```
 
-# License
-[MIT](LICENSE.md)
+## Examples
+Use the following examples to kickstart your development. Once you have a desired device, use the APIs below to interact with it.
 
-# Limitations
-Does not support:
+### List all devices
+```typescript
+import { usb } from 'usb';
 
-- Isochronous transfers
+const devices = await usb.getDevices();
 
-# Getting Started
-Use the following examples to kickstart your development. Once you have a desired device, use the APIs below to interact with it.
+for (const device of devices) {
+    console.log(device); // WebUSB device
+}
+```
 
-## APIs
-Since `v3.0.0`, the `node-usb` library supports the WebUSB API which follows the [WebUSB Specification](https://wicg.github.io/webusb/)
+### Find device by vid/pid
+```typescript
+import { usb } from 'usb';
 
-Convenience methods also exist to easily list or find devices.
+const device = await usb.findDeviceByIds(0x59e3, 0x0a23);
 
-Full auto-generated API documentation can be seen here:
+if (device) {
+    console.log(device); // WebUSB device
+}
+```
 
-https://node-usb.github.io/node-usb-rs/
+### Find device by SerialNumber
+```typescript
+import { usb } from 'usb';
+
+const device = await usb.findDeviceBySerial('TEST_DEVICE');
+
+if (device) {
+    console.log(device); // WebUSB device
+}
+```
+
+### Watch for connect/disconnect events
+```typescript
+import { usb } from 'usb';
+
+usb.addEventListener('connect', (event) => {
+    console.log('Device connected:', event.device.serialNumber);
+});
+
+usb.addEventListener('disconnect', (event) => {
+    console.log('Device disconnected:', event.device.serialNumber);
+});
+```
+
+### Use WebUSB approach to find a device
+```typescript
+import { webusb } from 'usb';
+
+// Returns first matching device
+const device = await webusb.requestDevice({
+    filters: [{}]
+})
 
-## Electron
+console.log(device); // WebUSB device
+```
+
+### Use WebUSB approach to find a device with custom selection method
+```typescript
+import { WebUSB } from 'usb';
+
+const customWebUSB = new WebUSB({
+    // This function can return a promise which allows a UI to be displayed if required
+    devicesFound: devices => devices.find(device => device.serialNumber === 'TEST_DEVICE')
+});
+
+// Returns device based on injected 'devicesFound' function
+const device = await customWebUSB.requestDevice({
+    filters: [{}]
+})
+
+console.log(device); // WebUSB device
+```
+
+### Electron
 Please refer to the maintained example for using `node-usb` in electron:
 
 https://github.com/node-usb/node-usb-example-electron
@@ -73,46 +149,39 @@ If using a packaging system for electron, ensure the `node-usb` library does not
 - nodeGypRebuild: false
 - npmRebuild: false
 
-## Convenience Functions
+# APIs
+Since `v3.0.0`, the `node-usb` API follows the WebUSB specification which can be found here:
 
-### getDeviceList()
-Return a list of `USB` objects for the USB devices attached to the system.
-
-### findByIds(vid, pid)
-Convenience method to get the first device with the specified VID and PID, or `undefined` if no such device is present.
+https://wicg.github.io/webusb/
 
-### findBySerialNumber(serialNumber)
-Convenience method to get the device with the specified serial number, or `undefined` if no such device is present.
+Two versions of the WebUSB API exist by default:
 
-## WebUSB
+- `usb` - which exposes all functionality in an unrestricted manner (e.g. without needing to `requestDevice()` first)
+- `webusb` - which follows the WebUSB specification exactly and requires the user to authorise devices via `requestDevice()` first.
 
-Please refer to the WebUSB specification which be found here:
+You may also construct your own WebUSB (e.g. to specify a `requestDevice()` callback) using the exported `WebUSB` class.
 
-https://wicg.github.io/webusb/
+Full auto-generated API documentation can be seen here:
 
-### Implementation Status
+https://node-usb.github.io/node-usb-rs/
 
-#### Architectures and Operating Systems
+## Implementation Status
 
-- i686-pc-windows-msvc
-- x86_64-apple-darwin
-- x86_64-pc-windows-msvc
-- x86_64-unknown-linux-gnu
-- x86_64-unknown-linux-musl
-- aarch64-apple-darwin
-- aarch64-pc-windows-msvc
-- aarch64-unknown-linux-gnu
-- aarch64-unknown-linux-musl
-- armv7-unknown-linux-gnueabihf
+### USB
 
-#### USB
+#### WebUSB Features
 
 - [x] getDevices()
 - [x] requestDevice()
 
-#### USBDevice
+#### Extended Features
+
+- [x] findDeviceByIds()
+- [x] findDeviceBySerial()
+
+### USBDevice
 
-##### WebUSB Features
+#### WebUSB Features
 
 - [x] usbVersionMajor
 - [x] usbVersionMinor
@@ -147,7 +216,7 @@ https://wicg.github.io/webusb/
 - [ ] isochronousTransferIn()
 - [ ] isochronousTransferOut()
 
-##### Extended Features
+#### Extended Features
 
 - [x] bus
 - [x] address
@@ -156,11 +225,28 @@ https://wicg.github.io/webusb/
 - [x] detachKernelDriver() (Linux only)
 - [x] attachKernelDriver() (Linux only)
 
-#### Events
+### Events
 
 - [x] connect
 - [x] disconnect
 
+## Extended Functions
+
+This library extends the WebUSB specification to add further functionality and convenience
+
+### findDeviceByIds(vid, pid)
+Convenience method to get the first device with the specified VID and PID, or `undefined` if no such device is present.
+
+### findDeviceBySerial(serialNumber)
+Convenience method to get the device with the specified serial number, or `undefined` if no such device is present.
+
+### detachKernelDriver(interfaceNumber) (Linux only)
+Detaches the kernel driver from the interface.
+You may need to execute this with elevated privileges.
+
+### attachKernelDriver(interfaceNumber) (Linux only)
+Re-attaches the kernel driver for the interface.
+
 # Development
 The library is based on native rust bindings wrapping the [nusb](https://docs.rs/nusb/latest/nusb) crate.
 

package/dist/index.d.ts

@@ -57,28 +57,28 @@ declare class WebUSB extends EventTarget implements USB {
      * @returns Promise containing an array of devices
      */
     getDevices(): Promise<UsbDevice[]>;
+    /**
+     * Convenience method to get the first device with the specified VID and PID, or `undefined` if no such device is present.
+     * @param vid
+     * @param pid
+     */
+    findDeviceByIds(vid: number, pid: number): Promise<UsbDevice | undefined>;
+    /**
+     * Convenience method to get the device with the specified serial number, or `undefined` if no such device is present.
+     * @param serialNumber
+     */
+    findDeviceBySerial(serialNumber: string): Promise<UsbDevice | undefined>;
     private loadDevices;
     private quickFilter;
     private filterDevice;
     private isAuthorisedDevice;
 }
 /**
- * Convenience method to get an array of all connected devices.
- */
-declare const getDeviceList: () => Promise<UsbDevice[]>;
-/**
- * Convenience method to get the first device with the specified VID and PID, or `undefined` if no such device is present.
- * @param vid
- * @param pid
- */
-declare const findByIds: (vid: number, pid: number) => Promise<UsbDevice | undefined>;
-/**
- * Convenience method to get the device with the specified serial number, or `undefined` if no such device is present.
- * @param serialNumber
+ * Default USB object (allows all devices by default)
  */
-declare const findBySerialNumber: (serialNumber: string) => Promise<UsbDevice | undefined>;
+declare const usb: WebUSB;
 /**
  * Default WebUSB object (mimics navigator.usb)
  */
 declare const webusb: WebUSB | USB;
-export { webusb, WebUSB, USBOptions, getDeviceList, findByIds, findBySerialNumber, };
+export { usb, webusb, WebUSB, USBOptions, };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findBySerialNumber = exports.findByIds = exports.getDeviceList = exports.WebUSB = exports.webusb = void 0;
+exports.WebUSB = exports.webusb = exports.usb = void 0;
 const index_js_1 = require("../index.js");
 /**
  * Hidden
@@ -59,14 +59,16 @@ index_js_1.UsbDevice.prototype.transferOut = async function (endpointNumber, dat
 /**
  * Hidden
  */
-index_js_1.UsbDevice.prototype.isochronousTransferIn = async function (_endpointNumber, _packetLengths) {
-    throw new Error('isochronousTransferIn error: method not implemented');
+index_js_1.UsbDevice.prototype.isochronousTransferIn = async function (endpointNumber, packetLengths, timeout = DEFAULT_TIMEOUT) {
+    const res = await this.nativeIsochronousTransferIn(endpointNumber, packetLengths, timeout);
+    return res;
 };
 /**
  * Hidden
  */
-index_js_1.UsbDevice.prototype.isochronousTransferOut = async function (_endpointNumber, _data, _packetLengths) {
-    throw new Error('isochronousTransferOut error: method not implemented');
+index_js_1.UsbDevice.prototype.isochronousTransferOut = async function (endpointNumber, data, packetLengths, timeout = DEFAULT_TIMEOUT) {
+    const res = await this.nativeIsochronousTransferOut(endpointNumber, toUint8Array(data), packetLengths, timeout);
+    return res;
 };
 class NamedError extends Error {
     constructor(message, name) {
@@ -120,7 +122,7 @@ class WebUSB extends EventTarget {
         this.nativeEmitter.start();
         this.nativeEmitter.addAttach(deviceConnectCallback);
         this.nativeEmitter.addDetach(deviceDisconnectCallback);
-        getDeviceList().then(devices => devices.forEach(device => this.knownDevices.set(device.handle, device)));
+        (0, index_js_1.nativeGetDevices)().then(devices => devices.forEach(device => this.knownDevices.set(device.handle, device)));
     }
     set onconnect(fn) {
         if (this._onconnect) {
@@ -210,8 +212,25 @@ class WebUSB extends EventTarget {
         const devices = await this.loadDevices(preFilters);
         return devices.filter(device => this.isAuthorisedDevice(device));
     }
+    /**
+     * Convenience method to get the first device with the specified VID and PID, or `undefined` if no such device is present.
+     * @param vid
+     * @param pid
+     */
+    async findDeviceByIds(vid, pid) {
+        const device = await (0, index_js_1.nativeFindDeviceByIds)(vid, pid);
+        return device || undefined;
+    }
+    /**
+     * Convenience method to get the device with the specified serial number, or `undefined` if no such device is present.
+     * @param serialNumber
+     */
+    async findDeviceBySerial(serialNumber) {
+        const device = await (0, index_js_1.nativeFindDeviceBySerial)(serialNumber);
+        return device || undefined;
+    }
     async loadDevices(preFilters) {
-        let devices = await getDeviceList();
+        let devices = await (0, index_js_1.nativeGetDevices)();
         // Pre-filter devices
         devices = this.quickFilter(devices, preFilters);
         return devices;
@@ -304,32 +323,12 @@ class WebUSB extends EventTarget {
 }
 exports.WebUSB = WebUSB;
 /**
- * Convenience method to get an array of all connected devices.
+ * Default USB object (allows all devices by default)
  */
-const getDeviceList = async () => {
-    const devices = await (0, index_js_1.nativeGetDeviceList)();
-    return devices;
-};
-exports.getDeviceList = getDeviceList;
-/**
- * Convenience method to get the first device with the specified VID and PID, or `undefined` if no such device is present.
- * @param vid
- * @param pid
- */
-const findByIds = async (vid, pid) => {
-    const device = await (0, index_js_1.nativeFindByIds)(vid, pid);
-    return device;
-};
-exports.findByIds = findByIds;
-/**
- * Convenience method to get the device with the specified serial number, or `undefined` if no such device is present.
- * @param serialNumber
- */
-const findBySerialNumber = async (serialNumber) => {
-    const device = await (0, index_js_1.nativeFindBySerialNumber)(serialNumber);
-    return device;
-};
-exports.findBySerialNumber = findBySerialNumber;
+const usb = new WebUSB({
+    allowAllDevices: true
+});
+exports.usb = usb;
 /**
  * Default WebUSB object (mimics navigator.usb)
  */

package/index.d.ts

@@ -77,18 +77,18 @@ export declare class UsbDevice {
   nativeControlTransferOut(setup: USBControlTransferParameters, timeout: number, data?: Uint8Array | undefined | null): Promise<number>
   nativeTransferIn(endpointNumber: number, timeout: number, length: number): Promise<Uint8Array | null>
   nativeTransferOut(endpointNumber: number, timeout: number, data: Uint8Array): Promise<number>
-  nativeIsochronousTransferIn(endpointNumber: number, packetLengths: Array<number>): Promise<USBIsochronousInTransferResult>
-  nativeIsochronousTransferOut(endpointNumber: number, data: Uint8Array, packetLengths: Array<number>): Promise<USBIsochronousOutTransferResult>
+  nativeIsochronousTransferIn(endpointNumber: number, packetLengths: Array<number>, timeout: number): Promise<USBIsochronousInTransferResult>
+  nativeIsochronousTransferOut(endpointNumber: number, data: Uint8Array, packetLengths: Array<number>, timeout: number): Promise<USBIsochronousOutTransferResult>
   clearHalt(direction: USBDirection, endpointNumber: number): Promise<void>
   detachKernelDriver(interfaceNumber: number): Promise<void>
   attachKernelDriver(interfaceNumber: number): Promise<void>
 }
 
-export declare function nativeFindByIds(vendorId: number, productId: number): Promise<UsbDevice>
+export declare function nativeFindDeviceByIds(vendorId: number, productId: number): Promise<UsbDevice | null>
 
-export declare function nativeFindBySerialNumber(serialNumber: string): Promise<UsbDevice>
+export declare function nativeFindDeviceBySerial(serialNumber: string): Promise<UsbDevice | null>
 
-export declare function nativeGetDeviceList(): Promise<Array<UsbDevice>>
+export declare function nativeGetDevices(): Promise<Array<UsbDevice>>
 
 export interface UsbAlternateInterface {
   alternateSetting: number

package/index.js

@@ -77,8 +77,8 @@ function requireNative() {
       try {
         const binding = require('@node-usb/usb-android-arm64')
         const bindingPackageVersion = require('@node-usb/usb-android-arm64/package.json').version
-        if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -93,8 +93,8 @@ function requireNative() {
       try {
         const binding = require('@node-usb/usb-android-arm-eabi')
         const bindingPackageVersion = require('@node-usb/usb-android-arm-eabi/package.json').version
-        if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -114,8 +114,8 @@ function requireNative() {
       try {
         const binding = require('@node-usb/usb-win32-x64-gnu')
         const bindingPackageVersion = require('@node-usb/usb-win32-x64-gnu/package.json').version
-        if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -130,8 +130,8 @@ function requireNative() {
       try {
         const binding = require('@node-usb/usb-win32-x64-msvc')
         const bindingPackageVersion = require('@node-usb/usb-win32-x64-msvc/package.json').version
-        if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -147,8 +147,8 @@ function requireNative() {
       try {
         const binding = require('@node-usb/usb-win32-ia32-msvc')
         const bindingPackageVersion = require('@node-usb/usb-win32-ia32-msvc/package.json').version
-        if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -163,8 +163,8 @@ function requireNative() {
       try {
         const binding = require('@node-usb/usb-win32-arm64-msvc')
         const bindingPackageVersion = require('@node-usb/usb-win32-arm64-msvc/package.json').version
-        if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -182,8 +182,8 @@ function requireNative() {
     try {
       const binding = require('@node-usb/usb-darwin-universal')
       const bindingPackageVersion = require('@node-usb/usb-darwin-universal/package.json').version
-      if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-        throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+      if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+        throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
       }
       return binding
     } catch (e) {
@@ -198,8 +198,8 @@ function requireNative() {
       try {
         const binding = require('@node-usb/usb-darwin-x64')
         const bindingPackageVersion = require('@node-usb/usb-darwin-x64/package.json').version
-        if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -214,8 +214,8 @@ function requireNative() {
       try {
         const binding = require('@node-usb/usb-darwin-arm64')
         const bindingPackageVersion = require('@node-usb/usb-darwin-arm64/package.json').version
-        if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -234,8 +234,8 @@ function requireNative() {
       try {
         const binding = require('@node-usb/usb-freebsd-x64')
         const bindingPackageVersion = require('@node-usb/usb-freebsd-x64/package.json').version
-        if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -250,8 +250,8 @@ function requireNative() {
       try {
         const binding = require('@node-usb/usb-freebsd-arm64')
         const bindingPackageVersion = require('@node-usb/usb-freebsd-arm64/package.json').version
-        if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -271,8 +271,8 @@ function requireNative() {
         try {
           const binding = require('@node-usb/usb-linux-x64-musl')
           const bindingPackageVersion = require('@node-usb/usb-linux-x64-musl/package.json').version
-          if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -287,8 +287,8 @@ function requireNative() {
         try {
           const binding = require('@node-usb/usb-linux-x64-gnu')
           const bindingPackageVersion = require('@node-usb/usb-linux-x64-gnu/package.json').version
-          if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -305,8 +305,8 @@ function requireNative() {
         try {
           const binding = require('@node-usb/usb-linux-arm64-musl')
           const bindingPackageVersion = require('@node-usb/usb-linux-arm64-musl/package.json').version
-          if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -321,8 +321,8 @@ function requireNative() {
         try {
           const binding = require('@node-usb/usb-linux-arm64-gnu')
           const bindingPackageVersion = require('@node-usb/usb-linux-arm64-gnu/package.json').version
-          if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -339,8 +339,8 @@ function requireNative() {
         try {
           const binding = require('@node-usb/usb-linux-arm-musleabihf')
           const bindingPackageVersion = require('@node-usb/usb-linux-arm-musleabihf/package.json').version
-          if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -355,8 +355,8 @@ function requireNative() {
         try {
           const binding = require('@node-usb/usb-linux-arm-gnueabihf')
           const bindingPackageVersion = require('@node-usb/usb-linux-arm-gnueabihf/package.json').version
-          if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -373,8 +373,8 @@ function requireNative() {
         try {
           const binding = require('@node-usb/usb-linux-loong64-musl')
           const bindingPackageVersion = require('@node-usb/usb-linux-loong64-musl/package.json').version
-          if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -389,8 +389,8 @@ function requireNative() {
         try {
           const binding = require('@node-usb/usb-linux-loong64-gnu')
           const bindingPackageVersion = require('@node-usb/usb-linux-loong64-gnu/package.json').version
-          if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -407,8 +407,8 @@ function requireNative() {
         try {
           const binding = require('@node-usb/usb-linux-riscv64-musl')
           const bindingPackageVersion = require('@node-usb/usb-linux-riscv64-musl/package.json').version
-          if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -423,8 +423,8 @@ function requireNative() {
         try {
           const binding = require('@node-usb/usb-linux-riscv64-gnu')
           const bindingPackageVersion = require('@node-usb/usb-linux-riscv64-gnu/package.json').version
-          if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -440,8 +440,8 @@ function requireNative() {
       try {
         const binding = require('@node-usb/usb-linux-ppc64-gnu')
         const bindingPackageVersion = require('@node-usb/usb-linux-ppc64-gnu/package.json').version
-        if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -456,8 +456,8 @@ function requireNative() {
       try {
         const binding = require('@node-usb/usb-linux-s390x-gnu')
         const bindingPackageVersion = require('@node-usb/usb-linux-s390x-gnu/package.json').version
-        if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -476,8 +476,8 @@ function requireNative() {
       try {
         const binding = require('@node-usb/usb-openharmony-arm64')
         const bindingPackageVersion = require('@node-usb/usb-openharmony-arm64/package.json').version
-        if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -492,8 +492,8 @@ function requireNative() {
       try {
         const binding = require('@node-usb/usb-openharmony-x64')
         const bindingPackageVersion = require('@node-usb/usb-openharmony-x64/package.json').version
-        if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -508,8 +508,8 @@ function requireNative() {
       try {
         const binding = require('@node-usb/usb-openharmony-arm')
         const bindingPackageVersion = require('@node-usb/usb-openharmony-arm/package.json').version
-        if (bindingPackageVersion !== '3.0.0-alpha.3' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.3 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '3.0.0-alpha.4' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 3.0.0-alpha.4 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -578,6 +578,6 @@ if (!nativeBinding) {
 module.exports = nativeBinding
 module.exports.Emitter = nativeBinding.Emitter
 module.exports.UsbDevice = nativeBinding.UsbDevice
-module.exports.nativeFindByIds = nativeBinding.nativeFindByIds
-module.exports.nativeFindBySerialNumber = nativeBinding.nativeFindBySerialNumber
-module.exports.nativeGetDeviceList = nativeBinding.nativeGetDeviceList
+module.exports.nativeFindDeviceByIds = nativeBinding.nativeFindDeviceByIds
+module.exports.nativeFindDeviceBySerial = nativeBinding.nativeFindDeviceBySerial
+module.exports.nativeGetDevices = nativeBinding.nativeGetDevices

package/package.json

@@ -2,7 +2,7 @@
   "name": "usb",
   "description": "Library to access USB devices",
   "license": "MIT",
-  "version": "3.0.0-alpha.3",
+  "version": "3.0.0-alpha.4",
   "main": "dist/index.js",
   "engines": {
     "node": ">= 12.22.0 < 13 || >= 14.17.0 < 15 || >= 15.12.0 < 16 || >= 16.0.0"
@@ -84,15 +84,15 @@
     "index.js"
   ],
   "optionalDependencies": {
-    "@node-usb/usb-win32-x64-msvc": "3.0.0-alpha.3",
-    "@node-usb/usb-darwin-x64": "3.0.0-alpha.3",
-    "@node-usb/usb-linux-x64-gnu": "3.0.0-alpha.3",
-    "@node-usb/usb-linux-x64-musl": "3.0.0-alpha.3",
-    "@node-usb/usb-linux-arm64-gnu": "3.0.0-alpha.3",
-    "@node-usb/usb-win32-ia32-msvc": "3.0.0-alpha.3",
-    "@node-usb/usb-linux-arm-gnueabihf": "3.0.0-alpha.3",
-    "@node-usb/usb-darwin-arm64": "3.0.0-alpha.3",
-    "@node-usb/usb-linux-arm64-musl": "3.0.0-alpha.3",
-    "@node-usb/usb-win32-arm64-msvc": "3.0.0-alpha.3"
+    "@node-usb/usb-win32-x64-msvc": "3.0.0-alpha.4",
+    "@node-usb/usb-darwin-x64": "3.0.0-alpha.4",
+    "@node-usb/usb-linux-x64-gnu": "3.0.0-alpha.4",
+    "@node-usb/usb-linux-x64-musl": "3.0.0-alpha.4",
+    "@node-usb/usb-linux-arm64-gnu": "3.0.0-alpha.4",
+    "@node-usb/usb-win32-ia32-msvc": "3.0.0-alpha.4",
+    "@node-usb/usb-linux-arm-gnueabihf": "3.0.0-alpha.4",
+    "@node-usb/usb-darwin-arm64": "3.0.0-alpha.4",
+    "@node-usb/usb-linux-arm64-musl": "3.0.0-alpha.4",
+    "@node-usb/usb-win32-arm64-msvc": "3.0.0-alpha.4"
   }
 }