id-scanner-lib 1.3.2 → 1.5.0

package/dist/types/modules/face/types.d.ts

@@ -0,0 +1,136 @@
+/**
+ * @file 人脸模块类型定义
+ * @description 人脸模块相关的类型和接口定义
+ * @module modules/face/types
+ */
+/**
+ * 人脸检测结果
+ */
+export interface FaceDetectionResult {
+    /** 人脸边界框 */
+    boundingBox: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    /** 人脸特征点 */
+    landmarks?: {
+        /** 左眼 */
+        leftEye: {
+            x: number;
+            y: number;
+        };
+        /** 右眼 */
+        rightEye: {
+            x: number;
+            y: number;
+        };
+        /** 鼻子 */
+        nose: {
+            x: number;
+            y: number;
+        };
+        /** 嘴巴 */
+        mouth: {
+            x: number;
+            y: number;
+        };
+        /** 下巴 */
+        chin: {
+            x: number;
+            y: number;
+        };
+    };
+    /** 人脸角度 */
+    angle?: {
+        /** 俯仰角 */
+        pitch: number;
+        /** 偏航角 */
+        yaw: number;
+        /** 翻滚角 */
+        roll: number;
+    };
+    /** 人脸属性 */
+    attributes?: {
+        /** 性别 */
+        gender?: {
+            /** 性别值 */
+            value: 'male' | 'female';
+            /** 置信度 */
+            confidence: number;
+        };
+        /** 年龄 */
+        age?: {
+            /** 年龄值 */
+            value: number;
+            /** 置信度 */
+            confidence: number;
+        };
+        /** 表情 */
+        emotion?: {
+            /** 表情值 */
+            value: 'neutral' | 'happiness' | 'surprise' | 'sadness' | 'anger' | 'disgust' | 'fear' | 'contempt';
+            /** 置信度 */
+            confidence: number;
+        };
+    };
+    /** 活体检测结果 */
+    liveness?: {
+        /** 是否通过活体检测 */
+        passed: boolean;
+        /** 活体检测分数 */
+        score: number;
+        /** 活体检测类型 */
+        type: 'blink' | 'mouth' | 'head' | 'passive';
+    };
+    /** 人脸图像 */
+    image?: ImageData;
+    /** 置信度 */
+    confidence: number;
+}
+/**
+ * 人脸比对结果
+ */
+export interface FaceComparisonResult {
+    /** 是否匹配 */
+    isMatch: boolean;
+    /** 相似度分数 */
+    similarity: number;
+    /** 置信度 */
+    confidence: number;
+}
+/**
+ * 人脸模块配置选项
+ */
+export interface FaceModuleOptions {
+    /** 是否启用模块 */
+    enabled?: boolean;
+    /** 检测器配置 */
+    detector?: {
+        /** 最小置信度 */
+        minConfidence?: number;
+        /** 是否检测特征点 */
+        detectLandmarks?: boolean;
+        /** 是否检测属性 */
+        detectAttributes?: boolean;
+        /** 是否返回人脸图像 */
+        returnFaceImage?: boolean;
+    };
+    /** 活体检测配置 */
+    liveness?: {
+        /** 是否启用活体检测 */
+        enabled?: boolean;
+        /** 活体检测类型 */
+        type?: 'blink' | 'mouth' | 'head' | 'passive';
+        /** 最小置信度 */
+        minConfidence?: number;
+        /** 检测超时时间（毫秒） */
+        timeout?: number;
+    };
+    /** 人脸比对配置 */
+    comparison?: {
+        /** 最小相似度阈值 */
+        minSimilarity?: number;
+    };
+}

package/dist/types/modules/id-card/anti-fake-detector.d.ts

