@crowsgear/escl-protocol-scanner 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,170 @@
+/**
+ * eSCL/AirPrint Protocol Scanner Types
+ * HTTP-based network scanner protocol for Canon, HP, Epson, and other MFP devices
+ */
+/**
+ * eSCL Scanner device information
+ */
+export interface ESCLScanner {
+    /** Device name from mDNS (cleaned of service type suffix) */
+    name: string;
+    /** Network hostname or IP address */
+    host: string;
+    /** HTTP service port (typically 80) */
+    port: number;
+    /** Full mDNS service name */
+    serviceName?: string;
+    /** Device model from mDNS TXT record */
+    model?: string;
+    /** Device manufacturer */
+    manufacturer?: string;
+}
+/**
+ * Scanner capabilities response
+ */
+export interface ESCLCapabilities {
+    /** Available scan resolutions in DPI */
+    resolutions: number[];
+    /** Supported color modes */
+    colorModes: ('BlackAndWhite1' | 'Grayscale8' | 'RGB24')[];
+    /** Available scan sources */
+    sources: ('Platen' | 'Adf' | 'Feeder')[];
+    /** Maximum scannable area width in mm */
+    maxWidth?: number;
+    /** Maximum scannable area height in mm */
+    maxHeight?: number;
+}
+/**
+ * Scan request parameters
+ */
+export interface ESCLScanParams {
+    /** Target scanner device */
+    scanner: ESCLScanner;
+    /** Resolution in DPI (e.g., 200, 300) */
+    dpi: number;
+    /** Color mode for scanning */
+    mode: 'bw' | 'gray' | 'color';
+    /** Scan source */
+    source: 'Platen' | 'Feeder';
+}
+/**
+ * Scanned image data
+ */
+export interface ScannedImage {
+    /** Base64 encoded PNG image data */
+    data: string;
+    /** Image dimensions */
+    width: number;
+    height: number;
+    /** Color mode used for scanning */
+    colorMode: string;
+}
+/**
+ * Generic eSCL response wrapper
+ */
+export interface ESCLResponse {
+    /** Operation success status */
+    success: boolean;
+    /** List of discovered scanners */
+    scanners?: ESCLScanner[];
+    /** Scanner capabilities */
+    capabilities?: ESCLCapabilities;
+    /** Scanned images */
+    images?: string[];
+    /** Number of images returned */
+    count?: number;
+    /** Error message if operation failed */
+    error?: string;
+    /** Additional response metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Scanner response for local scanner backend
+ */
+export interface ScannerResponse {
+    success: boolean;
+    scanners?: Array<{
+        id: string;
+        name: string;
+        type: string;
+    }>;
+    images?: string[];
+    count?: number;
+    error?: string;
+}
+/**
+ * Color mode mapping for UI display
+ */
+export interface ColorModeMap {
+    [key: string]: {
+        value: 'bw' | 'gray' | 'color';
+        label: string;
+    };
+}
+/**
+ * Image save parameters
+ */
+export interface SaveImageParams {
+    folderPath: string;
+    fileName: string;
+    imageData: string;
+}
+/**
+ * Image save result
+ */
+export interface SaveImageResult {
+    success: boolean;
+    filePath?: string;
+    error?: string;
+}
+/**
+ * Python subprocess command types
+ */
+export type ESCLCommand = {
+    action: 'list' | 'scan' | 'capabilities' | 'exit';
+    params?: ESCLScanParams;
+};
+/**
+ * Python subprocess command for legacy Python scanner
+ */
+export type PythonCommand = {
+    type: 'list' | 'scan' | 'exit';
+    params?: Record<string, unknown>;
+};
+/**
+ * Scan parameters for legacy Python scanner
+ */
+export interface ScanParams {
+    scanner?: {
+        name: string;
+        id: string;
+    };
+    dpi?: number;
+    mode?: string;
+    source?: string;
+}
+/**
+ * Python process spawn options
+ */
+export interface ProcessSpawnOptions {
+    /** Python executable path */
+    pythonPath?: string;
+    /** Enable verbose logging */
+    verbose?: boolean;
+    /** Timeout for subprocess communication (ms) */
+    timeout?: number;
+    /** Environment variables for Python process */
+    env?: NodeJS.ProcessEnv;
+}
+/**
+ * Scanner discovery response
+ */
+export interface DiscoveryResponse {
+    /** Operation success status */
+    success: boolean;
+    /** List of discovered scanners */
+    data: ESCLScanner[];
+    /** Error message if operation failed */
+    error?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0BAA0B;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,wCAAwC;IACxC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,4BAA4B;IAC5B,UAAU,EAAE,CAAC,gBAAgB,GAAG,YAAY,GAAG,OAAO,CAAC,EAAE,CAAC;IAC1D,6BAA6B;IAC7B,OAAO,EAAE,CAAC,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC,EAAE,CAAC;IACzC,yCAAyC;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,4BAA4B;IAC5B,OAAO,EAAE,WAAW,CAAC;IACrB,yCAAyC;IACzC,GAAG,EAAE,MAAM,CAAC;IACZ,8BAA8B;IAC9B,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,OAAO,CAAC;IAC9B,kBAAkB;IAClB,MAAM,EAAE,QAAQ,GAAG,QAAQ,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,oCAAoC;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,+BAA+B;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,kCAAkC;IAClC,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;IACzB,2BAA2B;IAC3B,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,qBAAqB;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,KAAK,CAAC;QACf,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;KACd,CAAC,CAAC;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,KAAK,EAAE,IAAI,GAAG,MAAM,GAAG,OAAO,CAAC;QAC/B,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,cAAc,GAAG,MAAM,CAAC;IAClD,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC;IACvC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,6BAA6B;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,6BAA6B;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gDAAgD;IAChD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,+BAA+B;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,kCAAkC;IAClC,IAAI,EAAE,WAAW,EAAE,CAAC;IACpB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}

package/dist/types.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * eSCL/AirPrint Protocol Scanner Types
+ * HTTP-based network scanner protocol for Canon, HP, Epson, and other MFP devices
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@crowsgear/escl-protocol-scanner",
+  "version": "0.1.0",
+  "description": "eSCL/AirPrint Protocol Scanner Library - HTTP-based network scanner support with mDNS discovery",
+  "license": "MIT",
+  "author": "byeong1",
+  "homepage": "https://github.com/byeong1/escl-protocol-scanner",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:byeong1/escl-protocol-scanner.git"
+  },
+  "bugs": {
+    "url": "https://github.com/byeong1/escl-protocol-scanner/issues"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./types": {
+      "import": "./dist/types.js",
+      "types": "./dist/types.d.ts"
+    },
+    "./client": {
+      "import": "./dist/client.js",
+      "types": "./dist/client.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "python",
+    "scripts",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "yarn run build",
+    "prepack": "yarn run build",
+    "postinstall": "node scripts/check-python-deps.js"
+  },
+  "keywords": [
+    "escl",
+    "scanner",
+    "airprint",
+    "network",
+    "mfp",
+    "printer"
+  ],
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "^24.7.2",
+    "typescript": "^5.9.3"
+  }
+}

