usb 2.5.2-alpha.1 → 2.6.0

package/.eslintrc.json

@@ -1,87 +0,0 @@
-{
-    "parser": "@typescript-eslint/parser",
-    "plugins": [
-        "@typescript-eslint"
-    ],
-    "extends": [
-        // https://eslint.org/docs/rules/
-        "eslint:recommended",
-        // https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin
-        "plugin:@typescript-eslint/recommended"
-    ],
-    "rules": {
-        "@typescript-eslint/no-empty-interface": [
-            "warn"
-        ],
-        "@typescript-eslint/no-this-alias": [
-            "warn"
-        ],
-        "@typescript-eslint/no-unused-vars": [
-            "warn",
-            {
-                "argsIgnorePattern": "^_"
-            }
-        ],
-        "block-spacing": [
-            "error",
-            "always"
-        ],
-        "brace-style": [
-            "error",
-            "1tbs",
-            {
-                "allowSingleLine": true
-            }
-        ],
-        "eol-last": [
-            "error"
-        ],
-        "indent": [
-            "error",
-            4,
-            {
-                "SwitchCase": 1
-            }
-        ],
-        "linebreak-style": [
-            "error",
-            "unix"
-        ],
-        "no-console": [
-            "warn"
-        ],
-        "no-constant-condition": [
-            "error",
-            {
-                "checkLoops": false
-            }
-        ],
-        "no-trailing-spaces": [
-            "error"
-        ],
-        "object-curly-spacing": [
-            "error",
-            "always"
-        ],
-        "quotes": [
-            "error",
-            "single"
-        ],
-        "semi": [
-            "error",
-            "always"
-        ]
-    },
-    "env": {
-        "commonjs": true,
-        "es6": true,
-        "node": true
-    },
-    "parserOptions": {
-        "ecmaVersion": 12,
-        "sourceType": "module",
-        "project": [
-            "./tsconfig.json"
-        ]
-    }
-}

package/.gitattributes

@@ -1 +0,0 @@
-* -text

package/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "libusb"]
-    path = libusb
-    url = https://github.com/libusb/libusb.git

package/.vscode/launch.json

@@ -1,15 +0,0 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Full Test",
-            "type": "node-terminal",
-            "request": "launch",
-            "preLaunchTask": "test",
-            "command": "exit 0",
-        }
-    ]
-}

package/.vscode/tasks.json

@@ -1,23 +0,0 @@
-{
-    "tasks": [
-        {
-            "label": "compile",
-            "type": "npm",
-            "script": "compile"
-        },
-        {
-            "label": "watch",
-            "type": "npm",
-            "script": "watch",
-            "group": {
-                "kind": "build",
-                "isDefault": true
-            }
-        },
-        {
-            "label": "test",
-            "type": "npm",
-            "script": "full-test"
-        }
-    ]
-}

package/libusb/.gitattributes

@@ -1,7 +0,0 @@
-*.ac            eol=lf
-*.am            eol=lf
-*.bat           eol=crlf
-*.sh            eol=lf
-.gitattributes  export-ignore
-.gitignore      export-ignore
-INSTALL_WIN.txt eol=crlf

package/libusb/msvc/.gitattributes

@@ -1,3 +0,0 @@
-*.sln                   eol=crlf
-*.vcxproj               eol=crlf
-*.vcxproj.filters       eol=crlf

package/tsc/index.ts

