@risleylima/escpos 0.0.13 → 0.1.0

package/docs/VERIFICATION_RESULTS.md

@@ -0,0 +1,172 @@
+# Pre-Publish Verification Results
+
+Date: 2024-11-23  
+Version: 0.0.15 (to be published)
+
+## ✅ All Verifications Passed
+
+### 1. NPM Package Verification ✅
+- **Status**: PASSED
+- **Package Name**: `@risleylima/escpos`
+- **Current Version**: `0.0.14`
+- **Files Included**: 
+  - ✅ Essential files (index.js, README.md, LICENSE, CHANGELOG.md)
+  - ✅ Source code (src/)
+  - ✅ Documentation (docs/)
+  - ✅ Examples (examples/)
+  - ✅ Configuration (package.json, jest.config.js)
+  - ✅ No node_modules included
+  - ✅ No test files included
+  - ✅ No .git included
+- **Package Size**: Reasonable (all files listed correctly)
+
+### 2. Dependencies Verification ✅
+- **Status**: PASSED
+- **Vulnerabilities**: 0 found (yarn audit)
+- **Outdated Dependencies**: 
+  - Only `get-pixels` shows as "exotic" (custom fork from GitHub - expected)
+  - All other dependencies are up to date
+- **Dependency Versions**:
+  - `usb@^2.16.0` ✅
+  - `serialport@^13.0.0` ✅
+  - `debug@^4.4.3` ✅
+  - `iconv-lite@^0.7.0` ✅
+  - `jest@^30.2.0` ✅
+
+### 3. Code Verification ✅
+- **Status**: PASSED
+- **Syntax**: No errors
+- **Exports**: All working correctly
+- **Load Time**: 0.083s (excellent performance)
+
+### 4. Test Verification ✅
+- **Status**: PASSED
+- **Total Tests**: 145
+- **Test Suites**: 9
+- **All Tests**: ✅ PASSING
+- **Coverage**:
+  - Statements: 100%
+  - Branches: 100%
+  - Functions: 100%
+  - Lines: 100%
+- **Result**: Perfect coverage achieved
+
+### 5. Compatibility Verification ✅
+- **Status**: PASSED
+- **Node.js Version**: v20.19.5 (current)
+- **Required Version**: >=18.0.0
+- **Compatibility**: ✅ Compatible
+- **Note**: Should test on Node.js 18 (minimum version) if possible
+
+### 6. Documentation Verification ✅
+- **Status**: PASSED
+- **README.md**: ✅ Complete and updated
+- **CHANGELOG.md**: ✅ Created with all changes
+- **JSDoc**: ✅ Complete (100% coverage)
+- **Additional Docs**: ✅ All translated to English
+- **Examples**: ✅ Present and documented
+
+### 7. Git Verification ✅
+- **Status**: PASSED
+- **Current Branch**: `main`
+- **Tags**: v0.0.5 through v0.0.9 exist
+- **Status**: Changes present (expected before commit)
+- **Sensitive Files**: ✅ None found (only documentation mentions)
+
+### 8. Build Verification ✅
+- **Status**: N/A (No build step required)
+- **Note**: This is a pure JavaScript library, no compilation needed
+
+### 9. Local Publication Verification ✅
+- **Status**: PASSED
+- **Exports Test**: ✅ All exports working
+  - USB ✅
+  - Serial ✅
+  - Printer ✅
+  - Adapter ✅
+  - Image ✅
+
+### 10. Versioning Verification ✅
+- **Status**: PASSED
+- **Current Version**: 0.0.14
+- **Next Version**: 0.0.15 (minor update)
+- **Semantic Versioning**: ✅ Follows semver
+- **CHANGELOG**: ✅ Version 0.0.14 found in CHANGELOG
+- **Breaking Changes**: None in public API
+
+### 11. Package Metadata Verification ✅
+- **Status**: PASSED
+- **Name**: `@risleylima/escpos` ✅
+- **Version**: `0.0.14` ✅
+- **Description**: "Library to deal with ESCPOS using some adapters" ✅
+- **Main**: `index.js` ✅
+- **Keywords**: ["EscPos", "USB"] ✅
+- **Author**: "Rlima Info" ✅
+- **License**: "MIT" ✅
+- **Repository**: `git+https://github.com/risleylima/escpos.git` ✅
+- **Bugs**: `https://github.com/risleylima/escpos/issues` ✅
+- **Homepage**: `https://github.com/risleylima/escpos#readme` ✅
+
+### 12. Security Verification ✅
+- **Status**: PASSED
+- **Vulnerabilities**: 0 found
+- **Sensitive Data**: ✅ None found
+  - No passwords
+  - No secrets
+  - No tokens
+  - No API keys
+- **Note**: Only documentation mentions of these terms (expected)
+
+### 13. Performance Verification ✅
+- **Status**: PASSED
+- **Load Time**: 0.083s (excellent)
+- **Package Size**: Reasonable
+- **Dependencies**: Only necessary ones included
+
+### 14. Essential Files Verification ✅
+- **Status**: PASSED
+- **index.js**: ✅ Present
+- **README.md**: ✅ Present
+- **LICENSE**: ✅ Present
+- **CHANGELOG.md**: ✅ Present
+- **package.json**: ✅ Present
+
+## 📊 Summary
+
+| Category | Status | Details |
+|----------|--------|---------|
+| Package | ✅ PASSED | All files correctly included |
+| Dependencies | ✅ PASSED | 0 vulnerabilities, all up to date |
+| Code | ✅ PASSED | No errors, fast load time |
+| Tests | ✅ PASSED | 145 tests, 100% coverage |
+| Compatibility | ✅ PASSED | Node.js >=18.0.0 |
+| Documentation | ✅ PASSED | Complete and in English |
+| Git | ✅ PASSED | On main branch |
+| Exports | ✅ PASSED | All working |
+| Versioning | ✅ PASSED | Follows semver |
+| Metadata | ✅ PASSED | All correct |
+| Security | ✅ PASSED | 0 vulnerabilities |
+| Performance | ✅ PASSED | Excellent |
+| Files | ✅ PASSED | All present |
+
+## 🎯 Ready for Publication
+
+**All verifications passed!** The package is ready to be published as v0.0.15.
+
+### Next Steps:
+1. Review CHANGELOG.md
+2. Commit changes (if needed)
+3. Run `npx np minor` to publish
+
+### Notes:
+- The package is in excellent condition
+- All dependencies are up to date
+- 100% test coverage achieved
+- Documentation is complete and in English
+- No security vulnerabilities
+- Performance is excellent
+
+---
+
+**Verification completed successfully! ✅**
+

