node-thermal-printer-js 1.0.2 → 1.0.4

package/README.md

@@ -2,6 +2,16 @@
 
 Public npm package for sending ESC/POS print jobs to a PSF588 printer over BLE or classic Bluetooth COM port.
 
+## Requirements (Read First)
+
+- Node.js is required for all usage.
+- BLE mode requires Python 3.11+ with `bleak` installed (this package uses a Python BLE bridge).
+- COM mode works with Node.js only, but your printer must already be paired as a COM port in your OS.
+
+## Quick Config (.env)
+
+All runtime settings can be changed from `.env` (transport, COM port, BLE name/address/UUID, timeouts) so you do not need to edit code files.
+
 ## Install
 
 ```bash

package/app.js

@@ -1,3 +1,4 @@
+import "dotenv/config";
 import { spawn } from "node:child_process";
 import { fileURLToPath } from "node:url";
 import path from "node:path";
@@ -57,22 +58,24 @@ const runPythonProcess = ({ cmd, cmdArgs, scriptArgs }) =>
   });
 
 const printViaComPort = async (data, options = {}) => {
-  const portPath = options.portPath || process.env.PRINTER_COM_PORT || "COM5";
+  const portPath = options.portPath || process.env.PRINTER_COM_PORT;
   const baudRate = options.baudRate || 9600;
 
   // Dynamically import `serialport` only when COM transport is requested.
-  let SerialPortModule;
+  let SerialPortCtor;
   try {
-    SerialPortModule = await import("serialport");
+    const SerialPortModule = await import("serialport");
+    SerialPortCtor = SerialPortModule.SerialPort || SerialPortModule.default;
+    
+    if (!SerialPortCtor) {
+      throw new Error("SerialPort constructor not found in module exports");
+    }
   } catch (e) {
     return Promise.reject(
       new Error(`serialport module not available: ${e.message}`),
     );
   }
 
-  const SerialPortCtor =
-    SerialPortModule.default || SerialPortModule.SerialPort || SerialPortModule;
-
   const port = new SerialPortCtor({
     path: portPath,
     baudRate,
@@ -110,7 +113,7 @@ const printViaBleBridge = (data, options = {}) => {
     "--data-b64",
     payload,
     "--name",
-    options.bleName || process.env.PRINTER_BLE_NAME || "PSF588",
+    options.bleName || process.env.PRINTER_BLE_NAME,
   ];
 
   if (options.bleAddress || process.env.PRINTER_BLE_ADDRESS) {
@@ -187,7 +190,7 @@ const printViaBleBridge = (data, options = {}) => {
 // Preferable on Windows: pair the PSF588 printer in OS Bluetooth settings
 // and note the outgoing COM port (e.g. COM5). Then call `printToPSF588(data, { portPath: 'COM5' })`.
 export const printData = (data, options = {}) => {
-  const transport = options.transport || process.env.PRINTER_TRANSPORT || "ble";
+  const transport = options.transport || process.env.PRINTER_TRANSPORT;
 
   if (transport === "ble") {
     return printViaBleBridge(data, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-thermal-printer-js",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "ESC/POS printer helper for PSF588 Bluetooth and COM printing.",
   "main": "app.js",
   "exports": {
@@ -31,6 +31,7 @@
     "access": "public"
   },
   "dependencies": {
+    "dotenv": "^16.6.1",
     "serialport": "^13.0.0"
   }
 }