id-scanner-lib 1.0.0 → 1.2.0

package/dist/index-umd.d.ts

@@ -0,0 +1,96 @@
+/**
+ * @file ID扫描识别库UMD格式入口文件
+ * @description 专门为UMD格式构建的入口，使用静态导入而非动态导入
+ * @module IDScannerLib
+ * @version 1.1.0
+ * @license MIT
+ */
+import { CameraOptions } from './utils/camera';
+import { IDCardInfo } from './utils/types';
+import type { QRScannerOptions } from './scanner/qr-scanner';
+import type { BarcodeScannerOptions } from './scanner/barcode-scanner';
+import { QRScanner } from './scanner/qr-scanner';
+import { BarcodeScanner } from './scanner/barcode-scanner';
+import { IDCardDetector } from './id-recognition/id-detector';
+import { OCRProcessor } from './id-recognition/ocr-processor';
+import { DataExtractor } from './id-recognition/data-extractor';
+import { ImageProcessor } from './utils/image-processing';
+/**
+ * IDScanner配置选项接口
+ */
+export interface IDScannerOptions {
+    cameraOptions?: CameraOptions;
+    qrScannerOptions?: QRScannerOptions;
+    barcodeScannerOptions?: BarcodeScannerOptions;
+    onQRCodeScanned?: (result: string) => void;
+    onBarcodeScanned?: (result: string) => void;
+    onIDCardScanned?: (info: IDCardInfo) => void;
+    onError?: (error: Error) => void;
+}
+/**
+ * IDScanner 主类
+ * UMD版本使用静态导入实现
+ */
+export declare class IDScanner {
+    private options;
+    private camera;
+    private qrScanner;
+    private barcodeScanner;
+    private idDetector;
+    private ocrProcessor;
+    private dataExtractor;
+    private scanMode;
+    private videoElement;
+    /**
+     * 构造函数
+     * @param options 配置选项
+     */
+    constructor(options?: IDScannerOptions);
+    /**
+     * 初始化模块
+     * 根据需要初始化OCR引擎
+     */
+    initialize(): Promise<void>;
+    /**
+     * 启动二维码扫描
+     * @param videoElement HTML视频元素
+     */
+    startQRScanner(videoElement: HTMLVideoElement): Promise<void>;
+    /**
+     * 启动条形码扫描
+     * @param videoElement HTML视频元素
+     */
+    startBarcodeScanner(videoElement: HTMLVideoElement): Promise<void>;
+    /**
+     * 启动身份证扫描
+     * @param videoElement HTML视频元素
+     */
+    startIDCardScanner(videoElement: HTMLVideoElement): Promise<void>;
+    /**
+     * 停止扫描
+     */
+    stop(): void;
+    /**
+     * 处理二维码扫描结果
+     */
+    private handleQRScan;
+    /**
+     * 处理条形码扫描结果
+     */
+    private handleBarcodeScan;
+    /**
+     * 处理身份证检测结果
+     */
+    private handleIDDetection;
+    /**
+     * 处理错误
+     */
+    private handleError;
+    /**
+     * 释放资源
+     */
+    terminate(): Promise<void>;
+}
+export { IDCardInfo } from './utils/types';
+export { CameraOptions } from './utils/camera';
+export { QRScanner, BarcodeScanner, IDCardDetector, OCRProcessor, DataExtractor, ImageProcessor };

package/dist/index.d.ts

@@ -5,24 +5,12 @@
  * @version 1.0.0
  * @license MIT
  */
