id-scanner-lib 1.5.0 → 1.6.2

package/dist/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/dist/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 }
+}

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "id-scanner-lib",
-  "version": "1.5.0",
-  "type": "module",
+  "version": "1.6.2",
   "description": "Browser-based ID card, QR code, and face recognition scanner with liveness detection",
   "main": "dist/id-scanner-lib.js",
   "module": "dist/id-scanner-lib.esm.js",
@@ -20,7 +19,7 @@
   },
   "scripts": {
     "build": "rimraf dist && rollup -c rollup.config.js",
-    "dev": "rollup -c -w rollup.config.js",
+    "dev": "vite build --watch",
     "test": "jest",
     "lint": "eslint --ext .ts,.js src",
     "format": "prettier --write \"src/**/*.{ts,js}\"",
@@ -49,9 +48,9 @@
   "author": "Your Name",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/agions/id-scanner-lib/issues"
+    "url": "https://github.com/yourusername/id-scanner-lib/issues"
   },
-  "homepage": "https://github.com/agions/id-scanner-lib#readme",
+  "homepage": "https://github.com/yourusername/id-scanner-lib#readme",
   "dependencies": {
     "@tensorflow/tfjs": "^4.16.0",
     "@vladmandic/face-api": "^1.7.13",
@@ -61,20 +60,25 @@
     "@babel/core": "^7.23.7",
     "@babel/preset-env": "^7.23.7",
     "@babel/preset-typescript": "^7.23.7",
+    "@eslint/js": "^10.0.1",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-json": "^6.0.1",
     "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-terser": "^1.0.0",
     "@rollup/plugin-typescript": "^11.1.5",
+    "@testing-library/jest-dom": "^6.9.1",
     "@types/jest": "^29.5.11",
-    "@typescript-eslint/eslint-plugin": "^6.19.1",
-    "@typescript-eslint/parser": "^6.19.1",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.56.1",
+    "@typescript-eslint/parser": "^8.56.1",
     "dts-bundle-generator": "^9.2.4",
-    "eslint": "^8.56.0",
+    "eslint": "^9.39.4",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
+    "globals": "^17.4.0",
     "jest": "^29.7.0",
+    "jest-environment-jsdom": "^30.2.0",
     "prettier": "^3.2.4",
     "rimraf": "^5.0.5",
     "rollup": "^4.9.6",
@@ -87,10 +91,16 @@
     "ts-jest": "^29.1.1",
     "tslib": "^2.6.2",
     "typedoc": "^0.25.7",
-    "typescript": "^5.3.3",
-    "vitepress": "^1.0.0-rc.25"
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.57.1",
+    "vite-plugin-dts": "^4.5.4",
+    "vitepress": "^1.6.4"
   },
   "engines": {
     "node": ">=14.0.0"
+  },
+  "overrides": {
+    "esbuild": "^0.27.0",
+    "vite": "^6.0.0"
   }
 }

package/src/core/camera-manager.ts

