@mleonard9/vin-scanner 0.1.1

package/src/vinUtils.ts

@@ -0,0 +1,368 @@
+import type {
+  BarcodeDetection,
+  DetectionOptions,
+  ScanBarcodeOptions,
+  TextDetection,
+  TextRecognitionLanguage,
+  VinCandidate,
+  VinResultMode,
+  VinScannerOptions,
+  WorkletPayload,
+} from './types';
+
+export type ResolvedVinScannerOptions = {
+  barcode: {
+    enabled: boolean;
+    formats: ScanBarcodeOptions;
+  };
+  text: {
+    enabled: boolean;
+    language: TextRecognitionLanguage;
+  };
+  detection: Required<DetectionOptions> & { resultMode: VinResultMode };
+};
+
+const DEFAULT_RESOLVED_OPTIONS: ResolvedVinScannerOptions = {
+  barcode: {
+    enabled: true,
+    formats: ['all'],
+  },
+  text: {
+    enabled: true,
+    language: 'latin',
+  },
+  detection: {
+    resultMode: 'best',
+    preferBarcode: true,
+    validateChecksum: true,
+    emitDuplicates: false,
+  },
+};
+
+export const resolveOptions = (
+  options?: VinScannerOptions
+): ResolvedVinScannerOptions => {
+  const resultMode: VinResultMode =
+    options?.detection?.resultMode ??
+    DEFAULT_RESOLVED_OPTIONS.detection.resultMode;
+  const emitDuplicates =
+    options?.detection?.emitDuplicates ??
+    (resultMode === 'all'
+      ? true
+      : DEFAULT_RESOLVED_OPTIONS.detection.emitDuplicates);
+
+  return {
+    barcode: {
+      enabled:
+        options?.barcode?.enabled ?? DEFAULT_RESOLVED_OPTIONS.barcode.enabled,
+      formats: options?.barcode?.formats?.length
+        ? [...options.barcode.formats]
+        : [...DEFAULT_RESOLVED_OPTIONS.barcode.formats],
+    },
+    text: {
+      enabled: options?.text?.enabled ?? DEFAULT_RESOLVED_OPTIONS.text.enabled,
+      language:
+        options?.text?.language ?? DEFAULT_RESOLVED_OPTIONS.text.language,
+    },
+    detection: {
+      resultMode,
+      preferBarcode:
+        options?.detection?.preferBarcode ??
+        DEFAULT_RESOLVED_OPTIONS.detection.preferBarcode,
+      validateChecksum:
+        options?.detection?.validateChecksum ??
+        DEFAULT_RESOLVED_OPTIONS.detection.validateChecksum,
+      emitDuplicates,
+    },
+  };
+};
+
+const VIN_PATTERN = /^[A-HJ-NPR-Z0-9]{17}$/;
+
+const transliteration: Record<string, number> = {
+  A: 1,
+  B: 2,
+  C: 3,
+  D: 4,
+  E: 5,
+  F: 6,
+  G: 7,
+  H: 8,
+  J: 1,
+  K: 2,
+  L: 3,
+  M: 4,
+  N: 5,
+  P: 7,
+  R: 9,
+  S: 2,
+  T: 3,
+  U: 4,
+  V: 5,
+  W: 6,
+  X: 7,
+  Y: 8,
+  Z: 9,
+};
+
+const weights = [8, 7, 6, 5, 4, 3, 2, 10, 0, 9, 8, 7, 6, 5, 4, 3, 2];
+
+const tokenizeCandidate = (value: string): string[] => {
+  if (!value) {
+    return [];
+  }
+  const normalized = value.toUpperCase();
+  const cleaned = normalized.replace(/[^A-Z0-9]/g, ' ');
+  const tokens = cleaned.split(/\s+/).filter((token) => token.length > 0);
+  const matches = new Set<string>();
+  tokens.forEach((token) => {
+    if (token.length < 17) {
+      return;
+    }
+    for (let i = 0; i <= token.length - 17; i += 1) {
+      const candidate = token.slice(i, i + 17);
+      if (VIN_PATTERN.test(candidate)) {
+        matches.add(candidate);
+      }
+    }
+  });
+  return Array.from(matches);
+};
+
+export const isValidVin = (value: string): boolean => {
+  if (!VIN_PATTERN.test(value)) {
+    return false;
+  }
+  const chars = value.split('');
+  let sum = 0;
+  for (let i = 0; i < chars.length; i += 1) {
+    const char = chars[i];
+    if (!char) {
+      return false;
+    }
+    const numeric = /^[0-9]$/.test(char)
+      ? Number.parseInt(char, 10)
+      : transliteration[char];
+    if (numeric === undefined) {
+      return false;
+    }
+    const weight = weights[i] ?? 0;
+    sum += numeric * weight;
+  }
+  const remainder = sum % 11;
+  const expected = remainder === 10 ? 'X' : remainder.toString();
+  const checkDigit = chars[8];
+  if (!checkDigit) {
+    return false;
+  }
+  return checkDigit === expected;
+};
+
+const toBoundingBox = (
+  candidate:
+    | Pick<
+        BarcodeDetection,
+        'top' | 'bottom' | 'left' | 'right' | 'width' | 'height'
+      >
+    | Pick<
+        TextDetection,
+        | 'blockFrameTop'
+        | 'blockFrameBottom'
+        | 'blockFrameLeft'
+        | 'blockFrameRight'
+        | 'lineFrameTop'
+        | 'lineFrameBottom'
+        | 'lineFrameLeft'
+        | 'lineFrameRight'
+        | 'elementFrameTop'
+        | 'elementFrameBottom'
+        | 'elementFrameLeft'
+        | 'elementFrameRight'
+      >,
+  preferred: 'block' | 'line' | 'element' | 'barcode'
+) => {
+  if (!candidate) {
+    return undefined;
+  }
+  if (preferred === 'barcode') {
+    const maybe = candidate as BarcodeDetection;
+    if (
+      typeof maybe.top === 'number' &&
+      typeof maybe.bottom === 'number' &&
+      typeof maybe.left === 'number' &&
+      typeof maybe.right === 'number'
+    ) {
+      return {
+        top: maybe.top,
+        bottom: maybe.bottom,
+        left: maybe.left,
+        right: maybe.right,
+        width: maybe.width,
+        height: maybe.height,
+      };
+    }
+  }
+
+  const block = candidate as TextDetection;
+  const blockBox =
+    typeof block.blockFrameTop === 'number' &&
+    typeof block.blockFrameBottom === 'number' &&
+    typeof block.blockFrameLeft === 'number' &&
+    typeof block.blockFrameRight === 'number'
+      ? {
+          top: block.blockFrameTop,
+          bottom: block.blockFrameBottom,
+          left: block.blockFrameLeft,
+          right: block.blockFrameRight,
+        }
+      : undefined;
+  const lineBox =
+    typeof block.lineFrameTop === 'number' &&
+    typeof block.lineFrameBottom === 'number' &&
+    typeof block.lineFrameLeft === 'number' &&
+    typeof block.lineFrameRight === 'number'
+      ? {
+          top: block.lineFrameTop,
+          bottom: block.lineFrameBottom,
+          left: block.lineFrameLeft,
+          right: block.lineFrameRight,
+        }
+      : undefined;
+  const elementBox =
+    typeof block.elementFrameTop === 'number' &&
+    typeof block.elementFrameBottom === 'number' &&
+    typeof block.elementFrameLeft === 'number' &&
+    typeof block.elementFrameRight === 'number'
+      ? {
+          top: block.elementFrameTop,
+          bottom: block.elementFrameBottom,
+          left: block.elementFrameLeft,
+          right: block.elementFrameRight,
+        }
+      : undefined;
+
+  if (preferred === 'element' && elementBox) {
+    return elementBox;
+  }
+  if (preferred === 'line' && lineBox) {
+    return lineBox;
+  }
+  return blockBox || lineBox || elementBox;
+};
+
+const candidateFromBarcode = (
+  detection: BarcodeDetection,
+  validateChecksum: boolean
+): VinCandidate[] => {
+  const values = new Set<string>();
+  tokenizeCandidate(detection.rawValue ?? '').forEach((value) =>
+    values.add(value)
+  );
+  tokenizeCandidate(detection.displayValue ?? '').forEach((value) =>
+    values.add(value)
+  );
+  const boundingBox = toBoundingBox(detection, 'barcode');
+  return Array.from(values).map((value) => {
+    const checksumValid = !validateChecksum || isValidVin(value);
+    return {
+      value,
+      source: 'barcode' as const,
+      confidence: checksumValid ? 0.95 : 0.8,
+      boundingBox,
+      origin: detection.displayValue ? 'displayValue' : 'rawValue',
+      rawPayload: detection,
+    };
+  });
+};
+
+const candidateFromText = (
+  detection: TextDetection,
+  validateChecksum: boolean
+): VinCandidate[] => {
+  const values = new Set<string>();
+  [
+    detection.lineText,
+    detection.elementText,
+    detection.blockText,
+    detection.resultText,
+  ].forEach((value) =>
+    tokenizeCandidate(value ?? '').forEach((v) => values.add(v))
+  );
+  const boundingBox =
+    toBoundingBox(detection, 'line') ??
+    toBoundingBox(detection, 'element') ??
+    toBoundingBox(detection, 'block');
+  return Array.from(values).map((value) => {
+    const checksumValid = !validateChecksum || isValidVin(value);
+    return {
+      value,
+      source: 'text' as const,
+      confidence: checksumValid ? 0.8 : 0.6,
+      boundingBox,
+      origin: detection.elementText
+        ? 'element'
+        : detection.lineText
+          ? 'line'
+          : 'block',
+      rawPayload: detection,
+    };
+  });
+};
+
+const dedupeCandidates = (candidates: VinCandidate[]): VinCandidate[] => {
+  const map = new Map<string, VinCandidate>();
+  candidates.forEach((candidate) => {
+    const key = [
+      candidate.value,
+      candidate.source,
+      candidate.boundingBox?.top ?? 'x',
+      candidate.boundingBox?.left ?? 'y',
+    ].join(':');
+    const existing = map.get(key);
+    if (!existing || existing.confidence < candidate.confidence) {
+      map.set(key, candidate);
+    }
+  });
+  return Array.from(map.values());
+};
+
+export const buildVinCandidates = (
+  payload: WorkletPayload,
+  options: ResolvedVinScannerOptions
+): VinCandidate[] => {
+  const list: VinCandidate[] = [];
+  if (options.barcode.enabled) {
+    (payload.barcodes ?? []).forEach((barcode) => {
+      list.push(
+        ...candidateFromBarcode(barcode, options.detection.validateChecksum)
+      );
+    });
+  }
+  if (options.text.enabled) {
+    (payload.textBlocks ?? []).forEach((textBlock) => {
+      list.push(
+        ...candidateFromText(textBlock, options.detection.validateChecksum)
+      );
+    });
+  }
+  return dedupeCandidates(list);
+};
+
+export const pickBestCandidate = (
+  candidates: VinCandidate[],
+  options: ResolvedVinScannerOptions
+): VinCandidate | null => {
+  if (!candidates.length) {
+    return null;
+  }
+  const sorted = [...candidates].sort((a, b) => {
+    if (a.confidence !== b.confidence) {
+      return b.confidence - a.confidence;
+    }
+    if (options.detection.preferBarcode && a.source !== b.source) {
+      return a.source === 'barcode' ? -1 : 1;
+    }
+    return 0;
+  });
+  return sorted[0] ?? null;
+};

package/vin-scanner.podspec

@@ -0,0 +1,28 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+folly_compiler_flags = '-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1 -Wno-comma -Wno-shorten-64-to-32'
+
+Pod::Spec.new do |s|
+  s.name         = "vin-scanner"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => min_ios_version_supported }
+  s.source       = { :git => "https://github.com/mleonard9/vin-scanner.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/**/*.{h,m,mm}"
+
+  s.dependency "React-Core"
+  s.dependency "VisionCamera"
+  s.dependency "GoogleMLKit/BarcodeScanning"
+  s.dependency "GoogleMLKit/TextRecognition"
+  s.dependency "GoogleMLKit/TextRecognitionChinese"
+  s.dependency "GoogleMLKit/TextRecognitionDevanagari"
+  s.dependency "GoogleMLKit/TextRecognitionJapanese"
+  s.dependency "GoogleMLKit/TextRecognitionKorean"
+
+end