id-scanner-lib 1.3.3 → 1.5.0

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

@@ -0,0 +1,181 @@
+/**
+ * @file 身份证模块类型定义
+ * @description 身份证模块相关的类型和接口定义
+ * @module modules/id-card/types
+ */
+/**
+ * 身份证类型枚举
+ */
+export declare enum IDCardType {
+    /** 第二代居民身份证正面 */
+    FRONT = "front",
+    /** 第二代居民身份证背面 */
+    BACK = "back",
+    /** 第一代居民身份证 */
+    FIRST_GENERATION = "first_generation",
+    /** 临时身份证 */
+    TEMPORARY = "temporary",
+    /** 外国人永久居留证 */
+    FOREIGN_PERMANENT = "foreign_permanent",
+    /** 港澳台居民居住证 */
+    HMT_RESIDENT = "hmt_resident",
+    /** 未知类型 */
+    UNKNOWN = "unknown"
+}
+/**
+ * 证件边缘信息
+ */
+export interface IDCardEdge {
+    /** 左上角坐标 */
+    topLeft: {
+        x: number;
+        y: number;
+    };
+    /** 右上角坐标 */
+    topRight: {
+        x: number;
+        y: number;
+    };
+    /** 右下角坐标 */
+    bottomRight: {
+        x: number;
+        y: number;
+    };
+    /** 左下角坐标 */
+    bottomLeft: {
+        x: number;
+        y: number;
+    };
+}
+/**
+ * 身份证信息
+ */
+export interface IDCardInfo {
+    nationality?: string;
+    issuingAuthority?: string;
+    validPeriod?: string;
+    /** 身份证类型 */
+    type?: IDCardType;
+    /** 身份证边缘信息 */
+    edge?: IDCardEdge;
+    /** 姓名 */
+    name?: string;
+    /** 性别 */
+    gender?: string;
+    /** 民族 */
+    ethnicity?: string;
+    /** 出生日期，格式: YYYY-MM-DD */
+    birthDate?: string;
+    /** 地址 */
+    address?: string;
+    /** 身份证号码 */
+    idNumber?: string;
+    /** 签发机关 */
+    issueAuthority?: string;
+    /** 有效期起始日期，格式: YYYY-MM-DD */
+    validFrom?: string;
+    /** 有效期截止日期，格式: YYYY-MM-DD */
+    validTo?: string;
+    /** 相片区域坐标 */
+    photoRegion?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    /** 原始身份证图像 */
+    image?: ImageData;
+    /** 置信度 */
+    confidence?: number;
+    /** 防伪检测结果 */
+    antiFake?: {
+        /** 是否通过防伪检测 */
+        passed: boolean;
+        /** 防伪检测分数 */
+        score: number;
+        /** 防伪特征检测结果 */
+        features?: {
+            /** 荧光油墨 */
+            fluorescent?: boolean;
+            /** 微缩文字 */
+            microtext?: boolean;
+            /** 光变图案 */
+            opticalVariable?: boolean;
+            /** 纹理 */
+            texture?: boolean;
+            /** 暗记 */
+            watermark?: boolean;
+        };
+    };
+}
+/**
+ * 身份证模块配置选项
+ */
+export interface IDCardModuleOptions {
+    /** 是否启用模块 */
+    enabled?: boolean;
+    /** 检测器配置 */
+    detector?: {
+        /** 最小置信度 */
+        minConfidence?: number;
+        /** 是否启用OCR识别 */
+        enableOCR?: boolean;
+        /** 是否启用防伪检测 */
+        enableAntiFake?: boolean;
+    };
+    /** OCR处理器配置 */
+    ocr?: {
+        /** 是否使用Web Worker处理OCR */
+        useWorker?: boolean;
+        /** 最大图像尺寸 */
+        maxImageDimension?: number;
+        /** 亮度调整 */
+        brightness?: number;
+        /** 对比度调整 */
+        contrast?: number;
+    };
+    /** 防伪检测配置 */
+    antiFake?: {
+        /** 防伪检测灵敏度 */
+        sensitivity?: number;
+        /** 最小置信度 */
+        minConfidence?: number;
+    };
+}
+/**
+ * 身份证验证结果
+ */
+export interface IDCardVerificationResult {
+    /** 是否验证通过 */
+    isValid: boolean;
+    /** 验证分数 */
+    score: number;
+    /** 失败原因 */
+    failureReason?: string;
+    /** 验证详情 */
+    details?: {
+        /** 身份证号码是否有效 */
+        idNumberValid?: boolean;
+        /** 签发日期是否有效 */
+        issueDateValid?: boolean;
+        /** 有效期是否过期 */
+        isExpired?: boolean;
+        /** 防伪检测是否通过 */
+        antiFakePassed?: boolean;
+    };
+}
+/**
+ * 图像处理配置选项
+ */
+export interface ImageProcessOptions {
+    /** 是否进行预处理 */
+    preprocess?: boolean;
+    /** 是否校正图像 */
+    correctPerspective?: boolean;
+    /** 是否增强图像 */
+    enhance?: boolean;
+    /** 是否去噪 */
+    denoise?: boolean;
+    /** 是否二值化 */
+    binarize?: boolean;
+}

