@mcesystems/usb-device-listener 1.0.14 → 1.0.15

package/dist/device-filter.d.ts

@@ -0,0 +1,24 @@
+import type { DeviceInfo, ListenerConfig } from "./types";
+/**
+ * Determine if a device notification should be sent based on the configuration.
+ *
+ * Filter priority (highest to lowest):
+ * 1. ignoredDevices - if device matches, always return false
+ * 2. listenOnlyDevices - if specified, device must match at least one
+ * 3. targetDevices - if specified, device must match at least one
+ * 4. logicalPortMap - if specified, device location must be in the map
+ *
+ * @param device - The device information from the native addon
+ * @param config - The listener configuration
+ * @returns true if the device should trigger a notification, false otherwise
+ */
+export declare function shouldNotifyDevice(device: DeviceInfo, config: ListenerConfig): boolean;
+/**
+ * Apply logical port mapping to a device if configured
+ *
+ * @param device - The device information from the native addon
+ * @param config - The listener configuration
+ * @returns Device info with logicalPort set if mapped, otherwise unchanged
+ */
+export declare function applyLogicalPortMapping(device: DeviceInfo, config: ListenerConfig): DeviceInfo;
+//# sourceMappingURL=device-filter.d.ts.map

package/dist/device-filter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-filter.d.ts","sourceRoot":"","sources":["../src/device-filter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAgB,MAAM,SAAS,CAAC;AA4BxE;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,GAAG,OAAO,CA8BtF;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,GAAG,UAAU,CAQ9F"}

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+import type { DeviceAddCallback, DeviceInfo, DeviceRemoveCallback, ListenerConfig, UsbDeviceListenerI } from "./types";
+/**
+ * USB Device Listener implementation
+ * Provides a type-safe wrapper around the native C++ addon
+ */
+export default class UsbDeviceListener implements UsbDeviceListenerI {
+    private config;
+    private userAddCallback;
+    private userRemoveCallback;
+    /**
+     * Start listening for USB device events
+     */
+    startListening(config: ListenerConfig): void;
+    /**
+     * Stop listening for USB device events
+     */
+    stopListening(): void;
+    /**
+     * Register callback for device connection events
+     */
+    onDeviceAdd(callback: DeviceAddCallback): void;
+    /**
+     * Register callback for device disconnection events
+     */
+    onDeviceRemove(callback: DeviceRemoveCallback): void;
+    /**
+     * List all currently connected USB devices
+     */
+    listDevices(): DeviceInfo[];
+}
+export type { DeviceInfo, DeviceAddCallback, DeviceRemoveCallback, ListenerConfig, TargetDevice, } from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACX,iBAAiB,EACjB,UAAU,EACV,oBAAoB,EACpB,cAAc,EACd,kBAAkB,EAClB,MAAM,SAAS,CAAC;AAoBjB;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAkB,YAAW,kBAAkB;IACnE,OAAO,CAAC,MAAM,CAAsB;IACpC,OAAO,CAAC,eAAe,CAAkC;IACzD,OAAO,CAAC,kBAAkB,CAAqC;IAE/D;;OAEG;IACI,cAAc,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI;IAQnD;;OAEG;IACI,aAAa,IAAI,IAAI;IAI5B;;OAEG;IACI,WAAW,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI;IAerD;;OAEG;IACI,cAAc,CAAC,QAAQ,EAAE,oBAAoB,GAAG,IAAI;IAe3D;;OAEG;IACI,WAAW,IAAI,UAAU,EAAE;CAGlC;AAED,YAAY,EACX,UAAU,EACV,iBAAiB,EACjB,oBAAoB,EACpB,cAAc,EACd,YAAY,GACZ,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,120 @@
+// src/index.ts
+import { createRequire } from "node:module";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+// src/device-filter.ts
+function toHexString(value) {
+  return value.toString(16).toUpperCase().padStart(4, "0");
+}
+function matchesDevice(device, target) {
+  const deviceVid = toHexString(device.vid);
+  const devicePid = toHexString(device.pid);
+  const targetVid = target.vid.toUpperCase();
+  const targetPid = target.pid.toUpperCase();
+  return deviceVid === targetVid && devicePid === targetPid;
+}
+function matchesAnyDevice(device, targets) {
+  return targets.some((target) => matchesDevice(device, target));
+}
+function shouldNotifyDevice(device, config) {
+  if (config.ignoredDevices && config.ignoredDevices.length > 0) {
+    if (matchesAnyDevice(device, config.ignoredDevices)) {
+      return false;
+    }
+  }
+  if (config.listenOnlyDevices && config.listenOnlyDevices.length > 0) {
+    if (!matchesAnyDevice(device, config.listenOnlyDevices)) {
+      return false;
+    }
+  }
+  if (config.targetDevices && config.targetDevices.length > 0) {
+    if (!matchesAnyDevice(device, config.targetDevices)) {
+      return false;
+    }
+  }
+  if (config.logicalPortMap && Object.keys(config.logicalPortMap).length > 0) {
+    if (!(device.locationInfo in config.logicalPortMap)) {
+      return false;
+    }
+  }
+  return true;
+}
+function applyLogicalPortMapping(device, config) {
+  if (config.logicalPortMap && device.locationInfo in config.logicalPortMap) {
+    return {
+      ...device,
+      logicalPort: config.logicalPortMap[device.locationInfo]
+    };
+  }
+  return device;
+}
+
+// src/index.ts
+var __filename = fileURLToPath(import.meta.url);
+var __dirname = path.dirname(__filename);
+var require2 = createRequire(import.meta.url);
+var packageRoot = path.join(__dirname, "..");
+var addon = require2("node-gyp-build")(packageRoot);
+var { listDevices, onDeviceAdd, onDeviceRemove, startListening, stopListening } = addon;
+var UsbDeviceListener = class {
+  config = {};
+  userAddCallback = null;
+  userRemoveCallback = null;
+  /**
+   * Start listening for USB device events
+   */
+  startListening(config) {
+    if (typeof config !== "object" || config === null) {
+      throw new TypeError("Config must be an object");
+    }
+    this.config = config;
+    startListening();
+  }
+  /**
+   * Stop listening for USB device events
+   */
+  stopListening() {
+    stopListening();
+  }
+  /**
+   * Register callback for device connection events
+   */
+  onDeviceAdd(callback) {
+    if (typeof callback !== "function") {
+      throw new TypeError("Callback must be a function");
+    }
+    this.userAddCallback = callback;
+    onDeviceAdd((device) => {
+      if (shouldNotifyDevice(device, this.config)) {
+        const enrichedDevice = applyLogicalPortMapping(device, this.config);
+        this.userAddCallback?.(enrichedDevice);
+      }
+    });
+  }
+  /**
+   * Register callback for device disconnection events
+   */
+  onDeviceRemove(callback) {
+    if (typeof callback !== "function") {
+      throw new TypeError("Callback must be a function");
+    }
+    this.userRemoveCallback = callback;
+    onDeviceRemove((device) => {
+      if (shouldNotifyDevice(device, this.config)) {
+        const enrichedDevice = applyLogicalPortMapping(device, this.config);
+        this.userRemoveCallback?.(enrichedDevice);
+      }
+    });
+  }
+  /**
+   * List all currently connected USB devices
+   */
+  listDevices() {
+    return listDevices();
+  }
+};
+export {
+  UsbDeviceListener as default
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/index.ts", "../src/device-filter.ts"],
+  "sourcesContent": ["import { createRequire } from \"node:module\";\r\nimport path from \"node:path\";\r\nimport { fileURLToPath } from \"node:url\";\r\nimport { applyLogicalPortMapping, shouldNotifyDevice } from \"./device-filter\";\r\nimport type {\r\n\tDeviceAddCallback,\r\n\tDeviceInfo,\r\n\tDeviceRemoveCallback,\r\n\tListenerConfig,\r\n\tUsbDeviceListenerI,\r\n} from \"./types\";\r\n\r\ninterface NativeAddon {\r\n\tstartListening(): void;\r\n\tstopListening(): void;\r\n\tonDeviceAdd(callback: DeviceAddCallback): void;\r\n\tonDeviceRemove(callback: DeviceRemoveCallback): void;\r\n\tlistDevices(): DeviceInfo[];\r\n}\r\n\r\nconst __filename = fileURLToPath(import.meta.url);\r\nconst __dirname = path.dirname(__filename);\r\n\r\n// Load native addon using require (CJS) from ESM context\r\nconst require = createRequire(import.meta.url);\r\nconst packageRoot = path.join(__dirname, \"..\");\r\nconst addon: NativeAddon = require(\"node-gyp-build\")(packageRoot);\r\n\r\nconst { listDevices, onDeviceAdd, onDeviceRemove, startListening, stopListening } = addon;\r\n\r\n/**\r\n * USB Device Listener implementation\r\n * Provides a type-safe wrapper around the native C++ addon\r\n */\r\nexport default class UsbDeviceListener implements UsbDeviceListenerI {\r\n\tprivate config: ListenerConfig = {};\r\n\tprivate userAddCallback: DeviceAddCallback | null = null;\r\n\tprivate userRemoveCallback: DeviceRemoveCallback | null = null;\r\n\r\n\t/**\r\n\t * Start listening for USB device events\r\n\t */\r\n\tpublic startListening(config: ListenerConfig): void {\r\n\t\tif (typeof config !== \"object\" || config === null) {\r\n\t\t\tthrow new TypeError(\"Config must be an object\");\r\n\t\t}\r\n\t\tthis.config = config;\r\n\t\tstartListening();\r\n\t}\r\n\r\n\t/**\r\n\t * Stop listening for USB device events\r\n\t */\r\n\tpublic stopListening(): void {\r\n\t\tstopListening();\r\n\t}\r\n\r\n\t/**\r\n\t * Register callback for device connection events\r\n\t */\r\n\tpublic onDeviceAdd(callback: DeviceAddCallback): void {\r\n\t\tif (typeof callback !== \"function\") {\r\n\t\t\tthrow new TypeError(\"Callback must be a function\");\r\n\t\t}\r\n\t\tthis.userAddCallback = callback;\r\n\r\n\t\t// Set up internal callback that filters devices\r\n\t\tonDeviceAdd((device: DeviceInfo) => {\r\n\t\t\tif (shouldNotifyDevice(device, this.config)) {\r\n\t\t\t\tconst enrichedDevice = applyLogicalPortMapping(device, this.config);\r\n\t\t\t\tthis.userAddCallback?.(enrichedDevice);\r\n\t\t\t}\r\n\t\t});\r\n\t}\r\n\r\n\t/**\r\n\t * Register callback for device disconnection events\r\n\t */\r\n\tpublic onDeviceRemove(callback: DeviceRemoveCallback): void {\r\n\t\tif (typeof callback !== \"function\") {\r\n\t\t\tthrow new TypeError(\"Callback must be a function\");\r\n\t\t}\r\n\t\tthis.userRemoveCallback = callback;\r\n\r\n\t\t// Set up internal callback that filters devices\r\n\t\tonDeviceRemove((device: DeviceInfo) => {\r\n\t\t\tif (shouldNotifyDevice(device, this.config)) {\r\n\t\t\t\tconst enrichedDevice = applyLogicalPortMapping(device, this.config);\r\n\t\t\t\tthis.userRemoveCallback?.(enrichedDevice);\r\n\t\t\t}\r\n\t\t});\r\n\t}\r\n\r\n\t/**\r\n\t * List all currently connected USB devices\r\n\t */\r\n\tpublic listDevices(): DeviceInfo[] {\r\n\t\treturn listDevices();\r\n\t}\r\n}\r\n\r\nexport type {\r\n\tDeviceInfo,\r\n\tDeviceAddCallback,\r\n\tDeviceRemoveCallback,\r\n\tListenerConfig,\r\n\tTargetDevice,\r\n} from \"./types\";\r\n", "import type { DeviceInfo, ListenerConfig, TargetDevice } from \"./types\";\n\n/**\n * Convert a decimal VID/PID to uppercase hex string for comparison\n */\nfunction toHexString(value: number): string {\n\treturn value.toString(16).toUpperCase().padStart(4, \"0\");\n}\n\n/**\n * Check if a device matches a target device filter by VID/PID\n */\nfunction matchesDevice(device: DeviceInfo, target: TargetDevice): boolean {\n\tconst deviceVid = toHexString(device.vid);\n\tconst devicePid = toHexString(device.pid);\n\tconst targetVid = target.vid.toUpperCase();\n\tconst targetPid = target.pid.toUpperCase();\n\n\treturn deviceVid === targetVid && devicePid === targetPid;\n}\n\n/**\n * Check if a device matches any device in a list of target devices\n */\nfunction matchesAnyDevice(device: DeviceInfo, targets: TargetDevice[]): boolean {\n\treturn targets.some((target) => matchesDevice(device, target));\n}\n\n/**\n * Determine if a device notification should be sent based on the configuration.\n *\n * Filter priority (highest to lowest):\n * 1. ignoredDevices - if device matches, always return false\n * 2. listenOnlyDevices - if specified, device must match at least one\n * 3. targetDevices - if specified, device must match at least one\n * 4. logicalPortMap - if specified, device location must be in the map\n *\n * @param device - The device information from the native addon\n * @param config - The listener configuration\n * @returns true if the device should trigger a notification, false otherwise\n */\nexport function shouldNotifyDevice(device: DeviceInfo, config: ListenerConfig): boolean {\n\t// Priority 1: Check ignoredDevices (highest priority - always blocks)\n\tif (config.ignoredDevices && config.ignoredDevices.length > 0) {\n\t\tif (matchesAnyDevice(device, config.ignoredDevices)) {\n\t\t\treturn false;\n\t\t}\n\t}\n\n\t// Priority 2: Check listenOnlyDevices (if specified, device must match)\n\tif (config.listenOnlyDevices && config.listenOnlyDevices.length > 0) {\n\t\tif (!matchesAnyDevice(device, config.listenOnlyDevices)) {\n\t\t\treturn false;\n\t\t}\n\t}\n\n\t// Priority 3: Check targetDevices (if specified, device must match)\n\tif (config.targetDevices && config.targetDevices.length > 0) {\n\t\tif (!matchesAnyDevice(device, config.targetDevices)) {\n\t\t\treturn false;\n\t\t}\n\t}\n\n\t// Priority 4: Check logicalPortMap (if specified, device must be mapped)\n\tif (config.logicalPortMap && Object.keys(config.logicalPortMap).length > 0) {\n\t\tif (!(device.locationInfo in config.logicalPortMap)) {\n\t\t\treturn false;\n\t\t}\n\t}\n\n\treturn true;\n}\n\n/**\n * Apply logical port mapping to a device if configured\n *\n * @param device - The device information from the native addon\n * @param config - The listener configuration\n * @returns Device info with logicalPort set if mapped, otherwise unchanged\n */\nexport function applyLogicalPortMapping(device: DeviceInfo, config: ListenerConfig): DeviceInfo {\n\tif (config.logicalPortMap && device.locationInfo in config.logicalPortMap) {\n\t\treturn {\n\t\t\t...device,\n\t\t\tlogicalPort: config.logicalPortMap[device.locationInfo],\n\t\t};\n\t}\n\treturn device;\n}\n"],
+  "mappings": ";AAAA,SAAS,qBAAqB;AAC9B,OAAO,UAAU;AACjB,SAAS,qBAAqB;;;ACG9B,SAAS,YAAY,OAAuB;AAC3C,SAAO,MAAM,SAAS,EAAE,EAAE,YAAY,EAAE,SAAS,GAAG,GAAG;AACxD;AAKA,SAAS,cAAc,QAAoB,QAA+B;AACzE,QAAM,YAAY,YAAY,OAAO,GAAG;AACxC,QAAM,YAAY,YAAY,OAAO,GAAG;AACxC,QAAM,YAAY,OAAO,IAAI,YAAY;AACzC,QAAM,YAAY,OAAO,IAAI,YAAY;AAEzC,SAAO,cAAc,aAAa,cAAc;AACjD;AAKA,SAAS,iBAAiB,QAAoB,SAAkC;AAC/E,SAAO,QAAQ,KAAK,CAAC,WAAW,cAAc,QAAQ,MAAM,CAAC;AAC9D;AAeO,SAAS,mBAAmB,QAAoB,QAAiC;AAEvF,MAAI,OAAO,kBAAkB,OAAO,eAAe,SAAS,GAAG;AAC9D,QAAI,iBAAiB,QAAQ,OAAO,cAAc,GAAG;AACpD,aAAO;AAAA,IACR;AAAA,EACD;AAGA,MAAI,OAAO,qBAAqB,OAAO,kBAAkB,SAAS,GAAG;AACpE,QAAI,CAAC,iBAAiB,QAAQ,OAAO,iBAAiB,GAAG;AACxD,aAAO;AAAA,IACR;AAAA,EACD;AAGA,MAAI,OAAO,iBAAiB,OAAO,cAAc,SAAS,GAAG;AAC5D,QAAI,CAAC,iBAAiB,QAAQ,OAAO,aAAa,GAAG;AACpD,aAAO;AAAA,IACR;AAAA,EACD;AAGA,MAAI,OAAO,kBAAkB,OAAO,KAAK,OAAO,cAAc,EAAE,SAAS,GAAG;AAC3E,QAAI,EAAE,OAAO,gBAAgB,OAAO,iBAAiB;AACpD,aAAO;AAAA,IACR;AAAA,EACD;AAEA,SAAO;AACR;AASO,SAAS,wBAAwB,QAAoB,QAAoC;AAC/F,MAAI,OAAO,kBAAkB,OAAO,gBAAgB,OAAO,gBAAgB;AAC1E,WAAO;AAAA,MACN,GAAG;AAAA,MACH,aAAa,OAAO,eAAe,OAAO,YAAY;AAAA,IACvD;AAAA,EACD;AACA,SAAO;AACR;;;ADpEA,IAAM,aAAa,cAAc,YAAY,GAAG;AAChD,IAAM,YAAY,KAAK,QAAQ,UAAU;AAGzC,IAAMA,WAAU,cAAc,YAAY,GAAG;AAC7C,IAAM,cAAc,KAAK,KAAK,WAAW,IAAI;AAC7C,IAAM,QAAqBA,SAAQ,gBAAgB,EAAE,WAAW;AAEhE,IAAM,EAAE,aAAa,aAAa,gBAAgB,gBAAgB,cAAc,IAAI;AAMpF,IAAqB,oBAArB,MAAqE;AAAA,EAC5D,SAAyB,CAAC;AAAA,EAC1B,kBAA4C;AAAA,EAC5C,qBAAkD;AAAA;AAAA;AAAA;AAAA,EAKnD,eAAe,QAA8B;AACnD,QAAI,OAAO,WAAW,YAAY,WAAW,MAAM;AAClD,YAAM,IAAI,UAAU,0BAA0B;AAAA,IAC/C;AACA,SAAK,SAAS;AACd,mBAAe;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA,EAKO,gBAAsB;AAC5B,kBAAc;AAAA,EACf;AAAA;AAAA;AAAA;AAAA,EAKO,YAAY,UAAmC;AACrD,QAAI,OAAO,aAAa,YAAY;AACnC,YAAM,IAAI,UAAU,6BAA6B;AAAA,IAClD;AACA,SAAK,kBAAkB;AAGvB,gBAAY,CAAC,WAAuB;AACnC,UAAI,mBAAmB,QAAQ,KAAK,MAAM,GAAG;AAC5C,cAAM,iBAAiB,wBAAwB,QAAQ,KAAK,MAAM;AAClE,aAAK,kBAAkB,cAAc;AAAA,MACtC;AAAA,IACD,CAAC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKO,eAAe,UAAsC;AAC3D,QAAI,OAAO,aAAa,YAAY;AACnC,YAAM,IAAI,UAAU,6BAA6B;AAAA,IAClD;AACA,SAAK,qBAAqB;AAG1B,mBAAe,CAAC,WAAuB;AACtC,UAAI,mBAAmB,QAAQ,KAAK,MAAM,GAAG;AAC5C,cAAM,iBAAiB,wBAAwB,QAAQ,KAAK,MAAM;AAClE,aAAK,qBAAqB,cAAc;AAAA,MACzC;AAAA,IACD,CAAC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKO,cAA4B;AAClC,WAAO,YAAY;AAAA,EACpB;AACD;",
+  "names": ["require"]
+}

