id-scanner-lib 1.3.2 → 1.5.0

package/src/modules/qrcode/qr-code-scanner.ts

@@ -0,0 +1,230 @@
+/**
+ * @file 二维码扫描器
+ * @description 提供二维码检测和解析功能
+ * @module modules/qrcode/qr-code-scanner
+ */
+
+import { EventEmitter } from '../../core/event-emitter';
+import { Logger } from '../../core/logger';
+import { QRCodeResult } from './types';
+import jsQR from 'jsqr';
+
+/**
+ * 二维码扫描器配置选项
+ */
+export interface QRCodeScannerOptions {
+  /** 最小置信度 */
+  minConfidence?: number;
+  /** 是否返回原始图像 */
+  returnImage?: boolean;
+  /** 图像处理配置 */
+  imageProcess?: {
+    /** 是否进行预处理 */
+    preprocess?: boolean;
+    /** 是否增强对比度 */
+    enhanceContrast?: boolean;
+    /** 二值化阈值 */
+    threshold?: number;
+  };
+}
+
+/**
+ * 二维码扫描器类
+ */
+export class QRCodeScanner extends EventEmitter {
+  private options: QRCodeScannerOptions;
+  private logger: Logger;
+  private initialized: boolean = false;
+
+  /**
+   * 构造函数
+   * @param options 配置选项
+   */
+  constructor(options: QRCodeScannerOptions = {}) {
+    super();
+    this.options = {
+      minConfidence: 0.6,
+      returnImage: false,
+      imageProcess: {
+        preprocess: true,
+        enhanceContrast: true,
+        threshold: 128,
+        ...options.imageProcess
+      },
+      ...options
+    };
+    this.logger = Logger.getInstance();
+  }
+
+  /**
+   * 初始化扫描器
+   */
+  public async initialize(): Promise<void> {
+    if (this.initialized) {
+      return;
+    }
+
+    this.logger.debug('QRCodeScanner', '初始化二维码扫描器');
+    
+    // 验证jsQR是否可用
+    if (typeof jsQR !== 'function') {
+      throw new Error('jsQR库未加载，请确保已安装jsqr依赖');
+    }
+
+    this.initialized = true;
+    this.logger.debug('QRCodeScanner', '二维码扫描器初始化完成');
+  }
+
+  /**
+   * 扫描图像中的二维码
+   * @param image 图像源
+   * @returns 二维码扫描结果
+   */
+  public async scan(
+    image: ImageData | HTMLImageElement | HTMLCanvasElement
+  ): Promise<QRCodeResult | undefined> {
+    if (!this.initialized) {
+      await this.initialize();
+    }
+
+    // 将输入转换为ImageData
+    const imageData = this.getImageData(image);
+    
+    // 图像预处理
+    const processedImage = this.options.imageProcess?.preprocess
+      ? this.preprocessImage(imageData)
+      : imageData;
+
+    // 使用jsQR进行扫描
+    const code = jsQR(
+      processedImage.data,
+      processedImage.width,
+      processedImage.height,
+      {
+        inversionAttempts: 'dontInvert'
+      }
+    );
+
+    if (!code) {
+      return undefined;
+    }
+
+    // 构建结果
+    const result: QRCodeResult = {
+      data: code.data,
+      boundingBox: {
+        topLeft: code.location.topLeftCorner,
+        topRight: code.location.topRightCorner,
+        bottomRight: code.location.bottomRightCorner,
+        bottomLeft: code.location.bottomLeftCorner
+      },
+      center: {
+        x: Math.round((code.location.topLeftCorner.x + code.location.bottomRightCorner.x) / 2),
+        y: Math.round((code.location.topLeftCorner.y + code.location.bottomRightCorner.y) / 2)
+      },
+      confidence: 1.0 // jsQR不提供置信度，默认为1.0
+    };
+
+    // 如果需要返回原始图像
+    if (this.options.returnImage) {
+      result.image = imageData;
+    }
+
+    this.logger.debug('QRCodeScanner', `扫描到二维码: ${result.data.substring(0, 20)}${result.data.length > 20 ? '...' : ''}`);
+    
+    return result;
+  }
+
+  /**
+   * 将各种图像源转换为ImageData
+   * @param image 图像源
+   * @returns ImageData
+   */
+  private getImageData(
+    image: ImageData | HTMLImageElement | HTMLCanvasElement
+  ): ImageData {
+    // 如果已经是ImageData，直接返回
+    if (image instanceof ImageData) {
+      return image;
+    }
+
+    // 创建canvas并获取2D上下文
+    const canvas = document.createElement('canvas');
+    const ctx = canvas.getContext('2d');
+
+    if (!ctx) {
+      throw new Error('无法创建Canvas上下文');
+    }
+
+    // 设置canvas尺寸
+    canvas.width = image.width;
+    canvas.height = image.height;
+
+    // 绘制图像
+    ctx.drawImage(image, 0, 0);
+
+    // 获取ImageData
+    return ctx.getImageData(0, 0, canvas.width, canvas.height);
+  }
+
+  /**
+   * 图像预处理
+   * @param imageData 原始图像数据
+   * @returns 处理后的图像数据
+   */
+  private preprocessImage(imageData: ImageData): ImageData {
+    // 创建canvas并获取2D上下文
+    const canvas = document.createElement('canvas');
+    const ctx = canvas.getContext('2d');
+
+    if (!ctx) {
+      return imageData;
+    }
+
+    // 设置canvas尺寸
+    canvas.width = imageData.width;
+    canvas.height = imageData.height;
+
+    // 绘制原始图像
+    ctx.putImageData(imageData, 0, 0);
+
+    // 增强对比度
+    if (this.options.imageProcess?.enhanceContrast) {
+      ctx.filter = 'contrast(150%)';
+      ctx.drawImage(canvas, 0, 0);
+      ctx.filter = 'none';
+    }
+
+    // 应用二值化
+    const threshold = this.options.imageProcess?.threshold || 128;
+    const processedData = ctx.getImageData(0, 0, canvas.width, canvas.height);
+    const data = processedData.data;
+
+    for (let i = 0; i < data.length; i += 4) {
+      // 计算灰度值
+      const gray = 0.299 * data[i] + 0.587 * data[i + 1] + 0.114 * data[i + 2];
+      // 二值化
+      const value = gray < threshold ? 0 : 255;
+      data[i] = data[i + 1] = data[i + 2] = value;
+    }
+
+    return processedData;
+  }
+
+  /**
+   * 释放资源
+   */
+  public async dispose(): Promise<void> {
+    if (!this.initialized) {
+      return;
+    }
+
+    this.logger.debug('QRCodeScanner', '释放二维码扫描器资源');
+    
+    // 移除所有事件监听器
+    this.removeAllListeners();
+    
+    this.initialized = false;
+    this.logger.debug('QRCodeScanner', '二维码扫描器资源已释放');
+  }
+} 

