idmission-web-sdk 2.3.87 → 2.3.89

package/dist/sdk2.umd.development.js

@@ -211,7 +211,7 @@
     return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
   };
 
-  var webSdkVersion = '2.3.87';
+  var webSdkVersion = '2.3.89';
 
   function getPlatform() {
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -8800,14 +8800,29 @@
       // we found that the bounding box ends at the brow and misses the forehead. this ratio represents how much we should extend the box to include the forehead.
       _k = _a.noseTrackingThreshold,
       // we found that the bounding box ends at the brow and misses the forehead. this ratio represents how much we should extend the box to include the forehead.
-      noseTrackingThreshold = _k === void 0 ? 0.2 : _k;
+      noseTrackingThreshold = _k === void 0 ? 0.2 : _k,
+      // this represents the maximum distance that the nose can be from the center of the face box -- 20% of the face box width or height
+      minCaptureBrightnessThreshold = _a.minCaptureBrightnessThreshold,
+      minCaptureRangeThreshold = _a.minCaptureRangeThreshold,
+      minCaptureVarianceThreshold = _a.minCaptureVarianceThreshold,
+      brightness = _a.brightness,
+      range = _a.range,
+      variance = _a.variance;
     var face = faces[0];
     var faceNotDetected = faces.length === 0;
     var faceNotCentered = false,
       faceLookingAway = false,
       faceTooClose = false,
-      faceTooFar = false;
-    if (face) {
+      faceTooFar = false,
+      faceVisibilityTooLow = false;
+    var hasAnyThreshold = minCaptureBrightnessThreshold !== undefined || minCaptureRangeThreshold !== undefined || minCaptureVarianceThreshold !== undefined;
+    if (hasAnyThreshold) {
+      var tooDark = minCaptureBrightnessThreshold !== undefined && brightness !== undefined && brightness < minCaptureBrightnessThreshold;
+      var tooLowRange = minCaptureRangeThreshold !== undefined && range !== undefined && range < minCaptureRangeThreshold;
+      var tooLowVariance = minCaptureVarianceThreshold !== undefined && variance !== undefined && variance < minCaptureVarianceThreshold;
+      faceVisibilityTooLow = !!(tooDark || tooLowRange || tooLowVariance);
+    }
+    if (face && !faceVisibilityTooLow) {
       // calculate frame centroids
       var frameCX = videoWidth / 2;
       var frameCY = videoHeight / 2;
@@ -8846,7 +8861,7 @@
     }
     var faceIsStable = false,
       noseIsStable = false;
-    if (faceInGuides) {
+    if (faceInGuides && !faceVisibilityTooLow) {
       var framesNeeded = Math.max(Math.ceil(average(framesNeededSamples$1)), 5);
       trackFace(face, framesNeeded, videoWidth, videoHeight);
       faceIsStable = lastNFaces.length >= framesNeeded && !lastNFacePairs.some(function (pair) {
@@ -8856,7 +8871,7 @@
         return pair.distance > noseDistanceThreshold;
       });
     }
-    var faceReady = faceInGuides && faceIsStable && noseIsStable;
+    var faceReady = faceInGuides && faceIsStable && noseIsStable && !faceVisibilityTooLow;
     return {
       face: face,
       faceNotDetected: faceNotDetected,
@@ -8867,7 +8882,8 @@
       faceReady: faceReady,
       faceReadyAt: faceReady ? new Date() : null,
       faceIsStable: faceIsStable,
-      noseIsStable: noseIsStable
+      noseIsStable: noseIsStable,
+      faceVisibilityTooLow: faceVisibilityTooLow
     };
   }
   function testFaceDetectionAgainstKnownImage(detector) {
@@ -12599,6 +12615,7 @@
     'Move forward...': 'Hay que moverse hacia adelante...',
     'Move to the center...': 'Hay que moverse hacia el centro...',
     'Waiting for face to be detected...': 'Esperando que se detecte la cara...',
+    'Improve lighting conditions...': 'Hay que buscar mejor iluminación...',
     'Please remove your eye coverings (sunglasses eye patch etc.)...': 'Hay que quitarse lo que cubre los ojos (lentes, parche, etc.)...',
     'Please remove your head coverings (hat scarf etc.)...': 'Hay que quitarse lo que cubre la cabeza (gorra, mascada, etc.)...',
     'Please remove your mask...': 'Hay que quitarse el cubrebocas...',
@@ -12730,6 +12747,7 @@
     'Move forward...': 'Nach vorne bewegen...',
     'Move to the center...': 'In die Mitte bewegen...',
     'Waiting for face to be detected...': 'Warte auf die Gesichtserkennung...',
+    'Improve lighting conditions...': 'Beleuchtungsbedingungen verbessern...',
     'Please remove your eye coverings (sunglasses eye patch etc.)...': 'Bitte Augenbedeckung entfernen (Sonnenbrille, Augenklappe usw.)...',
     'Please remove your head coverings (hat scarf etc.)...': 'Bitte Kopfbedeckung abnehmen (Mütze, Schal usw.)...',
     'Please remove your mask...': 'Bitte Maske ablegen...',
@@ -12861,6 +12879,7 @@
     'Move forward...': 'Avancez...',
     'Move to the center...': 'Déplacez-vous vers le centre...',
     'Waiting for face to be detected...': 'En attente de détection du visage...',
+    'Improve lighting conditions...': "Améliorer les conditions d'éclairage...",
     'Please remove your eye coverings (sunglasses eye patch etc.)...': 'Veuillez retirer ce qui recouvre vos yeux (lunettes de soleil, cache-œil, etc.)...',
     'Please remove your head coverings (hat scarf etc.)...': 'Veuillez retirer vos couvre-chefs (chapeau, foulard, etc.)...',
     'Please remove your mask...': 'Veuillez retirer votre masque...',
@@ -12992,6 +13011,7 @@
     'Move forward...': 'Spostarsi più vicino...',
     'Move to the center...': 'Spostarsi al centro...',
     'Waiting for face to be detected...': 'In attesa che venga rilevato il volto...',
+    'Improve lighting conditions...': 'Migliorare le condizioni di illuminazione...',
     'Please remove your eye coverings (sunglasses eye patch etc.)...': 'Rimuovere tutto ciò che copre gli occhi (occhiali da sole, bende, ecc.)...',
     'Please remove your head coverings (hat scarf etc.)...': 'Rimuovere tutto ciò che ricopre il capo (cappello, sciarpa, ecc.)...',
     'Please remove your mask...': 'Rimuovere la mascherina...',
@@ -13123,6 +13143,7 @@
     'Move forward...': '近づいてください…',
     'Move to the center...': '中央へ移動してください…',
     'Waiting for face to be detected...': '顔が検出されるのを待っています…',
+    'Improve lighting conditions...': '照明条件を改善してください…',
     'Please remove your eye coverings (sunglasses eye patch etc.)...': '目を覆うもの（サングラスや眼帯など）を取り外してください…',
     'Please remove your head coverings (hat scarf etc.)...': '頭を覆うもの（帽子やスカーフなど）を取り外してください…',
     'Please remove your mask...': 'マスクを取り外してください…',
@@ -13254,6 +13275,7 @@
     'Move forward...': 'Mover para frente...',
     'Move to the center...': 'Mover para o centro...',
     'Waiting for face to be detected...': 'Aguardando a detecção de rosto...',
+    'Improve lighting conditions...': 'Melhore as condições de iluminação...',
     'Please remove your eye coverings (sunglasses eye patch etc.)...': 'Por favor, remova as coberturas dos olhos (óculos de sol, tapa-olho, etc.)...',
     'Please remove your head coverings (hat scarf etc.)...': 'Por favor, remova as coberturas da cabeça (chapéu, cachecol, etc.)...',
     'Please remove your mask...': 'Por favor, remova sua máscara...',
@@ -13385,6 +13407,7 @@
     'Move forward...': 'Подвиньтесь вперед…',
     'Move to the center...': 'Переместите к центру…',
     'Waiting for face to be detected...': 'Ожидание обнаружения лица…',
+    'Improve lighting conditions...': 'Улучшите условия освещения…',
     'Please remove your eye coverings (sunglasses eye patch etc.)...': 'Снимите предметы, закрывающие глаза (солнцезащитные очки, повязку и т.д.)…',
     'Please remove your head coverings (hat scarf etc.)...': 'Снимите предметы, покрывающие голову (шапку, шарф и т.д.)…',
     'Please remove your mask...': 'Снимите маску…',
@@ -13516,6 +13539,7 @@
     'Move forward...': '請前進...',
     'Move to the center...': '請移至中心...',
     'Waiting for face to be detected...': '正在等待臉部辨識...',
+    'Improve lighting conditions...': '改善照明條件...',
     'Please remove your eye coverings (sunglasses eye patch etc.)...': '請取下眼睛遮蓋物（太陽眼鏡、眼罩等）...',
     'Please remove your head coverings (hat scarf etc.)...': '請取下頭部遮蓋物（帽子、圍巾等）...',
     'Please remove your mask...': '請脫下口罩...',
@@ -20773,6 +20797,110 @@
   };
   var templateObject_1$n, templateObject_2$l;
 
+  function detectBrightnessAndContrast(frame, brightnessAverager) {
+    var ctx = frame.getContext('2d');
+    if (!ctx || frame.width === 0 || frame.height === 0) return {};
+    var imageData = ctx.getImageData(0, 0, frame.width, frame.height);
+    var pixels = imageData.data; // This is already Uint8ClampedArray
+    var width = frame.width;
+    var sampleResolution = 10;
+    var xStep = Math.max(1, Math.floor(width / sampleResolution));
+    var yStep = Math.max(1, Math.floor(frame.height / sampleResolution));
+    var brightness = 0;
+    var brightnessForVariance = 0;
+    var minBrightness = Infinity;
+    var maxBrightness = -Infinity;
+    var iterations = 0;
+    for (var y = Math.floor(yStep / 2); y < frame.height; y += yStep) {
+      for (var x = Math.floor(xStep / 2); x < width; x += xStep) {
+        var pixelIndex = (y * width + x) * 4;
+        var r = pixels[pixelIndex];
+        var g = pixels[pixelIndex + 1];
+        var b = pixels[pixelIndex + 2];
+        // https://en.wikipedia.org/wiki/Relative_luminance
+        // pixels are represented by 4 channels/bytes, thus a step of 4
+        // the luminance formula is: 0.2126 * R + 0.7152 * G + 0.0722 * B (alpha is not used in this formula)
+        var luminance = r * 0.2126 + g * 0.7152 + b * 0.0722;
+        brightness += luminance;
+        brightnessForVariance += luminance * luminance;
+        minBrightness = Math.min(minBrightness, luminance);
+        maxBrightness = Math.max(maxBrightness, luminance);
+        iterations++;
+      }
+    }
+    var _a = brightnessAverager(brightness / iterations),
+      avg = _a.avg,
+      isFull = _a.isFull;
+    var range = maxBrightness - minBrightness;
+    var variance = brightnessForVariance / iterations - Math.pow(brightness / iterations, 2);
+    return {
+      brightness: isFull ? avg : undefined,
+      range: isFull ? range : undefined,
+      variance: isFull ? variance : undefined
+    };
+  }
+  function createRunningAvgFIFO(capacity) {
+    var cap = capacity | 0;
+    var buf = new Float64Array(cap);
+    var head = 0; // next write index
+    var count = 0; // how many valid items (<= cap)
+    var sum = 0;
+    return {
+      add: function add(x) {
+        if (count === cap) {
+          sum -= buf[head];
+        } else {
+          count++;
+        }
+        buf[head] = x;
+        sum += x;
+        head = head + 1 === cap ? 0 : head + 1;
+        return {
+          avg: sum / count,
+          isFull: count === cap
+        };
+      },
+      avg: function avg() {
+        return count ? sum / count : 0;
+      },
+      size: function size() {
+        return count;
+      },
+      clear: function clear() {
+        head = 0;
+        count = 0;
+        sum = 0;
+      },
+      isFull: function isFull() {
+        return count === cap;
+      }
+    };
+  }
+  function useRunningAvg(capacity) {
+    var fifoRef = React.useRef();
+    if (!fifoRef.current) fifoRef.current = createRunningAvgFIFO(capacity);
+    React.useEffect(function () {
+      fifoRef.current = createRunningAvgFIFO(capacity);
+    }, [capacity]);
+    return {
+      addToAverage: function addToAverage(x) {
+        return fifoRef.current.add(x);
+      },
+      average: function average() {
+        return fifoRef.current.avg();
+      },
+      size: function size() {
+        return fifoRef.current.size();
+      },
+      isFull: function isFull() {
+        return fifoRef.current.isFull();
+      },
+      clear: function clear() {
+        return fifoRef.current.clear();
+      }
+    };
+  }
+
   var SelfieGuidanceModelsContext = /*#__PURE__*/React.createContext({
     start: function start() {
       return null;
@@ -20802,7 +20930,10 @@
       _c = _a.modelLoadTimeoutMs,
       modelLoadTimeoutMs = _c === void 0 ? defaultSelfieCaptureModelLoadTimeoutMs : _c,
       _d = _a.requireVerticalFaceCentering,
-      requireVerticalFaceCentering = _d === void 0 ? true : _d;
+      requireVerticalFaceCentering = _d === void 0 ? true : _d,
+      minCaptureBrightnessThreshold = _a.minCaptureBrightnessThreshold,
+      minCaptureRangeThreshold = _a.minCaptureRangeThreshold,
+      minCaptureVarianceThreshold = _a.minCaptureVarianceThreshold;
     var _e = useCameraStore(useShallow(function (state) {
         return {
           videoRef: state.videoRef,
@@ -20815,6 +20946,7 @@
       cameraReady = _e.cameraReady;
     var canvasRef = React.useRef(null);
     var onPredictionHandler = React.useRef();
+    var addToAverage = useRunningAvg(5).addToAverage;
     var _f = useLoadFaceDetector({
         onModelError: onModelError,
         modelLoadTimeoutMs: modelLoadTimeoutMs,
@@ -20827,7 +20959,7 @@
       modelError = _f.modelError;
     var _g = useFrameLoop(React.useCallback(function () {
         return __awaiter(_this, void 0, void 0, function () {
-          var vw, vh, ctx, prediction, processed, e_1;
+          var vw, vh, ctx, thresholdsProvided, brightnessResults, brightness, range, variance, prediction, processed, e_1;
           var _a, _b;
           return __generator(this, function (_c) {
             switch (_c.label) {
@@ -20845,12 +20977,23 @@
                 _c.label = 1;
               case 1:
                 _c.trys.push([1, 3,, 4]);
+                thresholdsProvided = minCaptureBrightnessThreshold !== undefined || minCaptureRangeThreshold !== undefined || minCaptureVarianceThreshold !== undefined;
+                brightnessResults = thresholdsProvided ? detectBrightnessAndContrast(canvasRef.current, addToAverage) : undefined;
+                brightness = brightnessResults === null || brightnessResults === void 0 ? void 0 : brightnessResults.brightness;
+                range = brightnessResults === null || brightnessResults === void 0 ? void 0 : brightnessResults.range;
+                variance = brightnessResults === null || brightnessResults === void 0 ? void 0 : brightnessResults.variance;
                 prediction = makeFaceDetectorPrediction(canvasRef.current);
                 processed = processFaceDetectorPrediction({
                   faces: (_a = prediction === null || prediction === void 0 ? void 0 : prediction.faces) !== null && _a !== void 0 ? _a : [],
                   videoWidth: vw,
                   videoHeight: vh,
-                  requireVerticalFaceCentering: requireVerticalFaceCentering
+                  requireVerticalFaceCentering: requireVerticalFaceCentering,
+                  minCaptureBrightnessThreshold: minCaptureBrightnessThreshold,
+                  minCaptureRangeThreshold: minCaptureRangeThreshold,
+                  minCaptureVarianceThreshold: minCaptureVarianceThreshold,
+                  brightness: brightness,
+                  range: range,
+                  variance: variance
                 });
                 setLastFaceDetectionAt(new Date().getTime());
                 // setLastPrediction(processed)
@@ -20868,7 +21011,7 @@
             }
           });
         });
-      }, [cameraReady, modelError, ready, requireVerticalFaceCentering, videoLoaded, videoRef]), {
+      }, [cameraReady, modelError, ready, requireVerticalFaceCentering, videoLoaded, videoRef, addToAverage, minCaptureBrightnessThreshold, minCaptureRangeThreshold, minCaptureVarianceThreshold]), {
         throttleMs: throttleMs,
         autoStart: autoStart
       }),
@@ -21241,6 +21384,7 @@
       guidanceMoveForwardText: 'Move forward...',
       guidanceMoveToCenterText: 'Move to the center...',
       guidanceNoFaceDetectedText: 'Waiting for face to be detected...',
+      guidanceVisibilityTooLowText: 'Improve lighting conditions...',
       guidanceNotStableText: 'Please hold still...',
       guidanceManualCaptureText: 'Position your face in the circle and click to capture.',
       manualCaptureBtnText: 'Capture'
@@ -21248,7 +21392,7 @@
     var allowManualCapture = !!guidanceError && allowManualSelfieCaptureOnLoadingError;
     var satisfied = allowManualCapture || ((_b = prediction === null || prediction === void 0 ? void 0 : prediction.faceReady) !== null && _b !== void 0 ? _b : false);
     if (typeof guidanceSatisfied === 'boolean') satisfied = guidanceSatisfied;
-    guidanceMessage || (guidanceMessage = allowManualCapture ? verbiage.guidanceManualCaptureText : satisfied ? verbiage.guidanceHoldStillText : !prediction || (prediction === null || prediction === void 0 ? void 0 : prediction.faceNotDetected) ? verbiage.guidanceNoFaceDetectedText : (prediction === null || prediction === void 0 ? void 0 : prediction.faceNotCentered) ? verbiage.guidanceMoveToCenterText : (prediction === null || prediction === void 0 ? void 0 : prediction.faceLookingAway) ? verbiage.guidanceLookStraightText : (prediction === null || prediction === void 0 ? void 0 : prediction.faceTooClose) ? verbiage.guidanceMoveBackText : (prediction === null || prediction === void 0 ? void 0 : prediction.faceTooFar) ? verbiage.guidanceMoveForwardText : !(prediction === null || prediction === void 0 ? void 0 : prediction.faceIsStable) || !(prediction === null || prediction === void 0 ? void 0 : prediction.noseIsStable) ? verbiage.guidanceNotStableText : '');
+    guidanceMessage || (guidanceMessage = allowManualCapture ? verbiage.guidanceManualCaptureText : satisfied ? verbiage.guidanceHoldStillText : (prediction === null || prediction === void 0 ? void 0 : prediction.faceVisibilityTooLow) ? verbiage.guidanceVisibilityTooLowText : !prediction || (prediction === null || prediction === void 0 ? void 0 : prediction.faceNotDetected) ? verbiage.guidanceNoFaceDetectedText : (prediction === null || prediction === void 0 ? void 0 : prediction.faceNotCentered) ? verbiage.guidanceMoveToCenterText : (prediction === null || prediction === void 0 ? void 0 : prediction.faceLookingAway) ? verbiage.guidanceLookStraightText : (prediction === null || prediction === void 0 ? void 0 : prediction.faceTooClose) ? verbiage.guidanceMoveBackText : (prediction === null || prediction === void 0 ? void 0 : prediction.faceTooFar) ? verbiage.guidanceMoveForwardText : !(prediction === null || prediction === void 0 ? void 0 : prediction.faceIsStable) || !(prediction === null || prediction === void 0 ? void 0 : prediction.noseIsStable) ? verbiage.guidanceNotStableText : '');
     if (guidanceError && !allowManualSelfieCaptureOnLoadingError) {
       return /*#__PURE__*/React.createElement(SelfieCaptureFallback, {
         classNames: classNames.fallback
@@ -24916,7 +25060,10 @@
       throttleMs: 250,
       onModelError: props.onModelError,
       modelLoadTimeoutMs: props.modelLoadTimeoutMs,
-      requireVerticalFaceCentering: false
+      requireVerticalFaceCentering: false,
+      minCaptureBrightnessThreshold: props.minCaptureBrightnessThreshold,
+      minCaptureRangeThreshold: props.minCaptureRangeThreshold,
+      minCaptureVarianceThreshold: props.minCaptureVarianceThreshold
     }, /*#__PURE__*/React.createElement(VideoSignatureWizard, _assign({}, props, {
       onRetryClicked: onRetryClicked
     }))));
@@ -28667,6 +28814,9 @@
       guidesComponent = _a.guidesComponent,
       _q = _a.showFaceGuideThenSignaturePad,
       showFaceGuideThenSignaturePad = _q === void 0 ? false : _q,
+      minCaptureBrightnessThreshold = _a.minCaptureBrightnessThreshold,
+      minCaptureRangeThreshold = _a.minCaptureRangeThreshold,
+      minCaptureVarianceThreshold = _a.minCaptureVarianceThreshold,
       _r = _a.theme,
       theme = _r === void 0 ? 'default' : _r,
       classNames = _a.classNames,
@@ -28737,6 +28887,9 @@
           allowManualSelfieCaptureOnLoadingError: allowManualSelfieCaptureOnLoadingError,
           guidesComponent: guidesComponent,
           showFaceGuideThenSignaturePad: showFaceGuideThenSignaturePad,
+          minCaptureBrightnessThreshold: minCaptureBrightnessThreshold,
+          minCaptureRangeThreshold: minCaptureRangeThreshold,
+          minCaptureVarianceThreshold: minCaptureVarianceThreshold,
           classNames: classNames,
           colors: colors,
           debugMode: debugMode,
@@ -28744,7 +28897,7 @@
           onModelError: onModelError,
           onUserCancel: onUserCancel
         };
-      }, [onLoadingStarted, onLoadingProgress, onLoadingCompleted, onLoadingFailed, onSelfieCaptured, customOverlayContent, onLoadingOverlayDismissed, loadingOverlayMode, skipSuccessScreen, captureAudio, minSignaturePadPoints, headTrackingDisabled, headTrackingBoundaryPercentage, headTrackingBoundaryType, modelLoadTimeoutMs, faceLivenessProps, allowSignatureAfterLivenessCheckFailure, restartVideoOnSignaturePadCleared, skipLivenessValidation, allowManualSelfieCaptureOnLoadingError, guidesComponent, showFaceGuideThenSignaturePad, classNames, colors, debugMode, verbiage, onModelError, onUserCancel])
+      }, [onLoadingStarted, onLoadingProgress, onLoadingCompleted, onLoadingFailed, onSelfieCaptured, customOverlayContent, onLoadingOverlayDismissed, loadingOverlayMode, skipSuccessScreen, captureAudio, minSignaturePadPoints, headTrackingDisabled, headTrackingBoundaryPercentage, headTrackingBoundaryType, modelLoadTimeoutMs, faceLivenessProps, allowSignatureAfterLivenessCheckFailure, restartVideoOnSignaturePadCleared, skipLivenessValidation, allowManualSelfieCaptureOnLoadingError, guidesComponent, showFaceGuideThenSignaturePad, minCaptureBrightnessThreshold, minCaptureRangeThreshold, minCaptureVarianceThreshold, classNames, colors, debugMode, verbiage, onModelError, onUserCancel])
     })))));
   };