idmission-web-sdk 2.1.36 → 2.1.38

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

@@ -38,6 +38,8 @@ export type IdCaptureState = {
     idCardBackDetectionThresholdMet: boolean;
     passportDetectionScore: number;
     passportDetectionThresholdMet: boolean;
+    singlePageDetectionScore: number;
+    singlePageDetectionThresholdMet: boolean;
     focusScore: number;
     focusThresholdMet: boolean;
     isGoodFrame: boolean;

package/dist/lib/models/DocumentDetection.d.ts

@@ -1,16 +1,17 @@
 import { ObjectDetector, ObjectDetectorResult } from '@mediapipe/tasks-vision';
-export declare const defaultDocumentDetectorModelPath = "https://websdk-cdn-dev.idmission.com/assets/models/docdetectmp20240825/model_fp16.tflite";
+export declare const defaultDocumentDetectorModelPath = "https://websdk-cdn-dev.idmission.com/assets/models/docdetectmp20240830/model_fp16.tflite";
 export declare const defaultDocumentDetectionScoreThreshold = 0.1;
 export declare const defaultDocumentDetectionModelLoadTimeoutMs = 45000;
 export declare const defaultDocumentDetectionThresholds: DocumentDetectionThresholds;
-export type DocumentType = 'none' | 'idCardFront' | 'idCardBack' | 'passport';
+export type DocumentType = 'none' | 'idCardFront' | 'idCardBack' | 'passport' | 'singlePage';
 export declare const documentTypeDisplayNames: {
     idCardFront: string;
     idCardBack: string;
     passport: string;
+    singlePage: string;
     none: string;
 };
-export type Label = 'Document' | 'Document back' | 'MRZ' | 'PDF417' | 'Primary face' | 'Secondary face' | 'Glare' | 'Punch Hole' | 'Passport page';
+export type Label = 'Document' | 'Document back' | 'MRZ' | 'PDF417' | 'Primary face' | 'Secondary face' | 'Glare' | 'Punch Hole' | 'Passport page' | 'Single page';
 export type DetectedObjectBox = {
     xMin: number;
     xMax: number;
@@ -28,6 +29,7 @@ export type DocumentDetectionThresholds = {
     idCardFront?: number;
     idCardBack?: number;
     passport?: number;
+    singlePage?: number;
 };
 export declare function loadDocumentDetector(modelAssetPath?: string, scoreThreshold?: number): Promise<ObjectDetector>;
 export declare function useLoadDocumentDetector({ modelPath, modelLoadTimeoutMs, scoreThreshold, onModelError, }: {
@@ -54,6 +56,8 @@ export type DocumentDetectionPrediction = {
     idCardBackDetectionThresholdMet: boolean;
     passportDetectionScore: number;
     passportDetectionThresholdMet: boolean;
+    singlePageDetectionScore: number;
+    singlePageDetectionThresholdMet: boolean;
     bestDocument: DetectedObject | undefined;
     documentInBounds: boolean;
     documentTooClose: boolean;

package/dist/lib/models/Focus.d.ts

@@ -20,6 +20,10 @@ export type FocusThresholds = {
         desktop?: number;
         mobile?: number;
     };
+    singlePage?: {
+        desktop?: number;
+        mobile?: number;
+    };
 };
 export declare const defaultFocusThresholds: FocusThresholds;
 export declare function loadFocusModel(modelAssetPath: string): Promise<ImageClassifier>;

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.36';
+var webSdkVersion = '2.1.38';
 
 function getPlatform() {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -2696,6 +2696,10 @@ var defaultFocusThresholds = {
   passport: {
     desktop: 0,
     mobile: 0.3
+  },
+  singlePage: {
+    desktop: 0,
+    mobile: 0.3
   }
 };
 var models = {};
@@ -5359,18 +5363,20 @@ function sumUpProgressForDependencies(dependencies) {
   });
 }
 
-var defaultDocumentDetectorModelPath = "https://websdk-cdn-dev.idmission.com/assets/models/docdetectmp20240825/model_fp16.tflite";
+var defaultDocumentDetectorModelPath = "https://websdk-cdn-dev.idmission.com/assets/models/docdetectmp20240830/model_fp16.tflite";
 var defaultDocumentDetectionScoreThreshold = 0.1;
 var defaultDocumentDetectionModelLoadTimeoutMs = 45000;
 var defaultDocumentDetectionThresholds = {
   idCardFront: 0.6,
   idCardBack: 0.6,
-  passport: 0.4
+  passport: 0.4,
+  singlePage: 0.6
 };
 var documentTypeDisplayNames = {
   idCardFront: 'ID card front',
   idCardBack: 'ID card back',
   passport: 'Passport',
+  singlePage: 'Single page',
   none: 'None'
 };
 var detectors = {};
@@ -5506,7 +5512,7 @@ function makeDocumentDetectorPrediction(detector, frame) {
   });
 }
 function processDocumentDetectorPrediction(prediction, thresholds) {
-  var _a, _b, _c, _d, _e, _f, _g;
+  var _a, _b, _c, _d, _e, _f, _g, _h, _j;
   var detections = prediction.detections,
     frameWidth = prediction.frameWidth,
     frameHeight = prediction.frameHeight,
@@ -5535,19 +5541,26 @@ function processDocumentDetectorPrediction(prediction, thresholds) {
   var bestPassportPage = detectedObjects.find(function (obj) {
     return obj.label === 'Passport page';
   });
+  var bestSinglePage = detectedObjects.find(function (obj) {
+    return obj.label === 'Single page';
+  });
   var idCardFrontDetectionScore = (_a = bestIdCardFront === null || bestIdCardFront === void 0 ? void 0 : bestIdCardFront.score) !== null && _a !== void 0 ? _a : 0;
   var idCardBackDetectionScore = (_b = bestIdCardBack === null || bestIdCardBack === void 0 ? void 0 : bestIdCardBack.score) !== null && _b !== void 0 ? _b : 0;
   var passportDetectionScore = (_c = bestPassportPage === null || bestPassportPage === void 0 ? void 0 : bestPassportPage.score) !== null && _c !== void 0 ? _c : 0;
-  var idCardFrontDetectionThresholdMet = idCardFrontDetectionScore >= ((_d = thresholds.idCardFront) !== null && _d !== void 0 ? _d : 0);
-  var idCardBackDetectionThresholdMet = idCardBackDetectionScore >= ((_e = thresholds.idCardBack) !== null && _e !== void 0 ? _e : 0);
-  var passportDetectionThresholdMet = passportDetectionScore >= ((_f = thresholds.passport) !== null && _f !== void 0 ? _f : 0);
-  var bestDocument = passportDetectionThresholdMet ? bestPassportPage : idCardBackDetectionThresholdMet ? bestIdCardBack : bestIdCardFront;
-  var detectionThreshold = passportDetectionThresholdMet ? thresholds.passport : idCardBackDetectionThresholdMet ? thresholds.idCardBack : thresholds.idCardFront;
-  var detectionScore = (_g = bestDocument === null || bestDocument === void 0 ? void 0 : bestDocument.score) !== null && _g !== void 0 ? _g : 0;
+  var singlePageDetectionScore = (_d = bestSinglePage === null || bestSinglePage === void 0 ? void 0 : bestSinglePage.score) !== null && _d !== void 0 ? _d : 0;
+  var idCardFrontDetectionThresholdMet = idCardFrontDetectionScore >= ((_e = thresholds.idCardFront) !== null && _e !== void 0 ? _e : 0);
+  var idCardBackDetectionThresholdMet = idCardBackDetectionScore >= ((_f = thresholds.idCardBack) !== null && _f !== void 0 ? _f : 0);
+  var passportDetectionThresholdMet = passportDetectionScore >= ((_g = thresholds.passport) !== null && _g !== void 0 ? _g : 0);
+  var singlePageDetectionThresholdMet = singlePageDetectionScore >= ((_h = thresholds.singlePage) !== null && _h !== void 0 ? _h : 0);
+  var bestDocument = passportDetectionThresholdMet ? bestPassportPage : singlePageDetectionThresholdMet ? bestSinglePage : idCardBackDetectionThresholdMet ? bestIdCardBack : bestIdCardFront;
+  var detectionThreshold = passportDetectionThresholdMet ? thresholds.passport : singlePageDetectionThresholdMet ? thresholds.singlePage : idCardBackDetectionThresholdMet ? thresholds.idCardBack : thresholds.idCardFront;
+  var detectionScore = (_j = bestDocument === null || bestDocument === void 0 ? void 0 : bestDocument.score) !== null && _j !== void 0 ? _j : 0;
   var detectionThresholdMet = detectionScore >= (detectionThreshold !== null && detectionThreshold !== void 0 ? detectionThreshold : 0);
   var detectedDocumentType = 'none';
   if (passportDetectionThresholdMet) {
     detectedDocumentType = 'passport';
+  } else if (singlePageDetectionThresholdMet) {
+    detectedDocumentType = 'singlePage';
   } else if (idCardBackDetectionThresholdMet) {
     detectedDocumentType = 'idCardBack';
   } else if (detectionThresholdMet) {
@@ -5556,11 +5569,11 @@ function processDocumentDetectorPrediction(prediction, thresholds) {
   var documentInBounds = false;
   if (bestDocument) {
     var boundaryPx = 20;
-    var _h = bestDocument.box,
-      boundaryX = _h.xMin,
-      boundaryY = _h.yMin,
-      boundaryWidth = _h.width,
-      boundaryHeight = _h.height;
+    var _k = bestDocument.box,
+      boundaryX = _k.xMin,
+      boundaryY = _k.yMin,
+      boundaryWidth = _k.width,
+      boundaryHeight = _k.height;
     documentInBounds = boundaryY > boundaryPx &&
     // Is it valid top edge of ID detected?
     boundaryY + boundaryHeight + boundaryPx < frameHeight && (
@@ -5571,9 +5584,9 @@ function processDocumentDetectorPrediction(prediction, thresholds) {
   }
   var documentTooClose = false;
   if (bestDocument) {
-    var _j = [bestDocument.box.width / frameWidth, bestDocument.box.height / frameHeight],
-      docWidth = _j[0],
-      docHeight = _j[1];
+    var _l = [bestDocument.box.width / frameWidth, bestDocument.box.height / frameHeight],
+      docWidth = _l[0],
+      docHeight = _l[1];
     documentTooClose = docWidth > 0.85 || docHeight > 0.85;
   }
   return {
@@ -5588,6 +5601,8 @@ function processDocumentDetectorPrediction(prediction, thresholds) {
     idCardBackDetectionThresholdMet: idCardBackDetectionThresholdMet,
     passportDetectionScore: passportDetectionScore,
     passportDetectionThresholdMet: passportDetectionThresholdMet,
+    singlePageDetectionScore: singlePageDetectionScore,
+    singlePageDetectionThresholdMet: singlePageDetectionThresholdMet,
     bestDocument: bestDocument,
     documentInBounds: documentInBounds,
     documentTooClose: documentTooClose,
@@ -6002,20 +6017,24 @@ function IdCaptureModelsProviderInner(_a) {
     var _this = this;
     onDocumentDetected(function (prediction) {
       return __awaiter(_this, void 0, void 0, function () {
-        var stopDetectionAtStart, focusPredictionTime, focusScore, focusThresholdMet, isRequiredDocumentType, focusPrediction, focusThresholdSet, focusThreshold;
+        var stopDetectionAtStart, focusPredictionTime, focusScore, focusThresholdMet, detectedDocumentType, isRequiredDocumentType, focusPrediction, focusThresholdSet, focusThreshold;
         var _a, _b, _c, _d, _e, _f;
         return __generator(this, function (_g) {
           if (!lastPredictionCanvas.current) return [2 /*return*/];
           stopDetectionAtStart = stopDetection.current;
           focusPredictionTime = 0, focusScore = 0, focusThresholdMet = false;
-          isRequiredDocumentType = requiredDocumentType === 'none' || prediction.detectedDocumentType === requiredDocumentType || ((_a = requiredDocumentType.includes) === null || _a === void 0 ? void 0 : _a.call(requiredDocumentType, prediction.detectedDocumentType));
-          if (isRequiredDocumentType && prediction.detectedDocumentType !== 'none' && prediction.detectionThresholdMet && prediction.documentInBounds && !prediction.documentTooClose) {
+          detectedDocumentType = prediction.detectedDocumentType;
+          if (detectedDocumentType === 'singlePage') {
+            detectedDocumentType = 'passport';
+          }
+          isRequiredDocumentType = requiredDocumentType === 'none' || detectedDocumentType === requiredDocumentType || ((_a = requiredDocumentType.includes) === null || _a === void 0 ? void 0 : _a.call(requiredDocumentType, detectedDocumentType));
+          if (isRequiredDocumentType && detectedDocumentType !== 'none' && prediction.detectionThresholdMet && prediction.documentInBounds && !prediction.documentTooClose) {
             focusPrediction = makeFocusPrediction(lastPredictionCanvas.current, (_b = prediction.bestDocument) === null || _b === void 0 ? void 0 : _b.box);
             if (focusPrediction) {
               focusScore = focusPrediction.score;
               focusPredictionTime = focusPrediction.predictionTime;
             }
-            focusThresholdSet = (_c = thresholds.focus) === null || _c === void 0 ? void 0 : _c[prediction.detectedDocumentType];
+            focusThresholdSet = (_c = thresholds.focus) === null || _c === void 0 ? void 0 : _c[detectedDocumentType];
             focusThreshold = (_d = onMobile ? focusThresholdSet === null || focusThresholdSet === void 0 ? void 0 : focusThresholdSet.mobile : focusThresholdSet === null || focusThresholdSet === void 0 ? void 0 : focusThresholdSet.desktop) !== null && _d !== void 0 ? _d : 0;
             focusThresholdMet = focusScore >= focusThreshold;
             if (bestFocusScore.current <= focusScore && stopDetectionAtStart === stopDetection.current) {
@@ -6023,7 +6042,7 @@ function IdCaptureModelsProviderInner(_a) {
               drawToCanvas(bestPredictionCanvas.current, lastPredictionCanvas.current);
               setBestFrameDetails({
                 boundingBox: (_e = prediction.bestDocument) === null || _e === void 0 ? void 0 : _e.box,
-                documentType: prediction.detectedDocumentType,
+                documentType: detectedDocumentType,
                 detectionScore: prediction.detectionScore,
                 focusScore: focusScore
               });
@@ -6151,6 +6170,8 @@ var initialState$4 = {
   idCardBackDetectionThresholdMet: false,
   passportDetectionScore: 0,
   passportDetectionThresholdMet: false,
+  singlePageDetectionScore: 0,
+  singlePageDetectionThresholdMet: false,
   focusScore: 0,
   focusThresholdMet: false,
   isGoodFrame: false,
@@ -6251,6 +6272,8 @@ var _reducer = function reducer(state, action) {
         idCardBackDetectionThresholdMet = _d.idCardBackDetectionThresholdMet,
         passportDetectionScore = _d.passportDetectionScore,
         passportDetectionThresholdMet = _d.passportDetectionThresholdMet,
+        singlePageDetectionScore = _d.singlePageDetectionScore,
+        singlePageDetectionThresholdMet = _d.singlePageDetectionThresholdMet,
         bestDocument = _d.bestDocument,
         documentInBounds = _d.documentInBounds,
         documentTooClose = _d.documentTooClose,
@@ -6288,10 +6311,10 @@ var _reducer = function reducer(state, action) {
         }
       }
       if (state.captureRequirement === 'idCardOrPassport') {
-        if (detectedDocumentType === 'passport' && state.requestedDocumentType !== 'passport') {
+        if ((detectedDocumentType === 'passport' || detectedDocumentType === 'singlePage') && state.requestedDocumentType !== 'passport') {
           requestedDocumentType = 'passport';
         }
-        if (requestedDocumentType === 'passport' && passportDetectionScore < 0.3) {
+        if (requestedDocumentType === 'passport' && !passportDetectionThresholdMet && !singlePageDetectionThresholdMet) {
           requestedDocumentType = 'idCardFront' in state.capturedDocuments ? 'idCardBack' : 'idCardFront';
         }
       }
@@ -6318,6 +6341,8 @@ var _reducer = function reducer(state, action) {
         idCardBackDetectionThresholdMet: idCardBackDetectionThresholdMet,
         passportDetectionScore: passportDetectionScore,
         passportDetectionThresholdMet: passportDetectionThresholdMet,
+        singlePageDetectionScore: singlePageDetectionScore,
+        singlePageDetectionThresholdMet: singlePageDetectionThresholdMet,
         focusScore: focusScore,
         focusThresholdMet: focusThresholdMet,
         isGoodFrame: isGoodFrame,
@@ -7082,7 +7107,7 @@ var IdCapture = function IdCapture(_a) {
       scaling: debugScalingDetails,
       flipX: !((_a = cameraRef.current) === null || _a === void 0 ? void 0 : _a.isRearFacing)
     });
-  }))), debugMode && ( /*#__PURE__*/React__namespace.default.createElement(DebugStatsPane, null, cameraRef.current ? ( /*#__PURE__*/React__namespace.default.createElement(React__namespace.default.Fragment, null, "\u2705 Camera: ", cameraRef.current.label, " (", cameraRef.current.width, "x", cameraRef.current.height, ")")) : '❌ Camera not ready', /*#__PURE__*/React__namespace.default.createElement("br", null), state.frameCaptureRate > 0.75 ? '✅' : '👎', " Frame Rate:", ' ', Math.round((state.frameCaptureRate + Number.EPSILON) * 1000) / 1000, ' ', "fps (", detectionTime, "ms doc detect, ", focusPredictionTime, "ms focus)", /*#__PURE__*/React__namespace.default.createElement("br", null), modelsReady ? ( /*#__PURE__*/React__namespace.default.createElement(React__namespace.default.Fragment, null, state.detectionThresholdMet ? '✅' : '❌', " Detected Document Type: ", state.detectedDocumentType, /*#__PURE__*/React__namespace.default.createElement("br", null), state.idCardFrontDetectionThresholdMet ? '✅' : '❌', " ID Card Front Score: ", state.idCardFrontDetectionScore.toFixed(3), /*#__PURE__*/React__namespace.default.createElement("br", null), state.idCardBackDetectionThresholdMet ? '✅' : '❌', " ID Card Back Score: ", state.idCardBackDetectionScore.toFixed(3), /*#__PURE__*/React__namespace.default.createElement("br", null), state.passportDetectionThresholdMet ? '✅' : '❌', " Passport Score: ", state.passportDetectionScore.toFixed(3), /*#__PURE__*/React__namespace.default.createElement("br", null), state.focusThresholdMet ? '✅' : '❌', " Focus Score:", ' ', state.focusScore.toFixed(3), /*#__PURE__*/React__namespace.default.createElement("br", null), state.documentInBounds ? '✅' : '❌', " Document In Bounds", /*#__PURE__*/React__namespace.default.createElement("br", null), state.goodFramesThresholdMet ? '✅' : '❌', " Good Frame Count:", ' ', state.goodFramesCount, "/", state.goodFramesThreshold)) : ( /*#__PURE__*/React__namespace.default.createElement(React__namespace.default.Fragment, null, "\u274C Models not ready")))));
+  }))), debugMode && ( /*#__PURE__*/React__namespace.default.createElement(DebugStatsPane, null, cameraRef.current ? ( /*#__PURE__*/React__namespace.default.createElement(React__namespace.default.Fragment, null, "\u2705 Camera: ", cameraRef.current.label, " (", cameraRef.current.width, "x", cameraRef.current.height, ")")) : '❌ Camera not ready', /*#__PURE__*/React__namespace.default.createElement("br", null), state.frameCaptureRate > 0.75 ? '✅' : '👎', " Frame Rate:", ' ', Math.round((state.frameCaptureRate + Number.EPSILON) * 1000) / 1000, ' ', "fps (", detectionTime, "ms doc detect, ", focusPredictionTime, "ms focus)", /*#__PURE__*/React__namespace.default.createElement("br", null), modelsReady ? ( /*#__PURE__*/React__namespace.default.createElement(React__namespace.default.Fragment, null, state.detectionThresholdMet ? '✅' : '❌', " Detected Document Type: ", state.detectedDocumentType, /*#__PURE__*/React__namespace.default.createElement("br", null), state.idCardFrontDetectionThresholdMet ? '✅' : '❌', " ID Card Front Score: ", state.idCardFrontDetectionScore.toFixed(3), /*#__PURE__*/React__namespace.default.createElement("br", null), state.idCardBackDetectionThresholdMet ? '✅' : '❌', " ID Card Back Score: ", state.idCardBackDetectionScore.toFixed(3), /*#__PURE__*/React__namespace.default.createElement("br", null), state.passportDetectionThresholdMet ? '✅' : '❌', " Passport Score: ", state.passportDetectionScore.toFixed(3), /*#__PURE__*/React__namespace.default.createElement("br", null), state.singlePageDetectionThresholdMet ? '✅' : '❌', " Single Page Score: ", state.singlePageDetectionScore.toFixed(3), /*#__PURE__*/React__namespace.default.createElement("br", null), state.focusThresholdMet ? '✅' : '❌', " Focus Score:", ' ', state.focusScore.toFixed(3), /*#__PURE__*/React__namespace.default.createElement("br", null), state.documentInBounds ? '✅' : '❌', " Document In Bounds", /*#__PURE__*/React__namespace.default.createElement("br", null), state.goodFramesThresholdMet ? '✅' : '❌', " Good Frame Count:", ' ', state.goodFramesCount, "/", state.goodFramesThreshold)) : ( /*#__PURE__*/React__namespace.default.createElement(React__namespace.default.Fragment, null, "\u274C Models not ready")))));
 };
 var timeSince = function timeSince(t) {
   if (!t) return 0;