@risleylima/escpos 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -5,6 +5,13 @@ 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.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
@@ -55,6 +62,7 @@ Initial stable release with USB and Serial adapter support.
 
 ## Version History
 
+- **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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@risleylima/escpos",
-  "version": "0.1.1",
+  "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');