@@ -671,13 +671,28 @@ export class CameraManager extends EventEmitter {
   dispose(): void {
     this.stop();
     
+    // 停止并释放媒体流
+    this.stopMediaStream();
+    
     if (this.canvas) {
+      // 清空 canvas 内容
+      const ctx = this.canvas.getContext('2d');
+      if (ctx) ctx.clearRect(0, 0, this.canvas.width, this.canvas.height);
+      this.canvas.width = 0;
+      this.canvas.height = 0;
       this.canvas = null;
       this.canvasCtx = null;
     }
     
-    this.videoElement = null;
+    // 释放 video 元素
+    if (this.videoElement) {
+      this.videoElement.srcObject = null;
+      this.videoElement.load();
+      this.videoElement = null;
+    }
+    
     this.status = CameraStatus.NOT_INITIALIZED;
+    this.logger.debug('CameraManager', 'Camera resources disposed');
   }
   
   /**

package/src/core/config.ts

@@ -254,6 +254,43 @@ export class ConfigManager {
       }
     }
   }
+
+  /**
+   * 检查模块是否启用
+   * @param moduleName 模块名称
+   */
+  public isModuleEnabled(moduleName: string): boolean {
+    const key = `modules.${moduleName}.enabled`;
+    return this.get(key) ?? false;
+  }
+}
+
+/**
+ * 全局配置接口
+ */
+export interface GlobalConfig {
+  /** 版本号 */
+  version: string;
+  /** 调试模式 */
+  debug: boolean;
+  /** 日志级别 */
+  logLevel: string;
+  /** 摄像头配置 */
+  camera: {
+    resolution: { width: number; height: number };
+    frameRate: number;
+    facingMode: string;
+  };
+  /** 性能配置 */
+  performance: {
+    useCache: boolean;
+  };
+  /** 模块配置 */
+  modules: {
+    face: { enabled: boolean };
+    idcard: { enabled: boolean };
+    qrcode: { enabled: boolean };
+  };
 } 
 
 /**

package/src/core/errors.ts

@@ -31,9 +31,9 @@ export class IDScannerError extends Error {
     // 设置错误原因
     this.cause = options?.cause;
     
-    // 捕获堆栈
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, this.constructor);
+    // 捕获堆栈 (Node.js专有，浏览器环境忽略)
+    if (typeof (Error as any).captureStackTrace === 'function') {
+      (Error as any).captureStackTrace(this, this.constructor);
     }
   }
 }

package/src/core/event-emitter.test.ts

@@ -0,0 +1,42 @@
+/**
+ * @file EventEmitter 测试
+ * @description 测试事件发射器
+ */
+
+import { EventEmitter } from './event-emitter';
+
+describe('EventEmitter', () => {
+  let emitter: EventEmitter;
+
+  beforeEach(() => {
+    emitter = new EventEmitter();
+  });
+
+  afterEach(() => {
+    emitter.removeAllListeners();
+  });
+
+  it('should register and emit event', () => {
+    let called = false;
+    emitter.on('test', () => { called = true; });
+    emitter.emit('test');
+    expect(called).toBe(true);
+  });
+
+  it('should register one-time event', () => {
+    let count = 0;
+    emitter.once('test', () => { count++; });
+    emitter.emit('test');
+    emitter.emit('test');
+    expect(count).toBe(1);
+  });
+
+  it('should remove listener', () => {
+    let called = false;
+    const fn = () => { called = true; };
+    emitter.on('test', fn);
+    emitter.off('test', fn);
+    emitter.emit('test');
+    expect(called).toBe(false);
+  });
+});

package/src/core/loading-state.test.ts

@@ -0,0 +1,67 @@
+/**
+ * @file 加载状态管理测试
+ * @description 测试 LoadingStateManager
+ */
+
+import { LoadingStateManager, LoadingState } from './loading-state';
+
+describe('LoadingStateManager', () => {
+  let manager: LoadingStateManager;
+
+  beforeEach(() => {
+    manager = new LoadingStateManager();
+  });
+
+  afterEach(() => {
+    manager.dispose();
+  });
+
+  it('should start with idle state', () => {
+    expect(manager.getState()).toBe(LoadingState.IDLE);
+  });
+
+  it('should start loading', () => {
+    manager.startLoading(5);
+    
+    expect(manager.getState()).toBe(LoadingState.LOADING);
+    expect(manager.getProgress().progress).toBe(0);
+  });
+
+  it('should track model loading', () => {
+    manager.startLoading(5);
+    manager.startModelLoading('model1');
+    
+    expect(manager.getProgress().loadingModel).toBe('model1');
+    
+    manager.completeModelLoading('model1');
+    expect(manager.getProgress().loadedModels).toContain('model1');
+  });
+
+  it('should complete loading', () => {
+    manager.startLoading(2);
+    manager.completeModelLoading('model1');
+    manager.completeModelLoading('model2');
+    manager.complete();
+    
+    expect(manager.getState()).toBe(LoadingState.READY);
+    expect(manager.isReady()).toBe(true);
+  });
+
+  it('should handle failure', () => {
+    manager.startLoading(2);
+    manager.fail('Network error');
+    
+    expect(manager.getState()).toBe(LoadingState.ERROR);
+    expect(manager.getProgress().error).toBe('Network error');
+    expect(manager.hasError()).toBe(true);
+  });
+
+  it('should dispose correctly', () => {
+    manager.startLoading(2);
+    manager.complete();
+    manager.dispose();
+    
+    expect(manager.getState()).toBe(LoadingState.DISPOSED);
+    expect(manager.isReady()).toBe(false);
+  });
+});