id-scanner-lib 1.3.3 → 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,95 +1,106 @@
 {
   "name": "id-scanner-lib",
-  "version": "1.3.3",
-  "type": "module",
-  "main": "dist/id-scanner.js",
-  "module": "dist/id-scanner-core.esm.js",
-  "exports": {
-    ".": {
-      "import": "./dist/id-scanner-core.esm.js",
-      "require": "./dist/id-scanner.js"
-    },
-    "./core": {
-      "import": "./dist/id-scanner-core.esm.js",
-      "require": "./dist/id-scanner-core.js"
-    },
-    "./ocr": {
-      "import": "./dist/id-scanner-ocr.esm.js",
-      "require": "./dist/id-scanner-ocr.js"
-    },
-    "./qr": {
-      "import": "./dist/id-scanner-qr.esm.js",
-      "require": "./dist/id-scanner-qr.js"
-    }
-  },
+  "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",
   "types": "dist/types/index.d.ts",
-  "sideEffects": false,
+  "files": [
+    "dist",
+    "src",
+    "LICENSE",
+    "README.md"
+  ],
+  "bin": {
+    "id-scanner-scaffold": "./tools/scaffold.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
-    "build": "rollup -c",
-    "dev": "rollup -c -w",
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "prepublishOnly": "npm run build",
-    "publish:npm": "node scripts/publish.js",
-    "update:github": "node scripts/update-github.js",
-    "analyze": "rollup -c --environment ANALYZE:true",
-    "build:prod": "rollup -c --environment NODE_ENV:production",
-    "size": "npm run build:prod && node scripts/size-report.js",
-    "serve:demo": "npx http-server examples -o"
+    "build": "rimraf dist && rollup -c rollup.config.js",
+    "dev": "vite build --watch",
+    "test": "jest",
+    "lint": "eslint --ext .ts,.js src",
+    "format": "prettier --write \"src/**/*.{ts,js}\"",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:serve": "vitepress serve docs",
+    "prepare": "npm run build",
+    "scaffold": "node ./tools/scaffold.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/agions/id-scanner-lib.git"
   },
   "keywords": [
+    "id-scanner",
     "id-card",
     "qr-code",
     "scanner",
-    "ocr",
-    "barcode",
-    "identity",
-    "recognition",
-    "image-processing"
+    "face-recognition",
+    "id-verification",
+    "face-detection",
+    "face-liveness",
+    "biometrics",
+    "webcam"
   ],
-  "author": "agions",
+  "author": "Your Name",
   "license": "MIT",
-  "description": "一款纯前端实现的TypeScript身份证&二维码识别库，无需后端支持，所有处理在浏览器端完成，新增图像批处理与优化",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/agions/id-scanner-lib.git"
-  },
   "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",
-  "files": [
-    "dist",
-    "src",
-    "README.md",
-    "LICENSE"
-  ],
-  "publishConfig": {
-    "access": "public"
+  "homepage": "https://github.com/yourusername/id-scanner-lib#readme",
+  "dependencies": {
+    "@tensorflow/tfjs": "^4.16.0",
+    "@vladmandic/face-api": "^1.7.13",
+    "jsqr": "^1.4.0"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^28.0.3",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^16.0.1",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^12.1.2",
-    "@types/node": "^22.13.10",
-    "picocolors": "^1.1.1",
-    "rollup": "^4.35.0",
-    "rollup-plugin-bundle-analyzer": "^1.6.6",
-    "rollup-plugin-visualizer": "^5.9.2",
-    "tslib": "^2.8.1",
-    "typescript": "^5.8.2"
+    "@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": "^1.0.0",
+    "@rollup/plugin-typescript": "^11.1.5",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@types/jest": "^29.5.11",
+    "@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": "^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",
+    "rollup-plugin-copy": "^3.5.0",
+    "rollup-plugin-dts": "^6.1.0",
+    "rollup-plugin-livereload": "^2.0.5",
+    "rollup-plugin-polyfill-node": "^0.13.0",
+    "rollup-plugin-serve": "^1.1.1",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "ts-jest": "^29.1.1",
+    "tslib": "^2.6.2",
+    "typedoc": "^0.25.7",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.57.1",
+    "vite-plugin-dts": "^4.5.4",
+    "vitepress": "^1.6.4"
   },
-  "dependencies": {
-    "browser-image-compression": "^2.0.2",
-    "jsqr": "^1.4.0",
-    "lodash-es": "^4.17.21",
-    "tesseract.js": "^6.0.0"
+  "engines": {
+    "node": ">=14.0.0"
   },
-  "browserslist": [
-    ">0.2%",
-    "not dead",
-    "not op_mini all",
-    "last 2 versions"
-  ]
-}
+  "overrides": {
+    "esbuild": "^0.27.0",
+    "vite": "^6.0.0"
+  }
+}

package/src/core/base-module.ts

@@ -0,0 +1,78 @@
+/**
+ * @file 基础模块
+ * @description 提供基础模块实现，作为所有功能模块的基类
+ * @module core/base-module
+ */
+
+import { EventEmitter } from './event-emitter';
+import { Logger } from './logger';
+import { Module } from './module-manager';
+import { VERSION } from '../version';
+
+/**
+ * 基础模块类
+ * 提供模块的基本功能和生命周期管理
+ */
+export abstract class BaseModule extends EventEmitter implements Module {
+  /** 模块名称 */
+  public abstract readonly name: string;
+  
+  /** 模块版本 */
+  public readonly version: string = VERSION;
+  
+  /** 模块是否已初始化 */
+  protected _isInitialized: boolean = false;
+  
+  /** 日志工具 */
+  protected logger: Logger;
+  
+  /**
+   * 构造函数
+   */
+  constructor() {
+    super();
+    this.logger = Logger.getInstance();
+  }
+  
+  /**
+   * 获取模块是否已初始化
+   */
+  public get isInitialized(): boolean {
+    return this._isInitialized;
+  }
+  
+  /**
+   * 初始化模块
+   * 子类必须实现此方法
+   */
+  public abstract initialize(): Promise<void>;
+  
+  /**
+   * 释放模块资源
+   * 子类可以覆盖此方法以添加额外的资源释放逻辑
+   */
+  public async dispose(): Promise<void> {
+    if (!this._isInitialized) {
+      return;
+    }
+    
+    this.logger.debug(this.name, '释放模块资源');
+    
+    // 重置初始化状态
+    this._isInitialized = false;
+    
+    // 删除所有事件监听器
+    this.removeAllListeners();
+    
+    this.logger.debug(this.name, '模块资源已释放');
+  }
+  
+  /**
+   * 检查模块是否已初始化，如果未初始化则抛出错误
+   */
+  protected ensureInitialized(): void {
+    if (!this._isInitialized) {
+      throw new Error(`模块 ${this.name} 尚未初始化`);
+    }
+  }
+}