@mleonard9/vin-scanner 0.2.5 → 0.2.6

package/src/scanText.ts

@@ -16,21 +16,89 @@ const LINKING_ERROR: string =
   '- You rebuilt the app after installing the package\n' +
   '- You are not using Expo Go\n';
 
+const TEXT_BOX_STRIDE = 12;
+
+const toFloat32Array = (input: unknown): Float32Array | undefined => {
+  'worklet';
+  if (
+    input &&
+    typeof input === 'object' &&
+    'byteLength' in (input as ArrayBuffer)
+  ) {
+    try {
+      return new Float32Array(input as ArrayBuffer);
+    } catch {
+      return undefined;
+    }
+  }
+  return undefined;
+};
+
+const normalizeTextDetections = (payload: unknown): TextDetection[] => {
+  'worklet';
+  if (!payload) {
+    return [];
+  }
+  if (Array.isArray(payload)) {
+    return payload as TextDetection[];
+  }
+  const record = payload as {
+    detections?: Array<TextDetection & { boxIndex?: number }>;
+    boxes?: ArrayBuffer;
+  };
+  const detections = Array.isArray(record?.detections)
+    ? record.detections
+    : [];
+  const buffer = toFloat32Array(record?.boxes);
+  return detections.map((detection, index) => {
+    const output: TextDetection = { ...detection };
+    const boxIndex =
+      typeof detection?.boxIndex === 'number'
+        ? detection.boxIndex
+        : index;
+    if (buffer && boxIndex >= 0) {
+      const offset = boxIndex * TEXT_BOX_STRIDE;
+      if (offset + TEXT_BOX_STRIDE <= buffer.length) {
+        output.blockFrameTop = buffer[offset];
+        output.blockFrameBottom = buffer[offset + 1];
+        output.blockFrameLeft = buffer[offset + 2];
+        output.blockFrameRight = buffer[offset + 3];
+        output.lineFrameTop = buffer[offset + 4];
+        output.lineFrameBottom = buffer[offset + 5];
+        output.lineFrameLeft = buffer[offset + 6];
+        output.lineFrameRight = buffer[offset + 7];
+        output.elementFrameTop = buffer[offset + 8];
+        output.elementFrameBottom = buffer[offset + 9];
+        output.elementFrameLeft = buffer[offset + 10];
+        output.elementFrameRight = buffer[offset + 11];
+      }
+    }
+    return output;
+  });
+};
+
 export function createTextRecognitionPlugin(
   options: TextRecognitionOptions
 ): TextRecognitionPlugin {
   const plugin: FrameProcessorPlugin | undefined =
-    VisionCameraProxy.initFrameProcessorPlugin('scanText', {
+    VisionCameraProxy.initFrameProcessorPlugin('vinScannerText', {
       ...options,
     });
   if (!plugin) {
     throw new Error(LINKING_ERROR);
   }
   return {
-    scanText: (frame: Frame): TextDetection[] => {
+    scanText: (
+      frame: Frame,
+      overrides?: TextRecognitionOptions
+    ): TextDetection[] => {
       'worklet';
-      const result = plugin.call(frame);
-      return (Array.isArray(result) ? result : []) as TextDetection[];
+      const args =
+        overrides && Object.keys(overrides).length > 0
+          ? { ...options, ...overrides }
+          : options;
+      const result = plugin.call(frame, args);
+      return normalizeTextDetections(result);
     },
   };
 }

package/src/types.ts

@@ -25,6 +25,8 @@ export type BarcodeFormat =
 
 export type ScanBarcodeOptions = BarcodeFormat[];
 
+export type NativeBarcodeFormatMap = Partial<Record<BarcodeFormat, boolean>>;
+
 export type BarcodeDetection = {
   width?: number;
   height?: number;
@@ -121,6 +123,12 @@ export type DetectionOptions = {
   emitDuplicates?: boolean;
   includePartialVins?: boolean; // Allow detection of incomplete VINs (13-16 chars)
   minPartialLength?: number; // Minimum length for partial VINs (default: 13)
+  /**
+   * Maximum frame rate (in FPS) at which the frame processor should execute.
+   * Frames that arrive faster than this budget are dropped to keep the
+   * worklet responsive when ML Kit takes longer than the camera cadence.
+   */
+  maxFrameRate?: number;
 };
 
 export type VinScannerOptions = {
@@ -139,11 +147,17 @@ export type CameraTypes = {
 } & CameraProps;
 
 export type BarcodeScannerPlugin = {
-  scanBarcodes: (frame: Frame) => BarcodeDetection[] | undefined;
+  scanBarcodes: (
+    frame: Frame,
+    overrides?: NativeBarcodeFormatMap
+  ) => BarcodeDetection[] | undefined;
 };
 
 export type TextRecognitionPlugin = {
-  scanText: (frame: Frame) => TextDetection[] | undefined;
+  scanText: (
+    frame: Frame,
+    overrides?: TextRecognitionOptions
+  ) => TextDetection[] | undefined;
 };
 
 export type WorkletPayload = {

package/src/useVinScanner.ts

@@ -14,6 +14,7 @@ import {
 export function useVinScanner(options?: VinScannerOptions) {
   const resolvedOptions = useMemo(() => resolveOptions(options), [options]);
   const lastFingerprintRef = useRef<string | null | undefined>(undefined);
+  const lastFrameTimestampRef = useRef(0);
 
   const barcodeScanner = useMemo(() => {
     if (!resolvedOptions.barcode.enabled) {
@@ -43,12 +44,26 @@ export function useVinScanner(options?: VinScannerOptions) {
   const frameProcessor = useFrameProcessor(
     (frame: Frame) => {
       'worklet';
+      const now =
+        typeof frame?.timestamp === 'number' ? frame.timestamp : Date.now();
+      const maxFps = resolvedOptions.detection.maxFrameRate;
+      if (maxFps > 0) {
+        const minInterval = 1000 / maxFps;
+        if (
+          lastFrameTimestampRef.current > 0 &&
+          now - lastFrameTimestampRef.current < minInterval
+        ) {
+          return;
+        }
+        lastFrameTimestampRef.current = now;
+      }
+
       const barcodes = barcodeScanner ? barcodeScanner.scanBarcodes(frame) : [];
       const textBlocks = textScanner ? textScanner.scanText(frame) : [];
       const payload = {
         barcodes: barcodes ?? [],
         textBlocks: textBlocks ?? [],
-        timestamp: Date.now(),
+        timestamp: now,
       };
       const candidates = buildVinCandidates(payload, resolvedOptions);
       const best = pickBestCandidate(candidates, resolvedOptions);

package/src/vinUtils.ts

@@ -38,6 +38,7 @@ export type ResolvedVinScannerOptions = {
     resultMode: VinResultMode;
     includePartialVins: boolean;
     minPartialLength: number;
+    maxFrameRate: number;
   };
 };
 
@@ -57,6 +58,7 @@ const DEFAULT_RESOLVED_OPTIONS: ResolvedVinScannerOptions = {
     emitDuplicates: false,
     includePartialVins: false,
     minPartialLength: 13,
+    maxFrameRate: 30,
   },
 };
 
@@ -101,6 +103,9 @@ export const resolveOptions = (
       minPartialLength:
         options?.detection?.minPartialLength ??
         DEFAULT_RESOLVED_OPTIONS.detection.minPartialLength,
+      maxFrameRate:
+        options?.detection?.maxFrameRate ??
+        DEFAULT_RESOLVED_OPTIONS.detection.maxFrameRate,
     },
   };
 };