isahaq-barcode 1.0.0

package/index.js

@@ -0,0 +1,134 @@
+/**
+ * Isahaq Barcode Generator
+ * A universal barcode generator package supporting multiple barcode types and output formats
+ */
+
+const BarcodeService = require('./src/services/BarcodeService');
+const QrCodeBuilder = require('./src/builders/QrCodeBuilder');
+const { BarcodeTypes } = require('./src/types/BarcodeTypes');
+const { RenderFormats } = require('./src/renderers/RenderFormats');
+
+// Main service instance
+const barcodeService = new BarcodeService();
+
+/**
+ * Main Barcode Generator Class
+ */
+class BarcodeGenerator {
+  /**
+   * Generate a barcode in PNG format
+   * @param {string} data - The data to encode
+   * @param {string} type - The barcode type
+   * @param {Object} options - Additional options
+   * @returns {Buffer} PNG buffer
+   */
+  static png(data, type = 'code128', options = {}) {
+    return barcodeService.generate(data, type, 'png', options);
+  }
+
+  /**
+   * Generate a barcode in SVG format
+   * @param {string} data - The data to encode
+   * @param {string} type - The barcode type
+   * @param {Object} options - Additional options
+   * @returns {string} SVG string
+   */
+  static svg(data, type = 'code128', options = {}) {
+    return barcodeService.generate(data, type, 'svg', options);
+  }
+
+  /**
+   * Generate a barcode in HTML format
+   * @param {string} data - The data to encode
+   * @param {string} type - The barcode type
+   * @param {Object} options - Additional options
+   * @returns {string} HTML string
+   */
+  static html(data, type = 'code128', options = {}) {
+    return barcodeService.generate(data, type, 'html', options);
+  }
+
+  /**
+   * Generate a barcode in PDF format
+   * @param {string} data - The data to encode
+   * @param {string} type - The barcode type
+   * @param {Object} options - Additional options
+   * @returns {Buffer} PDF buffer
+   */
+  static pdf(data, type = 'code128', options = {}) {
+    return barcodeService.generate(data, type, 'pdf', options);
+  }
+
+  /**
+   * Generate a QR code with advanced features
+   * @param {Object} options - QR code options
+   * @returns {Object} QR code result
+   */
+  static modernQr(options = {}) {
+    return QrCodeBuilder.create(options);
+  }
+
+  /**
+   * Get available barcode types
+   * @returns {Array} Array of barcode types
+   */
+  static getBarcodeTypes() {
+    return BarcodeTypes.getAll();
+  }
+
+  /**
+   * Get available render formats
+   * @returns {Array} Array of render formats
+   */
+  static getRenderFormats() {
+    return RenderFormats.getAll();
+  }
+
+  /**
+   * Validate data for a specific barcode type
+   * @param {string} data - The data to validate
+   * @param {string} type - The barcode type
+   * @returns {Object} Validation result
+   */
+  static validate(data, type) {
+    return barcodeService.validate(data, type);
+  }
+
+  /**
+   * Generate multiple barcodes in batch
+   * @param {Array} items - Array of barcode generation items
+   * @returns {Array} Array of generated barcodes
+   */
+  static batch(items) {
+    return barcodeService.batch(items);
+  }
+
+  /**
+   * Get watermark positions for QR codes
+   * @returns {Array} Array of watermark positions
+   */
+  static getWatermarkPositions() {
+    return [
+      'top-left',
+      'top-right',
+      'bottom-left',
+      'bottom-right',
+      'center',
+      'top-center',
+      'bottom-center',
+      'left-center',
+      'right-center',
+    ];
+  }
+}
+
+// Export main class and utilities
+module.exports = BarcodeGenerator;
+module.exports.BarcodeGenerator = BarcodeGenerator;
+module.exports.BarcodeService = BarcodeService;
+module.exports.QrCodeBuilder = QrCodeBuilder;
+module.exports.BarcodeTypes = BarcodeTypes;
+module.exports.RenderFormats = RenderFormats;
+
+// Default export
+module.exports.default = BarcodeGenerator;

package/jest.config.js

