isahaq-barcode 1.2.0 → 1.2.1

package/README.md

@@ -42,7 +42,61 @@
 npm install isahaq-barcode
 ```
 
-**Requirements:** Node.js 14.0 or higher
+**Requirements:** Node.js 18.0 or higher
+
+## 🌐 Browser Compatibility
+
+> **Important:** This package is designed for **Node.js server-side environments** and is not compatible with browser environments.
+
+### Why Not Browser Compatible?
+
+- **Canvas Dependency**: Uses Node.js `canvas` library for image generation
+- **File System Access**: Requires Node.js `fs` module for file operations
+- **Server-Side Rendering**: Designed for server-side barcode generation
+
+### Recommended Usage Patterns
+
+**✅ Server-Side (Recommended):**
+
+```javascript
+// Node.js/Express.js server
+const BarcodeGenerator = require('isahaq-barcode');
+
+// Generate barcode on server
+app.get('/barcode/:data', (req, res) => {
+  const barcode = BarcodeGenerator.png(req.params.data, 'code128');
+  res.set('Content-Type', 'image/png');
+  res.send(barcode);
+});
+```
+
+**✅ Next.js API Routes:**
+
+```javascript
+// pages/api/barcode.js or app/api/barcode/route.js
+import BarcodeGenerator from 'isahaq-barcode';
+
+export default function handler(req, res) {
+  const barcode = BarcodeGenerator.png(req.query.data, 'code128');
+  res.setHeader('Content-Type', 'image/png');
+  res.send(barcode);
+}
+```
+
+**❌ Client-Side (Not Supported):**
+
+```javascript
+// This will NOT work in browsers
+import BarcodeGenerator from 'isahaq-barcode'; // ❌
+```
+
+### Alternative for Client-Side
+
+For browser-based barcode generation, consider:
+
+- **jsbarcode** - Client-side barcode generation
+- **qrcode** - Client-side QR code generation
+- **Server-side API** - Use this package on your backend
 
 **Global CLI Installation:**
 

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "isahaq-barcode",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "A universal barcode generator package supporting multiple barcode types and output formats, with extra features like batch generation, watermarking, validation, CLI, and Express.js integration",
   "main": "index.js",
+  "browser": {
+    "fs": false,
+    "path": false,
+    "os": false
+  },
   "bin": {
     "barcode-generate": "./bin/generate.js"
   },

package/src/builders/QrCodeBuilder.js

@@ -4,7 +4,15 @@
 
 const QRCode = require('qrcode');
 const { createCanvas, loadImage } = require('canvas');
-const fs = require('fs').promises;
+
+// Conditional fs import for Node.js environments only
+let fs;
+try {
+  fs = require('fs').promises;
+} catch {
+  // fs not available in browser environments
+  fs = null;
+}
 
 class QrCodeBuilder {
   constructor(options = {}) {
@@ -375,6 +383,11 @@ class QrCodeResult {
    * @returns {Promise<void>}
    */
   async saveToFile(filePath) {
+    if (!fs) {
+      throw new Error(
+        'File system operations are not available in browser environments. Use generate() or getDataUri() methods instead.'
+      );
+    }
     const buffer = await this.generate();
     await fs.writeFile(filePath, buffer);
   }