id-scanner-lib/dist/types/index.d.ts

Browser-based ID card, QR code, and face recognition scanner with liveness detection

/**
 * @file 主入口文件
 * @description ID Scanner库的主入口点，提供统一的API和模块导出
 * @module index
 */
import { IDCardModule } from './modules/id-card';
import { QRCodeModule } from './modules/qrcode';
import { FaceModule } from './modules/face';
import { LogLevel } from './core/logger';
import { IDCardModuleOptions } from './modules/id-card/types';
import { QRCodeModuleOptions } from './modules/qrcode/types';
import { FaceModuleOptions } from './modules/face/types';
/**
 * IDScanner配置选项
 */
export interface IDScannerOptions {
    /** 日志级别 */
    logLevel?: LogLevel;
    /** 是否启用身份证识别模块 */
    enableIDCard?: boolean;
    /** 是否启用二维码识别模块 */
    enableQRCode?: boolean;
    /** 是否启用人脸识别模块 */
    enableFace?: boolean;
    /** 身份证模块配置 */
    idCard?: IDCardModuleOptions;
    /** 二维码模块配置 */
    qrCode?: QRCodeModuleOptions;
    /** 人脸识别模块配置 */
    face?: FaceModuleOptions;
}
/**
 * IDScanner类
 * 提供整合的身份证、二维码和人脸识别功能
 */
export declare class IDScanner {
    /** 版本号 */
    static readonly VERSION = "1.5.0";
    /** 构建日期 */
    static readonly BUILD_DATE: string;
    /** 模块管理器 */
    private moduleManager;
    /** 是否已经初始化 */
    private initialized;
    /** 日志工具 */
    private logger;
    /**
     * 构造函数
     * @param options 配置选项
     */
    constructor(options?: IDScannerOptions);
    /**
     * 初始化库
     */
    initialize(): Promise<void>;
    /**
     * 获取身份证模块实例
     * @returns 身份证模块
     */
    getIDCardModule(): IDCardModule | undefined;
    /**
     * 获取二维码模块实例
     * @returns 二维码模块
     */
    getQRCodeModule(): QRCodeModule | undefined;
    /**
     * 获取人脸识别模块实例
     * @returns 人脸识别模块
     */
    getFaceModule(): FaceModule | undefined;
    /**
     * 释放所有资源
     */
    dispose(): Promise<void>;
}
export * from './core/module-manager';
export * from './core/logger';
export * from './core/errors';
export { IDCardModule } from './modules/id-card';
export { QRCodeModule } from './modules/qrcode';
export { FaceModule } from './modules/face';
export * from './utils/types';
export { IDCardModuleOptions, IDCardInfo, IDCardType, IDCardVerificationResult } from './modules/id-card/types';
export { QRCodeModuleOptions, QRCodeResult } from './modules/qrcode/types';
export { FaceModuleOptions, FaceDetectionResult, FaceComparisonResult } from './modules/face/types';
export default IDScanner;