package/src/modules/qrcode/types.ts

@@ -0,0 +1,65 @@
+/**
+ * @file 二维码模块类型定义
+ * @description 二维码模块相关的类型和接口定义
+ * @module modules/qrcode/types
+ */
+
+/**
+ * 二维码检测结果
+ */
+export interface QRCodeResult {
+  /** 二维码内容 */
+  data: string;
+  
+  /** 二维码类型 */
+  type?: string;
+  
+  /** 二维码边界框 */
+  boundingBox: {
+    topLeft: { x: number; y: number };
+    topRight: { x: number; y: number };
+    bottomRight: { x: number; y: number };
+    bottomLeft: { x: number; y: number };
+  };
+  
+  /** 二维码中心点 */
+  center: { x: number; y: number };
+  
+  /** 原始图像 */
+  image?: ImageData;
+  
+  /** 置信度 */
+  confidence?: number;
+}
+
+/**
+ * 二维码模块选项
+ */
+export interface QRCodeModuleOptions {
+  /** 是否启用模块 */
+  enabled?: boolean;
+  
+  /** 二维码扫描配置 */
+  scanner?: {
+    /** 最小置信度 */
+    minConfidence?: number;
+    
+    /** 是否尝试多次扫描 */
+    tryMultipleScan?: boolean;
+    
+    /** 是否返回原始图像 */
+    returnImage?: boolean;
+  };
+  
+  /** 图像处理配置 */
+  imageProcess?: {
+    /** 是否进行预处理 */
+    preprocess?: boolean;
+    
+    /** 是否增强对比度 */
+    enhanceContrast?: boolean;
+    
+    /** 二值化阈值 */
+    threshold?: number;
+  };
+} 

package/src/types/browser-image-compression.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Type definitions for browser-image-compression
+ */
+
+declare module 'browser-image-compression' {
+  export interface Options {
+    maxSizeMB?: number;
+    maxWidthOrHeight?: number;
+    useWebWorker?: boolean;
+    maxIteration?: number;
+    quality?: number;
+    fileType?: string;
+    onProgress?: (progress: number) => void;
+  }
+
+  function imageCompression(file: File, options?: Options): Promise<File>;
+  
+  export default imageCompression;
+}

