idmission-web-sdk 1.1.0 → 1.1.2

package/README.md

@@ -716,6 +716,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>skipSuccessScreen</code> (optional)</td><td>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.</td></tr>
 <tr><td><code>skipIdCapture</code> (optional)</td><td>boolean to indicate whether to skip the initial ID capture flow. Note that when this flag is set, submission to IDmission's servers will not be attempted; it should be used in tandem with onSubmit. Defaults to false.</td></tr>
 <tr><td><code>skipShowIdCardBack</code> (optional)</td><td>boolean or async function to indicate whether to instruct the user to show the back of their ID card during video capture. If an async function is supplied returning a boolean, it will be evaluated at the time of ID front video capture completion. Defaults to false.</td></tr>
+<tr><td><code>mergeAVStreams</code> (optional)</td><td>boolean flag to indicate whether recorded audio should be merged onto the recorded video stream before submission. Defaults to false.</td></tr>
 <tr><td><code>assets</code> (optional)</td><td>object containing any asset overrides, for available options consult the Assets table below.</td></tr>
 <tr><td><code>colors</code> (optional)</td><td>object containing any asset overrides, for available options consult the Colors table below.</td></tr>
 <tr><td><code>verbiage</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the Verbiage table below.</td></tr>

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

@@ -131,6 +131,8 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     disableFaceDetectionWhileAudioCaptureMsDelay?: number;
     /** Flag for suppressing fallback messaging - used when models fail to load */
     silentFallback?: boolean;
+    /** Boolean flag to indicate whether recorded audio should be merged onto the recorded video stream before submission. Defaults to false. */
+    mergeAVStreams?: boolean;
     /** Name of an included theme or object containing theme properties. **/
     theme?: ThemeInput;
     /** Object containing any asset overrides. */

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

@@ -18,6 +18,7 @@ export type IdVideoCaptureClassNames = {
     countdown?: string;
     captureBtnContainer?: string;
     captureBtn?: string;
+    exitCaptureBtn?: string;
 };
 export type IdVideoCaptureColors = {
     guidesSatisfiedColor?: string;
@@ -37,6 +38,7 @@ export type IdVideoCaptureProps = {
     onIdBackImageCaptured?: (imageUrl: string) => void;
     onFaceNotDetected?: () => void;
     onRecordingFailed?: () => void;
+    onExitCapture?: () => void;
     idCaptureModelsEnabled?: boolean;
     idCardFrontDelay?: number;
     idCardFrontDetectionThreshold?: number;
@@ -52,10 +54,11 @@ export type IdVideoCaptureProps = {
     readTextMinReadingMs?: number;
     disableFaceDetectionWhileAudioCapture: boolean;
     disableFaceDetectionWhileAudioCaptureMsDelay: number;
+    mergeAVStreams?: boolean;
     assets?: IdVideoCaptureAssets;
     classNames?: IdVideoCaptureClassNames;
     colors?: IdVideoCaptureColors;
     verbiage?: IdVideoCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const IdVideoCapture: ({ onComplete, onIdFrontImageCaptured, onIdBackImageCaptured, onFaceNotDetected, onRecordingFailed, idCaptureModelsEnabled, idCardFrontDelay, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, idCardBackDetectionThreshold, idCardBackFocusThreshold, goodIdCardBackFramesThreshold, skipShowIdCardBack, captureCountdownSeconds, readTextPrompt, readTextTimeoutDurationMs, readTextMinReadingMs, disableFaceDetectionWhileAudioCapture, disableFaceDetectionWhileAudioCaptureMsDelay, assets, classNames, colors, verbiage: rawVerbiage, debugMode, }: IdVideoCaptureProps) => ReactElement;
+export declare const IdVideoCapture: ({ onComplete, onIdFrontImageCaptured, onIdBackImageCaptured, onFaceNotDetected, onRecordingFailed, onExitCapture, idCaptureModelsEnabled, idCardFrontDelay, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, idCardBackDetectionThreshold, idCardBackFocusThreshold, goodIdCardBackFramesThreshold, skipShowIdCardBack, captureCountdownSeconds, readTextPrompt, readTextTimeoutDurationMs, readTextMinReadingMs, disableFaceDetectionWhileAudioCapture, disableFaceDetectionWhileAudioCaptureMsDelay, mergeAVStreams, assets, classNames, colors, verbiage: rawVerbiage, debugMode, }: IdVideoCaptureProps) => ReactElement;

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

@@ -65,10 +65,11 @@ export type VideoIdWizardProps = {
     disableFaceDetectionWhileAudioCapture?: boolean;
     disableFaceDetectionWhileAudioCaptureMsDelay?: number;
     silentFallback?: boolean;
+    mergeAVStreams?: boolean;
     assets?: VideoIdWizardAssets;
     classNames?: VideoIdWizardClassNames;
     colors?: VideoIdWizardColors;
     verbiage?: VideoIdWizardVerbiage;
     debugMode?: boolean;
 };
-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;
+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, mergeAVStreams, assets, classNames, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;

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

@@ -1,5 +1,5 @@
 import { Camera } from './Camera';
-export declare const useVideoRecorder: (camera: Camera | null, audioStream?: MediaStream | null) => {
+export declare const useVideoRecorder: (camera: Camera | null, audioStream?: MediaStream | null, mergeAVStreams?: boolean) => {
     isRecordingVideo: boolean;
     isRecordingAudio: boolean;
     startRecordingVideo: () => void;