@exige/web-scanner-sdk 0.2.28 → 0.2.29

package/dist/index.d.ts

@@ -17,6 +17,12 @@ export { createFinderSimulator, simulatorQuad } from './sdk/finder-simulator';
 export type { FinderSimulator, SimulatorPose } from './sdk/finder-simulator';
 export { recognizeText } from './sdk/ocr';
 export type { OcrOptions } from './sdk/ocr';
+export { decodePdf417, pdf417BarcodeDetectorSupported, } from './sdk/barcode';
+export type { Pdf417DecodeResult, Pdf417DecodeSource } from './sdk/barcode';
+export { parseAamvaDate, parseAamvaPayload, } from './sdk/aamva';
+export type { AamvaParseResult, DriverLicenseFieldKey, DriverLicenseFieldSource, DriverLicenseFields, ScanUseCase, } from './sdk/aamva';
+export { driverLicenseFieldsFromOcr, driverLicensePrompt, mergeDriverLicenseFields, startDriverLicenseSession, } from './sdk/driver-license';
+export type { DriverLicenseResult, DriverLicenseSession, DriverLicenseSessionOptions, DriverLicenseStatus, DriverLicenseStep, } from './sdk/driver-license';
 export { applyRedactions } from './sdk/redact';
 export type { RedactResult } from './sdk/redact';
 export { matchRedactionRules, redactProgrammatically } from './sdk/programmatic-redaction';

package/dist/react/context.d.ts

@@ -1,2 +1,2 @@
 import type { ScannerProviderProps } from './types';
-export declare function ScannerProvider({ open, autoCapture, captureMode, torch, onCapture, onCancel, onError, onSettings, onFinderStatus, modelUrl, ortWasmPaths, detectionIntervalMs, apiRef, children, }: ScannerProviderProps): import("react").JSX.Element;
+export declare function ScannerProvider({ open, useCase, autoCapture, captureMode, torch, onCapture, onDriverLicense, onCancel, onError, onSettings, onFinderStatus, modelUrl, ortWasmPaths, detectionIntervalMs, apiRef, children, }: ScannerProviderProps): import("react").JSX.Element;

package/dist/react/types.d.ts

@@ -2,9 +2,12 @@ import type { ReactNode, RefObject } from 'react';
 import type { CSSProperties } from 'react';
 import type { CameraDiagnostics, CameraPhoto, CaptureMode, TorchMode } from '../sdk/camera';
 import type { AutoCaptureMode, FinderCapture, FinderStatus } from '../sdk/finder';
+import type { ScanUseCase } from '../sdk/aamva';
+import type { DriverLicenseResult } from '../sdk/driver-license';
 import type { ModelDownloadSnapshot } from '../sdk/model-download';
 import type { OrtWasmPaths } from '../sdk/ort-runtime';
 import type { DocumentQuad } from '../sdk/types';
+export type { ScanUseCase, DriverLicenseResult };
 export type ScannerPhase = 'starting' | 'ready' | 'capturing' | 'captured' | 'error';
 export interface ScannerCapture extends FinderCapture {
     method: CameraPhoto['method'];
@@ -81,6 +84,12 @@ export interface ScannerState {
      * or starts a new capture.
      */
     frozenPreviewUrl?: string;
+    /** Present when `useCase` is `drivers-license`. */
+    useCase: ScanUseCase;
+    /** Current side of a driver’s license session. */
+    licenseSide?: 'front' | 'back';
+    /** True while OCR or PDF417 decode is running. */
+    licenseBusy?: boolean;
 }
 export interface ScannerApi {
     capture: () => Promise<void>;
@@ -94,6 +103,12 @@ export interface ScannerApi {
 /** The provider asserts the scan license before it starts the camera. */
 export interface ScannerProviderProps {
     open: boolean;
+    /**
+     * `document` (default) captures one still and calls `onCapture`.
+     * `drivers-license` captures front then back and calls `onDriverLicense`.
+     * It does not call `onCapture`.
+     */
+    useCase?: ScanUseCase;
     autoCapture?: AutoCaptureMode;
     /**
      * How the overlay captures. Default `auto`: when `open` becomes true
@@ -110,11 +125,17 @@ export interface ScannerProviderProps {
     /** Camera torch policy. Defaults to `defaultOff`. */
     torch?: TorchMode;
     /**
-     * Receives the high-resolution frame after a successful capture.
+     * Receives the high-resolution frame after a successful document capture.
+     * Unused when `useCase` is `drivers-license`.
      * The preview freezes on that still. The provider does not unmount or
      * stop the session. The host dismisses with `onCancel` or `open={false}`.
      */
-    onCapture: (capture: ScannerCapture) => void | Promise<void>;
+    onCapture?: (capture: ScannerCapture) => void | Promise<void>;
+    /**
+     * One structured license after the back barcode is decoded (or after a
+     * terminal barcode miss). Required for a useful `drivers-license` session.
+     */
+    onDriverLicense?: (result: DriverLicenseResult) => void | Promise<void>;
     /**
      * Called when Cancel or Close is tapped. The camera stays mounted.
      * The host dismisses it. Camera and finder sessions stop when the provider unmounts

package/dist/react.d.ts

@@ -1,4 +1,4 @@
 export { ScannerProvider } from './react/context';
 export { useScanner, useScannerRef } from './react/hooks';
 export { ScannerControls, ScannerDiagnostics, ScannerFrame, ScannerModelDownload, ScannerNotice, ScannerPreview, ScannerQuad, ScannerStatus, ScannerTopBar, } from './react/parts';
-export type { CaptureMode, ScannerApi, ScannerCapture, ScannerFrameProps, ScannerPhase, ScannerProviderProps, ScannerState, ScannerTheme, } from './react/types';
+export type { CaptureMode, DriverLicenseResult, ScanUseCase, ScannerApi, ScannerCapture, ScannerFrameProps, ScannerPhase, ScannerProviderProps, ScannerState, ScannerTheme, } from './react/types';