idmission-web-sdk 1.0.28 → 1.0.30

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

@@ -1,6 +1,12 @@
 import { FC, PropsWithChildren } from 'react';
 import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
-import { LangOption } from '../../lib/locales';
+import { CustomerSuppliedVerbiage, LangOption } from '../../lib/locales';
+import { VideoIdWizardAssets, VideoIdWizardColors, VideoIdWizardVerbiage } from '../video_id/IdVideoCaptureWizard';
+import { IdCaptureWizardProps } from '../id_capture/IdCaptureWizard';
+import { FaceLivenessWizardProps } from '../face_liveness/FaceLivenessWizard';
+export type VideoIdValidationAssets = VideoIdWizardAssets;
+export type VideoIdValidationColors = VideoIdWizardColors;
+export type VideoIdValidationVerbiage = VideoIdWizardVerbiage;
 export interface VideoIdValidationProps extends PropsWithChildren {
     lang?: LangOption;
     submissionToken: string;
@@ -8,9 +14,17 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     submissionUrl?: string;
     onBeforeSubmit?: (request: SubmissionRequest) => Promise<SubmissionRequest>;
     onComplete?: (submissionResponse: SubmissionResponse) => void;
+    onExitAfterFailure?: (submissionResponse: SubmissionResponse | null) => void;
+    idCaptureProps?: IdCaptureWizardProps;
+    faceLivenessProps?: FaceLivenessWizardProps;
+    readTextPrompt?: CustomerSuppliedVerbiage;
+    readTextTimeoutDurationMs?: number;
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
     geolocationEnabled?: boolean;
     geolocationRequired?: boolean;
+    assets?: VideoIdValidationAssets;
+    colors?: VideoIdValidationColors;
+    verbiage?: VideoIdValidationVerbiage;
     debugMode?: boolean;
 }
 export declare const VideoIdValidation: FC<VideoIdValidationProps>;

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

@@ -1,16 +1,33 @@
 import { ReactElement } from 'react';
