idmission-web-sdk 2.3.128 → 2.3.129

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.3.128';
+var webSdkVersion = '2.3.129';
 
 function getPlatform() {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -354,11 +354,13 @@ function attachMetadataToRequest(request, _a) {
   var selfieCaptureAttempts = _a.selfieCaptureAttempts,
     idFrontCaptureAttempts = _a.idFrontCaptureAttempts,
     idBackCaptureAttempts = _a.idBackCaptureAttempts,
+    barcodeCaptureAttempts = _a.barcodeCaptureAttempts,
     geolocationResult = _a.geolocationResult;
   var metadata = {
     selfie: selfieCaptureAttempts,
     front: idFrontCaptureAttempts,
     back: idBackCaptureAttempts,
+    barcode: barcodeCaptureAttempts,
     isRealIDCheckRequired: 'false',
     sdkVersion: "WebSDK_".concat(webSdkVersion),
     Resolution: typeof window !== 'undefined' ? "".concat(window.innerWidth, " x ").concat(window.innerHeight) : 'unknown'
@@ -1083,6 +1085,26 @@ function setServerUrl(url) {
   setDefaultSubmissionUrl(url + '/swagger');
   setDefaultDocumentServiceUrl(url + '/files/');
 }
+var capturedDocumentTypeToSubmissionKey = {
+  idCardFront: 'idFrontImage',
+  idCardBack: 'idBackImage',
+  passport: 'passportImage',
+  singlePage: 'idFrontImage',
+  selfie: 'selfieImage',
+  idFrontIrImage: 'idFrontIrImage',
+  idBackIrImage: 'idBackIrImage',
+  idFrontUvImage: 'idFrontUvImage',
+  idBackUvImage: 'idBackUvImage',
+  idBarcodeImage: 'idBarcodeImage'
+};
+var sanitizeMetadata = function sanitizeMetadata(metadata) {
+  var entries = Object.entries(metadata).filter(function (_a) {
+    var value = _a[1];
+    return value !== undefined && value !== null;
+  });
+  if (!entries.length) return null;
+  return Object.fromEntries(entries);
+};
 var SubmissionContext = /*#__PURE__*/createContext({
   submit: function submit() {
     return __awaiter(void 0, void 0, void 0, function () {
@@ -1170,6 +1192,9 @@ var SubmissionContext = /*#__PURE__*/createContext({
   setAdditionalDocuments: function setAdditionalDocuments() {
     return null;
   },
+  setDocumentFileMetadata: function setDocumentFileMetadata() {
+    return null;
+  },
   uploadDocument: Promise.resolve,
   logIdFrontCaptureAttempt: function logIdFrontCaptureAttempt() {
     return null;
@@ -1321,60 +1346,139 @@ var SubmissionProvider = function SubmissionProvider(_a) {
   var _18 = useState(null),
     signatureVideoMetadata = _18[0],
     setSignatureVideoMetadata = _18[1];
-  var _19 = useState(null),
-    idCaptureVideoUrl = _19[0],
-    setIdCaptureVideoUrl = _19[1];
-  var _20 = useState(null),
-    idCaptureVideoIdFrontImage = _20[0],
-    setIdCaptureVideoIdFrontImage = _20[1];
+  var _19 = useState({}),
+    documentFileMetadata = _19[0],
+    setDocumentFileMetadataState = _19[1];
+  var _20 = useState([]),
+    barcodeCaptureAttempts = _20[0],
+    setBarcodeCaptureAttempts = _20[1];
   var _21 = useState(null),
-    idCaptureVideoIdBackImage = _21[0],
-    setIdCaptureVideoIdBackImage = _21[1];
+    idCaptureVideoUrl = _21[0],
+    setIdCaptureVideoUrl = _21[1];
   var _22 = useState(null),
-    idCaptureVideoAudioUrl = _22[0],
-    setIdCaptureVideoAudioUrl = _22[1];
+    idCaptureVideoIdFrontImage = _22[0],
+    setIdCaptureVideoIdFrontImage = _22[1];
   var _23 = useState(null),
-    idCaptureVideoAudioStartsAt = _23[0],
-    setIdCaptureVideoAudioStartsAt = _23[1];
+    idCaptureVideoIdBackImage = _23[0],
+    setIdCaptureVideoIdBackImage = _23[1];
   var _24 = useState(null),
-    expectedAudioText = _24[0],
-    setExpectedAudioText = _24[1];
+    idCaptureVideoAudioUrl = _24[0],
+    setIdCaptureVideoAudioUrl = _24[1];
   var _25 = useState(null),
-    additionalDocuments = _25[0],
-    setAdditionalDocuments = _25[1];
+    idCaptureVideoAudioStartsAt = _25[0],
+    setIdCaptureVideoAudioStartsAt = _25[1];
   var _26 = useState(null),
-    geolocationResult = _26[0],
-    setGeolocationResult = _26[1];
-  var _27 = useState(0),
-    geolocationAttempts = _27[0],
-    setGeolocationAttempts = _27[1];
-  var _28 = useState(false),
-    geolocationBlocked = _28[0],
-    setGeolocationBlocked = _28[1];
-  var _29 = useState([]),
-    idFrontCaptureAttempts = _29[0],
-    setIdFrontCaptureAttempts = _29[1];
-  var _30 = useState([]),
-    idBackCaptureAttempts = _30[0],
-    setIdBackCaptureAttempts = _30[1];
+    expectedAudioText = _26[0],
+    setExpectedAudioText = _26[1];
+  var _27 = useState(null),
+    additionalDocuments = _27[0],
+    setAdditionalDocuments = _27[1];
+  var setDocumentFileMetadata = useCallback(function (key, metadata) {
+    var sanitized = metadata ? sanitizeMetadata(metadata) : null;
+    setDocumentFileMetadataState(function (current) {
+      var _a;
+      if (!sanitized) {
+        if (!(key in current)) return current;
+        var next = _assign({}, current);
+        delete next[key];
+        if (key === 'idBarcodeImage') {
+          setBarcodeCaptureAttempts([]);
+        }
+        return next;
+      }
+      return _assign(_assign({}, current), (_a = {}, _a[key] = sanitized, _a));
+    });
+  }, []);
+  var _28 = useState(null),
+    geolocationResult = _28[0],
+    setGeolocationResult = _28[1];
+  var _29 = useState(0),
+    geolocationAttempts = _29[0],
+    setGeolocationAttempts = _29[1];
+  var _30 = useState(false),
+    geolocationBlocked = _30[0],
+    setGeolocationBlocked = _30[1];
   var _31 = useState([]),
-    selfieCaptureAttempts = _31[0],
-    setSelfieCaptureAttempts = _31[1];
-  var logIdFrontCaptureAttempt = useCallback(function (attempt) {
+    idFrontCaptureAttempts = _31[0],
+    setIdFrontCaptureAttempts = _31[1];
+  var _32 = useState([]),
+    idBackCaptureAttempts = _32[0],
+    setIdBackCaptureAttempts = _32[1];
+  var _33 = useState([]),
+    selfieCaptureAttempts = _33[0],
+    setSelfieCaptureAttempts = _33[1];
+  var logIdFrontCaptureAttempt = useCallback(function (attempt, documentType) {
     setIdFrontCaptureAttempts(function (attempts) {
       return __spreadArray(__spreadArray([], attempts, true), [attempt], false);
     });
-  }, []);
-  var logIdBackCaptureAttempt = useCallback(function (attempt) {
+    var submissionKey = capturedDocumentTypeToSubmissionKey[documentType];
+    if (submissionKey) {
+      setDocumentFileMetadata(submissionKey, {
+        documentType: documentType,
+        documentKey: submissionKey,
+        captureMode: attempt.captureMode,
+        autoCapture: attempt.autoCapture,
+        captureTime: attempt.captureTime,
+        operationTime: attempt.operationTime,
+        bestDetectionScore: attempt.bestDetectionScore,
+        bestFocusScore: attempt.bestFocusScore,
+        bestBarcodeScore: attempt.bestBarcodeScore,
+        boundingBox: attempt.boundingBox
+      });
+    }
+    if (attempt.bestBarcodeScore !== undefined && attempt.bestBarcodeScore !== null) {
+      setBarcodeCaptureAttempts(function (attempts) {
+        return __spreadArray(__spreadArray([], attempts, true), [attempt], false);
+      });
+      setDocumentFileMetadata('idBarcodeImage', {
+        documentType: 'idBarcodeImage',
+        sourceDocumentType: documentType,
+        documentKey: 'idBarcodeImage',
+        bestBarcodeScore: attempt.bestBarcodeScore,
+        captureMode: attempt.captureMode,
+        autoCapture: attempt.autoCapture,
+        captureTime: attempt.captureTime,
+        operationTime: attempt.operationTime
+      });
+    }
+  }, [setDocumentFileMetadata]);
+  var logIdBackCaptureAttempt = useCallback(function (attempt, documentType) {
     setIdBackCaptureAttempts(function (attempts) {
       return __spreadArray(__spreadArray([], attempts, true), [attempt], false);
     });
-  }, []);
+    var submissionKey = capturedDocumentTypeToSubmissionKey[documentType];
+    if (submissionKey) {
+      setDocumentFileMetadata(submissionKey, {
+        documentType: documentType,
+        documentKey: submissionKey,
+        captureMode: attempt.captureMode,
+        autoCapture: attempt.autoCapture,
+        captureTime: attempt.captureTime,
+        operationTime: attempt.operationTime,
+        bestDetectionScore: attempt.bestDetectionScore,
+        bestFocusScore: attempt.bestFocusScore,
+        bestBarcodeScore: attempt.bestBarcodeScore,
+        boundingBox: attempt.boundingBox
+      });
+    }
+  }, [setDocumentFileMetadata]);
   var logSelfieCaptureAttempt = useCallback(function (attempt) {
     setSelfieCaptureAttempts(function (attempts) {
       return __spreadArray(__spreadArray([], attempts, true), [attempt], false);
     });
-  }, []);
+    setDocumentFileMetadata('selfieImage', {
+      documentType: 'selfie',
+      documentKey: 'selfieImage',
+      captureMode: attempt.captureMode,
+      autoCapture: attempt.autoCapture,
+      captureTime: attempt.captureTime,
+      operationTime: attempt.operationTime,
+      livenessScore: attempt.livenessScore,
+      bestDetectionScore: attempt.bestDetectionScore,
+      bestFocusScore: attempt.bestFocusScore,
+      boundingBox: attempt.boundingBox
+    });
+  }, [setDocumentFileMetadata]);
   useRevokeObjectUrlOnUnmount(signatureVideoUrl);
   useRevokeObjectUrlOnUnmount(idCaptureVideoUrl);
   useRevokeObjectUrlOnUnmount(idCaptureVideoAudioUrl);
@@ -1524,14 +1628,15 @@ var SubmissionProvider = function SubmissionProvider(_a) {
             if (!documentServiceUrl) return [3 /*break*/, 8];
             return [4 /*yield*/, Promise.all(Object.keys(documents).map(function (k) {
               return __awaiter(void 0, void 0, void 0, function () {
-                var filetype, metadata, _a, _b;
+                var filetype, metadataSource, metadata, _a, _b;
                 return __generator(this, function (_c) {
                   switch (_c.label) {
                     case 0:
                       if (!documents[k]) return [3 /*break*/, 2];
                       filetype = k.endsWith('Video') ? 'video/mp4' : k.endsWith('Audio') ? 'audio/mp4' : 'image/jpeg';
-                      metadata = k === 'signatureVideo' ? {
-                        filemetadata: JSON.stringify(signatureVideoMetadata)
+                      metadataSource = k === 'signatureVideo' && signatureVideoMetadata ? signatureVideoMetadata : documentFileMetadata[k];
+                      metadata = metadataSource ? {
+                        filemetadata: JSON.stringify(metadataSource)
                       } : {};
                       _a = documents;
                       _b = k;
@@ -1682,7 +1787,8 @@ var SubmissionProvider = function SubmissionProvider(_a) {
               selfieCaptureAttempts: selfieCaptureAttempts,
               idFrontCaptureAttempts: idFrontCaptureAttempts,
               idBackCaptureAttempts: idBackCaptureAttempts,
-              geolocationResult: geolocationResult
+              geolocationResult: geolocationResult,
+              barcodeCaptureAttempts: barcodeCaptureAttempts
             });
             if (!onBeforeSubmit.current) return [3 /*break*/, 10];
             return [4 /*yield*/, onBeforeSubmit.current(submissionRequest)];
@@ -1695,7 +1801,7 @@ var SubmissionProvider = function SubmissionProvider(_a) {
         }
       });
     });
-  }, [additionalDocuments, bypassAgeValidation, bypassNameMatching, cardData, clientRequestID, companyId, customerDataMatchConfig, deduplicationEnabled, deduplicationSynchronous, documentServiceUrl, enrollmentId, expectedAudioText, geolocationResult, idBackCaptureAttempts, idBackImage, idBackImageRequired, idBackIrImage, idBackUvImage, idBarcodeImage, idCaptureVideoAudioStartsAt, idCaptureVideoAudioUrl, idCaptureVideoIdBackImage, idCaptureVideoIdFrontImage, idCaptureVideoUrl, idCardForFaceMatch, idData, idFrontCaptureAttempts, idFrontImage, idFrontIrImage, idFrontUvImage, idImageResolutionCheck, jobId, manualReviewRequired, needImmediateResponse, passportImage, personalData, selfieCaptureAttempts, selfieImage, signatureData, signatureVideoUrl, signatureVideoMetadata, uploadDocument, verifyIdWithExternalDatabases, webhooksClientTraceId, webhooksEnabled, webhooksFireOnReview, webhooksFireOnReviewURL, webhooksSendInputImages, webhooksSendProcessedImages, webhooksStripSpecialCharacters, webhooksURL]);
+  }, [additionalDocuments, bypassAgeValidation, bypassNameMatching, cardData, clientRequestID, companyId, customerDataMatchConfig, deduplicationEnabled, deduplicationSynchronous, barcodeCaptureAttempts, documentFileMetadata, documentServiceUrl, enrollmentId, expectedAudioText, geolocationResult, idBackCaptureAttempts, idBackImage, idBackImageRequired, idBackIrImage, idBackUvImage, idBarcodeImage, idCaptureVideoAudioStartsAt, idCaptureVideoAudioUrl, idCaptureVideoIdBackImage, idCaptureVideoIdFrontImage, idCaptureVideoUrl, idCardForFaceMatch, idData, idFrontCaptureAttempts, idFrontImage, idFrontIrImage, idFrontUvImage, idImageResolutionCheck, jobId, manualReviewRequired, needImmediateResponse, passportImage, personalData, selfieCaptureAttempts, selfieImage, signatureData, signatureVideoUrl, signatureVideoMetadata, uploadDocument, verifyIdWithExternalDatabases, webhooksClientTraceId, webhooksEnabled, webhooksFireOnReview, webhooksFireOnReviewURL, webhooksSendInputImages, webhooksSendProcessedImages, webhooksStripSpecialCharacters, webhooksURL]);
   var defaultOnSubmit = useCallback(function () {
     return __awaiter(void 0, void 0, void 0, function () {
       var submissionResponse_1, payload, host, endpoint, response, statusMessage, submissionResponse_2, e_1, err;
@@ -1855,7 +1961,8 @@ var SubmissionProvider = function SubmissionProvider(_a) {
               selfieCaptureAttempts: selfieCaptureAttempts,
               idFrontCaptureAttempts: idFrontCaptureAttempts,
               idBackCaptureAttempts: idBackCaptureAttempts,
-              geolocationResult: geolocationResult
+              geolocationResult: geolocationResult,
+              barcodeCaptureAttempts: barcodeCaptureAttempts
             });
             if (!onBeforeLivenessCheck.current) return [3 /*break*/, 5];
             return [4 /*yield*/, onBeforeLivenessCheck.current(request)];
@@ -1869,7 +1976,7 @@ var SubmissionProvider = function SubmissionProvider(_a) {
         }
       });
     });
-  }, [clientRequestID, documentServiceUrl, estimateAge, geolocationResult, idBackCaptureAttempts, idCardForFaceMatch, idFrontCaptureAttempts, jobId, predictGender, selfieCaptureAttempts, uploadDocument, useDocumentServiceForLivenessChecks, webhooksStripSpecialCharacters]);
+  }, [clientRequestID, documentServiceUrl, estimateAge, geolocationResult, barcodeCaptureAttempts, idBackCaptureAttempts, idCardForFaceMatch, idFrontCaptureAttempts, jobId, predictGender, selfieCaptureAttempts, uploadDocument, useDocumentServiceForLivenessChecks, webhooksStripSpecialCharacters]);
   var checkLiveness = useCallback(function (imageDataUrl) {
     return __awaiter(void 0, void 0, void 0, function () {
       var request, host, endpoint, response, statusMessage, submissionResponse_3, e_2, err;
@@ -2002,6 +2109,7 @@ var SubmissionProvider = function SubmissionProvider(_a) {
       setIdCaptureVideoAudioStartsAt: setIdCaptureVideoAudioStartsAt,
       setExpectedAudioText: setExpectedAudioText,
       setAdditionalDocuments: setAdditionalDocuments,
+      setDocumentFileMetadata: setDocumentFileMetadata,
       uploadDocument: uploadDocument,
       logIdFrontCaptureAttempt: logIdFrontCaptureAttempt,
       logIdBackCaptureAttempt: logIdBackCaptureAttempt,
@@ -2010,7 +2118,7 @@ var SubmissionProvider = function SubmissionProvider(_a) {
       checkLiveness: checkLiveness,
       retryLocationAccess: retryLocationAccess
     };
-  }, [additionalDocuments, checkLiveness, environment, idBackImage, idBackIrImage, idBackUvImage, idBarcodeImage, idCaptureVideoAudioStartsAt, idCaptureVideoAudioUrl, idCaptureVideoIdBackImage, idCaptureVideoIdFrontImage, idCaptureVideoUrl, idFrontImage, idFrontIrImage, idFrontUvImage, livenessCheckRequest, logIdBackCaptureAttempt, logIdFrontCaptureAttempt, logSelfieCaptureAttempt, passportImage, retryLocationAccess, selfieImage, signatureData, signatureVideoUrl, submissionError, submissionRequest, submissionResponse, submissionStatus, submit, uploadDocument]);
+  }, [additionalDocuments, checkLiveness, environment, idBackImage, idBackIrImage, idBackUvImage, idBarcodeImage, idCaptureVideoAudioStartsAt, idCaptureVideoAudioUrl, idCaptureVideoIdBackImage, idCaptureVideoIdFrontImage, idCaptureVideoUrl, idFrontImage, idFrontIrImage, idFrontUvImage, livenessCheckRequest, logIdBackCaptureAttempt, logIdFrontCaptureAttempt, logSelfieCaptureAttempt, passportImage, retryLocationAccess, selfieImage, signatureData, signatureVideoUrl, setDocumentFileMetadata, submissionError, submissionRequest, submissionResponse, submissionStatus, submit, uploadDocument]);
   return /*#__PURE__*/React__default.createElement(SubmissionContext.Provider, {
     value: value
   }, geolocationRequired && geolocationBlocked ? ( /*#__PURE__*/React__default.createElement(GeolocationAccessDeniedOverlay, null)) : children, submissionError && ( /*#__PURE__*/React__default.createElement(SubmissionErrorOverlay, {
@@ -2075,23 +2183,26 @@ function getEnvFromUrl(url) {
   return 'unknown';
 }
 var CREATE_UPLOAD_RETRY_DELAYS = [1500, 3000, 6000, 12000];
-function shouldRetryCreateRequest(error) {
+var RETRYABLE_STATUS_CODES = new Set([408, 409, 423]);
+function shouldRetryTusError(error, retryableMethods) {
   var _a, _b, _c, _d;
   if (typeof ProgressEvent !== 'undefined' && error instanceof ProgressEvent) {
     return true;
   }
   if (error instanceof DetailedError) {
+    var method = void 0;
     try {
-      if (((_b = (_a = error.originalRequest) === null || _a === void 0 ? void 0 : _a.getMethod) === null || _b === void 0 ? void 0 : _b.call(_a)) !== 'POST') {
-        return false;
-      }
+      method = (_b = (_a = error.originalRequest) === null || _a === void 0 ? void 0 : _a.getMethod) === null || _b === void 0 ? void 0 : _b.call(_a);
     } catch (requestMethodError) {
       warn('Unable to read request method from tus error', requestMethodError);
       return false;
     }
+    if (method && retryableMethods.length && !retryableMethods.includes(method)) {
+      return false;
+    }
     var status_1 = (_d = (_c = error.originalResponse) === null || _c === void 0 ? void 0 : _c.getStatus) === null || _d === void 0 ? void 0 : _d.call(_c);
     if (typeof status_1 === 'number') {
-      if (status_1 >= 500 || status_1 === 409 || status_1 === 423) {
+      if (status_1 >= 500 || RETRYABLE_STATUS_CODES.has(status_1)) {
         return true;
       }
       return false;
@@ -2100,6 +2211,12 @@ function shouldRetryCreateRequest(error) {
   }
   return false;
 }
+function shouldRetryCreateRequest(error) {
+  return shouldRetryTusError(error, ['POST']);
+}
+function shouldRetryChunkRequest(error) {
+  return shouldRetryTusError(error, ['PATCH', 'POST']);
+}
 function normalizeUploadError(error) {
   if (error instanceof Error) {
     return error;
@@ -2224,6 +2341,9 @@ function startTusUpload(_a) {
       },
       onError: function onError(error) {
         reject(error);
+      },
+      onShouldRetry: function onShouldRetry(error) {
+        return shouldRetryChunkRequest(error);
       }
     });
     upload.findPreviousUploads().then(function (previousUploads) {
@@ -7171,7 +7291,8 @@ var IdCapture = function IdCapture(_a) {
     var capturedDocumentType = documentType;
     setTimeout(function () {
       var _a, _b;
-      var captureTime = performance.now() - ((_a = state.captureStartedAt) !== null && _a !== void 0 ? _a : new Date()).getTime();
+      var captureStartedAt = (_a = state.captureStartedAt) === null || _a === void 0 ? void 0 : _a.getTime();
+      var captureTime = captureStartedAt ? Date.now() - captureStartedAt : 0;
       var metadata = {
         autoCapture: 'Y',
         captureTime: captureTime,
@@ -11031,12 +11152,14 @@ var IdCaptureWizard = function IdCaptureWizard(_a) {
       captureState = _a.captureState,
       operationStartedAt = _a.operationStartedAt,
       requestedDocumentType = _a.requestedDocumentType;
+    if (!requestedDocumentType) return;
+    var docType = requestedDocumentType;
     metadata.operationTime = new Date().getTime() - (operationStartedAt !== null && operationStartedAt !== void 0 ? operationStartedAt : new Date()).getTime();
     metadata.captureMode = isFallbackMode ? 'Manual' : captureState === 'uploading' ? 'Upload' : 'Auto';
-    if (requestedDocumentType === 'idCardBack') {
-      logIdBackCaptureAttempt(metadata);
+    if (docType === 'idCardBack') {
+      logIdBackCaptureAttempt(metadata, docType);
     } else {
-      logIdFrontCaptureAttempt(metadata);
+      logIdFrontCaptureAttempt(metadata, docType);
     }
   }, [isFallbackMode, logIdBackCaptureAttempt, logIdFrontCaptureAttempt]);
   useEffect(function startModelsWhenCapturing() {
@@ -15439,10 +15562,16 @@ function SelfieCaptureWizard(_a) {
     onCapture === null || onCapture === void 0 ? void 0 : onCapture(imageUrl);
   }, [logCaptureMetadata, onCapture]);
   var onFallbackImageCaptured = useCallback(function (imageUrl) {
+    logSelfieCaptureAttempt({
+      autoCapture: 'N',
+      captureMode: 'Upload',
+      captureTime: 0,
+      operationTime: 0
+    });
     setSelfieImage(imageUrl);
     setCaptureState('SUCCESS');
     onCapture === null || onCapture === void 0 ? void 0 : onCapture(imageUrl);
-  }, [onCapture, setSelfieImage]);
+  }, [logSelfieCaptureAttempt, onCapture, setSelfieImage]);
   var guidesByRequestState = useCallback(function (props) {
     var GuidesComponent = guidesComponent !== null && guidesComponent !== void 0 ? guidesComponent : FaceCaptureGuideOverlay;
     var status = ['IN_PROGRESS', 'CAPTURE_STARTED', 'GUIDANCE_SATISFIED', 'CAPTURED'].includes(captureState) ? 'processing' : ['FAILED', 'ERROR'].includes(captureState) ? 'failure' : 'ready';