package/dist/types/modules/qrcode/index.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @file 二维码模块入口
+ * @description 提供二维码识别和解析功能的模块入口
+ * @module modules/qrcode
+ */
+import { BaseModule } from '../../core/base-module';
+import { QRCodeResult, QRCodeModuleOptions } from './types';
+/**
+ * 二维码模块
+ * 提供二维码检测和解析功能
+ */
+export declare class QRCodeModule extends BaseModule {
+    /** 模块名称 */
+    readonly name: string;
+    /** 模块配置 */
+    private options;
+    /** 二维码扫描器 */
+    private scanner;
+    /** 最后一次扫描结果 */
+    private lastScanResult?;
+    /**
+     * 构造函数
+     * @param options 模块配置选项
+     */
+    constructor(options?: QRCodeModuleOptions);
+    /**
+     * 初始化模块
+     */
+    initialize(): Promise<void>;
+    /**
+     * 扫描图像中的二维码
+     * @param image 图像源
+     * @returns 二维码扫描结果
+     */
+    scan(image: ImageData | HTMLImageElement | HTMLCanvasElement): Promise<QRCodeResult | undefined>;
+    /**
+     * 获取最后一次扫描结果
+     */
+    getLastScanResult(): QRCodeResult | undefined;
+    /**
+     * 解析二维码数据
+     * @param data 二维码数据
+     * @returns 解析后的数据对象
+     */
+    parseQRCodeData(data: string): Record<string, any> | string;
+    /**
+     * 释放模块资源
+     */
+    dispose(): Promise<void>;
+}
+export * from './types';

package/dist/types/modules/qrcode/qr-code-scanner.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @file 二维码扫描器
+ * @description 提供二维码检测和解析功能
+ * @module modules/qrcode/qr-code-scanner
+ */
+import { EventEmitter } from '../../core/event-emitter';
+import { QRCodeResult } from './types';
+/**
+ * 二维码扫描器配置选项
+ */
+export interface QRCodeScannerOptions {
+    /** 最小置信度 */
+    minConfidence?: number;
+    /** 是否返回原始图像 */
+    returnImage?: boolean;
+    /** 图像处理配置 */
+    imageProcess?: {
+        /** 是否进行预处理 */
+        preprocess?: boolean;
+        /** 是否增强对比度 */
+        enhanceContrast?: boolean;
+        /** 二值化阈值 */
+        threshold?: number;
+    };
+}
+/**
+ * 二维码扫描器类
+ */
+export declare class QRCodeScanner extends EventEmitter {
+    private options;
+    private logger;
+    private initialized;
+    /**
+     * 构造函数
+     * @param options 配置选项
+     */
+    constructor(options?: QRCodeScannerOptions);
+    /**
+     * 初始化扫描器
+     */
+    initialize(): Promise<void>;
+    /**
+     * 扫描图像中的二维码
+     * @param image 图像源
+     * @returns 二维码扫描结果
+     */
+    scan(image: ImageData | HTMLImageElement | HTMLCanvasElement): Promise<QRCodeResult | undefined>;
+    /**
+     * 将各种图像源转换为ImageData
+     * @param image 图像源
+     * @returns ImageData
+     */
+    private getImageData;
+    /**
+     * 图像预处理
+     * @param imageData 原始图像数据
+     * @returns 处理后的图像数据
+     */
+    private preprocessImage;
+    /**
+     * 释放资源
+     */
+    dispose(): Promise<void>;
+}

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

