@microblink/blinkid-ux-manager 7.4.0 → 7.4.1

package/dist/blinkid-ux-manager.js

@@ -939,18 +939,18 @@ class BlinkIdUxManager {
         }
       }
     );
-    const unsubscribeVideoObserver = cameraManager.subscribe(
+    const unsubscribeVideoObserver = this.cameraManager.subscribe(
       (s2) => s2.videoElement,
       (videoElement) => {
         if (!videoElement) {
-          console.debug("Removing timeout subscriptions");
+          console.debug("Removing camera manager subscriptions");
           this.reset();
           unsubscribeVideoObserver();
           unsubscribePlaybackState();
         }
       }
     );
-    cameraManager.addFrameCaptureCallback(this.#frameCaptureCallback);
+    this.cameraManager.addFrameCaptureCallback(this.#frameCaptureCallback);
   }
   /**
    * Indicates whether the UI should display the demo overlay. Controlled by the
@@ -1184,6 +1184,26 @@ class BlinkIdUxManager {
       }
     }
   };
+  /**
+   * Handles document class filtering if configured.
+   * Returns true if the document should be processed, false if it was filtered out.
+   *
+   * @param processResult - The result of processing the current frame
+   * @returns boolean indicating if the document should be processed
+   */
+  #handleDocumentClassFiltering(processResult) {
+    if (this.#documentClassFilter === void 0) {
+      return true;
+    }
+    const documentClassInfo = this.#extractDocumentClassInfo(processResult);
+    if (!this.#isDocumentClassified(documentClassInfo) || this.#documentClassFilter(documentClassInfo)) {
+      return true;
+    }
+    this.cameraManager.stopFrameCapture();
+    this.#invokeOnDocumentFilteredCallbacks(documentClassInfo);
+    this.#invokeOnFrameProcessCallbacks(processResult);
+    return false;
+  }
   /**
    * The frame capture callback. This is the main function that is called when a
    * new frame is captured. It is responsible for processing the frame and
@@ -1213,11 +1233,8 @@ class BlinkIdUxManager {
     }
     const processResult = await this.scanningSession.process(imageDataLike);
     this.#threadBusy = false;
-    if (this.#documentClassFilter !== void 0) {
-      const documentClassInfo = this.#extractDocumentClassInfo(processResult);
-      if (this.#isDocumentClassified(documentClassInfo) && !this.#documentClassFilter(documentClassInfo)) {
-        this.#invokeOnDocumentFilteredCallbacks(documentClassInfo);
-      }
+    if (!this.#handleDocumentClassFiltering(processResult)) {
+      return processResult.arrayBuffer;
     }
     this.#handleUiStateChanges(processResult);
     this.#invokeOnFrameProcessCallbacks(processResult);
@@ -1290,8 +1307,7 @@ class BlinkIdUxManager {
       console.debug("⏳🟢 timeout triggered");
       this.cameraManager.stopFrameCapture();
       this.#invokeOnErrorCallbacks("timeout");
-      this.feedbackStabilizer.reset();
-      this.uiState = this.feedbackStabilizer.currentState;
+      this.#resetUiState();
     }, this.#timeoutDuration);
   };
   /**
@@ -1368,6 +1384,14 @@ class BlinkIdUxManager {
   #isDocumentClassified(documentClassInfo) {
     return documentClassInfo?.country !== void 0 && documentClassInfo?.type !== void 0;
   }
+  /**
+   * Resets the feedback stabilizer and invokes the onUiStateChanged callbacks.
+   */
+  #resetUiState = () => {
+    this.feedbackStabilizer.reset();
+    this.uiState = this.feedbackStabilizer.currentState;
+    this.#invokeOnUiStateChangedCallbacks(this.uiState);
+  };
   /**
    * Clears the scanning session timeout.
    */
