id-scanner-lib 1.0.0 → 1.2.0

package/dist/types/id-recognition/ocr-processor.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @file OCR处理模块
+ * @description 提供身份证文字识别和信息提取功能
+ * @module OCRProcessor
+ */
+import { IDCardInfo } from '../utils/types';
+/**
+ * OCR处理器类
+ *
+ * 使用Tesseract.js实现对身份证图像的OCR文字识别和信息提取功能
+ *
+ * @example
+ * ```typescript
+ * // 创建OCR处理器
+ * const ocrProcessor = new OCRProcessor();
+ *
+ * // 初始化OCR引擎
+ * await ocrProcessor.initialize();
+ *
+ * // 处理身份证图像
+ * const idInfo = await ocrProcessor.processIDCard(idCardImageData);
+ * console.log('识别到的身份证信息:', idInfo);
+ *
+ * // 使用结束后释放资源
+ * await ocrProcessor.terminate();
+ * ```
+ */
+export declare class OCRProcessor {
+    private worker;
+    constructor();
+    /**
+     * 初始化OCR引擎
+     *
+     * 加载Tesseract OCR引擎和中文简体语言包，并设置适合身份证识别的参数
+     *
+     * @returns {Promise<void>} 初始化完成的Promise
+     */
+    initialize(): Promise<void>;
+    /**
+     * 处理身份证图像并提取信息
+     *
+     * 对身份证图像进行OCR识别，并从识别结果中提取结构化信息
+     *
+     * @param {ImageData} imageData - 身份证图像数据
+     * @returns {Promise<IDCardInfo>} 提取到的身份证信息
+     */
+    processIDCard(imageData: ImageData): Promise<IDCardInfo>;
+    /**
+     * 解析身份证文本信息
+     *
+     * 从OCR识别到的文本中提取结构化的身份证信息
+     *
+     * @private
+     * @param {string} text - OCR识别到的文本
+     * @returns {IDCardInfo} 提取到的身份证信息对象
+     */
+    private parseIDCardText;
+    /**
+     * 终止OCR引擎并释放资源
+     *
+     * @returns {Promise<void>} 终止完成的Promise
+     */
+    terminate(): Promise<void>;
+}

package/dist/types/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/types/index.d.ts

@@ -0,0 +1,78 @@
+/**
+ * @file ID扫描识别库主入口文件
+ * @description 提供身份证识别与二维码、条形码扫描功能的纯前端TypeScript库
+ * @module IDScannerLib
+ * @version 1.0.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';
+/**
+ * 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 主类
+ *
+ * 整合二维码、条形码扫描和身份证识别功能，提供统一的接口
+ * 使用动态导入实现按需加载
+ */
+export declare class IDScanner {
+    private options;
+    private camera;
+    private scanMode;
+    private videoElement;
+    private qrModule;
+    private ocrModule;
+    private isQRModuleLoaded;
+    private isOCRModuleLoaded;
+    /**
+     * 构造函数
+     * @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 handleError;
+    /**
+     * 释放资源
+     */
+    terminate(): Promise<void>;
+}
+export { IDCardInfo } from './utils/types';
+export { CameraOptions } from './utils/camera';

package/dist/types/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/types/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/scanner/barcode-scanner.d.ts

@@ -0,0 +1,90 @@
+/**
+ * @file 条形码扫描模块
+ * @description 提供实时条形码扫描和识别功能
+ * @module BarcodeScanner
+ */
+/**
+ * 条形码扫描器配置选项
+ *
+ * @interface BarcodeScannerOptions
+ * @property {number} [scanInterval] - 扫描间隔时间(毫秒)，默认为200ms
+ * @property {Function} [onScan] - 扫描成功回调函数
+ * @property {Function} [onError] - 错误处理回调函数
+ */
+export interface BarcodeScannerOptions {
+    scanInterval?: number;
+    onScan?: (result: string) => void;
+    onError?: (error: Error) => void;
+}
+/**
+ * 条形码扫描器类
+ *
+ * 提供实时扫描和识别摄像头中的条形码的功能
+ * 注意：当前实现是简化版，实际项目中建议集成专门的条形码识别库如ZXing或Quagga.js
+ *
+ * @example
+ * ```typescript
+ * // 创建条形码扫描器
+ * const barcodeScanner = new BarcodeScanner({
+ *   scanInterval: 100, // 每100ms扫描一次
+ *   onScan: (result) => {
+ *     console.log('扫描到条形码:', result);
+ *   },
+ *   onError: (error) => {
+ *     console.error('扫描错误:', error);
+ *   }
+ * });
+ *
+ * // 启动扫描
+ * const videoElement = document.getElementById('video') as HTMLVideoElement;
+ * await barcodeScanner.start(videoElement);
+ *
+ * // 停止扫描
+ * barcodeScanner.stop();
+ * ```
+ */
+export declare class BarcodeScanner {
+    private options;
+    private camera;
+    private scanning;
+    private scanTimer;
+    /**
+     * 创建条形码扫描器实例
+     *
+     * @param {BarcodeScannerOptions} [options] - 扫描器配置选项
+     */
+    constructor(options?: BarcodeScannerOptions);
+    /**
+     * 启动条形码扫描
+     *
+     * 初始化相机并开始连续扫描视频帧中的条形码
+     *
+     * @param {HTMLVideoElement} videoElement - 用于显示相机画面的video元素
+     * @returns {Promise<void>} 启动完成的Promise
+     * @throws 如果无法访问相机，将通过onError回调报告错误
+     */
+    start(videoElement: HTMLVideoElement): Promise<void>;
+    /**
+     * 执行一次条形码扫描
+     *
+     * 内部方法，捕获当前视频帧并尝试识别其中的条形码
+     *
+     * @private
+     */
+    private scan;
+    /**
+     * 条形码检测方法
+     *
+     * 注意：这是一个简化实现，实际需要集成专门的条形码识别库
+     *
+     * @private
+     * @param {ImageData} imageData - 要检测条形码的图像数据
+     */
+    private detectBarcode;
+    /**
+     * 停止条形码扫描
+     *
+     * 停止扫描循环并释放相机资源
+     */
+    stop(): void;
+}

