usb 3.0.0-alpha.1 → 3.0.0-alpha.3

package/README.md

@@ -1,93 +1,190 @@
-# `@napi-rs/package-template`
+# USB Library for Node.JS
 
-npm run clean
-npm i
-npm run build:all
+[![Build Status](https://github.com/node-usb/node-usb-rs/workflows/ci/badge.svg)](https://github.com/node-usb/node-usb-rs/actions)
+[![npm](https://img.shields.io/npm/dm/usb.svg)](https://www.npmjs.com/package/usb)
+[![Licence MIT](https://img.shields.io/badge/licence-MIT-blue.svg)](http://opensource.org/licenses/MIT)
+
+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/).
+
+# Prerequisites
 
+[Node.js >= v12.22.0](https://nodejs.org), which includes `npm`.
 
+## Windows
 
-![https://github.com/napi-rs/package-template/actions](https://github.com/napi-rs/package-template/workflows/CI/badge.svg)
+On Windows, if you get a `NOT_SUPPORTED` error when attempting to open your device, it's possible your device doesn't have a WinUSB driver to use.
 
-> Template project for writing node packages with napi-rs.
+You can install one using [Zadig](http://zadig.akeo.ie/).
+
+## Linux
+
+You may need to modify your udev and permission rules in order to access your desired device. Along the lines of:
+
+```code
+SUBSYSTEM=="usb", ATTR{idVendor}=="USB-VENDOR-ID", ATTR{idProduct}=="USB-PRODUCT-ID", MODE="0660", GROUP="GROUP-YOUR-USER-IS-IN"
+```
 
-# Usage
+# Installation
 
-1. Click **Use this template**.
-2. **Clone** your project.
-3. Run `yarn install` to install dependencies.
-4. Run `yarn napi rename -n [@your-scope/package-name] -b [binary-name]` command under the project folder to rename your package.
+Native modules are bundled as separate optional packages, so installation should be as simple as installing the package.
 
-## Install this test package
+With `npm`:
 
 ```bash
-yarn add @napi-rs/package-template
+npm install usb
 ```
 
-## Ability
+With `yarn`:
 
-### Build
+```bash
+yarn add usb
+```
 
-After `yarn build/npm run build` command, you can see `package-template.[darwin|win32|linux].node` file in project root. This is the native addon built from [lib.rs](./src/lib.rs).
+# License
+[MIT](LICENSE.md)
 
-### Test
+# Limitations
+Does not support:
 
-With [ava](https://github.com/avajs/ava), run `yarn test/npm run test` to testing native addon. You can also switch to another testing framework if you want.
+- Isochronous transfers
 
-### CI
+# Getting Started
+Use the following examples to kickstart your development. Once you have a desired device, use the APIs below to interact with it.
 
-With GitHub Actions, each commit and pull request will be built and tested automatically in [`node@20`, `@node22`] x [`macOS`, `Linux`, `Windows`] matrix. You will never be afraid of the native addon broken in these platforms.
+## APIs
+Since `v3.0.0`, the `node-usb` library supports the WebUSB API which follows the [WebUSB Specification](https://wicg.github.io/webusb/)
 
-### Release
+Convenience methods also exist to easily list or find devices.
 
-Release native package is very difficult in old days. Native packages may ask developers who use it to install `build toolchain` like `gcc/llvm`, `node-gyp` or something more.
+Full auto-generated API documentation can be seen here:
 
-With `GitHub actions`, we can easily prebuild a `binary` for major platforms. And with `N-API`, we should never be afraid of **ABI Compatible**.
+https://node-usb.github.io/node-usb-rs/
 
-The other problem is how to deliver prebuild `binary` to users. Downloading it in `postinstall` script is a common way that most packages do it right now. The problem with this solution is it introduced many other packages to download binary that has not been used by `runtime codes`. The other problem is some users may not easily download the binary from `GitHub/CDN` if they are behind a private network (But in most cases, they have a private NPM mirror).
+## Electron
+Please refer to the maintained example for using `node-usb` in electron:
 
-In this package, we choose a better way to solve this problem. We release different `npm packages` for different platforms. And add it to `optionalDependencies` before releasing the `Major` package to npm.
+https://github.com/node-usb/node-usb-example-electron
 
-`NPM` will choose which native package should download from `registry` automatically. You can see [npm](./npm) dir for details. And you can also run `yarn add @napi-rs/package-template` to see how it works.
+If using a packaging system for electron, ensure the `node-usb` library does not get recompiled as the correct binaries are already shipped with the package. For example, for [electron-builder](https://www.electron.build/), use these settings:
 
-## Develop requirements
+- buildDependenciesFromSource: true
+- nodeGypRebuild: false
+- npmRebuild: false
 
-- Install the latest `Rust`
-- Install `Node.js@10+` which fully supported `Node-API`
-- Install `yarn@1.x`
+## Convenience Functions
 
-## Test in local
+### getDeviceList()
+Return a list of `USB` objects for the USB devices attached to the system.
 
-- yarn
-- yarn build
-- yarn test
+### findByIds(vid, pid)
+Convenience method to get the first device with the specified VID and PID, or `undefined` if no such device is present.
 
-And you will see:
+### findBySerialNumber(serialNumber)
+Convenience method to get the device with the specified serial number, or `undefined` if no such device is present.
 
-```bash
-$ ava --verbose
+## WebUSB
 
-  ✔ sync function from native code
-  ✔ sleep function from native code (201ms)
-  ─
+Please refer to the WebUSB specification which be found here:
 
-  2 tests passed
-✨  Done in 1.12s.
-```
+https://wicg.github.io/webusb/
+
+### Implementation Status
+
+#### 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
 
-## Release package
+#### USB
 
-Ensure you have set your **NPM_TOKEN** in the `GitHub` project setting.
+- [x] getDevices()
+- [x] requestDevice()
 
-In `Settings -> Secrets`, add **NPM_TOKEN** into it.
+#### USBDevice
 
-When you want to release the package:
+##### WebUSB Features
+
+- [x] usbVersionMajor
+- [x] usbVersionMinor
+- [x] usbVersionSubminor
+- [x] deviceClass
+- [x] deviceSubclass
+- [x] deviceProtocol
+- [x] vendorId
+- [x] productId
+- [x] deviceVersionMajor
+- [x] deviceVersionMinor
+- [x] deviceVersionSubminor
+- [x] manufacturerName
+- [x] productName
+- [x] serialNumber
+- [x] configuration
+- [x] configurations
+- [x] opened
+- [x] open()
+- [x] close()
+- [x] selectConfiguration()
+- [x] claimInterface()
+- [x] releaseInterface()
+- [x] selectAlternateInterface()
+- [x] controlTransferIn()
+- [x] controlTransferOut()
+- [x] transferIn()
+- [x] transferOut()
+- [x] clearHalt()
+- [x] reset()
+- [x] forget()
+- [ ] isochronousTransferIn()
+- [ ] isochronousTransferOut()
+
+##### Extended Features
+
+- [x] bus
+- [x] address
+- [x] ports
+- [x] speed
+- [x] detachKernelDriver() (Linux only)
+- [x] attachKernelDriver() (Linux only)
+
+#### Events
+
+- [x] connect
+- [x] disconnect
+
+# Development
+The library is based on native rust bindings wrapping the [nusb](https://docs.rs/nusb/latest/nusb) crate.
+
+Ensure you have a working rust environment, instructions for setting this up are avalable at https://rust-lang.org/tools/install/
+
+## Setup
 
 ```bash
-npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git]
+git clone https://github.com/node-usb/node-usb-rs
+```
+
+## Building
+The package can be built as follows:
 
-git push
+```bash
+npm install
+npm run build:all
 ```
 
-GitHub actions will do the rest job for you.
+## Testing
+To execute the unit tests, Run:
+
+```bash
+npm run full-test
+```
 
-> WARN: Don't run `npm publish` manually.
+Some tests require an [attached STM32F103 Microprocessor USB device with specific firmware](https://github.com/node-usb/node-usb-test-firmware).

package/dist/index.d.ts

@@ -1,5 +1,4 @@
-import { Emitter } from '../index.js';
-import { EventEmitter } from 'events';
+import { UsbDevice, Emitter } from '../index.js';
 /**
  * USB Options
  */
@@ -7,7 +6,7 @@ interface USBOptions {
     /**
      * Optional `device found` callback function to allow the user to select a device
      */
-    devicesFound?: (devices: USBDevice[]) => Promise<USBDevice | void>;
+    devicesFound?: (devices: UsbDevice[]) => Promise<UsbDevice | void>;
     /**
      * Optional array of preconfigured allowed devices
      */
@@ -20,38 +19,44 @@ interface USBOptions {
      * Optional timeout (in milliseconds) to use for the device control transfers
      */
     deviceTimeout?: number;
-    /**
-     * Optional flag to enable/disable automatic kernal driver detaching (defaults to true)
-     */
-    autoDetachKernelDriver?: boolean;
 }
-declare class WebUSB implements USB {
+interface WebUSB {
+    addEventListener(type: "connect" | "disconnect", listener: (this: this, ev: USBConnectionEvent) => any, useCapture?: boolean): void;
+    addEventListener(type: string, listener: EventListenerOrEventListenerObject | null, options?: boolean | AddEventListenerOptions): void;
+    removeEventListener(type: "connect" | "disconnect", callback: (this: this, ev: USBConnectionEvent) => any, useCapture?: boolean): void;
+    removeEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: EventListenerOptions | boolean): void;
+}
+/**
+ * WebUSB class
+ *
+ * ### Events
+ *
+ * | Name | Event | Description |
+ * | ---- | ----- | ----------- |
+ * | `connect` | {@link USBConnectionEvent} | Device connected |
+ * | `disconnect` | {@link USBConnectionEvent} | Device disconnected |
+ */
+declare class WebUSB extends EventTarget implements USB {
     private options;
     protected nativeEmitter: Emitter;
-    protected emitter: EventEmitter<any>;
     protected authorisedDevices: Set<USBDeviceFilter>;
-    protected knownDevices: Map<string, USBDevice>;
+    protected knownDevices: Map<string, UsbDevice>;
     constructor(options?: USBOptions);
     private _onconnect;
     set onconnect(fn: (ev: USBConnectionEvent) => void);
     private _ondisconnect;
     set ondisconnect(fn: (ev: USBConnectionEvent) => void);
-    addEventListener(type: 'connect' | 'disconnect', listener: (this: this, ev: USBConnectionEvent) => void): void;
-    addEventListener(type: 'connect' | 'disconnect', listener: EventListener): void;
-    removeEventListener(type: 'connect' | 'disconnect', callback: (this: this, ev: USBConnectionEvent) => void): void;
-    removeEventListener(type: 'connect' | 'disconnect', callback: EventListener): void;
-    dispatchEvent(_event: Event): boolean;
     /**
      * Requests a single Web USB device
      * @param options The options to use when scanning
      * @returns Promise containing the selected device
      */
-    requestDevice(options?: USBDeviceRequestOptions): Promise<USBDevice>;
+    requestDevice(options?: USBDeviceRequestOptions): Promise<UsbDevice>;
     /**
      * Gets all allowed Web USB devices which are connected
      * @returns Promise containing an array of devices
      */
-    getDevices(): Promise<USBDevice[]>;
+    getDevices(): Promise<UsbDevice[]>;
     private loadDevices;
     private quickFilter;
     private filterDevice;
@@ -60,17 +65,20 @@ declare class WebUSB implements USB {
 /**
  * Convenience method to get an array of all connected devices.
  */
-declare const getDeviceList: () => Promise<USBDevice[]>;
+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>;
+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
  */
-declare const findBySerialNumber: (serialNumber: string) => Promise<USBDevice | undefined>;
+declare const findBySerialNumber: (serialNumber: string) => Promise<UsbDevice | undefined>;
+/**
+ * Default WebUSB object (mimics navigator.usb)
+ */
 declare const webusb: WebUSB | USB;
 export { webusb, WebUSB, USBOptions, getDeviceList, findByIds, findBySerialNumber, };

package/dist/index.js

@@ -2,132 +2,125 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.findBySerialNumber = exports.findByIds = exports.getDeviceList = exports.WebUSB = exports.webusb = void 0;
 const index_js_1 = require("../index.js");
-const events_1 = require("events");
+/**
+ * Hidden
+ */
+const DEFAULT_TIMEOUT = 1000;
+/**
+ * Hidden
+ */
+const toUint8Array = (data) => {
+    if (data instanceof ArrayBuffer) {
+        return new Uint8Array(data);
+    }
+    // ArrayBufferView
+    return new Uint8Array(data.buffer, data.byteOffset, data.byteLength);
+};
+/**
+ * Hidden
+ */
+index_js_1.UsbDevice.prototype.controlTransferIn = async function (setup, length, timeout = DEFAULT_TIMEOUT) {
+    const res = await this.nativeControlTransferIn(setup, timeout, length);
+    return {
+        data: res ? new DataView(res.buffer) : undefined,
+        status: res ? 'ok' : 'stall',
+    };
+};
+/**
+ * Hidden
+ */
+index_js_1.UsbDevice.prototype.controlTransferOut = async function (setup, data, timeout = DEFAULT_TIMEOUT) {
+    const res = await this.nativeControlTransferOut(setup, timeout, toUint8Array(data));
+    return {
+        bytesWritten: res,
+        status: res >= 0 ? 'ok' : 'stall',
+    };
+};
+/**
+ * Hidden
+ */
+index_js_1.UsbDevice.prototype.transferIn = async function (endpointNumber, length, timeout = DEFAULT_TIMEOUT) {
+    const res = await this.nativeTransferIn(endpointNumber, timeout, length);
+    return {
+        data: res ? new DataView(res.buffer) : undefined,
+        status: res ? 'ok' : 'stall',
+    };
+};
+/**
+ * Hidden
+ */
+index_js_1.UsbDevice.prototype.transferOut = async function (endpointNumber, data, timeout = DEFAULT_TIMEOUT) {
+    const res = await this.nativeTransferOut(endpointNumber, timeout, toUint8Array(data));
+    return {
+        bytesWritten: res,
+        status: res >= 0 ? 'ok' : 'stall',
+    };
+};
+/**
+ * Hidden
+ */
+index_js_1.UsbDevice.prototype.isochronousTransferIn = async function (_endpointNumber, _packetLengths) {
+    throw new Error('isochronousTransferIn error: method not implemented');
+};
+/**
+ * Hidden
+ */
+index_js_1.UsbDevice.prototype.isochronousTransferOut = async function (_endpointNumber, _data, _packetLengths) {
+    throw new Error('isochronousTransferOut error: method not implemented');
+};
 class NamedError extends Error {
     constructor(message, name) {
         super(message);
         this.name = name;
     }
 }
-const augmentDevice = (device) => {
-    const toUint8Array = (data) => {
-        if (data instanceof ArrayBuffer) {
-            return new Uint8Array(data);
-        }
-        // ArrayBufferView
-        return new Uint8Array(data.buffer, data.byteOffset, data.byteLength);
-    };
-    Object.defineProperty(device, 'controlTransferIn', {
-        enumerable: false,
-        configurable: false,
-        value: async function (setup, length) {
-            const res = await this.nativeControlTransferIn(setup, length);
-            return {
-                data: res ? new DataView(res.buffer) : undefined,
-                status: res ? 'ok' : 'stall',
-            };
-        },
-    });
-    Object.defineProperty(device, 'controlTransferOut', {
-        enumerable: false,
-        configurable: false,
-        value: async function (setup, data) {
-            const res = await this.nativeControlTransferOut(setup, toUint8Array(data));
-            return {
-                bytesWritten: res,
-                status: res >= 0 ? 'ok' : 'stall',
-            };
-        },
-    });
-    Object.defineProperty(device, 'transferIn', {
-        enumerable: false,
-        configurable: false,
-        value: async function (endpointNumber, length) {
-            const res = await this.nativeTransferIn(endpointNumber, length);
-            return {
-                data: res ? new DataView(res.buffer) : undefined,
-                status: res ? 'ok' : 'stall',
-            };
-        },
-    });
-    Object.defineProperty(device, 'transferOut', {
-        enumerable: false,
-        configurable: false,
-        value: async function (endpointNumber, data) {
-            const res = await this.nativeTransferOut(endpointNumber, toUint8Array(data));
-            return {
-                bytesWritten: res,
-                status: res >= 0 ? 'ok' : 'stall',
-            };
-        },
-    });
-    return device;
-};
-class WebUSB {
+class ConnectionEvent extends Event {
+    constructor(type, eventInitDict) {
+        super(type, eventInitDict);
+        this.eventInitDict = eventInitDict;
+    }
+    get device() {
+        return this.eventInitDict.device;
+    }
+}
+/**
+ * WebUSB class
+ *
+ * ### Events
+ *
+ * | Name | Event | Description |
+ * | ---- | ----- | ----------- |
+ * | `connect` | {@link USBConnectionEvent} | Device connected |
+ * | `disconnect` | {@link USBConnectionEvent} | Device disconnected |
+ */
+class WebUSB extends EventTarget {
     constructor(options = {}) {
+        super();
         this.options = options;
         this.nativeEmitter = new index_js_1.Emitter();
-        this.emitter = new events_1.EventEmitter();
         this.authorisedDevices = new Set();
         this.knownDevices = new Map();
         const deviceConnectCallback = async (device) => {
-            const webDevice = augmentDevice(device);
-            this.knownDevices.set(device.handle, webDevice);
+            this.knownDevices.set(device.handle, device);
             // When connected, emit an event if it is an allowed device
-            if (webDevice && this.isAuthorisedDevice(webDevice)) {
-                const event = {
-                    type: 'connect',
-                    device: webDevice
-                };
-                this.emitter.emit('connect', event);
+            if (device && this.isAuthorisedDevice(device)) {
+                this.dispatchEvent(new ConnectionEvent('connect', { device }));
             }
         };
         const deviceDisconnectCallback = async (handle) => {
             // When disconnected, emit an event if the device was a known allowed device
             if (this.knownDevices.has(handle)) {
-                const webDevice = this.knownDevices.get(handle);
-                if (webDevice && this.isAuthorisedDevice(webDevice)) {
-                    const event = {
-                        type: 'disconnect',
-                        device: webDevice
-                    };
-                    this.emitter.emit('disconnect', event);
+                const device = this.knownDevices.get(handle);
+                if (device && this.isAuthorisedDevice(device)) {
+                    this.dispatchEvent(new ConnectionEvent('disconnect', { device }));
                 }
                 this.knownDevices.delete(handle);
             }
         };
-        this.emitter.on('newListener', async (event) => {
-            const listenerCount = this.emitter.listenerCount(event);
-            if (listenerCount !== 0) {
-                return;
-            }
-            if (event === 'connect') {
-                this.nativeEmitter.addAttach(deviceConnectCallback);
-            }
-            else if (event === 'disconnect') {
-                // Ensure we know the current devices
-                this.knownDevices.clear();
-                const devices = await (0, index_js_1.nativeGetDeviceList)();
-                devices.forEach(device => {
-                    this.knownDevices.set(device.handle, augmentDevice(device));
-                });
-                this.nativeEmitter.addDetach(deviceDisconnectCallback);
-            }
-        });
-        this.emitter.on('removeListener', event => {
-            const listenerCount = this.emitter.listenerCount(event);
-            if (listenerCount !== 0) {
-                return;
-            }
-            if (event === 'connect') {
-                this.nativeEmitter.removeAttach(deviceConnectCallback);
-            }
-            else if (event === 'disconnect') {
-                this.knownDevices.clear();
-                this.nativeEmitter.removeDetach(deviceDisconnectCallback);
-            }
-        });
         this.nativeEmitter.start();
+        this.nativeEmitter.addAttach(deviceConnectCallback);
+        this.nativeEmitter.addDetach(deviceDisconnectCallback);
+        getDeviceList().then(devices => devices.forEach(device => this.knownDevices.set(device.handle, device)));
     }
     set onconnect(fn) {
         if (this._onconnect) {
@@ -149,16 +142,6 @@ class WebUSB {
             this.addEventListener('disconnect', this._ondisconnect);
         }
     }
-    addEventListener(type, listener) {
-        this.emitter.addListener(type, listener);
-    }
-    removeEventListener(type, callback) {
-        this.emitter.removeListener(type, callback);
-    }
-    dispatchEvent(_event) {
-        // Don't dispatch from here
-        return false;
-    }
     /**
      * Requests a single Web USB device
      * @param options The options to use when scanning
@@ -325,7 +308,7 @@ exports.WebUSB = WebUSB;
  */
 const getDeviceList = async () => {
     const devices = await (0, index_js_1.nativeGetDeviceList)();
-    return devices.map(device => augmentDevice(device));
+    return devices;
 };
 exports.getDeviceList = getDeviceList;
 /**
@@ -335,7 +318,7 @@ exports.getDeviceList = getDeviceList;
  */
 const findByIds = async (vid, pid) => {
     const device = await (0, index_js_1.nativeFindByIds)(vid, pid);
-    return device ? augmentDevice(device) : undefined;
+    return device;
 };
 exports.findByIds = findByIds;
 /**
@@ -344,9 +327,12 @@ exports.findByIds = findByIds;
  */
 const findBySerialNumber = async (serialNumber) => {
     const device = await (0, index_js_1.nativeFindBySerialNumber)(serialNumber);
-    return device ? augmentDevice(device) : undefined;
+    return device;
 };
 exports.findBySerialNumber = findBySerialNumber;
+/**
+ * Default WebUSB object (mimics navigator.usb)
+ */
 const webusb = typeof navigator !== 'undefined' && navigator.usb ? navigator.usb : new WebUSB();
 exports.webusb = webusb;
 //# sourceMappingURL=index.js.map

package/index.d.ts

@@ -1,5 +1,38 @@
-/* auto-generated by NAPI-RS */
-/* eslint-disable */
+export type USBSpeed = 'low' | 'full' | 'high' | 'super' | 'superPlus';
+
+export declare interface UsbDevice extends USBDevice {
+    /**
+     * The USB bus the device is connected to (e.g. `1-1`, `2-3.4`, etc.)
+     */
+    bus: string;
+
+    /**
+     * The USB address the device is connected to
+     */
+    address: number;
+
+    /**
+     * The USB port numbers the device is connected through (e.g. `[1]`, `[3, 4]`, etc.)
+     */
+    ports: Array<number>
+
+    /**
+     * The USB speed of the device (e.g. `Low`, `Full`, `High`, `Super`, `SuperPlus` or `undefined` if unknown)
+     */
+    speed?: USBSpeed;
+
+    /**
+     * Detaches the kernel driver from the specified interface number (Linux only)
+     * @param interfaceNumber 
+     */
+    detachKernelDriver(interfaceNumber: number): Promise<void>;
+
+    /**
+     * Attaches the kernel driver for the specified interface number (Linux only)
+     * @param interfaceNumber 
+     */
+    attachKernelDriver(interfaceNumber: number): Promise<void>;
+}
 export declare class Emitter {
   constructor()
   start(): Promise<void>
@@ -21,13 +54,17 @@ export declare class UsbDevice {
   deviceClass: number
   deviceSubclass: number
   deviceProtocol: number
-  manufacturerName?: string
-  productName?: string
-  serialNumber?: string
+  bus: string
+  address: number
+  ports: Array<number>
+  speed?: USBSpeed
   get handle(): string
+  get manufacturerName(): string | null
+  get productName(): string | null
+  get serialNumber(): string | null
   get opened(): boolean
+  get configuration(): USBConfiguration
   get configurations(): Array<USBConfiguration>
-  get configuration(): USBConfiguration | null
   open(): Promise<void>
   close(): Promise<void>
   forget(): Promise<void>
@@ -36,13 +73,15 @@ export declare class UsbDevice {
   claimInterface(interfaceNumber: number): Promise<void>
   releaseInterface(interfaceNumber: number): Promise<void>
   selectAlternateInterface(interfaceNumber: number, alternateSetting: number): Promise<void>
-  nativeControlTransferIn(setup: USBControlTransferParameters, length: number): Promise<Uint8Array | null>
-  nativeControlTransferOut(setup: USBControlTransferParameters, data?: Uint8Array | undefined | null): Promise<number>
-  nativeTransferIn(endpointNumber: number, length: number): Promise<Uint8Array | null>
-  nativeTransferOut(endpointNumber: number, data: Uint8Array): Promise<number>
-  isochronousTransferIn(endpointNumber: number, packetLengths: Array<number>): Promise<USBIsochronousInTransferResult>
-  isochronousTransferOut(endpointNumber: number, data: Uint8Array, packetLengths: Array<number>): Promise<USBIsochronousOutTransferResult>
+  nativeControlTransferIn(setup: USBControlTransferParameters, timeout: number, length: number): Promise<Uint8Array | null>
+  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>
   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>
@@ -51,19 +90,19 @@ export declare function nativeFindBySerialNumber(serialNumber: string): Promise<
 
 export declare function nativeGetDeviceList(): Promise<Array<UsbDevice>>
 
-export interface USBAlternateInterface {
+export interface UsbAlternateInterface {
   alternateSetting: number
   interfaceClass: number
   interfaceSubclass: number
   interfaceProtocol: number
   interfaceName?: string
-  endpoints: Array<USBEndpoint>
+  endpoints: Array<UsbEndpoint>
 }
 
-export interface USBConfiguration {
+export interface UsbConfiguration {
   configurationValue: number
   configurationName?: string
-  interfaces: Array<USBInterface>
+  interfaces: Array<UsbInterface>
 }
 
 export interface USBControlTransferParameters {
@@ -74,16 +113,16 @@ export interface USBControlTransferParameters {
   index: number
 }
 
-export interface USBEndpoint {
+export interface UsbEndpoint {
   endpointNumber: number
   direction: USBDirection
   type: USBEndpointType
   packetSize: number
 }
 
-export interface USBInterface {
+export interface UsbInterface {
   interfaceNumber: number
   claimed: boolean
-  alternate: USBAlternateInterface
-  alternates: Array<USBAlternateInterface>
+  alternate: UsbAlternateInterface
+  alternates: Array<UsbAlternateInterface>
 }

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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        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.`)
         }
         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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        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.`)
         }
         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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        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.`)
         }
         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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        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.`)
         }
         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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        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.`)
         }
         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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        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.`)
         }
         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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+      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.`)
       }
       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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        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.`)
         }
         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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        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.`)
         }
         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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        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.`)
         }
         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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        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.`)
         }
         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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          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.`)
           }
           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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          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.`)
           }
           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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          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.`)
           }
           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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          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.`)
           }
           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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          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.`)
           }
           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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          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.`)
           }
           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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          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.`)
           }
           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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          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.`)
           }
           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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          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.`)
           }
           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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          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.`)
           }
           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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        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.`)
         }
         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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        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.`)
         }
         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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        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.`)
         }
         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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        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.`)
         }
         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.1' && 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.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        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.`)
         }
         return binding
       } catch (e) {

package/package.json

@@ -2,14 +2,14 @@
   "name": "usb",
   "description": "Library to access USB devices",
   "license": "MIT",
-  "version": "3.0.0-alpha.1",
+  "version": "3.0.0-alpha.3",
   "main": "dist/index.js",
   "engines": {
     "node": ">= 12.22.0 < 13 || >= 14.17.0 < 15 || >= 15.12.0 < 16 || >= 16.0.0"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/node-usb/node-usb.git"
+    "url": "https://github.com/node-usb/node-usb-rs.git"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -49,21 +49,23 @@
     "prepublishOnly": "napi prepublish -t npm",
     "preversion": "napi build --platform && git add .",
     "version": "napi version",
-    "create-npm-dirs": "napi create-npm-dirs"
+    "create-npm-dirs": "napi create-npm-dirs",
+    "docs": "typedoc"
   },
   "dependencies": {
     "@types/w3c-web-usb": "^1.0.13"
   },
   "devDependencies": {
     "@napi-rs/cli": "^3.2.0",
-    "@types/node": "^25.0.10",
     "coffeescript": "^2.7.0",
     "mocha": "^11.7.5",
+    "typedoc": "^0.28.16",
     "typescript": "^5.9.3"
   },
   "napi": {
     "binaryName": "usb",
     "packageName": "@node-usb/usb",
+    "dtsHeaderFile": "./header.d.ts",
     "targets": [
       "x86_64-pc-windows-msvc",
       "x86_64-apple-darwin",
@@ -82,15 +84,15 @@
     "index.js"
   ],
   "optionalDependencies": {
-    "@node-usb/usb-win32-x64-msvc": "3.0.0-alpha.1",
-    "@node-usb/usb-darwin-x64": "3.0.0-alpha.1",
-    "@node-usb/usb-linux-x64-gnu": "3.0.0-alpha.1",
-    "@node-usb/usb-linux-x64-musl": "3.0.0-alpha.1",
-    "@node-usb/usb-linux-arm64-gnu": "3.0.0-alpha.1",
-    "@node-usb/usb-win32-ia32-msvc": "3.0.0-alpha.1",
-    "@node-usb/usb-linux-arm-gnueabihf": "3.0.0-alpha.1",
-    "@node-usb/usb-darwin-arm64": "3.0.0-alpha.1",
-    "@node-usb/usb-linux-arm64-musl": "3.0.0-alpha.1",
-    "@node-usb/usb-win32-arm64-msvc": "3.0.0-alpha.1"
+    "@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"
   }
 }