@exige/web-scanner-sdk 0.2.39 → 0.2.42

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,7 +3,7 @@ import '../components/scanner-camera-overlay.css';
3
3
  import type { ScannerFrameProps } from './types';
4
4
  export declare function ScannerFrame({ theme, style, title, children }: ScannerFrameProps): import("react").JSX.Element | null;
5
5
  export declare function ScannerPreview(): import("react").JSX.Element;
6
- export declare function ScannerQuad(): import("react").JSX.Element | null;
6
+ export declare function ScannerQuad(): import("react").JSX.Element;
7
7
  export declare function ScannerTopBar({ title }: {
8
8
  title?: string;
9
9
  }): import("react").JSX.Element;
@@ -43,7 +43,7 @@ export interface ScannerTheme {
43
43
  unstableColorHex?: string;
44
44
  /**
45
45
  * Finder box, status dot, and copy-report focus ring when the document is
46
- * ready, including the 3–2–1 hold-still. Default `#8af25a`.
46
+ * ready, including the hold-still. Default `#8af25a`.
47
47
  */
48
48
  readyColorHex?: string;
49
49
  /**
@@ -63,12 +63,14 @@ export interface ScannerState {
63
63
  displayQuad?: DocumentQuad;
64
64
  /**
65
65
  * Source size for a zxing PDF417 box on the license back.
66
- * Present only while that green hit is showing.
66
+ * Present while that barcode quad is showing next to the document box.
67
67
  */
68
68
  barcodeOverlay?: {
69
69
  width: number;
70
70
  height: number;
71
71
  };
72
+ /** ZXing PDF417 quad in `barcodeOverlay` pixels. */
73
+ barcodeQuad?: DocumentQuad;
72
74
  previewSize: {
73
75
  width: number;
74
76
  height: number;
@@ -94,7 +96,7 @@ export interface ScannerState {
94
96
  frozenPreviewUrl?: string;
95
97
  /** Present when `useCase` is `drivers-license`. */
96
98
  useCase: ScanUseCase;
97
- /** Current side of a driver’s license session. `flip` is the brief between-sides cue. */
99
+ /** Current side of a driver’s license session. `flip` is the between-sides dialog. */
98
100
  licenseSide?: 'front' | 'back' | 'flip';
99
101
  /** True while OCR or PDF417 decode is running. */
100
102
  licenseBusy?: boolean;
@@ -103,6 +105,8 @@ export interface ScannerApi {
103
105
  capture: () => Promise<void>;
104
106
  cancel: () => void;
105
107
  retry: () => void;
108
+ /** Dismiss the flip-to-back dialog and start the barcode session. */
109
+ continueLicenseFlip: () => void;
106
110
  setTorch: (enabled: boolean) => Promise<void>;
107
111
  setAutoCapture: (enabled: boolean) => void;
108
112
  copyReport: () => Promise<void>;