idmission-web-sdk 1.0.26 → 1.0.28

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

@@ -26,9 +26,10 @@ export type FaceLivenessWizardProps = {
     timeoutDurationMs?: number;
     maxRetries?: number;
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    releaseCameraAccessOnExit?: boolean;
     assets?: FaceLivenessAssets;
     colors?: FaceLivenessColors;
     verbiage?: FaceLivenessVerbiage;
     debugMode?: boolean;
 };
-export declare const FaceLivenessWizard: ({ onComplete, onSuccess, onTimeout, onExitAfterFailure, timeoutDurationMs, maxRetries, skipSuccessScreen, assets, colors, verbiage, debugMode, }: FaceLivenessWizardProps) => ReactElement;
+export declare const FaceLivenessWizard: ({ onComplete, onSuccess, onTimeout, onExitAfterFailure, timeoutDurationMs, maxRetries, skipSuccessScreen, releaseCameraAccessOnExit, assets, colors, verbiage, debugMode, }: FaceLivenessWizardProps) => ReactElement;

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

@@ -44,9 +44,10 @@ export type IdCaptureWizardProps = {
     idCardFocusScoreThreshold?: number;
     passportFocusScoreThreshold?: number;
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    releaseCameraAccessOnExit?: boolean;
     assets?: IdCaptureWizardAssets;
     colors?: IdCaptureWizardColors;
     verbiage?: IdCaptureWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const IdCaptureWizard: ({ onSuccess, autoCaptureEnabled, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, skipSuccessScreen, assets, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;
+export declare const IdCaptureWizard: ({ onSuccess, autoCaptureEnabled, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, skipSuccessScreen, releaseCameraAccessOnExit, assets, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;

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

@@ -1,8 +1,9 @@
 import { ReactElement } from 'react';
 import { IdCaptureWizardAssets, IdCaptureWizardColors, IdCaptureWizardProps, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
-import { FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
+import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 export type VideoIdWizardAssets = {
     idCapture?: IdCaptureWizardAssets;
+    faceLiveness?: FaceLivenessAssets;
 };
 export type VideoIdWizardColors = {
     idCapture?: IdCaptureWizardColors;

package/dist/sdk2.cjs.development.js

@@ -50,7 +50,7 @@ var tf__namespace = /*#__PURE__*/_interopNamespace(tf);
 var useResizeObserver__default = /*#__PURE__*/_interopDefaultLegacy(useResizeObserver);
 var SignatureCanvas__default = /*#__PURE__*/_interopDefaultLegacy(SignatureCanvas);
 
-var webSdkVersion = '1.0.26';
+var webSdkVersion = '1.0.28';
 
 function getPlatform() {
   return window.platform;
@@ -10347,29 +10347,31 @@ var IdCaptureWizard = function IdCaptureWizard(_a) {
     passportFocusScoreThreshold = _v === void 0 ? 0.3 : _v,
     _w = _a.skipSuccessScreen,
     skipSuccessScreen = _w === void 0 ? false : _w,
-    _x = _a.assets,
-    assets = _x === void 0 ? {} : _x,
-    _y = _a.colors,
-    colors = _y === void 0 ? {} : _y,
-    _z = _a.verbiage,
-    verbiage = _z === void 0 ? {} : _z,
-    _0 = _a.debugMode,
-    debugMode = _0 === void 0 ? false : _0;
-  var _1 = React.useReducer(reducer$4, initialState$4),
-    state = _1[0],
-    dispatch = _1[1];
+    _x = _a.releaseCameraAccessOnExit,
+    releaseCameraAccessOnExit = _x === void 0 ? true : _x,
+    _y = _a.assets,
+    assets = _y === void 0 ? {} : _y,
+    _z = _a.colors,
+    colors = _z === void 0 ? {} : _z,
+    _0 = _a.verbiage,
+    verbiage = _0 === void 0 ? {} : _0,
+    _1 = _a.debugMode,
+    debugMode = _1 === void 0 ? false : _1;
+  var _2 = React.useReducer(reducer$4, initialState$4),
+    state = _2[0],
+    dispatch = _2[1];
   var releaseCameraAccess = React.useContext(CameraStateContext).releaseCameraAccess;
-  var _2 = React.useState(false),
-    overlayDismissed = _2[0],
-    setOverlayDismissed = _2[1];
-  var _3 = React.useContext(SubmissionContext),
-    submissionStatus = _3.submissionStatus,
-    submissionResponse = _3.submissionResponse,
-    setIdFrontImage = _3.setIdFrontImage,
-    setIdBackImage = _3.setIdBackImage,
-    setPassportImage = _3.setPassportImage,
-    logIdFrontCaptureAttempt = _3.logIdFrontCaptureAttempt,
-    logIdBackCaptureAttempt = _3.logIdBackCaptureAttempt;
+  var _3 = React.useState(false),
+    overlayDismissed = _3[0],
+    setOverlayDismissed = _3[1];
+  var _4 = React.useContext(SubmissionContext),
+    submissionStatus = _4.submissionStatus,
+    submissionResponse = _4.submissionResponse,
+    setIdFrontImage = _4.setIdFrontImage,
+    setIdBackImage = _4.setIdBackImage,
+    setPassportImage = _4.setPassportImage,
+    logIdFrontCaptureAttempt = _4.logIdFrontCaptureAttempt,
+    logIdBackCaptureAttempt = _4.logIdBackCaptureAttempt;
   var modelsError = React.useContext(IdCaptureModelsContext).error;
   var operationStartedAt = React.useRef();
   React.useEffect(function () {
@@ -10417,7 +10419,7 @@ var IdCaptureWizard = function IdCaptureWizard(_a) {
     setIdFrontImage(idFrontImage);
     setIdBackImage(idBackImage);
     setPassportImage(passportImage);
-    releaseCameraAccess();
+    releaseCameraAccessOnExit && releaseCameraAccess();
     setTimeout(function () {
       onSuccess === null || onSuccess === void 0 ? void 0 : onSuccess({
         idFrontImage: idFrontImage,
@@ -10425,16 +10427,16 @@ var IdCaptureWizard = function IdCaptureWizard(_a) {
         passportImage: passportImage
       });
     }, 0);
-  }, [onSuccess, releaseCameraAccess, setIdBackImage, setIdFrontImage, setPassportImage, state.capturedDocuments]);
+  }, [onSuccess, releaseCameraAccess, releaseCameraAccessOnExit, setIdBackImage, setIdFrontImage, setPassportImage, state.capturedDocuments]);
   var showSuccessScreen = useShowSuccessScreen(skipSuccessScreen, state.captureState === CaptureState.COMPLETE, onSubmitClick);
   var onRetryClick = React.useCallback(function () {
     dispatch({
       type: 'reset'
     });
   }, []);
-  var _4 = React.useState(0),
-    attempt = _4[0],
-    setAttempt = _4[1];
+  var _5 = React.useState(0),
+    attempt = _5[0],
+    setAttempt = _5[1];
   var onExit = React.useCallback(function () {
     setOverlayDismissed(false);
     setAttempt(function (n) {
@@ -10446,9 +10448,9 @@ var IdCaptureWizard = function IdCaptureWizard(_a) {
   }, []);
   React.useEffect(function () {
     if (submissionStatus !== SubmissionStatus.READY) {
-      releaseCameraAccess();
+      releaseCameraAccessOnExit && releaseCameraAccess();
     }
-  }, [releaseCameraAccess, submissionStatus]);
+  }, [releaseCameraAccess, releaseCameraAccessOnExit, submissionStatus]);
   assets.idCardFront || (assets.idCardFront = {});
   (_b = assets.idCardFront).portraitGuidesImageUrl || (_b.portraitGuidesImageUrl = "".concat(DEFAULT_CDN_URL, "/Shieldout-IDCard-Front-SVG-Portrait-2.svg"));
   (_c = assets.idCardFront).landscapeGuidesImageUrl || (_c.landscapeGuidesImageUrl = "".concat(DEFAULT_CDN_URL, "/Shieldout-IDCard-Front-SVG-Landscape-2.svg"));
@@ -11644,28 +11646,30 @@ var FaceLivenessWizard = function FaceLivenessWizard(_a) {
     maxRetries = _c === void 0 ? 2 : _c,
     _d = _a.skipSuccessScreen,
     skipSuccessScreen = _d === void 0 ? false : _d,
-    _e = _a.assets,
-    assets = _e === void 0 ? {} : _e,
-    _f = _a.colors,
-    colors = _f === void 0 ? {} : _f,
-    _g = _a.verbiage,
-    verbiage = _g === void 0 ? {} : _g,
-    _h = _a.debugMode,
-    debugMode = _h === void 0 ? false : _h;
-  var _j = React.useContext(SubmissionContext),
-    submissionResponse = _j.submissionResponse,
-    setSelfieImage = _j.setSelfieImage,
-    logSelfieCaptureAttempt = _j.logSelfieCaptureAttempt;
+    _e = _a.releaseCameraAccessOnExit,
+    releaseCameraAccessOnExit = _e === void 0 ? true : _e,
+    _f = _a.assets,
+    assets = _f === void 0 ? {} : _f,
+    _g = _a.colors,
+    colors = _g === void 0 ? {} : _g,
+    _h = _a.verbiage,
+    verbiage = _h === void 0 ? {} : _h,
+    _j = _a.debugMode,
+    debugMode = _j === void 0 ? false : _j;
+  var _k = React.useContext(SubmissionContext),
+    submissionResponse = _k.submissionResponse,
+    setSelfieImage = _k.setSelfieImage,
+    logSelfieCaptureAttempt = _k.logSelfieCaptureAttempt;
   var releaseCameraAccess = React.useContext(CameraStateContext).releaseCameraAccess;
-  var _k = React.useState(''),
-    faceCropImageUrl = _k[0],
-    setFaceCropImageUrl = _k[1];
-  var _l = React.useState(0),
-    retryCount = _l[0],
-    setRetryCount = _l[1];
-  var _m = React.useState('LOADING'),
-    captureState = _m[0],
-    setCaptureState = _m[1];
+  var _l = React.useState(''),
+    faceCropImageUrl = _l[0],
+    setFaceCropImageUrl = _l[1];
+  var _m = React.useState(0),
+    retryCount = _m[0],
+    setRetryCount = _m[1];
+  var _o = React.useState('LOADING'),
+    captureState = _o[0],
+    setCaptureState = _o[1];
   var captureStartedAt = React.useRef();
   var captureEndedAt = React.useRef();
   var operationStartedAt = React.useRef();
@@ -11711,9 +11715,9 @@ var FaceLivenessWizard = function FaceLivenessWizard(_a) {
     setCaptureState('FAILED');
     onTimeout === null || onTimeout === void 0 ? void 0 : onTimeout(submissionResponse);
   }, [onTimeout, submissionResponse]);
-  var _o = React.useState(0),
-    attempt = _o[0],
-    setAttempt = _o[1];
+  var _p = React.useState(0),
+    attempt = _p[0],
+    setAttempt = _p[1];
   var onExitCallback = React.useCallback(function () {
     setAttempt(function (n) {
       return n + 1;
@@ -11722,11 +11726,11 @@ var FaceLivenessWizard = function FaceLivenessWizard(_a) {
   }, []);
   var onDoneCallback = React.useCallback(function () {
     logCaptureMetadata();
-    releaseCameraAccess();
+    releaseCameraAccessOnExit && releaseCameraAccess();
     setTimeout(function () {
       onComplete === null || onComplete === void 0 ? void 0 : onComplete(submissionResponse);
     }, 0);
-  }, [logCaptureMetadata, onComplete, releaseCameraAccess, submissionResponse]);
+  }, [logCaptureMetadata, onComplete, releaseCameraAccess, releaseCameraAccessOnExit, submissionResponse]);
   var showSuccessScreen = useShowSuccessScreen(skipSuccessScreen, captureState === 'SUCCESS', onDoneCallback);
   return /*#__PURE__*/React__default['default'].createElement(React__default['default'].Fragment, null, captureState !== 'LOADING' && function () {
     switch (captureState) {
@@ -11770,7 +11774,7 @@ var FaceLivenessWizard = function FaceLivenessWizard(_a) {
             setCaptureState('CAPTURING');
           },
           onExitClick: function onExitClick() {
-            releaseCameraAccess();
+            releaseCameraAccessOnExit && releaseCameraAccess();
             setTimeout(function () {
               onExitAfterFailure === null || onExitAfterFailure === void 0 ? void 0 : onExitAfterFailure(submissionResponse);
             }, 0);
@@ -14565,61 +14569,25 @@ var VideoIdWizard = function VideoIdWizard(_a) {
     verbiage = _j === void 0 ? {} : _j,
     _k = _a.debugMode,
     debugMode = _k === void 0 ? false : _k;
-  var _l = React.useContext(SubmissionContext),
-    selfieImage = _l.selfieImage,
-    setSelfieImage = _l.setSelfieImage,
-    logSelfieCaptureAttempt = _l.logSelfieCaptureAttempt;
-  var _m = React.useState('CAPTURING_ID'),
-    captureState = _m[0],
-    setCaptureState = _m[1];
-  var _o = React.useState(null),
-    videoUrl = _o[0],
-    setVideoUrl = _o[1];
-  var operationStartedAt = React.useRef();
-  var captureStartedAt = React.useRef();
-  var captureEndedAt = React.useRef();
-  React.useEffect(function () {
-    operationStartedAt.current = new Date();
-  }, []);
-  React.useEffect(function () {
-    if (captureState === 'CHECKING_LIVENESS') {
-      captureStartedAt.current = new Date();
-    }
-  }, [captureState]);
-  var logCaptureMetadata = React.useCallback(function () {
-    var _a, _b, _c;
-    logSelfieCaptureAttempt({
-      autoCapture: 'Y',
-      captureTime: ((_a = captureEndedAt.current) !== null && _a !== void 0 ? _a : new Date()).getTime() - ((_b = captureStartedAt.current) !== null && _b !== void 0 ? _b : new Date()).getTime(),
-      operationTime: new Date().getTime() - ((_c = operationStartedAt.current) !== null && _c !== void 0 ? _c : new Date()).getTime()
-    });
-    operationStartedAt.current = new Date();
-  }, [logSelfieCaptureAttempt]);
+  var _l = React.useState('CAPTURING_ID'),
+    captureState = _l[0],
+    setCaptureState = _l[1];
+  var _m = React.useState(null),
+    videoUrl = _m[0],
+    setVideoUrl = _m[1];
   var onIdCaptureSuccessProp = idCaptureProps.onSuccess;
   var onIdCaptureSuccess = React.useCallback(function (submission) {
     onIdCaptureSuccessProp === null || onIdCaptureSuccessProp === void 0 ? void 0 : onIdCaptureSuccessProp(submission);
     setCaptureState('CHECKING_LIVENESS');
   }, [onIdCaptureSuccessProp]);
-  var onFaceCaptureSuccess = React.useCallback(function (faceCropImageUrl) {
+  var onFaceCaptureSuccess = React.useCallback(function () {
     return tslib.__awaiter(void 0, void 0, void 0, function () {
-      var _a;
-      return tslib.__generator(this, function (_b) {
-        switch (_b.label) {
-          case 0:
-            setCaptureState('CAPTURING_VIDEO');
-            logCaptureMetadata();
-            if (!!selfieImage) return [3, 2];
-            _a = setSelfieImage;
-            return [4, dataUrlToBase64(faceCropImageUrl)];
-          case 1:
-            _a.apply(void 0, [_b.sent()]);
-            _b.label = 2;
-          case 2:
-            return [2];
-        }
+      return tslib.__generator(this, function (_a) {
+        setCaptureState('CAPTURING_VIDEO');
+        return [2];
       });
     });
-  }, [logCaptureMetadata, selfieImage, setSelfieImage]);
+  }, []);
   var onVideoCaptureComplete = React.useCallback(function (videoUrl) {
     setVideoUrl(videoUrl);
     setCaptureState('SUCCESS');
@@ -14630,13 +14598,16 @@ var VideoIdWizard = function VideoIdWizard(_a) {
   var onExit = React.useCallback(function () {
     setCaptureState('LOADING');
   }, []);
+  var isCapturingId = ['LOADING', 'CAPTURING_ID'].includes(captureState);
   return /*#__PURE__*/React__default['default'].createElement(IdCaptureModelsProvider, {
     documentDetectionModelUrl: (_c = (_b = idCaptureProps.assets) === null || _b === void 0 ? void 0 : _b.documentDetectionModelUrl) !== null && _c !== void 0 ? _c : '',
     focusModelUrl: (_e = (_d = idCaptureProps.assets) === null || _d === void 0 ? void 0 : _d.focusModelUrl) !== null && _e !== void 0 ? _e : '',
     logPredictions: debugMode
   }, /*#__PURE__*/React__default['default'].createElement(CameraProvider, {
-    preferContinuityCamera: ['LOADING', 'CAPTURING_ID'].includes(captureState),
-    preferFrontFacingCamera: !['LOADING', 'CAPTURING_ID'].includes(captureState)
+    key: isCapturingId ? 'id-camera' : 'selfie-camera',
+    preferContinuityCamera: isCapturingId,
+    preferFrontFacingCamera: !isCapturingId,
+    requestMicrophoneAccess: !isCapturingId
   }, /*#__PURE__*/React__default['default'].createElement(HighPerformanceSelfieGuidanceModelsProvider, null, captureState !== 'LOADING' && function () {
     switch (captureState) {
       case 'CAPTURING_ID':
@@ -14646,12 +14617,16 @@ var VideoIdWizard = function VideoIdWizard(_a) {
           verbiage: verbiage.idCapture,
           onSuccess: onIdCaptureSuccess,
           skipSuccessScreen: true,
+          releaseCameraAccessOnExit: false,
           debugMode: debugMode
         })));
       case 'CHECKING_LIVENESS':
-        return /*#__PURE__*/React__default['default'].createElement(FaceLivenessCapture, {
-          onSuccess: onFaceCaptureSuccess,
-          onExit: onExit,
+        return /*#__PURE__*/React__default['default'].createElement(FaceLivenessWizard, {
+          onComplete: onFaceCaptureSuccess,
+          onExitAfterFailure: onExit,
+          skipSuccessScreen: true,
+          releaseCameraAccessOnExit: false,
+          assets: assets.faceLiveness,
           colors: colors.faceLiveness,
           verbiage: verbiage.faceLiveness,
           debugMode: debugMode