@@ -0,0 +1,170 @@
+/**
+ * @file 身份证防伪检测模块
+ * @description 提供身份证防伪特征识别功能，区分真假身份证
+ * @module AntiFakeDetector
+ * @version 1.3.2
+ */
+import { Disposable } from "../../utils/resource-manager";
+/**
+ * 防伪检测结果
+ */
+export interface AntiFakeDetectionResult {
+    isAuthentic: boolean;
+    confidence: number;
+    detectedFeatures: string[];
+    message: string;
+    processingTime?: number;
+}
+/**
+ * 防伪检测器配置选项
+ */
+export interface AntiFakeDetectorOptions {
+    sensitivity?: number;
+    enableCache?: boolean;
+    cacheSize?: number;
+    logger?: (message: string) => void;
+}
+/**
+ * 身份证防伪特征检测器
+ *
+ * 基于图像分析技术检测身份证中的多种防伪特征，包括：
+ * 1. 荧光油墨特征
+ * 2. 微缩文字
+ * 3. 光变图案
+ * 4. 雕刻凹印
+ * 5. 隐形图案
+ *
+ * @example
+ * ```typescript
+ * // 创建防伪检测器
+ * const antiFakeDetector = new AntiFakeDetector({
+ *   sensitivity: 0.8,
+ *   enableCache: true
+ * });
+ *
+ * // 分析身份证图像
+ * const imageData = await ImageProcessor.createImageDataFromFile(idCardFile);
+ * const result = await antiFakeDetector.detect(imageData);
+ *
+ * if (result.isAuthentic) {
+ *   console.log('身份证真实，检测到防伪特征:', result.detectedFeatures);
+ * } else {
+ *   console.log('警告!', result.message);
+ * }
+ * ```
+ */
+export declare class AntiFakeDetector implements Disposable {
+    private options;
+    private resultCache;
+    /**
+     * 创建身份证防伪检测器实例
+     *
+     * @param options 防伪检测器配置
+     */
+    constructor(options?: AntiFakeDetectorOptions);
+    /**
+     * 检测身份证图像的防伪特征
+     *
+     * @param imageData 身份证图像数据
+     * @returns 防伪检测结果
+     */
+    detect(imageData: ImageData): Promise<AntiFakeDetectionResult>;
+    /**
+     * 增强身份证图像中的防伪特征
+     *
+     * @param imageData 原始图像数据
+     * @returns 增强后的图像数据
+     * @private
+     */
+    private enhanceAntiFakeFeatures;
+    /**
+     * 检测荧光油墨特征
+     *
+     * @param imageData 图像数据
+     * @returns [特征名称, 是否检测到, 置信度]
+     * @private
+     */
+    private detectUVInkFeatures;
+    /**
+     * 从图像数据中提取指定颜色通道
+     * @param imageData 原始图像数据
+     * @param channel 通道名称（red, green, blue）
+     */
+    private extractColorChannel;
+    /**
+     * 分析颜色通道分布特征
+     * @param channelData 颜色通道数据
+     */
+    private analyzeChannelDistribution;
+    /**
+     * 平滑直方图以减少噪声
+     */
+    private smoothHistogram;
+    /**
+     * 检测图像中的荧光颜色模式
+     */
+    private detectUVColorPattern;
+    /**
+     * 分析头像区域是否存在荧光特征
+     * 这个方法用于检测伪造的身份证，因为头像区域不应该有荧光特征
+     */
+    private analyzePortraitArea;
+    /**
+     * 检测微缩文字
+     *
+     * @param imageData 图像数据
+     * @returns [特征名称, 是否检测到, 置信度]
+     * @private
+     */
+    private detectMicroText;
+    /**
+     * 分析边缘图像的频率特征
+     * 微缩文字呈现高频的边缘过渡
+     */
+    private analyzeFrequencyFeatures;
+    /**
+     * 检测微缩文字区域
+     * 微缩文字通常呈现呈现规则的组合排列
+     */
+    private detectMicroTextRegions;
+    /**
+     * 深度优先搜索连通的边缘区域
+     */
+    private floodFillEdge;
+    /**
+     * 获取点集的外接矩形
+     */
+    private getBoundingBox;
+    /**
+     * 检测光变图案
+     *
+     * @param imageData 图像数据
+     * @returns [特征名称, 是否检测到, 置信度]
+     * @private
+     */
+    private detectOpticalVariable;
+    /**
+     * 检测凹印雕刻特征
+     *
+     * @param imageData 图像数据
+     * @returns [特征名称, 是否检测到, 置信度]
+     * @private
+     */
+    private detectIntaglioPrinting;
+    /**
+     * 检测隐形图案(幽灵图像)
+     *
+     * @param imageData 图像数据
+     * @returns [特征名称, 是否检测到, 置信度]
+     * @private
+     */
+    private detectGhostImage;
+    /**
+     * 清除结果缓存
+     */
+    clearCache(): void;
+    /**
+     * 释放资源
+     */
+    dispose(): void;
+}

package/dist/types/modules/id-card/id-card-detector.d.ts