@@ -1379,11 +1403,31 @@ class BlinkIdUxManager {
     window.clearTimeout(this.#timeoutId);
   };
   /**
-   * Resets the BlinkIdUxManager.
+   * Resets the scanning session.
+   *
+   * @param startFrameCapture Whether to start frame processing.
+   */
+  async resetScanningSession(startFrameCapture = true) {
+    console.debug("🔁 Resetting scanning session");
+    this.clearScanTimeout();
+    this.#threadBusy = false;
+    this.#successProcessResult = void 0;
+    this.#resetUiState();
+    await this.scanningSession.reset();
+    if (startFrameCapture) {
+      if (!this.cameraManager.isActive) {
+        await this.cameraManager.startCameraStream();
+      }
+      await this.cameraManager.startFrameCapture();
+    }
+  }
+  /**
+   * Resets the BlinkIdUxManager. Clears all callbacks.
    *
    * Does not reset the camera manager or the scanning session.
    */
   reset() {
+    console.debug("🔁 Resetting BlinkIdUxManager");
     this.clearScanTimeout();
     this.#threadBusy = false;
     this.#successProcessResult = void 0;
@@ -3051,6 +3095,9 @@ const BlinkIdUiStoreProvider = (props) => {
     showOnboardingGuide: props.showOnboardingGuide,
     showHelpTooltipTimeout: props.showHelpTooltipTimeout,
     showHelpButton: props.showHelpButton,
+    showDocumentFilteredModal: props.showDocumentFilteredModal,
+    showTimeoutModal: props.showTimeoutModal,
+    showUnsupportedDocumentModal: props.showUnsupportedDocumentModal,
     dismountFeedbackUi: props.dismountFeedbackUi
     /* eslint-enable solid/reactivity */
   });
@@ -3709,7 +3756,8 @@ const ErrorModal = (props) => {
   } = useBlinkIdUiStore();
   const hideModal = () => {
     updateStore({
-      errorState: void 0
+      errorState: void 0,
+      documentFiltered: false
     });
   };
   const dismountCameraManagerUi = () => {
@@ -3718,7 +3766,7 @@ const ErrorModal = (props) => {
   const handlePrimaryClick = async () => {
     hideModal();
     if (props.shouldResetScanningSession) {
-      await store.blinkIdUxManager.scanningSession.reset();
+      await store.blinkIdUxManager.resetScanningSession(false);
     }
     await store.blinkIdUxManager.cameraManager.startFrameCapture();
   };
@@ -3777,13 +3825,12 @@ const BlinkIdFeedbackUi = (props) => {
     onCleanup(() => errorCallbackCleanup());
   });
   createEffect(() => {
-    const errorCallbackCleanup = store.blinkIdUxManager.addOnDocumentFilteredCallback((_2) => {
-      store.blinkIdUxManager.cameraManager.stopFrameCapture();
+    const documentFilteredCallbackCleanup = store.blinkIdUxManager.addOnDocumentFilteredCallback((_2) => {
       updateStore({
         documentFiltered: true
       });
     });
-    onCleanup(() => errorCallbackCleanup());
+    onCleanup(() => documentFilteredCallbackCleanup());
   });
   const playbackState = createWithSignal(cameraManagerStore)((s2) => s2.playbackState);
   const isProcessing = () => playbackState() === "capturing";
@@ -3823,7 +3870,7 @@ const BlinkIdFeedbackUi = (props) => {
               get children() {
                 return [createComponent(Match, {
                   get when() {
-                    return store.errorState === "timeout";
+                    return store.showTimeoutModal && store.errorState === "timeout";
                   },
                   get children() {
                     return createComponent(ErrorModal, {
@@ -3838,7 +3885,7 @@ const BlinkIdFeedbackUi = (props) => {
                   }
                 }), createComponent(Match, {
                   get when() {
-                    return uiState().key === "UNSUPPORTED_DOCUMENT";
+                    return memo(() => !!store.showUnsupportedDocumentModal)() && uiState().key === "UNSUPPORTED_DOCUMENT";
                   },
                   get children() {
                     return createComponent(ErrorModal, {
@@ -3853,7 +3900,7 @@ const BlinkIdFeedbackUi = (props) => {
                   }
                 }), createComponent(Match, {
                   get when() {
-                    return store.documentFiltered;
+                    return store.showDocumentFilteredModal && store.documentFiltered;
                   },
                   get children() {
                     return createComponent(ErrorModal, {
@@ -3927,7 +3974,10 @@ function createBlinkIdFeedbackUi(blinkIdUxManager, cameraManagerComponent, {
   // todo - implement this
   preserveSdkInstance,
   showOnboardingGuide = true,
-  showHelpButton = true
+  showHelpButton = true,
+  showDocumentFilteredModal = true,
+  showTimeoutModal = true,
+  showUnsupportedDocumentModal = true
 } = {}) {
   const dismountFeedbackUiRef = {
     current: () => {
@@ -3941,6 +3991,9 @@ function createBlinkIdFeedbackUi(blinkIdUxManager, cameraManagerComponent, {
     cameraManagerComponent,
     showOnboardingGuide,
     showHelpButton,
+    showDocumentFilteredModal,
+    showTimeoutModal,
+    showUnsupportedDocumentModal,
     dismountFeedbackUi: () => dismountFeedbackUiRef.current(),
     get children() {
       return createComponent(BlinkIdFeedbackUi, {