id-scanner-lib 1.2.2 → 1.3.2

package/dist/core.d.ts

@@ -1,77 +0,0 @@
-/**
- * @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/demo/demo.d.ts

@@ -1,14 +0,0 @@
-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/id-recognition/data-extractor.d.ts

@@ -1,105 +0,0 @@
-/**
- * @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/id-recognition/id-detector.d.ts

@@ -1,100 +0,0 @@
-/**
- * @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;
-}

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

@@ -1,64 +0,0 @@
-/**
- * @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>;
-}