usb 2.9.0 → 2.11.0

package/dist/webusb/index.js

@@ -1,157 +1,57 @@
 "use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __values = (this && this.__values) || function(o) {
-    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
-    if (m) return m.call(o);
-    if (o && typeof o.length === "number") return {
-        next: function () {
-            if (o && i >= o.length) o = void 0;
-            return { value: o && o[i++], done: !o };
-        }
-    };
-    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
-};
-var __read = (this && this.__read) || function (o, n) {
-    var m = typeof Symbol === "function" && o[Symbol.iterator];
-    if (!m) return o;
-    var i = m.call(o), r, ar = [], e;
-    try {
-        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
-    }
-    catch (error) { e = { error: error }; }
-    finally {
-        try {
-            if (r && !r.done && (m = i["return"])) m.call(i);
-        }
-        finally { if (e) throw e.error; }
-    }
-    return ar;
-};
-var __spreadArray = (this && this.__spreadArray) || function (to, from) {
-    for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
-        to[j] = from[i];
-    return to;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebUSB = exports.getWebUsb = void 0;
-var usb = require("../usb");
-var events_1 = require("events");
-var webusb_device_1 = require("./webusb-device");
+const usb = require("../usb");
+const events_1 = require("events");
+const webusb_device_1 = require("./webusb-device");
 /**
  * Convenience method to get the WebUSB interface available
  */
-var getWebUsb = function () {
+const getWebUsb = () => {
     if (navigator && navigator.usb) {
         return navigator.usb;
     }
     return new WebUSB();
 };
 exports.getWebUsb = getWebUsb;
-var NamedError = /** @class */ (function (_super) {
-    __extends(NamedError, _super);
-    function NamedError(message, name) {
-        var _this = _super.call(this, message) || this;
-        _this.name = name;
-        return _this;
+class NamedError extends Error {
+    constructor(message, name) {
+        super(message);
+        this.name = name;
     }
-    return NamedError;
-}(Error));
-var WebUSB = /** @class */ (function () {
-    function WebUSB(options) {
-        var _this = this;
-        if (options === void 0) { options = {}; }
+}
+class WebUSB {
+    constructor(options = {}) {
         this.options = options;
         this.emitter = new events_1.EventEmitter();
         this.knownDevices = new Map();
         this.authorisedDevices = new Set();
-        var deviceConnectCallback = function (device) { return __awaiter(_this, void 0, void 0, function () {
-            var webDevice, event_1;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getWebDevice(device)];
-                    case 1:
-                        webDevice = _a.sent();
-                        // When connected, emit an event if it is an allowed device
-                        if (webDevice && this.isAuthorisedDevice(webDevice)) {
-                            event_1 = {
-                                type: 'connect',
-                                device: webDevice
-                            };
-                            this.emitter.emit('connect', event_1);
-                        }
-                        return [2 /*return*/];
-                }
-            });
-        }); };
-        var deviceDisconnectCallback = function (device) { return __awaiter(_this, void 0, void 0, function () {
-            var webDevice, event_2;
-            return __generator(this, function (_a) {
-                // When disconnected, emit an event if the device was a known allowed device
-                if (this.knownDevices.has(device)) {
-                    webDevice = this.knownDevices.get(device);
-                    if (webDevice && this.isAuthorisedDevice(webDevice)) {
-                        event_2 = {
-                            type: 'disconnect',
-                            device: webDevice
-                        };
-                        this.emitter.emit('disconnect', event_2);
-                    }
+        const deviceConnectCallback = async (device) => {
+            const webDevice = await this.getWebDevice(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);
+            }
+        };
+        const deviceDisconnectCallback = async (device) => {
+            // When disconnected, emit an event if the device was a known allowed device
+            if (this.knownDevices.has(device)) {
+                const webDevice = this.knownDevices.get(device);
+                if (webDevice && this.isAuthorisedDevice(webDevice)) {
+                    const event = {
+                        type: 'disconnect',
+                        device: webDevice
+                    };
+                    this.emitter.emit('disconnect', event);
                 }
-                return [2 /*return*/];
-            });
-        }); };
-        this.emitter.on('newListener', function (event) {
-            var listenerCount = _this.emitter.listenerCount(event);
+            }
+        };
+        this.emitter.on('newListener', event => {
+            const listenerCount = this.emitter.listenerCount(event);
             if (listenerCount !== 0) {
                 return;
             }
@@ -162,8 +62,8 @@ var WebUSB = /** @class */ (function () {
                 usb.addListener('detach', deviceDisconnectCallback);
             }
         });
-        this.emitter.on('removeListener', function (event) {
-            var listenerCount = _this.emitter.listenerCount(event);
+        this.emitter.on('removeListener', event => {
+            const listenerCount = this.emitter.listenerCount(event);
             if (listenerCount !== 0) {
                 return;
             }
@@ -175,226 +75,143 @@ var WebUSB = /** @class */ (function () {
             }
         });
     }
-    Object.defineProperty(WebUSB.prototype, "onconnect", {
-        set: function (fn) {
-            if (this._onconnect) {
-                this.removeEventListener('connect', this._onconnect);
-                this._onconnect = undefined;
-            }
-            if (fn) {
-                this._onconnect = fn;
-                this.addEventListener('connect', this._onconnect);
-            }
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(WebUSB.prototype, "ondisconnect", {
-        set: function (fn) {
-            if (this._ondisconnect) {
-                this.removeEventListener('disconnect', this._ondisconnect);
-                this._ondisconnect = undefined;
-            }
-            if (fn) {
-                this._ondisconnect = fn;
-                this.addEventListener('disconnect', this._ondisconnect);
-            }
-        },
-        enumerable: false,
-        configurable: true
-    });
-    WebUSB.prototype.addEventListener = function (type, listener) {
+    set onconnect(fn) {
+        if (this._onconnect) {
+            this.removeEventListener('connect', this._onconnect);
+            this._onconnect = undefined;
+        }
+        if (fn) {
+            this._onconnect = fn;
+            this.addEventListener('connect', this._onconnect);
+        }
+    }
+    set ondisconnect(fn) {
+        if (this._ondisconnect) {
+            this.removeEventListener('disconnect', this._ondisconnect);
+            this._ondisconnect = undefined;
+        }
+        if (fn) {
+            this._ondisconnect = fn;
+            this.addEventListener('disconnect', this._ondisconnect);
+        }
+    }
+    addEventListener(type, listener) {
         this.emitter.addListener(type, listener);
-    };
-    WebUSB.prototype.removeEventListener = function (type, callback) {
+    }
+    removeEventListener(type, callback) {
         this.emitter.removeListener(type, callback);
-    };
-    WebUSB.prototype.dispatchEvent = function (_event) {
+    }
+    dispatchEvent(_event) {
         // Don't dispatch from here
         return false;
-    };
+    }
     /**
      * Requests a single Web USB device
      * @param options The options to use when scanning
      * @returns Promise containing the selected device
      */
-    WebUSB.prototype.requestDevice = function (options) {
-        return __awaiter(this, void 0, void 0, function () {
-            var devices, device, _a, error_1;
-            var _this = this;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        // Must have options
-                        if (!options) {
-                            throw new TypeError('requestDevice error: 1 argument required, but only 0 present');
-                        }
-                        // Options must be an object
-                        if (options.constructor !== {}.constructor) {
-                            throw new TypeError('requestDevice error: parameter 1 (options) is not an object');
-                        }
-                        // Must have a filter
-                        if (!options.filters) {
-                            throw new TypeError('requestDevice error: required member filters is undefined');
-                        }
-                        // Filter must be an array
-                        if (options.filters.constructor !== [].constructor) {
-                            throw new TypeError('requestDevice error: the provided value cannot be converted to a sequence');
-                        }
-                        // Check filters
-                        options.filters.forEach(function (filter) {
-                            // Protocol & Subclass
-                            if (filter.protocolCode && !filter.subclassCode) {
-                                throw new TypeError('requestDevice error: subclass code is required');
-                            }
-                            // Subclass & Class
-                            if (filter.subclassCode && !filter.classCode) {
-                                throw new TypeError('requestDevice error: class code is required');
-                            }
-                        });
-                        return [4 /*yield*/, this.loadDevices(options.filters)];
-                    case 1:
-                        devices = _b.sent();
-                        devices = devices.filter(function (device) { return _this.filterDevice(device, options.filters); });
-                        if (devices.length === 0) {
-                            throw new NamedError('Failed to execute \'requestDevice\' on \'USB\': No device selected.', 'NotFoundError');
-                        }
-                        _b.label = 2;
-                    case 2:
-                        _b.trys.push([2, 6, , 7]);
-                        if (!this.options.devicesFound) return [3 /*break*/, 4];
-                        return [4 /*yield*/, this.options.devicesFound(devices)];
-                    case 3:
-                        _a = _b.sent();
-                        return [3 /*break*/, 5];
-                    case 4:
-                        _a = devices[0];
-                        _b.label = 5;
-                    case 5:
-                        device = _a;
-                        if (!device) {
-                            throw new NamedError('Failed to execute \'requestDevice\' on \'USB\': No device selected.', 'NotFoundError');
-                        }
-                        this.authorisedDevices.add({
-                            vendorId: device.vendorId,
-                            productId: device.productId,
-                            classCode: device.deviceClass,
-                            subclassCode: device.deviceSubclass,
-                            protocolCode: device.deviceProtocol,
-                            serialNumber: device.serialNumber
-                        });
-                        return [2 /*return*/, device];
-                    case 6:
-                        error_1 = _b.sent();
-                        throw new NamedError('Failed to execute \'requestDevice\' on \'USB\': No device selected.', 'NotFoundError');
-                    case 7: return [2 /*return*/];
-                }
-            });
+    async requestDevice(options) {
+        // Must have options
+        if (!options) {
+            throw new TypeError('requestDevice error: 1 argument required, but only 0 present');
+        }
+        // Options must be an object
+        if (options.constructor !== {}.constructor) {
+            throw new TypeError('requestDevice error: parameter 1 (options) is not an object');
+        }
+        // Must have a filter
+        if (!options.filters) {
+            throw new TypeError('requestDevice error: required member filters is undefined');
+        }
+        // Filter must be an array
+        if (options.filters.constructor !== [].constructor) {
+            throw new TypeError('requestDevice error: the provided value cannot be converted to a sequence');
+        }
+        // Check filters
+        options.filters.forEach(filter => {
+            // Protocol & Subclass
+            if (filter.protocolCode && !filter.subclassCode) {
+                throw new TypeError('requestDevice error: subclass code is required');
+            }
+            // Subclass & Class
+            if (filter.subclassCode && !filter.classCode) {
+                throw new TypeError('requestDevice error: class code is required');
+            }
         });
-    };
+        let devices = await this.loadDevices(options.filters);
+        devices = devices.filter(device => this.filterDevice(device, options.filters));
+        if (devices.length === 0) {
+            throw new NamedError('Failed to execute \'requestDevice\' on \'USB\': No device selected.', 'NotFoundError');
+        }
+        try {
+            // If no devicesFound function, select the first device found
+            const device = this.options.devicesFound ? await this.options.devicesFound(devices) : devices[0];
+            if (!device) {
+                throw new NamedError('Failed to execute \'requestDevice\' on \'USB\': No device selected.', 'NotFoundError');
+            }
+            this.authorisedDevices.add({
+                vendorId: device.vendorId,
+                productId: device.productId,
+                classCode: device.deviceClass,
+                subclassCode: device.deviceSubclass,
+                protocolCode: device.deviceProtocol,
+                serialNumber: device.serialNumber
+            });
+            return device;
+        }
+        catch (error) {
+            throw new NamedError('Failed to execute \'requestDevice\' on \'USB\': No device selected.', 'NotFoundError');
+        }
+    }
     /**
      * Gets all allowed Web USB devices which are connected
      * @returns Promise containing an array of devices
      */
-    WebUSB.prototype.getDevices = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var preFilters, devices;
-            var _this = this;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        preFilters = this.options.allowAllDevices ? undefined : this.options.allowedDevices;
-                        return [4 /*yield*/, this.loadDevices(preFilters)];
-                    case 1:
-                        devices = _a.sent();
-                        return [2 /*return*/, devices.filter(function (device) { return _this.isAuthorisedDevice(device); })];
-                }
-            });
-        });
-    };
-    WebUSB.prototype.loadDevices = function (preFilters) {
-        return __awaiter(this, void 0, void 0, function () {
-            var devices, refreshedKnownDevices, devices_1, devices_1_1, device, webDevice, e_1_1;
-            var e_1, _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        devices = usb.getDeviceList();
-                        // Pre-filter devices
-                        devices = this.quickFilter(devices, preFilters);
-                        refreshedKnownDevices = new Map();
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 6, 7, 8]);
-                        devices_1 = __values(devices), devices_1_1 = devices_1.next();
-                        _b.label = 2;
-                    case 2:
-                        if (!!devices_1_1.done) return [3 /*break*/, 5];
-                        device = devices_1_1.value;
-                        return [4 /*yield*/, this.getWebDevice(device)];
-                    case 3:
-                        webDevice = _b.sent();
-                        if (webDevice) {
-                            refreshedKnownDevices.set(device, webDevice);
-                        }
-                        _b.label = 4;
-                    case 4:
-                        devices_1_1 = devices_1.next();
-                        return [3 /*break*/, 2];
-                    case 5: return [3 /*break*/, 8];
-                    case 6:
-                        e_1_1 = _b.sent();
-                        e_1 = { error: e_1_1 };
-                        return [3 /*break*/, 8];
-                    case 7:
-                        try {
-                            if (devices_1_1 && !devices_1_1.done && (_a = devices_1.return)) _a.call(devices_1);
-                        }
-                        finally { if (e_1) throw e_1.error; }
-                        return [7 /*endfinally*/];
-                    case 8:
-                        // Refresh knownDevices to remove old devices from the map
-                        this.knownDevices = refreshedKnownDevices;
-                        return [2 /*return*/, __spreadArray([], __read(this.knownDevices.values()))];
-                }
-            });
-        });
-    };
+    async getDevices() {
+        const preFilters = this.options.allowAllDevices ? undefined : this.options.allowedDevices;
+        // Refresh devices and filter for allowed ones
+        const devices = await this.loadDevices(preFilters);
+        return devices.filter(device => this.isAuthorisedDevice(device));
+    }
+    async loadDevices(preFilters) {
+        let devices = usb.getDeviceList();
+        // Pre-filter devices
+        devices = this.quickFilter(devices, preFilters);
+        const refreshedKnownDevices = new Map();
+        for (const device of devices) {
+            const webDevice = await this.getWebDevice(device);
+            if (webDevice) {
+                refreshedKnownDevices.set(device, webDevice);
+            }
+        }
+        // Refresh knownDevices to remove old devices from the map
+        this.knownDevices = refreshedKnownDevices;
+        return [...this.knownDevices.values()];
+    }
     // Get a WebUSBDevice corresponding to underlying device.
     // Returns undefined the device was not found and could not be created.