-import { QRScanner, QRScannerOptions } from './scanner/qr-scanner';
-import { BarcodeScanner, BarcodeScannerOptions } from './scanner/barcode-scanner';
-import { IDCardDetector } from './id-recognition/id-detector';
-import { OCRProcessor } from './id-recognition/ocr-processor';
-import { DataExtractor } from './id-recognition/data-extractor';
-import { Camera, CameraOptions } from './utils/camera';
-import { ImageProcessor } from './utils/image-processing';
-import { IDCardInfo, DetectionResult } from './utils/types';
+import { CameraOptions } from './utils/camera';
+import { IDCardInfo } from './utils/types';
+import type { QRScannerOptions } from './scanner/qr-scanner';
+import type { BarcodeScannerOptions } from './scanner/barcode-scanner';
 /**
  * IDScanner配置选项接口
- * @interface IDScannerOptions
- * @property {CameraOptions} [cameraOptions] - 相机配置选项
- * @property {QRScannerOptions} [qrScannerOptions] - 二维码扫描配置选项
- * @property {BarcodeScannerOptions} [barcodeScannerOptions] - 条形码扫描配置选项
- * @property {Function} [onQRCodeScanned] - 二维码识别成功回调
- * @property {Function} [onBarcodeScanned] - 条形码识别成功回调
- * @property {Function} [onIDCardScanned] - 身份证识别成功回调
- * @property {Function} [onError] - 错误处理回调
  */
 export interface IDScannerOptions {
     cameraOptions?: CameraOptions;
@@ -37,107 +25,54 @@ export interface IDScannerOptions {
  * IDScanner 主类
  *
  * 整合二维码、条形码扫描和身份证识别功能，提供统一的接口
- *
- * @example
- * ```typescript
- * // 创建扫描器实例
- * const scanner = new IDScanner({
- *   onQRCodeScanned: (result) => {
- *     console.log('扫描到二维码:', result);
- *   },
- *   onIDCardScanned: (info) => {
- *     console.log('识别到身份证信息:', info);
- *   }
- * });
- *
- * // 初始化OCR引擎和相关资源
- * await scanner.initialize();
- *
- * // 启动二维码扫描
- * const videoElement = document.getElementById('video');
- * await scanner.startQRScanner(videoElement);
- *
- * // 停止扫描
- * scanner.stop();
- *
- * // 使用结束后释放资源
- * scanner.terminate();
- * ```
+ * 使用动态导入实现按需加载
  */
 export declare class IDScanner {
     private options;
-    private qrScanner;
-    private barcodeScanner;
-    private idDetector;
-    private ocrProcessor;
+    private camera;
     private scanMode;
+    private videoElement;
+    private qrModule;
+    private ocrModule;
+    private isQRModuleLoaded;
+    private isOCRModuleLoaded;
     /**
-     * 创建IDScanner实例
-     * @param {IDScannerOptions} [options] - 配置选项
+     * 构造函数
+     * @param options 配置选项
      */
     constructor(options?: IDScannerOptions);
     /**
-     * 初始化OCR引擎和相关资源
-     *
-     * @returns {Promise<void>} 初始化完成的Promise
-     * @throws 如果初始化失败，将抛出错误
+     * 初始化模块
+     * 根据需要初始化OCR引擎
      */
     initialize(): Promise<void>;
     /**
      * 启动二维码扫描
-     *
-     * @param {HTMLVideoElement} videoElement - 用于显示相机画面的video元素
-     * @returns {Promise<void>} 启动完成的Promise
+     * @param videoElement HTML视频元素
      */
     startQRScanner(videoElement: HTMLVideoElement): Promise<void>;
     /**
      * 启动条形码扫描
-     *
-     * @param {HTMLVideoElement} videoElement - 用于显示相机画面的video元素
-     * @returns {Promise<void>} 启动完成的Promise
+     * @param videoElement HTML视频元素
      */
     startBarcodeScanner(videoElement: HTMLVideoElement): Promise<void>;
     /**
-     * 启动身份证扫描识别
-     *
-     * @param {HTMLVideoElement} videoElement - 用于显示相机画面的video元素
-     * @returns {Promise<void>} 启动完成的Promise
+     * 启动身份证扫描
+     * @param videoElement HTML视频元素
      */
     startIDCardScanner(videoElement: HTMLVideoElement): Promise<void>;
     /**
-     * 停止当前扫描
+     * 停止扫描
      */
     stop(): void;
-    /**
-     * 处理二维码扫描结果
-     * @private
-     * @param {string} result - 扫描到的二维码内容
-     */
-    private handleQRScan;
-    /**
-     * 处理条形码扫描结果
-     * @private
-     * @param {string} result - 扫描到的条形码内容
-     */
-    private handleBarcodeScan;
-    /**
-     * 处理身份证检测结果
-     * @private
-     * @param {DetectionResult} result - 身份证检测结果
-     */
-    private handleIDDetection;
     /**
      * 处理错误
-     * @private
-     * @param {Error} error - 错误对象
      */
     private handleError;
     /**
-     * 终止所有扫描并释放资源
-     *
-     * @returns {Promise<void>} 资源释放完成的Promise
+     * 释放资源
      */
     terminate(): Promise<void>;
 }
-export { Camera, QRScanner, BarcodeScanner, IDCardDetector, OCRProcessor, DataExtractor, ImageProcessor };
-export type { CameraOptions, QRScannerOptions, BarcodeScannerOptions, IDCardInfo, DetectionResult };
+export { IDCardInfo } from './utils/types';
+export { CameraOptions } from './utils/camera';

package/dist/ocr-module.d.ts

@@ -0,0 +1,67 @@
+/**
+ * @file OCR模块入口文件
+ * @description 包含身份证OCR识别相关功能
+ * @module IDScannerOCR
+ * @version 1.0.0
+ * @license MIT
+ */
+import { IDCardInfo } from './utils/types';
+import { CameraOptions } from './utils/camera';
+/**
+ * OCR模块配置选项
+ */
+export interface OCRModuleOptions {
+    cameraOptions?: CameraOptions;
+    onIDCardScanned?: (info: IDCardInfo) => void;
+    onError?: (error: Error) => void;
+}
+/**
+ * OCR模块类
+ *
+ * 提供身份证检测和OCR文字识别功能
+ */
+export declare class OCRModule {
+    private options;
+    private idDetector;
+    private ocrProcessor;
+    private dataExtractor;
+    private camera;
+    private isRunning;
+    private videoElement;
+    /**
+     * 构造函数
+     * @param options 配置选项
+     */
+    constructor(options?: OCRModuleOptions);
+    /**
+     * 初始化OCR引擎
+     *
+     * @returns Promise<void>
+     */
+    initialize(): Promise<void>;
+    /**
+     * 启动身份证扫描
+     * @param videoElement HTML视频元素
+     */
+    startIDCardScanner(videoElement: HTMLVideoElement): Promise<void>;
+    /**
+     * 停止扫描
+     */
+    stop(): void;
+    /**
+     * 处理身份证检测结果
+     */
+    private handleIDDetection;
+    /**
+     * 处理错误
+     */
+    private handleError;
+    /**
+     * 释放资源
+     */
+    terminate(): Promise<void>;
+}
+export { IDCardDetector } from './id-recognition/id-detector';
+export { OCRProcessor } from './id-recognition/ocr-processor';
+export { DataExtractor } from './id-recognition/data-extractor';
+export { IDCardInfo } from './utils/types';

package/dist/qr-module.d.ts

@@ -0,0 +1,68 @@
+/**
+ * @file 二维码和条形码扫描模块
+ * @description 包含二维码和条形码扫描功能
+ * @module IDScannerQR
+ * @version 1.0.0
+ * @license MIT
+ */
+import { QRScannerOptions } from './scanner/qr-scanner';
+import { BarcodeScannerOptions } from './scanner/barcode-scanner';
+import { CameraOptions } from './utils/camera';
+/**
+ * 扫描模块配置选项
+ */
+export interface ScannerModuleOptions {
+    cameraOptions?: CameraOptions;
+    qrScannerOptions?: QRScannerOptions;
+    barcodeScannerOptions?: BarcodeScannerOptions;
+    onQRCodeScanned?: (result: string) => void;
+    onBarcodeScanned?: (result: string) => void;
+    onError?: (error: Error) => void;
+}
+/**
+ * 扫描模块类
+ *
+ * 提供独立的二维码和条形码扫描功能
+ */
+export declare class ScannerModule {
+    private options;
+    private qrScanner;
+    private barcodeScanner;
+    private camera;
+    private scanMode;
+    private videoElement;
+    /**
+     * 构造函数
+     * @param options 配置选项
+     */
+    constructor(options?: ScannerModuleOptions);
+    /**
+     * 启动二维码扫描
+     * @param videoElement HTML视频元素
+     */
+    startQRScanner(videoElement: HTMLVideoElement): Promise<void>;
+    /**
+     * 启动条形码扫描
+     * @param videoElement HTML视频元素
+     */
+    startBarcodeScanner(videoElement: HTMLVideoElement): Promise<void>;
+    /**
+     * 停止扫描
+     */
+    stop(): void;
+    /**
+     * 处理二维码扫描结果
+     */
+    private handleQRScan;
+    /**
+     * 处理条形码扫描结果
+     */
+    private handleBarcodeScan;
+    /**
+     * 处理错误
+     */
+    private handleError;
+}
+export { QRScanner, QRScannerOptions } from './scanner/qr-scanner';
+export { BarcodeScanner, BarcodeScannerOptions } from './scanner/barcode-scanner';
+export { Camera, CameraOptions } from './utils/camera';

package/dist/types/core.d.ts

@@ -0,0 +1,77 @@
+/**
+ * @file 轻量级扫描库核心
+ * @description 不包含OCR功能的轻量版，只提供二维码和条形码扫描功能
+ * @module IDScannerCore
+ * @version 1.0.0
+ * @license MIT
+ */
+import { QRScannerOptions } from './scanner/qr-scanner';
+import { BarcodeScannerOptions } from './scanner/barcode-scanner';
+import { CameraOptions } from './utils/camera';
+/**
+ * IDScannerCore配置选项
+ */
+export interface IDScannerCoreOptions {
+    cameraOptions?: CameraOptions;
+    qrScannerOptions?: QRScannerOptions;
+    barcodeScannerOptions?: BarcodeScannerOptions;
+    onQRCodeScanned?: (result: string) => void;
+    onBarcodeScanned?: (result: string) => void;
+    onError?: (error: Error) => void;
+}
+/**
+ * IDScannerCore 轻量级扫描类
+ *
+ * 提供二维码和条形码扫描功能，不包含OCR身份证识别功能
+ */
+export declare class IDScannerCore {
+    private options;
+    private qrScanner;
+    private barcodeScanner;
+    private camera;
+    private scanMode;
+    private videoElement;
+    /**
+     * 构造函数
+     * @param options 配置选项
+     */
+    constructor(options?: IDScannerCoreOptions);
+    /**
+     * 初始化扫描器
+     */
+    initialize(): Promise<void>;
+    /**
+     * 启动二维码扫描
+     * @param videoElement HTML视频元素
+     */
+    startQRScanner(videoElement: HTMLVideoElement): Promise<void>;
+    /**
+     * 启动条形码扫描
+     * @param videoElement HTML视频元素
+     */
+    startBarcodeScanner(videoElement: HTMLVideoElement): Promise<void>;
+    /**
+     * 停止扫描
+     */
+    stop(): void;
+    /**
+     * 处理二维码扫描结果
+     */
+    private handleQRScan;
+    /**
+     * 处理条形码扫描结果
+     */
+    private handleBarcodeScan;
+    /**
+     * 处理错误
+     */
+    private handleError;
+    /**
+     * 释放资源
+     */
+    terminate(): Promise<void>;
+}
+export { QRScanner, QRScannerOptions } from './scanner/qr-scanner';
+export { BarcodeScanner, BarcodeScannerOptions } from './scanner/barcode-scanner';
+export { Camera, CameraOptions } from './utils/camera';
+export { ImageProcessor } from './utils/image-processing';

package/dist/types/demo/demo.d.ts

@@ -0,0 +1,14 @@
+export declare class IDScannerDemo {
+    private scanner;
+    private videoElement;
+    private resultContainer;
+    private switchButton;
+    constructor(videoElementId: string, resultContainerId: string, switchButtonId: string);
+    initialize(): Promise<void>;
+    private currentMode;
+    private toggleScanMode;
+    private handleQRCodeResult;
+    private handleIDCardResult;
+    private handleError;
+    stop(): void;
+}

package/dist/types/id-recognition/data-extractor.d.ts

@@ -0,0 +1,105 @@
+/**
+ * @file 数据提取工具类
+ * @description 提供身份证信息的验证和格式化功能
+ * @module DataExtractor
+ */
+import { IDCardInfo } from '../utils/types';
+/**
+ * 数据提取工具类
+ *
+ * 提供身份证信息的验证、提取和增强功能，可以从身份证号码中提取出生日期、性别等信息，
+ * 并对OCR识别结果进行补充和验证
+ *
+ * @example
+ * ```typescript
+ * // 验证身份证号码
+ * const isValid = DataExtractor.validateIDNumber('110101199001011234');
+ *
+ * // 从身份证号码提取出生日期
+ * const birthDate = DataExtractor.extractBirthDateFromID('110101199001011234');
+ * // 结果: '1990-01-01'
+ *
+ * // 增强OCR识别结果
+ * const enhancedInfo = DataExtractor.enhanceIDCardInfo({
+ *   name: '张三',
+ *   idNumber: '110101199001011234'
+ * });
+ * // 结果会自动补充性别和出生日期
+ * ```
+ */
+export declare class DataExtractor {
+    /**
+     * 验证身份证号码格式
+     *
+     * 检查身份证号码的长度、格式和出生日期部分是否有效
+     *
+     * @param {string} idNumber - 要验证的身份证号码
+     * @returns {boolean} 是否是有效的身份证号码
+     */
+    static validateIDNumber(idNumber: string): boolean;
+    /**
+     * 从身份证号码提取出生日期
+     *
+     * @param {string} idNumber - 身份证号码
+     * @returns {string|null} 格式化的出生日期（YYYY-MM-DD），如果身份证号码无效则返回null
+     */
+    static extractBirthDateFromID(idNumber: string): string | null;
+    /**
+     * 从身份证号码提取性别
+     *
+     * 根据身份证号码第17位判断性别，奇数为男，偶数为女
+     *
+     * @param {string} idNumber - 身份证号码
+     * @returns {string|null} '男'或'女'，如果身份证号码无效则返回null
+     */
+    static extractGenderFromID(idNumber: string): string | null;
+    /**
+     * 从身份证号码提取地区编码
+     *
+     * @param {string} idNumber - 身份证号码
+     * @returns {string|null} 地区编码（前6位），如果身份证号码无效则返回null
+     */
+    static extractRegionFromID(idNumber: string): string | null;
+    /**
+     * 合并并优化身份证信息
+     *
+     * 使用多个来源的数据进行交叉验证和补充，如果OCR识别结果缺少某些信息，
+     * 但有身份证号码，则可以从号码中提取出生日期和性别等信息
+     *
+     * @param {IDCardInfo} ocrInfo - OCR识别到的身份证信息
+     * @param {string} [idNumber] - 可选的外部提供的身份证号码，优先级高于OCR识别结果
+     * @returns {IDCardInfo} 增强后的身份证信息
+     */
+    static enhanceIDCardInfo(ocrInfo: IDCardInfo, idNumber?: string): IDCardInfo;
+    /**
+     * 提取并验证身份证信息
+     *
+     * @param idCardInfo 初步提取的身份证信息
+     * @returns 验证和增强后的身份证信息
+     */
+    extractAndValidate(idCardInfo: IDCardInfo): IDCardInfo;
+    /**
+     * 规范化身份证号码
+     */
+    private normalizeIDNumber;
+    /**
+     * 验证身份证号码是否有效
+     */
+    private validateIDNumber;
+    /**
+     * 从身份证号中提取出生日期
+     */
+    private extractBirthDateFromID;
+    /**
+     * 从身份证号中提取性别信息
+     */
+    private extractGenderFromID;
+    /**
+     * 规范化日期格式
+     */
+    private normalizeDate;
+    /**
+     * 规范化地址信息
+     */
+    private normalizeAddress;
+}

package/dist/types/id-recognition/id-detector.d.ts

@@ -0,0 +1,100 @@
+/**
+ * @file 身份证检测模块
+ * @description 提供自动检测和定位图像中的身份证功能
+ * @module IDCardDetector
+ */
+/**
+ * DetectionResult接口
+ *
+ * 包含身份证检测结果信息
+ */
+export interface DetectionResult {
+    success: boolean;
+    imageData?: ImageData;
+    boundingBox?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    confidence?: number;
+    message?: string;
+}
+/**
+ * IDCardDetector配置选项
+ */
+export interface IDCardDetectorOptions {
+    onDetection?: (result: DetectionResult) => void;
+    onError?: (error: Error) => void;
+    detectionInterval?: number;
+}
+/**
+ * 身份证检测器类
+ *
+ * 通过图像处理和计算机视觉技术，实时检测视频流中的身份证，并提取身份证区域
+ * 注意：当前实现是简化版，实际项目中建议使用OpenCV.js进行更精确的检测
+ *
+ * @example
+ * ```typescript
+ * // 创建身份证检测器
+ * const detector = new IDCardDetector((result) => {
+ *   if (result.success && result.croppedImage) {
+ *     console.log('检测到身份证!');
+ *     // 对裁剪出的身份证图像进行处理
+ *     processIDCardImage(result.croppedImage);
+ *   }
+ * });
+ *
+ * // 启动检测
+ * const videoElement = document.getElementById('video') as HTMLVideoElement;
+ * await detector.start(videoElement);
+ *
+ * // 停止检测
+ * detector.stop();
+ * ```
+ */
+export declare class IDCardDetector {
+    private onDetected?;
+    private camera;
+    private detecting;
+    private detectTimer;
+    /**
+     * 创建身份证检测器实例
+     *
+     * @param {Function} [onDetected] - 身份证检测成功回调函数，接收检测结果对象
+     */
+    constructor(onDetected?: ((result: DetectionResult) => void) | undefined);
+    /**
+     * 启动身份证检测
+     *
+     * 初始化相机并开始连续检测视频帧中的身份证
+     *
+     * @param {HTMLVideoElement} videoElement - 用于显示相机画面的video元素
+     * @returns {Promise<void>} 启动完成的Promise
+     */
+    start(videoElement: HTMLVideoElement): Promise<void>;
+    /**
+     * 执行一次身份证检测
+     *
+     * 内部方法，捕获当前视频帧并尝试检测其中的身份证
+     *
+     * @private
+     */
+    private detect;
+    /**
+     * 身份证检测核心算法
+     *
+     * 通过图像处理技术检测和提取图像中的身份证区域
+     *
+     * @private
+     * @param {ImageData} imageData - 需要检测身份证的图像数据
+     * @returns {Promise<DetectionResult>} 检测结果，包含成功标志和裁剪后的身份证图像
+     */
+    private detectIDCard;
+    /**
+     * 停止身份证检测
+     *
+     * 停止检测循环并释放相机资源
+     */
+    stop(): void;
+}