@risleylima/escpos 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -5,7 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.0.15] - 2024-11-23
+## [0.2.0] - 2025-11-23
+
+### Added
+- `Serial.listSerial()` method to list all available serial ports
+  - Returns array of serial port objects with path, manufacturer, vendorId, productId, etc.
+  - Similar functionality to `USB.listUSB()` for consistency between adapters
+
+## [0.1.0] - 2025-11-23
 
 ### Added
 - Complete JSDoc documentation for all public APIs
@@ -55,6 +62,7 @@ Initial stable release with USB and Serial adapter support.
 
 ## Version History
 
-- **0.0.15** - Major dependency updates, 100% test coverage, complete documentation
+- **0.2.0** - Added `Serial.listSerial()` method for listing available serial ports
+- **0.1.0** - Major dependency updates, 100% test coverage, complete documentation
 - **0.0.14** - Initial stable release
 

package/README.md

@@ -215,6 +215,14 @@ await USB.disconnect();
 
 #### Methods
 
+##### `Serial.listSerial()`
+List all available serial ports.
+
+```javascript
+const ports = await Serial.listSerial();
+console.log(ports); // Array of serial port objects with path, manufacturer, vendorId, productId, etc.
+```
+
 ##### `Serial.connect(port, options)`
 Connect to a serial port printer.
 

package/docs/LIBRARY_OVERVIEW.md

@@ -3,7 +3,7 @@
 ## 📋 General Information
 
 - **Name**: `@risleylima/escpos`
-- **Version**: `0.0.14`
+- **Version**: `0.1.0`
 - **License**: MIT
 - **Node.js**: `>=18.0.0`
 - **Description**: Library to manage ESC/POS commands in Buffer (Node.js), then use an adapter to send the resulting data to the printer.

package/docs/PRE_PUBLISH_CHECKLIST.md

@@ -189,7 +189,7 @@ node -e "console.log(require('./package.json').version)"
 
 # Check if version follows semantic versioning
 # MAJOR.MINOR.PATCH
-# 0.0.14 -> 0.0.15 (minor update)
+# 0.0.14 -> 0.1.0 (minor update)
 ```
 
 **What to check:**
@@ -302,7 +302,7 @@ npx np minor
 
 ## 🎯 Specific Recommendations for This Version
 
-For v0.0.15, check especially:
+For v0.1.0, check especially:
 
 1. **Major Dependency Updates:**
    - [x] `usb@^2.16.0` - Promise-based API working

package/docs/PUBLIC_API_ANALYSIS.md

@@ -186,8 +186,7 @@ await printer.flush();
 ### Version Strategy
 
 Since there are **NO breaking changes** to the public API:
-- **Minor version bump**: `0.0.14` → `0.0.15` (recommended)
-- **OR patch version**: `0.0.14` → `0.0.15` (if you want to be conservative)
+- **Minor version bump**: `0.0.14` → `0.1.0` (published)
 
 **NOT a major version** because public API is unchanged.
 

package/docs/VERIFICATION_RESULTS.md

@@ -1,7 +1,7 @@
 # Pre-Publish Verification Results
 
-Date: 2024-11-23  
-Version: 0.0.15 (to be published)
+Date: 2025-11-23  
+Version: 0.1.0 (published)
 
 ## ✅ All Verifications Passed
 
@@ -89,7 +89,7 @@ Version: 0.0.15 (to be published)
 ### 10. Versioning Verification ✅
 - **Status**: PASSED
 - **Current Version**: 0.0.14
-- **Next Version**: 0.0.15 (minor update)
+- **Next Version**: 0.1.0 (minor update)
 - **Semantic Versioning**: ✅ Follows semver
 - **CHANGELOG**: ✅ Version 0.0.14 found in CHANGELOG
 - **Breaking Changes**: None in public API
@@ -151,7 +151,7 @@ Version: 0.0.15 (to be published)
 
 ## 🎯 Ready for Publication
 
-**All verifications passed!** The package is ready to be published as v0.0.15.
+**All verifications passed!** The package was successfully published as v0.1.0.
 
 ### Next Steps:
 1. Review CHANGELOG.md

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@risleylima/escpos",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Library to deal with ESCPOS using some adapters",
   "main": "index.js",
   "author": "Rlima Info",

package/src/serial-adapter/index.js

@@ -26,6 +26,22 @@ const scope = {
 // Create Adapter instance first, so it's the same object used internally and exported
 const Serial = new Adapter();
 
+/**
+ * List all available serial ports
+ * @async
+ * @returns {Promise<Array<Object>>} Array of serial port objects with properties like path, manufacturer, vendorId, productId, etc.
+ * @example
+ * const ports = await Serial.listSerial();
+ * console.log(ports);
+ * // [
+ * //   { path: '/dev/ttyUSB0', manufacturer: 'FTDI', vendorId: '0403', productId: '6001' },
+ * //   { path: '/dev/ttyUSB1', manufacturer: 'Prolific', vendorId: '067b', productId: '2303' }
+ * // ]
+ */
+Serial.listSerial = async () => {
+  return await SerialPort.list();
+};
+
 /**
  * Connect to a serial port printer
  * @async

package/tests/unit/adapters/serial-adapter.test.js

@@ -49,6 +49,20 @@ describe('Serial Adapter', () => {
     jest.clearAllMocks();
   });
 
+  describe('listSerial', () => {
+    it('should list all available serial ports', async () => {
+      const ports = await Serial.listSerial();
+      expect(Array.isArray(ports)).toBe(true);
+      expect(SerialPort.list).toHaveBeenCalled();
+    });
+
+    it('should return port objects with path property', async () => {
+      const ports = await Serial.listSerial();
+      expect(ports.length).toBeGreaterThan(0);
+      expect(ports[0]).toHaveProperty('path');
+    });
+  });
+
   describe('connect', () => {
     it('should connect to serial port', async () => {
       const result = await Serial.connect('/dev/ttyUSB0');