@@ -0,0 +1,13 @@
+module.exports = {
+  testEnvironment: 'node',
+  testMatch: ['**/__tests__/**/*.js', '**/?(*.)+(spec|test).js'],
+  collectCoverageFrom: [
+    'src/**/*.js',
+    '!src/**/*.test.js',
+    '!src/**/__tests__/**',
+  ],
+  coverageDirectory: 'coverage',
+  coverageReporters: ['text', 'lcov', 'html'],
+  setupFilesAfterEnv: ['<rootDir>/tests/setup.js'],
+  testTimeout: 10000,
+};

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "isahaq-barcode",
+  "version": "1.0.0",
+  "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",
+  "bin": {
+    "barcode-generate": "./bin/generate.js"
+  },
+  "scripts": {
+    "test": "npx jest",
+    "test:watch": "npx jest --watch",
+    "test:coverage": "npx jest --coverage",
+    "lint": "npx eslint .",
+    "lint:fix": "npx eslint . --fix",
+    "build": "npm run lint",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "barcode",
+    "qrcode",
+    "generator",
+    "code128",
+    "code39",
+    "ean13",
+    "upc",
+    "datamatrix",
+    "pdf417",
+    "aztec",
+    "svg",
+    "png",
+    "pdf",
+    "cli",
+    "express",
+    "node"
+  ],
+  "author": "hmisahaq01@gmail.com",
+  "license": "MIT",
+  "dependencies": {
+    "canvas": "^2.11.2",
+    "jsbarcode": "^3.11.5",
+    "qrcode": "^1.5.3",
+    "pdfkit": "^0.14.0",
+    "commander": "^11.1.0",
+    "chalk": "^4.1.2",
+    "ora": "^5.4.1"
+  },
+  "devDependencies": {
+    "jest": "^29.7.0",
+    "eslint": "^8.57.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^6.1.1"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/isahaq1/barcode-generator-npm.git"
+  },
+  "bugs": {
+    "url": "https://github.com/isahaq1/barcode-generator-npm/issues"
+  },
+  "homepage": "https://github.com/isahaq1/barcode-generator-npm#readme"
+}

package/src/builders/QrCodeBuilder.js