package/dist/types/scanner/qr-scanner.d.ts

@@ -0,0 +1,80 @@
+/**
+ * @file 二维码扫描模块
+ * @description 提供实时二维码扫描和识别功能
+ * @module QRScanner
+ */
+/**
+ * 二维码扫描器配置选项
+ *
+ * @interface QRScannerOptions
+ * @property {number} [scanInterval] - 扫描间隔时间(毫秒)，默认为200ms
+ * @property {Function} [onScan] - 扫描成功回调函数
+ * @property {Function} [onError] - 错误处理回调函数
+ */
+export interface QRScannerOptions {
+    scanInterval?: number;
+    onScan?: (result: string) => void;
+    onError?: (error: Error) => void;
+}
+/**
+ * 二维码扫描器类
+ *
+ * 提供实时扫描和识别摄像头中的二维码的功能
+ *
+ * @example
+ * ```typescript
+ * // 创建二维码扫描器
+ * const qrScanner = new QRScanner({
+ *   scanInterval: 100, // 每100ms扫描一次
+ *   onScan: (result) => {
+ *     console.log('扫描到二维码:', result);
+ *   },
+ *   onError: (error) => {
+ *     console.error('扫描错误:', error);
+ *   }
+ * });
+ *
+ * // 启动扫描
+ * const videoElement = document.getElementById('video') as HTMLVideoElement;
+ * await qrScanner.start(videoElement);
+ *
+ * // 停止扫描
+ * qrScanner.stop();
+ * ```
+ */
+export declare class QRScanner {
+    private options;
+    private camera;
+    private scanning;
+    private scanTimer;
+    /**
+     * 创建二维码扫描器实例
+     *
+     * @param {QRScannerOptions} [options] - 扫描器配置选项
+     */
+    constructor(options?: QRScannerOptions);
+    /**
+     * 启动二维码扫描
+     *
+     * 初始化相机并开始连续扫描视频帧中的二维码
+     *
+     * @param {HTMLVideoElement} videoElement - 用于显示相机画面的video元素
+     * @returns {Promise<void>} 启动完成的Promise
+     * @throws 如果无法访问相机，将通过onError回调报告错误
+     */
+    start(videoElement: HTMLVideoElement): Promise<void>;
+    /**
+     * 执行一次二维码扫描
+     *
+     * 内部方法，捕获当前视频帧并尝试识别其中的二维码
+     *
+     * @private
+     */
+    private scan;
+    /**
+     * 停止二维码扫描
+     *
+     * 停止扫描循环并释放相机资源
+     */
+    stop(): void;
+}

package/dist/types/utils/camera.d.ts