package/jest.config.js

@@ -0,0 +1,16 @@
+module.exports = {
+  testEnvironment: 'node',
+  testMatch: [
+    '**/tests/**/*.test.js',
+    '**/__tests__/**/*.js'
+  ],
+  collectCoverageFrom: [
+    'src/**/*.js',
+    '!src/**/index.js'
+  ],
+  coverageDirectory: 'coverage',
+  coverageReporters: ['text', 'lcov', 'html'],
+  verbose: true,
+  testTimeout: 10000
+};
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@risleylima/escpos",
-  "version": "0.0.13",
+  "version": "0.1.0",
   "description": "Library to deal with ESCPOS using some adapters",
   "main": "index.js",
   "author": "Rlima Info",
@@ -10,17 +10,22 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "debug": "^4.3.1",
-    "get-pixels": "^3.3.2",
-    "iconv-lite": "^0.6.3",
-    "serialport": "^12.0.0",
-    "usb": "^1.9.1"
+    "debug": "^4.4.3",
+    "get-pixels": "https://github.com/risleylima/get-pixels",
+    "iconv-lite": "^0.7.0",
+    "serialport": "^13.0.0",
+    "usb": "^2.16.0"
+  },
+  "devDependencies": {
+    "jest": "^30.2.0"
   },
   "directories": {
     "example": "examples"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" "
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage"
   },
   "repository": {
     "type": "git",

package/src/adapter/index.js

@@ -7,8 +7,15 @@ class NotImplementedException extends Error {
 
 /**
  * Generic Adapter that will implement the different types of adapter that will be constructed
+ * @class
+ * @extends EventEmitter
+ * @classdesc Base adapter class that provides the interface for USB and Serial adapters
  */
 class Adapter extends EventEmitter {
+  /**
+   * Creates an instance of Adapter
+   * @param {Adapter} [adapter] - Optional adapter instance to copy properties from
+   */
   constructor(adapter) {
     super();
     if (adapter) {
@@ -18,18 +25,48 @@ class Adapter extends EventEmitter {
     }
   }
 
+  /**
+   * Connect to the device
+   * @abstract
+   * @throws {NotImplementedException} Must be implemented by subclasses
+   */
   connect() {
     throw new NotImplementedException();
   }
+
+  /**
+   * Open the device connection
+   * @abstract
+   * @throws {NotImplementedException} Must be implemented by subclasses
+   */
   open() {
     throw new NotImplementedException();
   }
+
+  /**
+   * Write data to the device
+   * @abstract
+   * @param {Buffer} data - Data to write
+   * @throws {NotImplementedException} Must be implemented by subclasses
+   */
   write() {
     throw new NotImplementedException();
   }
+
+  /**
+   * Close the device connection
+   * @abstract
+   * @throws {NotImplementedException} Must be implemented by subclasses
+   */
   close() {
     throw new NotImplementedException();
   }
+
+  /**
+   * Read data from the device
+   * @abstract
+   * @throws {NotImplementedException} Must be implemented by subclasses
+   */
   read() {
     throw new NotImplementedException();
   }

package/src/printer/commands.js

@@ -1,10 +1,12 @@
 'use strict';
 /**
  * Utility function that converts numbers into hex values
- *
- * @usage:
- *   numToHex(256) => '0100'
- *   numToHex(0) => '00'
+ * @param {Number|String} value - Number to convert to hex
+ * @returns {String} Hexadecimal string representation (padded to even length)
+ * @example
+ *   numToHexString(256) => '0100'
+ *   numToHexString(0) => '00'
+ *   numToHexString(15) => '0f'
  */
 const numToHexString = (value) => {
   let num = Number(value);

package/src/printer/image.js

@@ -2,8 +2,12 @@
 const getPixels = require('get-pixels');
 
 /**
- * EscPos Image Object
- * @param {[type]} pixels Pixels formatted by the Get Pixels NPM Library
+ * EscPos Image Object for thermal printer image processing
+ * @class
+ * @classdesc Converts image pixels to printer-compatible formats (bitmap/raster)
+ * @param {Object} pixels - Pixels object formatted by the Get Pixels NPM Library
+ * @param {Array} pixels.shape - Image dimensions [width, height, colors]
+ * @param {Uint8Array} pixels.data - Pixel data array
  */
 class Image {
   constructor(pixels) {
@@ -38,6 +42,13 @@ class Image {
     });
   }
 
+  /**
+   * Convert image to bitmap format for thermal printer
+   * @param {Number} [density=24] - Bitmap density (dots per line)
+   * @returns {Object} Bitmap data object with data array and density
+   * @returns {Array} returns.data - Array of line data arrays
+   * @returns {Number} returns.density - Density used
+   */
   toBitmap(density) {
     density = density || 24;
 
@@ -77,6 +88,13 @@ class Image {
     };
   }
 
+  /**
+   * Convert image to raster format for thermal printer
+   * @returns {Object} Raster data object
+   * @returns {Array} returns.data - Raster data array
+   * @returns {Number} returns.width - Raster width in bytes
+   * @returns {Number} returns.height - Raster height in pixels
+   */
   toRaster() {
     let result = [];
     let width = this.size.width;
@@ -116,11 +134,14 @@ class Image {
 
 
   /**
-   * [load description]
-   * @param  {[type]}   url      [description]
-   * @param  {[type]}   type     [description]
-   * @param  {Function} callback [description]
-   * @return {Promise<Image>} Promise containing the Image Object itself;
+   * Load an image from URL or file path
+   * @static
+   * @param {String} url - Image URL or file path
+   * @param {String} [type] - Image MIME type (e.g., 'image/png', 'image/jpeg')
+   * @returns {Promise<Image>} Promise resolving to Image instance
+   * @throws {Error} If image cannot be loaded
+   * @example
+   *   const image = await Image.load('/path/to/image.png', 'image/png');
    */
   static load(url, type) {
     return new Promise((resolve, reject) => {

package/src/printer/index.js

@@ -5,7 +5,6 @@ const iconv = require('iconv-lite');
 const utils = require('./utils');
 
 const Image = require('./image');
-const Adapter = require('../adapter');
 
 /**
  * This is the Special Buffer, a "Dinamyc" Buffer that will control the data that will be sent to the printer
@@ -49,7 +48,8 @@ class Printer {
    * @param {{encoding:string,width:string}} options Refers to the options that can be used to instantiate the class (Encoding, Size of Columns)
    */
   constructor(adapter, options) {
-    this.adapter = new Adapter(adapter);
+    // Use adapter directly to maintain consistency - adapter is already an Adapter instance (USB/Serial)
+    this.adapter = adapter;
     this.options = options;
     this.buffer = new SpecBuffer();
     this.Image = Image;
@@ -172,6 +172,11 @@ class Printer {
    * @param  {String} encoding Refers to the type of encoding that will be used
    * @return {Printer} The escpos printer instance 
    */
+  /**
+   * Set the character encoding for text printing
+   * @param {String} encoding - Encoding name (e.g., 'GB18030', 'UTF-8', 'ASCII')
+   * @returns {Printer} The escpos printer instance
+   */
   encode(encoding) {
     this.encoding = encoding;
     return this;

package/src/printer/utils.js

@@ -1,15 +1,17 @@
 'use strict';
 /**
-* Get CharLength
-* @return {number} 1 || 2
-*/
+ * Get character length (1 or 2 bytes for multi-byte characters)
+ * @param {String} char - Single character to measure
+ * @returns {Number} 1 for single-byte, 2 for multi-byte characters
+ */
 function charLength(char) {
     const code = char.charCodeAt(0);
     return code > 0x7f && code <= 0xffff ? 2 : 1; // More than 2bytes count as 2
 }
 /**
- * getParityBit
- * @return {String} ParityBit
+ * Calculate parity bit for a string (used in barcode generation)
+ * @param {String} str - String to calculate parity for
+ * @returns {String} Parity bit as string
  */
 exports.getParityBit = function (str) {
     var parity = 0, reversedCode = str.split('').reverse().join('');
@@ -20,18 +22,20 @@ exports.getParityBit = function (str) {
 };
 
 /**
-* Get Code Length
-* @return {String} String Length
-*/
+ * Get code length as hex string
+ * @param {String} str - String to get length for
+ * @returns {String} Length as hex string
+ */
 exports.codeLength = function (str) {
     let buff = Buffer.from((str.length).toString(16), 'hex');
     return buff.toString();
 }
 
 /**
-* Get Text Length
-* @return {Number} String Length
-*/
+ * Get text length accounting for multi-byte characters
+ * @param {String} str - String to measure
+ * @returns {Number} Text length (multi-byte characters count as 2)
+ */
 exports.textLength = function (str) {
     return str.split('').reduce((accLen, char) => {
         return accLen + charLength(char);
@@ -39,9 +43,12 @@ exports.textLength = function (str) {
 }
 
 /**
-* Get Text Substring
-* @return {String} Resulting String
-*/
+ * Get text substring accounting for multi-byte characters
+ * @param {String} str - String to extract from
+ * @param {Number} start - Start position (in character units, not bytes)
+ * @param {Number} [end] - End position (in character units, not bytes)
+ * @returns {String} Resulting substring
+ */
 exports.textSubstring = function (str, start, end) {
     let accLen = 0;
     return str.split('').reduce((accStr, char) => {