@@ -1,75 +0,0 @@
-import { promisify } from 'util';
-import { WebUSB, getWebUsb } from './webusb';
-import { WebUSBDevice } from './webusb/webusb-device';
-import * as usb from './usb';
-
-const webusb = new WebUSB();
-const getDeviceList = usb.getDeviceList;
-const useUsbDkBackend = usb.useUsbDkBackend;
-
-/**
- * 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 = (vid: number, pid: number): usb.Device | undefined => {
-    const devices = usb.getDeviceList();
-    return devices.find(item => item.deviceDescriptor.idVendor === vid && item.deviceDescriptor.idProduct === pid);
-};
-
-/**
- * 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: string): Promise<usb.Device | undefined> => {
-    const devices = usb.getDeviceList();
-    const opened = (device: usb.Device): boolean => !!device.interfaces;
-
-    for (const device of devices) {
-        try {
-            if (!opened(device)) {
-                device.open();
-            }
-
-            const getStringDescriptor = promisify(device.getStringDescriptor).bind(device);
-            const buffer = await getStringDescriptor(device.deviceDescriptor.iSerialNumber);
-
-            if (buffer && buffer.toString() === serialNumber) {
-                return device;
-            }
-        } catch {
-            // Ignore any errors, device may be a system device or inaccessible
-        } finally {
-            try {
-                if (opened(device)) {
-                    device.close();
-                }
-            } catch {
-                // Ignore any errors, device may be a system device or inaccessible
-            }
-        }
-    }
-
-    return undefined;
-};
-
-export {
-    // Core usb object for quick access
-    usb,
-
-    // Convenience methods
-    useUsbDkBackend,
-    getDeviceList,
-    findByIds,
-    findBySerialNumber,
-    getWebUsb,
-
-    // Default WebUSB object (mimics navigator.usb)
-    webusb,
-
-    // WebUSB class for creating custom webusb instances
-    WebUSB,
-
-    // WebUSB Device class for turning a legacy usb.Device into a webusb device
-    WebUSBDevice
-};

package/tsc/usb/bindings.ts

@@ -1,310 +0,0 @@
-// Definitions from DefinitelyTyped, thanks to:
-//  Eric Brody <https://github.com/underscorebrody>
-//  Rob Moran <https://github.com/thegecko>
-
-import { join } from 'path';
-import type { DeviceDescriptor, ConfigDescriptor, BosDescriptor } from './descriptors';
-
-/* eslint-disable @typescript-eslint/no-var-requires */
-const usb = require('node-gyp-build')(join(__dirname, '..', '..'));
-module.exports = usb;
-
-/**
- * Return a list of `Device` objects for the USB devices attached to the system.
- */
-export declare function getDeviceList(): Device[];
-
-export declare const INIT_ERROR: number;
-
-export declare class LibUSBException extends Error {
-    errno: number;
-}
-
-/**
- * Set the libusb debug level (between 0 and 4)
- * @param level libusb debug level (between 0 and 4)
- */
-export declare function setDebugLevel(level: number): void;
-
-/**
- * Use USBDK Backend (Windows only)
- */
-export declare function useUsbDkBackend(): void;
-
-export declare function _supportedHotplugEvents(): number;
-export declare function _enableHotplugEvents(): void;
-export declare function _disableHotplugEvents(): void;
-export declare function _getLibusbCapability(capability: number): number;
-
-/**
- * Restore (re-reference) the hotplug events unreferenced by `unrefHotplugEvents()`
- */
-export declare function refHotplugEvents(): void;
-
-/**
- * Unreference the hotplug events from the event loop, allowing the process to exit even when listening for the `attach` and `detach` events
- */
-export declare function unrefHotplugEvents(): void;
-
-/** Represents a USB transfer */
-export declare class Transfer {
-    constructor(device: Device, endpointAddr: number, type: number, timeout: number, callback: (error: LibUSBException, buf: Buffer, actual: number) => void);
-
-    /**
-     * (Re-)submit the transfer.
-     *
-     * @param buffer Buffer where data will be written (for IN transfers) or read from (for OUT transfers).
-     */
-    submit(buffer: Buffer, callback?: (error: LibUSBException | undefined, buffer: Buffer, actualLength: number) => void): Transfer;
-
-    /**
-     * Cancel the transfer.
-     *
-     * Returns `true` if the transfer was canceled, `false` if it wasn't in pending state.
-     */
-    cancel(): boolean;
-}
-
-/** Represents a USB device. */
-export declare class Device {
-    /** Integer USB device number */
-    busNumber: number;
-
-    /** Integer USB device address */
-    deviceAddress: number;
-
-    /** Array containing the USB device port numbers, or `undefined` if not supported on this platform. */
-    portNumbers: number[];
-
-    /** Object with properties for the fields of the device descriptor. */
-    deviceDescriptor: DeviceDescriptor;
-
-    _bosDescriptor?: BosDescriptor;
-
-    __open(): void;
-    __close(): void;
-    __getParent(): Device;
-    __getConfigDescriptor(): ConfigDescriptor;
-    __getAllConfigDescriptors(): ConfigDescriptor[];
-    __setConfiguration(desired: number, callback: (error?: LibUSBException) => void): void;
-    __clearHalt(addr: number, callback: (error?: LibUSBException) => void): void;
-    __setInterface(addr: number, altSetting: number, callback: (error?: LibUSBException) => void): void;
-    __claimInterface(addr: number): void;
-    __releaseInterface(addr: number, callback: (error?: LibUSBException) => void): void;
-    __detachKernelDriver(addr: number): void;
-    __attachKernelDriver(addr: number): void;
-    __isKernelDriverActive(addr: number): boolean;
-
-    /**
-    * Performs a reset of the device. Callback is called when complete.
-    *
-    * The device must be open to use this method.
-    * @param callback
-    */
-    reset(callback: (error?: LibUSBException) => void): void;
-}
-
-/**
- * In the context of a \ref libusb_device_descriptor "device descriptor",
- * this bDeviceClass value indicates that each interface specifies its
- * own class information and all interfaces operate independently.
- */
-export declare const LIBUSB_CLASS_PER_INTERFACE: number;
-/** Audio class */
-export declare const LIBUSB_CLASS_AUDIO: number;
-/** Communications class */
-export declare const LIBUSB_CLASS_COMM: number;
-/** Human Interface Device class */
-export declare const LIBUSB_CLASS_HID: number;
-/** Printer class */
-export declare const LIBUSB_CLASS_PRINTER: number;
-/** Image class */
-export declare const LIBUSB_CLASS_PTP: number;
-/** Mass storage class */
-export declare const LIBUSB_CLASS_MASS_STORAGE: number;
-/** Hub class */
-export declare const LIBUSB_CLASS_HUB: number;
-/** Data class */
-export declare const LIBUSB_CLASS_DATA: number;
-/** Wireless class */
-export declare const LIBUSB_CLASS_WIRELESS: number;
-/** Application class */
-export declare const LIBUSB_CLASS_APPLICATION: number;
-/** Class is vendor-specific */
-export declare const LIBUSB_CLASS_VENDOR_SPEC: number;
-
-// libusb_standard_request
-/** Request status of the specific recipient */
-export declare const LIBUSB_REQUEST_GET_STATUS: number;
-/** Clear or disable a specific feature */
-export declare const LIBUSB_REQUEST_CLEAR_FEATURE: number;
-/** Set or enable a specific feature */
-export declare const LIBUSB_REQUEST_SET_FEATURE: number;
-/** Set device address for all future accesses */
-export declare const LIBUSB_REQUEST_SET_ADDRESS: number;
-/** Get the specified descriptor */
-export declare const LIBUSB_REQUEST_GET_DESCRIPTOR: number;
-/** Used to update existing descriptors or add new descriptors */
-export declare const LIBUSB_REQUEST_SET_DESCRIPTOR: number;
-/** Get the current device configuration value */
-export declare const LIBUSB_REQUEST_GET_CONFIGURATION: number;
-/** Set device configuration */
-export declare const LIBUSB_REQUEST_SET_CONFIGURATION: number;
-/** Return the selected alternate setting for the specified interface */
-export declare const LIBUSB_REQUEST_GET_INTERFACE: number;
-/** Select an alternate interface for the specified interface */
-export declare const LIBUSB_REQUEST_SET_INTERFACE: number;
-/** Set then report an endpoint's synchronization frame */
-export declare const LIBUSB_REQUEST_SYNCH_FRAME: number;
-
-// libusb_descriptor_type
-/** Device descriptor. See libusb_device_descriptor. */
-export declare const LIBUSB_DT_DEVICE: number;
-/** Configuration descriptor. See libusb_config_descriptor. */
-export declare const LIBUSB_DT_CONFIG: number;
-/** String descriptor */
-export declare const LIBUSB_DT_STRING: number;
-export declare const LIBUSB_DT_BOS: number;
-/** Interface descriptor. See libusb_interface_descriptor. */
-export declare const LIBUSB_DT_INTERFACE: number;
-/** Endpoint descriptor. See libusb_endpoint_descriptor. */
-export declare const LIBUSB_DT_ENDPOINT: number;
-/** HID descriptor */
-export declare const LIBUSB_DT_HID: number;
-/** HID report descriptor */
-export declare const LIBUSB_DT_REPORT: number;
-/** Physical descriptor */
-export declare const LIBUSB_DT_PHYSICAL: number;
-/** Hub descriptor */
-export declare const LIBUSB_DT_HUB: number;
-
-// libusb_endpoint_direction
-/** In: device-to-host */
-export declare const LIBUSB_ENDPOINT_IN: number;
-/** Out: host-to-device */
-export declare const LIBUSB_ENDPOINT_OUT: number;
-
-// libusb_transfer_type
-/** Control endpoint */
-export declare const LIBUSB_TRANSFER_TYPE_CONTROL: number;
-/** Isochronous endpoint */
-export declare const LIBUSB_TRANSFER_TYPE_ISOCHRONOUS: number;
-/** Bulk endpoint */
-export declare const LIBUSB_TRANSFER_TYPE_BULK: number;
-/** Interrupt endpoint */
-export declare const LIBUSB_TRANSFER_TYPE_INTERRUPT: number;
-
-// libusb_iso_sync_type
-/** No synchronization */
-export declare const LIBUSB_ISO_SYNC_TYPE_NONE: number;
-/** Asynchronous */
-export declare const LIBUSB_ISO_SYNC_TYPE_ASYNC: number;
-/** Adaptive */
-export declare const LIBUSB_ISO_SYNC_TYPE_ADAPTIVE: number;
-/** Synchronous */
-export declare const LIBUSB_ISO_SYNC_TYPE_SYNC: number;
-
-// libusb_iso_usage_type
-/** Data endpoint */
-export declare const LIBUSB_ISO_USAGE_TYPE_DATA: number;
-/** Feedback endpoint */
-export declare const LIBUSB_ISO_USAGE_TYPE_FEEDBACK: number;
-/** Implicit feedback Data endpoint */
-export declare const LIBUSB_ISO_USAGE_TYPE_IMPLICIT: number;
-
-// libusb_transfer_status
-/**
- * Transfer completed without error. Note that this does not indicate
- * that the entire amount of requested data was transferred.
- */
-export declare const LIBUSB_TRANSFER_COMPLETED: number;
-/** Transfer failed */
-export declare const LIBUSB_TRANSFER_ERROR: number;
-/** Transfer timed out */
-export declare const LIBUSB_TRANSFER_TIMED_OUT: number;
-/** Transfer was cancelled */
-export declare const LIBUSB_TRANSFER_CANCELLED: number;
-/**
- * For bulk/interrupt endpoints: halt condition detected (endpoint
- * stalled). For control endpoints: control request not supported.
- */
-export declare const LIBUSB_TRANSFER_STALL: number;
-/** Device was disconnected */
-export declare const LIBUSB_TRANSFER_NO_DEVICE: number;
-/** Device sent more data than requested */
-export declare const LIBUSB_TRANSFER_OVERFLOW: number;
-
-// libusb_transfer_flags
-/** Report short frames as errors */
-export declare const LIBUSB_TRANSFER_SHORT_NOT_OK: number;
-/**
- * Automatically free() transfer buffer during libusb_free_transfer().
- * Note that buffers allocated with libusb_dev_mem_alloc() should not
- * be attempted freed in this way, since free() is not an appropriate
- * way to release such memory.
- */
-export declare const LIBUSB_TRANSFER_FREE_BUFFER: number;
-/**
- * Automatically call libusb_free_transfer() after callback returns.
- * If this flag is set, it is illegal to call libusb_free_transfer()
- * from your transfer callback, as this will result in a double-free
- * when this flag is acted upon.
- */
-export declare const LIBUSB_TRANSFER_FREE_TRANSFER: number;
-
-// libusb_request_type
-/** Standard */
-export declare const LIBUSB_REQUEST_TYPE_STANDARD: number;
-/** Class */
-export declare const LIBUSB_REQUEST_TYPE_CLASS: number;
-/** Vendor */
-export declare const LIBUSB_REQUEST_TYPE_VENDOR: number;
-/** Reserved */
-export declare const LIBUSB_REQUEST_TYPE_RESERVED: number;
-
-// libusb_request_recipient
-/** Device */
-export declare const LIBUSB_RECIPIENT_DEVICE: number;
-/** Interface */
-export declare const LIBUSB_RECIPIENT_INTERFACE: number;
-/** Endpoint */
-export declare const LIBUSB_RECIPIENT_ENDPOINT: number;
-/** Other */
-export declare const LIBUSB_RECIPIENT_OTHER: number;
-
-export declare const LIBUSB_CONTROL_SETUP_SIZE: number;
-export declare const LIBUSB_DT_BOS_SIZE: number;
-
-// libusb_capability
-export declare const LIBUSB_CAP_HAS_CAPABILITY: number;
-export declare const LIBUSB_CAP_HAS_HOTPLUG: number;
-export declare const LIBUSB_CAP_HAS_HID_ACCESS: number;
-export declare const LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER: number;
-
-// libusb_error
-/** Input/output error */
-export declare const LIBUSB_ERROR_IO: number;
-/** Invalid parameter */
-export declare const LIBUSB_ERROR_INVALID_PARAM: number;
-/** Access denied (insufficient permissions) */
-export declare const LIBUSB_ERROR_ACCESS: number;
-/** No such device (it may have been disconnected) */
-export declare const LIBUSB_ERROR_NO_DEVICE: number;
-/** Entity not found */
-export declare const LIBUSB_ERROR_NOT_FOUND: number;
-/** Resource busy */
-export declare const LIBUSB_ERROR_BUSY: number;
-/** Operation timed out */
-export declare const LIBUSB_ERROR_TIMEOUT: number;
-/** Overflow */
-export declare const LIBUSB_ERROR_OVERFLOW: number;
-/** Pipe error */
-export declare const LIBUSB_ERROR_PIPE: number;
-/** System call interrupted (perhaps due to signal) */
-export declare const LIBUSB_ERROR_INTERRUPTED: number;
-/** Insufficient memory */
-export declare const LIBUSB_ERROR_NO_MEM: number;
-/** Operation not supported or unimplemented on this platform */
-export declare const LIBUSB_ERROR_NOT_SUPPORTED: number;
-/** Other error */
-export declare const LIBUSB_ERROR_OTHER: number;

package/tsc/usb/capability.ts

@@ -1,22 +0,0 @@
-import type { Device } from './bindings';
-import { CapabilityDescriptor } from './descriptors';
-
-export class Capability {
-    /** Object with fields from the capability descriptor -- see libusb documentation or USB spec. */
-    public descriptor: CapabilityDescriptor;
-
-    /** Integer capability type. */
-    public type: number;
-
-    /** Buffer capability data. */
-    public data: Buffer;
-
-    constructor(protected device: Device, protected id: number) {
-        if (!device._bosDescriptor) {
-            throw new Error('bosDescriptor not found');
-        }
-        this.descriptor = device._bosDescriptor.capabilities[this.id];
-        this.type = this.descriptor.bDevCapabilityType;
-        this.data = this.descriptor.dev_capability_data;
-    }
-}