idmission-web-sdk 1.0.373 → 1.0.374

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

@@ -37,7 +37,7 @@ export type DocumentDetectionPrediction = {
     mrzDetectionThresholdMet: boolean;
     pdf417DetectionScore: number;
     pdf417DetectionThresholdMet: boolean;
-    bestDocumentOrPassport: DetectedObject | undefined;
+    bestDocument: DetectedObject | undefined;
     bestMrz: DetectedObject | undefined;
     bestPdf417: DetectedObject | undefined;
     documentInBounds: boolean;

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

@@ -15,7 +15,7 @@ export type IdCapturePrediction = {
     mrzDetectionThresholdMet: boolean;
     pdf417DetectionScore: number;
     pdf417DetectionThresholdMet: boolean;
-    bestDocumentOrPassport: DetectedObject | undefined;
+    bestDocument: DetectedObject | undefined;
     bestMrz: DetectedObject | undefined;
     bestPdf417: DetectedObject | undefined;
     documentInBounds: boolean;

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

@@ -1,11 +1,14 @@
 type ProbeState = 'notProbed' | 'probing' | 'probed';
+export type NetworkTier = 'untested' | 'unusable' | 'slow' | 'medium' | 'fast';
 type ModelCapabilities = {
     probeState: ProbeState;
     delegate: 'GPU' | 'CPU' | 'NONE';
+    networkTier: NetworkTier;
     networkSpeed: number;
-    networkTier: 'untested' | 'slow' | 'medium' | 'fast';
+    networkTestTime: number;
 };
 export declare const defaultImageSegmenterModelPath = "https://websdk-cdn-dev.idmission.com/assets/models/selfiesegmenter20240524/selfie_segmenter.tflite";
-export declare const modelCapabilities: ModelCapabilities;
+export declare let modelCapabilities: ModelCapabilities;
 export declare function probeModelCapabilities(): Promise<void>;
+export declare function resetModelCapabilityProbe(): void;
 export {};

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

@@ -17,7 +17,7 @@ export type DetectedObject = {
     score: number;
 };
 export type DocumentDetectionThresholds = {
-    document?: number;
+    idCard?: number;
     passport?: number;
     mrz?: number;
     pdf417?: number;

package/dist/sdk2.cjs.development.js

@@ -49,7 +49,7 @@ var LanguageDetector__default = /*#__PURE__*/_interopDefaultLegacy(LanguageDetec
 var i18n__default = /*#__PURE__*/_interopDefaultLegacy(i18n);
 var SignatureCanvas__default = /*#__PURE__*/_interopDefaultLegacy(SignatureCanvas);
 
-var webSdkVersion = '1.0.373';
+var webSdkVersion = '1.0.374';
 
 function getPlatform() {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -2137,12 +2137,14 @@ var imageSegmenterModelSizeInBytes = 256440.32;
 // The idea here is that we globally set a cache key based on the time at page load. That way our built-in speed test
 // isn't fooled by cache times, but subsequent downloads of the vision runtime still do load from the cache.
 var tinyModelCacheKey = new Date().getTime();
-var modelCapabilities = {
+var initialModelCapabilities = {
   probeState: 'notProbed',
   delegate: 'GPU',
+  networkTier: 'untested',
   networkSpeed: 0,
-  networkTier: 'untested'
+  networkTestTime: 0 // represented in seconds.
 };
+var modelCapabilities = tslib.__assign({}, initialModelCapabilities);
 function probeModelCapabilities() {
   return tslib.__awaiter(this, void 0, void 0, function () {
     var error_1, error_2;
@@ -2197,37 +2199,55 @@ function probeModelCapabilities() {
     });
   });
 }
-function loadTinyModel(delegate) {
+function loadTinyModel(delegate, maxTime) {
   if (delegate === void 0) {
     delegate = 'GPU';
   }
+  if (maxTime === void 0) {
+    maxTime = 10000;
+  }
   return tslib.__awaiter(this, void 0, void 0, function () {
-    var modelAssetPath, startedAt, time, speedMbps, model, _a, _b, emptyFrame;
+    var modelAssetPath, startedAt, e_1, time, speedMbps, model, _a, _b, emptyFrame;
     return tslib.__generator(this, function (_c) {
       switch (_c.label) {
         case 0:
           modelAssetPath = "".concat(defaultImageSegmenterModelPath, "?_=").concat(tinyModelCacheKey);
           startedAt = new Date();
-          return [4 /*yield*/, preloadDependency(modelAssetPath)];
+          _c.label = 1;
         case 1:
+          _c.trys.push([1, 3,, 4]);
+          return [4 /*yield*/, Promise.race([preloadDependency(modelAssetPath), new Promise(function (_resolve, reject) {
+            setTimeout(function () {
+              reject(new Error('gave up after reaching maximum time allowed'));
+            }, maxTime);
+          })])];
+        case 2:
           _c.sent();
+          return [3 /*break*/, 4];
+        case 3:
+          e_1 = _c.sent();
+          error('speed test failed', e_1);
+          modelCapabilities.networkTier = 'unusable';
+          return [2 /*return*/];
+        case 4:
           time = (new Date().getTime() - startedAt.getTime()) / 1000.0;
+          modelCapabilities.networkTestTime || (modelCapabilities.networkTestTime = time);
           modelCapabilities.networkSpeed || (modelCapabilities.networkSpeed = imageSegmenterModelSizeInBytes / time);
-          modelCapabilities.networkTier = time < 500 ? 'fast' : time < 2000 ? 'medium' : 'slow';
+          modelCapabilities.networkTier = time < 0.5 ? 'fast' : time < 2 ? 'medium' : 'slow';
           speedMbps = modelCapabilities.networkSpeed / 1024 / 1024;
           log('Model Probing: network speed', speedMbps.toFixed(3), 'Mbps');
           log('Model Probing: network test took', time);
           log('Model Probing: network tier', modelCapabilities.networkTier);
           _b = (_a = tasksVision.ImageSegmenter).createFromOptions;
           return [4 /*yield*/, tasksVision.FilesetResolver.forVisionTasks(visionTasksBasePath)];
-        case 2:
+        case 5:
           return [4 /*yield*/, _b.apply(_a, [_c.sent(), {
             baseOptions: {
               modelAssetPath: modelAssetPath,
               delegate: delegate
             }
           }])];
-        case 3:
+        case 6:
           model = _c.sent();
           emptyFrame = document.createElement('canvas');
           model.segment(emptyFrame);
@@ -2952,7 +2972,7 @@ function makePrediction(detector, frame) {
   });
 }
 function processPrediction(prediction, thresholds) {
-  var _a, _b, _c, _d, _e, _f, _g, _h;
+  var _a, _b, _c, _d, _e, _f, _g;
   var detections = prediction.detections,
     frameWidth = prediction.frameWidth,
     frameHeight = prediction.frameHeight,
@@ -2980,18 +3000,19 @@ function processPrediction(prediction, thresholds) {
       return n > 0;
     });
   });
-  var bestDocument = detectedObjects.find(function (obj) {
+  var bestIdCard = detectedObjects.find(function (obj) {
     return obj.label === 'Document';
   });
   var bestPassportPage = detectedObjects.find(function (obj) {
     return obj.label === 'Passport page';
   });
-  var bestDocumentScore = (_a = bestDocument === null || bestDocument === void 0 ? void 0 : bestDocument.score) !== null && _a !== void 0 ? _a : 0;
+  var idCardScore = (_a = bestIdCard === null || bestIdCard === void 0 ? void 0 : bestIdCard.score) !== null && _a !== void 0 ? _a : 0;
   var passportDetectionScore = (_b = bestPassportPage === null || bestPassportPage === void 0 ? void 0 : bestPassportPage.score) !== null && _b !== void 0 ? _b : 0;
   var passportDetectionThresholdMet = passportDetectionScore >= ((_c = thresholds.passport) !== null && _c !== void 0 ? _c : 0);
-  var bestDocumentOrPassport = bestDocumentScore > passportDetectionScore ? bestDocument : bestPassportPage;
-  var detectionScore = passportDetectionThresholdMet ? passportDetectionScore : bestDocumentScore;
-  var detectionThresholdMet = detectionScore >= ((_d = thresholds.document) !== null && _d !== void 0 ? _d : 0);
+  var bestDocument = idCardScore > passportDetectionScore ? bestIdCard : bestPassportPage;
+  var detectionScore = passportDetectionThresholdMet ? passportDetectionScore : idCardScore;
+  var detectionThreshold = passportDetectionThresholdMet ? thresholds.passport : thresholds.idCard;
+  var detectionThresholdMet = detectionScore >= (detectionThreshold !== null && detectionThreshold !== void 0 ? detectionThreshold : 0);
   var detectedDocumentType = 'none';
   if (passportDetectionThresholdMet) {
     detectedDocumentType = 'passport';
@@ -3001,21 +3022,21 @@ function processPrediction(prediction, thresholds) {
   var bestMrz = detectedObjects.find(function (obj) {
     return obj.label === 'MRZ';
   });
-  var mrzDetectionScore = (_e = bestMrz === null || bestMrz === void 0 ? void 0 : bestMrz.score) !== null && _e !== void 0 ? _e : 0;
-  var mrzDetectionThresholdMet = mrzDetectionScore >= ((_f = thresholds.mrz) !== null && _f !== void 0 ? _f : 0);
+  var mrzDetectionScore = (_d = bestMrz === null || bestMrz === void 0 ? void 0 : bestMrz.score) !== null && _d !== void 0 ? _d : 0;
+  var mrzDetectionThresholdMet = mrzDetectionScore >= ((_e = thresholds.mrz) !== null && _e !== void 0 ? _e : 0);
   var bestPdf417 = detectedObjects.find(function (obj) {
     return obj.label === 'PDF417';
   });
-  var pdf417DetectionScore = (_g = bestPdf417 === null || bestPdf417 === void 0 ? void 0 : bestPdf417.score) !== null && _g !== void 0 ? _g : 0;
-  var pdf417DetectionThresholdMet = pdf417DetectionScore >= ((_h = thresholds.pdf417) !== null && _h !== void 0 ? _h : 0);
+  var pdf417DetectionScore = (_f = bestPdf417 === null || bestPdf417 === void 0 ? void 0 : bestPdf417.score) !== null && _f !== void 0 ? _f : 0;
+  var pdf417DetectionThresholdMet = pdf417DetectionScore >= ((_g = thresholds.pdf417) !== null && _g !== void 0 ? _g : 0);
   var documentInBounds = false;
-  if (bestDocumentOrPassport) {
+  if (bestDocument) {
     var boundaryPx = 20;
-    var _j = bestDocumentOrPassport.box,
-      boundaryX = _j.xMin,
-      boundaryY = _j.yMin,
-      boundaryWidth = _j.width,
-      boundaryHeight = _j.height;
+    var _h = bestDocument.box,
+      boundaryX = _h.xMin,
+      boundaryY = _h.yMin,
+      boundaryWidth = _h.width,
+      boundaryHeight = _h.height;
     documentInBounds = boundaryY > boundaryPx &&
     // Is it valid top edge of ID detected?
     boundaryY + boundaryHeight + boundaryPx < frameHeight && (
@@ -3025,10 +3046,10 @@ function processPrediction(prediction, thresholds) {
     boundaryX + boundaryWidth + boundaryPx < frameWidth; // Valid right edge if it's less than video width.
   }
   var documentTooClose = false;
-  if (bestDocumentOrPassport) {
-    var _k = [bestDocumentOrPassport.box.width / frameWidth, bestDocumentOrPassport.box.height / frameHeight],
-      docWidth = _k[0],
-      docHeight = _k[1];
+  if (bestDocument) {
+    var _j = [bestDocument.box.width / frameWidth, bestDocument.box.height / frameHeight],
+      docWidth = _j[0],
+      docHeight = _j[1];
     documentTooClose = docWidth > 0.85 || docHeight > 0.85;
   }
   return {
@@ -3043,7 +3064,7 @@ function processPrediction(prediction, thresholds) {
     mrzDetectionThresholdMet: mrzDetectionThresholdMet,
     pdf417DetectionScore: pdf417DetectionScore,
     pdf417DetectionThresholdMet: pdf417DetectionThresholdMet,
-    bestDocumentOrPassport: bestDocumentOrPassport,
+    bestDocument: bestDocument,
     bestMrz: bestMrz,
     bestPdf417: bestPdf417,
     documentInBounds: documentInBounds,
@@ -3354,7 +3375,7 @@ function IdCaptureModelsProviderInner(_a) {
               if (!lastPredictionCanvas.current) return [2 /*return*/];
               focusPrediction = null, focusPredictionTime = 0, focusScore = 0, focusThresholdMet = false;
               if (!(prediction.detectionThresholdMet && prediction.documentInBounds && !prediction.documentTooClose)) return [3 /*break*/, 2];
-              return [4 /*yield*/, makeFocusPrediction(lastPredictionCanvas.current, (_a = prediction.bestDocumentOrPassport) === null || _a === void 0 ? void 0 : _a.box)];
+              return [4 /*yield*/, makeFocusPrediction(lastPredictionCanvas.current, (_a = prediction.bestDocument) === null || _a === void 0 ? void 0 : _a.box)];
             case 1:
               focusPrediction = _g.sent();
               if (focusPrediction) {
@@ -3367,7 +3388,7 @@ function IdCaptureModelsProviderInner(_a) {
             case 2:
               if (bestFocusScore.current <= focusScore) {
                 bestFocusScore.current = focusScore;
-                setBestFrameBoundingBox((_e = prediction.bestDocumentOrPassport) === null || _e === void 0 ? void 0 : _e.box);
+                setBestFrameBoundingBox((_e = prediction.bestDocument) === null || _e === void 0 ? void 0 : _e.box);
                 setBestFrameDetectionScore(prediction.detectionScore);
                 setBestFrameFocusScore(focusScore);
                 drawToCanvas(bestPredictionCanvas.current, lastPredictionCanvas.current);
@@ -3590,7 +3611,7 @@ var reducer$4 = function reducer(state, action) {
         mrzDetectionThresholdMet = _d.mrzDetectionThresholdMet,
         pdf417DetectionScore = _d.pdf417DetectionScore,
         pdf417DetectionThresholdMet = _d.pdf417DetectionThresholdMet,
-        bestDocumentOrPassport = _d.bestDocumentOrPassport,
+        bestDocument = _d.bestDocument,
         bestMrz = _d.bestMrz,
         bestPdf417 = _d.bestPdf417,
         documentInBounds = _d.documentInBounds,
@@ -3620,7 +3641,7 @@ var reducer$4 = function reducer(state, action) {
         videoWidth: frameWidth,
         videoHeight: frameHeight,
         detectedObjects: detectedObjects,
-        bestDocument: bestDocumentOrPassport,
+        bestDocument: bestDocument,
         bestMrz: bestMrz,
         bestPdf417: bestPdf417,
         documentType: detectedDocumentType,
@@ -4283,7 +4304,7 @@ var IdCapture = function IdCapture(_a) {
     });
     resetBestFrame();
     setThresholds({
-      document: autoCaptureScoreThreshold,
+      idCard: autoCaptureScoreThreshold,
       passport: passportPageDetectionThreshold,
       mrz: mrzDetectionScoreThreshold,
       pdf417: pdf417DetectionThreshold,
@@ -10354,7 +10375,7 @@ var IdVideoCapture = function IdVideoCapture(_a) {
   }, [requestedAction, startIdModels, stopIdModels]);
   React.useEffect(function () {
     setThresholds({
-      document: requestedAction === 'SHOW_ID_FRONT' ? idCardFrontDetectionThreshold : requestedAction === 'SHOW_ID_BACK' ? idCardBackDetectionThreshold : 1,
+      idCard: requestedAction === 'SHOW_ID_FRONT' ? idCardFrontDetectionThreshold : requestedAction === 'SHOW_ID_BACK' ? idCardBackDetectionThreshold : 1,
       passport: 1,
       focus: {
         mobile: requestedAction === 'SHOW_ID_FRONT' ? idCardFrontFocusThreshold : requestedAction === 'SHOW_ID_BACK' ? idCardBackFocusThreshold : 0