package/python/base.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Scanner Backend Base Classes and Common Utilities
+"""
+
+from abc import ABC, abstractmethod
+import sys
+import json
+
+
+class ScannerBackend(ABC):
+    """Abstract base class for scanner backends"""
+
+    @abstractmethod
+    def list_scanners(self):
+        """
+        Return list of available scanners
+
+        Returns:
+            dict: {'success': bool, 'scanners': list, 'backend': str}
+                  or {'success': False, 'error': str}
+        """
+        pass
+
+    @abstractmethod
+    def scan(self, params):
+        """
+        Execute scan with given parameters
+
+        Args:
+            params (dict): {
+                'scanner': str,      # Scanner name/ID
+                'dpi': int,          # Resolution (default: 300)
+                'mode': str,         # 'gray', 'bw', 'color' (default: 'gray')
+                'format': str,       # 'a3', 'a4', 'b4', 'b5' (default: 'a3')
+                'adf': bool,         # Auto Document Feeder (default: True)
+                'duplex': bool       # Double-sided scanning (default: False)
+            }
+
+        Returns:
+            dict: {'success': bool, 'images': list, 'count': int, 'backend': str}
+                  or {'success': False, 'error': str}
+        """
+        pass
+
+
+def send_response(data):
+    """
+    Send JSON response via stdout
+
+    Args:
+        data (dict): Response data to send
+    """
+    response = json.dumps(data, ensure_ascii=False)
+    sys.stdout.write(response + '\n')
+    sys.stdout.flush()