idmission-web-sdk 1.0.388 → 1.0.390

package/README.md

@@ -79,6 +79,7 @@ Render a fullscreen ID capture component that instructs the user to photograph b
 <tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user completes the IDValidation flow with an invalid ID. Arguments: same as onComplete.</td></tr>
 <tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</td></tr>
 <tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
+<tr><td><code>onCameraAccessDenied</code> (optional)</td><td>callback function that fires when camera access is denied or lost.</td></tr>
 <tr><td><code>lang</code> (optional)</td><td>language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto.</td></tr>
 <tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
@@ -225,6 +226,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</td></tr>
 <tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after completing the FaceValidation flow and failing the realness check.</td></tr>
 <tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
+<tr><td><code>onCameraAccessDenied</code> (optional)</td><td>callback function that fires when camera access is denied or lost.</td></tr>
 <tr><td><code>lang</code> (optional)</td><td>language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto.</td></tr>
 <tr><td><code>timeoutDurationMs</code> (optional)</td><td>the duration of time in milliseconds that the user may try to pass the realness check. Defaults to 15000 (15 seconds).</td></tr>
 <tr><td><code>skipSuccessScreen</code> (optional)</td><td>boolean to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to false.</td></tr>
@@ -338,6 +340,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</td></tr>
 <tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check.</td></tr>
 <tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
+<tr><td><code>onCameraAccessDenied</code> (optional)</td><td>callback function that fires when camera access is denied or lost.</td></tr>
 <tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
@@ -411,6 +414,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</td></tr>
 <tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check.</td></tr>
 <tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
+<tr><td><code>onCameraAccessDenied</code> (optional)</td><td>callback function that fires when camera access is denied or lost.</td></tr>
 <tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
@@ -482,6 +486,7 @@ Render a fullscreen capture component that performs FaceValidation, and then sto
 <tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</td></tr>
 <tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check.</td></tr>
 <tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
+<tr><td><code>onCameraAccessDenied</code> (optional)</td><td>callback function that fires when camera access is denied or lost.</td></tr>
 <tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
@@ -535,6 +540,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</td></tr>
 <tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after failing the realness check.</td></tr>
 <tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
+<tr><td><code>onCameraAccessDenied</code> (optional)</td><td>callback function that fires when camera access is denied or lost.</td></tr>
 <tr><td><code>lang</code> (optional)</td><td>language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto.</td></tr>
 <tr><td><code>timeoutDurationMs</code> (optional)</td><td>the duration of time in milliseconds that the user may try to pass the realness check. Defaults to 15000 (15 seconds).</td></tr>
 <tr><td><code>skipSuccessScreen</code> (optional)</td><td>boolean to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to false.</td></tr>
@@ -578,6 +584,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</td></tr>
 <tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after failing the realness check.</td></tr>
 <tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
+<tr><td><code>onCameraAccessDenied</code> (optional)</td><td>callback function that fires when camera access is denied or lost.</td></tr>
 <tr><td><code>skipSuccessScreen</code> (optional)</td><td>boolean to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to false.</td></tr>
 <tr><td><code>lang</code> (optional)</td><td>language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto.</td></tr>
 <tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
@@ -675,6 +682,8 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</td></tr>
 <tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after failing the realness check.</td></tr>
 <tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
+<tr><td><code>onCameraAccessDenied</code> (optional)</td><td>callback function that fires when camera access is denied or lost.</td></tr>
+<tr><td><code>onMicrophoneAccessDenied</code> (optional)</td><td>callback function that fires when microphone access is denied or lost.</td></tr>
 <tr><td><code>lang</code> (optional)</td><td>language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto.</td></tr>
 <tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>

package/dist/components/CompositeWizard.d.ts

