usb 2.13.0 → 2.14.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [2.14.0] - 2024-09-15
+
+### Fixed
+- Fixed fatal exceptions by using `ThrowAsJavaScriptException` instead of `Napi::Error::Fatal` - [`817`](https://github.com/node-usb/node-usb/pull/817) ([cleoo](https://github.com/cleoo))
+
 ## [2.13.0] - 2024-05-26
 
 ### Changed

package/README.md

@@ -30,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
 ```
 
+You may need to modify your udev and permission rules in order to access your desired device. Along the lines of:
+
+SUBSYSTEM=="usb", ATTR{idVendor}=="USB-VENDOR-ID", ATTR{idProduct}=="USB-PRODUCT-ID", MODE="0660", GROUP="GROUP-YOUR-USER-IS-IN"
+
 # Troubleshooting
 
 For libusb issues, please refer to the FAQ at https://github.com/libusb/libusb/wiki/FAQ
@@ -203,6 +207,12 @@ Please refer to the maintained example for using `node-usb` in electron:
 
 https://github.com/node-usb/node-usb-example-electron
 
+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:
+
+- buildDependenciesFromSource: true
+- nodeGypRebuild: false
+- npmRebuild: false
+
 # APIs
 Since `v2.0.0`, the `node-usb` library supports two APIs:
 

package/dist/usb/bindings.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { DeviceDescriptor, ConfigDescriptor, BosDescriptor } from './descriptors';
 /**
  * Return a list of `Device` objects for the USB devices attached to the system.

package/dist/usb/capability.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { Device } from './bindings';
 import { CapabilityDescriptor } from './descriptors';
 export declare class Capability {

package/dist/usb/descriptors.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 /** A structure representing the standard USB device descriptor */
 export interface DeviceDescriptor {
     /** Size of this descriptor (in bytes) */

package/dist/usb/device.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import * as usb from './bindings';
 import { Interface } from './interface';
 import { Capability } from './capability';

package/dist/usb/endpoint.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { EventEmitter } from 'events';
 import { LibUSBException, Transfer, Device } from './bindings';
 import { EndpointDescriptor } from './descriptors';

package/dist/webusb/index.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="w3c-web-usb" />
 import * as usb from '../usb';
 import { EventEmitter } from 'events';
 import { WebUSBDevice } from './webusb-device';

package/dist/webusb/webusb-device.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="w3c-web-usb" />
 import * as usb from '../usb';
 /**
  * Wrapper to make a node-usb device look like a webusb device

package/package.json

@@ -2,7 +2,7 @@
   "name": "usb",
   "description": "Library to access USB devices",
   "license": "MIT",
-  "version": "2.13.0",
+  "version": "2.14.0",
   "main": "dist/index.js",
   "engines": {
     "node": ">=12.22.0 <13.0 || >=14.17.0"
@@ -66,8 +66,8 @@
     "node-gyp": "^10.0.1",
     "prebuildify": "^6.0.1",
     "prebuildify-ci": "^1.0.5",
-    "prebuildify-cross": "^5.0.0",
-    "typedoc": "^0.25.13",
+    "prebuildify-cross": "thegecko/prebuildify-cross#fix-docker",
+    "typedoc": "^0.26.7",
     "typescript": "^5.4.5"
   },
   "binary": {

package/src/device.cc

@@ -246,7 +246,7 @@ struct Req: Napi::AsyncWorker {
             Callback().Call(device->Value(), { error });
         }
         catch (const Napi::Error& e) {
-            Napi::Error::Fatal("", e.what());
+            e.ThrowAsJavaScriptException();
         }
     }
 };

package/src/transfer.cc

@@ -110,7 +110,7 @@ void handleCompletion(Transfer* self){
                 Napi::Number::New(env, (uint32_t)self->transfer->actual_length) });
         }
         catch (const Napi::Error& e) {
-            Napi::Error::Fatal("", e.what());
+            e.ThrowAsJavaScriptException();
         }
     }