@hxa-rn/vision-camera-code-scanner 0.2.0

package/dist/typescript/index.d.ts

@@ -0,0 +1,301 @@
+import type { Code, CodeType, Frame } from 'react-native-vision-camera';
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.BarcodeFormat
+ */
+export declare enum BarcodeFormat {
+    UNKNOWN = -1,
+    ALL_FORMATS = 0,
+    CODE_128 = 1,
+    CODE_39 = 2,
+    CODE_93 = 4,
+    CODABAR = 8,
+    DATA_MATRIX = 16,
+    EAN_13 = 32,
+    EAN_8 = 64,
+    ITF = 128,
+    QR_CODE = 256,
+    UPC_A = 512,
+    UPC_E = 1024,
+    PDF417 = 2048,
+    AZTEC = 4096
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.BarcodeValueType
+ */
+export declare enum BarcodeValueType {
+    UNKNOWN = 0,
+    CONTACT_INFO = 1,
+    EMAIL = 2,
+    ISBN = 3,
+    PHONE = 4,
+    PRODUCT = 5,
+    SMS = 6,
+    TEXT = 7,
+    URL = 8,
+    WIFI = 9,
+    GEO = 10,
+    CALENDAR_EVENT = 11,
+    DRIVER_LICENSE = 12
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.Address.AddressType
+ */
+export declare enum AddressType {
+    UNKNOWN = 0,
+    WORK = 1,
+    HOME = 2
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.Address
+ */
+export interface Address {
+    addressLines?: string[];
+    type?: AddressType;
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.PersonName
+ */
+export interface PersonName {
+    first?: string;
+    formattedName?: string;
+    last?: string;
+    middle?: string;
+    prefix?: string;
+    pronunciation?: string;
+    suffix?: string;
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.ContactInfo
+ */
+export interface ContactInfo {
+    addresses?: Address[];
+    emails?: Email[];
+    name?: PersonName;
+    organization?: string;
+    phones?: Phone[];
+    title?: string;
+    urls?: string[];
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.Email.FormatType
+ */
+export declare enum EmailType {
+    UNKNOWN = 0,
+    WORK = 1,
+    HOME = 2
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.Email
+ */
+export interface Email {
+    address?: string;
+    body?: string;
+    subject?: string;
+    type?: EmailType;
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.Phone.FormatType
+ */
+export declare enum PhoneType {
+    UNKNOWN = 0,
+    WORK = 1,
+    HOME = 2,
+    FAX = 3,
+    MOBILE = 4
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.Phone
+ */
+export interface Phone {
+    number?: string;
+    type?: PhoneType;
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.Sms
+ */
+export interface Sms {
+    message?: string;
+    phoneNumber?: string;
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.UrlBookmark
+ */
+export interface UrlBookmark {
+    title?: string;
+    url?: string;
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.WiFi.EncryptionType
+ */
+export declare enum EncryptionType {
+    OPEN = 1,
+    WPA = 2,
+    WEP = 3
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.WiFi
+ */
+export interface Wifi {
+    encryptionType?: EncryptionType;
+    password?: string;
+    ssid?: string;
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.GeoPoint
+ */
+export interface GeoPoint {
+    lat?: number;
+    lng?: number;
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.CalendarDateTime
+ */
+export interface Date {
+    day: number;
+    hours: number;
+    minutes: number;
+    month: number;
+    rawValue: string;
+    seconds: number;
+    year: number;
+    isUtc: boolean;
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.CalendarEvent
+ */
+export interface CalendarEvent {
+    description?: string;
+    end?: Date;
+    location?: string;
+    organizer?: string;
+    start?: Date;
+    status?: string;
+    summary?: string;
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode.DriverLicense
+ */
+export interface DriverLicense {
+    addressCity?: string;
+    addressState?: string;
+    addressStreet?: string;
+    addressZip?: string;
+    birthDate?: string;
+    documentType?: string;
+    expiryDate?: string;
+    firstName?: string;
+    gender?: string;
+    issueDate?: string;
+    issuingCountry?: string;
+    lastName?: string;
+    licenseNumber?: string;
+    middleName?: string;
+}
+/**
+ * @see https://developer.android.com/reference/android/graphics/Rect.html
+ */
+export interface Rect {
+    bottom: number;
+    left: number;
+    right: number;
+    top: number;
+}
+/**
+ * @see https://developer.android.com/reference/android/graphics/Point.html
+ */
+export interface Point {
+    x: number;
+    y: number;
+}
+/**
+ * @see https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode
+ */
+export type Barcode = {
+    boundingBox?: Rect;
+    cornerPoints?: Point[];
+    displayValue?: string;
+    rawValue?: string;
+    format: BarcodeFormat;
+    content: {
+        type: BarcodeValueType.UNKNOWN | BarcodeValueType.ISBN | BarcodeValueType.TEXT;
+        data: string;
+    } | {
+        type: BarcodeValueType.CONTACT_INFO;
+        data: ContactInfo;
+    } | {
+        type: BarcodeValueType.EMAIL;
+        data: Email;
+    } | {
+        type: BarcodeValueType.PHONE;
+        data: Phone;
+    } | {
+        type: BarcodeValueType.SMS;
+        data: Sms;
+    } | {
+        type: BarcodeValueType.URL;
+        data: UrlBookmark;
+    } | {
+        type: BarcodeValueType.WIFI;
+        data: Wifi;
+    } | {
+        type: BarcodeValueType.GEO;
+        data: GeoPoint;
+    } | {
+        type: BarcodeValueType.CALENDAR_EVENT;
+        data: CalendarEvent;
+    } | {
+        type: BarcodeValueType.DRIVER_LICENSE;
+        data: DriverLicense;
+    };
+};
+export interface CodeScannerOptions {
+    /**
+     * checkInverted: `Allows you to also scan white barcode with black backgrounds`
+     *
+     * 注意：鸿蒙（HarmonyOS）Scan Kit 无图像反色识别选项，此选项在鸿蒙端被忽略。
+     */
+    checkInverted?: boolean;
+}
+/**
+ * 将 JS 层 BarcodeFormat[] 转换为 vision-camera codeScanner 需要的 CodeType[]。
+ *
+ * - 空数组或包含 ALL_FORMATS：返回空数组，触发 Scan Kit customScan 的 ALL 默认扫描。
+ * - 其余格式经 FORMAT_TO_CODE_TYPE 映射（含上游 off-by-one 补偿）。
+ *
+ * @internal
+ */
+export declare function mapFormatsToCodeTypes(types: BarcodeFormat[]): CodeType[];
+/**
+ * 将 vision-camera 扫码回调的 Code 转换为原 API 的 Barcode 类型。
+ *
+ * 鸿蒙 Scan Kit 的 ScanResult 仅提供 originalValue / scanCodeRect / cornerPoints，
+ * 无 MLKit/iOS Vision 的丰富结构化字段，因此 content 统一降级为
+ * `{ type: BarcodeValueType.TEXT, data: rawValue }`。
+ *
+ * @internal
+ */
+export declare function toBarcode(code: Code): Barcode;
+/**
+ * 按调用方请求的格式，归一化 UPC_A / EAN_13 上报结果。
+ *
+ * UPC_A 与「前导 0 的 EAN_13」条纹图案完全等价，Scan Kit / 多数扫码库常把 UPC_A
+ * 报成 EAN_13（13 位且以 0 开头），或把 EAN_13 报成 UPC_A（去掉前导 0）。
+ * 当请求格式仅包含其中一种时，按请求意图纠正 format 与数值，便于格式过滤用例验证。
+ *
+ * @internal
+ */
+export declare function normalizeReportedBarcode(barcode: Barcode, requestedTypes: BarcodeFormat[]): Barcode;
+/**
+ * Scans barcodes in the passed frame with MLKit
+ *
+ * @param frame Camera frame
+ * @param types Array of barcode types to detect (for optimal performance, use less types)
+ * @param options Scan options
+ * @returns Detected barcodes from MLKit
+ *
+ * 鸿蒙端不支持：Frame Processor 工作集机制在 @react-native-ohos/react-native-vision-camera v4
+ * 中不存在（不导出 useFrameProcessor / FrameProcessorPlugin）。此函数在鸿蒙端导出为抛错 stub，
+ * 请改用 `useScanBarcodes` 返回的 codeScanner 并传给 `<Camera codeScanner={...}>`。
+ */
+export declare function scanBarcodes(_frame: Frame, _types: BarcodeFormat[], _options?: CodeScannerOptions): Barcode[];
+export * from './hook';

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@hxa-rn/vision-camera-code-scanner",
+  "displayName": "@hxa-rn/vision-camera-code-scanner",
+  "version": "0.2.0",
+  "description": "VisionCamera Frame Processor Plugin to read barcodes using MLKit Vision Barcode Scanning",
+  "main": "./src/index.ts",
+  "module": "./src/index.ts",
+  "react-native": "./src/index.ts",
+  "types": "./src/index.ts",
+  "source": "./src/index.ts",
+  "license": "MIT",
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rodgomesc/vision-camera-code-scanner"
+  },
+  "keywords": [
+    "react-native",
+    "harmony",
+    "harmonyos"
+  ],
+  "homepage": "https://github.com/rodgomesc/vision-camera-code-scanner#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "files": [
+    "dist/",
+    "src/",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "prepare": "bob build"
+  },
+  "peerDependencies": {
+    "react-native": ">=0.72",
+    "react": "*",
+    "@react-native-ohos/react-native-vision-camera": "~4.0.3"
+  },
+  "devDependencies": {
+    "typescript": "5.0.4",
+    "@react-native/typescript-config": "0.79.5",
+    "react": "18.2.0",
+    "@types/react": "18.2.79",
+    "react-native": "0.72.5",
+    "react-native-vision-camera": "~4.0.3",
+    "jest": "^29.6.3",
+    "react-native-builder-bob": "^0.18.0",
+    "@react-native-oh/react-native-harmony-cli": "^0.77.50",
+    "metro": "^0.81.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "harmony": {
+    "alias": "vision-camera-code-scanner"
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "dist",
+    "targets": [
+      "commonjs",
+      "module",
+      "typescript"
+    ]
+  }
+}

package/src/hook.tsx

@@ -0,0 +1,49 @@
+import { Code, CodeScanner, CodeScannerFrame, useCodeScanner } from 'react-native-vision-camera';
+import { useCallback, useState } from 'react';
+
+import {
+  Barcode,
+  BarcodeFormat,
+  CodeScannerOptions,
+  mapFormatsToCodeTypes,
+  normalizeReportedBarcode,
+  toBarcode,
+} from '.';
+
+/**
+ * 鸿蒙端 useScanBarcodes 重实现。
+ *
+ * 鸿蒙版 @react-native-ohos/react-native-vision-camera v4 不提供 Frame Processor 机制
+ * （不导出 useFrameProcessor / FrameProcessorPlugin），但内置 useCodeScanner + Camera.codeScanner
+ * （底层为 Scan Kit customScan）。因此本 hook 基于 useCodeScanner 构造扫码器，在 onCodeScanned
+ * 回调中把 Code[] 转换为原 API 的 Barcode[]。
+ *
+ * ⚠️ API 变更：返回值从 `[frameProcessor, barcodes]` 变为 `[codeScanner, barcodes, clearBarcodes]`。
+ * 调用方需将 codeScanner 传给 `<Camera codeScanner={codeScanner}>`，而非 frameProcessor。
+ * 停止扫描时应调用 clearBarcodes()，避免下次开始扫描时把上次结果当作新识别上报。
+ *
+ * @param types 要检测的条码格式数组；包含 ALL_FORMATS 或为空数组时检测所有格式。
+ * @param options 扫描选项；checkInverted（反色条码）在鸿蒙端被忽略（Scan Kit 无反色识别选项）。
+ * @returns [codeScanner, barcodes, clearBarcodes]
+ */
+export function useScanBarcodes(
+  types: BarcodeFormat[],
+  _options?: CodeScannerOptions
+): [CodeScanner, Barcode[], () => void] {
+  const [barcodes, setBarcodes] = useState<Barcode[]>([]);
+
+  const clearBarcodes = useCallback(() => {
+    setBarcodes([]);
+  }, []);
+
+  const codeScanner = useCodeScanner({
+    codeTypes: mapFormatsToCodeTypes(types),
+    onCodeScanned: (codes: Code[], _frame: CodeScannerFrame) => {
+      setBarcodes(
+        codes.map((code) => normalizeReportedBarcode(toBarcode(code), types))
+      );
+    },
+  });
+
+  return [codeScanner, barcodes, clearBarcodes];
+}