idmission-web-sdk 2.1.16 → 2.1.17

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

@@ -96,6 +96,8 @@ export interface IdValidationProps extends PropsWithChildren {
     rotateLoadingOverlayImageWhenPortrait?: boolean;
     /** Number of milliseconds indicating the maximum amount of time that should be spent trying to load the guided capture experience before giving up and resorting to the stock camera instead. Defaults to 45000 (45 seconds). */
     modelLoadTimeoutMs?: number;
+    /** Boolean to indicate whether to force the fallback mode even if the ID capture models are available. Defaults to `false`. */
+    forceFallbackMode?: boolean;
     /** Object to allow documents that have been previously captured to be submitted. Valid keys: `idCardFront`, `idCardBack`, `passport`.*/
     precapturedDocuments?: CapturedDocuments;
     /** Callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded. */

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

@@ -63,10 +63,11 @@ export type IdCaptureWizardProps = {
     portraitGuidesOnMobile?: boolean;
     rotateLoadingOverlayImageWhenPortrait?: boolean;
     silentFallback?: boolean;
+    forceFallbackMode?: boolean;
     assets?: IdCaptureWizardAssets;
     classNames?: IdCaptureWizardClassNames;
     colors?: IdCaptureWizardColors;
     verbiage?: IdCaptureWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, onUserCancel, loadingOverlayMode, precapturedDocuments, captureRequirement, separateIdCardCaptureSequence, thresholds, skipSuccessScreen, instructions, releaseCameraAccessOnExit, guideType, portraitGuidesOnMobile, rotateLoadingOverlayImageWhenPortrait, silentFallback, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;
+export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, onUserCancel, loadingOverlayMode, precapturedDocuments, captureRequirement, separateIdCardCaptureSequence, thresholds, skipSuccessScreen, instructions, releaseCameraAccessOnExit, guideType, portraitGuidesOnMobile, rotateLoadingOverlayImageWhenPortrait, silentFallback, forceFallbackMode, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;

package/dist/sdk2.esm.js

@@ -204,7 +204,7 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
   return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
 };
 
-var webSdkVersion = '2.1.16';
+var webSdkVersion = '2.1.17';
 
 function getPlatform() {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -9522,40 +9522,42 @@ var IdCaptureWizard = function IdCaptureWizard(_a) {
     rotateLoadingOverlayImageWhenPortrait = _1 === void 0 ? true : _1,
     _2 = _a.silentFallback,
     silentFallback = _2 === void 0 ? false : _2,
-    _3 = _a.assets,
-    assets = _3 === void 0 ? {} : _3,
-    _4 = _a.classNames,
-    classNames = _4 === void 0 ? {} : _4,
-    _5 = _a.colors,
-    colors = _5 === void 0 ? {} : _5,
-    _6 = _a.verbiage,
-    verbiage = _6 === void 0 ? {} : _6,
-    _7 = _a.debugMode,
-    debugMode = _7 === void 0 ? false : _7;
-  var _8 = useIdCaptureState(),
-    state = _8[0],
-    dispatch = _8[1];
-  var _9 = useContext(CameraStateContext),
-    cameraAccessDenied = _9.cameraAccessDenied,
-    requestCameraAccess = _9.requestCameraAccess,
-    releaseCameraAccess = _9.releaseCameraAccess;
-  var _10 = useState(false),
-    overlayDismissed = _10[0],
-    setOverlayDismissed = _10[1];
-  var _11 = useContext(SubmissionContext),
-    submissionStatus = _11.submissionStatus,
-    setIdFrontImage = _11.setIdFrontImage,
-    setIdBackImage = _11.setIdBackImage,
-    setPassportImage = _11.setPassportImage,
-    logIdFrontCaptureAttempt = _11.logIdFrontCaptureAttempt,
-    logIdBackCaptureAttempt = _11.logIdBackCaptureAttempt;
-  var _12 = useContext(IdCaptureModelsContext),
-    start = _12.start,
-    stop = _12.stop,
-    onPredictionMade = _12.onPredictionMade,
-    setRequiredDocumentType = _12.setRequiredDocumentType,
-    modelError = _12.modelError,
-    resetBestFrame = _12.resetBestFrame;
+    _3 = _a.forceFallbackMode,
+    forceFallbackMode = _3 === void 0 ? false : _3,
+    _4 = _a.assets,
+    assets = _4 === void 0 ? {} : _4,
+    _5 = _a.classNames,
+    classNames = _5 === void 0 ? {} : _5,
+    _6 = _a.colors,
+    colors = _6 === void 0 ? {} : _6,
+    _7 = _a.verbiage,
+    verbiage = _7 === void 0 ? {} : _7,
+    _8 = _a.debugMode,
+    debugMode = _8 === void 0 ? false : _8;
+  var _9 = useIdCaptureState(),
+    state = _9[0],
+    dispatch = _9[1];
+  var _10 = useContext(CameraStateContext),
+    cameraAccessDenied = _10.cameraAccessDenied,
+    requestCameraAccess = _10.requestCameraAccess,
+    releaseCameraAccess = _10.releaseCameraAccess;
+  var _11 = useState(false),
+    overlayDismissed = _11[0],
+    setOverlayDismissed = _11[1];
+  var _12 = useContext(SubmissionContext),
+    submissionStatus = _12.submissionStatus,
+    setIdFrontImage = _12.setIdFrontImage,
+    setIdBackImage = _12.setIdBackImage,
+    setPassportImage = _12.setPassportImage,
+    logIdFrontCaptureAttempt = _12.logIdFrontCaptureAttempt,
+    logIdBackCaptureAttempt = _12.logIdBackCaptureAttempt;
+  var _13 = useContext(IdCaptureModelsContext),
+    start = _13.start,
+    stop = _13.stop,
+    onPredictionMade = _13.onPredictionMade,
+    setRequiredDocumentType = _13.setRequiredDocumentType,
+    modelError = _13.modelError,
+    resetBestFrame = _13.resetBestFrame;
   useEffect(function () {
     dispatch({
       type: 'configureWizard',
@@ -9644,9 +9646,9 @@ var IdCaptureWizard = function IdCaptureWizard(_a) {
       type: 'resetWizard'
     });
   }, [dispatch]);
-  var _13 = useState(0),
-    attempt = _13[0],
-    setAttempt = _13[1];
+  var _14 = useState(0),
+    attempt = _14[0],
+    setAttempt = _14[1];
   var onExit = useCallback(function () {
     releaseCameraAccess();
     setOverlayDismissed(false);
@@ -9699,12 +9701,12 @@ var IdCaptureWizard = function IdCaptureWizard(_a) {
     })
   };
   var theme = useTheme();
-  var _14 = useIdCaptureState()[0],
-    guideRectX = _14.guideRectX,
-    guideRectY = _14.guideRectY,
-    guideRectWidth = _14.guideRectWidth,
-    guideRectHeight = _14.guideRectHeight,
-    imageUrl = _14.imageUrl;
+  var _15 = useIdCaptureState()[0],
+    guideRectX = _15.guideRectX,
+    guideRectY = _15.guideRectY,
+    guideRectWidth = _15.guideRectWidth,
+    guideRectHeight = _15.guideRectHeight,
+    imageUrl = _15.imageUrl;
   var idCaptureAssets = assets[state.requestedDocumentType];
   var idCaptureVerbiage = idCaptureVerbiages[state.requestedDocumentType];
   useEffect(function () {
@@ -9758,8 +9760,7 @@ var IdCaptureWizard = function IdCaptureWizard(_a) {
       });
     });
   }, [dispatch]);
-  useEffect(function () {}, []);
-  if (modelError) {
+  if (forceFallbackMode || modelError) {
     return /*#__PURE__*/React__default.createElement(IdCaptureFallback, {
       idCaptureRequirement: captureRequirement,
       onFinished: onSubmitClick,
@@ -13939,6 +13940,8 @@ var IdValidation = function IdValidation(_a) {
     rotateLoadingOverlayImageWhenPortrait = _k === void 0 ? true : _k,
     _l = _a.modelLoadTimeoutMs,
     modelLoadTimeoutMs = _l === void 0 ? defaultDocumentDetectionModelLoadTimeoutMs : _l,
+    _m = _a.forceFallbackMode,
+    forceFallbackMode = _m === void 0 ? false : _m,
     onBeforeSubmit = _a.onBeforeSubmit,
     onBeforeDocumentUpload = _a.onBeforeDocumentUpload,
     onDocumentUploadProgress = _a.onDocumentUploadProgress,
@@ -13952,28 +13955,28 @@ var IdValidation = function IdValidation(_a) {
     onUserCancel = _a.onUserCancel,
     onModelError = _a.onModelError,
     onCameraAccessDenied = _a.onCameraAccessDenied,
-    _m = _a.theme,
-    theme = _m === void 0 ? 'default' : _m,
-    _o = _a.assets,
-    assets = _o === void 0 ? {} : _o,
-    _p = _a.classNames,
-    classNames = _p === void 0 ? {} : _p,
-    _q = _a.colors,
-    colors = _q === void 0 ? {} : _q,
-    _r = _a.verbiage,
-    verbiage = _r === void 0 ? {} : _r,
-    _s = _a.captureSignature,
-    captureSignature = _s === void 0 ? false : _s,
-    _t = _a.captureSignatureVideo,
-    captureSignatureVideo = _t === void 0 ? false : _t,
-    _u = _a.captureAdditionalDocuments,
-    captureAdditionalDocuments = _u === void 0 ? [] : _u,
-    _v = _a.geolocationEnabled,
-    geolocationEnabled = _v === void 0 ? true : _v,
-    _w = _a.geolocationRequired,
-    geolocationRequired = _w === void 0 ? false : _w,
-    _x = _a.debugMode,
-    debugMode = _x === void 0 ? false : _x;
+    _o = _a.theme,
+    theme = _o === void 0 ? 'default' : _o,
+    _p = _a.assets,
+    assets = _p === void 0 ? {} : _p,
+    _q = _a.classNames,
+    classNames = _q === void 0 ? {} : _q,
+    _r = _a.colors,
+    colors = _r === void 0 ? {} : _r,
+    _s = _a.verbiage,
+    verbiage = _s === void 0 ? {} : _s,
+    _t = _a.captureSignature,
+    captureSignature = _t === void 0 ? false : _t,
+    _u = _a.captureSignatureVideo,
+    captureSignatureVideo = _u === void 0 ? false : _u,
+    _v = _a.captureAdditionalDocuments,
+    captureAdditionalDocuments = _v === void 0 ? [] : _v,
+    _w = _a.geolocationEnabled,
+    geolocationEnabled = _w === void 0 ? true : _w,
+    _x = _a.geolocationRequired,
+    geolocationRequired = _x === void 0 ? false : _x,
+    _y = _a.debugMode,
+    debugMode = _y === void 0 ? false : _y;
   useLanguage(lang);
   useDebugLogging(debugMode);
   var idCaptureProps = useMemo(function () {
@@ -13987,6 +13990,7 @@ var IdValidation = function IdValidation(_a) {
       thresholds: idCaptureThresholds,
       skipSuccessScreen: skipSuccessScreen,
       loadingOverlayMode: loadingOverlayMode,
+      forceFallbackMode: forceFallbackMode,
       instructions: instructions,
       guideType: guideType,
       portraitGuidesOnMobile: portraitGuidesOnMobile,
@@ -13998,7 +14002,7 @@ var IdValidation = function IdValidation(_a) {
       verbiage: verbiage,
       debugMode: debugMode
     };
-  }, [onExitCapture, onUserCancel, onModelError, precapturedDocuments, idCaptureRequirement, separateIdCardCaptureSequence, idCaptureThresholds, skipSuccessScreen, loadingOverlayMode, instructions, guideType, portraitGuidesOnMobile, rotateLoadingOverlayImageWhenPortrait, modelLoadTimeoutMs, assets, classNames, colors, verbiage, debugMode]);
+  }, [onExitCapture, onUserCancel, onModelError, precapturedDocuments, idCaptureRequirement, separateIdCardCaptureSequence, idCaptureThresholds, skipSuccessScreen, loadingOverlayMode, forceFallbackMode, instructions, guideType, portraitGuidesOnMobile, rotateLoadingOverlayImageWhenPortrait, modelLoadTimeoutMs, assets, classNames, colors, verbiage, debugMode]);
   var additionalDocumentCaptureProps = useMemo(function () {
     return {
       documents: captureAdditionalDocuments,