idmission-web-sdk 1.0.381 → 1.0.382

package/dist/components/camera/CameraProvider.d.ts

@@ -1,14 +1,27 @@
-import React, { ReactElement } from 'react';
-import { CaptureDevice } from '../../lib/camera/Camera';
-export declare const CameraStateContext: React.Context<CaptureDevice>;
+import React, { MutableRefObject, ReactElement } from 'react';
+import { Camera } from '../../lib/camera/Camera';
+export type CameraState = {
+    videoRef: MutableRefObject<HTMLVideoElement | null>;
+    videoLoaded: boolean;
+    setVideoLoaded: (value: boolean) => void;
+    cameraRef: MutableRefObject<Camera | null>;
+    cameraReady: boolean;
+    cameraAccessDenied: boolean;
+    retryCameraAccess: () => void;
+    releaseCameraAccess: () => void;
+    iphoneContinuityCameraAvailable: boolean;
+    iphoneContinuityCameraAllowed: boolean;
+    setIphoneContinuityCameraAllowed: (value: boolean) => void;
+    takePhoto: () => Promise<Blob | null>;
+};
+export declare const CameraStateContext: React.Context<CameraState>;
 export type CameraProviderProps = {
     children: ReactElement;
-    requestAccessAutomatically?: boolean;
     preferFrontFacingCamera?: boolean;
     preferContinuityCamera?: boolean;
-    requireMicrophoneAccess?: boolean;
+    requestMicrophoneAccess?: boolean;
     maxVideoWidth?: number;
     maxFps?: number;
     debugMode?: boolean;
 };
-export declare const CameraProvider: ({ children, requestAccessAutomatically, preferFrontFacingCamera, preferContinuityCamera, requireMicrophoneAccess, maxVideoWidth, maxFps, debugMode, }: CameraProviderProps) => ReactElement;
+export declare const CameraProvider: ({ children, preferFrontFacingCamera, preferContinuityCamera, requestMicrophoneAccess, maxVideoWidth, maxFps, debugMode, }: CameraProviderProps) => ReactElement;

package/dist/components/common/debug.d.ts

@@ -1,10 +1,7 @@
 import React, { ReactElement, ReactNode } from 'react';
 import { DetectedObject } from '../../lib/models/DocumentDetection';
