idmission-web-sdk 2.1.93 → 2.1.95

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

@@ -15,25 +15,30 @@ import { SelfieCaptureLoadingOverlayMode } from '../selfie_capture/SelfieCapture
 import { IdCaptureLoadingOverlayMode } from '../id_capture/IdCaptureLoadingOverlay';
 import { IdCaptureThresholds } from '../id_capture/IdCaptureModelsProvider';
 import { IdCaptureGuideImages } from '../guide_images';
+import { VideoIdWizardAssets, VideoIdWizardClassNames, VideoIdWizardColors, VideoIdWizardProps, VideoIdWizardVerbiage } from '../video_id/IdVideoCaptureWizard';
 export type CustomerEnrollmentAssets = {
     idCapture?: IdCaptureWizardAssets;
     faceLiveness?: FaceLivenessAssets;
+    videoIdCapture?: VideoIdWizardAssets;
 };
 export type CustomerEnrollmentClassNames = {
     idCapture?: IdCaptureWizardClassNames;
     faceLiveness?: FaceLivenessClassNames;
     additionalDocumentCapture?: AdditionalDocumentCaptureWizardClassNames;
     signatureCapture?: SignatureCaptureClassNames;
+    videoIdCapture?: VideoIdWizardClassNames;
     videoSignatureCapture?: VideoSignatureClassNames;
 };
 export type CustomerEnrollmentColors = {
     idCapture?: IdCaptureWizardColors;
     faceLiveness?: FaceLivenessColors;
+    videoIdCapture?: VideoIdWizardColors;
     videoSignatureCapture?: VideoSignatureColors;
 };
 export type CustomerEnrollmentVerbiage = {
     idCapture?: IdCaptureWizardVerbiage;
     faceLiveness?: FaceLivenessVerbiage;
+    videoIdCapture?: VideoIdWizardVerbiage;
     additionalDocumentCapture?: AdditionalDocumentCaptureWizardVerbiage;
     signatureCapture?: SignatureCaptureVerbiage;
     videoSignatureCapture?: VideoSignatureVerbiage;
@@ -161,6 +166,10 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     captureSignatureVideo?: boolean | (() => Promise<boolean>);
     /** Array of additional documents to be captured. Each element includes a name and description. */
     captureAdditionalDocuments?: AdditionalDocument[];
+    /** Boolean or async function indicating whether the user should be prompted to capture a video of themselves holding their ID. Defaults to `false`. */
+    captureVideoId?: boolean | (() => Promise<boolean>);
+    /** Object containing overrides for VideoIdCapture. */
+    captureVideoIdProps?: VideoIdWizardProps;
     /** Name of an included theme or object containing theme properties. **/
     theme?: ThemeInput;
     /** Object containing any asset overrides. */

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

@@ -24,10 +24,9 @@ export type FaceLivenessCaptureProps = {
     silentFallback?: boolean;
     guidesComponent?: ComponentType<FaceCaptureGuideOverlayProps>;
     disableCapturePreview?: boolean;
-    requireVerticalFaceCentering?: boolean;
     classNames?: FaceLivenessCaptureClassNames;
     colors?: FaceLivenessCaptureColors;
     verbiage?: FaceLivenessCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const FaceLivenessCapture: ({ onCapture, onSuccess, onTimeout, onExit, timeoutDurationMs, silentFallback, guidesComponent, disableCapturePreview, requireVerticalFaceCentering, classNames, colors, verbiage: rawVerbiage, debugMode, }: FaceLivenessCaptureProps) => ReactElement;
+export declare const FaceLivenessCapture: ({ onCapture, onSuccess, onTimeout, onExit, timeoutDurationMs, silentFallback, guidesComponent, disableCapturePreview, classNames, colors, verbiage: rawVerbiage, debugMode, }: FaceLivenessCaptureProps) => ReactElement;

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

@@ -45,11 +45,10 @@ export type FaceLivenessWizardProps = {
     silentFallback?: boolean;
     guidesComponent?: ComponentType<FaceCaptureGuideOverlayProps>;
     disableCapturePreview?: boolean;
-    requireVerticalFaceCentering?: boolean;
     assets?: FaceLivenessAssets;
     classNames?: FaceLivenessClassNames;
     colors?: FaceLivenessColors;
     verbiage?: FaceLivenessVerbiage;
     debugMode?: boolean;
 };
-export declare const FaceLivenessWizard: ({ onComplete, onSuccess, onTimeout, onExitCapture, onExitAfterFailure, onUserCancel, loadingOverlayMode, customOverlayContent, onCustomOverlayDismissed, timeoutDurationMs, maxRetries, skipSuccessScreen, renderCameraFeed, releaseCameraAccessOnExit, silentFallback, guidesComponent, disableCapturePreview, requireVerticalFaceCentering, assets, classNames, colors, verbiage, debugMode, }: FaceLivenessWizardProps) => ReactElement;
+export declare const FaceLivenessWizard: ({ onComplete, onSuccess, onTimeout, onExitCapture, onExitAfterFailure, onUserCancel, loadingOverlayMode, customOverlayContent, onCustomOverlayDismissed, timeoutDurationMs, maxRetries, skipSuccessScreen, renderCameraFeed, releaseCameraAccessOnExit, silentFallback, guidesComponent, disableCapturePreview, assets, classNames, colors, verbiage, debugMode, }: FaceLivenessWizardProps) => ReactElement;

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

@@ -27,6 +27,7 @@ export type SelfieCaptureVerbiage = {
     guidanceMoveForwardText?: CustomerSuppliedVerbiage;
     guidanceMoveToCenterText?: CustomerSuppliedVerbiage;
     guidanceNoFaceDetectedText?: CustomerSuppliedVerbiage;
+    guidanceNotStableText?: CustomerSuppliedVerbiage;
 };
 export type SelfieCaptureProps = {
     onGuidanceSatisfied?: () => void;
@@ -46,4 +47,4 @@ export type SelfieCaptureProps = {
     verbiage?: SelfieCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const SelfieCapture: ({ onGuidanceSatisfied, onGuidanceNotSatisfied, onSelfieCaptureStarted, onSelfieCaptured, onTimeout, onExit, timeoutDurationMs, guidanceMessage, guidanceSatisfied, guidesComponent, requireVerticalFaceCentering, shouldCapture, classNames, colors, verbiage: rawVerbiage, debugMode, }: SelfieCaptureProps) => ReactElement;
+export declare const SelfieCapture: ({ onGuidanceSatisfied, onGuidanceNotSatisfied, onSelfieCaptureStarted, onSelfieCaptured, onTimeout, onExit, timeoutDurationMs, guidanceMessage, guidanceSatisfied, guidesComponent, shouldCapture, classNames, colors, verbiage: rawVerbiage, debugMode, }: SelfieCaptureProps) => ReactElement;

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

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { MutableRefObject, ReactElement, ReactNode } from 'react';
-import { Face } from '../../lib/models/FaceDetection';
-export type SelfieGuidancePredictionHandler = (prediction: Face[]) => Promise<void> | void;
+import { FaceDetectionPrediction } from '../../lib/models/FaceDetection';
+export type SelfieGuidancePredictionHandler = (prediction: FaceDetectionPrediction) => Promise<void> | void;
 type SelfieGuidanceModelsState = {
     start: () => void;
     stop: () => void;
@@ -18,6 +18,7 @@ export type SelfieGuidanceModelsProviderProps = {
     throttleMs?: number;
     onModelError?: (error: Error) => void;
     modelLoadTimeoutMs?: number;
+    requireVerticalFaceCentering?: boolean;
 };
-export declare function SelfieGuidanceModelsProvider({ autoStart, children, throttleMs, onModelError, modelLoadTimeoutMs, }: SelfieGuidanceModelsProviderProps): ReactElement;
+export declare function SelfieGuidanceModelsProvider({ autoStart, children, throttleMs, onModelError, modelLoadTimeoutMs, requireVerticalFaceCentering, }: SelfieGuidanceModelsProviderProps): ReactElement;
 export {};

package/dist/lib/models/FaceDetection.d.ts

@@ -19,6 +19,17 @@ export type Face = {
         height: number;
     };
 };
+export type FaceDetectionPrediction = {
+    face: Face | null;
+    faceNotDetected: boolean;
+    faceNotCentered: boolean;
+    faceLookingAway: boolean;
+    faceTooClose: boolean;
+    faceTooFar: boolean;
+    faceReady: boolean;
+    faceReadyAt: Date | null;
+    faceIsStable: boolean;
+};
 export declare function loadFaceDetector(): Promise<FaceDetector>;
 export declare function useLoadFaceDetector({ onModelError, modelLoadTimeoutMs, }: {
     onModelError?: (error: Error) => void;
@@ -29,6 +40,16 @@ export declare function useLoadFaceDetector({ onModelError, modelLoadTimeoutMs,
     modelDownloadProgress: number;
     modelError: Error | null;
 };
+export declare let lastFaceDetectionAt: number;
+export declare let lastFaceDetectionTime: number;
+export declare function setLastFaceDetectionAt(time: number): void;
 export declare function makeFaceDetectorPrediction(model: FaceDetector, imageData: Frame): FaceDetectorResult & {
     faces: Face[];
 };
+export declare function processFaceDetectorPrediction({ faces, videoWidth, videoHeight, requireVerticalFaceCentering, stabilityThreshold, }: {
+    faces: Face[];
+    videoWidth: number;
+    videoHeight: number;
+    requireVerticalFaceCentering?: boolean;
+    stabilityThreshold?: number;
+}): FaceDetectionPrediction;

package/dist/lib/models/helpers.d.ts

@@ -1,5 +1,6 @@
 import { BoundingBox } from '@mediapipe/tasks-vision';
 import { MutableRefObject } from 'react';
+import { DetectedObjectBox } from './DocumentDetection';
 export declare function convertBoundingBox(box?: BoundingBox): {
     xMin: number;
     xMax: number;
@@ -9,3 +10,6 @@ export declare function convertBoundingBox(box?: BoundingBox): {
     height: number;
 };
 export declare function waitForVideoReady(videoRef: MutableRefObject<HTMLVideoElement | null>, checkEveryMs?: number): Promise<void>;
+export declare function createPairs<T>(arr: T[], maxPairs?: number): [T, T][];
+export declare function calculateIoU(boxA: DetectedObjectBox, boxB: DetectedObjectBox): number;
+export declare function average(arr: number[]): number;