+import { IdVideoCaptureGuidesAssets, IdVideoCaptureGuidesVerbiage } from './IdVideoCaptureGuides';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
+import { LoaderButtonColors } from '../common/LoaderButton';
+export type Action = 'SHOW_ID_FRONT' | 'FLIP_ID' | 'SHOW_ID_BACK' | 'READ_TEXT';
+export type IdVideoCaptureAssets = {
+    guides?: IdVideoCaptureGuidesAssets;
+};
+export type IdVideoCaptureColors = {
+    guidesSatisfiedColor?: string;
+    guidesUnsatisfiedColor?: string;
+    readTextDoneBtn?: LoaderButtonColors;
+};
 export type IdVideoCaptureVerbiage = {
-    idFrontInstructionText?: CustomerSuppliedVerbiage;
-    idBackInstructionText?: CustomerSuppliedVerbiage;
+    guides?: IdVideoCaptureGuidesVerbiage;
+    readTextHeading?: CustomerSuppliedVerbiage;
+    readTextDoneBtnText?: CustomerSuppliedVerbiage;
 };
 export type IdVideoCaptureProps = {
     onComplete?: (videoUrl: string) => void;
     onFaceNotDetected?: () => void;
-    idDetectionThreshold?: number;
-    idFocusThreshold?: number;
-    goodFramesThreshold?: number;
+    idCardFrontDetectionThreshold?: number;
+    idCardFrontFocusThreshold?: number;
+    goodIdCardFrontFramesThreshold?: number;
+    showIdCardBackDurationMs?: number;
+    readTextPrompt?: CustomerSuppliedVerbiage;
+    readTextTimeoutDurationMs?: number;
+    assets?: IdVideoCaptureAssets;
+    colors?: IdVideoCaptureColors;
     verbiage?: IdVideoCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const IdVideoCapture: ({ onComplete, onFaceNotDetected, idDetectionThreshold, idFocusThreshold, goodFramesThreshold, verbiage: rawVerbiage, debugMode, }: IdVideoCaptureProps) => ReactElement;
+export declare const IdVideoCapture: ({ onComplete, onFaceNotDetected, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, showIdCardBackDurationMs, readTextPrompt, readTextTimeoutDurationMs, assets, colors, verbiage: rawVerbiage, debugMode, }: IdVideoCaptureProps) => ReactElement;

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

@@ -8,8 +8,10 @@ export type IdVideoCaptureFlipIdPromptVerbiage = {
     instructionText?: CustomerSuppliedVerbiage;
 };
 export type IdVideoCaptureFlipIdPromptProps = {
+    imageWidth?: number;
+    imageHeight?: number;
     style?: CSSProperties;
     assets?: IdVideoCaptureFlipIdPromptAssets;
     verbiage?: IdVideoCaptureFlipIdPromptVerbiage;
 };
-export declare const IdVideoCaptureFlipIdPrompt: ({ style, assets, verbiage, }: IdVideoCaptureFlipIdPromptProps) => ReactElement;
+export declare const IdVideoCaptureFlipIdPrompt: ({ imageWidth, imageHeight, style, assets, verbiage, }: IdVideoCaptureFlipIdPromptProps) => ReactElement;

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

@@ -1,9 +1,20 @@
 import { ReactElement } from 'react';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
+export type Action = 'SHOW_ID_FRONT' | 'FLIP_ID' | 'SHOW_ID_BACK' | 'READ_TEXT';
+export type IdVideoCaptureGuidesAssets = {
+    frontImageUrl?: string;
+    backImageUrl?: string;
+};
+export type IdVideoCaptureGuidesVerbiage = {
+    idFrontInstructionText?: CustomerSuppliedVerbiage;
+    idBackInstructionText?: CustomerSuppliedVerbiage;
+    flipIdInstructionText?: CustomerSuppliedVerbiage;
+};
 export type IdVideoCaptureGuidesProps = {
-    instructionText?: string;
     borderWidth?: number;
     borderColor?: string;
-    guideImageUrl?: string;
-    flipping?: boolean;
+    requestedAction?: Action;
+    assets?: IdVideoCaptureGuidesAssets;
+    verbiage?: IdVideoCaptureGuidesVerbiage;
 };
-export declare const IdVideoCaptureGuides: ({ instructionText, borderWidth, borderColor, guideImageUrl, flipping, }: IdVideoCaptureGuidesProps) => ReactElement;
+export declare const IdVideoCaptureGuides: ({ requestedAction, borderWidth, borderColor, assets, verbiage: rawVerbiage, }: IdVideoCaptureGuidesProps) => ReactElement;

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

@@ -1,24 +1,37 @@
 import { ReactElement } from 'react';
 import { IdCaptureWizardAssets, IdCaptureWizardColors, IdCaptureWizardProps, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
-import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
+import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage, FaceLivenessWizardProps } from '../face_liveness/FaceLivenessWizard';
+import { IdVideoCaptureAssets, IdVideoCaptureColors, IdVideoCaptureVerbiage } from './IdVideoCapture';
+import { IdVideoCaptureSuccessColors, IdVideoCaptureSuccessVerbiage } from './IdVideoCaptureSuccess';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
+import { SubmissionResponse } from '../../contexts/SubmissionContext';
 export type VideoIdWizardAssets = {
     idCapture?: IdCaptureWizardAssets;
     faceLiveness?: FaceLivenessAssets;
+    idVideoCapture?: IdVideoCaptureAssets;
 };
 export type VideoIdWizardColors = {
     idCapture?: IdCaptureWizardColors;
     faceLiveness?: FaceLivenessColors;
+    idVideoCapture?: IdVideoCaptureColors;
+    success?: IdVideoCaptureSuccessColors;
 };
 export type VideoIdWizardVerbiage = {
     idCapture?: IdCaptureWizardVerbiage;
     faceLiveness?: FaceLivenessVerbiage;
+    idVideoCapture?: IdVideoCaptureVerbiage;
+    success?: IdVideoCaptureSuccessVerbiage;
 };
 export type VideoIdWizardProps = {
     idCaptureProps?: IdCaptureWizardProps;
+    faceLivenessProps?: FaceLivenessWizardProps;
+    onExitAfterFailure?: (submissionResponse: SubmissionResponse | null) => void;
+    readTextPrompt?: CustomerSuppliedVerbiage;
+    readTextTimeoutDurationMs?: number;
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
     assets?: VideoIdWizardAssets;
     colors?: VideoIdWizardColors;
     verbiage?: VideoIdWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const VideoIdWizard: ({ idCaptureProps, assets, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;
+export declare const VideoIdWizard: ({ idCaptureProps, faceLivenessProps, onExitAfterFailure, readTextPrompt, readTextTimeoutDurationMs, assets, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;

package/dist/contexts/SubmissionContext.d.ts

@@ -46,6 +46,7 @@ export type SubmissionRequest = {
     };
     biometricData?: {
         selfie?: string;
+        videoData?: string;
     };
     additionalData: {
         uniqueRequestId: string;
@@ -161,14 +162,16 @@ export type SubmissionState = {
     passportImage: string | null;
     selfieImage: string | null;
     signatureData: SignatureData | null;
-    signatureVideo: string | null;
+    signatureVideoUrl: string | null;
+    idCaptureVideoUrl: string | null;
     additionalDocuments: UploadedDocument[] | null;
     setIdFrontImage: (image: string) => void;
     setIdBackImage: (image: string) => void;
     setPassportImage: (image: string) => void;
     setSelfieImage: (image: string) => void;
     setSignatureData: (signatureData: SignatureData) => void;
-    setSignatureVideo: (videoB64: string) => void;
+    setSignatureVideoUrl: (videoDataUrl: string) => void;
+    setIdCaptureVideoUrl: (videoDataUrl: string) => void;
     setAdditionalDocuments: (uploadedDocuments: UploadedDocument[]) => void;
     logIdFrontCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
     logIdBackCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
@@ -187,3 +190,4 @@ export declare function attachMetadataToRequest(request: SubmissionRequest | Liv
     idBackCaptureAttempts: CaptureAttemptMetadata[];
     geolocationResult: GeolocationPosition | null;
 }): void;
+export declare function videoDataUrlToB64(url: string): Promise<string>;

package/dist/lib/camera/Camera.d.ts

@@ -22,8 +22,9 @@ type Resolution = {
 };
 export declare const quickScan: Resolution[];
 export type FacingMode = 'user' | 'environment' | 'left' | 'right';
-export declare function listAvailableCameras(facingMode?: FacingMode): Promise<MediaDeviceInfo[]>;
-declare function releaseCameraAccess(): void;
+export declare function listAvailableCameras(facingMode?: FacingMode, requestMicAccess?: boolean): Promise<MediaDeviceInfo[]>;
+export declare function obtainCameraAccess(stream: MediaStream, deviceLabel: string, video?: HTMLVideoElement | null): Camera;
+export declare function releaseCameraAccess(): void;
 export declare const useHighestResCaptureDevice: ({ preferFrontFacingCamera, preferContinuityCamera, requestMicrophoneAccess, }?: {
     preferFrontFacingCamera: boolean;
     preferContinuityCamera: boolean;

package/dist/lib/utils/useTimeout.d.ts

@@ -1,4 +1,4 @@
-export declare const useTimeout: (durationMs?: number, onTimeout?: () => void, timeoutAverted?: boolean, shouldWaitLonger?: boolean) => {
+export declare const useTimeout: (durationMs?: number, onTimeout?: () => void, timeoutAverted?: boolean, shouldWaitLonger?: boolean, shouldStart?: boolean) => {
     timedOut: boolean;
     timeoutStartedAt: Date | null | undefined;
 };