usb 2.9.0 → 2.11.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [2.11.0] - 2023-10-02
+
+### Fixed
+- Allow use of close on a closed device - [`676`](https://github.com/node-usb/node-usb/pull/676) ([Julien Vanier](https://github.com/monkbroc))
+
+## [2.10.0] - 2023-08-22
+
+### Fixed
+- Fixed using callbacks in startPolling - [`631`](https://github.com/node-usb/node-usb/pull/631) ([Tim Strazzere](https://github.com/strazzere))
+
 ## [2.9.0] - 2023-03-16
 
 ### Changed

package/README.md

@@ -20,6 +20,8 @@ You can install one using [Zadig](http://zadig.akeo.ie/) or another approach is
 
 Note that you cannot use multiple drivers on Windows as they get exclusive access to the device. So if you want to switch between drivers (e.g. using a printer with this software or the system), you will need to uninstall/install drivers as required.
 
+For further info, check [How to use libusb on Windows](https://github.com/libusb/libusb/wiki/Windows#user-content-How_to_use_libusb_on_Windows) in the libusb's wiki.
+
 ## Linux
 
 On Linux, you'll need libudev to build libusb if a prebuild is not available. On Ubuntu/Debian:
@@ -28,6 +30,10 @@ On Linux, you'll need libudev to build libusb if a prebuild is not available. On
 sudo apt-get install build-essential libudev-dev
 ```
 
+# Troubleshooting
+
+For libusb issues, please refer to the FAQ at https://github.com/libusb/libusb/wiki/FAQ
+
 # Installation
 
 Native modules are bundled using `prebuildify`, so installation should be as simple as installing the package.

package/binding.gyp

@@ -34,7 +34,7 @@
       'defines': [
         '_FILE_OFFSET_BITS=64',
         '_LARGEFILE_SOURCE',
-        'NAPI_VERSION=6'
+        'NAPI_VERSION=8'
       ],
       'include_dirs+': [
         'src/',

package/dist/index.js

@@ -9,136 +9,58 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-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.");
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LibUSBException = exports.useUsbDkBackend = exports.getDeviceList = exports.Transfer = exports.Device = exports.webusb = exports.findBySerialNumber = exports.findByIds = exports.usb = void 0;
-var util_1 = require("util");
-var webusb_1 = require("./webusb");
-var usb = require("./usb");
+const util_1 = require("util");
+const webusb_1 = require("./webusb");
+const usb = require("./usb");
 exports.usb = usb;
 /**
  * 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
  */
-var findByIds = function (vid, pid) {
-    var devices = usb.getDeviceList();
-    return devices.find(function (item) { return item.deviceDescriptor.idVendor === vid && item.deviceDescriptor.idProduct === pid; });
+const findByIds = (vid, pid) => {
+    const devices = usb.getDeviceList();
+    return devices.find(item => item.deviceDescriptor.idVendor === vid && item.deviceDescriptor.idProduct === pid);
 };
 exports.findByIds = findByIds;
 /**
  * Convenience method to get the device with the specified serial number, or `undefined` if no such device is present.
  * @param serialNumber
  */
-var findBySerialNumber = function (serialNumber) { return __awaiter(void 0, void 0, void 0, function () {
-    var devices, opened, devices_1, devices_1_1, device, getStringDescriptor, buffer, _a, e_1_1;
-    var e_1, _b;
-    return __generator(this, function (_c) {
-        switch (_c.label) {
-            case 0:
-                devices = usb.getDeviceList();
-                opened = function (device) { return !!device.interfaces; };
-                _c.label = 1;
-            case 1:
-                _c.trys.push([1, 9, 10, 11]);
-                devices_1 = __values(devices), devices_1_1 = devices_1.next();
-                _c.label = 2;
-            case 2:
-                if (!!devices_1_1.done) return [3 /*break*/, 8];
-                device = devices_1_1.value;
-                _c.label = 3;
-            case 3:
-                _c.trys.push([3, 5, 6, 7]);
-                if (!opened(device)) {
-                    device.open();
-                }
-                getStringDescriptor = util_1.promisify(device.getStringDescriptor).bind(device);
-                return [4 /*yield*/, getStringDescriptor(device.deviceDescriptor.iSerialNumber)];
-            case 4:
-                buffer = _c.sent();
-                if (buffer && buffer.toString() === serialNumber) {
-                    return [2 /*return*/, device];
-                }
-                return [3 /*break*/, 7];
-            case 5:
-                _a = _c.sent();
-                return [3 /*break*/, 7];
-            case 6:
-                try {
-                    if (opened(device)) {
-                        device.close();
-                    }
-                }
-                catch (_d) {
-                    // Ignore any errors, device may be a system device or inaccessible
-                }
-                return [7 /*endfinally*/];
-            case 7:
-                devices_1_1 = devices_1.next();
-                return [3 /*break*/, 2];
-            case 8: return [3 /*break*/, 11];
-            case 9:
-                e_1_1 = _c.sent();
-                e_1 = { error: e_1_1 };
-                return [3 /*break*/, 11];
-            case 10:
-                try {
-                    if (devices_1_1 && !devices_1_1.done && (_b = devices_1.return)) _b.call(devices_1);
+const findBySerialNumber = async (serialNumber) => {
+    const devices = usb.getDeviceList();
+    const opened = (device) => !!device.interfaces;
+    for (const device of devices) {
+        try {
+            if (!opened(device)) {
+                device.open();
+            }
+            const getStringDescriptor = util_1.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();
                 }
-                finally { if (e_1) throw e_1.error; }
-                return [7 /*endfinally*/];
-            case 11: return [2 /*return*/, undefined];
+            }
+            catch {
+                // Ignore any errors, device may be a system device or inaccessible
+            }
         }
-    });
-}); };
+    }
+    return undefined;
+};
 exports.findBySerialNumber = findBySerialNumber;
-var webusb = new webusb_1.WebUSB();
+const webusb = new webusb_1.WebUSB();
 exports.webusb = webusb;
 // Usb types
 var usb_1 = require("./usb");

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../tsc/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6BAAiC;AACjC,mCAAkC;AAClC,2BAA6B;AAoDzB,kBAAG;AAlDP;;;;GAIG;AACH,IAAM,SAAS,GAAG,UAAC,GAAW,EAAE,GAAW;IACvC,IAAM,OAAO,GAAG,GAAG,CAAC,aAAa,EAAE,CAAC;IACpC,OAAO,OAAO,CAAC,IAAI,CAAC,UAAA,IAAI,IAAI,OAAA,IAAI,CAAC,gBAAgB,CAAC,QAAQ,KAAK,GAAG,IAAI,IAAI,CAAC,gBAAgB,CAAC,SAAS,KAAK,GAAG,EAAjF,CAAiF,CAAC,CAAC;AACnH,CAAC,CAAC;AA6CE,8BAAS;AA3Cb;;;GAGG;AACH,IAAM,kBAAkB,GAAG,UAAO,YAAoB;;;;;;gBAC5C,OAAO,GAAG,GAAG,CAAC,aAAa,EAAE,CAAC;gBAC9B,MAAM,GAAG,UAAC,MAAkB,IAAc,OAAA,CAAC,CAAC,MAAM,CAAC,UAAU,EAAnB,CAAmB,CAAC;;;;gBAE/C,YAAA,SAAA,OAAO,CAAA;;;;gBAAjB,MAAM;;;;gBAET,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;oBACjB,MAAM,CAAC,IAAI,EAAE,CAAC;iBACjB;gBAEK,mBAAmB,GAAG,gBAAS,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAChE,qBAAM,mBAAmB,CAAC,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,EAAA;;gBAAzE,MAAM,GAAG,SAAgE;gBAE/E,IAAI,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,KAAK,YAAY,EAAE;oBAC9C,sBAAO,MAAM,EAAC;iBACjB;;;;;;gBAID,IAAI;oBACA,IAAI,MAAM,CAAC,MAAM,CAAC,EAAE;wBAChB,MAAM,CAAC,KAAK,EAAE,CAAC;qBAClB;iBACJ;gBAAC,WAAM;oBACJ,mEAAmE;iBACtE;;;;;;;;;;;;;;;;qBAIT,sBAAO,SAAS,EAAC;;;KACpB,CAAC;AAUE,gDAAkB;AARtB,IAAM,MAAM,GAAG,IAAI,eAAM,EAAE,CAAC;AAWxB,wBAAM;AAGV,YAAY;AACZ,6BAAwG;AAA/F,6FAAA,MAAM,OAAA;AAAE,+FAAA,QAAQ,OAAA;AAAgB,oGAAA,aAAa,OAAA;AAAE,sGAAA,eAAe,OAAA;AAAE,sGAAA,eAAe,OAAA;AACxF,mDAAiC;AACjC,oDAAkC;AAClC,iDAA+B;AAC/B,kDAAgC;AAEhC,eAAe;AACf,2CAAyB;AACzB,yDAAuC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../tsc/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,+BAAiC;AACjC,qCAAkC;AAClC,6BAA6B;AAoDzB,kBAAG;AAlDP;;;;GAIG;AACH,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,GAAW,EAA0B,EAAE;IACnE,MAAM,OAAO,GAAG,GAAG,CAAC,aAAa,EAAE,CAAC;IACpC,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,KAAK,GAAG,IAAI,IAAI,CAAC,gBAAgB,CAAC,SAAS,KAAK,GAAG,CAAC,CAAC;AACnH,CAAC,CAAC;AA6CE,8BAAS;AA3Cb;;;GAGG;AACH,MAAM,kBAAkB,GAAG,KAAK,EAAE,YAAoB,EAAmC,EAAE;IACvF,MAAM,OAAO,GAAG,GAAG,CAAC,aAAa,EAAE,CAAC;IACpC,MAAM,MAAM,GAAG,CAAC,MAAkB,EAAW,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC;IAEpE,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;QAC1B,IAAI;YACA,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;gBACjB,MAAM,CAAC,IAAI,EAAE,CAAC;aACjB;YAED,MAAM,mBAAmB,GAAG,gBAAS,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC/E,MAAM,MAAM,GAAG,MAAM,mBAAmB,CAAC,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;YAEhF,IAAI,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,KAAK,YAAY,EAAE;gBAC9C,OAAO,MAAM,CAAC;aACjB;SACJ;QAAC,MAAM;YACJ,mEAAmE;SACtE;gBAAS;YACN,IAAI;gBACA,IAAI,MAAM,CAAC,MAAM,CAAC,EAAE;oBAChB,MAAM,CAAC,KAAK,EAAE,CAAC;iBAClB;aACJ;YAAC,MAAM;gBACJ,mEAAmE;aACtE;SACJ;KACJ;IAED,OAAO,SAAS,CAAC;AACrB,CAAC,CAAC;AAUE,gDAAkB;AARtB,MAAM,MAAM,GAAG,IAAI,eAAM,EAAE,CAAC;AAWxB,wBAAM;AAGV,YAAY;AACZ,6BAAwG;AAA/F,6FAAA,MAAM,OAAA;AAAE,+FAAA,QAAQ,OAAA;AAAgB,oGAAA,aAAa,OAAA;AAAE,sGAAA,eAAe,OAAA;AAAE,sGAAA,eAAe,OAAA;AACxF,mDAAiC;AACjC,oDAAkC;AAClC,iDAA+B;AAC/B,kDAAgC;AAEhC,eAAe;AACf,2CAAyB;AACzB,yDAAuC"}

package/dist/usb/bindings.js

@@ -3,8 +3,8 @@
 //  Eric Brody <https://github.com/underscorebrody>
 //  Rob Moran <https://github.com/thegecko>
 Object.defineProperty(exports, "__esModule", { value: true });
-var path_1 = require("path");
+const path_1 = require("path");
 /* eslint-disable @typescript-eslint/no-var-requires */
-var usb = require('node-gyp-build')(path_1.join(__dirname, '..', '..'));
+const usb = require('node-gyp-build')(path_1.join(__dirname, '..', '..'));
 module.exports = usb;
 //# sourceMappingURL=bindings.js.map

package/dist/usb/bindings.js.map

@@ -1 +1 @@
-{"version":3,"file":"bindings.js","sourceRoot":"","sources":["../../tsc/usb/bindings.ts"],"names":[],"mappings":";AAAA,+CAA+C;AAC/C,mDAAmD;AACnD,2CAA2C;;AAE3C,6BAA4B;AAG5B,uDAAuD;AACvD,IAAM,GAAG,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,WAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AACnE,MAAM,CAAC,OAAO,GAAG,GAAG,CAAC"}
+{"version":3,"file":"bindings.js","sourceRoot":"","sources":["../../tsc/usb/bindings.ts"],"names":[],"mappings":";AAAA,+CAA+C;AAC/C,mDAAmD;AACnD,2CAA2C;;AAE3C,+BAA4B;AAG5B,uDAAuD;AACvD,MAAM,GAAG,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,WAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AACnE,MAAM,CAAC,OAAO,GAAG,GAAG,CAAC"}

package/dist/usb/capability.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Capability = void 0;
-var Capability = /** @class */ (function () {
-    function Capability(device, id) {
+class Capability {
+    constructor(device, id) {
         this.device = device;
         this.id = id;
         if (!device._bosDescriptor) {
@@ -12,7 +12,6 @@ var Capability = /** @class */ (function () {
         this.type = this.descriptor.bDevCapabilityType;
         this.data = this.descriptor.dev_capability_data;
     }
-    return Capability;
-}());
+}
 exports.Capability = Capability;
 //# sourceMappingURL=capability.js.map

package/dist/usb/capability.js.map

@@ -1 +1 @@
-{"version":3,"file":"capability.js","sourceRoot":"","sources":["../../tsc/usb/capability.ts"],"names":[],"mappings":";;;AAGA;IAUI,oBAAsB,MAAc,EAAY,EAAU;QAApC,WAAM,GAAN,MAAM,CAAQ;QAAY,OAAE,GAAF,EAAE,CAAQ;QACtD,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;YACxB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;SAC9C;QACD,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC9D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;QAC/C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IACpD,CAAC;IACL,iBAAC;AAAD,CAAC,AAlBD,IAkBC;AAlBY,gCAAU"}
+{"version":3,"file":"capability.js","sourceRoot":"","sources":["../../tsc/usb/capability.ts"],"names":[],"mappings":";;;AAGA,MAAa,UAAU;IAUnB,YAAsB,MAAc,EAAY,EAAU;QAApC,WAAM,GAAN,MAAM,CAAQ;QAAY,OAAE,GAAF,EAAE,CAAQ;QACtD,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;YACxB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;SAC9C;QACD,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC9D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;QAC/C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IACpD,CAAC;CACJ;AAlBD,gCAkBC"}