idmission-web-sdk 0.0.25 → 0.0.27

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

@@ -3,15 +3,7 @@ import '../../lib/utils/OffscreenCanvasPolyfill';
 import { DocumentType } from '../../lib/models/DocumentDetection';
 import { PDF417DetectionResult } from '../../lib/barcode/Native';
 import { CaptureAttemptMetadata } from '../../contexts/SubmissionContext';
-export type IdDocumentPrediction = {
-    documentDetected: boolean;
-    documentType: DocumentType;
-    documentScore: number;
-    mrzDetected: boolean;
-    mrzScore: number;
-    focusThresholdMet: boolean;
-    focusScore: number;
-};
+import { IdCapturePrediction } from './IdCaptureModelsProvider';
 export type IdCaptureAssets = {
     portraitGuidesImageUrl?: string;
     landscapeGuidesImageUrl?: string;
@@ -33,7 +25,7 @@ export type IdCaptureProps = {
     barcodeScanningEnabled?: boolean;
     maxBarcodeScanAttempts?: number;
     focusScoreThreshold?: number;
-    onPrediction?: (prediction: IdDocumentPrediction) => void;
+    onPrediction?: (prediction: IdCapturePrediction) => void;
     onBarcodeScanned?: (result: PDF417DetectionResult) => void;
     onCapture?: (frame: string, width: number, height: number, metadata: CaptureAttemptMetadata) => void;
     processingScreen?: React.ReactElement;

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

@@ -1,11 +1,12 @@
 import React, { MutableRefObject, ReactElement, ReactNode } from 'react';
-import { DetectedObject } from '../../lib/models/DocumentDetection';
+import { DetectedObject, DocumentType } from '../../lib/models/DocumentDetection';
 import { Frame } from '../../lib/utils/getFrameDimensions';
 export type IdCapturePrediction = {
     detectedObjects: DetectedObject[];
     detectionTime: number;
     detectionScore: number;
     detectionThresholdMet: boolean;
+    detectedDocumentType: DocumentType;
     passportDetectionScore: number;
     passportDetectionThresholdMet: boolean;
     mrzDetectionScore: number;

package/dist/sdk2.cjs.development.js

@@ -7907,7 +7907,7 @@ function clearCanvas(canvas) {
 function makePredictions(frame, lastPredictionCanvas, thresholds) {
   var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
   return tslib.__awaiter(this, void 0, void 0, function () {
-    var _l, frameWidth, frameHeight, _o, boxes, scores, labels, time, detectedObjects, bestDocument, bestPassportPage, bestDocumentScore, passportDetectionScore, passportDetectionThresholdMet, bestDocumentOrPassport, detectionScore, detectionThresholdMet, bestMrz, mrzDetectionScore, mrzDetectionThresholdMet, bestPdf417, pdf417DetectionScore, pdf417DetectionThresholdMet, focusPrediction, focusPredictionTime, focusScore, focusThresholdMet;
+    var _l, frameWidth, frameHeight, _o, boxes, scores, labels, time, detectedObjects, bestDocument, bestPassportPage, bestDocumentScore, passportDetectionScore, passportDetectionThresholdMet, bestDocumentOrPassport, detectionScore, detectionThresholdMet, detectedDocumentType, bestMrz, mrzDetectionScore, mrzDetectionThresholdMet, bestPdf417, pdf417DetectionScore, pdf417DetectionThresholdMet, focusPrediction, focusPredictionTime, focusScore, focusThresholdMet;
     var _p;
     return tslib.__generator(this, function (_q) {
       switch (_q.label) {
@@ -7932,6 +7932,12 @@ function makePredictions(frame, lastPredictionCanvas, thresholds) {
           bestDocumentOrPassport = bestDocumentScore > passportDetectionScore ? bestDocument : bestPassportPage;
           detectionScore = passportDetectionThresholdMet ? passportDetectionScore : bestDocumentScore;
           detectionThresholdMet = detectionScore >= ((_d = thresholds.document) !== null && _d !== void 0 ? _d : 0);
+          detectedDocumentType = DocumentType.NONE;
+          if (passportDetectionThresholdMet) {
+            detectedDocumentType = DocumentType.PASSPORT;
+          } else if (detectionThresholdMet) {
+            detectedDocumentType = DocumentType.ID_CARD;
+          }
           bestMrz = detectedObjects.find(function (obj) {
             return obj.label === 'MRZ';
           });
@@ -7954,14 +7960,15 @@ function makePredictions(frame, lastPredictionCanvas, thresholds) {
           return [2, {
             detectedObjects: detectedObjects,
             detectionScore: detectionScore,
+            detectionTime: time,
             detectionThresholdMet: detectionThresholdMet,
+            detectedDocumentType: detectedDocumentType,
             passportDetectionScore: passportDetectionScore,
             passportDetectionThresholdMet: passportDetectionThresholdMet,
             mrzDetectionScore: mrzDetectionScore,
             mrzDetectionThresholdMet: mrzDetectionThresholdMet,
             pdf417DetectionScore: pdf417DetectionScore,
             pdf417DetectionThresholdMet: pdf417DetectionThresholdMet,
-            detectionTime: time,
             bestDocumentOrPassport: bestDocumentOrPassport,
             bestMrz: bestMrz,
             bestPdf417: bestPdf417,
@@ -8360,6 +8367,7 @@ var reducer$5 = function reducer(state, action) {
         detectedObjects = _a.detectedObjects,
         detectionScore = _a.detectionScore,
         detectionThresholdMet = _a.detectionThresholdMet,
+        detectedDocumentType = _a.detectedDocumentType,
         passportDetectionScore = _a.passportDetectionScore,
         passportDetectionThresholdMet = _a.passportDetectionThresholdMet,
         mrzDetectionScore = _a.mrzDetectionScore,
@@ -8382,12 +8390,6 @@ var reducer$5 = function reducer(state, action) {
           goodFramesThreshold = Math.ceil(3 * frameCaptureRate);
         }
       }
-      var documentType = DocumentType.NONE;
-      if (passportDetectionThresholdMet) {
-        documentType = DocumentType.PASSPORT;
-      } else if (detectionThresholdMet) {
-        documentType = DocumentType.ID_CARD;
-      }
       var documentInBounds = false;
       if (bestDocumentOrPassport) {
         var _b = bestDocumentOrPassport.bbox,
@@ -8416,7 +8418,7 @@ var reducer$5 = function reducer(state, action) {
         bestDocument: bestDocumentOrPassport,
         bestMrz: bestMrz,
         bestPdf417: bestPdf417,
-        documentType: documentType,
+        documentType: detectedDocumentType,
         documentInBounds: documentInBounds,
         documentDetectionScore: detectionScore,
         documentDetectionThresholdMet: detectionThresholdMet,
@@ -8624,19 +8626,9 @@ var IdCapture = function IdCapture(_a) {
           prediction: prediction
         }
       });
+      onPrediction === null || onPrediction === void 0 ? void 0 : onPrediction(prediction);
     });
-  }, [onPredictionMade]);
-  React.useEffect(function () {
-    onPrediction === null || onPrediction === void 0 ? void 0 : onPrediction({
-      focusScore: state.focusScore,
-      focusThresholdMet: state.focusThresholdMet,
-      documentDetected: state.documentDetectionThresholdMet,
-      documentType: state.documentType,
-      documentScore: state.documentDetectionScore,
-      mrzDetected: state.mrzDetectionThresholdMet,
-      mrzScore: state.mrzDetectionScore
-    });
-  }, [onPrediction, state.bestPdf417, state.documentDetectionScore, state.documentDetectionThresholdMet, state.documentType, state.focusScore, state.focusThresholdMet, state.mrzDetectionScore, state.mrzDetectionThresholdMet]);
+  }, [onPrediction, onPredictionMade]);
   React.useEffect(function () {
     (function () {
       return tslib.__awaiter(void 0, void 0, void 0, function () {
@@ -9307,14 +9299,17 @@ var reducer$4 = function reducer(state, action) {
       {
         var prediction = action.payload.prediction;
         var newState = tslib.__assign(tslib.__assign({}, state), {
-          currentDocumentType: prediction.documentType
+          currentDocumentType: prediction.detectedDocumentType
         });
         if (newState.currentDocumentType === state.requestedDocumentType) {
           newState.differentDocumentTypeDetections = 0;
         }
-        if (prediction.documentType === 'PASSPORT' && state.requestedDocumentType !== 'PASSPORT') {
+        if (prediction.detectedDocumentType === 'PASSPORT' && state.requestedDocumentType !== 'PASSPORT') {
           newState.requestedDocumentType = DocumentType.PASSPORT;
         }
+        if (state.requestedDocumentType === 'PASSPORT' && prediction.passportDetectionScore < 0.3) {
+          newState.requestedDocumentType = DocumentType.ID_CARD_FRONT;
+        }
         return newState;
       }
     case 'barcodeScanned':
@@ -9478,9 +9473,6 @@ var IdCaptureWizard = function IdCaptureWizard(_a) {
       releaseCameraAccess();
     }
   }, [releaseCameraAccess, submissionStatus]);
-  if (submissionResponse) {
-    return /*#__PURE__*/React__default['default'].createElement(React__default['default'].Fragment, null, /*#__PURE__*/React__default['default'].createElement("h1", null, "Submission completed!"), /*#__PURE__*/React__default['default'].createElement("pre", null, JSON.stringify(submissionResponse, null, 2)));
-  }
   assets.idCardFrontPortraitGuidesImageUrl = assets.idCardFrontPortraitGuidesImageUrl || "".concat(DEFAULT_CDN_URL, "/Shieldout-IDCard-Front-SVG-Portrait-2.svg");
   assets.idCardFrontLandscapeGuidesImageUrl = assets.idCardFrontLandscapeGuidesImageUrl || "".concat(DEFAULT_CDN_URL, "/Shieldout-IDCard-Front-SVG-Landscape-2.svg");
   assets.idCardBackPortraitGuidesImageUrl = assets.idCardBackPortraitGuidesImageUrl || "".concat(DEFAULT_CDN_URL, "/Shieldout-IDCard-Back-SVG-Portrait-2.svg");
@@ -9491,6 +9483,48 @@ var IdCaptureWizard = function IdCaptureWizard(_a) {
   verbiage.idCardFrontInstructionText = verbiage.idCardFrontInstructionText || t('Scan the front of ID');
   verbiage.idCardBackInstructionText = verbiage.idCardBackInstructionText || t('Scan the back of ID');
   verbiage.passportInstructionText = verbiage.passportInstructionText || t('Scan the ID page of passport');
+  var idCardFrontAssets = React.useMemo(function () {
+    return {
+      portraitGuidesImageUrl: assets.idCardFrontPortraitGuidesImageUrl,
+      landscapeGuidesImageUrl: assets.idCardFrontLandscapeGuidesImageUrl
+    };
+  }, [assets.idCardFrontLandscapeGuidesImageUrl, assets.idCardFrontPortraitGuidesImageUrl]);
+  var idCardFrontVerbiage = React.useMemo(function () {
+    return {
+      instructionText: verbiage.idCardFrontInstructionText,
+      capturingText: verbiage.capturingText,
+      captureFailedText: verbiage.captureFailedText
+    };
+  }, [verbiage.captureFailedText, verbiage.capturingText, verbiage.idCardFrontInstructionText]);
+  var idCardBackAssets = React.useMemo(function () {
+    return {
+      portraitGuidesImageUrl: assets.idCardBackPortraitGuidesImageUrl,
+      landscapeGuidesImageUrl: assets.idCardBackLandscapeGuidesImageUrl
+    };
+  }, [assets.idCardBackLandscapeGuidesImageUrl, assets.idCardBackPortraitGuidesImageUrl]);
+  var idCardBackVerbiage = React.useMemo(function () {
+    return {
+      instructionText: verbiage.idCardBackInstructionText,
+      capturingText: verbiage.capturingText,
+      captureFailedText: verbiage.captureFailedText
+    };
+  }, [verbiage.captureFailedText, verbiage.capturingText, verbiage.idCardBackInstructionText]);
+  var passportAssets = React.useMemo(function () {
+    return {
+      portraitGuidesImageUrl: assets.passportPortraitGuidesImageUrl,
+      landscapeGuidesImageUrl: assets.passportLandscapeGuidesImageUrl
+    };
+  }, [assets.passportLandscapeGuidesImageUrl, assets.passportPortraitGuidesImageUrl]);
+  var passportVerbiage = React.useMemo(function () {
+    return {
+      instructionText: verbiage.passportInstructionText,
+      capturingText: verbiage.capturingText,
+      captureFailedText: verbiage.captureFailedText
+    };
+  }, [verbiage.captureFailedText, verbiage.capturingText, verbiage.passportInstructionText]);
+  if (submissionResponse) {
+    return /*#__PURE__*/React__default['default'].createElement(PageContainer, null, /*#__PURE__*/React__default['default'].createElement("h1", null, "Submission completed!"), /*#__PURE__*/React__default['default'].createElement("pre", null, JSON.stringify(submissionResponse, null, 2)));
+  }
   var flipIdPrompt = /*#__PURE__*/React__default['default'].createElement(FlipIdPrompt, {
     instructionText: verbiage.flipIdInstructionText,
     frontPortraitGuidesImage: assets.idCardFrontPortraitGuidesImageUrl,
@@ -9517,15 +9551,8 @@ var IdCaptureWizard = function IdCaptureWizard(_a) {
           onCapture: onCapture,
           processingScreen: flipIdPrompt,
           processingDelay: 3500,
-          assets: {
-            portraitGuidesImageUrl: assets.idCardFrontPortraitGuidesImageUrl,
-            landscapeGuidesImageUrl: assets.idCardFrontLandscapeGuidesImageUrl
-          },
-          verbiage: {
-            instructionText: verbiage.idCardFrontInstructionText,
-            capturingText: verbiage.capturingText,
-            captureFailedText: verbiage.captureFailedText
-          },
+          assets: idCardFrontAssets,
+          verbiage: idCardFrontVerbiage,
           debugMode: debugMode
         });
       case DocumentType.ID_CARD_BACK:
@@ -9542,15 +9569,8 @@ var IdCaptureWizard = function IdCaptureWizard(_a) {
           onPrediction: onPrediction,
           onBarcodeScanned: onBarcodeScanned,
           onCapture: onCapture,
-          assets: {
-            portraitGuidesImageUrl: assets.idCardBackPortraitGuidesImageUrl,
-            landscapeGuidesImageUrl: assets.idCardBackLandscapeGuidesImageUrl
-          },
-          verbiage: {
-            instructionText: verbiage.idCardBackInstructionText,
-            capturingText: verbiage.capturingText,
-            captureFailedText: verbiage.captureFailedText
-          },
+          assets: idCardBackAssets,
+          verbiage: idCardBackVerbiage,
           debugMode: debugMode
         });
       case DocumentType.PASSPORT:
@@ -9567,15 +9587,8 @@ var IdCaptureWizard = function IdCaptureWizard(_a) {
           onPrediction: onPrediction,
           onBarcodeScanned: onBarcodeScanned,
           onCapture: onCapture,
-          assets: {
-            portraitGuidesImageUrl: assets.passportPortraitGuidesImageUrl,
-            landscapeGuidesImageUrl: assets.passportLandscapeGuidesImageUrl
-          },
-          verbiage: {
-            instructionText: verbiage.passportInstructionText,
-            capturingText: verbiage.capturingText,
-            captureFailedText: verbiage.captureFailedText
-          },
+          assets: passportAssets,
+          verbiage: passportVerbiage,
           debugMode: debugMode
         });
       default:
@@ -10796,11 +10809,10 @@ var useHighestResCaptureDevice = function useHighestResCaptureDevice(_a) {
     if (!((_a = navigator.mediaDevices) === null || _a === void 0 ? void 0 : _a.getUserMedia)) return cleanup;
     (function () {
       return tslib.__awaiter(void 0, void 0, void 0, function () {
-        var isPortrait, stream, e_1;
+        var stream, e_1;
         return tslib.__generator(this, function (_a) {
           switch (_a.label) {
             case 0:
-              isPortrait = window.innerWidth < window.innerHeight;
               stream = null;
               _a.label = 1;
             case 1:
@@ -10812,8 +10824,9 @@ var useHighestResCaptureDevice = function useHighestResCaptureDevice(_a) {
                     exact: videoDevice.deviceId
                   },
                   width: {
-                    ideal: isPortrait ? 1080 : 1920
-                  }
+                    ideal: 1920
+                  },
+                  aspectRatio: 1.777777778
                 }
               })];
             case 2: