idmission-web-sdk 1.0.280 → 1.0.281

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

@@ -10,6 +10,8 @@ import { AdditionalDocumentCaptureWizardClassNames, AdditionalDocumentCaptureWiz
 import { SignatureCaptureClassNames, SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
 import { VideoSignatureClassNames, VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
 import { IdCaptureGuideType } from '../id_capture/IdCaptureGuides';
+import { SelfieCaptureLoadingOverlayMode } from '../selfie_capture/SelfieCaptureLoadingOverlay';
+import { IdCaptureLoadingOverlayMode } from '../id_capture/IdCaptureLoadingOverlay';
 export type VideoIdValidationAssets = VideoIdWizardAssets;
 export type VideoIdValidationClassNames = VideoIdWizardClassNames & {
     additionalDocumentCapture?: AdditionalDocumentCaptureWizardClassNames;
@@ -105,12 +107,16 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     skipIdCapture?: boolean;
     /** 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`. */
     skipShowIdCardBack?: boolean | (() => Promise<boolean>);
+    /** String indicating which ID capture loading overlay screen should be used. Supported values: 'default' and 'legacy'. Defaults to 'default'. */
+    idCaptureLoadingOverlayMode?: IdCaptureLoadingOverlayMode;
     /** String to indicate what type of guides to use during capture. Using `fit` is highly recommended in order to capture the best quality image. Valid values: `fit`, `overlay`. Defaults to `fit`. */
     idCaptureGuideType?: IdCaptureGuideType;
     /** Boolean to indicate whether guide images should be rotated on mobile. Defaults to `false`. */
     idCapturePortraitGuidesOnMobile?: boolean;
     /** Boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to `true`. */
     idCaptureRotateLoadingOverlayImageWhenPortrait?: boolean;
+    /** String indicating which face liveness loading overlay screen should be used. Supported values: 'default' and 'legacy'. Defaults to 'default'. */
+    faceLivenessLoadingOverlayMode?: SelfieCaptureLoadingOverlayMode;
     /** Name of an included theme or object containing theme properties. **/
     theme?: ThemeInput;
     /** Object containing any asset overrides. */

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

@@ -6,6 +6,8 @@ import { IdVideoCaptureSuccessClassNames, IdVideoCaptureSuccessColors, IdVideoCa
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 import { LivenessCheckRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { IdCaptureGuideType } from '../id_capture/IdCaptureGuides';
+import { IdCaptureLoadingOverlayMode } from '../id_capture/IdCaptureLoadingOverlay';
+import { SelfieCaptureLoadingOverlayMode } from '../selfie_capture/SelfieCaptureLoadingOverlay';
 export type VideoIdWizardAssets = {
     idCapture?: IdCaptureWizardAssets;
     faceLiveness?: FaceLivenessAssets;
@@ -49,13 +51,15 @@ export type VideoIdWizardProps = {
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
     skipIdCapture?: boolean;
     skipShowIdCardBack?: boolean | (() => Promise<boolean>);
+    idCaptureLoadingOverlayMode?: IdCaptureLoadingOverlayMode;
     idCaptureGuideType?: IdCaptureGuideType;
     idCapturePortraitGuidesOnMobile?: boolean;
     idCaptureRotateLoadingOverlayImageWhenPortrait?: boolean;
+    faceLivenessLoadingOverlayMode?: SelfieCaptureLoadingOverlayMode;
     assets?: VideoIdWizardAssets;
     classNames?: VideoIdWizardClassNames;
     colors?: VideoIdWizardColors;
     verbiage?: VideoIdWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const VideoIdWizard: ({ onComplete, onExitCapture, onExitAfterFailure, onUserCancel, idCaptureProps, faceLivenessProps, idCardFrontDetectionThreshold, idCardBackDetectionThreshold, idCardFrontFocusThreshold, idCardBackFocusThreshold, goodIdCardFrontFramesThreshold, goodIdCardBackFramesThreshold, readTextPrompt, readTextTimeoutDurationMs, skipIdCapture, skipShowIdCardBack, skipSuccessScreen, idCaptureGuideType, idCapturePortraitGuidesOnMobile, idCaptureRotateLoadingOverlayImageWhenPortrait, assets, classNames, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;
+export declare const VideoIdWizard: ({ onComplete, onExitCapture, onExitAfterFailure, onUserCancel, idCaptureProps, faceLivenessProps, idCardFrontDetectionThreshold, idCardBackDetectionThreshold, idCardFrontFocusThreshold, idCardBackFocusThreshold, goodIdCardFrontFramesThreshold, goodIdCardBackFramesThreshold, readTextPrompt, readTextTimeoutDurationMs, skipIdCapture, skipShowIdCardBack, skipSuccessScreen, idCaptureLoadingOverlayMode, idCaptureGuideType, idCapturePortraitGuidesOnMobile, idCaptureRotateLoadingOverlayImageWhenPortrait, faceLivenessLoadingOverlayMode, assets, classNames, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;

package/dist/index.d.ts

@@ -7,7 +7,7 @@ import { CustomerIdentification, CustomerIdentificationProps } from './component
 import { SignatureKYC, SignatureKYCProps } from './components/customer_flows/SignatureKYC';
 import { VideoIdValidation, VideoIdValidationProps } from './components/customer_flows/VideoIdValidation';
 import { preloadModels } from './lib/models/preloadModels';
-import { CustomerBiometricsEnrollment } from './components/customer_flows/CustomerBiometricsEnrollment';
+import { CustomerBiometricsEnrollment, CustomerBiometricsEnrollmentProps } from './components/customer_flows/CustomerBiometricsEnrollment';
 import { Theme, themes } from './themes';
 import { SubmissionRequest, SubmissionResponse } from './contexts/SubmissionContext';
 import { DocumentCapture, DocumentCaptureProps } from './components/customer_flows/DocumentCapture';
@@ -17,7 +17,7 @@ export declare const renderIdValidation: (optionsOrTargetElement: TargetElement
 export declare const renderFaceValidation: (optionsOrTargetElement: TargetElement | FaceValidationProps, options?: FaceValidationProps) => Element | DocumentFragment;
 export declare const renderIdAndFaceValidation: (optionsOrTargetElement: TargetElement | IdAndFaceValidationProps, options?: IdAndFaceValidationProps) => Element | DocumentFragment;
 export declare const renderCustomerIdAndBiometricsEnrollment: (optionsOrTargetElement: TargetElement | CustomerEnrollmentProps, options?: CustomerEnrollmentProps) => Element | DocumentFragment;
-export declare const renderCustomerBiometricsEnrollment: (optionsOrTargetElement: TargetElement | CustomerEnrollmentProps, options?: CustomerEnrollmentProps) => Element | DocumentFragment;
+export declare const renderCustomerBiometricsEnrollment: (optionsOrTargetElement: TargetElement | CustomerBiometricsEnrollmentProps, options?: CustomerBiometricsEnrollmentProps) => Element | DocumentFragment;
 export declare const renderCustomerVerification: (optionsOrTargetElement: TargetElement | CustomerVerificationProps, options?: CustomerVerificationProps) => Element | DocumentFragment;
 export declare const renderCustomerIdentification: (optionsOrTargetElement: TargetElement | CustomerIdentificationProps, options?: CustomerIdentificationProps) => Element | DocumentFragment;
 export declare const renderSignatureKYC: (optionsOrTargetElement: TargetElement | SignatureKYCProps, options?: SignatureKYCProps) => Element | DocumentFragment;

package/dist/sdk2.cjs.development.js

@@ -50,7 +50,7 @@ var LanguageDetector__default = /*#__PURE__*/_interopDefaultLegacy(LanguageDetec
 var i18n__default = /*#__PURE__*/_interopDefaultLegacy(i18n);
 var SignatureCanvas__default = /*#__PURE__*/_interopDefaultLegacy(SignatureCanvas);
 
-var webSdkVersion = '1.0.280';
+var webSdkVersion = '1.0.281';
 
 function getPlatform() {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -15844,31 +15844,35 @@ var VideoIdWizard = function VideoIdWizard(_a) {
     skipShowIdCardBack = _k === void 0 ? false : _k,
     _l = _a.skipSuccessScreen,
     skipSuccessScreen = _l === void 0 ? false : _l,
-    _m = _a.idCaptureGuideType,
-    idCaptureGuideType = _m === void 0 ? 'fit' : _m,
-    _o = _a.idCapturePortraitGuidesOnMobile,
-    idCapturePortraitGuidesOnMobile = _o === void 0 ? false : _o,
-    _p = _a.idCaptureRotateLoadingOverlayImageWhenPortrait,
-    idCaptureRotateLoadingOverlayImageWhenPortrait = _p === void 0 ? true : _p,
-    _q = _a.assets,
-    assets = _q === void 0 ? {} : _q,
-    _r = _a.classNames,
-    classNames = _r === void 0 ? {} : _r,
-    _s = _a.colors,
-    colors = _s === void 0 ? {} : _s,
-    _t = _a.verbiage,
-    verbiage = _t === void 0 ? {} : _t,
-    _u = _a.debugMode,
-    debugMode = _u === void 0 ? false : _u;
-  var _v = React.useContext(SubmissionContext),
-    submissionStatus = _v.submissionStatus,
-    idCaptureVideoUrl = _v.idCaptureVideoUrl,
-    setIdCaptureVideoUrl = _v.setIdCaptureVideoUrl,
-    setIdCaptureVideoIdFrontImage = _v.setIdCaptureVideoIdFrontImage,
-    setIdCaptureVideoIdBackImage = _v.setIdCaptureVideoIdBackImage;
-  var _w = React.useState('CAPTURING_ID'),
-    captureState = _w[0],
-    setCaptureState = _w[1];
+    _m = _a.idCaptureLoadingOverlayMode,
+    idCaptureLoadingOverlayMode = _m === void 0 ? 'legacy' : _m,
+    _o = _a.idCaptureGuideType,
+    idCaptureGuideType = _o === void 0 ? 'fit' : _o,
+    _p = _a.idCapturePortraitGuidesOnMobile,
+    idCapturePortraitGuidesOnMobile = _p === void 0 ? false : _p,
+    _q = _a.idCaptureRotateLoadingOverlayImageWhenPortrait,
+    idCaptureRotateLoadingOverlayImageWhenPortrait = _q === void 0 ? true : _q,
+    _r = _a.faceLivenessLoadingOverlayMode,
+    faceLivenessLoadingOverlayMode = _r === void 0 ? 'legacy' : _r,
+    _s = _a.assets,
+    assets = _s === void 0 ? {} : _s,
+    _t = _a.classNames,
+    classNames = _t === void 0 ? {} : _t,
+    _u = _a.colors,
+    colors = _u === void 0 ? {} : _u,
+    _v = _a.verbiage,
+    verbiage = _v === void 0 ? {} : _v,
+    _w = _a.debugMode,
+    debugMode = _w === void 0 ? false : _w;
+  var _x = React.useContext(SubmissionContext),
+    submissionStatus = _x.submissionStatus,
+    idCaptureVideoUrl = _x.idCaptureVideoUrl,
+    setIdCaptureVideoUrl = _x.setIdCaptureVideoUrl,
+    setIdCaptureVideoIdFrontImage = _x.setIdCaptureVideoIdFrontImage,
+    setIdCaptureVideoIdBackImage = _x.setIdCaptureVideoIdBackImage;
+  var _y = React.useState('CAPTURING_ID'),
+    captureState = _y[0],
+    setCaptureState = _y[1];
   React.useEffect(function () {
     if (skipIdCapture && captureState === 'CAPTURING_ID') setCaptureState('CHECKING_LIVENESS');
   }, [captureState, skipIdCapture]);
@@ -15898,9 +15902,9 @@ var VideoIdWizard = function VideoIdWizard(_a) {
   var onVideoCaptureFaceNotDetected = React.useCallback(function () {
     setCaptureState('CHECKING_LIVENESS');
   }, []);
-  var _x = React.useState(0),
-    attempt = _x[0],
-    setAttempt = _x[1];
+  var _z = React.useState(0),
+    attempt = _z[0],
+    setAttempt = _z[1];
   var userSuppliedExitAfterFailure = onExitAfterFailure !== null && onExitAfterFailure !== void 0 ? onExitAfterFailure : faceLivenessProps.onExitAfterFailure;
   var onFaceCaptureExitAfterFailure = React.useCallback(function (resp, req) {
     userSuppliedExitAfterFailure === null || userSuppliedExitAfterFailure === void 0 ? void 0 : userSuppliedExitAfterFailure(resp, req);
@@ -15945,7 +15949,7 @@ var VideoIdWizard = function VideoIdWizard(_a) {
       case 'CAPTURING_ID':
         return /*#__PURE__*/React__default['default'].createElement(IdCaptureStateProvider, null, /*#__PURE__*/React__default['default'].createElement(GuideOrientationProvider, null, /*#__PURE__*/React__default['default'].createElement(IdCaptureWizard, tslib.__assign({
           key: "id-capture-".concat(attempt),
-          loadingOverlayMode: "legacy"
+          loadingOverlayMode: idCaptureLoadingOverlayMode
         }, idCaptureProps, {
           assets: assets.idCapture,
           classNames: classNames.idCapture,
@@ -15964,7 +15968,7 @@ var VideoIdWizard = function VideoIdWizard(_a) {
       case 'CHECKING_LIVENESS':
         return /*#__PURE__*/React__default['default'].createElement(FaceLivenessWizard, tslib.__assign({
           key: "face-liveness-".concat(attempt),
-          loadingOverlayMode: "legacy"
+          loadingOverlayMode: faceLivenessLoadingOverlayMode
         }, faceLivenessProps, {
           onComplete: onFaceCaptureSuccess,
           onExitCapture: onExitCapture,
@@ -18213,34 +18217,38 @@ var VideoIdValidation = function VideoIdValidation(_a) {
     skipIdCapture = _l === void 0 ? false : _l,
     _m = _a.skipShowIdCardBack,
     skipShowIdCardBack = _m === void 0 ? false : _m,
-    _o = _a.idCaptureGuideType,
-    idCaptureGuideType = _o === void 0 ? 'fit' : _o,
-    _p = _a.idCapturePortraitGuidesOnMobile,
-    idCapturePortraitGuidesOnMobile = _p === void 0 ? false : _p,
-    _q = _a.idCaptureRotateLoadingOverlayImageWhenPortrait,
-    idCaptureRotateLoadingOverlayImageWhenPortrait = _q === void 0 ? true : _q,
-    _r = _a.theme,
-    theme = _r === void 0 ? 'default' : _r,
-    _s = _a.assets,
-    assets = _s === void 0 ? {} : _s,
-    _t = _a.classNames,
-    classNames = _t === void 0 ? {} : _t,
-    _u = _a.colors,
-    colors = _u === void 0 ? {} : _u,
-    _v = _a.verbiage,
-    verbiage = _v === void 0 ? {} : _v,
-    _w = _a.captureSignature,
-    captureSignature = _w === void 0 ? false : _w,
-    _x = _a.captureSignatureVideo,
-    captureSignatureVideo = _x === void 0 ? false : _x,
-    _y = _a.captureAdditionalDocuments,
-    captureAdditionalDocuments = _y === void 0 ? [] : _y,
-    _z = _a.geolocationEnabled,
-    geolocationEnabled = _z === void 0 ? true : _z,
-    _0 = _a.geolocationRequired,
-    geolocationRequired = _0 === void 0 ? false : _0,
-    _1 = _a.debugMode,
-    debugMode = _1 === void 0 ? false : _1;
+    _o = _a.idCaptureLoadingOverlayMode,
+    idCaptureLoadingOverlayMode = _o === void 0 ? 'legacy' : _o,
+    _p = _a.idCaptureGuideType,
+    idCaptureGuideType = _p === void 0 ? 'fit' : _p,
+    _q = _a.idCapturePortraitGuidesOnMobile,
+    idCapturePortraitGuidesOnMobile = _q === void 0 ? false : _q,
+    _r = _a.idCaptureRotateLoadingOverlayImageWhenPortrait,
+    idCaptureRotateLoadingOverlayImageWhenPortrait = _r === void 0 ? true : _r,
+    _s = _a.faceLivenessLoadingOverlayMode,
+    faceLivenessLoadingOverlayMode = _s === void 0 ? 'legacy' : _s,
+    _t = _a.theme,
+    theme = _t === void 0 ? 'default' : _t,
+    _u = _a.assets,
+    assets = _u === void 0 ? {} : _u,
+    _v = _a.classNames,
+    classNames = _v === void 0 ? {} : _v,
+    _w = _a.colors,
+    colors = _w === void 0 ? {} : _w,
+    _x = _a.verbiage,
+    verbiage = _x === void 0 ? {} : _x,
+    _y = _a.captureSignature,
+    captureSignature = _y === void 0 ? false : _y,
+    _z = _a.captureSignatureVideo,
+    captureSignatureVideo = _z === void 0 ? false : _z,
+    _0 = _a.captureAdditionalDocuments,
+    captureAdditionalDocuments = _0 === void 0 ? [] : _0,
+    _1 = _a.geolocationEnabled,
+    geolocationEnabled = _1 === void 0 ? true : _1,
+    _2 = _a.geolocationRequired,
+    geolocationRequired = _2 === void 0 ? false : _2,
+    _3 = _a.debugMode,
+    debugMode = _3 === void 0 ? false : _3;
   useLanguage(lang);
   var videoIdCaptureProps = React.useMemo(function () {
     return {
@@ -18260,16 +18268,18 @@ var VideoIdValidation = function VideoIdValidation(_a) {
       skipSuccessScreen: skipSuccessScreen,
       skipIdCapture: skipIdCapture,
       skipShowIdCardBack: skipShowIdCardBack,
+      idCaptureLoadingOverlayMode: idCaptureLoadingOverlayMode,
       idCaptureGuideType: idCaptureGuideType,
       idCapturePortraitGuidesOnMobile: idCapturePortraitGuidesOnMobile,
       idCaptureRotateLoadingOverlayImageWhenPortrait: idCaptureRotateLoadingOverlayImageWhenPortrait,
+      faceLivenessLoadingOverlayMode: faceLivenessLoadingOverlayMode,
       assets: assets,
       classNames: classNames,
       colors: colors,
       verbiage: verbiage,
       debugMode: debugMode
     };
-  }, [assets, classNames, colors, debugMode, faceLivenessProps, goodIdCardBackFramesThreshold, goodIdCardFrontFramesThreshold, idCaptureGuideType, idCapturePortraitGuidesOnMobile, idCaptureProps, idCaptureRotateLoadingOverlayImageWhenPortrait, idCardBackDetectionThreshold, idCardBackFocusThreshold, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, onExitAfterFailure, onExitCapture, onUserCancel, readTextPrompt, readTextTimeoutDurationMs, skipIdCapture, skipShowIdCardBack, skipSuccessScreen, verbiage]);
+  }, [assets, classNames, colors, debugMode, faceLivenessLoadingOverlayMode, faceLivenessProps, goodIdCardBackFramesThreshold, goodIdCardFrontFramesThreshold, idCaptureGuideType, idCaptureLoadingOverlayMode, idCapturePortraitGuidesOnMobile, idCaptureProps, idCaptureRotateLoadingOverlayImageWhenPortrait, idCardBackDetectionThreshold, idCardBackFocusThreshold, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, onExitAfterFailure, onExitCapture, onUserCancel, readTextPrompt, readTextTimeoutDurationMs, skipIdCapture, skipShowIdCardBack, skipSuccessScreen, verbiage]);
   var additionalDocumentCaptureProps = React.useMemo(function () {
     return {
       documents: captureAdditionalDocuments,