package/dist/types.d.ts

@@ -0,0 +1,195 @@
+/**
+ * USB Device Listener Type Definitions
+ *
+ * Type-safe interface for monitoring USB device connections and disconnections
+ */
+/**
+ * Device information returned by the listener
+ */
+export interface DeviceInfo {
+    /**
+     * Windows device instance ID
+     * Format: "USB\VID_xxxx&PID_xxxx\..."
+     */
+    deviceId: string;
+    /**
+     * USB Vendor ID (decimal)
+     * Use .toString(16) to convert to hex string
+     */
+    vid: number;
+    /**
+     * USB Product ID (decimal)
+     * Use .toString(16) to convert to hex string
+     */
+    pid: number;
+    /**
+     * Physical USB port location
+     * Format: "Port_#xxxx.Hub_#yyyy"
+     * This value is stable and can be used as a key for logical port mapping
+     */
+    locationInfo: string;
+    /**
+     * User-defined logical port number from configuration
+     * null if not mapped in logicalPortMap
+     */
+    logicalPort: number | null;
+}
+/**
+ * Target device filter by VID/PID
+ */
+export interface TargetDevice {
+    /**
+     * USB Vendor ID as hex string (e.g., "04E8")
+     */
+    vid: string;
+    /**
+     * USB Product ID as hex string (e.g., "6860")
+     */
+    pid: string;
+}
+/**
+ * Configuration for USB device listener
+ */
+export interface ListenerConfig {
+    /**
+     * Map physical port locations to logical port numbers
+     *
+     * Key: Location info string (e.g., "Port_#0005.Hub_#0002")
+     * Value: Logical port number (e.g., 1, 2, 3)
+     *
+     * Use listDevices() to discover location strings for your setup
+     *
+     * @example
+     * {
+     *   "Port_#0005.Hub_#0002": 1,
+     *   "Port_#0006.Hub_#0002": 2
+     * }
+     */
+    logicalPortMap?: Record<string, number>;
+    /**
+     * Filter to monitor only specific devices by VID/PID
+     *
+     * Empty array or undefined = monitor all USB devices
+     *
+     * @example
+     * [
+     *   { vid: "04E8", pid: "6860" },  // Samsung device
+     *   { vid: "2341", pid: "0043" }   // Arduino Uno
+     * ]
+     */
+    targetDevices?: TargetDevice[];
+    /**
+     * Devices to ignore by VID/PID
+     *
+     * Devices matching any entry will not trigger events,
+     * even if they match other filters.
+     * This takes highest priority over all other filters.
+     *
+     * @example
+     * [
+     *   { vid: "1234", pid: "5678" }  // Ignore this specific device
+     * ]
+     */
+    ignoredDevices?: TargetDevice[];
+    /**
+     * Only monitor these specific devices by VID/PID
+     *
+     * Empty array or undefined = monitor all devices (subject to other filters)
+     * When set, only devices matching an entry will trigger events.
+     *
+     * @example
+     * [
+     *   { vid: "04E8", pid: "6860" }  // Only listen to this device
+     * ]
+     */
+    listenOnlyDevices?: TargetDevice[];
+}
+/**
+ * Callback type for device add events
+ */
+export type DeviceAddCallback = (deviceInfo: DeviceInfo) => void;
+/**
+ * Callback type for device remove events
+ */
+export type DeviceRemoveCallback = (deviceInfo: DeviceInfo) => void;
+/**
+ * USB Device Listener Module
+ */
+export interface UsbDeviceListenerI {
+    /**
+     * Start listening for USB device events
+     *
+     * Creates a background thread that monitors Windows device change messages.
+     * Callbacks registered with onDeviceAdd/onDeviceRemove will be invoked
+     * when matching devices are connected or disconnected.
+     *
+     * @param config - Listener configuration
+     * @throws {TypeError} If config is not an object
+     * @throws {Error} If listener is already running
+     *
+     * @example
+     * listener.startListening({
+     *   logicalPortMap: { "Port_#0005.Hub_#0002": 1 },
+     *   targetDevices: [{ vid: "04E8", pid: "6860" }]
+     * });
+     */
+    startListening(config: ListenerConfig): void;
+    /**
+     * Stop listening for USB device events
+     *
+     * Stops the background thread and cleans up resources.
+     * Safe to call multiple times.
+     *
+     * @example
+     * listener.stopListening();
+     */
+    stopListening(): void;
+    /**
+     * Register callback for device connection events
+     *
+     * The callback will be invoked on the Node.js main thread whenever
+     * a matching USB device is connected.
+     *
+     * @param callback - Function to call when device is connected
+     * @throws {TypeError} If callback is not a function
+     *
+     * @example
+     * listener.onDeviceAdd((device) => {
+     *   console.log(`Device ${device.vid.toString(16)}:${device.pid.toString(16)}`);
+     *   console.log(`Connected to port ${device.logicalPort}`);
+     * });
+     */
+    onDeviceAdd(callback: DeviceAddCallback): void;
+    /**
+     * Register callback for device disconnection events
+     *
+     * The callback will be invoked on the Node.js main thread whenever
+     * a matching USB device is disconnected.
+     *
+     * @param callback - Function to call when device is disconnected
+     * @throws {TypeError} If callback is not a function
+     *
+     * @example
+     * listener.onDeviceRemove((device) => {
+     *   console.log(`Port ${device.logicalPort} disconnected`);
+     * });
+     */
+    onDeviceRemove(callback: DeviceRemoveCallback): void;
+    /**
+     * List all currently connected USB devices
+     *
+     * Returns information about all USB devices currently connected to the system.
+     * Useful for discovering device locations and initial state.
+     *
+     * @returns Array of device information objects
+     *
+     * @example
+     * const devices = listener.listDevices();
+     * devices.forEach(device => {
+     *   console.log(`Location: ${device.locationInfo}`);
+     *   console.log(`VID:PID = ${device.vid.toString(16)}:${device.pid.toString(16)}`);
+     * });
+     */
+    listDevices(): DeviceInfo[];
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAExC;;;;;;;;;;OAUG;IACH,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;IAE/B;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,YAAY,EAAE,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,iBAAiB,CAAC,EAAE,YAAY,EAAE,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;IAE7C;;;;;;;;OAQG;IACH,aAAa,IAAI,IAAI,CAAC;IAEtB;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAE/C;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,QAAQ,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAErD;;;;;;;;;;;;;;OAcG;IACH,WAAW,IAAI,UAAU,EAAE,CAAC;CAC5B"}

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@mcesystems/usb-device-listener",
-  "version": "1.0.14",
+  "version": "1.0.15",
   "description": "Native Windows USB device listener using PnP notifications without custom drivers",
   "type": "module",
-  "main": "src/index.ts",
-  "types": "src/index.ts",
+  "main": "dist/index.js",
+  "types": "dist/types.d.ts",
   "exports": {
     ".": {
-      "import": "./src/index.ts",
-      "types": "./src/index.ts"
+      "import": "./dist/index.js",
+      "types": "./dist/types.d.ts"
     }
   },
   "keywords": [
@@ -49,11 +49,9 @@
     "vitest": "^2.1.8"
   },
   "files": [
-    "src",
+    "dist",
     "prebuilds",
-    "native",
-    "binding.gyp",
-    "tsconfig.json",
+    "build/Release/*.node",
     "README.md"
   ],
   "gypfile": true,
@@ -61,7 +59,7 @@
     "win32"
   ],
   "scripts": {
-    "prebuild:gyp": "prebuildify --electron --strip --target 25.2.1",
+    "prebuild:gyp": "prebuildify --napi --strip --target 25.2.1",
     "build": "tsx esbuild.config.ts && tsc --emitDeclarationOnly",
     "rebuild": "node-gyp rebuild",
     "install": "node-gyp-build",

package/binding.gyp

@@ -1,41 +0,0 @@
-{
-	"targets": [
-		{
-			"target_name": "usb_device_listener",
-			"sources": [
-				"native/addon.cc",
-				"native/usb_listener.cc"
-			],
-			"include_dirs": [
-				"<!@(node -p \"require('node-addon-api').include\")"
-			],
-			"dependencies": [
-				"<!(node -p \"require('node-addon-api').gyp\")"
-			],
-			"defines": [
-				"NAPI_DISABLE_CPP_EXCEPTIONS",
-				"UNICODE",
-				"_UNICODE"
-			],
-			"conditions": [
-				[
-					"OS=='win'",
-					{
-						"libraries": [
-							"Setupapi.lib",
-							"Cfgmgr32.lib"
-						],
-						"msvs_settings": {
-							"VCCLCompilerTool": {
-								"ExceptionHandling": 1,
-								"AdditionalOptions": [
-									"/std:c++20"
-								]
-							}
-						}
-					}
-				]
-			]
-		}
-	]
-}

package/native/addon.cc

@@ -1,118 +0,0 @@
-#include <napi.h>
-#include "usb_listener.h"
-#include <memory>
-
-static std::unique_ptr<USBListener> g_listener;
-
-Napi::Value StartListening(const Napi::CallbackInfo& info) {
-	Napi::Env env = info.Env();
-	
-	if (!g_listener) {
-		g_listener = std::make_unique<USBListener>();
-	}
-	
-	std::string errorMsg;
-	if (!g_listener->StartListening(errorMsg)) {
-		Napi::Error::New(env, errorMsg).ThrowAsJavaScriptException();
-		return env.Undefined();
-	}
-	
-	return env.Undefined();
-}
-
-Napi::Value StopListening(const Napi::CallbackInfo& info) {
-	Napi::Env env = info.Env();
-	
-	if (g_listener) {
-		g_listener->StopListening();
-	}
-	
-	return env.Undefined();
-}
-
-Napi::Value OnDeviceAdd(const Napi::CallbackInfo& info) {
-	Napi::Env env = info.Env();
-	
-	if (info.Length() < 1 || !info[0].IsFunction()) {
-		Napi::TypeError::New(env, "Callback function expected").ThrowAsJavaScriptException();
-		return env.Undefined();
-	}
-	
-	Napi::Function callback = info[0].As<Napi::Function>();
-	
-	if (!g_listener) {
-		g_listener = std::make_unique<USBListener>();
-	}
-	
-	Napi::ThreadSafeFunction tsfn = Napi::ThreadSafeFunction::New(
-		env,
-		callback,
-		"DeviceAddCallback",
-		0,
-		1
-	);
-	
-	g_listener->SetAddCallback(tsfn);
-	
-	return env.Undefined();
-}
-
-Napi::Value OnDeviceRemove(const Napi::CallbackInfo& info) {
-	Napi::Env env = info.Env();
-	
-	if (info.Length() < 1 || !info[0].IsFunction()) {
-		Napi::TypeError::New(env, "Callback function expected").ThrowAsJavaScriptException();
-		return env.Undefined();
-	}
-	
-	Napi::Function callback = info[0].As<Napi::Function>();
-	
-	if (!g_listener) {
-		g_listener = std::make_unique<USBListener>();
-	}
-	
-	Napi::ThreadSafeFunction tsfn = Napi::ThreadSafeFunction::New(
-		env,
-		callback,
-		"DeviceRemoveCallback",
-		0,
-		1
-	);
-	
-	g_listener->SetRemoveCallback(tsfn);
-	
-	return env.Undefined();
-}
-
-Napi::Value ListDevices(const Napi::CallbackInfo& info) {
-	Napi::Env env = info.Env();
-	
-	if (!g_listener) {
-		g_listener = std::make_unique<USBListener>();
-	}
-	
-	std::vector<DeviceInfo> devices = g_listener->ListAllDevices();
-	
-	Napi::Array result = Napi::Array::New(env, devices.size());
-	for (size_t i = 0; i < devices.size(); i++) {
-		Napi::Object obj = Napi::Object::New(env);
-		obj.Set("deviceId", Napi::String::New(env, devices[i].deviceId));
-		obj.Set("vid", Napi::Number::New(env, devices[i].vid));
-		obj.Set("pid", Napi::Number::New(env, devices[i].pid));
-		obj.Set("locationInfo", Napi::String::New(env, devices[i].locationInfo));
-		result[i] = obj;
-	}
-	
-	return result;
-}
-
-Napi::Object Init(Napi::Env env, Napi::Object exports) {
-	exports.Set("startListening", Napi::Function::New(env, StartListening));
-	exports.Set("stopListening", Napi::Function::New(env, StopListening));
-	exports.Set("onDeviceAdd", Napi::Function::New(env, OnDeviceAdd));
-	exports.Set("onDeviceRemove", Napi::Function::New(env, OnDeviceRemove));
-	exports.Set("listDevices", Napi::Function::New(env, ListDevices));
-	return exports;
-}
-
-NODE_API_MODULE(usb_device_listener, Init)