@@ -0,0 +1,67 @@
+/**
+ * @file 二维码模块类型定义
+ * @description 二维码模块相关的类型和接口定义
+ * @module modules/qrcode/types
+ */
+/**
+ * 二维码检测结果
+ */
+export interface QRCodeResult {
+    /** 二维码内容 */
+    data: string;
+    /** 二维码类型 */
+    type?: string;
+    /** 二维码边界框 */
+    boundingBox: {
+        topLeft: {
+            x: number;
+            y: number;
+        };
+        topRight: {
+            x: number;
+            y: number;
+        };
+        bottomRight: {
+            x: number;
+            y: number;
+        };
+        bottomLeft: {
+            x: number;
+            y: number;
+        };
+    };
+    /** 二维码中心点 */
+    center: {
+        x: number;
+        y: number;
+    };
+    /** 原始图像 */
+    image?: ImageData;
+    /** 置信度 */
+    confidence?: number;
+}
+/**
+ * 二维码模块选项
+ */
+export interface QRCodeModuleOptions {
+    /** 是否启用模块 */
+    enabled?: boolean;
+    /** 二维码扫描配置 */
+    scanner?: {
+        /** 最小置信度 */
+        minConfidence?: number;
+        /** 是否尝试多次扫描 */
+        tryMultipleScan?: boolean;
+        /** 是否返回原始图像 */
+        returnImage?: boolean;
+    };
+    /** 图像处理配置 */
+    imageProcess?: {
+        /** 是否进行预处理 */
+        preprocess?: boolean;
+        /** 是否增强对比度 */
+        enhanceContrast?: boolean;
+        /** 二值化阈值 */
+        threshold?: number;
+    };
+}

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,176 @@
+/**
+ * @file 图像处理工具类
+ * @description 提供图像预处理功能，用于提高OCR识别率
+ * @module ImageProcessor
+ * @version 1.3.2
+ */
+/**
+ * 图像处理器配置选项
+ */
+export interface ImageProcessorOptions {
+    brightness?: number;
+    contrast?: number;
+    grayscale?: boolean;
+    invert?: boolean;
+    blur?: number;
+    sharpen?: boolean;
+}
+/**
+ * 图像压缩选项
+ */
+export interface ImageCompressionOptions {
+    maxSizeMB?: number;
+    maxWidthOrHeight?: number;
+    useWebWorker?: boolean;
+    maxIteration?: number;
+    quality?: number;
+    fileType?: string;
+}
+/**
+ * 图像处理工具类
+ *
+ * 提供各种图像处理功能，用于优化识别效果
+ */
+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 原始图像数据
+     * @param brightness 亮度调整值 (-100到100)
+     * @param contrast 对比度调整值 (-100到100)
+     * @returns 处理后的图像数据
+     */
+    static adjustBrightnessContrast(imageData: ImageData, brightness?: number, contrast?: number): ImageData;
+    /**
+     * 将图像转换为灰度图
+     *
+     * @param imageData 原始图像数据
+     * @returns 灰度图像数据
+     */
+    static toGrayscale(imageData: ImageData): ImageData;
+    /**
+     * 锐化图像
+     *
+     * @param imageData 原始图像数据
+     * @param amount 锐化程度，默认为2
+     * @returns 锐化后的图像数据
+     */
+    static sharpen(imageData: ImageData, amount?: number): ImageData;
+    /**
+     * 对图像应用阈值操作，增强对比度
+     *
+     * @param imageData 原始图像数据
+     * @param threshold 阈值 (0-255)
+     * @returns 处理后的图像数据
+     */
+    static threshold(imageData: ImageData, threshold?: number): ImageData;
+    /**
+     * 将图像转换为黑白图像（二值化）
+     *
+     * @param imageData 原始图像数据
+     * @returns 二值化后的图像数据
+     */
+    static toBinaryImage(imageData: ImageData): ImageData;
+    /**
+     * 使用OTSU算法计算最佳阈值
+     *
+     * @param imageData 灰度图像数据
+     * @returns 最佳阈值
+     */
+    private static getOtsuThreshold;
+    /**
+     * 批量应用图像处理
+     *
+     * @param imageData 原始图像数据
+     * @param options 处理选项
+     * @returns 处理后的图像数据
+     */
+    static batchProcess(imageData: ImageData, options: ImageProcessorOptions): ImageData;
+    /**
+     * 压缩图片文件
+     *
+     * @param file 图片文件
+     * @param options 压缩选项
+     * @returns Promise<File> 压缩后的文件
+     */
+    static compressImage(file: File, options?: ImageCompressionOptions): Promise<File>;
+    /**
+     * 从图片文件创建ImageData
+     *
+     * @param file 图片文件
+     * @returns Promise<ImageData>
+     */
+    static createImageDataFromFile(file: File): Promise<ImageData>;
+    /**
+     * 将ImageData转换为File对象
+     *
+     * @param imageData ImageData对象
+     * @param fileName 输出文件名
+     * @param fileType 输出文件类型
+     * @param quality 图片质量 (0-1)
+     * @returns Promise<File>
+     */
+    static imageDataToFile(imageData: ImageData, fileName?: string, fileType?: string, quality?: number): Promise<File>;
+    /**
+     * 将图像调整到指定大小
+     * @param image 输入图像
+     * @param maxWidth 最大宽度
+     * @param maxHeight 最大高度
+     * @param keepAspectRatio 是否保持宽高比
+     * @returns 调整后的图像
+     */
+    static resizeImage(image: ImageData | HTMLImageElement | HTMLCanvasElement, maxWidth: number, maxHeight: number, keepAspectRatio?: boolean): ImageData;
+    /**
+     * 边缘检测算法，用于识别图像中的边缘
+     * 基于Sobel算子实现
+     *
+     * @param imageData 原始图像数据，应已转为灰度图
+     * @param threshold 边缘阈值，默认为30
+     * @returns 检测到边缘的图像数据
+     */
+    static detectEdges(imageData: ImageData, threshold?: number): ImageData;
+    /**
+     * 卡尼-德里奇边缘检测
+     * 相比Sobel更精确的边缘检测算法
+     *
+     * @param imageData 灰度图像数据
+     * @param lowThreshold 低阈值
+     * @param highThreshold 高阈值
+     * @returns 边缘检测结果
+     */
+    static cannyEdgeDetection(imageData: ImageData, lowThreshold?: number, highThreshold?: number): ImageData;
+    /**
+     * 高斯模糊
+     */
+    private static gaussianBlur;
+    /**
+     * 生成高斯核
+     */
+    private static generateGaussianKernel;
+    /**
+     * 计算梯度强度和方向
+     */
+    private static computeGradients;
+    /**
+     * 非极大值抛弃
+     */
+    private static nonMaxSuppression;
+    /**
+     * 双阈值处理
+     */
+    private static hysteresisThresholding;
+}