id-scanner-lib 1.0.0 → 1.1.1

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

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

@@ -32,13 +32,13 @@ export interface CameraOptions {
  *
  * // 初始化相机
  * const videoElement = document.getElementById('video') as HTMLVideoElement;
- * await camera.initialize(videoElement);
+ * await camera.start(videoElement);
  *
  * // 捕获当前视频帧
  * const imageData = camera.captureFrame();
  *
  * // 使用结束后释放资源
- * camera.release();
+ * camera.stop();
  * ```
  */
 export declare class Camera {
@@ -47,30 +47,35 @@ export declare class Camera {
     private videoElement;
     /**
      * 创建相机实例
-     *
      * @param {CameraOptions} [options] - 相机配置选项
      */
     constructor(options?: CameraOptions);
     /**
-     * 初始化相机，请求摄像头权限并设置视频流
+     * 启动摄像头并将视频流绑定到视频元素
+     * @param videoElement HTML视频元素
+     * @returns Promise<void>
+     */
+    start(videoElement: HTMLVideoElement): Promise<void>;
+    /**
+     * 停止摄像头并释放资源
+     */
+    stop(): void;
+    /**
+     * 初始化相机，获取视频流并绑定到视频元素
      *
-     * @param {HTMLVideoElement} videoElement - 用于显示相机画面的video元素
+     * @param {HTMLVideoElement} videoElement - 用于显示视频流的视频元素
      * @returns {Promise<void>} 初始化完成的Promise
-     * @throws 如果无法访问相机，将抛出错误
+     * @throws 如果无法访问摄像头，将抛出错误
      */
     initialize(videoElement: HTMLVideoElement): Promise<void>;
     /**
-     * 获取当前视频帧
-     *
-     * 捕获当前视频画面并转换为ImageData对象，可用于图像处理和分析
+     * 捕获当前视频帧
      *
-     * @returns {ImageData|null} 当前视频帧的ImageData对象，如果未初始化视频则返回null
+     * @returns {ImageData|null} 视频帧的ImageData对象，如果未初始化则返回null
      */
     captureFrame(): ImageData | null;
     /**
-     * 释放相机资源
-     *
-     * 停止所有视频流轨道并清理资源。在不再需要相机时应调用此方法。
+     * 释放摄像头资源
      */
     release(): void;
 }

package/dist/utils/types.d.ts

@@ -1,6 +1,6 @@
 /**
  * @file 类型定义文件
- * @description 定义库中使用的公共类型和接口
+ * @description 定义全局类型
  * @module Types
  */
 /**
@@ -30,11 +30,11 @@ export interface DetectionResult {
  *
  * @interface IDCardInfo
  * @property {string} [name] - 姓名
- * @property {string} [gender] - 性别，通常为"男"或"女"
- * @property {string} [nationality] - 民族，如"汉族"、"满族"等
- * @property {string} [birthDate] - 出生日期，格式为"YYYY-MM-DD"
- * @property {string} [address] - 住址
- * @property {string} [idNumber] - 身份证号码，18位
+ * @property {string} [gender] - 性别
+ * @property {string} [nationality] - 民族
+ * @property {string} [birthDate] - 出生日期
+ * @property {string} [address] - 地址
+ * @property {string} [idNumber] - 身份证号码
  * @property {string} [issuingAuthority] - 签发机关
  * @property {string} [validPeriod] - 有效期限
  *

package/package.json

@@ -1,15 +1,36 @@
 {
   "name": "id-scanner-lib",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "type": "module",
   "main": "dist/id-scanner.js",
-  "module": "dist/id-scanner.esm.js",
-  "types": "dist/index.d.ts",
+  "module": "dist/id-scanner-core.esm.js",
+  "exports": {
+    ".": {
+      "import": "./dist/id-scanner-core.esm.js",
+      "require": "./dist/id-scanner.js"
+    },
+    "./core": {
+      "import": "./dist/id-scanner-core.esm.js",
+      "require": "./dist/id-scanner-core.js"
+    },
+    "./ocr": {
+      "import": "./dist/id-scanner-ocr.esm.js",
+      "require": "./dist/id-scanner-ocr.js"
+    },
+    "./qr": {
+      "import": "./dist/id-scanner-qr.esm.js",
+      "require": "./dist/id-scanner-qr.js"
+    }
+  },
+  "types": "dist/types/index.d.ts",
+  "sideEffects": false,
   "scripts": {
     "build": "rollup -c",
     "dev": "rollup -c -w",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "publish:npm": "node scripts/publish.js",
+    "update:github": "node scripts/update-github.js"
   },
   "keywords": [
     "id-card",

package/src/core.ts

@@ -0,0 +1,138 @@
+/**
+ * @file 轻量级扫描库核心
+ * @description 不包含OCR功能的轻量版，只提供二维码和条形码扫描功能
+ * @module IDScannerCore
+ * @version 1.0.0
+ * @license MIT
+ */
+
+import { QRScanner, QRScannerOptions } from './scanner/qr-scanner';
+import { BarcodeScanner, BarcodeScannerOptions } from './scanner/barcode-scanner';
+import { Camera, CameraOptions } from './utils/camera';
+import { ImageProcessor } from './utils/image-processing';
+
+/**
+ * IDScannerCore配置选项
+ */
+export interface IDScannerCoreOptions {
+  cameraOptions?: CameraOptions;
+  qrScannerOptions?: QRScannerOptions;
+  barcodeScannerOptions?: BarcodeScannerOptions;
+  onQRCodeScanned?: (result: string) => void;
+  onBarcodeScanned?: (result: string) => void;
+  onError?: (error: Error) => void;
+}
+
+/**
+ * IDScannerCore 轻量级扫描类
+ * 
+ * 提供二维码和条形码扫描功能，不包含OCR身份证识别功能
+ */
+export class IDScannerCore {
+  private qrScanner: QRScanner;
+  private barcodeScanner: BarcodeScanner;
+  private camera: Camera;
+  private scanMode: 'qr' | 'barcode' = 'qr';
+  private videoElement: HTMLVideoElement | null = null;
+  
+  /**
+   * 构造函数
+   * @param options 配置选项
+   */
+  constructor(private options: IDScannerCoreOptions = {}) {
+    this.camera = new Camera(options.cameraOptions);
+    this.qrScanner = new QRScanner({
+      ...options.qrScannerOptions,
+      onScan: this.handleQRScan.bind(this)
+    });
+    this.barcodeScanner = new BarcodeScanner({
+      ...options.barcodeScannerOptions,
+      onScan: this.handleBarcodeScan.bind(this)
+    });
+  }
+  
+  /**
+   * 初始化扫描器
+   */
+  async initialize(): Promise<void> {
+    // 轻量版无需初始化OCR引擎
+    console.log('IDScannerCore initialized');
+  }
+  
+  /**
+   * 启动二维码扫描
+   * @param videoElement HTML视频元素
+   */
+  async startQRScanner(videoElement: HTMLVideoElement): Promise<void> {
+    this.videoElement = videoElement;
+    this.scanMode = 'qr';
+    await this.camera.start(videoElement);
+    this.qrScanner.start(videoElement);
+  }
+  
+  /**
+   * 启动条形码扫描
+   * @param videoElement HTML视频元素
+   */
+  async startBarcodeScanner(videoElement: HTMLVideoElement): Promise<void> {
+    this.videoElement = videoElement;
+    this.scanMode = 'barcode';
+    await this.camera.start(videoElement);
+    this.barcodeScanner.start(videoElement);
+  }
+  
+  /**
+   * 停止扫描
+   */
+  stop(): void {
+    if (this.scanMode === 'qr') {
+      this.qrScanner.stop();
+    } else if (this.scanMode === 'barcode') {
+      this.barcodeScanner.stop();
+    }
+    this.camera.stop();
+  }
+  
+  /**
+   * 处理二维码扫描结果
+   */
+  private handleQRScan(result: string): void {
+    if (this.options.onQRCodeScanned) {
+      this.options.onQRCodeScanned(result);
+    }
+  }
+  
+  /**
+   * 处理条形码扫描结果
+   */
+  private handleBarcodeScan(result: string): void {
+    if (this.options.onBarcodeScanned) {
+      this.options.onBarcodeScanned(result);
+    }
+  }
+  
+  /**
+   * 处理错误
+   */
+  private handleError(error: Error): void {
+    if (this.options.onError) {
+      this.options.onError(error);
+    } else {
+      console.error('IDScannerCore error:', error);
+    }
+  }
+  
+  /**
+   * 释放资源
+   */
+  async terminate(): Promise<void> {
+    this.stop();
+    // 轻量版无需释放OCR资源
+  }
+}
+
+// 导出相关类型和工具
+export { QRScanner, QRScannerOptions } from './scanner/qr-scanner';
+export { BarcodeScanner, BarcodeScannerOptions } from './scanner/barcode-scanner';
+export { Camera, CameraOptions } from './utils/camera';
+export { ImageProcessor } from './utils/image-processing'; 

package/src/id-recognition/data-extractor.ts

@@ -162,4 +162,101 @@ export class DataExtractor {
     
     return result;
   }
+  
+  /**
+   * 提取并验证身份证信息
+   * 
+   * @param idCardInfo 初步提取的身份证信息
+   * @returns 验证和增强后的身份证信息
+   */
+  extractAndValidate(idCardInfo: IDCardInfo): IDCardInfo {
+    const enhancedInfo = {...idCardInfo};
+    
+    // 验证和规范化身份证号
+    if (enhancedInfo.idNumber) {
+      enhancedInfo.idNumber = this.normalizeIDNumber(enhancedInfo.idNumber);
+      
+      // 如果身份证号有效，推断出生日期
+      if (this.validateIDNumber(enhancedInfo.idNumber)) {
+        if (!enhancedInfo.birthDate) {
+          enhancedInfo.birthDate = this.extractBirthDateFromID(enhancedInfo.idNumber);
+        }
+        
+        // 推断性别
+        if (!enhancedInfo.gender) {
+          enhancedInfo.gender = this.extractGenderFromID(enhancedInfo.idNumber);
+        }
+      }
+    }
+    
+    // 规范化日期格式
+    if (enhancedInfo.birthDate) {
+      enhancedInfo.birthDate = this.normalizeDate(enhancedInfo.birthDate);
+    }
+    
+    // 规范化地址信息
+    if (enhancedInfo.address) {
+      enhancedInfo.address = this.normalizeAddress(enhancedInfo.address);
+    }
+    
+    return enhancedInfo;
+  }
+  
+  /**
+   * 规范化身份证号码
+   */
+  private normalizeIDNumber(idNumber: string): string {
+    // 移除空格和特殊字符
+    return idNumber.replace(/[\s\-]/g, '').toUpperCase();
+  }
+  
+  /**
+   * 验证身份证号码是否有效
+   */
+  private validateIDNumber(idNumber: string): boolean {
+    // 简单验证身份证号码长度和格式
+    const idRegex = /(^\d{15}$)|(^\d{17}([0-9]|X)$)/;
+    return idRegex.test(idNumber);
+  }
+  
+  /**
+   * 从身份证号中提取出生日期
+   */
+  private extractBirthDateFromID(idNumber: string): string {
+    if (idNumber.length === 18) {
+      return `${idNumber.substring(6, 10)}-${idNumber.substring(10, 12)}-${idNumber.substring(12, 14)}`;
+    } else if (idNumber.length === 15) {
+      return `19${idNumber.substring(6, 8)}-${idNumber.substring(8, 10)}-${idNumber.substring(10, 12)}`;
+    }
+    return '';
+  }
+  
+  /**
+   * 从身份证号中提取性别信息
+   */
+  private extractGenderFromID(idNumber: string): string {
+    let sexCode: number;
+    if (idNumber.length === 18) {
+      sexCode = parseInt(idNumber.charAt(16));
+    } else {
+      sexCode = parseInt(idNumber.charAt(14));
+    }
+    return sexCode % 2 === 1 ? '男' : '女';
+  }
+  
+  /**
+   * 规范化日期格式
+   */
+  private normalizeDate(date: string): string {
+    // 简单的日期格式化逻辑
+    return date.replace(/(\d{4})(\d{2})(\d{2})/, '$1-$2-$3');
+  }
+  
+  /**
+   * 规范化地址信息
+   */
+  private normalizeAddress(address: string): string {
+    // 地址格式化逻辑
+    return address.trim();
+  }
 } 

package/src/id-recognition/id-detector.ts

@@ -8,6 +8,15 @@ import { Camera } from '../utils/camera';
 import { ImageProcessor } from '../utils/image-processing';
 import { DetectionResult } from '../utils/types';
 
+/**
+ * IDCardDetector配置选项
+ */
+export interface IDCardDetectorOptions {
+  onDetection?: (result: DetectionResult) => void;
+  onError?: (error: Error) => void;
+  detectionInterval?: number;
+}
+
 /**
  * 身份证检测器类
  * 
@@ -37,14 +46,23 @@ export class IDCardDetector {
   private camera: Camera;
   private detecting = false;
   private detectTimer: number | null = null;
+  private onDetected?: (result: DetectionResult) => void;
   
   /**
    * 创建身份证检测器实例
    * 
-   * @param {Function} [onDetected] - 身份证检测成功回调函数，接收检测结果对象
+   * @param options 身份证检测器配置选项，或者检测回调函数
    */
-  constructor(private onDetected?: (result: DetectionResult) => void) {
+  constructor(options?: IDCardDetectorOptions | ((result: DetectionResult) => void)) {
     this.camera = new Camera();
+    
+    if (typeof options === 'function') {
+      // 兼容旧的构造函数方式
+      this.onDetected = options;
+    } else if (options) {
+      // 使用新的选项对象方式
+      this.onDetected = options.onDetection;
+    }
   }
   
   /**

package/src/id-recognition/ocr-processor.ts

@@ -56,11 +56,8 @@ export class OCRProcessor {
   
   /**
    * 处理身份证图像并提取信息
-   * 
-   * 对身份证图像进行OCR识别，并从识别结果中提取结构化信息
-   * 
-   * @param {ImageData} imageData - 身份证图像数据
-   * @returns {Promise<IDCardInfo>} 提取到的身份证信息
+   * @param imageData 要处理的身份证图像数据
+   * @returns 提取的身份证信息
    */
   async processIDCard(imageData: ImageData): Promise<IDCardInfo> {
     if (!this.worker) {
@@ -81,7 +78,7 @@ export class OCRProcessor {
       return this.parseIDCardText(data.text);
     } catch (error) {
       console.error('OCR识别错误:', error);
-      return {}; // 返回空对象
+      return {} as IDCardInfo;
     }
   }