idmission-web-sdk 2.1.28 → 2.1.29

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

@@ -27,6 +27,8 @@ export type IdCaptureState = {
     documentTooClose: boolean;
     flipRequired: boolean;
     backDetectedFirst: boolean;
+    allowOverrideFlipRequirement: boolean;
+    overrideFlipRequirement: boolean;
     idCardFrontDetectionScore: number;
     idCardFrontDetectionThresholdMet: boolean;
     idCardBackDetectionScore: number;
@@ -115,6 +117,10 @@ export type IdCaptureAction = {
     };
 } | {
     type: 'flipRequestCompleted';
+} | {
+    type: 'allowOverrideFlipRequirement';
+} | {
+    type: 'overrideFlipRequirement';
 } | {
     type: 'resetWizard';
 } | {
@@ -123,7 +129,8 @@ export type IdCaptureAction = {
 export type IdCaptureDispatch = Dispatch<IdCaptureAction>;
 export declare const IdCaptureStateContext: React.Context<IdCaptureState>;
 export declare const IdCaptureDispatchContext: React.Context<IdCaptureDispatch>;
-export declare const IdCaptureStateProvider: ({ children, }: {
+export declare const IdCaptureStateProvider: ({ children, flipRequiredTimeout, }: {
     children: ReactNode;
+    flipRequiredTimeout?: number;
 }) => React.JSX.Element;
 export declare const useIdCaptureState: () => [IdCaptureState, IdCaptureDispatch];

package/dist/sdk2.cjs.development.js

@@ -234,7 +234,7 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
   return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
 };
 
-var webSdkVersion = '2.1.28';
+var webSdkVersion = '2.1.29';
 
 function getPlatform() {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -6140,6 +6140,8 @@ var initialState$4 = {
   documentTooClose: false,
   flipRequired: false,
   backDetectedFirst: false,
+  allowOverrideFlipRequirement: false,
+  overrideFlipRequirement: false,
   idCardFrontDetectionScore: 0,
   idCardFrontDetectionThresholdMet: false,
   idCardBackDetectionScore: 0,
@@ -6258,7 +6260,7 @@ var _reducer = function reducer(state, action) {
           goodFramesThreshold = Math.ceil(3 * frameCaptureRate);
         }
       }
-      var flipRequired = !state.allowIdCardBackToFrontCapture && state.requestedDocumentType === 'idCardBack' && detectedDocumentType === 'idCardFront';
+      var flipRequired = !state.overrideFlipRequirement && !state.allowIdCardBackToFrontCapture && state.requestedDocumentType === 'idCardBack' && detectedDocumentType === 'idCardFront';
       var backDetectedFirst = state.allowIdCardBackToFrontCapture ? 'idCardBack' in state.capturedDocuments && detectedDocumentType === 'idCardBack' : state.requestedDocumentType.includes('idCardFront') && detectedDocumentType === 'idCardBack';
       var isGoodFrame = detectionThresholdMet && documentInBounds && !documentTooClose && !flipRequired && !backDetectedFirst && focusThresholdMet;
       var goodFramesCount = state.goodFramesCount;
@@ -6282,6 +6284,10 @@ var _reducer = function reducer(state, action) {
           requestedDocumentType = 'idCardFront' in state.capturedDocuments ? 'idCardBack' : 'idCardFront';
         }
       }
+      var allowOverrideFlipRequirement = state.allowOverrideFlipRequirement;
+      if (isGoodFrame) {
+        allowOverrideFlipRequirement = false;
+      }
       return _assign(_assign({}, state), {
         videoWidth: frameWidth,
         videoHeight: frameHeight,
@@ -6294,6 +6300,7 @@ var _reducer = function reducer(state, action) {
         documentTooClose: documentTooClose,
         flipRequired: flipRequired,
         backDetectedFirst: backDetectedFirst,
+        allowOverrideFlipRequirement: allowOverrideFlipRequirement,
         idCardFrontDetectionScore: idCardFrontDetectionScore,
         idCardFrontDetectionThresholdMet: idCardFrontDetectionThresholdMet,
         idCardBackDetectionScore: idCardBackDetectionScore,
@@ -6339,6 +6346,8 @@ var _reducer = function reducer(state, action) {
         var newState_1 = _assign(_assign({}, state), {
           capturing: false,
           captureFailed: false,
+          allowOverrideFlipRequirement: false,
+          overrideFlipRequirement: false,
           goodFramesCount: 0,
           capturedDocuments: _assign(_assign({}, state.capturedDocuments), (_a = {}, _a[action.payload.documentType] = action.payload, _a))
         });
@@ -6402,7 +6411,18 @@ var _reducer = function reducer(state, action) {
       }
     case 'flipRequestCompleted':
       return _assign(_assign({}, state), {
-        captureState: 'capturing'
+        captureState: 'capturing',
+        allowOverrideFlipRequirement: false,
+        overrideFlipRequirement: false
+      });
+    case 'allowOverrideFlipRequirement':
+      return _assign(_assign({}, state), {
+        allowOverrideFlipRequirement: true
+      });
+    case 'overrideFlipRequirement':
+      return _assign(_assign({}, state), {
+        allowOverrideFlipRequirement: false,
+        overrideFlipRequirement: true
       });
     case 'resetWizard':
       return _assign(_assign({}, initialState$4), {
@@ -6414,10 +6434,12 @@ var _reducer = function reducer(state, action) {
   }
 };
 var IdCaptureStateProvider = function IdCaptureStateProvider(_a) {
-  var children = _a.children;
-  var _b = React.useReducer(_reducer, initialState$4),
-    state = _b[0],
-    dispatch = _b[1];
+  var children = _a.children,
+    _b = _a.flipRequiredTimeout,
+    flipRequiredTimeout = _b === void 0 ? 10000 : _b;
+  var _c = React.useReducer(_reducer, initialState$4),
+    state = _c[0],
+    dispatch = _c[1];
   var onResize = useDebounce.useDebouncedCallback(function () {
     dispatch({
       type: 'redrawRequested'
@@ -6430,6 +6452,24 @@ var IdCaptureStateProvider = function IdCaptureStateProvider(_a) {
       window.removeEventListener('resize', onResize);
     };
   }, [onResize]);
+  var setRequiredDocumentType = React.useContext(IdCaptureModelsContext).setRequiredDocumentType;
+  React.useEffect(function () {
+    if (state.captureState !== 'capturing') return;
+    if (!state.flipRequired || state.allowOverrideFlipRequirement) return;
+    var t = setTimeout(function () {
+      dispatch({
+        type: 'allowOverrideFlipRequirement'
+      });
+    }, flipRequiredTimeout);
+    return function () {
+      clearTimeout(t);
+    };
+  }, [flipRequiredTimeout, state.allowOverrideFlipRequirement, state.captureState, state.flipRequired]);
+  React.useEffect(function () {
+    if (state.overrideFlipRequirement) {
+      setRequiredDocumentType('none');
+    }
+  }, [state.overrideFlipRequirement, setRequiredDocumentType]);
   return /*#__PURE__*/React__namespace.default.createElement(IdCaptureStateContext.Provider, {
     value: state
   }, /*#__PURE__*/React__namespace.default.createElement(IdCaptureDispatchContext.Provider, {
@@ -6982,7 +7022,41 @@ var IdCapture = function IdCapture(_a) {
   }, /*#__PURE__*/React__namespace.default.createElement(GuidanceMessage, {
     "$variant": satisfied ? 'positive' : 'default',
     className: classNames.guidanceMessage
-  }, guidanceMessage))), debugMode && ( /*#__PURE__*/React__namespace.default.createElement(DebugBoundingBoxOverlay, {
+  }, guidanceMessage), state.allowOverrideFlipRequirement && ( /*#__PURE__*/React__namespace.default.createElement("div", {
+    style: {
+      position: 'fixed',
+      left: 0,
+      bottom: 0,
+      width: '100dvw',
+      background: '#eed202',
+      display: 'flex',
+      zIndex: 100001
+    }
+  }, /*#__PURE__*/React__namespace.default.createElement("div", {
+    style: {
+      display: 'flex',
+      flexDirection: 'row',
+      padding: '16px 24px',
+      margin: 'auto 0',
+      width: '100%'
+    }
+  }, /*#__PURE__*/React__namespace.default.createElement("span", {
+    style: {
+      display: 'block',
+      margin: 'auto 12px auto 0'
+    }
+  }, "It appears that you are attempting to capture the wrong side of your ID card, but perhaps we are wrong about that. Would you like to proceed with capture anyway?"), /*#__PURE__*/React__namespace.default.createElement(LoaderButton, {
+    variant: "positive",
+    style: {
+      marginLeft: 'auto',
+      whiteSpace: 'nowrap'
+    },
+    onClick: function onClick() {
+      return dispatch({
+        type: 'overrideFlipRequirement'
+      });
+    }
+  }, "Capture Anyway")))))), debugMode && ( /*#__PURE__*/React__namespace.default.createElement(DebugBoundingBoxOverlay, {
     "$flipX": !((_j = cameraRef.current) === null || _j === void 0 ? void 0 : _j.isRearFacing),
     scaling: debugScalingDetails
   }, state.detectedObjects.map(function (obj, i) {