@@ -0,0 +1,131 @@
+/**
+ * @file 身份证检测器
+ * @description 提供身份证检测和解析功能
+ * @module modules/id-card/id-card-detector
+ */
+import { EventEmitter } from '../../core/event-emitter';
+import { Result } from '../../core/result';
+import { IDCardInfo } from './types';
+/**
+ * 身份证检测器配置选项
+ */
+export interface IDCardDetectorOptions {
+    /** 是否启用 */
+    enabled?: boolean;
+    /** 最小置信度 */
+    minConfidence?: number;
+    /** 是否检测身份证类型 */
+    detectType?: boolean;
+    /** 是否检测边缘 */
+    detectEdge?: boolean;
+    /** 是否启用边缘检测（用于更精确的边缘检测） */
+    enableEdgeDetection?: boolean;
+    /** 是否启用OCR识别 */
+    enableOCR?: boolean;
+    /** 是否裁剪并校正图像 */
+    cropAndAlign?: boolean;
+    /** 是否启用防伪检测 */
+    enableAntiFake?: boolean;
+    /** 是否返回原始图像 */
+    returnImage?: boolean;
+    /** 模型路径 */
+    modelPath?: string;
+}
+/**
+ * 图像处理配置选项
+ */
+export interface ImageProcessOptions {
+    /** 是否进行预处理 */
+    preprocess?: boolean;
+    /** 是否校正图像 */
+    correctPerspective?: boolean;
+    /** 是否增强图像 */
+    enhance?: boolean;
+    /** 是否去噪 */
+    denoise?: boolean;
+    /** 是否二值化 */
+    binarize?: boolean;
+}
+/**
+ * 身份证检测器类
+ */
+export declare class IDCardDetector extends EventEmitter {
+    private options;
+    private logger;
+    private initialized;
+    private models;
+    /**
+     * 构造函数
+     * @param options 配置选项
+     */
+    constructor(options?: IDCardDetectorOptions);
+    /**
+     * 初始化检测器
+     */
+    initialize(): Promise<void>;
+    /**
+     * 加载检测模型
+     * @private
+     */
+    private loadDetectionModel;
+    /**
+     * 加载OCR模型
+     * @private
+     */
+    private loadOCRModel;
+    /**
+     * 加载防伪模型
+     * @private
+     */
+    private loadAntiFakeModel;
+    /**
+     * 处理图像
+     * @param image 图像源（可以是ImageData、HTMLImageElement、HTMLCanvasElement等）
+     * @param processOptions 图像处理选项
+     * @returns 处理结果
+     */
+    processImage(image: ImageData | HTMLImageElement | HTMLCanvasElement, processOptions?: ImageProcessOptions): Promise<Result<IDCardInfo>>;
+    /**
+     * 预处理图像
+     * @param image 图像源
+     * @param options 处理选项
+     * @returns 处理后的图像
+     * @private
+     */
+    private preprocessImage;
+    /**
+     * 检测身份证
+     * @param image 图像数据
+     * @returns 检测结果
+     * @private
+     */
+    private detectIDCard;
+    /**
+     * 裁剪并校正图像
+     * @param image 图像数据
+     * @param edge 边缘信息
+     * @returns 校正后的图像
+     * @private
+     */
+    private cropAndAlign;
+    /**
+     * 识别文字
+     * @param image 图像数据
+     * @param type 身份证类型
+     * @returns 识别结果
+     * @private
+     */
+    private recognizeText;
+    /**
+     * 检测防伪特征
+     * @param image 图像数据
+     * @param detectionResult 检测结果
+     * @returns 防伪检测结果
+     * @private
+     */
+    private detectAntiFake;
+    /**
+     * 释放资源
+     */
+    dispose(): void;
+}

package/dist/types/modules/id-card/index.d.ts

@@ -0,0 +1,89 @@
+/**
+ * @file 身份证模块入口
+ * @description 提供身份证识别和验证功能的模块入口
+ * @module modules/id-card
+ */
+import { BaseModule } from '../../core/base-module';
+import { IDCardInfo, IDCardType, IDCardModuleOptions, IDCardVerificationResult } from './types';
+/**
+ * 身份证识别模块
+ * 提供身份证检测、OCR识别、防伪检测等功能
+ */
+export declare class IDCardModule extends BaseModule {
+    /** 模块名称 */
+    readonly name: string;
+    /** 模块配置 */
+    private options;
+    /** 身份证检测器 */
+    private detector;
+    /** OCR处理器 */
+    private ocrProcessor?;
+    /** 防伪检测器 */
+    private antiFakeDetector?;
+    /** 最后一次检测结果 */
+    private lastDetectionResult?;
+    /**
+     * 构造函数
+     * @param options 模块配置选项
+     */
+    constructor(options?: IDCardModuleOptions);
+    /**
+     * 初始化模块
+     */
+    initialize(): Promise<void>;
+    /**
+     * 识别身份证图像
+     * @param image 图像源
+     * @returns 识别结果
+     */
+    recognize(image: ImageData | HTMLImageElement | HTMLCanvasElement): Promise<IDCardInfo>;
+    /**
+     * 验证身份证信息
+     * @param idCardInfo 身份证信息
+     * @returns 验证结果
+     */
+    verify(idCardInfo: IDCardInfo): IDCardVerificationResult;
+    /**
+     * 获取最后一次识别结果
+     */
+    getLastRecognitionResult(): IDCardInfo | undefined;
+    /**
+     * 释放模块资源
+     */
+    dispose(): Promise<void>;
+    /**
+     * 验证身份证号码是否有效
+     * @param idNumber 身份证号码
+     * @returns 是否有效
+     */
+    private validateIDNumber;
+    /**
+     * 检查身份证是否过期
+     * @param validTo 有效期截止日期
+     * @returns 是否过期
+     */
+    private isIDCardExpired;
+    /**
+     * 检测身份证
+     * @param image 图像源
+     * @returns 检测结果
+     */
+    detect(image: ImageData | HTMLImageElement | HTMLCanvasElement): Promise<{
+        success: boolean;
+        type?: IDCardType;
+        confidence: number;
+        croppedImage?: ImageData;
+    }>;
+    /**
+     * 将图像转换为 ImageData
+     * @param image 图像源
+     * @returns ImageData 对象
+     */
+    private convertToImageData;
+    /**
+     * 确保模块已初始化
+     * @protected
+     */
+    protected ensureInitialized(): void;
+}
+export * from './types';