-import { Face, FaceKeypoint } from '../../lib/models/FaceDetection';
-export declare function DebugStatsPane({ children }: {
-    children: ReactNode;
-}): React.JSX.Element;
-export declare const DebugStatsPaneDiv: import("styled-components").IStyledComponent<"web", {
+import { Face, FaceKeypoint } from '../selfie_capture/HighPerformanceSelfieGuidanceModelsProvider';
+export declare const DebugStatsPane: import("styled-components").IStyledComponent<"web", {
     ref?: React.LegacyRef<HTMLSpanElement> | undefined;
     key?: React.Key | null | undefined;
     defaultChecked?: boolean | undefined;
@@ -316,7 +313,7 @@ export type DetectedObjectDebugBoxProps = {
     flipX?: boolean;
     color?: string;
 };
-export declare function IdCaptureDetectedObjectDebugBox({ obj, flipX, color, scaling, }: DetectedObjectDebugBoxProps): ReactElement;
+export declare function IdCaptureDetectedObjectDebugBox({ obj, flipX, color, }: DetectedObjectDebugBoxProps): ReactElement;
 export type SelfieCaptureFaceDebugBoxProps = {
     face: Face;
     scaling: DebugScalingDetails;

package/dist/components/customer_flows/CustomerIdAndBiometricsEnrollment.d.ts

@@ -88,10 +88,10 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     idAutoCaptureEnabled?: boolean;
     /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards. Defaults to 0.8. */
     idCardAutoCaptureScoreThreshold?: number;
-    /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75. */
-    passportAutoCaptureScoreThreshold?: number;
     /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for Machine Readable Zones. Defaults to 0.5. */
     mrzDetectionScoreThreshold?: number;
+    /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75. */
+    passportAutoCaptureScoreThreshold?: number;
     /** Number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. */
     idCardFocusScoreThreshold?: number;
     /** Number between 0 and 1 at which focus guidance score condition is considered to be met for passports. */

package/dist/components/customer_flows/IdAndFaceValidation.d.ts

@@ -85,10 +85,10 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
     idAutoCaptureEnabled?: boolean;
     /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards. Defaults to 0.8. */
     idCardAutoCaptureScoreThreshold?: number;
-    /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75. */
-    passportAutoCaptureScoreThreshold?: number;
     /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for Machine Readable Zones. Defaults to 0.5. */
     mrzDetectionScoreThreshold?: number;
+    /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75. */
+    passportAutoCaptureScoreThreshold?: number;
     /** Number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. */
     idCardFocusScoreThreshold?: number;
     /** Number between 0 and 1 at which focus guidance score condition is considered to be met for passports. */

package/dist/components/customer_flows/IdValidation.d.ts

@@ -72,8 +72,6 @@ export interface IdValidationProps extends PropsWithChildren {
     idCardAutoCaptureScoreThreshold?: number;
     /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75. */
     passportAutoCaptureScoreThreshold?: number;
-    /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for Machine Readable Zones. Defaults to 0.5. */
-    mrzDetectionScoreThreshold?: number;
     /** Number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. */
     idCardFocusScoreThreshold?: number;
     /** Number between 0 and 1 at which focus guidance score condition is considered to be met for passports. */

package/dist/components/face_liveness/FaceLivenessCapture.d.ts

@@ -2,6 +2,7 @@ import { ReactElement } from 'react';
 import { SelfieCaptureClassNames, SelfieCaptureColors, SelfieCaptureVerbiage } from '../selfie_capture/SelfieCapture';
 import { SelfieProgressPreviewClassNames } from '../common/SelfieProgressPreview';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
+import { SelfieCaptureLoadingOverlayProps } from '../selfie_capture/SelfieCaptureLoadingOverlay';
 export type FaceLivenessCaptureClassNames = SelfieCaptureClassNames & {
     imagePreview?: SelfieProgressPreviewClassNames;
 };
@@ -23,5 +24,6 @@ export type FaceLivenessCaptureProps = {
     colors?: FaceLivenessCaptureColors;
     verbiage?: FaceLivenessCaptureVerbiage;
     debugMode?: boolean;
+    selfieCaptureLoadingOverlayProps?: SelfieCaptureLoadingOverlayProps;
 };
-export declare const FaceLivenessCapture: ({ onCapture, onSuccess, onTimeout, onExit, timeoutDurationMs, silentFallback, classNames, colors, verbiage: rawVerbiage, debugMode, }: FaceLivenessCaptureProps) => ReactElement;
+export declare const FaceLivenessCapture: ({ onCapture, onSuccess, onTimeout, onExit, timeoutDurationMs, silentFallback, classNames, colors, verbiage: rawVerbiage, debugMode, selfieCaptureLoadingOverlayProps, }: FaceLivenessCaptureProps) => ReactElement;

package/dist/components/fallback_flows/SelfieCapture.d.ts

@@ -1,6 +1,7 @@
 import { ReactElement } from 'react';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 import { LoaderButtonColors } from '../common/LoaderButton';
+import { SelfieCaptureLoadingOverlayProps } from '../selfie_capture/SelfieCaptureLoadingOverlay';
 export type SelfieCaptureFallbackClassNames = {
     container?: string;
     inner?: string;
@@ -11,7 +12,6 @@ export type SelfieCaptureFallbackClassNames = {
     buttonsRow?: string;
     captureBtn?: string;
     doneBtn?: string;
-    retryCaptureBtn?: string;
 };
 export type SelfieCaptureFallbackColors = {
     captureBtn?: LoaderButtonColors;
@@ -23,10 +23,6 @@ export type SelfieCaptureFallbackVerbiage = {
     captureBtnText?: CustomerSuppliedVerbiage;
     doneBtnText?: CustomerSuppliedVerbiage;
     doneBtnLoadingText?: CustomerSuppliedVerbiage;
-    livenessFailedText?: CustomerSuppliedVerbiage;
-    livenessFailedReasonText?: CustomerSuppliedVerbiage;
-    retryButtonText?: CustomerSuppliedVerbiage;
-    retryCaptureButtonText?: CustomerSuppliedVerbiage;
 };
 export type SelfieCaptureFallbackProps = {
     onFinished?: (imageData: string) => void;
@@ -35,7 +31,6 @@ export type SelfieCaptureFallbackProps = {
     colors?: SelfieCaptureFallbackColors;
     verbiage?: SelfieCaptureFallbackVerbiage;
     silentFallback?: boolean;
-    invalidSelfie?: boolean;
-    guidanceMessage?: string;
+    selfieCaptureLoadingOverlayProps?: SelfieCaptureLoadingOverlayProps;
 };
-export declare const SelfieCaptureFallback: ({ onFinished, onCapture, classNames, colors, verbiage: rawVerbiage, silentFallback, invalidSelfie, guidanceMessage, }: SelfieCaptureFallbackProps) => ReactElement;
+export declare const SelfieCaptureFallback: ({ onFinished, onCapture, classNames, colors, verbiage: rawVerbiage, silentFallback, selfieCaptureLoadingOverlayProps: overlayProps, }: SelfieCaptureFallbackProps) => ReactElement;

package/dist/components/id_capture/CapturedDocuments.d.ts

@@ -1,13 +1,11 @@
-import { DetectedObjectBox } from '../../lib/models/DocumentDetection';
-export declare const CapturedDocumentTypeValues: readonly ["idCardFront", "idCardBack", "passport", "selfie"];
-export type CapturedDocumentType = (typeof CapturedDocumentTypeValues)[number];
 export type CapturedDocument = {
     imageData: string;
     width: number;
     height: number;
-    boundingBox?: DetectedObjectBox;
-    documentType: CapturedDocumentType;
+    boundingBox?: number[];
 };
+export declare const CapturedDocumentTypeValues: readonly ["idCardFront", "idCardBack", "passport", "selfie"];
+export type CapturedDocumentType = (typeof CapturedDocumentTypeValues)[number];
 export type CapturedDocuments = {
     [k in CapturedDocumentType]?: CapturedDocument;
 };

package/dist/components/id_capture/HighPerformanceObjectDetectionModelsProvider.d.ts

@@ -0,0 +1,36 @@
+import * as React from 'react';
+import { MutableRefObject, ReactElement, ReactNode } from 'react';
+import { ObjectDetector } from '@mediapipe/tasks-vision';
+export declare const visionTasksBasePath = "https://cdn.jsdelivr.net/npm/@mediapipe/tasks-vision@latest/wasm";
+export declare const objectDetectorModelPath = "https://websdk-cdn-dev.idmission.com/assets/models/mpobjtest/model_fp16.tflite";
+export type DetectedObject = {
+    box: {
+        xMin: number;
+        xMax: number;
+        yMin: number;
+        yMax: number;
+        width: number;
+        height: number;
+    };
+};
+export declare function loadHighPerformanceObjectDetector(modelAssetPath: string, delegate?: 'CPU' | 'GPU', scoreThreshold?: number): Promise<ObjectDetector>;
+type PredictionHandler = (prediction: DetectedObject[]) => void;
+type HighPerformanceSelfieGuidanceModelsState = {
+    start: () => void;
+    stop: () => void;
+    onPredictionMade: (handler: PredictionHandler) => void;
+    canvasRef: MutableRefObject<HTMLCanvasElement | null>;
+    ready: boolean;
+    error: Error | null;
+    modelDownloadProgress: number;
+};
+export declare const HighPerformanceObjectDetectionModelsContext: React.Context<HighPerformanceSelfieGuidanceModelsState>;
+export declare const HighPerformanceObjectDetectionModelsProvider: ({ autoStart, children, throttleMs, modelAssetPath, delegate, scoreThreshold, }: {
+    autoStart?: boolean | undefined;
+    children: ReactNode;
+    throttleMs?: number | undefined;
+    modelAssetPath?: string | undefined;
+    delegate?: "CPU" | "GPU" | undefined;
+    scoreThreshold?: number | undefined;
+}) => ReactElement;
+export {};

package/dist/components/id_capture/IdCapture.d.ts

@@ -40,24 +40,24 @@ export type IdCaptureVerbiage = {
 export type IdCaptureProps = {
     requiredDocumentType?: CapturedDocumentType;
     autoCaptureEnabled?: boolean;
-    idCardDetectionThreshold?: number;
-    passportDetectionThreshold?: number;
+    autoCaptureScoreThreshold?: number;
+    autoCaptureGoodFramesRequired?: number;
     autoCaptureBarcodeRequired?: boolean | 'mobile';
     mrzDetectionScoreThreshold?: number;
+    passportPageDetectionThreshold?: number;
     pdf417DetectionThreshold?: number;
     barcodeScanningEnabled?: boolean;
     maxBarcodeScanAttempts?: number;
-    idCardFocusScoreThreshold?: number;
-    passportFocusScoreThreshold?: number;
+    focusScoreThreshold?: number;
     guidanceMessage?: string;
     guidanceSatisfied?: boolean;
     onPrediction?: (prediction: IdCapturePrediction) => void;
     onBarcodeScanned?: (result: PDF417DetectionResult) => void;
-    onCapture?: (frame: string, width: number, height: number, documentType: CapturedDocumentType, metadata: CaptureAttemptMetadata) => void;
+    onCapture?: (frame: string, width: number, height: number, metadata: CaptureAttemptMetadata) => void;
     assets?: IdCaptureAssets;
     classNames?: IdCaptureClassNames;
     colors?: IdCaptureColors;
     verbiage?: IdCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const IdCapture: ({ requiredDocumentType, autoCaptureEnabled, autoCaptureBarcodeRequired, idCardDetectionThreshold, passportDetectionThreshold, mrzDetectionScoreThreshold, pdf417DetectionThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, barcodeScanningEnabled, maxBarcodeScanAttempts, guidanceMessage, guidanceSatisfied, onPrediction, onCapture, assets, classNames, colors, verbiage: rawVerbiage, debugMode, }: IdCaptureProps) => React.ReactElement;
+export declare const IdCapture: ({ requiredDocumentType, autoCaptureEnabled, autoCaptureScoreThreshold, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, mrzDetectionScoreThreshold, passportPageDetectionThreshold, pdf417DetectionThreshold, focusScoreThreshold, barcodeScanningEnabled, maxBarcodeScanAttempts, guidanceMessage, guidanceSatisfied, onPrediction, onBarcodeScanned, onCapture, assets, classNames, colors, verbiage: rawVerbiage, debugMode, }: IdCaptureProps) => React.ReactElement;

package/dist/components/id_capture/IdCaptureGuideOverlay.d.ts

@@ -548,281 +548,6 @@ export declare const GuideRegion: import("styled-components").IStyledComponent<"
     $minHeight?: number | undefined;
     $maskColor?: string | undefined;
 }>>;
-export declare const Spacer: import("styled-components").IStyledComponent<"web", {
-    key?: React.Key | null | undefined;
-    defaultChecked?: boolean | undefined;
-    defaultValue?: string | number | readonly string[] | undefined;
-    suppressContentEditableWarning?: boolean | undefined;
-    suppressHydrationWarning?: boolean | undefined;
-    accessKey?: string | undefined;
-    autoFocus?: boolean | undefined;
-    className?: string | undefined;
-    contentEditable?: (boolean | "true" | "false") | "inherit" | undefined;
-    contextMenu?: string | undefined;
-    dir?: string | undefined;
-    draggable?: (boolean | "true" | "false") | undefined;
-    hidden?: boolean | undefined;
-    id?: string | undefined;
-    lang?: string | undefined;
-    nonce?: string | undefined;
-    placeholder?: string | undefined;
-    slot?: string | undefined;
-    spellCheck?: (boolean | "true" | "false") | undefined;
-    style?: React.CSSProperties | undefined;
-    tabIndex?: number | undefined;
-    title?: string | undefined;
-    translate?: "yes" | "no" | undefined;
-    radioGroup?: string | undefined;
-    role?: React.AriaRole | undefined;
-    about?: string | undefined;
-    content?: string | undefined;
-    datatype?: string | undefined;
-    inlist?: any;
-    prefix?: string | undefined;
-    property?: string | undefined;
-    rel?: string | undefined;
-    resource?: string | undefined;
-    rev?: string | undefined;
-    typeof?: string | undefined;
-    vocab?: string | undefined;
-    autoCapitalize?: string | undefined;
-    autoCorrect?: string | undefined;
-    autoSave?: string | undefined;
-    color?: string | undefined;
-    itemProp?: string | undefined;
-    itemScope?: boolean | undefined;
-    itemType?: string | undefined;
-    itemID?: string | undefined;
-    itemRef?: string | undefined;
-    results?: number | undefined;
-    security?: string | undefined;
-    unselectable?: "on" | "off" | undefined;
-    inputMode?: "search" | "text" | "none" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined;
-    is?: string | undefined;
-    children?: React.ReactNode | Iterable<React.ReactNode>;
-    "aria-activedescendant"?: string | undefined;
-    "aria-atomic"?: (boolean | "true" | "false") | undefined;
-    "aria-autocomplete"?: "list" | "none" | "inline" | "both" | undefined;
-    "aria-braillelabel"?: string | undefined;
-    "aria-brailleroledescription"?: string | undefined;
-    "aria-busy"?: (boolean | "true" | "false") | undefined;
-    "aria-checked"?: boolean | "true" | "false" | "mixed" | undefined;
-    "aria-colcount"?: number | undefined;
-    "aria-colindex"?: number | undefined;
-    "aria-colindextext"?: string | undefined;
-    "aria-colspan"?: number | undefined;
-    "aria-controls"?: string | undefined;
-    "aria-current"?: boolean | "time" | "step" | "true" | "false" | "page" | "location" | "date" | undefined;
-    "aria-describedby"?: string | undefined;
-    "aria-description"?: string | undefined;
-    "aria-details"?: string | undefined;
-    "aria-disabled"?: (boolean | "true" | "false") | undefined;
-    "aria-dropeffect"?: "copy" | "link" | "none" | "execute" | "move" | "popup" | undefined;
-    "aria-errormessage"?: string | undefined;
-    "aria-expanded"?: (boolean | "true" | "false") | undefined;
-    "aria-flowto"?: string | undefined;
-    "aria-grabbed"?: (boolean | "true" | "false") | undefined;
-    "aria-haspopup"?: boolean | "dialog" | "menu" | "true" | "false" | "grid" | "listbox" | "tree" | undefined;
-    "aria-hidden"?: (boolean | "true" | "false") | undefined;
-    "aria-invalid"?: boolean | "true" | "false" | "grammar" | "spelling" | undefined;
-    "aria-keyshortcuts"?: string | undefined;
-    "aria-label"?: string | undefined;
-    "aria-labelledby"?: string | undefined;
-    "aria-level"?: number | undefined;
-    "aria-live"?: "off" | "assertive" | "polite" | undefined;
-    "aria-modal"?: (boolean | "true" | "false") | undefined;
-    "aria-multiline"?: (boolean | "true" | "false") | undefined;
-    "aria-multiselectable"?: (boolean | "true" | "false") | undefined;
-    "aria-orientation"?: "horizontal" | "vertical" | undefined;
-    "aria-owns"?: string | undefined;
-    "aria-placeholder"?: string | undefined;
-    "aria-posinset"?: number | undefined;
-    "aria-pressed"?: boolean | "true" | "false" | "mixed" | undefined;
-    "aria-readonly"?: (boolean | "true" | "false") | undefined;
-    "aria-relevant"?: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefined;
-    "aria-required"?: (boolean | "true" | "false") | undefined;
-    "aria-roledescription"?: string | undefined;
-    "aria-rowcount"?: number | undefined;
-    "aria-rowindex"?: number | undefined;
-    "aria-rowindextext"?: string | undefined;
-    "aria-rowspan"?: number | undefined;
-    "aria-selected"?: (boolean | "true" | "false") | undefined;
-    "aria-setsize"?: number | undefined;
-    "aria-sort"?: "none" | "ascending" | "descending" | "other" | undefined;
-    "aria-valuemax"?: number | undefined;
-    "aria-valuemin"?: number | undefined;
-    "aria-valuenow"?: number | undefined;
-    "aria-valuetext"?: string | undefined;
-    dangerouslySetInnerHTML?: {
-        __html: string | TrustedHTML;
-    } | undefined;
-    onCopy?: React.ClipboardEventHandler<HTMLDivElement> | undefined;
-    onCopyCapture?: React.ClipboardEventHandler<HTMLDivElement> | undefined;
-    onCut?: React.ClipboardEventHandler<HTMLDivElement> | undefined;
-    onCutCapture?: React.ClipboardEventHandler<HTMLDivElement> | undefined;
-    onPaste?: React.ClipboardEventHandler<HTMLDivElement> | undefined;
-    onPasteCapture?: React.ClipboardEventHandler<HTMLDivElement> | undefined;
-    onCompositionEnd?: React.CompositionEventHandler<HTMLDivElement> | undefined;
-    onCompositionEndCapture?: React.CompositionEventHandler<HTMLDivElement> | undefined;
-    onCompositionStart?: React.CompositionEventHandler<HTMLDivElement> | undefined;
-    onCompositionStartCapture?: React.CompositionEventHandler<HTMLDivElement> | undefined;
-    onCompositionUpdate?: React.CompositionEventHandler<HTMLDivElement> | undefined;
-    onCompositionUpdateCapture?: React.CompositionEventHandler<HTMLDivElement> | undefined;
-    onFocus?: React.FocusEventHandler<HTMLDivElement> | undefined;
-    onFocusCapture?: React.FocusEventHandler<HTMLDivElement> | undefined;
-    onBlur?: React.FocusEventHandler<HTMLDivElement> | undefined;
-    onBlurCapture?: React.FocusEventHandler<HTMLDivElement> | undefined;
-    onChange?: React.FormEventHandler<HTMLDivElement> | undefined;
-    onChangeCapture?: React.FormEventHandler<HTMLDivElement> | undefined;
-    onBeforeInput?: React.FormEventHandler<HTMLDivElement> | undefined;
-    onBeforeInputCapture?: React.FormEventHandler<HTMLDivElement> | undefined;
-    onInput?: React.FormEventHandler<HTMLDivElement> | undefined;
-    onInputCapture?: React.FormEventHandler<HTMLDivElement> | undefined;
-    onReset?: React.FormEventHandler<HTMLDivElement> | undefined;
-    onResetCapture?: React.FormEventHandler<HTMLDivElement> | undefined;
-    onSubmit?: React.FormEventHandler<HTMLDivElement> | undefined;
-    onSubmitCapture?: React.FormEventHandler<HTMLDivElement> | undefined;
-    onInvalid?: React.FormEventHandler<HTMLDivElement> | undefined;
-    onInvalidCapture?: React.FormEventHandler<HTMLDivElement> | undefined;
-    onLoad?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onLoadCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onError?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onErrorCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onKeyDown?: React.KeyboardEventHandler<HTMLDivElement> | undefined;
-    onKeyDownCapture?: React.KeyboardEventHandler<HTMLDivElement> | undefined;
-    onKeyPress?: React.KeyboardEventHandler<HTMLDivElement> | undefined;
-    onKeyPressCapture?: React.KeyboardEventHandler<HTMLDivElement> | undefined;
-    onKeyUp?: React.KeyboardEventHandler<HTMLDivElement> | undefined;
-    onKeyUpCapture?: React.KeyboardEventHandler<HTMLDivElement> | undefined;
-    onAbort?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onAbortCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onCanPlay?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onCanPlayCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onCanPlayThrough?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onCanPlayThroughCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onDurationChange?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onDurationChangeCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onEmptied?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onEmptiedCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onEncrypted?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onEncryptedCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onEnded?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onEndedCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onLoadedData?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onLoadedDataCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onLoadedMetadata?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onLoadedMetadataCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onLoadStart?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onLoadStartCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onPause?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onPauseCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onPlay?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onPlayCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onPlaying?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onPlayingCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onProgress?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onProgressCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onRateChange?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onRateChangeCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onResize?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onResizeCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onSeeked?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onSeekedCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onSeeking?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onSeekingCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onStalled?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onStalledCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onSuspend?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onSuspendCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onTimeUpdate?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onTimeUpdateCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onVolumeChange?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onVolumeChangeCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onWaiting?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onWaitingCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onAuxClick?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onAuxClickCapture?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onClick?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onClickCapture?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onContextMenu?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onContextMenuCapture?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onDoubleClick?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onDoubleClickCapture?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onDrag?: React.DragEventHandler<HTMLDivElement> | undefined;
-    onDragCapture?: React.DragEventHandler<HTMLDivElement> | undefined;
-    onDragEnd?: React.DragEventHandler<HTMLDivElement> | undefined;
-    onDragEndCapture?: React.DragEventHandler<HTMLDivElement> | undefined;
-    onDragEnter?: React.DragEventHandler<HTMLDivElement> | undefined;
-    onDragEnterCapture?: React.DragEventHandler<HTMLDivElement> | undefined;
-    onDragExit?: React.DragEventHandler<HTMLDivElement> | undefined;
-    onDragExitCapture?: React.DragEventHandler<HTMLDivElement> | undefined;
-    onDragLeave?: React.DragEventHandler<HTMLDivElement> | undefined;
-    onDragLeaveCapture?: React.DragEventHandler<HTMLDivElement> | undefined;
-    onDragOver?: React.DragEventHandler<HTMLDivElement> | undefined;
-    onDragOverCapture?: React.DragEventHandler<HTMLDivElement> | undefined;
-    onDragStart?: React.DragEventHandler<HTMLDivElement> | undefined;
-    onDragStartCapture?: React.DragEventHandler<HTMLDivElement> | undefined;
-    onDrop?: React.DragEventHandler<HTMLDivElement> | undefined;
-    onDropCapture?: React.DragEventHandler<HTMLDivElement> | undefined;
-    onMouseDown?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onMouseDownCapture?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onMouseEnter?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onMouseLeave?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onMouseMove?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onMouseMoveCapture?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onMouseOut?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onMouseOutCapture?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onMouseOver?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onMouseOverCapture?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onMouseUp?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onMouseUpCapture?: React.MouseEventHandler<HTMLDivElement> | undefined;
-    onSelect?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onSelectCapture?: React.ReactEventHandler<HTMLDivElement> | undefined;
-    onTouchCancel?: React.TouchEventHandler<HTMLDivElement> | undefined;
-    onTouchCancelCapture?: React.TouchEventHandler<HTMLDivElement> | undefined;
-    onTouchEnd?: React.TouchEventHandler<HTMLDivElement> | undefined;
-    onTouchEndCapture?: React.TouchEventHandler<HTMLDivElement> | undefined;
-    onTouchMove?: React.TouchEventHandler<HTMLDivElement> | undefined;
-    onTouchMoveCapture?: React.TouchEventHandler<HTMLDivElement> | undefined;
-    onTouchStart?: React.TouchEventHandler<HTMLDivElement> | undefined;
-    onTouchStartCapture?: React.TouchEventHandler<HTMLDivElement> | undefined;
-    onPointerDown?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onPointerDownCapture?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onPointerMove?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onPointerMoveCapture?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onPointerUp?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onPointerUpCapture?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onPointerCancel?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onPointerCancelCapture?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onPointerEnter?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onPointerEnterCapture?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onPointerLeave?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onPointerLeaveCapture?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onPointerOver?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onPointerOverCapture?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onPointerOut?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onPointerOutCapture?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onGotPointerCapture?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onGotPointerCaptureCapture?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onLostPointerCapture?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onLostPointerCaptureCapture?: React.PointerEventHandler<HTMLDivElement> | undefined;
-    onScroll?: React.UIEventHandler<HTMLDivElement> | undefined;
-    onScrollCapture?: React.UIEventHandler<HTMLDivElement> | undefined;
-    onWheel?: React.WheelEventHandler<HTMLDivElement> | undefined;
-    onWheelCapture?: React.WheelEventHandler<HTMLDivElement> | undefined;
-    onAnimationStart?: React.AnimationEventHandler<HTMLDivElement> | undefined;
-    onAnimationStartCapture?: React.AnimationEventHandler<HTMLDivElement> | undefined;
-    onAnimationEnd?: React.AnimationEventHandler<HTMLDivElement> | undefined;
-    onAnimationEndCapture?: React.AnimationEventHandler<HTMLDivElement> | undefined;
-    onAnimationIteration?: React.AnimationEventHandler<HTMLDivElement> | undefined;
-    onAnimationIterationCapture?: React.AnimationEventHandler<HTMLDivElement> | undefined;
-    onTransitionEnd?: React.TransitionEventHandler<HTMLDivElement> | undefined;
-    onTransitionEndCapture?: React.TransitionEventHandler<HTMLDivElement> | undefined;
-    $minWidth?: number | undefined;
-    $minHeight?: number | undefined;
-    $maskColor?: string | undefined;
-    ref?: ((instance: HTMLDivElement | null) => void) | React.RefObject<HTMLDivElement> | null | undefined;
-}>;
 export declare const GuideCenterRegion: import("styled-components").IStyledComponent<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
     $minWidth?: number | undefined;
     $isMirrored?: boolean | undefined;

package/dist/components/id_capture/IdCaptureModelsProvider.d.ts

@@ -1,8 +1,7 @@
-import React, { ReactElement, ReactNode } from 'react';
-import { DetectedObject, DetectedObjectBox, DocumentDetectionThresholds, DocumentType } from '../../lib/models/DocumentDetection';
-import { DocumentDetectionModelProviderProps } from './DocumentDetectionModelProvider';
-import { FocusModelProviderProps } from './FocusModelProvider';
-import { FocusThresholds } from '../../lib/models/Focus';
+import React, { MutableRefObject, ReactElement, ReactNode } from 'react';
+import { DetectedObject, DocumentType } from '../../lib/models/DocumentDetection';
+import { FocusPrediction } from '../../lib/models/Focus';
+import { Frame } from '../../lib/utils/getFrameDimensions';
 export type IdCapturePrediction = {
     detectedObjects: DetectedObject[];
     detectionTime: number;
@@ -15,7 +14,7 @@ export type IdCapturePrediction = {
     mrzDetectionThresholdMet: boolean;
     pdf417DetectionScore: number;
     pdf417DetectionThresholdMet: boolean;
-    bestDocument: DetectedObject | undefined;
+    bestDocumentOrPassport: DetectedObject | undefined;
     bestMrz: DetectedObject | undefined;
     bestPdf417: DetectedObject | undefined;
     documentInBounds: boolean;
@@ -27,40 +26,55 @@ export type IdCapturePrediction = {
     frameHeight: number;
     allZero: boolean;
 };
-export type IdCaptureThresholds = DocumentDetectionThresholds & {
-    focus?: FocusThresholds;
+export type IdCaptureThresholds = {
+    document?: number;
+    passport?: number;
+    mrz?: number;
+    pdf417?: number;
+    focus?: {
+        desktop?: number;
+        mobile?: number;
+    };
 };
-export type BestFrameDetails = {
-    boundingBox?: DetectedObjectBox;
-    documentType: DocumentType;
+export type BestFrame = {
+    canvas: HTMLCanvasElement;
+    boundingBox?: number[];
     detectionScore: number;
     focusScore: number;
 };
-export type BestFrame = BestFrameDetails & {
-    canvas: HTMLCanvasElement;
-};
 export type IdCaptureModelsState = {
     ready: boolean;
-    start: () => void;
-    stop: () => void;
     modelDownloadProgress: number;
+    working: MutableRefObject<boolean>;
     idModelError: Error | null;
     thresholds: IdCaptureThresholds;
     setThresholds: (value: IdCaptureThresholds) => void;
+    makePrediction: (frame: Frame) => void;
     onPredictionMade: (handler: (prediction: IdCapturePrediction) => void) => void;
     detectionTime: number;
     focusPredictionTime: number;
-    bestFrameDetails: BestFrameDetails | null;
-    getBestFrame: () => BestFrame | null;
+    getBestFrame: () => Promise<BestFrame | null>;
     resetBestFrame: () => void;
+    bestFrameDetectionScore: number;
+    bestFrameFocusScore: number;
 };
 export declare const IdCaptureModelsContext: React.Context<IdCaptureModelsState>;
 export type IdCaptureModelsProviderProps = {
     children: ReactNode;
     documentDetectionModelUrl?: string | undefined;
     focusModelUrl?: string | undefined;
+    logPredictions?: boolean;
     onModelError?: (error: Error) => void;
     modelLoadTimeoutMs?: number;
 };
-export declare function IdCaptureModelsProviderInner({ children, onModelError, }: IdCaptureModelsProviderProps): ReactElement;
-export declare function IdCaptureModelsProvider({ children, ...props }: IdCaptureModelsProviderProps & DocumentDetectionModelProviderProps & FocusModelProviderProps): React.JSX.Element;
+export declare const defaultDocumentDetectionModelUrl: string;
+export declare const defaultFocusModelUrl: string;
+export declare const defaultIdCaptureModelLoadTimeoutMs = 45000;
+export declare const IdCaptureModelsProvider: ({ children, documentDetectionModelUrl, focusModelUrl, logPredictions, onModelError, modelLoadTimeoutMs, }: IdCaptureModelsProviderProps) => ReactElement;
+type Canvases = {
+    lastPredictionCanvas: HTMLCanvasElement;
+    cropCanvas: HTMLCanvasElement;
+    rotateCanvas: HTMLCanvasElement;
+};
+export declare function makeFocusPrediction(imageData: Frame, canvases: Canvases, bbox?: number[], logPredictions?: boolean): Promise<[FocusPrediction, number]>;
+export {};