@switchlabs/verify-ai-react-native 2.4.11 → 2.4.15

package/README.md

@@ -56,15 +56,32 @@ function ScannerScreen() {
   const { verify } = useVerifyAI({ apiKey: 'vai_your_api_key' });
   return (
     <VerifyAIScanner
+      policy="scooter_parking"
       onCapture={(base64) =>
         verify({ image: base64, policy: 'scooter_parking' })
       }
       onResult={(result) => console.log(result.is_compliant ? 'PASS' : 'FAIL')}
+      onClose={(result) => console.log('closed', result?.id)}
+      showCloseButton
+      overlay={{
+        instructions: 'Center the scooter in the frame',
+        processingMessage: 'Checking parking compliance...',
+        failureMessage: 'Parking issue detected',
+        retryMessage: 'Try again. {remaining} attempts left.',
+        terminalResultDisplayMs: 3000,
+        terminalActionLabel: 'Continue',
+      }}
     />
   );
 }
 ```
 
+Passing `policy` enables policy-aware default copy and guide overlays for
+`scooter`, `bike`, and `forest` parking policies. Override copy through
+`overlay.instructions`, `processingMessage`, `successMessage`, `failureMessage`,
+`retryMessage`, `exhaustedMessage`, `terminalActionLabel`, and
+`terminalResultDisplayMs`.
+
 ## Offline Mode
 
 Requires `@react-native-async-storage/async-storage` to be installed.

package/lib/components/VerifyAIScanner.d.ts

@@ -5,16 +5,22 @@ import type { TelemetryReporter } from '../telemetry/TelemetryReporter';
 export interface VerifyAIScannerProps {
     /** Called with base64 image data when the user captures a photo. */
     onCapture: (base64: string) => Promise<VerificationResult | null>;
+    /** Optional policy ID used for policy-aware default scanner copy. */
+    policy?: string;
     /** Called when a terminal verification result is reached. */
     onResult?: (result: VerificationResult) => void;
     /** Called when an error occurs. */
     onError?: (error: Error) => void;
+    /** Called when the user presses the persistent close button. */
+    onClose?: (result: VerificationResult | null) => void;
     /** Overlay configuration for the camera view. */
     overlay?: ScannerOverlayConfig;
     /** Custom style for the container. */
     style?: ViewStyle;
     /** Whether to show the default capture button. Set false to use your own. */
     showCaptureButton?: boolean;
+    /** Whether to show the persistent close button. */
+    showCloseButton?: boolean;
     /** Ref to imperatively trigger capture from parent. */
     captureRef?: React.MutableRefObject<(() => void) | null>;
     /** Whether to enable the camera torch/flashlight. */
@@ -43,4 +49,4 @@ export interface VerifyAIScannerProps {
  * />
  * ```
  */
-export declare function VerifyAIScanner({ onCapture, onResult, onError, overlay, style, showCaptureButton, captureRef, enableTorch, telemetry: telemetryProp, }: VerifyAIScannerProps): import("react/jsx-runtime").JSX.Element;
+export declare function VerifyAIScanner({ onCapture, policy, onResult, onError, onClose, overlay: overlayProp, style, showCaptureButton, showCloseButton, captureRef, enableTorch, telemetry: telemetryProp, }: VerifyAIScannerProps): import("react/jsx-runtime").JSX.Element;