@@ -0,0 +1,81 @@
+/**
+ * @file 相机工具类
+ * @description 提供访问和控制设备摄像头的功能
+ * @module Camera
+ */
+/**
+ * 相机配置选项接口
+ *
+ * @interface CameraOptions
+ * @property {number} [width] - 视频宽度，默认为640
+ * @property {number} [height] - 视频高度，默认为480
+ * @property {string} [facingMode] - 摄像头朝向，'user'为前置摄像头，'environment'为后置摄像头，默认为'environment'
+ */
+export interface CameraOptions {
+    width?: number;
+    height?: number;
+    facingMode?: 'user' | 'environment';
+}
+/**
+ * 相机工具类
+ *
+ * 提供访问设备摄像头、获取视频流以及捕获图像帧的功能
+ *
+ * @example
+ * ```typescript
+ * // 创建相机实例
+ * const camera = new Camera({
+ *   width: 1280,
+ *   height: 720,
+ *   facingMode: 'environment' // 使用后置摄像头
+ * });
+ *
+ * // 初始化相机
+ * const videoElement = document.getElementById('video') as HTMLVideoElement;
+ * await camera.start(videoElement);
+ *
+ * // 捕获当前视频帧
+ * const imageData = camera.captureFrame();
+ *
+ * // 使用结束后释放资源
+ * camera.stop();
+ * ```
+ */
+export declare class Camera {
+    private options;
+    private stream;
+    private videoElement;
+    /**
+     * 创建相机实例
+     * @param {CameraOptions} [options] - 相机配置选项
+     */
+    constructor(options?: CameraOptions);
+    /**
+     * 启动摄像头并将视频流绑定到视频元素
+     * @param videoElement HTML视频元素
+     * @returns Promise<void>
+     */
+    start(videoElement: HTMLVideoElement): Promise<void>;
+    /**
+     * 停止摄像头并释放资源
+     */
+    stop(): void;
+    /**
+     * 初始化相机，获取视频流并绑定到视频元素
+     *
+     * @param {HTMLVideoElement} videoElement - 用于显示视频流的视频元素
+     * @returns {Promise<void>} 初始化完成的Promise
+     * @throws 如果无法访问摄像头，将抛出错误
+     */
+    initialize(videoElement: HTMLVideoElement): Promise<void>;
+    /**
+     * 捕获当前视频帧
+     *
+     * @returns {ImageData|null} 视频帧的ImageData对象，如果未初始化则返回null
+     */
+    captureFrame(): ImageData | null;
+    /**
+     * 释放摄像头资源
+     */
+    release(): void;
+}

package/dist/types/utils/image-processing.d.ts

@@ -0,0 +1,75 @@
+/**
+ * @file 图像处理工具类
+ * @description 提供图像处理相关的辅助功能
+ * @module ImageProcessor
+ */
+/**
+ * 图像处理工具类
+ *
+ * 提供常用的图像处理功能，如亮度和对比度调整、灰度转换、图像大小调整等。
+ * 这些功能可用于增强图像质量，提高OCR和扫描的识别率。
+ *
+ * @example
+ * ```typescript
+ * // 使用图像处理功能增强图像
+ * const enhancedImage = ImageProcessor.adjustBrightnessContrast(
+ *   originalImageData,
+ *   15,  // 增加亮度
+ *   25   // 增加对比度
+ * );
+ *
+ * // 转换为灰度图像
+ * const grayImage = ImageProcessor.toGrayscale(originalImageData);
+ * ```
+ */
+export declare class ImageProcessor {
+    /**
+     * 将ImageData转换为Canvas元素
+     *
+     * @param {ImageData} imageData - 要转换的图像数据
+     * @returns {HTMLCanvasElement} 包含图像的Canvas元素
+     */
+    static imageDataToCanvas(imageData: ImageData): HTMLCanvasElement;
+    /**
+     * 将Canvas转换为ImageData
+     *
+     * @param {HTMLCanvasElement} canvas - 要转换的Canvas元素
+     * @returns {ImageData|null} Canvas的图像数据，如果获取失败则返回null
+     */
+    static canvasToImageData(canvas: HTMLCanvasElement): ImageData | null;
+    /**
+     * 调整图像亮度和对比度
+     *
+     * @param {ImageData} imageData - 要处理的图像数据
+     * @param {number} [brightness=0] - 亮度调整值，正值增加亮度，负值降低亮度，范围建议为-100到100
+     * @param {number} [contrast=0] - 对比度调整值，正值增加对比度，负值降低对比度，范围建议为-100到100
+     * @returns {ImageData} 处理后的图像数据
+     */
+    static adjustBrightnessContrast(imageData: ImageData, brightness?: number, contrast?: number): ImageData;
+    /**
+     * 确保值在0-255范围内
+     *
+     * @private
+     * @param {number} value - 要截断的值
+     * @returns {number} 截断后的值，范围为0-255
+     */
+    private static truncate;
+    /**
+     * 将彩色图像转换为灰度图像
+     *
+     * 灰度转换可以简化图像，提高OCR和条形码识别的准确率
+     *
+     * @param {ImageData} imageData - 要转换的彩色图像
+     * @returns {ImageData} 转换后的灰度图像
+     */
+    static toGrayscale(imageData: ImageData): ImageData;
+    /**
+     * 调整图像大小
+     *
+     * @param {ImageData} imageData - 原图像数据
+     * @param {number} newWidth - 新宽度
+     * @param {number} newHeight - 新高度
+     * @returns {ImageData} 调整大小后的图像数据
+     */
+    static resize(imageData: ImageData, newWidth: number, newHeight: number): ImageData;
+}