id-scanner-lib 1.3.3 → 1.5.0

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

@@ -0,0 +1,175 @@
+/**
+ * @file 工具集
+ * @description 提供通用工具函数
+ * @module utils
+ */
+/**
+ * 创建延迟Promise
+ * @param ms 延迟毫秒数
+ */
+export declare function delay(ms: number): Promise<void>;
+/**
+ * 节流函数
+ * @param fn 要节流的函数
+ * @param wait 等待时间(ms)
+ */
+export declare function throttle<T extends (...args: any[]) => any>(fn: T, wait: number): (...args: Parameters<T>) => ReturnType<T> | undefined;
+/**
+ * 防抖函数
+ * @param fn 要防抖的函数
+ * @param wait 等待时间(ms)
+ * @param immediate 是否立即执行
+ */
+export declare function debounce<T extends (...args: any[]) => any>(fn: T, wait: number, immediate?: boolean): (...args: Parameters<T>) => void;
+/**
+ * 格式化字节大小
+ * @param bytes 字节数
+ * @param decimals 小数位数
+ */
+export declare function formatBytes(bytes: number, decimals?: number): string;
+/**
+ * 生成UUID
+ */
+export declare function generateUUID(): string;
+/**
+ * 检查浏览器支持的功能
+ */
+export declare const browserCapabilities: {
+    /**
+     * 检查是否支持摄像头
+     */
+    hasCamera(): boolean;
+    /**
+     * 检查是否支持WebAssembly
+     */
+    hasWasm(): boolean;
+    /**
+     * 检查是否支持WebWorker
+     */
+    hasWebWorker(): boolean;
+    /**
+     * 检查是否支持WebGL
+     */
+    hasWebGL(): boolean;
+    /**
+     * 检查是否支持SharedArrayBuffer
+     */
+    hasSharedArrayBuffer(): boolean;
+    /**
+     * 检查是否支持特定的功能
+     * @param feature 功能名称
+     */
+    supports(feature: string): boolean;
+};
+/**
+ * 数组分块
+ * @param array 要分块的数组
+ * @param chunkSize 每块大小
+ */
+export declare function chunk<T>(array: T[], chunkSize: number): T[][];
+/**
+ * 安全解析JSON
+ * @param text JSON字符串
+ * @param fallback 解析失败时的默认值
+ */
+export declare function safeParseJSON<T = any>(text: string, fallback: T): T;
+/**
+ * 限制值在指定范围内
+ * @param value 要限制的值
+ * @param min 最小值
+ * @param max 最大值
+ */
+export declare function clamp(value: number, min: number, max: number): number;
+/**
+ * 等待加载图片
+ * @param url 图片URL
+ */
+export declare function loadImage(url: string): Promise<HTMLImageElement>;
+/**
+ * 将Blob转换为Base64
+ * @param blob Blob对象
+ */
+export declare function blobToBase64(blob: Blob): Promise<string>;
+/**
+ * 将Base64转换为Blob
+ * @param base64 Base64字符串
+ * @param contentType 内容类型
+ */
+export declare function base64ToBlob(base64: string, contentType?: string): Blob;
+/**
+ * 获取媒体约束
+ * @param width 宽度
+ * @param height 高度
+ * @param facingMode 前后置摄像头
+ * @param frameRate 帧率
+ */
+export declare function getMediaConstraints(width?: number, height?: number, facingMode?: 'user' | 'environment', frameRate?: number): MediaStreamConstraints;
+/**
+ * 检查URL是否有效
+ * @param url 要检查的URL
+ */
+export declare function isValidUrl(url: string): boolean;
+/**
+ * DOM帮助函数
+ */
+export declare const dom: {
+    /**
+     * 创建元素
+     * @param tag 标签名
+     * @param attributes 属性
+     * @param children 子元素
+     */
+    createElement<K extends keyof HTMLElementTagNameMap>(tag: K, attributes?: Record<string, any>, children?: (string | Node)[]): HTMLElementTagNameMap[K];
+    /**
+     * 查找元素
+     * @param selector 选择器
+     * @param parent 父元素
+     */
+    find<E extends Element = Element>(selector: string, parent?: Document | Element): E | null;
+    /**
+     * 查找所有元素
+     * @param selector 选择器
+     * @param parent 父元素
+     */
+    findAll<E_1 extends Element = Element>(selector: string, parent?: Document | Element): E_1[];
+    /**
+     * 添加事件监听器
+     * @param element 元素
+     * @param event 事件名称
+     * @param handler 处理函数
+     * @param options 选项
+     */
+    on<K_1 extends keyof HTMLElementEventMap>(element: HTMLElement, event: K_1, handler: (event: HTMLElementEventMap[K_1]) => any, options?: AddEventListenerOptions): void;
+    /**
+     * 移除事件监听器
+     * @param element 元素
+     * @param event 事件名称
+     * @param handler 处理函数
+     * @param options 选项
+     */
+    off<K_2 extends keyof HTMLElementEventMap>(element: HTMLElement, event: K_2, handler: (event: HTMLElementEventMap[K_2]) => any, options?: EventListenerOptions): void;
+    /**
+     * 设置样式
+     * @param element 元素
+     * @param styles 样式对象
+     */
+    setStyles(element: HTMLElement, styles: Partial<CSSStyleDeclaration>): void;
+    /**
+     * 添加类名
+     * @param element 元素
+     * @param classNames 类名
+     */
+    addClass(element: HTMLElement, ...classNames: string[]): void;
+    /**
+     * 移除类名
+     * @param element 元素
+     * @param classNames 类名
+     */
+    removeClass(element: HTMLElement, ...classNames: string[]): void;
+    /**
+     * 判断是否包含类名
+     * @param element 元素
+     * @param className 类名
+     */
+    hasClass(element: HTMLElement, className: string): boolean;
+};

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