package/dist/types/modules/id-card/ocr-processor.d.ts

@@ -0,0 +1,110 @@
+/**
+ * @file OCR处理器
+ * @description 提供身份证OCR识别功能
+ * @module modules/id-card/ocr-processor
+ */
+/// <reference path="../../../../src/types/tesseract.d.ts" />
+import { IDCardInfo } from './types';
+import { LoggerMessage } from "tesseract.js";
+import { Disposable } from "../../utils/resource-manager";
+type LoggerFunction = ((message: string | LoggerMessage) => void) | undefined;
+/**
+ * OCR处理器选项接口
+ */
+export interface OCRProcessorOptions {
+    language?: string;
+    useWorker?: boolean;
+    maxImageDimension?: number;
+    timeout?: number;
+    brightness?: number;
+    contrast?: number;
+    onProgress?: (progress: number) => void;
+    enableCache?: boolean;
+    cacheSize?: number;
+    logger?: LoggerFunction;
+}
+/**
+ * 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 implements Disposable {
+    private worker;
+    private ocrWorker;
+    private initialized;
+    private resultCache;
+    private options;
+    /**
+     * 创建OCR处理器实例
+     *
+     * @param options OCR处理器选项
+     */
+    constructor(options?: OCRProcessorOptions);
+    /**
+     * 初始化OCR引擎
+     *
+     * 加载Tesseract OCR引擎和中文简体语言包，并设置适合身份证识别的参数
+     *
+     * @returns {Promise<void>} 初始化完成的Promise
+     */
+    initialize(): Promise<void>;
+    /**
+     * 处理身份证图像并提取信息
+     * @param imageData 要处理的身份证图像数据
+     * @returns 提取的身份证信息
+     */
+    processIDCard(imageData: ImageData): Promise<IDCardInfo>;
+    /**
+     * 解析身份证文本信息
+     *
+     * 从OCR识别到的文本中提取结构化的身份证信息
+     *
+     * @private
+     * @param {string} text - OCR识别到的文本
+     * @returns {IDCardInfo} 提取到的身份证信息对象
+     */
+    /**
+     * 格式化日期字符串为标准格式 (YYYY-MM-DD)
+     * @param dateStr 原始日期字符串
+     * @returns 格式化后的日期字符串
+     */
+    private formatDateString;
+    /**
+     * 验证身份证号是否符合规则
+     * @param idNumber 身份证号
+     * @returns 是否有效
+     */
+    private validateIDNumber;
+    private parseIDCardText;
+    /**
+     * 清除结果缓存
+     */
+    clearCache(): void;
+    /**
+     * 终止OCR引擎并释放资源
+     *
+     * @returns {Promise<void>} 终止完成的Promise
+     */
+    terminate(): Promise<void>;
+    /**
+     * 释放资源
+     */
+    dispose(): Promise<void>;
+}
+export {};

package/dist/types/modules/id-card/ocr-worker.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @file OCR Worker
+ * @description OCR处理的Worker线程实现
+ * @module modules/id-card/ocr-worker
+ */
+/// <reference path="../../../../src/types/tesseract.d.ts" />
+import { IDCardInfo } from './types';
+import { LoggerMessage } from 'tesseract.js';
+/**
+ * OCR处理输入参数
+ */
+export interface OCRProcessInput {
+    /** 图像Base64数据 */
+    imageBase64: string;
+    /** Tesseract Worker选项 */
+    tessWorkerOptions?: {
+        /** 语言 */
+        language?: string;
+        /** 日志回调 */
+        logger?: (message: LoggerMessage) => void;
+    };
+}
+/**
+ * 在Worker中处理OCR识别
+ * @param input OCR处理输入参数
+ * @returns OCR处理结果
+ */
+export declare function processOCRInWorker(input: OCRProcessInput): Promise<{
+    idCardInfo: IDCardInfo;
+    processingTime: number;
+}>;