@crowsgear/escl-protocol-scanner 1.1.1 → 1.2.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 eSCL Protocol Scanner Contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 eSCL Protocol Scanner Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.ko.md

@@ -0,0 +1,177 @@
+# @crowsgear/escl-protocol-scanner
+
+[English](./README.md)
+
+eSCL/AirPrint 프로토콜 기반 네트워크 스캐너 라이브러리입니다.
+
+> **참고**: 네트워크에 연결된 스캐너(WiFi 또는 LAN)만 지원합니다. USB 스캐너는 지원되지 않을 수 있습니다.
+
+## 설치
+
+```bash
+npm install @crowsgear/escl-protocol-scanner
+# 또는
+yarn add @crowsgear/escl-protocol-scanner
+```
+
+**Python 설치가 필요하지 않습니다!** Windows, macOS, Linux용 사전 빌드 바이너리가 포함되어 있습니다.
+별도의 Python 경로를 지정하여 사용할 수도 있습니다. 자세한 내용은 [Application (사용자 설정)](#application-사용자-설정)을 참고하세요.
+
+## 빠른 시작
+
+```typescript
+import { eSCLScanner } from '@crowsgear/escl-protocol-scanner';
+
+// 1. 스캐너 탐색 (result: IDiscoveryResponse)
+const result = await eSCLScanner.discoverScanners(10000);
+if (result.success && result.data.length > 0) {
+  console.log('발견된 스캐너:', result.data);
+}
+
+// 2. 스캐너 기능 조회 (result.data: IESCLScanner[])
+const scanner = result.data[0]; // 첫 번째 스캐너 선택
+const capabilities = await eSCLScanner.getCapabilities(scanner);
+console.log('해상도:', capabilities?.resolutions);
+console.log('색상 모드:', capabilities?.colorModes);
+
+// 3. 스캔 실행
+const filePaths = await eSCLScanner.quickScan({
+  scanner: scanner,
+  dpi: 300,
+  mode: 'color',
+  source: 'Platen',
+  documentFormat: 'image/jpeg',
+  savePath: '/path/to/save',
+});
+console.log('저장된 파일:', filePaths);
+```
+
+## API
+
+### eSCLScanner
+
+기본 인스턴스로, 바로 사용할 수 있습니다.
+
+```typescript
+import { eSCLScanner } from '@crowsgear/escl-protocol-scanner';
+
+// 스캐너 탐색
+const result = await eSCLScanner.discoverScanners(timeout?: number);
+
+// 스캐너 기능 조회
+const caps = await eSCLScanner.getCapabilities(scanner: IESCLScanner);
+
+// 빠른 스캔
+const files = await eSCLScanner.quickScan(params: IQuickScanParams);
+
+// 스캔 작업 생성
+const jobId = await eSCLScanner.createScanJob(scanner, dpi, colorMode, source, documentFormat, width?, height?);
+
+// 스캔 작업 상태 조회
+const status = await eSCLScanner.getScanJobStatus(scanner, jobId);
+
+// 이미지 다운로드
+const buffer = await eSCLScanner.downloadImage(scanner, imageUrl);
+```
+
+### Application (사용자 설정)
+
+사용자 설정을 위한 새 인스턴스를 생성합니다.
+
+```typescript
+import { Application } from '@crowsgear/escl-protocol-scanner';
+
+const myScanner = new Application({
+  timeout: 15000,
+  pythonPath: '/path/to/.venv/bin/python3', // 선택: Python 경로
+  debug: true,
+});
+
+const result = await myScanner.discoverScanners();
+```
+
+> **참고**: `pythonPath`를 지정하면 사전 빌드 바이너리보다 우선 적용됩니다.
+
+### quickScan 매개변수
+
+```typescript
+interface IQuickScanParams {
+  scanner: IESCLScanner;         // 스캐너 장치
+  dpi: number;                    // 해상도 (예: 200, 300, 600)
+  mode: 'bw' | 'gray' | 'color';  // 색상 모드
+  source: 'Platen' | 'Feeder';    // 스캔 소스 (평판/ADF)
+  documentFormat: string;         // MIME 타입 (예: 'image/jpeg')
+  savePath?: string;              // 저장 경로 (기본값: 현재 디렉터리)
+  width?: number;                 // 스캔 너비 mm (기본값: 210)
+  height?: number;                // 스캔 높이 mm (기본값: 297)
+  timeout?: number;               // 타임아웃 ms
+}
+```
+
+## 타입
+
+```typescript
+interface IESCLScanner {
+  name: string;
+  host: string;
+  port: number;
+  model?: string;
+  manufacturer?: string;
+}
+
+interface IESCLCapabilities {
+  resolutions: number[];
+  colorModes: ('BlackAndWhite1' | 'Grayscale8' | 'RGB24')[];
+  sources: ('Platen' | 'Adf' | 'Feeder')[];
+  documentFormats: string[];
+  maxWidth?: number;
+  maxHeight?: number;
+}
+
+interface IDiscoveryResponse {
+  success: boolean;
+  data: IESCLScanner[];
+  error?: string;
+}
+```
+
+## 용지 크기 참고
+
+| 용지    | 너비 (mm) | 높이 (mm) |
+|---------|-----------|-----------|
+| A4      | 210       | 297       |
+| A3      | 297       | 420       |
+| Letter  | 216       | 279       |
+| Legal   | 216       | 356       |
+
+## 지원 스캐너
+
+eSCL(AirPrint Scan) 프로토콜을 지원하는 모든 네트워크 스캐너 및 복합기에서 사용할 수 있습니다.
+Brother, Canon, Epson, HP, Ricoh, Xerox 등 주요 제조사의 최신 네트워크 복합기는 대부분 eSCL을 지원합니다.
+
+> eSCL은 Apple이 설계하고 [Mopria Alliance](https://mopria.org)가 업계 표준으로 관리하는 프로토콜입니다. 호환 기기 목록은 [Apple AirPrint 페이지](https://support.apple.com/en-us/102895)에서 확인할 수 있습니다.
+> 모든 기기에 대해 충분한 테스트가 이루어지지 않았으므로, 특정 기기에서 문제가 발생하면 [이슈](https://github.com/crowsgear/escl-protocol-scanner/issues)를 등록해 주세요.
+
+## 개발
+
+사전 빌드 바이너리 없이 개발하려면 Python 3과 `zeroconf`, `pillow`가 필요합니다.
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+pip install zeroconf pillow
+```
+
+```typescript
+import { Application } from '@crowsgear/escl-protocol-scanner';
+
+const scanner = new Application({
+  pythonPath: '/path/to/.venv/bin/python3',
+});
+
+const result = await scanner.discoverScanners();
+```
+
+## 라이선스
+
+MIT

package/README.md

@@ -1,173 +1,177 @@
-# @crowsgear/escl-protocol-scanner
-
-Network scanner library based on eSCL/AirPrint protocol.
-
-> **Note**: This library only supports network-connected scanners (WiFi or LAN). USB scanners are not supported.
-
-## Installation
-
-```bash
-npm install @crowsgear/escl-protocol-scanner
-# or
-yarn add @crowsgear/escl-protocol-scanner
-```
-
-**No Python installation required!** Pre-built binaries for Windows, macOS, and Linux are included.
-
-## Quick Start
-
-```typescript
-import { eSCLScanner } from '@crowsgear/escl-protocol-scanner';
-
-// 1. Discover scanners
-const result = await eSCLScanner.discoverScanners(10000);
-if (result.success && result.data.length > 0) {
-  console.log('Found scanners:', result.data);
-}
-
-// 2. Get scanner capabilities
-const scanner = result.data[0];
-const capabilities = await eSCLScanner.getCapabilities(scanner);
-console.log('Resolutions:', capabilities?.resolutions);
-console.log('Color modes:', capabilities?.colorModes);
-
-// 3. Perform scan
-const filePaths = await eSCLScanner.quickScan({
-  scanner: scanner,
-  dpi: 300,
-  mode: 'color',
-  source: 'Platen',
-  documentFormat: 'image/jpeg',
-  savePath: '/path/to/save',
-});
-console.log('Saved files:', filePaths);
-```
-
-## API
-
-### eSCLScanner
-
-Default instance, ready to use.
-
-```typescript
-import { eSCLScanner } from '@crowsgear/escl-protocol-scanner';
-
-// Discover scanners
-const result = await eSCLScanner.discoverScanners(timeout?: number);
-
-// Get scanner capabilities
-const caps = await eSCLScanner.getCapabilities(scanner: IESCLScanner);
-
-// Quick scan
-const files = await eSCLScanner.quickScan(params: IQuickScanParams);
-
-// Create scan job
-const jobId = await eSCLScanner.createScanJob(scanner, dpi, colorMode, source, documentFormat, width?, height?);
-
-// Get scan job status
-const status = await eSCLScanner.getScanJobStatus(scanner, jobId);
-
-// Download image
-const buffer = await eSCLScanner.downloadImage(scanner, imageUrl);
-```
-
-### Application (Custom Configuration)
-
-Create a new instance for custom configuration.
-
-```typescript
-import { Application } from '@crowsgear/escl-protocol-scanner';
-
-const myScanner = new Application({
-  timeout: 15000,
-  debug: true,
-});
-
-const result = await myScanner.discoverScanners();
-```
-
-### quickScan Parameters
-
-```typescript
-interface IQuickScanParams {
-  scanner: IESCLScanner;         // Scanner device
-  dpi: number;                    // Resolution (e.g., 200, 300, 600)
-  mode: 'bw' | 'gray' | 'color';  // Color mode
-  source: 'Platen' | 'Feeder';    // Scan source (flatbed/ADF)
-  documentFormat: string;         // MIME type (e.g., 'image/jpeg')
-  savePath?: string;              // Save path (default: cwd)
-  width?: number;                 // Scan width in mm (default: 210)
-  height?: number;                // Scan height in mm (default: 297)
-  timeout?: number;               // Timeout in ms
-}
-```
-
-## Types
-
-```typescript
-interface IESCLScanner {
-  name: string;
-  host: string;
-  port: number;
-  model?: string;
-  manufacturer?: string;
-}
-
-interface IESCLCapabilities {
-  resolutions: number[];
-  colorModes: ('BlackAndWhite1' | 'Grayscale8' | 'RGB24')[];
-  sources: ('Platen' | 'Adf' | 'Feeder')[];
-  documentFormats: string[];
-  maxWidth?: number;
-  maxHeight?: number;
-}
-
-interface IDiscoveryResponse {
-  success: boolean;
-  data: IESCLScanner[];
-  error?: string;
-}
-```
-
-## Paper Size Reference
-
-| Paper  | Width (mm) | Height (mm) |
-|--------|------------|-------------|
-| A4     | 210        | 297         |
-| A3     | 297        | 420         |
-| Letter | 216        | 279         |
-| Legal  | 216        | 356         |
-
-## Supported Scanners
-
-AirPrint/eSCL compatible network scanners:
-
-- Canon iR-ADV series
-- HP LaserJet MFP
-- Xerox WorkCentre
-- Epson WorkForce Pro
-- Other AirPrint compatible MFPs
-
-## Development
-
-For development without pre-built binaries, you can use Python directly:
-
-```bash
-pip install zeroconf pillow
-```
-
-```typescript
-import { Application } from '@crowsgear/escl-protocol-scanner';
-
-const scanner = new Application({
-  pythonPath: '/path/to/.venv/bin/python3',
-});
-
-const result = await scanner.discoverScanners();
-```
-
-> **Note**: When pre-built binaries exist, they take priority over Python scripts.
-
-## License
-
-MIT
+# @crowsgear/escl-protocol-scanner
+
+[한국어](./README.ko.md)
+
+Network scanner library based on eSCL/AirPrint protocol.
+
+> **Note**: This library only supports network-connected scanners (WiFi or LAN). USB scanners may not be supported.
+
+## Installation
+
+```bash
+npm install @crowsgear/escl-protocol-scanner
+# or
+yarn add @crowsgear/escl-protocol-scanner
+```
+
+**No Python installation required!** Pre-built binaries for Windows, macOS, and Linux are included.
+You can also specify a custom Python path. See [Application (Custom Configuration)](#application-custom-configuration) for details.
+
+## Quick Start
+
+```typescript
+import { eSCLScanner } from '@crowsgear/escl-protocol-scanner';
+
+// 1. Discover scanners (result: IDiscoveryResponse)
+const result = await eSCLScanner.discoverScanners(10000);
+if (result.success && result.data.length > 0) {
+  console.log('Found scanners:', result.data);
+}
+
+// 2. Get scanner capabilities (result.data: IESCLScanner[])
+const scanner = result.data[0]; // Select first scanner
+const capabilities = await eSCLScanner.getCapabilities(scanner);
+console.log('Resolutions:', capabilities?.resolutions);
+console.log('Color modes:', capabilities?.colorModes);
+
+// 3. Perform scan
+const filePaths = await eSCLScanner.quickScan({
+  scanner: scanner,
+  dpi: 300,
+  mode: 'color',
+  source: 'Platen',
+  documentFormat: 'image/jpeg',
+  savePath: '/path/to/save',
+});
+console.log('Saved files:', filePaths);
+```
+
+## API
+
+### eSCLScanner
+
+Default instance, ready to use.
+
+```typescript
+import { eSCLScanner } from '@crowsgear/escl-protocol-scanner';
+
+// Discover scanners
+const result = await eSCLScanner.discoverScanners(timeout?: number);
+
+// Get scanner capabilities
+const caps = await eSCLScanner.getCapabilities(scanner: IESCLScanner);
+
+// Quick scan
+const files = await eSCLScanner.quickScan(params: IQuickScanParams);
+
+// Create scan job
+const jobId = await eSCLScanner.createScanJob(scanner, dpi, colorMode, source, documentFormat, width?, height?);
+
+// Get scan job status
+const status = await eSCLScanner.getScanJobStatus(scanner, jobId);
+
+// Download image
+const buffer = await eSCLScanner.downloadImage(scanner, imageUrl);
+```
+
+### Application (Custom Configuration)
+
+Create a new instance for custom configuration.
+
+```typescript
+import { Application } from '@crowsgear/escl-protocol-scanner';
+
+const myScanner = new Application({
+  timeout: 15000,
+  pythonPath: '/path/to/.venv/bin/python3', // Optional: Python path
+  debug: true,
+});
+
+const result = await myScanner.discoverScanners();
+```
+
+> **Note**: When `pythonPath` is provided, it takes priority over pre-built binaries.
+
+### quickScan Parameters
+
+```typescript
+interface IQuickScanParams {
+  scanner: IESCLScanner;         // Scanner device
+  dpi: number;                    // Resolution (e.g., 200, 300, 600)
+  mode: 'bw' | 'gray' | 'color';  // Color mode
+  source: 'Platen' | 'Feeder';    // Scan source (flatbed/ADF)
+  documentFormat: string;         // MIME type (e.g., 'image/jpeg')
+  savePath?: string;              // Save path (default: cwd)
+  width?: number;                 // Scan width in mm (default: 210)
+  height?: number;                // Scan height in mm (default: 297)
+  timeout?: number;               // Timeout in ms
+}
+```
+
+## Types
+
+```typescript
+interface IESCLScanner {
+  name: string;
+  host: string;
+  port: number;
+  model?: string;
+  manufacturer?: string;
+}
+
+interface IESCLCapabilities {
+  resolutions: number[];
+  colorModes: ('BlackAndWhite1' | 'Grayscale8' | 'RGB24')[];
+  sources: ('Platen' | 'Adf' | 'Feeder')[];
+  documentFormats: string[];
+  maxWidth?: number;
+  maxHeight?: number;
+}
+
+interface IDiscoveryResponse {
+  success: boolean;
+  data: IESCLScanner[];
+  error?: string;
+}
+```
+
+## Paper Size Reference
+
+| Paper  | Width (mm) | Height (mm) |
+|--------|------------|-------------|
+| A4     | 210        | 297         |
+| A3     | 297        | 420         |
+| Letter | 216        | 279         |
+| Legal  | 216        | 356         |
+
+## Supported Scanners
+
+Works with any network scanner or MFP that supports the eSCL (AirPrint Scan) protocol.
+Most modern network MFPs from Brother, Canon, Epson, HP, Ricoh, Xerox, and others support eSCL.
+
+> eSCL is a protocol designed by Apple and maintained as an industry standard by the [Mopria Alliance](https://mopria.org). For a list of compatible devices, see the [Apple AirPrint page](https://support.apple.com/en-us/102895).
+> Not all devices have been fully tested. If you encounter issues with a specific device, please [open an issue](https://github.com/crowsgear/escl-protocol-scanner/issues).
+
+## Development
+
+For development without pre-built binaries, Python 3 with `zeroconf` and `pillow` is required.
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+pip install zeroconf pillow
+```
+
+```typescript
+import { Application } from '@crowsgear/escl-protocol-scanner';
+
+const scanner = new Application({
+  pythonPath: '/path/to/.venv/bin/python3',
+});
+
+const result = await scanner.discoverScanners();
+```
+
+## License
+
+MIT

package/dist/main.d.ts

@@ -4,11 +4,11 @@
  * 애플리케이션 진입점
  * Application 인스턴스를 생성하고 export
  */
-import { Application } from './core/application';
-export * from './types';
-export { Application } from './core/application';
-export { ESCLClient } from './services/client';
-export { ESCLDiscovery } from './services/discovery';
+import { Application } from "./core/application";
+export * from "./types";
+export { Application } from "./core/application";
+export { ESCLClient } from "./services/client";
+export { ESCLDiscovery } from "./services/discovery";
 declare const eSCLScanner: Application;
 export { eSCLScanner };
 export declare const VERSION: string;

package/dist/main.js

@@ -36,5 +36,5 @@ const eSCLScanner = new application_1.Application();
 exports.eSCLScanner = eSCLScanner;
 // Version (package.json에서 가져옴)
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-exports.VERSION = require('../package.json').version;
+exports.VERSION = require("../package.json").version;
 //# sourceMappingURL=main.js.map

package/dist/services/client.js

@@ -163,28 +163,28 @@ class ESCLClient {
         /* mm to 1/300 inch 변환 */
         const widthInUnits = Math.round((width || 210) / 25.4 * 300);
         const heightInUnits = Math.round((height || 297) / 25.4 * 300);
-        return `<?xml version="1.0" encoding="UTF-8"?>
-<scan:ScanSettings xmlns:scan="${ESCL_NS}" xmlns:pwg="${PWG_NS}">
-  <pwg:Version>2.0</pwg:Version>
-  <scan:Intent>Document</scan:Intent>
-  <pwg:ScanRegions>
-    <pwg:ScanRegion>
-      <pwg:ContentRegionUnits>escl:ThreeHundredthsOfInches</pwg:ContentRegionUnits>
-      <pwg:XOffset>0</pwg:XOffset>
-      <pwg:YOffset>0</pwg:YOffset>
-      <pwg:Width>${widthInUnits}</pwg:Width>
-      <pwg:Height>${heightInUnits}</pwg:Height>
-    </pwg:ScanRegion>
-  </pwg:ScanRegions>
-  <scan:Justification>
-    <pwg:XImagePosition>Center</pwg:XImagePosition>
-    <pwg:YImagePosition>Center</pwg:YImagePosition>
-  </scan:Justification>
-  <pwg:InputSource>${source}</pwg:InputSource>
-  <scan:ColorMode>${colorMode}</scan:ColorMode>
-  <scan:XResolution>${dpi}</scan:XResolution>
-  <scan:YResolution>${dpi}</scan:YResolution>
-  <pwg:DocumentFormat>${documentFormat}</pwg:DocumentFormat>
+        return `<?xml version="1.0" encoding="UTF-8"?>
+<scan:ScanSettings xmlns:scan="${ESCL_NS}" xmlns:pwg="${PWG_NS}">
+  <pwg:Version>2.0</pwg:Version>
+  <scan:Intent>Document</scan:Intent>
+  <pwg:ScanRegions>
+    <pwg:ScanRegion>
+      <pwg:ContentRegionUnits>escl:ThreeHundredthsOfInches</pwg:ContentRegionUnits>
+      <pwg:XOffset>0</pwg:XOffset>
+      <pwg:YOffset>0</pwg:YOffset>
+      <pwg:Width>${widthInUnits}</pwg:Width>
+      <pwg:Height>${heightInUnits}</pwg:Height>
+    </pwg:ScanRegion>
+  </pwg:ScanRegions>
+  <scan:Justification>
+    <pwg:XImagePosition>Center</pwg:XImagePosition>
+    <pwg:YImagePosition>Center</pwg:YImagePosition>
+  </scan:Justification>
+  <pwg:InputSource>${source}</pwg:InputSource>
+  <scan:ColorMode>${colorMode}</scan:ColorMode>
+  <scan:XResolution>${dpi}</scan:XResolution>
+  <scan:YResolution>${dpi}</scan:YResolution>
+  <pwg:DocumentFormat>${documentFormat}</pwg:DocumentFormat>
 </scan:ScanSettings>`;
     }
     /**

package/dist/services/discovery.d.ts

@@ -3,7 +3,7 @@
  * Uses Python's zeroconf library for mDNS discovery
  * Prefers pre-built binary if available, falls back to Python script
  */
-import { IESCLScanner, IDiscoveryResponse, IESCLDiscoveryOptions } from '../types';
+import { IESCLScanner, IDiscoveryResponse, IESCLDiscoveryOptions } from "../types";
 export type { IESCLDiscoveryOptions };
 /**
  * eSCL Scanner Discovery Service