@@ -0,0 +1,81 @@
+/**
+ * @file 性能优化工具
+ * @description 提供性能优化相关的工具函数
+ * @module utils/performance
+ */
+/**
+ * LRU缓存实现
+ */
+export declare class LRUCache<K, V> {
+    private capacity;
+    private cache;
+    /**
+     * 构造函数
+     * @param capacity 缓存容量
+     */
+    constructor(capacity?: number);
+    /**
+     * 获取缓存项
+     * @param key 键
+     * @returns 值，如果不存在则返回undefined
+     */
+    get(key: K): V | undefined;
+    /**
+     * 设置缓存项
+     * @param key 键
+     * @param value 值
+     */
+    set(key: K, value: V): void;
+    /**
+     * 检查键是否存在
+     * @param key 键
+     * @returns 是否存在
+     */
+    has(key: K): boolean;
+    /**
+     * 删除缓存项
+     * @param key 键
+     * @returns 是否成功删除
+     */
+    delete(key: K): boolean;
+    /**
+     * 清空缓存
+     */
+    clear(): void;
+    /**
+     * 获取缓存大小
+     */
+    get size(): number;
+    /**
+     * 获取所有键
+     */
+    keys(): IterableIterator<K>;
+    /**
+     * 获取所有值
+     */
+    values(): IterableIterator<V>;
+    /**
+     * 获取所有项
+     */
+    entries(): IterableIterator<[K, V]>;
+}
+/**
+ * 计算图像指纹
+ * @param imageData 图像数据
+ * @returns 图像指纹
+ */
+export declare function calculateImageFingerprint(imageData: ImageData): string;
+/**
+ * 防抖函数
+ * @param func 要执行的函数
+ * @param wait 等待时间（毫秒）
+ * @returns 防抖处理后的函数
+ */
+export declare function debounce<T extends (...args: any[]) => any>(func: T, wait: number): (...args: Parameters<T>) => void;
+/**
+ * 节流函数
+ * @param func 要执行的函数
+ * @param limit 时间限制（毫秒）
+ * @returns 节流处理后的函数
+ */
+export declare function throttle<T extends (...args: any[]) => any>(func: T, limit: number): (...args: Parameters<T>) => void;

