id-scanner-lib 1.2.2 → 1.3.2

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

@@ -1,81 +0,0 @@
-/**
- * @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

@@ -1,75 +0,0 @@
-/**
- * @file 图像处理工具类
- * @description 提供图像处理相关的辅助功能
- * @module ImageProcessor
- */
-/**
- * 图像处理工具类
- *
- * 提供常用的图像处理功能，如亮度和对比度调整、灰度转换、图像大小调整等。
- * 这些功能可用于增强图像质量，提高OCR和扫描的识别率。
- *
- * @example
- * ```typescript
- * // 使用图像处理功能增强图像
- * const enhancedImage = ImageProcessor.adjustBrightnessContrast(
- *   originalImageData,
- *   15,  // 增加亮度
- *   25   // 增加对比度
- * );
- *
- * // 转换为灰度图像
- * const grayImage = ImageProcessor.toGrayscale(originalImageData);
- * ```
- */
-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} imageData - 要处理的图像数据
-     * @param {number} [brightness=0] - 亮度调整值，正值增加亮度，负值降低亮度，范围建议为-100到100
-     * @param {number} [contrast=0] - 对比度调整值，正值增加对比度，负值降低对比度，范围建议为-100到100
-     * @returns {ImageData} 处理后的图像数据
-     */
-    static adjustBrightnessContrast(imageData: ImageData, brightness?: number, contrast?: number): ImageData;
-    /**
-     * 确保值在0-255范围内
-     *
-     * @private
-     * @param {number} value - 要截断的值
-     * @returns {number} 截断后的值，范围为0-255
-     */
-    private static truncate;
-    /**
-     * 将彩色图像转换为灰度图像
-     *
-     * 灰度转换可以简化图像，提高OCR和条形码识别的准确率
-     *
-     * @param {ImageData} imageData - 要转换的彩色图像
-     * @returns {ImageData} 转换后的灰度图像
-     */
-    static toGrayscale(imageData: ImageData): ImageData;
-    /**
-     * 调整图像大小
-     *
-     * @param {ImageData} imageData - 原图像数据
-     * @param {number} newWidth - 新宽度
-     * @param {number} newHeight - 新高度
-     * @returns {ImageData} 调整大小后的图像数据
-     */
-    static resize(imageData: ImageData, newWidth: number, newHeight: number): ImageData;
-}

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

@@ -1,65 +0,0 @@
-/**
- * @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] - 裁剪后的身份证图像
- */
-export interface DetectionResult {
-    success: boolean;
-    corners?: {
-        x: number;
-        y: number;
-    }[];
-    croppedImage?: ImageData;
-}
-/**
- * 身份证信息接口
- *
- * 包含从身份证中提取的各项个人信息
- *
- * @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;
-    nationality?: string;
-    birthDate?: string;
-    address?: string;
-    idNumber?: string;
-    issuingAuthority?: string;
-    validPeriod?: string;
-}

package/dist/utils/camera.d.ts

@@ -1,81 +0,0 @@
-/**
- * @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/utils/image-processing.d.ts

@@ -1,75 +0,0 @@
-/**
- * @file 图像处理工具类
- * @description 提供图像处理相关的辅助功能
- * @module ImageProcessor
- */
-/**
- * 图像处理工具类
- *
- * 提供常用的图像处理功能，如亮度和对比度调整、灰度转换、图像大小调整等。
- * 这些功能可用于增强图像质量，提高OCR和扫描的识别率。
- *
- * @example
- * ```typescript
- * // 使用图像处理功能增强图像
- * const enhancedImage = ImageProcessor.adjustBrightnessContrast(
- *   originalImageData,
- *   15,  // 增加亮度
- *   25   // 增加对比度
- * );
- *
- * // 转换为灰度图像
- * const grayImage = ImageProcessor.toGrayscale(originalImageData);
- * ```
- */
-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} imageData - 要处理的图像数据
-     * @param {number} [brightness=0] - 亮度调整值，正值增加亮度，负值降低亮度，范围建议为-100到100
-     * @param {number} [contrast=0] - 对比度调整值，正值增加对比度，负值降低对比度，范围建议为-100到100
-     * @returns {ImageData} 处理后的图像数据
-     */
-    static adjustBrightnessContrast(imageData: ImageData, brightness?: number, contrast?: number): ImageData;
-    /**
-     * 确保值在0-255范围内
-     *
-     * @private
-     * @param {number} value - 要截断的值
-     * @returns {number} 截断后的值，范围为0-255
-     */
-    private static truncate;
-    /**
-     * 将彩色图像转换为灰度图像
-     *
-     * 灰度转换可以简化图像，提高OCR和条形码识别的准确率
-     *
-     * @param {ImageData} imageData - 要转换的彩色图像
-     * @returns {ImageData} 转换后的灰度图像
-     */
-    static toGrayscale(imageData: ImageData): ImageData;
-    /**
-     * 调整图像大小
-     *
-     * @param {ImageData} imageData - 原图像数据
-     * @param {number} newWidth - 新宽度
-     * @param {number} newHeight - 新高度
-     * @returns {ImageData} 调整大小后的图像数据
-     */
-    static resize(imageData: ImageData, newWidth: number, newHeight: number): ImageData;
-}

package/dist/utils/types.d.ts

@@ -1,65 +0,0 @@
-/**
- * @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] - 裁剪后的身份证图像
- */
-export interface DetectionResult {
-    success: boolean;
-    corners?: {
-        x: number;
-        y: number;
-    }[];
-    croppedImage?: ImageData;
-}
-/**
- * 身份证信息接口
- *
- * 包含从身份证中提取的各项个人信息
- *
- * @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;
-    nationality?: string;
-    birthDate?: string;
-    address?: string;
-    idNumber?: string;
-    issuingAuthority?: string;
-    validPeriod?: string;
-}