-    WebUSB.prototype.getWebDevice = function (device) {
-        return __awaiter(this, void 0, void 0, function () {
-            var webDevice, _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        if (!!this.knownDevices.has(device)) return [3 /*break*/, 4];
-                        if (this.options.deviceTimeout) {
-                            device.timeout = this.options.deviceTimeout;
-                        }
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, webusb_device_1.WebUSBDevice.createInstance(device)];
-                    case 2:
-                        webDevice = _b.sent();
-                        this.knownDevices.set(device, webDevice);
-                        return [3 /*break*/, 4];
-                    case 3:
-                        _a = _b.sent();
-                        return [3 /*break*/, 4];
-                    case 4: return [2 /*return*/, this.knownDevices.get(device)];
-                }
-            });
-        });
-    };
+    async getWebDevice(device) {
+        if (!this.knownDevices.has(device)) {
+            if (this.options.deviceTimeout) {
+                device.timeout = this.options.deviceTimeout;
+            }
+            try {
+                const webDevice = await webusb_device_1.WebUSBDevice.createInstance(device);
+                this.knownDevices.set(device, webDevice);
+            }
+            catch {
+                // Ignore creation issues as this may be a system device
+            }
+        }
+        return this.knownDevices.get(device);
+    }
     // Undertake quick filter on devices before creating WebUSB devices if possible