package/dist/types/utils/resource-manager.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @file 资源管理器
+ * @description 提供资源管理和释放功能
+ * @module utils/resource-manager
+ */
+/**
+ * 可释放资源接口
+ */
+export interface Disposable {
+    /** 释放资源 */
+    dispose(): Promise<void> | void;
+}
+/**
+ * 资源管理器类
+ * 用于管理和自动释放资源
+ */
+export declare class ResourceManager {
+    private resources;
+    /**
+     * 注册资源
+     * @param resource 可释放资源
+     * @returns 资源本身，便于链式调用
+     */
+    register<T extends Disposable>(resource: T): T;
+    /**
+     * 释放指定资源
+     * @param resource 要释放的资源
+     * @returns 是否成功释放
+     */
+    release(resource: Disposable): Promise<boolean>;
+    /**
+     * 释放所有资源
+     */
+    releaseAll(): Promise<void>;
+    /**
+     * 获取当前管理的资源数量
+     */
+    get count(): number;
+}
+/**
+* 创建一个自动释放的资源
+* @param factory 资源工厂函数
+* @param disposeCallback 释放回调函数
+* @returns 创建的资源
+*/
+export declare function createDisposable<T>(factory: () => T, disposeCallback: (resource: T) => Promise<void> | void): T & Disposable;
+/**
+ * 使用资源并自动释放
+ * @param resource 可释放资源
+ * @param callback 使用资源的回调函数
+ * @returns 回调函数的返回值
+ */
+export declare function using<T extends Disposable, R>(resource: T, callback: (resource: T) => Promise<R> | R): Promise<R>;

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

@@ -0,0 +1,166 @@
+/**
+ * @file 类型定义文件
+ * @description 定义全局类型
+ * @module Types
+ */
+/**
+ * 身份证检测结果接口
+ *
+ * 包含身份证检测的结果信息，如是否成功检测到身份证、身份证的四个角点坐标以及裁剪后的身份证图像
+ *
+ * @interface DetectionResult
+ * @property {boolean} success - 是否成功检测到身份证
+ * @property {Object[]} [corners] - 检测到的身份证四个角点坐标
+ * @property {number} corners[].x - 角点X坐标
+ * @property {number} corners[].y - 角点Y坐标
+ * @property {ImageData} [croppedImage] - 裁剪后的身份证图像
+ * @property {ImageData} [imageData] - 原始图像数据
+ * @property {Object} [boundingBox] - 检测到的身份证边界框
+ * @property {number} boundingBox.x - 边界框左上角X坐标
+ * @property {number} boundingBox.y - 边界框左上角Y坐标
+ * @property {number} boundingBox.width - 边界框宽度
+ * @property {number} boundingBox.height - 边界框高度
+ * @property {number} [confidence] - 检测结果的置信度
+ * @property {string} [message] - 检测结果的消息
+ */
+export interface DetectionResult {
+    success: boolean;
+    corners?: {
+        x: number;
+        y: number;
+    }[];
+    croppedImage?: ImageData;
+    imageData?: ImageData;
+    boundingBox?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    confidence?: number;
+    message?: string;
+}
+/**
+ * 身份证信息接口
+ *
+ * 包含从身份证中提取的各项个人信息
+ *
+ * @interface IDCardInfo
+ * @property {string} [name] - 姓名
+ * @property {string} [gender] - 性别
+ * @property {string} [nationality] - 民族
+ * @property {string} [birthDate] - 出生日期
+ * @property {string} [address] - 地址
+ * @property {string} [idNumber] - 身份证号码
+ * @property {string} [issuingAuthority] - 签发机关
+ * @property {string} [validPeriod] - 有效期限
+ *
+ * @example
+ * ```typescript
+ * // 身份证信息示例
+ * const idInfo: IDCardInfo = {
+ *   name: '张三',
+ *   gender: '男',
+ *   nationality: '汉族',
+ *   birthDate: '1990-01-01',
+ *   address: '北京市海淀区xxxxx',
+ *   idNumber: '110101199001011234',
+ *   issuingAuthority: '北京市公安局海淀分局',
+ *   validPeriod: '2020.01.01-2040.01.01'
+ * };
+ * ```
+ */
+export interface IDCardInfo {
+    /** 姓名 */
+    name?: string;
+    /** 性别 */
+    gender?: string;
+    /** 民族 */
+    ethnicity?: string;
+    /** 出生日期 */
+    birthDate?: string;
+    /** 地址 */
+    address?: string;
+    /** 身份证号码 */
+    idNumber?: string;
+    /** 签发机关 */
+    issueAuthority?: string;
+    /** 有效期起始日期 */
+    validFrom?: string;
+    /** 有效期截止日期 */
+    validTo?: string;
+    /** 有效期限（完整文本） */
+    validPeriod?: string;
+    /** 照片区域 */
+    photoRegion?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    /** 类型 */
+    type?: string;
+    /** 置信度 */
+    confidence?: number;
+    /** 其他属性 */
+    [key: string]: any;
+}
+/**
+ * 点坐标
+ */
+export interface Point {
+    x: number;
+    y: number;
+}
+/**
+ * 矩形区域
+ */
+export interface Rect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+/**
+ * 可释放资源接口
+ */
+export interface Disposable {
+    /** 释放资源 */
+    dispose(): Promise<void>;
+}
+/**
+ * 图像处理选项
+ */
+export interface ImageProcessingOptions {
+    /** 亮度调整 (-100 到 100) */
+    brightness?: number;
+    /** 对比度调整 (-100 到 100) */
+    contrast?: number;
+    /** 饱和度调整 (-100 到 100) */
+    saturation?: number;
+    /** 锐化强度 (0 到 10) */
+    sharpen?: number | boolean;
+    /** 高斯模糊半径 (0 到 10) */
+    blur?: number;
+    /** 是否应用灰度转换 */
+    grayscale?: boolean;
+    /** 是否应用二值化 */
+    binarize?: boolean;
+    /** 二值化阈值 (0 到 255) */
+    threshold?: number;
+    /** 是否应用边缘检测 */
+    edgeDetection?: boolean;
+    /** 是否应用降噪 */
+    denoise?: boolean;
+    /** 是否应用直方图均衡化 */
+    histogramEqualization?: boolean;
+    /** 是否应用透视校正 */
+    perspectiveCorrection?: boolean;
+    /** 透视校正点 */
+    perspectivePoints?: {
+        topLeft: Point;
+        topRight: Point;
+        bottomRight: Point;
+        bottomLeft: Point;
+    };
+}

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