@@ -0,0 +1,401 @@
+/**
+ * QR Code Builder - Advanced QR code generation with logo and watermark support
+ */
+
+const QRCode = require('qrcode');
+const { createCanvas, loadImage } = require('canvas');
+const fs = require('fs').promises;
+
+class QrCodeBuilder {
+  constructor(options = {}) {
+    this.options = {
+      data: '',
+      size: 300,
+      margin: 10,
+      errorCorrectionLevel: 'M',
+      foregroundColor: [0, 0, 0],
+      backgroundColor: [255, 255, 255],
+      logoPath: null,
+      logoSize: 60, // Percentage of QR code size
+      label: null,
+      labelFont: null,
+      labelFontSize: 16,
+      watermark: null,
+      watermarkPosition: 'center',
+      format: 'png',
+      ...options,
+    };
+  }
+
+  /**
+   * Create a new QR Code Builder instance
+   * @param {Object} options - Initial options
+   * @returns {QrCodeBuilder} Builder instance
+   */
+  static create(options = {}) {
+    return new QrCodeBuilder(options);
+  }
+
+  /**
+   * Set the data to encode
+   * @param {string} data - The data to encode
+   * @returns {QrCodeBuilder} Builder instance
+   */
+  data(data) {
+    this.options.data = data;
+    return this;
+  }
+
+  /**
+   * Set the QR code size
+   * @param {number} size - Size in pixels
+   * @returns {QrCodeBuilder} Builder instance
+   */
+  size(size) {
+    this.options.size = size;
+    return this;
+  }
+
+  /**
+   * Set the margin
+   * @param {number} margin - Margin in pixels
+   * @returns {QrCodeBuilder} Builder instance
+   */
+  margin(margin) {
+    this.options.margin = margin;
+    return this;
+  }
+
+  /**
+   * Set the error correction level
+   * @param {string} level - Error correction level (L, M, Q, H)
+   * @returns {QrCodeBuilder} Builder instance
+   */
+  errorCorrectionLevel(level) {
+    this.options.errorCorrectionLevel = level;
+    return this;
+  }
+
+  /**
+   * Set the foreground color
+   * @param {Array} color - RGB color array [r, g, b]
+   * @returns {QrCodeBuilder} Builder instance
+   */
+  foregroundColor(color) {
+    this.options.foregroundColor = color;
+    return this;
+  }
+
+  /**
+   * Set the background color
+   * @param {Array} color - RGB color array [r, g, b]
+   * @returns {QrCodeBuilder} Builder instance
+   */
+  backgroundColor(color) {
+    this.options.backgroundColor = color;
+    return this;
+  }
+
+  /**
+   * Set the logo path
+   * @param {string} logoPath - Path to logo image
+   * @returns {QrCodeBuilder} Builder instance
+   */
+  logoPath(logoPath) {
+    this.options.logoPath = logoPath;
+    return this;
+  }
+
+  /**
+   * Set the logo size
+   * @param {number} logoSize - Logo size as percentage of QR code size
+   * @returns {QrCodeBuilder} Builder instance
+   */
+  logoSize(logoSize) {
+    this.options.logoSize = logoSize;
+    return this;
+  }
+
+  /**
+   * Set the label text
+   * @param {string} label - Label text
+   * @returns {QrCodeBuilder} Builder instance
+   */
+  label(label) {
+    this.options.label = label;
+    return this;
+  }
+
+  /**
+   * Set the label font
+   * @param {string} fontPath - Path to font file
+   * @param {number} fontSize - Font size
+   * @returns {QrCodeBuilder} Builder instance
+   */
+  labelFont(fontPath, fontSize = 16) {
+    this.options.labelFont = fontPath;
+    this.options.labelFontSize = fontSize;
+    return this;
+  }
+
+  /**
+   * Set the watermark
+   * @param {string} watermark - Watermark text or image path
+   * @param {string} position - Watermark position
+   * @returns {QrCodeBuilder} Builder instance
+   */
+  watermark(watermark, position = 'center') {
+    this.options.watermark = watermark;
+    this.options.watermarkPosition = position;
+    return this;
+  }
+
+  /**
+   * Set the output format
+   * @param {string} format - Output format (png, svg, jpg)
+   * @returns {QrCodeBuilder} Builder instance
+   */
+  format(format) {
+    this.options.format = format;
+    return this;
+  }
+
+  /**
+   * Build the QR code
+   * @returns {Object} QR code result
+   */
+  build() {
+    return new QrCodeResult(this.options);
+  }
+
+  /**
+   * Generate QR code and return as buffer
+   * @returns {Promise<Buffer>} QR code buffer
+   */
+  async generate() {
+    const result = this.build();
+    return await result.generate();
+  }
+
+  /**
+   * Generate QR code and save to file
+   * @param {string} filePath - Output file path
+   * @returns {Promise<void>}
+   */
+  async saveToFile(filePath) {
+    const result = this.build();
+    return await result.saveToFile(filePath);
+  }
+
+  /**
+   * Generate QR code and return as data URI
+   * @returns {Promise<string>} Data URI
+   */
+  async getDataUri() {
+    const result = this.build();
+    return await result.getDataUri();
+  }
+}
+
+/**
+ * QR Code Result - Handles QR code generation and output
+ */
+class QrCodeResult {
+  constructor(options) {
+    this.options = options;
+  }
+
+  /**
+   * Generate the QR code
+   * @returns {Promise<Buffer>} QR code buffer
+   */
+  async generate() {
+    try {
+      // Create canvas
+      const canvas = createCanvas(this.options.size, this.options.size);
+      const ctx = canvas.getContext('2d');
+
+      // Set background
+      ctx.fillStyle = this.rgbToHex(this.options.backgroundColor);
+      ctx.fillRect(0, 0, this.options.size, this.options.size);
+
+      // Generate QR code
+      const qrCodeDataURL = await QRCode.toDataURL(this.options.data, {
+        width: this.options.size - this.options.margin * 2,
+        margin: 0,
+        color: {
+          dark: this.rgbToHex(this.options.foregroundColor),
+          light: this.rgbToHex(this.options.backgroundColor),
+        },
+        errorCorrectionLevel: this.options.errorCorrectionLevel,
+      });
+
+      // Load QR code image
+      const qrCodeImage = await loadImage(qrCodeDataURL);
+      ctx.drawImage(qrCodeImage, this.options.margin, this.options.margin);
+
+      // Add logo if specified
+      if (this.options.logoPath) {
+        await this.addLogo(ctx);
+      }
+
+      // Add watermark if specified
+      if (this.options.watermark) {
+        await this.addWatermark(ctx);
+      }
+
+      // Add label if specified
+      if (this.options.label) {
+        this.addLabel(ctx);
+      }
+
+      // Convert to buffer
+      return canvas.toBuffer(`image/${this.options.format}`);
+    } catch (error) {
+      throw new Error(`QR code generation failed: ${error.message}`);
+    }
+  }
+
+  /**
+   * Add logo to QR code
+   * @param {CanvasRenderingContext2D} ctx - Canvas context
+   */
+  async addLogo(ctx) {
+    try {
+      const logoImage = await loadImage(this.options.logoPath);
+      const logoSize = (this.options.size * this.options.logoSize) / 100;
+      const logoX = (this.options.size - logoSize) / 2;
+      const logoY = (this.options.size - logoSize) / 2;
+
+      // Draw white background for logo
+      ctx.fillStyle = this.rgbToHex(this.options.backgroundColor);
+      ctx.fillRect(logoX - 5, logoY - 5, logoSize + 10, logoSize + 10);
+
+      // Draw logo
+      ctx.drawImage(logoImage, logoX, logoY, logoSize, logoSize);
+    } catch (error) {
+      console.warn(`Failed to add logo: ${error.message}`);
+    }
+  }
+
+  /**
+   * Add watermark to QR code
+   * @param {CanvasRenderingContext2D} ctx - Canvas context
+   */
+  async addWatermark(ctx) {
+    try {
+      // Check if watermark is an image path
+      if (
+        this.options.watermark.includes('.') &&
+        this.options.watermark.includes('/')
+      ) {
+        const watermarkImage = await loadImage(this.options.watermark);
+        const watermarkSize = this.options.size / 4;
+        const position = this.getWatermarkPosition(watermarkSize);
+
+        ctx.drawImage(
+          watermarkImage,
+          position.x,
+          position.y,
+          watermarkSize,
+          watermarkSize
+        );
+      } else {
+        // Text watermark
+        ctx.font = `${this.options.labelFontSize}px Arial`;
+        ctx.fillStyle = this.rgbToHex(this.options.foregroundColor);
+        ctx.textAlign = 'center';
+
+        const position = this.getWatermarkPosition(0);
+        ctx.fillText(this.options.watermark, position.x, position.y);
+      }
+    } catch (error) {
+      console.warn(`Failed to add watermark: ${error.message}`);
+    }
+  }
+
+  /**
+   * Add label to QR code
+   * @param {CanvasRenderingContext2D} ctx - Canvas context
+   */
+  addLabel(ctx) {
+    ctx.font = `${this.options.labelFontSize}px Arial`;
+    ctx.fillStyle = this.rgbToHex(this.options.foregroundColor);
+    ctx.textAlign = 'center';
+
+    const labelY = this.options.size - 10;
+    ctx.fillText(this.options.label, this.options.size / 2, labelY);
+  }
+
+  /**
+   * Get watermark position
+   * @param {number} size - Watermark size
+   * @returns {Object} Position coordinates
+   */
+  getWatermarkPosition(size) {
+    const positions = {
+      'top-left': { x: 10, y: 10 },
+      'top-right': { x: this.options.size - size - 10, y: 10 },
+      'bottom-left': { x: 10, y: this.options.size - size - 10 },
+      'bottom-right': {
+        x: this.options.size - size - 10,
+        y: this.options.size - size - 10,
+      },
+      center: {
+        x: (this.options.size - size) / 2,
+        y: (this.options.size - size) / 2,
+      },
+      'top-center': { x: (this.options.size - size) / 2, y: 10 },
+      'bottom-center': {
+        x: (this.options.size - size) / 2,
+        y: this.options.size - size - 10,
+      },
+      'left-center': { x: 10, y: (this.options.size - size) / 2 },
+      'right-center': {
+        x: this.options.size - size - 10,
+        y: (this.options.size - size) / 2,
+      },
+    };
+
+    return positions[this.options.watermarkPosition] || positions.center;
+  }
+
+  /**
+   * Convert RGB array to hex color
+   * @param {Array} rgb - RGB color array
+   * @returns {string} Hex color
+   */
+  rgbToHex(rgb) {
+    return `#${rgb.map((c) => c.toString(16).padStart(2, '0')).join('')}`;
+  }
+
+  /**
+   * Save QR code to file
+   * @param {string} filePath - Output file path
+   * @returns {Promise<void>}
+   */
+  async saveToFile(filePath) {
+    const buffer = await this.generate();
+    await fs.writeFile(filePath, buffer);
+  }
+
+  /**
+   * Get QR code as data URI
+   * @returns {Promise<string>} Data URI
+   */
+  async getDataUri() {
+    const buffer = await this.generate();
+    const base64 = buffer.toString('base64');
+    return `data:image/${this.options.format};base64,${base64}`;
+  }
+
+  /**
+   * Get QR code as string
+   * @returns {Promise<string>} QR code string
+   */
+  async getString() {
+    return await this.generate();
+  }
+}
+
+module.exports = QrCodeBuilder;