package/src/types/tesseract.d.ts

@@ -0,0 +1,280 @@
+/**
+ * Type definitions for tesseract.js
+ */
+
+declare module "tesseract.js" {
+  // Based on https://github.com/naptha/tesseract.js/blob/master/src/index.d.ts
+  // and https://github.com/naptha/tesseract.js/blob/master/docs/api.md
+
+  export interface Point {
+    x: number
+    y: number
+  }
+
+  export interface Bbox {
+    x0: number
+    y0: number
+    x1: number
+    y1: number
+  }
+
+  export interface Baseline {
+    x0: number
+    y0: number
+    x1: number
+    y1: number
+    has_descenders: boolean
+    has_ascenders: boolean
+  }
+
+  export interface Word {
+    symbols: Symbol[]
+    choices: Choice[]
+    text: string
+    confidence: number
+    baseline: Baseline
+    bbox: Bbox
+    is_numeric: boolean
+    in_dictionary: boolean
+    direction: string
+    language: string
+    is_from_dictionary: boolean
+    is_fuzzy: boolean
+    is_certain: boolean
+    is_bold: boolean
+    is_italic: boolean
+    is_underlined: boolean
+    is_monospace: boolean
+    is_serif: boolean
+    is_smallcaps: boolean
+    font_id: number
+    font_size: number
+    font_name: string
+  }
+
+  export interface Symbol {
+    choices: Choice[]
+    image: null | HTMLImageElement // Or string if it's a path/URL
+    text: string
+    confidence: number
+    baseline: Baseline
+    bbox: Bbox
+    is_superscript: boolean
+    is_subscript: boolean
+    is_dropcap: boolean
+  }
+
+  export interface Choice {
+    text: string
+    confidence: number
+  }
+
+  export interface Line {
+    words: Word[]
+    text: string
+    confidence: number
+    baseline: Baseline
+    bbox: Bbox
+  }
+
+  export interface Paragraph {
+    lines: Line[]
+    text: string
+    confidence: number
+    baseline: Baseline
+    bbox: Bbox
+    is_ltr: boolean
+  }
+
+  export interface Block {
+    paragraphs: Paragraph[]
+    lines: Line[]
+    words: Word[]
+    text: string
+    confidence: number
+    baseline: Baseline
+    bbox: Bbox
+    blocktype: string
+    polygon: Point[]
+  }
+
+  export interface Page {
+    blocks: Block[]
+    confidence: number
+    html: string // HTML representation of the page
+    jobId?: string
+    text: string
+    lines: Line[]
+    oem: string
+    operator: string
+    paragraphs: Paragraph[]
+    psm: string
+    symbols: Symbol[]
+    version: string
+    words: Word[]
+    hocr?: string // hOCR output
+    tsv?: string // TSV output
+  }
+
+  export interface LoggerMessage {
+    jobId?: string
+    workerId?: string
+    status: string
+    progress: number
+    userfriendlyText?: string
+  }
+
+  export interface WorkerOptions {
+    langPath?: string
+    corePath?: string
+    workerPath?: string
+    logger?: (message: LoggerMessage) => void // More specific type for logger message <mcreference index="1" link="https://github.com/naptha/tesseract.js/blob/master/docs/api.md"></mcreference>
+    errorHandler?: (error: Error) => void
+    // Add other options based on documentation if needed
+    [key: string]: any // For other less common or dynamic options
+  }
+
+  export interface RecognizeResult {
+    data: Page // Use the detailed Page interface
+  }
+
+  export interface DetectResult {
+    data: {
+      tesseract_script_id: number | null
+      script: string | null
+      script_confidence: number | null
+      orientation_degrees: number | null
+      orientation_confidence: number | null
+    }
+    jobId?: string
+  }
+
+  export interface ConfigResult {
+    data: null
+    jobId?: string
+  }
+
+  export type ImageLike =
+    | HTMLImageElement
+    | HTMLCanvasElement
+    | File
+    | string
+    | Buffer
+    | ImageData // Common image types
+
+  export interface Worker {
+    load(jobId?: string): Promise<ConfigResult> // <mcreference index="4" link="https://github.com/naptha/tesseract.js/blob/master/src/index.d.ts"></mcreference>
+    loadLanguage(
+      langs?: string | string[],
+      jobId?: string
+    ): Promise<ConfigResult> // <mcreference index="4" link="https://github.com/naptha/tesseract.js/blob/master/src/index.d.ts"></mcreference>
+    initialize(
+      langs?: string | string[],
+      oem?: OEM,
+      config?: string | Partial<InitOptions>,
+      jobId?: string
+    ): Promise<ConfigResult> // <mcreference index="4" link="https://github.com/naptha/tesseract.js/blob/master/src/index.d.ts"></mcreference>
+    setParameters(
+      params: Partial<Parameters>,
+      jobId?: string
+    ): Promise<ConfigResult> // <mcreference index="4" link="https://github.com/naptha/tesseract.js/blob/master/src/index.d.ts"></mcreference>
+    recognize(
+      image: ImageLike,
+      options?: Partial<RecognizeOptions>,
+      output?: Partial<OutputFormats>,
+      jobId?: string
+    ): Promise<RecognizeResult> // <mcreference index="4" link="https://github.com/naptha/tesseract.js/blob/master/src/index.d.ts"></mcreference>
+    detect(
+      image: ImageLike,
+      options?: Partial<WorkerOptions>,
+      jobId?: string
+    ): Promise<DetectResult> // <mcreference index="4" link="https://github.com/naptha/tesseract.js/blob/master/src/index.d.ts"></mcreference>
+    terminate(jobId?: string): Promise<ConfigResult> // <mcreference index="4" link="https://github.com/naptha/tesseract.js/blob/master/src/index.d.ts"></mcreference>
+    // Add other worker methods if present in the version you are targeting
+    // Example from docs for other methods like FS operations:
+    writeText?(
+      path: string,
+      text: string,
+      jobId?: string
+    ): Promise<ConfigResult>
+    readText?(path: string, jobId?: string): Promise<ConfigResult>
+    removeFile?(path: string, jobId?: string): Promise<ConfigResult> // Assuming removeFile also returns ConfigResult or similar
+    FS?(method: string, args: any[], jobId?: string): Promise<any> // FS is more generic
+  }
+
+  // Based on Tesseract's OEM and PSM enums
+  export enum OEM {
+    TESSERACT_ONLY = 0,
+    LSTM_ONLY = 1,
+    TESSERACT_LSTM_COMBINED = 2,
+    DEFAULT = 3,
+  }
+
+  export enum PSM {
+    OSD_ONLY = 0,
+    AUTO_OSD = 1,
+    AUTO_ONLY = 2,
+    AUTO = 3,
+    SINGLE_COLUMN = 4,
+    SINGLE_BLOCK_VERT_TEXT = 5,
+    SINGLE_BLOCK = 6,
+    SINGLE_LINE = 7,
+    SINGLE_WORD = 8,
+    CIRCLE_WORD = 9,
+    SINGLE_CHAR = 10,
+    SPARSE_TEXT = 11,
+    SPARSE_TEXT_OSD = 12,
+    RAW_LINE = 13,
+  }
+
+  export interface Parameters {
+    tessedit_char_whitelist?: string
+    tessedit_pageseg_mode?: PSM
+    // Add other Tesseract parameters as needed
+    [key: string]: any // For flexibility with other parameters
+  }
+
+  export interface RecognizeOptions {
+    rectangle?: Bbox // For recognizing a specific region
+    rectangles?: Bbox[] // For recognizing multiple regions
+    // Add other recognize specific options
+    [key: string]: any
+  }
+
+  export interface OutputFormats {
+    text?: boolean
+    blocks?: boolean
+    hocr?: boolean
+    tsv?: boolean
+    pdf?: boolean // If PDF output is supported
+    // Add other output formats
+    [key: string]: any
+  }
+
+  export interface InitOptions {
+    load_system_dawg?: boolean
+    load_freq_dawg?: boolean
+    load_punc_dawg?: boolean
+    load_number_dawg?: boolean
+    load_unambig_dawg?: boolean
+    load_bigram_dawg?: boolean
+    load_fixed_length_dawgs?: boolean
+    // Add other init-only parameters
+    [key: string]: any
+  }
+
+  export function createWorker(options?: Partial<WorkerOptions>): Worker // 修正返回类型为 Worker 而非 Promise<Worker>
+  export function setLogging(logging: boolean): void
+  export function recognize(
+    image: ImageLike,
+    langs?: string | string[],
+    options?: Partial<RecognizeOptions & WorkerOptions>
+  ): Promise<RecognizeResult>
+  export function detect(
+    image: ImageLike,
+    options?: Partial<WorkerOptions>
+  ): Promise<DetectResult>
+
+  // 正确导出 OEM 和 PSM 枚举
+  export { OEM, PSM }
+}