@@ -0,0 +1,52 @@
+/**
+ * @file Worker工具
+ * @description 提供Web Worker相关的工具函数
+ * @module utils/worker
+ */
+/**
+ * 检查是否支持Web Worker
+ * @returns 是否支持Web Worker
+ */
+export declare function isWorkerSupported(): boolean;
+/**
+ * 创建Worker
+ * @param workerFunction Worker函数
+ * @returns Worker实例
+ */
+export declare function createWorker<TInput, TOutput>(workerFunction: (input: TInput) => TOutput | Promise<TOutput>): {
+    postMessage: (input: TInput) => Promise<TOutput>;
+    terminate: () => void;
+};
+/**
+ * 工作线程池
+ * 用于管理和重用Worker线程，避免频繁创建和销毁
+ */
+export declare class WorkerPool<T, R> {
+    private workerFunction;
+    private size;
+    private workers;
+    /**
+     * 创建工作线程池
+     *
+     * @param workerFunction 要在Worker中执行的函数
+     * @param size 池中Worker的数量
+     */
+    constructor(workerFunction: (data: T) => Promise<R> | R, size?: number);
+    /**
+     * 获取一个可用的Worker
+     *
+     * @returns Worker包装对象
+     */
+    private getAvailableWorker;
+    /**
+     * 执行任务
+     *
+     * @param data 要处理的数据
+     * @returns 处理结果的Promise
+     */
+    execute(data: T): Promise<R>;
+    /**
+     * 终止所有Worker
+     */
+    terminate(): void;
+}

package/dist/types/version.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @file 版本号文件
+ * @description 定义库的版本号
+ * @module Version
+ */
+export declare const VERSION = "1.5.0";
+export declare const BUILD_DATE: string;