Windows USB support

Aspedm · Aspedm · commit 71549a453014 · 2024-03-07T14:13:18.000+01:00
diff --git a/README.md b/README.md
@@ -10,16 +10,16 @@ This project containts libs to get information about system.
 #### USB
 | Name          | Type            | Linux | Mac OS | Windows (10+) | Description                                       |
 |---------------|-----------------|-------|--------|---------------|---------------------------------------------------|
-|`bus`          | string \| null  | ✅    | ❌      | ❌            | Identifies the USB bus the device is connected to |
-|`deviceId`     | string \| null  | ✅    | ❌      | ❌            | Unique identifier assigned to the USB device      |
-|`id`           | string \| null  | ✅    | ✅      | ✅            | Unique identifier for the USB device              |
-|`name`         | string \| null  | ✅    | ✅      | ✅            | Human-readable name of the USB device             |
-|`type`         | string \| null  | ✅    | ✅      | ✅            | Categorizes the USB device based on functionality |
-|`removable`    | boolean \| null | ✅    | ✅      | ❌            | Indicates if the device is removable              |
-|`vendor`       | string \| null  | ✅    | ✅      | ❌            | Identifies the vendor                             |
-|`manufacturer` | string \| null  | ✅    | ✅      | ✅            | Specifies the device's manufacturer.              |
-|`maxPower`     | string \| null  | ✅    | ❌      | ❌            | Maximum power the device can draw (in mA)         |
-|`serialNumber` | string \| null  | ✅    | ✅      | ❌            | Unique serial number assigned by the manufacturer |
+|`bus`          | string \| null  | ✅    | ❌    | ❌            | Identifies the USB bus the device is connected to |
+|`deviceId`     | string \| null  | ✅    | ❌    | ✅            | Unique identifier assigned to the USB device      |
+|`id`           | string \| null  | ✅    | ✅    | ✅            | Unique identifier for the USB device              |
+|`name`         | string \| null  | ✅    | ✅    | ✅            | Human-readable name of the USB device             |
+|`type`         | string \| null  | ✅    | ✅    | ✅            | Categorizes the USB device based on functionality |
+|`removable`    | boolean \| null | ✅    | ✅    | ❌            | Indicates if the device is removable              |
+|`vendor`       | string \| null  | ✅    | ✅    | ❌            | Identifies the vendor                             |
+|`manufacturer` | string \| null  | ✅    | ✅    | ✅            | Specifies the device's manufacturer.              |
+|`maxPower`     | string \| null  | ✅    | ❌    | ❌            | Maximum power the device can draw (in mA)         |
+|`serialNumber` | string \| null  | ✅    | ✅    | ❌            | Unique serial number assigned by the manufacturer |
 
 ### Install
 ```sh
@@ -44,8 +44,14 @@ const myUsbDevices = async() => {
 3. Run playground ```yarn start```
 
 ### TODO
-- [ ] Support linux USB devices
-- [ ] Support windows USB devices
+#### USB
+- [ ] Support Linux USB devices
+- [X] Support Windows USB devices
+
+#### Audio
+- [ ] Support linux audio devices
+- [ ] Support Mac OS audio devices
+- [ ] Support Windows audio devices
 
 ### License
 Further details see [LICENSE](LICENSE) file.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "spci-libs",
-    "version": "0.0.2",
+    "version": "0.0.3",
     "description": "System information library",
     "author": "Tagir Khadzhiev <aspedm@gmail.com>",
     "license": "MIT",
@@ -11,8 +11,8 @@
     "types": "./dist/index.d.ts",
     "scripts": {
         "start": "node --experimental-modules playground/index.js",
-        "clean": "rm -rf dist",
-        "build": "yarn clean && node_modules/.bin/rollup --config",
+        "clean": "rimraf dist",
+        "build": "yarn clean && rollup --config",
         "prepublishOnly": "yarn build"
     },
     "devDependencies": {
@@ -23,6 +23,7 @@
         "@rollup/plugin-commonjs": "25.0.7",
         "@rollup/plugin-json": "6.1.0",
         "@rollup/plugin-node-resolve": "15.2.3",
+        "@rollup/plugin-terser": "0.4.4",
         "@rollup/plugin-typescript": "11.1.6",
         "@types/lodash": "4.14.202",
         "@types/node": "20.10.8",
@@ -40,10 +41,10 @@
         "eslint-plugin-react": "7.33.2",
         "eslint-plugin-react-hooks": "4.6.0",
         "prettier": "3.2.5",
+        "rimraf": "5.0.5",
         "rollup": "4.12.0",
         "rollup-plugin-commonjs": "10.1.0",
         "rollup-plugin-dts": "6.1.0",
-        "rollup-plugin-terser": "7.0.2",
         "typescript": "5.3.3"
     },
     "dependencies": {
diff --git a/rollup.config.js b/rollup.config.js
@@ -2,8 +2,8 @@ import { babel } from '@rollup/plugin-babel';
 import commonjs from '@rollup/plugin-commonjs';
 import json from '@rollup/plugin-json';
 import { nodeResolve } from '@rollup/plugin-node-resolve';
+import terser from '@rollup/plugin-terser';
 import { dts } from 'rollup-plugin-dts';
-import { terser } from 'rollup-plugin-terser';
 
 import pkg from './package.json' assert { type: 'json' };
 
diff --git a/src/system/usb/README.md b/src/system/usb/README.md
@@ -4,18 +4,18 @@ This class returned array of detected USB devices
 ### Fields
 Returned fields depends of OS.
 
-| Name          | Type            | Linux | Mac OS | Windows | Description                                       |
-|---------------|-----------------|-------|--------|---------|---------------------------------------------------|
-|`bus`          | string \| null  | ✅    | ❌      | ❌      | Identifies the USB bus the device is connected to |
-|`deviceId`     | string \| null  | ✅    | ❌      | ❌      | Unique identifier assigned to the USB device      |
-|`id`           | string \| null  | ✅    | ✅      | ✅      | Unique identifier for the USB device              |
-|`name`         | string \| null  | ✅    | ✅      | ✅      | Human-readable name of the USB device             |
-|`type`         | string \| null  | ✅    | ✅      | ✅      | Categorizes the USB device based on functionality |
-|`removable`    | boolean \| null | ✅    | ✅      | ❌      | Indicates if the device is removable              |
-|`vendor`       | string \| null  | ✅    | ✅      | ❌      | Identifies the vendor                             |
-|`manufacturer` | string \| null  | ✅    | ✅      | ✅      | Specifies the device's manufacturer.              |
-|`maxPower`     | string \| null  | ✅    | ❌      | ❌      | Maximum power the device can draw (in mA)         |
-|`serialNumber` | string \| null  | ✅    | ✅      | ❌      | Unique serial number assigned by the manufacturer |
+| Name          | Type            | Linux | Mac OS | Windows (10+) | Description                                       |
+|---------------|-----------------|-------|--------|---------------|---------------------------------------------------|
+|`bus`          | string \| null  | ✅    | ❌    | ❌            | Identifies the USB bus the device is connected to |
+|`deviceId`     | string \| null  | ✅    | ❌    | ✅            | Unique identifier assigned to the USB device      |
+|`id`           | string \| null  | ✅    | ✅    | ✅            | Unique identifier for the USB device              |
+|`name`         | string \| null  | ✅    | ✅    | ✅            | Human-readable name of the USB device             |
+|`type`         | string \| null  | ✅    | ✅    | ✅            | Categorizes the USB device based on functionality |
+|`removable`    | boolean \| null | ✅    | ✅    | ❌            | Indicates if the device is removable              |
+|`vendor`       | string \| null  | ✅    | ✅    | ❌            | Identifies the vendor                             |
+|`manufacturer` | string \| null  | ✅    | ✅    | ✅            | Specifies the device's manufacturer.              |
+|`maxPower`     | string \| null  | ✅    | ❌    | ❌            | Maximum power the device can draw (in mA)         |
+|`serialNumber` | string \| null  | ✅    | ✅    | ❌            | Unique serial number assigned by the manufacturer |
 
 
 ### How to use
diff --git a/src/system/usb/config.ts b/src/system/usb/config.ts
@@ -33,4 +33,5 @@ export enum USB_DEVICE_TYPE {
     MOUSE = 'Mouse',
     MICROPHONE = 'Microphone',
     STORAGE = 'Storage',
+    USB_COMPOSITE_DEVICE = 'USB Composite Device',
 }
diff --git a/src/system/usb/index.ts b/src/system/usb/index.ts
@@ -2,6 +2,7 @@ import { plafromDetector } from '../../helpers/platformDetector';
 
 import { ISpciUsb, ISpciUsbDevice } from './interface';
 import Macos from './macos';
+import Windows from './windows';
 
 class Usb {
     private PLATFORM: ISpciUsb | null = null;
@@ -10,7 +11,7 @@ class Usb {
         this.PLATFORM = plafromDetector<ISpciUsb | null>({
             linux: null,
             macos: new Macos(),
-            windows: null,
+            windows: new Windows(),
         });
     }
 
diff --git a/src/system/usb/windows/deviceTypeMapper/index.ts b/src/system/usb/windows/deviceTypeMapper/index.ts
@@ -0,0 +1,34 @@
+import { USB_DEVICE_TYPE } from '../../config';
+
+class DeviceTypeMapper {
+    private static WINDOWS_DEVICE_TYPES_MAP: Record<string, USB_DEVICE_TYPE> = {
+        iphone: USB_DEVICE_TYPE.PHONE,
+        ipad: USB_DEVICE_TYPE.TABLET,
+        magsafe: USB_DEVICE_TYPE.MAGSAFE,
+        earpods: USB_DEVICE_TYPE.HEADSET,
+        usbstor: USB_DEVICE_TYPE.STORAGE,
+        usbaudio: USB_DEVICE_TYPE.AUDIO,
+        disk: USB_DEVICE_TYPE.STORAGE,
+        usbhub: USB_DEVICE_TYPE.HUB,
+        bthusb: USB_DEVICE_TYPE.BLUETOOTH,
+        usbccgp: USB_DEVICE_TYPE.USB_COMPOSITE_DEVICE,
+        wudfwpdmtp: USB_DEVICE_TYPE.PHONE,
+        controller: USB_DEVICE_TYPE.CONTROLLER,
+    };
+
+    /**
+     * Map windows style usb device type to universal format
+     * @param {string} type
+     * @param {string} service
+     * @returns {string}
+     */
+    public static getFriendlyNameType(type: string, service: string): string {
+        if (typeof type !== 'string') return type;
+
+        const foundDevice = Object.keys(this.WINDOWS_DEVICE_TYPES_MAP).find(keyword => type.includes(keyword));
+
+        return foundDevice ? this.WINDOWS_DEVICE_TYPES_MAP[foundDevice] : service;
+    }
+}
+
+export default DeviceTypeMapper;
diff --git a/src/system/usb/windows/index.ts b/src/system/usb/windows/index.ts
@@ -1,12 +1,120 @@
+import get from 'lodash/get';
+import shelljs from 'shelljs';
+
+import { DEFAULT_FIELDS_VALUES } from '../config';
 import { ISpciUsb, ISpciUsbDevice } from '../interface';
 
+import DeviceTypeMapper from './deviceTypeMapper';
+
 class Windows implements ISpciUsb {
+    private USB_FIELDS: ISpciUsbDevice = { ...DEFAULT_FIELDS_VALUES };
+
+    private USB_BLOCK_LIST: string[] = [];
+
+    private CMD: string =
+        "Get-PnpDevice -PresentOnly | Where-Object { $_.InstanceId -match '^USB' } | Select-Object InstanceId, Status, ClassGuid, Manufacturer, DeviceId, FriendlyName, HardwareId, Service, Description | ConvertTo-JSON";
+
+    /**
+     * @param {string} output
+     * @returns {Record<string, string>[] | null}
+     */
+    private parseOutput(output: string): Record<string, string>[] | null {
+        if (typeof output !== 'string' || output.length === 0) return null;
+
+        try {
+            const result: Record<string, string>[] = JSON.parse(output);
+            return result;
+        } catch (error) {
+            console.error('Error while parse Windows output', error);
+            return null;
+        }
+    }
+
+    /**
+     * @param {string | null} name
+     * @returns {boolean}
+     */
+    private invalidDevice(name: string | null): boolean {
+        if (typeof name !== 'string') return true;
+        const value = name.toLowerCase();
+
+        const result = this.USB_BLOCK_LIST.some(item => item.includes(value));
+        return result;
+    }
+
+    /**
+     * @param { Record<string, string>} usbObj
+     * @param {number} id - Fake id
+     * @returns {ISpciUsbDevice | null}
+     */
+    private fillUsbFields(usbObj: Record<string, string>, id: number): ISpciUsbDevice {
+        try {
+            const name = get(usbObj, 'FriendlyName', null);
+            const invalidDevice = this.invalidDevice(name);
+            if (invalidDevice) {
+                return null;
+            }
+
+            const deviceId = get(usbObj, 'InstanceId', null);
+            const type = `${get(usbObj, 'Service', '').toLowerCase()} ${get(usbObj, 'FriendlyName', '').toLowerCase()}`;
+            const manufacturer = get(usbObj, 'Manufacturer', null);
+
+            const usbFields: ISpciUsbDevice = {
+                ...this.USB_FIELDS,
+                id: id.toString(),
+                name,
+                deviceId,
+                type: DeviceTypeMapper.getFriendlyNameType(type, get(usbObj, 'Service', '')),
+                manufacturer,
+            };
+
+            return usbFields;
+        } catch (error) {
+            console.error('Error while fill usb fields');
+            return null;
+        }
+    }
+
+    /**
+     * @returns {Promise<ISpciUsbDevice[]>}
+     */
+    private async getDevicesFromTerminal(): Promise<ISpciUsbDevice[]> {
+        return new Promise((resolve, reject) => {
+            const result: ISpciUsbDevice[] = [];
+            const responce = shelljs.exec(`powershell.exe -Command "${this.CMD}"`, {
+                async: false,
+                silent: true,
+            });
+
+            if (responce.code !== 0) {
+                console.error('Error while get data from terminal. Code:', responce.code);
+                reject(responce.stderr);
+            }
+
+            const devices = this.parseOutput(responce.stdout);
+            if (devices === null) {
+                reject(new Error('Error while parse windows output'));
+            }
+
+            devices.forEach((device, index) => {
+                const usb = this.fillUsbFields(device, index + 1);
+
+                if (usb !== null) {
+                    result.push(usb);
+                }
+            });
+
+            resolve(result);
+        });
+    }
+
     /**
      * Get windows usb devices
      * @returns {Promise<ISpciUsbDevice>}
      */
     public async getInfo(): Promise<ISpciUsbDevice[]> {
-        return [];
+        const result = await this.getDevicesFromTerminal();
+        return result;
     }
 }
 
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -33,4 +33,5 @@ export enum USB_DEVICE_TYPE {`
`33`	`33`	`MOUSE = 'Mouse',`
`34`	`34`	`MICROPHONE = 'Microphone',`
`35`	`35`	`STORAGE = 'Storage',`
	`36`	`+ USB_COMPOSITE_DEVICE = 'USB Composite Device',`
`36`	`37`	`}`