@oxmc/node-smbios 1.0.0

package/README.md

@@ -0,0 +1,473 @@
+# node-smbios
+
+[![npm version](https://badge.fury.io/js/node-smbios.svg)](https://www.npmjs.com/package/node-smbios)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Cross-platform Node.js native addon for reading SMBIOS (System Management BIOS) / DMI (Desktop Management Interface) hardware information.
+
+## Features
+
+- 🖥️ **Cross-platform** - Works on Windows, macOS, and Linux
+- ⚡ **Fast** - Native C++ implementation for optimal performance
+- 📦 **Easy to use** - Simple JavaScript API
+- 🔒 **No external dependencies** - Uses platform-native APIs
+- 🎯 **Comprehensive** - Reads BIOS, System, Board, Processor, Memory, and Chassis information
+- 🔧 **Stable** - Uses N-API for compatibility across Node.js versions
+
+## Installation
+
+```bash
+npm install node-smbios
+```
+
+### How Installation Works
+
+The package uses **prebuilt native binaries** for most users:
+
+1. **First**: Attempts to download a prebuilt binary from [GitHub Releases](https://github.com/oxmc/node-smbios/releases)
+   - Binaries are available for common platforms: Windows, macOS, Linux
+   - Supports Node.js versions: 16, 18, 20, 22
+   - Covers architectures: x64, arm64
+
+2. **Fallback**: If no prebuilt binary is available, it compiles from source
+   - Requires build tools (see below)
+   - Takes longer but works on any platform
+
+**Benefits:**
+- ✅ Most users get instant installation (no compilation needed)
+- ✅ No build tools required for common platforms
+- ✅ Automatic fallback ensures compatibility
+
+### Build Tools (Only if Compiling from Source)
+
+**Node.js:**
+- Node.js >= 16.0.0
+- npm (comes with Node.js)
+
+**Build Tools:**
+
+The package requires native compilation tools on each platform:
+
+#### Windows
+
+You need Visual Studio Build Tools (or full Visual Studio) with C++ support:
+
+**Option 1: Install Visual Studio 2022 or later**
+- Download from [Visual Studio Downloads](https://visualstudio.microsoft.com/downloads/)
+- During installation, select "Desktop development with C++" workload
+- Includes MSVC compiler, Windows SDK, and MSBuild
+
+**Option 2: Install Build Tools only**
+```bash
+npm install --global windows-build-tools
+```
+
+**Required components:**
+- MSVC C++ compiler
+- Windows SDK (10 or 11)
+- MSBuild
+
+**Dependencies/Libraries used:**
+- Windows Management Instrumentation (WMI) - Built into Windows
+- `wbemuuid.lib` - Links automatically via `#pragma comment`
+
+#### macOS
+
+Install Xcode Command Line Tools:
+
+```bash
+xcode-select --install
+```
+
+**Required components:**
+- Clang/LLVM C++ compiler
+- macOS SDK
+
+**System frameworks used:**
+- `IOKit.framework` - For hardware information access
+- `CoreFoundation.framework` - For data type conversions
+
+**Minimum macOS version:** 10.13 (High Sierra)
+
+#### Linux
+
+Install build essentials and development tools:
+
+**Debian/Ubuntu:**
+```bash
+sudo apt-get update
+sudo apt-get install -y build-essential python3
+```
+
+**Red Hat/Fedora/CentOS:**
+```bash
+sudo yum install gcc gcc-c++ make python3
+# or on newer versions:
+sudo dnf install gcc gcc-c++ make python3
+```
+
+**Arch Linux:**
+```bash
+sudo pacman -S base-devel python
+```
+
+**Required components:**
+- GCC/G++ compiler (version 7.0+)
+- GNU Make
+- Python 3 (for node-gyp)
+
+**System dependencies:**
+- No external libraries required (reads from `/sys/class/dmi/id/` and `/proc/`)
+- May require read permissions for DMI files (usually root or `sudo`)
+
+### Verifying Installation
+
+After installation, verify it works:
+
+```bash
+node -e "const smbios = require('node-smbios'); console.log(smbios.getSystemInfo());"
+```
+
+### Forcing Source Build
+
+If you want to compile from source instead of using prebuilt binaries:
+
+```bash
+npm install node-smbios --build-from-source
+```
+
+## Usage
+
+```javascript
+const smbios = require('node-smbios');
+
+// Get BIOS information
+const biosInfo = smbios.getBiosInfo();
+console.log('BIOS Vendor:', biosInfo.vendor);
+console.log('BIOS Version:', biosInfo.version);
+console.log('Release Date:', biosInfo.releaseDate);
+
+// Get System information
+const systemInfo = smbios.getSystemInfo();
+console.log('Manufacturer:', systemInfo.manufacturer);
+console.log('Product:', systemInfo.productName);
+console.log('Serial:', systemInfo.serialNumber);
+console.log('UUID:', systemInfo.uuid);
+
+// Get Board information
+const boardInfo = smbios.getBoardInfo();
+console.log('Board Manufacturer:', boardInfo.manufacturer);
+console.log('Board Product:', boardInfo.product);
+
+// Get Processor information
+const procInfo = smbios.getProcessorInfo();
+console.log('CPU:', procInfo.version);
+console.log('Cores:', procInfo.coreCount);
+console.log('Threads:', procInfo.threadCount);
+
+// Get Memory information
+const memInfo = smbios.getMemoryInfo();
+console.log('Total Memory:', memInfo.totalPhysicalMemory);
+console.log('Available Memory:', memInfo.availablePhysicalMemory);
+
+// Get Chassis information
+const chassisInfo = smbios.getChassisInfo();
+console.log('Chassis Type:', chassisInfo.type);
+console.log('Manufacturer:', chassisInfo.manufacturer);
+
+// Get ALL information at once
+const allInfo = smbios.getAllInfo();
+console.log(JSON.stringify(allInfo, null, 2));
+```
+
+## API Reference
+
+### `getBiosInfo()`
+
+Returns BIOS information:
+- `vendor` - BIOS manufacturer
+- `version` - BIOS version
+- `releaseDate` - BIOS release date
+- `biosCharacteristics` - Additional BIOS characteristics
+
+### `getSystemInfo()`
+
+Returns system information:
+- `manufacturer` - System manufacturer
+- `productName` - System product/model name
+- `serialNumber` - System serial number
+- `uuid` - System UUID
+- `skuNumber` - SKU number
+- `family` - Product family
+- `wakeUpType` - Wake-up type
+
+### `getBoardInfo()`
+
+Returns motherboard/baseboard information:
+- `manufacturer` - Board manufacturer
+- `product` - Board product name
+- `version` - Board version
+- `serialNumber` - Board serial number
+- `assetTag` - Asset tag
+- `locationInChassis` - Location in chassis
+
+### `getProcessorInfo()`
+
+Returns processor information:
+- `manufacturer` - CPU manufacturer
+- `version` - CPU model name
+- `socketDesignation` - CPU socket
+- `processorType` - Processor type
+- `processorFamily` - Processor family
+- `maxSpeed` - Maximum speed (MHz)
+- `currentSpeed` - Current speed (MHz)
+- `coreCount` - Number of cores
+- `threadCount` - Number of threads
+- `l2CacheSize` - L2 cache size (KB)
+- `l3CacheSize` - L3 cache size (KB)
+
+### `getMemoryInfo()`
+
+Returns memory information:
+- `totalPhysicalMemory` - Total physical memory (bytes)
+- `availablePhysicalMemory` - Available physical memory (bytes)
+- `totalVirtualMemory` - Total virtual memory (bytes)
+- `availableVirtualMemory` - Available virtual memory (bytes)
+- `memoryDevices` - Number of memory devices
+- `maxCapacity` - Maximum memory capacity
+
+### `getChassisInfo()`
+
+Returns chassis information:
+- `manufacturer` - Chassis manufacturer
+- `type` - Chassis type
+- `version` - Chassis version
+- `serialNumber` - Chassis serial number
+- `assetTag` - Asset tag
+- `bootUpState` - Boot-up state
+- `powerSupplyState` - Power supply state
+- `thermalState` - Thermal state
+
+### `getAllInfo()`
+
+Returns all information in a single object with keys: `bios`, `system`, `board`, `processor`, `memory`, `chassis`.
+
+## Platform-Specific Notes
+
+### Windows
+- Uses **WMI** (Windows Management Instrumentation)
+- Supports Windows 7 and later
+- May require administrator privileges for some detailed information
+
+### macOS
+- Uses **IOKit** framework
+- Accesses IORegistry for system information
+- Works on macOS 10.13 and later
+- Some processor/memory details may require additional system calls
+
+### Linux
+- Reads from `/sys/class/dmi/id/` for DMI information
+- Reads from `/proc/cpuinfo` and `/proc/meminfo` for processor and memory details
+- May require root privileges to access some DMI files
+- Works on most modern Linux distributions
+
+## Building from Source
+
+If you want to build the addon from source or contribute to development:
+
+### 1. Clone the Repository
+
+```bash
+git clone https://github.com/oxmc/node-smbios.git
+cd node-smbios
+```
+
+### 2. Install Dependencies
+
+```bash
+npm install
+```
+
+This installs:
+- `node-addon-api` - N-API C++ wrapper classes
+- `node-gyp` - Build tool for native addons
+
+### 3. Build the Native Addon
+
+```bash
+npm run build
+```
+
+This runs `node-gyp rebuild` which:
+1. Generates platform-specific build files (Visual Studio solution on Windows, Makefile on Unix)
+2. Compiles the C++ source files:
+   - `src/binding.cpp` - N-API bindings
+   - `src/smbios_common.cpp` - Common utilities
+   - Platform-specific file: `src/windows/smbios_windows.cpp`, `src/mac/smbios_macos.cpp`, or `src/linux/smbios_linux.cpp`
+3. Links with platform-specific libraries
+4. Outputs `build/Release/smbios.node` (the compiled addon)
+
+### 4. Run Tests
+
+```bash
+npm test
+```
+
+This runs `example.js` which demonstrates all API functions.
+
+### Build Configuration
+
+The build process is configured in `binding.gyp`:
+
+**Common settings:**
+- C++11 or later required
+- N-API based (no V8 API dependencies)
+- Exception handling enabled
+
+**Platform-specific compilation:**
+- **Windows**: Compiles with MSVC, links against `wbemuuid.lib` for WMI
+- **macOS**: Compiles with Clang, links against IOKit and CoreFoundation frameworks
+- **Linux**: Compiles with GCC, no external libraries needed
+
+### Development Commands
+
+```bash
+# Clean build artifacts
+npm run clean
+
+# Rebuild (clean + build)
+npm run build
+
+# Install and build (as end user would)
+npm install
+
+# Run example/test
+npm test
+```
+
+### Project Structure
+
+```
+node-smbios/
+├── src/
+│   ├── binding.cpp              # N-API entry point
+│   ├── smbios_common.h          # Common data structures
+│   ├── smbios_common.cpp        # Utility functions
+│   ├── windows/
+│   │   └── smbios_windows.cpp   # Windows WMI implementation
+│   ├── mac/
+│   │   └── smbios_macos.cpp     # macOS IOKit implementation
+│   └── linux/
+│       └── smbios_linux.cpp     # Linux /sys/dmi implementation
+├── binding.gyp                  # node-gyp configuration
+├── package.json                 # npm package configuration
+├── index.js                     # JavaScript entry point
+└── example.js                   # Usage examples
+```
+
+### Debugging Build Issues
+
+**Enable verbose output:**
+```bash
+npm run build -- --verbose
+```
+
+**Check node-gyp version:**
+```bash
+npx node-gyp --version
+```
+
+**Manually rebuild:**
+```bash
+npx node-gyp clean
+npx node-gyp configure
+npx node-gyp build
+```
+
+**Common issues:**
+- **Python not found**: node-gyp requires Python 3.x
+- **Compiler not found**: Install platform build tools (see Prerequisites)
+- **Permission errors**: On Linux, some DMI files require root access
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Releasing
+
+This project uses automated releases via GitHub Actions. To create a new release:
+
+1. Update the version in `package.json`:
+   ```bash
+   npm version patch  # or minor, or major
+   ```
+
+2. Push the tag to GitHub:
+   ```bash
+   git push && git push --tags
+   ```
+
+3. GitHub Actions will automatically:
+   - Build native binaries for all supported platforms (Windows, macOS, Linux)
+   - Upload binaries to GitHub Releases
+   - Publish the package to npm
+
+See [.github/RELEASE.md](.github/RELEASE.md) for more details on the release process.
+
+## Troubleshooting
+
+### Build Errors
+
+**Windows:**
+```bash
+npm install --global windows-build-tools
+```
+
+**macOS:**
+```bash
+xcode-select --install
+```
+
+**Linux (Debian/Ubuntu):**
+```bash
+sudo apt-get install build-essential
+```
+
+### Permission Issues
+
+Some SMBIOS information may require elevated privileges:
+
+**Windows:** Run as Administrator
+
+**Linux:** Run with sudo or add your user to appropriate groups
+
+**macOS:** Usually works without special privileges
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Author
+
+Your Name <your.email@example.com>
+
+## Acknowledgments
+
+- Uses [node-addon-api](https://github.com/nodejs/node-addon-api) for N-API bindings
+- Inspired by system information tools across different platforms
+
+## Related Projects
+
+- [systeminformation](https://www.npmjs.com/package/systeminformation) - Comprehensive system and OS information
+- [node-dmidecode](https://www.npmjs.com/package/node-dmidecode) - Linux dmidecode wrapper
+- [wmi-client](https://www.npmjs.com/package/wmi-client) - Windows WMI client
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for release history.

package/binding.gyp

@@ -0,0 +1,49 @@
+{
+  "targets": [
+    {
+      "target_name": "smbios",
+      "cflags!": [ "-fno-exceptions" ],
+      "cflags_cc!": [ "-fno-exceptions" ],
+      "cflags_cc": [ "-std=c++17" ],
+      "sources": [
+        "src/binding.cpp",
+        "src/smbios_common.cpp"
+      ],
+      "include_dirs": [
+        "<!@(node -p \"require('node-addon-api').include\")",
+        "<!@(node -p \"require('@mapbox/node-pre-gyp').include\")"
+      ],
+      "defines": [ "NAPI_DISABLE_CPP_EXCEPTIONS" ],
+      "conditions": [
+        ["OS=='win'", {
+          "sources": [ "src/windows/smbios_windows.cpp" ],
+          "libraries": [],
+          "msvs_settings": {
+            "VCCLCompilerTool": {
+              "ExceptionHandling": 1,
+              "AdditionalOptions": [ "/std:c++17" ]
+            }
+          }
+        }],
+        ["OS=='mac'", {
+          "sources": [ "src/mac/smbios_macos.cpp" ],
+          "xcode_settings": {
+            "GCC_ENABLE_CPP_EXCEPTIONS": "YES",
+            "CLANG_CXX_LANGUAGE_STANDARD": "c++17",
+            "CLANG_CXX_LIBRARY": "libc++",
+            "MACOSX_DEPLOYMENT_TARGET": "10.13"
+          },
+          "link_settings": {
+            "libraries": [
+              "-framework IOKit",
+              "-framework CoreFoundation"
+            ]
+          }
+        }],
+        ["OS=='linux'", {
+          "sources": [ "src/linux/smbios_linux.cpp" ]
+        }]
+      ]
+    }
+  ]
+}

package/example.js

@@ -0,0 +1,94 @@
+/**
+ * Example usage of node-smbios
+ * 
+ * This demonstrates how to retrieve SMBIOS information from the system.
+ * Run with: node example.js
+ */
+
+const smbios = require('./index');
+
+console.log('=== node-smbios Example ===\n');
+
+try {
+    // Get BIOS information
+    console.log('--- BIOS Information ---');
+    const biosInfo = smbios.getBiosInfo();
+    console.log('Vendor:', biosInfo.vendor || 'N/A');
+    console.log('Version:', biosInfo.version || 'N/A');
+    console.log('Release Date:', biosInfo.releaseDate || 'N/A');
+    console.log('BIOS Characteristics:', biosInfo.biosCharacteristics || 'N/A');
+    console.log();
+
+    // Get System information
+    console.log('--- System Information ---');
+    const systemInfo = smbios.getSystemInfo();
+    console.log('Manufacturer:', systemInfo.manufacturer || 'N/A');
+    console.log('Product Name:', systemInfo.productName || 'N/A');
+    console.log('Serial Number:', systemInfo.serialNumber || 'N/A');
+    console.log('UUID:', systemInfo.uuid || 'N/A');
+    console.log('SKU Number:', systemInfo.skuNumber || 'N/A');
+    console.log('Family:', systemInfo.family || 'N/A');
+    console.log('Wake Up Type:', systemInfo.wakeUpType || 'N/A');
+    console.log();
+
+    // Get Board information
+    console.log('--- Board Information ---');
+    const boardInfo = smbios.getBoardInfo();
+    console.log('Manufacturer:', boardInfo.manufacturer || 'N/A');
+    console.log('Product:', boardInfo.product || 'N/A');
+    console.log('Version:', boardInfo.version || 'N/A');
+    console.log('Serial Number:', boardInfo.serialNumber || 'N/A');
+    console.log('Asset Tag:', boardInfo.assetTag || 'N/A');
+    console.log('Location in Chassis:', boardInfo.locationInChassis || 'N/A');
+    console.log();
+
+    // Get Processor information
+    console.log('--- Processor Information ---');
+    const procInfo = smbios.getProcessorInfo();
+    console.log('Manufacturer:', procInfo.manufacturer || 'N/A');
+    console.log('Name:', procInfo.version || 'N/A');
+    console.log('Socket:', procInfo.socketDesignation || 'N/A');
+    console.log('Type:', procInfo.processorType || 'N/A');
+    console.log('Family:', procInfo.processorFamily || 'N/A');
+    console.log('Max Speed:', procInfo.maxSpeed || 'N/A');
+    console.log('Current Speed:', procInfo.currentSpeed || 'N/A');
+    console.log('Core Count:', procInfo.coreCount || 'N/A');
+    console.log('Thread Count:', procInfo.threadCount || 'N/A');
+    console.log('L2 Cache:', procInfo.l2CacheSize || 'N/A');
+    console.log('L3 Cache:', procInfo.l3CacheSize || 'N/A');
+    console.log();
+
+    // Get Memory information
+    console.log('--- Memory Information ---');
+    const memInfo = smbios.getMemoryInfo();
+    console.log('Total Physical Memory:', memInfo.totalPhysicalMemory || 'N/A');
+    console.log('Available Physical Memory:', memInfo.availablePhysicalMemory || 'N/A');
+    console.log('Total Virtual Memory:', memInfo.totalVirtualMemory || 'N/A');
+    console.log('Available Virtual Memory:', memInfo.availableVirtualMemory || 'N/A');
+    console.log('Memory Devices:', memInfo.memoryDevices || 'N/A');
+    console.log('Max Capacity:', memInfo.maxCapacity || 'N/A');
+    console.log();
+
+    // Get Chassis information
+    console.log('--- Chassis Information ---');
+    const chassisInfo = smbios.getChassisInfo();
+    console.log('Manufacturer:', chassisInfo.manufacturer || 'N/A');
+    console.log('Type:', chassisInfo.type || 'N/A');
+    console.log('Version:', chassisInfo.version || 'N/A');
+    console.log('Serial Number:', chassisInfo.serialNumber || 'N/A');
+    console.log('Asset Tag:', chassisInfo.assetTag || 'N/A');
+    console.log('Boot Up State:', chassisInfo.bootUpState || 'N/A');
+    console.log('Power Supply State:', chassisInfo.powerSupplyState || 'N/A');
+    console.log('Thermal State:', chassisInfo.thermalState || 'N/A');
+    console.log();
+
+    // Get all information at once
+    console.log('--- All Information (Single Call) ---');
+    const allInfo = smbios.getAllInfo();
+    console.log(JSON.stringify(allInfo, null, 2));
+
+} catch (error) {
+    console.error('Error:', error.message);
+    console.error('\nNote: Some information may require elevated privileges (administrator/root).');
+    process.exit(1);
+}

package/index.js

@@ -0,0 +1,33 @@
+/**
+ * node-smbios - Cross-platform SMBIOS information reader
+ * 
+ * This module provides a simple interface to read SMBIOS information
+ * from the system using native C++ code.
+ */
+
+try {
+    // Try to load prebuilt binary via node-pre-gyp
+    const binding_path = require('@mapbox/node-pre-gyp').find(
+        require('path').resolve(__dirname, './package.json')
+    );
+    module.exports = require(binding_path);
+} catch (err) {
+    try {
+        // Fall back to Release build
+        module.exports = require('./build/Release/smbios.node');
+    } catch (err2) {
+        try {
+            // Fall back to Debug build
+            module.exports = require('./build/Debug/smbios.node');
+        } catch (err3) {
+            // If no build is available, throw a helpful error
+            throw new Error(
+                'Native addon not found. Please run "npm install" or "npm run build" to compile the native addon.\n' +
+                'Original error: ' + err.message
+            );
+        }
+    }
+}
+
+// Add version information
+module.exports.version = require('./package.json').version;