-    WebUSB.prototype.quickFilter = function (devices, preFilters) {
+    quickFilter(devices, preFilters) {
         if (!preFilters || !preFilters.length) {
             return devices;
         }
         // Just pre-filter on vid/pid
-        return devices.filter(function (device) { return preFilters.some(function (filter) {
+        return devices.filter(device => preFilters.some(filter => {
             // Vendor
             if (filter.vendorId && filter.vendorId !== device.deviceDescriptor.idVendor)
                 return false;
@@ -404,14 +221,14 @@ var WebUSB = /** @class */ (function () {
             // Ignore Class, Subclass and Protocol as these need to check interfaces, too
             // Ignore serial number for node-usb as it requires device connection
             return true;
-        }); });
-    };
+        }));
+    }
     // Filter WebUSB devices
-    WebUSB.prototype.filterDevice = function (device, filters) {
+    filterDevice(device, filters) {
         if (!filters || !filters.length) {
             return true;
         }
-        return filters.some(function (filter) {
+        return filters.some(filter => {
             // Vendor
             if (filter.vendorId && filter.vendorId !== device.vendorId)
                 return false;
@@ -424,7 +241,7 @@ var WebUSB = /** @class */ (function () {
                     return false;
                 }
                 // Interface Descriptors
-                var match = device.configuration.interfaces.some(function (iface) {
+                const match = device.configuration.interfaces.some(iface => {
                     // Class
                     if (filter.classCode && filter.classCode !== iface.alternate.interfaceClass)
                         return false;
@@ -454,9 +271,9 @@ var WebUSB = /** @class */ (function () {
                 return false;
             return true;
         });
-    };
+    }
     // Check whether a device is authorised
-    WebUSB.prototype.isAuthorisedDevice = function (device) {
+    isAuthorisedDevice(device) {
         // All devices are authorised
         if (this.options.allowAllDevices) {
             return true;
@@ -466,16 +283,13 @@ var WebUSB = /** @class */ (function () {
             return true;
         }
         // Check authorised devices
-        return __spreadArray([], __read(this.authorisedDevices.values())).some(function (authorised) {
-            return authorised.vendorId === device.vendorId
-                && authorised.productId === device.productId
-                && authorised.classCode === device.deviceClass
-                && authorised.subclassCode === device.deviceSubclass
-                && authorised.protocolCode === device.deviceProtocol
-                && authorised.serialNumber === device.serialNumber;
-        });
-    };
-    return WebUSB;
-}());
+        return [...this.authorisedDevices.values()].some(authorised => authorised.vendorId === device.vendorId
+            && authorised.productId === device.productId
+            && authorised.classCode === device.deviceClass
+            && authorised.subclassCode === device.deviceSubclass
+            && authorised.protocolCode === device.deviceProtocol
+            && authorised.serialNumber === device.serialNumber);
+    }
+}
 exports.WebUSB = WebUSB;
 //# sourceMappingURL=index.js.map