@@ -17,6 +17,8 @@ export type CompositeWizardComponentProps = {
     videoIdCaptureProps?: VideoIdWizardProps;
     captureSignature?: boolean | (() => Promise<boolean>);
     captureSignatureVideo?: boolean | (() => Promise<boolean>);
+    onCameraAccessDenied?: () => void;
+    onMicrophoneAccessDenied?: () => void;
     debugMode?: boolean;
 };
 export type CompositeWizardProps = CompositeWizardComponentProps & {
@@ -27,4 +29,4 @@ export type CompositeWizardProps = CompositeWizardComponentProps & {
     onComplete?: (submissionResponse: SubmissionResponse) => void;
 };
 export declare const CompositeWizard: (props: CompositeWizardProps) => ReactElement;
-export declare const CompositeWizardComponent: ({ checks: userChecks, idCaptureProps, faceLivenessProps, additionalDocumentCaptureProps, signatureCaptureProps, videoSignatureCaptureProps, videoIdCaptureProps, captureSignature, captureSignatureVideo, debugMode, }: CompositeWizardComponentProps) => ReactElement;
+export declare const CompositeWizardComponent: ({ checks: userChecks, idCaptureProps, faceLivenessProps, additionalDocumentCaptureProps, signatureCaptureProps, videoSignatureCaptureProps, videoIdCaptureProps, captureSignature, captureSignatureVideo, onCameraAccessDenied, onMicrophoneAccessDenied, debugMode, }: CompositeWizardComponentProps) => ReactElement;

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

@@ -9,6 +9,8 @@ export type CameraProviderProps = {
     requireMicrophoneAccess?: boolean;
     maxVideoWidth?: number;
     maxFps?: number;
+    onCameraAccessDenied?: () => void;
+    onMicrophoneAccessDenied?: () => void;
     debugMode?: boolean;
 };
-export declare const CameraProvider: ({ children, requestAccessAutomatically, preferFrontFacingCamera, preferContinuityCamera, requireMicrophoneAccess, maxVideoWidth, maxFps, debugMode, }: CameraProviderProps) => ReactElement;
+export declare const CameraProvider: ({ children, requestAccessAutomatically, preferFrontFacingCamera, preferContinuityCamera, requireMicrophoneAccess, maxVideoWidth, maxFps, onCameraAccessDenied, onMicrophoneAccessDenied, 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/CustomerBiometricsEnrollment.d.ts

@@ -80,6 +80,8 @@ export interface CustomerBiometricsEnrollmentProps extends PropsWithChildren {
     onUserCancel?: () => void;
     /** Callback function that fires when the selfie capture models fail to load or fail during runtime. */
     onModelError?: (error: Error) => void;
+    /** Callback function that fires when the camera access is denied. */
+    onCameraAccessDenied?: () => void;
     /** Boolean or async function indicating whether the user should be prompted to sign the screen before submission. Defaults to `false`. */
     captureSignature?: boolean | (() => Promise<boolean>);
     /** Boolean or async function indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to `false`. */

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. */
@@ -134,6 +134,8 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     onIdCaptureModelError?: (error: Error) => void;
     /** Callback function that fires when the selfie capture models fail to load or fail during runtime. */
     onSelfieCaptureModelError?: (error: Error) => void;
+    /** Callback function that fires when the camera access is denied. */
+    onCameraAccessDenied?: () => void;
     /** Boolean or async function indicating whether the user should be prompted to sign the screen before submission. Defaults to `false`. */
     captureSignature?: boolean | (() => Promise<boolean>);
     /** Boolean or async function indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to `false`. */

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

@@ -54,6 +54,8 @@ export interface CustomerIdentificationProps extends PropsWithChildren {
     onUserCancel?: () => void;
     /** Callback function that fires when the selfie capture models fail to load or fail during runtime. */
     onModelError?: (error: Error) => void;
+    /** Callback function that fires when the camera access is denied. */
+    onCameraAccessDenied?: () => void;
     /** Name of an included theme or object containing theme properties. **/
     theme?: ThemeInput;
     /** Object containing any asset overrides. */

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

@@ -63,6 +63,8 @@ export interface CustomerVerificationProps extends PropsWithChildren {
     onUserCancel?: () => void;
     /** Callback function that fires when the selfie capture models fail to load or fail during runtime. */
     onModelError?: (error: Error) => void;
+    /** Callback function that fires when the camera access is denied. */
+    onCameraAccessDenied?: () => void;
     /** Boolean flag to indicate whether users should be prompted to share their location. Default is `true`. */
     geolocationEnabled?: boolean;
     /** Boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is `false`. */

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

@@ -23,6 +23,8 @@ export interface DocumentCaptureProps extends PropsWithChildren {
     onExitCapture?: () => void;
     /** Callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. */
     onUserCancel?: () => void;
+    /** Callback function that fires when the camera access is denied. */
+    onCameraAccessDenied?: () => void;
     documents?: CapturedDocument[];
     aspectRatio?: number;
     cameraFeedMode?: CameraFeedMode;

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

@@ -53,6 +53,8 @@ export interface FaceValidationProps extends PropsWithChildren {
     onUserCancel?: () => void;
     /** Callback function that fires when the selfie capture models fail to load or fail during runtime. */
     onModelError?: (error: Error) => void;
+    /** Callback function that fires when the camera access is denied. */
+    onCameraAccessDenied?: () => void;
     /** Name of an included theme or object containing theme properties. **/
     theme?: ThemeInput;
     /** Object containing any asset overrides. */

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. */
@@ -133,6 +133,8 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
     onIdCaptureModelError?: (error: Error) => void;
     /** Callback function that fires when the selfie capture models fail to load or fail during runtime. */
     onSelfieCaptureModelError?: (error: Error) => void;
+    /** Callback function that fires when the camera access is denied. */
+    onCameraAccessDenied?: () => void;
     /** Boolean or async function indicating whether the user should be prompted to sign the screen before submission. Defaults to `false`. */
     captureSignature?: boolean | (() => Promise<boolean>);
     /** Boolean or async function indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to `false`. */

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. */
@@ -108,6 +106,8 @@ export interface IdValidationProps extends PropsWithChildren {
     onUserCancel?: () => void;
     /** Callback function that fires when the ID capture models fail to load or fail during runtime. */
     onModelError?: (error: Error) => void;
+    /** Callback function that fires when the camera access is denied. */
+    onCameraAccessDenied?: () => void;
     /** Boolean or async function indicating whether the user should be prompted to sign the screen before submission. Defaults to `false`. */
     captureSignature?: boolean | (() => Promise<boolean>);
     /** Boolean or async function indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to `false`. */

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

@@ -21,6 +21,8 @@ export interface SignatureKYCProps extends PropsWithChildren {
     onUserCancel?: () => void;
     /** Callback function that fires when the selfie capture models fail to load or fail during runtime. */
     onModelError?: (error: Error) => void;
+    /** Callback function that fires when the camera access is denied. */
+    onCameraAccessDenied?: () => void;
     /** String indicating which loading overlay screen should be used. Supported values: 'default' and 'legacy'. Defaults to 'default'. */
     loadingOverlayMode?: SelfieCaptureLoadingOverlayMode;
     /** Boolean or async function to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to `false`. */

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

@@ -75,6 +75,10 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     onExitAfterFailure?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
     /** Callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. */
     onUserCancel?: () => void;
+    /** Callback function that fires when the camera access is denied. */
+    onCameraAccessDenied?: () => void;
+    /** Callback function that fires when the microphone access is denied. */
+    onMicrophoneAccessDenied?: () => void;
     /** Object containing any overrides for IDValidation. */
     idCaptureProps?: IdCaptureWizardProps;
     /** Object containing any overrides for FaceLiveness. */

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/docdetectmp20240517/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/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;
-    modelError: Error | null;
+    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 {};

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

@@ -51,6 +51,7 @@ export type IdCaptureState = {
     lastFrameCapturedAt: Date | null;
     frameCaptureRate: number;
     capturing: boolean;
+    captured: boolean;
     captureFailed: boolean;
     imageUrl: string | null;
     captureState: CaptureState;
@@ -59,8 +60,6 @@ export type IdCaptureState = {
     requestedDocumentType: CapturedDocumentType;
     detectedDocumentType: DocumentType;
     differentDocumentTypeDetections: number;
-    operationStartedAt: Date | null;
-    captureStartedAt: Date | null;
 };
 export type IdCaptureAction = {
     type: 'configureWizard';
@@ -71,13 +70,12 @@ export type IdCaptureAction = {
 } | {
     type: 'configureCapture';
     payload: {
+        requiredDocumentType?: CapturedDocumentType;
+        goodFramesThreshold: number;
         autoCaptureBarcodeRequired: boolean | 'mobile';
         barcodeScanningEnabled: boolean;
         maxBarcodeScanAttempts: number;
     };
-} | {
-    type: 'setRequiredDocumentType';
-    payload: CapturedDocumentType;
 } | {
     type: 'redrawRequested';
 } | {
@@ -103,8 +101,6 @@ export type IdCaptureAction = {
         width: number;
         height: number;
     };
-} | {
-    type: 'captureStarted';
 } | {
     type: 'capturing';
 } | {

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

@@ -54,6 +54,7 @@ export type IdCaptureWizardProps = {
     precapturedDocuments?: CapturedDocuments;
     captureRequirement?: IdCaptureRequirementOption;
     autoCaptureEnabled?: boolean;
+    autoCaptureGoodFramesRequired?: number;
     autoCaptureBarcodeRequired?: 'mobile' | boolean;
     barcodeScanningEnabled?: boolean;
     idCardAutoCaptureScoreThreshold?: number;
@@ -74,4 +75,4 @@ export type IdCaptureWizardProps = {
     verbiage?: IdCaptureWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, onUserCancel, loadingOverlayMode, precapturedDocuments, captureRequirement, autoCaptureEnabled, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, skipSuccessScreen, instructions, releaseCameraAccessOnExit, guideType, portraitGuidesOnMobile, rotateLoadingOverlayImageWhenPortrait, silentFallback, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;
+export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, onUserCancel, loadingOverlayMode, precapturedDocuments, captureRequirement, autoCaptureEnabled, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, skipSuccessScreen, instructions, releaseCameraAccessOnExit, guideType, portraitGuidesOnMobile, rotateLoadingOverlayImageWhenPortrait, silentFallback, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;

package/dist/components/selfie_capture/HighPerformanceSelfieGuidanceModelsProvider.d.ts

@@ -0,0 +1,42 @@
+import * as React from 'react';
+import { MutableRefObject, ReactElement, ReactNode } from 'react';
+import { FaceDetector } from '@mediapipe/tasks-vision';
+export declare const visionTasksBasePath = "https://cdn.jsdelivr.net/npm/@mediapipe/tasks-vision@0.10.7/wasm";
+export declare const faceDetectorModelPath = "https://websdk-cdn-dev.idmission.com/assets/models/blazeface20240207/blaze_face_short_range.tflite";
+export declare const defaultSelfieCaptureModelLoadTimeoutMs = 45000;
+export type FaceKeypoint = {
+    x: number;
+    y: number;
+    name: string;
+};
+export type Face = {
+    keypoints: FaceKeypoint[];
+    box: {
+        xMin: number;
+        xMax: number;
+        yMin: number;
+        yMax: number;
+        width: number;
+        height: number;
+    };
+};
+export declare function loadHighPerformanceFaceDetector(): Promise<FaceDetector>;
+type PredictionHandler = (prediction: Face[]) => 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 HighPerformanceSelfieGuidanceModelsContext: React.Context<HighPerformanceSelfieGuidanceModelsState>;
+export declare const HighPerformanceSelfieGuidanceModelsProvider: ({ autoStart, children, throttleMs, onModelError, modelLoadTimeoutMs, }: {
+    autoStart?: boolean | undefined;
+    children: ReactNode;
+    throttleMs?: number | undefined;
+    onModelError?: ((error: Error) => void) | undefined;
+    modelLoadTimeoutMs?: number | undefined;
+}) => ReactElement;
+export {};

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

@@ -1,8 +1,8 @@
 import { ReactElement } from 'react';
 import { FaceCaptureGuideOverlayClassNames } from '../face_liveness/FaceCaptureGuideOverlay';
+import { Face } from './HighPerformanceSelfieGuidanceModelsProvider';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 import { SelfieCaptureFallbackClassNames } from '../fallback_flows/SelfieCapture';
-import { Face } from '../../lib/models/FaceDetection';
 export type SelfieCaptureClassNames = {
     container?: string;
     cameraFeed?: string;

package/dist/components/selfie_capture/SelfieGuidanceModelsProvider.d.ts

@@ -1,23 +1,5 @@
-import * as React from 'react';
-import { MutableRefObject, ReactElement, ReactNode } from 'react';
-import { Face } from '../../lib/models/FaceDetection';
-type PredictionHandler = (prediction: Face[]) => void;
-type SelfieGuidanceModelsState = {
-    start: () => void;
-    stop: () => void;
-    onPredictionMade: (handler: PredictionHandler) => void;
-    canvasRef: MutableRefObject<HTMLCanvasElement | null>;
-    ready: boolean;
-    error: Error | null;
-    modelDownloadProgress: number;
-};
-export declare const SelfieGuidanceModelsContext: React.Context<SelfieGuidanceModelsState>;
+import { ReactElement } from 'react';
 export type SelfieGuidanceModelsProviderProps = {
-    autoStart?: boolean;
-    children: ReactNode;
-    throttleMs?: number;
-    onModelError?: (error: Error) => void;
-    modelLoadTimeoutMs?: number;
+    children: ReactElement;
 };
-export declare function SelfieGuidanceModelsProvider({ autoStart, children, throttleMs, onModelError, modelLoadTimeoutMs, }: SelfieGuidanceModelsProviderProps): ReactElement;
-export {};
+export declare const SelfieGuidanceModelsProvider: ({ children, }: SelfieGuidanceModelsProviderProps) => ReactElement;

package/dist/components/video_id/IdVideoCaptureWizard.d.ts

@@ -39,6 +39,8 @@ export type VideoIdWizardProps = {
     onExitAfterFailure?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
     onUserCancel?: () => void;
     onIdCaptureModelError?: (error: Error) => void;
+    onCameraAccessDenied?: () => void;
+    onMicrophoneAccessDenied?: () => void;
     idCaptureProps?: IdCaptureWizardProps;
     faceLivenessProps?: FaceLivenessWizardProps;
     idCaptureModelsEnabled?: boolean;
@@ -69,4 +71,4 @@ export type VideoIdWizardProps = {
     verbiage?: VideoIdWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const VideoIdWizard: ({ onComplete, onExitCapture, onExitAfterFailure, onUserCancel, onIdCaptureModelError, idCaptureProps, faceLivenessProps, idCaptureModelsEnabled, idCardFrontDetectionThreshold, idCardBackDetectionThreshold, idCardFrontFocusThreshold, idCardBackFocusThreshold, goodIdCardFrontFramesThreshold, goodIdCardBackFramesThreshold, readTextPrompt, readTextTimeoutDurationMs, readTextMinReadingMs, skipIdCapture, skipShowIdCardBack, skipSuccessScreen, idCaptureLoadingOverlayMode, idCaptureGuideType, idCapturePortraitGuidesOnMobile, idCaptureRotateLoadingOverlayImageWhenPortrait, idCaptureModelLoadTimeoutMs, faceLivenessLoadingOverlayMode, disableFaceDetectionWhileAudioCapture, disableFaceDetectionWhileAudioCaptureMsDelay, silentFallback, assets, classNames, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;
+export declare const VideoIdWizard: ({ onComplete, onExitCapture, onExitAfterFailure, onUserCancel, onIdCaptureModelError, onCameraAccessDenied, onMicrophoneAccessDenied, idCaptureProps, faceLivenessProps, idCaptureModelsEnabled, idCardFrontDetectionThreshold, idCardBackDetectionThreshold, idCardFrontFocusThreshold, idCardBackFocusThreshold, goodIdCardFrontFramesThreshold, goodIdCardBackFramesThreshold, readTextPrompt, readTextTimeoutDurationMs, readTextMinReadingMs, skipIdCapture, skipShowIdCardBack, skipSuccessScreen, idCaptureLoadingOverlayMode, idCaptureGuideType, idCapturePortraitGuidesOnMobile, idCaptureRotateLoadingOverlayImageWhenPortrait, idCaptureModelLoadTimeoutMs, faceLivenessLoadingOverlayMode, disableFaceDetectionWhileAudioCapture, disableFaceDetectionWhileAudioCaptureMsDelay, silentFallback, assets, classNames, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;

package/dist/contexts/SelfieGuidanceModelsContext.d.ts

@@ -0,0 +1,15 @@
+import { MutableRefObject } from 'react';
+import { Face } from '@tensorflow-models/face-detection';
+import { Frame } from '../lib/utils/getFrameDimensions';
+export type FacesPrediction = {
+    image: ImageBitmap;
+    faces: Face[];
+};
+export type SelfieGuidanceModelsState = {
+    ready: boolean;
+    working: MutableRefObject<boolean>;
+    makePrediction: (frame: Frame) => void;
+    onPredictionMade: (handler: (prediction: FacesPrediction) => void) => void;
+    faceDetectionTime: number;
+};
+export declare const SelfieGuidanceModelsContext: import("react").Context<SelfieGuidanceModelsState>;